diff --git a/providers/src/awscc/v00.00.00000/provider.yaml b/providers/src/awscc/v00.00.00000/provider.yaml index 519b1350..850f597a 100644 --- a/providers/src/awscc/v00.00.00000/provider.yaml +++ b/providers/src/awscc/v00.00.00000/provider.yaml @@ -20,6 +20,24 @@ providerServices: title: acmpca version: v00.00.00000 description: acmpca + aiops: + id: aiops:v00.00.00000 + name: aiops + preferred: true + service: + $ref: awscc/v00.00.00000/services/aiops.yaml + title: aiops + version: v00.00.00000 + description: aiops + amazonmq: + id: amazonmq:v00.00.00000 + name: amazonmq + preferred: true + service: + $ref: awscc/v00.00.00000/services/amazonmq.yaml + title: amazonmq + version: v00.00.00000 + description: amazonmq amplify: id: amplify:v00.00.00000 name: amplify @@ -101,6 +119,15 @@ providerServices: title: applicationinsights version: v00.00.00000 description: applicationinsights + applicationsignals: + id: applicationsignals:v00.00.00000 + name: applicationsignals + preferred: true + service: + $ref: awscc/v00.00.00000/services/applicationsignals.yaml + title: applicationsignals + version: v00.00.00000 + description: applicationsignals apprunner: id: apprunner:v00.00.00000 name: apprunner @@ -128,6 +155,15 @@ providerServices: title: appsync version: v00.00.00000 description: appsync + apptest: + id: apptest:v00.00.00000 + name: apptest + preferred: true + service: + $ref: awscc/v00.00.00000/services/apptest.yaml + title: apptest + version: v00.00.00000 + description: apptest aps: id: aps:v00.00.00000 name: aps @@ -137,6 +173,15 @@ providerServices: title: aps version: v00.00.00000 description: aps + arcregionswitch: + id: arcregionswitch:v00.00.00000 + name: arcregionswitch + preferred: true + service: + $ref: awscc/v00.00.00000/services/arcregionswitch.yaml + title: arcregionswitch + version: v00.00.00000 + description: arcregionswitch arczonalshift: id: arczonalshift:v00.00.00000 name: arczonalshift @@ -209,6 +254,33 @@ providerServices: title: batch version: v00.00.00000 description: batch + bcmdataexports: + id: bcmdataexports:v00.00.00000 + name: bcmdataexports + preferred: true + service: + $ref: awscc/v00.00.00000/services/bcmdataexports.yaml + title: bcmdataexports + version: v00.00.00000 + description: bcmdataexports + bedrock: + id: bedrock:v00.00.00000 + name: bedrock + preferred: true + service: + $ref: awscc/v00.00.00000/services/bedrock.yaml + title: bedrock + version: v00.00.00000 + description: bedrock + billing: + id: billing:v00.00.00000 + name: billing + preferred: true + service: + $ref: awscc/v00.00.00000/services/billing.yaml + title: billing + version: v00.00.00000 + description: billing billingconductor: id: billingconductor:v00.00.00000 name: billingconductor @@ -272,6 +344,15 @@ providerServices: title: cleanrooms version: v00.00.00000 description: cleanrooms + cleanroomsml: + id: cleanroomsml:v00.00.00000 + name: cleanroomsml + preferred: true + service: + $ref: awscc/v00.00.00000/services/cleanroomsml.yaml + title: cleanroomsml + version: v00.00.00000 + description: cleanroomsml cloudformation: id: cloudformation:v00.00.00000 name: cloudformation @@ -326,6 +407,15 @@ providerServices: title: codebuild version: v00.00.00000 description: codebuild + codeconnections: + id: codeconnections:v00.00.00000 + name: codeconnections + preferred: true + service: + $ref: awscc/v00.00.00000/services/codeconnections.yaml + title: codeconnections + version: v00.00.00000 + description: codeconnections codedeploy: id: codedeploy:v00.00.00000 name: codedeploy @@ -425,6 +515,15 @@ providerServices: title: connectcampaigns version: v00.00.00000 description: connectcampaigns + connectcampaignsv2: + id: connectcampaignsv2:v00.00.00000 + name: connectcampaignsv2 + preferred: true + service: + $ref: awscc/v00.00.00000/services/connectcampaignsv2.yaml + title: connectcampaignsv2 + version: v00.00.00000 + description: connectcampaignsv2 controltower: id: controltower:v00.00.00000 name: controltower @@ -488,6 +587,15 @@ providerServices: title: datazone version: v00.00.00000 description: datazone + deadline: + id: deadline:v00.00.00000 + name: deadline + preferred: true + service: + $ref: awscc/v00.00.00000/services/deadline.yaml + title: deadline + version: v00.00.00000 + description: deadline detective: id: detective:v00.00.00000 name: detective @@ -533,6 +641,15 @@ providerServices: title: docdbelastic version: v00.00.00000 description: docdbelastic + dsql: + id: dsql:v00.00.00000 + name: dsql + preferred: true + service: + $ref: awscc/v00.00.00000/services/dsql.yaml + title: dsql + version: v00.00.00000 + description: dsql dynamodb: id: dynamodb:v00.00.00000 name: dynamodb @@ -677,6 +794,15 @@ providerServices: title: evidently version: v00.00.00000 description: evidently + evs: + id: evs:v00.00.00000 + name: evs + preferred: true + service: + $ref: awscc/v00.00.00000/services/evs.yaml + title: evs + version: v00.00.00000 + description: evs finspace: id: finspace:v00.00.00000 name: finspace @@ -866,6 +992,15 @@ providerServices: title: internetmonitor version: v00.00.00000 description: internetmonitor + invoicing: + id: invoicing:v00.00.00000 + name: invoicing + preferred: true + service: + $ref: awscc/v00.00.00000/services/invoicing.yaml + title: invoicing + version: v00.00.00000 + description: invoicing iot: id: iot:v00.00.00000 name: iot @@ -902,15 +1037,6 @@ providerServices: title: iotevents version: v00.00.00000 description: iotevents - iotfleethub: - id: iotfleethub:v00.00.00000 - name: iotfleethub - preferred: true - service: - $ref: awscc/v00.00.00000/services/iotfleethub.yaml - title: iotfleethub - version: v00.00.00000 - description: iotfleethub iotfleetwise: id: iotfleetwise:v00.00.00000 name: iotfleetwise @@ -1055,6 +1181,15 @@ providerServices: title: lambda version: v00.00.00000 description: lambda + launchwizard: + id: launchwizard:v00.00.00000 + name: launchwizard + preferred: true + service: + $ref: awscc/v00.00.00000/services/launchwizard.yaml + title: launchwizard + version: v00.00.00000 + description: launchwizard lex: id: lex:v00.00.00000 name: lex @@ -1109,15 +1244,6 @@ providerServices: title: lookoutequipment version: v00.00.00000 description: lookoutequipment - lookoutmetrics: - id: lookoutmetrics:v00.00.00000 - name: lookoutmetrics - preferred: true - service: - $ref: awscc/v00.00.00000/services/lookoutmetrics.yaml - title: lookoutmetrics - version: v00.00.00000 - description: lookoutmetrics lookoutvision: id: lookoutvision:v00.00.00000 name: lookoutvision @@ -1208,6 +1334,15 @@ providerServices: title: memorydb version: v00.00.00000 description: memorydb + mpa: + id: mpa:v00.00.00000 + name: mpa + preferred: true + service: + $ref: awscc/v00.00.00000/services/mpa.yaml + title: mpa + version: v00.00.00000 + description: mpa msk: id: msk:v00.00.00000 name: msk @@ -1262,15 +1397,24 @@ providerServices: title: networkmanager version: v00.00.00000 description: networkmanager - nimblestudio: - id: nimblestudio:v00.00.00000 - name: nimblestudio + notifications: + id: notifications:v00.00.00000 + name: notifications + preferred: true + service: + $ref: awscc/v00.00.00000/services/notifications.yaml + title: notifications + version: v00.00.00000 + description: notifications + notificationscontacts: + id: notificationscontacts:v00.00.00000 + name: notificationscontacts preferred: true service: - $ref: awscc/v00.00.00000/services/nimblestudio.yaml - title: nimblestudio + $ref: awscc/v00.00.00000/services/notificationscontacts.yaml + title: notificationscontacts version: v00.00.00000 - description: nimblestudio + description: notificationscontacts oam: id: oam:v00.00.00000 name: oam @@ -1280,6 +1424,24 @@ providerServices: title: oam version: v00.00.00000 description: oam + observabilityadmin: + id: observabilityadmin:v00.00.00000 + name: observabilityadmin + preferred: true + service: + $ref: awscc/v00.00.00000/services/observabilityadmin.yaml + title: observabilityadmin + version: v00.00.00000 + description: observabilityadmin + odb: + id: odb:v00.00.00000 + name: odb + preferred: true + service: + $ref: awscc/v00.00.00000/services/odb.yaml + title: odb + version: v00.00.00000 + description: odb omics: id: omics:v00.00.00000 name: omics @@ -1307,15 +1469,6 @@ providerServices: title: opensearchservice version: v00.00.00000 description: opensearchservice - opsworkscm: - id: opsworkscm:v00.00.00000 - name: opsworkscm - preferred: true - service: - $ref: awscc/v00.00.00000/services/opsworkscm.yaml - title: opsworkscm - version: v00.00.00000 - description: opsworkscm organizations: id: organizations:v00.00.00000 name: organizations @@ -1343,6 +1496,15 @@ providerServices: title: panorama version: v00.00.00000 description: panorama + paymentcryptography: + id: paymentcryptography:v00.00.00000 + name: paymentcryptography + preferred: true + service: + $ref: awscc/v00.00.00000/services/paymentcryptography.yaml + title: paymentcryptography + version: v00.00.00000 + description: paymentcryptography pcaconnectorad: id: pcaconnectorad:v00.00.00000 name: pcaconnectorad @@ -1352,6 +1514,24 @@ providerServices: title: pcaconnectorad version: v00.00.00000 description: pcaconnectorad + pcaconnectorscep: + id: pcaconnectorscep:v00.00.00000 + name: pcaconnectorscep + preferred: true + service: + $ref: awscc/v00.00.00000/services/pcaconnectorscep.yaml + title: pcaconnectorscep + version: v00.00.00000 + description: pcaconnectorscep + pcs: + id: pcs:v00.00.00000 + name: pcs + preferred: true + service: + $ref: awscc/v00.00.00000/services/pcs.yaml + title: pcs + version: v00.00.00000 + description: pcs personalize: id: personalize:v00.00.00000 name: personalize @@ -1388,6 +1568,15 @@ providerServices: title: proton version: v00.00.00000 description: proton + qbusiness: + id: qbusiness:v00.00.00000 + name: qbusiness + preferred: true + service: + $ref: awscc/v00.00.00000/services/qbusiness.yaml + title: qbusiness + version: v00.00.00000 + description: qbusiness qldb: id: qldb:v00.00.00000 name: qldb @@ -1415,6 +1604,15 @@ providerServices: title: ram version: v00.00.00000 description: ram + rbin: + id: rbin:v00.00.00000 + name: rbin + preferred: true + service: + $ref: awscc/v00.00.00000/services/rbin.yaml + title: rbin + version: v00.00.00000 + description: rbin rds: id: rds:v00.00.00000 name: rds @@ -1514,6 +1712,15 @@ providerServices: title: route53 version: v00.00.00000 description: route53 + route53profiles: + id: route53profiles:v00.00.00000 + name: route53profiles + preferred: true + service: + $ref: awscc/v00.00.00000/services/route53profiles.yaml + title: route53profiles + version: v00.00.00000 + description: route53profiles route53recoverycontrol: id: route53recoverycontrol:v00.00.00000 name: route53recoverycontrol @@ -1586,6 +1793,15 @@ providerServices: title: s3outposts version: v00.00.00000 description: s3outposts + s3tables: + id: s3tables:v00.00.00000 + name: s3tables + preferred: true + service: + $ref: awscc/v00.00.00000/services/s3tables.yaml + title: s3tables + version: v00.00.00000 + description: s3tables sagemaker: id: sagemaker:v00.00.00000 name: sagemaker @@ -1622,6 +1838,15 @@ providerServices: title: securityhub version: v00.00.00000 description: securityhub + securitylake: + id: securitylake:v00.00.00000 + name: securitylake + preferred: true + service: + $ref: awscc/v00.00.00000/services/securitylake.yaml + title: securitylake + version: v00.00.00000 + description: securitylake servicecatalog: id: servicecatalog:v00.00.00000 name: servicecatalog @@ -1712,6 +1937,15 @@ providerServices: title: ssmcontacts version: v00.00.00000 description: ssmcontacts + ssmguiconnect: + id: ssmguiconnect:v00.00.00000 + name: ssmguiconnect + preferred: true + service: + $ref: awscc/v00.00.00000/services/ssmguiconnect.yaml + title: ssmguiconnect + version: v00.00.00000 + description: ssmguiconnect ssmincidents: id: ssmincidents:v00.00.00000 name: ssmincidents @@ -1721,6 +1955,15 @@ providerServices: title: ssmincidents version: v00.00.00000 description: ssmincidents + ssmquicksetup: + id: ssmquicksetup:v00.00.00000 + name: ssmquicksetup + preferred: true + service: + $ref: awscc/v00.00.00000/services/ssmquicksetup.yaml + title: ssmquicksetup + version: v00.00.00000 + description: ssmquicksetup sso: id: sso:v00.00.00000 name: sso @@ -1838,6 +2081,15 @@ providerServices: title: workspaces version: v00.00.00000 description: workspaces + workspacesinstances: + id: workspacesinstances:v00.00.00000 + name: workspacesinstances + preferred: true + service: + $ref: awscc/v00.00.00000/services/workspacesinstances.yaml + title: workspacesinstances + version: v00.00.00000 + description: workspacesinstances workspacesthinclient: id: workspacesthinclient:v00.00.00000 name: workspacesthinclient @@ -1874,6 +2126,15 @@ providerServices: title: cloud_control version: v00.00.00000 description: cloud_control + tagging: + id: tagging:v00.00.00000 + name: tagging + preferred: true + service: + $ref: awscc/v00.00.00000/services/tagging.yaml + title: tagging + version: v00.00.00000 + description: tagging config: auth: type: aws_signing_v4 diff --git a/providers/src/awscc/v00.00.00000/services/.gitignore b/providers/src/awscc/v00.00.00000/services/.gitignore deleted file mode 100644 index 86d0cb27..00000000 --- a/providers/src/awscc/v00.00.00000/services/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -# Ignore everything in this directory -* -# Except this file -!.gitignore \ No newline at end of file diff --git a/providers/src/awscc/v00.00.00000/services/accessanalyzer.yaml b/providers/src/awscc/v00.00.00000/services/accessanalyzer.yaml index 0fd4cf23..95c0f46d 100644 --- a/providers/src/awscc/v00.00.00000/services/accessanalyzer.yaml +++ b/providers/src/awscc/v00.00.00000/services/accessanalyzer.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: AccessAnalyzer - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ArchiveRule: description: An Access Analyzer archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. @@ -58,22 +438,100 @@ components: maxLength: 127 Value: type: string - description: 'The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' - minLength: 1 + description: 'The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 0 maxLength: 255 required: - Key - - Value + additionalProperties: false + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + AnalysisRuleCriteria: + description: The criteria for an analysis rule for an analyzer. + type: object + properties: + AccountIds: + description: A list of AWS account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. + type: array + x-insertionOrder: false + items: + type: string + ResourceTags: + description: |- + An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + + For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:. + + For the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + additionalProperties: false + InternalAccessAnalysisRuleCriteria: + description: The criteria for an analysis rule for an internal access analyzer. + type: object + properties: + AccountIds: + description: A list of AWS account IDs to apply to the internal access analysis rule criteria. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers and cannot include the organization owner account. + type: array + x-insertionOrder: false + items: + type: string + ResourceArns: + description: A list of resource ARNs to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources that match these ARNs. + type: array + x-insertionOrder: false + items: + type: string + ResourceTypes: + description: A list of resource types to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources of these types. + type: array + x-insertionOrder: false + items: + type: string + additionalProperties: false + InternalAccessConfiguration: + description: Specifies the configuration of an internal access analyzer for an AWS organization or account. This configuration determines how the analyzer evaluates internal access within your AWS environment. + type: object + properties: + InternalAccessAnalysisRule: + description: Contains information about analysis rules for the internal access analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule. + type: object + properties: + Inclusions: + description: A list of rules for the internal access analyzer containing criteria to include in analysis. Only resources that meet the rule criteria will generate findings. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/InternalAccessAnalysisRuleCriteria' + additionalProperties: false additionalProperties: false UnusedAccessConfiguration: description: The Configuration for Unused Access Analyzer type: object properties: UnusedAccessAge: - description: The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days. + description: The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 365 days. type: integer minimum: 1 - maximum: 180 + maximum: 365 + AnalysisRule: + description: Contains information about rules for the analyzer. + type: object + properties: + Exclusions: + description: A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AnalysisRuleCriteria' + additionalProperties: false additionalProperties: false Analyzer: type: object @@ -102,7 +560,7 @@ components: items: $ref: '#/components/schemas/Tag' Type: - description: The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS + description: The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS, ACCOUNT_UNUSED_ACCESS and ORGANIZATION_UNUSED_ACCESS type: string minLength: 0 maxLength: 1024 @@ -112,18 +570,35 @@ components: properties: UnusedAccessConfiguration: $ref: '#/components/schemas/UnusedAccessConfiguration' + InternalAccessConfiguration: + $ref: '#/components/schemas/InternalAccessConfiguration' additionalProperties: false required: - Type x-stackql-resource-name: analyzer - x-stackql-primaryIdentifier: + description: The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account + x-type-name: AWS::AccessAnalyzer::Analyzer + x-stackql-primary-identifier: - Arn x-create-only-properties: - AnalyzerName - Type + x-conditional-create-only-properties: - AnalyzerConfiguration x-read-only-properties: - Arn + x-required-properties: + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - access-analyzer:UntagResource + - access-analyzer:TagResource + - access-analyzer:ListTagsForResource x-required-permissions: create: - access-analyzer:CreateAnalyzer @@ -141,48 +616,133 @@ components: - access-analyzer:ListAnalyzers - access-analyzer:TagResource - access-analyzer:UntagResource + - access-analyzer:UpdateAnalyzer - access-analyzer:UpdateArchiveRule delete: - access-analyzer:DeleteAnalyzer list: - access-analyzer:ListAnalyzers + CreateAnalyzerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AnalyzerName: + description: Analyzer name + type: string + minLength: 1 + maxLength: 1024 + ArchiveRules: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ArchiveRule' + Arn: + description: Amazon Resource Name (ARN) of the analyzer + type: string + minLength: 1 + maxLength: 1600 + Tags: + type: array + maxItems: 50 + x-insertionOrder: false + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + Type: + description: The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS, ACCOUNT_UNUSED_ACCESS and ORGANIZATION_UNUSED_ACCESS + type: string + minLength: 0 + maxLength: 1024 + AnalyzerConfiguration: + description: The configuration for the analyzer + type: object + properties: + UnusedAccessConfiguration: + $ref: '#/components/schemas/UnusedAccessConfiguration' + InternalAccessConfiguration: + $ref: '#/components/schemas/InternalAccessConfiguration' + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateAnalyzerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: analyzers: name: analyzers id: awscc.accessanalyzer.analyzers x-cfn-schema-name: Analyzer - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' - AND region = 'us-east-1' - analyzer: - name: analyzer - id: awscc.accessanalyzer.analyzer - x-cfn-schema-name: Analyzer - x-type: get + x-cfn-type-name: AWS::AccessAnalyzer::Analyzer x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Analyzer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AccessAnalyzer::Analyzer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AccessAnalyzer::Analyzer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AccessAnalyzer::Analyzer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/analyzers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/analyzers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/analyzers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -197,7 +757,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -211,3 +771,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' AND data__Identifier = '' AND region = 'us-east-1' + analyzers_list_only: + name: analyzers_list_only + id: awscc.accessanalyzer.analyzers_list_only + x-cfn-schema-name: Analyzer + x-cfn-type-name: AWS::AccessAnalyzer::Analyzer + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Analyzer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnalyzer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnalyzerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/acmpca.yaml b/providers/src/awscc/v00.00.00000/services/acmpca.yaml index 9d1716bb..c0b782b7 100644 --- a/providers/src/awscc/v00.00.00000/services/acmpca.yaml +++ b/providers/src/awscc/v00.00.00000/services/acmpca.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ACMPCA - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ApiPassthrough: description: |- @@ -69,7 +449,7 @@ components: CustomExtension: description: |- Specifies the X.509 extension information for a certificate. - Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough`` [template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations). + Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough``[template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations). type: object additionalProperties: false properties: @@ -281,7 +661,6 @@ components: type: string required: - PartyName - - NameAssigner UniformResourceIdentifier: description: String that contains X.509 UniformResourceIdentifier information. type: string @@ -332,7 +711,9 @@ components: - SigningAlgorithm - Validity x-stackql-resource-name: certificate - x-stackql-primaryIdentifier: + description: The ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action. + x-type-name: AWS::ACMPCA::Certificate + x-stackql-primary-identifier: - Arn - CertificateAuthorityArn x-create-only-properties: @@ -343,9 +724,26 @@ components: - TemplateArn - Validity - ValidityNotBefore + x-write-only-properties: + - ApiPassthrough + - CertificateSigningRequest + - SigningAlgorithm + - TemplateArn + - Validity + - ValidityNotBefore x-read-only-properties: - Arn - Certificate + x-required-properties: + - CertificateAuthorityArn + - CertificateSigningRequest + - SigningAlgorithm + - Validity + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - acm-pca:IssueCertificate @@ -354,7 +752,6 @@ components: - acm-pca:GetCertificate delete: - acm-pca:GetCertificate - update: [] Tag: type: object additionalProperties: false @@ -363,6 +760,8 @@ components: type: string Value: type: string + required: + - Key CrlDistributionPointExtensionConfiguration: description: Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority type: object @@ -389,6 +788,12 @@ components: type: string CrlDistributionPointExtensionConfiguration: $ref: '#/components/schemas/CrlDistributionPointExtensionConfiguration' + CrlType: + type: string + CustomPath: + type: string + required: + - Enabled OcspConfiguration: description: Helps to configure online certificate status protocol (OCSP) responder for your certificate authority type: object @@ -398,6 +803,8 @@ components: type: boolean OcspCustomCname: type: string + required: + - Enabled RevocationConfiguration: description: Certificate Authority revocation information. type: object @@ -488,7 +895,9 @@ components: - SigningAlgorithm - Subject x-stackql-resource-name: certificate_authority - x-stackql-primaryIdentifier: + description: Private certificate authority. + x-type-name: AWS::ACMPCA::CertificateAuthority + x-stackql-primary-identifier: - Arn x-create-only-properties: - Type @@ -498,20 +907,39 @@ components: - CsrExtensions - KeyStorageSecurityStandard - UsageMode + x-write-only-properties: + - Subject + - CsrExtensions + - RevocationConfiguration + - KeyStorageSecurityStandard x-read-only-properties: - Arn - CertificateSigningRequest + x-required-properties: + - Type + - KeyAlgorithm + - SigningAlgorithm + - Subject + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - acm-pca:TagCertificateAuthority + - acm-pca:UntagCertificateAuthority x-required-permissions: create: - acm-pca:CreateCertificateAuthority - acm-pca:DescribeCertificateAuthority - acm-pca:GetCertificateAuthorityCsr + - acm-pca:TagCertificateAuthority read: - acm-pca:DescribeCertificateAuthority - acm-pca:GetCertificateAuthorityCsr - acm-pca:ListTags update: - - acm-pca:ListTags - acm-pca:TagCertificateAuthority - acm-pca:UntagCertificateAuthority - acm-pca:UpdateCertificateAuthority @@ -545,12 +973,25 @@ components: - CertificateAuthorityArn - Certificate x-stackql-resource-name: certificate_authority_activation - x-stackql-primaryIdentifier: + description: Used to install the certificate authority certificate and update the certificate authority status. + x-type-name: AWS::ACMPCA::CertificateAuthorityActivation + x-stackql-primary-identifier: - CertificateAuthorityArn x-create-only-properties: - CertificateAuthorityArn + x-write-only-properties: + - Certificate + - CertificateChain x-read-only-properties: - CompleteCertificateChain + x-required-properties: + - CertificateAuthorityArn + - Certificate + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - acm-pca:ImportCertificateAuthorityCertificate @@ -586,7 +1027,9 @@ components: - CertificateAuthorityArn - Principal x-stackql-resource-name: permission - x-stackql-primaryIdentifier: + description: Permission set on private certificate authority + x-type-name: AWS::ACMPCA::Permission + x-stackql-primary-identifier: - CertificateAuthorityArn - Principal x-create-only-properties: @@ -594,6 +1037,15 @@ components: - CertificateAuthorityArn - Principal - SourceAccount + x-required-properties: + - Actions + - CertificateAuthorityArn + - Principal + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - acm-pca:CreatePermission @@ -602,19 +1054,228 @@ components: - acm-pca:ListPermissions delete: - acm-pca:DeletePermission + CreateCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiPassthrough: + description: Specifies X.509 certificate information to be included in the issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored. + $ref: '#/components/schemas/ApiPassthrough' + CertificateAuthorityArn: + description: The Amazon Resource Name (ARN) for the private CA issues the certificate. + $ref: '#/components/schemas/Arn' + CertificateSigningRequest: + description: The certificate signing request (CSR) for the certificate. + type: string + minLength: 1 + SigningAlgorithm: + description: |- + The name of the algorithm that will be used to sign the certificate to be issued. + This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action. + The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key. + type: string + TemplateArn: + description: Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html). + $ref: '#/components/schemas/Arn' + Validity: + description: The period of time during which the certificate will be valid. + $ref: '#/components/schemas/Validity' + ValidityNotBefore: + description: |- + Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate. + By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ``ValidityNotBefore`` parameter can be used to customize the “Not Before” value. + Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional. + The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``. + $ref: '#/components/schemas/Validity' + Certificate: + description: '' + type: string + Arn: + description: '' + $ref: '#/components/schemas/Arn' + x-stackQL-stringOnly: true + x-title: CreateCertificateRequest + type: object + required: [] + CreateCertificateAuthorityRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the certificate authority. + $ref: '#/components/schemas/Arn' + Type: + description: The type of the certificate authority. + type: string + KeyAlgorithm: + description: Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. + type: string + SigningAlgorithm: + description: Algorithm your CA uses to sign certificate requests. + type: string + Subject: + description: Structure that contains X.500 distinguished name information for your CA. + $ref: '#/components/schemas/Subject' + RevocationConfiguration: + description: Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. + $ref: '#/components/schemas/RevocationConfiguration' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + CertificateSigningRequest: + description: The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate. + type: string + CsrExtensions: + description: Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action. + $ref: '#/components/schemas/CsrExtensions' + KeyStorageSecurityStandard: + description: KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys. + type: string + UsageMode: + description: Usage mode of the ceritificate authority. + type: string + x-stackQL-stringOnly: true + x-title: CreateCertificateAuthorityRequest + type: object + required: [] + CreateCertificateAuthorityActivationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateAuthorityArn: + description: Arn of the Certificate Authority. + type: string + Certificate: + description: Certificate Authority certificate that will be installed in the Certificate Authority. + type: string + CertificateChain: + description: Certificate chain for the Certificate Authority certificate. + type: string + Status: + description: The status of the Certificate Authority. + type: string + CompleteCertificateChain: + description: The complete certificate chain, including the Certificate Authority certificate. + type: string + x-stackQL-stringOnly: true + x-title: CreateCertificateAuthorityActivationRequest + type: object + required: [] + CreatePermissionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Actions: + description: The actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided. + type: array + x-insertionOrder: false + items: + type: string + CertificateAuthorityArn: + description: The Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission. + type: string + Principal: + description: The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com. + type: string + SourceAccount: + description: The ID of the calling account. + type: string + x-stackQL-stringOnly: true + x-title: CreatePermissionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - certificate: - name: certificate - id: awscc.acmpca.certificate + certificates: + name: certificates + id: awscc.acmpca.certificates x-cfn-schema-name: Certificate - x-type: get + x-cfn-type-name: AWS::ACMPCA::Certificate x-identifiers: - Arn - CertificateAuthorityArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -632,7 +1293,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -653,38 +1314,61 @@ components: name: certificate_authorities id: awscc.acmpca.certificate_authorities x-cfn-schema-name: CertificateAuthority - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' - AND region = 'us-east-1' - certificate_authority: - name: certificate_authority - id: awscc.acmpca.certificate_authority - x-cfn-schema-name: CertificateAuthority - x-type: get + x-cfn-type-name: AWS::ACMPCA::CertificateAuthority x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CertificateAuthority&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::CertificateAuthority" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::CertificateAuthority" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::CertificateAuthority" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -704,7 +1388,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -723,17 +1407,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' AND data__Identifier = '' AND region = 'us-east-1' - certificate_authority_activation: - name: certificate_authority_activation - id: awscc.acmpca.certificate_authority_activation + certificate_authorities_list_only: + name: certificate_authorities_list_only + id: awscc.acmpca.certificate_authorities_list_only + x-cfn-schema-name: CertificateAuthority + x-cfn-type-name: AWS::ACMPCA::CertificateAuthority + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' + AND region = 'us-east-1' + certificate_authority_activations: + name: certificate_authority_activations + id: awscc.acmpca.certificate_authority_activations x-cfn-schema-name: CertificateAuthorityActivation - x-type: get + x-cfn-type-name: AWS::ACMPCA::CertificateAuthorityActivation x-identifiers: - CertificateAuthorityArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CertificateAuthorityActivation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::CertificateAuthorityActivation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::CertificateAuthorityActivation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::CertificateAuthorityActivation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -747,7 +1510,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -760,18 +1523,53 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthorityActivation' AND data__Identifier = '' AND region = 'us-east-1' - permission: - name: permission - id: awscc.acmpca.permission + permissions: + name: permissions + id: awscc.acmpca.permissions x-cfn-schema-name: Permission - x-type: get + x-cfn-type-name: AWS::ACMPCA::Permission x-identifiers: - CertificateAuthorityArn - Principal + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ACMPCA::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -784,7 +1582,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -796,3 +1594,324 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ACMPCA::Permission' AND data__Identifier = '|' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CertificateAuthority&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificateAuthority + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateAuthorityRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CertificateAuthorityActivation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificateAuthorityActivation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateAuthorityActivationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePermission + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePermissionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/aiops.yaml b/providers/src/awscc/v00.00.00000/services/aiops.yaml new file mode 100644 index 00000000..49718e3e --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/aiops.yaml @@ -0,0 +1,996 @@ +openapi: 3.0.0 +info: + title: AIOps + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + description: The Investigation Role's ARN. + StringWithPatternAndLengthLimits: + type: string + maxLength: 512 + minLength: 1 + description: User friendly name for resources. + Timestamp: + type: string + description: The timestamp value. + InvestigationGroupArn: + type: string + maxLength: 2048 + minLength: 20 + description: The Investigation Group's ARN. + ChatbotNotificationChannel: + type: object + properties: + SNSTopicArn: + type: string + maxLength: 2048 + minLength: 20 + ChatConfigurationArns: + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + additionalProperties: false + CrossAccountConfiguration: + type: object + properties: + SourceRoleArn: + $ref: '#/components/schemas/RoleArn' + additionalProperties: false + EncryptionConfigMap: + type: object + properties: + EncryptionConfigurationType: + type: string + maxLength: 128 + minLength: 1 + KmsKeyId: + type: string + maxLength: 256 + minLength: 1 + additionalProperties: false + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 1 + required: + - Key + - Value + additionalProperties: false + InvestigationGroup: + type: object + properties: + RoleArn: + $ref: '#/components/schemas/RoleArn' + Name: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + CreatedBy: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + CreatedAt: + $ref: '#/components/schemas/Timestamp' + LastModifiedBy: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + LastModifiedAt: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + Arn: + $ref: '#/components/schemas/InvestigationGroupArn' + RetentionInDays: + type: integer + description: The number of days to retain the investigation group + EncryptionConfig: + $ref: '#/components/schemas/EncryptionConfigMap' + InvestigationGroupPolicy: + type: string + description: Investigation Group policy + IsCloudTrailEventHistoryEnabled: + type: boolean + description: Flag to enable cloud trail history + TagKeyBoundaries: + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + maxLength: 200 + minLength: 1 + ChatbotNotificationChannels: + description: An array of key-value pairs of notification channels to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ChatbotNotificationChannel' + CrossAccountConfigurations: + description: An array of cross account configurations. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/CrossAccountConfiguration' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - Name + x-stackql-resource-name: investigation_group + description: Definition of AWS::AIOps::InvestigationGroup Resource Type + x-type-name: AWS::AIOps::InvestigationGroup + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - RetentionInDays + x-read-only-properties: + - CreatedBy + - CreatedAt + - LastModifiedBy + - LastModifiedAt + - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - aiops:TagResource + - aiops:UntagResource + - aiops:ListTagsForResource + x-required-permissions: + create: + - aiops:CreateInvestigationGroup + - aiops:GetInvestigationGroup + - aiops:GetInvestigationGroupPolicy + - aiops:PutInvestigationGroupPolicy + - aiops:TagResource + - aiops:ListTagsForResource + - iam:PassRole + - kms:DescribeKey + - kms:ListAliases + - kms:Decrypt + - kms:Encrypt + - kms:GenerateDataKey + read: + - aiops:GetInvestigationGroup + - aiops:GetInvestigationGroupPolicy + - aiops:ListTagsForResource + - kms:DescribeKey + - kms:ListAliases + - kms:Decrypt + - kms:Encrypt + update: + - aiops:GetInvestigationGroup + - aiops:UpdateInvestigationGroup + - aiops:GetInvestigationGroupPolicy + - aiops:PutInvestigationGroupPolicy + - aiops:DeleteInvestigationGroupPolicy + - aiops:TagResource + - aiops:UntagResource + - aiops:ListTagsForResource + - iam:PassRole + - kms:DescribeKey + - kms:ListAliases + - kms:Decrypt + - kms:Encrypt + - kms:GenerateDataKey + delete: + - aiops:DeleteInvestigationGroup + - aiops:GetInvestigationGroup + - aiops:DeleteInvestigationGroupPolicy + - aiops:GetInvestigationGroupPolicy + - aiops:UntagResource + - kms:DescribeKey + - kms:ListAliases + list: + - aiops:ListInvestigationGroups + - kms:DescribeKey + - kms:ListAliases + CreateInvestigationGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RoleArn: + $ref: '#/components/schemas/RoleArn' + Name: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + CreatedBy: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + CreatedAt: + $ref: '#/components/schemas/Timestamp' + LastModifiedBy: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + LastModifiedAt: + $ref: '#/components/schemas/StringWithPatternAndLengthLimits' + Arn: + $ref: '#/components/schemas/InvestigationGroupArn' + RetentionInDays: + type: integer + description: The number of days to retain the investigation group + EncryptionConfig: + $ref: '#/components/schemas/EncryptionConfigMap' + InvestigationGroupPolicy: + type: string + description: Investigation Group policy + IsCloudTrailEventHistoryEnabled: + type: boolean + description: Flag to enable cloud trail history + TagKeyBoundaries: + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + maxLength: 200 + minLength: 1 + ChatbotNotificationChannels: + description: An array of key-value pairs of notification channels to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ChatbotNotificationChannel' + CrossAccountConfigurations: + description: An array of cross account configurations. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/CrossAccountConfiguration' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateInvestigationGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + investigation_groups: + name: investigation_groups + id: awscc.aiops.investigation_groups + x-cfn-schema-name: InvestigationGroup + x-cfn-type-name: AWS::AIOps::InvestigationGroup + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InvestigationGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AIOps::InvestigationGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AIOps::InvestigationGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AIOps::InvestigationGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/investigation_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/investigation_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/investigation_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.LastModifiedBy') as last_modified_by, + JSON_EXTRACT(Properties, '$.LastModifiedAt') as last_modified_at, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.RetentionInDays') as retention_in_days, + JSON_EXTRACT(Properties, '$.EncryptionConfig') as encryption_config, + JSON_EXTRACT(Properties, '$.InvestigationGroupPolicy') as investigation_group_policy, + JSON_EXTRACT(Properties, '$.IsCloudTrailEventHistoryEnabled') as is_cloud_trail_event_history_enabled, + JSON_EXTRACT(Properties, '$.TagKeyBoundaries') as tag_key_boundaries, + JSON_EXTRACT(Properties, '$.ChatbotNotificationChannels') as chatbot_notification_channels, + JSON_EXTRACT(Properties, '$.CrossAccountConfigurations') as cross_account_configurations, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AIOps::InvestigationGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastModifiedBy') as last_modified_by, + json_extract_path_text(Properties, 'LastModifiedAt') as last_modified_at, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RetentionInDays') as retention_in_days, + json_extract_path_text(Properties, 'EncryptionConfig') as encryption_config, + json_extract_path_text(Properties, 'InvestigationGroupPolicy') as investigation_group_policy, + json_extract_path_text(Properties, 'IsCloudTrailEventHistoryEnabled') as is_cloud_trail_event_history_enabled, + json_extract_path_text(Properties, 'TagKeyBoundaries') as tag_key_boundaries, + json_extract_path_text(Properties, 'ChatbotNotificationChannels') as chatbot_notification_channels, + json_extract_path_text(Properties, 'CrossAccountConfigurations') as cross_account_configurations, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AIOps::InvestigationGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + investigation_groups_list_only: + name: investigation_groups_list_only + id: awscc.aiops.investigation_groups_list_only + x-cfn-schema-name: InvestigationGroup + x-cfn-type-name: AWS::AIOps::InvestigationGroup + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AIOps::InvestigationGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AIOps::InvestigationGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InvestigationGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInvestigationGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInvestigationGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/amazonmq.yaml b/providers/src/awscc/v00.00.00000/services/amazonmq.yaml new file mode 100644 index 00000000..9d0f76a9 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/amazonmq.yaml @@ -0,0 +1,1112 @@ +openapi: 3.0.0 +info: + title: AmazonMQ + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + LogList: + type: object + additionalProperties: false + properties: + Audit: + type: boolean + General: + type: boolean + LdapServerMetadata: + type: object + additionalProperties: false + properties: + Hosts: + type: array + uniqueItems: false + items: + type: string + UserRoleName: + type: string + UserSearchMatching: + type: string + RoleName: + type: string + UserBase: + type: string + UserSearchSubtree: + type: boolean + RoleSearchMatching: + type: string + ServiceAccountUsername: + type: string + RoleBase: + type: string + ServiceAccountPassword: + type: string + RoleSearchSubtree: + type: boolean + required: + - Hosts + - UserSearchMatching + - UserBase + - RoleSearchMatching + - ServiceAccountUsername + - RoleBase + - ServiceAccountPassword + User: + type: object + additionalProperties: false + properties: + ReplicationUser: + type: boolean + ConsoleAccess: + type: boolean + Username: + type: string + Groups: + type: array + uniqueItems: false + items: + type: string + Password: + type: string + required: + - Username + - Password + MaintenanceWindow: + type: object + additionalProperties: false + properties: + DayOfWeek: + type: string + TimeOfDay: + type: string + TimeZone: + type: string + required: + - DayOfWeek + - TimeOfDay + - TimeZone + TagsEntry: + type: object + additionalProperties: false + properties: + Value: + type: string + Key: + type: string + required: + - Value + - Key + EncryptionOptions: + type: object + additionalProperties: false + properties: + KmsKeyId: + type: string + UseAwsOwnedKey: + type: boolean + required: + - UseAwsOwnedKey + ConfigurationId: + type: object + additionalProperties: false + properties: + Revision: + type: integer + Id: + type: string + required: + - Revision + - Id + Broker: + type: object + properties: + SecurityGroups: + type: array + uniqueItems: false + items: + type: string + DataReplicationPrimaryBrokerArn: + type: string + Configuration: + $ref: '#/components/schemas/ConfigurationId' + AuthenticationStrategy: + type: string + Users: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/User' + SubnetIds: + type: array + uniqueItems: false + items: + type: string + StompEndpoints: + type: array + uniqueItems: false + items: + type: string + MqttEndpoints: + type: array + uniqueItems: false + items: + type: string + AmqpEndpoints: + type: array + uniqueItems: false + items: + type: string + DeploymentMode: + type: string + EngineType: + type: string + EncryptionOptions: + $ref: '#/components/schemas/EncryptionOptions' + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/TagsEntry' + ConfigurationRevision: + type: integer + StorageType: + type: string + EngineVersion: + type: string + MaintenanceWindowStartTime: + $ref: '#/components/schemas/MaintenanceWindow' + HostInstanceType: + type: string + AutoMinorVersionUpgrade: + type: boolean + Logs: + $ref: '#/components/schemas/LogList' + ConsoleURLs: + type: array + uniqueItems: false + items: + type: string + ConfigurationId: + type: string + DataReplicationMode: + type: string + BrokerName: + type: string + WssEndpoints: + type: array + uniqueItems: false + items: + type: string + IpAddresses: + type: array + uniqueItems: false + items: + type: string + OpenWireEndpoints: + type: array + uniqueItems: false + items: + type: string + LdapServerMetadata: + $ref: '#/components/schemas/LdapServerMetadata' + PubliclyAccessible: + type: boolean + Id: + type: string + Arn: + type: string + required: + - DeploymentMode + - HostInstanceType + - EngineType + - Users + - PubliclyAccessible + - BrokerName + x-stackql-resource-name: broker + description: Resource Type definition for AWS::AmazonMQ::Broker + x-type-name: AWS::AmazonMQ::Broker + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - BrokerName + - StorageType + - DeploymentMode + - EngineType + - SubnetIds + - AuthenticationStrategy + - EncryptionOptions + - PubliclyAccessible + x-read-only-properties: + - IpAddresses + - ConsoleURLs + - Id + - MqttEndpoints + - OpenWireEndpoints + - ConfigurationId + - ConfigurationRevision + - StompEndpoints + - WssEndpoints + - AmqpEndpoints + - Arn + x-required-properties: + - DeploymentMode + - HostInstanceType + - EngineType + - Users + - PubliclyAccessible + - BrokerName + Configuration: + type: object + properties: + Arn: + type: string + description: The Amazon Resource Name (ARN) of the Amazon MQ configuration. + AuthenticationStrategy: + type: string + description: The authentication strategy associated with the configuration. The default is SIMPLE. + EngineType: + type: string + description: 'The type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.' + EngineVersion: + type: string + description: The version of the broker engine. + Data: + type: string + description: The base64-encoded XML configuration. + Description: + type: string + description: The description of the configuration. + Id: + type: string + description: The ID of the Amazon MQ configuration. + Name: + type: string + description: The name of the configuration. + Revision: + type: string + description: The revision number of the configuration. + Tags: + type: array + description: Create tags when creating the configuration. + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagsEntry' + required: + - EngineType + - Name + x-stackql-resource-name: configuration + description: Resource Type definition for AWS::AmazonMQ::Configuration + x-type-name: AWS::AmazonMQ::Configuration + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - AuthenticationStrategy + - EngineType + - EngineVersion + - Name + x-write-only-properties: + - Data + x-read-only-properties: + - Arn + - Id + - Revision + x-required-properties: + - EngineType + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mq:ListTags + - mq:CreateTags + - mq:DeleteTags + x-required-permissions: + create: + - mq:CreateConfiguration + - mq:CreateTags + - mq:UpdateConfiguration + read: + - mq:DescribeConfiguration + - mq:ListTags + update: + - mq:UpdateConfiguration + - mq:CreateTags + - mq:DeleteTags + delete: + - mq:DeleteConfiguration + list: + - mq:ListConfigurations + CreateConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The Amazon Resource Name (ARN) of the Amazon MQ configuration. + AuthenticationStrategy: + type: string + description: The authentication strategy associated with the configuration. The default is SIMPLE. + EngineType: + type: string + description: 'The type of broker engine. Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.' + EngineVersion: + type: string + description: The version of the broker engine. + Data: + type: string + description: The base64-encoded XML configuration. + Description: + type: string + description: The description of the configuration. + Id: + type: string + description: The ID of the Amazon MQ configuration. + Name: + type: string + description: The name of the configuration. + Revision: + type: string + description: The revision number of the configuration. + Tags: + type: array + description: Create tags when creating the configuration. + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagsEntry' + x-stackQL-stringOnly: true + x-title: CreateConfigurationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + brokers: + name: brokers + id: awscc.amazonmq.brokers + x-cfn-schema-name: Broker + x-cfn-type-name: AWS::AmazonMQ::Broker + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + configurations: + name: configurations + id: awscc.amazonmq.configurations + x-cfn-schema-name: Configuration + x-cfn-type-name: AWS::AmazonMQ::Configuration + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Configuration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmazonMQ::Configuration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmazonMQ::Configuration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmazonMQ::Configuration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AuthenticationStrategy') as authentication_strategy, + JSON_EXTRACT(Properties, '$.EngineType') as engine_type, + JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, + JSON_EXTRACT(Properties, '$.Data') as data, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Revision') as revision, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AmazonMQ::Configuration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthenticationStrategy') as authentication_strategy, + json_extract_path_text(Properties, 'EngineType') as engine_type, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'Data') as data, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Revision') as revision, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AmazonMQ::Configuration' + AND data__Identifier = '' + AND region = 'us-east-1' + configurations_list_only: + name: configurations_list_only + id: awscc.amazonmq.configurations_list_only + x-cfn-schema-name: Configuration + x-cfn-type-name: AWS::AmazonMQ::Configuration + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmazonMQ::Configuration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmazonMQ::Configuration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Configuration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/amplify.yaml b/providers/src/awscc/v00.00.00000/services/amplify.yaml index 52715348..0a017f31 100644 --- a/providers/src/awscc/v00.00.00000/services/amplify.yaml +++ b/providers/src/awscc/v00.00.00000/services/amplify.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Amplify - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AutoBranchCreationConfig: type: object @@ -68,6 +448,27 @@ components: required: - Username - Password + CacheConfig: + type: object + additionalProperties: false + properties: + Type: + type: string + enum: + - AMPLIFY_MANAGED + - AMPLIFY_MANAGED_NO_COOKIES + JobConfig: + type: object + additionalProperties: false + properties: + BuildComputeType: + type: string + enum: + - STANDARD_8GB + - LARGE_16GB + - XLARGE_72GB + required: + - BuildComputeType CustomRule: type: object additionalProperties: false @@ -158,6 +559,13 @@ components: minLength: 1 maxLength: 25000 pattern: (?s).+ + CacheConfig: + $ref: '#/components/schemas/CacheConfig' + ComputeRoleArn: + type: string + minLength: 0 + maxLength: 1000 + pattern: (?s).* CustomHeaders: type: string minLength: 0 @@ -211,16 +619,37 @@ components: uniqueItems: false items: $ref: '#/components/schemas/Tag' + JobConfig: + $ref: '#/components/schemas/JobConfig' required: - Name x-stackql-resource-name: app - x-stackql-primaryIdentifier: + description: The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches. + x-type-name: AWS::Amplify::App + x-stackql-primary-identifier: - Arn + x-write-only-properties: + - AccessToken + - BasicAuthConfig + - OauthToken + - AutoBranchCreationConfig x-read-only-properties: - AppId - AppName - Arn - DefaultDomain + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - amplify:TagResource + - amplify:ListTagsForResource + - amplify:UntagResource x-required-permissions: create: - amplify:GetApp @@ -298,6 +727,11 @@ components: minLength: 1 maxLength: 25000 pattern: (?s).+ + ComputeRoleArn: + type: string + minLength: 0 + maxLength: 1000 + pattern: (?s).* Description: type: string maxLength: 1000 @@ -308,6 +742,8 @@ components: type: boolean EnablePullRequestPreview: type: boolean + EnableSkewProtection: + type: boolean EnvironmentVariables: type: array uniqueItems: false @@ -338,13 +774,30 @@ components: - AppId - BranchName x-stackql-resource-name: branch - x-stackql-primaryIdentifier: + description: The AWS::Amplify::Branch resource creates a new branch within an app. + x-type-name: AWS::Amplify::Branch + x-stackql-primary-identifier: - Arn x-create-only-properties: - AppId - BranchName + x-write-only-properties: + - BasicAuthConfig x-read-only-properties: - Arn + x-required-properties: + - AppId + - BranchName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - amplify:TagResource + - amplify:ListTagsForResource + - amplify:UntagResource x-required-permissions: create: - amplify:GetBranch @@ -408,7 +861,7 @@ components: - CUSTOM CustomCertificateArn: type: string - pattern: '"^arn:aws:acm:[a-z0-9-]+:\d{12}:certificate\/.+$"' + pattern: ^arn:aws:acm:[a-z0-9-]+:\d{12}:certificate\/.+$ Certificate: type: object additionalProperties: false @@ -495,27 +948,39 @@ components: - DomainName - SubDomainSettings x-stackql-resource-name: domain - x-stackql-primaryIdentifier: + description: The AWS::Amplify::Domain resource allows you to connect a custom domain to your app. + x-type-name: AWS::Amplify::Domain + x-stackql-primary-identifier: - Arn x-create-only-properties: - AppId - DomainName + x-write-only-properties: + - CertificateSettings x-read-only-properties: - Arn - DomainStatus - StatusReason - CertificateRecord + - Certificate + - UpdateStatus + x-required-properties: + - AppId + - DomainName + - SubDomainSettings x-required-permissions: create: + - amplify:GetDomainAssociation - amplify:CreateDomainAssociation - route53:ListHostedZones - route53:ChangeResourceRecordSets - iam:PassRole - amplify:TagResource delete: + - amplify:GetDomainAssociation - amplify:DeleteDomainAssociation + - route53:ListHostedZones - iam:PassRole - - amplify:DeleteDomainAssociation list: - amplify:ListDomainAssociations - iam:PassRole @@ -526,6 +991,7 @@ components: - iam:PassRole - amplify:ListTagsForResource update: + - amplify:GetDomainAssociation - amplify:UpdateDomainAssociation - route53:ListHostedZones - route53:ChangeResourceRecordSets @@ -533,43 +999,326 @@ components: - amplify:ListTagsForResource - amplify:TagResource - amplify:UntagResource + CreateAppRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessToken: + type: string + minLength: 1 + maxLength: 255 + AppId: + type: string + minLength: 1 + maxLength: 20 + pattern: d[a-z0-9]+ + AppName: + type: string + minLength: 1 + maxLength: 255 + pattern: (?s).+ + Arn: + type: string + maxLength: 1000 + pattern: (?s).* + AutoBranchCreationConfig: + $ref: '#/components/schemas/AutoBranchCreationConfig' + BasicAuthConfig: + $ref: '#/components/schemas/BasicAuthConfig' + BuildSpec: + type: string + minLength: 1 + maxLength: 25000 + pattern: (?s).+ + CacheConfig: + $ref: '#/components/schemas/CacheConfig' + ComputeRoleArn: + type: string + minLength: 0 + maxLength: 1000 + pattern: (?s).* + CustomHeaders: + type: string + minLength: 0 + maxLength: 25000 + pattern: (?s).* + CustomRules: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/CustomRule' + DefaultDomain: + type: string + minLength: 0 + maxLength: 1000 + Description: + type: string + maxLength: 1000 + pattern: (?s).* + EnableBranchAutoDeletion: + type: boolean + EnvironmentVariables: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/EnvironmentVariable' + IAMServiceRole: + type: string + minLength: 1 + maxLength: 1000 + pattern: (?s).* + Name: + type: string + minLength: 1 + maxLength: 255 + pattern: (?s).+ + OauthToken: + type: string + maxLength: 1000 + pattern: (?s).* + Platform: + type: string + enum: + - WEB + - WEB_DYNAMIC + - WEB_COMPUTE + Repository: + type: string + pattern: (?s).* + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + JobConfig: + $ref: '#/components/schemas/JobConfig' + x-stackQL-stringOnly: true + x-title: CreateAppRequest + type: object + required: [] + CreateBranchRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AppId: + type: string + minLength: 1 + maxLength: 20 + pattern: d[a-z0-9]+ + Arn: + type: string + maxLength: 1000 + pattern: (?s).* + BasicAuthConfig: + $ref: '#/components/schemas/BasicAuthConfig' + Backend: + $ref: '#/components/schemas/Backend' + BranchName: + type: string + minLength: 1 + maxLength: 255 + pattern: (?s).+ + BuildSpec: + type: string + minLength: 1 + maxLength: 25000 + pattern: (?s).+ + ComputeRoleArn: + type: string + minLength: 0 + maxLength: 1000 + pattern: (?s).* + Description: + type: string + maxLength: 1000 + pattern: (?s).* + EnableAutoBuild: + type: boolean + EnablePerformanceMode: + type: boolean + EnablePullRequestPreview: + type: boolean + EnableSkewProtection: + type: boolean + EnvironmentVariables: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/EnvironmentVariable' + Framework: + type: string + maxLength: 255 + pattern: (?s).* + PullRequestEnvironmentName: + type: string + maxLength: 20 + pattern: (?s).* + Stage: + type: string + enum: + - EXPERIMENTAL + - BETA + - PULL_REQUEST + - PRODUCTION + - DEVELOPMENT + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateBranchRequest + type: object + required: [] + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AppId: + type: string + minLength: 1 + maxLength: 20 + pattern: d[a-z0-9]+ + Arn: + type: string + maxLength: 1000 + pattern: (?s).* + AutoSubDomainCreationPatterns: + type: array + uniqueItems: false + items: + type: string + minLength: 1 + maxLength: 2048 + pattern: (?s).+ + AutoSubDomainIAMRole: + type: string + pattern: ^$|^arn:.+:iam::\d{12}:role.+ + maxLength: 1000 + CertificateRecord: + type: string + maxLength: 1000 + Certificate: + $ref: '#/components/schemas/Certificate' + CertificateSettings: + $ref: '#/components/schemas/CertificateSettings' + DomainName: + type: string + pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$ + maxLength: 255 + DomainStatus: + type: string + UpdateStatus: + type: string + EnableAutoSubDomain: + type: boolean + StatusReason: + type: string + maxLength: 1000 + SubDomainSettings: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/SubDomainSetting' + maxItems: 255 + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: apps: name: apps id: awscc.amplify.apps x-cfn-schema-name: App - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' - AND region = 'us-east-1' - app: - name: app - id: awscc.amplify.app - x-cfn-schema-name: App - x-type: get + x-cfn-type-name: AWS::Amplify::App x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__App&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::App" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::App" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::App" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/apps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -581,6 +1330,8 @@ components: JSON_EXTRACT(Properties, '$.AutoBranchCreationConfig') as auto_branch_creation_config, JSON_EXTRACT(Properties, '$.BasicAuthConfig') as basic_auth_config, JSON_EXTRACT(Properties, '$.BuildSpec') as build_spec, + JSON_EXTRACT(Properties, '$.CacheConfig') as cache_config, + JSON_EXTRACT(Properties, '$.ComputeRoleArn') as compute_role_arn, JSON_EXTRACT(Properties, '$.CustomHeaders') as custom_headers, JSON_EXTRACT(Properties, '$.CustomRules') as custom_rules, JSON_EXTRACT(Properties, '$.DefaultDomain') as default_domain, @@ -592,12 +1343,13 @@ components: JSON_EXTRACT(Properties, '$.OauthToken') as oauth_token, JSON_EXTRACT(Properties, '$.Platform') as platform, JSON_EXTRACT(Properties, '$.Repository') as repository, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.JobConfig') as job_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::App' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -609,6 +1361,8 @@ components: json_extract_path_text(Properties, 'AutoBranchCreationConfig') as auto_branch_creation_config, json_extract_path_text(Properties, 'BasicAuthConfig') as basic_auth_config, json_extract_path_text(Properties, 'BuildSpec') as build_spec, + json_extract_path_text(Properties, 'CacheConfig') as cache_config, + json_extract_path_text(Properties, 'ComputeRoleArn') as compute_role_arn, json_extract_path_text(Properties, 'CustomHeaders') as custom_headers, json_extract_path_text(Properties, 'CustomRules') as custom_rules, json_extract_path_text(Properties, 'DefaultDomain') as default_domain, @@ -620,17 +1374,24 @@ components: json_extract_path_text(Properties, 'OauthToken') as oauth_token, json_extract_path_text(Properties, 'Platform') as platform, json_extract_path_text(Properties, 'Repository') as repository, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'JobConfig') as job_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::App' AND data__Identifier = '' AND region = 'us-east-1' - branches: - name: branches - id: awscc.amplify.branches - x-cfn-schema-name: Branch - x-type: list + apps_list_only: + name: apps_list_only + id: awscc.amplify.apps_list_only + x-cfn-schema-name: App + x-cfn-type-name: AWS::Amplify::App x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -639,7 +1400,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -647,19 +1408,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' AND region = 'us-east-1' - branch: - name: branch - id: awscc.amplify.branch + branches: + name: branches + id: awscc.amplify.branches x-cfn-schema-name: Branch - x-type: get + x-cfn-type-name: AWS::Amplify::Branch x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Branch&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::Branch" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::Branch" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::Branch" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/branches/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/branches/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/branches/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -670,10 +1479,12 @@ components: JSON_EXTRACT(Properties, '$.Backend') as backend, JSON_EXTRACT(Properties, '$.BranchName') as branch_name, JSON_EXTRACT(Properties, '$.BuildSpec') as build_spec, + JSON_EXTRACT(Properties, '$.ComputeRoleArn') as compute_role_arn, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.EnableAutoBuild') as enable_auto_build, JSON_EXTRACT(Properties, '$.EnablePerformanceMode') as enable_performance_mode, JSON_EXTRACT(Properties, '$.EnablePullRequestPreview') as enable_pull_request_preview, + JSON_EXTRACT(Properties, '$.EnableSkewProtection') as enable_skew_protection, JSON_EXTRACT(Properties, '$.EnvironmentVariables') as environment_variables, JSON_EXTRACT(Properties, '$.Framework') as framework, JSON_EXTRACT(Properties, '$.PullRequestEnvironmentName') as pull_request_environment_name, @@ -683,7 +1494,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -694,10 +1505,12 @@ components: json_extract_path_text(Properties, 'Backend') as backend, json_extract_path_text(Properties, 'BranchName') as branch_name, json_extract_path_text(Properties, 'BuildSpec') as build_spec, + json_extract_path_text(Properties, 'ComputeRoleArn') as compute_role_arn, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'EnableAutoBuild') as enable_auto_build, json_extract_path_text(Properties, 'EnablePerformanceMode') as enable_performance_mode, json_extract_path_text(Properties, 'EnablePullRequestPreview') as enable_pull_request_preview, + json_extract_path_text(Properties, 'EnableSkewProtection') as enable_skew_protection, json_extract_path_text(Properties, 'EnvironmentVariables') as environment_variables, json_extract_path_text(Properties, 'Framework') as framework, json_extract_path_text(Properties, 'PullRequestEnvironmentName') as pull_request_environment_name, @@ -706,13 +1519,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::Branch' AND data__Identifier = '' AND region = 'us-east-1' - domains: - name: domains - id: awscc.amplify.domains - x-cfn-schema-name: Domain - x-type: list + branches_list_only: + name: branches_list_only + id: awscc.amplify.branches_list_only + x-cfn-schema-name: Branch + x-cfn-type-name: AWS::Amplify::Branch x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -721,7 +1540,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -729,19 +1548,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' AND region = 'us-east-1' - domain: - name: domain - id: awscc.amplify.domain + domains: + name: domains + id: awscc.amplify.domains x-cfn-schema-name: Domain - x-type: get + x-cfn-type-name: AWS::Amplify::Domain x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Amplify::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -763,7 +1630,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -784,3 +1651,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::Domain' AND data__Identifier = '' AND region = 'us-east-1' + domains_list_only: + name: domains_list_only + id: awscc.amplify.domains_list_only + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::Amplify::Domain + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__App&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApp + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Branch&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBranch + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBranchRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/amplifyuibuilder.yaml b/providers/src/awscc/v00.00.00000/services/amplifyuibuilder.yaml index 202d3365..ff9e94d7 100644 --- a/providers/src/awscc/v00.00.00000/services/amplifyuibuilder.yaml +++ b/providers/src/awscc/v00.00.00000/services/amplifyuibuilder.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: AmplifyUIBuilder - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ActionParameters: type: object @@ -347,7 +727,9 @@ components: items: $ref: '#/components/schemas/ComponentVariant' x-stackql-resource-name: component - x-stackql-primaryIdentifier: + description: Definition of AWS::AmplifyUIBuilder::Component Resource Type + x-type-name: AWS::AmplifyUIBuilder::Component + x-stackql-primary-identifier: - AppId - EnvironmentName - Id @@ -358,6 +740,15 @@ components: - CreatedAt - Id - ModifiedAt + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - amplifyuibuilder:TagResource + - amplifyuibuilder:UntagResource x-required-permissions: create: - amplify:GetApp @@ -719,7 +1110,9 @@ components: Tags: $ref: '#/components/schemas/Tags' x-stackql-resource-name: form - x-stackql-primaryIdentifier: + description: Definition of AWS::AmplifyUIBuilder::Form Resource Type + x-type-name: AWS::AmplifyUIBuilder::Form + x-stackql-primary-identifier: - AppId - EnvironmentName - Id @@ -728,17 +1121,24 @@ components: - EnvironmentName x-read-only-properties: - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - amplifyuibuilder:TagResource + - amplifyuibuilder:UntagResource x-required-permissions: create: - amplify:GetApp - amplifyuibuilder:CreateForm - amplifyuibuilder:GetForm - amplifyuibuilder:TagResource - - amplifyuibuilder:UntagResource read: - amplify:GetApp - amplifyuibuilder:GetForm - - amplifyuibuilder:TagResource update: - amplify:GetApp - amplifyuibuilder:GetForm @@ -748,7 +1148,6 @@ components: delete: - amplify:GetApp - amplifyuibuilder:DeleteForm - - amplifyuibuilder:TagResource - amplifyuibuilder:UntagResource list: - amplify:GetApp @@ -801,7 +1200,9 @@ components: items: $ref: '#/components/schemas/ThemeValues' x-stackql-resource-name: theme - x-stackql-primaryIdentifier: + description: Definition of AWS::AmplifyUIBuilder::Theme Resource Type + x-type-name: AWS::AmplifyUIBuilder::Theme + x-stackql-primary-identifier: - AppId - EnvironmentName - Id @@ -812,6 +1213,15 @@ components: - CreatedAt - Id - ModifiedAt + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - amplifyuibuilder:TagResource + - amplifyuibuilder:UntagResource x-required-permissions: create: - amplify:GetApp @@ -834,51 +1244,224 @@ components: list: - amplify:GetApp - amplifyuibuilder:ListThemes + CreateComponentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AppId: + type: string + BindingProperties: + $ref: '#/components/schemas/ComponentBindingProperties' + Children: + type: array + items: + $ref: '#/components/schemas/ComponentChild' + CollectionProperties: + $ref: '#/components/schemas/ComponentCollectionProperties' + ComponentType: + type: string + maxLength: 255 + minLength: 1 + CreatedAt: + type: string + format: date-time + EnvironmentName: + type: string + Events: + $ref: '#/components/schemas/ComponentEvents' + Id: + type: string + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + Overrides: + $ref: '#/components/schemas/ComponentOverrides' + Properties: + $ref: '#/components/schemas/ComponentProperties' + SchemaVersion: + type: string + SourceId: + type: string + Tags: + $ref: '#/components/schemas/Tags' + Variants: + type: array + items: + $ref: '#/components/schemas/ComponentVariant' + x-stackQL-stringOnly: true + x-title: CreateComponentRequest + type: object + required: [] + CreateFormRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AppId: + type: string + Cta: + $ref: '#/components/schemas/FormCTA' + DataType: + $ref: '#/components/schemas/FormDataTypeConfig' + EnvironmentName: + type: string + Fields: + $ref: '#/components/schemas/FieldsMap' + FormActionType: + $ref: '#/components/schemas/FormActionType' + Id: + type: string + LabelDecorator: + $ref: '#/components/schemas/LabelDecorator' + Name: + type: string + maxLength: 255 + minLength: 1 + SchemaVersion: + type: string + SectionalElements: + $ref: '#/components/schemas/SectionalElementMap' + Style: + $ref: '#/components/schemas/FormStyle' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateFormRequest + type: object + required: [] + CreateThemeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AppId: + type: string + CreatedAt: + type: string + format: date-time + EnvironmentName: + type: string + Id: + type: string + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + Overrides: + type: array + items: + $ref: '#/components/schemas/ThemeValues' + Tags: + $ref: '#/components/schemas/Tags' + Values: + type: array + items: + $ref: '#/components/schemas/ThemeValues' + x-stackQL-stringOnly: true + x-title: CreateThemeRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: components: name: components id: awscc.amplifyuibuilder.components x-cfn-schema-name: Component - x-type: list - x-identifiers: - - AppId - - EnvironmentName - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppId') as app_id, - JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' - AND region = 'us-east-1' - component: - name: component - id: awscc.amplifyuibuilder.component - x-cfn-schema-name: Component - x-type: get + x-cfn-type-name: AWS::AmplifyUIBuilder::Component x-identifiers: - AppId - EnvironmentName - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Component&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Component" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Component" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Component" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/components/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/components/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/components/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -904,7 +1487,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -929,15 +1512,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' AND data__Identifier = '||' AND region = 'us-east-1' - forms: - name: forms - id: awscc.amplifyuibuilder.forms - x-cfn-schema-name: Form - x-type: list + components_list_only: + name: components_list_only + id: awscc.amplifyuibuilder.components_list_only + x-cfn-schema-name: Component + x-cfn-type-name: AWS::AmplifyUIBuilder::Component x-identifiers: - AppId - EnvironmentName - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -948,7 +1537,7 @@ components: JSON_EXTRACT(Properties, '$.AppId') as app_id, JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -958,21 +1547,69 @@ components: json_extract_path_text(Properties, 'AppId') as app_id, json_extract_path_text(Properties, 'EnvironmentName') as environment_name, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' AND region = 'us-east-1' - form: - name: form - id: awscc.amplifyuibuilder.form + forms: + name: forms + id: awscc.amplifyuibuilder.forms x-cfn-schema-name: Form - x-type: get + x-cfn-type-name: AWS::AmplifyUIBuilder::Form x-identifiers: - AppId - EnvironmentName - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Form&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Form" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Form" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Form" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/forms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/forms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/forms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -994,7 +1631,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1015,15 +1652,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' AND data__Identifier = '||' AND region = 'us-east-1' - themes: - name: themes - id: awscc.amplifyuibuilder.themes - x-cfn-schema-name: Theme - x-type: list + forms_list_only: + name: forms_list_only + id: awscc.amplifyuibuilder.forms_list_only + x-cfn-schema-name: Form + x-cfn-type-name: AWS::AmplifyUIBuilder::Form x-identifiers: - AppId - EnvironmentName - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1034,7 +1677,7 @@ components: JSON_EXTRACT(Properties, '$.AppId') as app_id, JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1044,21 +1687,69 @@ components: json_extract_path_text(Properties, 'AppId') as app_id, json_extract_path_text(Properties, 'EnvironmentName') as environment_name, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' AND region = 'us-east-1' - theme: - name: theme - id: awscc.amplifyuibuilder.theme + themes: + name: themes + id: awscc.amplifyuibuilder.themes x-cfn-schema-name: Theme - x-type: get + x-cfn-type-name: AWS::AmplifyUIBuilder::Theme x-identifiers: - AppId - EnvironmentName - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Theme&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Theme" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Theme" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AmplifyUIBuilder::Theme" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/themes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/themes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/themes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1076,7 +1767,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1093,3 +1784,319 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' AND data__Identifier = '||' AND region = 'us-east-1' + themes_list_only: + name: themes_list_only + id: awscc.amplifyuibuilder.themes_list_only + x-cfn-schema-name: Theme + x-cfn-type-name: AWS::AmplifyUIBuilder::Theme + x-identifiers: + - AppId + - EnvironmentName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AppId') as app_id, + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Component&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComponent + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComponentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Form&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateForm + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFormRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Theme&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTheme + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThemeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/apigateway.yaml b/providers/src/awscc/v00.00.00000/services/apigateway.yaml index 263acf7c..75178ed8 100644 --- a/providers/src/awscc/v00.00.00000/services/apigateway.yaml +++ b/providers/src/awscc/v00.00.00000/services/apigateway.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ApiGateway - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Account: type: object @@ -12,34 +392,39 @@ components: description: '' type: string CloudWatchRoleArn: - description: The ARN of an Amazon CloudWatch role for the current Account. + description: '' type: string x-stackql-resource-name: account - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account. + x-type-name: AWS::ApiGateway::Account + x-stackql-primary-identifier: - Id x-read-only-properties: - Id + x-tagging: + taggable: false x-required-permissions: + read: + - apigateway:GET create: - apigateway:PATCH - iam:GetRole - iam:PassRole - read: - - apigateway:GET update: - apigateway:PATCH - iam:GetRole - iam:PassRole - delete: [] + delete: + - apigateway:PATCH StageKey: type: object additionalProperties: false properties: RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string StageName: - description: The stage name associated with the stage key. + description: '' type: string description: '``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.' Tag: @@ -53,6 +438,7 @@ components: required: - Value - Key + description: '' ApiKey: type: object properties: @@ -60,17 +446,17 @@ components: description: '' type: string CustomerId: - description: An MKT customer identifier, when integrating with the AWS SaaS Marketplace. + description: '' type: string Description: - description: The description of the ApiKey. + description: '' type: string Enabled: - description: Specifies whether the ApiKey can be used by callers. + description: '' default: false type: boolean GenerateDistinctId: - description: Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used. + description: '' type: boolean Name: description: |- @@ -78,29 +464,43 @@ components: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. type: string StageKeys: - description: DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. + description: '' type: array uniqueItems: true items: $ref: '#/components/schemas/StageKey' Tags: - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. + description: '' type: array uniqueItems: false items: $ref: '#/components/schemas/Tag' Value: - description: Specifies a value of the API key. + description: '' type: string x-stackql-resource-name: api_key - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key. + x-type-name: AWS::ApiGateway::ApiKey + x-stackql-primary-identifier: - APIKeyId x-create-only-properties: - GenerateDistinctId - Name - Value + x-write-only-properties: + - GenerateDistinctId x-read-only-properties: - APIKeyId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -122,61 +522,65 @@ components: type: object properties: RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string AuthorizerId: type: string description: '' AuthType: - description: Optional customer-defined field, used in OpenAPI imports and exports without functional impact. + description: '' type: string AuthorizerCredentials: - description: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. + description: '' type: string AuthorizerResultTtlInSeconds: - description: The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. + description: '' type: integer AuthorizerUri: - description: >- - Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, - ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``. + description: '' type: string IdentitySource: - description: >- - The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a - comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not - null and non-empty. Only when thi + description: '' type: string IdentityValidationExpression: - description: >- - A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to - the ``REQUEST`` authorizer. + description: '' type: string Name: - description: The name of the authorizer. + description: '' type: string ProviderARNs: - description: 'A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.' + description: '' type: array uniqueItems: true items: type: string x-insertionOrder: false Type: - description: The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool. + description: '' type: string required: - RestApiId - Type - Name x-stackql-resource-name: authorizer - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. + x-type-name: AWS::ApiGateway::Authorizer + x-stackql-primary-identifier: - RestApiId - AuthorizerId x-create-only-properties: - RestApiId x-read-only-properties: - AuthorizerId + x-required-properties: + - RestApiId + - Type + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - apigateway:POST @@ -196,25 +600,87 @@ components: properties: BasePath: type: string - description: The base path name that callers of the API must provide as part of the URL after the domain name. + description: '' DomainName: type: string - description: The domain name of the BasePathMapping resource to be described. + description: '' RestApiId: type: string - description: The string identifier of the associated RestApi. + description: '' Stage: type: string - description: The name of the associated stage. + description: '' required: - DomainName x-stackql-resource-name: base_path_mapping - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL. + x-type-name: AWS::ApiGateway::BasePathMapping + x-stackql-primary-identifier: - DomainName - BasePath x-create-only-properties: - DomainName - BasePath + x-required-properties: + - DomainName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - apigateway:POST + - apigateway:GET + read: + - apigateway:GET + update: + - apigateway:GET + - apigateway:DELETE + - apigateway:PATCH + delete: + - apigateway:DELETE + list: + - apigateway:GET + BasePathMappingV2: + type: object + properties: + BasePath: + type: string + description: The base path name that callers of the API must provide in the URL after the domain name. + DomainNameArn: + type: string + description: The Arn of an AWS::ApiGateway::DomainNameV2 resource. + RestApiId: + type: string + description: The ID of the API. + Stage: + type: string + description: The name of the API's stage. + BasePathMappingArn: + type: string + description: Amazon Resource Name (ARN) of the resource. + required: + - DomainNameArn + - RestApiId + x-stackql-resource-name: base_path_mapping_v2 + description: Resource Type definition for AWS::ApiGateway::BasePathMappingV2 + x-type-name: AWS::ApiGateway::BasePathMappingV2 + x-stackql-primary-identifier: + - BasePathMappingArn + x-create-only-properties: + - DomainNameArn + - BasePath + x-read-only-properties: + - BasePathMappingArn + x-required-properties: + - DomainNameArn + - RestApiId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - apigateway:POST @@ -236,19 +702,31 @@ components: description: '' type: string Description: - description: The description of the client certificate. + description: '' type: string Tags: - description: The collection of tags. Each tag element is associated with a given resource. + description: '' type: array uniqueItems: false items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: client_certificate - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint. + x-type-name: AWS::ApiGateway::ClientCertificate + x-stackql-primary-identifier: - ClientCertificateId x-read-only-properties: - ClientCertificateId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -265,249 +743,255 @@ components: - apigateway:DELETE list: - apigateway:GET - StageDescription: + MethodSetting: + description: |- + The ``MethodSetting`` property type configures settings for all methods in a stage. + The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types. type: object additionalProperties: false properties: - AccessLogSetting: - description: Specifies settings for logging access in this stage. - $ref: '#/components/schemas/AccessLogSetting' - CacheClusterEnabled: - description: Specifies whether a cache cluster is enabled for the stage. - type: boolean - CacheClusterSize: - description: The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*. - type: string CacheDataEncrypted: - description: Indicates whether the cached responses are encrypted. + description: '' type: boolean CacheTtlInSeconds: - description: The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. + description: '' type: integer CachingEnabled: - description: Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*. + description: '' + type: boolean + DataTraceEnabled: + description: '' + type: boolean + HttpMethod: + description: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``. + type: string + LoggingLevel: + description: '' + type: string + MetricsEnabled: + description: '' type: boolean + ResourcePath: + description: >- + The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a + ``MethodSetting``. + type: string + ThrottlingBurstLimit: + description: '' + type: integer + minimum: 0 + ThrottlingRateLimit: + description: '' + type: number + minimum: 0 + StageDescription: + description: '``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.' + additionalProperties: false + type: object + properties: + CacheTtlInSeconds: + description: The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. + type: integer + Description: + description: A description of the purpose of the stage. + type: string + LoggingLevel: + description: The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*. + type: string CanarySetting: description: Specifies settings for the canary deployment in this stage. $ref: '#/components/schemas/CanarySetting' + ThrottlingRateLimit: + description: The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. + type: number ClientCertificateId: description: The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. type: string - DataTraceEnabled: - description: Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. - type: boolean - Description: - description: A description of the purpose of the stage. - type: string + Variables: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: 'A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.' + additionalProperties: false + type: object DocumentationVersion: description: The version identifier of the API documentation snapshot. type: string - LoggingLevel: - description: The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*. - type: string + CacheDataEncrypted: + description: Indicates whether the cached responses are encrypted. + type: boolean + DataTraceEnabled: + description: Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. + type: boolean + ThrottlingBurstLimit: + description: The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. + type: integer + CachingEnabled: + description: Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*. + type: boolean + TracingEnabled: + description: |- + Specifies whether active tracing with X-ray is enabled for this stage. + For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*. + type: boolean MethodSettings: - description: Configures settings for all of the stage's methods. - type: array uniqueItems: true + description: Configures settings for all of the stage's methods. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/MethodSetting' + AccessLogSetting: + description: Specifies settings for logging access in this stage. + $ref: '#/components/schemas/AccessLogSetting' + CacheClusterSize: + description: The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*. + type: string MetricsEnabled: description: Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. type: boolean Tags: - description: An array of arbitrary tags (key-value pairs) to associate with the stage. - type: array uniqueItems: false + description: An array of arbitrary tags (key-value pairs) to associate with the stage. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - ThrottlingBurstLimit: - description: The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. - type: integer - ThrottlingRateLimit: - description: The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. - type: number - TracingEnabled: - description: |- - Specifies whether active tracing with X-ray is enabled for this stage. - For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*. + CacheClusterEnabled: + description: '' type: boolean - Variables: - description: 'A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.' - type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - description: '``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.' - DeploymentCanarySettings: + CanarySetting: + description: '' type: object additionalProperties: false properties: + DeploymentId: + description: '' + type: string PercentTraffic: - description: The percentage (0.0-100.0) of traffic routed to the canary deployment. + description: '' type: number + minimum: 0 + maximum: 100 StageVariableOverrides: - description: A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. + description: '' type: object additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string UseStageCache: - description: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. + description: '' type: boolean + DeploymentCanarySettings: description: The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment. - AccessLogSetting: - description: |- - The ``AccessLogSetting`` property type specifies settings for logging access in this stage. - ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource. - type: object additionalProperties: false - properties: - DestinationArn: - description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. - type: string - Format: - description: A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. - type: string - CanarySetting: - description: Configuration settings of a canary deployment. type: object - additionalProperties: false properties: - DeploymentId: - description: The ID of the canary deployment. - type: string - PercentTraffic: - description: The percent (0-100) of traffic diverted to a canary deployment. - type: number - minimum: 0 - maximum: 100 StageVariableOverrides: - description: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string + description: '' + additionalProperties: false + type: object + PercentTraffic: + description: '' + type: number UseStageCache: - description: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. + description: '' type: boolean - MethodSetting: + AccessLogSetting: description: |- - The ``MethodSetting`` property type configures settings for all methods in a stage. - The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types. + The ``AccessLogSetting`` property type specifies settings for logging access in this stage. + ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource. type: object additionalProperties: false properties: - CacheDataEncrypted: - description: Specifies whether the cached responses are encrypted. - type: boolean - CacheTtlInSeconds: - description: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. - type: integer - CachingEnabled: - description: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. - type: boolean - DataTraceEnabled: - description: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. - type: boolean - HttpMethod: - description: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``. - type: string - LoggingLevel: - description: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events. + DestinationArn: + description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. type: string - MetricsEnabled: - description: Specifies whether Amazon CloudWatch metrics are enabled for this method. - type: boolean - ResourcePath: - description: >- - The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a - ``MethodSetting``. + Format: + description: A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. type: string - ThrottlingBurstLimit: - description: Specifies the throttling burst limit. - type: integer - minimum: 0 - ThrottlingRateLimit: - description: Specifies the throttling rate limit. - type: number - minimum: 0 Deployment: type: object properties: DeploymentId: - type: string description: '' - DeploymentCanarySettings: - $ref: '#/components/schemas/DeploymentCanarySettings' - description: The input configuration for a canary deployment. - Description: type: string - description: The description for the Deployment resource to create. - RestApiId: + Description: + description: '' type: string - description: The string identifier of the associated RestApi. StageDescription: - $ref: '#/components/schemas/StageDescription' description: The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name. + $ref: '#/components/schemas/StageDescription' StageName: + description: '' + type: string + RestApiId: + description: '' type: string - description: The name of the Stage resource for the Deployment resource to create. + DeploymentCanarySettings: + description: '' + $ref: '#/components/schemas/DeploymentCanarySettings' required: - RestApiId x-stackql-resource-name: deployment - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment. + x-type-name: AWS::ApiGateway::Deployment + x-stackql-primary-identifier: - DeploymentId - RestApiId x-create-only-properties: - DeploymentCanarySettings - RestApiId + x-write-only-properties: + - StageName + - StageDescription + - DeploymentCanarySettings x-read-only-properties: - DeploymentId + x-required-properties: + - RestApiId + x-tagging: + taggable: false x-required-permissions: + read: + - apigateway:GET create: - apigateway:POST - apigateway:PATCH - apigateway:PUT - apigateway:GET - read: - - apigateway:GET update: - apigateway:PATCH - apigateway:GET - apigateway:PUT - apigateway:DELETE + list: + - apigateway:GET delete: - apigateway:GET - apigateway:DELETE - list: - - apigateway:GET Location: type: object additionalProperties: false properties: Method: - description: >- - The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the - parent entity exactly. + description: '' type: string Name: - description: The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type. + description: '' type: string Path: - description: >- - The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute - must match that of the parent entity as a prefix. + description: '' type: string StatusCode: - description: The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly. + description: '' type: string Type: - description: The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type. + description: '' type: string enum: - API @@ -532,20 +1016,22 @@ components: description: '' type: string Location: - description: The location of the targeted API entity of the to-be-created documentation part. + description: '' $ref: '#/components/schemas/Location' Properties: - description: The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published. + description: '' type: string RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string required: - Location - Properties - RestApiId x-stackql-resource-name: documentation_part - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGateway::DocumentationPart + x-stackql-primary-identifier: - DocumentationPartId - RestApiId x-create-only-properties: @@ -553,6 +1039,12 @@ components: - RestApiId x-read-only-properties: - DocumentationPartId + x-required-properties: + - Location + - Properties + - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:GET @@ -570,26 +1062,33 @@ components: type: object properties: Description: - description: A description about the new documentation snapshot. + description: '' type: string DocumentationVersion: - description: The version identifier of the to-be-updated documentation version. + description: '' type: string minLength: 1 RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string minLength: 1 required: - DocumentationVersion - RestApiId x-stackql-resource-name: documentation_version - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGateway::DocumentationVersion + x-stackql-primary-identifier: - DocumentationVersion - RestApiId x-create-only-properties: - DocumentationVersion - RestApiId + x-required-properties: + - DocumentationVersion + - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:GET @@ -604,82 +1103,266 @@ components: list: - apigateway:GET EndpointConfiguration: - type: object + description: |- + The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. + ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource. additionalProperties: false + type: object properties: + IpAddressType: + description: '' + type: string Types: - type: array uniqueItems: true + description: '' + type: array items: type: string - description: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``. VpcEndpointIds: - type: array uniqueItems: true + description: '' + type: array items: + relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/Id type: string - description: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type. - description: |- - The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. - ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource. MutualTlsAuthentication: type: object properties: TruststoreUri: type: string + description: '' TruststoreVersion: type: string + description: '' additionalProperties: false + description: '' DomainName: type: object properties: DomainName: type: string + description: '' + DomainNameArn: + type: string + description: '' DistributionDomainName: type: string + description: '' DistributionHostedZoneId: type: string + description: '' EndpointConfiguration: $ref: '#/components/schemas/EndpointConfiguration' + description: '' MutualTlsAuthentication: $ref: '#/components/schemas/MutualTlsAuthentication' + description: '' RegionalDomainName: type: string + description: '' RegionalHostedZoneId: type: string + description: '' CertificateArn: type: string + description: '' RegionalCertificateArn: type: string + description: '' OwnershipVerificationCertificateArn: type: string + description: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn. SecurityPolicy: type: string + description: '' + RoutingMode: + type: string + description: '' + default: BASE_PATH_MAPPING_ONLY + enum: + - BASE_PATH_MAPPING_ONLY + - ROUTING_RULE_THEN_BASE_PATH_MAPPING + - ROUTING_RULE_ONLY Tags: type: array items: $ref: '#/components/schemas/Tag' + description: '' x-stackql-resource-name: domain_name - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ApiGateway::DomainName`` resource specifies a custom domain name for your API in API Gateway. + You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGateway::DomainName + x-stackql-primary-identifier: - DomainName x-create-only-properties: - DomainName x-read-only-properties: + - DomainNameArn - RegionalHostedZoneId - DistributionDomainName - RegionalDomainName - DistributionHostedZoneId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - apigateway:POST + - apigateway:PUT + - apigateway:GET + read: + - apigateway:GET + update: + - apigateway:GET + - apigateway:PUT + - apigateway:PATCH + delete: + - apigateway:GET + - apigateway:DELETE + list: + - apigateway:GET + DomainNameAccessAssociation: + type: object + properties: + DomainNameAccessAssociationArn: + type: string + description: The amazon resource name (ARN) of the domain name access association resource. + DomainNameArn: + type: string + description: The amazon resource name (ARN) of the domain name resource. + AccessAssociationSource: + type: string + description: The source of the domain name access association resource. + AccessAssociationSourceType: + type: string + description: The source type of the domain name access association resource. + enum: + - VPCE + Tags: + description: An array of arbitrary tags (key-value pairs) to associate with the domainname access association. + uniqueItems: false + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - DomainNameArn + - AccessAssociationSource + - AccessAssociationSourceType + x-stackql-resource-name: domain_name_access_association + description: Resource Type definition for AWS::ApiGateway::DomainNameAccessAssociation. + x-type-name: AWS::ApiGateway::DomainNameAccessAssociation + x-stackql-primary-identifier: + - DomainNameAccessAssociationArn + x-create-only-properties: + - DomainNameArn + - AccessAssociationSource + - AccessAssociationSourceType + - Tags + x-read-only-properties: + - DomainNameAccessAssociationArn + x-required-properties: + - DomainNameArn + - AccessAssociationSource + - AccessAssociationSourceType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:POST + - apigateway:DELETE + - apigateway:GET + x-required-permissions: + create: + - apigateway:POST + - apigateway:GET + read: + - apigateway:GET + delete: + - apigateway:DELETE + - apigateway:GET + list: + - apigateway:GET + DomainNameV2: + type: object + properties: + CertificateArn: + type: string + DomainName: + type: string + EndpointConfiguration: + $ref: '#/components/schemas/EndpointConfiguration' + SecurityPolicy: + type: string + Policy: + type: object + DomainNameId: + type: string + DomainNameArn: + type: string + description: The amazon resource name (ARN) of the domain name resource. + RoutingMode: + type: string + description: The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid. + default: BASE_PATH_MAPPING_ONLY + enum: + - BASE_PATH_MAPPING_ONLY + - ROUTING_RULE_THEN_BASE_PATH_MAPPING + - ROUTING_RULE_ONLY + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: domain_name_v2 + description: Resource Type definition for AWS::ApiGateway::DomainNameV2. + x-type-name: AWS::ApiGateway::DomainNameV2 + x-stackql-primary-identifier: + - DomainNameArn + x-create-only-properties: + - DomainName + - SecurityPolicy + - EndpointConfiguration + x-read-only-properties: + - DomainNameId + - DomainNameArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:PATCH + - apigateway:DELETE + - apigateway:GET + - apigateway:POST x-required-permissions: create: - - apigateway:* + - apigateway:POST + - apigateway:GET + - apigateway:UpdateDomainNamePolicy read: - - apigateway:* + - apigateway:GET update: - - apigateway:* + - apigateway:GET + - apigateway:PUT + - apigateway:PATCH + - apigateway:UpdateDomainNamePolicy delete: - - apigateway:* + - apigateway:DELETE + - apigateway:GET + - apigateway:UpdateDomainNamePolicy list: - - apigateway:* + - apigateway:GET GatewayResponse: type: object properties: @@ -687,23 +1370,23 @@ components: description: '' type: string RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string ResponseType: - description: The response type of the associated GatewayResponse. + description: '' type: string StatusCode: - description: The HTTP status code for this GatewayResponse. + description: '' type: string ResponseParameters: - description: Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. + description: '' type: object additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string ResponseTemplates: - description: Response templates of the GatewayResponse as a string-to-string map of key-value pairs. + description: '' type: object additionalProperties: false x-patternProperties: @@ -713,17 +1396,26 @@ components: - ResponseType - RestApiId x-stackql-resource-name: gateway_response - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::GatewayResponse`` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGateway::GatewayResponse + x-stackql-primary-identifier: - Id x-create-only-properties: - ResponseType - RestApiId x-read-only-properties: - Id + x-required-properties: + - ResponseType + - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:PUT - apigateway:GET + read: + - apigateway:GET update: - apigateway:GET - apigateway:PUT @@ -732,82 +1424,75 @@ components: - apigateway:DELETE list: - apigateway:GET - Integration: - type: object + MethodResponse: + description: '' additionalProperties: false + type: object properties: - CacheKeyParameters: - description: A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``. - type: array - uniqueItems: true - items: - type: string - CacheNamespace: - description: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources. + ResponseParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: boolean + description: '' + additionalProperties: false + type: object + StatusCode: + description: '' type: string - ConnectionId: - description: The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise. + ResponseModels: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: '' + additionalProperties: false + type: object + required: + - StatusCode + Integration: + description: '``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.' + additionalProperties: false + type: object + properties: + CacheNamespace: + description: '' type: string ConnectionType: - description: The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``. + description: '' type: string enum: - INTERNET - VPC_LINK - ContentHandling: - description: |- - Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: - If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the ``passthroughBehavior`` is configured to support payload pass-through. - type: string - enum: - - CONVERT_TO_BINARY - - CONVERT_TO_TEXT - Credentials: - description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\*:user/\*``. To use resource-based permissions on supported AWS services, specify null. - type: string - IntegrationHttpMethod: - description: Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property. - type: string IntegrationResponses: - description: Specifies the integration's responses. - type: array uniqueItems: true + description: '' + type: array items: $ref: '#/components/schemas/IntegrationResponse' + IntegrationHttpMethod: + description: '' + type: string + Uri: + description: '' + type: string PassthroughBehavior: - description: >- - Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without - transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 - Unsupported Media Type response + description: '' type: string enum: - WHEN_NO_MATCH - WHEN_NO_TEMPLATES - NEVER RequestParameters: - description: >- - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and - ``name`` must be a valid and unique method request parameter name. - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string - RequestTemplates: - description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. - type: object + description: '' additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - TimeoutInMillis: - description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. - type: integer - minimum: 50 + type: object + ConnectionId: + description: '' + type: string Type: - description: |- - Specifies an API method integration type. The valid value is one of the following: - For the HTTP and HTTP proxy integrations, each integration can specify a protocol (``http/https``), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a ``connectionType`` of ``VPC_LINK`` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. + description: '' type: string enum: - AWS @@ -815,151 +1500,132 @@ components: - HTTP - HTTP_PROXY - MOCK - Uri: - description: |- - Specifies Uniform Resource Identifier (URI) of the integration endpoint. - For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_ap + CacheKeyParameters: + uniqueItems: true + description: '' + type: array + items: + type: string + ContentHandling: + description: '' type: string - required: - - Type - description: '``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.' - MethodResponse: - type: object - additionalProperties: false - properties: - ResponseModels: - description: Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. - type: object - additionalProperties: false + enum: + - CONVERT_TO_BINARY + - CONVERT_TO_TEXT + RequestTemplates: x-patternProperties: '[a-zA-Z0-9]+': type: string - ResponseParameters: - description: >- - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to - the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.) - type: object + description: '' additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: boolean - StatusCode: - description: The method response's status code. + type: object + TimeoutInMillis: + description: '' + type: integer + minimum: 50 + Credentials: + description: '' type: string required: - - StatusCode - description: Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. + - Type IntegrationResponse: - type: object + description: '``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method''s backend finishes processing a request.' additionalProperties: false + type: object properties: + ResponseTemplates: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: '' + additionalProperties: false + type: object + SelectionPattern: + description: '' + type: string ContentHandling: - description: |- - Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: - If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. + description: '' type: string enum: - CONVERT_TO_BINARY - CONVERT_TO_TEXT ResponseParameters: - description: >- - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value - must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix. - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string - ResponseTemplates: - description: Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. - type: object + description: '' additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - SelectionPattern: - description: >- - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other - HTTP and AWS back ends, the HTTP status code is matched. - type: string + type: object StatusCode: - description: Specifies the status code that is used to map the integration response to an existing MethodResponse. + description: '' type: string required: - StatusCode - description: '``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method''s backend finishes processing a request.' Method: type: object properties: - ApiKeyRequired: - description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. - type: boolean - AuthorizationScopes: - description: >- - A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide - an access token instead of an identity token for authorization purposes. - type: array - items: - type: string - AuthorizationType: - description: |- - The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. - If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. - type: string - enum: - - NONE - - AWS_IAM - - CUSTOM - - COGNITO_USER_POOLS - AuthorizerId: - description: The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``. - type: string - HttpMethod: - description: The method's HTTP verb. - type: string Integration: - description: Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration. + description: '' $ref: '#/components/schemas/Integration' - MethodResponses: - description: Gets a method response associated with a given HTTP status code. - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/MethodResponse' OperationName: - description: A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example. + description: '' type: string RequestModels: - description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string - RequestParameters: - description: >- - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter - names defined here are available in Integration to be mapped to integration request parameters or templates. - type: object + description: '' additionalProperties: false + type: object + RestApiId: + description: '' + type: string + AuthorizationScopes: + description: '' + type: array + items: + type: string + RequestValidatorId: + description: '' + type: string + RequestParameters: x-patternProperties: '[a-zA-Z0-9]+': type: boolean - RequestValidatorId: - description: The identifier of a RequestValidator for request validation. + description: '' + additionalProperties: false + type: object + MethodResponses: + uniqueItems: true + description: '' + type: array + items: + $ref: '#/components/schemas/MethodResponse' + AuthorizerId: + description: '' type: string ResourceId: - description: The Resource identifier for the MethodResponse resource. + description: '' type: string - RestApiId: - description: The string identifier of the associated RestApi. + ApiKeyRequired: + description: '' + type: boolean + AuthorizationType: + description: |- + The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. + If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. + type: string + HttpMethod: + description: '' type: string required: - RestApiId - ResourceId - HttpMethod x-stackql-resource-name: method - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests. + x-type-name: AWS::ApiGateway::Method + x-stackql-primary-identifier: - RestApiId - ResourceId - HttpMethod @@ -967,13 +1633,22 @@ components: - RestApiId - ResourceId - HttpMethod + x-required-properties: + - RestApiId + - ResourceId + - HttpMethod + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - apigateway:GET create: - apigateway:PUT - apigateway:GET - iam:PassRole - read: - - apigateway:GET update: - apigateway:GET - apigateway:DELETE @@ -986,10 +1661,10 @@ components: properties: ContentType: type: string - description: The content-type for the model. + description: '' Description: type: string - description: The description of the model. + description: '' Name: type: string description: |- @@ -997,20 +1672,26 @@ components: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. RestApiId: type: string - description: The string identifier of the associated RestApi. + description: '' Schema: - description: The schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail. + description: '' type: object required: - RestApiId x-stackql-resource-name: model - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method. + x-type-name: AWS::ApiGateway::Model + x-stackql-primary-identifier: - RestApiId - Name x-create-only-properties: - ContentType - Name - RestApiId + x-required-properties: + - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -1032,21 +1713,23 @@ components: description: '' type: string Name: - description: The name of this RequestValidator + description: '' type: string RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string ValidateRequestBody: - description: A Boolean flag to indicate whether to validate a request body according to the configured Model schema. + description: '' type: boolean ValidateRequestParameters: - description: A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``). + description: '' type: boolean required: - RestApiId x-stackql-resource-name: request_validator - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGateway::RequestValidator + x-stackql-primary-identifier: - RestApiId - RequestValidatorId x-create-only-properties: @@ -1054,6 +1737,10 @@ components: - RestApiId x-read-only-properties: - RequestValidatorId + x-required-properties: + - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -1070,24 +1757,26 @@ components: Resource: type: object properties: - ResourceId: + ParentId: description: '' type: string - RestApiId: - description: The string identifier of the associated RestApi. + PathPart: + description: '' type: string - ParentId: - description: The parent resource's identifier. + ResourceId: + description: '' type: string - PathPart: - description: The last path segment for this resource. + RestApiId: + description: '' type: string required: - ParentId - PathPart - RestApiId x-stackql-resource-name: resource - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Resource`` resource creates a resource in an API. + x-type-name: AWS::ApiGateway::Resource + x-stackql-primary-identifier: - RestApiId - ResourceId x-create-only-properties: @@ -1096,6 +1785,12 @@ components: - RestApiId x-read-only-properties: - ResourceId + x-required-properties: + - ParentId + - PathPart + - RestApiId + x-tagging: + taggable: false x-required-permissions: read: - apigateway:GET @@ -1104,76 +1799,55 @@ components: update: - apigateway:GET - apigateway:PATCH - delete: - - apigateway:DELETE list: - apigateway:GET + delete: + - apigateway:DELETE S3Location: - type: object + description: |- + ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. + On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. additionalProperties: false + type: object properties: Bucket: - type: string description: The name of the S3 bucket where the OpenAPI file is stored. - ETag: type: string + ETag: description: The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file. - Version: type: string + Version: description: For versioning-enabled buckets, a specific version of the OpenAPI file. - Key: type: string + Key: description: The file name of the OpenAPI file (Amazon S3 object name). - description: |- - ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. - On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. + type: string RestApi: type: object properties: - RestApiId: - type: string - description: '' - RootResourceId: - type: string - description: '' - ApiKeySourceType: - type: string - description: 'The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.' - BinaryMediaTypes: - type: array - uniqueItems: true - items: - type: string - description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. - Body: + Policy: + description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. type: object - description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. BodyS3Location: - $ref: '#/components/schemas/S3Location' description: The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. - CloneFrom: - type: string - description: The ID of the RestApi that you want to clone from. - EndpointConfiguration: - $ref: '#/components/schemas/EndpointConfiguration' - description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/S3Location' Description: + description: '' type: string - description: The description of the RestApi. - DisableExecuteApiEndpoint: - type: boolean - description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint - FailOnWarnings: - type: boolean - description: A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``. - Name: - type: string - description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. MinimumCompressionSize: + description: '' type: integer - description: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. - Mode: + Parameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: '' + additionalProperties: false + type: object + CloneFrom: + description: '' type: string + Mode: description: |- This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. @@ -1181,29 +1855,73 @@ components: For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. - Policy: - type: object - description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. - Parameters: + type: string + RestApiId: + description: '' + type: string + DisableExecuteApiEndpoint: + description: '' + type: boolean + FailOnWarnings: + description: '' + type: boolean + BinaryMediaTypes: + uniqueItems: true + description: '' + type: array + items: + type: string + Name: + description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. + type: string + RootResourceId: + description: '' + type: string + ApiKeySourceType: + description: '' + type: string + EndpointConfiguration: + description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/EndpointConfiguration' + Body: + description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``. Tags: - type: array uniqueItems: false + description: '' + type: array items: $ref: '#/components/schemas/Tag' - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. x-stackql-resource-name: rest_api - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*. + On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. + x-type-name: AWS::ApiGateway::RestApi + x-stackql-primary-identifier: - RestApiId + x-write-only-properties: + - Body + - BodyS3Location + - CloneFrom + - FailOnWarnings + - Mode + - Parameters x-read-only-properties: - RestApiId - RootResourceId + x-tagging: + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - apigateway:GET create: - apigateway:GET - apigateway:POST @@ -1212,8 +1930,6 @@ components: - apigateway:UpdateRestApiPolicy - s3:GetObject - iam:PassRole - read: - - apigateway:GET update: - apigateway:GET - apigateway:DELETE @@ -1222,59 +1938,59 @@ components: - apigateway:UpdateRestApiPolicy - s3:GetObject - iam:PassRole - delete: - - apigateway:DELETE list: - apigateway:GET + delete: + - apigateway:DELETE Stage: type: object properties: AccessLogSetting: - description: Access log settings, including the access log format and access log destination ARN. + description: '' $ref: '#/components/schemas/AccessLogSetting' CacheClusterEnabled: - description: Specifies whether a cache cluster is enabled for the stage. + description: '' type: boolean CacheClusterSize: - description: The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + description: '' type: string CanarySetting: - description: Settings for the canary deployment in this stage. + description: '' $ref: '#/components/schemas/CanarySetting' ClientCertificateId: - description: The identifier of a client certificate for an API stage. + description: '' type: string DeploymentId: - description: The identifier of the Deployment that the stage points to. + description: '' type: string Description: - description: The stage's description. + description: '' type: string DocumentationVersion: - description: The version of the associated API documentation. + description: '' type: string MethodSettings: - description: A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\*/\*`` for overriding all methods in the stage. + description: '' type: array uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/MethodSetting' RestApiId: - description: The string identifier of the associated RestApi. + description: '' type: string StageName: - description: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. + description: '' type: string Tags: - description: The collection of tags. Each tag element is associated with a given resource. + description: '' type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' TracingEnabled: - description: Specifies whether active tracing with X-ray is enabled for the Stage. + description: '' type: boolean Variables: description: 'A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.' @@ -1286,12 +2002,26 @@ components: required: - RestApiId x-stackql-resource-name: stage - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment. + x-type-name: AWS::ApiGateway::Stage + x-stackql-primary-identifier: - RestApiId - StageName x-create-only-properties: - RestApiId - StageName + x-required-properties: + - RestApiId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -1315,18 +2045,18 @@ components: properties: ApiId: type: string - description: API Id of the associated API stage in a usage plan. + description: '' Stage: type: string - description: API stage name of the associated API stage in a usage plan. + description: '' Throttle: type: object - description: Map containing method level throttling information for API stage in a usage plan. + description: '' additionalProperties: false x-patternProperties: .*: $ref: '#/components/schemas/ThrottleSettings' - description: API stage name of the associated API stage in a usage plan. + description: '' ThrottleSettings: type: object additionalProperties: false @@ -1334,11 +2064,11 @@ components: BurstLimit: type: integer minimum: 0 - description: The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit. + description: '' RateLimit: type: number minimum: 0 - description: The API target request rate limit. + description: '' description: '``ThrottleSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.' QuotaSettings: type: object @@ -1347,14 +2077,14 @@ components: Limit: type: integer minimum: 0 - description: The target maximum number of requests that can be made in a given time period. + description: '' Offset: type: integer minimum: 0 - description: The number of requests subtracted from the given limit in the initial time period. + description: '' Period: type: string - description: The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH". + description: '' description: |- ``QuotaSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests. @@ -1366,34 +2096,48 @@ components: description: '' ApiStages: type: array - description: The associated API stages of a usage plan. + description: '' uniqueItems: true items: $ref: '#/components/schemas/ApiStage' Description: type: string - description: The description of a usage plan. + description: '' Quota: $ref: '#/components/schemas/QuotaSettings' - description: The target maximum number of permitted requests per a given unit time interval. + description: '' Tags: type: array - description: The collection of tags. Each tag element is associated with a given resource. + description: '' x-insertionOrder: false uniqueItems: false items: $ref: '#/components/schemas/Tag' Throttle: $ref: '#/components/schemas/ThrottleSettings' - description: A map containing method level throttling information for API stage in a usage plan. + description: '' UsagePlanName: type: string - description: The name of a usage plan. + description: '' x-stackql-resource-name: usage_plan - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*. + In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests. + x-type-name: AWS::ApiGateway::UsagePlan + x-stackql-primary-identifier: - Id x-read-only-properties: - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -1419,7 +2163,7 @@ components: description: The Id of the UsagePlanKey resource. type: string KeyType: - description: The type of a UsagePlanKey resource for a plan customer. + description: '' type: string enum: - API_KEY @@ -1434,7 +2178,9 @@ components: - UsagePlanId - KeyId x-stackql-resource-name: usage_plan_key - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to. + x-type-name: AWS::ApiGateway::UsagePlanKey + x-stackql-primary-identifier: - Id x-create-only-properties: - KeyId @@ -1442,6 +2188,12 @@ components: - KeyType x-read-only-properties: - Id + x-required-properties: + - KeyType + - UsagePlanId + - KeyId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -1457,38 +2209,49 @@ components: type: object properties: Name: - description: A name for the VPC link. + description: '' type: string Description: - description: A description of the VPC link. + description: '' type: string Tags: - description: An array of arbitrary tags (key-value pairs) to associate with the stage. + description: An array of arbitrary tags (key-value pairs) to associate with the VPC link. x-insertionOrder: false uniqueItems: true type: array items: $ref: '#/components/schemas/Tag' TargetArns: - description: The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner. + description: '' type: array uniqueItems: false x-insertionOrder: false items: type: string VpcLinkId: - description: The ID of the instance that backs VPC link. + description: '' type: string required: - Name - TargetArns x-stackql-resource-name: vpc_link - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGateway::VpcLink`` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the ``Amazon API Gateway REST API Reference``. + x-type-name: AWS::ApiGateway::VpcLink + x-stackql-primary-identifier: - VpcLinkId x-create-only-properties: - TargetArns x-read-only-properties: - VpcLinkId + x-required-properties: + - Name + - TargetArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - apigateway:POST @@ -1526,18 +2289,1012 @@ components: - ec2:DeleteVpcEndpointServiceConfigurations - ec2:DescribeVpcEndpointServiceConfigurations - ec2:ModifyVpcEndpointServicePermissions + CreateAccountRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: '' + type: string + CloudWatchRoleArn: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateAccountRequest + type: object + required: [] + CreateApiKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + APIKeyId: + description: '' + type: string + CustomerId: + description: '' + type: string + Description: + description: '' + type: string + Enabled: + description: '' + default: false + type: boolean + GenerateDistinctId: + description: '' + type: boolean + Name: + description: |- + A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + type: string + StageKeys: + description: '' + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/StageKey' + Tags: + description: '' + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Value: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateApiKeyRequest + type: object + required: [] + CreateAuthorizerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RestApiId: + description: '' + type: string + AuthorizerId: + type: string + description: '' + AuthType: + description: '' + type: string + AuthorizerCredentials: + description: '' + type: string + AuthorizerResultTtlInSeconds: + description: '' + type: integer + AuthorizerUri: + description: '' + type: string + IdentitySource: + description: '' + type: string + IdentityValidationExpression: + description: '' + type: string + Name: + description: '' + type: string + ProviderARNs: + description: '' + type: array + uniqueItems: true + items: + type: string + x-insertionOrder: false + Type: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateAuthorizerRequest + type: object + required: [] + CreateBasePathMappingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BasePath: + type: string + description: '' + DomainName: + type: string + description: '' + RestApiId: + type: string + description: '' + Stage: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateBasePathMappingRequest + type: object + required: [] + CreateBasePathMappingV2Request: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BasePath: + type: string + description: The base path name that callers of the API must provide in the URL after the domain name. + DomainNameArn: + type: string + description: The Arn of an AWS::ApiGateway::DomainNameV2 resource. + RestApiId: + type: string + description: The ID of the API. + Stage: + type: string + description: The name of the API's stage. + BasePathMappingArn: + type: string + description: Amazon Resource Name (ARN) of the resource. + x-stackQL-stringOnly: true + x-title: CreateBasePathMappingV2Request + type: object + required: [] + CreateClientCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClientCertificateId: + description: '' + type: string + Description: + description: '' + type: string + Tags: + description: '' + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateClientCertificateRequest + type: object + required: [] + CreateDeploymentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeploymentId: + description: '' + type: string + Description: + description: '' + type: string + StageDescription: + description: The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name. + $ref: '#/components/schemas/StageDescription' + StageName: + description: '' + type: string + RestApiId: + description: '' + type: string + DeploymentCanarySettings: + description: '' + $ref: '#/components/schemas/DeploymentCanarySettings' + x-stackQL-stringOnly: true + x-title: CreateDeploymentRequest + type: object + required: [] + CreateDocumentationPartRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DocumentationPartId: + description: '' + type: string + Location: + description: '' + $ref: '#/components/schemas/Location' + Properties: + description: '' + type: string + RestApiId: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateDocumentationPartRequest + type: object + required: [] + CreateDocumentationVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: '' + type: string + DocumentationVersion: + description: '' + type: string + minLength: 1 + RestApiId: + description: '' + type: string + minLength: 1 + x-stackQL-stringOnly: true + x-title: CreateDocumentationVersionRequest + type: object + required: [] + CreateDomainNameRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + type: string + description: '' + DomainNameArn: + type: string + description: '' + DistributionDomainName: + type: string + description: '' + DistributionHostedZoneId: + type: string + description: '' + EndpointConfiguration: + $ref: '#/components/schemas/EndpointConfiguration' + description: '' + MutualTlsAuthentication: + $ref: '#/components/schemas/MutualTlsAuthentication' + description: '' + RegionalDomainName: + type: string + description: '' + RegionalHostedZoneId: + type: string + description: '' + CertificateArn: + type: string + description: '' + RegionalCertificateArn: + type: string + description: '' + OwnershipVerificationCertificateArn: + type: string + description: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn. + SecurityPolicy: + type: string + description: '' + RoutingMode: + type: string + description: '' + default: BASE_PATH_MAPPING_ONLY + enum: + - BASE_PATH_MAPPING_ONLY + - ROUTING_RULE_THEN_BASE_PATH_MAPPING + - ROUTING_RULE_ONLY + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + description: '' + x-stackQL-stringOnly: true + x-title: CreateDomainNameRequest + type: object + required: [] + CreateDomainNameAccessAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainNameAccessAssociationArn: + type: string + description: The amazon resource name (ARN) of the domain name access association resource. + DomainNameArn: + type: string + description: The amazon resource name (ARN) of the domain name resource. + AccessAssociationSource: + type: string + description: The source of the domain name access association resource. + AccessAssociationSourceType: + type: string + description: The source type of the domain name access association resource. + enum: + - VPCE + Tags: + description: An array of arbitrary tags (key-value pairs) to associate with the domainname access association. + uniqueItems: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDomainNameAccessAssociationRequest + type: object + required: [] + CreateDomainNameV2Request: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateArn: + type: string + DomainName: + type: string + EndpointConfiguration: + $ref: '#/components/schemas/EndpointConfiguration' + SecurityPolicy: + type: string + Policy: + type: object + DomainNameId: + type: string + DomainNameArn: + type: string + description: The amazon resource name (ARN) of the domain name resource. + RoutingMode: + type: string + description: The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid. + default: BASE_PATH_MAPPING_ONLY + enum: + - BASE_PATH_MAPPING_ONLY + - ROUTING_RULE_THEN_BASE_PATH_MAPPING + - ROUTING_RULE_ONLY + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDomainNameV2Request + type: object + required: [] + CreateGatewayResponseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: '' + type: string + RestApiId: + description: '' + type: string + ResponseType: + description: '' + type: string + StatusCode: + description: '' + type: string + ResponseParameters: + description: '' + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + ResponseTemplates: + description: '' + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + x-stackQL-stringOnly: true + x-title: CreateGatewayResponseRequest + type: object + required: [] + CreateMethodRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Integration: + description: '' + $ref: '#/components/schemas/Integration' + OperationName: + description: '' + type: string + RequestModels: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: '' + additionalProperties: false + type: object + RestApiId: + description: '' + type: string + AuthorizationScopes: + description: '' + type: array + items: + type: string + RequestValidatorId: + description: '' + type: string + RequestParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: boolean + description: '' + additionalProperties: false + type: object + MethodResponses: + uniqueItems: true + description: '' + type: array + items: + $ref: '#/components/schemas/MethodResponse' + AuthorizerId: + description: '' + type: string + ResourceId: + description: '' + type: string + ApiKeyRequired: + description: '' + type: boolean + AuthorizationType: + description: |- + The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. + If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. + type: string + HttpMethod: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateMethodRequest + type: object + required: [] + CreateModelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContentType: + type: string + description: '' + Description: + type: string + description: '' + Name: + type: string + description: |- + A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + RestApiId: + type: string + description: '' + Schema: + description: '' + type: object + x-stackQL-stringOnly: true + x-title: CreateModelRequest + type: object + required: [] + CreateRequestValidatorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RequestValidatorId: + description: '' + type: string + Name: + description: '' + type: string + RestApiId: + description: '' + type: string + ValidateRequestBody: + description: '' + type: boolean + ValidateRequestParameters: + description: '' + type: boolean + x-stackQL-stringOnly: true + x-title: CreateRequestValidatorRequest + type: object + required: [] + CreateResourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ParentId: + description: '' + type: string + PathPart: + description: '' + type: string + ResourceId: + description: '' + type: string + RestApiId: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateResourceRequest + type: object + required: [] + CreateRestApiRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Policy: + description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. + type: object + BodyS3Location: + description: The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. + $ref: '#/components/schemas/S3Location' + Description: + description: '' + type: string + MinimumCompressionSize: + description: '' + type: integer + Parameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: '' + additionalProperties: false + type: object + CloneFrom: + description: '' + type: string + Mode: + description: |- + This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. + Valid values are ``overwrite`` or ``merge``. + For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. + For ``merge``, the new API definition is merged with the existing API. + If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. + Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. + type: string + RestApiId: + description: '' + type: string + DisableExecuteApiEndpoint: + description: '' + type: boolean + FailOnWarnings: + description: '' + type: boolean + BinaryMediaTypes: + uniqueItems: true + description: '' + type: array + items: + type: string + Name: + description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. + type: string + RootResourceId: + description: '' + type: string + ApiKeySourceType: + description: '' + type: string + EndpointConfiguration: + description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/EndpointConfiguration' + Body: + description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. + type: object + Tags: + uniqueItems: false + description: '' + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRestApiRequest + type: object + required: [] + CreateStageRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessLogSetting: + description: '' + $ref: '#/components/schemas/AccessLogSetting' + CacheClusterEnabled: + description: '' + type: boolean + CacheClusterSize: + description: '' + type: string + CanarySetting: + description: '' + $ref: '#/components/schemas/CanarySetting' + ClientCertificateId: + description: '' + type: string + DeploymentId: + description: '' + type: string + Description: + description: '' + type: string + DocumentationVersion: + description: '' + type: string + MethodSettings: + description: '' + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/MethodSetting' + RestApiId: + description: '' + type: string + StageName: + description: '' + type: string + Tags: + description: '' + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + TracingEnabled: + description: '' + type: boolean + Variables: + description: 'A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.' + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + x-stackQL-stringOnly: true + x-title: CreateStageRequest + type: object + required: [] + CreateUsagePlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + ApiStages: + type: array + description: '' + uniqueItems: true + items: + $ref: '#/components/schemas/ApiStage' + Description: + type: string + description: '' + Quota: + $ref: '#/components/schemas/QuotaSettings' + description: '' + Tags: + type: array + description: '' + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Throttle: + $ref: '#/components/schemas/ThrottleSettings' + description: '' + UsagePlanName: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateUsagePlanRequest + type: object + required: [] + CreateUsagePlanKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + KeyId: + description: The Id of the UsagePlanKey resource. + type: string + KeyType: + description: '' + type: string + enum: + - API_KEY + UsagePlanId: + description: The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer. + type: string + Id: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateUsagePlanKeyRequest + type: object + required: [] + CreateVpcLinkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: '' + type: string + Description: + description: '' + type: string + Tags: + description: An array of arbitrary tags (key-value pairs) to associate with the VPC link. + x-insertionOrder: false + uniqueItems: true + type: array + items: + $ref: '#/components/schemas/Tag' + TargetArns: + description: '' + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + VpcLinkId: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateVpcLinkRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - account: - name: account - id: awscc.apigateway.account + accounts: + name: accounts + id: awscc.apigateway.accounts x-cfn-schema-name: Account - x-type: get + x-cfn-type-name: AWS::ApiGateway::Account x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Account&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1548,7 +3305,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1562,38 +3319,61 @@ components: name: api_keys id: awscc.apigateway.api_keys x-cfn-schema-name: ApiKey - x-type: list - x-identifiers: - - APIKeyId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.APIKeyId') as api_key_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'APIKeyId') as api_key_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' - AND region = 'us-east-1' - api_key: - name: api_key - id: awscc.apigateway.api_key - x-cfn-schema-name: ApiKey - x-type: get + x-cfn-type-name: AWS::ApiGateway::ApiKey x-identifiers: - APIKeyId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApiKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ApiKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ApiKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ApiKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1611,7 +3391,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1628,14 +3408,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' AND data__Identifier = '' AND region = 'us-east-1' - authorizers: - name: authorizers - id: awscc.apigateway.authorizers - x-cfn-schema-name: Authorizer - x-type: list + api_keys_list_only: + name: api_keys_list_only + id: awscc.apigateway.api_keys_list_only + x-cfn-schema-name: ApiKey + x-cfn-type-name: AWS::ApiGateway::ApiKey x-identifiers: - - RestApiId - - AuthorizerId + - APIKeyId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1643,31 +3428,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' + JSON_EXTRACT(Properties, '$.APIKeyId') as api_key_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' + json_extract_path_text(Properties, 'APIKeyId') as api_key_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' AND region = 'us-east-1' - authorizer: - name: authorizer - id: awscc.apigateway.authorizer + authorizers: + name: authorizers + id: awscc.apigateway.authorizers x-cfn-schema-name: Authorizer - x-type: get + x-cfn-type-name: AWS::ApiGateway::Authorizer x-identifiers: - RestApiId - AuthorizerId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Authorizer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1687,7 +3518,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1706,14 +3537,138 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' AND data__Identifier = '|' AND region = 'us-east-1' + authorizers_list_only: + name: authorizers_list_only + id: awscc.apigateway.authorizers_list_only + x-cfn-schema-name: Authorizer + x-cfn-type-name: AWS::ApiGateway::Authorizer + x-identifiers: + - RestApiId + - AuthorizerId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' + AND region = 'us-east-1' base_path_mappings: name: base_path_mappings id: awscc.apigateway.base_path_mappings x-cfn-schema-name: BasePathMapping - x-type: list + x-cfn-type-name: AWS::ApiGateway::BasePathMapping + x-identifiers: + - DomainName + - BasePath + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BasePathMapping&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::BasePathMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::BasePathMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::BasePathMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.BasePath') as base_path, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.Stage') as stage + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BasePath') as base_path, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'Stage') as stage + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' + AND data__Identifier = '|' + AND region = 'us-east-1' + base_path_mappings_list_only: + name: base_path_mappings_list_only + id: awscc.apigateway.base_path_mappings_list_only + x-cfn-schema-name: BasePathMapping + x-cfn-type-name: AWS::ApiGateway::BasePathMapping x-identifiers: - DomainName - BasePath + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1734,49 +3689,104 @@ components: json_extract_path_text(Properties, 'BasePath') as base_path FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' AND region = 'us-east-1' - base_path_mapping: - name: base_path_mapping - id: awscc.apigateway.base_path_mapping - x-cfn-schema-name: BasePathMapping - x-type: get + base_path_mapping_v2s: + name: base_path_mapping_v2s + id: awscc.apigateway.base_path_mapping_v2s + x-cfn-schema-name: BasePathMappingV2 + x-cfn-type-name: AWS::ApiGateway::BasePathMappingV2 x-identifiers: - - DomainName - - BasePath + - BasePathMappingArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BasePathMappingV2&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::BasePathMappingV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::BasePathMappingV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::BasePathMappingV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/base_path_mapping_v2s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/base_path_mapping_v2s/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/base_path_mapping_v2s/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.BasePath') as base_path, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.Stage') as stage - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Stage') as stage, + JSON_EXTRACT(Properties, '$.BasePathMappingArn') as base_path_mapping_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMappingV2' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'BasePath') as base_path, - json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'Stage') as stage - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'Stage') as stage, + json_extract_path_text(Properties, 'BasePathMappingArn') as base_path_mapping_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMappingV2' + AND data__Identifier = '' AND region = 'us-east-1' - client_certificates: - name: client_certificates - id: awscc.apigateway.client_certificates - x-cfn-schema-name: ClientCertificate - x-type: list + base_path_mapping_v2s_list_only: + name: base_path_mapping_v2s_list_only + id: awscc.apigateway.base_path_mapping_v2s_list_only + x-cfn-schema-name: BasePathMappingV2 + x-cfn-type-name: AWS::ApiGateway::BasePathMappingV2 x-identifiers: - - ClientCertificateId + - BasePathMappingArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1784,28 +3794,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ClientCertificateId') as client_certificate_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' + JSON_EXTRACT(Properties, '$.BasePathMappingArn') as base_path_mapping_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMappingV2' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' + json_extract_path_text(Properties, 'BasePathMappingArn') as base_path_mapping_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMappingV2' AND region = 'us-east-1' - client_certificate: - name: client_certificate - id: awscc.apigateway.client_certificate + client_certificates: + name: client_certificates + id: awscc.apigateway.client_certificates x-cfn-schema-name: ClientCertificate - x-type: get + x-cfn-type-name: AWS::ApiGateway::ClientCertificate x-identifiers: - ClientCertificateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClientCertificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ClientCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ClientCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ClientCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/client_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/client_certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/client_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1817,7 +3875,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1828,14 +3886,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' AND data__Identifier = '' AND region = 'us-east-1' - deployments: - name: deployments - id: awscc.apigateway.deployments - x-cfn-schema-name: Deployment - x-type: list + client_certificates_list_only: + name: client_certificates_list_only + id: awscc.apigateway.client_certificates_list_only + x-cfn-schema-name: ClientCertificate + x-cfn-type-name: AWS::ApiGateway::ClientCertificate x-identifiers: - - DeploymentId - - RestApiId + - ClientCertificateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1843,67 +3906,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' + JSON_EXTRACT(Properties, '$.ClientCertificateId') as client_certificate_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' + json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' AND region = 'us-east-1' - deployment: - name: deployment - id: awscc.apigateway.deployment + deployments: + name: deployments + id: awscc.apigateway.deployments x-cfn-schema-name: Deployment - x-type: get + x-cfn-type-name: AWS::ApiGateway::Deployment x-identifiers: - DeploymentId - RestApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, - JSON_EXTRACT(Properties, '$.DeploymentCanarySettings') as deployment_canary_settings, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, JSON_EXTRACT(Properties, '$.StageDescription') as stage_description, - JSON_EXTRACT(Properties, '$.StageName') as stage_name + JSON_EXTRACT(Properties, '$.StageName') as stage_name, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.DeploymentCanarySettings') as deployment_canary_settings FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Deployment' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'DeploymentCanarySettings') as deployment_canary_settings, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, json_extract_path_text(Properties, 'StageDescription') as stage_description, - json_extract_path_text(Properties, 'StageName') as stage_name + json_extract_path_text(Properties, 'StageName') as stage_name, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'DeploymentCanarySettings') as deployment_canary_settings FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Deployment' AND data__Identifier = '|' AND region = 'us-east-1' - documentation_parts: - name: documentation_parts - id: awscc.apigateway.documentation_parts - x-cfn-schema-name: DocumentationPart - x-type: list + deployments_list_only: + name: deployments_list_only + id: awscc.apigateway.deployments_list_only + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::ApiGateway::Deployment x-identifiers: - - DocumentationPartId + - DeploymentId - RestApiId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1911,31 +4026,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DocumentationPartId') as documentation_part_id, + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DocumentationPartId') as documentation_part_id, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' AND region = 'us-east-1' - documentation_part: - name: documentation_part - id: awscc.apigateway.documentation_part + documentation_parts: + name: documentation_parts + id: awscc.apigateway.documentation_parts x-cfn-schema-name: DocumentationPart - x-type: get + x-cfn-type-name: AWS::ApiGateway::DocumentationPart x-identifiers: - DocumentationPartId - RestApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DocumentationPart&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DocumentationPart" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DocumentationPart" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DocumentationPart" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1948,7 +4111,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1960,14 +4123,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' AND data__Identifier = '|' AND region = 'us-east-1' - documentation_versions: - name: documentation_versions - id: awscc.apigateway.documentation_versions - x-cfn-schema-name: DocumentationVersion - x-type: list + documentation_parts_list_only: + name: documentation_parts_list_only + id: awscc.apigateway.documentation_parts_list_only + x-cfn-schema-name: DocumentationPart + x-cfn-type-name: AWS::ApiGateway::DocumentationPart x-identifiers: - - DocumentationVersion + - DocumentationPartId - RestApiId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1975,31 +4144,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DocumentationVersion') as documentation_version, + JSON_EXTRACT(Properties, '$.DocumentationPartId') as documentation_part_id, JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, + json_extract_path_text(Properties, 'DocumentationPartId') as documentation_part_id, json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' AND region = 'us-east-1' - documentation_version: - name: documentation_version - id: awscc.apigateway.documentation_version + documentation_versions: + name: documentation_versions + id: awscc.apigateway.documentation_versions x-cfn-schema-name: DocumentationVersion - x-type: get + x-cfn-type-name: AWS::ApiGateway::DocumentationVersion x-identifiers: - DocumentationVersion - RestApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DocumentationVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DocumentationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DocumentationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DocumentationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2011,7 +4228,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2022,13 +4239,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' AND data__Identifier = '|' AND region = 'us-east-1' - domain_names: - name: domain_names - id: awscc.apigateway.domain_names - x-cfn-schema-name: DomainName - x-type: list + documentation_versions_list_only: + name: documentation_versions_list_only + id: awscc.apigateway.documentation_versions_list_only + x-cfn-schema-name: DocumentationVersion + x-cfn-type-name: AWS::ApiGateway::DocumentationVersion x-identifiers: - - DomainName + - DocumentationVersion + - RestApiId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2036,33 +4260,84 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + JSON_EXTRACT(Properties, '$.DocumentationVersion') as documentation_version, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' AND region = 'us-east-1' - domain_name: - name: domain_name - id: awscc.apigateway.domain_name + domain_names: + name: domain_names + id: awscc.apigateway.domain_names x-cfn-schema-name: DomainName - x-type: get + x-cfn-type-name: AWS::ApiGateway::DomainName x-identifiers: - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainName&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, JSON_EXTRACT(Properties, '$.DistributionDomainName') as distribution_domain_name, JSON_EXTRACT(Properties, '$.DistributionHostedZoneId') as distribution_hosted_zone_id, JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, @@ -2073,17 +4348,19 @@ components: JSON_EXTRACT(Properties, '$.RegionalCertificateArn') as regional_certificate_arn, JSON_EXTRACT(Properties, '$.OwnershipVerificationCertificateArn') as ownership_verification_certificate_arn, JSON_EXTRACT(Properties, '$.SecurityPolicy') as security_policy, + JSON_EXTRACT(Properties, '$.RoutingMode') as routing_mode, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainName' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, json_extract_path_text(Properties, 'DistributionDomainName') as distribution_domain_name, json_extract_path_text(Properties, 'DistributionHostedZoneId') as distribution_hosted_zone_id, json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, @@ -2094,17 +4371,369 @@ components: json_extract_path_text(Properties, 'RegionalCertificateArn') as regional_certificate_arn, json_extract_path_text(Properties, 'OwnershipVerificationCertificateArn') as ownership_verification_certificate_arn, json_extract_path_text(Properties, 'SecurityPolicy') as security_policy, + json_extract_path_text(Properties, 'RoutingMode') as routing_mode, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainName' AND data__Identifier = '' AND region = 'us-east-1' + domain_names_list_only: + name: domain_names_list_only + id: awscc.apigateway.domain_names_list_only + x-cfn-schema-name: DomainName + x-cfn-type-name: AWS::ApiGateway::DomainName + x-identifiers: + - DomainName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + AND region = 'us-east-1' + domain_name_access_associations: + name: domain_name_access_associations + id: awscc.apigateway.domain_name_access_associations + x-cfn-schema-name: DomainNameAccessAssociation + x-cfn-type-name: AWS::ApiGateway::DomainNameAccessAssociation + x-identifiers: + - DomainNameAccessAssociationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainNameAccessAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainNameAccessAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainNameAccessAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_name_access_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_name_access_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DomainNameAccessAssociationArn') as domain_name_access_association_arn, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, + JSON_EXTRACT(Properties, '$.AccessAssociationSource') as access_association_source, + JSON_EXTRACT(Properties, '$.AccessAssociationSourceType') as access_association_source_type, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainNameAccessAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainNameAccessAssociationArn') as domain_name_access_association_arn, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, + json_extract_path_text(Properties, 'AccessAssociationSource') as access_association_source, + json_extract_path_text(Properties, 'AccessAssociationSourceType') as access_association_source_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainNameAccessAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + domain_name_access_associations_list_only: + name: domain_name_access_associations_list_only + id: awscc.apigateway.domain_name_access_associations_list_only + x-cfn-schema-name: DomainNameAccessAssociation + x-cfn-type-name: AWS::ApiGateway::DomainNameAccessAssociation + x-identifiers: + - DomainNameAccessAssociationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainNameAccessAssociationArn') as domain_name_access_association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainNameAccessAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainNameAccessAssociationArn') as domain_name_access_association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainNameAccessAssociation' + AND region = 'us-east-1' + domain_name_v2s: + name: domain_name_v2s + id: awscc.apigateway.domain_name_v2s + x-cfn-schema-name: DomainNameV2 + x-cfn-type-name: AWS::ApiGateway::DomainNameV2 + x-identifiers: + - DomainNameArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainNameV2&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainNameV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainNameV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainNameV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_name_v2s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_name_v2s/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_name_v2s/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, + JSON_EXTRACT(Properties, '$.SecurityPolicy') as security_policy, + JSON_EXTRACT(Properties, '$.Policy') as policy, + JSON_EXTRACT(Properties, '$.DomainNameId') as domain_name_id, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, + JSON_EXTRACT(Properties, '$.RoutingMode') as routing_mode, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainNameV2' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, + json_extract_path_text(Properties, 'SecurityPolicy') as security_policy, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'DomainNameId') as domain_name_id, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, + json_extract_path_text(Properties, 'RoutingMode') as routing_mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainNameV2' + AND data__Identifier = '' + AND region = 'us-east-1' + domain_name_v2s_list_only: + name: domain_name_v2s_list_only + id: awscc.apigateway.domain_name_v2s_list_only + x-cfn-schema-name: DomainNameV2 + x-cfn-type-name: AWS::ApiGateway::DomainNameV2 + x-identifiers: + - DomainNameArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainNameV2' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainNameV2' + AND region = 'us-east-1' gateway_responses: name: gateway_responses id: awscc.apigateway.gateway_responses x-cfn-schema-name: GatewayResponse - x-type: list + x-cfn-type-name: AWS::ApiGateway::GatewayResponse + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GatewayResponse&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::GatewayResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::GatewayResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::GatewayResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateway_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateway_responses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/gateway_responses/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.ResponseType') as response_type, + JSON_EXTRACT(Properties, '$.StatusCode') as status_code, + JSON_EXTRACT(Properties, '$.ResponseParameters') as response_parameters, + JSON_EXTRACT(Properties, '$.ResponseTemplates') as response_templates + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'ResponseType') as response_type, + json_extract_path_text(Properties, 'StatusCode') as status_code, + json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, + json_extract_path_text(Properties, 'ResponseTemplates') as response_templates + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' + AND data__Identifier = '' + AND region = 'us-east-1' + gateway_responses_list_only: + name: gateway_responses_list_only + id: awscc.apigateway.gateway_responses_list_only + x-cfn-schema-name: GatewayResponse + x-cfn-type-name: AWS::ApiGateway::GatewayResponse x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2123,58 +4752,106 @@ components: json_extract_path_text(Properties, 'Id') as id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' AND region = 'us-east-1' - method: - name: method - id: awscc.apigateway.method + methods: + name: methods + id: awscc.apigateway.methods x-cfn-schema-name: Method - x-type: get + x-cfn-type-name: AWS::ApiGateway::Method x-identifiers: - RestApiId - ResourceId - HttpMethod + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Method&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Method" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Method" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Method" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/methods/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/methods/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/methods/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ApiKeyRequired') as api_key_required, - JSON_EXTRACT(Properties, '$.AuthorizationScopes') as authorization_scopes, - JSON_EXTRACT(Properties, '$.AuthorizationType') as authorization_type, - JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, - JSON_EXTRACT(Properties, '$.HttpMethod') as http_method, JSON_EXTRACT(Properties, '$.Integration') as integration, - JSON_EXTRACT(Properties, '$.MethodResponses') as method_responses, JSON_EXTRACT(Properties, '$.OperationName') as operation_name, JSON_EXTRACT(Properties, '$.RequestModels') as request_models, - JSON_EXTRACT(Properties, '$.RequestParameters') as request_parameters, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.AuthorizationScopes') as authorization_scopes, JSON_EXTRACT(Properties, '$.RequestValidatorId') as request_validator_id, + JSON_EXTRACT(Properties, '$.RequestParameters') as request_parameters, + JSON_EXTRACT(Properties, '$.MethodResponses') as method_responses, + JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + JSON_EXTRACT(Properties, '$.ApiKeyRequired') as api_key_required, + JSON_EXTRACT(Properties, '$.AuthorizationType') as authorization_type, + JSON_EXTRACT(Properties, '$.HttpMethod') as http_method FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Method' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ApiKeyRequired') as api_key_required, - json_extract_path_text(Properties, 'AuthorizationScopes') as authorization_scopes, - json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, - json_extract_path_text(Properties, 'HttpMethod') as http_method, json_extract_path_text(Properties, 'Integration') as integration, - json_extract_path_text(Properties, 'MethodResponses') as method_responses, json_extract_path_text(Properties, 'OperationName') as operation_name, json_extract_path_text(Properties, 'RequestModels') as request_models, - json_extract_path_text(Properties, 'RequestParameters') as request_parameters, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'AuthorizationScopes') as authorization_scopes, json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id, + json_extract_path_text(Properties, 'RequestParameters') as request_parameters, + json_extract_path_text(Properties, 'MethodResponses') as method_responses, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id + json_extract_path_text(Properties, 'ApiKeyRequired') as api_key_required, + json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, + json_extract_path_text(Properties, 'HttpMethod') as http_method FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Method' AND data__Identifier = '||' AND region = 'us-east-1' @@ -2182,42 +4859,62 @@ components: name: models id: awscc.apigateway.models x-cfn-schema-name: Model - x-type: list - x-identifiers: - - RestApiId - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' - AND region = 'us-east-1' - model: - name: model - id: awscc.apigateway.model - x-cfn-schema-name: Model - x-type: get + x-cfn-type-name: AWS::ApiGateway::Model x-identifiers: - RestApiId - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Model&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Model" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Model" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Model" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2231,7 +4928,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2244,14 +4941,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Model' AND data__Identifier = '|' AND region = 'us-east-1' - request_validators: - name: request_validators - id: awscc.apigateway.request_validators - x-cfn-schema-name: RequestValidator - x-type: list + models_list_only: + name: models_list_only + id: awscc.apigateway.models_list_only + x-cfn-schema-name: Model + x-cfn-type-name: AWS::ApiGateway::Model x-identifiers: - RestApiId - - RequestValidatorId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2260,8 +4963,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.RequestValidatorId') as request_validator_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2269,21 +4972,69 @@ components: SELECT region, json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' AND region = 'us-east-1' - request_validator: - name: request_validator - id: awscc.apigateway.request_validator + request_validators: + name: request_validators + id: awscc.apigateway.request_validators x-cfn-schema-name: RequestValidator - x-type: get + x-cfn-type-name: AWS::ApiGateway::RequestValidator x-identifiers: - RestApiId - RequestValidatorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RequestValidator&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::RequestValidator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::RequestValidator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::RequestValidator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/request_validators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/request_validators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/request_validators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2297,7 +5048,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2310,14 +5061,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' AND data__Identifier = '|' AND region = 'us-east-1' - resources: - name: resources - id: awscc.apigateway.resources - x-cfn-schema-name: Resource - x-type: list + request_validators_list_only: + name: request_validators_list_only + id: awscc.apigateway.request_validators_list_only + x-cfn-schema-name: RequestValidator + x-cfn-type-name: AWS::ApiGateway::RequestValidator x-identifiers: - RestApiId - - ResourceId + - RequestValidatorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2326,8 +5083,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' + JSON_EXTRACT(Properties, '$.RequestValidatorId') as request_validator_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2335,52 +5092,107 @@ components: SELECT region, json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' + json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' AND region = 'us-east-1' - resource: - name: resource - id: awscc.apigateway.resource + resources: + name: resources + id: awscc.apigateway.resources x-cfn-schema-name: Resource - x-type: get + x-cfn-type-name: AWS::ApiGateway::Resource x-identifiers: - RestApiId - ResourceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Resource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Resource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Resource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Resource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, JSON_EXTRACT(Properties, '$.ParentId') as parent_id, - JSON_EXTRACT(Properties, '$.PathPart') as path_part + JSON_EXTRACT(Properties, '$.PathPart') as path_part, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Resource' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, json_extract_path_text(Properties, 'ParentId') as parent_id, - json_extract_path_text(Properties, 'PathPart') as path_part + json_extract_path_text(Properties, 'PathPart') as path_part, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Resource' AND data__Identifier = '|' AND region = 'us-east-1' - rest_apis: - name: rest_apis - id: awscc.apigateway.rest_apis - x-cfn-schema-name: RestApi - x-type: list + resources_list_only: + name: resources_list_only + id: awscc.apigateway.resources_list_only + x-cfn-schema-name: Resource + x-cfn-type-name: AWS::ApiGateway::Resource x-identifiers: - RestApiId + - ResourceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2388,86 +5200,141 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' AND region = 'us-east-1' - rest_api: - name: rest_api - id: awscc.apigateway.rest_api + rest_apis: + name: rest_apis + id: awscc.apigateway.rest_apis x-cfn-schema-name: RestApi - x-type: get + x-cfn-type-name: AWS::ApiGateway::RestApi x-identifiers: - RestApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RestApi&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::RestApi" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::RestApi" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::RestApi" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rest_apis/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rest_apis/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rest_apis/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.RootResourceId') as root_resource_id, - JSON_EXTRACT(Properties, '$.ApiKeySourceType') as api_key_source_type, - JSON_EXTRACT(Properties, '$.BinaryMediaTypes') as binary_media_types, - JSON_EXTRACT(Properties, '$.Body') as body, + JSON_EXTRACT(Properties, '$.Policy') as policy, JSON_EXTRACT(Properties, '$.BodyS3Location') as body_s3_location, - JSON_EXTRACT(Properties, '$.CloneFrom') as clone_from, - JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.MinimumCompressionSize') as minimum_compression_size, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.CloneFrom') as clone_from, + JSON_EXTRACT(Properties, '$.Mode') as mode, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, JSON_EXTRACT(Properties, '$.DisableExecuteApiEndpoint') as disable_execute_api_endpoint, JSON_EXTRACT(Properties, '$.FailOnWarnings') as fail_on_warnings, + JSON_EXTRACT(Properties, '$.BinaryMediaTypes') as binary_media_types, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.MinimumCompressionSize') as minimum_compression_size, - JSON_EXTRACT(Properties, '$.Mode') as mode, - JSON_EXTRACT(Properties, '$.Policy') as policy, - JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.RootResourceId') as root_resource_id, + JSON_EXTRACT(Properties, '$.ApiKeySourceType') as api_key_source_type, + JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, + JSON_EXTRACT(Properties, '$.Body') as body, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RestApi' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'RootResourceId') as root_resource_id, - json_extract_path_text(Properties, 'ApiKeySourceType') as api_key_source_type, - json_extract_path_text(Properties, 'BinaryMediaTypes') as binary_media_types, - json_extract_path_text(Properties, 'Body') as body, + json_extract_path_text(Properties, 'Policy') as policy, json_extract_path_text(Properties, 'BodyS3Location') as body_s3_location, - json_extract_path_text(Properties, 'CloneFrom') as clone_from, - json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MinimumCompressionSize') as minimum_compression_size, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'CloneFrom') as clone_from, + json_extract_path_text(Properties, 'Mode') as mode, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, json_extract_path_text(Properties, 'DisableExecuteApiEndpoint') as disable_execute_api_endpoint, json_extract_path_text(Properties, 'FailOnWarnings') as fail_on_warnings, + json_extract_path_text(Properties, 'BinaryMediaTypes') as binary_media_types, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'MinimumCompressionSize') as minimum_compression_size, - json_extract_path_text(Properties, 'Mode') as mode, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'RootResourceId') as root_resource_id, + json_extract_path_text(Properties, 'ApiKeySourceType') as api_key_source_type, + json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, + json_extract_path_text(Properties, 'Body') as body, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RestApi' AND data__Identifier = '' AND region = 'us-east-1' - stages: - name: stages - id: awscc.apigateway.stages - x-cfn-schema-name: Stage - x-type: list + rest_apis_list_only: + name: rest_apis_list_only + id: awscc.apigateway.rest_apis_list_only + x-cfn-schema-name: RestApi + x-cfn-type-name: AWS::ApiGateway::RestApi x-identifiers: - RestApiId - - StageName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2475,31 +5342,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.StageName') as stage_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'StageName') as stage_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' AND region = 'us-east-1' - stage: - name: stage - id: awscc.apigateway.stage + stages: + name: stages + id: awscc.apigateway.stages x-cfn-schema-name: Stage - x-type: get + x-cfn-type-name: AWS::ApiGateway::Stage x-identifiers: - RestApiId - StageName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Stage&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Stage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Stage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Stage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stages/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2522,7 +5435,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2544,13 +5457,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Stage' AND data__Identifier = '|' AND region = 'us-east-1' - usage_plans: - name: usage_plans - id: awscc.apigateway.usage_plans - x-cfn-schema-name: UsagePlan - x-type: list + stages_list_only: + name: stages_list_only + id: awscc.apigateway.stages_list_only + x-cfn-schema-name: Stage + x-cfn-type-name: AWS::ApiGateway::Stage x-identifiers: - - Id + - RestApiId + - StageName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2558,28 +5478,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.StageName') as stage_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'StageName') as stage_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' AND region = 'us-east-1' - usage_plan: - name: usage_plan - id: awscc.apigateway.usage_plan + usage_plans: + name: usage_plans + id: awscc.apigateway.usage_plans x-cfn-schema-name: UsagePlan - x-type: get + x-cfn-type-name: AWS::ApiGateway::UsagePlan x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UsagePlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::UsagePlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::UsagePlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::UsagePlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/usage_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/usage_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/usage_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2595,7 +5565,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2610,13 +5580,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' AND data__Identifier = '' AND region = 'us-east-1' - usage_plan_keys: - name: usage_plan_keys - id: awscc.apigateway.usage_plan_keys - x-cfn-schema-name: UsagePlanKey - x-type: list + usage_plans_list_only: + name: usage_plans_list_only + id: awscc.apigateway.usage_plans_list_only + x-cfn-schema-name: UsagePlan + x-cfn-type-name: AWS::ApiGateway::UsagePlan x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2625,7 +5601,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2633,19 +5609,54 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' AND region = 'us-east-1' - usage_plan_key: - name: usage_plan_key - id: awscc.apigateway.usage_plan_key + usage_plan_keys: + name: usage_plan_keys + id: awscc.apigateway.usage_plan_keys x-cfn-schema-name: UsagePlanKey - x-type: get + x-cfn-type-name: AWS::ApiGateway::UsagePlanKey x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UsagePlanKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::UsagePlanKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::UsagePlanKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/usage_plan_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/usage_plan_keys/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2658,7 +5669,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2670,13 +5681,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' AND data__Identifier = '' AND region = 'us-east-1' - vpc_links: - name: vpc_links - id: awscc.apigateway.vpc_links - x-cfn-schema-name: VpcLink - x-type: list + usage_plan_keys_list_only: + name: usage_plan_keys_list_only + id: awscc.apigateway.usage_plan_keys_list_only + x-cfn-schema-name: UsagePlanKey + x-cfn-type-name: AWS::ApiGateway::UsagePlanKey x-identifiers: - - VpcLinkId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2684,28 +5701,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' AND region = 'us-east-1' - vpc_link: - name: vpc_link - id: awscc.apigateway.vpc_link + vpc_links: + name: vpc_links + id: awscc.apigateway.vpc_links x-cfn-schema-name: VpcLink - x-type: get + x-cfn-type-name: AWS::ApiGateway::VpcLink x-identifiers: - VpcLinkId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcLink&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::VpcLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::VpcLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::VpcLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2719,7 +5784,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2732,3 +5797,1111 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' AND data__Identifier = '' AND region = 'us-east-1' + vpc_links_list_only: + name: vpc_links_list_only + id: awscc.apigateway.vpc_links_list_only + x-cfn-schema-name: VpcLink + x-cfn-type-name: AWS::ApiGateway::VpcLink + x-identifiers: + - VpcLinkId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Account&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccount + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccountRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApiKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApiKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApiKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Authorizer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAuthorizer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAuthorizerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BasePathMapping&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBasePathMapping + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBasePathMappingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BasePathMappingV2&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBasePathMappingV2 + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBasePathMappingV2Request' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ClientCertificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateClientCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClientCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeployment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DocumentationPart&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDocumentationPart + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDocumentationPartRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DocumentationVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDocumentationVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDocumentationVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainName&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainName + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainNameRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainNameAccessAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainNameAccessAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainNameAccessAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainNameV2&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainNameV2 + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainNameV2Request' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GatewayResponse&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGatewayResponse + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGatewayResponseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Method&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMethod + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMethodRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Model&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RequestValidator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRequestValidator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRequestValidatorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Resource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RestApi&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRestApi + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRestApiRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Stage&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UsagePlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUsagePlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUsagePlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UsagePlanKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUsagePlanKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUsagePlanKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcLink&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcLink + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcLinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/apigatewayv2.yaml b/providers/src/awscc/v00.00.00000/services/apigatewayv2.yaml index 0c179f45..4ecb7a84 100644 --- a/providers/src/awscc/v00.00.00000/services/apigatewayv2.yaml +++ b/providers/src/awscc/v00.00.00000/services/apigatewayv2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ApiGatewayV2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: BodyS3Location: type: object @@ -63,21 +443,38 @@ components: RouteSelectionExpression: type: string description: The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs. + Body: + type: object + description: The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources. BodyS3Location: $ref: '#/components/schemas/BodyS3Location' description: The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources. - Description: - type: string - description: The description of the API. - ApiEndpoint: - type: string - description: '' BasePath: type: string description: Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs. + CredentialsArn: + type: string + description: >- + This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP + integrations. Supported only for HTTP APIs. + CorsConfiguration: + $ref: '#/components/schemas/Cors' + description: A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information. + RouteKey: + type: string + description: This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs. + Target: + type: string + description: This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. FailOnWarnings: type: boolean description: Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered. + ApiEndpoint: + type: string + description: '' + Description: + type: string + description: The description of the API. DisableExecuteApiEndpoint: type: boolean description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. @@ -87,32 +484,15 @@ components: Name: type: string description: The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``. - Target: - type: string - description: This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. - CredentialsArn: - type: string - description: >- - This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP - integrations. Supported only for HTTP APIs. - CorsConfiguration: - $ref: '#/components/schemas/Cors' - description: A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information. Version: type: string description: A version identifier for the API. ProtocolType: type: string description: The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``. - RouteKey: - type: string - description: This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs. ApiId: type: string description: '' - Body: - type: object - description: The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources. Tags: type: object description: The collection of tags. Each tag element is associated with a given resource. @@ -123,14 +503,38 @@ components: ApiKeySelectionExpression: type: string description: An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + IpAddressType: + type: string + description: '' x-stackql-resource-name: api - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.* + x-type-name: AWS::ApiGatewayV2::Api + x-stackql-primary-identifier: - ApiId x-create-only-properties: - ProtocolType + x-write-only-properties: + - Body + - BasePath + - BodyS3Location + - BodyS3Location/Etag + - BodyS3Location/Bucket + - BodyS3Location/Version + - BodyS3Location/Key + - CredentialsArn + - FailOnWarnings + - RouteKey + - Target + - DisableSchemaValidation x-read-only-properties: - ApiId - ApiEndpoint + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - apigateway:POST @@ -175,13 +579,26 @@ components: - Stage - ApiId x-stackql-resource-name: api_mapping - x-stackql-primaryIdentifier: + description: >- + The ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway + V2 API Reference*. + x-type-name: AWS::ApiGatewayV2::ApiMapping + x-stackql-primary-identifier: - ApiMappingId - DomainName x-create-only-properties: - DomainName x-read-only-properties: - ApiMappingId + x-required-properties: + - DomainName + - Stage + - ApiId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - apigateway:POST @@ -226,12 +643,6 @@ components: AuthorizerType: type: string description: The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs). - JwtConfiguration: - $ref: '#/components/schemas/JWTConfiguration' - description: The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs. - AuthorizerResultTtlInSeconds: - type: integer - description: The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. IdentitySource: type: array uniqueItems: false @@ -241,15 +652,21 @@ components: The identity source for which authorization is requested. For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``. + JwtConfiguration: + $ref: '#/components/schemas/JWTConfiguration' + description: The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs. + AuthorizerResultTtlInSeconds: + type: integer + description: The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. AuthorizerPayloadFormatVersion: type: string description: Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - ApiId: - type: string - description: The API identifier. EnableSimpleResponses: type: boolean description: Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + ApiId: + type: string + description: The API identifier. AuthorizerId: type: string description: '' @@ -261,13 +678,32 @@ components: - ApiId - Name x-stackql-resource-name: authorizer - x-stackql-primaryIdentifier: + description: >- + The ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer + Guide*. + x-type-name: AWS::ApiGatewayV2::Authorizer + x-stackql-primary-identifier: - AuthorizerId - ApiId x-create-only-properties: - ApiId + x-write-only-properties: + - AuthorizerPayloadFormatVersion + - AuthorizerResultTtlInSeconds + - EnableSimpleResponses + - AuthorizerCredentialsArn + - AuthorizerUri x-read-only-properties: - AuthorizerId + x-required-properties: + - AuthorizerType + - ApiId + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - apigateway:POST @@ -302,13 +738,25 @@ components: required: - ApiId x-stackql-resource-name: deployment - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API. + x-type-name: AWS::ApiGatewayV2::Deployment + x-stackql-primary-identifier: - ApiId - DeploymentId x-create-only-properties: - ApiId + x-write-only-properties: + - StageName x-read-only-properties: - DeploymentId + x-required-properties: + - ApiId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - apigateway:POST @@ -353,9 +801,12 @@ components: CertificateArn: type: string description: An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. + IpAddressType: + type: string + description: '' description: |- The ``DomainNameConfiguration`` property type specifies the configuration for an API's domain name. - ``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource. + ``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource. DomainName: type: object properties: @@ -368,8 +819,11 @@ components: RegionalDomainName: description: '' type: string + DomainNameArn: + description: '' + type: string DomainName: - description: The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported. + description: The custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore (``_``) character are not supported. type: string DomainNameConfigurations: description: The domain name configurations. @@ -377,6 +831,14 @@ components: uniqueItems: false items: $ref: '#/components/schemas/DomainNameConfiguration' + RoutingMode: + type: string + description: '' + default: API_MAPPING_ONLY + enum: + - API_MAPPING_ONLY + - ROUTING_RULE_THEN_API_MAPPING + - ROUTING_RULE_ONLY Tags: type: object description: The collection of tags associated with a domain name. @@ -387,13 +849,26 @@ components: required: - DomainName x-stackql-resource-name: domain_name - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). + You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGatewayV2::DomainName + x-stackql-primary-identifier: - DomainName x-create-only-properties: - DomainName x-read-only-properties: - RegionalDomainName - RegionalHostedZoneId + - DomainNameArn + x-required-properties: + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - apigateway:POST @@ -410,6 +885,158 @@ components: - apigateway:DELETE list: - apigateway:GET + ResponseParameter: + description: response parameter + type: object + additionalProperties: false + properties: + Destination: + type: string + Source: + type: string + ResponseParameterList: + description: list of response parameters + type: array + items: + $ref: '#/components/schemas/ResponseParameter' + ResponseParameterMap: + description: map of response parameter lists + type: object + additionalProperties: false + properties: + ResponseParameters: + $ref: '#/components/schemas/ResponseParameterList' + TlsConfig: + description: The TlsConfig property specifies the TLS configuration for a private integration. Supported only for HTTP APIs. + type: object + additionalProperties: false + properties: + ServerNameToVerify: + type: string + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + Integration: + type: object + properties: + ApiId: + description: The API identifier. + type: string + ConnectionId: + description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. + type: string + ConnectionType: + description: The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET. + type: string + ContentHandlingStrategy: + description: Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT. + type: string + CredentialsArn: + description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. + type: string + Description: + description: The description of the integration. + type: string + IntegrationMethod: + description: Specifies the integration's HTTP method type. + type: string + IntegrationSubtype: + description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. + type: string + IntegrationId: + description: The integration ID. + type: string + IntegrationType: + description: The integration type of an integration. + type: string + IntegrationUri: + description: For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. + type: string + PassthroughBehavior: + description: 'Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.' + type: string + PayloadFormatVersion: + description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 For all other integrations, 1.0 is the only supported value. + type: string + RequestParameters: + description: A key-value map specifying parameters. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + RequestTemplates: + description: A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + ResponseParameters: + description: Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + $ref: '#/components/schemas/ResponseParameterMap' + TemplateSelectionExpression: + description: The template selection expression for the integration. Supported only for WebSocket APIs. + type: string + TimeoutInMillis: + description: Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. + type: integer + TlsConfig: + description: The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. + $ref: '#/components/schemas/TlsConfig' + required: + - ApiId + - IntegrationType + x-stackql-resource-name: integration + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::ApiGatewayV2::Integration + x-stackql-primary-identifier: + - ApiId + - IntegrationId + x-create-only-properties: + - ApiId + x-read-only-properties: + - IntegrationId + x-required-properties: + - ApiId + - IntegrationType + x-tagging: + taggable: false + x-required-permissions: + create: + - apigateway:POST + - iam:PassRole + update: + - apigateway:PATCH + - apigateway:GET + - apigateway:PUT + - iam:PassRole + read: + - apigateway:GET + delete: + - apigateway:GET + - apigateway:DELETE + list: + - apigateway:GET IntegrationResponse: type: object properties: @@ -448,7 +1075,9 @@ components: - IntegrationId - IntegrationResponseKey x-stackql-resource-name: integration_response - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGatewayV2::IntegrationResponse + x-stackql-primary-identifier: - ApiId - IntegrationId - IntegrationResponseId @@ -457,6 +1086,12 @@ components: - IntegrationId x-read-only-properties: - IntegrationResponseId + x-required-properties: + - ApiId + - IntegrationId + - IntegrationResponseKey + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -497,13 +1132,21 @@ components: - Schema - Name x-stackql-resource-name: model - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGatewayV2::Model + x-stackql-primary-identifier: - ApiId - ModelId x-create-only-properties: - ApiId x-read-only-properties: - ModelId + x-required-properties: + - ApiId + - Schema + - Name + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -579,13 +1222,23 @@ components: - RouteKey - ApiId x-stackql-resource-name: route - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::Route`` resource creates a route for an API. + x-type-name: AWS::ApiGatewayV2::Route + x-stackql-primary-identifier: - ApiId - RouteId x-create-only-properties: - ApiId + x-write-only-properties: + - AuthorizerId + - RequestParameters x-read-only-properties: - RouteId + x-required-properties: + - RouteKey + - ApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -634,7 +1287,9 @@ components: - RouteId - ApiId x-stackql-resource-name: route_response - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGatewayV2::RouteResponse + x-stackql-primary-identifier: - ApiId - RouteId - RouteResponseId @@ -643,6 +1298,15 @@ components: - RouteId x-read-only-properties: - RouteResponseId + x-required-properties: + - RouteResponseKey + - RouteId + - ApiId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - apigateway:POST @@ -657,31 +1321,143 @@ components: - apigateway:DELETE list: - apigateway:GET - VpcLink: + Condition: type: object properties: - VpcLinkId: - type: string - description: '' - SubnetIds: + MatchHeaders: + $ref: '#/components/schemas/MatchHeaders' + MatchBasePaths: + $ref: '#/components/schemas/MatchBasePaths' + MatchHeaders: + type: object + required: + - AnyOf + properties: + AnyOf: type: array - uniqueItems: false items: - type: string - description: A list of subnet IDs to include in the VPC link. - SecurityGroupIds: + $ref: '#/components/schemas/MatchHeaderValue' + MatchBasePaths: + type: object + required: + - AnyOf + properties: + AnyOf: type: array - uniqueItems: false items: type: string - description: A list of security group IDs for the VPC link. - Tags: - type: object - description: The collection of tags. Each tag element is associated with a given resource. - additionalProperties: false - x-patternProperties: - .*: - type: string + MatchHeaderValue: + type: object + required: + - Header + - ValueGlob + properties: + Header: + type: string + ValueGlob: + type: string + Action: + type: object + required: + - InvokeApi + properties: + InvokeApi: + $ref: '#/components/schemas/ActionInvokeApi' + ActionInvokeApi: + type: object + required: + - ApiId + - Stage + properties: + ApiId: + type: string + Stage: + type: string + StripBasePath: + type: boolean + RoutingRule: + type: object + properties: + RoutingRuleId: + description: RoutingRule Id generated by service + type: string + RoutingRuleArn: + type: string + description: Amazon Resource Name (ARN) of the resource. + DomainNameArn: + type: string + description: The amazon resource name (ARN) of the domain name resource. + Priority: + type: integer + Conditions: + type: array + items: + $ref: '#/components/schemas/Condition' + Actions: + type: array + items: + $ref: '#/components/schemas/Action' + required: + - DomainNameArn + - Priority + - Conditions + - Actions + x-stackql-resource-name: routing_rule + description: Schema for AWS::ApiGatewayV2::RoutingRule + x-type-name: AWS::ApiGatewayV2::RoutingRule + x-stackql-primary-identifier: + - RoutingRuleArn + x-create-only-properties: + - DomainNameArn + x-read-only-properties: + - RoutingRuleArn + - RoutingRuleId + x-required-properties: + - DomainNameArn + - Priority + - Conditions + - Actions + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - apigateway:CreateRoutingRule + read: + - apigateway:GetRoutingRule + update: + - apigateway:UpdateRoutingRule + delete: + - apigateway:DeleteRoutingRule + list: + - apigateway:ListRoutingRules + VpcLink: + type: object + properties: + VpcLinkId: + type: string + description: '' + SubnetIds: + type: array + uniqueItems: false + items: + type: string + description: A list of subnet IDs to include in the VPC link. + SecurityGroupIds: + type: array + uniqueItems: false + items: + type: string + description: A list of security group IDs for the VPC link. + Tags: + type: object + description: The collection of tags. Each tag element is associated with a given resource. + additionalProperties: false + x-patternProperties: + .*: + type: string Name: type: string description: The name of the VPC link. @@ -689,13 +1465,24 @@ components: - SubnetIds - Name x-stackql-resource-name: vpc_link - x-stackql-primaryIdentifier: + description: The ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGatewayV2::VpcLink + x-stackql-primary-identifier: - VpcLinkId x-create-only-properties: - SecurityGroupIds - SubnetIds x-read-only-properties: - VpcLinkId + x-required-properties: + - SubnetIds + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - apigateway:POST @@ -728,105 +1515,745 @@ components: - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole - iam:GetServiceLinkedRoleDeletionStatus + CreateApiRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteSelectionExpression: + type: string + description: The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs. + Body: + type: object + description: The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources. + BodyS3Location: + $ref: '#/components/schemas/BodyS3Location' + description: The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources. + BasePath: + type: string + description: Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs. + CredentialsArn: + type: string + description: >- + This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for + HTTP integrations. Supported only for HTTP APIs. + CorsConfiguration: + $ref: '#/components/schemas/Cors' + description: A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information. + RouteKey: + type: string + description: This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs. + Target: + type: string + description: This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. + FailOnWarnings: + type: boolean + description: Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered. + ApiEndpoint: + type: string + description: '' + Description: + type: string + description: The description of the API. + DisableExecuteApiEndpoint: + type: boolean + description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. + DisableSchemaValidation: + type: boolean + description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. + Name: + type: string + description: The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``. + Version: + type: string + description: A version identifier for the API. + ProtocolType: + type: string + description: The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``. + ApiId: + type: string + description: '' + Tags: + type: object + description: The collection of tags. Each tag element is associated with a given resource. + additionalProperties: false + x-patternProperties: + .*: + type: string + ApiKeySelectionExpression: + type: string + description: An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + IpAddressType: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateApiRequest + type: object + required: [] + CreateApiMappingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiMappingId: + description: '' + type: string + DomainName: + description: The domain name. + type: string + Stage: + description: The API stage. + type: string + ApiMappingKey: + description: The API mapping key. + type: string + ApiId: + description: The identifier of the API. + type: string + x-stackQL-stringOnly: true + x-title: CreateApiMappingRequest + type: object + required: [] + CreateAuthorizerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdentityValidationExpression: + type: string + description: This parameter is not used. + AuthorizerUri: + type: string + description: >- + The authorizer's Uniform Resource Identifier (URI). For ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form: ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where *{region}* is the same as the region hosting the Lambda function, path indicates that the + remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``. + AuthorizerCredentialsArn: + type: string + description: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers. + AuthorizerType: + type: string + description: The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs). + IdentitySource: + type: array + uniqueItems: false + items: + type: string + description: |- + The identity source for which authorization is requested. + For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``. + JwtConfiguration: + $ref: '#/components/schemas/JWTConfiguration' + description: The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs. + AuthorizerResultTtlInSeconds: + type: integer + description: The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. + AuthorizerPayloadFormatVersion: + type: string + description: Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are ``1.0`` and ``2.0``. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + EnableSimpleResponses: + type: boolean + description: Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + ApiId: + type: string + description: The API identifier. + AuthorizerId: + type: string + description: '' + Name: + type: string + description: The name of the authorizer. + x-stackQL-stringOnly: true + x-title: CreateAuthorizerRequest + type: object + required: [] + CreateDeploymentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeploymentId: + type: string + description: '' + Description: + type: string + description: The description for the deployment resource. + StageName: + type: string + description: The name of an existing stage to associate with the deployment. + ApiId: + type: string + description: The API identifier. + x-stackQL-stringOnly: true + x-title: CreateDeploymentRequest + type: object + required: [] + CreateDomainNameRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MutualTlsAuthentication: + description: The mutual TLS authentication configuration for a custom domain name. + $ref: '#/components/schemas/MutualTlsAuthentication' + RegionalHostedZoneId: + description: '' + type: string + RegionalDomainName: + description: '' + type: string + DomainNameArn: + description: '' + type: string + DomainName: + description: The custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore (``_``) character are not supported. + type: string + DomainNameConfigurations: + description: The domain name configurations. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/DomainNameConfiguration' + RoutingMode: + type: string + description: '' + default: API_MAPPING_ONLY + enum: + - API_MAPPING_ONLY + - ROUTING_RULE_THEN_API_MAPPING + - ROUTING_RULE_ONLY + Tags: + type: object + description: The collection of tags associated with a domain name. + additionalProperties: false + x-patternProperties: + .*: + type: string + x-stackQL-stringOnly: true + x-title: CreateDomainNameRequest + type: object + required: [] + CreateIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiId: + description: The API identifier. + type: string + ConnectionId: + description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. + type: string + ConnectionType: + description: The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET. + type: string + ContentHandlingStrategy: + description: Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT. + type: string + CredentialsArn: + description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. + type: string + Description: + description: The description of the integration. + type: string + IntegrationMethod: + description: Specifies the integration's HTTP method type. + type: string + IntegrationSubtype: + description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. + type: string + IntegrationId: + description: The integration ID. + type: string + IntegrationType: + description: The integration type of an integration. + type: string + IntegrationUri: + description: For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. + type: string + PassthroughBehavior: + description: 'Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.' + type: string + PayloadFormatVersion: + description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 For all other integrations, 1.0 is the only supported value. + type: string + RequestParameters: + description: A key-value map specifying parameters. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + RequestTemplates: + description: A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + ResponseParameters: + description: Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + $ref: '#/components/schemas/ResponseParameterMap' + TemplateSelectionExpression: + description: The template selection expression for the integration. Supported only for WebSocket APIs. + type: string + TimeoutInMillis: + description: Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. + type: integer + TlsConfig: + description: The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. + $ref: '#/components/schemas/TlsConfig' + x-stackQL-stringOnly: true + x-title: CreateIntegrationRequest + type: object + required: [] + CreateIntegrationResponseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IntegrationResponseId: + description: '' + type: string + ResponseTemplates: + description: The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. + type: object + TemplateSelectionExpression: + description: The template selection expression for the integration response. Supported only for WebSocket APIs. + type: string + ResponseParameters: + description: >- + A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value + must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix. + type: object + ContentHandlingStrategy: + description: |- + Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: + ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob. + ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string. + If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + type: string + IntegrationId: + description: The integration ID. + type: string + IntegrationResponseKey: + description: The integration response key. + type: string + ApiId: + description: The API identifier. + type: string + x-stackQL-stringOnly: true + x-title: CreateIntegrationResponseRequest + type: object + required: [] + CreateModelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ModelId: + type: string + description: '' + Description: + type: string + description: The description of the model. + ContentType: + type: string + description: The content-type for the model, for example, "application/json". + Schema: + type: object + description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. + ApiId: + type: string + description: The API identifier. + Name: + type: string + description: The name of the model. + x-stackQL-stringOnly: true + x-title: CreateModelRequest + type: object + required: [] + CreateRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteId: + type: string + description: '' + RouteResponseSelectionExpression: + type: string + description: The route response selection expression for the route. Supported only for WebSocket APIs. + RequestModels: + type: object + description: The request models for the route. Supported only for WebSocket APIs. + OperationName: + type: string + description: The operation name for the route. + AuthorizationScopes: + type: array + uniqueItems: false + items: + type: string + description: The authorization scopes supported by this route. + ApiKeyRequired: + type: boolean + description: Specifies whether an API key is required for the route. Supported only for WebSocket APIs. + RouteKey: + type: string + description: The route key for the route. For HTTP APIs, the route key can be either ``$default``, or a combination of an HTTP method and resource path, for example, ``GET /pets``. + AuthorizationType: + type: string + description: The authorization type for the route. For WebSocket APIs, valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. For HTTP APIs, valid values are ``NONE`` for open access, ``JWT`` for using JSON Web Tokens, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. + ModelSelectionExpression: + type: string + description: The model selection expression for the route. Supported only for WebSocket APIs. + ApiId: + type: string + description: The API identifier. + RequestParameters: + type: object + items: + $ref: '#/components/schemas/ParameterConstraints' + description: The request parameters for the route. Supported only for WebSocket APIs. + Target: + type: string + description: The target for the route. + AuthorizerId: + type: string + description: The identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. + x-stackQL-stringOnly: true + x-title: CreateRouteRequest + type: object + required: [] + CreateRouteResponseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteResponseKey: + type: string + description: The route response key. + ResponseParameters: + $ref: '#/components/schemas/RouteParameters' + description: The route response parameters. + RouteId: + type: string + description: The route ID. + ModelSelectionExpression: + type: string + description: The model selection expression for the route response. Supported only for WebSocket APIs. + ApiId: + type: string + description: The API identifier. + ResponseModels: + type: object + description: The response models for the route response. + RouteResponseId: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateRouteResponseRequest + type: object + required: [] + CreateRoutingRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RoutingRuleId: + description: RoutingRule Id generated by service + type: string + RoutingRuleArn: + type: string + description: Amazon Resource Name (ARN) of the resource. + DomainNameArn: + type: string + description: The amazon resource name (ARN) of the domain name resource. + Priority: + type: integer + Conditions: + type: array + items: + $ref: '#/components/schemas/Condition' + Actions: + type: array + items: + $ref: '#/components/schemas/Action' + x-stackQL-stringOnly: true + x-title: CreateRoutingRuleRequest + type: object + required: [] + CreateVpcLinkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VpcLinkId: + type: string + description: '' + SubnetIds: + type: array + uniqueItems: false + items: + type: string + description: A list of subnet IDs to include in the VPC link. + SecurityGroupIds: + type: array + uniqueItems: false + items: + type: string + description: A list of security group IDs for the VPC link. + Tags: + type: object + description: The collection of tags. Each tag element is associated with a given resource. + additionalProperties: false + x-patternProperties: + .*: + type: string + Name: + type: string + description: The name of the VPC link. + x-stackQL-stringOnly: true + x-title: CreateVpcLinkRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: apis: name: apis id: awscc.apigatewayv2.apis x-cfn-schema-name: Api - x-type: list - x-identifiers: - - ApiId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' - AND region = 'us-east-1' - api: - name: api - id: awscc.apigatewayv2.api - x-cfn-schema-name: Api - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::Api x-identifiers: - ApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Api&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Api" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Api" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Api" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apis/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apis/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/apis/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.RouteSelectionExpression') as route_selection_expression, + JSON_EXTRACT(Properties, '$.Body') as body, JSON_EXTRACT(Properties, '$.BodyS3Location') as body_s3_location, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.ApiEndpoint') as api_endpoint, JSON_EXTRACT(Properties, '$.BasePath') as base_path, + JSON_EXTRACT(Properties, '$.CredentialsArn') as credentials_arn, + JSON_EXTRACT(Properties, '$.CorsConfiguration') as cors_configuration, + JSON_EXTRACT(Properties, '$.RouteKey') as route_key, + JSON_EXTRACT(Properties, '$.Target') as target, JSON_EXTRACT(Properties, '$.FailOnWarnings') as fail_on_warnings, + JSON_EXTRACT(Properties, '$.ApiEndpoint') as api_endpoint, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DisableExecuteApiEndpoint') as disable_execute_api_endpoint, JSON_EXTRACT(Properties, '$.DisableSchemaValidation') as disable_schema_validation, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Target') as target, - JSON_EXTRACT(Properties, '$.CredentialsArn') as credentials_arn, - JSON_EXTRACT(Properties, '$.CorsConfiguration') as cors_configuration, JSON_EXTRACT(Properties, '$.Version') as version, JSON_EXTRACT(Properties, '$.ProtocolType') as protocol_type, - JSON_EXTRACT(Properties, '$.RouteKey') as route_key, JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.Body') as body, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ApiKeySelectionExpression') as api_key_selection_expression + JSON_EXTRACT(Properties, '$.ApiKeySelectionExpression') as api_key_selection_expression, + JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'RouteSelectionExpression') as route_selection_expression, + json_extract_path_text(Properties, 'Body') as body, json_extract_path_text(Properties, 'BodyS3Location') as body_s3_location, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ApiEndpoint') as api_endpoint, json_extract_path_text(Properties, 'BasePath') as base_path, + json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn, + json_extract_path_text(Properties, 'CorsConfiguration') as cors_configuration, + json_extract_path_text(Properties, 'RouteKey') as route_key, + json_extract_path_text(Properties, 'Target') as target, json_extract_path_text(Properties, 'FailOnWarnings') as fail_on_warnings, + json_extract_path_text(Properties, 'ApiEndpoint') as api_endpoint, + json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'DisableExecuteApiEndpoint') as disable_execute_api_endpoint, json_extract_path_text(Properties, 'DisableSchemaValidation') as disable_schema_validation, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Target') as target, - json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn, - json_extract_path_text(Properties, 'CorsConfiguration') as cors_configuration, json_extract_path_text(Properties, 'Version') as version, json_extract_path_text(Properties, 'ProtocolType') as protocol_type, - json_extract_path_text(Properties, 'RouteKey') as route_key, json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'Body') as body, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ApiKeySelectionExpression') as api_key_selection_expression + json_extract_path_text(Properties, 'ApiKeySelectionExpression') as api_key_selection_expression, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' AND data__Identifier = '' AND region = 'us-east-1' - api_mappings: - name: api_mappings - id: awscc.apigatewayv2.api_mappings - x-cfn-schema-name: ApiMapping - x-type: list + apis_list_only: + name: apis_list_only + id: awscc.apigatewayv2.apis_list_only + x-cfn-schema-name: Api + x-cfn-type-name: AWS::ApiGatewayV2::Api x-identifiers: - - ApiMappingId - - DomainName + - ApiId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -834,31 +2261,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ApiMappingId') as api_mapping_id, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' + JSON_EXTRACT(Properties, '$.ApiId') as api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ApiMappingId') as api_mapping_id, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' + json_extract_path_text(Properties, 'ApiId') as api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' AND region = 'us-east-1' - api_mapping: - name: api_mapping - id: awscc.apigatewayv2.api_mapping + api_mappings: + name: api_mappings + id: awscc.apigatewayv2.api_mappings x-cfn-schema-name: ApiMapping - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::ApiMapping x-identifiers: - ApiMappingId - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApiMapping&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::ApiMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::ApiMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::ApiMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_mappings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/api_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -872,7 +2345,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -885,14 +2358,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' AND data__Identifier = '|' AND region = 'us-east-1' - authorizers: - name: authorizers - id: awscc.apigatewayv2.authorizers - x-cfn-schema-name: Authorizer - x-type: list + api_mappings_list_only: + name: api_mappings_list_only + id: awscc.apigatewayv2.api_mappings_list_only + x-cfn-schema-name: ApiMapping + x-cfn-type-name: AWS::ApiGatewayV2::ApiMapping x-identifiers: - - AuthorizerId - - ApiId + - ApiMappingId + - DomainName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -900,31 +2379,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, - JSON_EXTRACT(Properties, '$.ApiId') as api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' + JSON_EXTRACT(Properties, '$.ApiMappingId') as api_mapping_id, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' + json_extract_path_text(Properties, 'ApiMappingId') as api_mapping_id, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' AND region = 'us-east-1' - authorizer: - name: authorizer - id: awscc.apigatewayv2.authorizer + authorizers: + name: authorizers + id: awscc.apigatewayv2.authorizers x-cfn-schema-name: Authorizer - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::Authorizer x-identifiers: - AuthorizerId - ApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Authorizer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -933,19 +2460,19 @@ components: JSON_EXTRACT(Properties, '$.AuthorizerUri') as authorizer_uri, JSON_EXTRACT(Properties, '$.AuthorizerCredentialsArn') as authorizer_credentials_arn, JSON_EXTRACT(Properties, '$.AuthorizerType') as authorizer_type, + JSON_EXTRACT(Properties, '$.IdentitySource') as identity_source, JSON_EXTRACT(Properties, '$.JwtConfiguration') as jwt_configuration, JSON_EXTRACT(Properties, '$.AuthorizerResultTtlInSeconds') as authorizer_result_ttl_in_seconds, - JSON_EXTRACT(Properties, '$.IdentitySource') as identity_source, JSON_EXTRACT(Properties, '$.AuthorizerPayloadFormatVersion') as authorizer_payload_format_version, - JSON_EXTRACT(Properties, '$.ApiId') as api_id, JSON_EXTRACT(Properties, '$.EnableSimpleResponses') as enable_simple_responses, + JSON_EXTRACT(Properties, '$.ApiId') as api_id, JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, JSON_EXTRACT(Properties, '$.Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -954,25 +2481,149 @@ components: json_extract_path_text(Properties, 'AuthorizerUri') as authorizer_uri, json_extract_path_text(Properties, 'AuthorizerCredentialsArn') as authorizer_credentials_arn, json_extract_path_text(Properties, 'AuthorizerType') as authorizer_type, + json_extract_path_text(Properties, 'IdentitySource') as identity_source, json_extract_path_text(Properties, 'JwtConfiguration') as jwt_configuration, json_extract_path_text(Properties, 'AuthorizerResultTtlInSeconds') as authorizer_result_ttl_in_seconds, - json_extract_path_text(Properties, 'IdentitySource') as identity_source, json_extract_path_text(Properties, 'AuthorizerPayloadFormatVersion') as authorizer_payload_format_version, - json_extract_path_text(Properties, 'ApiId') as api_id, json_extract_path_text(Properties, 'EnableSimpleResponses') as enable_simple_responses, + json_extract_path_text(Properties, 'ApiId') as api_id, json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' AND data__Identifier = '|' AND region = 'us-east-1' + authorizers_list_only: + name: authorizers_list_only + id: awscc.apigatewayv2.authorizers_list_only + x-cfn-schema-name: Authorizer + x-cfn-type-name: AWS::ApiGatewayV2::Authorizer + x-identifiers: + - AuthorizerId + - ApiId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, + JSON_EXTRACT(Properties, '$.ApiId') as api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' + AND region = 'us-east-1' deployments: name: deployments id: awscc.apigatewayv2.deployments x-cfn-schema-name: Deployment - x-type: list + x-cfn-type-name: AWS::ApiGatewayV2::Deployment x-identifiers: - ApiId - DeploymentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.StageName') as stage_name, + JSON_EXTRACT(Properties, '$.ApiId') as api_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'StageName') as stage_name, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' + AND data__Identifier = '|' + AND region = 'us-east-1' + deployments_list_only: + name: deployments_list_only + id: awscc.apigatewayv2.deployments_list_only + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::ApiGatewayV2::Deployment + x-identifiers: + - ApiId + - DeploymentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -993,49 +2644,110 @@ components: json_extract_path_text(Properties, 'DeploymentId') as deployment_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' AND region = 'us-east-1' - deployment: - name: deployment - id: awscc.apigatewayv2.deployment - x-cfn-schema-name: Deployment - x-type: get + domain_names: + name: domain_names + id: awscc.apigatewayv2.domain_names + x-cfn-schema-name: DomainName + x-cfn-type-name: AWS::ApiGatewayV2::DomainName x-identifiers: - - ApiId - - DeploymentId + - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainName&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.StageName') as stage_name, - JSON_EXTRACT(Properties, '$.ApiId') as api_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.MutualTlsAuthentication') as mutual_tls_authentication, + JSON_EXTRACT(Properties, '$.RegionalHostedZoneId') as regional_hosted_zone_id, + JSON_EXTRACT(Properties, '$.RegionalDomainName') as regional_domain_name, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.DomainNameConfigurations') as domain_name_configurations, + JSON_EXTRACT(Properties, '$.RoutingMode') as routing_mode, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'StageName') as stage_name, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'MutualTlsAuthentication') as mutual_tls_authentication, + json_extract_path_text(Properties, 'RegionalHostedZoneId') as regional_hosted_zone_id, + json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainNameConfigurations') as domain_name_configurations, + json_extract_path_text(Properties, 'RoutingMode') as routing_mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' + AND data__Identifier = '' AND region = 'us-east-1' - domain_names: - name: domain_names - id: awscc.apigatewayv2.domain_names + domain_names_list_only: + name: domain_names_list_only + id: awscc.apigatewayv2.domain_names_list_only x-cfn-schema-name: DomainName - x-type: list + x-cfn-type-name: AWS::ApiGatewayV2::DomainName x-identifiers: - DomainName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1054,54 +2766,134 @@ components: json_extract_path_text(Properties, 'DomainName') as domain_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' AND region = 'us-east-1' - domain_name: - name: domain_name - id: awscc.apigatewayv2.domain_name - x-cfn-schema-name: DomainName - x-type: get + integrations: + name: integrations + id: awscc.apigatewayv2.integrations + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::ApiGatewayV2::Integration x-identifiers: - - DomainName + - ApiId + - IntegrationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.MutualTlsAuthentication') as mutual_tls_authentication, - JSON_EXTRACT(Properties, '$.RegionalHostedZoneId') as regional_hosted_zone_id, - JSON_EXTRACT(Properties, '$.RegionalDomainName') as regional_domain_name, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.DomainNameConfigurations') as domain_name_configurations, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.ConnectionId') as connection_id, + JSON_EXTRACT(Properties, '$.ConnectionType') as connection_type, + JSON_EXTRACT(Properties, '$.ContentHandlingStrategy') as content_handling_strategy, + JSON_EXTRACT(Properties, '$.CredentialsArn') as credentials_arn, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.IntegrationMethod') as integration_method, + JSON_EXTRACT(Properties, '$.IntegrationSubtype') as integration_subtype, + JSON_EXTRACT(Properties, '$.IntegrationId') as integration_id, + JSON_EXTRACT(Properties, '$.IntegrationType') as integration_type, + JSON_EXTRACT(Properties, '$.IntegrationUri') as integration_uri, + JSON_EXTRACT(Properties, '$.PassthroughBehavior') as passthrough_behavior, + JSON_EXTRACT(Properties, '$.PayloadFormatVersion') as payload_format_version, + JSON_EXTRACT(Properties, '$.RequestParameters') as request_parameters, + JSON_EXTRACT(Properties, '$.RequestTemplates') as request_templates, + JSON_EXTRACT(Properties, '$.ResponseParameters') as response_parameters, + JSON_EXTRACT(Properties, '$.TemplateSelectionExpression') as template_selection_expression, + JSON_EXTRACT(Properties, '$.TimeoutInMillis') as timeout_in_millis, + JSON_EXTRACT(Properties, '$.TlsConfig') as tls_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Integration' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'MutualTlsAuthentication') as mutual_tls_authentication, - json_extract_path_text(Properties, 'RegionalHostedZoneId') as regional_hosted_zone_id, - json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DomainNameConfigurations') as domain_name_configurations, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' - AND data__Identifier = '' + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'ConnectionId') as connection_id, + json_extract_path_text(Properties, 'ConnectionType') as connection_type, + json_extract_path_text(Properties, 'ContentHandlingStrategy') as content_handling_strategy, + json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IntegrationMethod') as integration_method, + json_extract_path_text(Properties, 'IntegrationSubtype') as integration_subtype, + json_extract_path_text(Properties, 'IntegrationId') as integration_id, + json_extract_path_text(Properties, 'IntegrationType') as integration_type, + json_extract_path_text(Properties, 'IntegrationUri') as integration_uri, + json_extract_path_text(Properties, 'PassthroughBehavior') as passthrough_behavior, + json_extract_path_text(Properties, 'PayloadFormatVersion') as payload_format_version, + json_extract_path_text(Properties, 'RequestParameters') as request_parameters, + json_extract_path_text(Properties, 'RequestTemplates') as request_templates, + json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, + json_extract_path_text(Properties, 'TemplateSelectionExpression') as template_selection_expression, + json_extract_path_text(Properties, 'TimeoutInMillis') as timeout_in_millis, + json_extract_path_text(Properties, 'TlsConfig') as tls_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Integration' + AND data__Identifier = '|' AND region = 'us-east-1' - integration_responses: - name: integration_responses - id: awscc.apigatewayv2.integration_responses - x-cfn-schema-name: IntegrationResponse - x-type: list + integrations_list_only: + name: integrations_list_only + id: awscc.apigatewayv2.integrations_list_only + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::ApiGatewayV2::Integration x-identifiers: - ApiId - IntegrationId - - IntegrationResponseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1110,9 +2902,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.IntegrationId') as integration_id, - JSON_EXTRACT(Properties, '$.IntegrationResponseId') as integration_response_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' + JSON_EXTRACT(Properties, '$.IntegrationId') as integration_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Integration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1120,23 +2911,70 @@ components: SELECT region, json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'IntegrationId') as integration_id, - json_extract_path_text(Properties, 'IntegrationResponseId') as integration_response_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' + json_extract_path_text(Properties, 'IntegrationId') as integration_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Integration' AND region = 'us-east-1' - integration_response: - name: integration_response - id: awscc.apigatewayv2.integration_response + integration_responses: + name: integration_responses + id: awscc.apigatewayv2.integration_responses x-cfn-schema-name: IntegrationResponse - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::IntegrationResponse x-identifiers: - ApiId - IntegrationId - IntegrationResponseId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IntegrationResponse&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::IntegrationResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::IntegrationResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::IntegrationResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integration_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integration_responses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/integration_responses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1153,7 +2991,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1169,14 +3007,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' AND data__Identifier = '||' AND region = 'us-east-1' - models: - name: models - id: awscc.apigatewayv2.models - x-cfn-schema-name: Model - x-type: list + integration_responses_list_only: + name: integration_responses_list_only + id: awscc.apigatewayv2.integration_responses_list_only + x-cfn-schema-name: IntegrationResponse + x-cfn-type-name: AWS::ApiGatewayV2::IntegrationResponse x-identifiers: - ApiId - - ModelId + - IntegrationId + - IntegrationResponseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1185,8 +3030,9 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.ModelId') as model_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' + JSON_EXTRACT(Properties, '$.IntegrationId') as integration_id, + JSON_EXTRACT(Properties, '$.IntegrationResponseId') as integration_response_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1194,21 +3040,70 @@ components: SELECT region, json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'ModelId') as model_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' + json_extract_path_text(Properties, 'IntegrationId') as integration_id, + json_extract_path_text(Properties, 'IntegrationResponseId') as integration_response_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' AND region = 'us-east-1' - model: - name: model - id: awscc.apigatewayv2.model + models: + name: models + id: awscc.apigatewayv2.models x-cfn-schema-name: Model - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::Model x-identifiers: - ApiId - ModelId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Model&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Model" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Model" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Model" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1223,7 +3118,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1237,14 +3132,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' AND data__Identifier = '|' AND region = 'us-east-1' - routes: - name: routes - id: awscc.apigatewayv2.routes - x-cfn-schema-name: Route - x-type: list + models_list_only: + name: models_list_only + id: awscc.apigatewayv2.models_list_only + x-cfn-schema-name: Model + x-cfn-type-name: AWS::ApiGatewayV2::Model x-identifiers: - ApiId - - RouteId + - ModelId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1253,8 +3154,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.RouteId') as route_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' + JSON_EXTRACT(Properties, '$.ModelId') as model_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1262,21 +3163,69 @@ components: SELECT region, json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'RouteId') as route_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' + json_extract_path_text(Properties, 'ModelId') as model_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' AND region = 'us-east-1' - route: - name: route - id: awscc.apigatewayv2.route + routes: + name: routes + id: awscc.apigatewayv2.routes x-cfn-schema-name: Route - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::Route x-identifiers: - ApiId - RouteId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Route&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1298,7 +3247,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1319,15 +3268,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' AND data__Identifier = '|' AND region = 'us-east-1' - route_responses: - name: route_responses - id: awscc.apigatewayv2.route_responses - x-cfn-schema-name: RouteResponse - x-type: list + routes_list_only: + name: routes_list_only + id: awscc.apigatewayv2.routes_list_only + x-cfn-schema-name: Route + x-cfn-type-name: AWS::ApiGatewayV2::Route x-identifiers: - ApiId - RouteId - - RouteResponseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1336,9 +3290,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.RouteId') as route_id, - JSON_EXTRACT(Properties, '$.RouteResponseId') as route_response_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' + JSON_EXTRACT(Properties, '$.RouteId') as route_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1346,23 +3299,70 @@ components: SELECT region, json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'RouteId') as route_id, - json_extract_path_text(Properties, 'RouteResponseId') as route_response_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' + json_extract_path_text(Properties, 'RouteId') as route_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' AND region = 'us-east-1' - route_response: - name: route_response - id: awscc.apigatewayv2.route_response + route_responses: + name: route_responses + id: awscc.apigatewayv2.route_responses x-cfn-schema-name: RouteResponse - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::RouteResponse x-identifiers: - ApiId - RouteId - RouteResponseId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteResponse&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::RouteResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::RouteResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::RouteResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_responses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/route_responses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1378,7 +3378,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1393,13 +3393,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' AND data__Identifier = '||' AND region = 'us-east-1' - vpc_links: - name: vpc_links - id: awscc.apigatewayv2.vpc_links - x-cfn-schema-name: VpcLink - x-type: list + route_responses_list_only: + name: route_responses_list_only + id: awscc.apigatewayv2.route_responses_list_only + x-cfn-schema-name: RouteResponse + x-cfn-type-name: AWS::ApiGatewayV2::RouteResponse x-identifiers: - - VpcLinkId + - ApiId + - RouteId + - RouteResponseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1407,28 +3415,198 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.RouteId') as route_id, + JSON_EXTRACT(Properties, '$.RouteResponseId') as route_response_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'RouteId') as route_id, + json_extract_path_text(Properties, 'RouteResponseId') as route_response_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' + AND region = 'us-east-1' + routing_rules: + name: routing_rules + id: awscc.apigatewayv2.routing_rules + x-cfn-schema-name: RoutingRule + x-cfn-type-name: AWS::ApiGatewayV2::RoutingRule + x-identifiers: + - RoutingRuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RoutingRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::RoutingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::RoutingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::RoutingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routing_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routing_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/routing_rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RoutingRuleId') as routing_rule_id, + JSON_EXTRACT(Properties, '$.RoutingRuleArn') as routing_rule_arn, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, + JSON_EXTRACT(Properties, '$.Priority') as priority, + JSON_EXTRACT(Properties, '$.Conditions') as conditions, + JSON_EXTRACT(Properties, '$.Actions') as actions + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::RoutingRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RoutingRuleId') as routing_rule_id, + json_extract_path_text(Properties, 'RoutingRuleArn') as routing_rule_arn, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'Conditions') as conditions, + json_extract_path_text(Properties, 'Actions') as actions + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::RoutingRule' + AND data__Identifier = '' + AND region = 'us-east-1' + routing_rules_list_only: + name: routing_rules_list_only + id: awscc.apigatewayv2.routing_rules_list_only + x-cfn-schema-name: RoutingRule + x-cfn-type-name: AWS::ApiGatewayV2::RoutingRule + x-identifiers: + - RoutingRuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RoutingRuleArn') as routing_rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RoutingRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RoutingRuleArn') as routing_rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RoutingRule' AND region = 'us-east-1' - vpc_link: - name: vpc_link - id: awscc.apigatewayv2.vpc_link + vpc_links: + name: vpc_links + id: awscc.apigatewayv2.vpc_links x-cfn-schema-name: VpcLink - x-type: get + x-cfn-type-name: AWS::ApiGatewayV2::VpcLink x-identifiers: - VpcLinkId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcLink&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::VpcLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::VpcLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGatewayV2::VpcLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1442,7 +3620,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1455,3 +3633,691 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' AND data__Identifier = '' AND region = 'us-east-1' + vpc_links_list_only: + name: vpc_links_list_only + id: awscc.apigatewayv2.vpc_links_list_only + x-cfn-schema-name: VpcLink + x-cfn-type-name: AWS::ApiGatewayV2::VpcLink + x-identifiers: + - VpcLinkId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Api&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApi + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApiRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApiMapping&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApiMapping + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApiMappingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Authorizer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAuthorizer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAuthorizerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeployment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainName&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainName + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainNameRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IntegrationResponse&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegrationResponse + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationResponseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Model&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Route&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteResponse&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteResponse + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteResponseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RoutingRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoutingRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoutingRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcLink&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcLink + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcLinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/appconfig.yaml b/providers/src/awscc/v00.00.00000/services/appconfig.yaml index 3fa86100..2016dc33 100644 --- a/providers/src/awscc/v00.00.00000/services/appconfig.yaml +++ b/providers/src/awscc/v00.00.00000/services/appconfig.yaml @@ -1,26 +1,405 @@ openapi: 3.0.0 info: title: AppConfig - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tags: description: Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + additionalProperties: false type: object properties: - Key: - type: string - description: The key-value string map. The tag key can be up to 128 characters and must not start with aws:. - minLength: 1 - maxLength: 128 - pattern: ^(?!aws:.)[a-zA-Z0-9 +=._:/-]*$ Value: - type: string - description: The tag value can be up to 256 characters. minLength: 0 + description: The tag value can be up to 256 characters. + type: string maxLength: 256 - additionalProperties: false + Key: + minLength: 1 + description: The key-value string map. The tag key can be up to 128 characters and must not start with aws:. + type: string + maxLength: 128 Application: type: object properties: @@ -43,10 +422,24 @@ components: required: - Name x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppConfig::Application + x-type-name: AWS::AppConfig::Application + x-stackql-primary-identifier: - ApplicationId x-read-only-properties: - ApplicationId + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource x-required-permissions: create: - appconfig:CreateApplication @@ -67,129 +460,136 @@ components: - appconfig:ListApplications Validators: description: A list of methods for validating the configuration. - type: object additionalProperties: false + type: object properties: Type: - type: string description: AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA. - Content: type: string - description: Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. + Content: minLength: 0 + description: Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. + type: string maxLength: 32768 ConfigurationProfile: type: object properties: - LocationUri: + ConfigurationProfileId: + description: The configuration profile ID type: string - description: A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. + LocationUri: minLength: 1 + description: A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. + type: string maxLength: 2048 Type: - type: string - description: 'The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform' pattern: ^[a-zA-Z\.]+ - Description: + description: 'The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform' type: string - description: A description of the configuration profile. + KmsKeyIdentifier: + pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$ + description: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. + type: string + Description: minLength: 0 + description: A description of the configuration profile. + type: string maxLength: 1024 + KmsKeyArn: + minLength: 20 + pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ + description: The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service. + type: string + maxLength: 2048 Validators: - type: array - description: A list of methods for validating the configuration. + maxItems: 2 uniqueItems: false + description: A list of methods for validating the configuration. + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Validators' - x-insertionOrder: false - maxItems: 2 RetrievalRoleArn: - type: string - description: The ARN of an IAM role with permission to access the configuration at the specified LocationUri. minLength: 20 + pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov|aws-eusc):(iam)::\d{12}:role[/].*)$ + description: The ARN of an IAM role with permission to access the configuration at the specified LocationUri. + type: string maxLength: 2048 - pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\d{12}:role[/].*)$ - ConfigurationProfileId: + DeletionProtectionCheck: + description: On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html type: string - description: The configuration profile ID + enum: + - ACCOUNT_DEFAULT + - APPLY + - BYPASS ApplicationId: - type: string - description: The application ID. pattern: '[a-z0-9]{4,7}' + description: The application ID. + type: string Tags: - type: array - description: Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. uniqueItems: false + description: Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tags' - x-insertionOrder: false Name: - type: string - description: A name for the configuration profile. minLength: 1 - maxLength: 128 - KmsKeyIdentifier: - type: string - description: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. - pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\d{1}:\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$ - KmsKeyArn: + description: A name for the configuration profile. type: string - description: The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service. - minLength: 20 - maxLength: 2048 - pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ + maxLength: 128 required: - LocationUri - ApplicationId - Name x-stackql-resource-name: configuration_profile - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::AppConfig::ConfigurationProfile + x-stackql-primary-identifier: - ApplicationId - ConfigurationProfileId x-create-only-properties: - LocationUri - Type - ApplicationId + x-write-only-properties: + - DeletionProtectionCheck x-read-only-properties: - ConfigurationProfileId - KmsKeyArn + x-required-properties: + - LocationUri + - ApplicationId + - Name + x-tagging: + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - appconfig:GetConfigurationProfile + - appconfig:ListTagsForResource create: - appconfig:CreateConfigurationProfile - appconfig:GetConfigurationProfile - appconfig:TagResource - appconfig:ListTagsForResource - iam:PassRole - read: - - appconfig:GetConfigurationProfile - - appconfig:ListTagsForResource update: - appconfig:UpdateConfigurationProfile - appconfig:TagResource - appconfig:UntagResource - iam:PassRole - delete: - - appconfig:DeleteConfigurationProfile list: - appconfig:ListConfigurationProfiles - Monitor: - type: object - description: Amazon CloudWatch alarm to monitor during the deployment process. - additionalProperties: false - properties: - AlarmArn: - type: string - description: Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. - minLength: 1 - maxLength: 2048 - AlarmRoleArn: - type: string - description: ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn. - minLength: 20 - maxLength: 2048 - pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\d{12}:role[/].*)$ - required: - - AlarmArn + delete: + - appconfig:DeleteConfigurationProfile Tag: description: A key-value pair to associate with a resource. type: object @@ -208,73 +608,333 @@ components: - Key - Value additionalProperties: false - Environment: + DynamicExtensionParameters: + additionalProperties: false type: object properties: - EnvironmentId: + ParameterValue: type: string + ExtensionReference: + type: string + ParameterName: + type: string + Deployment: + type: object + properties: + DeploymentStrategyId: + description: The deployment strategy ID. + type: string + ConfigurationProfileId: + description: The configuration profile ID. + type: string + EnvironmentId: description: The environment ID. - pattern: '[a-z0-9]{4,7}' - ApplicationId: type: string + KmsKeyIdentifier: + pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\d{1}:\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$ + description: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. + type: string + Description: + description: A description of the deployment. + type: string + ConfigurationVersion: + description: The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number. + type: string + State: + description: The state of the deployment. + type: string + enum: + - BAKING + - VALIDATING + - DEPLOYING + - COMPLETE + - ROLLING_BACK + - ROLLED_BACK + - REVERTED + DeploymentNumber: + description: The sequence number of the deployment. + type: string + ApplicationId: description: The application ID. + type: string + DynamicExtensionParameters: + uniqueItems: false + type: array + items: + $ref: '#/components/schemas/DynamicExtensionParameters' + Tags: + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - ApplicationId + - ConfigurationProfileId + - DeploymentStrategyId + - EnvironmentId + - ConfigurationVersion + x-stackql-resource-name: deployment + description: Resource Type definition for AWS::AppConfig::Deployment + x-type-name: AWS::AppConfig::Deployment + x-stackql-primary-identifier: + - ApplicationId + - EnvironmentId + - DeploymentNumber + x-create-only-properties: + - ApplicationId + - ConfigurationProfileId + - DeploymentStrategyId + - EnvironmentId + - Description + - ConfigurationVersion + - KmsKeyIdentifier + - DynamicExtensionParameters + - Tags + x-write-only-properties: + - DynamicExtensionParameters + x-read-only-properties: + - DeploymentNumber + - State + x-required-properties: + - ApplicationId + - ConfigurationProfileId + - DeploymentStrategyId + - EnvironmentId + - ConfigurationVersion + x-tagging: + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: false + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - appconfig:GetDeployment + - appconfig:ListTagsForResource + create: + - appconfig:StartDeployment + - appconfig:GetDeployment + - appconfig:TagResource + - appconfig:ListTagsForResource + - kms:GenerateDataKey + list: + - appconfig:ListDeployments + delete: + - appconfig:StopDeployment + DeploymentStrategy: + type: object + properties: + DeploymentDurationInMinutes: + type: number + description: Total amount of time for a deployment to last. + Description: + type: string + description: A description of the deployment strategy. + FinalBakeTimeInMinutes: + type: number + description: >- + Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConfig + User Guide. + GrowthFactor: + type: number + description: The percentage of targets to receive a deployed configuration during each interval. + GrowthType: + type: string + description: |- + The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: + + Linear: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. + + Exponential: For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: + + 2*(2^0) + + 2*(2^1) + + 2*(2^2) + + Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. + enum: + - EXPONENTIAL + - LINEAR + Name: + type: string + description: A name for the deployment strategy. + ReplicateTo: + type: string + description: Save the deployment strategy to a Systems Manager (SSM) document. + enum: + - NONE + - SSM_DOCUMENT + Tags: + type: array + description: Assigns metadata to an AWS AppConfig resource. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Id: + type: string + description: The deployment strategy ID. + required: + - DeploymentDurationInMinutes + - GrowthFactor + - Name + - ReplicateTo + x-stackql-resource-name: deployment_strategy + description: Resource Type definition for AWS::AppConfig::DeploymentStrategy + x-type-name: AWS::AppConfig::DeploymentStrategy + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + - ReplicateTo + x-read-only-properties: + - Id + x-required-properties: + - DeploymentDurationInMinutes + - GrowthFactor + - Name + - ReplicateTo + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource + x-required-permissions: + create: + - appconfig:CreateDeploymentStrategy + - appconfig:TagResource + read: + - appconfig:GetDeploymentStrategy + - appconfig:ListTagsForResource + update: + - appconfig:UpdateDeploymentStrategy + - appconfig:TagResource + - appconfig:UntagResource + delete: + - appconfig:DeleteDeploymentStrategy + list: + - appconfig:ListDeploymentStrategies + Monitor: + description: Amazon CloudWatch alarm to monitor during the deployment process. + additionalProperties: false + type: object + properties: + AlarmArn: + minLength: 1 + description: Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. + type: string + maxLength: 2048 + AlarmRoleArn: + minLength: 20 + description: ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn. + type: string + maxLength: 2048 + required: + - AlarmArn + Environment: + type: object + properties: + EnvironmentId: pattern: '[a-z0-9]{4,7}' - Name: + description: The environment ID. type: string - description: A name for the environment. - minLength: 1 - maxLength: 64 Description: - type: string - description: A description of the environment. minLength: 0 + description: A description of the environment. + type: string maxLength: 1024 Monitors: - type: array + minItems: 0 + maxItems: 5 description: Amazon CloudWatch alarms to monitor during the deployment process. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Monitor' - minItems: 0 - maxItems: 5 + DeletionProtectionCheck: + description: On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html + type: string + enum: + - ACCOUNT_DEFAULT + - APPLY + - BYPASS + ApplicationId: + pattern: '[a-z0-9]{4,7}' + description: The application ID. + type: string Tags: - type: array - description: Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. uniqueItems: true + description: Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - x-insertionOrder: false + Name: + minLength: 1 + description: A name for the environment. + type: string + maxLength: 64 required: - Name - ApplicationId x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppConfig::Environment + x-type-name: AWS::AppConfig::Environment + x-stackql-primary-identifier: - ApplicationId - EnvironmentId x-create-only-properties: - ApplicationId + x-write-only-properties: + - DeletionProtectionCheck x-read-only-properties: - EnvironmentId + x-required-properties: + - Name + - ApplicationId + x-tagging: + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - appconfig:GetEnvironment + - appconfig:ListTagsForResource create: - appconfig:CreateEnvironment - appconfig:GetEnvironment - appconfig:ListTagsForResource - appconfig:TagResource - iam:PassRole - read: - - appconfig:GetEnvironment - - appconfig:ListTagsForResource update: - appconfig:UpdateEnvironment - appconfig:TagResource - appconfig:UntagResource - iam:PassRole + list: + - appconfig:ListEnvironments delete: - appconfig:GetEnvironment - appconfig:DeleteEnvironment - list: - - appconfig:ListEnvironments Actions: description: A list of actions for an extension to take at a specific action point. uniqueItems: true @@ -319,6 +979,8 @@ components: description: The description of the extension Parameter. minLength: 0 maxLength: 1024 + Dynamic: + type: boolean Required: type: boolean required: @@ -356,7 +1018,7 @@ components: Tags: description: An array of key-value tags to apply to this resource. type: array - uniqueItems: false + uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/Tag' @@ -364,17 +1026,31 @@ components: - Name - Actions x-stackql-resource-name: extension - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppConfig::Extension + x-type-name: AWS::AppConfig::Extension + x-stackql-primary-identifier: - Id x-create-only-properties: - Name - - Tags - - Tags/*/Key - - Tags/*/Value + x-write-only-properties: + - LatestVersionNumber x-read-only-properties: - Id - Arn - VersionNumber + x-required-properties: + - Name + - Actions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource x-required-permissions: create: - appconfig:CreateExtension @@ -382,6 +1058,7 @@ components: - iam:PassRole read: - appconfig:GetExtension + - appconfig:ListTagsForResource update: - appconfig:UpdateExtension - appconfig:TagResource @@ -417,31 +1094,44 @@ components: Tags: description: An array of key-value pairs to apply to this resource. type: array - uniqueItems: false + uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: extension_association - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::AppConfig::ExtensionAssociation + x-stackql-primary-identifier: - Id x-create-only-properties: - ExtensionIdentifier - ResourceIdentifier - ExtensionVersionNumber - - Tags - - Tags/*/Key - - Tags/*/Value + x-write-only-properties: + - ExtensionIdentifier + - ResourceIdentifier x-read-only-properties: - Id - Arn - ResourceArn - ExtensionArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appconfig:TagResource + - appconfig:UntagResource + - appconfig:ListTagsForResource x-required-permissions: create: - appconfig:CreateExtensionAssociation - appconfig:TagResource read: - appconfig:GetExtensionAssociation + - appconfig:ListTagsForResource update: - appconfig:UpdateExtensionAssociation - appconfig:TagResource @@ -454,46 +1144,48 @@ components: HostedConfigurationVersion: type: object properties: - ApplicationId: - type: string - description: The application ID. - pattern: '[a-z0-9]{4,7}' ConfigurationProfileId: - type: string - description: The configuration profile ID. pattern: '[a-z0-9]{4,7}' - VersionNumber: + description: The configuration profile ID. type: string - description: Current version number of hosted configuration version. Description: - type: string - description: A description of the hosted configuration version. minLength: 0 - maxLength: 1024 - Content: + description: A description of the hosted configuration version. type: string - description: The content of the configuration or the configuration data. + maxLength: 1024 ContentType: - type: string - description: A standard MIME type describing the format of the configuration content. minLength: 1 + description: A standard MIME type describing the format of the configuration content. + type: string maxLength: 255 LatestVersionNumber: - type: integer description: An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version. - VersionLabel: + type: integer + Content: + description: The content of the configuration or the configuration data. type: string - description: A user-defined label for an AWS AppConfig hosted configuration version. - pattern: ^$|.*[^0-9].* + VersionLabel: minLength: 0 + pattern: ^$|.*[^0-9].* + description: A user-defined label for an AWS AppConfig hosted configuration version. + type: string maxLength: 64 + ApplicationId: + pattern: '[a-z0-9]{4,7}' + description: The application ID. + type: string + VersionNumber: + description: Current version number of hosted configuration version. + type: string required: - ApplicationId - ConfigurationProfileId - Content - ContentType x-stackql-resource-name: hosted_configuration_version - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppConfig::HostedConfigurationVersion + x-type-name: AWS::AppConfig::HostedConfigurationVersion + x-stackql-primary-identifier: - ApplicationId - ConfigurationProfileId - VersionNumber @@ -505,25 +1197,582 @@ components: - ContentType - LatestVersionNumber - VersionLabel + x-write-only-properties: + - LatestVersionNumber x-read-only-properties: - VersionNumber + x-required-properties: + - ApplicationId + - ConfigurationProfileId + - Content + - ContentType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: - create: - - appconfig:CreateHostedConfigurationVersion read: - appconfig:GetHostedConfigurationVersion - delete: - - appconfig:DeleteHostedConfigurationVersion + create: + - appconfig:CreateHostedConfigurationVersion list: - appconfig:ListHostedConfigurationVersions + delete: + - appconfig:DeleteHostedConfigurationVersion + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: A description of the application. + ApplicationId: + type: string + description: The application Id + Tags: + type: array + description: Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + uniqueItems: true + items: + $ref: '#/components/schemas/Tags' + x-insertionOrder: false + Name: + type: string + description: A name for the application. + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateConfigurationProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConfigurationProfileId: + description: The configuration profile ID + type: string + LocationUri: + minLength: 1 + description: A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. + type: string + maxLength: 2048 + Type: + pattern: ^[a-zA-Z\.]+ + description: 'The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform' + type: string + KmsKeyIdentifier: + pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$ + description: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. + type: string + Description: + minLength: 0 + description: A description of the configuration profile. + type: string + maxLength: 1024 + KmsKeyArn: + minLength: 20 + pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ + description: The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service. + type: string + maxLength: 2048 + Validators: + maxItems: 2 + uniqueItems: false + description: A list of methods for validating the configuration. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Validators' + RetrievalRoleArn: + minLength: 20 + pattern: ^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov|aws-eusc):(iam)::\d{12}:role[/].*)$ + description: The ARN of an IAM role with permission to access the configuration at the specified LocationUri. + type: string + maxLength: 2048 + DeletionProtectionCheck: + description: On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html + type: string + enum: + - ACCOUNT_DEFAULT + - APPLY + - BYPASS + ApplicationId: + pattern: '[a-z0-9]{4,7}' + description: The application ID. + type: string + Tags: + uniqueItems: false + description: Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tags' + Name: + minLength: 1 + description: A name for the configuration profile. + type: string + maxLength: 128 + x-stackQL-stringOnly: true + x-title: CreateConfigurationProfileRequest + type: object + required: [] + CreateDeploymentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeploymentStrategyId: + description: The deployment strategy ID. + type: string + ConfigurationProfileId: + description: The configuration profile ID. + type: string + EnvironmentId: + description: The environment ID. + type: string + KmsKeyIdentifier: + pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\d{1}:\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$ + description: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. + type: string + Description: + description: A description of the deployment. + type: string + ConfigurationVersion: + description: The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number. + type: string + State: + description: The state of the deployment. + type: string + enum: + - BAKING + - VALIDATING + - DEPLOYING + - COMPLETE + - ROLLING_BACK + - ROLLED_BACK + - REVERTED + DeploymentNumber: + description: The sequence number of the deployment. + type: string + ApplicationId: + description: The application ID. + type: string + DynamicExtensionParameters: + uniqueItems: false + type: array + items: + $ref: '#/components/schemas/DynamicExtensionParameters' + Tags: + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDeploymentRequest + type: object + required: [] + CreateDeploymentStrategyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeploymentDurationInMinutes: + type: number + description: Total amount of time for a deployment to last. + Description: + type: string + description: A description of the deployment strategy. + FinalBakeTimeInMinutes: + type: number + description: >- + Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS + AppConfig User Guide. + GrowthFactor: + type: number + description: The percentage of targets to receive a deployed configuration during each interval. + GrowthType: + type: string + description: |- + The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: + + Linear: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. + + Exponential: For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: + + 2*(2^0) + + 2*(2^1) + + 2*(2^2) + + Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. + enum: + - EXPONENTIAL + - LINEAR + Name: + type: string + description: A name for the deployment strategy. + ReplicateTo: + type: string + description: Save the deployment strategy to a Systems Manager (SSM) document. + enum: + - NONE + - SSM_DOCUMENT + Tags: + type: array + description: Assigns metadata to an AWS AppConfig resource. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Id: + type: string + description: The deployment strategy ID. + x-stackQL-stringOnly: true + x-title: CreateDeploymentStrategyRequest + type: object + required: [] + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EnvironmentId: + pattern: '[a-z0-9]{4,7}' + description: The environment ID. + type: string + Description: + minLength: 0 + description: A description of the environment. + type: string + maxLength: 1024 + Monitors: + minItems: 0 + maxItems: 5 + description: Amazon CloudWatch alarms to monitor during the deployment process. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Monitor' + DeletionProtectionCheck: + description: On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html + type: string + enum: + - ACCOUNT_DEFAULT + - APPLY + - BYPASS + ApplicationId: + pattern: '[a-z0-9]{4,7}' + description: The application ID. + type: string + Tags: + uniqueItems: true + description: Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + Name: + minLength: 1 + description: A name for the environment. + type: string + maxLength: 64 + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + CreateExtensionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + VersionNumber: + type: integer + Name: + description: Name of the extension. + type: string + Description: + description: Description of the extension. + type: string + Actions: + type: object + x-patternProperties: + ^.+$: + $ref: '#/components/schemas/Actions' + additionalProperties: false + Parameters: + type: object + x-patternProperties: + ^.+$: + $ref: '#/components/schemas/Parameter' + additionalProperties: false + LatestVersionNumber: + type: integer + Tags: + description: An array of key-value tags to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateExtensionRequest + type: object + required: [] + CreateExtensionAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + ExtensionArn: + type: string + ResourceArn: + type: string + ExtensionIdentifier: + type: string + ResourceIdentifier: + type: string + ExtensionVersionNumber: + type: integer + Parameters: + type: object + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateExtensionAssociationRequest + type: object + required: [] + CreateHostedConfigurationVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConfigurationProfileId: + pattern: '[a-z0-9]{4,7}' + description: The configuration profile ID. + type: string + Description: + minLength: 0 + description: A description of the hosted configuration version. + type: string + maxLength: 1024 + ContentType: + minLength: 1 + description: A standard MIME type describing the format of the configuration content. + type: string + maxLength: 255 + LatestVersionNumber: + description: An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version. + type: integer + Content: + description: The content of the configuration or the configuration data. + type: string + VersionLabel: + minLength: 0 + pattern: ^$|.*[^0-9].* + description: A user-defined label for an AWS AppConfig hosted configuration version. + type: string + maxLength: 64 + ApplicationId: + pattern: '[a-z0-9]{4,7}' + description: The application ID. + type: string + VersionNumber: + description: Current version number of hosted configuration version. + type: string + x-stackQL-stringOnly: true + x-title: CreateHostedConfigurationVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.appconfig.applications x-cfn-schema-name: Application - x-type: list + x-cfn-type-name: AWS::AppConfig::Application + x-identifiers: + - ApplicationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.appconfig.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::AppConfig::Application x-identifiers: - ApplicationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -542,49 +1791,120 @@ components: json_extract_path_text(Properties, 'ApplicationId') as application_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Application' AND region = 'us-east-1' - application: - name: application - id: awscc.appconfig.application - x-cfn-schema-name: Application - x-type: get + configuration_profiles: + name: configuration_profiles + id: awscc.appconfig.configuration_profiles + x-cfn-schema-name: ConfigurationProfile + x-cfn-type-name: AWS::AppConfig::ConfigurationProfile x-identifiers: - ApplicationId + - ConfigurationProfileId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::ConfigurationProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::ConfigurationProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::ConfigurationProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id, + JSON_EXTRACT(Properties, '$.LocationUri') as location_uri, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, + JSON_EXTRACT(Properties, '$.Validators') as validators, + JSON_EXTRACT(Properties, '$.RetrievalRoleArn') as retrieval_role_arn, + JSON_EXTRACT(Properties, '$.DeletionProtectionCheck') as deletion_protection_check, JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Application' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, + json_extract_path_text(Properties, 'LocationUri') as location_uri, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Validators') as validators, + json_extract_path_text(Properties, 'RetrievalRoleArn') as retrieval_role_arn, + json_extract_path_text(Properties, 'DeletionProtectionCheck') as deletion_protection_check, json_extract_path_text(Properties, 'ApplicationId') as application_id, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Application' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' + AND data__Identifier = '|' AND region = 'us-east-1' - configuration_profiles: - name: configuration_profiles - id: awscc.appconfig.configuration_profiles + configuration_profiles_list_only: + name: configuration_profiles_list_only + id: awscc.appconfig.configuration_profiles_list_only x-cfn-schema-name: ConfigurationProfile - x-type: list + x-cfn-type-name: AWS::AppConfig::ConfigurationProfile x-identifiers: - ApplicationId - ConfigurationProfileId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -605,64 +1925,107 @@ components: json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' AND region = 'us-east-1' - configuration_profile: - name: configuration_profile - id: awscc.appconfig.configuration_profile - x-cfn-schema-name: ConfigurationProfile - x-type: get + deployments: + name: deployments + id: awscc.appconfig.deployments + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::AppConfig::Deployment x-identifiers: - ApplicationId - - ConfigurationProfileId + - EnvironmentId + - DeploymentNumber + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LocationUri') as location_uri, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Validators') as validators, - JSON_EXTRACT(Properties, '$.RetrievalRoleArn') as retrieval_role_arn, + JSON_EXTRACT(Properties, '$.DeploymentStrategyId') as deployment_strategy_id, JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, - JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ConfigurationVersion') as configuration_version, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.DeploymentNumber') as deployment_number, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.DynamicExtensionParameters') as dynamic_extension_parameters, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Deployment' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LocationUri') as location_uri, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Validators') as validators, - json_extract_path_text(Properties, 'RetrievalRoleArn') as retrieval_role_arn, + json_extract_path_text(Properties, 'DeploymentStrategyId') as deployment_strategy_id, json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ConfigurationVersion') as configuration_version, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'DeploymentNumber') as deployment_number, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'DynamicExtensionParameters') as dynamic_extension_parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Deployment' + AND data__Identifier = '||' AND region = 'us-east-1' - environments: - name: environments - id: awscc.appconfig.environments - x-cfn-schema-name: Environment - x-type: list + deployments_list_only: + name: deployments_list_only + id: awscc.appconfig.deployments_list_only + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::AppConfig::Deployment x-identifiers: - ApplicationId - EnvironmentId + - DeploymentNumber + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -671,8 +2034,9 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.DeploymentNumber') as deployment_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Deployment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -680,56 +2044,238 @@ components: SELECT region, json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'DeploymentNumber') as deployment_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Deployment' + AND region = 'us-east-1' + deployment_strategies: + name: deployment_strategies + id: awscc.appconfig.deployment_strategies + x-cfn-schema-name: DeploymentStrategy + x-cfn-type-name: AWS::AppConfig::DeploymentStrategy + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeploymentStrategy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::DeploymentStrategy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::DeploymentStrategy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::DeploymentStrategy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployment_strategies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployment_strategies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deployment_strategies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DeploymentDurationInMinutes') as deployment_duration_in_minutes, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FinalBakeTimeInMinutes') as final_bake_time_in_minutes, + JSON_EXTRACT(Properties, '$.GrowthFactor') as growth_factor, + JSON_EXTRACT(Properties, '$.GrowthType') as growth_type, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ReplicateTo') as replicate_to, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::DeploymentStrategy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeploymentDurationInMinutes') as deployment_duration_in_minutes, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FinalBakeTimeInMinutes') as final_bake_time_in_minutes, + json_extract_path_text(Properties, 'GrowthFactor') as growth_factor, + json_extract_path_text(Properties, 'GrowthType') as growth_type, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ReplicateTo') as replicate_to, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::DeploymentStrategy' + AND data__Identifier = '' + AND region = 'us-east-1' + deployment_strategies_list_only: + name: deployment_strategies_list_only + id: awscc.appconfig.deployment_strategies_list_only + x-cfn-schema-name: DeploymentStrategy + x-cfn-type-name: AWS::AppConfig::DeploymentStrategy + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::DeploymentStrategy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::DeploymentStrategy' AND region = 'us-east-1' - environment: - name: environment - id: awscc.appconfig.environment + environments: + name: environments + id: awscc.appconfig.environments x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::AppConfig::Environment x-identifiers: - ApplicationId - EnvironmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Monitors') as monitors, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.DeletionProtectionCheck') as deletion_protection_check, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Environment' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Monitors') as monitors, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'DeletionProtectionCheck') as deletion_protection_check, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Environment' AND data__Identifier = '|' AND region = 'us-east-1' - extensions: - name: extensions - id: awscc.appconfig.extensions - x-cfn-schema-name: Extension - x-type: list + environments_list_only: + name: environments_list_only + id: awscc.appconfig.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::AppConfig::Environment x-identifiers: - - Id + - ApplicationId + - EnvironmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -737,28 +2283,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' AND region = 'us-east-1' - extension: - name: extension - id: awscc.appconfig.extension + extensions: + name: extensions + id: awscc.appconfig.extensions x-cfn-schema-name: Extension - x-type: get + x-cfn-type-name: AWS::AppConfig::Extension x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Extension&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Extension" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Extension" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::Extension" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/extensions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/extensions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/extensions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -776,7 +2372,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -793,13 +2389,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Extension' AND data__Identifier = '' AND region = 'us-east-1' - extension_associations: - name: extension_associations - id: awscc.appconfig.extension_associations - x-cfn-schema-name: ExtensionAssociation - x-type: list + extensions_list_only: + name: extensions_list_only + id: awscc.appconfig.extensions_list_only + x-cfn-schema-name: Extension + x-cfn-type-name: AWS::AppConfig::Extension x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -808,7 +2410,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -816,19 +2418,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' AND region = 'us-east-1' - extension_association: - name: extension_association - id: awscc.appconfig.extension_association + extension_associations: + name: extension_associations + id: awscc.appconfig.extension_associations x-cfn-schema-name: ExtensionAssociation - x-type: get + x-cfn-type-name: AWS::AppConfig::ExtensionAssociation x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ExtensionAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::ExtensionAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::ExtensionAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::ExtensionAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/extension_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/extension_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/extension_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -846,7 +2496,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -863,46 +2513,132 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' AND data__Identifier = '' AND region = 'us-east-1' + extension_associations_list_only: + name: extension_associations_list_only + id: awscc.appconfig.extension_associations_list_only + x-cfn-schema-name: ExtensionAssociation + x-cfn-type-name: AWS::AppConfig::ExtensionAssociation + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' + AND region = 'us-east-1' hosted_configuration_versions: name: hosted_configuration_versions id: awscc.appconfig.hosted_configuration_versions x-cfn-schema-name: HostedConfigurationVersion - x-type: list + x-cfn-type-name: AWS::AppConfig::HostedConfigurationVersion x-identifiers: - ApplicationId - ConfigurationProfileId - VersionNumber + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HostedConfigurationVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::HostedConfigurationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppConfig::HostedConfigurationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hosted_configuration_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hosted_configuration_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + data__Identifier, JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ContentType') as content_type, + JSON_EXTRACT(Properties, '$.LatestVersionNumber') as latest_version_number, + JSON_EXTRACT(Properties, '$.Content') as content, + JSON_EXTRACT(Properties, '$.VersionLabel') as version_label, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, JSON_EXTRACT(Properties, '$.VersionNumber') as version_number - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'ApplicationId') as application_id, + data__Identifier, json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'VersionLabel') as version_label, + json_extract_path_text(Properties, 'ApplicationId') as application_id, json_extract_path_text(Properties, 'VersionNumber') as version_number - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' + AND data__Identifier = '||' AND region = 'us-east-1' - hosted_configuration_version: - name: hosted_configuration_version - id: awscc.appconfig.hosted_configuration_version + hosted_configuration_versions_list_only: + name: hosted_configuration_versions_list_only + id: awscc.appconfig.hosted_configuration_versions_list_only x-cfn-schema-name: HostedConfigurationVersion - x-type: get + x-cfn-type-name: AWS::AppConfig::HostedConfigurationVersion x-identifiers: - ApplicationId - ConfigurationProfileId - VersionNumber + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -910,32 +2646,507 @@ components: ddl: |- SELECT region, - data__Identifier, JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id, - JSON_EXTRACT(Properties, '$.VersionNumber') as version_number, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Content') as content, - JSON_EXTRACT(Properties, '$.ContentType') as content_type, - JSON_EXTRACT(Properties, '$.LatestVersionNumber') as latest_version_number, - JSON_EXTRACT(Properties, '$.VersionLabel') as version_label - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, json_extract_path_text(Properties, 'ApplicationId') as application_id, json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, - json_extract_path_text(Properties, 'VersionNumber') as version_number, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'ContentType') as content_type, - json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, - json_extract_path_text(Properties, 'VersionLabel') as version_label - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' - AND data__Identifier = '||' + json_extract_path_text(Properties, 'VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeployment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeploymentStrategy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeploymentStrategy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentStrategyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Extension&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateExtension + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateExtensionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ExtensionAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateExtensionAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateExtensionAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HostedConfigurationVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHostedConfigurationVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHostedConfigurationVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/appflow.yaml b/providers/src/awscc/v00.00.00000/services/appflow.yaml index 1a213fb8..d63f0728 100644 --- a/providers/src/awscc/v00.00.00000/services/appflow.yaml +++ b/providers/src/awscc/v00.00.00000/services/appflow.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: AppFlow - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ConnectorProvisioningConfig: description: Contains information about the configuration of the connector being registered. @@ -36,7 +416,7 @@ components: ConnectorArn: description: ' The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.' type: string - pattern: arn:*:appflow:.*:[0-9]+:.* + pattern: arn:.*:appflow:.*:[0-9]+:.* maxLength: 512 ConnectorProvisioningType: description: 'The provisioning type of the connector. Currently the only supported value is LAMBDA. ' @@ -56,12 +436,22 @@ components: - ConnectorProvisioningType - ConnectorProvisioningConfig x-stackql-resource-name: connector - x-stackql-primaryIdentifier: + description: Resource schema for AWS::AppFlow::Connector + x-type-name: AWS::AppFlow::Connector + x-stackql-primary-identifier: - ConnectorLabel x-create-only-properties: - ConnectorLabel x-read-only-properties: - ConnectorArn + x-required-properties: + - ConnectorProvisioningType + - ConnectorProvisioningConfig + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - appflow:RegisterConnector @@ -949,15 +1339,29 @@ components: - ConnectionMode - ConnectorType x-stackql-resource-name: connector_profile - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppFlow::ConnectorProfile + x-type-name: AWS::AppFlow::ConnectorProfile + x-stackql-primary-identifier: - ConnectorProfileName x-create-only-properties: - ConnectorProfileName - ConnectorType - ConnectorLabel + x-write-only-properties: + - ConnectorProfileConfig + - KMSArn x-read-only-properties: - ConnectorProfileArn - CredentialsArn + x-required-properties: + - ConnectorProfileName + - ConnectionMode + - ConnectorType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - appflow:CreateConnectorProfile @@ -2231,13 +2635,31 @@ components: - DestinationFlowConfigList - TriggerConfig x-stackql-resource-name: flow - x-stackql-primaryIdentifier: + description: Resource schema for AWS::AppFlow::Flow. + x-type-name: AWS::AppFlow::Flow + x-stackql-primary-identifier: - FlowName x-create-only-properties: - FlowName - KMSArn x-read-only-properties: - FlowArn + x-required-properties: + - FlowName + - Tasks + - SourceFlowConfig + - DestinationFlowConfigList + - TriggerConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - appflow:TagResource + - appflow:UntagResource + - appflow:ListTagsForResource x-required-permissions: create: - appflow:CreateFlow @@ -2260,6 +2682,7 @@ components: - appflow:DescribeFlow - appflow:ListTagsForResource update: + - appflow:DescribeFlow - appflow:UpdateFlow - appflow:StartFlow - appflow:StopFlow @@ -2278,43 +2701,239 @@ components: - appflow:DeleteFlow list: - appflow:ListFlows + CreateConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectorLabel: + description: ' The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.' + type: string + pattern: '[a-zA-Z0-9][\w!@#.-]+' + maxLength: 512 + ConnectorArn: + description: ' The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account.' + type: string + pattern: arn:.*:appflow:.*:[0-9]+:.* + maxLength: 512 + ConnectorProvisioningType: + description: 'The provisioning type of the connector. Currently the only supported value is LAMBDA. ' + type: string + pattern: '[a-zA-Z0-9][\w!@#.-]+' + maxLength: 256 + minLength: 1 + ConnectorProvisioningConfig: + description: Contains information about the configuration of the connector being registered. + $ref: '#/components/schemas/ConnectorProvisioningConfig' + Description: + description: A description about the connector that's being registered. + type: string + pattern: '[\s\w/!@#+=.-]*' + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreateConnectorRequest + type: object + required: [] + CreateConnectorProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectorProfileArn: + description: Unique identifier for connector profile resources + type: string + pattern: arn:aws:appflow:.*:[0-9]+:.* + maxLength: 512 + ConnectorLabel: + description: The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/. + type: string + pattern: '[\w!@#.-]+' + maxLength: 256 + ConnectorProfileName: + description: The maximum number of items to retrieve in a single batch. + type: string + pattern: '[\w/!@#+=.-]+' + maxLength: 256 + KMSArn: + description: The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. + type: string + pattern: arn:aws:kms:.*:[0-9]+:.* + maxLength: 2048 + minLength: 20 + ConnectorType: + description: List of Saas providers that need connector profile to be created + $ref: '#/components/schemas/ConnectorType' + ConnectionMode: + description: Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular + type: string + enum: + - Public + - Private + ConnectorProfileConfig: + description: Connector specific configurations needed to create connector profile + $ref: '#/components/schemas/ConnectorProfileConfig' + CredentialsArn: + description: A unique Arn for Connector-Profile resource + type: string + pattern: arn:aws:.*:.*:[0-9]+:.* + maxLength: 512 + x-stackQL-stringOnly: true + x-title: CreateConnectorProfileRequest + type: object + required: [] + CreateFlowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + description: ARN identifier of the flow. + type: string + pattern: arn:aws:appflow:.*:[0-9]+:.* + maxLength: 512 + FlowName: + description: Name of the flow. + type: string + pattern: '[a-zA-Z0-9][\w!@#.-]+' + maxLength: 256 + minLength: 1 + Description: + description: Description of the flow. + type: string + pattern: '[\w!@#\-.?,\s]*' + maxLength: 2048 + KMSArn: + description: The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. + type: string + pattern: arn:aws:kms:.*:[0-9]+:.* + maxLength: 2048 + minLength: 20 + TriggerConfig: + description: Trigger settings of the flow. + $ref: '#/components/schemas/TriggerConfig' + FlowStatus: + description: Flow activation status for Scheduled- and Event-triggered flows + type: string + enum: + - Active + - Suspended + - Draft + SourceFlowConfig: + description: Configurations of Source connector of the flow. + $ref: '#/components/schemas/SourceFlowConfig' + DestinationFlowConfigList: + description: List of Destination connectors of the flow. + type: array + items: + $ref: '#/components/schemas/DestinationFlowConfig' + Tasks: + description: List of tasks for the flow. + type: array + items: + $ref: '#/components/schemas/Task' + Tags: + description: List of Tags. + type: array + items: + $ref: '#/components/schemas/Tag' + MetadataCatalogConfig: + description: Configurations of metadata catalog of the flow. + $ref: '#/components/schemas/MetadataCatalogConfig' + x-stackQL-stringOnly: true + x-title: CreateFlowRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: connectors: name: connectors id: awscc.appflow.connectors x-cfn-schema-name: Connector - x-type: list - x-identifiers: - - ConnectorLabel - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorLabel') as connector_label - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorLabel') as connector_label - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' - AND region = 'us-east-1' - connector: - name: connector - id: awscc.appflow.connector - x-cfn-schema-name: Connector - x-type: get + x-cfn-type-name: AWS::AppFlow::Connector x-identifiers: - ConnectorLabel + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2328,7 +2947,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2341,13 +2960,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::Connector' AND data__Identifier = '' AND region = 'us-east-1' - connector_profiles: - name: connector_profiles - id: awscc.appflow.connector_profiles - x-cfn-schema-name: ConnectorProfile - x-type: list + connectors_list_only: + name: connectors_list_only + id: awscc.appflow.connectors_list_only + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::AppFlow::Connector x-identifiers: - - ConnectorProfileName + - ConnectorLabel + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2355,28 +2980,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConnectorProfileName') as connector_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' + JSON_EXTRACT(Properties, '$.ConnectorLabel') as connector_label + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConnectorProfileName') as connector_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' + json_extract_path_text(Properties, 'ConnectorLabel') as connector_label + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' AND region = 'us-east-1' - connector_profile: - name: connector_profile - id: awscc.appflow.connector_profile + connector_profiles: + name: connector_profiles + id: awscc.appflow.connector_profiles x-cfn-schema-name: ConnectorProfile - x-type: get + x-cfn-type-name: AWS::AppFlow::ConnectorProfile x-identifiers: - ConnectorProfileName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConnectorProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::ConnectorProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::ConnectorProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::ConnectorProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2393,7 +3066,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2409,13 +3082,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' AND data__Identifier = '' AND region = 'us-east-1' - flows: - name: flows - id: awscc.appflow.flows - x-cfn-schema-name: Flow - x-type: list + connector_profiles_list_only: + name: connector_profiles_list_only + id: awscc.appflow.connector_profiles_list_only + x-cfn-schema-name: ConnectorProfile + x-cfn-type-name: AWS::AppFlow::ConnectorProfile x-identifiers: - - FlowName + - ConnectorProfileName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2423,28 +3102,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FlowName') as flow_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' + JSON_EXTRACT(Properties, '$.ConnectorProfileName') as connector_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FlowName') as flow_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' + json_extract_path_text(Properties, 'ConnectorProfileName') as connector_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' AND region = 'us-east-1' - flow: - name: flow - id: awscc.appflow.flow + flows: + name: flows + id: awscc.appflow.flows x-cfn-schema-name: Flow - x-type: get + x-cfn-type-name: AWS::AppFlow::Flow x-identifiers: - FlowName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Flow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppFlow::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2464,7 +3191,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2483,3 +3210,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::Flow' AND data__Identifier = '' AND region = 'us-east-1' + flows_list_only: + name: flows_list_only + id: awscc.appflow.flows_list_only + x-cfn-schema-name: Flow + x-cfn-type-name: AWS::AppFlow::Flow + x-identifiers: + - FlowName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FlowName') as flow_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FlowName') as flow_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConnectorProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnectorProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Flow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/appintegrations.yaml b/providers/src/awscc/v00.00.00000/services/appintegrations.yaml index 115bbe61..fff73048 100644 --- a/providers/src/awscc/v00.00.00000/services/appintegrations.yaml +++ b/providers/src/awscc/v00.00.00000/services/appintegrations.yaml @@ -1,10 +1,579 @@ openapi: 3.0.0 info: title: AppIntegrations - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + type: object + properties: + Key: + description: A key to identify the tag. + type: string + pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ + minLength: 1 + maxLength: 128 + Value: + description: Corresponding tag value for the key. + type: string + minLength: 0 + maxLength: 256 + additionalProperties: false + required: + - Key + - Value + ExternalUrlConfig: + type: object + additionalProperties: false + required: + - AccessUrl + properties: + AccessUrl: + type: string + pattern: ^\w+\:\/\/.*$ + minLength: 1 + maxLength: 1000 + ApprovedOrigins: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ApprovedOrigins' + minItems: 0 + maxItems: 50 + ApprovedOrigins: + type: string + pattern: ^\w+\:\/\/.*$ + minLength: 1 + maxLength: 1000 + Permissions: + type: string + pattern: ^[a-zA-Z0-9\/\._\-\*]+$ + minLength: 1 + maxLength: 255 + ContactHandling: + type: object + additionalProperties: false + properties: + Scope: + type: string + enum: + - CROSS_CONTACTS + - PER_CONTACT + required: + - Scope + ApplicationConfig: + type: object + additionalProperties: false + properties: + ContactHandling: + $ref: '#/components/schemas/ContactHandling' + IframeConfig: + type: object + additionalProperties: false + properties: + Allow: + type: array + x-insertionOrder: false + items: + type: string + Sandbox: + type: array + x-insertionOrder: false + items: + type: string + Application: + type: object + properties: + Name: + description: The name of the application. + type: string + pattern: ^[a-zA-Z0-9\/\._ \-]+$ + minLength: 1 + maxLength: 255 + Id: + description: The id of the application. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + Namespace: + description: The namespace of the application. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + Description: + description: The application description. + type: string + minLength: 1 + maxLength: 1000 + ApplicationArn: + description: The Amazon Resource Name (ARN) of the application. + pattern: ^arn:aws[-a-z0-9]*:app-integrations:[-a-z0-9]*:[0-9]{12}:application/[-a-zA-Z0-9]* + type: string + minLength: 1 + maxLength: 2048 + ApplicationSourceConfig: + description: Application source config + type: object + additionalProperties: false + properties: + ExternalUrlConfig: + $ref: '#/components/schemas/ExternalUrlConfig' + required: + - ExternalUrlConfig + Permissions: + description: The configuration of events or requests that the application has access to. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Permissions' + minItems: 0 + maxItems: 150 + Tags: + description: The tags (keys and values) associated with the application. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 200 + IsService: + description: Indicates if the application is a service + type: boolean + default: false + InitializationTimeout: + description: The initialization timeout in milliseconds. Required when IsService is true. + type: integer + ApplicationConfig: + description: The application configuration. Cannot be used when IsService is true. + $ref: '#/components/schemas/ApplicationConfig' + IframeConfig: + description: The iframe configuration + $ref: '#/components/schemas/IframeConfig' + required: + - Name + - Namespace + - Description + - ApplicationSourceConfig + x-stackql-resource-name: application + description: Resource Type definition for AWS:AppIntegrations::Application + x-type-name: AWS::AppIntegrations::Application + x-stackql-primary-identifier: + - ApplicationArn + x-read-only-properties: + - ApplicationArn + - Id + x-required-properties: + - Name + - Namespace + - Description + - ApplicationSourceConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - app-integrations:TagResource + - app-integrations:UntagResource + x-required-permissions: + create: + - app-integrations:CreateApplication + - app-integrations:TagResource + read: + - app-integrations:GetApplication + list: + - app-integrations:ListApplications + - app-integrations:ListTagsForResource + update: + - app-integrations:GetApplication + - app-integrations:UpdateApplication + - app-integrations:TagResource + - app-integrations:UntagResource + delete: + - app-integrations:DeleteApplication ScheduleConfig: type: object properties: @@ -29,24 +598,6 @@ components: additionalProperties: false required: - ScheduleExpression - Tag: - type: object - properties: - Key: - description: A key to identify the tag. - type: string - pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ - minLength: 1 - maxLength: 128 - Value: - description: Corresponding tag value for the key. - type: string - minLength: 0 - maxLength: 256 - additionalProperties: false - required: - - Key - - Value FileConfiguration: description: The configuration for what files should be pulled from the source. type: object @@ -153,7 +704,9 @@ components: - KmsKey - SourceURI x-stackql-resource-name: data_integration - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppIntegrations::DataIntegration + x-type-name: AWS::AppIntegrations::DataIntegration + x-stackql-primary-identifier: - Id x-create-only-properties: - KmsKey @@ -162,6 +715,19 @@ components: x-read-only-properties: - Id - DataIntegrationArn + x-required-properties: + - Name + - KmsKey + - SourceURI + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - app-integrations:TagResource + - app-integrations:UntagResource x-required-permissions: create: - app-integrations:CreateDataIntegration @@ -222,7 +788,7 @@ components: Source: description: The source of the events. type: string - pattern: ^aws\.partner\/.*$ + pattern: ^aws\.(partner\/.*|cases)$ minLength: 1 maxLength: 256 additionalProperties: false @@ -288,7 +854,9 @@ components: - EventBridgeBus - EventFilter x-stackql-resource-name: event_integration - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppIntegrations::EventIntegration + x-type-name: AWS::AppIntegrations::EventIntegration + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -296,6 +864,19 @@ components: - EventFilter x-read-only-properties: - EventIntegrationArn + x-required-properties: + - Name + - EventBridgeBus + - EventFilter + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - app-integrations:TagResource + - app-integrations:UntagResource x-required-permissions: create: - app-integrations:CreateEventIntegration @@ -312,14 +893,327 @@ components: - app-integrations:UntagResource delete: - app-integrations:DeleteEventIntegration + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the application. + type: string + pattern: ^[a-zA-Z0-9\/\._ \-]+$ + minLength: 1 + maxLength: 255 + Id: + description: The id of the application. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + Namespace: + description: The namespace of the application. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + Description: + description: The application description. + type: string + minLength: 1 + maxLength: 1000 + ApplicationArn: + description: The Amazon Resource Name (ARN) of the application. + pattern: ^arn:aws[-a-z0-9]*:app-integrations:[-a-z0-9]*:[0-9]{12}:application/[-a-zA-Z0-9]* + type: string + minLength: 1 + maxLength: 2048 + ApplicationSourceConfig: + description: Application source config + type: object + additionalProperties: false + properties: + ExternalUrlConfig: + $ref: '#/components/schemas/ExternalUrlConfig' + required: + - ExternalUrlConfig + Permissions: + description: The configuration of events or requests that the application has access to. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Permissions' + minItems: 0 + maxItems: 150 + Tags: + description: The tags (keys and values) associated with the application. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 200 + IsService: + description: Indicates if the application is a service + type: boolean + default: false + InitializationTimeout: + description: The initialization timeout in milliseconds. Required when IsService is true. + type: integer + ApplicationConfig: + description: The application configuration. Cannot be used when IsService is true. + $ref: '#/components/schemas/ApplicationConfig' + IframeConfig: + description: The iframe configuration + $ref: '#/components/schemas/IframeConfig' + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateDataIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: The data integration description. + type: string + minLength: 1 + maxLength: 1000 + Id: + description: The unique identifer of the data integration. + type: string + pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' + minLength: 1 + maxLength: 255 + DataIntegrationArn: + description: The Amazon Resource Name (ARN) of the data integration. + type: string + pattern: ^arn:aws[-a-z]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + minLength: 1 + maxLength: 2048 + Name: + description: The name of the data integration. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + KmsKey: + description: The KMS key of the data integration. + type: string + pattern: .*\S.* + minLength: 1 + maxLength: 255 + ScheduleConfig: + description: The name of the data and how often it should be pulled from the source. + $ref: '#/components/schemas/ScheduleConfig' + SourceURI: + description: The URI of the data source. + type: string + pattern: ^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$) + minLength: 1 + maxLength: 1000 + Tags: + description: The tags (keys and values) associated with the data integration. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 200 + FileConfiguration: + description: The configuration for what files should be pulled from the source. + $ref: '#/components/schemas/FileConfiguration' + ObjectConfiguration: + description: The configuration for what data should be pulled from the source. + $ref: '#/components/schemas/ObjectConfiguration' + x-stackQL-stringOnly: true + x-title: CreateDataIntegrationRequest + type: object + required: [] + CreateEventIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: The event integration description. + type: string + minLength: 1 + maxLength: 1000 + EventIntegrationArn: + description: The Amazon Resource Name (ARN) of the event integration. + type: string + pattern: ^arn:aws[-a-z]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + minLength: 1 + maxLength: 2048 + Name: + description: The name of the event integration. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + EventBridgeBus: + description: The Amazon Eventbridge bus for the event integration. + type: string + pattern: ^[a-zA-Z0-9/\._\-]+$ + minLength: 1 + maxLength: 255 + EventFilter: + description: The EventFilter (source) associated with the event integration. + $ref: '#/components/schemas/EventFilter' + Tags: + description: The tags (keys and values) associated with the event integration. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 200 + x-stackQL-stringOnly: true + x-title: CreateEventIntegrationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - data_integrations: - name: data_integrations - id: awscc.appintegrations.data_integrations - x-cfn-schema-name: DataIntegration - x-type: list + applications: + name: applications + id: awscc.appintegrations.applications + x-cfn-schema-name: Application + x-cfn-type-name: AWS::AppIntegrations::Application x-identifiers: - - Id + - ApplicationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Namespace') as namespace, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ApplicationSourceConfig') as application_source_config, + JSON_EXTRACT(Properties, '$.Permissions') as permissions, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.IsService') as is_service, + JSON_EXTRACT(Properties, '$.InitializationTimeout') as initialization_timeout, + JSON_EXTRACT(Properties, '$.ApplicationConfig') as application_config, + JSON_EXTRACT(Properties, '$.IframeConfig') as iframe_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationSourceConfig') as application_source_config, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IsService') as is_service, + json_extract_path_text(Properties, 'InitializationTimeout') as initialization_timeout, + json_extract_path_text(Properties, 'ApplicationConfig') as application_config, + json_extract_path_text(Properties, 'IframeConfig') as iframe_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.appintegrations.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::AppIntegrations::Application + x-identifiers: + - ApplicationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -327,28 +1221,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::Application' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' + json_extract_path_text(Properties, 'ApplicationArn') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::Application' AND region = 'us-east-1' - data_integration: - name: data_integration - id: awscc.appintegrations.data_integration + data_integrations: + name: data_integrations + id: awscc.appintegrations.data_integrations x-cfn-schema-name: DataIntegration - x-type: get + x-cfn-type-name: AWS::AppIntegrations::DataIntegration x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataIntegration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::DataIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::DataIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::DataIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -367,7 +1309,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -385,13 +1327,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' AND data__Identifier = '' AND region = 'us-east-1' - event_integrations: - name: event_integrations - id: awscc.appintegrations.event_integrations - x-cfn-schema-name: EventIntegration - x-type: list + data_integrations_list_only: + name: data_integrations_list_only + id: awscc.appintegrations.data_integrations_list_only + x-cfn-schema-name: DataIntegration + x-cfn-type-name: AWS::AppIntegrations::DataIntegration x-identifiers: - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -399,28 +1347,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' AND region = 'us-east-1' - event_integration: - name: event_integration - id: awscc.appintegrations.event_integration + event_integrations: + name: event_integrations + id: awscc.appintegrations.event_integrations x-cfn-schema-name: EventIntegration - x-type: get + x-cfn-type-name: AWS::AppIntegrations::EventIntegration x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventIntegration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::EventIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::EventIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppIntegrations::EventIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -435,7 +1431,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -449,3 +1445,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' AND data__Identifier = '' AND region = 'us-east-1' + event_integrations_list_only: + name: event_integrations_list_only + id: awscc.appintegrations.event_integrations_list_only + x-cfn-schema-name: EventIntegration + x-cfn-type-name: AWS::AppIntegrations::EventIntegration + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataIntegration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventIntegration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/applicationautoscaling.yaml b/providers/src/awscc/v00.00.00000/services/applicationautoscaling.yaml index 5ac35c9c..39db934b 100644 --- a/providers/src/awscc/v00.00.00000/services/applicationautoscaling.yaml +++ b/providers/src/awscc/v00.00.00000/services/applicationautoscaling.yaml @@ -1,84 +1,542 @@ openapi: 3.0.0 info: title: ApplicationAutoScaling - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: SuspendedState: - type: object + description: |- + ``SuspendedState`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state. + For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide*. additionalProperties: false - description: specifies whether the scaling activities for a scalable target are in a suspended state + type: object properties: - ScheduledScalingSuspended: - type: boolean DynamicScalingOutSuspended: + description: Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``. + type: boolean + ScheduledScalingSuspended: + description: Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``. type: boolean DynamicScalingInSuspended: + description: Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``. type: boolean ScheduledAction: - type: object + description: |- + ``ScheduledAction`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target. + For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide*. additionalProperties: false - description: specifies a scheduled action for a scalable target + type: object properties: Timezone: + description: The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression. type: string ScheduledActionName: + description: The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target. type: string EndTime: + description: The date and time that the action is scheduled to end, in UTC. type: string Schedule: + description: |- + The schedule for this action. The following formats are supported: + + At expressions - "``at(yyyy-mm-ddThh:mm:ss)``" + + Rate expressions - "``rate(valueunit)``" + + Cron expressions - "``cron(fields)``" + + At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. + At and cron expressions use Universal Coordinated Time (UTC) by default. + The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. + For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``. type: string StartTime: + description: The date and time that the action is scheduled to begin, in UTC. type: string ScalableTargetAction: + description: The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. $ref: '#/components/schemas/ScalableTargetAction' required: - ScheduledActionName - Schedule ScalableTargetAction: - type: object + description: '``ScalableTargetAction`` specifies the minimum and maximum capacity for the ``ScalableTargetAction`` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.' additionalProperties: false - description: specifies the minimum and maximum capacity + type: object properties: MinCapacity: + description: The minimum capacity. type: integer MaxCapacity: + description: The maximum capacity. type: integer ScalableTarget: type: object properties: - Id: - description: This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace - type: string - MaxCapacity: - description: The maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand - type: integer - MinCapacity: - description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand - type: integer - ResourceId: - description: The identifier of the resource associated with the scalable target - type: string - RoleARN: - description: 'Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. ' - type: string - ScalableDimension: - description: The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property - type: string ScheduledActions: - description: The scheduled actions for the scalable target. Duplicates aren't allowed. - type: array uniqueItems: true + description: The scheduled actions for the scalable target. Duplicates aren't allowed. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/ScheduledAction' + ResourceId: + description: |- + The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Amazon ElastiCache cache cluster - The resource type is ``cache-cluster`` and the unique identifier is the cache cluster name. Example: ``cache-cluster/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``. + type: string ServiceNamespace: - description: The namespace of the AWS service that provides the resource, or a custom-resource + description: The namespace of the AWS service that provides the resource, or a ``custom-resource``. + type: string + ScalableDimension: + description: |- + The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:cache-cluster:Nodes`` - The number of nodes for an Amazon ElastiCache cache cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. + + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool. type: string SuspendedState: - description: An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. + description: |- + An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. + *Suspension Outcomes* + + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. $ref: '#/components/schemas/SuspendedState' + Id: + description: '' + type: string + MinCapacity: + description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. + type: integer + RoleARN: + description: >- + Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with + IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*. + To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page. + type: string + MaxCapacity: + description: The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. + type: integer required: - ResourceId - ServiceNamespace @@ -86,7 +544,12 @@ components: - MinCapacity - MaxCapacity x-stackql-resource-name: scalable_target - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ApplicationAutoScaling::ScalableTarget`` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource. + For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*. + If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. + x-type-name: AWS::ApplicationAutoScaling::ScalableTarget + x-stackql-primary-identifier: - ResourceId - ScalableDimension - ServiceNamespace @@ -94,9 +557,25 @@ components: - ResourceId - ScalableDimension - ServiceNamespace + x-write-only-properties: + - RoleARN x-read-only-properties: - Id + x-required-properties: + - ResourceId + - ServiceNamespace + - ScalableDimension + - MinCapacity + - MaxCapacity + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - application-autoscaling:DescribeScalableTargets + - application-autoscaling:DescribeScheduledActions create: - application-autoscaling:DescribeScalableTargets - application-autoscaling:RegisterScalableTarget @@ -110,11 +589,6 @@ components: - lambda:GetProvisionedConcurrencyConfig - lambda:PutProvisionedConcurrencyConfig - lambda:DeleteProvisionedConcurrencyConfig - read: - - application-autoscaling:DescribeScalableTargets - - application-autoscaling:DescribeScheduledActions - list: - - application-autoscaling:DescribeScalableTargets update: - application-autoscaling:RegisterScalableTarget - application-autoscaling:DescribeScalableTargets @@ -127,239 +601,602 @@ components: - lambda:GetProvisionedConcurrencyConfig - lambda:PutProvisionedConcurrencyConfig - lambda:DeleteProvisionedConcurrencyConfig + list: + - application-autoscaling:DescribeScalableTargets delete: - application-autoscaling:DeregisterScalableTarget - StepScalingPolicyConfiguration: - description: A step scaling policy. + PredictiveScalingMetricDataQuery: + description: The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp. + additionalProperties: false + type: object + properties: + ReturnData: + description: |- + Indicates whether to return the timestamps and raw data values of this metric. + If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification. + If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``). + type: boolean + Expression: + description: |- + The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + type: string + Label: + description: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. + type: string + MetricStat: + description: |- + Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + $ref: '#/components/schemas/PredictiveScalingMetricStat' + Id: + description: A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. + type: string + TargetTrackingMetricStat: + description: |- + This structure defines the CloudWatch metric to return, along with the statistic and unit. + ``TargetTrackingMetricStat`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property type. + For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*. + additionalProperties: false type: object + properties: + Stat: + description: |- + The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*. + The most commonly used metric for scaling is ``Average``. + type: string + Metric: + description: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + $ref: '#/components/schemas/TargetTrackingMetric' + Unit: + description: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*. + type: string + PredictiveScalingMetricDimension: + description: Describes the dimension of a metric. additionalProperties: false + type: object properties: - AdjustmentType: - description: Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted. + Value: + description: The value of the dimension. type: string - Cooldown: - description: The amount of time, in seconds, to wait for a previous scaling activity to take effect. - type: integer - MetricAggregationType: - description: The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average + Name: + description: The name of the dimension. type: string - MinAdjustmentMagnitude: - description: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. - type: integer - StepAdjustments: - description: A set of adjustments that enable you to scale based on the size of the alarm breach. + TargetTrackingMetricDimension: + description: '``TargetTrackingMetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type. Duplicate dimensions are not allowed.' + additionalProperties: false + type: object + properties: + Value: + description: The value of the dimension. + type: string + Name: + description: The name of the dimension. + type: string + PredictiveScalingCustomizedCapacityMetric: + description: Represents a CloudWatch metric of your choosing for a predictive scaling policy. + additionalProperties: false + type: object + properties: + MetricDataQueries: + uniqueItems: true + description: One or more metric data queries to provide data points for a metric specification. + x-insertionOrder: false type: array + items: + $ref: '#/components/schemas/PredictiveScalingMetricDataQuery' + required: + - MetricDataQueries + TargetTrackingMetricDataQuery: + description: |- + The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp. + You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series. + For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide*. + ``TargetTrackingMetricDataQuery`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. + additionalProperties: false + type: object + properties: + ReturnData: + description: |- + Indicates whether to return the timestamps and raw data values of this metric. + If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification. + If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``). + type: boolean + Expression: + description: |- + The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. + Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + type: string + Label: + description: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. + type: string + MetricStat: + description: |- + Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + $ref: '#/components/schemas/TargetTrackingMetricStat' + Id: + description: A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. + type: string + PredictiveScalingCustomizedScalingMetric: + description: One or more metric data queries to provide data points for a metric specification. + additionalProperties: false + type: object + properties: + MetricDataQueries: uniqueItems: true + description: One or more metric data queries to provide data points for a metric specification. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/StepAdjustment' - TargetTrackingScalingPolicyConfiguration: - description: A target tracking scaling policy. + $ref: '#/components/schemas/PredictiveScalingMetricDataQuery' + required: + - MetricDataQueries + CustomizedMetricSpecification: + description: |- + Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling. + For information about the available metrics for a service, see [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*. + To create your customized metric specification: + + Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*. + + Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases. + + For an example of how creating new metrics can be useful, see [Scaling based on Amazon SQS](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html) in the *Amazon EC2 Auto Scaling User Guide*. This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling. + For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). + ``CustomizedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type. + additionalProperties: false type: object + properties: + MetricName: + description: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + type: string + Metrics: + uniqueItems: false + description: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TargetTrackingMetricDataQuery' + Statistic: + description: The statistic of the metric. + type: string + Dimensions: + uniqueItems: false + description: |- + The dimensions of the metric. + Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/MetricDimension' + Unit: + description: The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*. + type: string + Namespace: + description: The namespace of the metric. + type: string + PredictiveScalingPredefinedLoadMetric: + description: |- + Describes a load metric for a predictive scaling policy. + When returned in the output of ``DescribePolicies``, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair. + The following predefined metrics are available for predictive scaling: + + ``ECSServiceAverageCPUUtilization`` + + ``ECSServiceAverageMemoryUtilization`` + + ``ECSServiceCPUUtilization`` + + ``ECSServiceMemoryUtilization`` + + ``ECSServiceTotalCPUUtilization`` + + ``ECSServiceTotalMemoryUtilization`` + + ``ALBRequestCount`` + + ``ALBRequestCountPerTarget`` + + ``TotalALBRequestCount`` additionalProperties: false + type: object properties: + PredefinedMetricType: + description: The metric type. + type: string + ResourceLabel: + description: A label that uniquely identifies a target group. + type: string + required: + - PredefinedMetricType + TargetTrackingScalingPolicyConfiguration: + description: >- + ``TargetTrackingScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization + remains at or near the target utilization value. + For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User Guide*. + additionalProperties: false + type: object + properties: + ScaleOutCooldown: + description: The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*. + type: integer + TargetValue: + description: The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. + type: number CustomizedMetricSpecification: description: A customized metric. You can specify either a predefined metric or a customized metric. $ref: '#/components/schemas/CustomizedMetricSpecification' DisableScaleIn: - description: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false. + description: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is ``true``, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is ``false``. type: boolean + ScaleInCooldown: + description: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*. + type: integer PredefinedMetricSpecification: description: A predefined metric. You can specify either a predefined metric or a customized metric. $ref: '#/components/schemas/PredefinedMetricSpecification' - ScaleInCooldown: - description: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. - type: integer - ScaleOutCooldown: - description: The amount of time, in seconds, to wait for a previous scale-out activity to take effect. - type: integer - TargetValue: - description: The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. - type: number required: - TargetValue + PredictiveScalingPredefinedMetricPair: + description: |- + Represents a metric pair for a predictive scaling policy. + The following predefined metrics are available for predictive scaling: + + ``ECSServiceAverageCPUUtilization`` + + ``ECSServiceAverageMemoryUtilization`` + + ``ECSServiceCPUUtilization`` + + ``ECSServiceMemoryUtilization`` + + ``ECSServiceTotalCPUUtilization`` + + ``ECSServiceTotalMemoryUtilization`` + + ``ALBRequestCount`` + + ``ALBRequestCountPerTarget`` + + ``TotalALBRequestCount`` + additionalProperties: false + type: object + properties: + PredefinedMetricType: + description: 'Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric.' + type: string + ResourceLabel: + description: A label that uniquely identifies a specific target group from which to determine the total and average request count. + type: string + required: + - PredefinedMetricType + StepAdjustment: + description: |- + ``StepAdjustment`` specifies a step adjustment for the ``StepAdjustments`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property type. + For the following examples, suppose that you have an alarm with a breach threshold of 50: + + To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. + + To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. + + For more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User Guide*. + You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the ``AWS::ApplicationAutoScaling::ScalingPolicy`` documentation. + additionalProperties: false + type: object + properties: + MetricIntervalUpperBound: + description: |- + The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. + You must specify at least one upper or lower bound. + type: number + MetricIntervalLowerBound: + description: |- + The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. + You must specify at least one upper or lower bound. + type: number + ScalingAdjustment: + description: The amount by which to scale. The adjustment is based on the value that you specified in the ``AdjustmentType`` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity. + type: integer + required: + - ScalingAdjustment PredefinedMetricSpecification: - description: Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling. + description: |- + Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling. + ``PredefinedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type. + additionalProperties: false + type: object + properties: + PredefinedMetricType: + description: The metric type. The ``ALBRequestCountPerTarget`` metric type applies only to Spot fleet requests and ECS services. + type: string + ResourceLabel: + description: |- + Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ``ALBRequestCountPerTarget`` and there is a target group attached to the Spot Fleet or ECS service. + You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: + ``app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff``. + Where: + + app// is the final portion of the load balancer ARN + + targetgroup// is the final portion of the target group ARN. + + To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. + type: string + required: + - PredefinedMetricType + MetricDimension: + description: '``MetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. Duplicate dimensions are not allowed.' + additionalProperties: false type: object + properties: + Value: + description: The value of the dimension. + type: string + Name: + description: The name of the dimension. + type: string + required: + - Value + - Name + PredictiveScalingPolicyConfiguration: + description: Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services. additionalProperties: false + type: object + properties: + MaxCapacityBreachBehavior: + description: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. + type: string + MaxCapacityBuffer: + description: |- + The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. + Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. + type: integer + Mode: + description: The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. + type: string + MetricSpecifications: + uniqueItems: true + description: |- + This structure includes the metrics and target utilization to use for predictive scaling. + This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PredictiveScalingMetricSpecification' + SchedulingBufferTime: + description: |- + The amount of time, in seconds, that the start time can be advanced. + The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + type: integer + required: + - MetricSpecifications + PredictiveScalingPredefinedScalingMetric: + description: |- + Describes a scaling metric for a predictive scaling policy. + When returned in the output of ``DescribePolicies``, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair. + The following predefined metrics are available for predictive scaling: + + ``ECSServiceAverageCPUUtilization`` + + ``ECSServiceAverageMemoryUtilization`` + + ``ECSServiceCPUUtilization`` + + ``ECSServiceMemoryUtilization`` + + ``ECSServiceTotalCPUUtilization`` + + ``ECSServiceTotalMemoryUtilization`` + + ``ALBRequestCount`` + + ``ALBRequestCountPerTarget`` + + ``TotalALBRequestCount`` + additionalProperties: false + type: object properties: PredefinedMetricType: - description: The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services. + description: The metric type. type: string ResourceLabel: - description: Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. + description: A label that uniquely identifies a specific target group from which to determine the average request count. type: string required: - PredefinedMetricType - CustomizedMetricSpecification: - description: Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling. + PredictiveScalingMetricSpecification: + description: |- + This structure specifies the metrics and target utilization settings for a predictive scaling policy. + You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric. + additionalProperties: false type: object + properties: + CustomizedLoadMetricSpecification: + description: The customized load metric specification. + $ref: '#/components/schemas/PredictiveScalingCustomizedLoadMetric' + PredefinedLoadMetricSpecification: + description: The predefined load metric specification. + $ref: '#/components/schemas/PredictiveScalingPredefinedLoadMetric' + TargetValue: + description: Specifies the target utilization. + type: number + PredefinedScalingMetricSpecification: + description: The predefined scaling metric specification. + $ref: '#/components/schemas/PredictiveScalingPredefinedScalingMetric' + CustomizedCapacityMetricSpecification: + description: The customized capacity metric specification. + $ref: '#/components/schemas/PredictiveScalingCustomizedCapacityMetric' + CustomizedScalingMetricSpecification: + description: The customized scaling metric specification. + $ref: '#/components/schemas/PredictiveScalingCustomizedScalingMetric' + PredefinedMetricPairSpecification: + description: The predefined metric pair specification that determines the appropriate scaling metric and load metric to use. + $ref: '#/components/schemas/PredictiveScalingPredefinedMetricPair' + required: + - TargetValue + PredictiveScalingMetric: + description: Describes the scaling metric. additionalProperties: false + type: object properties: + MetricName: + description: The name of the metric. + type: string Dimensions: - description: The dimensions of the metric. - type: array uniqueItems: false + description: Describes the dimensions of the metric. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/MetricDimension' - MetricName: - description: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. - type: string + $ref: '#/components/schemas/PredictiveScalingMetricDimension' Namespace: description: The namespace of the metric. type: string - Statistic: - description: The statistic of the metric. - type: string - Unit: - description: The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference. - type: string - Metrics: - description: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/TargetTrackingMetricDataQuery' - TargetTrackingMetricDataQuery: - description: The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp. - type: object + PredictiveScalingCustomizedLoadMetric: + description: The customized load metric specification. additionalProperties: false - properties: - Expression: - description: The math expression to perform on the returned data, if this object is performing a math expression. - type: string - Id: - description: A short name that identifies the object's results in the response. - type: string - Label: - description: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. - type: string - ReturnData: - description: Indicates whether to return the timestamps and raw data values of this metric. - type: boolean - MetricStat: - description: Information about the metric data to return. - $ref: '#/components/schemas/TargetTrackingMetricStat' - TargetTrackingMetricStat: - description: This structure defines the CloudWatch metric to return, along with the statistic, period, and unit. type: object - additionalProperties: false properties: - Metric: - description: 'The CloudWatch metric to return, including the metric name, namespace, and dimensions. ' - $ref: '#/components/schemas/TargetTrackingMetric' - Stat: - description: The statistic to return. It can include any CloudWatch statistic or extended statistic. - type: string - Unit: - description: The unit to use for the returned data points. - type: string + MetricDataQueries: + uniqueItems: true + description: '' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PredictiveScalingMetricDataQuery' + required: + - MetricDataQueries TargetTrackingMetric: - description: Represents a specific metric. - type: object + description: |- + Represents a specific metric for a target tracking scaling policy for Application Auto Scaling. + Metric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property type. additionalProperties: false + type: object properties: + MetricName: + description: The name of the metric. + type: string Dimensions: - description: The dimensions for the metric. - type: array uniqueItems: false + description: |- + The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*. + Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/TargetTrackingMetricDimension' - MetricName: - description: The name of the metric. - type: string Namespace: - description: The namespace of the metric. + description: The namespace of the metric. For more information, see the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*. type: string - TargetTrackingMetricDimension: - description: Describes the dimension of a metric. - type: object + PredictiveScalingMetricStat: + description: This structure defines the CloudWatch metric to return, along with the statistic and unit. additionalProperties: false + type: object properties: - Name: - description: The name of the dimension. + Stat: + description: |- + The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*. + The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. type: string - Value: - description: The value of the dimension. + Metric: + description: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + $ref: '#/components/schemas/PredictiveScalingMetric' + Unit: + description: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*. type: string - StepAdjustment: - description: Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. - type: object + StepScalingPolicyConfiguration: + description: |- + ``StepScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling policy configuration for Application Auto Scaling. + For more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*. additionalProperties: false - properties: - MetricIntervalLowerBound: - description: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. - type: number - MetricIntervalUpperBound: - description: The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. - type: number - ScalingAdjustment: - description: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. - type: integer - required: - - ScalingAdjustment - MetricDimension: - description: Describes the dimension names and values associated with a metric. type: object - additionalProperties: false properties: - Name: - description: The name of the dimension. + MetricAggregationType: + description: The aggregation type for the CloudWatch metrics. Valid values are ``Minimum``, ``Maximum``, and ``Average``. If the aggregation type is null, the value is treated as ``Average``. type: string - Value: - description: The value of the dimension. + Cooldown: + description: The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling User Guide*. + type: integer + StepAdjustments: + uniqueItems: true + description: |- + A set of adjustments that enable you to scale based on the size of the alarm breach. + At least one step adjustment is required if you are adding a new step scaling policy configuration. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/StepAdjustment' + MinAdjustmentMagnitude: + description: The minimum value to scale by when the adjustment type is ``PercentChangeInCapacity``. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a ``MinAdjustmentMagnitude`` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a ``MinAdjustmentMagnitude`` of 2, Application Auto Scaling scales out the service by 2 tasks. + type: integer + AdjustmentType: + description: Specifies whether the ``ScalingAdjustment`` value in the ``StepAdjustment`` property is an absolute number or a percentage of the current capacity. type: string - required: - - Value - - Name ScalingPolicy: type: object properties: - PolicyName: - description: |- - The name of the scaling policy. - - Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name. - type: string PolicyType: description: |- The scaling policy type. - - The following policy types are supported: - - TargetTrackingScaling Not supported for Amazon EMR - - StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. + The following policy types are supported: + ``TargetTrackingScaling``—Not supported for Amazon EMR + ``StepScaling``—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. + ``PredictiveScaling``—Only supported for Amazon ECS type: string ResourceId: - description: The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. - type: string - ScalableDimension: - description: The scalable dimension. This string consists of the service namespace, resource type, and scaling property. + description: |- + The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Amazon ElastiCache cache cluster - The resource type is ``cache-cluster`` and the unique identifier is the cache cluster name. Example: ``cache-cluster/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``. type: string ScalingTargetId: - description: The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource. + description: |- + The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource. + You must specify either the ``ScalingTargetId`` property, or the ``ResourceId``, ``ScalableDimension``, and ``ServiceNamespace`` properties, but not both. + type: string + PolicyName: + description: |- + The name of the scaling policy. + Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name. type: string ServiceNamespace: - description: The namespace of the AWS service that provides the resource, or a custom-resource. + description: The namespace of the AWS service that provides the resource, or a ``custom-resource``. + type: string + ScalableDimension: + description: |- + The scalable dimension. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:cache-cluster:Nodes`` - The number of nodes for an Amazon ElastiCache cache cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. + + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool. type: string - StepScalingPolicyConfiguration: - description: A step scaling policy. - $ref: '#/components/schemas/StepScalingPolicyConfiguration' TargetTrackingScalingPolicyConfiguration: description: A target tracking scaling policy. $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration' Arn: - description: ARN is a read only property for the resource. + description: '' type: string + StepScalingPolicyConfiguration: + description: A step scaling policy. + $ref: '#/components/schemas/StepScalingPolicyConfiguration' + PredictiveScalingPolicyConfiguration: + description: The predictive scaling policy configuration. + $ref: '#/components/schemas/PredictiveScalingPolicyConfiguration' required: - PolicyName - PolicyType x-stackql-resource-name: scaling_policy - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target. + For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*. + x-type-name: AWS::ApplicationAutoScaling::ScalingPolicy + x-stackql-primary-identifier: - Arn - ScalableDimension x-create-only-properties: @@ -368,63 +1205,357 @@ components: - ResourceId - ScalableDimension - ScalingTargetId + x-write-only-properties: + - TargetTrackingScalingPolicyConfiguration/PredefinedMetricSpecification/ResourceLabel + - ScalingTargetId x-read-only-properties: - Arn + x-required-properties: + - PolicyName + - PolicyType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - application-autoscaling:DescribeScalingPolicies create: - application-autoscaling:DescribeScalingPolicies - application-autoscaling:PutScalingPolicy - read: - - application-autoscaling:DescribeScalingPolicies + - cloudwatch:GetMetricData update: - application-autoscaling:DescribeScalingPolicies - application-autoscaling:PutScalingPolicy + - cloudwatch:GetMetricData + list: + - application-autoscaling:DescribeScalingPolicies delete: - application-autoscaling:DescribeScalingPolicies - application-autoscaling:DeleteScalingPolicy - list: - - application-autoscaling:DescribeScalingPolicies + CreateScalableTargetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScheduledActions: + uniqueItems: true + description: The scheduled actions for the scalable target. Duplicates aren't allowed. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ScheduledAction' + ResourceId: + description: |- + The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Amazon ElastiCache cache cluster - The resource type is ``cache-cluster`` and the unique identifier is the cache cluster name. Example: ``cache-cluster/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``. + type: string + ServiceNamespace: + description: The namespace of the AWS service that provides the resource, or a ``custom-resource``. + type: string + ScalableDimension: + description: |- + The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:cache-cluster:Nodes`` - The number of nodes for an Amazon ElastiCache cache cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. + + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool. + type: string + SuspendedState: + description: |- + An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. + *Suspension Outcomes* + + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. + $ref: '#/components/schemas/SuspendedState' + Id: + description: '' + type: string + MinCapacity: + description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. + type: integer + RoleARN: + description: >- + Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with + IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*. + To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page. + type: string + MaxCapacity: + description: The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. + type: integer + x-stackQL-stringOnly: true + x-title: CreateScalableTargetRequest + type: object + required: [] + CreateScalingPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyType: + description: |- + The scaling policy type. + The following policy types are supported: + ``TargetTrackingScaling``—Not supported for Amazon EMR + ``StepScaling``—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. + ``PredictiveScaling``—Only supported for Amazon ECS + type: string + ResourceId: + description: |- + The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Amazon ElastiCache cache cluster - The resource type is ``cache-cluster`` and the unique identifier is the cache cluster name. Example: ``cache-cluster/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``. + type: string + ScalingTargetId: + description: |- + The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource. + You must specify either the ``ScalingTargetId`` property, or the ``ResourceId``, ``ScalableDimension``, and ``ServiceNamespace`` properties, but not both. + type: string + PolicyName: + description: |- + The name of the scaling policy. + Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name. + type: string + ServiceNamespace: + description: The namespace of the AWS service that provides the resource, or a ``custom-resource``. + type: string + ScalableDimension: + description: |- + The scalable dimension. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:cache-cluster:Nodes`` - The number of nodes for an Amazon ElastiCache cache cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. + + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool. + type: string + TargetTrackingScalingPolicyConfiguration: + description: A target tracking scaling policy. + $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration' + Arn: + description: '' + type: string + StepScalingPolicyConfiguration: + description: A step scaling policy. + $ref: '#/components/schemas/StepScalingPolicyConfiguration' + PredictiveScalingPolicyConfiguration: + description: The predictive scaling policy configuration. + $ref: '#/components/schemas/PredictiveScalingPolicyConfiguration' + x-stackQL-stringOnly: true + x-title: CreateScalingPolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: scalable_targets: name: scalable_targets id: awscc.applicationautoscaling.scalable_targets x-cfn-schema-name: ScalableTarget - x-type: list + x-cfn-type-name: AWS::ApplicationAutoScaling::ScalableTarget x-identifiers: - ResourceId - ScalableDimension - ServiceNamespace + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScalableTarget&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationAutoScaling::ScalableTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationAutoScaling::ScalableTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationAutoScaling::ScalableTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ScheduledActions') as scheduled_actions, JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace, JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, - JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' + JSON_EXTRACT(Properties, '$.SuspendedState') as suspended_state, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.MinCapacity') as min_capacity, + JSON_EXTRACT(Properties, '$.RoleARN') as role_arn, + JSON_EXTRACT(Properties, '$.MaxCapacity') as max_capacity + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'ScheduledActions') as scheduled_actions, json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, - json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' + json_extract_path_text(Properties, 'SuspendedState') as suspended_state, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'MinCapacity') as min_capacity, + json_extract_path_text(Properties, 'RoleARN') as role_arn, + json_extract_path_text(Properties, 'MaxCapacity') as max_capacity + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' + AND data__Identifier = '||' AND region = 'us-east-1' - scalable_target: - name: scalable_target - id: awscc.applicationautoscaling.scalable_target + scalable_targets_list_only: + name: scalable_targets_list_only + id: awscc.applicationautoscaling.scalable_targets_list_only x-cfn-schema-name: ScalableTarget - x-type: get + x-cfn-type-name: AWS::ApplicationAutoScaling::ScalableTarget x-identifiers: - ResourceId - ScalableDimension - ServiceNamespace + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -432,73 +1563,131 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.MaxCapacity') as max_capacity, - JSON_EXTRACT(Properties, '$.MinCapacity') as min_capacity, JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.RoleARN') as role_arn, JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, - JSON_EXTRACT(Properties, '$.ScheduledActions') as scheduled_actions, - JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace, - JSON_EXTRACT(Properties, '$.SuspendedState') as suspended_state - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, - json_extract_path_text(Properties, 'MinCapacity') as min_capacity, json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'RoleARN') as role_arn, json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, - json_extract_path_text(Properties, 'ScheduledActions') as scheduled_actions, - json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, - json_extract_path_text(Properties, 'SuspendedState') as suspended_state - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' - AND data__Identifier = '||' + json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' AND region = 'us-east-1' scaling_policies: name: scaling_policies id: awscc.applicationautoscaling.scaling_policies x-cfn-schema-name: ScalingPolicy - x-type: list + x-cfn-type-name: AWS::ApplicationAutoScaling::ScalingPolicy x-identifiers: - Arn - ScalableDimension + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScalingPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationAutoScaling::ScalingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationAutoScaling::ScalingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationAutoScaling::ScalingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ScalingTargetId') as scaling_target_id, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace, + JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, + JSON_EXTRACT(Properties, '$.TargetTrackingScalingPolicyConfiguration') as target_tracking_scaling_policy_configuration, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' + JSON_EXTRACT(Properties, '$.StepScalingPolicyConfiguration') as step_scaling_policy_configuration, + JSON_EXTRACT(Properties, '$.PredictiveScalingPolicyConfiguration') as predictive_scaling_policy_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ScalingTargetId') as scaling_target_id, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, + json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, + json_extract_path_text(Properties, 'TargetTrackingScalingPolicyConfiguration') as target_tracking_scaling_policy_configuration, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' + json_extract_path_text(Properties, 'StepScalingPolicyConfiguration') as step_scaling_policy_configuration, + json_extract_path_text(Properties, 'PredictiveScalingPolicyConfiguration') as predictive_scaling_policy_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' + AND data__Identifier = '|' AND region = 'us-east-1' - scaling_policy: - name: scaling_policy - id: awscc.applicationautoscaling.scaling_policy + scaling_policies_list_only: + name: scaling_policies_list_only + id: awscc.applicationautoscaling.scaling_policies_list_only x-cfn-schema-name: ScalingPolicy - x-type: get + x-cfn-type-name: AWS::ApplicationAutoScaling::ScalingPolicy x-identifiers: - Arn - ScalableDimension + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -506,34 +1695,253 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, - JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, - JSON_EXTRACT(Properties, '$.ScalingTargetId') as scaling_target_id, - JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace, - JSON_EXTRACT(Properties, '$.StepScalingPolicyConfiguration') as step_scaling_policy_configuration, - JSON_EXTRACT(Properties, '$.TargetTrackingScalingPolicyConfiguration') as target_tracking_scaling_policy_configuration, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyType') as policy_type, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, - json_extract_path_text(Properties, 'ScalingTargetId') as scaling_target_id, - json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, - json_extract_path_text(Properties, 'StepScalingPolicyConfiguration') as step_scaling_policy_configuration, - json_extract_path_text(Properties, 'TargetTrackingScalingPolicyConfiguration') as target_tracking_scaling_policy_configuration, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScalableTarget&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScalableTarget + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScalableTargetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScalingPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScalingPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScalingPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/applicationinsights.yaml b/providers/src/awscc/v00.00.00000/services/applicationinsights.yaml index 07f5e2cd..aaa4f10b 100644 --- a/providers/src/awscc/v00.00.00000/services/applicationinsights.yaml +++ b/providers/src/awscc/v00.00.00000/services/applicationinsights.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ApplicationInsights - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -110,7 +490,7 @@ components: Tier: description: The tier of the application component. type: string - pattern: ^[A-Z][[A-Z]_]*$ + pattern: ^[A-Z][A-Z_]*$ ComponentConfigurationMode: description: The component monitoring configuration mode. type: string @@ -170,6 +550,12 @@ components: items: $ref: '#/components/schemas/WindowsEvent' x-insertionOrder: true + Processes: + description: A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section. + type: array + items: + $ref: '#/components/schemas/Process' + x-insertionOrder: true Alarms: description: A list of alarms to monitor for the component. type: array @@ -185,6 +571,12 @@ components: HAClusterPrometheusExporter: description: The HA cluster Prometheus Exporter settings. $ref: '#/components/schemas/HAClusterPrometheusExporter' + NetWeaverPrometheusExporter: + description: The NetWeaver Prometheus Exporter settings. + $ref: '#/components/schemas/NetWeaverPrometheusExporter' + SQLServerPrometheusExporter: + description: The SQL Prometheus Exporter settings. + $ref: '#/components/schemas/SQLServerPrometheusExporter' additionalProperties: false SubComponentConfigurationDetails: description: The configuration settings of sub components. @@ -208,6 +600,12 @@ components: items: $ref: '#/components/schemas/WindowsEvent' x-insertionOrder: true + Processes: + description: A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section. + type: array + items: + $ref: '#/components/schemas/Process' + x-insertionOrder: true additionalProperties: false JMXPrometheusExporter: description: The JMX Prometheus Exporter settings. @@ -260,6 +658,42 @@ components: description: Prometheus exporter port. type: string additionalProperties: false + NetWeaverPrometheusExporter: + description: The NetWeaver Prometheus Exporter Settings. + type: object + properties: + SAPSID: + description: SAP NetWeaver SID. + type: string + InstanceNumbers: + description: SAP instance numbers for ASCS, ERS, and App Servers. + type: array + items: + type: string + minLength: 1 + maxLength: 2 + pattern: \b([0-9]|[0-9][0-9])\b + PrometheusPort: + description: Prometheus exporter port. + type: string + required: + - SAPSID + - InstanceNumbers + additionalProperties: false + SQLServerPrometheusExporter: + description: The SQL prometheus exporter settings. + type: object + properties: + PrometheusPort: + description: Prometheus exporter port. + type: string + SQLSecretName: + description: 'Secret name which managers SQL exporter connection. e.g. {"data_source_name": "sqlserver://:@localhost:1433"}' + type: string + required: + - PrometheusPort + - SQLSecretName + additionalProperties: false AlarmMetric: description: A metric to be monitored for the component. type: object @@ -289,7 +723,7 @@ components: LogType: description: The log type decides the log patterns against which Application Insights analyzes the log. type: string - pattern: ^[A-Z][[A-Z]_]*$ + pattern: ^[A-Z][A-Z_]*$ Encoding: description: The type of encoding of the logs to be monitored. type: string @@ -340,6 +774,26 @@ components: - EventName - EventLevels additionalProperties: false + Process: + description: A process to be monitored for the component. + type: object + properties: + ProcessName: + description: The name of the process to be monitored for the component. + type: string + minLength: 1 + maxLength: 256 + pattern: ^[a-zA-Z0-9_,-]+$ + AlarmMetrics: + description: A list of metrics to monitor for the component. + type: array + items: + $ref: '#/components/schemas/AlarmMetric' + x-insertionOrder: true + required: + - ProcessName + - AlarmMetrics + additionalProperties: false EventLevel: description: The level of event to log. type: string @@ -409,6 +863,12 @@ components: minLength: 20 maxLength: 300 pattern: ^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$ + SNSNotificationArn: + description: Application Insights sends notifications to this SNS topic whenever there is a problem update in the associated application. + type: string + minLength: 20 + maxLength: 300 + pattern: ^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$ Tags: description: The tags of Application Insights application. type: array @@ -445,64 +905,242 @@ components: type: string enum: - ACCOUNT_BASED + AttachMissingPermission: + description: If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing + type: boolean required: - ResourceGroupName x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ApplicationInsights::Application + x-type-name: AWS::ApplicationInsights::Application + x-stackql-primary-identifier: - ApplicationARN x-create-only-properties: - ResourceGroupName - GroupingType + x-write-only-properties: + - ComponentMonitoringSettings + - LogPatternSets + - CustomComponents + - GroupingType + - OpsItemSNSTopicArn + - SNSNotificationArn + - AttachMissingPermission x-read-only-properties: - ApplicationARN + x-required-properties: + - ResourceGroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - applicationinsights:ListTagsForResource + - applicationinsights:TagResource + - applicationinsights:UntagResource x-required-permissions: create: - - '*' + - applicationinsights:CreateApplication + - applicationinsights:Describe* + - applicationinsights:CreateComponent + - applicationinsights:CreateLogPattern + - applicationinsights:UpdateComponentConfiguration + - applicationinsights:ListComponents + - applicationinsights:TagResource + - ec2:Describe* + - rds:Describe* + - sqs:ListQueues + - elasticloadbalancing:Describe* + - autoscaling:DescribeAutoScalingGroups + - lambda:ListFunctions + - dynamodb:ListTables + - s3:ListAllMyBuckets + - sns:ListTopics + - states:ListStateMachines + - apigateway:GET + - ecs:List* + - ecs:DescribeTaskDefinition + - eks:List* + - fsx:DescribeFileSystems + - route53:List* + - route53resolver:List* + - logs:DescribeLogGroups + - resource-explorer:ListResources + - elasticfilesystem:DescribeFileSystems read: - - '*' + - applicationinsights:Describe* + - applicationinsights:List* update: - - '*' + - applicationinsights:CreateApplication + - applicationinsights:Describe* + - applicationinsights:UpdateApplication + - applicationinsights:TagResource + - applicationinsights:UntagResource + - applicationinsights:List* + - applicationinsights:CreateComponent + - applicationinsights:DeleteComponent + - applicationinsights:CreateLogPattern + - applicationinsights:DeleteLogPattern + - applicationinsights:UpdateLogPattern + - applicationinsights:UpdateComponentConfiguration delete: - - '*' + - applicationinsights:DeleteApplication + - applicationinsights:DescribeApplication list: - - '*' + - applicationinsights:List* + - applicationinsights:Describe* + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceGroupName: + description: The name of the resource group. + type: string + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z0-9.-_]*' + ApplicationARN: + description: The ARN of the ApplicationInsights application. + type: string + CWEMonitorEnabled: + description: Indicates whether Application Insights can listen to CloudWatch events for the application resources. + type: boolean + OpsCenterEnabled: + description: When set to true, creates opsItems for any problems detected on an application. + type: boolean + OpsItemSNSTopicArn: + description: The SNS topic provided to Application Insights that is associated to the created opsItem. + type: string + minLength: 20 + maxLength: 300 + pattern: ^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$ + SNSNotificationArn: + description: Application Insights sends notifications to this SNS topic whenever there is a problem update in the associated application. + type: string + minLength: 20 + maxLength: 300 + pattern: ^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$ + Tags: + description: The tags of Application Insights application. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + x-insertionOrder: true + CustomComponents: + description: The custom grouped components. + type: array + items: + $ref: '#/components/schemas/CustomComponent' + minItems: 1 + x-insertionOrder: true + LogPatternSets: + description: The log pattern sets. + type: array + items: + $ref: '#/components/schemas/LogPatternSet' + minItems: 1 + x-insertionOrder: true + AutoConfigurationEnabled: + description: If set to true, application will be configured with recommended monitoring configuration. + type: boolean + ComponentMonitoringSettings: + description: The monitoring settings of the components. + type: array + items: + $ref: '#/components/schemas/ComponentMonitoringSetting' + minItems: 1 + x-insertionOrder: true + GroupingType: + description: The grouping type of the application + type: string + enum: + - ACCOUNT_BASED + AttachMissingPermission: + description: If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing + type: boolean + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.applicationinsights.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationARN - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationARN') as application_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationARN') as application_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.applicationinsights.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::ApplicationInsights::Application x-identifiers: - ApplicationARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationInsights::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationInsights::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationInsights::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -512,17 +1150,19 @@ components: JSON_EXTRACT(Properties, '$.CWEMonitorEnabled') as cwe_monitor_enabled, JSON_EXTRACT(Properties, '$.OpsCenterEnabled') as ops_center_enabled, JSON_EXTRACT(Properties, '$.OpsItemSNSTopicArn') as ops_item_sns_topic_arn, + JSON_EXTRACT(Properties, '$.SNSNotificationArn') as sns_notification_arn, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.CustomComponents') as custom_components, JSON_EXTRACT(Properties, '$.LogPatternSets') as log_pattern_sets, JSON_EXTRACT(Properties, '$.AutoConfigurationEnabled') as auto_configuration_enabled, JSON_EXTRACT(Properties, '$.ComponentMonitoringSettings') as component_monitoring_settings, - JSON_EXTRACT(Properties, '$.GroupingType') as grouping_type + JSON_EXTRACT(Properties, '$.GroupingType') as grouping_type, + JSON_EXTRACT(Properties, '$.AttachMissingPermission') as attach_missing_permission FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationInsights::Application' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -532,12 +1172,240 @@ components: json_extract_path_text(Properties, 'CWEMonitorEnabled') as cwe_monitor_enabled, json_extract_path_text(Properties, 'OpsCenterEnabled') as ops_center_enabled, json_extract_path_text(Properties, 'OpsItemSNSTopicArn') as ops_item_sns_topic_arn, + json_extract_path_text(Properties, 'SNSNotificationArn') as sns_notification_arn, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'CustomComponents') as custom_components, json_extract_path_text(Properties, 'LogPatternSets') as log_pattern_sets, json_extract_path_text(Properties, 'AutoConfigurationEnabled') as auto_configuration_enabled, json_extract_path_text(Properties, 'ComponentMonitoringSettings') as component_monitoring_settings, - json_extract_path_text(Properties, 'GroupingType') as grouping_type + json_extract_path_text(Properties, 'GroupingType') as grouping_type, + json_extract_path_text(Properties, 'AttachMissingPermission') as attach_missing_permission FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationInsights::Application' AND data__Identifier = '' AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.applicationinsights.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::ApplicationInsights::Application + x-identifiers: + - ApplicationARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationARN') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationARN') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/applicationsignals.yaml b/providers/src/awscc/v00.00.00000/services/applicationsignals.yaml new file mode 100644 index 00000000..89b67553 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/applicationsignals.yaml @@ -0,0 +1,1477 @@ +openapi: 3.0.0 +info: + title: ApplicationSignals + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + AccountId: + description: The identifier for the specified AWS account. + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + Discovery: + type: object + properties: + AccountId: + $ref: '#/components/schemas/AccountId' + required: [] + x-stackql-resource-name: discovery + description: Resource Type definition for AWS::ApplicationSignals::Discovery + x-type-name: AWS::ApplicationSignals::Discovery + x-stackql-primary-identifier: + - AccountId + x-read-only-properties: + - AccountId + x-required-properties: [] + x-tagging: + taggable: false + x-required-permissions: + create: + - application-signals:StartDiscovery + - application-signals:ListServices + - iam:CreateServiceLinkedRole + read: + - application-signals:ListServices + update: + - application-signals:ListServices + delete: + - application-signals:ListServices + list: + - application-signals:ListServices + Sli: + description: This structure contains information about the performance metric that an SLO monitors. + type: object + additionalProperties: false + properties: + SliMetric: + $ref: '#/components/schemas/SliMetric' + MetricThreshold: + description: The value that the SLI metric is compared to. + type: number + ComparisonOperator: + description: The arithmetic operation used when comparing the specified metric to the threshold. + type: string + enum: + - GreaterThanOrEqualTo + - LessThanOrEqualTo + - LessThan + - GreaterThan + required: + - SliMetric + - MetricThreshold + - ComparisonOperator + RequestBasedSli: + description: This structure contains information about the performance metric that a request-based SLO monitors. + type: object + additionalProperties: false + properties: + RequestBasedSliMetric: + $ref: '#/components/schemas/RequestBasedSliMetric' + MetricThreshold: + description: The value that the SLI metric is compared to. + type: number + ComparisonOperator: + description: The arithmetic operation used when comparing the specified metric to the threshold. + type: string + enum: + - GreaterThanOrEqualTo + - LessThanOrEqualTo + - LessThan + - GreaterThan + required: + - RequestBasedSliMetric + Goal: + description: A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold. + type: object + additionalProperties: false + properties: + Interval: + $ref: '#/components/schemas/Interval' + AttainmentGoal: + description: |- + The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state. + If you omit this parameter, 99 is used to represent 99% as the attainment goal. + type: number + WarningThreshold: + description: The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used. + type: number + SliMetric: + description: A structure that contains information about the metric that the SLO monitors. + type: object + additionalProperties: false + properties: + KeyAttributes: + $ref: '#/components/schemas/KeyAttributes' + OperationName: + description: If the SLO monitors a specific operation of the service, this field displays that operation name. + type: string + minLength: 1 + maxLength: 255 + MetricType: + description: If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used. + type: string + enum: + - LATENCY + - AVAILABILITY + Statistic: + description: The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic + type: string + minLength: 1 + maxLength: 20 + PeriodSeconds: + description: The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance. + type: integer + minimum: 60 + maximum: 900 + MetricDataQueries: + $ref: '#/components/schemas/MetricDataQueries' + DependencyConfig: + $ref: '#/components/schemas/DependencyConfig' + RequestBasedSliMetric: + description: This structure contains the information about the metric that is used for a request-based SLO. + type: object + additionalProperties: false + properties: + KeyAttributes: + $ref: '#/components/schemas/KeyAttributes' + OperationName: + description: If the SLO monitors a specific operation of the service, this field displays that operation name. + type: string + minLength: 1 + maxLength: 255 + MetricType: + description: If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used. + type: string + enum: + - LATENCY + - AVAILABILITY + TotalRequestCountMetric: + description: This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in `MonitoredRequestCountMetric`. + $ref: '#/components/schemas/MetricDataQueries' + MonitoredRequestCountMetric: + $ref: '#/components/schemas/MonitoredRequestCountMetric' + DependencyConfig: + $ref: '#/components/schemas/DependencyConfig' + MonitoredRequestCountMetric: + description: This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in `TotalRequestCountMetric` is divided by the number found for `MonitoredRequestCountMetric` to determine the percentage of successful requests that this SLO tracks. + type: object + additionalProperties: false + properties: + GoodCountMetric: + description: If you want to count "good requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "good requests" in this structure. + $ref: '#/components/schemas/MetricDataQueries' + BadCountMetric: + description: If you want to count "bad requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "bad requests" in this structure. + $ref: '#/components/schemas/MetricDataQueries' + KeyAttributes: + description: This is a string-to-string map that contains information about the type of object that this SLO is related to. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + Interval: + description: |- + The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval. + If you omit this parameter, a rolling interval of 7 days is used. + type: object + additionalProperties: false + properties: + RollingInterval: + $ref: '#/components/schemas/RollingInterval' + CalendarInterval: + $ref: '#/components/schemas/CalendarInterval' + RollingInterval: + description: If the interval is a calendar interval, this structure contains the interval specifications. + type: object + additionalProperties: false + properties: + DurationUnit: + $ref: '#/components/schemas/DurationUnit' + Duration: + $ref: '#/components/schemas/Duration' + required: + - DurationUnit + - Duration + CalendarInterval: + description: If the interval for this service level objective is a calendar interval, this structure contains the interval specifications. + type: object + additionalProperties: false + properties: + StartTime: + type: integer + description: |- + Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m. + As soon as one calendar interval ends, another automatically begins. + minimum: 946684800 + DurationUnit: + $ref: '#/components/schemas/DurationUnit' + Duration: + $ref: '#/components/schemas/Duration' + required: + - StartTime + - DurationUnit + - Duration + DurationUnit: + description: Specifies the interval unit. + type: string + enum: + - MINUTE + - HOUR + - DAY + - MONTH + Duration: + description: Specifies the duration of each interval. For example, if `Duration` is 1 and `DurationUnit` is `MONTH`, each interval is one month, aligned with the calendar. + type: integer + minimum: 1 + MetricDataQueries: + description: If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression. + type: array + uniqueItems: false + x-insertionOrder: true + items: + $ref: '#/components/schemas/MetricDataQuery' + MetricDataQuery: + description: >- + Use this structure to define a metric or metric math expression that you want to use as for a service level objective. + + Each `MetricDataQuery` in the `MetricDataQueries` array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those + Expression structures, exactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO. + type: object + additionalProperties: false + properties: + MetricStat: + description: A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both. + $ref: '#/components/schemas/MetricStat' + Id: + description: A short name used to tie this object to the results in the response. + type: string + ReturnData: + description: This option indicates whether to return the timestamps and raw data values of this metric. + type: boolean + Expression: + description: The math expression to be performed on the returned data. + type: string + AccountId: + description: The ID of the account where the metrics are located, if this is a cross-account alarm. + type: string + required: + - Id + MetricStat: + description: A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both. + type: object + additionalProperties: false + properties: + Period: + description: The granularity, in seconds, to be used for the metric. + type: integer + Metric: + $ref: '#/components/schemas/Metric' + Stat: + description: The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. + type: string + Unit: + description: If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions. + type: string + required: + - Stat + - Period + - Metric + Metric: + description: This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions. + type: object + additionalProperties: false + properties: + MetricName: + description: The name of the metric to use. + type: string + Dimensions: + description: An array of one or more dimensions to use to define the metric that you want to use. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Dimension' + Namespace: + description: The namespace of the metric. + type: string + Dimension: + description: A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension. You can assign up to 30 dimensions to a metric. + type: object + additionalProperties: false + properties: + Value: + description: The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values + type: string + Name: + description: The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names. + type: string + required: + - Value + - Name + Tags: + description: The list of tag keys and values associated with the resource you specified + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + maxItems: 200 + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ + description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. + minLength: 1 + maxLength: 128 + Value: + type: string + description: The value for the specified tag key. + minLength: 0 + maxLength: 256 + required: + - Key + - Value + BurnRateConfigurations: + description: Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/BurnRateConfiguration' + minItems: 0 + maxItems: 10 + BurnRateConfiguration: + type: object + description: |- + This object defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly. + For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following: + burn rate = error rate over the look-back window / (1 - attainment goal percentage) + additionalProperties: false + properties: + LookBackWindowMinutes: + description: The number of minutes to use as the look-back window. + type: integer + minimum: 1 + maximum: 10080 + required: + - LookBackWindowMinutes + ExclusionWindows: + description: Each object in this array defines a time exclusion window for this SLO. The time exclusion window is used to exclude breaching data points from affecting attainment rate, error budget, and burn rate metrics. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ExclusionWindow' + minItems: 0 + maxItems: 10 + ExclusionWindow: + description: This object defines a time exclusion window for this SLO. The time exclusion window is used to exclude breaching data points from affecting attainment rate, error budget, and burn rate metrics. + type: object + additionalProperties: false + properties: + Window: + $ref: '#/components/schemas/Window' + StartTime: + type: string + description: The time you want the exclusion window to start at. Note that time exclusion windows can only be scheduled in the future, not the past. + RecurrenceRule: + $ref: '#/components/schemas/RecurrenceRule' + Reason: + description: An optional reason for scheduling this time exclusion window. Default is 'No reason'. + type: string + minLength: 1 + maxLength: 1024 + default: No reason + required: + - Window + Window: + description: This object defines the length of time an exclusion window should span. + type: object + additionalProperties: false + properties: + DurationUnit: + $ref: '#/components/schemas/DurationUnit' + Duration: + $ref: '#/components/schemas/Duration' + required: + - DurationUnit + - Duration + RecurrenceRule: + description: This object defines how often to repeat a time exclusion window. + type: object + additionalProperties: false + properties: + Expression: + description: A cron or rate expression denoting how often to repeat this exclusion window. + type: string + minLength: 1 + maxLength: 1024 + required: + - Expression + DependencyConfig: + description: Configuration for identifying a dependency and its operation + type: object + additionalProperties: false + properties: + DependencyKeyAttributes: + $ref: '#/components/schemas/DependencyKeyAttributes' + DependencyOperationName: + type: string + description: When the SLO monitors a specific operation of the dependency, this field specifies the name of that operation in the dependency. + minLength: 1 + maxLength: 255 + required: + - DependencyKeyAttributes + - DependencyOperationName + DependencyKeyAttributes: + description: If this SLO is related to a metric collected by Application Signals, you must use this field to specify which dependency the SLO metric is related to. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + ServiceLevelObjective: + type: object + properties: + Arn: + description: The ARN of this SLO. + type: string + pattern: ^arn:[^:]*:application-signals:[^:]*:[^:]*:slo\/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$ + Name: + description: The name of this SLO. + type: string + pattern: ^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$ + Description: + description: An optional description for this SLO. Default is 'No description' + type: string + minLength: 1 + maxLength: 1024 + default: No description + CreatedTime: + type: integer + description: Epoch time in seconds of the time that this SLO was created + minimum: 946684800 + LastUpdatedTime: + type: integer + description: Epoch time in seconds of the time that this SLO was most recently updated + minimum: 946684800 + Sli: + $ref: '#/components/schemas/Sli' + RequestBasedSli: + $ref: '#/components/schemas/RequestBasedSli' + EvaluationType: + description: Displays whether this is a period-based SLO or a request-based SLO. + type: string + enum: + - PeriodBased + - RequestBased + Goal: + $ref: '#/components/schemas/Goal' + Tags: + $ref: '#/components/schemas/Tags' + BurnRateConfigurations: + $ref: '#/components/schemas/BurnRateConfigurations' + ExclusionWindows: + $ref: '#/components/schemas/ExclusionWindows' + required: + - Name + x-stackql-resource-name: service_level_objective + description: Resource Type definition for AWS::ApplicationSignals::ServiceLevelObjective + x-type-name: AWS::ApplicationSignals::ServiceLevelObjective + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + x-read-only-properties: + - Arn + - CreatedTime + - LastUpdatedTime + - EvaluationType + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - application-signals:ListTagsForResource + - application-signals:TagResource + - application-signals:UntagResource + x-required-permissions: + create: + - application-signals:CreateServiceLevelObjective + - cloudwatch:GetMetricData + - application-signals:TagResource + - application-signals:GetServiceLevelObjective + - application-signals:ListTagsForResource + - iam:GetRole + - iam:CreateServiceLinkedRole + - application-signals:ListServiceLevelObjectiveExclusionWindows + - application-signals:BatchUpdateExclusionWindows + read: + - application-signals:GetServiceLevelObjective + - application-signals:ListTagsForResource + - application-signals:ListServiceLevelObjectiveExclusionWindows + update: + - application-signals:UpdateServiceLevelObjective + - cloudwatch:GetMetricData + - application-signals:TagResource + - application-signals:UntagResource + - application-signals:GetServiceLevelObjective + - application-signals:ListTagsForResource + - application-signals:ListServiceLevelObjectiveExclusionWindows + - application-signals:BatchUpdateExclusionWindows + delete: + - application-signals:DeleteServiceLevelObjective + - application-signals:UntagResource + - application-signals:GetServiceLevelObjective + list: + - application-signals:ListServiceLevelObjectives + - application-signals:ListTagsForResource + - application-signals:ListServiceLevelObjectiveExclusionWindows + CreateDiscoveryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + $ref: '#/components/schemas/AccountId' + x-stackQL-stringOnly: true + x-title: CreateDiscoveryRequest + type: object + required: [] + CreateServiceLevelObjectiveRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The ARN of this SLO. + type: string + pattern: ^arn:[^:]*:application-signals:[^:]*:[^:]*:slo\/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$ + Name: + description: The name of this SLO. + type: string + pattern: ^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$ + Description: + description: An optional description for this SLO. Default is 'No description' + type: string + minLength: 1 + maxLength: 1024 + default: No description + CreatedTime: + type: integer + description: Epoch time in seconds of the time that this SLO was created + minimum: 946684800 + LastUpdatedTime: + type: integer + description: Epoch time in seconds of the time that this SLO was most recently updated + minimum: 946684800 + Sli: + $ref: '#/components/schemas/Sli' + RequestBasedSli: + $ref: '#/components/schemas/RequestBasedSli' + EvaluationType: + description: Displays whether this is a period-based SLO or a request-based SLO. + type: string + enum: + - PeriodBased + - RequestBased + Goal: + $ref: '#/components/schemas/Goal' + Tags: + $ref: '#/components/schemas/Tags' + BurnRateConfigurations: + $ref: '#/components/schemas/BurnRateConfigurations' + ExclusionWindows: + $ref: '#/components/schemas/ExclusionWindows' + x-stackQL-stringOnly: true + x-title: CreateServiceLevelObjectiveRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + discoveries: + name: discoveries + id: awscc.applicationsignals.discoveries + x-cfn-schema-name: Discovery + x-cfn-type-name: AWS::ApplicationSignals::Discovery + x-identifiers: + - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Discovery&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationSignals::Discovery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationSignals::Discovery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationSignals::Discovery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/discoveries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/discoveries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/discoveries/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationSignals::Discovery' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationSignals::Discovery' + AND data__Identifier = '' + AND region = 'us-east-1' + discoveries_list_only: + name: discoveries_list_only + id: awscc.applicationsignals.discoveries_list_only + x-cfn-schema-name: Discovery + x-cfn-type-name: AWS::ApplicationSignals::Discovery + x-identifiers: + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationSignals::Discovery' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationSignals::Discovery' + AND region = 'us-east-1' + service_level_objectives: + name: service_level_objectives + id: awscc.applicationsignals.service_level_objectives + x-cfn-schema-name: ServiceLevelObjective + x-cfn-type-name: AWS::ApplicationSignals::ServiceLevelObjective + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceLevelObjective&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationSignals::ServiceLevelObjective" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationSignals::ServiceLevelObjective" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApplicationSignals::ServiceLevelObjective" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_level_objectives/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_level_objectives/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_level_objectives/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.Sli') as sli, + JSON_EXTRACT(Properties, '$.RequestBasedSli') as request_based_sli, + JSON_EXTRACT(Properties, '$.EvaluationType') as evaluation_type, + JSON_EXTRACT(Properties, '$.Goal') as goal, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.BurnRateConfigurations') as burn_rate_configurations, + JSON_EXTRACT(Properties, '$.ExclusionWindows') as exclusion_windows + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationSignals::ServiceLevelObjective' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Sli') as sli, + json_extract_path_text(Properties, 'RequestBasedSli') as request_based_sli, + json_extract_path_text(Properties, 'EvaluationType') as evaluation_type, + json_extract_path_text(Properties, 'Goal') as goal, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'BurnRateConfigurations') as burn_rate_configurations, + json_extract_path_text(Properties, 'ExclusionWindows') as exclusion_windows + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationSignals::ServiceLevelObjective' + AND data__Identifier = '' + AND region = 'us-east-1' + service_level_objectives_list_only: + name: service_level_objectives_list_only + id: awscc.applicationsignals.service_level_objectives_list_only + x-cfn-schema-name: ServiceLevelObjective + x-cfn-type-name: AWS::ApplicationSignals::ServiceLevelObjective + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationSignals::ServiceLevelObjective' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationSignals::ServiceLevelObjective' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Discovery&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDiscovery + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDiscoveryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceLevelObjective&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceLevelObjective + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceLevelObjectiveRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/apprunner.yaml b/providers/src/awscc/v00.00.00000/services/apprunner.yaml index 7742a951..fbcb091f 100644 --- a/providers/src/awscc/v00.00.00000/services/apprunner.yaml +++ b/providers/src/awscc/v00.00.00000/services/apprunner.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: AppRunner - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -50,7 +430,9 @@ components: $ref: '#/components/schemas/Tag' x-insertionOrder: false x-stackql-resource-name: auto_scaling_configuration - x-stackql-primaryIdentifier: + description: Describes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services. + x-type-name: AWS::AppRunner::AutoScalingConfiguration + x-stackql-primary-identifier: - AutoScalingConfigurationArn x-create-only-properties: - AutoScalingConfigurationName @@ -62,6 +444,16 @@ components: - AutoScalingConfigurationArn - AutoScalingConfigurationRevision - Latest + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - apprunner:TagResource + - apprunner:UntagResource + - apprunner:ListTagsForResource x-required-permissions: create: - apprunner:CreateAutoScalingConfiguration @@ -72,7 +464,7 @@ components: delete: - apprunner:DeleteAutoScalingConfiguration list: - - apprunner:ListAutoScalingConfiguration + - apprunner:ListAutoScalingConfigurations TraceConfiguration: description: Describes the configuration of the tracing feature within an AWS App Runner observability configuration. type: object @@ -116,16 +508,27 @@ components: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: observability_configuration - x-stackql-primaryIdentifier: + description: The AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration + x-type-name: AWS::AppRunner::ObservabilityConfiguration + x-stackql-primary-identifier: - ObservabilityConfigurationArn x-create-only-properties: - ObservabilityConfigurationName - TraceConfiguration - Tags + x-write-only-properties: + - Tags x-read-only-properties: - ObservabilityConfigurationArn - ObservabilityConfigurationRevision - Latest + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - apprunner:CreateObservabilityConfiguration @@ -223,6 +626,7 @@ components: - RUBY_31 - PYTHON_311 - NODEJS_18 + - NODEJS_22 BuildCommand: type: string description: Build Command @@ -489,17 +893,32 @@ components: required: - SourceConfiguration x-stackql-resource-name: service - x-stackql-primaryIdentifier: + description: The AWS::AppRunner::Service resource specifies an AppRunner Service. + x-type-name: AWS::AppRunner::Service + x-stackql-primary-identifier: - ServiceArn x-create-only-properties: - ServiceName - EncryptionConfiguration - - Tags + x-write-only-properties: + - AutoScalingConfigurationArn x-read-only-properties: - ServiceArn - ServiceId - ServiceUrl - Status + x-required-properties: + - SourceConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - apprunner:TagResource + - apprunner:UntagResource + - apprunner:ListTagsForResource x-required-permissions: create: - apprunner:CreateService @@ -564,16 +983,28 @@ components: required: - Subnets x-stackql-resource-name: vpc_connector - x-stackql-primaryIdentifier: + description: The AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector. + x-type-name: AWS::AppRunner::VpcConnector + x-stackql-primary-identifier: - VpcConnectorArn x-create-only-properties: - VpcConnectorName - Subnets - SecurityGroups - Tags + x-write-only-properties: + - Tags x-read-only-properties: - VpcConnectorArn - VpcConnectorRevision + x-required-properties: + - Subnets + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -651,16 +1082,29 @@ components: - ServiceArn - IngressVpcConfiguration x-stackql-resource-name: vpc_ingress_connection - x-stackql-primaryIdentifier: + description: The AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection. + x-type-name: AWS::AppRunner::VpcIngressConnection + x-stackql-primary-identifier: - VpcIngressConnectionArn x-create-only-properties: - VpcIngressConnectionName - ServiceArn - Tags + x-write-only-properties: + - Tags x-read-only-properties: - VpcIngressConnectionArn - DomainName - Status + x-required-properties: + - ServiceArn + - IngressVpcConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - apprunner:CreateVpcIngressConnection @@ -677,43 +1121,326 @@ components: - apprunner:DeleteVpcIngressConnection list: - apprunner:ListVpcIngressConnections + CreateAutoScalingConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoScalingConfigurationArn: + description: The Amazon Resource Name (ARN) of this auto scaling configuration. + type: string + minLength: 1 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011} + AutoScalingConfigurationName: + description: The customer-provided auto scaling configuration name. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The auto scaling configuration name can be used in multiple revisions of a configuration. + type: string + minLength: 4 + maxLength: 32 + pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,31}' + AutoScalingConfigurationRevision: + description: 'The revision of this auto scaling configuration. It''s unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.' + type: integer + MaxConcurrency: + description: The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up to use more instances to process the requests. + type: integer + MaxSize: + description: The maximum number of instances that an App Runner service scales up to. At most MaxSize instances actively serve traffic for your service. + type: integer + MinSize: + description: The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset. + type: integer + Latest: + description: It's set to true for the configuration with the highest Revision among all configurations that share the same AutoScalingConfigurationName. It's set to false otherwise. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code. + type: boolean + Tags: + description: A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair. + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateAutoScalingConfigurationRequest + type: object + required: [] + CreateObservabilityConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ObservabilityConfigurationArn: + description: The Amazon Resource Name (ARN) of this ObservabilityConfiguration + type: string + minLength: 1 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011} + ObservabilityConfigurationName: + description: A name for the observability configuration. When you use it for the first time in an AWS Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. + type: string + minLength: 4 + maxLength: 32 + pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,31}' + ObservabilityConfigurationRevision: + description: 'The revision of this observability configuration. It''s unique among all the active configurations (''Status'': ''ACTIVE'') that share the same ObservabilityConfigurationName.' + type: integer + Latest: + description: It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise. + type: boolean + TraceConfiguration: + description: The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. + $ref: '#/components/schemas/TraceConfiguration' + Tags: + description: A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair. + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateObservabilityConfigurationRequest + type: object + required: [] + CreateServiceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ServiceName: + description: The AppRunner Service Name. + type: string + minLength: 4 + maxLength: 40 + pattern: '[A-Za-z0-9][A-Za-z0-9-_]{3,39}' + ServiceId: + description: The AppRunner Service Id + type: string + minLength: 32 + maxLength: 32 + ServiceArn: + description: The Amazon Resource Name (ARN) of the AppRunner Service. + type: string + minLength: 1 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011} + ServiceUrl: + description: The Service Url of the AppRunner Service. + type: string + Status: + description: AppRunner Service status. + type: string + SourceConfiguration: + $ref: '#/components/schemas/SourceConfiguration' + InstanceConfiguration: + $ref: '#/components/schemas/InstanceConfiguration' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + HealthCheckConfiguration: + $ref: '#/components/schemas/HealthCheckConfiguration' + ObservabilityConfiguration: + $ref: '#/components/schemas/ServiceObservabilityConfiguration' + AutoScalingConfigurationArn: + description: Autoscaling configuration ARN + type: string + minLength: 1 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011} + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + x-stackQL-stringOnly: true + x-title: CreateServiceRequest + type: object + required: [] + CreateVpcConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VpcConnectorName: + description: A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector. + type: string + minLength: 4 + maxLength: 40 + pattern: ^[A-Za-z0-9][A-Za-z0-9-\\_]{3,39}$ + VpcConnectorArn: + description: The Amazon Resource Name (ARN) of this VPC connector. + type: string + minLength: 44 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011} + VpcConnectorRevision: + description: 'The revision of this VPC connector. It''s unique among all the active connectors ("Status": "ACTIVE") that share the same Name.' + type: integer + Subnets: + description: A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + items: + type: string + SecurityGroups: + description: A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Tags: + description: A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair. + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVpcConnectorRequest + type: object + required: [] + CreateVpcIngressConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VpcIngressConnectionArn: + description: The Amazon Resource Name (ARN) of the VpcIngressConnection. + type: string + minLength: 1 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011} + VpcIngressConnectionName: + description: The customer-provided Vpc Ingress Connection name. + type: string + minLength: 4 + maxLength: 40 + pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,39}' + ServiceArn: + description: The Amazon Resource Name (ARN) of the service. + type: string + minLength: 1 + maxLength: 1011 + pattern: arn:aws(-[\w]+)*:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[0-9]{12}:(\w|/|-){1,1011} + Status: + description: The current status of the VpcIngressConnection. + type: string + enum: + - AVAILABLE + - PENDING_CREATION + - PENDING_UPDATE + - PENDING_DELETION + - FAILED_CREATION + - FAILED_UPDATE + - FAILED_DELETION + - DELETED + DomainName: + description: The Domain name associated with the VPC Ingress Connection. + type: string + minLength: 1 + maxLength: 255 + pattern: '[A-Za-z0-9*.-]{1,255}' + IngressVpcConfiguration: + $ref: '#/components/schemas/IngressVpcConfiguration' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVpcIngressConnectionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: auto_scaling_configurations: name: auto_scaling_configurations id: awscc.apprunner.auto_scaling_configurations x-cfn-schema-name: AutoScalingConfiguration - x-type: list - x-identifiers: - - AutoScalingConfigurationArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AutoScalingConfigurationArn') as auto_scaling_configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' - AND region = 'us-east-1' - auto_scaling_configuration: - name: auto_scaling_configuration - id: awscc.apprunner.auto_scaling_configuration - x-cfn-schema-name: AutoScalingConfiguration - x-type: get + x-cfn-type-name: AWS::AppRunner::AutoScalingConfiguration x-identifiers: - AutoScalingConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutoScalingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::AutoScalingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::AutoScalingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/auto_scaling_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/auto_scaling_configurations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -730,7 +1457,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -746,13 +1473,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - observability_configurations: - name: observability_configurations - id: awscc.apprunner.observability_configurations - x-cfn-schema-name: ObservabilityConfiguration - x-type: list + auto_scaling_configurations_list_only: + name: auto_scaling_configurations_list_only + id: awscc.apprunner.auto_scaling_configurations_list_only + x-cfn-schema-name: AutoScalingConfiguration + x-cfn-type-name: AWS::AppRunner::AutoScalingConfiguration x-identifiers: - - ObservabilityConfigurationArn + - AutoScalingConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -760,28 +1493,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ObservabilityConfigurationArn') as observability_configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' + JSON_EXTRACT(Properties, '$.AutoScalingConfigurationArn') as auto_scaling_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ObservabilityConfigurationArn') as observability_configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' + json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' AND region = 'us-east-1' - observability_configuration: - name: observability_configuration - id: awscc.apprunner.observability_configuration + observability_configurations: + name: observability_configurations + id: awscc.apprunner.observability_configurations x-cfn-schema-name: ObservabilityConfiguration - x-type: get + x-cfn-type-name: AWS::AppRunner::ObservabilityConfiguration x-identifiers: - ObservabilityConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ObservabilityConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::ObservabilityConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::ObservabilityConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/observability_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/observability_configurations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -796,7 +1564,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -810,13 +1578,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - services: - name: services - id: awscc.apprunner.services - x-cfn-schema-name: Service - x-type: list + observability_configurations_list_only: + name: observability_configurations_list_only + id: awscc.apprunner.observability_configurations_list_only + x-cfn-schema-name: ObservabilityConfiguration + x-cfn-type-name: AWS::AppRunner::ObservabilityConfiguration x-identifiers: - - ServiceArn + - ObservabilityConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -824,28 +1598,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' + JSON_EXTRACT(Properties, '$.ObservabilityConfigurationArn') as observability_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ServiceArn') as service_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' + json_extract_path_text(Properties, 'ObservabilityConfigurationArn') as observability_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' AND region = 'us-east-1' - service: - name: service - id: awscc.apprunner.service + services: + name: services + id: awscc.apprunner.services x-cfn-schema-name: Service - x-type: get + x-cfn-type-name: AWS::AppRunner::Service x-identifiers: - ServiceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -867,7 +1689,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -888,13 +1710,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::Service' AND data__Identifier = '' AND region = 'us-east-1' - vpc_connectors: - name: vpc_connectors - id: awscc.apprunner.vpc_connectors - x-cfn-schema-name: VpcConnector - x-type: list + services_list_only: + name: services_list_only + id: awscc.apprunner.services_list_only + x-cfn-schema-name: Service + x-cfn-type-name: AWS::AppRunner::Service x-identifiers: - - VpcConnectorArn + - ServiceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -902,28 +1730,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VpcConnectorArn') as vpc_connector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' + JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VpcConnectorArn') as vpc_connector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' + json_extract_path_text(Properties, 'ServiceArn') as service_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' AND region = 'us-east-1' - vpc_connector: - name: vpc_connector - id: awscc.apprunner.vpc_connector + vpc_connectors: + name: vpc_connectors + id: awscc.apprunner.vpc_connectors x-cfn-schema-name: VpcConnector - x-type: get + x-cfn-type-name: AWS::AppRunner::VpcConnector x-identifiers: - VpcConnectorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcConnector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::VpcConnector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::VpcConnector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_connectors/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -938,7 +1801,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -952,13 +1815,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' AND data__Identifier = '' AND region = 'us-east-1' - vpc_ingress_connections: - name: vpc_ingress_connections - id: awscc.apprunner.vpc_ingress_connections - x-cfn-schema-name: VpcIngressConnection - x-type: list + vpc_connectors_list_only: + name: vpc_connectors_list_only + id: awscc.apprunner.vpc_connectors_list_only + x-cfn-schema-name: VpcConnector + x-cfn-type-name: AWS::AppRunner::VpcConnector x-identifiers: - - VpcIngressConnectionArn + - VpcConnectorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -966,28 +1835,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VpcIngressConnectionArn') as vpc_ingress_connection_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' + JSON_EXTRACT(Properties, '$.VpcConnectorArn') as vpc_connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VpcIngressConnectionArn') as vpc_ingress_connection_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' + json_extract_path_text(Properties, 'VpcConnectorArn') as vpc_connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' AND region = 'us-east-1' - vpc_ingress_connection: - name: vpc_ingress_connection - id: awscc.apprunner.vpc_ingress_connection + vpc_ingress_connections: + name: vpc_ingress_connections + id: awscc.apprunner.vpc_ingress_connections x-cfn-schema-name: VpcIngressConnection - x-type: get + x-cfn-type-name: AWS::AppRunner::VpcIngressConnection x-identifiers: - VpcIngressConnectionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcIngressConnection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::VpcIngressConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::VpcIngressConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppRunner::VpcIngressConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1003,7 +1920,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1018,3 +1935,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' AND data__Identifier = '' AND region = 'us-east-1' + vpc_ingress_connections_list_only: + name: vpc_ingress_connections_list_only + id: awscc.apprunner.vpc_ingress_connections_list_only + x-cfn-schema-name: VpcIngressConnection + x-cfn-type-name: AWS::AppRunner::VpcIngressConnection + x-identifiers: + - VpcIngressConnectionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VpcIngressConnectionArn') as vpc_ingress_connection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcIngressConnectionArn') as vpc_ingress_connection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutoScalingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutoScalingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutoScalingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ObservabilityConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateObservabilityConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateObservabilityConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateService + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcConnector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcIngressConnection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcIngressConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcIngressConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/appstream.yaml b/providers/src/awscc/v00.00.00000/services/appstream.yaml index 6ddd3d86..1b399f17 100644 --- a/providers/src/awscc/v00.00.00000/services/appstream.yaml +++ b/providers/src/awscc/v00.00.00000/services/appstream.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: AppStream - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: S3Location: type: object @@ -78,7 +458,9 @@ components: - Name - SourceS3Location x-stackql-resource-name: app_block - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::AppBlock + x-type-name: AWS::AppStream::AppBlock + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -91,6 +473,19 @@ components: x-read-only-properties: - Arn - CreatedTime + x-required-properties: + - Name + - SourceS3Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - appstream:TagResource + - appstream:ListTagsForResource + - appstream:UntagResource x-required-permissions: create: - appstream:CreateAppBlock @@ -100,8 +495,14 @@ components: - s3:GetBucketOwnershipControls read: - appstream:DescribeAppBlocks + - appstream:ListTagsForResource delete: - appstream:DeleteAppBlock + - appstream:DescribeAppBlocks + update: + - appstream:DescribeAppBlocks + - appstream:TagResource + - appstream:UntagResource PlatformType: type: string AccessEndpoint: @@ -176,13 +577,32 @@ components: - InstanceType - VpcConfig x-stackql-resource-name: app_block_builder - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::AppBlockBuilder. + x-type-name: AWS::AppStream::AppBlockBuilder + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - AppBlockArns x-read-only-properties: - Arn - CreatedTime + x-required-properties: + - Name + - Platform + - InstanceType + - VpcConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - appstream:ListTagsForResource + - appstream:TagResource + - appstream:UntagResource x-required-permissions: create: - appstream:CreateAppBlockBuilder @@ -191,9 +611,11 @@ components: - appstream:AssociateAppBlockBuilderAppBlock - appstream:DescribeAppBlockBuilderAppBlockAssociations - appstream:TagResource + - appstream:ListTagsForResource - iam:PassRole read: - appstream:DescribeAppBlockBuilders + - appstream:ListTagsForResource update: - appstream:UpdateAppBlockBuilder - appstream:DescribeAppBlockBuilders @@ -270,15 +692,36 @@ components: - InstanceFamilies - AppBlockArn x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::Application + x-type-name: AWS::AppStream::Application + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name - InstanceFamilies - Platforms + x-write-only-properties: + - AttributesToDelete x-read-only-properties: - Arn - CreatedTime + x-required-properties: + - Name + - IconS3Location + - LaunchPath + - Platforms + - InstanceFamilies + - AppBlockArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - appstream:TagResource + - appstream:ListTagsForResource + - appstream:UntagResource x-required-permissions: create: - s3:GetObject @@ -286,11 +729,16 @@ components: - appstream:TagResource read: - appstream:DescribeApplications + - appstream:ListTagsForResource update: - appstream:UpdateApplication + - appstream:DescribeApplications + - appstream:TagResource + - appstream:UntagResource - s3:GetObject delete: - appstream:DeleteApplication + - appstream:DescribeApplications ApplicationEntitlementAssociation: type: object properties: @@ -305,7 +753,9 @@ components: - EntitlementName - ApplicationIdentifier x-stackql-resource-name: application_entitlement_association - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::ApplicationEntitlementAssociation + x-type-name: AWS::AppStream::ApplicationEntitlementAssociation + x-stackql-primary-identifier: - StackName - EntitlementName - ApplicationIdentifier @@ -313,6 +763,12 @@ components: - StackName - EntitlementName - ApplicationIdentifier + x-required-properties: + - StackName + - EntitlementName + - ApplicationIdentifier + x-tagging: + taggable: false x-required-permissions: create: - appstream:AssociateApplicationToEntitlement @@ -333,12 +789,19 @@ components: - FleetName - ApplicationArn x-stackql-resource-name: application_fleet_association - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::ApplicationFleetAssociation + x-type-name: AWS::AppStream::ApplicationFleetAssociation + x-stackql-primary-identifier: - FleetName - ApplicationArn x-create-only-properties: - FleetName - ApplicationArn + x-required-properties: + - FleetName + - ApplicationArn + x-tagging: + taggable: false x-required-permissions: create: - appstream:AssociateApplicationFleet @@ -386,15 +849,25 @@ components: - OrganizationalUnitDistinguishedNames - ServiceAccountCredentials x-stackql-resource-name: directory_config - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::DirectoryConfig + x-type-name: AWS::AppStream::DirectoryConfig + x-stackql-primary-identifier: - DirectoryName x-create-only-properties: - DirectoryName + x-write-only-properties: + - ServiceAccountCredentials/AccountPassword + x-required-properties: + - DirectoryName + - OrganizationalUnitDistinguishedNames + - ServiceAccountCredentials + x-tagging: + taggable: false x-required-permissions: create: - appstream:CreateDirectoryConfig - appstream:DeleteDirectoryConfig - - appstream:DescribeDirectoryConfig + - appstream:DescribeDirectoryConfigs - appstream:UpdateDirectoryConfig - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole @@ -402,7 +875,7 @@ components: update: - appstream:CreateDirectoryConfig - appstream:DeleteDirectoryConfig - - appstream:DescribeDirectoryConfig + - appstream:DescribeDirectoryConfigs - appstream:UpdateDirectoryConfig - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole @@ -410,7 +883,7 @@ components: read: - appstream:CreateDirectoryConfig - appstream:DeleteDirectoryConfig - - appstream:DescribeDirectoryConfig + - appstream:DescribeDirectoryConfigs - appstream:UpdateDirectoryConfig - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole @@ -418,7 +891,7 @@ components: delete: - appstream:CreateDirectoryConfig - appstream:DeleteDirectoryConfig - - appstream:DescribeDirectoryConfig + - appstream:DescribeDirectoryConfigs - appstream:UpdateDirectoryConfig - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole @@ -426,7 +899,7 @@ components: list: - appstream:CreateDirectoryConfig - appstream:DeleteDirectoryConfig - - appstream:DescribeDirectoryConfig + - appstream:DescribeDirectoryConfigs - appstream:UpdateDirectoryConfig - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole @@ -469,7 +942,9 @@ components: - AppVisibility - Attributes x-stackql-resource-name: entitlement - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::Entitlement + x-type-name: AWS::AppStream::Entitlement + x-stackql-primary-identifier: - StackName - Name x-create-only-properties: @@ -478,6 +953,13 @@ components: x-read-only-properties: - CreatedTime - LastModifiedTime + x-required-properties: + - Name + - StackName + - AppVisibility + - Attributes + x-tagging: + taggable: false x-required-permissions: create: - appstream:CreateEntitlement @@ -536,10 +1018,21 @@ components: - InstanceType - Name x-stackql-resource-name: image_builder - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppStream::ImageBuilder + x-type-name: AWS::AppStream::ImageBuilder + x-stackql-primary-identifier: - Name x-read-only-properties: - StreamingUrl + x-required-properties: + - InstanceType + - Name + x-tagging: + taggable: false + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - appstream:CreateImageBuilder @@ -585,18 +1078,388 @@ components: - iam:CreateServiceLinkedRole - iam:DeleteServiceLinkedRole - iam:GetServiceLinkedRoleDeletionStatus + CreateAppBlockRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + Arn: + $ref: '#/components/schemas/Arn' + Description: + type: string + DisplayName: + type: string + SourceS3Location: + $ref: '#/components/schemas/S3Location' + SetupScriptDetails: + $ref: '#/components/schemas/ScriptDetails' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + CreatedTime: + type: string + PackagingType: + $ref: '#/components/schemas/PackagingType' + PostSetupScriptDetails: + $ref: '#/components/schemas/ScriptDetails' + x-stackQL-stringOnly: true + x-title: CreateAppBlockRequest + type: object + required: [] + CreateAppBlockBuilderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + Arn: + $ref: '#/components/schemas/Arn' + Description: + type: string + DisplayName: + type: string + Platform: + $ref: '#/components/schemas/PlatformType' + AccessEndpoints: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/AccessEndpoint' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + VpcConfig: + $ref: '#/components/schemas/VpcConfig' + EnableDefaultInternetAccess: + type: boolean + IamRoleArn: + type: string + CreatedTime: + type: string + InstanceType: + type: string + AppBlockArns: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Arn' + x-stackQL-stringOnly: true + x-title: CreateAppBlockBuilderRequest + type: object + required: [] + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + DisplayName: + type: string + Description: + type: string + LaunchPath: + type: string + LaunchParameters: + type: string + WorkingDirectory: + type: string + InstanceFamilies: + type: array + uniqueItems: true + items: + type: string + x-insertionOrder: false + IconS3Location: + $ref: '#/components/schemas/S3Location' + Arn: + $ref: '#/components/schemas/Arn' + AppBlockArn: + $ref: '#/components/schemas/Arn' + Platforms: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/PlatformType' + x-insertionOrder: false + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + AttributesToDelete: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ApplicationAttribute' + x-insertionOrder: false + CreatedTime: + type: string + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateApplicationEntitlementAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StackName: + type: string + EntitlementName: + type: string + ApplicationIdentifier: + type: string + x-stackQL-stringOnly: true + x-title: CreateApplicationEntitlementAssociationRequest + type: object + required: [] + CreateApplicationFleetAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FleetName: + type: string + ApplicationArn: + $ref: '#/components/schemas/Arn' + x-stackQL-stringOnly: true + x-title: CreateApplicationFleetAssociationRequest + type: object + required: [] + CreateDirectoryConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OrganizationalUnitDistinguishedNames: + type: array + uniqueItems: false + items: + type: string + ServiceAccountCredentials: + $ref: '#/components/schemas/ServiceAccountCredentials' + DirectoryName: + type: string + CertificateBasedAuthProperties: + $ref: '#/components/schemas/CertificateBasedAuthProperties' + x-stackQL-stringOnly: true + x-title: CreateDirectoryConfigRequest + type: object + required: [] + CreateEntitlementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + StackName: + type: string + Description: + type: string + AppVisibility: + type: string + Attributes: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Attribute' + CreatedTime: + type: string + LastModifiedTime: + type: string + x-stackQL-stringOnly: true + x-title: CreateEntitlementRequest + type: object + required: [] + CreateImageBuilderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + VpcConfig: + $ref: '#/components/schemas/VpcConfig' + EnableDefaultInternetAccess: + type: boolean + DomainJoinInfo: + $ref: '#/components/schemas/DomainJoinInfo' + AppstreamAgentVersion: + type: string + Name: + type: string + ImageName: + type: string + DisplayName: + type: string + IamRoleArn: + type: string + InstanceType: + type: string + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + StreamingUrl: + type: string + ImageArn: + type: string + AccessEndpoints: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/AccessEndpoint' + x-stackQL-stringOnly: true + x-title: CreateImageBuilderRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - app_block: - name: app_block - id: awscc.appstream.app_block + app_blocks: + name: app_blocks + id: awscc.appstream.app_blocks x-cfn-schema-name: AppBlock - x-type: get + x-cfn-type-name: AWS::AppStream::AppBlock x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AppBlock&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::AppBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::AppBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::AppBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_blocks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_blocks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/app_blocks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -615,7 +1478,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -637,38 +1500,61 @@ components: name: app_block_builders id: awscc.appstream.app_block_builders x-cfn-schema-name: AppBlockBuilder - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' - AND region = 'us-east-1' - app_block_builder: - name: app_block_builder - id: awscc.appstream.app_block_builder - x-cfn-schema-name: AppBlockBuilder - x-type: get + x-cfn-type-name: AWS::AppStream::AppBlockBuilder x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AppBlockBuilder&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::AppBlockBuilder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::AppBlockBuilder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::AppBlockBuilder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -690,7 +1576,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -711,17 +1597,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' AND data__Identifier = '' AND region = 'us-east-1' - application: - name: application - id: awscc.appstream.application + app_block_builders_list_only: + name: app_block_builders_list_only + id: awscc.appstream.app_block_builders_list_only + x-cfn-schema-name: AppBlockBuilder + x-cfn-type-name: AWS::AppStream::AppBlockBuilder + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' + AND region = 'us-east-1' + applications: + name: applications + id: awscc.appstream.applications x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::AppStream::Application x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -744,7 +1709,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -766,19 +1731,54 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::Application' AND data__Identifier = '' AND region = 'us-east-1' - application_entitlement_association: - name: application_entitlement_association - id: awscc.appstream.application_entitlement_association + application_entitlement_associations: + name: application_entitlement_associations + id: awscc.appstream.application_entitlement_associations x-cfn-schema-name: ApplicationEntitlementAssociation - x-type: get + x-cfn-type-name: AWS::AppStream::ApplicationEntitlementAssociation x-identifiers: - StackName - EntitlementName - ApplicationIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationEntitlementAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::ApplicationEntitlementAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::ApplicationEntitlementAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_entitlement_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_entitlement_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -790,7 +1790,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -801,18 +1801,53 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::ApplicationEntitlementAssociation' AND data__Identifier = '||' AND region = 'us-east-1' - application_fleet_association: - name: application_fleet_association - id: awscc.appstream.application_fleet_association + application_fleet_associations: + name: application_fleet_associations + id: awscc.appstream.application_fleet_associations x-cfn-schema-name: ApplicationFleetAssociation - x-type: get + x-cfn-type-name: AWS::AppStream::ApplicationFleetAssociation x-identifiers: - FleetName - ApplicationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationFleetAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::ApplicationFleetAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::ApplicationFleetAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_fleet_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_fleet_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -823,7 +1858,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -837,34 +1872,98 @@ components: name: directory_configs id: awscc.appstream.directory_configs x-cfn-schema-name: DirectoryConfig - x-type: list + x-cfn-type-name: AWS::AppStream::DirectoryConfig x-identifiers: - DirectoryName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DirectoryConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::DirectoryConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::DirectoryConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::DirectoryConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/directory_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/directory_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/directory_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DirectoryName') as directory_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' + data__Identifier, + JSON_EXTRACT(Properties, '$.OrganizationalUnitDistinguishedNames') as organizational_unit_distinguished_names, + JSON_EXTRACT(Properties, '$.ServiceAccountCredentials') as service_account_credentials, + JSON_EXTRACT(Properties, '$.DirectoryName') as directory_name, + JSON_EXTRACT(Properties, '$.CertificateBasedAuthProperties') as certificate_based_auth_properties + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'DirectoryName') as directory_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' + data__Identifier, + json_extract_path_text(Properties, 'OrganizationalUnitDistinguishedNames') as organizational_unit_distinguished_names, + json_extract_path_text(Properties, 'ServiceAccountCredentials') as service_account_credentials, + json_extract_path_text(Properties, 'DirectoryName') as directory_name, + json_extract_path_text(Properties, 'CertificateBasedAuthProperties') as certificate_based_auth_properties + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' + AND data__Identifier = '' AND region = 'us-east-1' - directory_config: - name: directory_config - id: awscc.appstream.directory_config + directory_configs_list_only: + name: directory_configs_list_only + id: awscc.appstream.directory_configs_list_only x-cfn-schema-name: DirectoryConfig - x-type: get + x-cfn-type-name: AWS::AppStream::DirectoryConfig x-identifiers: - DirectoryName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -872,39 +1971,77 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.OrganizationalUnitDistinguishedNames') as organizational_unit_distinguished_names, - JSON_EXTRACT(Properties, '$.ServiceAccountCredentials') as service_account_credentials, - JSON_EXTRACT(Properties, '$.DirectoryName') as directory_name, - JSON_EXTRACT(Properties, '$.CertificateBasedAuthProperties') as certificate_based_auth_properties - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DirectoryName') as directory_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'OrganizationalUnitDistinguishedNames') as organizational_unit_distinguished_names, - json_extract_path_text(Properties, 'ServiceAccountCredentials') as service_account_credentials, - json_extract_path_text(Properties, 'DirectoryName') as directory_name, - json_extract_path_text(Properties, 'CertificateBasedAuthProperties') as certificate_based_auth_properties - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' - AND data__Identifier = '' + json_extract_path_text(Properties, 'DirectoryName') as directory_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' AND region = 'us-east-1' - entitlement: - name: entitlement - id: awscc.appstream.entitlement + entitlements: + name: entitlements + id: awscc.appstream.entitlements x-cfn-schema-name: Entitlement - x-type: get + x-cfn-type-name: AWS::AppStream::Entitlement x-identifiers: - StackName - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Entitlement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::Entitlement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::Entitlement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::Entitlement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -920,7 +2057,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -939,38 +2076,48 @@ components: name: image_builders id: awscc.appstream.image_builders x-cfn-schema-name: ImageBuilder - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' - AND region = 'us-east-1' - image_builder: - name: image_builder - id: awscc.appstream.image_builder - x-cfn-schema-name: ImageBuilder - x-type: get + x-cfn-type-name: AWS::AppStream::ImageBuilder x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ImageBuilder&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::ImageBuilder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppStream::ImageBuilder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/image_builders/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/image_builders/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -993,7 +2140,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1015,3 +2162,523 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' AND data__Identifier = '' AND region = 'us-east-1' + image_builders_list_only: + name: image_builders_list_only + id: awscc.appstream.image_builders_list_only + x-cfn-schema-name: ImageBuilder + x-cfn-type-name: AWS::AppStream::ImageBuilder + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AppBlock&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAppBlock + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppBlockRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AppBlockBuilder&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAppBlockBuilder + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppBlockBuilderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationEntitlementAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationEntitlementAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationEntitlementAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationFleetAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationFleetAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationFleetAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DirectoryConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDirectoryConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDirectoryConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Entitlement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEntitlement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEntitlementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ImageBuilder&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateImageBuilder + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateImageBuilderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/appsync.yaml b/providers/src/awscc/v00.00.00000/services/appsync.yaml index 31e38768..78d84a2a 100644 --- a/providers/src/awscc/v00.00.00000/services/appsync.yaml +++ b/providers/src/awscc/v00.00.00000/services/appsync.yaml @@ -1,10 +1,988 @@ openapi: 3.0.0 info: title: AppSync - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + EventConfig: + description: The configuration for an Event Api + type: object + additionalProperties: false + properties: + AuthProviders: + $ref: '#/components/schemas/AuthProviders' + ConnectionAuthModes: + $ref: '#/components/schemas/AuthModes' + DefaultPublishAuthModes: + $ref: '#/components/schemas/AuthModes' + DefaultSubscribeAuthModes: + $ref: '#/components/schemas/AuthModes' + LogConfig: + $ref: '#/components/schemas/EventLogConfig' + required: + - AuthProviders + - ConnectionAuthModes + - DefaultPublishAuthModes + - DefaultSubscribeAuthModes + AuthMode: + description: An auth mode. + type: object + additionalProperties: false + properties: + AuthType: + $ref: '#/components/schemas/AuthenticationType' + AuthModes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AuthMode' + AuthenticationType: + description: Security configuration for your AppSync API. + type: string + enum: + - AMAZON_COGNITO_USER_POOLS + - AWS_IAM + - API_KEY + - OPENID_CONNECT + - AWS_LAMBDA + OpenIDConnectConfig: + type: object + additionalProperties: false + properties: + ClientId: + description: The client identifier of the Relying party at the OpenID identity provider. + type: string + AuthTTL: + description: The number of milliseconds that a token is valid after being authenticated. + type: number + Issuer: + description: 'The issuer for the OIDC configuration. ' + type: string + IatTTL: + description: |+ + The number of milliseconds that a token is valid after it's issued to a user. + + type: number + CognitoConfig: + description: Optional authorization configuration for using Amazon Cognito user pools with your API endpoint. + type: object + additionalProperties: false + properties: + AppIdClientRegex: + type: string + UserPoolId: + type: string + AwsRegion: + type: string + required: + - UserPoolId + - AwsRegion + LambdaAuthorizerConfig: + type: object + additionalProperties: false + properties: + IdentityValidationExpression: + description: A regular expression for validation of tokens before the Lambda function is called. + type: string + AuthorizerUri: + description: The ARN of the Lambda function to be called for authorization. + type: string + AuthorizerResultTtlInSeconds: + description: The number of seconds a response should be cached for. + type: integer + AuthProviders: + description: A list of auth providers for the AppSync API. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AuthProvider' + AuthProvider: + description: An auth provider for the AppSync API. + type: object + additionalProperties: false + properties: + AuthType: + $ref: '#/components/schemas/AuthenticationType' + OpenIDConnectConfig: + $ref: '#/components/schemas/OpenIDConnectConfig' + CognitoConfig: + $ref: '#/components/schemas/CognitoConfig' + LambdaAuthorizerConfig: + $ref: '#/components/schemas/LambdaAuthorizerConfig' + required: + - AuthType + Tag: + type: object + additionalProperties: false + properties: + Value: + type: string + Key: + type: string + required: + - Value + - Key + Tags: + description: An arbitrary set of tags (key-value pairs) for this Domain Name. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + ApiName: + description: The name of the AppSync API. + type: string + minLength: 1 + maxLength: 50 + pattern: '[A-Za-z0-9_\-\ ]+' + OwnerContact: + description: The owner contact information for an API resource. + type: string + minLength: 1 + maxLength: 250 + pattern: '[A-Za-z0-9_\-\ \.]+' + DnsMap: + description: A map of DNS names for the AppSync API. + type: object + additionalProperties: false + properties: + Realtime: + type: string + Http: + type: string + EventLogLevel: + description: Logging level for the AppSync API. + type: string + enum: + - NONE + - ERROR + - ALL + - INFO + - DEBUG + EventLogConfig: + description: The log config for the AppSync API. + type: object + additionalProperties: false + properties: + LogLevel: + $ref: '#/components/schemas/EventLogLevel' + CloudWatchLogsRoleArn: + type: string + required: + - LogLevel + - CloudWatchLogsRoleArn + Api: + type: object + properties: + ApiId: + description: The unique identifier for the AppSync Api generated by the service + type: string + ApiArn: + description: The Amazon Resource Name (ARN) of the AppSync Api + type: string + Name: + $ref: '#/components/schemas/ApiName' + OwnerContact: + $ref: '#/components/schemas/OwnerContact' + Dns: + $ref: '#/components/schemas/DnsMap' + EventConfig: + $ref: '#/components/schemas/EventConfig' + Tags: + $ref: '#/components/schemas/Tags' + required: + - Name + x-stackql-resource-name: api + description: Resource schema for AppSync Api + x-type-name: AWS::AppSync::Api + x-stackql-primary-identifier: + - ApiArn + x-read-only-properties: + - ApiId + - Dns + - Dns/Realtime + - Dns/Http + - ApiArn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appsync:TagResource + - appsync:UntagResource + x-required-permissions: + create: + - appsync:CreateApi + - appsync:TagResource + - appsync:GetApi + - iam:PassRole + read: + - appsync:GetApi + - appsync:ListTagsForResource + update: + - appsync:UpdateApi + - appsync:TagResource + - appsync:UntagResource + - appsync:GetApi + - iam:PassRole + delete: + - appsync:DeleteApi + - appsync:UntagResource + list: + - appsync:ListApis + Namespace: + description: Namespace indentifier. + type: string + minLength: 1 + maxLength: 50 + pattern: ([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?) + Code: + description: String of APPSYNC_JS code to be used by the handlers. + type: string + minLength: 1 + maxLength: 32768 + ChannelNamespaceArn: + type: string + description: The Amazon Resource Name (ARN) for the Channel Namespace. + HandlerBehavior: + type: string + description: Integration behavior for a handler configuration. + enum: + - CODE + - DIRECT + HandlerConfig: + type: object + additionalProperties: false + properties: + Behavior: + $ref: '#/components/schemas/HandlerBehavior' + Integration: + $ref: '#/components/schemas/Integration' + required: + - Behavior + - Integration + HandlerConfigs: + type: object + additionalProperties: false + properties: + OnPublish: + $ref: '#/components/schemas/HandlerConfig' + OnSubscribe: + $ref: '#/components/schemas/HandlerConfig' + Integration: + type: object + additionalProperties: false + properties: + DataSourceName: + description: Data source to invoke for this integration. + type: string + minLength: 1 + maxLength: 512 + pattern: ([_A-Za-z][_0-9A-Za-z]{0,511})? + LambdaConfig: + $ref: '#/components/schemas/LambdaConfig' + required: + - DataSourceName + InvokeType: + description: Invocation type for direct lambda integrations. + type: string + enum: + - REQUEST_RESPONSE + - EVENT + LambdaConfig: + type: object + additionalProperties: false + properties: + LambdaFunctionArn: + description: The ARN for the Lambda function. + type: string + required: + - LambdaFunctionArn + ChannelNamespace: + type: object + properties: + ApiId: + description: AppSync Api Id that this Channel Namespace belongs to. + type: string + Name: + $ref: '#/components/schemas/Namespace' + SubscribeAuthModes: + description: List of AuthModes supported for Subscribe operations. + $ref: '#/components/schemas/AuthModes' + PublishAuthModes: + description: List of AuthModes supported for Publish operations. + $ref: '#/components/schemas/AuthModes' + CodeHandlers: + $ref: '#/components/schemas/Code' + CodeS3Location: + description: The Amazon S3 endpoint where the code is located. + type: string + ChannelNamespaceArn: + $ref: '#/components/schemas/ChannelNamespaceArn' + Tags: + $ref: '#/components/schemas/Tags' + HandlerConfigs: + $ref: '#/components/schemas/HandlerConfigs' + required: + - ApiId + - Name + x-stackql-resource-name: channel_namespace + description: Resource schema for AppSync ChannelNamespace + x-type-name: AWS::AppSync::ChannelNamespace + x-stackql-primary-identifier: + - ChannelNamespaceArn + x-create-only-properties: + - ApiId + - Name + x-write-only-properties: + - CodeS3Location + x-read-only-properties: + - ChannelNamespaceArn + x-required-properties: + - ApiId + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appsync:TagResource + - appsync:UntagResource + x-required-permissions: + create: + - appsync:CreateChannelNamespace + - appsync:TagResource + - appsync:GetChannelNamespace + - s3:GetObject + read: + - appsync:GetChannelNamespace + - appsync:ListTagsForResource + update: + - appsync:UpdateChannelNamespace + - appsync:TagResource + - appsync:UntagResource + - appsync:GetChannelNamespace + - s3:GetObject + delete: + - appsync:DeleteChannelNamespace + - appsync:UntagResource + list: + - appsync:ListChannelNamespaces + RdsHttpEndpointConfig: + type: object + additionalProperties: false + properties: + DatabaseName: + description: Logical database name. + type: string + AwsRegion: + description: AWS Region for RDS HTTP endpoint. + type: string + DbClusterIdentifier: + description: Amazon RDS cluster Amazon Resource Name (ARN). + type: string + AwsSecretStoreArn: + description: The ARN for database credentials stored in AWS Secrets Manager. + type: string + Schema: + description: Logical schema name. + type: string + required: + - AwsRegion + - DbClusterIdentifier + - AwsSecretStoreArn + OpenSearchServiceConfig: + type: object + additionalProperties: false + properties: + AwsRegion: + description: The AWS Region. + type: string + Endpoint: + description: The endpoint. + type: string + required: + - AwsRegion + - Endpoint + AwsIamConfig: + type: object + additionalProperties: false + properties: + SigningRegion: + description: The signing Region for AWS Identity and Access Management authorization. + type: string + SigningServiceName: + description: The signing service name for AWS Identity and Access Management authorization. + type: string + EventBridgeConfig: + type: object + additionalProperties: false + properties: + EventBusArn: + description: ARN for the EventBridge bus. + type: string + required: + - EventBusArn + AuthorizationConfig: + type: object + additionalProperties: false + properties: + AuthorizationType: + description: The authorization type that the HTTP endpoint requires. + type: string + AwsIamConfig: + description: The AWS Identity and Access Management settings. + $ref: '#/components/schemas/AwsIamConfig' + required: + - AuthorizationType + DeltaSyncConfig: + type: object + additionalProperties: false + properties: + BaseTableTTL: + description: The number of minutes that an Item is stored in the data source. + type: string + DeltaSyncTableTTL: + description: The number of minutes that a Delta Sync log entry is stored in the Delta Sync table. + type: string + DeltaSyncTableName: + description: The Delta Sync table name. + type: string + required: + - BaseTableTTL + - DeltaSyncTableTTL + - DeltaSyncTableName + RelationalDatabaseConfig: + type: object + additionalProperties: false + properties: + RdsHttpEndpointConfig: + description: Information about the Amazon RDS resource. + $ref: '#/components/schemas/RdsHttpEndpointConfig' + RelationalDatabaseSourceType: + description: The type of relational data source. + type: string + required: + - RelationalDatabaseSourceType + HttpConfig: + type: object + additionalProperties: false + properties: + Endpoint: + description: The endpoint. + type: string + AuthorizationConfig: + description: The authorization configuration. + $ref: '#/components/schemas/AuthorizationConfig' + required: + - Endpoint + ElasticsearchConfig: + type: object + additionalProperties: false + properties: + AwsRegion: + description: The AWS Region. + type: string + Endpoint: + description: The endpoint. + type: string + required: + - AwsRegion + - Endpoint + DynamoDBConfig: + type: object + additionalProperties: false + properties: + TableName: + description: The table name. + type: string + DeltaSyncConfig: + description: The DeltaSyncConfig for a versioned datasource. + $ref: '#/components/schemas/DeltaSyncConfig' + UseCallerCredentials: + description: Set to TRUE to use AWS Identity and Access Management with this data source. + type: boolean + AwsRegion: + description: The AWS Region. + type: string + Versioned: + description: Set to TRUE to use Conflict Detection and Resolution with this data source. + type: boolean + required: + - TableName + - AwsRegion + DataSource: + type: object + properties: + ApiId: + description: Unique AWS AppSync GraphQL API identifier where this data source will be created. + type: string + Description: + description: The description of the data source. + type: string + DynamoDBConfig: + description: AWS Region and TableName for an Amazon DynamoDB table in your account. + $ref: '#/components/schemas/DynamoDBConfig' + ElasticsearchConfig: + description: |- + AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. + As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service. This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source. + $ref: '#/components/schemas/ElasticsearchConfig' + EventBridgeConfig: + description: ARN for the EventBridge bus. + $ref: '#/components/schemas/EventBridgeConfig' + HttpConfig: + description: Endpoints for an HTTP data source. + $ref: '#/components/schemas/HttpConfig' + LambdaConfig: + description: An ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account. + $ref: '#/components/schemas/LambdaConfig' + Name: + description: Friendly name for you to identify your AppSync data source after creation. + type: string + OpenSearchServiceConfig: + description: AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. + $ref: '#/components/schemas/OpenSearchServiceConfig' + RelationalDatabaseConfig: + description: Relational Database configuration of the relational database data source. + $ref: '#/components/schemas/RelationalDatabaseConfig' + ServiceRoleArn: + description: The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source. + type: string + Type: + description: The type of the data source. + type: string + DataSourceArn: + description: The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename. + type: string + MetricsConfig: + description: '' + type: string + enum: + - DISABLED + - ENABLED + required: + - Type + - ApiId + - Name + x-stackql-resource-name: data_source + description: Resource Type definition for AWS::AppSync::DataSource + x-type-name: AWS::AppSync::DataSource + x-stackql-primary-identifier: + - DataSourceArn + x-create-only-properties: + - ApiId + - Name + x-read-only-properties: + - DataSourceArn + x-required-properties: + - Type + - ApiId + - Name + x-tagging: + taggable: false + x-required-permissions: + create: + - appsync:CreateDataSource + - appsync:GetDataSource + - iam:PassRole + read: + - appsync:GetDataSource + update: + - appsync:UpdateDataSource + - iam:PassRole + delete: + - appsync:DeleteDataSource + - appsync:GetDataSource + list: + - appsync:ListDataSources DomainName: type: object properties: @@ -26,11 +1004,18 @@ components: type: string HostedZoneId: type: string + DomainNameArn: + type: string + description: The Amazon Resource Name (ARN) for the Domain Name. + Tags: + $ref: '#/components/schemas/Tags' required: - DomainName - CertificateArn x-stackql-resource-name: domain_name - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppSync::DomainName + x-type-name: AWS::AppSync::DomainName + x-stackql-primary-identifier: - DomainName x-create-only-properties: - DomainName @@ -38,17 +1023,35 @@ components: x-read-only-properties: - AppSyncDomainName - HostedZoneId + - DomainNameArn + x-required-properties: + - DomainName + - CertificateArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - appsync:TagResource + - appsync:UntagResource x-required-permissions: create: - appsync:CreateDomainName - appsync:GetDomainName - acm:DescribeCertificate - cloudfront:UpdateDistribution + - appsync:TagResource delete: - appsync:GetDomainName - appsync:DeleteDomainName + - appsync:UntagResource update: - appsync:UpdateDomainName + - appsync:TagResource + - appsync:UntagResource + - appsync:GetDomainName read: - appsync:GetDomainName list: @@ -69,12 +1072,22 @@ components: - DomainName - ApiId x-stackql-resource-name: domain_name_api_association - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppSync::DomainNameApiAssociation + x-type-name: AWS::AppSync::DomainNameApiAssociation + x-stackql-primary-identifier: - ApiAssociationIdentifier x-create-only-properties: - DomainName x-read-only-properties: - ApiAssociationIdentifier + x-required-properties: + - DomainName + - ApiId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - appsync:AssociateApi @@ -109,15 +1122,15 @@ components: type: string description: |- The Conflict Resolution strategy to perform in the event of a conflict. - + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server. - + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy. - + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``. + + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server. + + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy. + + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``. ConflictDetection: type: string description: |- The Conflict Detection strategy to use. - + *VERSION*: Detect conflicts based on object versions for this resolver. - + *NONE*: Do not detect conflicts when invoking this resolver. + + *VERSION*: Detect conflicts based on object versions for this resolver. + + *NONE*: Do not detect conflicts when invoking this resolver. LambdaConflictHandlerConfig: $ref: '#/components/schemas/LambdaConflictHandlerConfig' description: The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler. @@ -190,13 +1203,28 @@ components: - DataSourceName - Name x-stackql-resource-name: function_configuration - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::AppSync::FunctionConfiguration + x-stackql-primary-identifier: - FunctionArn x-create-only-properties: - ApiId + x-write-only-properties: + - CodeS3Location + - ResponseMappingTemplateS3Location + - RequestMappingTemplateS3Location x-read-only-properties: - FunctionArn - FunctionId + x-required-properties: + - ApiId + - DataSourceName + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - s3:GetObject @@ -210,6 +1238,226 @@ components: - appsync:DeleteFunction list: - appsync:ListFunctions + EnhancedMetricsConfig: + type: object + additionalProperties: false + properties: + OperationLevelMetricsConfig: + description: |+ + Controls how operation metrics will be emitted to CloudWatch. Operation metrics include: + + type: string + ResolverLevelMetricsBehavior: + description: |+ + Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include: + + type: string + DataSourceLevelMetricsBehavior: + description: |+ + Controls how data source metrics will be emitted to CloudWatch. Data source metrics include: + + type: string + required: + - OperationLevelMetricsConfig + - ResolverLevelMetricsBehavior + - DataSourceLevelMetricsBehavior + CognitoUserPoolConfig: + type: object + additionalProperties: false + properties: + AppIdClientRegex: + description: 'A regular expression for validating the incoming Amazon Cognito user pool app client ID. ' + type: string + UserPoolId: + description: The user pool ID + type: string + AwsRegion: + description: The AWS Region in which the user pool was created. + type: string + UserPoolConfig: + type: object + additionalProperties: false + properties: + AppIdClientRegex: + description: A regular expression for validating the incoming Amazon Cognito user pool app client ID. + type: string + UserPoolId: + description: The user pool ID. + type: string + AwsRegion: + description: The AWS Region in which the user pool was created. + type: string + DefaultAction: + description: The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration. + type: string + AdditionalAuthenticationProvider: + type: object + additionalProperties: false + properties: + LambdaAuthorizerConfig: + $ref: '#/components/schemas/LambdaAuthorizerConfig' + OpenIDConnectConfig: + $ref: '#/components/schemas/OpenIDConnectConfig' + UserPoolConfig: + $ref: '#/components/schemas/CognitoUserPoolConfig' + AuthenticationType: + description: The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda. + type: string + required: + - AuthenticationType + LogConfig: + type: object + additionalProperties: false + properties: + ExcludeVerboseContent: + description: Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. + type: boolean + FieldLogLevel: + description: The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL. + type: string + CloudWatchLogsRoleArn: + description: The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account. + type: string + GraphQLApi: + type: object + properties: + AdditionalAuthenticationProviders: + type: array + description: A list of additional authentication providers for the GraphqlApi API. + uniqueItems: true + items: + $ref: '#/components/schemas/AdditionalAuthenticationProvider' + ApiId: + description: Unique AWS AppSync GraphQL API identifier. + type: string + ApiType: + description: The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED). + type: string + Arn: + description: The Amazon Resource Name (ARN) of the API key + type: string + AuthenticationType: + description: Security configuration for your GraphQL API + type: string + EnhancedMetricsConfig: + description: Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent. + $ref: '#/components/schemas/EnhancedMetricsConfig' + EnvironmentVariables: + description: A map containing the list of resources with their properties and environment variables. + type: object + additionalProperties: false + x-patternProperties: + ^[A-Za-z]+\w*$: + type: string + GraphQLDns: + description: The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. + type: string + GraphQLEndpointArn: + description: The GraphQL endpoint ARN. + type: string + GraphQLUrl: + description: The Endpoint URL of your GraphQL API. + type: string + IntrospectionConfig: + description: Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled. + type: string + LambdaAuthorizerConfig: + description: A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time. + $ref: '#/components/schemas/LambdaAuthorizerConfig' + LogConfig: + description: The Amazon CloudWatch Logs configuration. + $ref: '#/components/schemas/LogConfig' + MergedApiExecutionRoleArn: + description: 'The AWS Identity and Access Management service role ARN for a merged API. ' + type: string + Name: + description: The API name + type: string + OpenIDConnectConfig: + description: The OpenID Connect configuration. + $ref: '#/components/schemas/OpenIDConnectConfig' + OwnerContact: + description: The owner contact information for an API resource. + type: string + QueryDepthLimit: + description: The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. + type: integer + RealtimeDns: + description: The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. + type: string + RealtimeUrl: + description: The GraphQL API real-time endpoint URL. + type: string + ResolverCountLimit: + description: The maximum number of resolvers that can be invoked in a single request. + type: integer + Tags: + description: |+ + An arbitrary set of tags (key-value pairs) for this GraphQL API. + + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + UserPoolConfig: + description: |+ + Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. + + $ref: '#/components/schemas/UserPoolConfig' + Visibility: + description: Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided. + type: string + XrayEnabled: + description: |+ + A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi. + + type: boolean + required: + - Name + - AuthenticationType + x-stackql-resource-name: graphql_api + description: Resource Type definition for AWS::AppSync::GraphQLApi + x-type-name: AWS::AppSync::GraphQLApi + x-stackql-primary-identifier: + - ApiId + x-read-only-properties: + - ApiId + - Arn + - GraphQLEndpointArn + - GraphQLDns + - GraphQLUrl + - RealtimeDns + - RealtimeUrl + x-required-properties: + - Name + - AuthenticationType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - appsync:TagResource + - appsync:UntagResource + - appsync:ListTagsForResource + x-required-permissions: + create: + - appsync:CreateGraphqlApi + - appsync:TagResource + read: + - appsync:GetGraphqlApi + - appsync:GetGraphqlApiEnvironmentVariables + - appsync:ListTagsForResource + update: + - appsync:GetGraphqlApi + - appsync:UpdateGraphqlApi + - appsync:TagResource + - appsync:UntagResource + delete: + - appsync:DeleteGraphqlApi + list: + - appsync:ListGraphqlApis PipelineConfig: type: object additionalProperties: false @@ -223,7 +1471,7 @@ components: type: string description: |- Use the ``PipelineConfig`` property type to specify ``PipelineConfig`` for an APSYlong resolver. - ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource. + ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource. CachingConfig: type: object additionalProperties: false @@ -270,8 +1518,8 @@ components: type: string description: |- The resolver type. - + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. - + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. + + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. + + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. MaxBatchSize: type: integer description: The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation. @@ -306,7 +1554,7 @@ components: description: The GraphQL type that invokes this resolver. MetricsConfig: type: string - description: '' + description: Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value. enum: - ENABLED - DISABLED @@ -315,14 +1563,29 @@ components: - ApiId - FieldName x-stackql-resource-name: resolver - x-stackql-primaryIdentifier: + description: |- + The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html). + When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation. + See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*. + x-type-name: AWS::AppSync::Resolver + x-stackql-primary-identifier: - ResolverArn x-create-only-properties: - ApiId - FieldName - TypeName + x-write-only-properties: + - RequestMappingTemplateS3Location + - ResponseMappingTemplateS3Location + - CodeS3Location x-read-only-properties: - ResolverArn + x-required-properties: + - TypeName + - ApiId + - FieldName + x-tagging: + taggable: false x-required-permissions: create: - s3:GetObject @@ -401,11 +1664,19 @@ components: type: string format: date-time x-stackql-resource-name: source_api_association - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AppSync::SourceApiAssociation + x-type-name: AWS::AppSync::SourceApiAssociation + x-stackql-primary-identifier: - AssociationArn + x-stackql-additional-identifiers: + - - SourceApiIdentifier + - MergedApiIdentifier x-create-only-properties: - SourceApiIdentifier - MergedApiIdentifier + x-write-only-properties: + - SourceApiIdentifier + - MergedApiIdentifier x-read-only-properties: - AssociationId - AssociationArn @@ -416,6 +1687,11 @@ components: - SourceApiAssociationStatus - SourceApiAssociationStatusDetail - LastSuccessfulMergeDate + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - appsync:AssociateSourceGraphqlApi @@ -429,20 +1705,902 @@ components: - appsync:UpdateSourceApiAssociation - appsync:GetSourceApiAssociation delete: - - appsync:GetSourceApiAssociation - - appsync:DisassociateSourceGraphqlApi - - appsync:DisassociateMergedGraphqlApi - - appsync:ListSourceApiAssociations - list: - - appsync:ListSourceApiAssociations - x-stackQL-resources: - domain_names: - name: domain_names - id: awscc.appsync.domain_names - x-cfn-schema-name: DomainName - x-type: list + - appsync:GetSourceApiAssociation + - appsync:DisassociateSourceGraphqlApi + - appsync:DisassociateMergedGraphqlApi + - appsync:ListSourceApiAssociations + list: + - appsync:ListSourceApiAssociations + CreateApiRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiId: + description: The unique identifier for the AppSync Api generated by the service + type: string + ApiArn: + description: The Amazon Resource Name (ARN) of the AppSync Api + type: string + Name: + $ref: '#/components/schemas/ApiName' + OwnerContact: + $ref: '#/components/schemas/OwnerContact' + Dns: + $ref: '#/components/schemas/DnsMap' + EventConfig: + $ref: '#/components/schemas/EventConfig' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateApiRequest + type: object + required: [] + CreateChannelNamespaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiId: + description: AppSync Api Id that this Channel Namespace belongs to. + type: string + Name: + $ref: '#/components/schemas/Namespace' + SubscribeAuthModes: + description: List of AuthModes supported for Subscribe operations. + $ref: '#/components/schemas/AuthModes' + PublishAuthModes: + description: List of AuthModes supported for Publish operations. + $ref: '#/components/schemas/AuthModes' + CodeHandlers: + $ref: '#/components/schemas/Code' + CodeS3Location: + description: The Amazon S3 endpoint where the code is located. + type: string + ChannelNamespaceArn: + $ref: '#/components/schemas/ChannelNamespaceArn' + Tags: + $ref: '#/components/schemas/Tags' + HandlerConfigs: + $ref: '#/components/schemas/HandlerConfigs' + x-stackQL-stringOnly: true + x-title: CreateChannelNamespaceRequest + type: object + required: [] + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiId: + description: Unique AWS AppSync GraphQL API identifier where this data source will be created. + type: string + Description: + description: The description of the data source. + type: string + DynamoDBConfig: + description: AWS Region and TableName for an Amazon DynamoDB table in your account. + $ref: '#/components/schemas/DynamoDBConfig' + ElasticsearchConfig: + description: |- + AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. + As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service. This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source. + $ref: '#/components/schemas/ElasticsearchConfig' + EventBridgeConfig: + description: ARN for the EventBridge bus. + $ref: '#/components/schemas/EventBridgeConfig' + HttpConfig: + description: Endpoints for an HTTP data source. + $ref: '#/components/schemas/HttpConfig' + LambdaConfig: + description: An ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account. + $ref: '#/components/schemas/LambdaConfig' + Name: + description: Friendly name for you to identify your AppSync data source after creation. + type: string + OpenSearchServiceConfig: + description: AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. + $ref: '#/components/schemas/OpenSearchServiceConfig' + RelationalDatabaseConfig: + description: Relational Database configuration of the relational database data source. + $ref: '#/components/schemas/RelationalDatabaseConfig' + ServiceRoleArn: + description: The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source. + type: string + Type: + description: The type of the data source. + type: string + DataSourceArn: + description: The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/datasources/datasourcename. + type: string + MetricsConfig: + description: '' + type: string + enum: + - DISABLED + - ENABLED + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateDomainNameRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + type: string + minLength: 1 + maxLength: 253 + pattern: ^(\*[a-z\d-]*\.)?([a-z\d-]+\.)+[a-z\d-]+$ + Description: + type: string + minLength: 0 + maxLength: 255 + CertificateArn: + type: string + minLength: 3 + maxLength: 2048 + pattern: ^arn:[a-z-]*:acm:[a-z0-9-]*:\d{12}:certificate/[0-9A-Za-z_/-]*$ + AppSyncDomainName: + type: string + HostedZoneId: + type: string + DomainNameArn: + type: string + description: The Amazon Resource Name (ARN) for the Domain Name. + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateDomainNameRequest + type: object + required: [] + CreateDomainNameApiAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + type: string + minLength: 1 + maxLength: 253 + pattern: ^(\*[a-z\d-]*\.)?([a-z\d-]+\.)+[a-z\d-]+$ + ApiId: + type: string + ApiAssociationIdentifier: + type: string + x-stackQL-stringOnly: true + x-title: CreateDomainNameApiAssociationRequest + type: object + required: [] + CreateFunctionConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FunctionId: + description: The unique identifier for the function generated by the service + type: string + FunctionArn: + description: The ARN for the function generated by the service + type: string + ApiId: + description: The AWS AppSync GraphQL API that you want to attach using this function. + type: string + Code: + description: The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. + type: string + CodeS3Location: + description: The Amazon S3 endpoint (where the code is located??). + type: string + DataSourceName: + description: The name of data source this function will attach. + type: string + Description: + description: The function description. + type: string + FunctionVersion: + description: The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported. + type: string + MaxBatchSize: + description: The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. + type: integer + Name: + description: The name of the function. + type: string + RequestMappingTemplate: + description: The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. + type: string + RequestMappingTemplateS3Location: + description: Describes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked. + type: string + ResponseMappingTemplate: + description: The Function response mapping template. + type: string + ResponseMappingTemplateS3Location: + description: The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. + type: string + Runtime: + description: Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. + $ref: '#/components/schemas/AppSyncRuntime' + SyncConfig: + description: Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked. + $ref: '#/components/schemas/SyncConfig' + x-stackQL-stringOnly: true + x-title: CreateFunctionConfigurationRequest + type: object + required: [] + CreateGraphQLApiRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalAuthenticationProviders: + type: array + description: A list of additional authentication providers for the GraphqlApi API. + uniqueItems: true + items: + $ref: '#/components/schemas/AdditionalAuthenticationProvider' + ApiId: + description: Unique AWS AppSync GraphQL API identifier. + type: string + ApiType: + description: The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED). + type: string + Arn: + description: The Amazon Resource Name (ARN) of the API key + type: string + AuthenticationType: + description: Security configuration for your GraphQL API + type: string + EnhancedMetricsConfig: + description: Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent. + $ref: '#/components/schemas/EnhancedMetricsConfig' + EnvironmentVariables: + description: A map containing the list of resources with their properties and environment variables. + type: object + additionalProperties: false + x-patternProperties: + ^[A-Za-z]+\w*$: + type: string + GraphQLDns: + description: The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. + type: string + GraphQLEndpointArn: + description: The GraphQL endpoint ARN. + type: string + GraphQLUrl: + description: The Endpoint URL of your GraphQL API. + type: string + IntrospectionConfig: + description: Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled. + type: string + LambdaAuthorizerConfig: + description: A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time. + $ref: '#/components/schemas/LambdaAuthorizerConfig' + LogConfig: + description: The Amazon CloudWatch Logs configuration. + $ref: '#/components/schemas/LogConfig' + MergedApiExecutionRoleArn: + description: 'The AWS Identity and Access Management service role ARN for a merged API. ' + type: string + Name: + description: The API name + type: string + OpenIDConnectConfig: + description: The OpenID Connect configuration. + $ref: '#/components/schemas/OpenIDConnectConfig' + OwnerContact: + description: The owner contact information for an API resource. + type: string + QueryDepthLimit: + description: The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. + type: integer + RealtimeDns: + description: The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. + type: string + RealtimeUrl: + description: The GraphQL API real-time endpoint URL. + type: string + ResolverCountLimit: + description: The maximum number of resolvers that can be invoked in a single request. + type: integer + Tags: + description: |+ + An arbitrary set of tags (key-value pairs) for this GraphQL API. + + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + UserPoolConfig: + description: |+ + Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. + + $ref: '#/components/schemas/UserPoolConfig' + Visibility: + description: Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided. + type: string + XrayEnabled: + description: |+ + A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi. + + type: boolean + x-stackQL-stringOnly: true + x-title: CreateGraphQLApiRequest + type: object + required: [] + CreateResolverRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiId: + type: string + description: The APSYlong GraphQL API to which you want to attach this resolver. + CachingConfig: + $ref: '#/components/schemas/CachingConfig' + description: The caching configuration for the resolver. + Code: + type: string + description: The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``. + CodeS3Location: + type: string + description: The Amazon S3 endpoint. + DataSourceName: + type: string + description: The resolver data source name. + FieldName: + type: string + description: The GraphQL field on a type that invokes the resolver. + Kind: + type: string + description: |- + The resolver type. + + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. + + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. + MaxBatchSize: + type: integer + description: The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation. + PipelineConfig: + $ref: '#/components/schemas/PipelineConfig' + description: Functions linked with the pipeline resolver. + RequestMappingTemplate: + type: string + description: |- + The request mapping template. + Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required. + RequestMappingTemplateS3Location: + type: string + description: The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template. + ResolverArn: + type: string + description: '' + ResponseMappingTemplate: + type: string + description: The response mapping template. + ResponseMappingTemplateS3Location: + type: string + description: The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template. + Runtime: + $ref: '#/components/schemas/AppSyncRuntime' + description: Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. + SyncConfig: + $ref: '#/components/schemas/SyncConfig' + description: The ``SyncConfig`` for a resolver attached to a versioned data source. + TypeName: + type: string + description: The GraphQL type that invokes this resolver. + MetricsConfig: + type: string + description: Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value. + enum: + - ENABLED + - DISABLED + x-stackQL-stringOnly: true + x-title: CreateResolverRequest + type: object + required: [] + CreateSourceApiAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SourceApiIdentifier: + description: Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN + type: string + MergedApiIdentifier: + description: Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN + type: string + Description: + description: Description of the SourceApiAssociation. + type: string + SourceApiAssociationConfig: + description: Customized configuration for SourceApiAssociation. + $ref: '#/components/schemas/SourceApiAssociationConfig' + AssociationId: + description: Id of the SourceApiAssociation. + type: string + AssociationArn: + description: ARN of the SourceApiAssociation. + type: string + SourceApiId: + description: GraphQLApiId of the source API in the association. + type: string + SourceApiArn: + description: ARN of the source API in the association. + type: string + pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + MergedApiId: + description: GraphQLApiId of the Merged API in the association. + type: string + MergedApiArn: + description: ARN of the Merged API in the association. + type: string + pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + SourceApiAssociationStatus: + description: Current status of SourceApiAssociation. + type: string + enum: + - MERGE_SCHEDULED + - MERGE_FAILED + - MERGE_SUCCESS + - MERGE_IN_PROGRESS + - AUTO_MERGE_SCHEDULE_FAILED + - DELETION_SCHEDULED + - DELETION_IN_PROGRESS + - DELETION_FAILED + SourceApiAssociationStatusDetail: + description: Current SourceApiAssociation status details. + type: string + LastSuccessfulMergeDate: + description: Date of last schema successful merge. + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateSourceApiAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + apis: + name: apis + id: awscc.appsync.apis + x-cfn-schema-name: Api + x-cfn-type-name: AWS::AppSync::Api + x-identifiers: + - ApiArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Api&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::Api" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::Api" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::Api" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apis/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apis/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/apis/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.ApiArn') as api_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OwnerContact') as owner_contact, + JSON_EXTRACT(Properties, '$.Dns') as dns, + JSON_EXTRACT(Properties, '$.EventConfig') as event_config, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::Api' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'ApiArn') as api_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OwnerContact') as owner_contact, + json_extract_path_text(Properties, 'Dns') as dns, + json_extract_path_text(Properties, 'EventConfig') as event_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::Api' + AND data__Identifier = '' + AND region = 'us-east-1' + apis_list_only: + name: apis_list_only + id: awscc.appsync.apis_list_only + x-cfn-schema-name: Api + x-cfn-type-name: AWS::AppSync::Api + x-identifiers: + - ApiArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApiArn') as api_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Api' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiArn') as api_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Api' + AND region = 'us-east-1' + channel_namespaces: + name: channel_namespaces + id: awscc.appsync.channel_namespaces + x-cfn-schema-name: ChannelNamespace + x-cfn-type-name: AWS::AppSync::ChannelNamespace + x-identifiers: + - ChannelNamespaceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ChannelNamespace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::ChannelNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::ChannelNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::ChannelNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_namespaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channel_namespaces/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.SubscribeAuthModes') as subscribe_auth_modes, + JSON_EXTRACT(Properties, '$.PublishAuthModes') as publish_auth_modes, + JSON_EXTRACT(Properties, '$.CodeHandlers') as code_handlers, + JSON_EXTRACT(Properties, '$.CodeS3Location') as code_s3_location, + JSON_EXTRACT(Properties, '$.ChannelNamespaceArn') as channel_namespace_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.HandlerConfigs') as handler_configs + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::ChannelNamespace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SubscribeAuthModes') as subscribe_auth_modes, + json_extract_path_text(Properties, 'PublishAuthModes') as publish_auth_modes, + json_extract_path_text(Properties, 'CodeHandlers') as code_handlers, + json_extract_path_text(Properties, 'CodeS3Location') as code_s3_location, + json_extract_path_text(Properties, 'ChannelNamespaceArn') as channel_namespace_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'HandlerConfigs') as handler_configs + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::ChannelNamespace' + AND data__Identifier = '' + AND region = 'us-east-1' + channel_namespaces_list_only: + name: channel_namespaces_list_only + id: awscc.appsync.channel_namespaces_list_only + x-cfn-schema-name: ChannelNamespace + x-cfn-type-name: AWS::AppSync::ChannelNamespace + x-identifiers: + - ChannelNamespaceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ChannelNamespaceArn') as channel_namespace_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::ChannelNamespace' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ChannelNamespaceArn') as channel_namespace_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::ChannelNamespace' + AND region = 'us-east-1' + data_sources: + name: data_sources + id: awscc.appsync.data_sources + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::AppSync::DataSource + x-identifiers: + - DataSourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DynamoDBConfig') as dynamo_db_config, + JSON_EXTRACT(Properties, '$.ElasticsearchConfig') as elasticsearch_config, + JSON_EXTRACT(Properties, '$.EventBridgeConfig') as event_bridge_config, + JSON_EXTRACT(Properties, '$.HttpConfig') as http_config, + JSON_EXTRACT(Properties, '$.LambdaConfig') as lambda_config, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OpenSearchServiceConfig') as open_search_service_config, + JSON_EXTRACT(Properties, '$.RelationalDatabaseConfig') as relational_database_config, + JSON_EXTRACT(Properties, '$.ServiceRoleArn') as service_role_arn, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.DataSourceArn') as data_source_arn, + JSON_EXTRACT(Properties, '$.MetricsConfig') as metrics_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::DataSource' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DynamoDBConfig') as dynamo_db_config, + json_extract_path_text(Properties, 'ElasticsearchConfig') as elasticsearch_config, + json_extract_path_text(Properties, 'EventBridgeConfig') as event_bridge_config, + json_extract_path_text(Properties, 'HttpConfig') as http_config, + json_extract_path_text(Properties, 'LambdaConfig') as lambda_config, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OpenSearchServiceConfig') as open_search_service_config, + json_extract_path_text(Properties, 'RelationalDatabaseConfig') as relational_database_config, + json_extract_path_text(Properties, 'ServiceRoleArn') as service_role_arn, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'DataSourceArn') as data_source_arn, + json_extract_path_text(Properties, 'MetricsConfig') as metrics_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::DataSource' + AND data__Identifier = '' + AND region = 'us-east-1' + data_sources_list_only: + name: data_sources_list_only + id: awscc.appsync.data_sources_list_only + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::AppSync::DataSource x-identifiers: - - DomainName + - DataSourceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -450,28 +2608,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' + JSON_EXTRACT(Properties, '$.DataSourceArn') as data_source_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DataSource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' + json_extract_path_text(Properties, 'DataSourceArn') as data_source_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DataSource' AND region = 'us-east-1' - domain_name: - name: domain_name - id: awscc.appsync.domain_name + domain_names: + name: domain_names + id: awscc.appsync.domain_names x-cfn-schema-name: DomainName - x-type: get + x-cfn-type-name: AWS::AppSync::DomainName x-identifiers: - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainName&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -480,12 +2686,14 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, JSON_EXTRACT(Properties, '$.AppSyncDomainName') as app_sync_domain_name, - JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id + JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id, + JSON_EXTRACT(Properties, '$.DomainNameArn') as domain_name_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::DomainName' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -494,21 +2702,102 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, json_extract_path_text(Properties, 'AppSyncDomainName') as app_sync_domain_name, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, + json_extract_path_text(Properties, 'DomainNameArn') as domain_name_arn, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::DomainName' AND data__Identifier = '' AND region = 'us-east-1' - domain_name_api_association: - name: domain_name_api_association - id: awscc.appsync.domain_name_api_association + domain_names_list_only: + name: domain_names_list_only + id: awscc.appsync.domain_names_list_only + x-cfn-schema-name: DomainName + x-cfn-type-name: AWS::AppSync::DomainName + x-identifiers: + - DomainName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' + AND region = 'us-east-1' + domain_name_api_associations: + name: domain_name_api_associations + id: awscc.appsync.domain_name_api_associations x-cfn-schema-name: DomainNameApiAssociation - x-type: get + x-cfn-type-name: AWS::AppSync::DomainNameApiAssociation x-identifiers: - ApiAssociationIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainNameApiAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DomainNameApiAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DomainNameApiAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::DomainNameApiAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -520,7 +2809,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -535,38 +2824,61 @@ components: name: function_configurations id: awscc.appsync.function_configurations x-cfn-schema-name: FunctionConfiguration - x-type: list - x-identifiers: - - FunctionArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionArn') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' - AND region = 'us-east-1' - function_configuration: - name: function_configuration - id: awscc.appsync.function_configuration - x-cfn-schema-name: FunctionConfiguration - x-type: get + x-cfn-type-name: AWS::AppSync::FunctionConfiguration x-identifiers: - FunctionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FunctionConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::FunctionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::FunctionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::FunctionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/function_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/function_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/function_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -591,7 +2903,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -615,13 +2927,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - resolvers: - name: resolvers - id: awscc.appsync.resolvers - x-cfn-schema-name: Resolver - x-type: list + function_configurations_list_only: + name: function_configurations_list_only + id: awscc.appsync.function_configurations_list_only + x-cfn-schema-name: FunctionConfiguration + x-cfn-type-name: AWS::AppSync::FunctionConfiguration x-identifiers: - - ResolverArn + - FunctionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -629,28 +2947,232 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResolverArn') as resolver_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' + JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResolverArn') as resolver_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' + json_extract_path_text(Properties, 'FunctionArn') as function_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' + AND region = 'us-east-1' + graphql_apis: + name: graphql_apis + id: awscc.appsync.graphql_apis + x-cfn-schema-name: GraphQLApi + x-cfn-type-name: AWS::AppSync::GraphQLApi + x-identifiers: + - ApiId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GraphQLApi&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::GraphQLApi" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::GraphQLApi" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::GraphQLApi" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/graphql_apis/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/graphql_apis/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/graphql_apis/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AdditionalAuthenticationProviders') as additional_authentication_providers, + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.ApiType') as api_type, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AuthenticationType') as authentication_type, + JSON_EXTRACT(Properties, '$.EnhancedMetricsConfig') as enhanced_metrics_config, + JSON_EXTRACT(Properties, '$.EnvironmentVariables') as environment_variables, + JSON_EXTRACT(Properties, '$.GraphQLDns') as graph_ql_dns, + JSON_EXTRACT(Properties, '$.GraphQLEndpointArn') as graph_ql_endpoint_arn, + JSON_EXTRACT(Properties, '$.GraphQLUrl') as graph_ql_url, + JSON_EXTRACT(Properties, '$.IntrospectionConfig') as introspection_config, + JSON_EXTRACT(Properties, '$.LambdaAuthorizerConfig') as lambda_authorizer_config, + JSON_EXTRACT(Properties, '$.LogConfig') as log_config, + JSON_EXTRACT(Properties, '$.MergedApiExecutionRoleArn') as merged_api_execution_role_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OpenIDConnectConfig') as open_id_connect_config, + JSON_EXTRACT(Properties, '$.OwnerContact') as owner_contact, + JSON_EXTRACT(Properties, '$.QueryDepthLimit') as query_depth_limit, + JSON_EXTRACT(Properties, '$.RealtimeDns') as realtime_dns, + JSON_EXTRACT(Properties, '$.RealtimeUrl') as realtime_url, + JSON_EXTRACT(Properties, '$.ResolverCountLimit') as resolver_count_limit, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UserPoolConfig') as user_pool_config, + JSON_EXTRACT(Properties, '$.Visibility') as visibility, + JSON_EXTRACT(Properties, '$.XrayEnabled') as xray_enabled + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::GraphQLApi' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalAuthenticationProviders') as additional_authentication_providers, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'ApiType') as api_type, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, + json_extract_path_text(Properties, 'EnhancedMetricsConfig') as enhanced_metrics_config, + json_extract_path_text(Properties, 'EnvironmentVariables') as environment_variables, + json_extract_path_text(Properties, 'GraphQLDns') as graph_ql_dns, + json_extract_path_text(Properties, 'GraphQLEndpointArn') as graph_ql_endpoint_arn, + json_extract_path_text(Properties, 'GraphQLUrl') as graph_ql_url, + json_extract_path_text(Properties, 'IntrospectionConfig') as introspection_config, + json_extract_path_text(Properties, 'LambdaAuthorizerConfig') as lambda_authorizer_config, + json_extract_path_text(Properties, 'LogConfig') as log_config, + json_extract_path_text(Properties, 'MergedApiExecutionRoleArn') as merged_api_execution_role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OpenIDConnectConfig') as open_id_connect_config, + json_extract_path_text(Properties, 'OwnerContact') as owner_contact, + json_extract_path_text(Properties, 'QueryDepthLimit') as query_depth_limit, + json_extract_path_text(Properties, 'RealtimeDns') as realtime_dns, + json_extract_path_text(Properties, 'RealtimeUrl') as realtime_url, + json_extract_path_text(Properties, 'ResolverCountLimit') as resolver_count_limit, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserPoolConfig') as user_pool_config, + json_extract_path_text(Properties, 'Visibility') as visibility, + json_extract_path_text(Properties, 'XrayEnabled') as xray_enabled + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::GraphQLApi' + AND data__Identifier = '' + AND region = 'us-east-1' + graphql_apis_list_only: + name: graphql_apis_list_only + id: awscc.appsync.graphql_apis_list_only + x-cfn-schema-name: GraphQLApi + x-cfn-type-name: AWS::AppSync::GraphQLApi + x-identifiers: + - ApiId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApiId') as api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::GraphQLApi' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::GraphQLApi' AND region = 'us-east-1' - resolver: - name: resolver - id: awscc.appsync.resolver + resolvers: + name: resolvers + id: awscc.appsync.resolvers x-cfn-schema-name: Resolver - x-type: get + x-cfn-type-name: AWS::AppSync::Resolver x-identifiers: - ResolverArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Resolver&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::Resolver" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::Resolver" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::Resolver" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -677,7 +3199,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -703,13 +3225,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::Resolver' AND data__Identifier = '' AND region = 'us-east-1' - source_api_associations: - name: source_api_associations - id: awscc.appsync.source_api_associations - x-cfn-schema-name: SourceApiAssociation - x-type: list + resolvers_list_only: + name: resolvers_list_only + id: awscc.appsync.resolvers_list_only + x-cfn-schema-name: Resolver + x-cfn-type-name: AWS::AppSync::Resolver x-identifiers: - - AssociationArn + - ResolverArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -717,28 +3245,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' + JSON_EXTRACT(Properties, '$.ResolverArn') as resolver_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AssociationArn') as association_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' + json_extract_path_text(Properties, 'ResolverArn') as resolver_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' AND region = 'us-east-1' - source_api_association: - name: source_api_association - id: awscc.appsync.source_api_association + source_api_associations: + name: source_api_associations + id: awscc.appsync.source_api_associations x-cfn-schema-name: SourceApiAssociation - x-type: get + x-cfn-type-name: AWS::AppSync::SourceApiAssociation x-identifiers: - AssociationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SourceApiAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::SourceApiAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::SourceApiAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppSync::SourceApiAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -760,7 +3336,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -781,3 +3357,565 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' AND data__Identifier = '' AND region = 'us-east-1' + source_api_associations_list_only: + name: source_api_associations_list_only + id: awscc.appsync.source_api_associations_list_only + x-cfn-schema-name: SourceApiAssociation + x-cfn-type-name: AWS::AppSync::SourceApiAssociation + x-identifiers: + - AssociationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationArn') as association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Api&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApi + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApiRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ChannelNamespace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannelNamespace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelNamespaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainName&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainName + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainNameRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainNameApiAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainNameApiAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainNameApiAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FunctionConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFunctionConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFunctionConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GraphQLApi&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGraphQLApi + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGraphQLApiRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Resolver&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolver + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SourceApiAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSourceApiAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSourceApiAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/apptest.yaml b/providers/src/awscc/v00.00.00000/services/apptest.yaml new file mode 100644 index 00000000..82d605c5 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/apptest.yaml @@ -0,0 +1,1253 @@ +openapi: 3.0.0 +info: + title: AppTest + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Batch: + type: object + properties: + BatchJobName: + type: string + pattern: ^\S{1,1000}$ + BatchJobParameters: + $ref: '#/components/schemas/BatchJobParameters' + ExportDataSetNames: + type: array + items: + type: string + pattern: ^\S{1,100}$ + required: + - BatchJobName + additionalProperties: false + BatchJobParameters: + type: object + x-patternProperties: + .+: + type: string + additionalProperties: false + CaptureTool: + type: string + enum: + - Precisely + - AWS DMS + CloudFormationAction: + type: object + properties: + Resource: + type: string + pattern: ^\S{1,1000}$ + ActionType: + $ref: '#/components/schemas/CloudFormationActionType' + required: + - Resource + additionalProperties: false + CloudFormationActionType: + type: string + enum: + - Create + - Delete + CompareAction: + type: object + properties: + Input: + $ref: '#/components/schemas/Input' + Output: + $ref: '#/components/schemas/Output' + required: + - Input + additionalProperties: false + DataSet: + type: object + properties: + Type: + $ref: '#/components/schemas/DataSetType' + Name: + type: string + pattern: ^\S{1,100}$ + Ccsid: + type: string + pattern: ^\S{1,50}$ + Format: + $ref: '#/components/schemas/Format' + Length: + type: number + required: + - Ccsid + - Format + - Length + - Name + - Type + additionalProperties: false + DataSetType: + type: string + enum: + - PS + DatabaseCDC: + type: object + properties: + SourceMetadata: + $ref: '#/components/schemas/SourceDatabaseMetadata' + TargetMetadata: + $ref: '#/components/schemas/TargetDatabaseMetadata' + required: + - SourceMetadata + - TargetMetadata + additionalProperties: false + FileMetadata: + oneOf: + - type: object + title: DataSets + properties: + DataSets: + type: array + items: + $ref: '#/components/schemas/DataSet' + required: + - DataSets + additionalProperties: false + - type: object + title: DatabaseCDC + properties: + DatabaseCDC: + $ref: '#/components/schemas/DatabaseCDC' + required: + - DatabaseCDC + additionalProperties: false + Format: + type: string + enum: + - FIXED + - VARIABLE + - LINE_SEQUENTIAL + Input: + oneOf: + - type: object + title: File + properties: + File: + $ref: '#/components/schemas/InputFile' + required: + - File + additionalProperties: false + InputFile: + type: object + properties: + SourceLocation: + type: string + pattern: ^\S{1,1000}$ + TargetLocation: + type: string + pattern: ^\S{1,1000}$ + FileMetadata: + $ref: '#/components/schemas/FileMetadata' + required: + - FileMetadata + - SourceLocation + - TargetLocation + additionalProperties: false + M2ManagedActionProperties: + type: object + properties: + ForceStop: + type: boolean + ImportDataSetLocation: + type: string + pattern: ^\S{1,1000}$ + additionalProperties: false + M2ManagedActionType: + type: string + enum: + - Configure + - Deconfigure + M2ManagedApplicationAction: + type: object + properties: + Resource: + type: string + pattern: ^\S{1,1000}$ + ActionType: + $ref: '#/components/schemas/M2ManagedActionType' + Properties: + $ref: '#/components/schemas/M2ManagedActionProperties' + required: + - ActionType + - Resource + additionalProperties: false + M2NonManagedActionType: + type: string + enum: + - Configure + - Deconfigure + M2NonManagedApplicationAction: + type: object + properties: + Resource: + type: string + pattern: ^\S{1,1000}$ + ActionType: + $ref: '#/components/schemas/M2NonManagedActionType' + required: + - ActionType + - Resource + additionalProperties: false + MainframeAction: + type: object + properties: + Resource: + type: string + pattern: ^\S{1,1000}$ + ActionType: + $ref: '#/components/schemas/MainframeActionType' + Properties: + $ref: '#/components/schemas/MainframeActionProperties' + required: + - ActionType + - Resource + additionalProperties: false + MainframeActionProperties: + type: object + properties: + DmsTaskArn: + type: string + pattern: ^\S{1,1000}$ + additionalProperties: false + MainframeActionType: + oneOf: + - type: object + title: Batch + properties: + Batch: + $ref: '#/components/schemas/Batch' + required: + - Batch + additionalProperties: false + - type: object + title: Tn3270 + properties: + Tn3270: + $ref: '#/components/schemas/TN3270' + required: + - Tn3270 + additionalProperties: false + Output: + oneOf: + - type: object + title: File + properties: + File: + $ref: '#/components/schemas/OutputFile' + required: + - File + additionalProperties: false + OutputFile: + type: object + properties: + FileLocation: + type: string + maxLength: 1024 + minLength: 0 + additionalProperties: false + ResourceAction: + oneOf: + - type: object + title: M2ManagedApplicationAction + properties: + M2ManagedApplicationAction: + $ref: '#/components/schemas/M2ManagedApplicationAction' + required: + - M2ManagedApplicationAction + additionalProperties: false + - type: object + title: M2NonManagedApplicationAction + properties: + M2NonManagedApplicationAction: + $ref: '#/components/schemas/M2NonManagedApplicationAction' + required: + - M2NonManagedApplicationAction + additionalProperties: false + - type: object + title: CloudFormationAction + properties: + CloudFormationAction: + $ref: '#/components/schemas/CloudFormationAction' + required: + - CloudFormationAction + additionalProperties: false + Script: + type: object + properties: + ScriptLocation: + type: string + maxLength: 1024 + minLength: 0 + Type: + $ref: '#/components/schemas/ScriptType' + required: + - ScriptLocation + - Type + additionalProperties: false + ScriptType: + type: string + enum: + - Selenium + SourceDatabase: + type: string + enum: + - z/OS-DB2 + SourceDatabaseMetadata: + type: object + properties: + Type: + $ref: '#/components/schemas/SourceDatabase' + CaptureTool: + $ref: '#/components/schemas/CaptureTool' + required: + - CaptureTool + - Type + additionalProperties: false + Step: + type: object + properties: + Name: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_\-]{1,59}$ + Description: + type: string + maxLength: 1000 + minLength: 0 + Action: + $ref: '#/components/schemas/StepAction' + required: + - Action + - Name + additionalProperties: false + StepAction: + oneOf: + - type: object + title: ResourceAction + properties: + ResourceAction: + $ref: '#/components/schemas/ResourceAction' + required: + - ResourceAction + additionalProperties: false + - type: object + title: MainframeAction + properties: + MainframeAction: + $ref: '#/components/schemas/MainframeAction' + required: + - MainframeAction + additionalProperties: false + - type: object + title: CompareAction + properties: + CompareAction: + $ref: '#/components/schemas/CompareAction' + required: + - CompareAction + additionalProperties: false + TN3270: + type: object + properties: + Script: + $ref: '#/components/schemas/Script' + ExportDataSetNames: + type: array + items: + type: string + pattern: ^\S{1,100}$ + required: + - Script + additionalProperties: false + TagMap: + type: object + maxProperties: 200 + minProperties: 0 + x-patternProperties: + ^(?!aws:).+$: + type: string + maxLength: 256 + minLength: 0 + additionalProperties: false + TargetDatabase: + type: string + enum: + - PostgreSQL + TargetDatabaseMetadata: + type: object + properties: + Type: + $ref: '#/components/schemas/TargetDatabase' + CaptureTool: + $ref: '#/components/schemas/CaptureTool' + required: + - CaptureTool + - Type + additionalProperties: false + TestCaseLatestVersion: + type: object + properties: + Version: + type: number + Status: + $ref: '#/components/schemas/TestCaseLifecycle' + required: + - Status + - Version + additionalProperties: false + TestCaseLifecycle: + type: string + enum: + - Active + - Deleting + TestCase: + type: object + properties: + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + LastUpdateTime: + type: string + format: date-time + LatestVersion: + $ref: '#/components/schemas/TestCaseLatestVersion' + Name: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_\-]{1,59}$ + Status: + $ref: '#/components/schemas/TestCaseLifecycle' + Steps: + type: array + items: + $ref: '#/components/schemas/Step' + maxItems: 20 + minItems: 1 + Tags: + $ref: '#/components/schemas/TagMap' + TestCaseArn: + type: string + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$ + TestCaseId: + type: string + pattern: ^[A-Za-z0-9:/\-]{1,100}$ + TestCaseVersion: + type: number + required: + - Name + - Steps + x-stackql-resource-name: test_case + description: Represents a Test Case that can be captured and executed + x-type-name: AWS::AppTest::TestCase + x-stackql-primary-identifier: + - TestCaseId + x-create-only-properties: + - Name + x-read-only-properties: + - CreationTime + - LastUpdateTime + - LatestVersion + - Status + - TestCaseArn + - TestCaseId + - TestCaseVersion + x-required-properties: + - Name + - Steps + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - apptest:TagResource + - apptest:UntagResource + - apptest:ListTagsForResource + x-required-permissions: + create: + - apptest:CreateTestCase + - apptest:GetTestCase + - apptest:ListTagsForResource + read: + - apptest:GetTestCase + - apptest:ListTagsForResource + update: + - apptest:UpdateTestCase + - apptest:GetTestCase + - apptest:TagResource + - apptest:UnTagResource + - apptest:ListTagsForResource + delete: + - apptest:GetTestCase + - apptest:ListTagsForResource + - apptest:DeleteTestCase + list: + - apptest:ListTestCases + CreateTestCaseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + LastUpdateTime: + type: string + format: date-time + LatestVersion: + $ref: '#/components/schemas/TestCaseLatestVersion' + Name: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_\-]{1,59}$ + Status: + $ref: '#/components/schemas/TestCaseLifecycle' + Steps: + type: array + items: + $ref: '#/components/schemas/Step' + maxItems: 20 + minItems: 1 + Tags: + $ref: '#/components/schemas/TagMap' + TestCaseArn: + type: string + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$ + TestCaseId: + type: string + pattern: ^[A-Za-z0-9:/\-]{1,100}$ + TestCaseVersion: + type: number + x-stackQL-stringOnly: true + x-title: CreateTestCaseRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + test_cases: + name: test_cases + id: awscc.apptest.test_cases + x-cfn-schema-name: TestCase + x-cfn-type-name: AWS::AppTest::TestCase + x-identifiers: + - TestCaseId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TestCase&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppTest::TestCase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppTest::TestCase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AppTest::TestCase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/test_cases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/test_cases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/test_cases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.LastUpdateTime') as last_update_time, + JSON_EXTRACT(Properties, '$.LatestVersion') as latest_version, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Steps') as steps, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TestCaseArn') as test_case_arn, + JSON_EXTRACT(Properties, '$.TestCaseId') as test_case_id, + JSON_EXTRACT(Properties, '$.TestCaseVersion') as test_case_version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppTest::TestCase' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LastUpdateTime') as last_update_time, + json_extract_path_text(Properties, 'LatestVersion') as latest_version, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Steps') as steps, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TestCaseArn') as test_case_arn, + json_extract_path_text(Properties, 'TestCaseId') as test_case_id, + json_extract_path_text(Properties, 'TestCaseVersion') as test_case_version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AppTest::TestCase' + AND data__Identifier = '' + AND region = 'us-east-1' + test_cases_list_only: + name: test_cases_list_only + id: awscc.apptest.test_cases_list_only + x-cfn-schema-name: TestCase + x-cfn-type-name: AWS::AppTest::TestCase + x-identifiers: + - TestCaseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TestCaseId') as test_case_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppTest::TestCase' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TestCaseId') as test_case_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AppTest::TestCase' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TestCase&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTestCase + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTestCaseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/aps.yaml b/providers/src/awscc/v00.00.00000/services/aps.yaml index 566482f5..f9395f49 100644 --- a/providers/src/awscc/v00.00.00000/services/aps.yaml +++ b/providers/src/awscc/v00.00.00000/services/aps.yaml @@ -1,10 +1,430 @@ openapi: 3.0.0 info: title: APS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + ResourcePolicy: + type: object + properties: + WorkspaceArn: + description: The Arn of an APS Workspace that the PolicyDocument will be attached to. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$ + PolicyDocument: + description: The JSON to use as the Resource-based Policy. + type: string + required: + - WorkspaceArn + - PolicyDocument + x-stackql-resource-name: resource_policy + description: Resource Type definition for AWS::APS::ResourcePolicy + x-type-name: AWS::APS::ResourcePolicy + x-stackql-primary-identifier: + - WorkspaceArn + x-create-only-properties: + - WorkspaceArn + x-required-properties: + - WorkspaceArn + - PolicyDocument + x-tagging: + taggable: false + x-required-permissions: + create: + - aps:PutResourcePolicy + - aps:DescribeResourcePolicy + read: + - aps:DescribeResourcePolicy + update: + - aps:PutResourcePolicy + - aps:DescribeResourcePolicy + delete: + - aps:DeleteResourcePolicy + - aps:DescribeResourcePolicy + list: + - aps:DescribeResourcePolicy + - aps:ListWorkspaces Tag: description: A key-value pair to associate with a resource. type: object @@ -54,13 +474,28 @@ components: - Data - Name x-stackql-resource-name: rule_groups_namespace - x-stackql-primaryIdentifier: + description: RuleGroupsNamespace schema for cloudformation. + x-type-name: AWS::APS::RuleGroupsNamespace + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name - Workspace x-read-only-properties: - Arn + x-required-properties: + - Workspace + - Data + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - aps:TagResource + - aps:UntagResource x-required-permissions: create: - aps:CreateRuleGroupsNamespace @@ -81,6 +516,192 @@ components: list: - aps:ListRuleGroupsNamespaces - aps:ListTagsForResource + ScrapeConfiguration: + description: Scraper configuration + type: object + properties: + ConfigurationBlob: + description: Prometheus compatible scrape configuration in base64 encoded blob format + type: string + oneOf: + - required: + - ConfigurationBlob + additionalProperties: false + RoleConfiguration: + description: Role configuration + type: object + properties: + SourceRoleArn: + description: IAM Role in source account + type: string + TargetRoleArn: + description: IAM Role in the target account + type: string + additionalProperties: false + Source: + description: Scraper metrics source + type: object + properties: + EksConfiguration: + description: Configuration for EKS metrics source + type: object + properties: + ClusterArn: + description: ARN of an EKS cluster + type: string + pattern: ^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$ + SecurityGroupIds: + description: List of security group IDs + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' + SubnetIds: + description: List of subnet IDs + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetId' + required: + - ClusterArn + - SubnetIds + additionalProperties: false + oneOf: + - required: + - EksConfiguration + additionalProperties: false + Destination: + description: Scraper metrics destination + type: object + properties: + AmpConfiguration: + description: Configuration for Amazon Managed Prometheus metrics destination + type: object + properties: + WorkspaceArn: + description: ARN of an Amazon Managed Prometheus workspace + type: string + pattern: ^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$ + required: + - WorkspaceArn + additionalProperties: false + oneOf: + - required: + - AmpConfiguration + additionalProperties: false + SecurityGroupId: + description: ID of a security group + type: string + pattern: ^sg-[0-9a-z]+$ + SubnetId: + description: ID of a subnet + type: string + pattern: ^subnet-[0-9a-z]+$ + Scraper: + type: object + properties: + ScraperId: + description: Required to identify a specific scraper. + type: string + pattern: ^s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ + minLength: 1 + maxLength: 64 + Alias: + description: Scraper alias. + type: string + pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$ + minLength: 1 + maxLength: 100 + Arn: + description: Scraper ARN. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]+:[0-9]+:scraper/s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ + RoleArn: + description: IAM role ARN for the scraper. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::[0-9]{12}:role/[a-zA-Z0-9-]+$ + minLength: 20 + maxLength: 2048 + ScrapeConfiguration: + $ref: '#/components/schemas/ScrapeConfiguration' + RoleConfiguration: + $ref: '#/components/schemas/RoleConfiguration' + Source: + $ref: '#/components/schemas/Source' + Destination: + $ref: '#/components/schemas/Destination' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - ScrapeConfiguration + - Source + - Destination + x-stackql-resource-name: scraper + description: Resource Type definition for AWS::APS::Scraper + x-type-name: AWS::APS::Scraper + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Source + x-read-only-properties: + - ScraperId + - Arn + - RoleArn + x-required-properties: + - ScrapeConfiguration + - Source + - Destination + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - aps:TagResource + - aps:UntagResource + x-required-permissions: + create: + - aps:CreateScraper + - aps:DescribeScraper + - aps:DescribeWorkspace + - aps:TagResource + - eks:CreateAccessEntry + - eks:AssociateAccessPolicy + - eks:DescribeCluster + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - iam:CreateServiceLinkedRole + - iam:PassRole + read: + - aps:DescribeScraper + - aps:ListTagsForResource + update: + - aps:CreateScraper + - aps:DescribeScraper + - aps:UpdateScraper + - aps:DescribeWorkspace + - aps:TagResource + - aps:UntagResource + - aps:ListTagsForResource + - iam:PassRole + delete: + - aps:DeleteScraper + - aps:DescribeScraper + - aps:DescribeWorkspace + - eks:AssociateAccessPolicy + - eks:DescribeCluster + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - iam:DeleteServiceLinkedRole + list: + - aps:ListScrapers + - aps:ListTagsForResource LoggingConfiguration: description: Logging configuration type: object @@ -91,6 +712,116 @@ components: minLength: 0 maxLength: 512 additionalProperties: false + Label: + description: Series label + type: object + properties: + Name: + type: string + pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ + description: Name of the label + minLength: 1 + Value: + type: string + description: Value of the label + minLength: 1 + required: + - Name + - Value + additionalProperties: false + LimitsPerLabelSetEntry: + description: Limits that can be applied to a label set + type: object + properties: + MaxSeries: + description: The maximum number of active series that can be ingested for this label set + type: integer + minimum: 0 + additionalProperties: false + LimitsPerLabelSet: + description: Label set and its associated limits + type: object + properties: + Limits: + $ref: '#/components/schemas/LimitsPerLabelSetEntry' + LabelSet: + description: An array of series labels + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Label' + minItems: 0 + required: + - Limits + - LabelSet + additionalProperties: false + WorkspaceConfiguration: + description: Workspace configuration + type: object + properties: + RetentionPeriodInDays: + description: How many days that metrics are retained in the workspace + type: integer + minimum: 1 + LimitsPerLabelSets: + description: An array of label set and associated limits + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/LimitsPerLabelSet' + minItems: 0 + additionalProperties: false + CloudWatchLogDestination: + description: Represents a cloudwatch logs destination for query logging + type: object + properties: + LogGroupArn: + description: The ARN of the CloudWatch Logs log group + type: string + minLength: 0 + maxLength: 512 + required: + - LogGroupArn + additionalProperties: false + LoggingFilter: + description: Filters for logging + type: object + properties: + QspThreshold: + description: Query logs with QSP above this limit are vended + type: integer + minimum: 0 + required: + - QspThreshold + additionalProperties: false + LoggingDestination: + description: Destinations for query logging + type: object + properties: + CloudWatchLogs: + $ref: '#/components/schemas/CloudWatchLogDestination' + Filters: + $ref: '#/components/schemas/LoggingFilter' + required: + - CloudWatchLogs + - Filters + additionalProperties: false + QueryLoggingConfiguration: + description: Query logging configuration + type: object + properties: + Destinations: + description: The destinations configuration for query logging + type: array + items: + $ref: '#/components/schemas/LoggingDestination' + minItems: 1 + maxItems: 1 + required: + - Destinations + additionalProperties: false Workspace: type: object properties: @@ -119,6 +850,10 @@ components: type: string LoggingConfiguration: $ref: '#/components/schemas/LoggingConfiguration' + WorkspaceConfiguration: + $ref: '#/components/schemas/WorkspaceConfiguration' + QueryLoggingConfiguration: + $ref: '#/components/schemas/QueryLoggingConfiguration' KmsKeyArn: description: KMS Key ARN used to encrypt and decrypt AMP workspace data. type: string @@ -134,7 +869,9 @@ components: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: workspace - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::APS::Workspace + x-type-name: AWS::APS::Workspace + x-stackql-primary-identifier: - Arn x-create-only-properties: - KmsKeyArn @@ -142,6 +879,16 @@ components: - WorkspaceId - Arn - PrometheusEndpoint + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - aps:TagResource + - aps:UntagResource x-required-permissions: create: - aps:CreateWorkspace @@ -150,6 +897,9 @@ components: - aps:CreateAlertManagerDefinition - aps:DescribeAlertManagerDefinition - aps:CreateLoggingConfiguration + - aps:CreateQueryLoggingConfiguration + - aps:DescribeWorkspaceConfiguration + - aps:UpdateWorkspaceConfiguration - logs:CreateLogDelivery - logs:GetLogDelivery - logs:ListLogDeliveries @@ -162,6 +912,8 @@ components: - aps:ListTagsForResource - aps:DescribeAlertManagerDefinition - aps:DescribeLoggingConfiguration + - aps:DescribeQueryLoggingConfiguration + - aps:DescribeWorkspaceConfiguration update: - aps:UpdateWorkspaceAlias - aps:DescribeWorkspace @@ -175,6 +927,12 @@ components: - aps:DescribeLoggingConfiguration - aps:UpdateLoggingConfiguration - aps:DeleteLoggingConfiguration + - aps:DescribeWorkspaceConfiguration + - aps:UpdateWorkspaceConfiguration + - aps:CreateQueryLoggingConfiguration + - aps:UpdateQueryLoggingConfiguration + - aps:DeleteQueryLoggingConfiguration + - aps:DescribeQueryLoggingConfiguration - logs:CreateLogDelivery - logs:GetLogDelivery - logs:UpdateLogDelivery @@ -186,18 +944,288 @@ components: - aps:DescribeWorkspace - aps:DeleteAlertManagerDefinition - aps:DeleteLoggingConfiguration + - aps:DeleteQueryLoggingConfiguration - logs:DeleteLogDelivery list: - aps:ListWorkspaces - aps:ListTagsForResource + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkspaceArn: + description: The Arn of an APS Workspace that the PolicyDocument will be attached to. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$ + PolicyDocument: + description: The JSON to use as the Resource-based Policy. + type: string + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateRuleGroupsNamespaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Workspace: + description: Required to identify a specific APS Workspace associated with this RuleGroupsNamespace. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$ + Name: + description: The RuleGroupsNamespace name. + type: string + minLength: 1 + maxLength: 64 + Data: + description: The RuleGroupsNamespace data. + type: string + Arn: + description: The RuleGroupsNamespace ARN. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:rulegroupsnamespace/[a-zA-Z0-9-]+/[0-9A-Za-z][-.0-9A-Z_a-z]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRuleGroupsNamespaceRequest + type: object + required: [] + CreateScraperRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScraperId: + description: Required to identify a specific scraper. + type: string + pattern: ^s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ + minLength: 1 + maxLength: 64 + Alias: + description: Scraper alias. + type: string + pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$ + minLength: 1 + maxLength: 100 + Arn: + description: Scraper ARN. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]+:[0-9]+:scraper/s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ + RoleArn: + description: IAM role ARN for the scraper. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::[0-9]{12}:role/[a-zA-Z0-9-]+$ + minLength: 20 + maxLength: 2048 + ScrapeConfiguration: + $ref: '#/components/schemas/ScrapeConfiguration' + RoleConfiguration: + $ref: '#/components/schemas/RoleConfiguration' + Source: + $ref: '#/components/schemas/Source' + Destination: + $ref: '#/components/schemas/Destination' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateScraperRequest + type: object + required: [] + CreateWorkspaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkspaceId: + description: Required to identify a specific APS Workspace. + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}$ + minLength: 1 + maxLength: 100 + Alias: + description: AMP Workspace alias. + type: string + minLength: 0 + maxLength: 100 + Arn: + description: Workspace arn. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + AlertManagerDefinition: + description: The AMP Workspace alert manager definition data + type: string + PrometheusEndpoint: + description: AMP Workspace prometheus endpoint + type: string + LoggingConfiguration: + $ref: '#/components/schemas/LoggingConfiguration' + WorkspaceConfiguration: + $ref: '#/components/schemas/WorkspaceConfiguration' + QueryLoggingConfiguration: + $ref: '#/components/schemas/QueryLoggingConfiguration' + KmsKeyArn: + description: KMS Key ARN used to encrypt and decrypt AMP workspace data. + type: string + pattern: ^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$ + minLength: 20 + maxLength: 2048 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateWorkspaceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - rule_groups_namespaces: - name: rule_groups_namespaces - id: awscc.aps.rule_groups_namespaces - x-cfn-schema-name: RuleGroupsNamespace - x-type: list + resource_policies: + name: resource_policies + id: awscc.aps.resource_policies + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::APS::ResourcePolicy x-identifiers: - - Arn + - WorkspaceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.WorkspaceArn') as workspace_arn, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkspaceArn') as workspace_arn, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.aps.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::APS::ResourcePolicy + x-identifiers: + - WorkspaceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -205,28 +1233,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' + JSON_EXTRACT(Properties, '$.WorkspaceArn') as workspace_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::ResourcePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' + json_extract_path_text(Properties, 'WorkspaceArn') as workspace_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::ResourcePolicy' AND region = 'us-east-1' - rule_groups_namespace: - name: rule_groups_namespace - id: awscc.aps.rule_groups_namespace + rule_groups_namespaces: + name: rule_groups_namespaces + id: awscc.aps.rule_groups_namespaces x-cfn-schema-name: RuleGroupsNamespace - x-type: get + x-cfn-type-name: AWS::APS::RuleGroupsNamespace x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RuleGroupsNamespace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::RuleGroupsNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::RuleGroupsNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::RuleGroupsNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -240,7 +1316,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -253,13 +1329,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' AND data__Identifier = '' AND region = 'us-east-1' - workspaces: - name: workspaces - id: awscc.aps.workspaces - x-cfn-schema-name: Workspace - x-type: list + rule_groups_namespaces_list_only: + name: rule_groups_namespaces_list_only + id: awscc.aps.rule_groups_namespaces_list_only + x-cfn-schema-name: RuleGroupsNamespace + x-cfn-type-name: AWS::APS::RuleGroupsNamespace x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -268,7 +1350,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -276,19 +1358,191 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' AND region = 'us-east-1' - workspace: - name: workspace - id: awscc.aps.workspace - x-cfn-schema-name: Workspace - x-type: get + scrapers: + name: scrapers + id: awscc.aps.scrapers + x-cfn-schema-name: Scraper + x-cfn-type-name: AWS::APS::Scraper x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Scraper&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::Scraper" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::Scraper" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::Scraper" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scrapers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scrapers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scrapers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ScraperId') as scraper_id, + JSON_EXTRACT(Properties, '$.Alias') as alias, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.ScrapeConfiguration') as scrape_configuration, + JSON_EXTRACT(Properties, '$.RoleConfiguration') as role_configuration, + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.Destination') as destination, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Scraper' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScraperId') as scraper_id, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'ScrapeConfiguration') as scrape_configuration, + json_extract_path_text(Properties, 'RoleConfiguration') as role_configuration, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Scraper' + AND data__Identifier = '' + AND region = 'us-east-1' + scrapers_list_only: + name: scrapers_list_only + id: awscc.aps.scrapers_list_only + x-cfn-schema-name: Scraper + x-cfn-type-name: AWS::APS::Scraper + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Scraper' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Scraper' + AND region = 'us-east-1' + workspaces: + name: workspaces + id: awscc.aps.workspaces + x-cfn-schema-name: Workspace + x-cfn-type-name: AWS::APS::Workspace + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workspace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::APS::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -299,13 +1553,15 @@ components: JSON_EXTRACT(Properties, '$.AlertManagerDefinition') as alert_manager_definition, JSON_EXTRACT(Properties, '$.PrometheusEndpoint') as prometheus_endpoint, JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration, + JSON_EXTRACT(Properties, '$.WorkspaceConfiguration') as workspace_configuration, + JSON_EXTRACT(Properties, '$.QueryLoggingConfiguration') as query_logging_configuration, JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Workspace' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -316,8 +1572,362 @@ components: json_extract_path_text(Properties, 'AlertManagerDefinition') as alert_manager_definition, json_extract_path_text(Properties, 'PrometheusEndpoint') as prometheus_endpoint, json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, + json_extract_path_text(Properties, 'WorkspaceConfiguration') as workspace_configuration, + json_extract_path_text(Properties, 'QueryLoggingConfiguration') as query_logging_configuration, json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Workspace' AND data__Identifier = '' AND region = 'us-east-1' + workspaces_list_only: + name: workspaces_list_only + id: awscc.aps.workspaces_list_only + x-cfn-schema-name: Workspace + x-cfn-type-name: AWS::APS::Workspace + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RuleGroupsNamespace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRuleGroupsNamespace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleGroupsNamespaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Scraper&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScraper + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScraperRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workspace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkspace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkspaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/arcregionswitch.yaml b/providers/src/awscc/v00.00.00000/services/arcregionswitch.yaml new file mode 100644 index 00000000..341ea8df --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/arcregionswitch.yaml @@ -0,0 +1,1600 @@ +openapi: 3.0.0 +info: + title: ARCRegionSwitch + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + AlarmCondition: + type: string + enum: + - red + - green + AlarmType: + type: string + enum: + - applicationHealth + - trigger + ArcRoutingControlConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + RegionAndRoutingControls: + $ref: '#/components/schemas/RegionAndRoutingControls' + required: + - RegionAndRoutingControls + additionalProperties: false + ArcRoutingControlState: + type: object + properties: + RoutingControlArn: + type: string + State: + $ref: '#/components/schemas/RoutingControlStateChange' + required: + - RoutingControlArn + - State + additionalProperties: false + Asg: + type: object + properties: + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + Arn: + type: string + pattern: ^arn:aws:autoscaling:[a-z0-9-]+:\d{12}:autoScalingGroup:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:autoScalingGroupName/[\S\s]{1,255}$ + additionalProperties: false + AssociatedAlarm: + type: object + properties: + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + ResourceIdentifier: + type: string + AlarmType: + $ref: '#/components/schemas/AlarmType' + required: + - AlarmType + - ResourceIdentifier + additionalProperties: false + AssociatedAlarmMap: + type: object + x-patternProperties: + .+: + $ref: '#/components/schemas/AssociatedAlarm' + additionalProperties: false + CustomActionLambdaConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + Lambdas: + type: array + items: + $ref: '#/components/schemas/Lambdas' + maxItems: 2 + minItems: 1 + RetryIntervalMinutes: + type: number + RegionToRun: + $ref: '#/components/schemas/RegionToRunIn' + Ungraceful: + $ref: '#/components/schemas/LambdaUngraceful' + required: + - Lambdas + - RegionToRun + - RetryIntervalMinutes + additionalProperties: false + Ec2AsgCapacityIncreaseConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + Asgs: + type: array + items: + $ref: '#/components/schemas/Asg' + maxItems: 2 + minItems: 2 + Ungraceful: + $ref: '#/components/schemas/Ec2Ungraceful' + TargetPercent: + type: number + default: 100 + CapacityMonitoringApproach: + allOf: + - $ref: '#/components/schemas/Ec2AsgCapacityMonitoringApproach' + - default: sampledMaxInLast24Hours + required: + - Asgs + additionalProperties: false + Ec2AsgCapacityMonitoringApproach: + type: string + enum: + - sampledMaxInLast24Hours + - autoscalingMaxInLast24Hours + Ec2Ungraceful: + type: object + properties: + MinimumSuccessPercentage: + type: number + maximum: 99 + minimum: 0 + required: + - MinimumSuccessPercentage + additionalProperties: false + EcsCapacityIncreaseConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + Services: + type: array + items: + $ref: '#/components/schemas/Service' + maxItems: 2 + minItems: 2 + Ungraceful: + $ref: '#/components/schemas/EcsUngraceful' + TargetPercent: + type: number + default: 100 + CapacityMonitoringApproach: + allOf: + - $ref: '#/components/schemas/EcsCapacityMonitoringApproach' + - default: sampledMaxInLast24Hours + required: + - Services + additionalProperties: false + EcsCapacityMonitoringApproach: + type: string + enum: + - sampledMaxInLast24Hours + - containerInsightsMaxInLast24Hours + EcsUngraceful: + type: object + properties: + MinimumSuccessPercentage: + type: number + maximum: 99 + minimum: 0 + required: + - MinimumSuccessPercentage + additionalProperties: false + EksCapacityMonitoringApproach: + type: string + enum: + - sampledMaxInLast24Hours + EksCluster: + type: object + properties: + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + ClusterArn: + type: string + pattern: ^arn:aws[a-zA-Z-]*:eks:[a-z0-9-]+:\d{12}:cluster/[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}$ + required: + - ClusterArn + additionalProperties: false + EksResourceScalingConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + KubernetesResourceType: + $ref: '#/components/schemas/KubernetesResourceType' + ScalingResources: + type: array + items: + $ref: '#/components/schemas/KubernetesScalingApplication' + minItems: 1 + EksClusters: + type: array + items: + $ref: '#/components/schemas/EksCluster' + minItems: 2 + Ungraceful: + $ref: '#/components/schemas/EksResourceScalingUngraceful' + TargetPercent: + type: number + default: 100 + minimum: 1 + CapacityMonitoringApproach: + allOf: + - $ref: '#/components/schemas/EksCapacityMonitoringApproach' + - default: sampledMaxInLast24Hours + required: + - KubernetesResourceType + additionalProperties: false + EksResourceScalingUngraceful: + type: object + properties: + MinimumSuccessPercentage: + type: number + maximum: 99 + minimum: 0 + required: + - MinimumSuccessPercentage + additionalProperties: false + ExecutionApprovalConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + ApprovalRole: + type: string + required: + - ApprovalRole + additionalProperties: false + ExecutionBlockConfiguration: + oneOf: + - type: object + title: CustomActionLambdaConfig + properties: + CustomActionLambdaConfig: + $ref: '#/components/schemas/CustomActionLambdaConfiguration' + required: + - CustomActionLambdaConfig + additionalProperties: false + - type: object + title: Ec2AsgCapacityIncreaseConfig + properties: + Ec2AsgCapacityIncreaseConfig: + $ref: '#/components/schemas/Ec2AsgCapacityIncreaseConfiguration' + required: + - Ec2AsgCapacityIncreaseConfig + additionalProperties: false + - type: object + title: ExecutionApprovalConfig + properties: + ExecutionApprovalConfig: + $ref: '#/components/schemas/ExecutionApprovalConfiguration' + required: + - ExecutionApprovalConfig + additionalProperties: false + - type: object + title: ArcRoutingControlConfig + properties: + ArcRoutingControlConfig: + $ref: '#/components/schemas/ArcRoutingControlConfiguration' + required: + - ArcRoutingControlConfig + additionalProperties: false + - type: object + title: GlobalAuroraConfig + properties: + GlobalAuroraConfig: + $ref: '#/components/schemas/GlobalAuroraConfiguration' + required: + - GlobalAuroraConfig + additionalProperties: false + - type: object + title: ParallelConfig + properties: + ParallelConfig: + $ref: '#/components/schemas/ParallelExecutionBlockConfiguration' + required: + - ParallelConfig + additionalProperties: false + - type: object + title: RegionSwitchPlanConfig + properties: + RegionSwitchPlanConfig: + $ref: '#/components/schemas/RegionSwitchPlanConfiguration' + required: + - RegionSwitchPlanConfig + additionalProperties: false + - type: object + title: EcsCapacityIncreaseConfig + properties: + EcsCapacityIncreaseConfig: + $ref: '#/components/schemas/EcsCapacityIncreaseConfiguration' + required: + - EcsCapacityIncreaseConfig + additionalProperties: false + - type: object + title: EksResourceScalingConfig + properties: + EksResourceScalingConfig: + $ref: '#/components/schemas/EksResourceScalingConfiguration' + required: + - EksResourceScalingConfig + additionalProperties: false + - type: object + title: Route53HealthCheckConfig + properties: + Route53HealthCheckConfig: + $ref: '#/components/schemas/Route53HealthCheckConfiguration' + required: + - Route53HealthCheckConfig + additionalProperties: false + ExecutionBlockType: + type: string + enum: + - CustomActionLambda + - ManualApproval + - AuroraGlobalDatabase + - EC2AutoScaling + - ARCRoutingControl + - ARCRegionSwitchPlan + - Parallel + - ECSServiceScaling + - EKSResourceScaling + - Route53HealthCheck + GlobalAuroraConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + Behavior: + allOf: + - $ref: '#/components/schemas/GlobalAuroraDefaultBehavior' + - default: switchoverOnly + Ungraceful: + $ref: '#/components/schemas/GlobalAuroraUngraceful' + GlobalClusterIdentifier: + type: string + DatabaseClusterArns: + type: array + items: + type: string + required: + - Behavior + - DatabaseClusterArns + - GlobalClusterIdentifier + additionalProperties: false + GlobalAuroraDefaultBehavior: + type: string + enum: + - switchoverOnly + - failover + GlobalAuroraUngraceful: + type: object + properties: + Ungraceful: + $ref: '#/components/schemas/GlobalAuroraUngracefulBehavior' + additionalProperties: false + GlobalAuroraUngracefulBehavior: + type: string + enum: + - failover + KubernetesResourceType: + type: object + properties: + ApiVersion: + type: string + Kind: + type: string + required: + - ApiVersion + - Kind + additionalProperties: false + KubernetesScalingApplication: + type: object + x-patternProperties: + .+: + $ref: '#/components/schemas/RegionalScalingResource' + additionalProperties: false + KubernetesScalingResource: + type: object + properties: + Namespace: + type: string + pattern: ^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$ + Name: + type: string + HpaName: + type: string + required: + - Name + - Namespace + additionalProperties: false + LambdaUngraceful: + type: object + properties: + Behavior: + allOf: + - $ref: '#/components/schemas/LambdaUngracefulBehavior' + - default: skip + additionalProperties: false + LambdaUngracefulBehavior: + type: string + enum: + - skip + Lambdas: + type: object + properties: + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + Arn: + type: string + additionalProperties: false + ParallelExecutionBlockConfiguration: + type: object + properties: + Steps: + type: array + items: + $ref: '#/components/schemas/Step' + required: + - Steps + additionalProperties: false + RecoveryApproach: + type: string + enum: + - activeActive + - activePassive + RegionAndRoutingControls: + type: object + x-patternProperties: + .+: + type: array + items: + $ref: '#/components/schemas/ArcRoutingControlState' + additionalProperties: false + RegionSwitchPlanConfiguration: + type: object + properties: + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + Arn: + type: string + pattern: ^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})$ + required: + - Arn + additionalProperties: false + RegionToRunIn: + type: string + enum: + - activatingRegion + - deactivatingRegion + RegionalScalingResource: + type: object + x-patternProperties: + ^[a-z]{2}-[a-z-]+-\d+$: + $ref: '#/components/schemas/KubernetesScalingResource' + additionalProperties: false + Route53HealthCheckConfiguration: + type: object + properties: + TimeoutMinutes: + type: number + default: 60 + minimum: 1 + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + HostedZoneId: + type: string + maxLength: 32 + minLength: 1 + RecordName: + type: string + maxLength: 1024 + minLength: 1 + RecordSets: + type: array + items: + $ref: '#/components/schemas/Route53ResourceRecordSet' + required: + - HostedZoneId + - RecordName + additionalProperties: false + Route53ResourceRecordSet: + type: object + properties: + RecordSetIdentifier: + type: string + maxLength: 1024 + minLength: 1 + Region: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + additionalProperties: false + RoutingControlStateChange: + type: string + enum: + - 'On' + - 'Off' + Service: + type: object + properties: + CrossAccountRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + ExternalId: + type: string + ClusterArn: + type: string + pattern: ^arn:aws:ecs:[a-z0-9-]+:\d{12}:cluster/[a-zA-Z0-9_-]{1,255}$ + ServiceArn: + type: string + pattern: ^arn:aws:ecs:[a-z0-9-]+:\d{12}:service/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]{1,255}$ + additionalProperties: false + Step: + type: object + properties: + Name: + type: string + Description: + type: string + ExecutionBlockConfiguration: + $ref: '#/components/schemas/ExecutionBlockConfiguration' + ExecutionBlockType: + $ref: '#/components/schemas/ExecutionBlockType' + required: + - ExecutionBlockConfiguration + - ExecutionBlockType + - Name + additionalProperties: false + Tags: + type: object + maxProperties: 200 + minProperties: 0 + x-patternProperties: + .+: + type: string + maxLength: 256 + minLength: 0 + additionalProperties: false + Trigger: + type: object + properties: + Description: + type: string + TargetRegion: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + Action: + $ref: '#/components/schemas/WorkflowTargetAction' + Conditions: + type: array + items: + $ref: '#/components/schemas/TriggerCondition' + maxItems: 10 + minItems: 1 + MinDelayMinutesBetweenExecutions: + type: number + required: + - Action + - Conditions + - MinDelayMinutesBetweenExecutions + - TargetRegion + additionalProperties: false + TriggerCondition: + type: object + properties: + AssociatedAlarmName: + type: string + Condition: + $ref: '#/components/schemas/AlarmCondition' + required: + - AssociatedAlarmName + - Condition + additionalProperties: false + Workflow: + type: object + properties: + Steps: + type: array + items: + $ref: '#/components/schemas/Step' + WorkflowTargetAction: + $ref: '#/components/schemas/WorkflowTargetAction' + WorkflowTargetRegion: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + WorkflowDescription: + type: string + required: + - WorkflowTargetAction + additionalProperties: false + WorkflowTargetAction: + type: string + enum: + - activate + - deactivate + HealthCheckState: + type: object + properties: + HealthCheckId: + type: string + Region: + type: string + additionalProperties: false + HealthChecks: + type: array + items: + $ref: '#/components/schemas/HealthCheckState' + maxItems: 2 + minItems: 2 + HealthCheckIds: + type: array + items: + type: string + HealthCheckRecordNames: + type: array + items: + type: string + HealthCheckRegions: + type: array + items: + type: string + HostedZoneIds: + type: array + items: + type: string + Plan: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})$ + AssociatedAlarms: + $ref: '#/components/schemas/AssociatedAlarmMap' + Description: + type: string + ExecutionRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + Name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?$ + Owner: + type: string + pattern: ^\d{12}$ + PrimaryRegion: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + RecoveryApproach: + $ref: '#/components/schemas/RecoveryApproach' + RecoveryTimeObjectiveMinutes: + type: number + maximum: 10080 + minimum: 1 + Regions: + type: array + items: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + maxItems: 2 + minItems: 2 + Tags: + $ref: '#/components/schemas/Tags' + Triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + Version: + type: string + Workflows: + type: array + items: + $ref: '#/components/schemas/Workflow' + HealthChecksForPlan: + type: object + x-patternProperties: + .+: + $ref: '#/components/schemas/HealthChecks' + additionalProperties: false + Route53HealthChecks: + type: object + properties: + HealthCheckIds: + $ref: '#/components/schemas/HealthCheckIds' + RecordNames: + $ref: '#/components/schemas/HealthCheckRecordNames' + Regions: + $ref: '#/components/schemas/HealthCheckRegions' + HostedZoneIds: + $ref: '#/components/schemas/HostedZoneIds' + additionalProperties: false + required: + - ExecutionRole + - Name + - RecoveryApproach + - Regions + - Workflows + x-stackql-resource-name: plan + description: Represents a plan that specifies Regions, IAM roles, and workflows of logic required to perform the desired change to your multi-Region application + x-type-name: AWS::ARCRegionSwitch::Plan + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - PrimaryRegion + - RecoveryApproach + - Regions + x-read-only-properties: + - Arn + - Owner + - Version + - HealthChecksForPlan + - Route53HealthChecks + x-required-properties: + - ExecutionRole + - Name + - RecoveryApproach + - Regions + - Workflows + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - arc-region-switch:TagResource + - arc-region-switch:UntagResource + - arc-region-switch:ListTagsForResource + x-required-permissions: + create: + - arc-region-switch:CreatePlan + - arc-region-switch:GetPlan + - arc-region-switch:ListRoute53HealthChecks + - arc-region-switch:ListTagsForResource + - arc-region-switch:TagResource + - iam:PassRole + read: + - arc-region-switch:GetPlan + - arc-region-switch:ListRoute53HealthChecks + - arc-region-switch:ListTagsForResource + update: + - arc-region-switch:GetPlan + - arc-region-switch:ListRoute53HealthChecks + - arc-region-switch:ListTagsForResource + - arc-region-switch:TagResource + - arc-region-switch:UntagResource + - arc-region-switch:UpdatePlan + - iam:PassRole + delete: + - arc-region-switch:DeletePlan + - arc-region-switch:GetPlan + list: + - arc-region-switch:ListPlans + CreatePlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})$ + AssociatedAlarms: + $ref: '#/components/schemas/AssociatedAlarmMap' + Description: + type: string + ExecutionRole: + type: string + pattern: ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$ + Name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?$ + Owner: + type: string + pattern: ^\d{12}$ + PrimaryRegion: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + RecoveryApproach: + $ref: '#/components/schemas/RecoveryApproach' + RecoveryTimeObjectiveMinutes: + type: number + maximum: 10080 + minimum: 1 + Regions: + type: array + items: + type: string + pattern: ^[a-z]{2}-[a-z-]+-\d+$ + maxItems: 2 + minItems: 2 + Tags: + $ref: '#/components/schemas/Tags' + Triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + Version: + type: string + Workflows: + type: array + items: + $ref: '#/components/schemas/Workflow' + HealthChecksForPlan: + type: object + x-patternProperties: + .+: + $ref: '#/components/schemas/HealthChecks' + additionalProperties: false + Route53HealthChecks: + type: object + properties: + HealthCheckIds: + $ref: '#/components/schemas/HealthCheckIds' + RecordNames: + $ref: '#/components/schemas/HealthCheckRecordNames' + Regions: + $ref: '#/components/schemas/HealthCheckRegions' + HostedZoneIds: + $ref: '#/components/schemas/HostedZoneIds' + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreatePlanRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + plans: + name: plans + id: awscc.arcregionswitch.plans + x-cfn-schema-name: Plan + x-cfn-type-name: AWS::ARCRegionSwitch::Plan + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Plan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCRegionSwitch::Plan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCRegionSwitch::Plan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCRegionSwitch::Plan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/plans/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AssociatedAlarms') as associated_alarms, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ExecutionRole') as execution_role, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Owner') as owner, + JSON_EXTRACT(Properties, '$.PrimaryRegion') as primary_region, + JSON_EXTRACT(Properties, '$.RecoveryApproach') as recovery_approach, + JSON_EXTRACT(Properties, '$.RecoveryTimeObjectiveMinutes') as recovery_time_objective_minutes, + JSON_EXTRACT(Properties, '$.Regions') as regions, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Triggers') as triggers, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Workflows') as workflows, + JSON_EXTRACT(Properties, '$.HealthChecksForPlan') as health_checks_for_plan, + JSON_EXTRACT(Properties, '$.Route53HealthChecks') as route53_health_checks + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ARCRegionSwitch::Plan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AssociatedAlarms') as associated_alarms, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ExecutionRole') as execution_role, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'PrimaryRegion') as primary_region, + json_extract_path_text(Properties, 'RecoveryApproach') as recovery_approach, + json_extract_path_text(Properties, 'RecoveryTimeObjectiveMinutes') as recovery_time_objective_minutes, + json_extract_path_text(Properties, 'Regions') as regions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Triggers') as triggers, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Workflows') as workflows, + json_extract_path_text(Properties, 'HealthChecksForPlan') as health_checks_for_plan, + json_extract_path_text(Properties, 'Route53HealthChecks') as route53_health_checks + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ARCRegionSwitch::Plan' + AND data__Identifier = '' + AND region = 'us-east-1' + plans_list_only: + name: plans_list_only + id: awscc.arcregionswitch.plans_list_only + x-cfn-schema-name: Plan + x-cfn-type-name: AWS::ARCRegionSwitch::Plan + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCRegionSwitch::Plan' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCRegionSwitch::Plan' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Plan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/arczonalshift.yaml b/providers/src/awscc/v00.00.00000/services/arczonalshift.yaml index 715f7933..bc45c061 100644 --- a/providers/src/awscc/v00.00.00000/services/arczonalshift.yaml +++ b/providers/src/awscc/v00.00.00000/services/arczonalshift.yaml @@ -1,15 +1,440 @@ openapi: 3.0.0 info: title: ARCZonalShift - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + AccountId: + description: User account id, used as part of the primary identifier for the resource + type: string + pattern: ^\d{12}$ + Region: + description: Region, used as part of the primary identifier for the resource + type: string + pattern: ^[a-z0-9-]*$ + maxLength: 30 + minLength: 5 + AutoshiftObserverNotificationStatus: + type: object + properties: + Status: + $ref: '#/components/schemas/AutoshiftObserverNotificationStatus' + AccountId: + $ref: '#/components/schemas/AccountId' + Region: + $ref: '#/components/schemas/Region' + required: + - Status + x-stackql-resource-name: autoshift_observer_notification_status + description: Definition of AWS::ARCZonalShift::AutoshiftObserverNotificationStatus Resource Type + x-type-name: AWS::ARCZonalShift::AutoshiftObserverNotificationStatus + x-stackql-primary-identifier: + - AccountId + - Region + x-create-only-properties: + - Status + x-read-only-properties: + - AccountId + - Region + x-required-properties: + - Status + x-tagging: + taggable: false + x-required-permissions: + create: + - arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus + read: + - arc-zonal-shift:GetAutoshiftObserverNotificationStatus + delete: + - arc-zonal-shift:UpdateAutoshiftObserverNotificationStatus + - arc-zonal-shift:GetAutoshiftObserverNotificationStatus + list: + - arc-zonal-shift:GetAutoshiftObserverNotificationStatus ZonalAutoshiftStatus: type: string enum: - ENABLED - - DISABLED ControlCondition: type: object properties: @@ -19,15 +444,16 @@ components: type: string maxLength: 1024 minLength: 8 - pattern: ^arn:.*$ + pattern: ^.*$ required: - AlarmIdentifier - Type additionalProperties: false ControlConditionType: type: string - enum: - - CLOUDWATCH + minLength: 8 + maxLength: 10 + pattern: ^[a-zA-Z]*$ PracticeRunConfiguration: type: object properties: @@ -73,9 +499,6 @@ components: properties: ZonalAutoshiftStatus: $ref: '#/components/schemas/ZonalAutoshiftStatus' - x-dependencies: - ZonalAutoshiftStatus: - - PracticeRunConfiguration PracticeRunConfiguration: $ref: '#/components/schemas/PracticeRunConfiguration' ResourceIdentifier: @@ -83,10 +506,14 @@ components: maxLength: 1024 minLength: 8 x-stackql-resource-name: zonal_autoshift_configuration - x-stackql-primaryIdentifier: + description: Definition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type + x-type-name: AWS::ARCZonalShift::ZonalAutoshiftConfiguration + x-stackql-primary-identifier: - ResourceIdentifier x-create-only-properties: - ResourceIdentifier + x-tagging: + taggable: false x-required-permissions: create: - arc-zonal-shift:CreatePracticeRunConfiguration @@ -107,14 +534,145 @@ components: - arc-zonal-shift:UpdateZonalAutoshiftConfiguration list: - arc-zonal-shift:ListManagedResources + CreateAutoshiftObserverNotificationStatusRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + $ref: '#/components/schemas/AutoshiftObserverNotificationStatus' + AccountId: + $ref: '#/components/schemas/AccountId' + Region: + $ref: '#/components/schemas/Region' + x-stackQL-stringOnly: true + x-title: CreateAutoshiftObserverNotificationStatusRequest + type: object + required: [] + CreateZonalAutoshiftConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ZonalAutoshiftStatus: + $ref: '#/components/schemas/ZonalAutoshiftStatus' + PracticeRunConfiguration: + $ref: '#/components/schemas/PracticeRunConfiguration' + ResourceIdentifier: + type: string + maxLength: 1024 + minLength: 8 + x-stackQL-stringOnly: true + x-title: CreateZonalAutoshiftConfigurationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - zonal_autoshift_configurations: - name: zonal_autoshift_configurations - id: awscc.arczonalshift.zonal_autoshift_configurations - x-cfn-schema-name: ZonalAutoshiftConfiguration - x-type: list + autoshift_observer_notification_statuses: + name: autoshift_observer_notification_statuses + id: awscc.arczonalshift.autoshift_observer_notification_statuses + x-cfn-schema-name: AutoshiftObserverNotificationStatus + x-cfn-type-name: AWS::ARCZonalShift::AutoshiftObserverNotificationStatus x-identifiers: - - ResourceIdentifier + - AccountId + - Region + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutoshiftObserverNotificationStatus&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCZonalShift::AutoshiftObserverNotificationStatus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCZonalShift::AutoshiftObserverNotificationStatus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/autoshift_observer_notification_statuses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/autoshift_observer_notification_statuses/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.Region') as region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ARCZonalShift::AutoshiftObserverNotificationStatus' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'Region') as region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ARCZonalShift::AutoshiftObserverNotificationStatus' + AND data__Identifier = '|' + AND region = 'us-east-1' + autoshift_observer_notification_statuses_list_only: + name: autoshift_observer_notification_statuses_list_only + id: awscc.arczonalshift.autoshift_observer_notification_statuses_list_only + x-cfn-schema-name: AutoshiftObserverNotificationStatus + x-cfn-type-name: AWS::ARCZonalShift::AutoshiftObserverNotificationStatus + x-identifiers: + - AccountId + - Region + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -122,28 +680,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResourceIdentifier') as resource_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.Region') as region + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::AutoshiftObserverNotificationStatus' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'Region') as region + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::AutoshiftObserverNotificationStatus' AND region = 'us-east-1' - zonal_autoshift_configuration: - name: zonal_autoshift_configuration - id: awscc.arczonalshift.zonal_autoshift_configuration + zonal_autoshift_configurations: + name: zonal_autoshift_configurations + id: awscc.arczonalshift.zonal_autoshift_configurations x-cfn-schema-name: ZonalAutoshiftConfiguration - x-type: get + x-cfn-type-name: AWS::ARCZonalShift::ZonalAutoshiftConfiguration x-identifiers: - ResourceIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ZonalAutoshiftConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCZonalShift::ZonalAutoshiftConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCZonalShift::ZonalAutoshiftConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ARCZonalShift::ZonalAutoshiftConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -155,7 +763,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -166,3 +774,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' AND data__Identifier = '' AND region = 'us-east-1' + zonal_autoshift_configurations_list_only: + name: zonal_autoshift_configurations_list_only + id: awscc.arczonalshift.zonal_autoshift_configurations_list_only + x-cfn-schema-name: ZonalAutoshiftConfiguration + x-cfn-type-name: AWS::ARCZonalShift::ZonalAutoshiftConfiguration + x-identifiers: + - ResourceIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ResourceIdentifier') as resource_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutoshiftObserverNotificationStatus&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutoshiftObserverNotificationStatus + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutoshiftObserverNotificationStatusRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ZonalAutoshiftConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateZonalAutoshiftConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateZonalAutoshiftConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/athena.yaml b/providers/src/awscc/v00.00.00000/services/athena.yaml index 2edd4dd7..28f3d18d 100644 --- a/providers/src/awscc/v00.00.00000/services/athena.yaml +++ b/providers/src/awscc/v00.00.00000/services/athena.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Athena - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: description: The Amazon Resource Name (ARN) of the specified capacity reservation @@ -104,8 +484,12 @@ components: - Name - TargetDpus x-stackql-resource-name: capacity_reservation - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Athena::CapacityReservation + x-type-name: AWS::Athena::CapacityReservation + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Name x-create-only-properties: - Name x-read-only-properties: @@ -114,6 +498,19 @@ components: - AllocatedDpus - CreationTime - LastSuccessfulAllocationTime + x-required-properties: + - Name + - TargetDpus + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - athena:UntagResource + - athena:TagResource + - athena:ListTagsForResource x-required-permissions: create: - athena:CreateCapacityReservation @@ -167,24 +564,92 @@ components: description: 'A list of comma separated tags to add to the data catalog that is created. ' $ref: '#/components/schemas/Tags' Type: - description: 'The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. ' + description: 'The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.' type: string enum: - LAMBDA - GLUE - HIVE + - FEDERATED + Status: + description: The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously. + type: string + enum: + - CREATE_IN_PROGRESS + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_FAILED_CLEANUP_IN_PROGRESS + - CREATE_FAILED_CLEANUP_COMPLETE + - CREATE_FAILED_CLEANUP_FAILED + - DELETE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + ConnectionType: + description: The type of connection for a FEDERATED data catalog + type: string + Error: + description: Text of the error that occurred during data catalog creation or deletion. + type: string required: - Name - Type x-stackql-resource-name: data_catalog - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Athena::DataCatalog + x-type-name: AWS::Athena::DataCatalog + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-required-properties: + - Name + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - athena:UntagResource + - athena:TagResource + - athena:ListTagsForResource x-required-permissions: create: - athena:CreateDataCatalog + - athena:GetDataCatalog - athena:TagResource + - s3:ListBucket + - glue:TagResource + - glue:CreateConnection + - glue:DeleteConnection + - glue:UpdateConnection + - serverlessrepo:CreateCloudFormationTemplate + - serverlessrepo:GetCloudFormationTemplate + - cloudformation:CreateStack + - cloudformation:DeleteStack + - cloudformation:DescribeStacks + - cloudformation:CreateChangeSet + - iam:AttachRolePolicy + - iam:DetachRolePolicy + - iam:DeleteRolePolicy + - iam:PutRolePolicy + - iam:CreateRole + - iam:TagRole + - iam:DeleteRole + - iam:GetRole + - iam:GetRolePolicy + - iam:PassRole + - lambda:DeleteFunction + - lambda:CreateFunction + - lambda:TagResource + - lambda:GetFunction + - ec2:DescribeSecurityGroups + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - secretsmanager:ListSecrets + - glue:GetConnection + - ecr:BatchGetImage + - ecr:GetDownloadUrlForLayer read: - athena:GetDataCatalog - athena:ListTagsForResource @@ -196,8 +661,18 @@ components: - athena:ListTagsForResource delete: - athena:DeleteDataCatalog + - athena:GetDataCatalog + - glue:GetConnection + - glue:UpdateConnection + - cloudformation:DeleteStack + - cloudformation:DescribeStacks + - lambda:DeleteFunction + - iam:DeleteRole + - iam:DeleteRolePolicy + - iam:DetachRolePolicy + - s3:ListBucket list: - - athena:ListDataCatalog + - athena:ListDataCatalogs NamedQuery: type: object properties: @@ -233,7 +708,9 @@ components: - Database - QueryString x-stackql-resource-name: named_query - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Athena::NamedQuery + x-type-name: AWS::Athena::NamedQuery + x-stackql-primary-identifier: - NamedQueryId x-create-only-properties: - Name @@ -243,6 +720,9 @@ components: - WorkGroup x-read-only-properties: - NamedQueryId + x-required-properties: + - Database + - QueryString x-required-permissions: create: - athena:CreateNamedQuery @@ -280,12 +760,18 @@ components: - WorkGroup - QueryStatement x-stackql-resource-name: prepared_statement - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Athena::PreparedStatement + x-type-name: AWS::Athena::PreparedStatement + x-stackql-primary-identifier: - StatementName - WorkGroup x-create-only-properties: - StatementName - WorkGroup + x-required-properties: + - StatementName + - WorkGroup + - QueryStatement x-required-permissions: create: - athena:CreatePreparedStatement @@ -355,6 +841,13 @@ components: required: - EncryptionOption additionalProperties: false + ManagedStorageEncryptionConfiguration: + description: Indicates the encryption configuration for Athena Managed Storage. If not setting this field, Managed Storage will encrypt the query results with Athena's encryption key + type: object + properties: + KmsKey: + $ref: '#/components/schemas/KmsKey' + additionalProperties: false RemoveEncryptionConfiguration: type: boolean AdditionalConfiguration: @@ -432,6 +925,15 @@ components: RemoveAclConfiguration: $ref: '#/components/schemas/RemoveAclConfiguration' additionalProperties: false + ManagedQueryResultsConfiguration: + description: The configuration for the managed query results and encryption option. ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time + type: object + properties: + EncryptionConfiguration: + $ref: '#/components/schemas/ManagedStorageEncryptionConfiguration' + Enabled: + type: boolean + additionalProperties: false WorkGroupConfiguration: type: object properties: @@ -453,6 +955,8 @@ components: $ref: '#/components/schemas/ExecutionRole' CustomerContentEncryptionConfiguration: $ref: '#/components/schemas/CustomerContentEncryptionConfiguration' + ManagedQueryResultsConfiguration: + $ref: '#/components/schemas/ManagedQueryResultsConfiguration' additionalProperties: false WorkGroupConfigurationUpdates: type: object @@ -480,6 +984,8 @@ components: $ref: '#/components/schemas/CustomerContentEncryptionConfiguration' RemoveCustomerContentEncryptionConfiguration: $ref: '#/components/schemas/RemoveCustomerContentEncryptionConfiguration' + ManagedQueryResultsConfiguration: + $ref: '#/components/schemas/ManagedQueryResultsConfiguration' additionalProperties: false WorkGroup: type: object @@ -517,14 +1023,32 @@ components: required: - Name x-stackql-resource-name: work_group - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Athena::WorkGroup + x-type-name: AWS::Athena::WorkGroup + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - WorkGroupConfigurationUpdates + - RecursiveDeleteOption + - WorkGroupConfiguration/AdditionalConfiguration x-read-only-properties: - CreationTime - WorkGroupConfiguration/EngineVersion/EffectiveEngineVersion - WorkGroupConfigurationUpdates/EngineVersion/EffectiveEngineVersion + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - athena:UntagResource + - athena:TagResource + - athena:ListTagsForResource x-required-permissions: create: - athena:CreateWorkGroup @@ -562,43 +1086,318 @@ components: - s3:ListMultipartUploadParts - kms:Decrypt - kms:GenerateDataKey + CreateCapacityReservationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + Name: + description: The reservation name. + pattern: '[a-zA-Z0-9._-]{1,128}' + type: string + Status: + description: The status of the reservation. + $ref: '#/components/schemas/CapacityReservationStatus' + TargetDpus: + description: The number of DPUs to request to be allocated to the reservation. + type: integer + format: int64 + minimum: 1 + AllocatedDpus: + description: The number of DPUs Athena has provisioned and allocated for the reservation + type: integer + format: int64 + minimum: 0 + CapacityAssignmentConfiguration: + $ref: '#/components/schemas/CapacityAssignmentConfiguration' + CreationTime: + description: The date and time the reservation was created. + type: string + LastSuccessfulAllocationTime: + description: The timestamp when the last successful allocated was made + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCapacityReservationRequest + type: object + required: [] + CreateDataCatalogRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: 'The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. ' + type: string + minLength: 1 + maxLength: 256 + Description: + description: 'A description of the data catalog to be created. ' + type: string + minLength: 1 + maxLength: 1024 + Parameters: + description: 'Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. ' + type: object + x-patternProperties: + .*: + type: string + maxLength: 51200 + additionalProperties: false + Tags: + description: 'A list of comma separated tags to add to the data catalog that is created. ' + $ref: '#/components/schemas/Tags' + Type: + description: 'The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.' + type: string + enum: + - LAMBDA + - GLUE + - HIVE + - FEDERATED + Status: + description: The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously. + type: string + enum: + - CREATE_IN_PROGRESS + - CREATE_COMPLETE + - CREATE_FAILED + - CREATE_FAILED_CLEANUP_IN_PROGRESS + - CREATE_FAILED_CLEANUP_COMPLETE + - CREATE_FAILED_CLEANUP_FAILED + - DELETE_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + ConnectionType: + description: The type of connection for a FEDERATED data catalog + type: string + Error: + description: Text of the error that occurred during data catalog creation or deletion. + type: string + x-stackQL-stringOnly: true + x-title: CreateDataCatalogRequest + type: object + required: [] + CreateNamedQueryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The query name. + type: string + minLength: 1 + maxLength: 128 + Database: + description: The database to which the query belongs. + type: string + minLength: 1 + maxLength: 255 + Description: + description: The query description. + type: string + minLength: 1 + maxLength: 1024 + QueryString: + description: The contents of the query with all query statements. + type: string + minLength: 1 + maxLength: 262144 + WorkGroup: + description: The name of the workgroup that contains the named query. + type: string + minLength: 1 + maxLength: 128 + NamedQueryId: + description: The unique ID of the query. + type: string + x-stackQL-stringOnly: true + x-title: CreateNamedQueryRequest + type: object + required: [] + CreatePreparedStatementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StatementName: + description: The name of the prepared statement. + type: string + minLength: 1 + maxLength: 256 + WorkGroup: + description: The name of the workgroup to which the prepared statement belongs. + type: string + minLength: 1 + maxLength: 128 + Description: + description: The description of the prepared statement. + type: string + minLength: 1 + maxLength: 1024 + QueryStatement: + description: The query string for the prepared statement. + type: string + minLength: 1 + maxLength: 262144 + x-stackQL-stringOnly: true + x-title: CreatePreparedStatementRequest + type: object + required: [] + CreateWorkGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The workGroup name. + pattern: '[a-zA-Z0-9._-]{1,128}' + type: string + Description: + description: The workgroup description. + type: string + minLength: 0 + maxLength: 1024 + Tags: + description: One or more tags, separated by commas, that you want to attach to the workgroup as you create it + $ref: '#/components/schemas/Tags' + WorkGroupConfiguration: + description: The workgroup configuration + $ref: '#/components/schemas/WorkGroupConfiguration' + WorkGroupConfigurationUpdates: + description: The workgroup configuration update object + $ref: '#/components/schemas/WorkGroupConfigurationUpdates' + CreationTime: + description: The date and time the workgroup was created. + type: string + State: + description: 'The state of the workgroup: ENABLED or DISABLED.' + type: string + enum: + - ENABLED + - DISABLED + RecursiveDeleteOption: + description: The option to delete the workgroup and its contents even if the workgroup contains any named queries. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateWorkGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: capacity_reservations: name: capacity_reservations id: awscc.athena.capacity_reservations x-cfn-schema-name: CapacityReservation - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' - AND region = 'us-east-1' - capacity_reservation: - name: capacity_reservation - id: awscc.athena.capacity_reservation - x-cfn-schema-name: CapacityReservation - x-type: get + x-cfn-type-name: AWS::Athena::CapacityReservation x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CapacityReservation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::CapacityReservation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::CapacityReservation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::CapacityReservation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -616,7 +1415,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -633,13 +1432,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::CapacityReservation' AND data__Identifier = '' AND region = 'us-east-1' - data_catalogs: - name: data_catalogs - id: awscc.athena.data_catalogs - x-cfn-schema-name: DataCatalog - x-type: list + capacity_reservations_list_only: + name: capacity_reservations_list_only + id: awscc.athena.capacity_reservations_list_only + x-cfn-schema-name: CapacityReservation + x-cfn-type-name: AWS::Athena::CapacityReservation x-identifiers: - - Name + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -647,28 +1452,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' AND region = 'us-east-1' - data_catalog: - name: data_catalog - id: awscc.athena.data_catalog + data_catalogs: + name: data_catalogs + id: awscc.athena.data_catalogs x-cfn-schema-name: DataCatalog - x-type: get + x-cfn-type-name: AWS::Athena::DataCatalog x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataCatalog&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::DataCatalog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::DataCatalog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::DataCatalog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -677,12 +1530,15 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Parameters') as parameters, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Type') as type + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.ConnectionType') as connection_type, + JSON_EXTRACT(Properties, '$.Error') as error FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::DataCatalog' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -691,17 +1547,26 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Parameters') as parameters, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ConnectionType') as connection_type, + json_extract_path_text(Properties, 'Error') as error FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::DataCatalog' AND data__Identifier = '' AND region = 'us-east-1' - named_queries: - name: named_queries - id: awscc.athena.named_queries - x-cfn-schema-name: NamedQuery - x-type: list + data_catalogs_list_only: + name: data_catalogs_list_only + id: awscc.athena.data_catalogs_list_only + x-cfn-schema-name: DataCatalog + x-cfn-type-name: AWS::Athena::DataCatalog x-identifiers: - - NamedQueryId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -709,28 +1574,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.NamedQueryId') as named_query_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'NamedQueryId') as named_query_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' AND region = 'us-east-1' - named_query: - name: named_query - id: awscc.athena.named_query + named_queries: + name: named_queries + id: awscc.athena.named_queries x-cfn-schema-name: NamedQuery - x-type: get + x-cfn-type-name: AWS::Athena::NamedQuery x-identifiers: - NamedQueryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NamedQuery&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::NamedQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::NamedQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/named_queries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/named_queries/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -745,7 +1645,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -759,14 +1659,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::NamedQuery' AND data__Identifier = '' AND region = 'us-east-1' - prepared_statements: - name: prepared_statements - id: awscc.athena.prepared_statements - x-cfn-schema-name: PreparedStatement - x-type: list + named_queries_list_only: + name: named_queries_list_only + id: awscc.athena.named_queries_list_only + x-cfn-schema-name: NamedQuery + x-cfn-type-name: AWS::Athena::NamedQuery x-identifiers: - - StatementName - - WorkGroup + - NamedQueryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -774,31 +1679,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StatementName') as statement_name, - JSON_EXTRACT(Properties, '$.WorkGroup') as work_group - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' + JSON_EXTRACT(Properties, '$.NamedQueryId') as named_query_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StatementName') as statement_name, - json_extract_path_text(Properties, 'WorkGroup') as work_group - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' + json_extract_path_text(Properties, 'NamedQueryId') as named_query_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' AND region = 'us-east-1' - prepared_statement: - name: prepared_statement - id: awscc.athena.prepared_statement + prepared_statements: + name: prepared_statements + id: awscc.athena.prepared_statements x-cfn-schema-name: PreparedStatement - x-type: get + x-cfn-type-name: AWS::Athena::PreparedStatement x-identifiers: - StatementName - WorkGroup + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PreparedStatement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::PreparedStatement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::PreparedStatement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::PreparedStatement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -811,7 +1762,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -823,13 +1774,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::PreparedStatement' AND data__Identifier = '|' AND region = 'us-east-1' - work_groups: - name: work_groups - id: awscc.athena.work_groups - x-cfn-schema-name: WorkGroup - x-type: list + prepared_statements_list_only: + name: prepared_statements_list_only + id: awscc.athena.prepared_statements_list_only + x-cfn-schema-name: PreparedStatement + x-cfn-type-name: AWS::Athena::PreparedStatement x-identifiers: - - Name + - StatementName + - WorkGroup + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -837,28 +1795,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' + JSON_EXTRACT(Properties, '$.StatementName') as statement_name, + JSON_EXTRACT(Properties, '$.WorkGroup') as work_group + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' + json_extract_path_text(Properties, 'StatementName') as statement_name, + json_extract_path_text(Properties, 'WorkGroup') as work_group + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' AND region = 'us-east-1' - work_group: - name: work_group - id: awscc.athena.work_group + work_groups: + name: work_groups + id: awscc.athena.work_groups x-cfn-schema-name: WorkGroup - x-type: get + x-cfn-type-name: AWS::Athena::WorkGroup x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WorkGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::WorkGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::WorkGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Athena::WorkGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/work_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/work_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/work_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -875,7 +1883,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -891,3 +1899,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::WorkGroup' AND data__Identifier = '' AND region = 'us-east-1' + work_groups_list_only: + name: work_groups_list_only + id: awscc.athena.work_groups_list_only + x-cfn-schema-name: WorkGroup + x-cfn-type-name: AWS::Athena::WorkGroup + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CapacityReservation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCapacityReservation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCapacityReservationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataCatalog&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataCatalog + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataCatalogRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NamedQuery&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNamedQuery + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNamedQueryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PreparedStatement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePreparedStatement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePreparedStatementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WorkGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/auditmanager.yaml b/providers/src/awscc/v00.00.00000/services/auditmanager.yaml index e59528bf..47c8cc73 100644 --- a/providers/src/awscc/v00.00.00000/services/auditmanager.yaml +++ b/providers/src/awscc/v00.00.00000/services/auditmanager.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: AuditManager - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: FrameworkId: description: The identifier for the specified framework. @@ -241,15 +621,31 @@ components: $ref: '#/components/schemas/AssessmentDescription' required: [] x-stackql-resource-name: assessment - x-stackql-primaryIdentifier: + description: An entity that defines the scope of audit evidence collected by AWS Audit Manager. + x-type-name: AWS::AuditManager::Assessment + x-stackql-primary-identifier: - AssessmentId x-create-only-properties: - FrameworkId - AwsAccount + x-write-only-properties: + - Name + - Description x-read-only-properties: - AssessmentId - Arn - CreationTime + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - auditmanager:TagResource + - auditmanager:ListTagsForResource + - auditmanager:UntagResource x-required-permissions: create: - auditmanager:CreateAssessment @@ -266,45 +662,129 @@ components: - auditmanager:BatchDeleteDelegationByAssessment delete: - auditmanager:DeleteAssessment + - auditmanager:UntagResource list: - auditmanager:ListAssessments + - auditmanager:ListTagsForResource + CreateAssessmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FrameworkId: + $ref: '#/components/schemas/FrameworkId' + AssessmentId: + $ref: '#/components/schemas/UUID' + AwsAccount: + $ref: '#/components/schemas/AWSAccount' + Arn: + $ref: '#/components/schemas/AssessmentArn' + Tags: + description: The tags associated with the assessment. + type: array + items: + $ref: '#/components/schemas/Tag' + Delegations: + description: The list of delegations. + type: array + items: + $ref: '#/components/schemas/Delegation' + Roles: + description: The list of roles for the specified assessment. + type: array + items: + $ref: '#/components/schemas/Role' + Scope: + $ref: '#/components/schemas/Scope' + AssessmentReportsDestination: + $ref: '#/components/schemas/AssessmentReportsDestination' + Status: + $ref: '#/components/schemas/AssessmentStatus' + CreationTime: + $ref: '#/components/schemas/Timestamp' + Name: + $ref: '#/components/schemas/AssessmentName' + Description: + $ref: '#/components/schemas/AssessmentDescription' + x-stackQL-stringOnly: true + x-title: CreateAssessmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: assessments: name: assessments id: awscc.auditmanager.assessments x-cfn-schema-name: Assessment - x-type: list - x-identifiers: - - AssessmentId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssessmentId') as assessment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssessmentId') as assessment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' - AND region = 'us-east-1' - assessment: - name: assessment - id: awscc.auditmanager.assessment - x-cfn-schema-name: Assessment - x-type: get + x-cfn-type-name: AWS::AuditManager::Assessment x-identifiers: - AssessmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Assessment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AuditManager::Assessment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AuditManager::Assessment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AuditManager::Assessment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assessments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/assessments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -326,7 +806,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -347,3 +827,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AuditManager::Assessment' AND data__Identifier = '' AND region = 'us-east-1' + assessments_list_only: + name: assessments_list_only + id: awscc.auditmanager.assessments_list_only + x-cfn-schema-name: Assessment + x-cfn-type-name: AWS::AuditManager::Assessment + x-identifiers: + - AssessmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssessmentId') as assessment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssessmentId') as assessment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Assessment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssessment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssessmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/autoscaling.yaml b/providers/src/awscc/v00.00.00000/services/autoscaling.yaml index 36e77666..7ee53f61 100644 --- a/providers/src/awscc/v00.00.00000/services/autoscaling.yaml +++ b/providers/src/awscc/v00.00.00000/services/autoscaling.yaml @@ -1,188 +1,552 @@ openapi: 3.0.0 info: title: AutoScaling - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - TagProperty: - additionalProperties: false + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object + CancelResourceRequestOutput: properties: - Value: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: type: string - Key: + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: type: string - PropagateAtLaunch: - type: boolean required: - - Value - - Key - - PropagateAtLaunch - LaunchTemplateSpecification: - additionalProperties: false + - DesiredState + title: CreateResourceInput type: object + CreateResourceOutput: properties: - LaunchTemplateName: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: type: string - Version: + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: type: string - LaunchTemplateId: + TypeName: + type: string + TypeVersionId: type: string required: - - Version - InstancesDistribution: - additionalProperties: false + - Identifier + title: DeleteResourceInput type: object + DeleteResourceOutput: properties: - OnDemandAllocationStrategy: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: type: string - OnDemandBaseCapacity: - type: integer - OnDemandPercentageAboveBaseCapacity: - type: integer - SpotInstancePools: - type: integer - SpotAllocationStrategy: + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: type: string - SpotMaxPrice: + EventTime: + type: number + Identifier: type: string - AcceleratorCountRequest: + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + AvailabilityZoneImpairmentPolicy: + description: Describes an Availability Zone impairment policy. additionalProperties: false type: object properties: - Min: - type: integer - Max: - type: integer + ZonalShiftEnabled: + description: If ``true``, enable zonal shift for your Auto Scaling group. + type: boolean + ImpairedZoneHealthCheckBehavior: + description: >- + Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select ``Replace unhealthy``, instances that appear unhealthy will be replaced in all Availability Zones. If you select ``Ignore unhealthy``, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see [Auto Scaling group zonal shift](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-zonal-shift.html) in the + *Amazon EC2 Auto Scaling User Guide*. + type: string + enum: + - IgnoreUnhealthy + - ReplaceUnhealthy + required: + - ImpairedZoneHealthCheckBehavior + - ZonalShiftEnabled LifecycleHookSpecification: + description: |- + ``LifecycleHookSpecification`` specifies a lifecycle hook for the ``LifecycleHookSpecificationList`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. + For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the ``AWS::AutoScaling::LifecycleHook`` resource. additionalProperties: false type: object properties: LifecycleHookName: + description: The name of the lifecycle hook. type: string LifecycleTransition: + description: |- + The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``. type: string HeartbeatTimeout: + description: The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour). type: integer NotificationMetadata: + description: Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. type: string DefaultResult: + description: |- + The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. + Valid values: ``CONTINUE`` | ``ABANDON`` type: string NotificationTargetARN: + description: The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue. type: string RoleARN: + description: |- + The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*. + Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. type: string required: - LifecycleHookName - LifecycleTransition MemoryGiBPerVCpuRequest: + description: '``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.' additionalProperties: false type: object properties: Min: + description: The memory minimum in GiB. type: number Max: + description: The memory maximum in GiB. type: number - NotificationConfiguration: - additionalProperties: false - type: object - properties: - TopicARN: - type: array - items: - type: string - NotificationTypes: - uniqueItems: false - x-insertionOrder: false - type: array - items: - type: string - required: - - TopicARN - MetricsCollection: - additionalProperties: false - type: object - properties: - Metrics: - uniqueItems: false - x-insertionOrder: false - type: array - items: - type: string - Granularity: - type: string - required: - - Granularity TotalLocalStorageGBRequest: + description: '``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.' additionalProperties: false type: object properties: Min: + description: The storage minimum in GB. type: number Max: + description: The storage maximum in GB. type: number - MemoryMiBRequest: - additionalProperties: false - type: object - properties: - Min: - type: integer - Max: - type: integer - InstanceMaintenancePolicy: - additionalProperties: false - type: object - properties: - MaxHealthyPercentage: - type: integer - MinHealthyPercentage: - type: integer - x-dependencies: - MaxHealthyPercentage: - - MinHealthyPercentage - MinHealthyPercentage: - - MaxHealthyPercentage NetworkBandwidthGbpsRequest: + description: |- + ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps. + Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*. additionalProperties: false type: object properties: Min: + description: The minimum amount of network bandwidth, in gigabits per second (Gbps). type: number Max: + description: The maximum amount of network bandwidth, in gigabits per second (Gbps). type: number BaselineEbsBandwidthMbpsRequest: + description: '``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.' additionalProperties: false type: object properties: Min: + description: The minimum value in Mbps. type: integer Max: + description: The maximum value in Mbps. type: integer NetworkInterfaceCountRequest: + description: '``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.' additionalProperties: false type: object properties: Min: + description: The minimum number of network interfaces. type: integer Max: + description: The maximum number of network interfaces. type: integer VCpuCountRequest: + description: '``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.' additionalProperties: false type: object properties: Min: + description: The minimum number of vCPUs. type: integer Max: + description: The maximum number of vCPUs. type: integer + PerformanceFactorReferenceRequest: + description: |- + Specify an instance family to use as the baseline reference for CPU performance. All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. + Currently only one instance family can be specified in the list. + additionalProperties: false + type: object + properties: + InstanceFamily: + description: |- + The instance family to use as a baseline reference. + Make sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance ``c6i.large``, the instance family is ``c6i``, not ``c6``. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types*. + The following instance types are *not supported* for performance protection. + + ``c1`` + + ``g3| g3s`` + + ``hpc7g`` + + ``m1| m2`` + + ``mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro`` + + ``p3dn | p4d | p5`` + + ``t1`` + + ``u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb`` + + If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families. + If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response. + type: string LaunchTemplate: + description: |- + Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy. + ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type. additionalProperties: false type: object properties: LaunchTemplateSpecification: + description: The launch template. $ref: '#/components/schemas/LaunchTemplateSpecification' Overrides: uniqueItems: false + description: Any properties that you specify override the same properties in the launch template. x-insertionOrder: true type: array items: @@ -190,274 +554,922 @@ components: required: - LaunchTemplateSpecification LaunchTemplateOverrides: + description: |- + Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy: + + Override the instance type that is specified in the launch template. + + Use multiple instance types. + + Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group. + After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used. + ``LaunchTemplateOverrides`` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type. additionalProperties: false type: object properties: LaunchTemplateSpecification: + description: >- + Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance + type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. + You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. $ref: '#/components/schemas/LaunchTemplateSpecification' WeightedCapacity: + description: >- + If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two + units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the + range of 1-999. + If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. + Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances. type: string InstanceRequirements: + description: |- + The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. + You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. + If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. $ref: '#/components/schemas/InstanceRequirements' InstanceType: + description: |- + The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. + You can specify up to 40 instance types per Auto Scaling group. type: string - AcceleratorTotalMemoryMiBRequest: + CpuPerformanceFactorRequest: + description: The CPU performance to consider, using an instance family as the baseline reference. additionalProperties: false type: object properties: - Min: - type: integer - Max: - type: integer + References: + description: |- + Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. + Currently only one instance family can be specified in the list. + $ref: '#/components/schemas/PerformanceFactorReferenceSetRequest' MixedInstancesPolicy: + description: |- + Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. + A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. + You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration. + There are key differences between Spot Instances and On-Demand Instances: + + The price for Spot Instances varies based on demand + + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes + + When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. + ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. additionalProperties: false type: object properties: InstancesDistribution: + description: The instances distribution. $ref: '#/components/schemas/InstancesDistribution' LaunchTemplate: + description: One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. $ref: '#/components/schemas/LaunchTemplate' required: - LaunchTemplate - InstanceRequirements: + CapacityReservationIds: + uniqueItems: true + x-insertionOrder: true + type: array + items: + type: string + CapacityReservationResourceGroupArns: + uniqueItems: true + x-insertionOrder: true + type: array + items: + type: string + TagProperty: + description: |- + A structure that specifies a tag for the ``Tags`` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. + For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource. + CloudFormation adds the following tags to all Auto Scaling groups and associated instances: + + aws:cloudformation:stack-name + + aws:cloudformation:stack-id + + aws:cloudformation:logical-id additionalProperties: false type: object properties: - LocalStorageTypes: - uniqueItems: true + Value: + description: The tag value. + type: string + Key: + description: The tag key. + type: string + PropagateAtLaunch: + description: Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. + type: boolean + required: + - Value + - Key + - PropagateAtLaunch + LaunchTemplateSpecification: + description: |- + Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. + You must specify the following: + + The ID or the name of the launch template, but not both. + + The version of the launch template. + + ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. + For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. + For examples of launch templates, see [Create launch templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html). + additionalProperties: false + type: object + properties: + LaunchTemplateName: + description: |- + The name of the launch template. + You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both. + type: string + Version: + description: |- + The version number of the launch template. + Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). + For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource. + type: string + LaunchTemplateId: + description: |- + The ID of the launch template. + You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both. + type: string + required: + - Version + InstancesDistribution: + description: |- + Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. + For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. + ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type. + additionalProperties: false + type: object + properties: + OnDemandAllocationStrategy: + description: |- + The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. + The following lists the valid values: + + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do. + type: string + OnDemandBaseCapacity: + description: |- + The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. + This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. + Default: 0 + An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. + type: integer + OnDemandPercentageAboveBaseCapacity: + description: |- + Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. + Default: 100 + An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. + type: integer + SpotInstancePools: + description: |- + The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. + Default: 2 + type: integer + SpotAllocationStrategy: + description: |- + The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. + The following lists the valid values: + + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. + type: string + SpotMaxPrice: + description: |- + The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value. + If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. + Valid Range: Minimum value of 0.001 + type: string + AcceleratorCountRequest: + description: '``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.' + additionalProperties: false + type: object + properties: + Min: + description: The minimum value. + type: integer + Max: + description: The maximum value. + type: integer + AvailabilityZoneDistribution: + description: '``AvailabilityZoneDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.' + additionalProperties: false + type: object + properties: + CapacityDistributionStrategy: + description: |- + If launches fail in an Availability Zone, the following strategies are available. The default is ``balanced-best-effort``. + + ``balanced-only`` - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution. + + ``balanced-best-effort`` - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead. + type: string + enum: + - balanced-best-effort + - balanced-only + NotificationConfiguration: + description: |- + A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. + For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html). + For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*. + additionalProperties: false + type: object + properties: + TopicARN: + description: The Amazon Resource Name (ARN) of the Amazon SNS topic. + type: array + items: + type: string + NotificationTypes: + uniqueItems: false + description: |- + A list of event types that send a notification. Event types can include any of the following types. + *Allowed values*: + + ``autoscaling:EC2_INSTANCE_LAUNCH`` + + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + + ``autoscaling:EC2_INSTANCE_TERMINATE`` + + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + + ``autoscaling:TEST_NOTIFICATION`` x-insertionOrder: false type: array items: type: string + required: + - TopicARN + MetricsCollection: + description: |- + ``MetricsCollection`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. + For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource. + additionalProperties: false + type: object + properties: + Metrics: + uniqueItems: false + description: |- + Identifies the metrics to enable. + You can specify one or more of the following metrics: + + ``GroupMinSize`` + + ``GroupMaxSize`` + + ``GroupDesiredCapacity`` + + ``GroupInServiceInstances`` + + ``GroupPendingInstances`` + + ``GroupStandbyInstances`` + + ``GroupTerminatingInstances`` + + ``GroupTotalInstances`` + + ``GroupInServiceCapacity`` + + ``GroupPendingCapacity`` + + ``GroupStandbyCapacity`` + + ``GroupTerminatingCapacity`` + + ``GroupTotalCapacity`` + + ``WarmPoolDesiredCapacity`` + + ``WarmPoolWarmedCapacity`` + + ``WarmPoolPendingCapacity`` + + ``WarmPoolTerminatingCapacity`` + + ``WarmPoolTotalCapacity`` + + ``GroupAndWarmPoolDesiredCapacity`` + + ``GroupAndWarmPoolTotalCapacity`` + + If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. + For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*. + x-insertionOrder: false + type: array + items: + type: string + Granularity: + description: The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``. + type: string + required: + - Granularity + MemoryMiBRequest: + description: '``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.' + additionalProperties: false + type: object + properties: + Min: + description: The memory minimum in MiB. + type: integer + Max: + description: The memory maximum in MiB. + type: integer + InstanceMaintenancePolicy: + description: |- + ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. + For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. + additionalProperties: false + type: object + properties: + MaxHealthyPercentage: + description: |- + Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. + Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. + type: integer + MinHealthyPercentage: + description: Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``. + type: integer + x-dependencies: + MaxHealthyPercentage: + - MinHealthyPercentage + MinHealthyPercentage: + - MaxHealthyPercentage + BaselinePerformanceFactorsRequest: + description: |- + The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Auto Scaling uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. + Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` uses the CPU performance of the ``c6i`` family as the baseline reference. + additionalProperties: false + type: object + properties: + Cpu: + description: The CPU performance to consider, using an instance family as the baseline reference. + $ref: '#/components/schemas/CpuPerformanceFactorRequest' + PerformanceFactorReferenceSetRequest: + uniqueItems: true + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PerformanceFactorReferenceRequest' + AcceleratorTotalMemoryMiBRequest: + description: '``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.' + additionalProperties: false + type: object + properties: + Min: + description: The memory minimum in MiB. + type: integer + Max: + description: The memory maximum in MiB. + type: integer + TrafficSourceIdentifier: + description: Identifying information for a traffic source. + additionalProperties: false + type: object + properties: + Type: + description: |- + Provides additional context for the value of ``Identifier``. + The following lists the valid values: + + ``elb`` if ``Identifier`` is the name of a Classic Load Balancer. + + ``elbv2`` if ``Identifier`` is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group. + + ``vpc-lattice`` if ``Identifier`` is the ARN of a VPC Lattice target group. + + Required if the identifier is the name of a Classic Load Balancer. + type: string + Identifier: + description: |- + Identifies the traffic source. + For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region. + For example: + + Application Load Balancer ARN: ``arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456`` + + Classic Load Balancer name: ``my-classic-load-balancer`` + + VPC Lattice ARN: ``arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456`` + + To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) and [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operations. + To get the ARN of a target group for VPC Lattice, use the VPC Lattice [GetTargetGroup](https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html) API operation. + type: string + required: + - Identifier + - Type + InstanceRequirements: + description: |- + The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. + When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. + To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: + + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. + + You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. + For an example template, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html). + For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. + ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type. + additionalProperties: false + type: object + properties: InstanceGenerations: uniqueItems: true + description: |- + Indicates whether current or previous generation instance types are included. + + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. + + For previous generation instance types, specify ``previous``. + + Default: Any current or previous generation x-insertionOrder: false type: array items: type: string - NetworkInterfaceCount: - $ref: '#/components/schemas/NetworkInterfaceCountRequest' AcceleratorTypes: uniqueItems: true + description: |- + Lists the accelerator types that must be on an instance type. + + For instance types with GPU accelerators, specify ``gpu``. + + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. + + Default: Any accelerator type x-insertionOrder: false type: array items: type: string MemoryGiBPerVCpu: + description: |- + The minimum and maximum amount of memory per vCPU for an instance type, in GiB. + Default: No minimum or maximum limits $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' AcceleratorManufacturers: uniqueItems: true + description: |- + Indicates whether instance types must have accelerators by specific manufacturers. + + For instance types with NVIDIA devices, specify ``nvidia``. + + For instance types with AMD devices, specify ``amd``. + + For instance types with AWS devices, specify ``amazon-web-services``. + + For instance types with Xilinx devices, specify ``xilinx``. + + Default: Any manufacturer x-insertionOrder: false type: array items: type: string - ExcludedInstanceTypes: + VCpuCount: + description: The minimum and maximum number of vCPUs for an instance type. + $ref: '#/components/schemas/VCpuCountRequest' + LocalStorage: + description: |- + Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*. + Default: ``included`` + type: string + CpuManufacturers: uniqueItems: true - x-insertionOrder: true + description: |- + Lists which specific CPU manufacturers to include. + + For instance types with Intel CPUs, specify ``intel``. + + For instance types with AMD CPUs, specify ``amd``. + + For instance types with AWS CPUs, specify ``amazon-web-services``. + + For instance types with Apple CPUs, specify ``apple``. + + Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. + Default: Any manufacturer + x-insertionOrder: false type: array items: type: string - VCpuCount: - $ref: '#/components/schemas/VCpuCountRequest' - AllowedInstanceTypes: + BareMetal: + description: |- + Indicates whether bare metal instance types are included, excluded, or required. + Default: ``excluded`` + type: string + RequireHibernateSupport: + description: |- + Indicates whether instance types must provide On-Demand Instance hibernation support. + Default: ``false`` + type: boolean + MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: + description: >- + [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation + instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. + type: integer + OnDemandMaxPricePercentageOverLowestPrice: + description: >- + [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous + generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. + To turn off price protection, specify a high value, such as ``999999``. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. + Default: ``20`` + type: integer + MemoryMiB: + description: The minimum and maximum instance memory size for an instance type, in MiB. + $ref: '#/components/schemas/MemoryMiBRequest' + LocalStorageTypes: uniqueItems: true + description: |- + Indicates the type of local storage that is required. + + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + + For instance types with solid state drive (SSD) storage, specify ``ssd``. + + Default: Any local storage type + x-insertionOrder: false + type: array + items: + type: string + NetworkInterfaceCount: + description: |- + The minimum and maximum number of network interfaces for an instance type. + Default: No minimum or maximum limits + $ref: '#/components/schemas/NetworkInterfaceCountRequest' + ExcludedInstanceTypes: + uniqueItems: true + description: |- + The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. + If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. + Default: No excluded instance types x-insertionOrder: true type: array items: type: string - LocalStorage: - type: string - CpuManufacturers: + AllowedInstanceTypes: uniqueItems: true - x-insertionOrder: false + description: |- + The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. + You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. + If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. + Default: All instance types + x-insertionOrder: true type: array items: type: string AcceleratorCount: + description: |- + The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. + To exclude accelerator-enabled instance types, set ``Max`` to ``0``. + Default: No minimum or maximum limits $ref: '#/components/schemas/AcceleratorCountRequest' NetworkBandwidthGbps: + description: |- + The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). + Default: No minimum or maximum limits $ref: '#/components/schemas/NetworkBandwidthGbpsRequest' - BareMetal: - type: string - RequireHibernateSupport: - type: boolean - MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: - type: integer + BaselinePerformanceFactors: + description: The baseline performance factors for the instance requirements. + $ref: '#/components/schemas/BaselinePerformanceFactorsRequest' BaselineEbsBandwidthMbps: + description: |- + The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. + Default: No minimum or maximum limits $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' SpotMaxPricePercentageOverLowestPrice: + description: >- + [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation + instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. type: integer AcceleratorNames: uniqueItems: true + description: |- + Lists the accelerators that must be on an instance type. + + For instance types with NVIDIA A100 GPUs, specify ``a100``. + + For instance types with NVIDIA V100 GPUs, specify ``v100``. + + For instance types with NVIDIA K80 GPUs, specify ``k80``. + + For instance types with NVIDIA T4 GPUs, specify ``t4``. + + For instance types with NVIDIA M60 GPUs, specify ``m60``. + + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. + + Default: Any accelerator x-insertionOrder: false type: array items: type: string AcceleratorTotalMemoryMiB: + description: |- + The minimum and maximum total memory size for the accelerators on an instance type, in MiB. + Default: No minimum or maximum limits $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - OnDemandMaxPricePercentageOverLowestPrice: - type: integer BurstablePerformance: + description: |- + Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*. + Default: ``excluded`` type: string - MemoryMiB: - $ref: '#/components/schemas/MemoryMiBRequest' TotalLocalStorageGB: + description: |- + The minimum and maximum total local storage size for an instance type, in GB. + Default: No minimum or maximum limits $ref: '#/components/schemas/TotalLocalStorageGBRequest' required: - MemoryMiB - VCpuCount + CapacityReservationTarget: + description: The target for the Capacity Reservation. Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs. + additionalProperties: false + type: object + properties: + CapacityReservationIds: + description: The Capacity Reservation IDs to launch instances into. + $ref: '#/components/schemas/CapacityReservationIds' + CapacityReservationResourceGroupArns: + description: The resource group ARNs of the Capacity Reservation to launch instances into. + $ref: '#/components/schemas/CapacityReservationResourceGroupArns' + CapacityReservationSpecification: + description: Describes the Capacity Reservation preference and targeting options. If you specify ``open`` or ``none`` for ``CapacityReservationPreference``, do not specify a ``CapacityReservationTarget``. + additionalProperties: false + type: object + properties: + CapacityReservationPreference: + description: |- + The capacity reservation preference. The following options are available: + + ``capacity-reservations-only`` - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch. + + ``capacity-reservations-first`` - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity. + + ``none`` - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity. + + ``default`` - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation. + type: string + CapacityReservationTarget: + description: Describes a target Capacity Reservation or Capacity Reservation resource group. + $ref: '#/components/schemas/CapacityReservationTarget' + required: + - CapacityReservationPreference AutoScalingGroup: type: object properties: LifecycleHookSpecificationList: uniqueItems: false - x-insertionOrder: true + description: One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. + x-insertionOrder: false type: array items: $ref: '#/components/schemas/LifecycleHookSpecification' LoadBalancerNames: uniqueItems: false + description: A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead. x-insertionOrder: true type: array items: type: string LaunchConfigurationName: + description: |- + The name of the launch configuration to use to launch instances. + Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``. type: string ServiceLinkedRoleARN: + description: The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*. type: string + AvailabilityZoneImpairmentPolicy: + description: The Availability Zone impairment policy. + $ref: '#/components/schemas/AvailabilityZoneImpairmentPolicy' TargetGroupARNs: uniqueItems: false + description: >- + The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in + the *Amazon EC2 Auto Scaling User Guide*. x-insertionOrder: false type: array items: type: string Cooldown: + description: |- + *Only needed if you use simple scaling policies.* + The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*. + Default: ``300`` seconds type: string NotificationConfigurations: uniqueItems: false + description: Configures an Auto Scaling group to send notifications when specified events take place. x-insertionOrder: true type: array items: $ref: '#/components/schemas/NotificationConfiguration' DesiredCapacity: pattern: ^[0-9]+$ + description: |- + The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. + The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. + CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price. type: string HealthCheckGracePeriod: + description: >- + The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling + group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. + Default: ``0`` seconds type: integer DefaultInstanceWarmup: + description: |- + The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. + During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. + To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. + Default: None type: integer + SkipZonalShiftValidation: + description: '' + type: boolean NewInstancesProtectedFromScaleIn: + description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. type: boolean LaunchTemplate: + description: |- + Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. + If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. $ref: '#/components/schemas/LaunchTemplateSpecification' MixedInstancesPolicy: + description: |- + An embedded object that specifies a mixed instances policy. + The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. + For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. $ref: '#/components/schemas/MixedInstancesPolicy' VPCZoneIdentifier: uniqueItems: false + description: |- + A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. + If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). + When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). + Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones. x-insertionOrder: false type: array items: type: string Tags: + description: >- + One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For + more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. x-insertionOrder: false type: array items: $ref: '#/components/schemas/TagProperty' Context: + description: Reserved. type: string CapacityRebalance: + description: >- + Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot + Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*. type: boolean InstanceId: + description: |- + The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. + If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``. + type: string + AutoScalingGroupARN: + description: '' type: string AvailabilityZones: uniqueItems: false + description: A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template. x-insertionOrder: false type: array items: type: string NotificationConfiguration: + description: '' $ref: '#/components/schemas/NotificationConfiguration' + AvailabilityZoneDistribution: + description: The instance capacity distribution across Availability Zones. + $ref: '#/components/schemas/AvailabilityZoneDistribution' MetricsCollection: uniqueItems: false + description: Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled. x-insertionOrder: true type: array items: $ref: '#/components/schemas/MetricsCollection' InstanceMaintenancePolicy: + description: An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. $ref: '#/components/schemas/InstanceMaintenancePolicy' MaxSize: pattern: ^[0-9]+$ + description: |- + The maximum size of the group. + With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). type: string MinSize: pattern: ^[0-9]+$ + description: The minimum size of the group. type: string TerminationPolicies: uniqueItems: false + description: |- + A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. + Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias`` x-insertionOrder: true type: array items: type: string AutoScalingGroupName: + description: |- + The name of the Auto Scaling group. This name must be unique per Region per account. + The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. + You cannot use a colon (:) in the name. type: string + TrafficSources: + uniqueItems: true + description: The traffic sources associated with this Auto Scaling group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TrafficSourceIdentifier' DesiredCapacityType: + description: |- + The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*. + By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. + Valid values: ``units`` | ``vcpu`` | ``memory-mib`` type: string PlacementGroup: + description: |- + The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide*. + A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group. type: string + CapacityReservationSpecification: + description: The capacity reservation specification. + $ref: '#/components/schemas/CapacityReservationSpecification' HealthCheckType: + description: |- + A comma-separated value string of one or more health check types. + The valid values are ``EC2``, ``EBS``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*. + Only specify ``EC2`` if you must clear a value that was previously set. type: string MaxInstanceLifetime: + description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. type: integer required: - MinSize - MaxSize x-stackql-resource-name: auto_scaling_group - x-stackql-primaryIdentifier: + description: |- + The ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. + For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). + Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*. + For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*. + x-type-name: AWS::AutoScaling::AutoScalingGroup + x-stackql-primary-identifier: - AutoScalingGroupName x-create-only-properties: - InstanceId - AutoScalingGroupName + x-conditional-create-only-properties: + - LaunchConfigurationName + - VPCZoneIdentifier + - LaunchTemplate + - MixedInstancesPolicy + x-write-only-properties: + - SkipZonalShiftValidation + - InstanceId + x-read-only-properties: + - AutoScalingGroupARN + x-required-properties: + - MinSize + - MaxSize + x-tagging: + permissions: + - autoscaling:CreateOrUpdateTags + - autoscaling:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: read: - - autoscaling:* - - managed-fleets:GetAutoScalingGroup + - autoscaling:Describe* + - managed-fleets:Get* create: - - autoscaling:* + - autoscaling:CreateAutoScalingGroup + - autoscaling:UpdateAutoScalingGroup + - autoscaling:CreateOrUpdateTags + - autoscaling:Describe* + - autoscaling:EnableMetricsCollection + - autoscaling:PutNotificationConfiguration - cloudwatch:PutMetricAlarm - ec2:Describe* - - ec2:GetInstanceTypesFromInstanceRequirements + - ec2:Get* - ec2:RunInstances - - elasticloadbalancing:DescribeLoadBalancers - - elasticloadbalancing:DescribeTargetGroups + - elasticloadbalancing:Describe* - iam:CreateServiceLinkedRole - iam:PassRole - - managed-fleets:GetAutoScalingGroup + - managed-fleets:Get* - managed-fleets:CreateAutoScalingGroup - - ssm:GetParameters + - managed-fleets:UpdateAutoScalingGroup + - ssm:Get* + - vpc-lattice:DeregisterTargets + - vpc-lattice:GetTargetGroup + - vpc-lattice:ListTargets + - vpc-lattice:RegisterTargets update: - - autoscaling:* + - autoscaling:UpdateAutoScalingGroup + - autoscaling:CreateOrUpdateTags + - autoscaling:DeleteTags + - autoscaling:Describe* + - autoscaling:EnableMetricsCollection + - autoscaling:DisableMetricsCollection + - autoscaling:PutNotificationConfiguration + - autoscaling:DeleteNotificationConfiguration + - autoscaling:DetachLoadBalancerTargetGroups + - autoscaling:AttachLoadBalancerTargetGroups + - autoscaling:AttachLoadBalancers + - autoscaling:DetachLoadBalancers + - autoscaling:AttachTrafficSources + - autoscaling:DetachTrafficSources + - autoscaling:DeleteLifecycleHook + - autoscaling:PutLifecycleHook - cloudwatch:PutMetricAlarm - ec2:Describe* - - ec2:GetInstanceTypesFromInstanceRequirements + - ec2:Get* - ec2:RunInstances - - elasticloadbalancing:DescribeLoadBalancers - - elasticloadbalancing:DescribeTargetGroups + - elasticloadbalancing:Describe* - iam:CreateServiceLinkedRole - iam:PassRole - - managed-fleets:GetAutoScalingGroup + - managed-fleets:Get* - managed-fleets:RegisterAutoScalingGroup - managed-fleets:DeregisterAutoScalingGroup - managed-fleets:UpdateAutoScalingGroup - - ssm:GetParameters + - ssm:Get* + - vpc-lattice:DeregisterTargets + - vpc-lattice:GetTargetGroup + - vpc-lattice:ListTargets + - vpc-lattice:RegisterTargets list: - - autoscaling:* + - autoscaling:Describe* delete: - - autoscaling:* - - managed-fleets:GetAutoScalingGroup + - autoscaling:DeleteAutoScalingGroup + - autoscaling:UpdateAutoScalingGroup + - autoscaling:Describe* + - managed-fleets:Get* - managed-fleets:DeleteAutoScalingGroup MetadataOptions: description: MetadataOptions is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances. - type: object additionalProperties: false + type: object properties: HttpPutResponseHopLimit: description: The desired HTTP PUT response hop limit for instance metadata requests. @@ -470,18 +1482,18 @@ components: type: string BlockDeviceMapping: description: BlockDeviceMapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group. - type: object additionalProperties: false + type: object properties: + Ebs: + description: Parameters used to automatically set up EBS volumes when an instance is launched. + $ref: '#/components/schemas/BlockDevice' NoDevice: description: Setting this value to true suppresses the specified device included in the block device mapping of the AMI. type: boolean VirtualName: description: The name of the virtual device. type: string - Ebs: - description: Parameters used to automatically set up EBS volumes when an instance is launched. - $ref: '#/components/schemas/BlockDevice' DeviceName: description: 'The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). ' type: string @@ -489,8 +1501,8 @@ components: - DeviceName BlockDevice: description: BlockDevice is a subproperty of BlockDeviceMapping that describes an Amazon EBS volume. - type: object additionalProperties: false + type: object properties: SnapshotId: description: The snapshot ID of the volume to use. @@ -501,6 +1513,9 @@ components: Encrypted: description: 'Specifies whether the volume should be encrypted. ' type: boolean + Throughput: + description: The throughput (MiBps) to provision for a gp3 volume. + type: integer Iops: description: 'The number of input/output (I/O) operations per second (IOPS) to provision for the volume. ' type: integer @@ -510,87 +1525,93 @@ components: DeleteOnTermination: description: 'Indicates whether the volume is deleted on instance termination. ' type: boolean - Throughput: - description: The throughput (MiBps) to provision for a gp3 volume. - type: integer LaunchConfiguration: type: object properties: - AssociatePublicIpAddress: - description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. - type: boolean - BlockDeviceMappings: - description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. - type: array - uniqueItems: true + PlacementTenancy: + description: The tenancy of the instance, either default or dedicated. + type: string + SecurityGroups: + description: A list that contains the security groups to assign to the instances in the Auto Scaling group. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/BlockDeviceMapping' - ClassicLinkVPCId: - description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + type: string + LaunchConfigurationName: + minLength: 1 + description: The name of the launch configuration. This name must be unique per Region per account. + type: string + maxLength: 255 + MetadataOptions: + description: The metadata options for the instances. + $ref: '#/components/schemas/MetadataOptions' + InstanceId: + description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. type: string + UserData: + description: The Base64-encoded user data to make available to the launched EC2 instances. + type: string + maxLength: 21847 ClassicLinkVPCSecurityGroups: description: The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property. - type: array x-insertionOrder: false + type: array items: type: string - EbsOptimized: - description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). - type: boolean + BlockDeviceMappings: + uniqueItems: true + description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' IamInstanceProfile: description: Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. type: string - ImageId: - description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. - type: string - InstanceId: - description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. - type: string - InstanceMonitoring: - description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. - type: boolean - InstanceType: - description: Specifies the instance type of the EC2 instance. - type: string KernelId: description: Provides the ID of the kernel associated with the EC2 AMI. type: string + AssociatePublicIpAddress: + description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. + type: boolean + ClassicLinkVPCId: + description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + type: string + EbsOptimized: + description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). + type: boolean KeyName: description: Provides the name of the EC2 key pair. type: string - LaunchConfigurationName: - description: The name of the launch configuration. This name must be unique per Region per account. + SpotPrice: + description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. type: string - minLength: 1 - maxLength: 255 - MetadataOptions: - description: The metadata options for the instances. - $ref: '#/components/schemas/MetadataOptions' - PlacementTenancy: - description: The tenancy of the instance, either default or dedicated. + ImageId: + description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. + type: string + InstanceType: + description: Specifies the instance type of the EC2 instance. type: string RamDiskId: description: The ID of the RAM disk to select. type: string - SecurityGroups: - description: A list that contains the security groups to assign to the instances in the Auto Scaling group. - type: array - x-insertionOrder: false - items: - type: string - SpotPrice: - description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. - type: string - UserData: - description: The Base64-encoded user data to make available to the launched EC2 instances. - type: string - maxLength: 21847 + InstanceMonitoring: + description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. + type: boolean required: - ImageId - InstanceType x-stackql-resource-name: launch_configuration - x-stackql-primaryIdentifier: + description: The AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances. + x-type-name: AWS::AutoScaling::LaunchConfiguration + x-stackql-primary-identifier: - LaunchConfigurationName x-create-only-properties: - AssociatePublicIpAddress @@ -612,18 +1633,25 @@ components: - SecurityGroups - SpotPrice - UserData + x-write-only-properties: + - InstanceId + x-required-properties: + - ImageId + - InstanceType + x-tagging: + taggable: false x-required-permissions: + read: + - autoscaling:DescribeLaunchConfigurations create: - autoscaling:CreateLaunchConfiguration - autoscaling:DescribeLaunchConfigurations - iam:PassRole - read: + list: - autoscaling:DescribeLaunchConfigurations delete: - autoscaling:DeleteLaunchConfiguration - autoscaling:DescribeLaunchConfigurations - list: - - autoscaling:DescribeLaunchConfigurations LifecycleHook: type: object properties: @@ -659,12 +1687,19 @@ components: - LifecycleTransition - AutoScalingGroupName x-stackql-resource-name: lifecycle_hook - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::AutoScaling::LifecycleHook + x-type-name: AWS::AutoScaling::LifecycleHook + x-stackql-primary-identifier: - AutoScalingGroupName - LifecycleHookName x-create-only-properties: - AutoScalingGroupName - LifecycleHookName + x-required-properties: + - LifecycleTransition + - AutoScalingGroupName + x-tagging: + taggable: false x-required-permissions: create: - autoscaling:PutLifecycleHook @@ -733,16 +1768,21 @@ components: uniqueItems: true items: $ref: '#/components/schemas/MetricDimension' + Metrics: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/TargetTrackingMetricDataQuery' Statistic: type: string Unit: type: string Namespace: type: string - required: - - MetricName - - Statistic - - Namespace + Period: + type: integer + required: [] TargetTrackingConfiguration: type: object additionalProperties: false @@ -874,6 +1914,21 @@ components: required: - MetricName - Namespace + TargetTrackingMetricStat: + type: object + additionalProperties: false + properties: + Metric: + $ref: '#/components/schemas/Metric' + Stat: + type: string + Unit: + type: string + Period: + type: integer + required: + - Stat + - Metric MetricStat: type: object additionalProperties: false @@ -882,11 +1937,29 @@ components: $ref: '#/components/schemas/Metric' Stat: type: string - Unit: + Unit: + type: string + required: + - Stat + - Metric + TargetTrackingMetricDataQuery: + type: object + additionalProperties: false + properties: + Label: + type: string + MetricStat: + $ref: '#/components/schemas/TargetTrackingMetricStat' + Id: + type: string + ReturnData: + type: boolean + Expression: type: string + Period: + type: integer required: - - Stat - - Metric + - Id MetricDataQuery: type: object additionalProperties: false @@ -951,13 +2024,22 @@ components: required: - AutoScalingGroupName x-stackql-resource-name: scaling_policy - x-stackql-primaryIdentifier: + description: The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application. + x-type-name: AWS::AutoScaling::ScalingPolicy + x-stackql-primary-identifier: - Arn x-create-only-properties: - AutoScalingGroupName x-read-only-properties: - PolicyName - Arn + x-required-properties: + - AutoScalingGroupName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - autoscaling:DescribePolicies @@ -1007,13 +2089,19 @@ components: required: - AutoScalingGroupName x-stackql-resource-name: scheduled_action - x-stackql-primaryIdentifier: + description: The AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes. + x-type-name: AWS::AutoScaling::ScheduledAction + x-stackql-primary-identifier: - ScheduledActionName - AutoScalingGroupName x-create-only-properties: - AutoScalingGroupName x-read-only-properties: - ScheduledActionName + x-required-properties: + - AutoScalingGroupName + x-tagging: + taggable: false x-required-permissions: create: - autoscaling:PutScheduledUpdateGroupAction @@ -1049,10 +2137,16 @@ components: required: - AutoScalingGroupName x-stackql-resource-name: warm_pool - x-stackql-primaryIdentifier: + description: Resource schema for AWS::AutoScaling::WarmPool. + x-type-name: AWS::AutoScaling::WarmPool + x-stackql-primary-identifier: - AutoScalingGroupName x-create-only-properties: - AutoScalingGroupName + x-required-properties: + - AutoScalingGroupName + x-tagging: + taggable: false x-required-permissions: create: - autoscaling:PutWarmPool @@ -1067,43 +2161,558 @@ components: - autoscaling:PutWarmPool - autoscaling:DescribeWarmPool - autoscaling:DescribeAutoScalingGroups + list: + - autoscaling:DescribeWarmPool + CreateAutoScalingGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LifecycleHookSpecificationList: + uniqueItems: false + description: One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/LifecycleHookSpecification' + LoadBalancerNames: + uniqueItems: false + description: A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead. + x-insertionOrder: true + type: array + items: + type: string + LaunchConfigurationName: + description: |- + The name of the launch configuration to use to launch instances. + Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``. + type: string + ServiceLinkedRoleARN: + description: The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*. + type: string + AvailabilityZoneImpairmentPolicy: + description: The Availability Zone impairment policy. + $ref: '#/components/schemas/AvailabilityZoneImpairmentPolicy' + TargetGroupARNs: + uniqueItems: false + description: >- + The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling + group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*. + x-insertionOrder: false + type: array + items: + type: string + Cooldown: + description: |- + *Only needed if you use simple scaling policies.* + The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*. + Default: ``300`` seconds + type: string + NotificationConfigurations: + uniqueItems: false + description: Configures an Auto Scaling group to send notifications when specified events take place. + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/NotificationConfiguration' + DesiredCapacity: + pattern: ^[0-9]+$ + description: |- + The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. + The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. + CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price. + type: string + HealthCheckGracePeriod: + description: >- + The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling + group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. + Default: ``0`` seconds + type: integer + DefaultInstanceWarmup: + description: |- + The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. + During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. + To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. + Default: None + type: integer + SkipZonalShiftValidation: + description: '' + type: boolean + NewInstancesProtectedFromScaleIn: + description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. + type: boolean + LaunchTemplate: + description: |- + Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. + If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. + $ref: '#/components/schemas/LaunchTemplateSpecification' + MixedInstancesPolicy: + description: |- + An embedded object that specifies a mixed instances policy. + The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. + For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. + $ref: '#/components/schemas/MixedInstancesPolicy' + VPCZoneIdentifier: + uniqueItems: false + description: |- + A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. + If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). + When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). + Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones. + x-insertionOrder: false + type: array + items: + type: string + Tags: + description: >- + One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. + For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TagProperty' + Context: + description: Reserved. + type: string + CapacityRebalance: + description: >- + Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot + Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*. + type: boolean + InstanceId: + description: |- + The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. + If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``. + type: string + AutoScalingGroupARN: + description: '' + type: string + AvailabilityZones: + uniqueItems: false + description: A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template. + x-insertionOrder: false + type: array + items: + type: string + NotificationConfiguration: + description: '' + $ref: '#/components/schemas/NotificationConfiguration' + AvailabilityZoneDistribution: + description: The instance capacity distribution across Availability Zones. + $ref: '#/components/schemas/AvailabilityZoneDistribution' + MetricsCollection: + uniqueItems: false + description: Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled. + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/MetricsCollection' + InstanceMaintenancePolicy: + description: An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. + $ref: '#/components/schemas/InstanceMaintenancePolicy' + MaxSize: + pattern: ^[0-9]+$ + description: |- + The maximum size of the group. + With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). + type: string + MinSize: + pattern: ^[0-9]+$ + description: The minimum size of the group. + type: string + TerminationPolicies: + uniqueItems: false + description: |- + A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. + Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias`` + x-insertionOrder: true + type: array + items: + type: string + AutoScalingGroupName: + description: |- + The name of the Auto Scaling group. This name must be unique per Region per account. + The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. + You cannot use a colon (:) in the name. + type: string + TrafficSources: + uniqueItems: true + description: The traffic sources associated with this Auto Scaling group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TrafficSourceIdentifier' + DesiredCapacityType: + description: |- + The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*. + By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. + Valid values: ``units`` | ``vcpu`` | ``memory-mib`` + type: string + PlacementGroup: + description: |- + The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide*. + A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group. + type: string + CapacityReservationSpecification: + description: The capacity reservation specification. + $ref: '#/components/schemas/CapacityReservationSpecification' + HealthCheckType: + description: |- + A comma-separated value string of one or more health check types. + The valid values are ``EC2``, ``EBS``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*. + Only specify ``EC2`` if you must clear a value that was previously set. + type: string + MaxInstanceLifetime: + description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. + type: integer + x-stackQL-stringOnly: true + x-title: CreateAutoScalingGroupRequest + type: object + required: [] + CreateLaunchConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PlacementTenancy: + description: The tenancy of the instance, either default or dedicated. + type: string + SecurityGroups: + description: A list that contains the security groups to assign to the instances in the Auto Scaling group. + x-insertionOrder: false + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + type: string + LaunchConfigurationName: + minLength: 1 + description: The name of the launch configuration. This name must be unique per Region per account. + type: string + maxLength: 255 + MetadataOptions: + description: The metadata options for the instances. + $ref: '#/components/schemas/MetadataOptions' + InstanceId: + description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. + type: string + UserData: + description: The Base64-encoded user data to make available to the launched EC2 instances. + type: string + maxLength: 21847 + ClassicLinkVPCSecurityGroups: + description: The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property. + x-insertionOrder: false + type: array + items: + type: string + BlockDeviceMappings: + uniqueItems: true + description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' + IamInstanceProfile: + description: Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. + type: string + KernelId: + description: Provides the ID of the kernel associated with the EC2 AMI. + type: string + AssociatePublicIpAddress: + description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. + type: boolean + ClassicLinkVPCId: + description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + type: string + EbsOptimized: + description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). + type: boolean + KeyName: + description: Provides the name of the EC2 key pair. + type: string + SpotPrice: + description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. + type: string + ImageId: + description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. + type: string + InstanceType: + description: Specifies the instance type of the EC2 instance. + type: string + RamDiskId: + description: The ID of the RAM disk to select. + type: string + InstanceMonitoring: + description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateLaunchConfigurationRequest + type: object + required: [] + CreateLifecycleHookRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoScalingGroupName: + description: The name of the Auto Scaling group for the lifecycle hook. + type: string + DefaultResult: + description: The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default). + type: string + HeartbeatTimeout: + description: The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property. + type: integer + LifecycleHookName: + description: The name of the lifecycle hook. + type: string + minLength: 1 + maxLength: 255 + LifecycleTransition: + description: The instance state to which you want to attach the lifecycle hook. + type: string + NotificationMetadata: + description: Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target. + type: string + minLength: 1 + maxLength: 1023 + NotificationTargetARN: + description: 'The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.' + type: string + RoleARN: + description: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. + type: string + x-stackQL-stringOnly: true + x-title: CreateLifecycleHookRequest + type: object + required: [] + CreateScalingPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MetricAggregationType: + description: The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling. + type: string + PolicyName: + type: string + PolicyType: + description: 'One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling' + type: string + PredictiveScalingConfiguration: + description: A predictive scaling policy. Includes support for predefined metrics only. + $ref: '#/components/schemas/PredictiveScalingConfiguration' + ScalingAdjustment: + description: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.) + type: integer + Cooldown: + description: The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group. + type: string + StepAdjustments: + description: A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.) + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StepAdjustment' + AutoScalingGroupName: + description: The name of the Auto Scaling group. + type: string + MinAdjustmentMagnitude: + description: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. + type: integer + TargetTrackingConfiguration: + description: A target tracking scaling policy. Includes support for predefined or customized metrics. + $ref: '#/components/schemas/TargetTrackingConfiguration' + EstimatedInstanceWarmup: + description: The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling. + type: integer + AdjustmentType: + description: Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. + type: string + Arn: + description: The ARN of the AutoScaling scaling policy + type: string + x-stackQL-stringOnly: true + x-title: CreateScalingPolicyRequest + type: object + required: [] + CreateScheduledActionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScheduledActionName: + description: Auto-generated unique identifier + type: string + MinSize: + description: The minimum size of the Auto Scaling group. + type: integer + Recurrence: + description: The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops. + type: string + TimeZone: + description: The time zone for the cron expression. + type: string + EndTime: + description: The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. + type: string + AutoScalingGroupName: + description: The name of the Auto Scaling group. + type: string + StartTime: + description: The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. + type: string + DesiredCapacity: + description: The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. + type: integer + MaxSize: + description: The minimum size of the Auto Scaling group. + type: integer + x-stackQL-stringOnly: true + x-title: CreateScheduledActionRequest + type: object + required: [] + CreateWarmPoolRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoScalingGroupName: + type: string + MaxGroupPreparedCapacity: + type: integer + MinSize: + type: integer + PoolState: + type: string + InstanceReusePolicy: + $ref: '#/components/schemas/InstanceReusePolicy' + x-stackQL-stringOnly: true + x-title: CreateWarmPoolRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: auto_scaling_groups: name: auto_scaling_groups id: awscc.autoscaling.auto_scaling_groups x-cfn-schema-name: AutoScalingGroup - x-type: list - x-identifiers: - - AutoScalingGroupName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' - AND region = 'us-east-1' - auto_scaling_group: - name: auto_scaling_group - id: awscc.autoscaling.auto_scaling_group - x-cfn-schema-name: AutoScalingGroup - x-type: get + x-cfn-type-name: AWS::AutoScaling::AutoScalingGroup x-identifiers: - AutoScalingGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutoScalingGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::AutoScalingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::AutoScalingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::AutoScalingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1112,12 +2721,14 @@ components: JSON_EXTRACT(Properties, '$.LoadBalancerNames') as load_balancer_names, JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name, JSON_EXTRACT(Properties, '$.ServiceLinkedRoleARN') as service_linked_role_arn, + JSON_EXTRACT(Properties, '$.AvailabilityZoneImpairmentPolicy') as availability_zone_impairment_policy, JSON_EXTRACT(Properties, '$.TargetGroupARNs') as target_group_arns, JSON_EXTRACT(Properties, '$.Cooldown') as cooldown, JSON_EXTRACT(Properties, '$.NotificationConfigurations') as notification_configurations, JSON_EXTRACT(Properties, '$.DesiredCapacity') as desired_capacity, JSON_EXTRACT(Properties, '$.HealthCheckGracePeriod') as health_check_grace_period, JSON_EXTRACT(Properties, '$.DefaultInstanceWarmup') as default_instance_warmup, + JSON_EXTRACT(Properties, '$.SkipZonalShiftValidation') as skip_zonal_shift_validation, JSON_EXTRACT(Properties, '$.NewInstancesProtectedFromScaleIn') as new_instances_protected_from_scale_in, JSON_EXTRACT(Properties, '$.LaunchTemplate') as launch_template, JSON_EXTRACT(Properties, '$.MixedInstancesPolicy') as mixed_instances_policy, @@ -1126,23 +2737,27 @@ components: JSON_EXTRACT(Properties, '$.Context') as context, JSON_EXTRACT(Properties, '$.CapacityRebalance') as capacity_rebalance, JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.AutoScalingGroupARN') as auto_scaling_group_arn, JSON_EXTRACT(Properties, '$.AvailabilityZones') as availability_zones, JSON_EXTRACT(Properties, '$.NotificationConfiguration') as notification_configuration, + JSON_EXTRACT(Properties, '$.AvailabilityZoneDistribution') as availability_zone_distribution, JSON_EXTRACT(Properties, '$.MetricsCollection') as metrics_collection, JSON_EXTRACT(Properties, '$.InstanceMaintenancePolicy') as instance_maintenance_policy, JSON_EXTRACT(Properties, '$.MaxSize') as max_size, JSON_EXTRACT(Properties, '$.MinSize') as min_size, JSON_EXTRACT(Properties, '$.TerminationPolicies') as termination_policies, JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name, + JSON_EXTRACT(Properties, '$.TrafficSources') as traffic_sources, JSON_EXTRACT(Properties, '$.DesiredCapacityType') as desired_capacity_type, JSON_EXTRACT(Properties, '$.PlacementGroup') as placement_group, + JSON_EXTRACT(Properties, '$.CapacityReservationSpecification') as capacity_reservation_specification, JSON_EXTRACT(Properties, '$.HealthCheckType') as health_check_type, JSON_EXTRACT(Properties, '$.MaxInstanceLifetime') as max_instance_lifetime FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1151,12 +2766,14 @@ components: json_extract_path_text(Properties, 'LoadBalancerNames') as load_balancer_names, json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, json_extract_path_text(Properties, 'ServiceLinkedRoleARN') as service_linked_role_arn, + json_extract_path_text(Properties, 'AvailabilityZoneImpairmentPolicy') as availability_zone_impairment_policy, json_extract_path_text(Properties, 'TargetGroupARNs') as target_group_arns, json_extract_path_text(Properties, 'Cooldown') as cooldown, json_extract_path_text(Properties, 'NotificationConfigurations') as notification_configurations, json_extract_path_text(Properties, 'DesiredCapacity') as desired_capacity, json_extract_path_text(Properties, 'HealthCheckGracePeriod') as health_check_grace_period, json_extract_path_text(Properties, 'DefaultInstanceWarmup') as default_instance_warmup, + json_extract_path_text(Properties, 'SkipZonalShiftValidation') as skip_zonal_shift_validation, json_extract_path_text(Properties, 'NewInstancesProtectedFromScaleIn') as new_instances_protected_from_scale_in, json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, json_extract_path_text(Properties, 'MixedInstancesPolicy') as mixed_instances_policy, @@ -1165,28 +2782,38 @@ components: json_extract_path_text(Properties, 'Context') as context, json_extract_path_text(Properties, 'CapacityRebalance') as capacity_rebalance, json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'AutoScalingGroupARN') as auto_scaling_group_arn, json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, + json_extract_path_text(Properties, 'AvailabilityZoneDistribution') as availability_zone_distribution, json_extract_path_text(Properties, 'MetricsCollection') as metrics_collection, json_extract_path_text(Properties, 'InstanceMaintenancePolicy') as instance_maintenance_policy, json_extract_path_text(Properties, 'MaxSize') as max_size, json_extract_path_text(Properties, 'MinSize') as min_size, json_extract_path_text(Properties, 'TerminationPolicies') as termination_policies, json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'TrafficSources') as traffic_sources, json_extract_path_text(Properties, 'DesiredCapacityType') as desired_capacity_type, json_extract_path_text(Properties, 'PlacementGroup') as placement_group, + json_extract_path_text(Properties, 'CapacityReservationSpecification') as capacity_reservation_specification, json_extract_path_text(Properties, 'HealthCheckType') as health_check_type, json_extract_path_text(Properties, 'MaxInstanceLifetime') as max_instance_lifetime FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' AND data__Identifier = '' AND region = 'us-east-1' - launch_configurations: - name: launch_configurations - id: awscc.autoscaling.launch_configurations - x-cfn-schema-name: LaunchConfiguration - x-type: list + auto_scaling_groups_list_only: + name: auto_scaling_groups_list_only + id: awscc.autoscaling.auto_scaling_groups_list_only + x-cfn-schema-name: AutoScalingGroup + x-cfn-type-name: AWS::AutoScaling::AutoScalingGroup x-identifiers: - - LaunchConfigurationName + - AutoScalingGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1194,90 +2821,130 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' AND region = 'us-east-1' - launch_configuration: - name: launch_configuration - id: awscc.autoscaling.launch_configuration + launch_configurations: + name: launch_configurations + id: awscc.autoscaling.launch_configurations x-cfn-schema-name: LaunchConfiguration - x-type: get + x-cfn-type-name: AWS::AutoScaling::LaunchConfiguration x-identifiers: - LaunchConfigurationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LaunchConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::LaunchConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::LaunchConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/launch_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/launch_configurations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AssociatePublicIpAddress') as associate_public_ip_address, + JSON_EXTRACT(Properties, '$.PlacementTenancy') as placement_tenancy, + JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, + JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name, + JSON_EXTRACT(Properties, '$.MetadataOptions') as metadata_options, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.UserData') as user_data, + JSON_EXTRACT(Properties, '$.ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, JSON_EXTRACT(Properties, '$.BlockDeviceMappings') as block_device_mappings, + JSON_EXTRACT(Properties, '$.IamInstanceProfile') as iam_instance_profile, + JSON_EXTRACT(Properties, '$.KernelId') as kernel_id, + JSON_EXTRACT(Properties, '$.AssociatePublicIpAddress') as associate_public_ip_address, JSON_EXTRACT(Properties, '$.ClassicLinkVPCId') as classic_link_vpc_id, - JSON_EXTRACT(Properties, '$.ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, JSON_EXTRACT(Properties, '$.EbsOptimized') as ebs_optimized, - JSON_EXTRACT(Properties, '$.IamInstanceProfile') as iam_instance_profile, + JSON_EXTRACT(Properties, '$.KeyName') as key_name, + JSON_EXTRACT(Properties, '$.SpotPrice') as spot_price, JSON_EXTRACT(Properties, '$.ImageId') as image_id, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.InstanceMonitoring') as instance_monitoring, JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, - JSON_EXTRACT(Properties, '$.KernelId') as kernel_id, - JSON_EXTRACT(Properties, '$.KeyName') as key_name, - JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name, - JSON_EXTRACT(Properties, '$.MetadataOptions') as metadata_options, - JSON_EXTRACT(Properties, '$.PlacementTenancy') as placement_tenancy, JSON_EXTRACT(Properties, '$.RamDiskId') as ram_disk_id, - JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, - JSON_EXTRACT(Properties, '$.SpotPrice') as spot_price, - JSON_EXTRACT(Properties, '$.UserData') as user_data + JSON_EXTRACT(Properties, '$.InstanceMonitoring') as instance_monitoring FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, + json_extract_path_text(Properties, 'PlacementTenancy') as placement_tenancy, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, + json_extract_path_text(Properties, 'MetadataOptions') as metadata_options, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'UserData') as user_data, + json_extract_path_text(Properties, 'ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, + json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, + json_extract_path_text(Properties, 'KernelId') as kernel_id, + json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, json_extract_path_text(Properties, 'ClassicLinkVPCId') as classic_link_vpc_id, - json_extract_path_text(Properties, 'ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, - json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'SpotPrice') as spot_price, json_extract_path_text(Properties, 'ImageId') as image_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'InstanceMonitoring') as instance_monitoring, json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'KernelId') as kernel_id, - json_extract_path_text(Properties, 'KeyName') as key_name, - json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, - json_extract_path_text(Properties, 'MetadataOptions') as metadata_options, - json_extract_path_text(Properties, 'PlacementTenancy') as placement_tenancy, json_extract_path_text(Properties, 'RamDiskId') as ram_disk_id, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'SpotPrice') as spot_price, - json_extract_path_text(Properties, 'UserData') as user_data + json_extract_path_text(Properties, 'InstanceMonitoring') as instance_monitoring FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - lifecycle_hooks: - name: lifecycle_hooks - id: awscc.autoscaling.lifecycle_hooks - x-cfn-schema-name: LifecycleHook - x-type: list + launch_configurations_list_only: + name: launch_configurations_list_only + id: awscc.autoscaling.launch_configurations_list_only + x-cfn-schema-name: LaunchConfiguration + x-cfn-type-name: AWS::AutoScaling::LaunchConfiguration x-identifiers: - - AutoScalingGroupName - - LifecycleHookName + - LaunchConfigurationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1285,31 +2952,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name, - JSON_EXTRACT(Properties, '$.LifecycleHookName') as lifecycle_hook_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' + JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, - json_extract_path_text(Properties, 'LifecycleHookName') as lifecycle_hook_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' + json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' AND region = 'us-east-1' - lifecycle_hook: - name: lifecycle_hook - id: awscc.autoscaling.lifecycle_hook + lifecycle_hooks: + name: lifecycle_hooks + id: awscc.autoscaling.lifecycle_hooks x-cfn-schema-name: LifecycleHook - x-type: get + x-cfn-type-name: AWS::AutoScaling::LifecycleHook x-identifiers: - AutoScalingGroupName - LifecycleHookName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LifecycleHook&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::LifecycleHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::LifecycleHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::LifecycleHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1326,7 +3039,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1342,13 +3055,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' AND data__Identifier = '|' AND region = 'us-east-1' - scaling_policies: - name: scaling_policies - id: awscc.autoscaling.scaling_policies - x-cfn-schema-name: ScalingPolicy - x-type: list + lifecycle_hooks_list_only: + name: lifecycle_hooks_list_only + id: awscc.autoscaling.lifecycle_hooks_list_only + x-cfn-schema-name: LifecycleHook + x-cfn-type-name: AWS::AutoScaling::LifecycleHook x-identifiers: - - Arn + - AutoScalingGroupName + - LifecycleHookName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1356,28 +3076,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name, + JSON_EXTRACT(Properties, '$.LifecycleHookName') as lifecycle_hook_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'LifecycleHookName') as lifecycle_hook_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' AND region = 'us-east-1' - scaling_policy: - name: scaling_policy - id: awscc.autoscaling.scaling_policy + scaling_policies: + name: scaling_policies + id: awscc.autoscaling.scaling_policies x-cfn-schema-name: ScalingPolicy - x-type: get + x-cfn-type-name: AWS::AutoScaling::ScalingPolicy x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScalingPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::ScalingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::ScalingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::ScalingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1399,7 +3169,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1420,14 +3190,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' AND data__Identifier = '' AND region = 'us-east-1' - scheduled_actions: - name: scheduled_actions - id: awscc.autoscaling.scheduled_actions - x-cfn-schema-name: ScheduledAction - x-type: list + scaling_policies_list_only: + name: scaling_policies_list_only + id: awscc.autoscaling.scaling_policies_list_only + x-cfn-schema-name: ScalingPolicy + x-cfn-type-name: AWS::AutoScaling::ScalingPolicy x-identifiers: - - ScheduledActionName - - AutoScalingGroupName + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1435,31 +3210,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name, - JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' AND region = 'us-east-1' - scheduled_action: - name: scheduled_action - id: awscc.autoscaling.scheduled_action + scheduled_actions: + name: scheduled_actions + id: awscc.autoscaling.scheduled_actions x-cfn-schema-name: ScheduledAction - x-type: get + x-cfn-type-name: AWS::AutoScaling::ScheduledAction x-identifiers: - ScheduledActionName - AutoScalingGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScheduledAction&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::ScheduledAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::ScheduledAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::ScheduledAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1477,7 +3298,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1494,17 +3315,99 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' AND data__Identifier = '|' AND region = 'us-east-1' - warm_pool: - name: warm_pool - id: awscc.autoscaling.warm_pool - x-cfn-schema-name: WarmPool - x-type: get + scheduled_actions_list_only: + name: scheduled_actions_list_only + id: awscc.autoscaling.scheduled_actions_list_only + x-cfn-schema-name: ScheduledAction + x-cfn-type-name: AWS::AutoScaling::ScheduledAction x-identifiers: + - ScheduledActionName - AutoScalingGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name, + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' + AND region = 'us-east-1' + warm_pools: + name: warm_pools + id: awscc.autoscaling.warm_pools + x-cfn-schema-name: WarmPool + x-cfn-type-name: AWS::AutoScaling::WarmPool + x-identifiers: + - AutoScalingGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WarmPool&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::WarmPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::WarmPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::AutoScaling::WarmPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/warm_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/warm_pools/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/warm_pools/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1518,7 +3421,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1531,3 +3434,439 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::WarmPool' AND data__Identifier = '' AND region = 'us-east-1' + warm_pools_list_only: + name: warm_pools_list_only + id: awscc.autoscaling.warm_pools_list_only + x-cfn-schema-name: WarmPool + x-cfn-type-name: AWS::AutoScaling::WarmPool + x-identifiers: + - AutoScalingGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::WarmPool' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::WarmPool' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutoScalingGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutoScalingGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutoScalingGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LaunchConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLaunchConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLaunchConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LifecycleHook&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLifecycleHook + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLifecycleHookRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScalingPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScalingPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScalingPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScheduledAction&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScheduledAction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduledActionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WarmPool&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWarmPool + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWarmPoolRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/b2bi.yaml b/providers/src/awscc/v00.00.00000/services/b2bi.yaml index 30b53051..46e4a506 100644 --- a/providers/src/awscc/v00.00.00000/services/b2bi.yaml +++ b/providers/src/awscc/v00.00.00000/services/b2bi.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: B2BI - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: CapabilityConfiguration: oneOf: @@ -15,6 +395,11 @@ components: required: - Edi additionalProperties: false + CapabilityDirection: + type: string + enum: + - INBOUND + - OUTBOUND CapabilityType: type: string enum: @@ -22,6 +407,8 @@ components: EdiConfiguration: type: object properties: + CapabilityDirection: + $ref: '#/components/schemas/CapabilityDirection' Type: $ref: '#/components/schemas/EdiType' InputLocation: @@ -87,37 +474,357 @@ components: X12TransactionSet: type: string enum: + - X12_100 + - X12_101 + - X12_102 + - X12_103 + - X12_104 + - X12_105 + - X12_106 + - X12_107 + - X12_108 + - X12_109 - X12_110 + - X12_111 + - X12_112 + - X12_113 + - X12_120 + - X12_121 + - X12_124 + - X12_125 + - X12_126 + - X12_127 + - X12_128 + - X12_129 + - X12_130 + - X12_131 + - X12_132 + - X12_133 + - X12_135 + - X12_138 + - X12_139 + - X12_140 + - X12_141 + - X12_142 + - X12_143 + - X12_144 + - X12_146 + - X12_147 + - X12_148 + - X12_149 + - X12_150 + - X12_151 + - X12_152 + - X12_153 + - X12_154 + - X12_155 + - X12_157 + - X12_158 + - X12_159 + - X12_160 + - X12_161 + - X12_163 + - X12_170 + - X12_175 + - X12_176 + - X12_179 - X12_180 + - X12_185 + - X12_186 + - X12_187 + - X12_188 + - X12_189 + - X12_190 + - X12_191 + - X12_194 + - X12_195 + - X12_196 + - X12_197 + - X12_198 + - X12_199 + - X12_200 + - X12_201 + - X12_202 + - X12_203 - X12_204 + - X12_205 + - X12_206 - X12_210 + - X12_211 + - X12_212 + - X12_213 - X12_214 - X12_215 + - X12_216 + - X12_217 + - X12_218 + - X12_219 + - X12_220 + - X12_222 + - X12_223 + - X12_224 + - X12_225 + - X12_227 + - X12_228 + - X12_240 + - X12_242 + - X12_244 + - X12_245 + - X12_248 + - X12_249 + - X12_250 + - X12_251 + - X12_252 + - X12_255 + - X12_256 + - X12_259 + - X12_260 + - X12_261 + - X12_262 + - X12_263 + - X12_264 + - X12_265 + - X12_266 + - X12_267 + - X12_268 + - X12_269 + - X12_270 + - X12_271 + - X12_272 + - X12_273 + - X12_274 + - X12_275 + - X12_276 + - X12_277 + - X12_278 + - X12_280 + - X12_283 + - X12_284 + - X12_285 + - X12_286 + - X12_288 + - X12_290 + - X12_300 + - X12_301 + - X12_303 + - X12_304 + - X12_309 - X12_310 + - X12_311 + - X12_312 + - X12_313 - X12_315 + - X12_317 + - X12_319 - X12_322 + - X12_323 + - X12_324 + - X12_325 + - X12_326 + - X12_350 + - X12_352 + - X12_353 + - X12_354 + - X12_355 + - X12_356 + - X12_357 + - X12_358 + - X12_361 + - X12_362 - X12_404 - X12_410 + - X12_412 + - X12_414 + - X12_417 + - X12_418 + - X12_419 + - X12_420 + - X12_421 + - X12_422 + - X12_423 + - X12_424 + - X12_425 + - X12_426 + - X12_429 + - X12_431 + - X12_432 + - X12_433 + - X12_434 + - X12_435 + - X12_436 + - X12_437 + - X12_440 + - X12_451 + - X12_452 + - X12_453 + - X12_455 + - X12_456 + - X12_460 + - X12_463 + - X12_466 + - X12_468 + - X12_470 + - X12_475 + - X12_485 + - X12_486 + - X12_490 + - X12_492 + - X12_494 + - X12_500 + - X12_501 + - X12_503 + - X12_504 + - X12_511 + - X12_517 + - X12_521 + - X12_527 + - X12_536 + - X12_540 + - X12_561 + - X12_567 + - X12_568 + - X12_601 + - X12_602 + - X12_620 + - X12_625 + - X12_650 + - X12_715 + - X12_753 + - X12_754 + - X12_805 + - X12_806 + - X12_810 + - X12_811 + - X12_812 + - X12_813 + - X12_814 + - X12_815 + - X12_816 + - X12_818 + - X12_819 - X12_820 + - X12_821 + - X12_822 + - X12_823 - X12_824 + - X12_826 + - X12_827 + - X12_828 + - X12_829 - X12_830 + - X12_831 + - X12_832 + - X12_833 + - X12_834 + - X12_835 + - X12_836 + - X12_837 + - X12_838 + - X12_839 + - X12_840 + - X12_841 + - X12_842 + - X12_843 + - X12_844 + - X12_845 - X12_846 + - X12_847 + - X12_848 + - X12_849 - X12_850 + - X12_851 - X12_852 + - X12_853 + - X12_854 - X12_855 - X12_856 + - X12_857 + - X12_858 + - X12_859 - X12_860 - X12_861 + - X12_862 + - X12_863 - X12_864 + - X12_865 + - X12_866 + - X12_867 + - X12_868 + - X12_869 + - X12_870 + - X12_871 + - X12_872 + - X12_873 + - X12_874 + - X12_875 + - X12_876 + - X12_877 + - X12_878 + - X12_879 + - X12_880 + - X12_881 + - X12_882 + - X12_883 + - X12_884 + - X12_885 + - X12_886 + - X12_887 + - X12_888 + - X12_889 + - X12_891 + - X12_893 + - X12_894 + - X12_895 + - X12_896 + - X12_920 + - X12_924 + - X12_925 + - X12_926 + - X12_928 - X12_940 + - X12_943 + - X12_944 + - X12_945 + - X12_947 + - X12_980 - X12_990 + - X12_993 + - X12_996 - X12_997 + - X12_998 + - X12_999 + - X12_270_X279 + - X12_271_X279 + - X12_275_X210 + - X12_275_X211 + - X12_276_X212 + - X12_277_X212 + - X12_277_X214 + - X12_277_X364 + - X12_278_X217 + - X12_820_X218 + - X12_820_X306 + - X12_824_X186 + - X12_834_X220 + - X12_834_X307 + - X12_834_X318 + - X12_835_X221 + - X12_837_X222 + - X12_837_X223 + - X12_837_X224 + - X12_837_X291 + - X12_837_X292 + - X12_837_X298 + - X12_999_X231 X12Version: type: string enum: - VERSION_4010 - VERSION_4030 + - VERSION_4050 + - VERSION_4060 - VERSION_5010 + - VERSION_5010_HIPAA Capability: type: object properties: @@ -161,7 +868,9 @@ components: - Name - Type x-stackql-resource-name: capability - x-stackql-primaryIdentifier: + description: Definition of AWS::B2BI::Capability Resource Type + x-type-name: AWS::B2BI::Capability + x-stackql-primary-identifier: - CapabilityId x-create-only-properties: - Type @@ -170,6 +879,20 @@ components: - CapabilityId - CreatedAt - ModifiedAt + x-required-properties: + - Configuration + - Name + - Type + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - b2bi:ListTagsForResource + - b2bi:TagResource + - b2bi:UntagResource x-required-permissions: create: - b2bi:CreateCapability @@ -199,6 +922,203 @@ components: - b2bi:DeleteCapability list: - b2bi:ListCapabilities + CapabilityOptions: + type: object + properties: + OutboundEdi: + $ref: '#/components/schemas/OutboundEdiOptions' + InboundEdi: + $ref: '#/components/schemas/InboundEdiOptions' + additionalProperties: false + InboundEdiOptions: + type: object + properties: + X12: + $ref: '#/components/schemas/X12InboundEdiOptions' + additionalProperties: false + LineTerminator: + type: string + enum: + - CRLF + - LF + - CR + OutboundEdiOptions: + oneOf: + - type: object + title: X12 + properties: + X12: + $ref: '#/components/schemas/X12Envelope' + required: + - X12 + additionalProperties: false + WrapFormat: + type: string + enum: + - SEGMENT + - ONE_LINE + - LINE_LENGTH + WrapOptions: + type: object + properties: + WrapBy: + $ref: '#/components/schemas/WrapFormat' + LineTerminator: + $ref: '#/components/schemas/LineTerminator' + LineLength: + type: number + minimum: 1 + additionalProperties: false + X12AcknowledgmentOptions: + type: object + properties: + FunctionalAcknowledgment: + $ref: '#/components/schemas/X12FunctionalAcknowledgment' + TechnicalAcknowledgment: + $ref: '#/components/schemas/X12TechnicalAcknowledgment' + required: + - FunctionalAcknowledgment + - TechnicalAcknowledgment + additionalProperties: false + X12ControlNumbers: + type: object + properties: + StartingInterchangeControlNumber: + type: number + maximum: 999999999 + minimum: 1 + StartingFunctionalGroupControlNumber: + type: number + maximum: 999999999 + minimum: 1 + StartingTransactionSetControlNumber: + type: number + maximum: 999999999 + minimum: 1 + additionalProperties: false + X12Delimiters: + type: object + properties: + ComponentSeparator: + type: string + maxLength: 1 + minLength: 1 + pattern: ^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$ + DataElementSeparator: + type: string + maxLength: 1 + minLength: 1 + pattern: ^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$ + SegmentTerminator: + type: string + maxLength: 1 + minLength: 1 + pattern: ^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$ + additionalProperties: false + X12Envelope: + type: object + properties: + Common: + $ref: '#/components/schemas/X12OutboundEdiHeaders' + WrapOptions: + $ref: '#/components/schemas/WrapOptions' + additionalProperties: false + X12FunctionalAcknowledgment: + type: string + enum: + - DO_NOT_GENERATE + - GENERATE_ALL_SEGMENTS + - GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP + X12FunctionalGroupHeaders: + type: object + properties: + ApplicationSenderCode: + type: string + maxLength: 15 + minLength: 2 + pattern: ^[a-zA-Z0-9 ]*$ + ApplicationReceiverCode: + type: string + maxLength: 15 + minLength: 2 + pattern: ^[a-zA-Z0-9 ]*$ + ResponsibleAgencyCode: + type: string + maxLength: 2 + minLength: 1 + pattern: ^[a-zA-Z0-9]*$ + additionalProperties: false + X12GS05TimeFormat: + type: string + enum: + - HHMM + - HHMMSS + - HHMMSSDD + X12InboundEdiOptions: + type: object + properties: + AcknowledgmentOptions: + $ref: '#/components/schemas/X12AcknowledgmentOptions' + additionalProperties: false + X12InterchangeControlHeaders: + type: object + properties: + SenderIdQualifier: + type: string + maxLength: 2 + minLength: 2 + pattern: ^[a-zA-Z0-9]*$ + SenderId: + type: string + maxLength: 15 + minLength: 15 + pattern: ^[a-zA-Z0-9 ]*$ + ReceiverIdQualifier: + type: string + maxLength: 2 + minLength: 2 + pattern: ^[a-zA-Z0-9]*$ + ReceiverId: + type: string + maxLength: 15 + minLength: 15 + pattern: ^[a-zA-Z0-9 ]*$ + RepetitionSeparator: + type: string + maxLength: 1 + minLength: 1 + AcknowledgmentRequestedCode: + type: string + maxLength: 1 + minLength: 1 + pattern: ^[a-zA-Z0-9]*$ + UsageIndicatorCode: + type: string + maxLength: 1 + minLength: 1 + pattern: ^[a-zA-Z0-9]*$ + additionalProperties: false + X12OutboundEdiHeaders: + type: object + properties: + InterchangeControlHeaders: + $ref: '#/components/schemas/X12InterchangeControlHeaders' + FunctionalGroupHeaders: + $ref: '#/components/schemas/X12FunctionalGroupHeaders' + Delimiters: + $ref: '#/components/schemas/X12Delimiters' + ValidateEdi: + type: boolean + ControlNumbers: + $ref: '#/components/schemas/X12ControlNumbers' + Gs05TimeFormat: + $ref: '#/components/schemas/X12GS05TimeFormat' + additionalProperties: false + X12TechnicalAcknowledgment: + type: string + enum: + - DO_NOT_GENERATE + - GENERATE_ALL_SEGMENTS Partnership: type: object properties: @@ -209,6 +1129,8 @@ components: maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_-]+$ + CapabilityOptions: + $ref: '#/components/schemas/CapabilityOptions' CreatedAt: type: string format: date-time @@ -255,11 +1177,14 @@ components: minLength: 1 pattern: ^[a-zA-Z0-9_-]+$ required: + - Capabilities - Email - Name - ProfileId x-stackql-resource-name: partnership - x-stackql-primaryIdentifier: + description: Definition of AWS::B2BI::Partnership Resource Type + x-type-name: AWS::B2BI::Partnership + x-stackql-primary-identifier: - PartnershipId x-create-only-properties: - Email @@ -271,6 +1196,21 @@ components: - PartnershipArn - PartnershipId - TradingPartnerId + x-required-properties: + - Capabilities + - Email + - Name + - ProfileId + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - b2bi:ListTagsForResource + - b2bi:TagResource + - b2bi:UntagResource x-required-permissions: create: - b2bi:CreatePartnership @@ -346,7 +1286,9 @@ components: - Name - Phone x-stackql-resource-name: profile - x-stackql-primaryIdentifier: + description: Definition of AWS::B2BI::Profile Resource Type + x-type-name: AWS::B2BI::Profile + x-stackql-primary-identifier: - ProfileId x-create-only-properties: - Logging @@ -356,6 +1298,21 @@ components: - ModifiedAt - ProfileArn - ProfileId + x-required-properties: + - BusinessName + - Logging + - Name + - Phone + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - b2bi:ListTagsForResource + - b2bi:TagResource + - b2bi:UntagResource x-required-permissions: create: - b2bi:CreateProfile @@ -382,16 +1339,219 @@ components: - logs:ListLogDeliveries list: - b2bi:ListProfiles + AdvancedOptions: + type: object + properties: + X12: + $ref: '#/components/schemas/X12AdvancedOptions' + additionalProperties: false + ElementRequirement: + type: string + enum: + - OPTIONAL + - MANDATORY FileFormat: type: string enum: - XML - JSON + - NOT_USED + FormatOptions: + oneOf: + - type: object + title: X12 + properties: + X12: + $ref: '#/components/schemas/X12Details' + required: + - X12 + additionalProperties: false + FromFormat: + type: string + enum: + - X12 + InputConversion: + type: object + properties: + FromFormat: + $ref: '#/components/schemas/FromFormat' + FormatOptions: + $ref: '#/components/schemas/FormatOptions' + AdvancedOptions: + $ref: '#/components/schemas/AdvancedOptions' + required: + - FromFormat + additionalProperties: false + Mapping: + type: object + properties: + TemplateLanguage: + $ref: '#/components/schemas/MappingTemplateLanguage' + Template: + type: string + maxLength: 350000 + minLength: 0 + required: + - TemplateLanguage + additionalProperties: false + MappingTemplateLanguage: + type: string + enum: + - XSLT + - JSONATA + OutputConversion: + type: object + properties: + ToFormat: + $ref: '#/components/schemas/ToFormat' + FormatOptions: + $ref: '#/components/schemas/FormatOptions' + AdvancedOptions: + $ref: '#/components/schemas/AdvancedOptions' + required: + - ToFormat + additionalProperties: false + SampleDocumentKeys: + type: object + properties: + Input: + type: string + maxLength: 1024 + minLength: 0 + Output: + type: string + maxLength: 1024 + minLength: 0 + additionalProperties: false + SampleDocuments: + type: object + properties: + BucketName: + type: string + maxLength: 63 + minLength: 3 + Keys: + type: array + items: + $ref: '#/components/schemas/SampleDocumentKeys' + required: + - BucketName + - Keys + additionalProperties: false + ToFormat: + type: string + enum: + - X12 TransformerStatus: type: string enum: - active - inactive + X12AdvancedOptions: + type: object + properties: + SplitOptions: + $ref: '#/components/schemas/X12SplitOptions' + ValidationOptions: + $ref: '#/components/schemas/X12ValidationOptions' + additionalProperties: false + X12CodeListValidationRule: + type: object + properties: + ElementId: + type: string + maxLength: 4 + minLength: 4 + pattern: ^[0-9]{4}$ + CodesToAdd: + type: array + items: + type: string + CodesToRemove: + type: array + items: + type: string + required: + - ElementId + additionalProperties: false + X12ElementLengthValidationRule: + type: object + properties: + ElementId: + type: string + maxLength: 4 + minLength: 4 + pattern: ^[0-9]{4}$ + MaxLength: + type: number + maximum: 1000000 + minimum: 1 + MinLength: + type: number + maximum: 1000000 + minimum: 1 + required: + - ElementId + - MaxLength + - MinLength + additionalProperties: false + X12ElementRequirementValidationRule: + type: object + properties: + ElementPosition: + type: string + pattern: ^[a-zA-Z0-9]+(?:-\d{2})(?:-\d{2})?$ + Requirement: + $ref: '#/components/schemas/ElementRequirement' + required: + - ElementPosition + - Requirement + additionalProperties: false + X12SplitBy: + type: string + enum: + - NONE + - TRANSACTION + X12SplitOptions: + type: object + properties: + SplitBy: + $ref: '#/components/schemas/X12SplitBy' + additionalProperties: false + X12ValidationOptions: + type: object + properties: + ValidationRules: + type: array + items: + $ref: '#/components/schemas/X12ValidationRule' + additionalProperties: false + X12ValidationRule: + oneOf: + - type: object + title: CodeListValidationRule + properties: + CodeListValidationRule: + $ref: '#/components/schemas/X12CodeListValidationRule' + required: + - CodeListValidationRule + additionalProperties: false + - type: object + title: ElementLengthValidationRule + properties: + ElementLengthValidationRule: + $ref: '#/components/schemas/X12ElementLengthValidationRule' + required: + - ElementLengthValidationRule + additionalProperties: false + - type: object + title: ElementRequirementValidationRule + properties: + ElementRequirementValidationRule: + $ref: '#/components/schemas/X12ElementRequirementValidationRule' + required: + - ElementRequirementValidationRule + additionalProperties: false Transformer: type: object properties: @@ -402,10 +1562,15 @@ components: $ref: '#/components/schemas/EdiType' FileFormat: $ref: '#/components/schemas/FileFormat' + InputConversion: + $ref: '#/components/schemas/InputConversion' + Mapping: + $ref: '#/components/schemas/Mapping' MappingTemplate: type: string maxLength: 350000 minLength: 0 + description: 'This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.' ModifiedAt: type: string format: date-time @@ -413,10 +1578,16 @@ components: type: string maxLength: 254 minLength: 1 + pattern: ^[a-zA-Z0-9_-]{1,512}$ + OutputConversion: + $ref: '#/components/schemas/OutputConversion' SampleDocument: type: string maxLength: 1024 minLength: 0 + description: 'This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.' + SampleDocuments: + $ref: '#/components/schemas/SampleDocuments' Status: $ref: '#/components/schemas/TransformerStatus' Tags: @@ -435,19 +1606,31 @@ components: minLength: 1 pattern: ^[a-zA-Z0-9_-]+$ required: - - EdiType - - FileFormat - - MappingTemplate - Name - Status x-stackql-resource-name: transformer - x-stackql-primaryIdentifier: + description: Definition of AWS::B2BI::Transformer Resource Type + x-type-name: AWS::B2BI::Transformer + x-stackql-primary-identifier: - TransformerId x-read-only-properties: - CreatedAt - ModifiedAt - TransformerArn - TransformerId + x-required-properties: + - Name + - Status + x-tagging: + cloudFormationSystemTags: true + permissions: + - b2bi:ListTagsForResource + - b2bi:TagResource + - b2bi:UntagResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true x-required-permissions: create: - b2bi:CreateTransformer @@ -475,43 +1658,325 @@ components: - logs:ListLogDeliveries list: - b2bi:ListTransformers + CreateCapabilityRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CapabilityArn: + type: string + maxLength: 255 + minLength: 1 + CapabilityId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Configuration: + $ref: '#/components/schemas/CapabilityConfiguration' + CreatedAt: + type: string + format: date-time + InstructionsDocuments: + type: array + items: + $ref: '#/components/schemas/S3Location' + maxItems: 5 + minItems: 0 + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 254 + minLength: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/CapabilityType' + x-stackQL-stringOnly: true + x-title: CreateCapabilityRequest + type: object + required: [] + CreatePartnershipRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Capabilities: + type: array + items: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + CapabilityOptions: + $ref: '#/components/schemas/CapabilityOptions' + CreatedAt: + type: string + format: date-time + Email: + type: string + maxLength: 254 + minLength: 5 + pattern: ^[\w\.\-]+@[\w\.\-]+$ + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 254 + minLength: 1 + PartnershipArn: + type: string + maxLength: 255 + minLength: 1 + PartnershipId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Phone: + type: string + maxLength: 22 + minLength: 7 + pattern: ^\+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?$ + ProfileId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + TradingPartnerId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + x-stackQL-stringOnly: true + x-title: CreatePartnershipRequest + type: object + required: [] + CreateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BusinessName: + type: string + maxLength: 254 + minLength: 1 + CreatedAt: + type: string + format: date-time + Email: + type: string + maxLength: 254 + minLength: 5 + pattern: ^[\w\.\-]+@[\w\.\-]+$ + LogGroupName: + type: string + maxLength: 512 + minLength: 1 + Logging: + $ref: '#/components/schemas/Logging' + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 254 + minLength: 1 + Phone: + type: string + maxLength: 22 + minLength: 7 + pattern: ^\+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?$ + ProfileArn: + type: string + maxLength: 255 + minLength: 1 + ProfileId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateProfileRequest + type: object + required: [] + CreateTransformerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + type: string + format: date-time + EdiType: + $ref: '#/components/schemas/EdiType' + FileFormat: + $ref: '#/components/schemas/FileFormat' + InputConversion: + $ref: '#/components/schemas/InputConversion' + Mapping: + $ref: '#/components/schemas/Mapping' + MappingTemplate: + type: string + maxLength: 350000 + minLength: 0 + description: 'This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.' + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 254 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]{1,512}$ + OutputConversion: + $ref: '#/components/schemas/OutputConversion' + SampleDocument: + type: string + maxLength: 1024 + minLength: 0 + description: 'This shape is deprecated: This is a legacy trait. Please use input-conversion or output-conversion.' + SampleDocuments: + $ref: '#/components/schemas/SampleDocuments' + Status: + $ref: '#/components/schemas/TransformerStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + TransformerArn: + type: string + maxLength: 255 + minLength: 1 + TransformerId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + x-stackQL-stringOnly: true + x-title: CreateTransformerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: capabilities: name: capabilities id: awscc.b2bi.capabilities x-cfn-schema-name: Capability - x-type: list - x-identifiers: - - CapabilityId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CapabilityId') as capability_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CapabilityId') as capability_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' - AND region = 'us-east-1' - capability: - name: capability - id: awscc.b2bi.capability - x-cfn-schema-name: Capability - x-type: get + x-cfn-type-name: AWS::B2BI::Capability x-identifiers: - CapabilityId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Capability&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Capability" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Capability" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Capability" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -529,7 +1994,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -546,13 +2011,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Capability' AND data__Identifier = '' AND region = 'us-east-1' - partnerships: - name: partnerships - id: awscc.b2bi.partnerships - x-cfn-schema-name: Partnership - x-type: list + capabilities_list_only: + name: capabilities_list_only + id: awscc.b2bi.capabilities_list_only + x-cfn-schema-name: Capability + x-cfn-type-name: AWS::B2BI::Capability x-identifiers: - - PartnershipId + - CapabilityId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -560,33 +2031,82 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PartnershipId') as partnership_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' + JSON_EXTRACT(Properties, '$.CapabilityId') as capability_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PartnershipId') as partnership_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' + json_extract_path_text(Properties, 'CapabilityId') as capability_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' AND region = 'us-east-1' - partnership: - name: partnership - id: awscc.b2bi.partnership + partnerships: + name: partnerships + id: awscc.b2bi.partnerships x-cfn-schema-name: Partnership - x-type: get + x-cfn-type-name: AWS::B2BI::Partnership x-identifiers: - PartnershipId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Partnership&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Partnership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Partnership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Partnership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/partnerships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/partnerships/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/partnerships/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Capabilities') as capabilities, + JSON_EXTRACT(Properties, '$.CapabilityOptions') as capability_options, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.Email') as email, JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, @@ -601,12 +2121,13 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'CapabilityOptions') as capability_options, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'Email') as email, json_extract_path_text(Properties, 'ModifiedAt') as modified_at, @@ -620,13 +2141,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Partnership' AND data__Identifier = '' AND region = 'us-east-1' - profiles: - name: profiles - id: awscc.b2bi.profiles - x-cfn-schema-name: Profile - x-type: list + partnerships_list_only: + name: partnerships_list_only + id: awscc.b2bi.partnerships_list_only + x-cfn-schema-name: Partnership + x-cfn-type-name: AWS::B2BI::Partnership x-identifiers: - - ProfileId + - PartnershipId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -634,28 +2161,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' + JSON_EXTRACT(Properties, '$.PartnershipId') as partnership_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProfileId') as profile_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' + json_extract_path_text(Properties, 'PartnershipId') as partnership_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' AND region = 'us-east-1' - profile: - name: profile - id: awscc.b2bi.profile + profiles: + name: profiles + id: awscc.b2bi.profiles x-cfn-schema-name: Profile - x-type: get + x-cfn-type-name: AWS::B2BI::Profile x-identifiers: - ProfileId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -675,7 +2250,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -694,13 +2269,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Profile' AND data__Identifier = '' AND region = 'us-east-1' - transformers: - name: transformers - id: awscc.b2bi.transformers - x-cfn-schema-name: Transformer - x-type: list + profiles_list_only: + name: profiles_list_only + id: awscc.b2bi.profiles_list_only + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::B2BI::Profile x-identifiers: - - TransformerId + - ProfileId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -708,28 +2289,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TransformerId') as transformer_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransformerId') as transformer_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' AND region = 'us-east-1' - transformer: - name: transformer - id: awscc.b2bi.transformer + transformers: + name: transformers + id: awscc.b2bi.transformers x-cfn-schema-name: Transformer - x-type: get + x-cfn-type-name: AWS::B2BI::Transformer x-identifiers: - TransformerId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Transformer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Transformer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Transformer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::B2BI::Transformer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transformers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transformers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transformers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -737,10 +2366,14 @@ components: JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.EdiType') as edi_type, JSON_EXTRACT(Properties, '$.FileFormat') as file_format, + JSON_EXTRACT(Properties, '$.InputConversion') as input_conversion, + JSON_EXTRACT(Properties, '$.Mapping') as mapping, JSON_EXTRACT(Properties, '$.MappingTemplate') as mapping_template, JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OutputConversion') as output_conversion, JSON_EXTRACT(Properties, '$.SampleDocument') as sample_document, + JSON_EXTRACT(Properties, '$.SampleDocuments') as sample_documents, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.TransformerArn') as transformer_arn, @@ -749,7 +2382,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -757,10 +2390,14 @@ components: json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'EdiType') as edi_type, json_extract_path_text(Properties, 'FileFormat') as file_format, + json_extract_path_text(Properties, 'InputConversion') as input_conversion, + json_extract_path_text(Properties, 'Mapping') as mapping, json_extract_path_text(Properties, 'MappingTemplate') as mapping_template, json_extract_path_text(Properties, 'ModifiedAt') as modified_at, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OutputConversion') as output_conversion, json_extract_path_text(Properties, 'SampleDocument') as sample_document, + json_extract_path_text(Properties, 'SampleDocuments') as sample_documents, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'TransformerArn') as transformer_arn, @@ -768,3 +2405,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Transformer' AND data__Identifier = '' AND region = 'us-east-1' + transformers_list_only: + name: transformers_list_only + id: awscc.b2bi.transformers_list_only + x-cfn-schema-name: Transformer + x-cfn-type-name: AWS::B2BI::Transformer + x-identifiers: + - TransformerId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TransformerId') as transformer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransformerId') as transformer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Capability&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCapability + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCapabilityRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Partnership&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePartnership + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePartnershipRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Transformer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransformer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransformerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/backup.yaml b/providers/src/awscc/v00.00.00000/services/backup.yaml index af4214c3..da5ceb02 100644 --- a/providers/src/awscc/v00.00.00000/services/backup.yaml +++ b/providers/src/awscc/v00.00.00000/services/backup.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Backup - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: BackupPlanResourceType: type: object @@ -42,6 +422,12 @@ components: type: string ScheduleExpressionTimezone: type: string + IndexActions: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/IndexActionsResourceType' RecoveryPointTags: type: object additionalProperties: false @@ -82,6 +468,20 @@ components: type: string required: - DestinationBackupVaultArn + IndexActionsResourceType: + type: object + additionalProperties: false + properties: + ResourceTypes: + $ref: '#/components/schemas/ResourceTypes' + ResourceTypes: + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/ResourceType' + ResourceType: + type: string LifecycleResourceType: type: object additionalProperties: false @@ -112,12 +512,26 @@ components: required: - BackupPlan x-stackql-resource-name: backup_plan - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Backup::BackupPlan + x-type-name: AWS::Backup::BackupPlan + x-stackql-primary-identifier: - BackupPlanId x-read-only-properties: - BackupPlanId - VersionId - BackupPlanArn + x-required-properties: + - BackupPlan + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/BackupPlanTags + permissions: + - backup:TagResource + - backup:UntagResource + - backup:ListTags x-required-permissions: read: - backup:GetBackupPlan @@ -230,7 +644,9 @@ components: - BackupSelection - BackupPlanId x-stackql-resource-name: backup_selection - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Backup::BackupSelection + x-type-name: AWS::Backup::BackupSelection + x-stackql-primary-identifier: - Id x-create-only-properties: - BackupSelection @@ -238,6 +654,14 @@ components: x-read-only-properties: - SelectionId - Id + x-required-properties: + - BackupSelection + - BackupPlanId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: delete: - backup:GetBackupSelection @@ -251,18 +675,19 @@ components: - iam:CreateServiceLinkedRole list: - backup:ListBackupSelections + - backup:ListBackupPlans NotificationObjectType: - type: object additionalProperties: false + type: object properties: + SNSTopicArn: + type: string BackupVaultEvents: - type: array - x-insertionOrder: false uniqueItems: false + x-insertionOrder: false + type: array items: type: string - SNSTopicArn: - type: string required: - SNSTopicArn - BackupVaultEvents @@ -279,8 +704,8 @@ components: required: - MinRetentionDays BackupVaultNamePattern: - type: string pattern: ^[a-zA-Z0-9\-\_]{2,50}$ + type: string BackupVault: type: object properties: @@ -305,13 +730,29 @@ components: required: - BackupVaultName x-stackql-resource-name: backup_vault - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Backup::BackupVault + x-type-name: AWS::Backup::BackupVault + x-stackql-primary-identifier: - BackupVaultName x-create-only-properties: - BackupVaultName - EncryptionKeyArn + x-write-only-properties: + - LockConfiguration/ChangeableForDays x-read-only-properties: - BackupVaultArn + x-required-properties: + - BackupVaultName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/BackupVaultTags + permissions: + - backup:TagResource + - backup:UntagResource + - backup:ListTags x-required-permissions: create: - backup:TagResource @@ -397,19 +838,19 @@ components: - ParameterName - ParameterValue Tag: - type: object additionalProperties: false + type: object properties: - Key: - type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 1 - maxLength: 128 Value: - type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' minLength: 0 + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string maxLength: 256 + Key: + minLength: 1 + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + maxLength: 128 required: - Key - Value @@ -464,7 +905,9 @@ components: required: - FrameworkControls x-stackql-resource-name: framework - x-stackql-primaryIdentifier: + description: Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results. + x-type-name: AWS::Backup::Framework + x-stackql-primary-identifier: - FrameworkArn x-create-only-properties: - FrameworkName @@ -473,6 +916,18 @@ components: - CreationTime - FrameworkStatus - DeploymentStatus + x-required-properties: + - FrameworkControls + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/FrameworkTags + permissions: + - backup:TagResource + - backup:UntagResource + - backup:ListTags x-required-permissions: create: - backup:CreateFramework @@ -494,6 +949,95 @@ components: - backup:DescribeFramework list: - backup:ListFrameworks + LogicallyAirGappedBackupVault: + type: object + properties: + VaultState: + type: string + BackupVaultTags: + x-patternProperties: + ^.{1,128}$: + type: string + additionalProperties: false + type: object + VaultType: + type: string + BackupVaultName: + $ref: '#/components/schemas/BackupVaultNamePattern' + BackupVaultArn: + type: string + EncryptionKeyArn: + type: string + MaxRetentionDays: + type: integer + MinRetentionDays: + type: integer + Notifications: + $ref: '#/components/schemas/NotificationObjectType' + AccessPolicy: + type: object + required: + - BackupVaultName + - MinRetentionDays + - MaxRetentionDays + x-stackql-resource-name: logically_air_gapped_backup_vault + description: Resource Type definition for AWS::Backup::LogicallyAirGappedBackupVault + x-type-name: AWS::Backup::LogicallyAirGappedBackupVault + x-stackql-primary-identifier: + - BackupVaultName + x-create-only-properties: + - BackupVaultName + - MinRetentionDays + - MaxRetentionDays + x-read-only-properties: + - BackupVaultArn + - EncryptionKeyArn + - VaultState + - VaultType + x-required-properties: + - BackupVaultName + - MinRetentionDays + - MaxRetentionDays + x-tagging: + permissions: + - backup:TagResource + - backup:UntagResource + - backup:ListTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/BackupVaultTags + cloudFormationSystemTags: true + x-required-permissions: + read: + - backup:DescribeBackupVault + - backup:GetBackupVaultNotifications + - backup:GetBackupVaultAccessPolicy + - backup:ListTags + create: + - backup:TagResource + - backup:CreateLogicallyAirGappedBackupVault + - backup:PutBackupVaultAccessPolicy + - backup:PutBackupVaultNotifications + - backup-storage:Mount + - backup-storage:MountCapsule + - backup:DescribeBackupVault + update: + - backup:DescribeBackupVault + - backup:DeleteBackupVaultAccessPolicy + - backup:DeleteBackupVaultNotifications + - backup:DeleteBackupVaultLockConfiguration + - backup:GetBackupVaultAccessPolicy + - backup:ListTags + - backup:TagResource + - backup:UntagResource + - backup:PutBackupVaultAccessPolicy + - backup:PutBackupVaultNotifications + - backup:PutBackupVaultLockConfiguration + list: + - backup:ListBackupVaults + delete: + - backup:DeleteBackupVault ReportPlan: type: object properties: @@ -580,12 +1124,27 @@ components: - ReportDeliveryChannel - ReportSetting x-stackql-resource-name: report_plan - x-stackql-primaryIdentifier: + description: Contains detailed information about a report plan in AWS Backup Audit Manager. + x-type-name: AWS::Backup::ReportPlan + x-stackql-primary-identifier: - ReportPlanArn x-create-only-properties: - ReportPlanName x-read-only-properties: - ReportPlanArn + x-required-properties: + - ReportDeliveryChannel + - ReportSetting + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/ReportPlanTags + permissions: + - backup:TagResource + - backup:UntagResource + - backup:ListTags x-required-permissions: create: - backup:CreateReportPlan @@ -608,28 +1167,28 @@ components: list: - backup:ListReportPlans RestoreTestingRecoveryPointSelection: - type: object additionalProperties: false + type: object properties: - Algorithm: - $ref: '#/components/schemas/RestoreTestingRecoveryPointSelectionAlgorithm' SelectionWindowDays: type: integer RecoveryPointTypes: - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/RestoreTestingRecoveryPointType' IncludeVaults: - type: array x-insertionOrder: false + type: array items: type: string ExcludeVaults: - type: array x-insertionOrder: false + type: array items: type: string + Algorithm: + $ref: '#/components/schemas/RestoreTestingRecoveryPointSelectionAlgorithm' required: - Algorithm - RecoveryPointTypes @@ -647,55 +1206,71 @@ components: RestoreTestingPlan: type: object properties: + ScheduleExpression: + type: string + StartWindowHours: + type: integer RecoveryPointSelection: $ref: '#/components/schemas/RestoreTestingRecoveryPointSelection' RestoreTestingPlanArn: type: string RestoreTestingPlanName: type: string - ScheduleExpression: - type: string ScheduleExpressionTimezone: type: string - StartWindowHours: - type: integer Tags: + uniqueItems: true + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - type: array - x-insertionOrder: false - uniqueItems: true required: - RecoveryPointSelection - ScheduleExpression - RestoreTestingPlanName x-stackql-resource-name: restore_testing_plan - x-stackql-primaryIdentifier: + description: Definition of AWS::Backup::RestoreTestingPlan Resource Type + x-type-name: AWS::Backup::RestoreTestingPlan + x-stackql-primary-identifier: - RestoreTestingPlanName x-create-only-properties: - RestoreTestingPlanName x-read-only-properties: - RestoreTestingPlanArn + x-required-properties: + - RecoveryPointSelection + - ScheduleExpression + - RestoreTestingPlanName + x-tagging: + permissions: + - backup:TagResource + - backup:UntagResource + - backup:ListTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - backup:GetRestoreTestingPlan + - backup:ListTags create: - backup:CreateRestoreTestingPlan - backup:TagResource - backup:GetRestoreTestingPlan - backup:ListTags - read: - - backup:GetRestoreTestingPlan - - backup:ListTags update: - backup:UpdateRestoreTestingPlan - backup:TagResource - backup:UntagResource - backup:GetRestoreTestingPlan - backup:ListTags + list: + - backup:ListRestoreTestingPlans delete: - backup:DeleteRestoreTestingPlan - backup:GetRestoreTestingPlan - list: - - backup:ListRestoreTestingPlans KeyValue: additionalProperties: false properties: @@ -755,13 +1330,26 @@ components: - RestoreTestingPlanName - RestoreTestingSelectionName x-stackql-resource-name: restore_testing_selection - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Backup::RestoreTestingSelection + x-type-name: AWS::Backup::RestoreTestingSelection + x-stackql-primary-identifier: - RestoreTestingPlanName - RestoreTestingSelectionName x-create-only-properties: - ProtectedResourceType - RestoreTestingPlanName - RestoreTestingSelectionName + x-required-properties: + - IamRoleArn + - ProtectedResourceType + - RestoreTestingPlanName + - RestoreTestingSelectionName + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - backup:CreateRestoreTestingSelection @@ -778,43 +1366,435 @@ components: - backup:GetRestoreTestingSelection list: - backup:ListRestoreTestingSelections - x-stackQL-resources: - backup_plans: - name: backup_plans - id: awscc.backup.backup_plans - x-cfn-schema-name: BackupPlan - x-type: list - x-identifiers: - - BackupPlanId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BackupPlanId') as backup_plan_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' - AND region = 'us-east-1' - backup_plan: - name: backup_plan - id: awscc.backup.backup_plan + - backup:ListRestoreTestingPlans + CreateBackupPlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BackupPlan: + $ref: '#/components/schemas/BackupPlanResourceType' + BackupPlanTags: + type: object + additionalProperties: false + x-patternProperties: + ^.{1,128}$: + type: string + BackupPlanArn: + type: string + BackupPlanId: + type: string + VersionId: + type: string + x-stackQL-stringOnly: true + x-title: CreateBackupPlanRequest + type: object + required: [] + CreateBackupSelectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + BackupPlanId: + type: string + BackupSelection: + $ref: '#/components/schemas/BackupSelectionResourceType' + SelectionId: + type: string + x-stackQL-stringOnly: true + x-title: CreateBackupSelectionRequest + type: object + required: [] + CreateBackupVaultRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessPolicy: + type: object + BackupVaultName: + $ref: '#/components/schemas/BackupVaultNamePattern' + BackupVaultTags: + type: object + additionalProperties: false + x-patternProperties: + ^.{1,128}$: + type: string + EncryptionKeyArn: + type: string + Notifications: + $ref: '#/components/schemas/NotificationObjectType' + LockConfiguration: + $ref: '#/components/schemas/LockConfigurationType' + BackupVaultArn: + type: string + x-stackQL-stringOnly: true + x-title: CreateBackupVaultRequest + type: object + required: [] + CreateFrameworkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FrameworkName: + description: The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). + type: string + pattern: '[a-zA-Z][_a-zA-Z0-9]*' + minLength: 1 + maxLength: 256 + FrameworkDescription: + description: An optional description of the framework with a maximum 1,024 characters. + type: string + minLength: 0 + maxLength: 1024 + FrameworkArn: + description: An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource + type: string + DeploymentStatus: + description: 'The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`' + type: string + CreationTime: + description: The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC. + type: string + FrameworkControls: + description: Contains detailed information about all of the controls of a framework. Each framework must contain at least one control. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/FrameworkControl' + FrameworkStatus: + type: string + description: |- + A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are: + + `ACTIVE` when recording is turned on for all resources governed by the framework. + + `PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework. + + `INACTIVE` when recording is turned off for all resources governed by the framework. + + `UNAVAILABLE` when AWS Backup is unable to validate recording status at this time. + FrameworkTags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + description: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. + x-stackQL-stringOnly: true + x-title: CreateFrameworkRequest + type: object + required: [] + CreateLogicallyAirGappedBackupVaultRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VaultState: + type: string + BackupVaultTags: + x-patternProperties: + ^.{1,128}$: + type: string + additionalProperties: false + type: object + VaultType: + type: string + BackupVaultName: + $ref: '#/components/schemas/BackupVaultNamePattern' + BackupVaultArn: + type: string + EncryptionKeyArn: + type: string + MaxRetentionDays: + type: integer + MinRetentionDays: + type: integer + Notifications: + $ref: '#/components/schemas/NotificationObjectType' + AccessPolicy: + type: object + x-stackQL-stringOnly: true + x-title: CreateLogicallyAirGappedBackupVaultRequest + type: object + required: [] + CreateReportPlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ReportPlanName: + type: string + description: The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z][_a-zA-Z0-9]*' + ReportPlanArn: + type: string + description: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. + ReportPlanDescription: + type: string + description: An optional description of the report plan with a maximum of 1,024 characters. + minLength: 0 + maxLength: 1024 + pattern: .*\S.* + ReportPlanTags: + description: Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + ReportDeliveryChannel: + type: object + description: A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. + properties: + Formats: + type: array + description: 'A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.' + uniqueItems: true + x-insertionOrder: false + items: + type: string + S3BucketName: + type: string + description: The unique name of the S3 bucket that receives your reports. + S3KeyPrefix: + type: string + description: 'The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.' + additionalProperties: false + required: + - S3BucketName + ReportSetting: + type: object + description: Identifies the report template for the report. Reports are built using a report template. + properties: + ReportTemplate: + type: string + description: 'Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`' + FrameworkArns: + type: array + description: The Amazon Resource Names (ARNs) of the frameworks a report covers. + x-insertionOrder: false + uniqueItems: true + items: + type: string + Accounts: + type: array + description: The list of AWS accounts that a report covers. + x-insertionOrder: false + uniqueItems: true + items: + type: string + OrganizationUnits: + type: array + description: The list of AWS organization units that a report covers. + x-insertionOrder: false + uniqueItems: true + items: + type: string + Regions: + type: array + description: The list of AWS regions that a report covers. + x-insertionOrder: false + uniqueItems: true + items: + type: string + additionalProperties: false + required: + - ReportTemplate + x-stackQL-stringOnly: true + x-title: CreateReportPlanRequest + type: object + required: [] + CreateRestoreTestingPlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScheduleExpression: + type: string + StartWindowHours: + type: integer + RecoveryPointSelection: + $ref: '#/components/schemas/RestoreTestingRecoveryPointSelection' + RestoreTestingPlanArn: + type: string + RestoreTestingPlanName: + type: string + ScheduleExpressionTimezone: + type: string + Tags: + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRestoreTestingPlanRequest + type: object + required: [] + CreateRestoreTestingSelectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IamRoleArn: + type: string + ProtectedResourceArns: + type: array + x-insertionOrder: false + items: + type: string + ProtectedResourceConditions: + $ref: '#/components/schemas/ProtectedResourceConditions' + ProtectedResourceType: + type: string + RestoreMetadataOverrides: + $ref: '#/components/schemas/SensitiveStringMap' + RestoreTestingPlanName: + type: string + RestoreTestingSelectionName: + type: string + ValidationWindowHours: + type: integer + x-stackQL-stringOnly: true + x-title: CreateRestoreTestingSelectionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + backup_plans: + name: backup_plans + id: awscc.backup.backup_plans x-cfn-schema-name: BackupPlan - x-type: get + x-cfn-type-name: AWS::Backup::BackupPlan x-identifiers: - BackupPlanId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BackupPlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -828,7 +1808,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -841,13 +1821,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupPlan' AND data__Identifier = '' AND region = 'us-east-1' - backup_selections: - name: backup_selections - id: awscc.backup.backup_selections - x-cfn-schema-name: BackupSelection - x-type: list + backup_plans_list_only: + name: backup_plans_list_only + id: awscc.backup.backup_plans_list_only + x-cfn-schema-name: BackupPlan + x-cfn-type-name: AWS::Backup::BackupPlan x-identifiers: - - Id + - BackupPlanId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -855,28 +1841,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' + JSON_EXTRACT(Properties, '$.BackupPlanId') as backup_plan_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' + json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' AND region = 'us-east-1' - backup_selection: - name: backup_selection - id: awscc.backup.backup_selection + backup_selections: + name: backup_selections + id: awscc.backup.backup_selections x-cfn-schema-name: BackupSelection - x-type: get + x-cfn-type-name: AWS::Backup::BackupSelection x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BackupSelection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupSelection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupSelection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/backup_selections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/backup_selections/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -889,7 +1910,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -901,13 +1922,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupSelection' AND data__Identifier = '' AND region = 'us-east-1' - backup_vaults: - name: backup_vaults - id: awscc.backup.backup_vaults - x-cfn-schema-name: BackupVault - x-type: list + backup_selections_list_only: + name: backup_selections_list_only + id: awscc.backup.backup_selections_list_only + x-cfn-schema-name: BackupSelection + x-cfn-type-name: AWS::Backup::BackupSelection x-identifiers: - - BackupVaultName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -915,28 +1942,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BackupVaultName') as backup_vault_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' AND region = 'us-east-1' - backup_vault: - name: backup_vault - id: awscc.backup.backup_vault + backup_vaults: + name: backup_vaults + id: awscc.backup.backup_vaults x-cfn-schema-name: BackupVault - x-type: get + x-cfn-type-name: AWS::Backup::BackupVault x-identifiers: - BackupVaultName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BackupVault&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupVault" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupVault" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::BackupVault" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -952,7 +2027,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -967,13 +2042,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupVault' AND data__Identifier = '' AND region = 'us-east-1' - frameworks: - name: frameworks - id: awscc.backup.frameworks - x-cfn-schema-name: Framework - x-type: list + backup_vaults_list_only: + name: backup_vaults_list_only + id: awscc.backup.backup_vaults_list_only + x-cfn-schema-name: BackupVault + x-cfn-type-name: AWS::Backup::BackupVault x-identifiers: - - FrameworkArn + - BackupVaultName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -981,28 +2062,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FrameworkArn') as framework_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' + JSON_EXTRACT(Properties, '$.BackupVaultName') as backup_vault_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FrameworkArn') as framework_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' + json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' AND region = 'us-east-1' - framework: - name: framework - id: awscc.backup.framework + frameworks: + name: frameworks + id: awscc.backup.frameworks x-cfn-schema-name: Framework - x-type: get + x-cfn-type-name: AWS::Backup::Framework x-identifiers: - FrameworkArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Framework&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::Framework" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::Framework" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::Framework" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/frameworks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/frameworks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/frameworks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1019,7 +2148,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1035,13 +2164,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::Framework' AND data__Identifier = '' AND region = 'us-east-1' - report_plans: - name: report_plans - id: awscc.backup.report_plans - x-cfn-schema-name: ReportPlan - x-type: list + frameworks_list_only: + name: frameworks_list_only + id: awscc.backup.frameworks_list_only + x-cfn-schema-name: Framework + x-cfn-type-name: AWS::Backup::Framework x-identifiers: - - ReportPlanArn + - FrameworkArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1049,28 +2184,202 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ReportPlanArn') as report_plan_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' + JSON_EXTRACT(Properties, '$.FrameworkArn') as framework_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ReportPlanArn') as report_plan_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' + json_extract_path_text(Properties, 'FrameworkArn') as framework_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' + AND region = 'us-east-1' + logically_air_gapped_backup_vaults: + name: logically_air_gapped_backup_vaults + id: awscc.backup.logically_air_gapped_backup_vaults + x-cfn-schema-name: LogicallyAirGappedBackupVault + x-cfn-type-name: AWS::Backup::LogicallyAirGappedBackupVault + x-identifiers: + - BackupVaultName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LogicallyAirGappedBackupVault&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::LogicallyAirGappedBackupVault" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::LogicallyAirGappedBackupVault" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::LogicallyAirGappedBackupVault" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logically_air_gapped_backup_vaults/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logically_air_gapped_backup_vaults/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/logically_air_gapped_backup_vaults/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.VaultState') as vault_state, + JSON_EXTRACT(Properties, '$.BackupVaultTags') as backup_vault_tags, + JSON_EXTRACT(Properties, '$.VaultType') as vault_type, + JSON_EXTRACT(Properties, '$.BackupVaultName') as backup_vault_name, + JSON_EXTRACT(Properties, '$.BackupVaultArn') as backup_vault_arn, + JSON_EXTRACT(Properties, '$.EncryptionKeyArn') as encryption_key_arn, + JSON_EXTRACT(Properties, '$.MaxRetentionDays') as max_retention_days, + JSON_EXTRACT(Properties, '$.MinRetentionDays') as min_retention_days, + JSON_EXTRACT(Properties, '$.Notifications') as notifications, + JSON_EXTRACT(Properties, '$.AccessPolicy') as access_policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::LogicallyAirGappedBackupVault' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VaultState') as vault_state, + json_extract_path_text(Properties, 'BackupVaultTags') as backup_vault_tags, + json_extract_path_text(Properties, 'VaultType') as vault_type, + json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name, + json_extract_path_text(Properties, 'BackupVaultArn') as backup_vault_arn, + json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, + json_extract_path_text(Properties, 'MaxRetentionDays') as max_retention_days, + json_extract_path_text(Properties, 'MinRetentionDays') as min_retention_days, + json_extract_path_text(Properties, 'Notifications') as notifications, + json_extract_path_text(Properties, 'AccessPolicy') as access_policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::LogicallyAirGappedBackupVault' + AND data__Identifier = '' AND region = 'us-east-1' - report_plan: - name: report_plan - id: awscc.backup.report_plan + logically_air_gapped_backup_vaults_list_only: + name: logically_air_gapped_backup_vaults_list_only + id: awscc.backup.logically_air_gapped_backup_vaults_list_only + x-cfn-schema-name: LogicallyAirGappedBackupVault + x-cfn-type-name: AWS::Backup::LogicallyAirGappedBackupVault + x-identifiers: + - BackupVaultName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.BackupVaultName') as backup_vault_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::LogicallyAirGappedBackupVault' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::LogicallyAirGappedBackupVault' + AND region = 'us-east-1' + report_plans: + name: report_plans + id: awscc.backup.report_plans x-cfn-schema-name: ReportPlan - x-type: get + x-cfn-type-name: AWS::Backup::ReportPlan x-identifiers: - ReportPlanArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReportPlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::ReportPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::ReportPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::ReportPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/report_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/report_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/report_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1085,7 +2394,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1099,13 +2408,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::ReportPlan' AND data__Identifier = '' AND region = 'us-east-1' - restore_testing_plans: - name: restore_testing_plans - id: awscc.backup.restore_testing_plans - x-cfn-schema-name: RestoreTestingPlan - x-type: list + report_plans_list_only: + name: report_plans_list_only + id: awscc.backup.report_plans_list_only + x-cfn-schema-name: ReportPlan + x-cfn-type-name: AWS::Backup::ReportPlan x-identifiers: - - RestoreTestingPlanName + - ReportPlanArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1113,66 +2428,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' + JSON_EXTRACT(Properties, '$.ReportPlanArn') as report_plan_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' + json_extract_path_text(Properties, 'ReportPlanArn') as report_plan_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' AND region = 'us-east-1' - restore_testing_plan: - name: restore_testing_plan - id: awscc.backup.restore_testing_plan + restore_testing_plans: + name: restore_testing_plans + id: awscc.backup.restore_testing_plans x-cfn-schema-name: RestoreTestingPlan - x-type: get + x-cfn-type-name: AWS::Backup::RestoreTestingPlan x-identifiers: - RestoreTestingPlanName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RestoreTestingPlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::RestoreTestingPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::RestoreTestingPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::RestoreTestingPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ScheduleExpression') as schedule_expression, + JSON_EXTRACT(Properties, '$.StartWindowHours') as start_window_hours, JSON_EXTRACT(Properties, '$.RecoveryPointSelection') as recovery_point_selection, JSON_EXTRACT(Properties, '$.RestoreTestingPlanArn') as restore_testing_plan_arn, JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name, - JSON_EXTRACT(Properties, '$.ScheduleExpression') as schedule_expression, JSON_EXTRACT(Properties, '$.ScheduleExpressionTimezone') as schedule_expression_timezone, - JSON_EXTRACT(Properties, '$.StartWindowHours') as start_window_hours, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, + json_extract_path_text(Properties, 'StartWindowHours') as start_window_hours, json_extract_path_text(Properties, 'RecoveryPointSelection') as recovery_point_selection, json_extract_path_text(Properties, 'RestoreTestingPlanArn') as restore_testing_plan_arn, json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, - json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, json_extract_path_text(Properties, 'ScheduleExpressionTimezone') as schedule_expression_timezone, - json_extract_path_text(Properties, 'StartWindowHours') as start_window_hours, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' AND data__Identifier = '' AND region = 'us-east-1' - restore_testing_selections: - name: restore_testing_selections - id: awscc.backup.restore_testing_selections - x-cfn-schema-name: RestoreTestingSelection - x-type: list + restore_testing_plans_list_only: + name: restore_testing_plans_list_only + id: awscc.backup.restore_testing_plans_list_only + x-cfn-schema-name: RestoreTestingPlan + x-cfn-type-name: AWS::Backup::RestoreTestingPlan x-identifiers: - RestoreTestingPlanName - - RestoreTestingSelectionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1180,31 +2548,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name, - JSON_EXTRACT(Properties, '$.RestoreTestingSelectionName') as restore_testing_selection_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' + JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, - json_extract_path_text(Properties, 'RestoreTestingSelectionName') as restore_testing_selection_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' + json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' AND region = 'us-east-1' - restore_testing_selection: - name: restore_testing_selection - id: awscc.backup.restore_testing_selection + restore_testing_selections: + name: restore_testing_selections + id: awscc.backup.restore_testing_selections x-cfn-schema-name: RestoreTestingSelection - x-type: get + x-cfn-type-name: AWS::Backup::RestoreTestingSelection x-identifiers: - RestoreTestingPlanName - RestoreTestingSelectionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RestoreTestingSelection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::RestoreTestingSelection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::RestoreTestingSelection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Backup::RestoreTestingSelection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1221,7 +2635,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1237,3 +2651,526 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' AND data__Identifier = '|' AND region = 'us-east-1' + restore_testing_selections_list_only: + name: restore_testing_selections_list_only + id: awscc.backup.restore_testing_selections_list_only + x-cfn-schema-name: RestoreTestingSelection + x-cfn-type-name: AWS::Backup::RestoreTestingSelection + x-identifiers: + - RestoreTestingPlanName + - RestoreTestingSelectionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name, + JSON_EXTRACT(Properties, '$.RestoreTestingSelectionName') as restore_testing_selection_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, + json_extract_path_text(Properties, 'RestoreTestingSelectionName') as restore_testing_selection_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BackupPlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBackupPlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBackupPlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BackupSelection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBackupSelection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBackupSelectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BackupVault&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBackupVault + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBackupVaultRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Framework&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFramework + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFrameworkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LogicallyAirGappedBackupVault&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLogicallyAirGappedBackupVault + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLogicallyAirGappedBackupVaultRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReportPlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReportPlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReportPlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RestoreTestingPlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRestoreTestingPlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRestoreTestingPlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RestoreTestingSelection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRestoreTestingSelection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRestoreTestingSelectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/backupgateway.yaml b/providers/src/awscc/v00.00.00000/services/backupgateway.yaml index da6f4e91..c3476d7a 100644 --- a/providers/src/awscc/v00.00.00000/services/backupgateway.yaml +++ b/providers/src/awscc/v00.00.00000/services/backupgateway.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: BackupGateway - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: HypervisorState: type: string @@ -79,15 +459,34 @@ components: minLength: 1 pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$ x-stackql-resource-name: hypervisor - x-stackql-primaryIdentifier: + description: Definition of AWS::BackupGateway::Hypervisor Resource Type + x-type-name: AWS::BackupGateway::Hypervisor + x-stackql-primary-identifier: - HypervisorArn x-create-only-properties: - KmsKeyArn - Tags + x-write-only-properties: + - KmsKeyArn + - LogGroupArn + - Name + - Password + - Username x-read-only-properties: - HypervisorArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - backup-gateway:UntagResource + - backup-gateway:TagResource + - backup-gateway:ListTagsForResource x-required-permissions: create: + - backup-gateway:ListTagsForResource - backup-gateway:ImportHypervisorConfiguration - backup-gateway:GetHypervisor - backup-gateway:ListHypervisors @@ -98,55 +497,143 @@ components: read: - backup-gateway:GetHypervisor - backup-gateway:ListHypervisors + - backup-gateway:ListTagsForResource update: - backup-gateway:UpdateHypervisor - backup-gateway:GetHypervisor - backup-gateway:ListHypervisors - backup-gateway:ImportHypervisorConfiguration - backup-gateway:DeleteHypervisor + - backup-gateway:ListTagsForResource delete: - backup-gateway:DeleteHypervisor - backup-gateway:GetHypervisor - backup-gateway:ListHypervisors list: - backup-gateway:ListHypervisors + CreateHypervisorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Host: + type: string + maxLength: 128 + minLength: 3 + pattern: ^.+$ + HypervisorArn: + type: string + maxLength: 500 + minLength: 50 + pattern: ^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$ + KmsKeyArn: + type: string + maxLength: 500 + minLength: 50 + pattern: ^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)$ + LogGroupArn: + type: string + maxLength: 2048 + minLength: 0 + pattern: ^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*$ + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + Password: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[ -~]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + Username: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$ + x-stackQL-stringOnly: true + x-title: CreateHypervisorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: hypervisors: name: hypervisors id: awscc.backupgateway.hypervisors x-cfn-schema-name: Hypervisor - x-type: list - x-identifiers: - - HypervisorArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HypervisorArn') as hypervisor_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HypervisorArn') as hypervisor_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' - AND region = 'us-east-1' - hypervisor: - name: hypervisor - id: awscc.backupgateway.hypervisor - x-cfn-schema-name: Hypervisor - x-type: get + x-cfn-type-name: AWS::BackupGateway::Hypervisor x-identifiers: - HypervisorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Hypervisor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BackupGateway::Hypervisor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BackupGateway::Hypervisor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BackupGateway::Hypervisor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hypervisors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hypervisors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hypervisors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -163,7 +650,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -179,3 +666,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' AND data__Identifier = '' AND region = 'us-east-1' + hypervisors_list_only: + name: hypervisors_list_only + id: awscc.backupgateway.hypervisors_list_only + x-cfn-schema-name: Hypervisor + x-cfn-type-name: AWS::BackupGateway::Hypervisor + x-identifiers: + - HypervisorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.HypervisorArn') as hypervisor_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HypervisorArn') as hypervisor_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Hypervisor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHypervisor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHypervisorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/batch.yaml b/providers/src/awscc/v00.00.00000/services/batch.yaml index a5e1b311..c01c9291 100644 --- a/providers/src/awscc/v00.00.00000/services/batch.yaml +++ b/providers/src/awscc/v00.00.00000/services/batch.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Batch - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ComputeResources: type: object @@ -93,6 +473,38 @@ components: type: string Version: type: string + UserdataType: + type: string + enum: + - EKS_BOOTSTRAP_SH + - EKS_NODEADM + Overrides: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/LaunchTemplateSpecificationOverride' + LaunchTemplateSpecificationOverride: + type: object + additionalProperties: false + properties: + LaunchTemplateId: + type: string + LaunchTemplateName: + type: string + Version: + type: string + UserdataType: + type: string + enum: + - EKS_BOOTSTRAP_SH + - EKS_NODEADM + TargetInstanceTypes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string UpdatePolicy: type: object additionalProperties: false @@ -147,19 +559,54 @@ components: type: integer EksConfiguration: $ref: '#/components/schemas/EksConfiguration' + Context: + type: string required: - Type x-stackql-resource-name: compute_environment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Batch::ComputeEnvironment + x-type-name: AWS::Batch::ComputeEnvironment + x-stackql-primary-identifier: - ComputeEnvironmentArn + x-stackql-additional-identifiers: + - - ComputeEnvironmentName x-create-only-properties: - ComputeResources/SpotIamFleetRole - ComputeEnvironmentName - Tags - Type - EksConfiguration + x-conditional-create-only-properties: + - ComputeResources/AllocationStrategy + - ComputeResources/BidPercentage + - ComputeResources/Ec2Configuration + - ComputeResources/Ec2KeyPair + - ComputeResources/ImageId + - ComputeResources/InstanceRole + - ComputeResources/InstanceTypes + - ComputeResources/LaunchTemplate + - ComputeResources/PlacementGroup + - ComputeResources/SecurityGroupIds + - ComputeResources/Subnets + - ComputeResources/Tags + - ComputeResources/Type + x-write-only-properties: + - ComputeResources/UpdateToLatestImageVersion + - ReplaceComputeEnvironment + - UpdatePolicy x-read-only-properties: - ComputeEnvironmentArn + x-required-properties: + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - Batch:TagResource + - Batch:UnTagResource x-required-permissions: create: - Batch:CreateComputeEnvironment @@ -168,6 +615,7 @@ components: - iam:CreateServiceLinkedRole - Iam:PassRole - Eks:DescribeCluster + - ec2:DescribeLaunchTemplateVersions read: - Batch:DescribeComputeEnvironments update: @@ -177,54 +625,51 @@ components: - Batch:UnTagResource - Iam:PassRole - Eks:DescribeCluster + - ec2:DescribeLaunchTemplateVersions delete: - Batch:DeleteComputeEnvironment - Batch:DescribeComputeEnvironments - Batch:UpdateComputeEnvironment - Iam:PassRole - Eks:DescribeCluster + - ec2:DescribeLaunchTemplateVersions list: - Batch:DescribeComputeEnvironments ResourceArn: description: ARN of the Scheduling Policy. type: string - ComputeEnvironmentOrder: - type: object - additionalProperties: false - properties: - ComputeEnvironment: - type: string - Order: - type: integer - required: - - ComputeEnvironment - - Order - JobQueue: + ResourceType: + description: Type of Consumable Resource. + type: string + enum: + - REPLENISHABLE + - NON_REPLENISHABLE + ConsumableResource: type: object properties: - JobQueueName: + ConsumableResourceName: + description: Name of ConsumableResource. type: string - minLength: 1 - maxLength: 128 - JobQueueArn: + pattern: '' + ConsumableResourceArn: $ref: '#/components/schemas/ResourceArn' - ComputeEnvironmentOrder: - type: array - x-insertionOrder: true - uniqueItems: false - items: - $ref: '#/components/schemas/ComputeEnvironmentOrder' - Priority: + TotalQuantity: + description: Total Quantity of ConsumableResource. type: integer - minimum: 0 - maximum: 1000 - State: - type: string - enum: - - DISABLED - - ENABLED - SchedulingPolicyArn: - $ref: '#/components/schemas/ResourceArn' + format: int64 + InUseQuantity: + description: In-use Quantity of ConsumableResource. + type: integer + format: int64 + AvailableQuantity: + description: Available Quantity of ConsumableResource. + type: integer + format: int64 + ResourceType: + $ref: '#/components/schemas/ResourceType' + CreatedAt: + type: integer + format: int64 Tags: type: object description: A key-value pair to associate with a resource. @@ -233,144 +678,1630 @@ components: type: string additionalProperties: false required: - - ComputeEnvironmentOrder - - Priority - x-stackql-resource-name: job_queue - x-stackql-primaryIdentifier: - - JobQueueArn + - ResourceType + - TotalQuantity + x-stackql-resource-name: consumable_resource + description: Resource Type definition for AWS::Batch::ConsumableResource + x-type-name: AWS::Batch::ConsumableResource + x-stackql-primary-identifier: + - ConsumableResourceArn x-create-only-properties: + - ConsumableResourceName + - ResourceType - Tags - - JobQueueName x-read-only-properties: - - JobQueueArn + - ConsumableResourceArn + - CreatedAt + - InUseQuantity + - AvailableQuantity + x-required-properties: + - ResourceType + - TotalQuantity + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - Batch:TagResource + - Batch:UntagResource x-required-permissions: create: - - Batch:CreateJobQueue + - Batch:CreateConsumableResource - Batch:TagResource - - Batch:DescribeJobQueues read: - - Batch:DescribeJobQueues + - Batch:DescribeConsumableResource update: - - Batch:DescribeJobQueues - - Batch:UpdateJobQueue + - Batch:UpdateConsumableResource - Batch:TagResource - Batch:UnTagResource delete: - - Batch:UpdateJobQueue - - Batch:DescribeJobQueues - - Batch:DeleteJobQueue + - Batch:DescribeConsumableResource + - Batch:DeleteConsumableResource list: - - Batch:DescribeJobQueues - FairsharePolicy: - description: Fair Share Policy for the Job Queue. + - Batch:ListConsumableResources + ContainerProperties: type: object + additionalProperties: false properties: - ShareDecaySeconds: - type: number - minimum: 0 - maximum: 604800 - ComputeReservation: - type: number - minimum: 0 - maximum: 99 - ShareDistribution: - description: List of Share Attributes + Command: + type: array + uniqueItems: false + x-insertionOrder: true + items: + type: string + Environment: + type: array + uniqueItems: false + x-insertionOrder: true + items: + $ref: '#/components/schemas/Environment' + Image: + type: string + JobRoleArn: + type: string + Memory: + type: integer + MountPoints: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/MountPoint' + Privileged: + type: boolean + ReadonlyRootFilesystem: + type: boolean + Ulimits: type: array + uniqueItems: false x-insertionOrder: false items: - $ref: '#/components/schemas/ShareAttributes' - required: [] - additionalProperties: false - ShareAttributes: + $ref: '#/components/schemas/Ulimit' + User: + type: string + Vcpus: + type: integer + Volumes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Volume' + ResourceRequirements: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ResourceRequirement' + LinuxParameters: + $ref: '#/components/schemas/LinuxParameters' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + ExecutionRoleArn: + type: string + Secrets: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Secret' + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + FargatePlatformConfiguration: + type: object + additionalProperties: false + properties: + PlatformVersion: + type: string + EphemeralStorage: + $ref: '#/components/schemas/EphemeralStorage' + RuntimePlatform: + $ref: '#/components/schemas/RuntimePlatform' + RepositoryCredentials: + $ref: '#/components/schemas/RepositoryCredentials' + EnableExecuteCommand: + type: boolean + required: + - Image + MultiNodeContainerProperties: type: object + additionalProperties: false properties: - ShareIdentifier: + Command: + type: array + uniqueItems: false + x-insertionOrder: true + items: + type: string + Environment: + type: array + uniqueItems: false + x-insertionOrder: true + items: + $ref: '#/components/schemas/Environment' + Image: type: string - WeightFactor: - type: number - minimum: 0 - maximum: 1000 - required: [] - additionalProperties: false - SchedulingPolicy: + JobRoleArn: + type: string + Memory: + type: integer + MountPoints: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/MountPoint' + Privileged: + type: boolean + ReadonlyRootFilesystem: + type: boolean + Ulimits: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Ulimit' + User: + type: string + Vcpus: + type: integer + Volumes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Volume' + InstanceType: + type: string + ResourceRequirements: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ResourceRequirement' + LinuxParameters: + $ref: '#/components/schemas/LinuxParameters' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + ExecutionRoleArn: + type: string + Secrets: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Secret' + EphemeralStorage: + $ref: '#/components/schemas/EphemeralStorage' + RuntimePlatform: + $ref: '#/components/schemas/RuntimePlatform' + RepositoryCredentials: + $ref: '#/components/schemas/RepositoryCredentials' + EnableExecuteCommand: + type: boolean + required: + - Image + EphemeralStorage: type: object + additionalProperties: false properties: - Name: + SizeInGiB: + type: integer + required: + - SizeInGiB + LinuxParameters: + type: object + additionalProperties: false + properties: + Devices: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Device' + InitProcessEnabled: + type: boolean + MaxSwap: + type: integer + Swappiness: + type: integer + SharedMemorySize: + type: integer + Tmpfs: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tmpfs' + LogConfiguration: + type: object + additionalProperties: false + properties: + LogDriver: + type: string + Options: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + SecretOptions: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Secret' + required: + - LogDriver + RuntimePlatform: + type: object + additionalProperties: false + properties: + OperatingSystemFamily: + type: string + CpuArchitecture: + type: string + NetworkConfiguration: + type: object + additionalProperties: false + properties: + AssignPublicIp: + type: string + RepositoryCredentials: + type: object + additionalProperties: false + properties: + CredentialsParameter: + type: string + required: + - CredentialsParameter + Environment: + type: object + additionalProperties: false + properties: + Name: + type: string + Value: + type: string + MountPoint: + type: object + additionalProperties: false + properties: + ContainerPath: + type: string + ReadOnly: + type: boolean + SourceVolume: + type: string + Ulimit: + type: object + additionalProperties: false + properties: + HardLimit: + type: integer + Name: + type: string + SoftLimit: + type: integer + required: + - HardLimit + - Name + - SoftLimit + Volume: + type: object + additionalProperties: false + properties: + Host: + $ref: '#/components/schemas/Host' + EfsVolumeConfiguration: + $ref: '#/components/schemas/EFSVolumeConfiguration' + Name: + type: string + Host: + type: object + additionalProperties: false + properties: + SourcePath: + type: string + EFSVolumeConfiguration: + type: object + additionalProperties: false + properties: + FileSystemId: + type: string + RootDirectory: + type: string + TransitEncryption: + type: string + TransitEncryptionPort: + type: integer + AuthorizationConfig: + $ref: '#/components/schemas/EFSAuthorizationConfig' + required: + - FileSystemId + EFSAuthorizationConfig: + type: object + additionalProperties: false + properties: + AccessPointId: + type: string + Iam: + type: string + ResourceRequirement: + type: object + additionalProperties: false + properties: + Type: + type: string + Value: + type: string + Device: + type: object + additionalProperties: false + properties: + HostPath: + type: string + ContainerPath: + type: string + Permissions: + type: array + x-insertionOrder: false + uniqueItems: false + items: + type: string + Tmpfs: + type: object + additionalProperties: false + properties: + ContainerPath: + type: string + Size: + type: integer + MountOptions: + type: array + x-insertionOrder: false + uniqueItems: false + items: + type: string + required: + - ContainerPath + - Size + Secret: + type: object + additionalProperties: false + properties: + Name: + type: string + ValueFrom: + type: string + required: + - Name + - ValueFrom + EksProperties: + type: object + additionalProperties: false + properties: + PodProperties: + $ref: '#/components/schemas/EksPodProperties' + EksPodProperties: + type: object + additionalProperties: false + properties: + ServiceAccountName: + type: string + HostNetwork: + type: boolean + DnsPolicy: + type: string + InitContainers: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EksContainer' + Containers: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EksContainer' + Volumes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EksVolume' + ImagePullSecrets: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ImagePullSecret' + Metadata: + $ref: '#/components/schemas/EksMetadata' + ShareProcessNamespace: + type: boolean + EksContainer: + type: object + additionalProperties: false + properties: + Name: + type: string + Image: + type: string + ImagePullPolicy: + type: string + Command: + type: array + x-insertionOrder: true + uniqueItems: false + items: + type: string + Args: + type: array + x-insertionOrder: true + uniqueItems: false + items: + type: string + Env: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EksContainerEnvironmentVariable' + Resources: + $ref: '#/components/schemas/EksContainerResourceRequirements' + VolumeMounts: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EksContainerVolumeMount' + SecurityContext: + $ref: '#/components/schemas/EksContainerSecurityContext' + required: + - Image + EksContainerEnvironmentVariable: + type: object + additionalProperties: false + properties: + Name: + type: string + Value: + type: string + required: + - Name + EksContainerResourceRequirements: + type: object + additionalProperties: false + properties: + Limits: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + Requests: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + EksContainerSecurityContext: + type: object + additionalProperties: false + properties: + RunAsUser: + type: integer + RunAsGroup: + type: integer + Privileged: + type: boolean + AllowPrivilegeEscalation: + type: boolean + ReadOnlyRootFilesystem: + type: boolean + RunAsNonRoot: + type: boolean + EksVolume: + type: object + additionalProperties: false + properties: + Name: + type: string + HostPath: + $ref: '#/components/schemas/EksHostPath' + EmptyDir: + $ref: '#/components/schemas/EksEmptyDir' + Secret: + $ref: '#/components/schemas/EksSecret' + PersistentVolumeClaim: + $ref: '#/components/schemas/EksPersistentVolumeClaim' + required: + - Name + EksHostPath: + type: object + additionalProperties: false + properties: + Path: + type: string + EksEmptyDir: + type: object + additionalProperties: false + properties: + Medium: + type: string + SizeLimit: + type: string + EksSecret: + type: object + additionalProperties: false + properties: + SecretName: + type: string + Optional: + type: boolean + required: + - SecretName + EksPersistentVolumeClaim: + type: object + additionalProperties: false + properties: + ClaimName: + type: string + ReadOnly: + type: boolean + required: + - ClaimName + EksContainerVolumeMount: + type: object + additionalProperties: false + properties: + Name: + type: string + MountPath: + type: string + SubPath: + type: string + ReadOnly: + type: boolean + EksMetadata: + type: object + additionalProperties: false + properties: + Labels: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + Annotations: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + Namespace: + type: string + ImagePullSecret: + type: object + additionalProperties: false + properties: + Name: + type: string + RetryStrategy: + type: object + additionalProperties: false + properties: + Attempts: + type: integer + EvaluateOnExit: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EvaluateOnExit' + EvaluateOnExit: + type: object + additionalProperties: false + properties: + OnExitCode: + type: string + OnStatusReason: + type: string + OnReason: + type: string + Action: + type: string + required: + - Action + NodeProperties: + type: object + additionalProperties: false + properties: + NumNodes: + type: integer + MainNode: + type: integer + NodeRangeProperties: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/NodeRangeProperty' + required: + - NumNodes + - MainNode + - NodeRangeProperties + NodeRangeProperty: + type: object + additionalProperties: false + properties: + TargetNodes: + type: string + Container: + $ref: '#/components/schemas/MultiNodeContainerProperties' + EcsProperties: + $ref: '#/components/schemas/MultiNodeEcsProperties' + EksProperties: + $ref: '#/components/schemas/EksProperties' + ConsumableResourceProperties: + $ref: '#/components/schemas/ConsumableResourceProperties' + InstanceTypes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + required: + - TargetNodes + JobTimeout: + type: object + additionalProperties: false + properties: + AttemptDurationSeconds: + type: integer + EcsProperties: + type: object + additionalProperties: false + properties: + TaskProperties: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EcsTaskProperties' + required: + - TaskProperties + EcsTaskProperties: + type: object + additionalProperties: false + properties: + Containers: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/TaskContainerProperties' + EphemeralStorage: + $ref: '#/components/schemas/EphemeralStorage' + ExecutionRoleArn: + type: string + RuntimePlatform: + $ref: '#/components/schemas/RuntimePlatform' + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + Volumes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Volume' + PidMode: + type: string + IpcMode: + type: string + PlatformVersion: + type: string + TaskRoleArn: + type: string + EnableExecuteCommand: + type: boolean + MultiNodeEcsProperties: + type: object + additionalProperties: false + properties: + TaskProperties: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/MultiNodeEcsTaskProperties' + required: + - TaskProperties + MultiNodeEcsTaskProperties: + type: object + additionalProperties: false + properties: + Containers: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/TaskContainerProperties' + ExecutionRoleArn: + type: string + Volumes: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Volume' + PidMode: + type: string + IpcMode: + type: string + TaskRoleArn: + type: string + EnableExecuteCommand: + type: boolean + TaskContainerProperties: + type: object + additionalProperties: false + properties: + Command: + type: array + uniqueItems: false + x-insertionOrder: true + items: + type: string + Environment: + type: array + uniqueItems: false + x-insertionOrder: true + items: + $ref: '#/components/schemas/Environment' + DependsOn: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/TaskContainerDependency' + Name: + type: string + Image: + type: string + LinuxParameters: + $ref: '#/components/schemas/LinuxParameters' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + MountPoints: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/MountPoint' + Essential: + type: boolean + Privileged: + type: boolean + ReadonlyRootFilesystem: + type: boolean + Ulimits: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Ulimit' + User: + type: string + Secrets: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Secret' + RepositoryCredentials: + $ref: '#/components/schemas/RepositoryCredentials' + ResourceRequirements: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ResourceRequirement' + FirelensConfiguration: + type: object + additionalProperties: false + properties: + Type: + type: string + Options: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + required: + - Type + required: + - Image + TaskContainerDependency: + type: object + additionalProperties: false + properties: + ContainerName: + type: string + Condition: + type: string + required: + - ContainerName + - Condition + ConsumableResourceRequirement: + type: object + additionalProperties: false + properties: + ConsumableResource: + type: string + description: The ARN of the consumable resource the job definition should consume. + pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} + Quantity: + type: integer + format: int64 + required: + - ConsumableResource + - Quantity + ConsumableResourceProperties: + type: object + additionalProperties: false + properties: + ConsumableResourceList: + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/ConsumableResourceRequirement' + required: + - ConsumableResourceList + JobDefinition: + type: object + properties: + ContainerProperties: + $ref: '#/components/schemas/ContainerProperties' + EcsProperties: + $ref: '#/components/schemas/EcsProperties' + NodeProperties: + $ref: '#/components/schemas/NodeProperties' + JobDefinitionName: + type: string + maxLength: 128 + JobDefinitionArn: + type: string + SchedulingPriority: + type: integer + Parameters: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + PlatformCapabilities: + type: array + x-insertionOrder: true + uniqueItems: false + items: + type: string + PropagateTags: + type: boolean + RetryStrategy: + $ref: '#/components/schemas/RetryStrategy' + Timeout: + $ref: '#/components/schemas/JobTimeout' + Type: + type: string + Tags: + type: object + additionalProperties: false + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + EksProperties: + $ref: '#/components/schemas/EksProperties' + ConsumableResourceProperties: + $ref: '#/components/schemas/ConsumableResourceProperties' + required: + - Type + x-stackql-resource-name: job_definition + description: Resource Type definition for AWS::Batch::JobDefinition + x-type-name: AWS::Batch::JobDefinition + x-stackql-primary-identifier: + - JobDefinitionName + x-create-only-properties: + - JobDefinitionName + x-read-only-properties: + - JobDefinitionArn + x-required-properties: + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - Batch:TagResource + - Batch:UnTagResource + x-required-permissions: + create: + - Batch:RegisterJobDefinition + - Batch:TagResource + - Batch:DescribeJobDefinitions + - Iam:PassRole + read: + - Batch:DescribeJobDefinitions + update: + - Batch:DescribeJobDefinitions + - Batch:RegisterJobDefinition + - Batch:DeregisterJobDefinition + - Batch:TagResource + - Batch:UntagResource + - Iam:PassRole + delete: + - Batch:DescribeJobDefinitions + - Batch:DeregisterJobDefinition + - Iam:PassRole + list: + - Batch:DescribeJobDefinitions + ComputeEnvironmentOrder: + type: object + additionalProperties: false + properties: + ComputeEnvironment: + type: string + Order: + type: integer + required: + - ComputeEnvironment + - Order + ServiceEnvironmentOrder: + type: object + additionalProperties: false + properties: + ServiceEnvironment: + type: string + Order: + type: integer + required: + - ServiceEnvironment + - Order + JobStateTimeLimitAction: + type: object + additionalProperties: false + properties: + Action: + type: string + enum: + - CANCEL + - TERMINATE + MaxTimeSeconds: + type: integer + minimum: 600 + maximum: 86400 + Reason: + type: string + State: + type: string + enum: + - RUNNABLE + required: + - Action + - MaxTimeSeconds + - Reason + - State + JobQueue: + type: object + properties: + JobQueueName: + type: string + minLength: 1 + maxLength: 128 + JobQueueArn: + $ref: '#/components/schemas/ResourceArn' + JobQueueType: + type: string + ComputeEnvironmentOrder: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/ComputeEnvironmentOrder' + ServiceEnvironmentOrder: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/ServiceEnvironmentOrder' + JobStateTimeLimitActions: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/JobStateTimeLimitAction' + Priority: + type: integer + minimum: 0 + maximum: 1000 + State: + type: string + enum: + - DISABLED + - ENABLED + SchedulingPolicyArn: + $ref: '#/components/schemas/ResourceArn' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + required: + - Priority + x-stackql-resource-name: job_queue + description: Resource Type definition for AWS::Batch::JobQueue + x-type-name: AWS::Batch::JobQueue + x-stackql-primary-identifier: + - JobQueueArn + x-create-only-properties: + - Tags + - JobQueueName + - JobQueueType + x-read-only-properties: + - JobQueueArn + x-required-properties: + - Priority + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - Batch:TagResource + - Batch:UntagResource + x-required-permissions: + create: + - Batch:CreateJobQueue + - Batch:TagResource + - Batch:DescribeJobQueues + read: + - Batch:DescribeJobQueues + update: + - Batch:DescribeJobQueues + - Batch:UpdateJobQueue + - Batch:TagResource + - Batch:UnTagResource + delete: + - Batch:UpdateJobQueue + - Batch:DescribeJobQueues + - Batch:DeleteJobQueue + list: + - Batch:DescribeJobQueues + FairsharePolicy: + description: Fair Share Policy for the Job Queue. + type: object + properties: + ShareDecaySeconds: + type: number + minimum: 0 + maximum: 604800 + ComputeReservation: + type: number + minimum: 0 + maximum: 99 + ShareDistribution: + description: List of Share Attributes + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ShareAttributes' + required: [] + additionalProperties: false + ShareAttributes: + type: object + properties: + ShareIdentifier: + type: string + WeightFactor: + type: number + minimum: 0 + maximum: 1000 + required: [] + additionalProperties: false + SchedulingPolicy: + type: object + properties: + Name: description: Name of Scheduling Policy. type: string - pattern: '' - Arn: - $ref: '#/components/schemas/ResourceArn' - FairsharePolicy: - $ref: '#/components/schemas/FairsharePolicy' - Tags: + pattern: '' + Arn: + $ref: '#/components/schemas/ResourceArn' + FairsharePolicy: + $ref: '#/components/schemas/FairsharePolicy' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + x-stackql-resource-name: scheduling_policy + description: Resource Type definition for AWS::Batch::SchedulingPolicy + x-type-name: AWS::Batch::SchedulingPolicy + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - Tags + x-read-only-properties: + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - Batch:TagResource + - Batch:UntagResource + x-required-permissions: + create: + - Batch:CreateSchedulingPolicy + - Batch:TagResource + read: + - Batch:DescribeSchedulingPolicies + update: + - Batch:UpdateSchedulingPolicy + - Batch:TagResource + - Batch:UnTagResource + delete: + - Batch:DescribeSchedulingPolicies + - Batch:DeleteSchedulingPolicy + list: + - Batch:ListSchedulingPolicies + - Batch:DescribeSchedulingPolicies + CapacityLimits: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/CapacityLimit' + CapacityLimit: + type: object + additionalProperties: false + properties: + MaxCapacity: + type: integer + CapacityUnit: + type: string + ServiceEnvironment: + type: object + properties: + ServiceEnvironmentArn: + type: string + ServiceEnvironmentName: + type: string + State: + type: string + ServiceEnvironmentType: + type: string + CapacityLimits: + $ref: '#/components/schemas/CapacityLimits' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + required: + - ServiceEnvironmentType + - CapacityLimits + x-stackql-resource-name: service_environment + description: Resource Type definition for AWS::Batch::ServiceEnvironment + x-type-name: AWS::Batch::ServiceEnvironment + x-stackql-primary-identifier: + - ServiceEnvironmentArn + x-stackql-additional-identifiers: + - - ServiceEnvironmentName + x-create-only-properties: + - ServiceEnvironmentName + - ServiceEnvironmentType + x-read-only-properties: + - ServiceEnvironmentArn + x-required-properties: + - ServiceEnvironmentType + - CapacityLimits + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - Batch:TagResource + - Batch:UntagResource + x-required-permissions: + create: + - Batch:CreateServiceEnvironment + - Batch:TagResource + - Batch:DescribeServiceEnvironments + - Iam:CreateServiceLinkedRole + read: + - Batch:DescribeServiceEnvironments + update: + - Batch:UpdateServiceEnvironment + - Batch:DescribeServiceEnvironments + - Batch:TagResource + - Batch:UntagResource + delete: + - Batch:DeleteServiceEnvironment + - Batch:DescribeServiceEnvironments + - Batch:UpdateServiceEnvironment + list: + - Batch:DescribeServiceEnvironments + CreateComputeEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ComputeEnvironmentArn: + type: string + ComputeEnvironmentName: + type: string + ComputeResources: + $ref: '#/components/schemas/ComputeResources' + ReplaceComputeEnvironment: + type: boolean + default: true + ServiceRole: + type: string + State: + type: string + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + Type: + type: string + UpdatePolicy: + $ref: '#/components/schemas/UpdatePolicy' + UnmanagedvCpus: + type: integer + EksConfiguration: + $ref: '#/components/schemas/EksConfiguration' + Context: + type: string + x-stackQL-stringOnly: true + x-title: CreateComputeEnvironmentRequest + type: object + required: [] + CreateConsumableResourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConsumableResourceName: + description: Name of ConsumableResource. + type: string + pattern: '' + ConsumableResourceArn: + $ref: '#/components/schemas/ResourceArn' + TotalQuantity: + description: Total Quantity of ConsumableResource. + type: integer + format: int64 + InUseQuantity: + description: In-use Quantity of ConsumableResource. + type: integer + format: int64 + AvailableQuantity: + description: Available Quantity of ConsumableResource. + type: integer + format: int64 + ResourceType: + $ref: '#/components/schemas/ResourceType' + CreatedAt: + type: integer + format: int64 + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateConsumableResourceRequest + type: object + required: [] + CreateJobDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContainerProperties: + $ref: '#/components/schemas/ContainerProperties' + EcsProperties: + $ref: '#/components/schemas/EcsProperties' + NodeProperties: + $ref: '#/components/schemas/NodeProperties' + JobDefinitionName: + type: string + maxLength: 128 + JobDefinitionArn: + type: string + SchedulingPriority: + type: integer + Parameters: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + PlatformCapabilities: + type: array + x-insertionOrder: true + uniqueItems: false + items: + type: string + PropagateTags: + type: boolean + RetryStrategy: + $ref: '#/components/schemas/RetryStrategy' + Timeout: + $ref: '#/components/schemas/JobTimeout' + Type: + type: string + Tags: + type: object + additionalProperties: false + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + EksProperties: + $ref: '#/components/schemas/EksProperties' + ConsumableResourceProperties: + $ref: '#/components/schemas/ConsumableResourceProperties' + x-stackQL-stringOnly: true + x-title: CreateJobDefinitionRequest + type: object + required: [] + CreateJobQueueRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + JobQueueName: + type: string + minLength: 1 + maxLength: 128 + JobQueueArn: + $ref: '#/components/schemas/ResourceArn' + JobQueueType: + type: string + ComputeEnvironmentOrder: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/ComputeEnvironmentOrder' + ServiceEnvironmentOrder: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/ServiceEnvironmentOrder' + JobStateTimeLimitActions: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/JobStateTimeLimitAction' + Priority: + type: integer + minimum: 0 + maximum: 1000 + State: + type: string + enum: + - DISABLED + - ENABLED + SchedulingPolicyArn: + $ref: '#/components/schemas/ResourceArn' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateJobQueueRequest + type: object + required: [] + CreateSchedulingPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of Scheduling Policy. + type: string + pattern: '' + Arn: + $ref: '#/components/schemas/ResourceArn' + FairsharePolicy: + $ref: '#/components/schemas/FairsharePolicy' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateSchedulingPolicyRequest + type: object + required: [] + CreateServiceEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object - description: A key-value pair to associate with a resource. - x-patternProperties: - .*: + properties: + ServiceEnvironmentArn: type: string - additionalProperties: false - x-stackql-resource-name: scheduling_policy - x-stackql-primaryIdentifier: - - Arn - x-create-only-properties: - - Name - - Tags - x-read-only-properties: - - Arn - x-required-permissions: - create: - - Batch:CreateSchedulingPolicy - - Batch:TagResource - read: - - Batch:DescribeSchedulingPolicies - update: - - Batch:UpdateSchedulingPolicy - - Batch:TagResource - - Batch:UnTagResource - delete: - - Batch:DescribeSchedulingPolicies - - Batch:DeleteSchedulingPolicy - list: - - Batch:ListSchedulingPolicies - - Batch:DescribeSchedulingPolicies + ServiceEnvironmentName: + type: string + State: + type: string + ServiceEnvironmentType: + type: string + CapacityLimits: + $ref: '#/components/schemas/CapacityLimits' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + .*: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateServiceEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: compute_environments: name: compute_environments id: awscc.batch.compute_environments x-cfn-schema-name: ComputeEnvironment - x-type: list - x-identifiers: - - ComputeEnvironmentArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ComputeEnvironmentArn') as compute_environment_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ComputeEnvironmentArn') as compute_environment_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' - AND region = 'us-east-1' - compute_environment: - name: compute_environment - id: awscc.batch.compute_environment - x-cfn-schema-name: ComputeEnvironment - x-type: get + x-cfn-type-name: AWS::Batch::ComputeEnvironment x-identifiers: - ComputeEnvironmentArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ComputeEnvironment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ComputeEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ComputeEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ComputeEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/compute_environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/compute_environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/compute_environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -385,12 +2316,13 @@ components: JSON_EXTRACT(Properties, '$.Type') as type, JSON_EXTRACT(Properties, '$.UpdatePolicy') as update_policy, JSON_EXTRACT(Properties, '$.UnmanagedvCpus') as unmanagedv_cpus, - JSON_EXTRACT(Properties, '$.EksConfiguration') as eks_configuration + JSON_EXTRACT(Properties, '$.EksConfiguration') as eks_configuration, + JSON_EXTRACT(Properties, '$.Context') as context FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -405,17 +2337,24 @@ components: json_extract_path_text(Properties, 'Type') as type, json_extract_path_text(Properties, 'UpdatePolicy') as update_policy, json_extract_path_text(Properties, 'UnmanagedvCpus') as unmanagedv_cpus, - json_extract_path_text(Properties, 'EksConfiguration') as eks_configuration + json_extract_path_text(Properties, 'EksConfiguration') as eks_configuration, + json_extract_path_text(Properties, 'Context') as context FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' AND data__Identifier = '' AND region = 'us-east-1' - job_queues: - name: job_queues - id: awscc.batch.job_queues - x-cfn-schema-name: JobQueue - x-type: list + compute_environments_list_only: + name: compute_environments_list_only + id: awscc.batch.compute_environments_list_only + x-cfn-schema-name: ComputeEnvironment + x-cfn-type-name: AWS::Batch::ComputeEnvironment x-identifiers: - - JobQueueArn + - ComputeEnvironmentArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -423,35 +2362,344 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.JobQueueArn') as job_queue_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' + JSON_EXTRACT(Properties, '$.ComputeEnvironmentArn') as compute_environment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' + json_extract_path_text(Properties, 'ComputeEnvironmentArn') as compute_environment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' + AND region = 'us-east-1' + consumable_resources: + name: consumable_resources + id: awscc.batch.consumable_resources + x-cfn-schema-name: ConsumableResource + x-cfn-type-name: AWS::Batch::ConsumableResource + x-identifiers: + - ConsumableResourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConsumableResource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ConsumableResource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ConsumableResource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ConsumableResource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/consumable_resources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/consumable_resources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/consumable_resources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ConsumableResourceName') as consumable_resource_name, + JSON_EXTRACT(Properties, '$.ConsumableResourceArn') as consumable_resource_arn, + JSON_EXTRACT(Properties, '$.TotalQuantity') as total_quantity, + JSON_EXTRACT(Properties, '$.InUseQuantity') as in_use_quantity, + JSON_EXTRACT(Properties, '$.AvailableQuantity') as available_quantity, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ConsumableResource' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConsumableResourceName') as consumable_resource_name, + json_extract_path_text(Properties, 'ConsumableResourceArn') as consumable_resource_arn, + json_extract_path_text(Properties, 'TotalQuantity') as total_quantity, + json_extract_path_text(Properties, 'InUseQuantity') as in_use_quantity, + json_extract_path_text(Properties, 'AvailableQuantity') as available_quantity, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ConsumableResource' + AND data__Identifier = '' + AND region = 'us-east-1' + consumable_resources_list_only: + name: consumable_resources_list_only + id: awscc.batch.consumable_resources_list_only + x-cfn-schema-name: ConsumableResource + x-cfn-type-name: AWS::Batch::ConsumableResource + x-identifiers: + - ConsumableResourceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConsumableResourceArn') as consumable_resource_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ConsumableResource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConsumableResourceArn') as consumable_resource_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ConsumableResource' + AND region = 'us-east-1' + job_definitions: + name: job_definitions + id: awscc.batch.job_definitions + x-cfn-schema-name: JobDefinition + x-cfn-type-name: AWS::Batch::JobDefinition + x-identifiers: + - JobDefinitionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__JobDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::JobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::JobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::JobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/job_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/job_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/job_definitions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ContainerProperties') as container_properties, + JSON_EXTRACT(Properties, '$.EcsProperties') as ecs_properties, + JSON_EXTRACT(Properties, '$.NodeProperties') as node_properties, + JSON_EXTRACT(Properties, '$.JobDefinitionName') as job_definition_name, + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn, + JSON_EXTRACT(Properties, '$.SchedulingPriority') as scheduling_priority, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.PlatformCapabilities') as platform_capabilities, + JSON_EXTRACT(Properties, '$.PropagateTags') as propagate_tags, + JSON_EXTRACT(Properties, '$.RetryStrategy') as retry_strategy, + JSON_EXTRACT(Properties, '$.Timeout') as timeout, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.EksProperties') as eks_properties, + JSON_EXTRACT(Properties, '$.ConsumableResourceProperties') as consumable_resource_properties + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::JobDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContainerProperties') as container_properties, + json_extract_path_text(Properties, 'EcsProperties') as ecs_properties, + json_extract_path_text(Properties, 'NodeProperties') as node_properties, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, + json_extract_path_text(Properties, 'SchedulingPriority') as scheduling_priority, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'PlatformCapabilities') as platform_capabilities, + json_extract_path_text(Properties, 'PropagateTags') as propagate_tags, + json_extract_path_text(Properties, 'RetryStrategy') as retry_strategy, + json_extract_path_text(Properties, 'Timeout') as timeout, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EksProperties') as eks_properties, + json_extract_path_text(Properties, 'ConsumableResourceProperties') as consumable_resource_properties + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::JobDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + job_definitions_list_only: + name: job_definitions_list_only + id: awscc.batch.job_definitions_list_only + x-cfn-schema-name: JobDefinition + x-cfn-type-name: AWS::Batch::JobDefinition + x-identifiers: + - JobDefinitionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.JobDefinitionName') as job_definition_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobDefinition' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobDefinition' AND region = 'us-east-1' - job_queue: - name: job_queue - id: awscc.batch.job_queue + job_queues: + name: job_queues + id: awscc.batch.job_queues x-cfn-schema-name: JobQueue - x-type: get + x-cfn-type-name: AWS::Batch::JobQueue x-identifiers: - JobQueueArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__JobQueue&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::JobQueue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::JobQueue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::JobQueue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/job_queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/job_queues/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/job_queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.JobQueueName') as job_queue_name, JSON_EXTRACT(Properties, '$.JobQueueArn') as job_queue_arn, + JSON_EXTRACT(Properties, '$.JobQueueType') as job_queue_type, JSON_EXTRACT(Properties, '$.ComputeEnvironmentOrder') as compute_environment_order, + JSON_EXTRACT(Properties, '$.ServiceEnvironmentOrder') as service_environment_order, + JSON_EXTRACT(Properties, '$.JobStateTimeLimitActions') as job_state_time_limit_actions, JSON_EXTRACT(Properties, '$.Priority') as priority, JSON_EXTRACT(Properties, '$.State') as state, JSON_EXTRACT(Properties, '$.SchedulingPolicyArn') as scheduling_policy_arn, @@ -460,14 +2708,17 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'JobQueueName') as job_queue_name, json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn, + json_extract_path_text(Properties, 'JobQueueType') as job_queue_type, json_extract_path_text(Properties, 'ComputeEnvironmentOrder') as compute_environment_order, + json_extract_path_text(Properties, 'ServiceEnvironmentOrder') as service_environment_order, + json_extract_path_text(Properties, 'JobStateTimeLimitActions') as job_state_time_limit_actions, json_extract_path_text(Properties, 'Priority') as priority, json_extract_path_text(Properties, 'State') as state, json_extract_path_text(Properties, 'SchedulingPolicyArn') as scheduling_policy_arn, @@ -475,13 +2726,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::JobQueue' AND data__Identifier = '' AND region = 'us-east-1' - scheduling_policies: - name: scheduling_policies - id: awscc.batch.scheduling_policies - x-cfn-schema-name: SchedulingPolicy - x-type: list + job_queues_list_only: + name: job_queues_list_only + id: awscc.batch.job_queues_list_only + x-cfn-schema-name: JobQueue + x-cfn-type-name: AWS::Batch::JobQueue x-identifiers: - - Arn + - JobQueueArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -489,28 +2746,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' + JSON_EXTRACT(Properties, '$.JobQueueArn') as job_queue_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' + json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' AND region = 'us-east-1' - scheduling_policy: - name: scheduling_policy - id: awscc.batch.scheduling_policy + scheduling_policies: + name: scheduling_policies + id: awscc.batch.scheduling_policies x-cfn-schema-name: SchedulingPolicy - x-type: get + x-cfn-type-name: AWS::Batch::SchedulingPolicy x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SchedulingPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::SchedulingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::SchedulingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::SchedulingPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -523,7 +2828,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -535,3 +2840,557 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' AND data__Identifier = '' AND region = 'us-east-1' + scheduling_policies_list_only: + name: scheduling_policies_list_only + id: awscc.batch.scheduling_policies_list_only + x-cfn-schema-name: SchedulingPolicy + x-cfn-type-name: AWS::Batch::SchedulingPolicy + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' + AND region = 'us-east-1' + service_environments: + name: service_environments + id: awscc.batch.service_environments + x-cfn-schema-name: ServiceEnvironment + x-cfn-type-name: AWS::Batch::ServiceEnvironment + x-identifiers: + - ServiceEnvironmentArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceEnvironment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ServiceEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ServiceEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Batch::ServiceEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_environments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ServiceEnvironmentArn') as service_environment_arn, + JSON_EXTRACT(Properties, '$.ServiceEnvironmentName') as service_environment_name, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.ServiceEnvironmentType') as service_environment_type, + JSON_EXTRACT(Properties, '$.CapacityLimits') as capacity_limits, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ServiceEnvironment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ServiceEnvironmentArn') as service_environment_arn, + json_extract_path_text(Properties, 'ServiceEnvironmentName') as service_environment_name, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'ServiceEnvironmentType') as service_environment_type, + json_extract_path_text(Properties, 'CapacityLimits') as capacity_limits, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ServiceEnvironment' + AND data__Identifier = '' + AND region = 'us-east-1' + service_environments_list_only: + name: service_environments_list_only + id: awscc.batch.service_environments_list_only + x-cfn-schema-name: ServiceEnvironment + x-cfn-type-name: AWS::Batch::ServiceEnvironment + x-identifiers: + - ServiceEnvironmentArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ServiceEnvironmentArn') as service_environment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ServiceEnvironment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceEnvironmentArn') as service_environment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ServiceEnvironment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ComputeEnvironment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComputeEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComputeEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConsumableResource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConsumableResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConsumableResourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__JobDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateJobDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateJobDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__JobQueue&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateJobQueue + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateJobQueueRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SchedulingPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchedulingPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSchedulingPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceEnvironment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/bcmdataexports.yaml b/providers/src/awscc/v00.00.00000/services/bcmdataexports.yaml new file mode 100644 index 00000000..47a63978 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/bcmdataexports.yaml @@ -0,0 +1,919 @@ +openapi: 3.0.0 +info: + title: BCMDataExports + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + CompressionOption: + type: string + enum: + - GZIP + - PARQUET + DataQuery: + type: object + properties: + QueryStatement: + type: string + maxLength: 36000 + minLength: 1 + pattern: ^[\S\s]*$ + TableConfigurations: + $ref: '#/components/schemas/TableConfigurations' + required: + - QueryStatement + additionalProperties: false + DestinationConfigurations: + type: object + properties: + S3Destination: + $ref: '#/components/schemas/S3Destination' + required: + - S3Destination + additionalProperties: false + Export: + type: object + properties: + Export: + $ref: '#/components/schemas/Export' + ExportArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' + maxItems: 200 + minItems: 0 + required: + - Export + x-stackql-resource-name: export + description: Definition of AWS::BCMDataExports::Export Resource Type + x-type-name: AWS::BCMDataExports::Export + x-documentation-url: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DataExports_CreateExport.html#API_DataExports_CreateExport_RequestSyntax + x-stackql-primary-identifier: + - ExportArn + x-create-only-properties: + - Export/Name + - Export/DataQuery/TableConfigurations + - Export/RefreshCadence + x-read-only-properties: + - ExportArn + x-required-properties: + - Export + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - bcm-data-exports:ListTagsForResource + - bcm-data-exports:TagResource + - bcm-data-exports:UntagResource + x-required-permissions: + create: + - bcm-data-exports:CreateExport + - bcm-data-exports:GetExport + - bcm-data-exports:ListTagsForResource + - bcm-data-exports:TagResource + - cur:PutReportDefinition + read: + - bcm-data-exports:GetExport + - bcm-data-exports:ListTagsForResource + update: + - bcm-data-exports:UpdateExport + - bcm-data-exports:TagResource + - bcm-data-exports:UntagResource + - bcm-data-exports:GetExport + - bcm-data-exports:ListTagsForResource + delete: + - bcm-data-exports:DeleteExport + list: + - bcm-data-exports:ListExports + FormatOption: + type: string + enum: + - TEXT_OR_CSV + - PARQUET + FrequencyOption: + type: string + enum: + - SYNCHRONOUS + OverwriteOption: + type: string + enum: + - CREATE_NEW_REPORT + - OVERWRITE_REPORT + RefreshCadence: + type: object + properties: + Frequency: + $ref: '#/components/schemas/FrequencyOption' + required: + - Frequency + additionalProperties: false + ResourceTag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 0 + required: + - Key + - Value + additionalProperties: false + S3Destination: + type: object + properties: + S3Bucket: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^[\S\s]*$ + S3Prefix: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^[\S\s]*$ + S3Region: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^[\S\s]*$ + S3OutputConfigurations: + $ref: '#/components/schemas/S3OutputConfigurations' + required: + - S3Bucket + - S3OutputConfigurations + - S3Prefix + - S3Region + additionalProperties: false + S3OutputConfigurations: + type: object + properties: + OutputType: + $ref: '#/components/schemas/S3OutputType' + Format: + $ref: '#/components/schemas/FormatOption' + Compression: + $ref: '#/components/schemas/CompressionOption' + Overwrite: + $ref: '#/components/schemas/OverwriteOption' + required: + - Compression + - Format + - OutputType + - Overwrite + additionalProperties: false + S3OutputType: + type: string + enum: + - CUSTOM + TableConfigurations: + type: object + x-patternProperties: + ^[\S\s]*$: + $ref: '#/components/schemas/TableProperties' + additionalProperties: false + TableProperties: + type: object + x-patternProperties: + ^[\S\s]*$: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^[\S\s]*$ + additionalProperties: false + CreateExportRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Export: + $ref: '#/components/schemas/Export' + ExportArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[-a-z0-9]*:[-a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateExportRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + exports: + name: exports + id: awscc.bcmdataexports.exports + x-cfn-schema-name: Export + x-cfn-type-name: AWS::BCMDataExports::Export + x-identifiers: + - ExportArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Export&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BCMDataExports::Export" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BCMDataExports::Export" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BCMDataExports::Export" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/exports/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/exports/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/exports/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Export') as export, + JSON_EXTRACT(Properties, '$.ExportArn') as export_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BCMDataExports::Export' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Export') as export, + json_extract_path_text(Properties, 'ExportArn') as export_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BCMDataExports::Export' + AND data__Identifier = '' + AND region = 'us-east-1' + exports_list_only: + name: exports_list_only + id: awscc.bcmdataexports.exports_list_only + x-cfn-schema-name: Export + x-cfn-type-name: AWS::BCMDataExports::Export + x-identifiers: + - ExportArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ExportArn') as export_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BCMDataExports::Export' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ExportArn') as export_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BCMDataExports::Export' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Export&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateExport + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateExportRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/bedrock.yaml b/providers/src/awscc/v00.00.00000/services/bedrock.yaml new file mode 100644 index 00000000..1f5249c9 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/bedrock.yaml @@ -0,0 +1,10865 @@ +openapi: 3.0.0 +info: + title: Bedrock + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + APISchema: + description: Contains information about the API Schema for the Action Group + oneOf: + - type: object + title: S3 + properties: + S3: + $ref: '#/components/schemas/S3Identifier' + required: + - S3 + additionalProperties: false + - type: object + title: Payload + properties: + Payload: + type: string + description: String OpenAPI Payload + required: + - Payload + additionalProperties: false + ActionGroupExecutor: + description: Type of Executors for an Action Group + oneOf: + - type: object + title: Lambda + properties: + Lambda: + type: string + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: ARN of a Lambda. + required: + - Lambda + additionalProperties: false + - type: object + title: CustomControl + properties: + CustomControl: + $ref: '#/components/schemas/CustomControlMethod' + required: + - CustomControl + additionalProperties: false + ActionGroupSignature: + type: string + description: Action Group Signature for a BuiltIn Action + enum: + - AMAZON.UserInput + - AMAZON.CodeInterpreter + ActionGroupState: + type: string + description: State of the action group + enum: + - ENABLED + - DISABLED + AdditionalModelRequestFields: + type: object + description: Contains model-specific configurations + AgentActionGroup: + type: object + description: Contains the information of an Agent Action Group + properties: + ActionGroupName: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name of the action group + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of action group + ParentActionGroupSignature: + $ref: '#/components/schemas/ActionGroupSignature' + ActionGroupExecutor: + $ref: '#/components/schemas/ActionGroupExecutor' + ApiSchema: + $ref: '#/components/schemas/APISchema' + ActionGroupState: + $ref: '#/components/schemas/ActionGroupState' + FunctionSchema: + $ref: '#/components/schemas/FunctionSchema' + SkipResourceInUseCheckOnDelete: + description: Specifies whether to allow deleting action group while it is in use. + type: boolean + default: false + required: + - ActionGroupName + additionalProperties: false + AgentCollaboration: + type: string + description: Agent collaboration state + enum: + - DISABLED + - SUPERVISOR + - SUPERVISOR_ROUTER + AgentCollaborator: + type: object + description: Agent Collaborator + properties: + AgentDescriptor: + type: object + description: Agent descriptor for agent collaborator + properties: + AliasArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$ + description: Alias ARN for agent descriptor + additionalProperties: false + CollaborationInstruction: + type: string + description: Agent collaborator instruction + CollaboratorName: + type: string + description: Agent collaborator name + RelayConversationHistory: + $ref: '#/components/schemas/RelayConversationHistory' + required: + - AgentDescriptor + - CollaborationInstruction + - CollaboratorName + additionalProperties: false + AgentKnowledgeBase: + type: object + description: Agent Knowledge Base + properties: + KnowledgeBaseId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + KnowledgeBaseState: + $ref: '#/components/schemas/KnowledgeBaseState' + required: + - KnowledgeBaseId + - Description + additionalProperties: false + AgentStatus: + type: string + description: Schema Type for Action APIs. + enum: + - CREATING + - PREPARING + - PREPARED + - NOT_PREPARED + - DELETING + - FAILED + - VERSIONING + - UPDATING + CreationMode: + type: string + description: Creation Mode for Prompt Configuration. + enum: + - DEFAULT + - OVERRIDDEN + CustomOrchestration: + type: object + description: Structure for custom orchestration + properties: + Executor: + $ref: '#/components/schemas/OrchestrationExecutor' + additionalProperties: false + CustomControlMethod: + type: string + description: Custom control of action execution + enum: + - RETURN_CONTROL + FoundationModel: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$ + description: ARN or name of a Bedrock model. + Function: + type: object + description: Function definition + properties: + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + Description: + type: string + maxLength: 1200 + minLength: 1 + description: Description of function + Parameters: + $ref: '#/components/schemas/ParameterMap' + RequireConfirmation: + $ref: '#/components/schemas/RequireConfirmation' + required: + - Name + additionalProperties: false + FunctionSchema: + description: Schema of Functions + type: object + x-title: Functions + properties: + Functions: + type: array + items: + $ref: '#/components/schemas/Function' + description: List of Function definitions + x-insertionOrder: false + required: + - Functions + additionalProperties: false + GuardrailConfiguration: + type: object + description: Configuration for a guardrail + properties: + GuardrailIdentifier: + type: string + maxLength: 2048 + pattern: ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$ + description: Identifier for the guardrail, could be the id or the arn + GuardrailVersion: + type: string + pattern: ^(([0-9]{1,8})|(DRAFT))$ + description: Version of the guardrail + additionalProperties: false + MemoryConfiguration: + type: object + description: Configuration for memory storage + properties: + EnabledMemoryTypes: + $ref: '#/components/schemas/EnabledMemoryTypes' + StorageDays: + type: number + description: Maximum number of days to store session details + SessionSummaryConfiguration: + $ref: '#/components/schemas/SessionSummaryConfiguration' + additionalProperties: false + EnabledMemoryTypes: + type: array + description: Types of session storage persisted in memory + items: + $ref: '#/components/schemas/MemoryType' + x-insertionOrder: false + MemoryType: + type: string + description: Memory type + enum: + - SESSION_SUMMARY + SessionSummaryConfiguration: + type: object + description: Configuration for Session Summarization + properties: + MaxRecentSessions: + type: number + description: Maximum number of Sessions to Summarize + additionalProperties: false + InferenceConfiguration: + type: object + description: Configuration for inference in prompt configuration + properties: + Temperature: + type: number + maximum: 1 + minimum: 0 + description: Controls randomness, higher values increase diversity + TopP: + type: number + maximum: 1 + minimum: 0 + description: Cumulative probability cutoff for token selection + TopK: + type: number + maximum: 500 + minimum: 0 + description: Sample from the k most likely next tokens + MaximumLength: + type: number + maximum: 4096 + minimum: 0 + description: Maximum length of output + StopSequences: + type: array + items: + type: string + maxItems: 4 + minItems: 0 + description: List of stop sequences + x-insertionOrder: false + additionalProperties: false + KnowledgeBaseState: + type: string + description: State of the knowledge base; whether it is enabled or disabled + enum: + - ENABLED + - DISABLED + OrchestrationExecutor: + description: Types of executors for custom orchestration strategy + type: object + x-title: Lambda + properties: + Lambda: + type: string + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: ARN of a Lambda. + required: + - Lambda + additionalProperties: false + OrchestrationType: + type: string + description: Types of orchestration strategy for agents + enum: + - DEFAULT + - CUSTOM_ORCHESTRATION + ParameterDetail: + type: object + description: Parameter detail + properties: + Description: + type: string + maxLength: 500 + minLength: 1 + description: Description of function parameter. + Type: + $ref: '#/components/schemas/Type' + Required: + type: boolean + description: Information about if a parameter is required for function call. Default to false. + required: + - Type + additionalProperties: false + ParameterMap: + type: object + description: A map of parameter name and detail + x-patternProperties: + ^([0-9a-zA-Z][_-]?){1,100}$: + $ref: '#/components/schemas/ParameterDetail' + additionalProperties: false + PromptConfiguration: + type: object + description: BasePromptConfiguration per Prompt Type. + properties: + PromptType: + $ref: '#/components/schemas/PromptType' + PromptCreationMode: + $ref: '#/components/schemas/CreationMode' + PromptState: + $ref: '#/components/schemas/PromptState' + BasePromptTemplate: + type: string + maxLength: 100000 + minLength: 1 + description: Base Prompt Template. + InferenceConfiguration: + $ref: '#/components/schemas/InferenceConfiguration' + ParserMode: + $ref: '#/components/schemas/CreationMode' + FoundationModel: + $ref: '#/components/schemas/FoundationModel' + AdditionalModelRequestFields: + $ref: '#/components/schemas/AdditionalModelRequestFields' + additionalProperties: false + PromptOverrideConfiguration: + type: object + description: Configuration for prompt override. + properties: + PromptConfigurations: + type: array + items: + $ref: '#/components/schemas/PromptConfiguration' + maxItems: 10 + description: List of BasePromptConfiguration + x-insertionOrder: false + OverrideLambda: + type: string + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: ARN of a Lambda. + required: + - PromptConfigurations + additionalProperties: false + PromptState: + type: string + description: Prompt State. + enum: + - ENABLED + - DISABLED + PromptType: + type: string + description: Prompt Type. + enum: + - PRE_PROCESSING + - ORCHESTRATION + - POST_PROCESSING + - ROUTING_CLASSIFIER + - MEMORY_SUMMARIZATION + - KNOWLEDGE_BASE_RESPONSE_GENERATION + RelayConversationHistory: + type: string + description: Relay conversation history state + enum: + - TO_COLLABORATOR + - DISABLED + RequireConfirmation: + type: string + description: ENUM to check if action requires user confirmation + enum: + - ENABLED + - DISABLED + S3Identifier: + type: object + description: The identifier for the S3 resource. + properties: + S3BucketName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + description: A bucket in S3. + S3ObjectKey: + type: string + maxLength: 1024 + minLength: 1 + pattern: ^[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*$ + description: A object key in S3. + additionalProperties: false + TagsMap: + type: object + description: A map of tag keys and values + x-patternProperties: + ^[a-zA-Z0-9\s._:/=+@-]*$: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: Value of a tag + additionalProperties: false + Type: + type: string + description: Parameter Type + enum: + - string + - number + - integer + - boolean + - array + Agent: + type: object + properties: + ActionGroups: + type: array + items: + $ref: '#/components/schemas/AgentActionGroup' + description: List of ActionGroups + x-insertionOrder: false + AgentArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$ + description: Arn representation of the Agent. + AgentId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + AgentName: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + AgentResourceRoleArn: + type: string + maxLength: 2048 + description: ARN of a IAM role. + AgentStatus: + $ref: '#/components/schemas/AgentStatus' + AgentVersion: + type: string + maxLength: 5 + minLength: 5 + pattern: ^DRAFT$ + description: Draft Agent Version. + AutoPrepare: + description: Specifies whether to automatically prepare after creating or updating the agent. + type: boolean + default: false + CreatedAt: + type: string + description: Time Stamp. + format: date-time + CustomOrchestration: + $ref: '#/components/schemas/CustomOrchestration' + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + SkipResourceInUseCheckOnDelete: + description: Specifies whether to allow deleting agent while it is in use. + type: boolean + default: false + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: Failure Reasons for Error. + x-insertionOrder: false + FoundationModel: + $ref: '#/components/schemas/FoundationModel' + GuardrailConfiguration: + $ref: '#/components/schemas/GuardrailConfiguration' + MemoryConfiguration: + $ref: '#/components/schemas/MemoryConfiguration' + IdleSessionTTLInSeconds: + type: number + maximum: 3600 + minimum: 60 + description: Max Session Time. + AgentCollaboration: + $ref: '#/components/schemas/AgentCollaboration' + Instruction: + type: string + minLength: 40 + description: Instruction for the agent. + KnowledgeBases: + type: array + items: + $ref: '#/components/schemas/AgentKnowledgeBase' + description: List of Agent Knowledge Bases + x-insertionOrder: false + AgentCollaborators: + type: array + items: + $ref: '#/components/schemas/AgentCollaborator' + description: List of Agent Collaborators + x-insertionOrder: false + OrchestrationType: + $ref: '#/components/schemas/OrchestrationType' + PreparedAt: + type: string + description: Time Stamp. + format: date-time + PromptOverrideConfiguration: + $ref: '#/components/schemas/PromptOverrideConfiguration' + RecommendedActions: + type: array + items: + type: string + maxLength: 2048 + description: The recommended action users can take to resolve an error in failureReasons. + maxItems: 2048 + description: The recommended actions users can take to resolve an error in failureReasons. + x-insertionOrder: false + Tags: + $ref: '#/components/schemas/TagsMap' + TestAliasTags: + $ref: '#/components/schemas/TagsMap' + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + required: + - AgentName + x-stackql-resource-name: agent + description: Definition of AWS::Bedrock::Agent Resource Type + x-type-name: AWS::Bedrock::Agent + x-stackql-primary-identifier: + - AgentId + x-write-only-properties: + - AutoPrepare + - SkipResourceInUseCheckOnDelete + - ActionGroups/*/SkipResourceInUseCheckOnDelete + x-read-only-properties: + - AgentArn + - AgentId + - AgentStatus + - AgentVersion + - CreatedAt + - FailureReasons + - PreparedAt + - RecommendedActions + - UpdatedAt + x-required-properties: + - AgentName + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateAgent + - bedrock:GetAgent + - bedrock:PrepareAgent + - bedrock:GetAgentKnowledgeBase + - bedrock:AssociateAgentKnowledgeBase + - bedrock:ListAgentKnowledgeBases + - bedrock:CreateAgentActionGroup + - bedrock:GetAgentActionGroup + - bedrock:ListAgentActionGroups + - bedrock:TagResource + - bedrock:ListTagsForResource + - bedrock:CreateGuardrail + - bedrock:CreateGuardrailVersion + - bedrock:GetGuardrail + - bedrock:AssociateAgentCollaborator + - bedrock:GetAgentCollaborator + - bedrock:ListAgentCollaborators + - iam:PassRole + - kms:GenerateDataKeyWithoutPlainText + - kms:ReEncryptFrom + - kms:ReEncryptTo + - kms:Decrypt + - kms:GenerateDataKey + read: + - bedrock:GetAgent + - bedrock:GetAgentActionGroup + - bedrock:ListAgentActionGroups + - bedrock:GetAgentKnowledgeBase + - bedrock:ListAgentKnowledgeBases + - bedrock:ListTagsForResource + - bedrock:GetGuardrail + - bedrock:GetAgentCollaborator + - bedrock:ListAgentCollaborators + - kms:Decrypt + - kms:GenerateDataKey + - kms:Encrypt + update: + - bedrock:GetAgent + - bedrock:UpdateAgent + - bedrock:PrepareAgent + - bedrock:GetAgentKnowledgeBase + - bedrock:UpdateAgentKnowledgeBase + - bedrock:AssociateAgentKnowledgeBase + - bedrock:DisassociateAgentKnowledgeBase + - bedrock:ListAgentKnowledgeBases + - bedrock:CreateAgentActionGroup + - bedrock:GetAgentActionGroup + - bedrock:UpdateAgentActionGroup + - bedrock:DeleteAgentActionGroup + - bedrock:ListAgentActionGroups + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + - bedrock:UpdateGuardrail + - bedrock:GetGuardrail + - bedrock:AssociateAgentCollaborator + - bedrock:GetAgentCollaborator + - bedrock:ListAgentCollaborators + - bedrock:DisassociateAgentCollaborator + - bedrock:UpdateAgentCollaborator + - kms:Decrypt + - kms:Encrypt + - kms:GenerateDataKey + - kms:GenerateDataKeyWithoutPlainText + - kms:ReEncryptFrom + - kms:ReEncryptTo + - iam:PassRole + delete: + - bedrock:GetAgent + - bedrock:DeleteAgent + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + - kms:Decrypt + - kms:Encrypt + - kms:GenerateDataKey + list: + - bedrock:ListAgents + - bedrock:ListGuardrails + AgentAliasHistoryEvent: + type: object + description: History event for an alias for an Agent. + properties: + RoutingConfiguration: + type: array + items: + $ref: '#/components/schemas/AgentAliasRoutingConfigurationListItem' + maxItems: 1 + description: Routing configuration for an Agent alias. + x-insertionOrder: false + EndDate: + type: string + description: Time Stamp. + StartDate: + type: string + description: Time Stamp. + additionalProperties: false + AgentAliasRoutingConfigurationListItem: + type: object + description: Details about the routing configuration for an Agent alias. + properties: + AgentVersion: + type: string + maxLength: 5 + minLength: 1 + pattern: ^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$ + description: Agent Version. + required: + - AgentVersion + additionalProperties: false + AgentAliasStatus: + type: string + description: The statuses an Agent Alias can be in. + enum: + - CREATING + - PREPARED + - FAILED + - UPDATING + - DELETING + AgentAlias: + type: object + properties: + AgentAliasArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$ + description: Arn representation of the Agent Alias. + AgentAliasHistoryEvents: + type: array + items: + $ref: '#/components/schemas/AgentAliasHistoryEvent' + maxItems: 10 + description: The list of history events for an alias for an Agent. + x-insertionOrder: false + AgentAliasId: + type: string + maxLength: 10 + minLength: 10 + pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$ + description: Id for an Agent Alias generated at the server side. + AgentAliasName: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + AgentAliasStatus: + $ref: '#/components/schemas/AgentAliasStatus' + AgentId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + CreatedAt: + type: string + description: Time Stamp. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + RoutingConfiguration: + type: array + items: + $ref: '#/components/schemas/AgentAliasRoutingConfigurationListItem' + maxItems: 1 + description: Routing configuration for an Agent alias. + x-insertionOrder: false + Tags: + $ref: '#/components/schemas/TagsMap' + UpdatedAt: + type: string + description: Time Stamp. + required: + - AgentAliasName + - AgentId + x-stackql-resource-name: agent_alias + description: Definition of AWS::Bedrock::AgentAlias Resource Type + x-type-name: AWS::Bedrock::AgentAlias + x-stackql-primary-identifier: + - AgentId + - AgentAliasId + x-stackql-additional-identifiers: + - - AgentAliasArn + x-create-only-properties: + - AgentId + x-read-only-properties: + - AgentAliasArn + - AgentAliasHistoryEvents + - AgentAliasId + - AgentAliasStatus + - CreatedAt + - UpdatedAt + x-required-properties: + - AgentAliasName + - AgentId + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:PrepareAgent + - bedrock:GetAgent + - bedrock:CreateAgentAlias + - bedrock:TagResource + - bedrock:GetAgentAlias + - bedrock:ListTagsForResource + read: + - bedrock:GetAgentAlias + - bedrock:ListTagsForResource + update: + - bedrock:PrepareAgent + - bedrock:GetAgent + - bedrock:UpdateAgentAlias + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:GetAgentAlias + - bedrock:ListTagsForResource + delete: + - bedrock:DeleteAgentAlias + list: + - bedrock:ListAgentAliases + InferenceProfileModelSource: + description: Various ways to encode a list of models in a CreateInferenceProfile request + oneOf: + - type: object + title: CopyFrom + properties: + CopyFrom: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|foundation-model)/[a-zA-Z0-9-:.]+$ + description: |- + Source arns for a custom inference profile to copy its regional load balancing config from. This + can either be a foundation model or predefined inference profile ARN. + required: + - CopyFrom + additionalProperties: false + InferenceProfileStatus: + type: string + description: Status of the Inference Profile + enum: + - ACTIVE + InferenceProfileType: + type: string + description: Type of the Inference Profile + enum: + - APPLICATION + - SYSTEM_DEFINED + InferenceProfileModel: + type: object + description: Model configuration + properties: + ModelArn: + type: string + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$ + description: ARN for Foundation Models in Bedrock. These models can be used as base models for model customization jobs + additionalProperties: false + Tag: + type: object + description: Definition of the key/value pair for a tag + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: Tag Key + Value: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: Tag Value + required: + - Key + - Value + additionalProperties: false + Unit: + type: object + additionalProperties: false + ApplicationInferenceProfile: + type: object + properties: + CreatedAt: + type: string + description: Time Stamp + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + pattern: ^([0-9a-zA-Z:.][ _-]?)+$ + description: Description of the inference profile + InferenceProfileArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$ + InferenceProfileId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-:.]+$ + InferenceProfileIdentifier: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+$ + description: Inference profile identifier. Supports both system-defined inference profile ids, and inference profile ARNs. + InferenceProfileName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^([0-9a-zA-Z][ _-]?)+$ + ModelSource: + $ref: '#/components/schemas/InferenceProfileModelSource' + Models: + type: array + items: + $ref: '#/components/schemas/InferenceProfileModel' + maxItems: 5 + minItems: 1 + description: List of model configuration + Status: + $ref: '#/components/schemas/InferenceProfileStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + Type: + $ref: '#/components/schemas/InferenceProfileType' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + required: + - InferenceProfileName + x-stackql-resource-name: application_inference_profile + description: Definition of AWS::Bedrock::ApplicationInferenceProfile Resource Type + x-type-name: AWS::Bedrock::ApplicationInferenceProfile + x-stackql-primary-identifier: + - InferenceProfileIdentifier + x-create-only-properties: + - Description + - InferenceProfileName + - ModelSource + x-write-only-properties: + - ModelSource + x-read-only-properties: + - Models + - InferenceProfileArn + - InferenceProfileId + - InferenceProfileIdentifier + - Status + - Type + - CreatedAt + - UpdatedAt + x-required-properties: + - InferenceProfileName + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateInferenceProfile + - bedrock:GetInferenceProfile + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetInferenceProfile + - bedrock:ListTagsForResource + update: + - bedrock:GetInferenceProfile + - bedrock:ListTagsForResource + - bedrock:TagResource + - bedrock:UntagResource + delete: + - bedrock:DeleteInferenceProfile + - bedrock:GetInferenceProfile + list: + - bedrock:ListInferenceProfiles + Name: + type: string + pattern: ^[0-9a-zA-Z-_ ]+$ + minLength: 1 + maxLength: 256 + description: The name inherited from the policy + Description: + type: string + pattern: ^[\s\S]+$ + maxLength: 1024 + description: The description inherited from the policy + PolicyDefinitionRule: + type: object + properties: + Id: + type: string + pattern: ^[A-Z][0-9A-Z]{11}$ + minLength: 12 + maxLength: 12 + description: A unique id within the PolicyDefinition + Expression: + type: string + pattern: ^[\s\S]+$ + maxLength: 2048 + description: The SMT expression for this rule + AlternateExpression: + type: string + pattern: ^[\s\S]+$ + maxLength: 2048 + description: An alternate expression for this rule + required: + - Id + - Expression + additionalProperties: false + PolicyDefinitionRuleList: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PolicyDefinitionRule' + maxItems: 500 + PolicyDefinitionTypeValue: + type: object + properties: + Value: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_]+$ + minLength: 1 + maxLength: 64 + description: The value of the type value. + Description: + type: string + pattern: ^[\s\S]+$ + maxLength: 1024 + description: A natural language description of the type's value. + required: + - Value + additionalProperties: false + PolicyDefinitionTypeValueList: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PolicyDefinitionTypeValue' + minItems: 1 + maxItems: 50 + PolicyDefinitionType: + type: object + properties: + Name: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_]+$ + minLength: 1 + maxLength: 64 + description: A name for this type. + Description: + type: string + pattern: ^[\s\S]+$ + maxLength: 1024 + description: A natural language description of this type. + Values: + $ref: '#/components/schemas/PolicyDefinitionTypeValueList' + description: A list of valid values for this type. + required: + - Name + - Values + additionalProperties: false + PolicyDefinitionTypeList: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PolicyDefinitionType' + maxItems: 50 + PolicyDefinitionVariable: + type: object + properties: + Name: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_]+$ + minLength: 1 + maxLength: 64 + description: A name from this variable. + Type: + type: string + pattern: ^[A-Za-z][A-Za-z0-9_]+$ + minLength: 1 + maxLength: 64 + description: A type for this variable. + Description: + type: string + pattern: ^[\s\S]+$ + maxLength: 1024 + description: A natural language description of this variable. + required: + - Name + - Type + - Description + additionalProperties: false + PolicyDefinitionVariableList: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PolicyDefinitionVariable' + maxItems: 200 + PolicyDefinition: + type: object + properties: + Version: + type: string + description: The policy format version. + Types: + $ref: '#/components/schemas/PolicyDefinitionTypeList' + description: The types definition block of an AutomatedReasoningPolicyDefinition. + Rules: + $ref: '#/components/schemas/PolicyDefinitionRuleList' + description: The rules definition block of an AutomatedReasoningPolicyDefinition. + Variables: + $ref: '#/components/schemas/PolicyDefinitionVariableList' + description: The variables definition block of an AutomatedReasoningPolicyDefinition. + additionalProperties: false + PolicyArn: + type: string + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy\/[a-z0-9]{12}$ + minLength: 1 + maxLength: 2048 + description: 'Arn of the policy ' + Version: + type: string + pattern: ^([1-9][0-9]{0,11})$ + maxLength: 12 + description: The version of the policy + DefinitionHash: + type: string + pattern: ^[0-9a-z]{128}$ + minLength: 128 + maxLength: 128 + description: The hash for this version + CreatedAt: + type: string + format: date-time + description: Time this policy version was created + UpdatedAt: + type: string + format: date-time + description: Time this policy was last updated + PolicyId: + type: string + pattern: ^[a-z0-9]{12}$ + minLength: 1 + maxLength: 2048 + description: The id of the associated policy + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AutomatedReasoningPolicy: + type: object + properties: + Name: + $ref: '#/components/schemas/Name' + Description: + $ref: '#/components/schemas/Description' + PolicyDefinition: + $ref: '#/components/schemas/PolicyDefinition' + PolicyArn: + $ref: '#/components/schemas/PolicyArn' + Version: + $ref: '#/components/schemas/Version' + DefinitionHash: + $ref: '#/components/schemas/DefinitionHash' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + PolicyId: + $ref: '#/components/schemas/PolicyId' + Tags: + $ref: '#/components/schemas/Tags' + required: + - Name + x-stackql-resource-name: automated_reasoning_policy + description: Definition of AWS::Bedrock::AutomatedReasoningPolicy Resource Type + x-type-name: AWS::Bedrock::AutomatedReasoningPolicy + x-stackql-primary-identifier: + - PolicyArn + x-read-only-properties: + - Version + - PolicyId + - PolicyArn + - DefinitionHash + - CreatedAt + - UpdatedAt + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - bedrock:TagResource + - bedrock:ListTagsForResource + - bedrock:UntagResource + x-required-permissions: + create: + - bedrock:CreateAutomatedReasoningPolicy + - bedrock:GetAutomatedReasoningPolicy + - bedrock:ExportAutomatedReasoningPolicyVersion + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetAutomatedReasoningPolicy + - bedrock:ExportAutomatedReasoningPolicyVersion + - bedrock:ListTagsForResource + update: + - bedrock:UpdateAutomatedReasoningPolicy + - bedrock:GetAutomatedReasoningPolicy + - bedrock:ExportAutomatedReasoningPolicyVersion + - bedrock:ListTagsForResource + - bedrock:TagResource + - bedrock:UntagResource + delete: + - bedrock:DeleteAutomatedReasoningPolicy + - bedrock:GetAutomatedReasoningPolicy + list: + - bedrock:ListAutomatedReasoningPolicies + AutomatedReasoningPolicyVersion: + type: object + properties: + PolicyArn: + $ref: '#/components/schemas/PolicyArn' + Name: + $ref: '#/components/schemas/Name' + Description: + $ref: '#/components/schemas/Description' + Version: + $ref: '#/components/schemas/Version' + DefinitionHash: + $ref: '#/components/schemas/DefinitionHash' + LastUpdatedDefinitionHash: + $ref: '#/components/schemas/DefinitionHash' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + PolicyId: + $ref: '#/components/schemas/PolicyId' + Tags: + $ref: '#/components/schemas/Tags' + required: + - PolicyArn + x-stackql-resource-name: automated_reasoning_policy_version + description: Definition of AWS::Bedrock::AutomatedReasoningPolicyVersion Resource Type + x-type-name: AWS::Bedrock::AutomatedReasoningPolicyVersion + x-stackql-primary-identifier: + - PolicyArn + - Version + x-create-only-properties: + - PolicyArn + - LastUpdatedDefinitionHash + - Tags + x-write-only-properties: + - LastUpdatedDefinitionHash + x-read-only-properties: + - Version + - Name + - Description + - CreatedAt + - UpdatedAt + - PolicyId + - DefinitionHash + x-required-properties: + - PolicyArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - bedrock:TagResource + - bedrock:ListTagsForResource + - bedrock:UntagResource + x-required-permissions: + create: + - bedrock:CreateAutomatedReasoningPolicyVersion + - bedrock:GetAutomatedReasoningPolicy + - bedrock:ExportAutomatedReasoningPolicyVersion + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetAutomatedReasoningPolicy + - bedrock:ExportAutomatedReasoningPolicyVersion + - bedrock:ListTagsForResource + delete: + - bedrock:DeleteAutomatedReasoningPolicy + - bedrock:GetAutomatedReasoningPolicy + list: + - bedrock:ListAutomatedReasoningPolicies + Blueprint: + type: object + properties: + BlueprintArn: + type: string + maxLength: 128 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$ + description: ARN of a Blueprint + BlueprintName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]+$ + description: Name of the Blueprint + CreationTime: + type: string + description: Creation timestamp + format: date-time + LastModifiedTime: + type: string + description: Last modified timestamp + format: date-time + Schema: + type: object + description: Schema of the blueprint + Type: + type: string + description: Modality Type + enum: + - DOCUMENT + - IMAGE + - AUDIO + - VIDEO + BlueprintStage: + type: string + description: Stage of the Blueprint + enum: + - DEVELOPMENT + - LIVE + KmsKeyId: + type: string + description: KMS key identifier + minLength: 1 + maxLength: 2048 + KmsEncryptionContext: + type: object + description: KMS encryption context + x-patternProperties: + ^.*$: + type: string + additionalProperties: false + x-dependencies: + KmsEncryptionContext: + - KmsKeyId + Tags: + description: List of Tags + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + required: + - BlueprintName + - Schema + - Type + x-stackql-resource-name: blueprint + description: Definition of AWS::Bedrock::Blueprint Resource Type + x-type-name: AWS::Bedrock::Blueprint + x-stackql-primary-identifier: + - BlueprintArn + x-create-only-properties: + - BlueprintName + - Type + x-read-only-properties: + - BlueprintArn + - BlueprintStage + - CreationTime + - LastModifiedTime + x-required-properties: + - BlueprintName + - Schema + - Type + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateBlueprint + - bedrock:GetBlueprint + - bedrock:TagResource + - bedrock:ListTagsForResource + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + read: + - bedrock:GetBlueprint + - bedrock:ListTagsForResource + - kms:DescribeKey + - kms:Decrypt + update: + - bedrock:UpdateBlueprint + - bedrock:GetBlueprint + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + delete: + - bedrock:DeleteBlueprint + - bedrock:GetBlueprint + - kms:DescribeKey + - kms:Decrypt + list: + - bedrock:ListBlueprints + AudioExtractionCategory: + type: object + properties: + State: + $ref: '#/components/schemas/State' + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/AudioExtractionCategoryType' + required: + - State + additionalProperties: false + AudioExtractionCategoryType: + type: string + enum: + - AUDIO_CONTENT_MODERATION + - TRANSCRIPT + - TOPIC_CONTENT_MODERATION + AudioStandardExtraction: + type: object + properties: + Category: + $ref: '#/components/schemas/AudioExtractionCategory' + required: + - Category + additionalProperties: false + AudioStandardGenerativeField: + type: object + properties: + State: + $ref: '#/components/schemas/State' + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/AudioStandardGenerativeFieldType' + required: + - State + additionalProperties: false + AudioStandardGenerativeFieldType: + type: string + enum: + - AUDIO_SUMMARY + - IAB + - TOPIC_SUMMARY + AudioStandardOutputConfiguration: + type: object + properties: + Extraction: + $ref: '#/components/schemas/AudioStandardExtraction' + GenerativeField: + $ref: '#/components/schemas/AudioStandardGenerativeField' + additionalProperties: false + BlueprintItem: + type: object + properties: + BlueprintArn: + type: string + maxLength: 128 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$ + description: ARN of a Blueprint + BlueprintVersion: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[0-9]*$ + description: Blueprint Version + BlueprintStage: + $ref: '#/components/schemas/BlueprintStage' + required: + - BlueprintArn + additionalProperties: false + BlueprintStage: + type: string + description: Stage of the Blueprint + enum: + - DEVELOPMENT + - LIVE + CustomOutputConfiguration: + type: object + description: Custom output configuration + properties: + Blueprints: + type: array + items: + $ref: '#/components/schemas/BlueprintItem' + additionalProperties: false + DataAutomationProjectStage: + type: string + description: Stage of the Project + enum: + - DEVELOPMENT + - LIVE + DataAutomationProjectStatus: + type: string + enum: + - COMPLETED + - IN_PROGRESS + - FAILED + DocumentBoundingBox: + type: object + properties: + State: + $ref: '#/components/schemas/State' + required: + - State + additionalProperties: false + DocumentExtractionGranularity: + type: object + properties: + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/DocumentExtractionGranularityType' + additionalProperties: false + DocumentExtractionGranularityType: + type: string + enum: + - DOCUMENT + - PAGE + - ELEMENT + - WORD + - LINE + DocumentOutputAdditionalFileFormat: + type: object + properties: + State: + $ref: '#/components/schemas/State' + required: + - State + additionalProperties: false + DocumentOutputFormat: + type: object + properties: + TextFormat: + $ref: '#/components/schemas/DocumentOutputTextFormat' + AdditionalFileFormat: + $ref: '#/components/schemas/DocumentOutputAdditionalFileFormat' + required: + - AdditionalFileFormat + - TextFormat + additionalProperties: false + DocumentOutputTextFormat: + type: object + properties: + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/DocumentOutputTextFormatType' + additionalProperties: false + DocumentOutputTextFormatType: + type: string + enum: + - PLAIN_TEXT + - MARKDOWN + - HTML + - CSV + DocumentOverrideConfiguration: + type: object + properties: + Splitter: + $ref: '#/components/schemas/SplitterConfiguration' + ModalityProcessing: + $ref: '#/components/schemas/ModalityProcessingConfiguration' + additionalProperties: false + AudioOverrideConfiguration: + type: object + properties: + ModalityProcessing: + $ref: '#/components/schemas/ModalityProcessingConfiguration' + additionalProperties: false + VideoOverrideConfiguration: + type: object + properties: + ModalityProcessing: + $ref: '#/components/schemas/ModalityProcessingConfiguration' + additionalProperties: false + ImageOverrideConfiguration: + type: object + properties: + ModalityProcessing: + $ref: '#/components/schemas/ModalityProcessingConfiguration' + additionalProperties: false + DocumentStandardExtraction: + type: object + properties: + Granularity: + $ref: '#/components/schemas/DocumentExtractionGranularity' + BoundingBox: + $ref: '#/components/schemas/DocumentBoundingBox' + required: + - BoundingBox + - Granularity + additionalProperties: false + DocumentStandardGenerativeField: + type: object + properties: + State: + $ref: '#/components/schemas/State' + required: + - State + additionalProperties: false + DocumentStandardOutputConfiguration: + type: object + properties: + Extraction: + $ref: '#/components/schemas/DocumentStandardExtraction' + GenerativeField: + $ref: '#/components/schemas/DocumentStandardGenerativeField' + OutputFormat: + $ref: '#/components/schemas/DocumentOutputFormat' + additionalProperties: false + ImageBoundingBox: + type: object + properties: + State: + $ref: '#/components/schemas/State' + required: + - State + additionalProperties: false + ImageExtractionCategory: + type: object + properties: + State: + $ref: '#/components/schemas/State' + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ImageExtractionCategoryType' + required: + - State + additionalProperties: false + ImageExtractionCategoryType: + type: string + enum: + - CONTENT_MODERATION + - TEXT_DETECTION + - LOGOS + ImageStandardExtraction: + type: object + properties: + Category: + $ref: '#/components/schemas/ImageExtractionCategory' + BoundingBox: + $ref: '#/components/schemas/ImageBoundingBox' + required: + - BoundingBox + - Category + additionalProperties: false + ImageStandardGenerativeField: + type: object + properties: + State: + $ref: '#/components/schemas/State' + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ImageStandardGenerativeFieldType' + required: + - State + additionalProperties: false + ImageStandardGenerativeFieldType: + type: string + enum: + - IMAGE_SUMMARY + - IAB + ImageStandardOutputConfiguration: + type: object + properties: + Extraction: + $ref: '#/components/schemas/ImageStandardExtraction' + GenerativeField: + $ref: '#/components/schemas/ImageStandardGenerativeField' + additionalProperties: false + OverrideConfiguration: + type: object + description: Override configuration + properties: + Document: + $ref: '#/components/schemas/DocumentOverrideConfiguration' + Audio: + $ref: '#/components/schemas/AudioOverrideConfiguration' + Video: + $ref: '#/components/schemas/VideoOverrideConfiguration' + Image: + $ref: '#/components/schemas/ImageOverrideConfiguration' + ModalityRouting: + $ref: '#/components/schemas/ModalityRoutingConfiguration' + additionalProperties: false + ModalityRoutingConfiguration: + type: object + description: Modality routing configuration + properties: + jpeg: + $ref: '#/components/schemas/DesiredModality' + png: + $ref: '#/components/schemas/DesiredModality' + mp4: + $ref: '#/components/schemas/DesiredModality' + mov: + $ref: '#/components/schemas/DesiredModality' + additionalProperties: false + DesiredModality: + type: string + enum: + - DOCUMENT + - IMAGE + - VIDEO + - AUDIO + SplitterConfiguration: + type: object + properties: + State: + $ref: '#/components/schemas/State' + additionalProperties: false + ModalityProcessingConfiguration: + type: object + properties: + State: + $ref: '#/components/schemas/State' + additionalProperties: false + StandardOutputConfiguration: + type: object + description: Standard output configuration + properties: + Document: + $ref: '#/components/schemas/DocumentStandardOutputConfiguration' + Image: + $ref: '#/components/schemas/ImageStandardOutputConfiguration' + Video: + $ref: '#/components/schemas/VideoStandardOutputConfiguration' + Audio: + $ref: '#/components/schemas/AudioStandardOutputConfiguration' + additionalProperties: false + State: + type: string + enum: + - ENABLED + - DISABLED + VideoBoundingBox: + type: object + properties: + State: + $ref: '#/components/schemas/State' + required: + - State + additionalProperties: false + VideoExtractionCategory: + type: object + properties: + State: + $ref: '#/components/schemas/State' + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/VideoExtractionCategoryType' + required: + - State + additionalProperties: false + VideoExtractionCategoryType: + type: string + enum: + - CONTENT_MODERATION + - TEXT_DETECTION + - TRANSCRIPT + - LOGOS + VideoStandardExtraction: + type: object + properties: + Category: + $ref: '#/components/schemas/VideoExtractionCategory' + BoundingBox: + $ref: '#/components/schemas/VideoBoundingBox' + required: + - BoundingBox + - Category + additionalProperties: false + VideoStandardGenerativeField: + type: object + properties: + State: + $ref: '#/components/schemas/State' + Types: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/VideoStandardGenerativeFieldType' + required: + - State + additionalProperties: false + VideoStandardGenerativeFieldType: + type: string + enum: + - VIDEO_SUMMARY + - IAB + - CHAPTER_SUMMARY + VideoStandardOutputConfiguration: + type: object + properties: + Extraction: + $ref: '#/components/schemas/VideoStandardExtraction' + GenerativeField: + $ref: '#/components/schemas/VideoStandardGenerativeField' + additionalProperties: false + DataAutomationProject: + type: object + properties: + CreationTime: + type: string + description: Time Stamp + format: date-time + CustomOutputConfiguration: + $ref: '#/components/schemas/CustomOutputConfiguration' + LastModifiedTime: + type: string + description: Time Stamp + format: date-time + OverrideConfiguration: + $ref: '#/components/schemas/OverrideConfiguration' + ProjectArn: + type: string + maxLength: 128 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}$ + description: ARN of a DataAutomationProject + ProjectDescription: + type: string + description: Description of the DataAutomationProject + ProjectName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]+$ + description: Name of the DataAutomationProject + ProjectStage: + $ref: '#/components/schemas/DataAutomationProjectStage' + StandardOutputConfiguration: + $ref: '#/components/schemas/StandardOutputConfiguration' + Status: + $ref: '#/components/schemas/DataAutomationProjectStatus' + KmsKeyId: + type: string + description: KMS key identifier + minLength: 1 + maxLength: 2048 + KmsEncryptionContext: + type: object + description: KMS encryption context + x-patternProperties: + ^.*$: + type: string + additionalProperties: false + x-dependencies: + KmsEncryptionContext: + - KmsKeyId + Tags: + description: List of Tags + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + required: + - ProjectName + x-stackql-resource-name: data_automation_project + description: Definition of AWS::Bedrock::DataAutomationProject Resource Type + x-type-name: AWS::Bedrock::DataAutomationProject + x-stackql-primary-identifier: + - ProjectArn + x-create-only-properties: + - ProjectName + x-read-only-properties: + - CreationTime + - LastModifiedTime + - ProjectArn + - ProjectStage + - Status + x-required-properties: + - ProjectName + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateDataAutomationProject + - bedrock:GetDataAutomationProject + - bedrock:TagResource + - bedrock:ListTagsForResource + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + read: + - bedrock:GetDataAutomationProject + - bedrock:ListTagsForResource + - kms:DescribeKey + - kms:Decrypt + update: + - bedrock:UpdateDataAutomationProject + - bedrock:GetDataAutomationProject + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + delete: + - bedrock:DeleteDataAutomationProject + - bedrock:GetDataAutomationProject + - kms:DescribeKey + - kms:Decrypt + list: + - bedrock:ListDataAutomationProjects + ContextEnrichmentConfiguration: + type: object + description: Additional Enrichment Configuration for example when using GraphRag. + properties: + Type: + $ref: '#/components/schemas/ContextEnrichmentType' + BedrockFoundationModelConfiguration: + $ref: '#/components/schemas/BedrockFoundationModelContextEnrichmentConfiguration' + required: + - Type + additionalProperties: false + ContextEnrichmentType: + type: string + description: Enrichment type to be used for the vector database. + enum: + - BEDROCK_FOUNDATION_MODEL + BedrockFoundationModelContextEnrichmentConfiguration: + type: object + description: Bedrock Foundation Model configuration to be used for Context Enrichment. + properties: + EnrichmentStrategyConfiguration: + $ref: '#/components/schemas/EnrichmentStrategyConfiguration' + ModelArn: + $ref: '#/components/schemas/ModelArn' + required: + - EnrichmentStrategyConfiguration + - ModelArn + additionalProperties: false + EnrichmentStrategyConfiguration: + type: object + description: Strategy to be used when using Bedrock Foundation Model for Context Enrichment. + properties: + Method: + $ref: '#/components/schemas/EnrichmentStrategyMethod' + required: + - Method + additionalProperties: false + EnrichmentStrategyMethod: + type: string + description: Enrichment Strategy method. + enum: + - CHUNK_ENTITY_EXTRACTION + BedrockFoundationModelConfiguration: + type: object + description: Settings for a foundation model used to parse documents for a data source. + properties: + ModelArn: + $ref: '#/components/schemas/ModelArn' + ParsingPrompt: + $ref: '#/components/schemas/ParsingPrompt' + ParsingModality: + $ref: '#/components/schemas/ParsingModality' + required: + - ModelArn + additionalProperties: false + ModelArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$ + description: The model's ARN. + ChunkingConfiguration: + type: object + description: Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. + properties: + ChunkingStrategy: + $ref: '#/components/schemas/ChunkingStrategy' + FixedSizeChunkingConfiguration: + $ref: '#/components/schemas/FixedSizeChunkingConfiguration' + HierarchicalChunkingConfiguration: + $ref: '#/components/schemas/HierarchicalChunkingConfiguration' + SemanticChunkingConfiguration: + $ref: '#/components/schemas/SemanticChunkingConfiguration' + required: + - ChunkingStrategy + additionalProperties: false + ChunkingStrategy: + type: string + description: Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. + enum: + - FIXED_SIZE + - NONE + - HIERARCHICAL + - SEMANTIC + CustomTransformationConfiguration: + type: object + description: Settings for customizing steps in the data source content ingestion pipeline. + properties: + IntermediateStorage: + $ref: '#/components/schemas/IntermediateStorage' + Transformations: + type: array + items: + $ref: '#/components/schemas/Transformation' + maxItems: 1 + minItems: 1 + description: A list of Lambda functions that process documents. + x-insertionOrder: false + required: + - IntermediateStorage + - Transformations + additionalProperties: false + DataSourceConfiguration: + type: object + description: Specifies a raw data source location to ingest. + properties: + Type: + $ref: '#/components/schemas/DataSourceType' + S3Configuration: + $ref: '#/components/schemas/S3DataSourceConfiguration' + ConfluenceConfiguration: + $ref: '#/components/schemas/ConfluenceDataSourceConfiguration' + SalesforceConfiguration: + $ref: '#/components/schemas/SalesforceDataSourceConfiguration' + SharePointConfiguration: + $ref: '#/components/schemas/SharePointDataSourceConfiguration' + WebConfiguration: + $ref: '#/components/schemas/WebDataSourceConfiguration' + required: + - Type + additionalProperties: false + DataSourceStatus: + type: string + description: The status of a data source. + enum: + - AVAILABLE + - DELETING + - DELETE_UNSUCCESSFUL + DataSourceType: + type: string + description: The type of the data source location. + enum: + - S3 + - CONFLUENCE + - SALESFORCE + - SHAREPOINT + - WEB + - CUSTOM + - REDSHIFT_METADATA + DataDeletionPolicy: + type: string + description: The deletion policy for the data source. + enum: + - RETAIN + - DELETE + FixedSizeChunkingConfiguration: + type: object + description: Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field. + properties: + MaxTokens: + type: integer + minimum: 1 + description: The maximum number of tokens to include in a chunk. + OverlapPercentage: + type: integer + maximum: 99 + minimum: 1 + description: The percentage of overlap between adjacent chunks of a data source. + required: + - MaxTokens + - OverlapPercentage + additionalProperties: false + HierarchicalChunkingConfiguration: + type: object + description: Configurations for when you choose hierarchical chunking. If you set the chunkingStrategy as NONE, exclude this field. + properties: + LevelConfigurations: + type: array + items: + $ref: '#/components/schemas/HierarchicalChunkingLevelConfiguration' + maxItems: 2 + minItems: 2 + description: Token settings for each layer. + x-insertionOrder: false + OverlapTokens: + type: integer + minimum: 1 + description: The number of tokens to repeat across chunks in the same layer. + required: + - LevelConfigurations + - OverlapTokens + additionalProperties: false + HierarchicalChunkingLevelConfiguration: + type: object + description: Token settings for a layer in a hierarchical chunking configuration. + properties: + MaxTokens: + type: integer + minimum: 1 + maximum: 8192 + description: The maximum number of tokens that a chunk can contain in this layer. + required: + - MaxTokens + additionalProperties: false + IntermediateStorage: + type: object + description: A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline. + properties: + S3Location: + $ref: '#/components/schemas/S3Location' + required: + - S3Location + additionalProperties: false + ParsingConfiguration: + type: object + description: Settings for parsing document contents + properties: + ParsingStrategy: + $ref: '#/components/schemas/ParsingStrategy' + BedrockFoundationModelConfiguration: + $ref: '#/components/schemas/BedrockFoundationModelConfiguration' + BedrockDataAutomationConfiguration: + $ref: '#/components/schemas/BedrockDataAutomationConfiguration' + required: + - ParsingStrategy + additionalProperties: false + ParsingModality: + type: string + description: Determine how will parsed content be stored. + enum: + - MULTIMODAL + BedrockDataAutomationConfiguration: + type: object + description: Settings for a Bedrock Data Automation used to parse documents for a data source. + properties: + ParsingModality: + $ref: '#/components/schemas/ParsingModality' + additionalProperties: false + ParsingPrompt: + type: object + description: Instructions for interpreting the contents of a document. + properties: + ParsingPromptText: + type: string + maxLength: 10000 + minLength: 1 + description: Instructions for interpreting the contents of a document. + required: + - ParsingPromptText + additionalProperties: false + ParsingStrategy: + type: string + description: The parsing strategy for the data source. + enum: + - BEDROCK_FOUNDATION_MODEL + - BEDROCK_DATA_AUTOMATION + S3DataSourceConfiguration: + type: object + description: The configuration information to connect to Amazon S3 as your data source. + properties: + BucketArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$ + description: The ARN of the bucket that contains the data source. + InclusionPrefixes: + type: array + items: + type: string + maxLength: 300 + minLength: 1 + description: Prefix for s3 object. + maxItems: 1 + minItems: 1 + description: A list of S3 prefixes that define the object containing the data sources. + x-insertionOrder: false + BucketOwnerAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + description: The account ID for the owner of the S3 bucket. + required: + - BucketArn + additionalProperties: false + ConfluenceDataSourceConfiguration: + type: object + description: The configuration information to connect to Confluence as your data source. + properties: + SourceConfiguration: + $ref: '#/components/schemas/ConfluenceSourceConfiguration' + CrawlerConfiguration: + $ref: '#/components/schemas/ConfluenceCrawlerConfiguration' + required: + - SourceConfiguration + additionalProperties: false + SalesforceDataSourceConfiguration: + type: object + description: The configuration information to connect to Salesforce as your data source. + properties: + SourceConfiguration: + $ref: '#/components/schemas/SalesforceSourceConfiguration' + CrawlerConfiguration: + $ref: '#/components/schemas/SalesforceCrawlerConfiguration' + required: + - SourceConfiguration + additionalProperties: false + SharePointDataSourceConfiguration: + type: object + description: The configuration information to connect to SharePoint as your data source. + properties: + SourceConfiguration: + $ref: '#/components/schemas/SharePointSourceConfiguration' + CrawlerConfiguration: + $ref: '#/components/schemas/SharePointCrawlerConfiguration' + required: + - SourceConfiguration + additionalProperties: false + WebDataSourceConfiguration: + type: object + description: Configures a web data source location. + properties: + SourceConfiguration: + $ref: '#/components/schemas/WebSourceConfiguration' + CrawlerConfiguration: + $ref: '#/components/schemas/WebCrawlerConfiguration' + required: + - SourceConfiguration + additionalProperties: false + S3Location: + type: object + description: An Amazon S3 location. + properties: + URI: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^s3://.{1,128}$ + description: The location's URI + required: + - URI + additionalProperties: false + SemanticChunkingConfiguration: + type: object + description: Configurations for when you choose semantic chunking. If you set the chunkingStrategy as NONE, exclude this field. + properties: + BreakpointPercentileThreshold: + type: integer + minimum: 50 + maximum: 99 + description: The dissimilarity threshold for splitting chunks. + BufferSize: + type: integer + minimum: 0 + maximum: 1 + description: The buffer size. + MaxTokens: + type: integer + minimum: 1 + description: The maximum number of tokens that a chunk can contain. + required: + - BreakpointPercentileThreshold + - BufferSize + - MaxTokens + additionalProperties: false + ServerSideEncryptionConfiguration: + type: object + description: Contains details about the server-side encryption for the data source. + properties: + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: The ARN of the AWS KMS key used to encrypt the resource. + additionalProperties: false + Transformation: + type: object + description: A Lambda function that processes documents. + properties: + StepToApply: + type: string + description: When the service applies the transformation. + enum: + - POST_CHUNKING + TransformationFunction: + $ref: '#/components/schemas/TransformationFunction' + required: + - StepToApply + - TransformationFunction + additionalProperties: false + TransformationFunction: + type: object + description: A Lambda function that processes documents. + properties: + TransformationLambdaConfiguration: + $ref: '#/components/schemas/TransformationLambdaConfiguration' + required: + - TransformationLambdaConfiguration + additionalProperties: false + TransformationLambdaConfiguration: + type: object + description: A Lambda function that processes documents. + properties: + LambdaArn: + type: string + maxLength: 2048 + minLength: 0 + pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: The function's ARN identifier. + required: + - LambdaArn + additionalProperties: false + VectorIngestionConfiguration: + type: object + description: Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. + properties: + ChunkingConfiguration: + $ref: '#/components/schemas/ChunkingConfiguration' + CustomTransformationConfiguration: + $ref: '#/components/schemas/CustomTransformationConfiguration' + ParsingConfiguration: + $ref: '#/components/schemas/ParsingConfiguration' + ContextEnrichmentConfiguration: + $ref: '#/components/schemas/ContextEnrichmentConfiguration' + additionalProperties: false + ConfluenceSourceConfiguration: + type: object + description: The endpoint information to connect to your Confluence data source. + properties: + HostUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^https://[A-Za-z0-9][^\s]*$ + description: The Confluence host URL or instance URL. + HostType: + type: string + description: The supported host type, whether online/cloud or server/on-premises. + enum: + - SAAS + AuthType: + type: string + description: The supported authentication type to authenticate and connect to your Confluence instance. + enum: + - BASIC + - OAUTH2_CLIENT_CREDENTIALS + CredentialsSecretArn: + type: string + description: The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration. + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + required: + - HostUrl + - HostType + - AuthType + - CredentialsSecretArn + additionalProperties: false + ConfluenceCrawlerConfiguration: + type: object + description: The configuration of the Confluence content. For example, configuring specific types of Confluence content. + properties: + FilterConfiguration: + $ref: '#/components/schemas/CrawlFilterConfiguration' + additionalProperties: false + SalesforceSourceConfiguration: + type: object + description: The endpoint information to connect to your Salesforce data source. + properties: + HostUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^https://[A-Za-z0-9][^\s]*$ + description: The Salesforce host URL or instance URL. + AuthType: + type: string + description: The supported authentication type to authenticate and connect to your Salesforce instance. + enum: + - OAUTH2_CLIENT_CREDENTIALS + CredentialsSecretArn: + type: string + description: The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration. + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + required: + - HostUrl + - AuthType + - CredentialsSecretArn + additionalProperties: false + SalesforceCrawlerConfiguration: + type: object + description: The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content. + properties: + FilterConfiguration: + $ref: '#/components/schemas/CrawlFilterConfiguration' + additionalProperties: false + SharePointSourceConfiguration: + type: object + description: The endpoint information to connect to your SharePoint data source. + properties: + SiteUrls: + type: array + description: A list of one or more SharePoint site URLs. + items: + type: string + pattern: ^https://[A-Za-z0-9][^\s]*$ + description: A forced-HTTPS web url. + maxItems: 100 + minItems: 1 + x-insertionOrder: false + HostType: + type: string + description: The supported host type, whether online/cloud or server/on-premises. + enum: + - ONLINE + AuthType: + type: string + description: The supported authentication type to authenticate and connect to your SharePoint site/sites. + enum: + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS + CredentialsSecretArn: + type: string + description: The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration. + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + TenantId: + type: string + description: The identifier of your Microsoft 365 tenant. + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + Domain: + type: string + description: The domain of your SharePoint instance or site URL/URLs. + maxLength: 50 + minLength: 1 + required: + - Domain + - SiteUrls + - HostType + - AuthType + - CredentialsSecretArn + additionalProperties: false + SharePointCrawlerConfiguration: + type: object + description: The configuration of the SharePoint content. For example, configuring specific types of SharePoint content. + properties: + FilterConfiguration: + $ref: '#/components/schemas/CrawlFilterConfiguration' + additionalProperties: false + WebSourceConfiguration: + type: object + description: A web source configuration. + properties: + UrlConfiguration: + $ref: '#/components/schemas/UrlConfiguration' + required: + - UrlConfiguration + additionalProperties: false + UrlConfiguration: + type: object + description: A url configuration. + properties: + SeedUrls: + $ref: '#/components/schemas/SeedUrls' + required: + - SeedUrls + additionalProperties: false + SeedUrl: + type: object + description: A seed url object. + properties: + Url: + type: string + pattern: ^https?://[A-Za-z0-9][^\s]*$ + description: A web url. + required: + - Url + additionalProperties: false + SeedUrls: + type: array + description: A list of web urls. + items: + $ref: '#/components/schemas/SeedUrl' + maxItems: 100 + minItems: 1 + x-insertionOrder: false + WebCrawlerConfiguration: + type: object + description: Configuration for the web crawler. + properties: + CrawlerLimits: + $ref: '#/components/schemas/WebCrawlerLimits' + InclusionFilters: + $ref: '#/components/schemas/FilterList' + ExclusionFilters: + $ref: '#/components/schemas/FilterList' + Scope: + $ref: '#/components/schemas/WebScopeType' + UserAgent: + type: string + description: The suffix that will be included in the user agent header. + maxLength: 40 + minLength: 15 + UserAgentHeader: + type: string + description: The full user agent header, including UUID and suffix. + maxLength: 86 + minLength: 61 + additionalProperties: false + WebCrawlerLimits: + type: object + description: Limit settings for the web crawler. + properties: + RateLimit: + type: integer + minimum: 1 + maximum: 300 + description: Rate of web URLs retrieved per minute. + MaxPages: + type: integer + minimum: 1 + description: Maximum number of pages the crawler can crawl. + additionalProperties: false + WebScopeType: + type: string + description: The scope that a web crawl job will be restricted to. + enum: + - HOST_ONLY + - SUBDOMAINS + CrawlFilterConfiguration: + type: object + description: The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content. + properties: + Type: + type: string + description: The crawl filter type. + enum: + - PATTERN + PatternObjectFilter: + $ref: '#/components/schemas/PatternObjectFilterConfiguration' + required: + - Type + additionalProperties: false + PatternObjectFilterConfiguration: + type: object + description: The configuration of specific filters applied to your data source content. You can filter out or include certain content. + properties: + Filters: + $ref: '#/components/schemas/PatternObjectFilterList' + required: + - Filters + additionalProperties: false + PatternObjectFilterList: + type: array + items: + $ref: '#/components/schemas/PatternObjectFilter' + maxItems: 25 + minItems: 1 + description: Contains information + PatternObjectFilter: + type: object + description: The specific filters applied to your data source content. You can filter out or include certain content. + properties: + ObjectType: + type: string + maxLength: 50 + minLength: 1 + description: The supported object type or content type of the data source. + InclusionFilters: + $ref: '#/components/schemas/FilterList' + ExclusionFilters: + $ref: '#/components/schemas/FilterList' + required: + - ObjectType + additionalProperties: false + FilterList: + type: array + description: A set of regular expression filter patterns for a type of object. + items: + type: string + maxLength: 1000 + description: A list of one or more inclusion/exclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn't crawled. + maxItems: 25 + minItems: 1 + x-insertionOrder: false + DataSource: + type: object + properties: + DataSourceConfiguration: + $ref: '#/components/schemas/DataSourceConfiguration' + DataSourceId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + KnowledgeBaseId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: The unique identifier of the knowledge base to which to add the data source. + DataSourceStatus: + $ref: '#/components/schemas/DataSourceStatus' + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: The name of the data source. + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + VectorIngestionConfiguration: + $ref: '#/components/schemas/VectorIngestionConfiguration' + DataDeletionPolicy: + $ref: '#/components/schemas/DataDeletionPolicy' + CreatedAt: + type: string + description: The time at which the data source was created. + UpdatedAt: + type: string + description: The time at which the knowledge base was last updated. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: The details of the failure reasons related to the data source. + x-insertionOrder: false + required: + - DataSourceConfiguration + - Name + - KnowledgeBaseId + x-stackql-resource-name: data_source + description: Definition of AWS::Bedrock::DataSource Resource Type + x-type-name: AWS::Bedrock::DataSource + x-stackql-primary-identifier: + - KnowledgeBaseId + - DataSourceId + x-create-only-properties: + - KnowledgeBaseId + - VectorIngestionConfiguration/ChunkingConfiguration + - VectorIngestionConfiguration/ParsingConfiguration + - DataSourceConfiguration/Type + x-read-only-properties: + - DataSourceId + - DataSourceStatus + - CreatedAt + - UpdatedAt + - FailureReasons + - DataSourceConfiguration/WebConfiguration/CrawlerConfiguration/UserAgentHeader + x-required-properties: + - DataSourceConfiguration + - Name + - KnowledgeBaseId + x-tagging: + taggable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - bedrock:CreateDataSource + - bedrock:GetDataSource + - bedrock:GetKnowledgeBase + - kms:GenerateDataKey + read: + - bedrock:GetDataSource + update: + - bedrock:GetDataSource + - bedrock:UpdateDataSource + - kms:GenerateDataKey + delete: + - bedrock:GetDataSource + - bedrock:DeleteDataSource + list: + - bedrock:ListDataSources + ConditionFlowNodeConfiguration: + type: object + description: Condition flow node configuration + properties: + Conditions: + type: array + items: + $ref: '#/components/schemas/FlowCondition' + maxItems: 5 + minItems: 1 + description: List of conditions in a condition node + x-insertionOrder: true + required: + - Conditions + additionalProperties: false + FlowCondition: + type: object + description: Condition branch for a condition node + properties: + Name: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a condition in a flow + Expression: + type: string + maxLength: 64 + minLength: 1 + description: Expression for a condition in a flow + required: + - Name + additionalProperties: false + FlowConditionalConnectionConfiguration: + type: object + description: Conditional connection configuration + properties: + Condition: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a condition in a flow + required: + - Condition + additionalProperties: false + FlowConnection: + type: object + description: Flow connection + properties: + Type: + $ref: '#/components/schemas/FlowConnectionType' + Name: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$ + description: Name of a connection in a flow + Source: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node in a flow + Target: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node in a flow + Configuration: + $ref: '#/components/schemas/FlowConnectionConfiguration' + required: + - Name + - Source + - Target + - Type + additionalProperties: false + FlowConnectionConfiguration: + description: Connection configuration + oneOf: + - type: object + title: Data + properties: + Data: + $ref: '#/components/schemas/FlowDataConnectionConfiguration' + required: + - Data + additionalProperties: false + - type: object + title: Conditional + properties: + Conditional: + $ref: '#/components/schemas/FlowConditionalConnectionConfiguration' + required: + - Conditional + additionalProperties: false + FlowConnectionType: + type: string + description: Connection type + enum: + - Data + - Conditional + FlowDataConnectionConfiguration: + type: object + description: Data connection configuration + properties: + SourceOutput: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node output in a flow + TargetInput: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node input in a flow + required: + - SourceOutput + - TargetInput + additionalProperties: false + FlowDefinition: + type: object + description: Flow definition + properties: + Nodes: + type: array + items: + $ref: '#/components/schemas/FlowNode' + maxItems: 40 + description: List of nodes in a flow + x-insertionOrder: true + Connections: + type: array + items: + $ref: '#/components/schemas/FlowConnection' + maxItems: 100 + description: List of connections + x-insertionOrder: true + additionalProperties: false + FlowValidation: + type: object + description: Validation for Flow + properties: + Message: + type: string + description: validation message + additionalProperties: false + required: + - Message + FlowValidations: + type: array + description: List of flow validations + items: + $ref: '#/components/schemas/FlowValidation' + x-insertionOrder: false + FlowNode: + type: object + description: Internal mixin for flow node + properties: + Name: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node in a flow + Type: + $ref: '#/components/schemas/FlowNodeType' + Configuration: + $ref: '#/components/schemas/FlowNodeConfiguration' + Inputs: + type: array + items: + $ref: '#/components/schemas/FlowNodeInput' + maxItems: 5 + description: List of node inputs in a flow + x-insertionOrder: true + Outputs: + type: array + items: + $ref: '#/components/schemas/FlowNodeOutput' + maxItems: 5 + description: List of node outputs in a flow + x-insertionOrder: true + required: + - Name + - Type + additionalProperties: false + FlowNodeConfiguration: + description: Node configuration in a flow + oneOf: + - type: object + title: Input + properties: + Input: + $ref: '#/components/schemas/InputFlowNodeConfiguration' + required: + - Input + additionalProperties: false + - type: object + title: Output + properties: + Output: + $ref: '#/components/schemas/OutputFlowNodeConfiguration' + required: + - Output + additionalProperties: false + - type: object + title: KnowledgeBase + properties: + KnowledgeBase: + $ref: '#/components/schemas/KnowledgeBaseFlowNodeConfiguration' + required: + - KnowledgeBase + additionalProperties: false + - type: object + title: Condition + properties: + Condition: + $ref: '#/components/schemas/ConditionFlowNodeConfiguration' + required: + - Condition + additionalProperties: false + - type: object + title: Lex + properties: + Lex: + $ref: '#/components/schemas/LexFlowNodeConfiguration' + required: + - Lex + additionalProperties: false + - type: object + title: Prompt + properties: + Prompt: + $ref: '#/components/schemas/PromptFlowNodeConfiguration' + required: + - Prompt + additionalProperties: false + - type: object + title: LambdaFunction + properties: + LambdaFunction: + $ref: '#/components/schemas/LambdaFunctionFlowNodeConfiguration' + required: + - LambdaFunction + additionalProperties: false + - type: object + title: Agent + properties: + Agent: + $ref: '#/components/schemas/AgentFlowNodeConfiguration' + required: + - Agent + additionalProperties: false + - type: object + title: Storage + properties: + Storage: + $ref: '#/components/schemas/StorageFlowNodeConfiguration' + required: + - Storage + additionalProperties: false + - type: object + title: Retrieval + properties: + Retrieval: + $ref: '#/components/schemas/RetrievalFlowNodeConfiguration' + required: + - Retrieval + additionalProperties: false + - type: object + title: Iterator + properties: + Iterator: + $ref: '#/components/schemas/IteratorFlowNodeConfiguration' + required: + - Iterator + additionalProperties: false + - type: object + title: Collector + properties: + Collector: + $ref: '#/components/schemas/CollectorFlowNodeConfiguration' + required: + - Collector + additionalProperties: false + - type: object + title: InlineCode + properties: + InlineCode: + $ref: '#/components/schemas/InlineCodeFlowNodeConfiguration' + required: + - InlineCode + additionalProperties: false + - type: object + title: Loop + properties: + Loop: + $ref: '#/components/schemas/LoopFlowNodeConfiguration' + required: + - Loop + additionalProperties: false + - type: object + title: LoopInput + properties: + LoopInput: + $ref: '#/components/schemas/LoopInputFlowNodeConfiguration' + required: + - LoopInput + additionalProperties: false + - type: object + title: LoopController + properties: + LoopController: + $ref: '#/components/schemas/LoopControllerFlowNodeConfiguration' + required: + - LoopController + additionalProperties: false + FlowNodeIODataType: + type: string + description: Type of input/output for a node in a flow + enum: + - String + - Number + - Boolean + - Object + - Array + FlowNodeInputCategory: + type: string + description: Optional tag to classify input type, currently exclusive to LoopNode + enum: + - LoopCondition + - ReturnValueToLoopStart + - ExitLoop + FlowNodeInput: + type: object + description: Input to a node in a flow + properties: + Name: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node input in a flow + Type: + $ref: '#/components/schemas/FlowNodeIODataType' + Expression: + type: string + maxLength: 64 + minLength: 1 + description: Expression for a node input in a flow + required: + - Expression + - Name + - Type + additionalProperties: false + FlowNodeOutput: + type: object + description: Output of a node in a flow + properties: + Name: + type: string + pattern: ^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$ + description: Name of a node output in a flow + Type: + $ref: '#/components/schemas/FlowNodeIODataType' + required: + - Name + - Type + additionalProperties: false + FlowNodeType: + type: string + description: Flow node types + enum: + - Input + - Output + - KnowledgeBase + - Condition + - Lex + - Prompt + - LambdaFunction + - Agent + - Iterator + - Collector + - Storage + - Retrieval + - InlineCode + - Loop + - LoopInput + - LoopController + FlowStatus: + type: string + description: Schema Type for Flow APIs + enum: + - Failed + - Prepared + - Preparing + - NotPrepared + InputFlowNodeConfiguration: + type: object + description: Input flow node configuration + additionalProperties: false + AgentFlowNodeConfiguration: + type: object + description: Agent flow node configuration + properties: + AgentAliasArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$ + description: Arn representation of the Agent Alias. + required: + - AgentAliasArn + additionalProperties: false + KnowledgeBaseFlowNodeConfiguration: + type: object + description: Knowledge base flow node configuration + properties: + KnowledgeBaseId: + type: string + maxLength: 10 + pattern: ^[0-9a-zA-Z]+$ + description: Identifier of the KnowledgeBase + ModelId: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$ + description: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models. + GuardrailConfiguration: + $ref: '#/components/schemas/GuardrailConfiguration' + NumberOfResults: + type: number + maximum: 100 + minimum: 1 + description: Number Of Results to Retrieve + PromptTemplate: + $ref: '#/components/schemas/KnowledgeBasePromptTemplate' + InferenceConfiguration: + $ref: '#/components/schemas/PromptInferenceConfiguration' + OrchestrationConfiguration: + $ref: '#/components/schemas/KnowledgeBaseOrchestrationConfiguration' + RerankingConfiguration: + $ref: '#/components/schemas/VectorSearchRerankingConfiguration' + required: + - KnowledgeBaseId + additionalProperties: false + LambdaFunctionFlowNodeConfiguration: + type: object + description: Lambda function flow node configuration + properties: + LambdaArn: + type: string + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: ARN of a Lambda. + required: + - LambdaArn + additionalProperties: false + LexFlowNodeConfiguration: + type: object + description: Lex flow node configuration + properties: + BotAliasArn: + type: string + maxLength: 78 + pattern: ^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$ + description: ARN of a Lex bot alias + LocaleId: + type: string + maxLength: 10 + minLength: 1 + description: Lex bot locale id + required: + - BotAliasArn + - LocaleId + additionalProperties: false + OutputFlowNodeConfiguration: + type: object + description: Output flow node configuration + additionalProperties: false + IteratorFlowNodeConfiguration: + type: object + description: Iterator flow node configuration + additionalProperties: false + CollectorFlowNodeConfiguration: + type: object + description: Collector flow node configuration + additionalProperties: false + PromptFlowNodeConfiguration: + type: object + description: Prompt flow node configuration + properties: + SourceConfiguration: + $ref: '#/components/schemas/PromptFlowNodeSourceConfiguration' + GuardrailConfiguration: + $ref: '#/components/schemas/GuardrailConfiguration' + required: + - SourceConfiguration + additionalProperties: false + StorageFlowNodeConfiguration: + type: object + description: Storage flow node configuration + properties: + ServiceConfiguration: + $ref: '#/components/schemas/StorageFlowNodeServiceConfiguration' + required: + - ServiceConfiguration + additionalProperties: false + RetrievalFlowNodeConfiguration: + type: object + description: Retrieval flow node configuration + properties: + ServiceConfiguration: + $ref: '#/components/schemas/RetrievalFlowNodeServiceConfiguration' + required: + - ServiceConfiguration + additionalProperties: false + PromptFlowNodeInlineConfiguration: + type: object + description: Inline prompt configuration for prompt node + properties: + TemplateType: + $ref: '#/components/schemas/PromptTemplateType' + TemplateConfiguration: + $ref: '#/components/schemas/PromptTemplateConfiguration' + ModelId: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$ + description: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models. + InferenceConfiguration: + $ref: '#/components/schemas/PromptInferenceConfiguration' + required: + - ModelId + - TemplateConfiguration + - TemplateType + additionalProperties: false + PromptFlowNodeResourceConfiguration: + type: object + description: Resource prompt configuration for prompt node + properties: + PromptArn: + type: string + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$ + description: ARN of a prompt resource possibly with a version + required: + - PromptArn + additionalProperties: false + PromptFlowNodeSourceConfiguration: + description: Prompt source configuration for prompt node + oneOf: + - type: object + title: Resource + properties: + Resource: + $ref: '#/components/schemas/PromptFlowNodeResourceConfiguration' + required: + - Resource + additionalProperties: false + - type: object + title: Inline + properties: + Inline: + $ref: '#/components/schemas/PromptFlowNodeInlineConfiguration' + required: + - Inline + additionalProperties: false + StorageFlowNodeServiceConfiguration: + description: storage service configuration for storage node + oneOf: + - type: object + title: S3 + properties: + S3: + $ref: '#/components/schemas/StorageFlowNodeS3Configuration' + additionalProperties: false + StorageFlowNodeS3Configuration: + type: object + description: s3 storage configuration for storage node + properties: + BucketName: + type: string + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + description: bucket name of an s3 that will be used for storage flow node configuration + required: + - BucketName + additionalProperties: false + RetrievalFlowNodeServiceConfiguration: + description: Retrieval service configuration for Retrieval node + oneOf: + - type: object + title: S3 + properties: + S3: + $ref: '#/components/schemas/RetrievalFlowNodeS3Configuration' + additionalProperties: false + RetrievalFlowNodeS3Configuration: + type: object + description: s3 Retrieval configuration for Retrieval node + properties: + BucketName: + type: string + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + description: bucket name of an s3 that will be used for Retrieval flow node configuration + required: + - BucketName + additionalProperties: false + PromptInferenceConfiguration: + description: Model inference configuration + oneOf: + - type: object + title: Text + properties: + Text: + $ref: '#/components/schemas/PromptModelInferenceConfiguration' + required: + - Text + additionalProperties: false + PromptInputVariable: + type: object + description: Input variable + properties: + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for an input variable + additionalProperties: false + PromptModelInferenceConfiguration: + type: object + description: Prompt model inference configuration + properties: + Temperature: + type: number + maximum: 1 + minimum: 0 + description: Controls randomness, higher values increase diversity + TopP: + type: number + maximum: 1 + minimum: 0 + description: Cumulative probability cutoff for token selection + MaxTokens: + type: number + maximum: 4096 + minimum: 0 + description: Maximum length of output + StopSequences: + type: array + items: + type: string + maxItems: 4 + minItems: 0 + description: List of stop sequences + x-insertionOrder: true + additionalProperties: false + PromptTemplateConfiguration: + description: Prompt template configuration + oneOf: + - type: object + title: Text + properties: + Text: + $ref: '#/components/schemas/TextPromptTemplateConfiguration' + required: + - Text + additionalProperties: false + - type: object + title: Chat + properties: + Chat: + $ref: '#/components/schemas/ChatPromptTemplateConfiguration' + required: + - Chat + additionalProperties: false + PromptTemplateType: + type: string + description: Prompt template type + enum: + - TEXT + - CHAT + DefinitionSubstitutions: + type: object + description: When supplied with DefinitionString or DefinitionS3Location, substrings in the definition matching ${keyname} will be replaced with the associated value from this map + additionalProperties: false + x-patternProperties: + ^[a-zA-Z0-9]+$: + anyOf: + - type: string + - type: integer + - type: boolean + minProperties: 1 + maxProperties: 500 + TextPromptTemplateConfiguration: + type: object + description: Configuration for text prompt template + properties: + Text: + type: string + maxLength: 200000 + minLength: 1 + description: Prompt content for String prompt template + InputVariables: + type: array + items: + $ref: '#/components/schemas/PromptInputVariable' + maxItems: 20 + minItems: 0 + description: List of input variables + x-insertionOrder: true + CachePoint: + $ref: '#/components/schemas/CachePointBlock' + required: + - Text + additionalProperties: false + LoopFlowNodeConfiguration: + type: object + description: Loop node config, contains loop's internal definition + properties: + Definition: + $ref: '#/components/schemas/FlowDefinition' + required: + - Definition + additionalProperties: false + LoopInputFlowNodeConfiguration: + type: object + description: Configuration for the LoopInput node + additionalProperties: false + LoopControllerFlowNodeConfiguration: + type: object + description: Configuration for the LoopController node, which manages loop execution + properties: + ContinueCondition: + $ref: '#/components/schemas/FlowCondition' + MaxIterations: + type: number + default: 10 + maximum: 1000 + minimum: 1 + description: Maximum number of iterations the loop can perform + required: + - ContinueCondition + additionalProperties: false + InlineCodeFlowNodeConfiguration: + type: object + description: Inline code config strucuture, contains code configs + properties: + Code: + type: string + maxLength: 5000000 + description: The inline code entered by customers. max size is 5MB. + Language: + $ref: '#/components/schemas/SupportedLanguages' + required: + - Code + - Language + additionalProperties: false + SupportedLanguages: + type: string + description: Enum encodes the supported language type + enum: + - Python_3 + BedrockRerankingModelArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$ + description: Arn of a Bedrock Reranking model + VectorSearchRerankingConfigurationType: + type: string + description: Enum of Rerank Configuration Types + enum: + - BEDROCK_RERANKING_MODEL + RerankingMetadataSelectionMode: + type: string + description: Reranking Metadata Selection Mode + enum: + - SELECTIVE + - ALL + FieldForReranking: + type: object + properties: + FieldName: + type: string + maxLength: 2000 + minLength: 1 + description: Field name for reranking + description: Field name for reranking + required: + - FieldName + additionalProperties: false + FieldsForReranking: + type: array + items: + $ref: '#/components/schemas/FieldForReranking' + maxItems: 100 + minItems: 1 + description: List of Fields For Reranking + x-insertionOrder: true + RerankingMetadataSelectiveModeConfiguration: + description: Reranking Metadata Selective Mode Configuration + oneOf: + - type: object + title: FieldsToInclude + properties: + FieldsToInclude: + $ref: '#/components/schemas/FieldsForReranking' + required: + - FieldsToInclude + additionalProperties: false + - type: object + title: FieldsToExclude + properties: + FieldsToExclude: + $ref: '#/components/schemas/FieldsForReranking' + required: + - FieldsToExclude + additionalProperties: false + MetadataConfigurationForReranking: + type: object + x-title: MetadataConfigurationForReranking + properties: + SelectionMode: + $ref: '#/components/schemas/RerankingMetadataSelectionMode' + SelectiveModeConfiguration: + $ref: '#/components/schemas/RerankingMetadataSelectiveModeConfiguration' + required: + - SelectionMode + additionalProperties: false + VectorSearchBedrockRerankingModelConfiguration: + type: object + x-title: VectorSearchBedrockRerankingModelConfiguration + properties: + ModelArn: + $ref: '#/components/schemas/BedrockRerankingModelArn' + AdditionalModelRequestFields: + $ref: '#/components/schemas/AdditionalModelRequestFields' + required: + - ModelArn + additionalProperties: false + VectorSearchBedrockRerankingConfiguration: + type: object + x-title: VectorSearchBedrockRerankingConfiguration + properties: + ModelConfiguration: + $ref: '#/components/schemas/VectorSearchBedrockRerankingModelConfiguration' + NumberOfRerankedResults: + type: number + maximum: 100 + minimum: 1 + description: Number Of Results For Reranking + MetadataConfiguration: + $ref: '#/components/schemas/MetadataConfigurationForReranking' + required: + - ModelConfiguration + additionalProperties: false + VectorSearchRerankingConfiguration: + type: object + x-title: VectorSearchRerankingConfiguration + properties: + Type: + $ref: '#/components/schemas/VectorSearchRerankingConfigurationType' + BedrockRerankingConfiguration: + $ref: '#/components/schemas/VectorSearchBedrockRerankingConfiguration' + required: + - Type + additionalProperties: false + PerformanceConfigurationLatency: + type: string + description: Performance Configuration Latency + enum: + - standard + - optimized + PerformanceConfiguration: + type: object + x-title: PerformanceConfiguration + properties: + Latency: + $ref: '#/components/schemas/PerformanceConfigurationLatency' + additionalProperties: false + KnowledgeBasePromptTemplate: + description: Knowledge Base Prompt template + oneOf: + - type: object + title: Text + properties: + TextPromptTemplate: + type: string + minLength: 1 + maxLength: 100000 + required: + - TextPromptTemplate + additionalProperties: false + KnowledgeBaseOrchestrationConfiguration: + type: object + x-title: KnowledgeBaseOrchestrationConfiguration + properties: + PromptTemplate: + $ref: '#/components/schemas/KnowledgeBasePromptTemplate' + InferenceConfig: + $ref: '#/components/schemas/PromptInferenceConfiguration' + AdditionalModelRequestFields: + $ref: '#/components/schemas/AdditionalModelRequestFields' + PerformanceConfig: + $ref: '#/components/schemas/PerformanceConfiguration' + additionalProperties: false + Flow: + type: object + properties: + Arn: + type: string + maxLength: 1011 + minLength: 20 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$ + description: Arn representation of the Flow + CreatedAt: + type: string + description: Time Stamp. + format: date-time + Definition: + $ref: '#/components/schemas/FlowDefinition' + DefinitionString: + type: string + description: A JSON string containing a Definition with the same schema as the Definition property of this resource + maxLength: 512000 + DefinitionS3Location: + $ref: '#/components/schemas/S3Location' + DefinitionSubstitutions: + $ref: '#/components/schemas/DefinitionSubstitutions' + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the flow + ExecutionRoleArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$ + description: ARN of a IAM role + Id: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Flow + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for the flow + Status: + $ref: '#/components/schemas/FlowStatus' + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + Validations: + $ref: '#/components/schemas/FlowValidations' + Version: + type: string + maxLength: 5 + minLength: 5 + pattern: ^DRAFT$ + description: Draft Version. + Tags: + $ref: '#/components/schemas/TagsMap' + TestAliasTags: + $ref: '#/components/schemas/TagsMap' + required: + - ExecutionRoleArn + - Name + x-stackql-resource-name: flow + description: Definition of AWS::Bedrock::Flow Resource Type + x-type-name: AWS::Bedrock::Flow + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - Id + x-write-only-properties: + - DefinitionString + - DefinitionS3Location + - DefinitionSubstitutions + x-read-only-properties: + - Arn + - CreatedAt + - Id + - Status + - UpdatedAt + - Version + - Validations + x-required-properties: + - ExecutionRoleArn + - Name + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateFlow + - bedrock:GetFlow + - bedrock:PrepareFlow + - iam:PassRole + - s3:GetObject + - s3:GetObjectVersion + - bedrock:TagResource + - bedrock:ListTagsForResource + - kms:GenerateDataKey + - kms:Decrypt + - bedrock:CreateGuardrail + - bedrock:CreateGuardrailVersion + - bedrock:GetGuardrail + read: + - bedrock:GetFlow + - bedrock:ListTagsForResource + - kms:Decrypt + - bedrock:GetGuardrail + update: + - bedrock:UpdateFlow + - bedrock:GetFlow + - bedrock:PrepareFlow + - iam:PassRole + - s3:GetObject + - s3:GetObjectVersion + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + - kms:GenerateDataKey + - kms:Decrypt + - bedrock:UpdateGuardrail + - bedrock:GetGuardrail + delete: + - bedrock:DeleteFlow + - bedrock:GetFlow + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + list: + - bedrock:ListFlows + - bedrock:ListGuardrails + ConcurrencyType: + type: string + enum: + - Automatic + - Manual + FlowAliasConcurrencyConfiguration: + type: object + properties: + Type: + $ref: '#/components/schemas/ConcurrencyType' + MaxConcurrency: + type: number + maximum: 100 + minimum: 1 + description: Number of nodes executed concurrently at a time + required: + - Type + additionalProperties: false + FlowAliasRoutingConfigurationListItem: + type: object + description: Details about the routing configuration for a Flow alias. + properties: + FlowVersion: + type: string + maxLength: 5 + minLength: 1 + pattern: ^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$ + description: Version. + additionalProperties: false + FlowAlias: + type: object + properties: + Arn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}$ + description: Arn of the Flow Alias + FlowArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$ + description: Arn representation of the Flow + ConcurrencyConfiguration: + $ref: '#/components/schemas/FlowAliasConcurrencyConfiguration' + CreatedAt: + type: string + description: Time Stamp. + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + FlowId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a flow resource. + Id: + type: string + maxLength: 10 + minLength: 10 + pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$ + description: Id for a Flow Alias generated at the server side. + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + RoutingConfiguration: + type: array + items: + $ref: '#/components/schemas/FlowAliasRoutingConfigurationListItem' + maxItems: 1 + minItems: 1 + description: Routing configuration for a Flow alias. + x-insertionOrder: true + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + Tags: + $ref: '#/components/schemas/TagsMap' + required: + - Name + - FlowArn + - RoutingConfiguration + x-stackql-resource-name: flow_alias + description: Definition of AWS::Bedrock::FlowAlias Resource Type + x-type-name: AWS::Bedrock::FlowAlias + x-stackql-primary-identifier: + - Arn + - FlowArn + x-create-only-properties: + - FlowArn + x-read-only-properties: + - Arn + - CreatedAt + - FlowId + - Id + - UpdatedAt + x-required-properties: + - Name + - FlowArn + - RoutingConfiguration + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateFlowAlias + - bedrock:GetFlowAlias + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetFlowAlias + - bedrock:ListTagsForResource + update: + - bedrock:UpdateFlowAlias + - bedrock:GetFlowAlias + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + delete: + - bedrock:DeleteFlowAlias + list: + - bedrock:ListFlowAliases + FlowVersion: + type: object + properties: + FlowArn: + type: string + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$ + description: Arn representation of the Flow + CreatedAt: + type: string + description: Time Stamp. + format: date-time + Definition: + $ref: '#/components/schemas/FlowDefinition' + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the flow version + ExecutionRoleArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$ + description: ARN of a IAM role + FlowId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Flow + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for the flow + Status: + $ref: '#/components/schemas/FlowStatus' + Version: + type: string + pattern: ^[0-9]{1,5}$ + description: Numerical Version. + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + required: + - FlowArn + x-stackql-resource-name: flow_version + description: Definition of AWS::Bedrock::FlowVersion Resource Type + x-type-name: AWS::Bedrock::FlowVersion + x-stackql-primary-identifier: + - FlowArn + - Version + x-create-only-properties: + - Description + - FlowArn + x-read-only-properties: + - CreatedAt + - Definition + - ExecutionRoleArn + - FlowId + - Name + - Status + - Version + - CustomerEncryptionKeyArn + x-required-properties: + - FlowArn + x-tagging: + taggable: false + x-required-permissions: + create: + - bedrock:CreateFlowVersion + - bedrock:GetFlowVersion + - kms:GenerateDataKey + - kms:Decrypt + - bedrock:CreateGuardrail + - bedrock:CreateGuardrailVersion + - bedrock:GetGuardrail + read: + - bedrock:GetFlowVersion + - kms:Decrypt + - bedrock:GetGuardrail + delete: + - bedrock:DeleteFlowVersion + - bedrock:GetFlowVersion + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + list: + - bedrock:ListFlowVersions + - bedrock:ListGuardrails + update: + - noservice:NoAction + ContentFilterAction: + type: string + enum: + - BLOCK + - NONE + Modality: + type: string + description: Modality for filters + enum: + - TEXT + - IMAGE + ContentFilterConfig: + type: object + description: Content filter config in content policy. + properties: + Type: + $ref: '#/components/schemas/ContentFilterType' + InputStrength: + $ref: '#/components/schemas/FilterStrength' + OutputStrength: + $ref: '#/components/schemas/FilterStrength' + InputModalities: + type: array + items: + $ref: '#/components/schemas/Modality' + minItems: 1 + description: List of modalities + OutputModalities: + type: array + items: + $ref: '#/components/schemas/Modality' + minItems: 1 + description: List of modalities + InputAction: + $ref: '#/components/schemas/ContentFilterAction' + OutputAction: + $ref: '#/components/schemas/ContentFilterAction' + InputEnabled: + type: boolean + OutputEnabled: + type: boolean + required: + - InputStrength + - OutputStrength + - Type + additionalProperties: false + ContentFilterType: + type: string + description: Type of filter in content policy + enum: + - SEXUAL + - VIOLENCE + - HATE + - INSULTS + - MISCONDUCT + - PROMPT_ATTACK + ContentPolicyConfig: + type: object + description: Content policy config for a guardrail. + properties: + FiltersConfig: + type: array + items: + $ref: '#/components/schemas/ContentFilterConfig' + maxItems: 6 + minItems: 1 + description: List of content filter configs in content policy. + ContentFiltersTierConfig: + type: object + properties: + TierName: + $ref: '#/components/schemas/ContentFiltersTierName' + required: + - TierName + additionalProperties: false + description: Guardrail tier config for content policy + required: + - FiltersConfig + additionalProperties: false + ContextualGroundingAction: + type: string + enum: + - BLOCK + - NONE + ContextualGroundingFilterConfig: + type: object + description: A config for grounding filter. + properties: + Type: + $ref: '#/components/schemas/ContextualGroundingFilterType' + Threshold: + type: number + minimum: 0 + description: The threshold for this filter. + Action: + $ref: '#/components/schemas/ContextualGroundingAction' + Enabled: + type: boolean + required: + - Threshold + - Type + additionalProperties: false + ContextualGroundingFilterType: + type: string + description: Type of contextual grounding filter + enum: + - GROUNDING + - RELEVANCE + ContextualGroundingPolicyConfig: + type: object + description: Contextual grounding policy config for a guardrail. + properties: + FiltersConfig: + type: array + items: + $ref: '#/components/schemas/ContextualGroundingFilterConfig' + minItems: 1 + description: List of contextual grounding filter configs. + required: + - FiltersConfig + additionalProperties: false + FilterStrength: + type: string + description: Strength for filters + enum: + - NONE + - LOW + - MEDIUM + - HIGH + GuardrailCrossRegionConfig: + type: object + description: The system-defined guardrail profile that you’re using with your guardrail + properties: + GuardrailProfileArn: + type: string + maxLength: 2048 + minLength: 15 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$ + description: The Amazon Resource Name (ARN) of the guardrail profile + required: + - GuardrailProfileArn + additionalProperties: false + GuardrailStatus: + type: string + description: Status of the guardrail + enum: + - CREATING + - UPDATING + - VERSIONING + - READY + - FAILED + - DELETING + ManagedWordsConfig: + type: object + description: A managed words config. + properties: + Type: + $ref: '#/components/schemas/ManagedWordsType' + InputAction: + $ref: '#/components/schemas/WordAction' + OutputAction: + $ref: '#/components/schemas/WordAction' + InputEnabled: + type: boolean + OutputEnabled: + type: boolean + required: + - Type + additionalProperties: false + ManagedWordsType: + type: string + description: Options for managed words. + enum: + - PROFANITY + PiiEntityConfig: + type: object + description: Pii entity configuration. + properties: + Type: + $ref: '#/components/schemas/PiiEntityType' + Action: + $ref: '#/components/schemas/SensitiveInformationAction' + InputAction: + $ref: '#/components/schemas/SensitiveInformationAction' + OutputAction: + $ref: '#/components/schemas/SensitiveInformationAction' + InputEnabled: + type: boolean + OutputEnabled: + type: boolean + required: + - Action + - Type + additionalProperties: false + PiiEntityType: + type: string + description: The currently supported PII entities + enum: + - ADDRESS + - AGE + - AWS_ACCESS_KEY + - AWS_SECRET_KEY + - CA_HEALTH_NUMBER + - CA_SOCIAL_INSURANCE_NUMBER + - CREDIT_DEBIT_CARD_CVV + - CREDIT_DEBIT_CARD_EXPIRY + - CREDIT_DEBIT_CARD_NUMBER + - DRIVER_ID + - EMAIL + - INTERNATIONAL_BANK_ACCOUNT_NUMBER + - IP_ADDRESS + - LICENSE_PLATE + - MAC_ADDRESS + - NAME + - PASSWORD + - PHONE + - PIN + - SWIFT_CODE + - UK_NATIONAL_HEALTH_SERVICE_NUMBER + - UK_NATIONAL_INSURANCE_NUMBER + - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER + - URL + - USERNAME + - US_BANK_ACCOUNT_NUMBER + - US_BANK_ROUTING_NUMBER + - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER + - US_PASSPORT_NUMBER + - US_SOCIAL_SECURITY_NUMBER + - VEHICLE_IDENTIFICATION_NUMBER + RegexConfig: + type: object + description: A regex configuration. + properties: + Name: + type: string + maxLength: 100 + minLength: 1 + description: The regex name. + Description: + type: string + maxLength: 1000 + minLength: 1 + description: The regex description. + Pattern: + type: string + minLength: 1 + description: The regex pattern. + Action: + $ref: '#/components/schemas/SensitiveInformationAction' + InputAction: + $ref: '#/components/schemas/SensitiveInformationAction' + OutputAction: + $ref: '#/components/schemas/SensitiveInformationAction' + InputEnabled: + type: boolean + OutputEnabled: + type: boolean + required: + - Action + - Name + - Pattern + additionalProperties: false + SensitiveInformationAction: + type: string + description: Options for sensitive information action. + enum: + - BLOCK + - ANONYMIZE + - NONE + SensitiveInformationPolicyConfig: + type: object + description: Sensitive information policy config for a guardrail. + properties: + PiiEntitiesConfig: + type: array + items: + $ref: '#/components/schemas/PiiEntityConfig' + minItems: 1 + uniqueItems: true + description: List of entities. + RegexesConfig: + type: array + items: + $ref: '#/components/schemas/RegexConfig' + minItems: 1 + description: List of regex. + additionalProperties: false + TopicAction: + type: string + enum: + - BLOCK + - NONE + TopicConfig: + type: object + description: Topic config in topic policy. + properties: + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[0-9a-zA-Z-_ !?.]+$ + description: Name of topic in topic policy + Definition: + type: string + maxLength: 200 + minLength: 1 + description: Definition of topic in topic policy + Examples: + type: array + items: + type: string + maxLength: 100 + minLength: 1 + description: Text example in topic policy + minItems: 0 + description: List of text examples + Type: + $ref: '#/components/schemas/TopicType' + InputAction: + $ref: '#/components/schemas/TopicAction' + OutputAction: + $ref: '#/components/schemas/TopicAction' + InputEnabled: + type: boolean + OutputEnabled: + type: boolean + required: + - Definition + - Name + - Type + additionalProperties: false + TopicPolicyConfig: + type: object + description: Topic policy config for a guardrail. + properties: + TopicsConfig: + type: array + items: + $ref: '#/components/schemas/TopicConfig' + minItems: 1 + description: List of topic configs in topic policy. + TopicsTierConfig: + type: object + properties: + TierName: + $ref: '#/components/schemas/TopicsTierName' + required: + - TierName + additionalProperties: false + description: Guardrail tier config for topic policy + required: + - TopicsConfig + additionalProperties: false + TopicType: + type: string + description: Type of topic in a policy + enum: + - DENY + WordAction: + type: string + enum: + - BLOCK + - NONE + WordConfig: + type: object + description: A custom word config. + properties: + Text: + type: string + minLength: 1 + description: The custom word text. + InputAction: + $ref: '#/components/schemas/WordAction' + OutputAction: + $ref: '#/components/schemas/WordAction' + InputEnabled: + type: boolean + OutputEnabled: + type: boolean + required: + - Text + additionalProperties: false + WordPolicyConfig: + type: object + description: Word policy config for a guardrail. + properties: + WordsConfig: + type: array + items: + $ref: '#/components/schemas/WordConfig' + minItems: 1 + description: List of custom word configs. + ManagedWordListsConfig: + type: array + items: + $ref: '#/components/schemas/ManagedWordsConfig' + description: A config for the list of managed words. + additionalProperties: false + ContentFiltersTierName: + type: string + description: Tier name for tier configuration in content filters policy + enum: + - CLASSIC + - STANDARD + TopicsTierName: + type: string + description: Tier name for tier configuration in topic policy + enum: + - CLASSIC + - STANDARD + Guardrail: + type: object + properties: + BlockedInputMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + BlockedOutputsMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + ContentPolicyConfig: + $ref: '#/components/schemas/ContentPolicyConfig' + ContextualGroundingPolicyConfig: + $ref: '#/components/schemas/ContextualGroundingPolicyConfig' + CreatedAt: + type: string + description: Time Stamp + format: date-time + CrossRegionConfig: + $ref: '#/components/schemas/GuardrailCrossRegionConfig' + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the guardrail or its version + FailureRecommendations: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Recommendation for guardrail failure status + maxItems: 100 + description: List of failure recommendations + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: The KMS key with which the guardrail was encrypted at rest + Name: + type: string + maxLength: 50 + minLength: 1 + pattern: ^[0-9a-zA-Z-_]+$ + description: Name of the guardrail + SensitiveInformationPolicyConfig: + $ref: '#/components/schemas/SensitiveInformationPolicyConfig' + Status: + $ref: '#/components/schemas/GuardrailStatus' + StatusReasons: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Reason for guardrail status + maxItems: 100 + description: List of status reasons + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + TopicPolicyConfig: + $ref: '#/components/schemas/TopicPolicyConfig' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + Version: + type: string + pattern: ^(([1-9][0-9]{0,7})|(DRAFT))$ + description: Guardrail version + WordPolicyConfig: + $ref: '#/components/schemas/WordPolicyConfig' + required: + - Name + - BlockedInputMessaging + - BlockedOutputsMessaging + x-stackql-resource-name: guardrail + description: Definition of AWS::Bedrock::Guardrail Resource Type + x-type-name: AWS::Bedrock::Guardrail + x-stackql-primary-identifier: + - GuardrailArn + x-read-only-properties: + - CreatedAt + - FailureRecommendations + - GuardrailArn + - GuardrailId + - Status + - StatusReasons + - UpdatedAt + - Version + x-required-properties: + - Name + - BlockedInputMessaging + - BlockedOutputsMessaging + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:ListTagsForResource + - bedrock:TagResource + - bedrock:UntagResource + x-required-permissions: + create: + - bedrock:CreateGuardrail + - bedrock:GetGuardrail + - kms:DescribeKey + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetGuardrail + - kms:Decrypt + - bedrock:ListTagsForResource + update: + - bedrock:UpdateGuardrail + - bedrock:GetGuardrail + - bedrock:ListTagsForResource + - bedrock:TagResource + - bedrock:UntagResource + - kms:DescribeKey + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + delete: + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + - kms:Decrypt + - kms:RetireGrant + list: + - bedrock:ListGuardrails + GuardrailVersion: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Guardrail version + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + GuardrailIdentifier: + type: string + maxLength: 2048 + pattern: ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$ + description: Identifier (GuardrailId or GuardrailArn) for the guardrail + Version: + type: string + pattern: ^[1-9][0-9]{0,7}$ + description: Guardrail version + required: + - GuardrailIdentifier + x-stackql-resource-name: guardrail_version + description: Definition of AWS::Bedrock::GuardrailVersion Resource Type + x-type-name: AWS::Bedrock::GuardrailVersion + x-stackql-primary-identifier: + - GuardrailId + - Version + x-create-only-properties: + - Description + - GuardrailIdentifier + x-write-only-properties: + - GuardrailIdentifier + x-read-only-properties: + - GuardrailArn + - GuardrailId + - Version + x-required-properties: + - GuardrailIdentifier + x-tagging: + taggable: false + x-required-permissions: + create: + - bedrock:CreateGuardrailVersion + - bedrock:GetGuardrail + - kms:CreateGrant + - kms:Decrypt + read: + - bedrock:GetGuardrail + - kms:Decrypt + delete: + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + - kms:RetireGrant + PromptRouterStatus: + type: string + description: Status of a PromptRouter + enum: + - AVAILABLE + PromptRouterTargetModel: + type: object + description: Model configuration + properties: + ModelArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: (^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)$ + description: Arn of underlying model which are added in the Prompt Router. + required: + - ModelArn + additionalProperties: false + PromptRouterType: + type: string + description: Type of a Prompt Router + enum: + - custom + - default + RoutingCriteria: + type: object + description: Represents the criteria used for routing requests. + properties: + ResponseQualityDifference: + type: number + maximum: 100 + minimum: 0 + required: + - ResponseQualityDifference + additionalProperties: false + IntelligentPromptRouter: + type: object + properties: + CreatedAt: + type: string + description: Time Stamp + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + pattern: ^([0-9a-zA-Z:.][ _-]?)+$ + description: Description of the Prompt Router. + FallbackModel: + $ref: '#/components/schemas/PromptRouterTargetModel' + Models: + type: array + items: + $ref: '#/components/schemas/PromptRouterTargetModel' + description: List of model configuration + PromptRouterArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:(default-)?prompt-router/[a-zA-Z0-9-:.]+$ + description: Arn of the Prompt Router. + PromptRouterName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^([0-9a-zA-Z][ _-]?)+$ + description: Name of the Prompt Router. + RoutingCriteria: + $ref: '#/components/schemas/RoutingCriteria' + Status: + $ref: '#/components/schemas/PromptRouterStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + Type: + $ref: '#/components/schemas/PromptRouterType' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + required: + - FallbackModel + - Models + - PromptRouterName + - RoutingCriteria + x-stackql-resource-name: intelligent_prompt_router + description: Definition of AWS::Bedrock::IntelligentPromptRouter Resource Type + x-type-name: AWS::Bedrock::IntelligentPromptRouter + x-stackql-primary-identifier: + - PromptRouterArn + x-create-only-properties: + - FallbackModel + - Models + - PromptRouterName + - RoutingCriteria + - Description + x-read-only-properties: + - CreatedAt + - PromptRouterArn + - Status + - Type + - UpdatedAt + x-required-properties: + - FallbackModel + - Models + - PromptRouterName + - RoutingCriteria + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreatePromptRouter + - bedrock:GetPromptRouter + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetPromptRouter + - bedrock:ListTagsForResource + update: + - bedrock:GetPromptRouter + - bedrock:ListTagsForResource + - bedrock:TagResource + - bedrock:UntagResource + delete: + - bedrock:DeletePromptRouter + - bedrock:GetPromptRouter + list: + - bedrock:ListPromptRouters + KnowledgeBaseConfiguration: + type: object + description: Contains details about the embeddings model used for the knowledge base. + properties: + Type: + $ref: '#/components/schemas/KnowledgeBaseType' + VectorKnowledgeBaseConfiguration: + $ref: '#/components/schemas/VectorKnowledgeBaseConfiguration' + KendraKnowledgeBaseConfiguration: + $ref: '#/components/schemas/KendraKnowledgeBaseConfiguration' + SqlKnowledgeBaseConfiguration: + $ref: '#/components/schemas/SqlKnowledgeBaseConfiguration' + required: + - Type + additionalProperties: false + KnowledgeBaseStatus: + type: string + description: The status of a knowledge base. + enum: + - CREATING + - ACTIVE + - DELETING + - UPDATING + - FAILED + - DELETE_UNSUCCESSFUL + KnowledgeBaseStorageType: + type: string + description: The storage type of a knowledge base. + enum: + - OPENSEARCH_SERVERLESS + - PINECONE + - RDS + - MONGO_DB_ATLAS + - NEPTUNE_ANALYTICS + - OPENSEARCH_MANAGED_CLUSTER + KnowledgeBaseType: + type: string + description: The type of a knowledge base. + enum: + - VECTOR + - KENDRA + - SQL + OpenSearchManagedClusterConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in Amazon OpenSearch Service. + properties: + DomainArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(|-cn|-us-gov|-iso):es:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:domain/[a-z][a-z0-9-]{3,28}$ + description: The Amazon Resource Name (ARN) of the OpenSearch domain. + DomainEndpoint: + type: string + maxLength: 2048 + pattern: ^https://.*$ + description: The endpoint URL the OpenSearch domain. + VectorIndexName: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(?![\-_+.])[a-z0-9][a-z0-9\-_\.]*$ + description: The name of the vector store. + FieldMapping: + $ref: '#/components/schemas/OpenSearchManagedClusterFieldMapping' + required: + - DomainArn + - DomainEndpoint + - VectorIndexName + - FieldMapping + additionalProperties: false + OpenSearchManagedClusterFieldMapping: + type: object + description: A mapping of Bedrock Knowledge Base fields to OpenSearch Managed Cluster field names + properties: + VectorField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - MetadataField + - TextField + - VectorField + additionalProperties: false + OpenSearchServerlessConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in Amazon OpenSearch Service. + properties: + CollectionArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(|-cn|-us-gov|-iso):aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}$ + description: The ARN of the OpenSearch Service vector store. + VectorIndexName: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the vector store. + FieldMapping: + $ref: '#/components/schemas/OpenSearchServerlessFieldMapping' + required: + - CollectionArn + - FieldMapping + - VectorIndexName + additionalProperties: false + OpenSearchServerlessFieldMapping: + type: object + description: A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names + properties: + VectorField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - MetadataField + - TextField + - VectorField + additionalProperties: false + PineconeConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in Pinecone. + properties: + ConnectionString: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The endpoint URL for your index management page. + CredentialsSecretArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. + Namespace: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The namespace to be used to write new data to your database. + FieldMapping: + $ref: '#/components/schemas/PineconeFieldMapping' + required: + - ConnectionString + - CredentialsSecretArn + - FieldMapping + additionalProperties: false + PineconeFieldMapping: + type: object + description: Contains the names of the fields to which to map information about the vector store. + properties: + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - MetadataField + - TextField + additionalProperties: false + RdsConfiguration: + type: object + description: Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. + properties: + ResourceArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$ + description: The ARN of the vector store. + CredentialsSecretArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database. + DatabaseName: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of your Amazon RDS database. + TableName: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\.\-]+$ + description: The name of the table in the database. + FieldMapping: + $ref: '#/components/schemas/RdsFieldMapping' + required: + - CredentialsSecretArn + - DatabaseName + - FieldMapping + - ResourceArn + - TableName + additionalProperties: false + RdsFieldMapping: + type: object + description: Contains the names of the fields to which to map information about the vector store. + properties: + PrimaryKeyField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores the ID for each entry. + VectorField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + TextField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + CustomMetadataField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores custom metadata about the vector store. + required: + - MetadataField + - PrimaryKeyField + - TextField + - VectorField + additionalProperties: false + RedisEnterpriseCloudConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in Redis Enterprise Cloud. + properties: + Endpoint: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The endpoint URL of the Redis Enterprise Cloud database. + VectorIndexName: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the vector index. + CredentialsSecretArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database. + FieldMapping: + $ref: '#/components/schemas/RedisEnterpriseCloudFieldMapping' + required: + - CredentialsSecretArn + - Endpoint + - FieldMapping + - VectorIndexName + additionalProperties: false + RedisEnterpriseCloudFieldMapping: + type: object + description: Contains the names of the fields to which to map information about the vector store. + properties: + VectorField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - MetadataField + - TextField + - VectorField + additionalProperties: false + MongoDbAtlasFieldMapping: + type: object + description: Contains the names of the fields to which to map information about the vector store. + properties: + VectorField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - VectorField + - MetadataField + - TextField + additionalProperties: false + MongoDbAtlasConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud. + properties: + Endpoint: + type: string + maxLength: 2048 + pattern: ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.mongodb\.net$ + description: MongoDB Atlas endpoint. + CredentialsSecretArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database. + DatabaseName: + type: string + maxLength: 63 + pattern: ^.*$ + description: Name of the database within MongoDB Atlas. + CollectionName: + type: string + maxLength: 63 + pattern: ^.*$ + description: Name of the collection within MongoDB Atlas. + VectorIndexName: + type: string + maxLength: 2048 + pattern: ^.*$ + description: Name of a MongoDB Atlas index. + TextIndexName: + type: string + maxLength: 2048 + pattern: ^.*$ + description: Name of a MongoDB Atlas text index. + EndpointServiceName: + type: string + maxLength: 255 + pattern: ^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$ + description: MongoDB Atlas endpoint service name. + FieldMapping: + $ref: '#/components/schemas/MongoDbAtlasFieldMapping' + required: + - Endpoint + - CredentialsSecretArn + - DatabaseName + - CollectionName + - VectorIndexName + - FieldMapping + additionalProperties: false + NeptuneAnalyticsFieldMapping: + type: object + description: A mapping of Bedrock Knowledge Base fields to Neptune Analytics fields. + properties: + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - TextField + - MetadataField + additionalProperties: false + NeptuneAnalyticsConfiguration: + type: object + description: Contains the configurations to use Neptune Analytics as Vector Store. + properties: + GraphArn: + type: string + minLength: 1 + maxLength: 255 + pattern: ^arn:aws(|-cn|-us-gov):neptune-graph:[a-zA-Z0-9-]*:[0-9]{12}:graph\/g-[a-zA-Z0-9]{10}$ + description: ARN for Neptune Analytics graph database. + FieldMapping: + $ref: '#/components/schemas/NeptuneAnalyticsFieldMapping' + required: + - GraphArn + - FieldMapping + additionalProperties: false + StorageConfiguration: + type: object + description: The vector store service in which the knowledge base is stored. + properties: + Type: + $ref: '#/components/schemas/KnowledgeBaseStorageType' + OpensearchServerlessConfiguration: + $ref: '#/components/schemas/OpenSearchServerlessConfiguration' + PineconeConfiguration: + $ref: '#/components/schemas/PineconeConfiguration' + RdsConfiguration: + $ref: '#/components/schemas/RdsConfiguration' + MongoDbAtlasConfiguration: + $ref: '#/components/schemas/MongoDbAtlasConfiguration' + NeptuneAnalyticsConfiguration: + $ref: '#/components/schemas/NeptuneAnalyticsConfiguration' + OpensearchManagedClusterConfiguration: + $ref: '#/components/schemas/OpenSearchManagedClusterConfiguration' + required: + - Type + oneOf: + - required: + - OpensearchServerlessConfiguration + - required: + - PineconeConfiguration + - required: + - RdsConfiguration + - required: + - NeptuneAnalyticsConfiguration + - required: + - MongoDbAtlasConfiguration + - required: + - OpensearchManagedClusterConfiguration + additionalProperties: false + BedrockEmbeddingModelConfiguration: + type: object + description: The vector configuration details for the Bedrock embeddings model. + properties: + Dimensions: + type: integer + maximum: 4096 + minimum: 0 + description: The dimensions details for the vector configuration used on the Bedrock embeddings model. + EmbeddingDataType: + type: string + description: The data type for the vectors when using a model to convert text into vector embeddings. + enum: + - FLOAT32 + - BINARY + additionalProperties: false + EmbeddingModelConfiguration: + type: object + description: The embeddings model configuration details for the vector model used in Knowledge Base. + properties: + BedrockEmbeddingModelConfiguration: + $ref: '#/components/schemas/BedrockEmbeddingModelConfiguration' + additionalProperties: false + VectorKnowledgeBaseConfiguration: + type: object + description: Contains details about the model used to create vector embeddings for the knowledge base. + properties: + EmbeddingModelArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$ + description: The ARN of the model used to create vector embeddings for the knowledge base. + EmbeddingModelConfiguration: + $ref: '#/components/schemas/EmbeddingModelConfiguration' + SupplementalDataStorageConfiguration: + $ref: '#/components/schemas/SupplementalDataStorageConfiguration' + required: + - EmbeddingModelArn + additionalProperties: false + SupplementalDataStorageLocationType: + type: string + description: Supplemental data storage location type. + enum: + - S3 + SupplementalDataStorageLocation: + type: object + description: Supplemental data storage location. + properties: + SupplementalDataStorageLocationType: + $ref: '#/components/schemas/SupplementalDataStorageLocationType' + S3Location: + $ref: '#/components/schemas/S3Location' + required: + - SupplementalDataStorageLocationType + additionalProperties: false + SupplementalDataStorageLocations: + type: array + items: + $ref: '#/components/schemas/SupplementalDataStorageLocation' + maxItems: 1 + minItems: 1 + description: List of supplemental data storage locations. + x-insertionOrder: false + SupplementalDataStorageConfiguration: + type: object + description: Configurations for supplemental data storage. + properties: + SupplementalDataStorageLocations: + $ref: '#/components/schemas/SupplementalDataStorageLocations' + required: + - SupplementalDataStorageLocations + additionalProperties: false + KendraKnowledgeBaseConfiguration: + type: object + description: Configurations for a Kendra knowledge base + properties: + KendraIndexArn: + $ref: '#/components/schemas/KendraIndexArn' + required: + - KendraIndexArn + additionalProperties: false + KendraIndexArn: + type: string + description: Arn of a Kendra index + pattern: ^arn:aws(|-cn|-us-gov):kendra:[a-z0-9-]{1,20}:([0-9]{12}|):index/([a-zA-Z0-9][a-zA-Z0-9-]{35}|[a-zA-Z0-9][a-zA-Z0-9-]{35}-[a-zA-Z0-9][a-zA-Z0-9-]{35})$ + SqlKnowledgeBaseConfiguration: + type: object + description: Configurations for a SQL knowledge base + properties: + Type: + $ref: '#/components/schemas/QueryEngineType' + RedshiftConfiguration: + $ref: '#/components/schemas/RedshiftConfiguration' + required: + - Type + additionalProperties: false + QueryEngineType: + type: string + description: SQL query engine type + enum: + - REDSHIFT + RedshiftConfiguration: + type: object + description: Configurations for a Redshift knowledge base + properties: + StorageConfigurations: + $ref: '#/components/schemas/RedshiftQueryEngineStorageConfigurations' + QueryEngineConfiguration: + $ref: '#/components/schemas/RedshiftQueryEngineConfiguration' + QueryGenerationConfiguration: + $ref: '#/components/schemas/QueryGenerationConfiguration' + required: + - StorageConfigurations + - QueryEngineConfiguration + additionalProperties: false + RedshiftQueryEngineStorageConfigurations: + type: array + description: List of configurations for available Redshift query engine storage types + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/RedshiftQueryEngineStorageConfiguration' + x-insertionOrder: false + RedshiftQueryEngineStorageConfiguration: + type: object + description: Configurations for available Redshift query engine storage types + properties: + Type: + $ref: '#/components/schemas/RedshiftQueryEngineStorageType' + AwsDataCatalogConfiguration: + $ref: '#/components/schemas/RedshiftQueryEngineAwsDataCatalogStorageConfiguration' + RedshiftConfiguration: + $ref: '#/components/schemas/RedshiftQueryEngineRedshiftStorageConfiguration' + required: + - Type + additionalProperties: false + RedshiftQueryEngineStorageType: + type: string + description: Redshift query engine storage type + enum: + - REDSHIFT + - AWS_DATA_CATALOG + RedshiftQueryEngineAwsDataCatalogStorageConfiguration: + type: object + description: Configurations for Redshift query engine AWS Data Catalog backed storage + properties: + TableNames: + $ref: '#/components/schemas/AwsDataCatalogTableNames' + required: + - TableNames + additionalProperties: false + AwsDataCatalogTableNames: + type: array + description: List of table names in AWS Data Catalog. Must follow two part notation + items: + $ref: '#/components/schemas/AwsDataCatalogTableName' + minItems: 1 + maxItems: 1000 + x-insertionOrder: false + AwsDataCatalogTableName: + type: string + description: AWS Data Catalog table name + pattern: ^.*\.*$ + minLength: 1 + maxLength: 200 + RedshiftQueryEngineRedshiftStorageConfiguration: + type: object + description: Configurations for Redshift query engine Redshift backed storage + properties: + DatabaseName: + $ref: '#/components/schemas/RedshiftDatabase' + required: + - DatabaseName + additionalProperties: false + RedshiftDatabase: + type: string + description: Redshift database name + minLength: 1 + maxLength: 200 + RedshiftQueryEngineConfiguration: + type: object + description: Configurations for Redshift query engine + properties: + Type: + $ref: '#/components/schemas/RedshiftQueryEngineType' + ServerlessConfiguration: + $ref: '#/components/schemas/RedshiftServerlessConfiguration' + ProvisionedConfiguration: + $ref: '#/components/schemas/RedshiftProvisionedConfiguration' + required: + - Type + additionalProperties: false + RedshiftQueryEngineType: + type: string + description: Redshift query engine type + enum: + - SERVERLESS + - PROVISIONED + RedshiftServerlessConfiguration: + type: object + description: Configurations for serverless Redshift query engine + properties: + WorkgroupArn: + $ref: '#/components/schemas/WorkgroupArn' + AuthConfiguration: + $ref: '#/components/schemas/RedshiftServerlessAuthConfiguration' + required: + - WorkgroupArn + - AuthConfiguration + additionalProperties: false + WorkgroupArn: + type: string + description: Workgroup arn + pattern: ^(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ + RedshiftServerlessAuthConfiguration: + type: object + description: Configurations for Redshift query engine serverless auth setup + properties: + Type: + $ref: '#/components/schemas/RedshiftServerlessAuthType' + UsernamePasswordSecretArn: + $ref: '#/components/schemas/SecretArn' + required: + - Type + additionalProperties: false + RedshiftServerlessAuthType: + type: string + description: Serverless Redshift auth type + enum: + - IAM + - USERNAME_PASSWORD + SecretArn: + type: string + description: Arn of a SecretsManager Secret + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + RedshiftProvisionedConfiguration: + type: object + description: Configurations for provisioned Redshift query engine + properties: + ClusterIdentifier: + $ref: '#/components/schemas/RedshiftClusterIdentifier' + AuthConfiguration: + $ref: '#/components/schemas/RedshiftProvisionedAuthConfiguration' + required: + - ClusterIdentifier + - AuthConfiguration + additionalProperties: false + RedshiftClusterIdentifier: + type: string + description: Redshift cluster identifier + minLength: 1 + maxLength: 63 + RedshiftProvisionedAuthConfiguration: + type: object + description: Configurations for Redshift query engine provisioned auth setup + properties: + Type: + $ref: '#/components/schemas/RedshiftProvisionedAuthType' + DatabaseUser: + type: string + description: Redshift database user + UsernamePasswordSecretArn: + $ref: '#/components/schemas/SecretArn' + required: + - Type + additionalProperties: false + RedshiftProvisionedAuthType: + type: string + description: Provisioned Redshift auth type + enum: + - IAM + - USERNAME_PASSWORD + - USERNAME + QueryGenerationConfiguration: + type: object + description: Configurations for generating Redshift engine queries + properties: + ExecutionTimeoutSeconds: + $ref: '#/components/schemas/QueryExecutionTimeoutSeconds' + GenerationContext: + $ref: '#/components/schemas/QueryGenerationContext' + additionalProperties: false + QueryExecutionTimeoutSeconds: + type: integer + description: Max query execution timeout + minimum: 1 + maximum: 200 + QueryGenerationContext: + type: object + description: Context used to improve query generation + properties: + Tables: + $ref: '#/components/schemas/QueryGenerationTables' + CuratedQueries: + $ref: '#/components/schemas/CuratedQueries' + additionalProperties: false + QueryGenerationTables: + type: array + description: List of tables used for Redshift query generation context + items: + $ref: '#/components/schemas/QueryGenerationTable' + maxItems: 50 + x-insertionOrder: false + QueryGenerationTable: + type: object + description: Tables used for Redshift query generation context + properties: + Name: + $ref: '#/components/schemas/QueryGenerationTableName' + Description: + $ref: '#/components/schemas/DescriptionString' + Inclusion: + $ref: '#/components/schemas/InclusionType' + Columns: + $ref: '#/components/schemas/QueryGenerationColumns' + required: + - Name + additionalProperties: false + QueryGenerationTableName: + type: string + description: Query generation table name. Must follow three-part notation + pattern: ^.*\..*\..*$ + DescriptionString: + type: string + description: Description for the attached entity + minLength: 1 + maxLength: 200 + InclusionType: + type: string + description: Include or Exclude status for an entity + enum: + - INCLUDE + - EXCLUDE + QueryGenerationColumns: + type: array + description: List of Redshift query generation columns + items: + $ref: '#/components/schemas/QueryGenerationColumn' + x-insertionOrder: false + QueryGenerationColumn: + type: object + description: Redshift query generation column + properties: + Name: + $ref: '#/components/schemas/QueryGenerationColumnName' + Description: + $ref: '#/components/schemas/DescriptionString' + Inclusion: + $ref: '#/components/schemas/InclusionType' + additionalProperties: false + QueryGenerationColumnName: + type: string + description: Query generation column name + minLength: 1 + maxLength: 127 + CuratedQueries: + type: array + description: List of example queries and results + maxItems: 10 + items: + $ref: '#/components/schemas/CuratedQuery' + x-insertionOrder: false + CuratedQuery: + type: object + description: Curated query or question and answer pair + properties: + NaturalLanguage: + $ref: '#/components/schemas/NaturalLanguageString' + Sql: + $ref: '#/components/schemas/SqlString' + required: + - NaturalLanguage + - Sql + additionalProperties: false + NaturalLanguageString: + type: string + description: Question for the curated query + minLength: 1 + maxLength: 1000 + SqlString: + type: string + description: Answer for the curated query + minLength: 1 + maxLength: 1000 + KnowledgeBase: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + KnowledgeBaseConfiguration: + $ref: '#/components/schemas/KnowledgeBaseConfiguration' + KnowledgeBaseId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: The unique identifier of the knowledge base. + KnowledgeBaseArn: + type: string + maxLength: 128 + minLength: 0 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$ + description: The ARN of the knowledge base. + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: The name of the knowledge base. + Status: + $ref: '#/components/schemas/KnowledgeBaseStatus' + RoleArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$ + description: The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_ + CreatedAt: + type: string + description: The time at which the knowledge base was created. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: A list of reasons that the API operation on the knowledge base failed. + x-insertionOrder: false + UpdatedAt: + type: string + description: The time at which the knowledge base was last updated. + StorageConfiguration: + $ref: '#/components/schemas/StorageConfiguration' + Tags: + $ref: '#/components/schemas/TagsMap' + required: + - KnowledgeBaseConfiguration + - Name + - RoleArn + x-stackql-resource-name: knowledge_base + description: Definition of AWS::Bedrock::KnowledgeBase Resource Type + x-type-name: AWS::Bedrock::KnowledgeBase + x-stackql-primary-identifier: + - KnowledgeBaseId + x-create-only-properties: + - StorageConfiguration + - KnowledgeBaseConfiguration/Type + - KnowledgeBaseConfiguration/VectorKnowledgeBaseConfiguration + - KnowledgeBaseConfiguration/KendraKnowledgeBaseConfiguration + - KnowledgeBaseConfiguration/SqlKnowledgeBaseConfiguration/Type + - KnowledgeBaseConfiguration/SqlKnowledgeBaseConfiguration/RedshiftConfiguration/StorageConfigurations + - KnowledgeBaseConfiguration/SqlKnowledgeBaseConfiguration/RedshiftConfiguration/QueryEngineConfiguration + x-read-only-properties: + - KnowledgeBaseId + - KnowledgeBaseArn + - CreatedAt + - UpdatedAt + - FailureReasons + - Status + x-required-properties: + - KnowledgeBaseConfiguration + - Name + - RoleArn + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreateKnowledgeBase + - bedrock:GetKnowledgeBase + - bedrock:TagResource + - bedrock:ListTagsForResource + - bedrock:AssociateThirdPartyKnowledgeBase + - iam:PassRole + read: + - bedrock:GetKnowledgeBase + - bedrock:ListTagsForResource + update: + - bedrock:GetKnowledgeBase + - bedrock:UpdateKnowledgeBase + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + - bedrock:AssociateThirdPartyKnowledgeBase + - iam:PassRole + delete: + - bedrock:GetKnowledgeBase + - bedrock:DeleteKnowledgeBase + - bedrock:ListDataSources + list: + - bedrock:ListKnowledgeBases + PromptVariant: + type: object + description: Prompt variant + properties: + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a variant. + TemplateType: + $ref: '#/components/schemas/PromptTemplateType' + TemplateConfiguration: + $ref: '#/components/schemas/PromptTemplateConfiguration' + ModelId: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$ + description: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models. + InferenceConfiguration: + $ref: '#/components/schemas/PromptInferenceConfiguration' + GenAiResource: + $ref: '#/components/schemas/PromptGenAiResource' + AdditionalModelRequestFields: + $ref: '#/components/schemas/AdditionalModelRequestFields' + Metadata: + $ref: '#/components/schemas/PromptMetadataList' + required: + - Name + - TemplateType + - TemplateConfiguration + additionalProperties: false + ChatPromptTemplateConfiguration: + type: object + description: Configuration for chat prompt template + properties: + Messages: + type: array + items: + $ref: '#/components/schemas/Message' + minItems: 0 + description: List of messages for chat prompt template + x-insertionOrder: true + System: + type: array + items: + $ref: '#/components/schemas/SystemContentBlock' + minItems: 0 + description: Configuration for chat prompt template + x-insertionOrder: true + ToolConfiguration: + $ref: '#/components/schemas/ToolConfiguration' + InputVariables: + type: array + items: + $ref: '#/components/schemas/PromptInputVariable' + maxItems: 20 + minItems: 0 + description: List of input variables + x-insertionOrder: true + required: + - Messages + additionalProperties: false + TextS3Location: + type: object + description: The identifier for the S3 resource. + properties: + Bucket: + type: string + maxLength: 63 + minLength: 3 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + description: A bucket in S3 + Key: + type: string + maxLength: 1024 + minLength: 1 + description: A object key in S3 + Version: + type: string + maxLength: 1024 + minLength: 1 + description: The version of the the S3 object to use + required: + - Bucket + - Key + additionalProperties: false + ConversationRole: + type: string + description: Conversation roles for the chat prompt + enum: + - user + - assistant + ContentBlock: + description: Configuration for chat prompt template + oneOf: + - title: Text + type: object + properties: + Text: + type: string + minLength: 1 + description: Configuration for chat prompt template + required: + - Text + additionalProperties: false + - title: CachePoint + type: object + properties: + CachePoint: + $ref: '#/components/schemas/CachePointBlock' + required: + - CachePoint + additionalProperties: false + SystemContentBlock: + description: Configuration for chat prompt template + oneOf: + - title: Text + type: object + properties: + Text: + type: string + minLength: 1 + description: Configuration for chat prompt template + required: + - Text + additionalProperties: false + - title: CachePoint + type: object + properties: + CachePoint: + $ref: '#/components/schemas/CachePointBlock' + required: + - CachePoint + additionalProperties: false + Message: + type: object + description: Chat prompt Message + properties: + Role: + $ref: '#/components/schemas/ConversationRole' + Content: + type: array + items: + $ref: '#/components/schemas/ContentBlock' + minItems: 1 + description: List of Content Blocks + x-insertionOrder: true + required: + - Role + - Content + additionalProperties: false + ToolInputSchema: + description: Tool input schema + oneOf: + - type: object + title: Json + properties: + Json: + type: object + description: Tool input schema json + required: + - Json + additionalProperties: false + ToolSpecification: + type: object + description: Tool specification + properties: + Name: + type: string + pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ + minLength: 1 + maxLength: 64 + description: Tool name + Description: + type: string + minLength: 1 + InputSchema: + $ref: '#/components/schemas/ToolInputSchema' + required: + - Name + - InputSchema + additionalProperties: false + Tool: + description: Tool details + oneOf: + - type: object + title: ToolSpec + properties: + ToolSpec: + $ref: '#/components/schemas/ToolSpecification' + required: + - ToolSpec + additionalProperties: false + - title: CachePoint + type: object + properties: + CachePoint: + $ref: '#/components/schemas/CachePointBlock' + required: + - CachePoint + additionalProperties: false + AutoToolChoice: + type: object + description: Auto Tool choice + additionalProperties: false + AnyToolChoice: + type: object + description: Any Tool choice + additionalProperties: false + SpecificToolChoice: + type: object + description: Specific Tool choice + properties: + Name: + type: string + pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ + minLength: 1 + maxLength: 64 + description: Tool name + required: + - Name + additionalProperties: false + ToolChoice: + description: Tool choice + oneOf: + - title: Auto + type: object + properties: + Auto: + $ref: '#/components/schemas/AutoToolChoice' + required: + - Auto + additionalProperties: false + - title: Any + type: object + properties: + Any: + $ref: '#/components/schemas/AnyToolChoice' + required: + - Any + additionalProperties: false + - title: Tool + type: object + properties: + Tool: + $ref: '#/components/schemas/SpecificToolChoice' + required: + - Tool + additionalProperties: false + ToolConfiguration: + type: object + description: Tool configuration + properties: + Tools: + type: array + items: + $ref: '#/components/schemas/Tool' + minItems: 1 + description: List of Tools + x-insertionOrder: true + ToolChoice: + $ref: '#/components/schemas/ToolChoice' + required: + - Tools + additionalProperties: false + PromptAgentResource: + description: Target Agent to invoke with Prompt + type: object + properties: + AgentIdentifier: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$ + description: Arn representation of the Agent Alias. + required: + - AgentIdentifier + additionalProperties: false + PromptGenAiResource: + description: Target resource to invoke with Prompt + oneOf: + - type: object + title: Agent + properties: + Agent: + $ref: '#/components/schemas/PromptAgentResource' + required: + - Agent + additionalProperties: false + CachePointBlock: + description: CachePointBlock + type: object + properties: + Type: + $ref: '#/components/schemas/CachePointType' + required: + - Type + additionalProperties: false + CachePointType: + description: CachePoint types for CachePointBlock + type: string + enum: + - default + PromptMetadataList: + type: array + description: List of metadata to associate with the prompt variant. + items: + $ref: '#/components/schemas/PromptMetadataEntry' + maxItems: 50 + minItems: 0 + x-insertionOrder: true + PromptMetadataEntry: + type: object + description: Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. + properties: + Key: + $ref: '#/components/schemas/PromptMetadataKey' + Value: + $ref: '#/components/schemas/PromptMetadataValue' + required: + - Key + - Value + additionalProperties: false + PromptMetadataKey: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: The key of a metadata tag for a prompt variant. + PromptMetadataValue: + type: string + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: The value of a metadata tag for a prompt variant. + Prompt: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$ + description: ARN of a prompt resource possibly with a version + CreatedAt: + type: string + description: Time Stamp. + format: date-time + DefaultVariant: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a variant. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Name for a prompt resource. + Id: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Prompt + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a prompt resource. + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + Variants: + type: array + items: + $ref: '#/components/schemas/PromptVariant' + maxItems: 1 + minItems: 0 + description: List of prompt variants + x-insertionOrder: true + Tags: + $ref: '#/components/schemas/TagsMap' + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + Version: + type: string + maxLength: 5 + minLength: 5 + pattern: ^DRAFT$ + description: Draft Version. + required: + - Name + x-stackql-resource-name: prompt + description: Definition of AWS::Bedrock::Prompt Resource Type + x-type-name: AWS::Bedrock::Prompt + x-stackql-primary-identifier: + - Arn + x-write-only-properties: + - Variants/*/TemplateConfiguration/Text/TextS3Location + x-read-only-properties: + - Arn + - CreatedAt + - Id + - UpdatedAt + - Version + x-required-properties: + - Name + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreatePrompt + - bedrock:GetPrompt + - s3:GetObject + - s3:GetObjectVersion + - bedrock:TagResource + - bedrock:ListTagsForResource + - kms:GenerateDataKey + - kms:Decrypt + read: + - bedrock:GetPrompt + - bedrock:ListTagsForResource + - kms:Decrypt + update: + - bedrock:UpdatePrompt + - bedrock:GetPrompt + - s3:GetObject + - s3:GetObjectVersion + - bedrock:TagResource + - bedrock:UntagResource + - bedrock:ListTagsForResource + - kms:GenerateDataKey + - kms:Decrypt + delete: + - bedrock:DeletePrompt + - bedrock:GetPrompt + list: + - bedrock:ListPrompts + PromptVersion: + type: object + properties: + PromptArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$ + description: ARN of a prompt resource possibly with a version + Arn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}:[0-9]{1,20})$ + description: ARN of a prompt version resource + CreatedAt: + type: string + description: Time Stamp. + format: date-time + PromptId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Prompt + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + Version: + type: string + maxLength: 5 + minLength: 1 + pattern: ^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$ + description: Version. + Variants: + type: array + items: + $ref: '#/components/schemas/PromptVariant' + maxItems: 1 + minItems: 1 + description: List of prompt variants + x-insertionOrder: true + DefaultVariant: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a variant. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description for a prompt version resource. + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a prompt resource. + Tags: + $ref: '#/components/schemas/TagsMap' + required: + - PromptArn + x-stackql-resource-name: prompt_version + description: Definition of AWS::Bedrock::PromptVersion Resource Type + x-type-name: AWS::Bedrock::PromptVersion + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - PromptArn + - Description + - Tags + x-read-only-properties: + - Arn + - CreatedAt + - PromptId + - UpdatedAt + - Version + - Name + - DefaultVariant + - Variants + - CustomerEncryptionKeyArn + x-required-properties: + - PromptArn + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: false + taggable: true + permissions: + - bedrock:TagResource + - bedrock:ListTagsForResource + x-required-permissions: + create: + - bedrock:CreatePromptVersion + - bedrock:GetPrompt + - bedrock:TagResource + - bedrock:ListTagsForResource + - kms:GenerateDataKey + - kms:Decrypt + read: + - bedrock:GetPrompt + - bedrock:ListTagsForResource + - kms:Decrypt + delete: + - bedrock:DeletePrompt + - bedrock:GetPrompt + list: + - bedrock:ListPrompts + CreateAgentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActionGroups: + type: array + items: + $ref: '#/components/schemas/AgentActionGroup' + description: List of ActionGroups + x-insertionOrder: false + AgentArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$ + description: Arn representation of the Agent. + AgentId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + AgentName: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + AgentResourceRoleArn: + type: string + maxLength: 2048 + description: ARN of a IAM role. + AgentStatus: + $ref: '#/components/schemas/AgentStatus' + AgentVersion: + type: string + maxLength: 5 + minLength: 5 + pattern: ^DRAFT$ + description: Draft Agent Version. + AutoPrepare: + description: Specifies whether to automatically prepare after creating or updating the agent. + type: boolean + default: false + CreatedAt: + type: string + description: Time Stamp. + format: date-time + CustomOrchestration: + $ref: '#/components/schemas/CustomOrchestration' + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + SkipResourceInUseCheckOnDelete: + description: Specifies whether to allow deleting agent while it is in use. + type: boolean + default: false + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: Failure Reasons for Error. + x-insertionOrder: false + FoundationModel: + $ref: '#/components/schemas/FoundationModel' + GuardrailConfiguration: + $ref: '#/components/schemas/GuardrailConfiguration' + MemoryConfiguration: + $ref: '#/components/schemas/MemoryConfiguration' + IdleSessionTTLInSeconds: + type: number + maximum: 3600 + minimum: 60 + description: Max Session Time. + AgentCollaboration: + $ref: '#/components/schemas/AgentCollaboration' + Instruction: + type: string + minLength: 40 + description: Instruction for the agent. + KnowledgeBases: + type: array + items: + $ref: '#/components/schemas/AgentKnowledgeBase' + description: List of Agent Knowledge Bases + x-insertionOrder: false + AgentCollaborators: + type: array + items: + $ref: '#/components/schemas/AgentCollaborator' + description: List of Agent Collaborators + x-insertionOrder: false + OrchestrationType: + $ref: '#/components/schemas/OrchestrationType' + PreparedAt: + type: string + description: Time Stamp. + format: date-time + PromptOverrideConfiguration: + $ref: '#/components/schemas/PromptOverrideConfiguration' + RecommendedActions: + type: array + items: + type: string + maxLength: 2048 + description: The recommended action users can take to resolve an error in failureReasons. + maxItems: 2048 + description: The recommended actions users can take to resolve an error in failureReasons. + x-insertionOrder: false + Tags: + $ref: '#/components/schemas/TagsMap' + TestAliasTags: + $ref: '#/components/schemas/TagsMap' + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + x-stackQL-stringOnly: true + x-title: CreateAgentRequest + type: object + required: [] + CreateAgentAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AgentAliasArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$ + description: Arn representation of the Agent Alias. + AgentAliasHistoryEvents: + type: array + items: + $ref: '#/components/schemas/AgentAliasHistoryEvent' + maxItems: 10 + description: The list of history events for an alias for an Agent. + x-insertionOrder: false + AgentAliasId: + type: string + maxLength: 10 + minLength: 10 + pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$ + description: Id for an Agent Alias generated at the server side. + AgentAliasName: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + AgentAliasStatus: + $ref: '#/components/schemas/AgentAliasStatus' + AgentId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + CreatedAt: + type: string + description: Time Stamp. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + RoutingConfiguration: + type: array + items: + $ref: '#/components/schemas/AgentAliasRoutingConfigurationListItem' + maxItems: 1 + description: Routing configuration for an Agent alias. + x-insertionOrder: false + Tags: + $ref: '#/components/schemas/TagsMap' + UpdatedAt: + type: string + description: Time Stamp. + x-stackQL-stringOnly: true + x-title: CreateAgentAliasRequest + type: object + required: [] + CreateApplicationInferenceProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + type: string + description: Time Stamp + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + pattern: ^([0-9a-zA-Z:.][ _-]?)+$ + description: Description of the inference profile + InferenceProfileArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$ + InferenceProfileId: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-:.]+$ + InferenceProfileIdentifier: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+$ + description: Inference profile identifier. Supports both system-defined inference profile ids, and inference profile ARNs. + InferenceProfileName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^([0-9a-zA-Z][ _-]?)+$ + ModelSource: + $ref: '#/components/schemas/InferenceProfileModelSource' + Models: + type: array + items: + $ref: '#/components/schemas/InferenceProfileModel' + maxItems: 5 + minItems: 1 + description: List of model configuration + Status: + $ref: '#/components/schemas/InferenceProfileStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + Type: + $ref: '#/components/schemas/InferenceProfileType' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + x-stackQL-stringOnly: true + x-title: CreateApplicationInferenceProfileRequest + type: object + required: [] + CreateAutomatedReasoningPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + $ref: '#/components/schemas/Name' + Description: + $ref: '#/components/schemas/Description' + PolicyDefinition: + $ref: '#/components/schemas/PolicyDefinition' + PolicyArn: + $ref: '#/components/schemas/PolicyArn' + Version: + $ref: '#/components/schemas/Version' + DefinitionHash: + $ref: '#/components/schemas/DefinitionHash' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + PolicyId: + $ref: '#/components/schemas/PolicyId' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateAutomatedReasoningPolicyRequest + type: object + required: [] + CreateAutomatedReasoningPolicyVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyArn: + $ref: '#/components/schemas/PolicyArn' + Name: + $ref: '#/components/schemas/Name' + Description: + $ref: '#/components/schemas/Description' + Version: + $ref: '#/components/schemas/Version' + DefinitionHash: + $ref: '#/components/schemas/DefinitionHash' + LastUpdatedDefinitionHash: + $ref: '#/components/schemas/DefinitionHash' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + PolicyId: + $ref: '#/components/schemas/PolicyId' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateAutomatedReasoningPolicyVersionRequest + type: object + required: [] + CreateBlueprintRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BlueprintArn: + type: string + maxLength: 128 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$ + description: ARN of a Blueprint + BlueprintName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]+$ + description: Name of the Blueprint + CreationTime: + type: string + description: Creation timestamp + format: date-time + LastModifiedTime: + type: string + description: Last modified timestamp + format: date-time + Schema: + type: object + description: Schema of the blueprint + Type: + type: string + description: Modality Type + enum: + - DOCUMENT + - IMAGE + - AUDIO + - VIDEO + BlueprintStage: + type: string + description: Stage of the Blueprint + enum: + - DEVELOPMENT + - LIVE + KmsKeyId: + type: string + description: KMS key identifier + minLength: 1 + maxLength: 2048 + KmsEncryptionContext: + type: object + description: KMS encryption context + x-patternProperties: + ^.*$: + type: string + additionalProperties: false + x-dependencies: + KmsEncryptionContext: + - KmsKeyId + Tags: + description: List of Tags + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateBlueprintRequest + type: object + required: [] + CreateDataAutomationProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreationTime: + type: string + description: Time Stamp + format: date-time + CustomOutputConfiguration: + $ref: '#/components/schemas/CustomOutputConfiguration' + LastModifiedTime: + type: string + description: Time Stamp + format: date-time + OverrideConfiguration: + $ref: '#/components/schemas/OverrideConfiguration' + ProjectArn: + type: string + maxLength: 128 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}$ + description: ARN of a DataAutomationProject + ProjectDescription: + type: string + description: Description of the DataAutomationProject + ProjectName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]+$ + description: Name of the DataAutomationProject + ProjectStage: + $ref: '#/components/schemas/DataAutomationProjectStage' + StandardOutputConfiguration: + $ref: '#/components/schemas/StandardOutputConfiguration' + Status: + $ref: '#/components/schemas/DataAutomationProjectStatus' + KmsKeyId: + type: string + description: KMS key identifier + minLength: 1 + maxLength: 2048 + KmsEncryptionContext: + type: object + description: KMS encryption context + x-patternProperties: + ^.*$: + type: string + additionalProperties: false + x-dependencies: + KmsEncryptionContext: + - KmsKeyId + Tags: + description: List of Tags + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDataAutomationProjectRequest + type: object + required: [] + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DataSourceConfiguration: + $ref: '#/components/schemas/DataSourceConfiguration' + DataSourceId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a resource. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + KnowledgeBaseId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: The unique identifier of the knowledge base to which to add the data source. + DataSourceStatus: + $ref: '#/components/schemas/DataSourceStatus' + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: The name of the data source. + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + VectorIngestionConfiguration: + $ref: '#/components/schemas/VectorIngestionConfiguration' + DataDeletionPolicy: + $ref: '#/components/schemas/DataDeletionPolicy' + CreatedAt: + type: string + description: The time at which the data source was created. + UpdatedAt: + type: string + description: The time at which the knowledge base was last updated. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: The details of the failure reasons related to the data source. + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateFlowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 1011 + minLength: 20 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$ + description: Arn representation of the Flow + CreatedAt: + type: string + description: Time Stamp. + format: date-time + Definition: + $ref: '#/components/schemas/FlowDefinition' + DefinitionString: + type: string + description: A JSON string containing a Definition with the same schema as the Definition property of this resource + maxLength: 512000 + DefinitionS3Location: + $ref: '#/components/schemas/S3Location' + DefinitionSubstitutions: + $ref: '#/components/schemas/DefinitionSubstitutions' + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the flow + ExecutionRoleArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$ + description: ARN of a IAM role + Id: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Flow + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for the flow + Status: + $ref: '#/components/schemas/FlowStatus' + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + Validations: + $ref: '#/components/schemas/FlowValidations' + Version: + type: string + maxLength: 5 + minLength: 5 + pattern: ^DRAFT$ + description: Draft Version. + Tags: + $ref: '#/components/schemas/TagsMap' + TestAliasTags: + $ref: '#/components/schemas/TagsMap' + x-stackQL-stringOnly: true + x-title: CreateFlowRequest + type: object + required: [] + CreateFlowAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}$ + description: Arn of the Flow Alias + FlowArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$ + description: Arn representation of the Flow + ConcurrencyConfiguration: + $ref: '#/components/schemas/FlowAliasConcurrencyConfiguration' + CreatedAt: + type: string + description: Time Stamp. + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + FlowId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a flow resource. + Id: + type: string + maxLength: 10 + minLength: 10 + pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$ + description: Id for a Flow Alias generated at the server side. + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + RoutingConfiguration: + type: array + items: + $ref: '#/components/schemas/FlowAliasRoutingConfigurationListItem' + maxItems: 1 + minItems: 1 + description: Routing configuration for a Flow alias. + x-insertionOrder: true + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + Tags: + $ref: '#/components/schemas/TagsMap' + x-stackQL-stringOnly: true + x-title: CreateFlowAliasRequest + type: object + required: [] + CreateFlowVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + type: string + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$ + description: Arn representation of the Flow + CreatedAt: + type: string + description: Time Stamp. + format: date-time + Definition: + $ref: '#/components/schemas/FlowDefinition' + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the flow version + ExecutionRoleArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$ + description: ARN of a IAM role + FlowId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Flow + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for the flow + Status: + $ref: '#/components/schemas/FlowStatus' + Version: + type: string + pattern: ^[0-9]{1,5}$ + description: Numerical Version. + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + x-stackQL-stringOnly: true + x-title: CreateFlowVersionRequest + type: object + required: [] + CreateGuardrailRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BlockedInputMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + BlockedOutputsMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + ContentPolicyConfig: + $ref: '#/components/schemas/ContentPolicyConfig' + ContextualGroundingPolicyConfig: + $ref: '#/components/schemas/ContextualGroundingPolicyConfig' + CreatedAt: + type: string + description: Time Stamp + format: date-time + CrossRegionConfig: + $ref: '#/components/schemas/GuardrailCrossRegionConfig' + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the guardrail or its version + FailureRecommendations: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Recommendation for guardrail failure status + maxItems: 100 + description: List of failure recommendations + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: The KMS key with which the guardrail was encrypted at rest + Name: + type: string + maxLength: 50 + minLength: 1 + pattern: ^[0-9a-zA-Z-_]+$ + description: Name of the guardrail + SensitiveInformationPolicyConfig: + $ref: '#/components/schemas/SensitiveInformationPolicyConfig' + Status: + $ref: '#/components/schemas/GuardrailStatus' + StatusReasons: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Reason for guardrail status + maxItems: 100 + description: List of status reasons + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + TopicPolicyConfig: + $ref: '#/components/schemas/TopicPolicyConfig' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + Version: + type: string + pattern: ^(([1-9][0-9]{0,7})|(DRAFT))$ + description: Guardrail version + WordPolicyConfig: + $ref: '#/components/schemas/WordPolicyConfig' + x-stackQL-stringOnly: true + x-title: CreateGuardrailRequest + type: object + required: [] + CreateGuardrailVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Guardrail version + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + GuardrailIdentifier: + type: string + maxLength: 2048 + pattern: ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$ + description: Identifier (GuardrailId or GuardrailArn) for the guardrail + Version: + type: string + pattern: ^[1-9][0-9]{0,7}$ + description: Guardrail version + x-stackQL-stringOnly: true + x-title: CreateGuardrailVersionRequest + type: object + required: [] + CreateIntelligentPromptRouterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + type: string + description: Time Stamp + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + pattern: ^([0-9a-zA-Z:.][ _-]?)+$ + description: Description of the Prompt Router. + FallbackModel: + $ref: '#/components/schemas/PromptRouterTargetModel' + Models: + type: array + items: + $ref: '#/components/schemas/PromptRouterTargetModel' + description: List of model configuration + PromptRouterArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:(default-)?prompt-router/[a-zA-Z0-9-:.]+$ + description: Arn of the Prompt Router. + PromptRouterName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^([0-9a-zA-Z][ _-]?)+$ + description: Name of the Prompt Router. + RoutingCriteria: + $ref: '#/components/schemas/RoutingCriteria' + Status: + $ref: '#/components/schemas/PromptRouterStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + Type: + $ref: '#/components/schemas/PromptRouterType' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + x-stackQL-stringOnly: true + x-title: CreateIntelligentPromptRouterRequest + type: object + required: [] + CreateKnowledgeBaseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Resource. + KnowledgeBaseConfiguration: + $ref: '#/components/schemas/KnowledgeBaseConfiguration' + KnowledgeBaseId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: The unique identifier of the knowledge base. + KnowledgeBaseArn: + type: string + maxLength: 128 + minLength: 0 + pattern: ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$ + description: The ARN of the knowledge base. + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: The name of the knowledge base. + Status: + $ref: '#/components/schemas/KnowledgeBaseStatus' + RoleArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$ + description: The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_ + CreatedAt: + type: string + description: The time at which the knowledge base was created. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: A list of reasons that the API operation on the knowledge base failed. + x-insertionOrder: false + UpdatedAt: + type: string + description: The time at which the knowledge base was last updated. + StorageConfiguration: + $ref: '#/components/schemas/StorageConfiguration' + Tags: + $ref: '#/components/schemas/TagsMap' + x-stackQL-stringOnly: true + x-title: CreateKnowledgeBaseRequest + type: object + required: [] + CreatePromptRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$ + description: ARN of a prompt resource possibly with a version + CreatedAt: + type: string + description: Time Stamp. + format: date-time + DefaultVariant: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a variant. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Name for a prompt resource. + Id: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Prompt + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a prompt resource. + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + Variants: + type: array + items: + $ref: '#/components/schemas/PromptVariant' + maxItems: 1 + minItems: 0 + description: List of prompt variants + x-insertionOrder: true + Tags: + $ref: '#/components/schemas/TagsMap' + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + Version: + type: string + maxLength: 5 + minLength: 5 + pattern: ^DRAFT$ + description: Draft Version. + x-stackQL-stringOnly: true + x-title: CreatePromptRequest + type: object + required: [] + CreatePromptVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PromptArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$ + description: ARN of a prompt resource possibly with a version + Arn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}:[0-9]{1,20})$ + description: ARN of a prompt version resource + CreatedAt: + type: string + description: Time Stamp. + format: date-time + PromptId: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + description: Identifier for a Prompt + UpdatedAt: + type: string + description: Time Stamp. + format: date-time + Version: + type: string + maxLength: 5 + minLength: 1 + pattern: ^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$ + description: Version. + Variants: + type: array + items: + $ref: '#/components/schemas/PromptVariant' + maxItems: 1 + minItems: 1 + description: List of prompt variants + x-insertionOrder: true + DefaultVariant: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a variant. + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description for a prompt version resource. + CustomerEncryptionKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: A KMS key ARN + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a prompt resource. + Tags: + $ref: '#/components/schemas/TagsMap' + x-stackQL-stringOnly: true + x-title: CreatePromptVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + agents: + name: agents + id: awscc.bedrock.agents + x-cfn-schema-name: Agent + x-cfn-type-name: AWS::Bedrock::Agent + x-identifiers: + - AgentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Agent&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Agent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Agent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Agent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agents/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/agents/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ActionGroups') as action_groups, + JSON_EXTRACT(Properties, '$.AgentArn') as agent_arn, + JSON_EXTRACT(Properties, '$.AgentId') as agent_id, + JSON_EXTRACT(Properties, '$.AgentName') as agent_name, + JSON_EXTRACT(Properties, '$.AgentResourceRoleArn') as agent_resource_role_arn, + JSON_EXTRACT(Properties, '$.AgentStatus') as agent_status, + JSON_EXTRACT(Properties, '$.AgentVersion') as agent_version, + JSON_EXTRACT(Properties, '$.AutoPrepare') as auto_prepare, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CustomOrchestration') as custom_orchestration, + JSON_EXTRACT(Properties, '$.CustomerEncryptionKeyArn') as customer_encryption_key_arn, + JSON_EXTRACT(Properties, '$.SkipResourceInUseCheckOnDelete') as skip_resource_in_use_check_on_delete, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FailureReasons') as failure_reasons, + JSON_EXTRACT(Properties, '$.FoundationModel') as foundation_model, + JSON_EXTRACT(Properties, '$.GuardrailConfiguration') as guardrail_configuration, + JSON_EXTRACT(Properties, '$.MemoryConfiguration') as memory_configuration, + JSON_EXTRACT(Properties, '$.IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, + JSON_EXTRACT(Properties, '$.AgentCollaboration') as agent_collaboration, + JSON_EXTRACT(Properties, '$.Instruction') as instruction, + JSON_EXTRACT(Properties, '$.KnowledgeBases') as knowledge_bases, + JSON_EXTRACT(Properties, '$.AgentCollaborators') as agent_collaborators, + JSON_EXTRACT(Properties, '$.OrchestrationType') as orchestration_type, + JSON_EXTRACT(Properties, '$.PreparedAt') as prepared_at, + JSON_EXTRACT(Properties, '$.PromptOverrideConfiguration') as prompt_override_configuration, + JSON_EXTRACT(Properties, '$.RecommendedActions') as recommended_actions, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TestAliasTags') as test_alias_tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Agent' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActionGroups') as action_groups, + json_extract_path_text(Properties, 'AgentArn') as agent_arn, + json_extract_path_text(Properties, 'AgentId') as agent_id, + json_extract_path_text(Properties, 'AgentName') as agent_name, + json_extract_path_text(Properties, 'AgentResourceRoleArn') as agent_resource_role_arn, + json_extract_path_text(Properties, 'AgentStatus') as agent_status, + json_extract_path_text(Properties, 'AgentVersion') as agent_version, + json_extract_path_text(Properties, 'AutoPrepare') as auto_prepare, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CustomOrchestration') as custom_orchestration, + json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn, + json_extract_path_text(Properties, 'SkipResourceInUseCheckOnDelete') as skip_resource_in_use_check_on_delete, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FailureReasons') as failure_reasons, + json_extract_path_text(Properties, 'FoundationModel') as foundation_model, + json_extract_path_text(Properties, 'GuardrailConfiguration') as guardrail_configuration, + json_extract_path_text(Properties, 'MemoryConfiguration') as memory_configuration, + json_extract_path_text(Properties, 'IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, + json_extract_path_text(Properties, 'AgentCollaboration') as agent_collaboration, + json_extract_path_text(Properties, 'Instruction') as instruction, + json_extract_path_text(Properties, 'KnowledgeBases') as knowledge_bases, + json_extract_path_text(Properties, 'AgentCollaborators') as agent_collaborators, + json_extract_path_text(Properties, 'OrchestrationType') as orchestration_type, + json_extract_path_text(Properties, 'PreparedAt') as prepared_at, + json_extract_path_text(Properties, 'PromptOverrideConfiguration') as prompt_override_configuration, + json_extract_path_text(Properties, 'RecommendedActions') as recommended_actions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TestAliasTags') as test_alias_tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Agent' + AND data__Identifier = '' + AND region = 'us-east-1' + agents_list_only: + name: agents_list_only + id: awscc.bedrock.agents_list_only + x-cfn-schema-name: Agent + x-cfn-type-name: AWS::Bedrock::Agent + x-identifiers: + - AgentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AgentId') as agent_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Agent' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AgentId') as agent_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Agent' + AND region = 'us-east-1' + agent_aliases: + name: agent_aliases + id: awscc.bedrock.agent_aliases + x-cfn-schema-name: AgentAlias + x-cfn-type-name: AWS::Bedrock::AgentAlias + x-identifiers: + - AgentId + - AgentAliasId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AgentAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AgentAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AgentAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AgentAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AgentAliasArn') as agent_alias_arn, + JSON_EXTRACT(Properties, '$.AgentAliasHistoryEvents') as agent_alias_history_events, + JSON_EXTRACT(Properties, '$.AgentAliasId') as agent_alias_id, + JSON_EXTRACT(Properties, '$.AgentAliasName') as agent_alias_name, + JSON_EXTRACT(Properties, '$.AgentAliasStatus') as agent_alias_status, + JSON_EXTRACT(Properties, '$.AgentId') as agent_id, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.RoutingConfiguration') as routing_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AgentAliasArn') as agent_alias_arn, + json_extract_path_text(Properties, 'AgentAliasHistoryEvents') as agent_alias_history_events, + json_extract_path_text(Properties, 'AgentAliasId') as agent_alias_id, + json_extract_path_text(Properties, 'AgentAliasName') as agent_alias_name, + json_extract_path_text(Properties, 'AgentAliasStatus') as agent_alias_status, + json_extract_path_text(Properties, 'AgentId') as agent_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RoutingConfiguration') as routing_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' + AND data__Identifier = '|' + AND region = 'us-east-1' + agent_aliases_list_only: + name: agent_aliases_list_only + id: awscc.bedrock.agent_aliases_list_only + x-cfn-schema-name: AgentAlias + x-cfn-type-name: AWS::Bedrock::AgentAlias + x-identifiers: + - AgentId + - AgentAliasId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AgentId') as agent_id, + JSON_EXTRACT(Properties, '$.AgentAliasId') as agent_alias_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AgentId') as agent_id, + json_extract_path_text(Properties, 'AgentAliasId') as agent_alias_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' + AND region = 'us-east-1' + application_inference_profiles: + name: application_inference_profiles + id: awscc.bedrock.application_inference_profiles + x-cfn-schema-name: ApplicationInferenceProfile + x-cfn-type-name: AWS::Bedrock::ApplicationInferenceProfile + x-identifiers: + - InferenceProfileIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationInferenceProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::ApplicationInferenceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::ApplicationInferenceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::ApplicationInferenceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_inference_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_inference_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/application_inference_profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.InferenceProfileArn') as inference_profile_arn, + JSON_EXTRACT(Properties, '$.InferenceProfileId') as inference_profile_id, + JSON_EXTRACT(Properties, '$.InferenceProfileIdentifier') as inference_profile_identifier, + JSON_EXTRACT(Properties, '$.InferenceProfileName') as inference_profile_name, + JSON_EXTRACT(Properties, '$.ModelSource') as model_source, + JSON_EXTRACT(Properties, '$.Models') as models, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::ApplicationInferenceProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InferenceProfileArn') as inference_profile_arn, + json_extract_path_text(Properties, 'InferenceProfileId') as inference_profile_id, + json_extract_path_text(Properties, 'InferenceProfileIdentifier') as inference_profile_identifier, + json_extract_path_text(Properties, 'InferenceProfileName') as inference_profile_name, + json_extract_path_text(Properties, 'ModelSource') as model_source, + json_extract_path_text(Properties, 'Models') as models, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::ApplicationInferenceProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + application_inference_profiles_list_only: + name: application_inference_profiles_list_only + id: awscc.bedrock.application_inference_profiles_list_only + x-cfn-schema-name: ApplicationInferenceProfile + x-cfn-type-name: AWS::Bedrock::ApplicationInferenceProfile + x-identifiers: + - InferenceProfileIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.InferenceProfileIdentifier') as inference_profile_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::ApplicationInferenceProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InferenceProfileIdentifier') as inference_profile_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::ApplicationInferenceProfile' + AND region = 'us-east-1' + automated_reasoning_policies: + name: automated_reasoning_policies + id: awscc.bedrock.automated_reasoning_policies + x-cfn-schema-name: AutomatedReasoningPolicy + x-cfn-type-name: AWS::Bedrock::AutomatedReasoningPolicy + x-identifiers: + - PolicyArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutomatedReasoningPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AutomatedReasoningPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AutomatedReasoningPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AutomatedReasoningPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/automated_reasoning_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/automated_reasoning_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/automated_reasoning_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.PolicyDefinition') as policy_definition, + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.DefinitionHash') as definition_hash, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PolicyDefinition') as policy_definition, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'DefinitionHash') as definition_hash, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + automated_reasoning_policies_list_only: + name: automated_reasoning_policies_list_only + id: awscc.bedrock.automated_reasoning_policies_list_only + x-cfn-schema-name: AutomatedReasoningPolicy + x-cfn-type-name: AWS::Bedrock::AutomatedReasoningPolicy + x-identifiers: + - PolicyArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicy' + AND region = 'us-east-1' + automated_reasoning_policy_versions: + name: automated_reasoning_policy_versions + id: awscc.bedrock.automated_reasoning_policy_versions + x-cfn-schema-name: AutomatedReasoningPolicyVersion + x-cfn-type-name: AWS::Bedrock::AutomatedReasoningPolicyVersion + x-identifiers: + - PolicyArn + - Version + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutomatedReasoningPolicyVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AutomatedReasoningPolicyVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::AutomatedReasoningPolicyVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/automated_reasoning_policy_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/automated_reasoning_policy_versions/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.DefinitionHash') as definition_hash, + JSON_EXTRACT(Properties, '$.LastUpdatedDefinitionHash') as last_updated_definition_hash, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicyVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'DefinitionHash') as definition_hash, + json_extract_path_text(Properties, 'LastUpdatedDefinitionHash') as last_updated_definition_hash, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicyVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + automated_reasoning_policy_versions_list_only: + name: automated_reasoning_policy_versions_list_only + id: awscc.bedrock.automated_reasoning_policy_versions_list_only + x-cfn-schema-name: AutomatedReasoningPolicyVersion + x-cfn-type-name: AWS::Bedrock::AutomatedReasoningPolicyVersion + x-identifiers: + - PolicyArn + - Version + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn, + JSON_EXTRACT(Properties, '$.Version') as version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicyVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn, + json_extract_path_text(Properties, 'Version') as version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AutomatedReasoningPolicyVersion' + AND region = 'us-east-1' + blueprints: + name: blueprints + id: awscc.bedrock.blueprints + x-cfn-schema-name: Blueprint + x-cfn-type-name: AWS::Bedrock::Blueprint + x-identifiers: + - BlueprintArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Blueprint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Blueprint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Blueprint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Blueprint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/blueprints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/blueprints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/blueprints/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.BlueprintArn') as blueprint_arn, + JSON_EXTRACT(Properties, '$.BlueprintName') as blueprint_name, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, + JSON_EXTRACT(Properties, '$.Schema') as _schema, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.BlueprintStage') as blueprint_stage, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.KmsEncryptionContext') as kms_encryption_context, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Blueprint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BlueprintArn') as blueprint_arn, + json_extract_path_text(Properties, 'BlueprintName') as blueprint_name, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'BlueprintStage') as blueprint_stage, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'KmsEncryptionContext') as kms_encryption_context, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Blueprint' + AND data__Identifier = '' + AND region = 'us-east-1' + blueprints_list_only: + name: blueprints_list_only + id: awscc.bedrock.blueprints_list_only + x-cfn-schema-name: Blueprint + x-cfn-type-name: AWS::Bedrock::Blueprint + x-identifiers: + - BlueprintArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.BlueprintArn') as blueprint_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Blueprint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BlueprintArn') as blueprint_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Blueprint' + AND region = 'us-east-1' + data_automation_projects: + name: data_automation_projects + id: awscc.bedrock.data_automation_projects + x-cfn-schema-name: DataAutomationProject + x-cfn-type-name: AWS::Bedrock::DataAutomationProject + x-identifiers: + - ProjectArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataAutomationProject&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataAutomationProject" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataAutomationProject" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataAutomationProject" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_automation_projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_automation_projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_automation_projects/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.CustomOutputConfiguration') as custom_output_configuration, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, + JSON_EXTRACT(Properties, '$.OverrideConfiguration') as override_configuration, + JSON_EXTRACT(Properties, '$.ProjectArn') as project_arn, + JSON_EXTRACT(Properties, '$.ProjectDescription') as project_description, + JSON_EXTRACT(Properties, '$.ProjectName') as project_name, + JSON_EXTRACT(Properties, '$.ProjectStage') as project_stage, + JSON_EXTRACT(Properties, '$.StandardOutputConfiguration') as standard_output_configuration, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.KmsEncryptionContext') as kms_encryption_context, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataAutomationProject' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'CustomOutputConfiguration') as custom_output_configuration, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'OverrideConfiguration') as override_configuration, + json_extract_path_text(Properties, 'ProjectArn') as project_arn, + json_extract_path_text(Properties, 'ProjectDescription') as project_description, + json_extract_path_text(Properties, 'ProjectName') as project_name, + json_extract_path_text(Properties, 'ProjectStage') as project_stage, + json_extract_path_text(Properties, 'StandardOutputConfiguration') as standard_output_configuration, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'KmsEncryptionContext') as kms_encryption_context, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataAutomationProject' + AND data__Identifier = '' + AND region = 'us-east-1' + data_automation_projects_list_only: + name: data_automation_projects_list_only + id: awscc.bedrock.data_automation_projects_list_only + x-cfn-schema-name: DataAutomationProject + x-cfn-type-name: AWS::Bedrock::DataAutomationProject + x-identifiers: + - ProjectArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ProjectArn') as project_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataAutomationProject' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProjectArn') as project_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataAutomationProject' + AND region = 'us-east-1' + data_sources: + name: data_sources + id: awscc.bedrock.data_sources + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::Bedrock::DataSource + x-identifiers: + - KnowledgeBaseId + - DataSourceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DataSourceConfiguration') as data_source_configuration, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id, + JSON_EXTRACT(Properties, '$.DataSourceStatus') as data_source_status, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + JSON_EXTRACT(Properties, '$.VectorIngestionConfiguration') as vector_ingestion_configuration, + JSON_EXTRACT(Properties, '$.DataDeletionPolicy') as data_deletion_policy, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.FailureReasons') as failure_reasons + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'DataSourceStatus') as data_source_status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'VectorIngestionConfiguration') as vector_ingestion_configuration, + json_extract_path_text(Properties, 'DataDeletionPolicy') as data_deletion_policy, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'FailureReasons') as failure_reasons + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + data_sources_list_only: + name: data_sources_list_only + id: awscc.bedrock.data_sources_list_only + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::Bedrock::DataSource + x-identifiers: + - KnowledgeBaseId + - DataSourceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND region = 'us-east-1' + flows: + name: flows + id: awscc.bedrock.flows + x-cfn-schema-name: Flow + x-cfn-type-name: AWS::Bedrock::Flow + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Flow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flows/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.DefinitionString') as definition_string, + JSON_EXTRACT(Properties, '$.DefinitionS3Location') as definition_s3_location, + JSON_EXTRACT(Properties, '$.DefinitionSubstitutions') as definition_substitutions, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.CustomerEncryptionKeyArn') as customer_encryption_key_arn, + JSON_EXTRACT(Properties, '$.Validations') as validations, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TestAliasTags') as test_alias_tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Flow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'DefinitionString') as definition_string, + json_extract_path_text(Properties, 'DefinitionS3Location') as definition_s3_location, + json_extract_path_text(Properties, 'DefinitionSubstitutions') as definition_substitutions, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn, + json_extract_path_text(Properties, 'Validations') as validations, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TestAliasTags') as test_alias_tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Flow' + AND data__Identifier = '' + AND region = 'us-east-1' + flows_list_only: + name: flows_list_only + id: awscc.bedrock.flows_list_only + x-cfn-schema-name: Flow + x-cfn-type-name: AWS::Bedrock::Flow + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Flow' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Flow' + AND region = 'us-east-1' + flow_aliases: + name: flow_aliases + id: awscc.bedrock.flow_aliases + x-cfn-schema-name: FlowAlias + x-cfn-type-name: AWS::Bedrock::FlowAlias + x-identifiers: + - Arn + - FlowArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::FlowAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::FlowAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::FlowAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_aliases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.ConcurrencyConfiguration') as concurrency_configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FlowId') as flow_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.RoutingConfiguration') as routing_configuration, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::FlowAlias' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'ConcurrencyConfiguration') as concurrency_configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FlowId') as flow_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoutingConfiguration') as routing_configuration, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::FlowAlias' + AND data__Identifier = '|' + AND region = 'us-east-1' + flow_aliases_list_only: + name: flow_aliases_list_only + id: awscc.bedrock.flow_aliases_list_only + x-cfn-schema-name: FlowAlias + x-cfn-type-name: AWS::Bedrock::FlowAlias + x-identifiers: + - Arn + - FlowArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::FlowAlias' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'FlowArn') as flow_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::FlowAlias' + AND region = 'us-east-1' + flow_versions: + name: flow_versions + id: awscc.bedrock.flow_versions + x-cfn-schema-name: FlowVersion + x-cfn-type-name: AWS::Bedrock::FlowVersion + x-identifiers: + - FlowArn + - Version + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::FlowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::FlowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::FlowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, + JSON_EXTRACT(Properties, '$.FlowId') as flow_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.CustomerEncryptionKeyArn') as customer_encryption_key_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::FlowVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'FlowId') as flow_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::FlowVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + flow_versions_list_only: + name: flow_versions_list_only + id: awscc.bedrock.flow_versions_list_only + x-cfn-schema-name: FlowVersion + x-cfn-type-name: AWS::Bedrock::FlowVersion + x-identifiers: + - FlowArn + - Version + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.Version') as version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::FlowVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'Version') as version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::FlowVersion' + AND region = 'us-east-1' + guardrails: + name: guardrails + id: awscc.bedrock.guardrails + x-cfn-schema-name: Guardrail + x-cfn-type-name: AWS::Bedrock::Guardrail + x-identifiers: + - GuardrailArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Guardrail&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Guardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Guardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Guardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/guardrails/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/guardrails/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/guardrails/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.BlockedInputMessaging') as blocked_input_messaging, + JSON_EXTRACT(Properties, '$.BlockedOutputsMessaging') as blocked_outputs_messaging, + JSON_EXTRACT(Properties, '$.ContentPolicyConfig') as content_policy_config, + JSON_EXTRACT(Properties, '$.ContextualGroundingPolicyConfig') as contextual_grounding_policy_config, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CrossRegionConfig') as cross_region_config, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FailureRecommendations') as failure_recommendations, + JSON_EXTRACT(Properties, '$.GuardrailArn') as guardrail_arn, + JSON_EXTRACT(Properties, '$.GuardrailId') as guardrail_id, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.SensitiveInformationPolicyConfig') as sensitive_information_policy_config, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusReasons') as status_reasons, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TopicPolicyConfig') as topic_policy_config, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.WordPolicyConfig') as word_policy_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BlockedInputMessaging') as blocked_input_messaging, + json_extract_path_text(Properties, 'BlockedOutputsMessaging') as blocked_outputs_messaging, + json_extract_path_text(Properties, 'ContentPolicyConfig') as content_policy_config, + json_extract_path_text(Properties, 'ContextualGroundingPolicyConfig') as contextual_grounding_policy_config, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CrossRegionConfig') as cross_region_config, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FailureRecommendations') as failure_recommendations, + json_extract_path_text(Properties, 'GuardrailArn') as guardrail_arn, + json_extract_path_text(Properties, 'GuardrailId') as guardrail_id, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SensitiveInformationPolicyConfig') as sensitive_information_policy_config, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReasons') as status_reasons, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TopicPolicyConfig') as topic_policy_config, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'WordPolicyConfig') as word_policy_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND data__Identifier = '' + AND region = 'us-east-1' + guardrails_list_only: + name: guardrails_list_only + id: awscc.bedrock.guardrails_list_only + x-cfn-schema-name: Guardrail + x-cfn-type-name: AWS::Bedrock::Guardrail + x-identifiers: + - GuardrailArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.GuardrailArn') as guardrail_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GuardrailArn') as guardrail_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND region = 'us-east-1' + guardrail_versions: + name: guardrail_versions + id: awscc.bedrock.guardrail_versions + x-cfn-schema-name: GuardrailVersion + x-cfn-type-name: AWS::Bedrock::GuardrailVersion + x-identifiers: + - GuardrailId + - Version + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GuardrailVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::GuardrailVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::GuardrailVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/guardrail_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/guardrail_versions/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.GuardrailArn') as guardrail_arn, + JSON_EXTRACT(Properties, '$.GuardrailId') as guardrail_id, + JSON_EXTRACT(Properties, '$.GuardrailIdentifier') as guardrail_identifier, + JSON_EXTRACT(Properties, '$.Version') as version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::GuardrailVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'GuardrailArn') as guardrail_arn, + json_extract_path_text(Properties, 'GuardrailId') as guardrail_id, + json_extract_path_text(Properties, 'GuardrailIdentifier') as guardrail_identifier, + json_extract_path_text(Properties, 'Version') as version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::GuardrailVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + intelligent_prompt_routers: + name: intelligent_prompt_routers + id: awscc.bedrock.intelligent_prompt_routers + x-cfn-schema-name: IntelligentPromptRouter + x-cfn-type-name: AWS::Bedrock::IntelligentPromptRouter + x-identifiers: + - PromptRouterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IntelligentPromptRouter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::IntelligentPromptRouter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::IntelligentPromptRouter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::IntelligentPromptRouter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/intelligent_prompt_routers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/intelligent_prompt_routers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/intelligent_prompt_routers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FallbackModel') as fallback_model, + JSON_EXTRACT(Properties, '$.Models') as models, + JSON_EXTRACT(Properties, '$.PromptRouterArn') as prompt_router_arn, + JSON_EXTRACT(Properties, '$.PromptRouterName') as prompt_router_name, + JSON_EXTRACT(Properties, '$.RoutingCriteria') as routing_criteria, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::IntelligentPromptRouter' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FallbackModel') as fallback_model, + json_extract_path_text(Properties, 'Models') as models, + json_extract_path_text(Properties, 'PromptRouterArn') as prompt_router_arn, + json_extract_path_text(Properties, 'PromptRouterName') as prompt_router_name, + json_extract_path_text(Properties, 'RoutingCriteria') as routing_criteria, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::IntelligentPromptRouter' + AND data__Identifier = '' + AND region = 'us-east-1' + intelligent_prompt_routers_list_only: + name: intelligent_prompt_routers_list_only + id: awscc.bedrock.intelligent_prompt_routers_list_only + x-cfn-schema-name: IntelligentPromptRouter + x-cfn-type-name: AWS::Bedrock::IntelligentPromptRouter + x-identifiers: + - PromptRouterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PromptRouterArn') as prompt_router_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::IntelligentPromptRouter' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PromptRouterArn') as prompt_router_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::IntelligentPromptRouter' + AND region = 'us-east-1' + knowledge_bases: + name: knowledge_bases + id: awscc.bedrock.knowledge_bases + x-cfn-schema-name: KnowledgeBase + x-cfn-type-name: AWS::Bedrock::KnowledgeBase + x-identifiers: + - KnowledgeBaseId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.KnowledgeBaseConfiguration') as knowledge_base_configuration, + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id, + JSON_EXTRACT(Properties, '$.KnowledgeBaseArn') as knowledge_base_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.FailureReasons') as failure_reasons, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.StorageConfiguration') as storage_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KnowledgeBaseConfiguration') as knowledge_base_configuration, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'FailureReasons') as failure_reasons, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'StorageConfiguration') as storage_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + AND data__Identifier = '' + AND region = 'us-east-1' + knowledge_bases_list_only: + name: knowledge_bases_list_only + id: awscc.bedrock.knowledge_bases_list_only + x-cfn-schema-name: KnowledgeBase + x-cfn-type-name: AWS::Bedrock::KnowledgeBase + x-identifiers: + - KnowledgeBaseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + AND region = 'us-east-1' + prompts: + name: prompts + id: awscc.bedrock.prompts + x-cfn-schema-name: Prompt + x-cfn-type-name: AWS::Bedrock::Prompt + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Prompt&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Prompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Prompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Prompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prompts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prompts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/prompts/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DefaultVariant') as default_variant, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.Variants') as variants, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CustomerEncryptionKeyArn') as customer_encryption_key_arn, + JSON_EXTRACT(Properties, '$.Version') as version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Prompt' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DefaultVariant') as default_variant, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Variants') as variants, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn, + json_extract_path_text(Properties, 'Version') as version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Prompt' + AND data__Identifier = '' + AND region = 'us-east-1' + prompts_list_only: + name: prompts_list_only + id: awscc.bedrock.prompts_list_only + x-cfn-schema-name: Prompt + x-cfn-type-name: AWS::Bedrock::Prompt + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Prompt' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Prompt' + AND region = 'us-east-1' + prompt_versions: + name: prompt_versions + id: awscc.bedrock.prompt_versions + x-cfn-schema-name: PromptVersion + x-cfn-type-name: AWS::Bedrock::PromptVersion + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PromptVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::PromptVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::PromptVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prompt_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prompt_versions/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PromptArn') as prompt_arn, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.PromptId') as prompt_id, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Variants') as variants, + JSON_EXTRACT(Properties, '$.DefaultVariant') as default_variant, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.CustomerEncryptionKeyArn') as customer_encryption_key_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::PromptVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PromptArn') as prompt_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'PromptId') as prompt_id, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Variants') as variants, + json_extract_path_text(Properties, 'DefaultVariant') as default_variant, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::PromptVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + prompt_versions_list_only: + name: prompt_versions_list_only + id: awscc.bedrock.prompt_versions_list_only + x-cfn-schema-name: PromptVersion + x-cfn-type-name: AWS::Bedrock::PromptVersion + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::PromptVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::PromptVersion' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Agent&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAgent + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAgentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AgentAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAgentAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAgentAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationInferenceProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationInferenceProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationInferenceProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutomatedReasoningPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutomatedReasoningPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutomatedReasoningPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutomatedReasoningPolicyVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutomatedReasoningPolicyVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutomatedReasoningPolicyVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Blueprint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBlueprint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBlueprintRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataAutomationProject&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataAutomationProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataAutomationProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Flow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Guardrail&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGuardrail + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGuardrailRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GuardrailVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGuardrailVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGuardrailVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IntelligentPromptRouter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntelligentPromptRouter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntelligentPromptRouterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKnowledgeBase + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKnowledgeBaseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Prompt&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrompt + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePromptRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PromptVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePromptVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePromptVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/billing.yaml b/providers/src/awscc/v00.00.00000/services/billing.yaml new file mode 100644 index 00000000..2ba64ad6 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/billing.yaml @@ -0,0 +1,963 @@ +openapi: 3.0.0 +info: + title: Billing + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + DimensionKey: + type: string + enum: + - LINKED_ACCOUNT + BillingViewType: + type: string + enum: + - PRIMARY + - BILLING_GROUP + - CUSTOM + Tag: + description: A key-value pair to associate with a Billing View. + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + Arn: + type: string + pattern: arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_\+=\.\-@]{0,75}[a-zA-Z0-9] + BillingView: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + BillingViewType: + $ref: '#/components/schemas/BillingViewType' + DataFilterExpression: + type: object + additionalProperties: false + properties: + Dimensions: + type: object + additionalProperties: false + properties: + Key: + $ref: '#/components/schemas/DimensionKey' + Values: + type: array + items: + type: string + maxLength: 1024 + pattern: '[\S\s]*' + minItems: 1 + maxItems: 200 + Tags: + type: object + additionalProperties: false + properties: + Key: + type: string + pattern: '[\S\s]*' + maxLength: 1024 + Values: + type: array + items: + type: string + pattern: '[\S\s]*' + maxLength: 1024 + minItems: 1 + maxItems: 200 + CreatedAt: + description: The time when the billing view was created. + type: number + Description: + type: string + maxLength: 1024 + Name: + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_\+=\.\-@]+' + OwnerAccountId: + type: string + pattern: '[0-9]{12}' + Tags: + description: An array of key-value pairs associated to the billing view being created. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + SourceViews: + description: An array of strings that define the billing view's source. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + pattern: arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9_+=.@-]{1,75} + UpdatedAt: + description: The time when the billing view was last updated. + type: number + required: + - Name + - SourceViews + x-stackql-resource-name: billing_view + description: A billing view is a container of cost & usage metadata. + x-type-name: AWS::Billing::BillingView + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - SourceViews + - Description + - Name + x-read-only-properties: + - Arn + - CreatedAt + - UpdatedAt + - OwnerAccountId + - BillingViewType + x-required-properties: + - Name + - SourceViews + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - billing:TagResource + - billing:UntagResource + - billing:ListTagsForResource + x-required-permissions: + create: + - billing:CreateBillingView + - billing:TagResource + - billing:ListTagsForResource + - billing:GetBillingView + - billing:ListSourceViewsForBillingView + read: + - billing:GetBillingView + - billing:ListTagsForResource + - billing:ListSourceViewsForBillingView + update: + - billing:UpdateBillingView + - billing:GetBillingView + - billing:ListTagsForResource + - billing:TagResource + - billing:UntagResource + - billing:ListSourceViewsForBillingView + delete: + - billing:GetBillingView + - billing:DeleteBillingView + list: + - billing:ListBillingViews + CreateBillingViewRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + BillingViewType: + $ref: '#/components/schemas/BillingViewType' + DataFilterExpression: + type: object + additionalProperties: false + properties: + Dimensions: + type: object + additionalProperties: false + properties: + Key: + $ref: '#/components/schemas/DimensionKey' + Values: + type: array + items: + type: string + maxLength: 1024 + pattern: '[\S\s]*' + minItems: 1 + maxItems: 200 + Tags: + type: object + additionalProperties: false + properties: + Key: + type: string + pattern: '[\S\s]*' + maxLength: 1024 + Values: + type: array + items: + type: string + pattern: '[\S\s]*' + maxLength: 1024 + minItems: 1 + maxItems: 200 + CreatedAt: + description: The time when the billing view was created. + type: number + Description: + type: string + maxLength: 1024 + Name: + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_\+=\.\-@]+' + OwnerAccountId: + type: string + pattern: '[0-9]{12}' + Tags: + description: An array of key-value pairs associated to the billing view being created. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + SourceViews: + description: An array of strings that define the billing view's source. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + pattern: arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9_+=.@-]{1,75} + UpdatedAt: + description: The time when the billing view was last updated. + type: number + x-stackQL-stringOnly: true + x-title: CreateBillingViewRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + billing_views: + name: billing_views + id: awscc.billing.billing_views + x-cfn-schema-name: BillingView + x-cfn-type-name: AWS::Billing::BillingView + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BillingView&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Billing::BillingView" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Billing::BillingView" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Billing::BillingView" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/billing_views/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/billing_views/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/billing_views/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.BillingViewType') as billing_view_type, + JSON_EXTRACT(Properties, '$.DataFilterExpression') as data_filter_expression, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OwnerAccountId') as owner_account_id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.SourceViews') as source_views, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Billing::BillingView' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BillingViewType') as billing_view_type, + json_extract_path_text(Properties, 'DataFilterExpression') as data_filter_expression, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SourceViews') as source_views, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Billing::BillingView' + AND data__Identifier = '' + AND region = 'us-east-1' + billing_views_list_only: + name: billing_views_list_only + id: awscc.billing.billing_views_list_only + x-cfn-schema-name: BillingView + x-cfn-type-name: AWS::Billing::BillingView + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Billing::BillingView' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Billing::BillingView' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BillingView&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBillingView + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBillingViewRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/billingconductor.yaml b/providers/src/awscc/v00.00.00000/services/billingconductor.yaml index 68c5fdd2..a27b27fd 100644 --- a/providers/src/awscc/v00.00.00000/services/billingconductor.yaml +++ b/providers/src/awscc/v00.00.00000/services/billingconductor.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: BillingConductor - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: BillingGroupStatus: type: string @@ -99,7 +479,9 @@ components: - PrimaryAccountId - ComputationPreference x-stackql-resource-name: billing_group - x-stackql-primaryIdentifier: + description: A billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family. + x-type-name: AWS::BillingConductor::BillingGroup + x-stackql-primary-identifier: - Arn x-create-only-properties: - PrimaryAccountId @@ -110,6 +492,21 @@ components: - StatusReason - CreationTime - LastModifiedTime + x-required-properties: + - Name + - AccountGrouping + - PrimaryAccountId + - ComputationPreference + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - billingconductor:ListTagsForResource + - billingconductor:TagResource + - billingconductor:UntagResource x-required-permissions: create: - billingconductor:CreateBillingGroup @@ -288,7 +685,9 @@ components: - Name - BillingGroupArn x-stackql-resource-name: custom_line_item - x-stackql-primaryIdentifier: + description: A custom line item is an one time charge that is applied to a specific billing group's bill. + x-type-name: AWS::BillingConductor::CustomLineItem + x-stackql-primary-identifier: - Arn x-create-only-properties: - BillingGroupArn @@ -303,6 +702,19 @@ components: - AssociationSize - CurrencyCode - ProductCode + x-required-properties: + - Name + - BillingGroupArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - billingconductor:ListTagsForResource + - billingconductor:TagResource + - billingconductor:UntagResource x-required-permissions: create: - billingconductor:CreateCustomLineItem @@ -375,13 +787,27 @@ components: required: - Name x-stackql-resource-name: pricing_plan - x-stackql-primaryIdentifier: + description: Pricing Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups. + x-type-name: AWS::BillingConductor::PricingPlan + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn - Size - CreationTime - LastModifiedTime + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - billingconductor:ListTagsForResource + - billingconductor:TagResource + - billingconductor:UntagResource x-required-permissions: create: - billingconductor:CreatePricingPlan @@ -507,7 +933,9 @@ components: - Scope - Type x-stackql-resource-name: pricing_rule - x-stackql-primaryIdentifier: + description: A markup/discount that is defined for a specific set of services that can later be associated with a pricing plan. + x-type-name: AWS::BillingConductor::PricingRule + x-stackql-primary-identifier: - Arn x-create-only-properties: - Scope @@ -520,6 +948,20 @@ components: - AssociatedPricingPlanCount - CreationTime - LastModifiedTime + x-required-properties: + - Name + - Scope + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - billingconductor:ListTagsForResource + - billingconductor:TagResource + - billingconductor:UntagResource x-required-permissions: create: - billingconductor:CreatePricingRule @@ -541,43 +983,341 @@ components: list: - billingconductor:ListPricingRules - billingconductor:ListTagsForResource + CreateBillingGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Billing Group ARN + type: string + pattern: arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12} + Name: + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_\+=\.\-@]+' + Description: + type: string + maxLength: 1024 + PrimaryAccountId: + description: This account will act as a virtual payer account of the billing group + type: string + pattern: '[0-9]{12}' + ComputationPreference: + $ref: '#/components/schemas/ComputationPreference' + AccountGrouping: + $ref: '#/components/schemas/AccountGrouping' + Size: + description: Number of accounts in the billing group + type: integer + Status: + $ref: '#/components/schemas/BillingGroupStatus' + StatusReason: + type: string + CreationTime: + description: Creation timestamp in UNIX epoch time format + type: integer + LastModifiedTime: + description: Latest modified timestamp in UNIX epoch time format + type: integer + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateBillingGroupRequest + type: object + required: [] + CreateCustomLineItemRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_\+=\.\-@]+' + Description: + type: string + maxLength: 255 + CustomLineItemChargeDetails: + $ref: '#/components/schemas/CustomLineItemChargeDetails' + BillingGroupArn: + description: Billing Group ARN + type: string + pattern: arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12} + BillingPeriodRange: + $ref: '#/components/schemas/BillingPeriodRange' + Arn: + description: ARN + type: string + pattern: (arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10} + CreationTime: + description: Creation timestamp in UNIX epoch time format + type: integer + LastModifiedTime: + description: Latest modified timestamp in UNIX epoch time format + type: integer + AssociationSize: + description: Number of source values associated to this custom line item + type: integer + ProductCode: + type: string + minLength: 1 + maxLength: 29 + CurrencyCode: + type: string + enum: + - USD + - CNY + AccountId: + type: string + description: The account which this custom line item will be charged to + pattern: '[0-9]{12}' + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCustomLineItemRequest + type: object + required: [] + CreatePricingPlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Pricing Plan ARN + type: string + pattern: arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10} + Name: + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_\+=\.\-@]+' + PricingRuleArns: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PricingRuleArn' + Size: + type: integer + description: Number of associated pricing rules + Description: + type: string + maxLength: 1024 + CreationTime: + description: Creation timestamp in UNIX epoch time format + type: integer + LastModifiedTime: + description: Latest modified timestamp in UNIX epoch time format + type: integer + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePricingPlanRequest + type: object + required: [] + CreatePricingRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Pricing rule ARN + type: string + pattern: arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10} + Name: + description: Pricing rule name + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_\+=\.\-@]+' + Description: + description: Pricing rule description + type: string + maxLength: 1024 + Scope: + description: A term used to categorize the granularity of a Pricing Rule. + type: string + enum: + - GLOBAL + - SERVICE + - BILLING_ENTITY + - SKU + Type: + description: One of MARKUP, DISCOUNT or TIERING that describes the behaviour of the pricing rule. + type: string + enum: + - MARKUP + - DISCOUNT + - TIERING + ModifierPercentage: + description: Pricing rule modifier percentage + type: number + minimum: 0 + Service: + description: The service which a pricing rule is applied on + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9\.\-]+' + BillingEntity: + description: The seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplaces. Supported billing entities are AWS, AWS Marketplace, and AISPL. + type: string + enum: + - AWS + - AWS Marketplace + - AISPL + Tiering: + description: The set of tiering configurations for the pricing rule. + type: object + additionalProperties: false + properties: + FreeTier: + $ref: '#/components/schemas/FreeTier' + UsageType: + description: The UsageType which a SKU pricing rule is modifying + type: string + minLength: 1 + maxLength: 256 + pattern: ^\S+$ + Operation: + description: The Operation which a SKU pricing rule is modifying + type: string + minLength: 1 + maxLength: 256 + pattern: ^\S+$ + AssociatedPricingPlanCount: + description: The number of pricing plans associated with pricing rule + type: integer + minimum: 0 + CreationTime: + description: Creation timestamp in UNIX epoch time format + type: integer + LastModifiedTime: + description: Latest modified timestamp in UNIX epoch time format + type: integer + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePricingRuleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: billing_groups: name: billing_groups id: awscc.billingconductor.billing_groups x-cfn-schema-name: BillingGroup - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' - AND region = 'us-east-1' - billing_group: - name: billing_group - id: awscc.billingconductor.billing_group - x-cfn-schema-name: BillingGroup - x-type: get + x-cfn-type-name: AWS::BillingConductor::BillingGroup x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BillingGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::BillingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::BillingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::BillingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -598,7 +1338,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -618,13 +1358,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' AND data__Identifier = '' AND region = 'us-east-1' - custom_line_items: - name: custom_line_items - id: awscc.billingconductor.custom_line_items - x-cfn-schema-name: CustomLineItem - x-type: list + billing_groups_list_only: + name: billing_groups_list_only + id: awscc.billingconductor.billing_groups_list_only + x-cfn-schema-name: BillingGroup + x-cfn-type-name: AWS::BillingConductor::BillingGroup x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -633,7 +1379,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -641,19 +1387,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' AND region = 'us-east-1' - custom_line_item: - name: custom_line_item - id: awscc.billingconductor.custom_line_item + custom_line_items: + name: custom_line_items + id: awscc.billingconductor.custom_line_items x-cfn-schema-name: CustomLineItem - x-type: get + x-cfn-type-name: AWS::BillingConductor::CustomLineItem x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomLineItem&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::CustomLineItem" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::CustomLineItem" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::CustomLineItem" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -675,7 +1469,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -696,13 +1490,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' AND data__Identifier = '' AND region = 'us-east-1' - pricing_plans: - name: pricing_plans - id: awscc.billingconductor.pricing_plans - x-cfn-schema-name: PricingPlan - x-type: list + custom_line_items_list_only: + name: custom_line_items_list_only + id: awscc.billingconductor.custom_line_items_list_only + x-cfn-schema-name: CustomLineItem + x-cfn-type-name: AWS::BillingConductor::CustomLineItem x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -711,7 +1511,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -719,19 +1519,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' AND region = 'us-east-1' - pricing_plan: - name: pricing_plan - id: awscc.billingconductor.pricing_plan + pricing_plans: + name: pricing_plans + id: awscc.billingconductor.pricing_plans x-cfn-schema-name: PricingPlan - x-type: get + x-cfn-type-name: AWS::BillingConductor::PricingPlan x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PricingPlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::PricingPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::PricingPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::PricingPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -748,7 +1596,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -764,13 +1612,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' AND data__Identifier = '' AND region = 'us-east-1' - pricing_rules: - name: pricing_rules - id: awscc.billingconductor.pricing_rules - x-cfn-schema-name: PricingRule - x-type: list + pricing_plans_list_only: + name: pricing_plans_list_only + id: awscc.billingconductor.pricing_plans_list_only + x-cfn-schema-name: PricingPlan + x-cfn-type-name: AWS::BillingConductor::PricingPlan x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -779,7 +1633,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -787,19 +1641,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' AND region = 'us-east-1' - pricing_rule: - name: pricing_rule - id: awscc.billingconductor.pricing_rule + pricing_rules: + name: pricing_rules + id: awscc.billingconductor.pricing_rules x-cfn-schema-name: PricingRule - x-type: get + x-cfn-type-name: AWS::BillingConductor::PricingRule x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PricingRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::PricingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::PricingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::BillingConductor::PricingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -823,7 +1725,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -846,3 +1748,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' AND data__Identifier = '' AND region = 'us-east-1' + pricing_rules_list_only: + name: pricing_rules_list_only + id: awscc.billingconductor.pricing_rules_list_only + x-cfn-schema-name: PricingRule + x-cfn-type-name: AWS::BillingConductor::PricingRule + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BillingGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBillingGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBillingGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomLineItem&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomLineItem + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomLineItemRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PricingPlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePricingPlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePricingPlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PricingRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePricingRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePricingRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/budgets.yaml b/providers/src/awscc/v00.00.00000/services/budgets.yaml index f9d0afb2..661aae82 100644 --- a/providers/src/awscc/v00.00.00000/services/budgets.yaml +++ b/providers/src/awscc/v00.00.00000/services/budgets.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Budgets - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Subscriber: type: object @@ -105,6 +485,17 @@ components: SsmActionDefinition: $ref: '#/components/schemas/SsmActionDefinition' additionalProperties: false + ResourceTag: + type: object + properties: + Key: + type: string + Value: + type: string + required: + - Key + - Value + additionalProperties: false BudgetsAction: type: object properties: @@ -140,6 +531,10 @@ components: minItems: 1 Definition: $ref: '#/components/schemas/Definition' + ResourceTags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' required: - BudgetName - NotificationType @@ -149,7 +544,9 @@ components: - Definition - Subscribers x-stackql-resource-name: budgets_action - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::Budgets::BudgetsAction + x-stackql-primary-identifier: - ActionId - BudgetName x-create-only-properties: @@ -157,61 +554,164 @@ components: - BudgetName x-read-only-properties: - ActionId + x-required-properties: + - BudgetName + - NotificationType + - ActionType + - ActionThreshold + - ExecutionRoleArn + - Definition + - Subscribers + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/ResourceTags + permissions: + - budgets:TagResource + - budgets:UntagResource + - budgets:ListTagsForResource x-required-permissions: create: - budgets:CreateBudgetAction - iam:PassRole + - budgets:TagResource read: - budgets:DescribeBudgetAction + - budgets:ListTagsForResource update: - budgets:UpdateBudgetAction - iam:PassRole + - budgets:TagResource + - budgets:UntagResource + - budgets:ListTagsForResource delete: - budgets:DeleteBudgetAction list: - budgets:DescribeBudgetActionsForAccount - budgets:DescribeBudgetActionsForBudget + CreateBudgetsActionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActionId: + type: string + BudgetName: + type: string + NotificationType: + type: string + enum: + - ACTUAL + - FORECASTED + ActionType: + type: string + enum: + - APPLY_IAM_POLICY + - APPLY_SCP_POLICY + - RUN_SSM_DOCUMENTS + ActionThreshold: + $ref: '#/components/schemas/ActionThreshold' + ExecutionRoleArn: + type: string + ApprovalModel: + type: string + enum: + - AUTOMATIC + - MANUAL + Subscribers: + type: array + items: + $ref: '#/components/schemas/Subscriber' + maxItems: 11 + minItems: 1 + Definition: + $ref: '#/components/schemas/Definition' + ResourceTags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' + x-stackQL-stringOnly: true + x-title: CreateBudgetsActionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: budgets_actions: name: budgets_actions id: awscc.budgets.budgets_actions x-cfn-schema-name: BudgetsAction - x-type: list - x-identifiers: - - ActionId - - BudgetName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ActionId') as action_id, - JSON_EXTRACT(Properties, '$.BudgetName') as budget_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ActionId') as action_id, - json_extract_path_text(Properties, 'BudgetName') as budget_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' - AND region = 'us-east-1' - budgets_action: - name: budgets_action - id: awscc.budgets.budgets_action - x-cfn-schema-name: BudgetsAction - x-type: get + x-cfn-type-name: AWS::Budgets::BudgetsAction x-identifiers: - ActionId - BudgetName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BudgetsAction&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Budgets::BudgetsAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Budgets::BudgetsAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Budgets::BudgetsAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -224,12 +724,13 @@ components: JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, JSON_EXTRACT(Properties, '$.ApprovalModel') as approval_model, JSON_EXTRACT(Properties, '$.Subscribers') as subscribers, - JSON_EXTRACT(Properties, '$.Definition') as definition + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.ResourceTags') as resource_tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -242,7 +743,237 @@ components: json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, json_extract_path_text(Properties, 'ApprovalModel') as approval_model, json_extract_path_text(Properties, 'Subscribers') as subscribers, - json_extract_path_text(Properties, 'Definition') as definition + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' AND data__Identifier = '|' AND region = 'us-east-1' + budgets_actions_list_only: + name: budgets_actions_list_only + id: awscc.budgets.budgets_actions_list_only + x-cfn-schema-name: BudgetsAction + x-cfn-type-name: AWS::Budgets::BudgetsAction + x-identifiers: + - ActionId + - BudgetName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ActionId') as action_id, + JSON_EXTRACT(Properties, '$.BudgetName') as budget_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ActionId') as action_id, + json_extract_path_text(Properties, 'BudgetName') as budget_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BudgetsAction&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBudgetsAction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBudgetsActionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cassandra.yaml b/providers/src/awscc/v00.00.00000/services/cassandra.yaml index fdc5be6d..30bf0fe4 100644 --- a/providers/src/awscc/v00.00.00000/services/cassandra.yaml +++ b/providers/src/awscc/v00.00.00000/services/cassandra.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Cassandra - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to apply to the resource @@ -45,6 +425,7 @@ components: items: type: string enum: + - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-south-1 @@ -64,7 +445,7 @@ components: uniqueItems: true x-insertionOrder: false minItems: 2 - maxItems: 6 + maxItems: 17 Keyspace: type: object properties: @@ -81,13 +462,29 @@ components: maxItems: 50 ReplicationSpecification: $ref: '#/components/schemas/ReplicationSpecification' + ClientSideTimestampsEnabled: + type: boolean + description: Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again. required: [] x-stackql-resource-name: keyspace - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Cassandra::Keyspace + x-type-name: AWS::Cassandra::Keyspace + x-stackql-primary-identifier: - KeyspaceName x-create-only-properties: - - ReplicationSpecification - KeyspaceName + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cassandra:TagResource + - cassandra:TagMultiRegionResource + - cassandra:UntagResource + - cassandra:UntagMultiRegionResource x-required-permissions: create: - cassandra:Create @@ -103,12 +500,23 @@ components: update: - cassandra:Alter - cassandra:AlterMultiRegionResource + - cassandra:Modify + - cassandra:ModifyMultiRegionResource - cassandra:Select - cassandra:SelectMultiRegionResource - cassandra:TagResource - cassandra:TagMultiRegionResource - cassandra:UntagResource - cassandra:UntagMultiRegionResource + - application-autoscaling:RegisterScalableTarget + - application-autoscaling:DeregisterScalableTarget + - application-autoscaling:DescribeScalableTargets + - application-autoscaling:DescribeScalingPolicies + - application-autoscaling:PutScalingPolicy + - cloudwatch:DeleteAlarms + - cloudwatch:DescribeAlarms + - cloudwatch:PutMetricAlarm + - iam:CreateServiceLinkedRole delete: - cassandra:Drop - cassandra:DropMultiRegionResource @@ -260,6 +668,40 @@ components: required: - Region additionalProperties: false + CdcSpecification: + description: Represents the CDC configuration for the table + type: object + properties: + Status: + $ref: '#/components/schemas/CdcStatus' + ViewType: + $ref: '#/components/schemas/CdcViewType' + Tags: + description: An array of key-value pairs to apply to the CDC stream resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + required: + - Status + additionalProperties: false + CdcStatus: + description: Indicates whether CDC is enabled or disabled for the table + type: string + enum: + - ENABLED + - DISABLED + CdcViewType: + description: Specifies what data should be captured in the change data stream + type: string + enum: + - NEW_IMAGE + - OLD_IMAGE + - KEYS_ONLY + - NEW_AND_OLD_IMAGES + default: NEW_AND_OLD_IMAGES Table: type: object properties: @@ -317,6 +759,8 @@ components: $ref: '#/components/schemas/EncryptionSpecification' AutoScalingSpecifications: $ref: '#/components/schemas/AutoScalingSpecification' + CdcSpecification: + $ref: '#/components/schemas/CdcSpecification' ReplicaSpecifications: type: array minItems: 1 @@ -328,7 +772,9 @@ components: - KeyspaceName - PartitionKeyColumns x-stackql-resource-name: table - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Cassandra::Table + x-type-name: AWS::Cassandra::Table + x-stackql-primary-identifier: - KeyspaceName - TableName x-create-only-properties: @@ -337,6 +783,23 @@ components: - PartitionKeyColumns - ClusteringKeyColumns - ClientSideTimestampsEnabled + x-write-only-properties: + - AutoScalingSpecifications + - ReplicaSpecifications + x-required-properties: + - KeyspaceName + - PartitionKeyColumns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cassandra:TagResource + - cassandra:TagMultiRegionResource + - cassandra:UntagResource + - cassandra:UntagMultiRegionResource x-required-permissions: create: - cassandra:Create @@ -358,6 +821,7 @@ components: - cloudwatch:DescribeAlarms - cloudwatch:GetMetricData - cloudwatch:PutMetricAlarm + - iam:CreateServiceLinkedRole read: - cassandra:Select - cassandra:SelectMultiRegionResource @@ -392,6 +856,7 @@ components: - cloudwatch:DescribeAlarms - cloudwatch:GetMetricData - cloudwatch:PutMetricAlarm + - iam:CreateServiceLinkedRole delete: - cassandra:Drop - cassandra:DropMultiRegionResource @@ -418,73 +883,363 @@ components: - cloudwatch:DescribeAlarms - cloudwatch:GetMetricData - cloudwatch:PutMetricAlarm + Field: + type: object + properties: + FieldName: + type: string + FieldType: + type: string + required: + - FieldName + - FieldType + additionalProperties: false + Type: + type: object + properties: + KeyspaceName: + description: Name of the Keyspace which contains the User-Defined Type. + type: string + TypeName: + description: Name of the User-Defined Type. + type: string + Fields: + description: Field definitions of the User-Defined Type + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Field' + DirectReferringTables: + description: List of Tables that directly reference the User-Defined Type in their columns. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + DirectParentTypes: + description: List of parent User-Defined Types that directly reference the User-Defined Type in their fields. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + MaxNestingDepth: + description: Maximum nesting depth of the User-Defined Type across the field types. + type: integer + LastModifiedTimestamp: + description: Timestamp of the last time the User-Defined Type's meta data was modified. + type: number + KeyspaceArn: + description: ARN of the Keyspace which contains the User-Defined Type. + type: string + required: + - KeyspaceName + - TypeName + - Fields + x-stackql-resource-name: type + description: Resource schema for AWS::Cassandra::Type + x-type-name: AWS::Cassandra::Type + x-stackql-primary-identifier: + - KeyspaceName + - TypeName + x-create-only-properties: + - KeyspaceName + - TypeName + - Fields + x-read-only-properties: + - DirectReferringTables + - DirectParentTypes + - MaxNestingDepth + - LastModifiedTimestamp + - KeyspaceArn + x-required-properties: + - KeyspaceName + - TypeName + - Fields + x-tagging: + taggable: false + x-required-permissions: + create: + - cassandra:Create + - cassandra:Select + read: + - cassandra:Select + delete: + - cassandra:Drop + - cassandra:Select + list: + - cassandra:Select + CreateKeyspaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + KeyspaceName: + description: Name for Cassandra keyspace + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$ + Tags: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + ReplicationSpecification: + $ref: '#/components/schemas/ReplicationSpecification' + ClientSideTimestampsEnabled: + type: boolean + description: Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace. To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you enabled client-side timestamps for a table, you can’t disable it again. + x-stackQL-stringOnly: true + x-title: CreateKeyspaceRequest + type: object + required: [] + CreateTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + KeyspaceName: + description: Name for Cassandra keyspace + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$ + TableName: + description: Name for Cassandra table + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$ + RegularColumns: + description: Non-key columns of the table + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Column' + PartitionKeyColumns: + description: Partition key columns of the table + type: array + minItems: 1 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/Column' + ClusteringKeyColumns: + description: Clustering key columns of the table + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/ClusteringKeyColumn' + BillingMode: + $ref: '#/components/schemas/BillingMode' + PointInTimeRecoveryEnabled: + description: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table + type: boolean + ClientSideTimestampsEnabled: + description: Indicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again. + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + DefaultTimeToLive: + description: Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column. + type: integer + minimum: 0 + EncryptionSpecification: + $ref: '#/components/schemas/EncryptionSpecification' + AutoScalingSpecifications: + $ref: '#/components/schemas/AutoScalingSpecification' + CdcSpecification: + $ref: '#/components/schemas/CdcSpecification' + ReplicaSpecifications: + type: array + minItems: 1 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/ReplicaSpecification' + x-stackQL-stringOnly: true + x-title: CreateTableRequest + type: object + required: [] + CreateTypeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + KeyspaceName: + description: Name of the Keyspace which contains the User-Defined Type. + type: string + TypeName: + description: Name of the User-Defined Type. + type: string + Fields: + description: Field definitions of the User-Defined Type + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Field' + DirectReferringTables: + description: List of Tables that directly reference the User-Defined Type in their columns. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + DirectParentTypes: + description: List of parent User-Defined Types that directly reference the User-Defined Type in their fields. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + MaxNestingDepth: + description: Maximum nesting depth of the User-Defined Type across the field types. + type: integer + LastModifiedTimestamp: + description: Timestamp of the last time the User-Defined Type's meta data was modified. + type: number + KeyspaceArn: + description: ARN of the Keyspace which contains the User-Defined Type. + type: string + x-stackQL-stringOnly: true + x-title: CreateTypeRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: keyspaces: name: keyspaces id: awscc.cassandra.keyspaces x-cfn-schema-name: Keyspace - x-type: list - x-identifiers: - - KeyspaceName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' - AND region = 'us-east-1' - keyspace: - name: keyspace - id: awscc.cassandra.keyspace - x-cfn-schema-name: Keyspace - x-type: get + x-cfn-type-name: AWS::Cassandra::Keyspace x-identifiers: - KeyspaceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Keyspace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Keyspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Keyspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Keyspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/keyspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/keyspaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/keyspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ReplicationSpecification') as replication_specification + JSON_EXTRACT(Properties, '$.ReplicationSpecification') as replication_specification, + JSON_EXTRACT(Properties, '$.ClientSideTimestampsEnabled') as client_side_timestamps_enabled FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Keyspace' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ReplicationSpecification') as replication_specification + json_extract_path_text(Properties, 'ReplicationSpecification') as replication_specification, + json_extract_path_text(Properties, 'ClientSideTimestampsEnabled') as client_side_timestamps_enabled FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Keyspace' AND data__Identifier = '' AND region = 'us-east-1' - tables: - name: tables - id: awscc.cassandra.tables - x-cfn-schema-name: Table - x-type: list + keyspaces_list_only: + name: keyspaces_list_only + id: awscc.cassandra.keyspaces_list_only + x-cfn-schema-name: Keyspace + x-cfn-type-name: AWS::Cassandra::Keyspace x-identifiers: - KeyspaceName - - TableName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -492,31 +1247,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' + JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, - json_extract_path_text(Properties, 'TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' AND region = 'us-east-1' - table: - name: table - id: awscc.cassandra.table + tables: + name: tables + id: awscc.cassandra.tables x-cfn-schema-name: Table - x-type: get + x-cfn-type-name: AWS::Cassandra::Table x-identifiers: - KeyspaceName - TableName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -533,12 +1334,13 @@ components: JSON_EXTRACT(Properties, '$.DefaultTimeToLive') as default_time_to_live, JSON_EXTRACT(Properties, '$.EncryptionSpecification') as encryption_specification, JSON_EXTRACT(Properties, '$.AutoScalingSpecifications') as auto_scaling_specifications, + JSON_EXTRACT(Properties, '$.CdcSpecification') as cdc_specification, JSON_EXTRACT(Properties, '$.ReplicaSpecifications') as replica_specifications FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Table' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -555,7 +1357,434 @@ components: json_extract_path_text(Properties, 'DefaultTimeToLive') as default_time_to_live, json_extract_path_text(Properties, 'EncryptionSpecification') as encryption_specification, json_extract_path_text(Properties, 'AutoScalingSpecifications') as auto_scaling_specifications, + json_extract_path_text(Properties, 'CdcSpecification') as cdc_specification, json_extract_path_text(Properties, 'ReplicaSpecifications') as replica_specifications FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Table' AND data__Identifier = '|' AND region = 'us-east-1' + tables_list_only: + name: tables_list_only + id: awscc.cassandra.tables_list_only + x-cfn-schema-name: Table + x-cfn-type-name: AWS::Cassandra::Table + x-identifiers: + - KeyspaceName + - TableName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, + json_extract_path_text(Properties, 'TableName') as table_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' + AND region = 'us-east-1' + types: + name: types + id: awscc.cassandra.types + x-cfn-schema-name: Type + x-cfn-type-name: AWS::Cassandra::Type + x-identifiers: + - KeyspaceName + - TypeName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Type&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Type" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cassandra::Type" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/types/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, + JSON_EXTRACT(Properties, '$.TypeName') as type_name, + JSON_EXTRACT(Properties, '$.Fields') as fields, + JSON_EXTRACT(Properties, '$.DirectReferringTables') as direct_referring_tables, + JSON_EXTRACT(Properties, '$.DirectParentTypes') as direct_parent_types, + JSON_EXTRACT(Properties, '$.MaxNestingDepth') as max_nesting_depth, + JSON_EXTRACT(Properties, '$.LastModifiedTimestamp') as last_modified_timestamp, + JSON_EXTRACT(Properties, '$.KeyspaceArn') as keyspace_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Type' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'Fields') as fields, + json_extract_path_text(Properties, 'DirectReferringTables') as direct_referring_tables, + json_extract_path_text(Properties, 'DirectParentTypes') as direct_parent_types, + json_extract_path_text(Properties, 'MaxNestingDepth') as max_nesting_depth, + json_extract_path_text(Properties, 'LastModifiedTimestamp') as last_modified_timestamp, + json_extract_path_text(Properties, 'KeyspaceArn') as keyspace_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Type' + AND data__Identifier = '|' + AND region = 'us-east-1' + types_list_only: + name: types_list_only + id: awscc.cassandra.types_list_only + x-cfn-schema-name: Type + x-cfn-type-name: AWS::Cassandra::Type + x-identifiers: + - KeyspaceName + - TypeName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, + JSON_EXTRACT(Properties, '$.TypeName') as type_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Type' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, + json_extract_path_text(Properties, 'TypeName') as type_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Type' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Keyspace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKeyspace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyspaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Type&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateType + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTypeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ce.yaml b/providers/src/awscc/v00.00.00000/services/ce.yaml index f7c456e2..5b6573d7 100644 --- a/providers/src/awscc/v00.00.00000/services/ce.yaml +++ b/providers/src/awscc/v00.00.00000/services/ce.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CE - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: description: Subscription ARN @@ -85,7 +465,9 @@ components: - MonitorName - MonitorType x-stackql-resource-name: anomaly_monitor - x-stackql-primaryIdentifier: + description: AWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor. + x-type-name: AWS::CE::AnomalyMonitor + x-stackql-primary-identifier: - MonitorArn x-create-only-properties: - MonitorType @@ -98,12 +480,24 @@ components: - LastEvaluatedDate - LastUpdatedDate - DimensionalValueCount + x-required-properties: + - MonitorName + - MonitorType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/ResourceTags + permissions: + - ce:ListTagsForResource x-required-permissions: create: - ce:CreateAnomalyMonitor - ce:TagResource read: - ce:GetAnomalyMonitors + - ce:ListTagsForResource update: - ce:UpdateAnomalyMonitor delete: @@ -186,7 +580,9 @@ components: - Frequency - SubscriptionName x-stackql-resource-name: anomaly_subscription - x-stackql-primaryIdentifier: + description: AWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified + x-type-name: AWS::CE::AnomalySubscription + x-stackql-primary-identifier: - SubscriptionArn x-create-only-properties: - ResourceTags @@ -194,12 +590,26 @@ components: - SubscriptionArn - AccountId - Subscribers/*/Status + x-required-properties: + - MonitorArnList + - Subscribers + - Frequency + - SubscriptionName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/ResourceTags + permissions: + - ce:ListTagsForResource x-required-permissions: create: - ce:CreateAnomalySubscription - ce:TagResource read: - ce:GetAnomalySubscriptions + - ce:ListTagsForResource update: - ce:UpdateAnomalySubscription delete: @@ -240,66 +650,305 @@ components: description: The default value for the cost category minLength: 1 maxLength: 50 + Tags: + type: array + description: Tags to assign to the cost category. + items: + $ref: '#/components/schemas/ResourceTag' + minItems: 0 + maxItems: 200 + x-insertionOrder: false required: - Name - RuleVersion - Rules x-stackql-resource-name: cost_category - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::CE::CostCategory. Cost Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine. + x-type-name: AWS::CE::CostCategory + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn - EffectiveStart + x-required-properties: + - Name + - RuleVersion + - Rules + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ce:TagResource + - ce:UntagResource + - ce:ListTagsForResource x-required-permissions: create: - ce:CreateCostCategoryDefinition + - ce:TagResource read: - ce:DescribeCostCategoryDefinition + - ce:ListTagsForResource update: - ce:UpdateCostCategoryDefinition + - ce:TagResource + - ce:UntagResource delete: - ce:DeleteCostCategoryDefinition list: - ce:ListCostCategoryDefinitions + CreateAnomalyMonitorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MonitorArn: + $ref: '#/components/schemas/Arn' + MonitorType: + type: string + enum: + - DIMENSIONAL + - CUSTOM + MonitorName: + description: The name of the monitor. + type: string + pattern: '[\S\s]*' + minLength: 0 + maxLength: 1024 + CreationDate: + description: 'The date when the monitor was created. ' + type: string + minLength: 0 + maxLength: 40 + pattern: (\d{4}-\d{2}-\d{2})(T\d{2}:\d{2}:\d{2}Z)? + LastEvaluatedDate: + description: The date when the monitor last evaluated for anomalies. + type: string + minLength: 0 + maxLength: 40 + pattern: (\d{4}-\d{2}-\d{2})(T\d{2}:\d{2}:\d{2}Z)?|(NOT_EVALUATED_YET) + LastUpdatedDate: + description: The date when the monitor was last updated. + type: string + minLength: 0 + maxLength: 40 + pattern: (\d{4}-\d{2}-\d{2})(T\d{2}:\d{2}:\d{2}Z)? + MonitorDimension: + description: The dimensions to evaluate + type: string + enum: + - SERVICE + MonitorSpecification: + type: string + DimensionalValueCount: + description: The value for evaluated dimensions. + type: integer + minimum: 0 + ResourceTags: + type: array + description: Tags to assign to monitor. + items: + $ref: '#/components/schemas/ResourceTag' + minItems: 0 + maxItems: 200 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateAnomalyMonitorRequest + type: object + required: [] + CreateAnomalySubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SubscriptionArn: + $ref: '#/components/schemas/Arn' + SubscriptionName: + description: The name of the subscription. + type: string + pattern: '[\S\s]*' + minLength: 0 + maxLength: 1024 + AccountId: + description: The accountId + type: string + minLength: 0 + maxLength: 1024 + MonitorArnList: + description: A list of cost anomaly monitors. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Arn' + Subscribers: + description: A list of subscriber + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Subscriber' + Threshold: + description: 'The dollar value that triggers a notification if the threshold is exceeded. ' + type: number + minimum: 0 + ThresholdExpression: + description: An Expression object in JSON String format used to specify the anomalies that you want to generate alerts for. + type: string + Frequency: + description: 'The frequency at which anomaly reports are sent over email. ' + type: string + enum: + - DAILY + - IMMEDIATE + - WEEKLY + ResourceTags: + type: array + description: Tags to assign to subscription. + items: + $ref: '#/components/schemas/ResourceTag' + minItems: 0 + maxItems: 200 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateAnomalySubscriptionRequest + type: object + required: [] + CreateCostCategoryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Cost category ARN + type: string + pattern: ^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$ + EffectiveStart: + $ref: '#/components/schemas/ZonedDateTime' + Name: + type: string + minLength: 1 + maxLength: 50 + RuleVersion: + type: string + enum: + - CostCategoryExpression.v1 + Rules: + type: string + description: JSON array format of Expression in Billing and Cost Management API + SplitChargeRules: + type: string + description: Json array format of CostCategorySplitChargeRule in Billing and Cost Management API + DefaultValue: + type: string + description: The default value for the cost category + minLength: 1 + maxLength: 50 + Tags: + type: array + description: Tags to assign to the cost category. + items: + $ref: '#/components/schemas/ResourceTag' + minItems: 0 + maxItems: 200 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateCostCategoryRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: anomaly_monitors: name: anomaly_monitors id: awscc.ce.anomaly_monitors x-cfn-schema-name: AnomalyMonitor - x-type: list - x-identifiers: - - MonitorArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MonitorArn') as monitor_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MonitorArn') as monitor_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' - AND region = 'us-east-1' - anomaly_monitor: - name: anomaly_monitor - id: awscc.ce.anomaly_monitor - x-cfn-schema-name: AnomalyMonitor - x-type: get + x-cfn-type-name: AWS::CE::AnomalyMonitor x-identifiers: - MonitorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AnomalyMonitor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::AnomalyMonitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::AnomalyMonitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::AnomalyMonitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -318,7 +967,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -336,13 +985,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' AND data__Identifier = '' AND region = 'us-east-1' - anomaly_subscriptions: - name: anomaly_subscriptions - id: awscc.ce.anomaly_subscriptions - x-cfn-schema-name: AnomalySubscription - x-type: list + anomaly_monitors_list_only: + name: anomaly_monitors_list_only + id: awscc.ce.anomaly_monitors_list_only + x-cfn-schema-name: AnomalyMonitor + x-cfn-type-name: AWS::CE::AnomalyMonitor x-identifiers: - - SubscriptionArn + - MonitorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -350,28 +1005,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SubscriptionArn') as subscription_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' + JSON_EXTRACT(Properties, '$.MonitorArn') as monitor_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SubscriptionArn') as subscription_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' + json_extract_path_text(Properties, 'MonitorArn') as monitor_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' AND region = 'us-east-1' - anomaly_subscription: - name: anomaly_subscription - id: awscc.ce.anomaly_subscription + anomaly_subscriptions: + name: anomaly_subscriptions + id: awscc.ce.anomaly_subscriptions x-cfn-schema-name: AnomalySubscription - x-type: get + x-cfn-type-name: AWS::CE::AnomalySubscription x-identifiers: - SubscriptionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AnomalySubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::AnomalySubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::AnomalySubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::AnomalySubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -389,7 +1092,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -406,13 +1109,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CE::AnomalySubscription' AND data__Identifier = '' AND region = 'us-east-1' - cost_categories: - name: cost_categories - id: awscc.ce.cost_categories - x-cfn-schema-name: CostCategory - x-type: list + anomaly_subscriptions_list_only: + name: anomaly_subscriptions_list_only + id: awscc.ce.anomaly_subscriptions_list_only + x-cfn-schema-name: AnomalySubscription + x-cfn-type-name: AWS::CE::AnomalySubscription x-identifiers: - - Arn + - SubscriptionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -420,28 +1129,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' + JSON_EXTRACT(Properties, '$.SubscriptionArn') as subscription_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' + json_extract_path_text(Properties, 'SubscriptionArn') as subscription_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' AND region = 'us-east-1' - cost_category: - name: cost_category - id: awscc.ce.cost_category + cost_categories: + name: cost_categories + id: awscc.ce.cost_categories x-cfn-schema-name: CostCategory - x-type: get + x-cfn-type-name: AWS::CE::CostCategory x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CostCategory&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::CostCategory" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::CostCategory" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CE::CostCategory" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cost_categories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cost_categories/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cost_categories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -452,12 +1209,13 @@ components: JSON_EXTRACT(Properties, '$.RuleVersion') as rule_version, JSON_EXTRACT(Properties, '$.Rules') as rules, JSON_EXTRACT(Properties, '$.SplitChargeRules') as split_charge_rules, - JSON_EXTRACT(Properties, '$.DefaultValue') as default_value + JSON_EXTRACT(Properties, '$.DefaultValue') as default_value, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CE::CostCategory' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -468,7 +1226,318 @@ components: json_extract_path_text(Properties, 'RuleVersion') as rule_version, json_extract_path_text(Properties, 'Rules') as rules, json_extract_path_text(Properties, 'SplitChargeRules') as split_charge_rules, - json_extract_path_text(Properties, 'DefaultValue') as default_value + json_extract_path_text(Properties, 'DefaultValue') as default_value, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CE::CostCategory' AND data__Identifier = '' AND region = 'us-east-1' + cost_categories_list_only: + name: cost_categories_list_only + id: awscc.ce.cost_categories_list_only + x-cfn-schema-name: CostCategory + x-cfn-type-name: AWS::CE::CostCategory + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AnomalyMonitor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnomalyMonitor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnomalyMonitorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AnomalySubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnomalySubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnomalySubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CostCategory&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCostCategory + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCostCategoryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/certificatemanager.yaml b/providers/src/awscc/v00.00.00000/services/certificatemanager.yaml index f9537287..c36953b3 100644 --- a/providers/src/awscc/v00.00.00000/services/certificatemanager.yaml +++ b/providers/src/awscc/v00.00.00000/services/certificatemanager.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CertificateManager - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ExpiryEventsConfiguration: type: object @@ -25,10 +405,14 @@ components: required: - ExpiryEventsConfiguration x-stackql-resource-name: account - x-stackql-primaryIdentifier: + description: Resource schema for AWS::CertificateManager::Account. + x-type-name: AWS::CertificateManager::Account + x-stackql-primary-identifier: - AccountId x-read-only-properties: - AccountId + x-required-properties: + - ExpiryEventsConfiguration x-required-permissions: create: - acm:GetAccountConfiguration @@ -41,18 +425,94 @@ components: delete: - acm:GetAccountConfiguration - acm:PutAccountConfiguration + CreateAccountRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ExpiryEventsConfiguration: + $ref: '#/components/schemas/ExpiryEventsConfiguration' + AccountId: + $ref: '#/components/schemas/AccountId' + x-stackQL-stringOnly: true + x-title: CreateAccountRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - account: - name: account - id: awscc.certificatemanager.account + accounts: + name: accounts + id: awscc.certificatemanager.accounts x-cfn-schema-name: Account - x-type: get + x-cfn-type-name: AWS::CertificateManager::Account x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Account&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CertificateManager::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CertificateManager::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CertificateManager::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -63,7 +523,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -73,3 +533,198 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CertificateManager::Account' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Account&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccount + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccountRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/chatbot.yaml b/providers/src/awscc/v00.00.00000/services/chatbot.yaml index 27803913..e71a7a57 100644 --- a/providers/src/awscc/v00.00.00000/services/chatbot.yaml +++ b/providers/src/awscc/v00.00.00000/services/chatbot.yaml @@ -1,10 +1,538 @@ openapi: 3.0.0 info: title: Chatbot - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + CustomActionAttachment: + type: object + properties: + NotificationType: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + ButtonText: + type: string + maxLength: 50 + minLength: 1 + pattern: ^[\S\s]+$ + Criteria: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CustomActionAttachmentCriteria' + maxItems: 5 + minItems: 1 + Variables: + $ref: '#/components/schemas/CustomActionAttachmentVariables' + additionalProperties: false + CustomActionAttachmentCriteria: + type: object + properties: + Operator: + $ref: '#/components/schemas/CustomActionAttachmentCriteriaOperator' + VariableName: + type: string + Value: + type: string + maxLength: 1024 + minLength: 0 + required: + - Operator + - VariableName + additionalProperties: false + CustomActionAttachmentCriteriaOperator: + type: string + enum: + - HAS_VALUE + - EQUALS + CustomActionAttachmentVariables: + type: object + maxProperties: 5 + minProperties: 1 + x-patternProperties: + .+: + type: string + additionalProperties: false + CustomActionDefinition: + type: object + properties: + CommandText: + type: string + maxLength: 5000 + minLength: 1 + required: + - CommandText + additionalProperties: false + Tag: + type: object + additionalProperties: false + properties: + Value: + type: string + Key: + type: string + required: + - Value + - Key + CustomAction: + type: object + properties: + ActionName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]{1,64}$ + AliasName: + type: string + maxLength: 30 + minLength: 1 + pattern: ^[A-Za-z0-9-_]+$ + Attachments: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CustomActionAttachment' + CustomActionArn: + type: string + maxLength: 1011 + minLength: 1 + pattern: ^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$ + Definition: + $ref: '#/components/schemas/CustomActionDefinition' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + required: + - ActionName + - Definition + x-stackql-resource-name: custom_action + description: Definition of AWS::Chatbot::CustomAction Resource Type + x-type-name: AWS::Chatbot::CustomAction + x-stackql-primary-identifier: + - CustomActionArn + x-create-only-properties: + - ActionName + x-read-only-properties: + - CustomActionArn + x-required-properties: + - ActionName + - Definition + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - chatbot:TagResource + - chatbot:ListTagsForResource + - chatbot:UntagResource + x-required-permissions: + create: + - chatbot:CreateCustomAction + - chatbot:GetCustomAction + - chatbot:TagResource + - chatbot:ListTagsForResource + read: + - chatbot:GetCustomAction + - chatbot:ListTagsForResource + update: + - chatbot:UpdateCustomAction + - chatbot:GetCustomAction + - chatbot:TagResource + - chatbot:UntagResource + - chatbot:ListTagsForResource + delete: + - chatbot:DeleteCustomAction + list: + - chatbot:ListCustomActions MicrosoftTeamsChannelConfiguration: type: object properties: @@ -20,6 +548,12 @@ components: pattern: ^([a-zA-Z0-9-_=+/.,])*%3[aA]([a-zA-Z0-9-_=+/.,])*%40([a-zA-Z0-9-_=+/.,])*$ minLength: 1 maxLength: 256 + TeamsChannelName: + description: The name of the Microsoft Teams channel + type: string + pattern: ^(.*)$ + minLength: 1 + maxLength: 256 TeamsTenantId: description: The id of the Microsoft Teams tenant type: string @@ -63,6 +597,20 @@ components: description: Enables use of a user role requirement in your chat configuration type: boolean default: false + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CustomizationResourceArns: + description: ARNs of Custom Actions to associate with notifications in the provided chat channel. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$ required: - TeamId - TeamsChannelId @@ -70,7 +618,9 @@ components: - ConfigurationName - IamRoleArn x-stackql-resource-name: microsoft_teams_channel_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration. + x-type-name: AWS::Chatbot::MicrosoftTeamsChannelConfiguration + x-stackql-primary-identifier: - Arn x-create-only-properties: - TeamId @@ -78,21 +628,50 @@ components: - ConfigurationName x-read-only-properties: - Arn + x-required-properties: + - TeamId + - TeamsChannelId + - TeamsTenantId + - ConfigurationName + - IamRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - chatbot:TagResource + - chatbot:ListTagsForResource + - chatbot:UntagResource x-required-permissions: create: - chatbot:CreateMicrosoftTeamsChannelConfiguration + - chatbot:TagResource + - chatbot:AssociateToConfiguration + - chatbot:ListAssociations - iam:PassRole - iam:CreateServiceLinkedRole read: - chatbot:GetMicrosoftTeamsChannelConfiguration + - chatbot:ListAssociations update: - chatbot:UpdateMicrosoftTeamsChannelConfiguration + - chatbot:TagResource + - chatbot:UntagResource + - chatbot:ListTagsForResource + - chatbot:AssociateToConfiguration + - chatbot:DisassociateFromConfiguration + - chatbot:ListAssociations - iam:PassRole delete: - chatbot:GetMicrosoftTeamsChannelConfiguration - chatbot:DeleteMicrosoftTeamsChannelConfiguration + - chatbot:DisassociateFromConfiguration + - chatbot:ListAssociations list: - chatbot:ListMicrosoftTeamsChannelConfigurations + - chatbot:ListAssociations SlackChannelConfiguration: type: object properties: @@ -141,45 +720,407 @@ components: items: type: string pattern: ^(^$|arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})$ + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' UserRoleRequired: description: Enables use of a user role requirement in your chat configuration type: boolean default: false + CustomizationResourceArns: + description: ARNs of Custom Actions to associate with notifications in the provided chat channel. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$ required: - SlackWorkspaceId - SlackChannelId - ConfigurationName - IamRoleArn x-stackql-resource-name: slack_channel_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Chatbot::SlackChannelConfiguration. + x-type-name: AWS::Chatbot::SlackChannelConfiguration + x-stackql-primary-identifier: - Arn x-create-only-properties: - SlackWorkspaceId - ConfigurationName x-read-only-properties: - Arn + x-required-properties: + - SlackWorkspaceId + - SlackChannelId + - ConfigurationName + - IamRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - chatbot:TagResource + - chatbot:ListTagsForResource + - chatbot:UntagResource x-required-permissions: create: - chatbot:CreateSlackChannelConfiguration + - chatbot:TagResource + - chatbot:AssociateToConfiguration + - chatbot:ListAssociations - iam:PassRole - iam:CreateServiceLinkedRole read: - chatbot:DescribeSlackChannelConfigurations + - chatbot:ListAssociations update: - chatbot:UpdateSlackChannelConfiguration + - chatbot:TagResource + - chatbot:UntagResource + - chatbot:ListTagsForResource + - chatbot:AssociateToConfiguration + - chatbot:DisassociateFromConfiguration + - chatbot:ListAssociations - iam:PassRole delete: - chatbot:DeleteSlackChannelConfiguration + - chatbot:DisassociateFromConfiguration + - chatbot:ListAssociations list: - chatbot:DescribeSlackChannelConfigurations + - chatbot:ListAssociations + CreateCustomActionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActionName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]{1,64}$ + AliasName: + type: string + maxLength: 30 + minLength: 1 + pattern: ^[A-Za-z0-9-_]+$ + Attachments: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CustomActionAttachment' + CustomActionArn: + type: string + maxLength: 1011 + minLength: 1 + pattern: ^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$ + Definition: + $ref: '#/components/schemas/CustomActionDefinition' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateCustomActionRequest + type: object + required: [] + CreateMicrosoftTeamsChannelConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TeamId: + description: The id of the Microsoft Teams team + type: string + pattern: ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ + minLength: 36 + maxLength: 36 + TeamsChannelId: + description: The id of the Microsoft Teams channel + type: string + pattern: ^([a-zA-Z0-9-_=+/.,])*%3[aA]([a-zA-Z0-9-_=+/.,])*%40([a-zA-Z0-9-_=+/.,])*$ + minLength: 1 + maxLength: 256 + TeamsChannelName: + description: The name of the Microsoft Teams channel + type: string + pattern: ^(.*)$ + minLength: 1 + maxLength: 256 + TeamsTenantId: + description: The id of the Microsoft Teams tenant + type: string + pattern: ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ + minLength: 36 + maxLength: 36 + ConfigurationName: + description: The name of the configuration + type: string + pattern: ^[A-Za-z0-9-_]+$ + minLength: 1 + maxLength: 128 + IamRoleArn: + description: The ARN of the IAM role that defines the permissions for AWS Chatbot + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + SnsTopicArns: + description: ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + LoggingLevel: + description: Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs + type: string + pattern: ^(ERROR|INFO|NONE)$ + default: NONE + Arn: + description: Amazon Resource Name (ARN) of the configuration + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + GuardrailPolicies: + description: The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^(^$|arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})$ + UserRoleRequired: + description: Enables use of a user role requirement in your chat configuration + type: boolean + default: false + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CustomizationResourceArns: + description: ARNs of Custom Actions to associate with notifications in the provided chat channel. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$ + x-stackQL-stringOnly: true + x-title: CreateMicrosoftTeamsChannelConfigurationRequest + type: object + required: [] + CreateSlackChannelConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SlackWorkspaceId: + description: The id of the Slack workspace + type: string + pattern: ^[0-9A-Z]{1,255}$ + minLength: 1 + maxLength: 256 + SlackChannelId: + description: The id of the Slack channel + type: string + pattern: ^[A-Za-z0-9]+$ + minLength: 1 + maxLength: 256 + ConfigurationName: + description: The name of the configuration + type: string + pattern: ^[A-Za-z0-9-_]+$ + minLength: 1 + maxLength: 128 + IamRoleArn: + description: The ARN of the IAM role that defines the permissions for AWS Chatbot + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + SnsTopicArns: + description: ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + LoggingLevel: + description: Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs + type: string + pattern: ^(ERROR|INFO|NONE)$ + default: NONE + Arn: + description: Amazon Resource Name (ARN) of the configuration + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + GuardrailPolicies: + description: The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^(^$|arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})$ + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + UserRoleRequired: + description: Enables use of a user role requirement in your chat configuration + type: boolean + default: false + CustomizationResourceArns: + description: ARNs of Custom Actions to associate with notifications in the provided chat channel. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$ + x-stackQL-stringOnly: true + x-title: CreateSlackChannelConfigurationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - microsoft_teams_channel_configurations: - name: microsoft_teams_channel_configurations - id: awscc.chatbot.microsoft_teams_channel_configurations - x-cfn-schema-name: MicrosoftTeamsChannelConfiguration - x-type: list + custom_actions: + name: custom_actions + id: awscc.chatbot.custom_actions + x-cfn-schema-name: CustomAction + x-cfn-type-name: AWS::Chatbot::CustomAction x-identifiers: - - Arn + - CustomActionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomAction&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::CustomAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::CustomAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::CustomAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_actions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ActionName') as action_name, + JSON_EXTRACT(Properties, '$.AliasName') as alias_name, + JSON_EXTRACT(Properties, '$.Attachments') as attachments, + JSON_EXTRACT(Properties, '$.CustomActionArn') as custom_action_arn, + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::CustomAction' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActionName') as action_name, + json_extract_path_text(Properties, 'AliasName') as alias_name, + json_extract_path_text(Properties, 'Attachments') as attachments, + json_extract_path_text(Properties, 'CustomActionArn') as custom_action_arn, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::CustomAction' + AND data__Identifier = '' + AND region = 'us-east-1' + custom_actions_list_only: + name: custom_actions_list_only + id: awscc.chatbot.custom_actions_list_only + x-cfn-schema-name: CustomAction + x-cfn-type-name: AWS::Chatbot::CustomAction + x-identifiers: + - CustomActionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -187,34 +1128,83 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' + JSON_EXTRACT(Properties, '$.CustomActionArn') as custom_action_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::CustomAction' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' + json_extract_path_text(Properties, 'CustomActionArn') as custom_action_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::CustomAction' AND region = 'us-east-1' - microsoft_teams_channel_configuration: - name: microsoft_teams_channel_configuration - id: awscc.chatbot.microsoft_teams_channel_configuration + microsoft_teams_channel_configurations: + name: microsoft_teams_channel_configurations + id: awscc.chatbot.microsoft_teams_channel_configurations x-cfn-schema-name: MicrosoftTeamsChannelConfiguration - x-type: get + x-cfn-type-name: AWS::Chatbot::MicrosoftTeamsChannelConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MicrosoftTeamsChannelConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.TeamId') as team_id, JSON_EXTRACT(Properties, '$.TeamsChannelId') as teams_channel_id, + JSON_EXTRACT(Properties, '$.TeamsChannelName') as teams_channel_name, JSON_EXTRACT(Properties, '$.TeamsTenantId') as teams_tenant_id, JSON_EXTRACT(Properties, '$.ConfigurationName') as configuration_name, JSON_EXTRACT(Properties, '$.IamRoleArn') as iam_role_arn, @@ -222,18 +1212,21 @@ components: JSON_EXTRACT(Properties, '$.LoggingLevel') as logging_level, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.GuardrailPolicies') as guardrail_policies, - JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required + JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CustomizationResourceArns') as customization_resource_arns FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'TeamId') as team_id, json_extract_path_text(Properties, 'TeamsChannelId') as teams_channel_id, + json_extract_path_text(Properties, 'TeamsChannelName') as teams_channel_name, json_extract_path_text(Properties, 'TeamsTenantId') as teams_tenant_id, json_extract_path_text(Properties, 'ConfigurationName') as configuration_name, json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, @@ -241,17 +1234,25 @@ components: json_extract_path_text(Properties, 'LoggingLevel') as logging_level, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'GuardrailPolicies') as guardrail_policies, - json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required + json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CustomizationResourceArns') as customization_resource_arns FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - slack_channel_configurations: - name: slack_channel_configurations - id: awscc.chatbot.slack_channel_configurations - x-cfn-schema-name: SlackChannelConfiguration - x-type: list + microsoft_teams_channel_configurations_list_only: + name: microsoft_teams_channel_configurations_list_only + id: awscc.chatbot.microsoft_teams_channel_configurations_list_only + x-cfn-schema-name: MicrosoftTeamsChannelConfiguration + x-cfn-type-name: AWS::Chatbot::MicrosoftTeamsChannelConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -260,7 +1261,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -268,19 +1269,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' AND region = 'us-east-1' - slack_channel_configuration: - name: slack_channel_configuration - id: awscc.chatbot.slack_channel_configuration + slack_channel_configurations: + name: slack_channel_configurations + id: awscc.chatbot.slack_channel_configurations x-cfn-schema-name: SlackChannelConfiguration - x-type: get + x-cfn-type-name: AWS::Chatbot::SlackChannelConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SlackChannelConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::SlackChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::SlackChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Chatbot::SlackChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -293,12 +1342,14 @@ components: JSON_EXTRACT(Properties, '$.LoggingLevel') as logging_level, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.GuardrailPolicies') as guardrail_policies, - JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required, + JSON_EXTRACT(Properties, '$.CustomizationResourceArns') as customization_resource_arns FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -311,7 +1362,319 @@ components: json_extract_path_text(Properties, 'LoggingLevel') as logging_level, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'GuardrailPolicies') as guardrail_policies, - json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required, + json_extract_path_text(Properties, 'CustomizationResourceArns') as customization_resource_arns FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' AND data__Identifier = '' AND region = 'us-east-1' + slack_channel_configurations_list_only: + name: slack_channel_configurations_list_only + id: awscc.chatbot.slack_channel_configurations_list_only + x-cfn-schema-name: SlackChannelConfiguration + x-cfn-type-name: AWS::Chatbot::SlackChannelConfiguration + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomAction&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomAction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomActionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MicrosoftTeamsChannelConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMicrosoftTeamsChannelConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMicrosoftTeamsChannelConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SlackChannelConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSlackChannelConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSlackChannelConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cleanrooms.yaml b/providers/src/awscc/v00.00.00000/services/cleanrooms.yaml index f18abb78..5245b2fe 100644 --- a/providers/src/awscc/v00.00.00000/services/cleanrooms.yaml +++ b/providers/src/awscc/v00.00.00000/services/cleanrooms.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CleanRooms - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AnalysisParameter: type: object @@ -36,6 +416,19 @@ components: - TIME - TIMETZ - VARBYTE + - BINARY + - BYTE + - CHARACTER + - DOUBLE + - FLOAT + - INT + - LONG + - NUMERIC + - SHORT + - STRING + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TINYINT required: - Name - Type @@ -58,15 +451,95 @@ components: required: - ReferencedTables AnalysisSource: + oneOf: + - type: object + title: Text + properties: + Text: + type: string + maxLength: 90000 + minLength: 0 + required: + - Text + additionalProperties: false + - type: object + title: Artifacts + properties: + Artifacts: + $ref: '#/components/schemas/AnalysisTemplateArtifacts' + required: + - Artifacts + additionalProperties: false + AnalysisTemplateArtifacts: + type: object + properties: + EntryPoint: + $ref: '#/components/schemas/AnalysisTemplateArtifact' + AdditionalArtifacts: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AnalysisTemplateArtifact' + maxItems: 1 + minItems: 1 + RoleArn: + type: string + maxLength: 512 + minLength: 32 + required: + - EntryPoint + - RoleArn + additionalProperties: false + AnalysisTemplateArtifact: type: object + properties: + Location: + $ref: '#/components/schemas/S3Location' + required: + - Location additionalProperties: false + S3Location: + type: object properties: - Text: + Bucket: type: string - minLength: 0 - maxLength: 15000 + maxLength: 63 + minLength: 3 + Key: + type: string + required: + - Bucket + - Key + additionalProperties: false + AnalysisSourceMetadata: + oneOf: + - type: object + title: Artifacts + properties: + Artifacts: + $ref: '#/components/schemas/AnalysisTemplateArtifactMetadata' + required: + - Artifacts + additionalProperties: false + AnalysisTemplateArtifactMetadata: + type: object + properties: + EntryPointHash: + $ref: '#/components/schemas/Hash' + AdditionalArtifactHashes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Hash' required: - - Text + - EntryPointHash + additionalProperties: false + Hash: + type: object + properties: + Sha256: + type: string + additionalProperties: false Tag: type: object additionalProperties: false @@ -135,36 +608,53 @@ components: $ref: '#/components/schemas/AnalysisSchema' Source: $ref: '#/components/schemas/AnalysisSource' + SourceMetadata: + $ref: '#/components/schemas/AnalysisSourceMetadata' Format: type: string enum: - SQL + - PYSPARK_1_0 required: - Source - Format - Name - MembershipIdentifier x-stackql-resource-name: analysis_template - x-stackql-primaryIdentifier: + description: Represents a stored analysis within a collaboration + x-type-name: AWS::CleanRooms::AnalysisTemplate + x-stackql-primary-identifier: - AnalysisTemplateIdentifier - MembershipIdentifier x-create-only-properties: - Name - MembershipIdentifier - Source - - Source/Text - Format - AnalysisParameters - - AnalysisParameters/Name - - AnalysisParameters/Type - - AnalysisParameters/DefaultValue + - Schema x-read-only-properties: - CollaborationArn - CollaborationIdentifier - AnalysisTemplateIdentifier - - Schema - Arn - MembershipArn + x-required-properties: + - Source + - Format + - Name + - MembershipIdentifier + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource x-required-permissions: create: - cleanrooms:CreateAnalysisTemplate @@ -172,6 +662,7 @@ components: - cleanrooms:TagResource - cleanrooms:GetAnalysisTemplate - cleanrooms:ListAnalysisTemplates + - iam:PassRole read: - cleanrooms:GetAnalysisTemplate - cleanrooms:ListTagsForResource @@ -189,6 +680,16 @@ components: - cleanrooms:UntagResource list: - cleanrooms:ListAnalysisTemplates + AnalyticsEngine: + type: string + enum: + - CLEAN_ROOMS_SQL + - SPARK + CollaborationJobLogStatus: + type: string + enum: + - ENABLED + - DISABLED CollaborationQueryLogStatus: type: string enum: @@ -215,6 +716,7 @@ components: type: string enum: - CAN_QUERY + - CAN_RUN_JOB - CAN_RECEIVE_RESULTS MemberAbilities: type: array @@ -222,6 +724,25 @@ components: items: $ref: '#/components/schemas/MemberAbility' uniqueItems: true + MLMemberAbilities: + type: object + properties: + CustomMLMemberAbilities: + $ref: '#/components/schemas/CustomMLMemberAbilities' + required: + - CustomMLMemberAbilities + additionalProperties: false + CustomMLMemberAbility: + type: string + enum: + - CAN_RECEIVE_MODEL_OUTPUT + - CAN_RECEIVE_INFERENCE_OUTPUT + CustomMLMemberAbilities: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CustomMLMemberAbility' + uniqueItems: true MemberSpecification: type: object properties: @@ -232,6 +753,8 @@ components: pattern: ^\d+$ MemberAbilities: $ref: '#/components/schemas/MemberAbilities' + MLMemberAbilities: + $ref: '#/components/schemas/MLMemberAbilities' DisplayName: $ref: '#/components/schemas/Name' PaymentConfiguration: @@ -239,7 +762,6 @@ components: required: - AccountId - DisplayName - - MemberAbilities additionalProperties: false MemberStatus: type: string @@ -257,10 +779,22 @@ components: type: object additionalProperties: false properties: + JobCompute: + $ref: '#/components/schemas/JobComputePaymentConfig' QueryCompute: $ref: '#/components/schemas/QueryComputePaymentConfig' + MachineLearning: + $ref: '#/components/schemas/MLPaymentConfig' required: - QueryCompute + JobComputePaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible QueryComputePaymentConfig: type: object additionalProperties: false @@ -269,6 +803,30 @@ components: type: boolean required: - IsResponsible + MLPaymentConfig: + type: object + additionalProperties: false + properties: + ModelTraining: + $ref: '#/components/schemas/ModelTrainingPaymentConfig' + ModelInference: + $ref: '#/components/schemas/ModelInferencePaymentConfig' + ModelTrainingPaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible + ModelInferencePaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible Collaboration: type: object properties: @@ -291,6 +849,8 @@ components: $ref: '#/components/schemas/Name' CreatorMemberAbilities: $ref: '#/components/schemas/MemberAbilities' + CreatorMLMemberAbilities: + $ref: '#/components/schemas/MLMemberAbilities' DataEncryptionMetadata: $ref: '#/components/schemas/DataEncryptionMetadata' Description: @@ -310,30 +870,52 @@ components: maxLength: 100 minLength: 1 pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + JobLogStatus: + $ref: '#/components/schemas/CollaborationJobLogStatus' QueryLogStatus: $ref: '#/components/schemas/CollaborationQueryLogStatus' + AnalyticsEngine: + $ref: '#/components/schemas/AnalyticsEngine' CreatorPaymentConfiguration: $ref: '#/components/schemas/PaymentConfiguration' required: - CreatorDisplayName - - CreatorMemberAbilities - - Members - Name - Description - QueryLogStatus x-stackql-resource-name: collaboration - x-stackql-primaryIdentifier: + description: Represents a collaboration between AWS accounts that allows for secure data collaboration + x-type-name: AWS::CleanRooms::Collaboration + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html + x-stackql-primary-identifier: - CollaborationIdentifier x-create-only-properties: - CreatorDisplayName - CreatorMemberAbilities + - CreatorMLMemberAbilities - DataEncryptionMetadata + - JobLogStatus - QueryLogStatus - Members - CreatorPaymentConfiguration x-read-only-properties: - Arn - CollaborationIdentifier + x-required-properties: + - CreatorDisplayName + - Name + - Description + - QueryLogStatus + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource x-required-permissions: create: - cleanrooms:CreateCollaboration @@ -420,6 +1002,18 @@ components: type: string enum: - DIRECT_QUERY + - DIRECT_JOB + - MULTIPLE + SelectedAnalysisMethod: + type: string + enum: + - DIRECT_QUERY + - DIRECT_JOB + SelectedAnalysisMethods: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SelectedAnalysisMethod' JoinRequiredOption: type: string enum: @@ -440,6 +1034,17 @@ components: - RTRIM - UPPER - COALESCE + - CONVERT + - CURRENT_DATE + - DATEADD + - EXTRACT + - GETDATE + - SUBSTRING + - TO_CHAR + - TO_DATE + - TO_NUMBER + - TO_TIMESTAMP + - TRIM AnalysisRuleAggregation: type: object properties: @@ -478,6 +1083,8 @@ components: items: $ref: '#/components/schemas/AggregationConstraint' minItems: 1 + AdditionalAnalyses: + $ref: '#/components/schemas/AdditionalAnalyses' required: - AggregateColumns - JoinColumns @@ -505,6 +1112,8 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/AnalysisRuleColumnName' + AdditionalAnalyses: + $ref: '#/components/schemas/AdditionalAnalyses' required: - JoinColumns - ListColumns @@ -513,7 +1122,7 @@ components: type: string minLength: 0 maxLength: 200 - pattern: (ANY_QUERY|arn:[\w]{3}:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+) + pattern: (ANY_QUERY|ANY_JOB|arn:[\w]{3}:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+) AllowedAnalyses: type: array x-insertionOrder: false @@ -531,6 +1140,38 @@ components: minItems: 0 items: $ref: '#/components/schemas/AllowedAnalysisProvider' + DisallowedOutputColumns: + type: array + x-insertionOrder: false + minItems: 0 + items: + $ref: '#/components/schemas/AnalysisRuleColumnName' + AdditionalAnalyses: + type: string + enum: + - ALLOWED + - REQUIRED + - NOT_ALLOWED + DifferentialPrivacyColumn: + type: object + properties: + Name: + type: string + required: + - Name + additionalProperties: false + DifferentialPrivacy: + type: object + properties: + Columns: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DifferentialPrivacyColumn' + minItems: 1 + required: + - Columns + additionalProperties: false AnalysisRuleCustom: type: object properties: @@ -538,6 +1179,12 @@ components: $ref: '#/components/schemas/AllowedAnalyses' AllowedAnalysisProviders: $ref: '#/components/schemas/AllowedAnalysisProviders' + DifferentialPrivacy: + $ref: '#/components/schemas/DifferentialPrivacy' + DisallowedOutputColumns: + $ref: '#/components/schemas/DisallowedOutputColumns' + AdditionalAnalyses: + $ref: '#/components/schemas/AdditionalAnalyses' required: - AllowedAnalyses additionalProperties: false @@ -597,34 +1244,133 @@ components: - DatabaseName - TableName additionalProperties: false - AnalysisRule: - type: object - properties: - Type: - $ref: '#/components/schemas/ConfiguredTableAnalysisRuleType' - Policy: - $ref: '#/components/schemas/ConfiguredTableAnalysisRulePolicy' - required: - - Type - - Policy - additionalProperties: false - TableReference: - type: object - x-title: Glue - properties: - Glue: - $ref: '#/components/schemas/GlueTableReference' - required: - - Glue - additionalProperties: false - ConfiguredTable: + SnowflakeTableReference: type: object properties: - Arn: + SecretArn: type: string - maxLength: 100 - Tags: - description: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. + maxLength: 256 + AccountIdentifier: + type: string + maxLength: 256 + minLength: 3 + DatabaseName: + type: string + maxLength: 256 + minLength: 1 + TableName: + type: string + maxLength: 256 + minLength: 1 + SchemaName: + type: string + maxLength: 256 + minLength: 1 + TableSchema: + $ref: '#/components/schemas/SnowflakeTableSchema' + required: + - AccountIdentifier + - DatabaseName + - SchemaName + - SecretArn + - TableName + - TableSchema + additionalProperties: false + SnowflakeTableSchema: + oneOf: + - type: object + title: V1 + properties: + V1: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SnowflakeTableSchemaV1' + maxItems: 250 + minItems: 1 + required: + - V1 + additionalProperties: false + SnowflakeTableSchemaV1: + type: object + properties: + ColumnName: + type: string + maxLength: 128 + ColumnType: + type: string + maxLength: 255 + required: + - ColumnName + - ColumnType + additionalProperties: false + AthenaTableReference: + type: object + properties: + WorkGroup: + type: string + maxLength: 128 + minLength: 1 + OutputLocation: + type: string + maxLength: 1024 + minLength: 8 + DatabaseName: + type: string + maxLength: 128 + TableName: + type: string + maxLength: 128 + required: + - DatabaseName + - TableName + - WorkGroup + additionalProperties: false + AnalysisRule: + type: object + properties: + Type: + $ref: '#/components/schemas/ConfiguredTableAnalysisRuleType' + Policy: + $ref: '#/components/schemas/ConfiguredTableAnalysisRulePolicy' + required: + - Type + - Policy + additionalProperties: false + TableReference: + oneOf: + - type: object + title: Glue + properties: + Glue: + $ref: '#/components/schemas/GlueTableReference' + required: + - Glue + additionalProperties: false + - type: object + title: Snowflake + properties: + Snowflake: + $ref: '#/components/schemas/SnowflakeTableReference' + required: + - Snowflake + additionalProperties: false + - type: object + title: Athena + properties: + Athena: + $ref: '#/components/schemas/AthenaTableReference' + required: + - Athena + additionalProperties: false + ConfiguredTable: + type: object + properties: + Arn: + type: string + maxLength: 100 + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. x-insertionOrder: false items: $ref: '#/components/schemas/Tag' @@ -641,6 +1387,8 @@ components: minItems: 1 AnalysisMethod: $ref: '#/components/schemas/AnalysisMethod' + SelectedAnalysisMethods: + $ref: '#/components/schemas/SelectedAnalysisMethods' ConfiguredTableIdentifier: type: string maxLength: 36 @@ -670,15 +1418,28 @@ components: - Name - TableReference x-stackql-resource-name: configured_table - x-stackql-primaryIdentifier: + description: Represents a table that can be associated with collaborations + x-type-name: AWS::CleanRooms::ConfiguredTable + x-stackql-primary-identifier: - ConfiguredTableIdentifier - x-create-only-properties: - - AllowedColumns - - AnalysisMethod - - TableReference x-read-only-properties: - Arn - ConfiguredTableIdentifier + x-required-properties: + - AllowedColumns + - AnalysisMethod + - Name + - TableReference + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource x-required-permissions: create: - cleanrooms:CreateConfiguredTable @@ -698,12 +1459,15 @@ components: - cleanrooms:ListTagsForResource - cleanrooms:TagResource - cleanrooms:ListConfiguredTables + - athena:GetTableMetadata read: - cleanrooms:GetConfiguredTable - cleanrooms:GetConfiguredTableAnalysisRule - cleanrooms:ListTagsForResource update: - cleanrooms:UpdateConfiguredTable + - cleanrooms:UpdateConfiguredTableReference + - cleanrooms:UpdateConfiguredTableAllowedColumns - cleanrooms:GetConfiguredTable - cleanrooms:CreateConfiguredTableAnalysisRule - cleanrooms:UpdateConfiguredTableAnalysisRule @@ -738,12 +1502,109 @@ components: - glue:GetSchemaVersion list: - cleanrooms:ListConfiguredTables + ConfiguredTableAssociationAnalysisRuleType: + type: string + enum: + - AGGREGATION + - LIST + - CUSTOM + AllowedResultReceiver: + type: string + minLength: 12 + maxLength: 12 + pattern: \d+ + AllowedResultReceivers: + type: array + x-insertionOrder: false + minItems: 0 + items: + $ref: '#/components/schemas/AllowedResultReceiver' + AllowedAdditionalAnalysis: + type: string + maxLength: 256 + AllowedAdditionalAnalyses: + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 25 + items: + $ref: '#/components/schemas/AllowedAdditionalAnalysis' + ConfiguredTableAssociationAnalysisRuleCustom: + type: object + properties: + AllowedResultReceivers: + $ref: '#/components/schemas/AllowedResultReceivers' + AllowedAdditionalAnalyses: + $ref: '#/components/schemas/AllowedAdditionalAnalyses' + additionalProperties: false + ConfiguredTableAssociationAnalysisRuleAggregation: + type: object + properties: + AllowedResultReceivers: + $ref: '#/components/schemas/AllowedResultReceivers' + AllowedAdditionalAnalyses: + $ref: '#/components/schemas/AllowedAdditionalAnalyses' + additionalProperties: false + ConfiguredTableAssociationAnalysisRuleList: + type: object + properties: + AllowedResultReceivers: + $ref: '#/components/schemas/AllowedResultReceivers' + AllowedAdditionalAnalyses: + $ref: '#/components/schemas/AllowedAdditionalAnalyses' + additionalProperties: false + ConfiguredTableAssociationAnalysisRulePolicyV1: + oneOf: + - type: object + title: List + properties: + List: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRuleList' + required: + - List + additionalProperties: false + - type: object + title: Aggregation + properties: + Aggregation: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRuleAggregation' + required: + - Aggregation + additionalProperties: false + - type: object + title: Custom + properties: + Custom: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRuleCustom' + required: + - Custom + additionalProperties: false + ConfiguredTableAssociationAnalysisRulePolicy: + type: object + x-title: V1 + properties: + V1: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRulePolicyV1' + required: + - V1 + additionalProperties: false + ConfiguredTableAssociationAnalysisRule: + type: object + properties: + Type: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRuleType' + Policy: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRulePolicy' + required: + - Type + - Policy + additionalProperties: false ConfiguredTableAssociation: type: object properties: Arn: type: string - maxLength: 100 + maxLength: 256 Tags: description: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. x-insertionOrder: false @@ -777,13 +1638,22 @@ components: type: string maxLength: 512 minLength: 32 + ConfiguredTableAssociationAnalysisRules: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRule' + maxItems: 1 + minItems: 1 required: - ConfiguredTableIdentifier - Name - RoleArn - MembershipIdentifier x-stackql-resource-name: configured_table_association - x-stackql-primaryIdentifier: + description: Represents a table that can be queried within a collaboration + x-type-name: AWS::CleanRooms::ConfiguredTableAssociation + x-stackql-primary-identifier: - ConfiguredTableAssociationIdentifier - MembershipIdentifier x-create-only-properties: @@ -793,6 +1663,22 @@ components: x-read-only-properties: - ConfiguredTableAssociationIdentifier - Arn + x-required-properties: + - ConfiguredTableIdentifier + - Name + - RoleArn + - MembershipIdentifier + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource x-required-permissions: create: - cleanrooms:CreateConfiguredTableAssociation @@ -801,9 +1687,14 @@ components: - cleanrooms:TagResource - cleanrooms:GetConfiguredTableAssociation - cleanrooms:ListConfiguredTableAssociations + - cleanrooms:DeleteConfiguredTableAssociation + - cleanrooms:DeleteConfiguredTableAssociationAnalysisRule + - cleanrooms:CreateConfiguredTableAssociationAnalysisRule + - cleanrooms:GetConfiguredTableAssociationAnalysisRule read: - cleanrooms:GetConfiguredTableAssociation - cleanrooms:ListTagsForResource + - cleanrooms:GetConfiguredTableAssociationAnalysisRule update: - cleanrooms:UpdateConfiguredTableAssociation - cleanrooms:GetConfiguredTableAssociation @@ -811,272 +1702,1720 @@ components: - cleanrooms:ListTagsForResource - cleanrooms:TagResource - cleanrooms:UntagResource + - cleanrooms:DeleteConfiguredTableAssociationAnalysisRule + - cleanrooms:CreateConfiguredTableAssociationAnalysisRule + - cleanrooms:GetConfiguredTableAssociationAnalysisRule + - cleanrooms:UpdateConfiguredTableAssociationAnalysisRule delete: - cleanrooms:DeleteConfiguredTableAssociation - cleanrooms:GetConfiguredTableAssociation - cleanrooms:ListConfiguredTableAssociations - cleanrooms:ListTagsForResource - cleanrooms:UntagResource + - cleanrooms:DeleteConfiguredTableAssociationAnalysisRule + - cleanrooms:GetConfiguredTableAssociationAnalysisRule list: - cleanrooms:ListConfiguredTableAssociations - MembershipQueryLogStatus: - type: string - enum: - - ENABLED - - DISABLED - MembershipStatus: - type: string - enum: - - ACTIVE - - REMOVED - - COLLABORATION_DELETED - ResultFormat: + UUID: type: string - enum: - - CSV - - PARQUET - ProtectedQueryS3OutputConfiguration: + maxLength: 36 + minLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + IdMappingTableInputReferenceConfig: type: object - additionalProperties: false properties: - ResultFormat: - $ref: '#/components/schemas/ResultFormat' - Bucket: - type: string - minLength: 3 - maxLength: 63 - KeyPrefix: + InputReferenceArn: type: string + maxLength: 2048 + minLength: 20 + ManageResourcePolicies: + type: boolean required: - - ResultFormat - - Bucket - MembershipProtectedQueryOutputConfiguration: - type: object + - InputReferenceArn + - ManageResourcePolicies additionalProperties: false - properties: - S3: - $ref: '#/components/schemas/ProtectedQueryS3OutputConfiguration' - required: - - S3 - MembershipProtectedQueryResultConfiguration: + IdMappingTableInputSource: type: object - additionalProperties: false properties: - OutputConfiguration: - $ref: '#/components/schemas/MembershipProtectedQueryOutputConfiguration' - RoleArn: + IdNamespaceAssociationId: type: string - minLength: 32 - maxLength: 512 + Type: + type: string + enum: + - SOURCE + - TARGET required: - - OutputConfiguration - MembershipPaymentConfiguration: - type: object + - IdNamespaceAssociationId + - Type additionalProperties: false - properties: - QueryCompute: - $ref: '#/components/schemas/MembershipQueryComputePaymentConfig' - required: - - QueryCompute - MembershipQueryComputePaymentConfig: + IdMappingTableInputReferenceProperties: type: object - additionalProperties: false properties: - IsResponsible: - type: boolean + IdMappingTableInputSource: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/IdMappingTableInputSource' + maxItems: 2 + minItems: 2 required: - - IsResponsible - Membership: + - IdMappingTableInputSource + additionalProperties: false + IdMappingTable: type: object properties: + IdMappingTableIdentifier: + $ref: '#/components/schemas/UUID' Arn: + type: string + maxLength: 200 + InputReferenceConfig: + $ref: '#/components/schemas/IdMappingTableInputReferenceConfig' + MembershipIdentifier: + $ref: '#/components/schemas/UUID' + MembershipArn: + type: string + maxLength: 100 + CollaborationIdentifier: + $ref: '#/components/schemas/UUID' + CollaborationArn: type: string maxLength: 100 + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + Name: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$ + InputReferenceProperties: + $ref: '#/components/schemas/IdMappingTableInputReferenceProperties' + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 4 Tags: - description: An arbitrary set of tags (key-value pairs) for this cleanrooms membership. + type: array x-insertionOrder: false items: $ref: '#/components/schemas/Tag' uniqueItems: true + required: + - MembershipIdentifier + - Name + - InputReferenceConfig + x-stackql-resource-name: id_mapping_table + description: Represents an association between an ID mapping workflow and a collaboration + x-type-name: AWS::CleanRooms::IdMappingTable + x-stackql-primary-identifier: + - IdMappingTableIdentifier + - MembershipIdentifier + x-create-only-properties: + - MembershipIdentifier + - Name + - InputReferenceConfig + x-read-only-properties: + - IdMappingTableIdentifier + - Arn + - MembershipArn + - CollaborationIdentifier + - CollaborationArn + - InputReferenceProperties + x-required-properties: + - MembershipIdentifier + - Name + - InputReferenceConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource + x-required-permissions: + create: + - cleanrooms:CreateIdMappingTable + - cleanrooms:GetIdMappingTable + - cleanrooms:ListIdMappingTables + - cleanrooms:ListTagsForResource + - cleanrooms:TagResource + - cleanrooms:GetMembership + - cleanrooms:GetCollaboration + - entityresolution:GetIdMappingWorkflow + - entityresolution:AddPolicyStatement + read: + - cleanrooms:GetIdMappingTable + - cleanrooms:ListTagsForResource + - cleanrooms:GetMembership + - cleanrooms:GetCollaboration + update: + - cleanrooms:UpdateIdMappingTable + - cleanrooms:GetIdMappingTable + - cleanrooms:GetMembership + - cleanrooms:ListTagsForResource + - cleanrooms:TagResource + - cleanrooms:UntagResource + - entityresolution:GetIdMappingWorkflow + - entityresolution:AddPolicyStatement + delete: + - cleanrooms:DeleteIdMappingTable + - cleanrooms:GetIdMappingTable + - cleanrooms:ListIdMappingTables + - cleanrooms:GetMembership + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - entityresolution:GetIdMappingWorkflow + - entityresolution:AddPolicyStatement + - entityresolution:DeletePolicyStatement + list: + - cleanrooms:ListIdMappingTables + - cleanrooms:GetMembership + - cleanrooms:GetCollaboration + Document: + type: object + IdNamespaceAssociationInputReferenceConfig: + type: object + properties: + InputReferenceArn: + type: string + maxLength: 256 + ManageResourcePolicies: + type: boolean + required: + - InputReferenceArn + - ManageResourcePolicies + additionalProperties: false + IdMappingConfig: + type: object + properties: + AllowUseAsDimensionColumn: + type: boolean + required: + - AllowUseAsDimensionColumn + additionalProperties: false + IdNamespaceAssociationInputReferenceProperties: + type: object + properties: + IdNamespaceType: + type: string + enum: + - SOURCE + - TARGET + IdMappingWorkflowsSupported: type: array - CollaborationArn: + x-insertionOrder: false + items: + $ref: '#/components/schemas/Document' + required: [] + additionalProperties: false + IdNamespaceAssociation: + type: object + properties: + IdNamespaceAssociationIdentifier: + $ref: '#/components/schemas/UUID' + Arn: type: string - maxLength: 100 - CollaborationCreatorAccountId: + maxLength: 256 + MembershipIdentifier: + $ref: '#/components/schemas/UUID' + MembershipArn: type: string - maxLength: 12 - minLength: 12 - pattern: ^\d+$ + maxLength: 100 CollaborationIdentifier: + $ref: '#/components/schemas/UUID' + CollaborationArn: type: string - maxLength: 36 - minLength: 36 - pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' - MembershipIdentifier: + maxLength: 100 + InputReferenceConfig: + $ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + Name: type: string - maxLength: 36 - minLength: 36 - pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' - QueryLogStatus: - $ref: '#/components/schemas/MembershipQueryLogStatus' - DefaultResultConfiguration: - $ref: '#/components/schemas/MembershipProtectedQueryResultConfiguration' - PaymentConfiguration: - $ref: '#/components/schemas/MembershipPaymentConfiguration' + maxLength: 100 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + IdMappingConfig: + $ref: '#/components/schemas/IdMappingConfig' + InputReferenceProperties: + $ref: '#/components/schemas/IdNamespaceAssociationInputReferenceProperties' required: - - CollaborationIdentifier - - QueryLogStatus - x-stackql-resource-name: membership - x-stackql-primaryIdentifier: + - MembershipIdentifier + - InputReferenceConfig + - Name + x-stackql-resource-name: id_namespace_association + description: Represents an association between an ID namespace and a collaboration + x-type-name: AWS::CleanRooms::IdNamespaceAssociation + x-stackql-primary-identifier: + - IdNamespaceAssociationIdentifier - MembershipIdentifier x-create-only-properties: - - CollaborationIdentifier + - MembershipIdentifier + - InputReferenceConfig x-read-only-properties: + - IdNamespaceAssociationIdentifier - Arn + - MembershipArn + - CollaborationIdentifier - CollaborationArn - - CollaborationCreatorAccountId + - InputReferenceProperties + x-required-properties: - MembershipIdentifier + - InputReferenceConfig + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource x-required-permissions: create: - - cleanrooms:CreateMembership - - logs:CreateLogDelivery - - logs:GetLogDelivery - - logs:UpdateLogDelivery - - logs:DeleteLogDelivery - - logs:ListLogDeliveries - - logs:DescribeLogGroups - - logs:DescribeResourcePolicies - - logs:PutResourcePolicy - - logs:CreateLogGroup - - cleanrooms:GetMembership + - cleanrooms:CreateIdNamespaceAssociation + - cleanrooms:GetIdNamespaceAssociation + - cleanrooms:ListIdNamespaceAssociations - cleanrooms:ListTagsForResource - cleanrooms:TagResource - - cleanrooms:ListMemberships - - iam:PassRole - read: - cleanrooms:GetMembership + - cleanrooms:GetCollaboration + - entityresolution:GetIdNamespace + - entityresolution:AddPolicyStatement + read: + - cleanrooms:GetIdNamespaceAssociation - cleanrooms:ListTagsForResource - - logs:ListLogDeliveries - - logs:DescribeLogGroups - - logs:DescribeResourcePolicies - - logs:GetLogDelivery + - cleanrooms:GetMembership + - cleanrooms:GetCollaboration + - entityresolution:GetIdNamespace update: - - cleanrooms:UpdateMembership + - cleanrooms:UpdateIdNamespaceAssociation + - cleanrooms:GetIdNamespaceAssociation - cleanrooms:GetMembership - - logs:CreateLogDelivery - - logs:GetLogDelivery - - logs:UpdateLogDelivery - - logs:DeleteLogDelivery - - logs:ListLogDeliveries - - logs:DescribeLogGroups - - logs:DescribeResourcePolicies - - logs:PutResourcePolicy - - logs:CreateLogGroup + - cleanrooms:GetCollaboration - cleanrooms:ListTagsForResource - cleanrooms:TagResource - cleanrooms:UntagResource - - iam:PassRole + - entityresolution:GetIdNamespace + - entityresolution:AddPolicyStatement delete: - - cleanrooms:DeleteMembership + - cleanrooms:DeleteIdNamespaceAssociation + - cleanrooms:GetIdNamespaceAssociation + - cleanrooms:ListIdNamespaceAssociations - cleanrooms:GetMembership - - cleanrooms:ListMemberships + - cleanrooms:GetCollaboration - cleanrooms:ListTagsForResource - - logs:ListLogDeliveries - - logs:DescribeLogGroups - - logs:DescribeResourcePolicies - - logs:GetLogDelivery + - cleanrooms:UntagResource + - entityresolution:GetIdNamespace + - entityresolution:DeletePolicyStatement list: - - cleanrooms:ListMemberships - x-stackQL-resources: - analysis_templates: - name: analysis_templates - id: awscc.cleanrooms.analysis_templates - x-cfn-schema-name: AnalysisTemplate - x-type: list - x-identifiers: - - AnalysisTemplateIdentifier - - MembershipIdentifier - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AnalysisTemplateIdentifier') as analysis_template_identifier, - JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + - cleanrooms:ListIdNamespaceAssociations + - cleanrooms:GetMembership + - cleanrooms:GetCollaboration + MembershipQueryLogStatus: + type: string + enum: + - ENABLED + - DISABLED + MembershipJobLogStatus: + type: string + enum: + - ENABLED + - DISABLED + MembershipStatus: + type: string + enum: + - ACTIVE + - REMOVED + - COLLABORATION_DELETED + ResultFormat: + type: string + enum: + - CSV + - PARQUET + ProtectedQueryS3OutputConfiguration: + type: object + additionalProperties: false + properties: + ResultFormat: + $ref: '#/components/schemas/ResultFormat' + Bucket: + type: string + minLength: 3 + maxLength: 63 + KeyPrefix: + type: string + SingleFileOutput: + type: boolean + required: + - ResultFormat + - Bucket + ProtectedJobS3OutputConfigurationInput: + type: object + additionalProperties: false + properties: + Bucket: + type: string + minLength: 3 + maxLength: 63 + KeyPrefix: + type: string + required: + - Bucket + MembershipProtectedQueryOutputConfiguration: + type: object + additionalProperties: false + properties: + S3: + $ref: '#/components/schemas/ProtectedQueryS3OutputConfiguration' + required: + - S3 + MembershipProtectedJobOutputConfiguration: + type: object + additionalProperties: false + properties: + S3: + $ref: '#/components/schemas/ProtectedJobS3OutputConfigurationInput' + required: + - S3 + MembershipProtectedQueryResultConfiguration: + type: object + additionalProperties: false + properties: + OutputConfiguration: + $ref: '#/components/schemas/MembershipProtectedQueryOutputConfiguration' + RoleArn: + type: string + minLength: 32 + maxLength: 512 + required: + - OutputConfiguration + MembershipProtectedJobResultConfiguration: + type: object + additionalProperties: false + properties: + OutputConfiguration: + $ref: '#/components/schemas/MembershipProtectedJobOutputConfiguration' + RoleArn: + type: string + minLength: 32 + maxLength: 512 + required: + - OutputConfiguration + - RoleArn + MembershipPaymentConfiguration: + type: object + additionalProperties: false + properties: + QueryCompute: + $ref: '#/components/schemas/MembershipQueryComputePaymentConfig' + MachineLearning: + $ref: '#/components/schemas/MembershipMLPaymentConfig' + JobCompute: + $ref: '#/components/schemas/MembershipJobComputePaymentConfig' + required: + - QueryCompute + MembershipQueryComputePaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible + MembershipMLPaymentConfig: + type: object + additionalProperties: false + properties: + ModelTraining: + $ref: '#/components/schemas/MembershipModelTrainingPaymentConfig' + ModelInference: + $ref: '#/components/schemas/MembershipModelInferencePaymentConfig' + MembershipModelTrainingPaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible + MembershipModelInferencePaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible + MembershipJobComputePaymentConfig: + type: object + additionalProperties: false + properties: + IsResponsible: + type: boolean + required: + - IsResponsible + Membership: + type: object + properties: + Arn: + type: string + maxLength: 100 + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms membership. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + type: array + CollaborationArn: + type: string + maxLength: 100 + CollaborationCreatorAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^\d+$ + CollaborationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + MembershipIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + QueryLogStatus: + $ref: '#/components/schemas/MembershipQueryLogStatus' + JobLogStatus: + $ref: '#/components/schemas/MembershipJobLogStatus' + DefaultResultConfiguration: + $ref: '#/components/schemas/MembershipProtectedQueryResultConfiguration' + DefaultJobResultConfiguration: + $ref: '#/components/schemas/MembershipProtectedJobResultConfiguration' + PaymentConfiguration: + $ref: '#/components/schemas/MembershipPaymentConfiguration' + required: + - CollaborationIdentifier + - QueryLogStatus + x-stackql-resource-name: membership + description: Represents an AWS account that is a part of a collaboration + x-type-name: AWS::CleanRooms::Membership + x-stackql-primary-identifier: + - MembershipIdentifier + x-create-only-properties: + - CollaborationIdentifier + x-read-only-properties: + - Arn + - CollaborationArn + - CollaborationCreatorAccountId + - MembershipIdentifier + x-required-properties: + - CollaborationIdentifier + - QueryLogStatus + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource + x-required-permissions: + create: + - cleanrooms:CreateMembership + - logs:CreateLogDelivery + - logs:GetLogDelivery + - logs:UpdateLogDelivery + - logs:DeleteLogDelivery + - logs:ListLogDeliveries + - logs:DescribeLogGroups + - logs:DescribeResourcePolicies + - logs:PutResourcePolicy + - logs:CreateLogGroup + - cleanrooms:GetMembership + - cleanrooms:ListTagsForResource + - cleanrooms:TagResource + - cleanrooms:ListMemberships + - iam:PassRole + read: + - cleanrooms:GetMembership + - cleanrooms:ListTagsForResource + - logs:ListLogDeliveries + - logs:DescribeLogGroups + - logs:DescribeResourcePolicies + - logs:GetLogDelivery + update: + - cleanrooms:UpdateMembership + - cleanrooms:GetMembership + - logs:CreateLogDelivery + - logs:GetLogDelivery + - logs:UpdateLogDelivery + - logs:DeleteLogDelivery + - logs:ListLogDeliveries + - logs:DescribeLogGroups + - logs:DescribeResourcePolicies + - logs:PutResourcePolicy + - logs:CreateLogGroup + - cleanrooms:ListTagsForResource + - cleanrooms:TagResource + - cleanrooms:UntagResource + - iam:PassRole + delete: + - cleanrooms:DeleteMembership + - cleanrooms:GetMembership + - cleanrooms:ListMemberships + - cleanrooms:ListTagsForResource + - logs:ListLogDeliveries + - logs:DescribeLogGroups + - logs:DescribeResourcePolicies + - logs:GetLogDelivery + list: + - cleanrooms:ListMemberships + PrivacyBudgetTemplate: + type: object + properties: + Arn: + type: string + maxLength: 200 + CollaborationArn: + type: string + maxLength: 100 + CollaborationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + PrivacyBudgetTemplateIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array + AutoRefresh: + type: string + enum: + - CALENDAR_MONTH + - NONE + PrivacyBudgetType: + type: string + enum: + - DIFFERENTIAL_PRIVACY + Parameters: + type: object + additionalProperties: false + properties: + Epsilon: + type: integer + minimum: 1 + maximum: 20 + UsersNoisePerQuery: + type: integer + minimum: 10 + maximum: 100 + required: + - Epsilon + - UsersNoisePerQuery + MembershipArn: + type: string + maxLength: 100 + MembershipIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + required: + - AutoRefresh + - PrivacyBudgetType + - Parameters + - MembershipIdentifier + x-stackql-resource-name: privacy_budget_template + description: Represents a privacy budget within a collaboration + x-type-name: AWS::CleanRooms::PrivacyBudgetTemplate + x-stackql-primary-identifier: + - PrivacyBudgetTemplateIdentifier + - MembershipIdentifier + x-create-only-properties: + - MembershipIdentifier + - PrivacyBudgetType + - AutoRefresh + x-read-only-properties: + - CollaborationArn + - CollaborationIdentifier + - PrivacyBudgetTemplateIdentifier + - Arn + - MembershipArn + x-required-properties: + - AutoRefresh + - PrivacyBudgetType + - Parameters + - MembershipIdentifier + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + - cleanrooms:TagResource + x-required-permissions: + create: + - cleanrooms:CreatePrivacyBudgetTemplate + - cleanrooms:ListTagsForResource + - cleanrooms:TagResource + - cleanrooms:GetPrivacyBudgetTemplate + - cleanrooms:ListPrivacyBudgetTemplates + read: + - cleanrooms:GetPrivacyBudgetTemplate + - cleanrooms:ListTagsForResource + update: + - cleanrooms:UpdatePrivacyBudgetTemplate + - cleanrooms:GetPrivacyBudgetTemplate + - cleanrooms:ListTagsForResource + - cleanrooms:TagResource + - cleanrooms:UntagResource + delete: + - cleanrooms:DeletePrivacyBudgetTemplate + - cleanrooms:GetPrivacyBudgetTemplate + - cleanrooms:ListPrivacyBudgetTemplates + - cleanrooms:ListTagsForResource + - cleanrooms:UntagResource + list: + - cleanrooms:ListPrivacyBudgetTemplates + CreateAnalysisTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 200 + CollaborationArn: + type: string + maxLength: 100 + CollaborationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array + AnalysisParameters: + description: The member who can query can provide this placeholder for a literal data value in an analysis template + x-insertionOrder: false + items: + $ref: '#/components/schemas/AnalysisParameter' + type: array + minItems: 0 + maxItems: 10 + AnalysisTemplateIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + MembershipArn: + type: string + maxLength: 100 + MembershipIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Name: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$ + Schema: + $ref: '#/components/schemas/AnalysisSchema' + Source: + $ref: '#/components/schemas/AnalysisSource' + SourceMetadata: + $ref: '#/components/schemas/AnalysisSourceMetadata' + Format: + type: string + enum: + - SQL + - PYSPARK_1_0 + x-stackQL-stringOnly: true + x-title: CreateAnalysisTemplateRequest + type: object + required: [] + CreateCollaborationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 100 + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + type: array + CollaborationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + CreatorDisplayName: + $ref: '#/components/schemas/Name' + CreatorMemberAbilities: + $ref: '#/components/schemas/MemberAbilities' + CreatorMLMemberAbilities: + $ref: '#/components/schemas/MLMemberAbilities' + DataEncryptionMetadata: + $ref: '#/components/schemas/DataEncryptionMetadata' + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + Members: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/MemberSpecification' + maxItems: 9 + minItems: 0 + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + JobLogStatus: + $ref: '#/components/schemas/CollaborationJobLogStatus' + QueryLogStatus: + $ref: '#/components/schemas/CollaborationQueryLogStatus' + AnalyticsEngine: + $ref: '#/components/schemas/AnalyticsEngine' + CreatorPaymentConfiguration: + $ref: '#/components/schemas/PaymentConfiguration' + x-stackQL-stringOnly: true + x-title: CreateCollaborationRequest + type: object + required: [] + CreateConfiguredTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 100 + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + type: array + AllowedColumns: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 128 + pattern: ^[a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?$ + maxItems: 100 + minItems: 1 + AnalysisMethod: + $ref: '#/components/schemas/AnalysisMethod' + SelectedAnalysisMethods: + $ref: '#/components/schemas/SelectedAnalysisMethods' + ConfiguredTableIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + AnalysisRules: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AnalysisRule' + maxItems: 1 + minItems: 1 + TableReference: + $ref: '#/components/schemas/TableReference' + x-stackQL-stringOnly: true + x-title: CreateConfiguredTableRequest + type: object + required: [] + CreateConfiguredTableAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 256 + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array + ConfiguredTableAssociationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + ConfiguredTableIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + MembershipIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Name: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$ + RoleArn: + type: string + maxLength: 512 + minLength: 32 + ConfiguredTableAssociationAnalysisRules: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ConfiguredTableAssociationAnalysisRule' + maxItems: 1 + minItems: 1 + x-stackQL-stringOnly: true + x-title: CreateConfiguredTableAssociationRequest + type: object + required: [] + CreateIdMappingTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdMappingTableIdentifier: + $ref: '#/components/schemas/UUID' + Arn: + type: string + maxLength: 200 + InputReferenceConfig: + $ref: '#/components/schemas/IdMappingTableInputReferenceConfig' + MembershipIdentifier: + $ref: '#/components/schemas/UUID' + MembershipArn: + type: string + maxLength: 100 + CollaborationIdentifier: + $ref: '#/components/schemas/UUID' + CollaborationArn: + type: string + maxLength: 100 + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + Name: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$ + InputReferenceProperties: + $ref: '#/components/schemas/IdMappingTableInputReferenceProperties' + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 4 + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateIdMappingTableRequest + type: object + required: [] + CreateIdNamespaceAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdNamespaceAssociationIdentifier: + $ref: '#/components/schemas/UUID' + Arn: + type: string + maxLength: 256 + MembershipIdentifier: + $ref: '#/components/schemas/UUID' + MembershipArn: + type: string + maxLength: 100 + CollaborationIdentifier: + $ref: '#/components/schemas/UUID' + CollaborationArn: + type: string + maxLength: 100 + InputReferenceConfig: + $ref: '#/components/schemas/IdNamespaceAssociationInputReferenceConfig' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + IdMappingConfig: + $ref: '#/components/schemas/IdMappingConfig' + InputReferenceProperties: + $ref: '#/components/schemas/IdNamespaceAssociationInputReferenceProperties' + x-stackQL-stringOnly: true + x-title: CreateIdNamespaceAssociationRequest + type: object + required: [] + CreateMembershipRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 100 + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms membership. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + type: array + CollaborationArn: + type: string + maxLength: 100 + CollaborationCreatorAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^\d+$ + CollaborationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + MembershipIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + QueryLogStatus: + $ref: '#/components/schemas/MembershipQueryLogStatus' + JobLogStatus: + $ref: '#/components/schemas/MembershipJobLogStatus' + DefaultResultConfiguration: + $ref: '#/components/schemas/MembershipProtectedQueryResultConfiguration' + DefaultJobResultConfiguration: + $ref: '#/components/schemas/MembershipProtectedJobResultConfiguration' + PaymentConfiguration: + $ref: '#/components/schemas/MembershipPaymentConfiguration' + x-stackQL-stringOnly: true + x-title: CreateMembershipRequest + type: object + required: [] + CreatePrivacyBudgetTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 200 + CollaborationArn: + type: string + maxLength: 100 + CollaborationIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + PrivacyBudgetTemplateIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array + AutoRefresh: + type: string + enum: + - CALENDAR_MONTH + - NONE + PrivacyBudgetType: + type: string + enum: + - DIFFERENTIAL_PRIVACY + Parameters: + type: object + additionalProperties: false + properties: + Epsilon: + type: integer + minimum: 1 + maximum: 20 + UsersNoisePerQuery: + type: integer + minimum: 10 + maximum: 100 + required: + - Epsilon + - UsersNoisePerQuery + MembershipArn: + type: string + maxLength: 100 + MembershipIdentifier: + type: string + maxLength: 36 + minLength: 36 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' + x-stackQL-stringOnly: true + x-title: CreatePrivacyBudgetTemplateRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + analysis_templates: + name: analysis_templates + id: awscc.cleanrooms.analysis_templates + x-cfn-schema-name: AnalysisTemplate + x-cfn-type-name: AWS::CleanRooms::AnalysisTemplate + x-identifiers: + - AnalysisTemplateIdentifier + - MembershipIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AnalysisTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::AnalysisTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::AnalysisTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::AnalysisTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CollaborationArn') as collaboration_arn, + JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AnalysisParameters') as analysis_parameters, + JSON_EXTRACT(Properties, '$.AnalysisTemplateIdentifier') as analysis_template_identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.MembershipArn') as membership_arn, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Schema') as _schema, + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.SourceMetadata') as source_metadata, + JSON_EXTRACT(Properties, '$.Format') as _format + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AnalysisParameters') as analysis_parameters, + json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MembershipArn') as membership_arn, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'SourceMetadata') as source_metadata, + json_extract_path_text(Properties, 'Format') as _format + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + analysis_templates_list_only: + name: analysis_templates_list_only + id: awscc.cleanrooms.analysis_templates_list_only + x-cfn-schema-name: AnalysisTemplate + x-cfn-type-name: AWS::CleanRooms::AnalysisTemplate + x-identifiers: + - AnalysisTemplateIdentifier + - MembershipIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AnalysisTemplateIdentifier') as analysis_template_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + AND region = 'us-east-1' + collaborations: + name: collaborations + id: awscc.cleanrooms.collaborations + x-cfn-schema-name: Collaboration + x-cfn-type-name: AWS::CleanRooms::Collaboration + x-identifiers: + - CollaborationIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Collaboration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::Collaboration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::Collaboration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::Collaboration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/collaborations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/collaborations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/collaborations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, + JSON_EXTRACT(Properties, '$.CreatorDisplayName') as creator_display_name, + JSON_EXTRACT(Properties, '$.CreatorMemberAbilities') as creator_member_abilities, + JSON_EXTRACT(Properties, '$.CreatorMLMemberAbilities') as creator_ml_member_abilities, + JSON_EXTRACT(Properties, '$.DataEncryptionMetadata') as data_encryption_metadata, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Members') as members, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.JobLogStatus') as job_log_status, + JSON_EXTRACT(Properties, '$.QueryLogStatus') as query_log_status, + JSON_EXTRACT(Properties, '$.AnalyticsEngine') as analytics_engine, + JSON_EXTRACT(Properties, '$.CreatorPaymentConfiguration') as creator_payment_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'CreatorDisplayName') as creator_display_name, + json_extract_path_text(Properties, 'CreatorMemberAbilities') as creator_member_abilities, + json_extract_path_text(Properties, 'CreatorMLMemberAbilities') as creator_ml_member_abilities, + json_extract_path_text(Properties, 'DataEncryptionMetadata') as data_encryption_metadata, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Members') as members, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'JobLogStatus') as job_log_status, + json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, + json_extract_path_text(Properties, 'AnalyticsEngine') as analytics_engine, + json_extract_path_text(Properties, 'CreatorPaymentConfiguration') as creator_payment_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + AND data__Identifier = '' + AND region = 'us-east-1' + collaborations_list_only: + name: collaborations_list_only + id: awscc.cleanrooms.collaborations_list_only + x-cfn-schema-name: Collaboration + x-cfn-type-name: AWS::CleanRooms::Collaboration + x-identifiers: + - CollaborationIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + AND region = 'us-east-1' + configured_tables: + name: configured_tables + id: awscc.cleanrooms.configured_tables + x-cfn-schema-name: ConfiguredTable + x-cfn-type-name: AWS::CleanRooms::ConfiguredTable + x-identifiers: + - ConfiguredTableIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfiguredTable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::ConfiguredTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::ConfiguredTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::ConfiguredTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configured_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configured_tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configured_tables/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AllowedColumns') as allowed_columns, + JSON_EXTRACT(Properties, '$.AnalysisMethod') as analysis_method, + JSON_EXTRACT(Properties, '$.SelectedAnalysisMethods') as selected_analysis_methods, + JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.AnalysisRules') as analysis_rules, + JSON_EXTRACT(Properties, '$.TableReference') as table_reference + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AllowedColumns') as allowed_columns, + json_extract_path_text(Properties, 'AnalysisMethod') as analysis_method, + json_extract_path_text(Properties, 'SelectedAnalysisMethods') as selected_analysis_methods, + json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AnalysisRules') as analysis_rules, + json_extract_path_text(Properties, 'TableReference') as table_reference + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' + AND data__Identifier = '' + AND region = 'us-east-1' + configured_tables_list_only: + name: configured_tables_list_only + id: awscc.cleanrooms.configured_tables_list_only + x-cfn-schema-name: ConfiguredTable + x-cfn-type-name: AWS::CleanRooms::ConfiguredTable + x-identifiers: + - ConfiguredTableIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' AND region = 'us-east-1' - analysis_template: - name: analysis_template - id: awscc.cleanrooms.analysis_template - x-cfn-schema-name: AnalysisTemplate - x-type: get + configured_table_associations: + name: configured_table_associations + id: awscc.cleanrooms.configured_table_associations + x-cfn-schema-name: ConfiguredTableAssociation + x-cfn-type-name: AWS::CleanRooms::ConfiguredTableAssociation x-identifiers: - - AnalysisTemplateIdentifier + - ConfiguredTableAssociationIdentifier - MembershipIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfiguredTableAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::ConfiguredTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::ConfiguredTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::ConfiguredTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.CollaborationArn') as collaboration_arn, - JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.AnalysisParameters') as analysis_parameters, - JSON_EXTRACT(Properties, '$.AnalysisTemplateIdentifier') as analysis_template_identifier, + JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.MembershipArn') as membership_arn, JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Schema') as _schema, - JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.Format') as _format - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationAnalysisRules') as configured_table_association_analysis_rules + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AnalysisParameters') as analysis_parameters, - json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, + json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'MembershipArn') as membership_arn, json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Format') as _format - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'ConfiguredTableAssociationAnalysisRules') as configured_table_association_analysis_rules + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' - collaborations: - name: collaborations - id: awscc.cleanrooms.collaborations - x-cfn-schema-name: Collaboration - x-type: list + configured_table_associations_list_only: + name: configured_table_associations_list_only + id: awscc.cleanrooms.configured_table_associations_list_only + x-cfn-schema-name: ConfiguredTableAssociation + x-cfn-type-name: AWS::CleanRooms::ConfiguredTableAssociation x-identifiers: - - CollaborationIdentifier + - ConfiguredTableAssociationIdentifier + - MembershipIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1084,73 +3423,133 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' AND region = 'us-east-1' - collaboration: - name: collaboration - id: awscc.cleanrooms.collaboration - x-cfn-schema-name: Collaboration - x-type: get + id_mapping_tables: + name: id_mapping_tables + id: awscc.cleanrooms.id_mapping_tables + x-cfn-schema-name: IdMappingTable + x-cfn-type-name: AWS::CleanRooms::IdMappingTable x-identifiers: - - CollaborationIdentifier + - IdMappingTableIdentifier + - MembershipIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdMappingTable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::IdMappingTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::IdMappingTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::IdMappingTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/id_mapping_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/id_mapping_tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/id_mapping_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.IdMappingTableIdentifier') as id_mapping_table_identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.InputReferenceConfig') as input_reference_config, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier, + JSON_EXTRACT(Properties, '$.MembershipArn') as membership_arn, JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, - JSON_EXTRACT(Properties, '$.CreatorDisplayName') as creator_display_name, - JSON_EXTRACT(Properties, '$.CreatorMemberAbilities') as creator_member_abilities, - JSON_EXTRACT(Properties, '$.DataEncryptionMetadata') as data_encryption_metadata, + JSON_EXTRACT(Properties, '$.CollaborationArn') as collaboration_arn, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Members') as members, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.QueryLogStatus') as query_log_status, - JSON_EXTRACT(Properties, '$.CreatorPaymentConfiguration') as creator_payment_configuration - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InputReferenceProperties') as input_reference_properties, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::IdMappingTable' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'IdMappingTableIdentifier') as id_mapping_table_identifier, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'InputReferenceConfig') as input_reference_config, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, + json_extract_path_text(Properties, 'MembershipArn') as membership_arn, json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, - json_extract_path_text(Properties, 'CreatorDisplayName') as creator_display_name, - json_extract_path_text(Properties, 'CreatorMemberAbilities') as creator_member_abilities, - json_extract_path_text(Properties, 'DataEncryptionMetadata') as data_encryption_metadata, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Members') as members, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, - json_extract_path_text(Properties, 'CreatorPaymentConfiguration') as creator_payment_configuration - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' - AND data__Identifier = '' + json_extract_path_text(Properties, 'InputReferenceProperties') as input_reference_properties, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::IdMappingTable' + AND data__Identifier = '|' AND region = 'us-east-1' - configured_tables: - name: configured_tables - id: awscc.cleanrooms.configured_tables - x-cfn-schema-name: ConfiguredTable - x-type: list + id_mapping_tables_list_only: + name: id_mapping_tables_list_only + id: awscc.cleanrooms.id_mapping_tables_list_only + x-cfn-schema-name: IdMappingTable + x-cfn-type-name: AWS::CleanRooms::IdMappingTable x-identifiers: - - ConfiguredTableIdentifier + - IdMappingTableIdentifier + - MembershipIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1158,70 +3557,133 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' + JSON_EXTRACT(Properties, '$.IdMappingTableIdentifier') as id_mapping_table_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::IdMappingTable' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' + json_extract_path_text(Properties, 'IdMappingTableIdentifier') as id_mapping_table_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::IdMappingTable' AND region = 'us-east-1' - configured_table: - name: configured_table - id: awscc.cleanrooms.configured_table - x-cfn-schema-name: ConfiguredTable - x-type: get + id_namespace_associations: + name: id_namespace_associations + id: awscc.cleanrooms.id_namespace_associations + x-cfn-schema-name: IdNamespaceAssociation + x-cfn-type-name: AWS::CleanRooms::IdNamespaceAssociation x-identifiers: - - ConfiguredTableIdentifier + - IdNamespaceAssociationIdentifier + - MembershipIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdNamespaceAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::IdNamespaceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::IdNamespaceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::IdNamespaceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/id_namespace_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/id_namespace_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/id_namespace_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.IdNamespaceAssociationIdentifier') as id_namespace_association_identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier, + JSON_EXTRACT(Properties, '$.MembershipArn') as membership_arn, + JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, + JSON_EXTRACT(Properties, '$.CollaborationArn') as collaboration_arn, + JSON_EXTRACT(Properties, '$.InputReferenceConfig') as input_reference_config, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.AllowedColumns') as allowed_columns, - JSON_EXTRACT(Properties, '$.AnalysisMethod') as analysis_method, - JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier, - JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.AnalysisRules') as analysis_rules, - JSON_EXTRACT(Properties, '$.TableReference') as table_reference - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.IdMappingConfig') as id_mapping_config, + JSON_EXTRACT(Properties, '$.InputReferenceProperties') as input_reference_properties + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::IdNamespaceAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'IdNamespaceAssociationIdentifier') as id_namespace_association_identifier, json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, + json_extract_path_text(Properties, 'MembershipArn') as membership_arn, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, + json_extract_path_text(Properties, 'InputReferenceConfig') as input_reference_config, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AllowedColumns') as allowed_columns, - json_extract_path_text(Properties, 'AnalysisMethod') as analysis_method, - json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, - json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AnalysisRules') as analysis_rules, - json_extract_path_text(Properties, 'TableReference') as table_reference - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IdMappingConfig') as id_mapping_config, + json_extract_path_text(Properties, 'InputReferenceProperties') as input_reference_properties + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::IdNamespaceAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' - configured_table_associations: - name: configured_table_associations - id: awscc.cleanrooms.configured_table_associations - x-cfn-schema-name: ConfiguredTableAssociation - x-type: list + id_namespace_associations_list_only: + name: id_namespace_associations_list_only + id: awscc.cleanrooms.id_namespace_associations_list_only + x-cfn-schema-name: IdNamespaceAssociation + x-cfn-type-name: AWS::CleanRooms::IdNamespaceAssociation x-identifiers: - - ConfiguredTableAssociationIdentifier + - IdNamespaceAssociationIdentifier - MembershipIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1229,70 +3691,129 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + JSON_EXTRACT(Properties, '$.IdNamespaceAssociationIdentifier') as id_namespace_association_identifier, JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::IdNamespaceAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + json_extract_path_text(Properties, 'IdNamespaceAssociationIdentifier') as id_namespace_association_identifier, json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::IdNamespaceAssociation' AND region = 'us-east-1' - configured_table_association: - name: configured_table_association - id: awscc.cleanrooms.configured_table_association - x-cfn-schema-name: ConfiguredTableAssociation - x-type: get + memberships: + name: memberships + id: awscc.cleanrooms.memberships + x-cfn-schema-name: Membership + x-cfn-type-name: AWS::CleanRooms::Membership x-identifiers: - - ConfiguredTableAssociationIdentifier - MembershipIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Membership&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::Membership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::Membership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::Membership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/memberships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/memberships/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/memberships/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, - JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier, - JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.CollaborationArn') as collaboration_arn, + JSON_EXTRACT(Properties, '$.CollaborationCreatorAccountId') as collaboration_creator_account_id, + JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.QueryLogStatus') as query_log_status, + JSON_EXTRACT(Properties, '$.JobLogStatus') as job_log_status, + JSON_EXTRACT(Properties, '$.DefaultResultConfiguration') as default_result_configuration, + JSON_EXTRACT(Properties, '$.DefaultJobResultConfiguration') as default_job_result_configuration, + JSON_EXTRACT(Properties, '$.PaymentConfiguration') as payment_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Membership' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, - json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, - json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, + json_extract_path_text(Properties, 'CollaborationCreatorAccountId') as collaboration_creator_account_id, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, + json_extract_path_text(Properties, 'JobLogStatus') as job_log_status, + json_extract_path_text(Properties, 'DefaultResultConfiguration') as default_result_configuration, + json_extract_path_text(Properties, 'DefaultJobResultConfiguration') as default_job_result_configuration, + json_extract_path_text(Properties, 'PaymentConfiguration') as payment_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Membership' + AND data__Identifier = '' AND region = 'us-east-1' - memberships: - name: memberships - id: awscc.cleanrooms.memberships + memberships_list_only: + name: memberships_list_only + id: awscc.cleanrooms.memberships_list_only x-cfn-schema-name: Membership - x-type: list + x-cfn-type-name: AWS::CleanRooms::Membership x-identifiers: - MembershipIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1311,48 +3832,622 @@ components: json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Membership' AND region = 'us-east-1' - membership: - name: membership - id: awscc.cleanrooms.membership - x-cfn-schema-name: Membership - x-type: get + privacy_budget_templates: + name: privacy_budget_templates + id: awscc.cleanrooms.privacy_budget_templates + x-cfn-schema-name: PrivacyBudgetTemplate + x-cfn-type-name: AWS::CleanRooms::PrivacyBudgetTemplate x-identifiers: + - PrivacyBudgetTemplateIdentifier - MembershipIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PrivacyBudgetTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::PrivacyBudgetTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::PrivacyBudgetTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRooms::PrivacyBudgetTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.CollaborationArn') as collaboration_arn, - JSON_EXTRACT(Properties, '$.CollaborationCreatorAccountId') as collaboration_creator_account_id, JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier, - JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier, - JSON_EXTRACT(Properties, '$.QueryLogStatus') as query_log_status, - JSON_EXTRACT(Properties, '$.DefaultResultConfiguration') as default_result_configuration, - JSON_EXTRACT(Properties, '$.PaymentConfiguration') as payment_configuration - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Membership' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AutoRefresh') as auto_refresh, + JSON_EXTRACT(Properties, '$.PrivacyBudgetType') as privacy_budget_type, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.MembershipArn') as membership_arn, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, - json_extract_path_text(Properties, 'CollaborationCreatorAccountId') as collaboration_creator_account_id, json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, - json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, - json_extract_path_text(Properties, 'DefaultResultConfiguration') as default_result_configuration, - json_extract_path_text(Properties, 'PaymentConfiguration') as payment_configuration - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Membership' - AND data__Identifier = '' + json_extract_path_text(Properties, 'PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AutoRefresh') as auto_refresh, + json_extract_path_text(Properties, 'PrivacyBudgetType') as privacy_budget_type, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'MembershipArn') as membership_arn, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + privacy_budget_templates_list_only: + name: privacy_budget_templates_list_only + id: awscc.cleanrooms.privacy_budget_templates_list_only + x-cfn-schema-name: PrivacyBudgetTemplate + x-cfn-type-name: AWS::CleanRooms::PrivacyBudgetTemplate + x-identifiers: + - PrivacyBudgetTemplateIdentifier + - MembershipIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AnalysisTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnalysisTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnalysisTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Collaboration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCollaboration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCollaborationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfiguredTable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfiguredTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfiguredTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfiguredTableAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfiguredTableAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfiguredTableAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdMappingTable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdMappingTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdMappingTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdNamespaceAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdNamespaceAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdNamespaceAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Membership&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMembership + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMembershipRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PrivacyBudgetTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrivacyBudgetTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePrivacyBudgetTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cleanroomsml.yaml b/providers/src/awscc/v00.00.00000/services/cleanroomsml.yaml new file mode 100644 index 00000000..1d8d8e77 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/cleanroomsml.yaml @@ -0,0 +1,951 @@ +openapi: 3.0.0 +info: + title: CleanRoomsML + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ColumnSchema: + type: object + properties: + ColumnName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$ + ColumnTypes: + type: array + items: + $ref: '#/components/schemas/ColumnType' + maxItems: 1 + minItems: 1 + required: + - ColumnName + - ColumnTypes + additionalProperties: false + ColumnType: + type: string + enum: + - USER_ID + - ITEM_ID + - TIMESTAMP + - CATEGORICAL_FEATURE + - NUMERICAL_FEATURE + DataSource: + type: object + properties: + GlueDataSource: + $ref: '#/components/schemas/GlueDataSource' + required: + - GlueDataSource + additionalProperties: false + Dataset: + type: object + properties: + Type: + $ref: '#/components/schemas/DatasetType' + InputConfig: + $ref: '#/components/schemas/DatasetInputConfig' + required: + - InputConfig + - Type + additionalProperties: false + DatasetInputConfig: + type: object + properties: + Schema: + type: array + items: + $ref: '#/components/schemas/ColumnSchema' + maxItems: 100 + minItems: 1 + DataSource: + $ref: '#/components/schemas/DataSource' + required: + - DataSource + - Schema + additionalProperties: false + DatasetType: + type: string + enum: + - INTERACTIONS + GlueDataSource: + type: object + properties: + TableName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$ + DatabaseName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$ + CatalogId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + required: + - DatabaseName + - TableName + additionalProperties: false + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + Value: + type: string + minLength: 1 + maxLength: 256 + required: + - Value + - Key + TrainingDatasetStatus: + type: string + enum: + - ACTIVE + Unit: + type: object + additionalProperties: false + TrainingDataset: + type: object + properties: + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + Name: + type: string + maxLength: 63 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$ + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + type: array + TrainingData: + type: array + items: + $ref: '#/components/schemas/Dataset' + maxItems: 1 + minItems: 1 + TrainingDatasetArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$ + Status: + $ref: '#/components/schemas/TrainingDatasetStatus' + required: + - Name + - RoleArn + - TrainingData + x-stackql-resource-name: training_dataset + description: Definition of AWS::CleanRoomsML::TrainingDataset Resource Type + x-type-name: AWS::CleanRoomsML::TrainingDataset + x-stackql-primary-identifier: + - TrainingDatasetArn + x-create-only-properties: + - Description + - Name + - RoleArn + - TrainingData + x-read-only-properties: + - Status + - TrainingDatasetArn + x-required-properties: + - Name + - RoleArn + - TrainingData + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cleanrooms-ml:TagResource + - cleanrooms-ml:UntagResource + x-required-permissions: + create: + - cleanrooms-ml:CreateTrainingDataset + - cleanrooms-ml:GetTrainingDataset + - cleanrooms-ml:TagResource + - iam:PassRole + read: + - cleanrooms-ml:GetTrainingDataset + delete: + - cleanrooms-ml:DeleteTrainingDataset + list: + - cleanrooms-ml:ListTrainingDatasets + update: + - cleanrooms-ml:TagResource + - cleanrooms-ml:UntagResource + CreateTrainingDatasetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 255 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$ + Name: + type: string + maxLength: 63 + minLength: 1 + pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$ + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$ + Tags: + description: An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + type: array + TrainingData: + type: array + items: + $ref: '#/components/schemas/Dataset' + maxItems: 1 + minItems: 1 + TrainingDatasetArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$ + Status: + $ref: '#/components/schemas/TrainingDatasetStatus' + x-stackQL-stringOnly: true + x-title: CreateTrainingDatasetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + training_datasets: + name: training_datasets + id: awscc.cleanroomsml.training_datasets + x-cfn-schema-name: TrainingDataset + x-cfn-type-name: AWS::CleanRoomsML::TrainingDataset + x-identifiers: + - TrainingDatasetArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrainingDataset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRoomsML::TrainingDataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRoomsML::TrainingDataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CleanRoomsML::TrainingDataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/training_datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/training_datasets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/training_datasets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TrainingData') as training_data, + JSON_EXTRACT(Properties, '$.TrainingDatasetArn') as training_dataset_arn, + JSON_EXTRACT(Properties, '$.Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrainingData') as training_data, + json_extract_path_text(Properties, 'TrainingDatasetArn') as training_dataset_arn, + json_extract_path_text(Properties, 'Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' + AND data__Identifier = '' + AND region = 'us-east-1' + training_datasets_list_only: + name: training_datasets_list_only + id: awscc.cleanroomsml.training_datasets_list_only + x-cfn-schema-name: TrainingDataset + x-cfn-type-name: AWS::CleanRoomsML::TrainingDataset + x-identifiers: + - TrainingDatasetArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TrainingDatasetArn') as training_dataset_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrainingDatasetArn') as training_dataset_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrainingDataset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrainingDataset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrainingDatasetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cloud_control.yaml b/providers/src/awscc/v00.00.00000/services/cloud_control.yaml index 443ebb5d..abb4a24d 100644 --- a/providers/src/awscc/v00.00.00000/services/cloud_control.yaml +++ b/providers/src/awscc/v00.00.00000/services/cloud_control.yaml @@ -525,6 +525,9 @@ components: x-stackQL-resources: resource: name: resource + x-cfn-schema-name: ResourceDescription + x-example-where-clause: WHERE region = 'us-east-1' AND data__TypeName = '' AND data__Identifier = '' + x-type: native methods: get_resource: operation: @@ -545,6 +548,10 @@ components: title: resource resources: name: resources + x-cfn-schema-name: ResourceDescriptions + x-example-where-clause: WHERE region = 'us-east-1' AND data__TypeName = '' + x-description: 'For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.' + x-type: native methods: list_resources: operation: @@ -592,6 +599,10 @@ components: title: resources resource_request: name: resource_request + x-cfn-schema-name: ProgressEvent + x-example-where-clause: WHERE region = 'us-east-1' AND data__RequestToken = '' + x-description: 'For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.' + x-type: native methods: get_resource_request: operation: @@ -612,6 +623,10 @@ components: title: resource_request resource_requests: name: resource_requests + x-cfn-schema-name: ResourceRequestStatusSummaries + x-example-where-clause: WHERE region = 'us-east-1' AND data__ResourceRequestStatusFilter = '' + x-description: 'For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.' + x-type: native methods: list_resource_requests: operation: @@ -639,6 +654,125 @@ components: - $ref: '#/components/x-stackQL-resources/resource_requests/methods/list_resource_requests' update: [] title: resource_requests + vw_successful_requests: + name: vw_successful_requests + id: aws.cloud_control.vw_successful_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["SUCCESS"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["SUCCESS"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + vw_failed_requests: + name: vw_failed_requests + id: aws.cloud_control.vw_failed_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["FAILED"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["FAILED"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + vw_cancelled_requests: + name: vw_cancelled_requests + id: aws.cloud_control.vw_cancelled_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + vw_pending_requests: + name: vw_pending_requests + id: aws.cloud_control.vw_pending_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS"], "Operations": ["CREATE", "UPDATE", "DELETE"]}' + and region = 'us-east-1' + vw_create_requests: + name: vw_create_requests + id: aws.cloud_control.vw_create_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["CREATE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["CREATE"]}' + and region = 'us-east-1' + vw_update_requests: + name: vw_update_requests + id: aws.cloud_control.vw_update_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["UPDATE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["UPDATE"]}' + and region = 'us-east-1' + vw_delete_requests: + name: vw_delete_requests + id: aws.cloud_control.vw_delete_requests + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["DELETE"]}' + and region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + select * from aws.cloud_control.resource_requests + where data__ResourceRequestStatusFilter = '{"OperationStatuses": ["PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCEL_IN_PROGRESS", "CANCEL_COMPLETE"], "Operations": ["DELETE"]}' + and region = 'us-east-1' parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 diff --git a/providers/src/awscc/v00.00.00000/services/cloudformation.yaml b/providers/src/awscc/v00.00.00000/services/cloudformation.yaml index aab63b71..5b4a7cf1 100644 --- a/providers/src/awscc/v00.00.00000/services/cloudformation.yaml +++ b/providers/src/awscc/v00.00.00000/services/cloudformation.yaml @@ -1,10 +1,670 @@ openapi: 3.0.0 info: title: CloudFormation - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + S3Location: + description: S3 Source Location for the Guard files. + type: object + properties: + Uri: + description: S3 uri of Guard files. + type: string + VersionId: + description: S3 object version + type: string + additionalProperties: false + required: + - Uri + Role: + description: IAM Role ARN + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + maxLength: 256 + StackRole: + description: IAM Stack Role ARN filter + type: string + maxLength: 256 + anyOf: + - pattern: arn:.+:iam::[0-9]{12}:role/.+ + - pattern: ^(arn:.+:iam::((?!\*|\?)[0-9]{12}|(?=.*\*)[0-9*?]{1,12}|[0-9?]{12}):role/.+|\*)$ + StackName: + pattern: ^[a-zA-Z*?][-a-zA-Z0-9*?]*$ + description: CloudFormation Stack name + type: string + maxLength: 128 + TargetOperation: + description: Which operations should this Hook run against? Resource changes, stacks or change sets. + type: string + enum: + - RESOURCE + - STACK + - CHANGE_SET + - CLOUD_CONTROL + TargetName: + description: Type name of hook target. Hook targets are the destination where hooks will be invoked against. + type: string + pattern: ^(?!.*\*\?).*$ + minLength: 1 + maxLength: 256 + Action: + description: Target actions are the type of operation hooks will be executed at. + type: string + enum: + - CREATE + - UPDATE + - DELETE + InvocationPoint: + description: Invocation points are the point in provisioning workflow where hooks will be executed. + type: string + enum: + - PRE_PROVISION + HookTarget: + description: Hook targets are the destination where hooks will be invoked against. + type: object + properties: + TargetName: + $ref: '#/components/schemas/TargetName' + Action: + $ref: '#/components/schemas/Action' + InvocationPoint: + $ref: '#/components/schemas/InvocationPoint' + additionalProperties: false + required: + - TargetName + - Action + - InvocationPoint + GuardHook: + type: object + properties: + RuleLocation: + $ref: '#/components/schemas/S3Location' + LogBucket: + description: S3 Bucket where the guard validate report will be uploaded to + type: string + HookStatus: + default: DISABLED + description: Attribute to specify which stacks this hook applies to or should get invoked for + type: string + enum: + - ENABLED + - DISABLED + TargetOperations: + description: Which operations should this Hook run against? Resource changes, stacks or change sets. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/TargetOperation' + FailureMode: + default: WARN + description: Attribute to specify CloudFormation behavior on hook failure. + type: string + enum: + - FAIL + - WARN + TargetFilters: + description: Attribute to specify which targets should invoke the hook + type: object + oneOf: + - type: object + minProperties: 1 + properties: + TargetNames: + description: List of type names that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TargetName' + Actions: + description: List of actions that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Action' + InvocationPoints: + description: List of invocation points that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/InvocationPoint' + additionalProperties: false + - type: object + properties: + Targets: + description: List of hook targets + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/HookTarget' + additionalProperties: false + required: + - Targets + StackFilters: + description: Filters to allow hooks to target specific stack attributes + type: object + properties: + FilteringCriteria: + description: Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match + type: string + default: ALL + enum: + - ALL + - ANY + StackNames: + description: List of stack names as filters + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack names that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + Exclude: + description: List of stack names that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + StackRoles: + description: List of stack roles that are performing the stack operations. + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack roles that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + Exclude: + description: List of stack roles that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + required: + - FilteringCriteria + additionalProperties: false + Alias: + description: The typename alias for the hook. + pattern: ^(?!(?i)aws)[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + HookArn: + description: The Amazon Resource Name (ARN) of the activated hook + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + ExecutionRole: + description: The execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3. + $ref: '#/components/schemas/Role' + Options: + properties: + InputParams: + $ref: '#/components/schemas/S3Location' + required: [] + additionalProperties: false + required: + - RuleLocation + - HookStatus + - TargetOperations + - FailureMode + - Alias + - ExecutionRole + x-stackql-resource-name: guard_hook + description: This is a CloudFormation resource for activating the first-party AWS::Hooks::GuardHook. + x-type-name: AWS::CloudFormation::GuardHook + x-stackql-primary-identifier: + - HookArn + x-create-only-properties: + - ExecutionRole + - Alias + x-read-only-properties: + - HookArn + x-required-properties: + - RuleLocation + - HookStatus + - TargetOperations + - FailureMode + - Alias + - ExecutionRole + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cloudformation:ActivateType + - cloudformation:DescribeType + - cloudformation:ListTypes + - cloudformation:SetTypeConfiguration + - cloudformation:BatchDescribeTypeConfigurations + - iam:PassRole + read: + - cloudformation:DescribeType + - cloudformation:BatchDescribeTypeConfigurations + update: + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DescribeType + - cloudformation:SetTypeConfiguration + - iam:PassRole + delete: + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DescribeType + - cloudformation:DeactivateType + - cloudformation:SetTypeConfiguration + list: + - cloudformation:ListTypes + - cloudformation:DescribeType + - cloudformation:BatchDescribeTypeConfigurations HookDefaultVersion: type: object properties: @@ -28,10 +688,17 @@ components: pattern: ^[A-Za-z0-9-]{1,128}$ type: string x-stackql-resource-name: hook_default_version - x-stackql-primaryIdentifier: + description: Set a version as default version for a hook in CloudFormation Registry. + x-type-name: AWS::CloudFormation::HookDefaultVersion + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cloudformation:SetTypeDefaultVersion @@ -72,12 +739,19 @@ components: - default type: string x-stackql-resource-name: hook_type_config - x-stackql-primaryIdentifier: + description: Specifies the configuration data for a registered hook in CloudFormation Registry. + x-type-name: AWS::CloudFormation::HookTypeConfig + x-stackql-primary-identifier: - ConfigurationArn x-create-only-properties: - ConfigurationAlias x-read-only-properties: - ConfigurationArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cloudformation:SetTypeConfiguration @@ -162,19 +836,31 @@ components: - SchemaHandlerPackage - TypeName x-stackql-resource-name: hook_version - x-stackql-primaryIdentifier: + description: Publishes new or first hook version to AWS CloudFormation Registry. + x-type-name: AWS::CloudFormation::HookVersion + x-stackql-primary-identifier: - Arn x-create-only-properties: - ExecutionRoleArn - LoggingConfig - SchemaHandlerPackage - TypeName + x-write-only-properties: + - SchemaHandlerPackage x-read-only-properties: - Arn - IsDefaultVersion - Visibility - VersionId - TypeArn + x-required-properties: + - SchemaHandlerPackage + - TypeName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cloudformation:DescribeType @@ -192,6 +878,208 @@ components: list: - cloudformation:ListTypes - cloudformation:ListTypeVersions + LambdaHook: + type: object + properties: + LambdaFunction: + description: Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook. + type: string + minLength: 1 + maxLength: 170 + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? + HookStatus: + default: ENABLED + description: Attribute to specify which stacks this hook applies to or should get invoked for + type: string + enum: + - ENABLED + - DISABLED + TargetOperations: + description: Which operations should this Hook run against? Resource changes, stacks or change sets. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/TargetOperation' + FailureMode: + description: Attribute to specify CloudFormation behavior on hook failure. + type: string + enum: + - FAIL + - WARN + TargetFilters: + description: Attribute to specify which targets should invoke the hook + type: object + oneOf: + - type: object + minProperties: 1 + properties: + TargetNames: + description: List of type names that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TargetName' + Actions: + description: List of actions that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Action' + InvocationPoints: + description: List of invocation points that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/InvocationPoint' + additionalProperties: false + - type: object + properties: + Targets: + description: List of hook targets + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/HookTarget' + additionalProperties: false + required: + - Targets + StackFilters: + description: Filters to allow hooks to target specific stack attributes + type: object + properties: + FilteringCriteria: + description: Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match + type: string + default: ALL + enum: + - ALL + - ANY + StackNames: + description: List of stack names as filters + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack names that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + Exclude: + description: List of stack names that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + StackRoles: + description: List of stack roles that are performing the stack operations. + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack roles that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + Exclude: + description: List of stack roles that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + required: + - FilteringCriteria + additionalProperties: false + Alias: + description: The typename alias for the hook. + pattern: ^(?!(?i)aws)[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + HookArn: + description: The Amazon Resource Name (ARN) of the activated hook + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + ExecutionRole: + description: The execution role ARN assumed by Hooks to invoke Lambda. + $ref: '#/components/schemas/Role' + required: + - LambdaFunction + - FailureMode + - Alias + - ExecutionRole + - TargetOperations + - HookStatus + x-stackql-resource-name: lambda_hook + description: This is a CloudFormation resource for the first-party AWS::Hooks::LambdaHook. + x-type-name: AWS::CloudFormation::LambdaHook + x-stackql-primary-identifier: + - HookArn + x-create-only-properties: + - Alias + x-read-only-properties: + - HookArn + x-required-properties: + - LambdaFunction + - FailureMode + - Alias + - ExecutionRole + - TargetOperations + - HookStatus + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cloudformation:ListTypes + - cloudformation:ActivateType + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DescribeType + - cloudformation:SetTypeConfiguration + - iam:PassRole + read: + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DescribeType + update: + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DescribeType + - cloudformation:SetTypeConfiguration + - iam:PassRole + delete: + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DeactivateType + - cloudformation:DescribeType + - cloudformation:SetTypeConfiguration + list: + - cloudformation:ListTypes + - cloudformation:BatchDescribeTypeConfigurations + - cloudformation:DescribeType ModuleDefaultVersion: type: object properties: @@ -208,12 +1096,19 @@ components: pattern: ^[0-9]{8}$ type: string x-stackql-resource-name: module_default_version - x-stackql-primaryIdentifier: + description: A module that has been registered in the CloudFormation registry as the default version + x-type-name: AWS::CloudFormation::ModuleDefaultVersion + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ModuleName x-create-only-properties: - Arn - ModuleName - VersionId + x-write-only-properties: + - ModuleName + - VersionId x-required-permissions: create: - cloudformation:DescribeType @@ -278,11 +1173,15 @@ components: - ModuleName - ModulePackage x-stackql-resource-name: module_version - x-stackql-primaryIdentifier: + description: A module that has been registered in the CloudFormation registry. + x-type-name: AWS::CloudFormation::ModuleVersion + x-stackql-primary-identifier: - Arn x-create-only-properties: - ModuleName - ModulePackage + x-write-only-properties: + - ModulePackage x-read-only-properties: - Arn - Description @@ -292,6 +1191,9 @@ components: - TimeCreated - VersionId - Visibility + x-required-properties: + - ModuleName + - ModulePackage x-required-permissions: create: - cloudformation:DescribeType @@ -322,8 +1224,8 @@ components: minLength: 5 maxLength: 64 PublisherId: - description: The publisher id assigned by CloudFormation for publishing in this region. - pattern: '[0-9a-zA-Z]{40}' + description: The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. + pattern: '[0-9a-zA-Z-]{1,40}' type: string minLength: 1 maxLength: 40 @@ -350,7 +1252,9 @@ components: - HOOK type: string x-stackql-resource-name: public_type_version - x-stackql-primaryIdentifier: + description: Test and Publish a resource that has been registered in the CloudFormation Registry. + x-type-name: AWS::CloudFormation::PublicTypeVersion + x-stackql-primary-identifier: - PublicTypeArn x-create-only-properties: - LogDeliveryBucket @@ -358,6 +1262,8 @@ components: - TypeName - Type - Arn + x-write-only-properties: + - Arn x-read-only-properties: - PublicTypeArn - TypeVersionArn @@ -383,8 +1289,8 @@ components: description: Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf type: boolean PublisherId: - description: The publisher id assigned by CloudFormation for publishing in this region. - pattern: '[0-9a-zA-Z]{40}' + description: The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. + pattern: '[0-9a-zA-Z-]{1,40}' type: string minLength: 1 maxLength: 40 @@ -413,7 +1319,9 @@ components: required: - AcceptTermsAndConditions x-stackql-resource-name: publisher - x-stackql-primaryIdentifier: + description: Register as a publisher in the CloudFormation Registry. + x-type-name: AWS::CloudFormation::Publisher + x-stackql-primary-identifier: - PublisherId x-create-only-properties: - AcceptTermsAndConditions @@ -423,6 +1331,8 @@ components: - PublisherStatus - PublisherProfile - IdentityProvider + x-required-properties: + - AcceptTermsAndConditions x-required-permissions: create: - cloudformation:RegisterPublisher @@ -457,8 +1367,12 @@ components: description: The Amazon Resource Name (ARN) of the type version. type: string x-stackql-resource-name: resource_default_version - x-stackql-primaryIdentifier: + description: The default version of a resource that has been registered in the CloudFormation Registry. + x-type-name: AWS::CloudFormation::ResourceDefaultVersion + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - TypeName x-read-only-properties: - Arn x-required-permissions: @@ -533,13 +1447,17 @@ components: - SchemaHandlerPackage - TypeName x-stackql-resource-name: resource_version - x-stackql-primaryIdentifier: + description: A resource that has been registered in the CloudFormation Registry. + x-type-name: AWS::CloudFormation::ResourceVersion + x-stackql-primary-identifier: - Arn x-create-only-properties: - ExecutionRoleArn - LoggingConfig - SchemaHandlerPackage - TypeName + x-write-only-properties: + - SchemaHandlerPackage x-read-only-properties: - Arn - IsDefaultVersion @@ -547,6 +1465,9 @@ components: - Visibility - VersionId - TypeArn + x-required-properties: + - SchemaHandlerPackage + - TypeName x-required-permissions: create: - cloudformation:DescribeTypeRegistration @@ -700,10 +1621,17 @@ components: required: - StackName x-stackql-resource-name: stack - x-stackql-primaryIdentifier: + description: The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template. + x-type-name: AWS::CloudFormation::Stack + x-stackql-primary-identifier: - StackId + x-stackql-additional-identifiers: + - - StackName x-create-only-properties: - StackName + x-write-only-properties: + - TemplateURL + - StackPolicyURL x-read-only-properties: - StackId - StackStatus @@ -713,6 +1641,14 @@ components: - ChangeSetId - Outputs - LastUpdateTime + x-required-properties: + - StackName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - cloudformation:DescribeStacks @@ -765,6 +1701,12 @@ components: enum: - SEQUENTIAL - PARALLEL + ConcurrencyMode: + description: Specifies how the concurrency level behaves during the operation execution. + type: string + enum: + - STRICT_FAILURE_TOLERANCE + - SOFT_FAILURE_TOLERANCE Active: description: When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order. type: boolean @@ -792,6 +1734,8 @@ components: $ref: '#/components/schemas/Region' RegionConcurrencyType: $ref: '#/components/schemas/RegionConcurrencyType' + ConcurrencyMode: + $ref: '#/components/schemas/ConcurrencyMode' additionalProperties: false Parameter: type: object @@ -959,13 +1903,34 @@ components: - StackSetName - PermissionModel x-stackql-resource-name: stack_set - x-stackql-primaryIdentifier: + description: StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances + x-type-name: AWS::CloudFormation::StackSet + x-stackql-primary-identifier: - StackSetId + x-stackql-additional-identifiers: + - - StackSetName x-create-only-properties: - PermissionModel - StackSetName + x-write-only-properties: + - TemplateURL + - OperationPreferences + - StackInstancesGroup + - CallAs x-read-only-properties: - StackSetId + x-required-properties: + - StackSetName + - PermissionModel + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - cloudformation:TagResource + - cloudformation:UntagResource x-required-permissions: create: - cloudformation:GetTemplateSummary @@ -1014,8 +1979,8 @@ components: description: The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials. type: string PublisherId: - description: The publisher id assigned by CloudFormation for publishing in this region. - pattern: '[0-9a-zA-Z]{40}' + description: The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. + pattern: '[0-9a-zA-Z-]{1,40}' type: string minLength: 1 maxLength: 40 @@ -1062,10 +2027,19 @@ components: - HOOK type: string x-stackql-resource-name: type_activation - x-stackql-primaryIdentifier: + description: Enable a resource that has been published in the CloudFormation Registry. + x-type-name: AWS::CloudFormation::TypeActivation + x-stackql-primary-identifier: - Arn x-create-only-properties: - LoggingConfig + x-write-only-properties: + - ExecutionRoleArn + - Type + - LoggingConfig + - VersionBump + - AutoUpdate + - MajorVersion x-read-only-properties: - Arn x-required-permissions: @@ -1084,56 +2058,1276 @@ components: - cloudformation:DescribeType list: - cloudformation:ListTypes - x-stackQL-resources: - hook_default_versions: - name: hook_default_versions - id: awscc.cloudformation.hook_default_versions - x-cfn-schema-name: HookDefaultVersion - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' - AND region = 'us-east-1' - hook_default_version: - name: hook_default_version - id: awscc.cloudformation.hook_default_version - x-cfn-schema-name: HookDefaultVersion - x-type: get - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.TypeVersionArn') as type_version_arn, - JSON_EXTRACT(Properties, '$.TypeName') as type_name, + CreateGuardHookRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleLocation: + $ref: '#/components/schemas/S3Location' + LogBucket: + description: S3 Bucket where the guard validate report will be uploaded to + type: string + HookStatus: + default: DISABLED + description: Attribute to specify which stacks this hook applies to or should get invoked for + type: string + enum: + - ENABLED + - DISABLED + TargetOperations: + description: Which operations should this Hook run against? Resource changes, stacks or change sets. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/TargetOperation' + FailureMode: + default: WARN + description: Attribute to specify CloudFormation behavior on hook failure. + type: string + enum: + - FAIL + - WARN + TargetFilters: + description: Attribute to specify which targets should invoke the hook + type: object + oneOf: + - type: object + minProperties: 1 + properties: + TargetNames: + description: List of type names that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TargetName' + Actions: + description: List of actions that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Action' + InvocationPoints: + description: List of invocation points that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/InvocationPoint' + additionalProperties: false + - type: object + properties: + Targets: + description: List of hook targets + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/HookTarget' + additionalProperties: false + required: + - Targets + StackFilters: + description: Filters to allow hooks to target specific stack attributes + type: object + properties: + FilteringCriteria: + description: Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match + type: string + default: ALL + enum: + - ALL + - ANY + StackNames: + description: List of stack names as filters + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack names that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + Exclude: + description: List of stack names that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + StackRoles: + description: List of stack roles that are performing the stack operations. + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack roles that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + Exclude: + description: List of stack roles that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + required: + - FilteringCriteria + additionalProperties: false + Alias: + description: The typename alias for the hook. + pattern: ^(?!(?i)aws)[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + HookArn: + description: The Amazon Resource Name (ARN) of the activated hook + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + ExecutionRole: + description: The execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3. + $ref: '#/components/schemas/Role' + Options: + properties: + InputParams: + $ref: '#/components/schemas/S3Location' + required: [] + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateGuardHookRequest + type: object + required: [] + CreateHookDefaultVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TypeVersionArn: + description: The Amazon Resource Name (ARN) of the type version. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + TypeName: + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + Arn: + description: The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + VersionId: + description: The ID of an existing version of the hook to set as the default. + pattern: ^[A-Za-z0-9-]{1,128}$ + type: string + x-stackQL-stringOnly: true + x-title: CreateHookDefaultVersionRequest + type: object + required: [] + CreateHookTypeConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TypeArn: + description: The Amazon Resource Name (ARN) of the type without version number. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + TypeName: + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + ConfigurationArn: + description: The Amazon Resource Name (ARN) for the configuration data, in this account and region. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type(-configuration)?/hook/.+$ + type: string + Configuration: + description: The configuration data for the extension, in this account and region. + pattern: '[\s\S]+' + type: string + ConfigurationAlias: + description: An alias by which to refer to this extension configuration data. + pattern: ^[a-zA-Z0-9]{1,256}$ + default: default + enum: + - default + type: string + x-stackQL-stringOnly: true + x-title: CreateHookTypeConfigRequest + type: object + required: [] + CreateHookVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the type, here the HookVersion. This is used to uniquely identify a HookVersion resource + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + TypeArn: + description: The Amazon Resource Name (ARN) of the type without the versionID. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + ExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials. + pattern: arn:.+:iam::[0-9]{12}:role/.+ + maxLength: 256 + type: string + IsDefaultVersion: + description: Indicates if this type version is the current default version + type: boolean + LoggingConfig: + $ref: '#/components/schemas/LoggingConfig' + description: Specifies logging configuration information for a type. + SchemaHandlerPackage: + description: |- + A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. + + For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide. + maxLength: 4096 + type: string + TypeName: + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + VersionId: + description: The ID of the version of the type represented by this hook instance. + pattern: ^[A-Za-z0-9-]{1,128}$ + type: string + Visibility: + description: |- + The scope at which the type is visible and usable in CloudFormation operations. + + Valid values include: + + PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. + + PUBLIC: The type is publically visible and usable within any Amazon account. + enum: + - PUBLIC + - PRIVATE + type: string + x-stackQL-stringOnly: true + x-title: CreateHookVersionRequest + type: object + required: [] + CreateLambdaHookRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LambdaFunction: + description: Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook. + type: string + minLength: 1 + maxLength: 170 + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? + HookStatus: + default: ENABLED + description: Attribute to specify which stacks this hook applies to or should get invoked for + type: string + enum: + - ENABLED + - DISABLED + TargetOperations: + description: Which operations should this Hook run against? Resource changes, stacks or change sets. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/TargetOperation' + FailureMode: + description: Attribute to specify CloudFormation behavior on hook failure. + type: string + enum: + - FAIL + - WARN + TargetFilters: + description: Attribute to specify which targets should invoke the hook + type: object + oneOf: + - type: object + minProperties: 1 + properties: + TargetNames: + description: List of type names that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TargetName' + Actions: + description: List of actions that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Action' + InvocationPoints: + description: List of invocation points that the hook is going to target + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/InvocationPoint' + additionalProperties: false + - type: object + properties: + Targets: + description: List of hook targets + type: array + minItems: 1 + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/HookTarget' + additionalProperties: false + required: + - Targets + StackFilters: + description: Filters to allow hooks to target specific stack attributes + type: object + properties: + FilteringCriteria: + description: Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match + type: string + default: ALL + enum: + - ALL + - ANY + StackNames: + description: List of stack names as filters + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack names that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + Exclude: + description: List of stack names that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackName' + StackRoles: + description: List of stack roles that are performing the stack operations. + type: object + additionalProperties: false + minProperties: 1 + properties: + Include: + description: List of stack roles that the hook is going to target + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + Exclude: + description: List of stack roles that the hook is going to be excluded from + type: array + maxItems: 50 + minItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackRole' + required: + - FilteringCriteria + additionalProperties: false + Alias: + description: The typename alias for the hook. + pattern: ^(?!(?i)aws)[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + HookArn: + description: The Amazon Resource Name (ARN) of the activated hook + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/.+$ + type: string + ExecutionRole: + description: The execution role ARN assumed by Hooks to invoke Lambda. + $ref: '#/components/schemas/Role' + x-stackQL-stringOnly: true + x-title: CreateLambdaHookRequest + type: object + required: [] + CreateModuleDefaultVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the module version to set as the default version. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+/[0-9]{8}$ + type: string + ModuleName: + description: The name of a module existing in the registry. + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE + type: string + VersionId: + description: The ID of an existing version of the named module to set as the default. + pattern: ^[0-9]{8}$ + type: string + x-stackQL-stringOnly: true + x-title: CreateModuleDefaultVersionRequest + type: object + required: [] + CreateModuleVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the module. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/module/.+$ + type: string + Description: + description: The description of the registered module. + maxLength: 1024 + minLength: 1 + type: string + DocumentationUrl: + description: The URL of a page providing detailed documentation for this module. + maxLength: 4096 + type: string + ModuleName: + description: |- + The name of the module being registered. + + Recommended module naming pattern: company_or_organization::service::type::MODULE. + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::MODULE + type: string + ModulePackage: + description: The url to the S3 bucket containing the schema and template fragment for the module you want to register. + type: string + IsDefaultVersion: + description: Indicator of whether this module version is the current default version + type: boolean + Schema: + description: The schema defining input parameters to and resources generated by the module. + maxLength: 16777216 + minLength: 1 + type: string + TimeCreated: + description: The time that the specified module version was registered. + type: string + VersionId: + description: The version ID of the module represented by this module instance. + pattern: ^[0-9]{8}$ + type: string + Visibility: + description: |- + The scope at which the type is visible and usable in CloudFormation operations. + + The only allowed value at present is: + + PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. + enum: + - PRIVATE + type: string + x-stackQL-stringOnly: true + x-title: CreateModuleVersionRequest + type: object + required: [] + CreatePublicTypeVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Number (ARN) of the extension. + pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+ + type: string + TypeVersionArn: + description: The Amazon Resource Number (ARN) of the extension with the versionId. + pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+ + type: string + PublicVersionNumber: + description: The version number of a public third-party extension + type: string + minLength: 5 + maxLength: 64 + PublisherId: + description: The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. + pattern: '[0-9a-zA-Z-]{1,40}' + type: string + minLength: 1 + maxLength: 40 + PublicTypeArn: + description: The Amazon Resource Number (ARN) assigned to the public extension upon publication + pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+ + type: string + maxLength: 1024 + TypeName: + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}' + type: string + LogDeliveryBucket: + description: A url to the S3 bucket where logs for the testType run will be available + type: string + Type: + description: The kind of extension + enum: + - RESOURCE + - MODULE + - HOOK + type: string + x-stackQL-stringOnly: true + x-title: CreatePublicTypeVersionRequest + type: object + required: [] + CreatePublisherRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AcceptTermsAndConditions: + description: Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf + type: boolean + PublisherId: + description: The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. + pattern: '[0-9a-zA-Z-]{1,40}' + type: string + minLength: 1 + maxLength: 40 + ConnectionArn: + description: If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. + type: string + pattern: arn:aws(-[w]+)*:.+:.+:[0-9]{12}:.+ + PublisherStatus: + description: Whether the publisher is verified. + type: string + enum: + - VERIFIED + - UNVERIFIED + PublisherProfile: + description: The URL to the publisher's profile with the identity provider. + pattern: (http:|https:)+[^s]+[w] + type: string + maxLength: 1024 + IdentityProvider: + description: The type of account used as the identity provider when registering this publisher with CloudFormation. + type: string + enum: + - AWS_Marketplace + - GitHub + - Bitbucket + x-stackQL-stringOnly: true + x-title: CreatePublisherRequest + type: object + required: [] + CreateResourceDefaultVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VersionId: + pattern: ^[A-Za-z0-9-]{1,128}$ + description: The ID of an existing version of the resource to set as the default. + type: string + TypeName: + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + type: string + Arn: + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$ + description: The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion + type: string + TypeVersionArn: + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$ + description: The Amazon Resource Name (ARN) of the type version. + type: string + x-stackQL-stringOnly: true + x-title: CreateResourceDefaultVersionRequest + type: object + required: [] + CreateResourceVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$ + type: string + TypeArn: + description: The Amazon Resource Name (ARN) of the type without the versionID. + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/resource/.+$ + type: string + ExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials. + type: string + IsDefaultVersion: + description: Indicates if this type version is the current default version + type: boolean + LoggingConfig: + $ref: '#/components/schemas/LoggingConfig' + description: Specifies logging configuration information for a type. + ProvisioningType: + description: The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. + enum: + - NON_PROVISIONABLE + - IMMUTABLE + - FULLY_MUTABLE + type: string + SchemaHandlerPackage: + description: |- + A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. + + For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide. + type: string + TypeName: + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + pattern: ^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}$ + type: string + VersionId: + description: The ID of the version of the type represented by this resource instance. + pattern: ^[A-Za-z0-9-]{1,128}$ + type: string + Visibility: + description: |- + The scope at which the type is visible and usable in CloudFormation operations. + + Valid values include: + + PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. + + PUBLIC: The type is publically visible and usable within any Amazon account. + enum: + - PUBLIC + - PRIVATE + type: string + x-stackQL-stringOnly: true + x-title: CreateResourceVersionRequest + type: object + required: [] + CreateStackRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Capabilities: + type: array + uniqueItems: false + items: + type: string + enum: + - CAPABILITY_IAM + - CAPABILITY_NAMED_IAM + - CAPABILITY_AUTO_EXPAND + RoleARN: + type: string + Outputs: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Output' + Description: + type: string + minLength: 1 + maxLength: 1024 + DisableRollback: + type: boolean + EnableTerminationProtection: + type: boolean + NotificationARNs: + type: array + uniqueItems: false + items: + type: string + maxItems: 5 + Parameters: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + ParentId: + type: string + RootId: + type: string + ChangeSetId: + type: string + StackName: + type: string + StackId: + type: string + StackPolicyBody: + type: object + StackPolicyURL: + type: string + StackStatus: + type: string + enum: + - CREATE_IN_PROGRESS + - CREATE_FAILED + - CREATE_COMPLETE + - ROLLBACK_IN_PROGRESS + - ROLLBACK_FAILED + - ROLLBACK_COMPLETE + - DELETE_IN_PROGRESS + - DELETE_FAILED + - DELETE_COMPLETE + - UPDATE_IN_PROGRESS + - UPDATE_COMPLETE_CLEANUP_IN_PROGRESS + - UPDATE_COMPLETE + - UPDATE_FAILED + - UPDATE_ROLLBACK_IN_PROGRESS + - UPDATE_ROLLBACK_FAILED + - UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS + - UPDATE_ROLLBACK_COMPLETE + - REVIEW_IN_PROGRESS + - IMPORT_IN_PROGRESS + - IMPORT_COMPLETE + - IMPORT_ROLLBACK_IN_PROGRESS + - IMPORT_ROLLBACK_FAILED + - IMPORT_ROLLBACK_COMPLETE + StackStatusReason: + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + TemplateBody: + type: object + TemplateURL: + type: string + minLength: 1 + maxLength: 1024 + TimeoutInMinutes: + type: integer + minimum: 1 + LastUpdateTime: + type: string + CreationTime: + type: string + x-stackQL-stringOnly: true + x-title: CreateStackRequest + type: object + required: [] + CreateStackSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StackSetName: + description: The name to associate with the stack set. The name must be unique in the Region where you create your stack set. + type: string + pattern: ^[a-zA-Z][a-zA-Z0-9\-]{0,127}$ + maxLength: 128 + StackSetId: + description: The ID of the stack set that you're creating. + type: string + AdministrationRoleARN: + description: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. + type: string + minLength: 20 + maxLength: 2048 + AutoDeployment: + description: Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED. + $ref: '#/components/schemas/AutoDeployment' + Capabilities: + description: In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Capability' + Description: + description: A description of the stack set. You can use the description to identify the stack set's purpose or other important information. + type: string + minLength: 1 + maxLength: 1024 + ExecutionRoleName: + description: The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. + type: string + minLength: 1 + maxLength: 64 + OperationPreferences: + $ref: '#/components/schemas/OperationPreferences' + StackInstancesGroup: + description: A group of stack instances with parameters in some specific accounts and regions. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/StackInstances' + Parameters: + description: The input parameters for the stack set template. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Parameter' + PermissionModel: + description: Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified. + type: string + enum: + - SERVICE_MANAGED + - SELF_MANAGED + Tags: + description: The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + TemplateBody: + description: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. + type: string + minLength: 1 + maxLength: 51200 + TemplateURL: + description: 'Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.' + type: string + minLength: 1 + maxLength: 5120 + CallAs: + description: Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. + type: string + enum: + - SELF + - DELEGATED_ADMIN + ManagedExecution: + description: Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. + type: object + properties: + Active: + $ref: '#/components/schemas/Active' + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateStackSetRequest + type: object + required: [] + CreateTypeActivationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the extension. + pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+ + type: string + ExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials. + type: string + PublisherId: + description: The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region. + pattern: '[0-9a-zA-Z-]{1,40}' + type: string + minLength: 1 + maxLength: 40 + LoggingConfig: + $ref: '#/components/schemas/LoggingConfig' + description: Specifies logging configuration information for a type. + PublicTypeArn: + description: The Amazon Resource Number (ARN) assigned to the public extension upon publication + pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+ + type: string + maxLength: 1024 + AutoUpdate: + description: Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. + type: boolean + TypeNameAlias: + description: An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates. + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}' + type: string + minLength: 10 + maxLength: 204 + VersionBump: + description: Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled + type: string + enum: + - MAJOR + - MINOR + MajorVersion: + description: The Major Version of the type you want to enable + type: string + minLength: 1 + maxLength: 100000 + TypeName: + description: |- + The name of the type being registered. + + We recommend that type names adhere to the following pattern: company_or_organization::service::type. + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}' + type: string + Type: + description: The kind of extension + enum: + - RESOURCE + - MODULE + - HOOK + type: string + x-stackQL-stringOnly: true + x-title: CreateTypeActivationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + guard_hooks: + name: guard_hooks + id: awscc.cloudformation.guard_hooks + x-cfn-schema-name: GuardHook + x-cfn-type-name: AWS::CloudFormation::GuardHook + x-identifiers: + - HookArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GuardHook&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::GuardHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::GuardHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::GuardHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/guard_hooks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/guard_hooks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/guard_hooks/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RuleLocation') as rule_location, + JSON_EXTRACT(Properties, '$.LogBucket') as log_bucket, + JSON_EXTRACT(Properties, '$.HookStatus') as hook_status, + JSON_EXTRACT(Properties, '$.TargetOperations') as target_operations, + JSON_EXTRACT(Properties, '$.FailureMode') as failure_mode, + JSON_EXTRACT(Properties, '$.TargetFilters') as target_filters, + JSON_EXTRACT(Properties, '$.StackFilters') as stack_filters, + JSON_EXTRACT(Properties, '$.Alias') as alias, + JSON_EXTRACT(Properties, '$.HookArn') as hook_arn, + JSON_EXTRACT(Properties, '$.ExecutionRole') as execution_role, + JSON_EXTRACT(Properties, '$.Options') as options + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::GuardHook' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleLocation') as rule_location, + json_extract_path_text(Properties, 'LogBucket') as log_bucket, + json_extract_path_text(Properties, 'HookStatus') as hook_status, + json_extract_path_text(Properties, 'TargetOperations') as target_operations, + json_extract_path_text(Properties, 'FailureMode') as failure_mode, + json_extract_path_text(Properties, 'TargetFilters') as target_filters, + json_extract_path_text(Properties, 'StackFilters') as stack_filters, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'HookArn') as hook_arn, + json_extract_path_text(Properties, 'ExecutionRole') as execution_role, + json_extract_path_text(Properties, 'Options') as options + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::GuardHook' + AND data__Identifier = '' + AND region = 'us-east-1' + guard_hooks_list_only: + name: guard_hooks_list_only + id: awscc.cloudformation.guard_hooks_list_only + x-cfn-schema-name: GuardHook + x-cfn-type-name: AWS::CloudFormation::GuardHook + x-identifiers: + - HookArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.HookArn') as hook_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::GuardHook' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HookArn') as hook_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::GuardHook' + AND region = 'us-east-1' + hook_default_versions: + name: hook_default_versions + id: awscc.cloudformation.hook_default_versions + x-cfn-schema-name: HookDefaultVersion + x-cfn-type-name: AWS::CloudFormation::HookDefaultVersion + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HookDefaultVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookDefaultVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookDefaultVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hook_default_versions/methods/create_resource' + delete: [] + update: + - $ref: '#/components/x-stackQL-resources/hook_default_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TypeVersionArn') as type_version_arn, + JSON_EXTRACT(Properties, '$.TypeName') as type_name, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.VersionId') as version_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1145,13 +3339,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' AND data__Identifier = '' AND region = 'us-east-1' - hook_type_configs: - name: hook_type_configs - id: awscc.cloudformation.hook_type_configs - x-cfn-schema-name: HookTypeConfig - x-type: list + hook_default_versions_list_only: + name: hook_default_versions_list_only + id: awscc.cloudformation.hook_default_versions_list_only + x-cfn-schema-name: HookDefaultVersion + x-cfn-type-name: AWS::CloudFormation::HookDefaultVersion x-identifiers: - - ConfigurationArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1159,28 +3359,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConfigurationArn') as configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConfigurationArn') as configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' AND region = 'us-east-1' - hook_type_config: - name: hook_type_config - id: awscc.cloudformation.hook_type_config + hook_type_configs: + name: hook_type_configs + id: awscc.cloudformation.hook_type_configs x-cfn-schema-name: HookTypeConfig - x-type: get + x-cfn-type-name: AWS::CloudFormation::HookTypeConfig x-identifiers: - ConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HookTypeConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookTypeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookTypeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookTypeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1194,7 +3442,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1207,13 +3455,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' AND data__Identifier = '' AND region = 'us-east-1' - hook_versions: - name: hook_versions - id: awscc.cloudformation.hook_versions - x-cfn-schema-name: HookVersion - x-type: list + hook_type_configs_list_only: + name: hook_type_configs_list_only + id: awscc.cloudformation.hook_type_configs_list_only + x-cfn-schema-name: HookTypeConfig + x-cfn-type-name: AWS::CloudFormation::HookTypeConfig x-identifiers: - - Arn + - ConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1221,28 +3475,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' + JSON_EXTRACT(Properties, '$.ConfigurationArn') as configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' + json_extract_path_text(Properties, 'ConfigurationArn') as configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' AND region = 'us-east-1' - hook_version: - name: hook_version - id: awscc.cloudformation.hook_version + hook_versions: + name: hook_versions + id: awscc.cloudformation.hook_versions x-cfn-schema-name: HookVersion - x-type: get + x-cfn-type-name: AWS::CloudFormation::HookVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HookVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::HookVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hook_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hook_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1260,7 +3549,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1277,13 +3566,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' AND data__Identifier = '' AND region = 'us-east-1' - module_default_versions: - name: module_default_versions - id: awscc.cloudformation.module_default_versions - x-cfn-schema-name: ModuleDefaultVersion - x-type: list + hook_versions_list_only: + name: hook_versions_list_only + id: awscc.cloudformation.hook_versions_list_only + x-cfn-schema-name: HookVersion + x-cfn-type-name: AWS::CloudFormation::HookVersion x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1292,7 +3587,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1300,19 +3595,165 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' AND region = 'us-east-1' - module_default_version: - name: module_default_version - id: awscc.cloudformation.module_default_version + lambda_hooks: + name: lambda_hooks + id: awscc.cloudformation.lambda_hooks + x-cfn-schema-name: LambdaHook + x-cfn-type-name: AWS::CloudFormation::LambdaHook + x-identifiers: + - HookArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LambdaHook&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::LambdaHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::LambdaHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::LambdaHook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lambda_hooks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lambda_hooks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/lambda_hooks/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.LambdaFunction') as lambda_function, + JSON_EXTRACT(Properties, '$.HookStatus') as hook_status, + JSON_EXTRACT(Properties, '$.TargetOperations') as target_operations, + JSON_EXTRACT(Properties, '$.FailureMode') as failure_mode, + JSON_EXTRACT(Properties, '$.TargetFilters') as target_filters, + JSON_EXTRACT(Properties, '$.StackFilters') as stack_filters, + JSON_EXTRACT(Properties, '$.Alias') as alias, + JSON_EXTRACT(Properties, '$.HookArn') as hook_arn, + JSON_EXTRACT(Properties, '$.ExecutionRole') as execution_role + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::LambdaHook' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LambdaFunction') as lambda_function, + json_extract_path_text(Properties, 'HookStatus') as hook_status, + json_extract_path_text(Properties, 'TargetOperations') as target_operations, + json_extract_path_text(Properties, 'FailureMode') as failure_mode, + json_extract_path_text(Properties, 'TargetFilters') as target_filters, + json_extract_path_text(Properties, 'StackFilters') as stack_filters, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'HookArn') as hook_arn, + json_extract_path_text(Properties, 'ExecutionRole') as execution_role + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::LambdaHook' + AND data__Identifier = '' + AND region = 'us-east-1' + lambda_hooks_list_only: + name: lambda_hooks_list_only + id: awscc.cloudformation.lambda_hooks_list_only + x-cfn-schema-name: LambdaHook + x-cfn-type-name: AWS::CloudFormation::LambdaHook + x-identifiers: + - HookArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.HookArn') as hook_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::LambdaHook' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HookArn') as hook_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::LambdaHook' + AND region = 'us-east-1' + module_default_versions: + name: module_default_versions + id: awscc.cloudformation.module_default_versions x-cfn-schema-name: ModuleDefaultVersion - x-type: get + x-cfn-type-name: AWS::CloudFormation::ModuleDefaultVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModuleDefaultVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ModuleDefaultVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/module_default_versions/methods/create_resource' + delete: [] + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1323,29 +3764,95 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' AND data__Identifier = '' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ModuleName') as module_name, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + module_default_versions_list_only: + name: module_default_versions_list_only + id: awscc.cloudformation.module_default_versions_list_only + x-cfn-schema-name: ModuleDefaultVersion + x-cfn-type-name: AWS::CloudFormation::ModuleDefaultVersion + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' + AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ModuleName') as module_name, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' AND region = 'us-east-1' - module_version: - name: module_version - id: awscc.cloudformation.module_version + module_versions: + name: module_versions + id: awscc.cloudformation.module_versions x-cfn-schema-name: ModuleVersion - x-type: get + x-cfn-type-name: AWS::CloudFormation::ModuleVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModuleVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ModuleVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ModuleVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/module_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/module_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1364,7 +3871,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1386,38 +3893,35 @@ components: name: public_type_versions id: awscc.cloudformation.public_type_versions x-cfn-schema-name: PublicTypeVersion - x-type: list - x-identifiers: - - PublicTypeArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PublicTypeArn') as public_type_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' - AND region = 'us-east-1' - public_type_version: - name: public_type_version - id: awscc.cloudformation.public_type_version - x-cfn-schema-name: PublicTypeVersion - x-type: get + x-cfn-type-name: AWS::CloudFormation::PublicTypeVersion x-identifiers: - PublicTypeArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PublicTypeVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::PublicTypeVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/public_type_versions/methods/create_resource' + delete: [] + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1434,7 +3938,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1450,13 +3954,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' AND data__Identifier = '' AND region = 'us-east-1' - publishers: - name: publishers - id: awscc.cloudformation.publishers - x-cfn-schema-name: Publisher - x-type: list + public_type_versions_list_only: + name: public_type_versions_list_only + id: awscc.cloudformation.public_type_versions_list_only + x-cfn-schema-name: PublicTypeVersion + x-cfn-type-name: AWS::CloudFormation::PublicTypeVersion x-identifiers: - - PublisherId + - PublicTypeArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1464,28 +3974,50 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PublisherId') as publisher_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' + JSON_EXTRACT(Properties, '$.PublicTypeArn') as public_type_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PublisherId') as publisher_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' + json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' AND region = 'us-east-1' - publisher: - name: publisher - id: awscc.cloudformation.publisher + publishers: + name: publishers + id: awscc.cloudformation.publishers x-cfn-schema-name: Publisher - x-type: get + x-cfn-type-name: AWS::CloudFormation::Publisher x-identifiers: - PublisherId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Publisher&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::Publisher" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/publishers/methods/create_resource' + delete: [] + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1500,7 +4032,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1514,13 +4046,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::Publisher' AND data__Identifier = '' AND region = 'us-east-1' - resource_default_versions: - name: resource_default_versions - id: awscc.cloudformation.resource_default_versions - x-cfn-schema-name: ResourceDefaultVersion - x-type: list + publishers_list_only: + name: publishers_list_only + id: awscc.cloudformation.publishers_list_only + x-cfn-schema-name: Publisher + x-cfn-type-name: AWS::CloudFormation::Publisher x-identifiers: - - Arn + - PublisherId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1528,28 +4066,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' + JSON_EXTRACT(Properties, '$.PublisherId') as publisher_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' + json_extract_path_text(Properties, 'PublisherId') as publisher_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' AND region = 'us-east-1' - resource_default_version: - name: resource_default_version - id: awscc.cloudformation.resource_default_version + resource_default_versions: + name: resource_default_versions + id: awscc.cloudformation.resource_default_versions x-cfn-schema-name: ResourceDefaultVersion - x-type: get + x-cfn-type-name: AWS::CloudFormation::ResourceDefaultVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceDefaultVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ResourceDefaultVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ResourceDefaultVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ResourceDefaultVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1562,7 +4148,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1574,13 +4160,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' AND data__Identifier = '' AND region = 'us-east-1' - resource_versions: - name: resource_versions - id: awscc.cloudformation.resource_versions - x-cfn-schema-name: ResourceVersion - x-type: list + resource_default_versions_list_only: + name: resource_default_versions_list_only + id: awscc.cloudformation.resource_default_versions_list_only + x-cfn-schema-name: ResourceDefaultVersion + x-cfn-type-name: AWS::CloudFormation::ResourceDefaultVersion x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1589,7 +4181,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1597,19 +4189,54 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' AND region = 'us-east-1' - resource_version: - name: resource_version - id: awscc.cloudformation.resource_version + resource_versions: + name: resource_versions + id: awscc.cloudformation.resource_versions x-cfn-schema-name: ResourceVersion - x-type: get + x-cfn-type-name: AWS::CloudFormation::ResourceVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ResourceVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::ResourceVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1628,7 +4255,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1646,13 +4273,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' AND data__Identifier = '' AND region = 'us-east-1' - stacks: - name: stacks - id: awscc.cloudformation.stacks - x-cfn-schema-name: Stack - x-type: list + resource_versions_list_only: + name: resource_versions_list_only + id: awscc.cloudformation.resource_versions_list_only + x-cfn-schema-name: ResourceVersion + x-cfn-type-name: AWS::CloudFormation::ResourceVersion x-identifiers: - - StackId + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1660,28 +4293,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StackId') as stack_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StackId') as stack_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' AND region = 'us-east-1' - stack: - name: stack - id: awscc.cloudformation.stack + stacks: + name: stacks + id: awscc.cloudformation.stacks x-cfn-schema-name: Stack - x-type: get + x-cfn-type-name: AWS::CloudFormation::Stack x-identifiers: - StackId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Stack&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::Stack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::Stack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::Stack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stacks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stacks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stacks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1713,7 +4394,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1744,13 +4425,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::Stack' AND data__Identifier = '' AND region = 'us-east-1' - stack_sets: - name: stack_sets - id: awscc.cloudformation.stack_sets - x-cfn-schema-name: StackSet - x-type: list + stacks_list_only: + name: stacks_list_only + id: awscc.cloudformation.stacks_list_only + x-cfn-schema-name: Stack + x-cfn-type-name: AWS::CloudFormation::Stack x-identifiers: - - StackSetId + - StackId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1758,28 +4445,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StackSetId') as stack_set_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' + JSON_EXTRACT(Properties, '$.StackId') as stack_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StackSetId') as stack_set_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' + json_extract_path_text(Properties, 'StackId') as stack_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' AND region = 'us-east-1' - stack_set: - name: stack_set - id: awscc.cloudformation.stack_set + stack_sets: + name: stack_sets + id: awscc.cloudformation.stack_sets x-cfn-schema-name: StackSet - x-type: get + x-cfn-type-name: AWS::CloudFormation::StackSet x-identifiers: - StackSetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StackSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::StackSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::StackSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::StackSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stack_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stack_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stack_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1804,7 +4539,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1828,13 +4563,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::StackSet' AND data__Identifier = '' AND region = 'us-east-1' - type_activations: - name: type_activations - id: awscc.cloudformation.type_activations - x-cfn-schema-name: TypeActivation - x-type: list + stack_sets_list_only: + name: stack_sets_list_only + id: awscc.cloudformation.stack_sets_list_only + x-cfn-schema-name: StackSet + x-cfn-type-name: AWS::CloudFormation::StackSet x-identifiers: - - Arn + - StackSetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1842,28 +4583,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' + JSON_EXTRACT(Properties, '$.StackSetId') as stack_set_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' + json_extract_path_text(Properties, 'StackSetId') as stack_set_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' AND region = 'us-east-1' - type_activation: - name: type_activation - id: awscc.cloudformation.type_activation + type_activations: + name: type_activations + id: awscc.cloudformation.type_activations x-cfn-schema-name: TypeActivation - x-type: get + x-cfn-type-name: AWS::CloudFormation::TypeActivation x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TypeActivation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::TypeActivation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::TypeActivation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFormation::TypeActivation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/type_activations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/type_activations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/type_activations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1883,7 +4672,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1902,3 +4691,775 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' AND data__Identifier = '' AND region = 'us-east-1' + type_activations_list_only: + name: type_activations_list_only + id: awscc.cloudformation.type_activations_list_only + x-cfn-schema-name: TypeActivation + x-cfn-type-name: AWS::CloudFormation::TypeActivation + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GuardHook&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGuardHook + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGuardHookRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HookDefaultVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHookDefaultVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHookDefaultVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HookTypeConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHookTypeConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHookTypeConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HookVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHookVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHookVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LambdaHook&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLambdaHook + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLambdaHookRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModuleDefaultVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModuleDefaultVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModuleDefaultVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModuleVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModuleVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModuleVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PublicTypeVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePublicTypeVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePublicTypeVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Publisher&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePublisher + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePublisherRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceDefaultVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceDefaultVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceDefaultVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Stack&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStack + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStackRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StackSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStackSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStackSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TypeActivation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTypeActivation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTypeActivationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cloudfront.yaml b/providers/src/awscc/v00.00.00000/services/cloudfront.yaml index 29cdfba9..b32505df 100644 --- a/providers/src/awscc/v00.00.00000/services/cloudfront.yaml +++ b/providers/src/awscc/v00.00.00000/services/cloudfront.yaml @@ -1,31 +1,515 @@ openapi: 3.0.0 info: title: CloudFront - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + AnycastIpList: + type: object + properties: + AnycastIpList: + $ref: '#/components/schemas/AnycastIpList' + description: '' + ETag: + type: string + description: '' + Id: + type: string + description: '' + IpCount: + type: integer + description: The number of IP addresses in the Anycast static IP list. + Name: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]{1,64}$ + type: string + description: The name of the Anycast static IP list. + Tags: + $ref: '#/components/schemas/Tags' + description: A complex type that contains zero or more ``Tag`` elements. + required: + - IpCount + - Name + x-stackql-resource-name: anycast_ip_list + description: An Anycast static IP list. For more information, see [Request Anycast static IPs to use for allowlisting](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/request-static-ips.html) in the *Amazon CloudFront Developer Guide*. + x-type-name: AWS::CloudFront::AnycastIpList + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - IpCount + - Name + - Tags + x-read-only-properties: + - AnycastIpList + - ETag + - Id + x-required-properties: + - IpCount + - Name + x-tagging: + cloudFormationSystemTags: false + permissions: + - cloudfront:TagResource + - cloudfront:ListTagsForResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: false + taggable: true + x-required-permissions: + create: + - cloudfront:CreateAnycastIpList + - cloudfront:TagResource + delete: + - cloudfront:DeleteAnycastIpList + - cloudfront:GetAnycastIpList + list: + - cloudfront:ListAnycastIpLists + read: + - cloudfront:GetAnycastIpList + - cloudfront:ListTagsForResource + Tag: + additionalProperties: false + properties: + Key: + type: string + description: |- + A string that contains ``Tag`` key. + The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``. + Value: + type: string + description: |- + A string that contains an optional ``Tag`` value. + The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``. + required: + - Value + - Key + type: object + description: A complex type that contains ``Tag`` key and ``Tag`` value. + Tags: + additionalProperties: false + properties: + Items: + items: + $ref: '#/components/schemas/Tag' + type: array + description: A complex type that contains ``Tag`` elements. + type: object + description: A complex type that contains zero or more ``Tag`` elements. CachePolicyConfig: additionalProperties: false properties: Comment: type: string + description: A comment to describe the cache policy. The comment cannot be longer than 128 characters. DefaultTTL: minimum: 0 multipleOf: 1 type: number + description: >- + The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does *not* send ``Cache-Control`` or ``Expires`` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache + (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. + The default value for this field is 86400 seconds (one day). If the value of ``MinTTL`` is more than 86400 seconds, then the default value for this field is the same as the value of ``MinTTL``. MaxTTL: minimum: 0 multipleOf: 1 type: number + description: >- + The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends ``Cache-Control`` or ``Expires`` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront + Developer Guide*. + The default value for this field is 31536000 seconds (one year). If the value of ``MinTTL`` or ``DefaultTTL`` is more than 31536000 seconds, then the default value for this field is the same as the value of ``DefaultTTL``. MinTTL: minimum: 0 multipleOf: 1 type: number + description: The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. Name: type: string + description: A unique name to identify the cache policy. ParametersInCacheKeyAndForwardedToOrigin: $ref: '#/components/schemas/ParametersInCacheKeyAndForwardedToOrigin' + description: The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin. required: - Name - MinTTL @@ -33,84 +517,160 @@ components: - DefaultTTL - ParametersInCacheKeyAndForwardedToOrigin type: object + description: |- + A cache policy configuration. + This configuration determines the following: + + The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. + + The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. + + The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``. CookiesConfig: additionalProperties: false properties: CookieBehavior: pattern: ^(none|whitelist|all|allExcept)$ type: string + description: |- + Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are: + + ``none`` – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any cookies that are listed in a ``CachePolicy``*are* included in origin requests. + + ``whitelist`` – Only the cookies in viewer requests that are listed in the ``CookieNames`` type are included in requests that CloudFront sends to the origin. + + ``all`` – All cookies in viewer requests are included in requests that CloudFront sends to the origin. + + ``allExcept`` – All cookies in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``CookieNames`` type, which are not included. Cookies: items: type: string type: array uniqueItems: false + description: Contains a list of cookie names. required: - CookieBehavior type: object + description: An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin. HeadersConfig: additionalProperties: false properties: HeaderBehavior: pattern: ^(none|whitelist|allViewer|allViewerAndWhitelistCloudFront|allExcept)$ type: string + description: |- + Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are: + + ``none`` – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any headers that are listed in a ``CachePolicy``*are* included in origin requests. + + ``whitelist`` – Only the HTTP headers that are listed in the ``Headers`` type are included in requests that CloudFront sends to the origin. + + ``allViewer`` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. + + ``allViewerAndWhitelistCloudFront`` – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the ``Headers`` type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront. + + ``allExcept`` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``Headers`` type, which are not included. Headers: items: type: string type: array uniqueItems: false + description: Contains a list of HTTP header names. required: - HeaderBehavior type: object + description: An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin. ParametersInCacheKeyAndForwardedToOrigin: additionalProperties: false properties: CookiesConfig: $ref: '#/components/schemas/CookiesConfig' + description: An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin. EnableAcceptEncodingBrotli: type: boolean + description: |- + A flag that can affect whether the ``Accept-Encoding`` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. + This field is related to the ``EnableAcceptEncodingGzip`` field. If one or both of these fields is ``true``*and* the viewer request includes the ``Accept-Encoding`` header, then CloudFront does the following: + + Normalizes the value of the viewer's ``Accept-Encoding`` header + + Includes the normalized header in the cache key + + Includes the normalized header in the request to the origin, if a request is necessary + + For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*. + If you set this value to ``true``, and this cache behavior also has an origin request policy attached, do not include the ``Accept-Encoding`` header in the origin request policy. CloudFront always includes the ``Accept-Encoding`` header in origin requests when the value of this field is ``true``, so including this header in an origin request policy has no effect. + If both of these fields are ``false``, then CloudFront treats the ``Accept-Encoding`` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add ``Accept-Encoding`` to the headers whitelist like any other HTTP header. EnableAcceptEncodingGzip: type: boolean + description: |- + A flag that can affect whether the ``Accept-Encoding`` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. + This field is related to the ``EnableAcceptEncodingBrotli`` field. If one or both of these fields is ``true``*and* the viewer request includes the ``Accept-Encoding`` header, then CloudFront does the following: + + Normalizes the value of the viewer's ``Accept-Encoding`` header + + Includes the normalized header in the cache key + + Includes the normalized header in the request to the origin, if a request is necessary + + For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*. + If you set this value to ``true``, and this cache behavior also has an origin request policy attached, do not include the ``Accept-Encoding`` header in the origin request policy. CloudFront always includes the ``Accept-Encoding`` header in origin requests when the value of this field is ``true``, so including this header in an origin request policy has no effect. + If both of these fields are ``false``, then CloudFront treats the ``Accept-Encoding`` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add ``Accept-Encoding`` to the headers whitelist like any other HTTP header. HeadersConfig: $ref: '#/components/schemas/HeadersConfig' + description: An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin. QueryStringsConfig: $ref: '#/components/schemas/QueryStringsConfig' + description: An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin. required: - EnableAcceptEncodingGzip - HeadersConfig - CookiesConfig - QueryStringsConfig type: object + description: |- + This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. + The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``. QueryStringsConfig: additionalProperties: false properties: QueryStringBehavior: pattern: ^(none|whitelist|all|allExcept)$ type: string + description: |- + Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are: + + ``none`` – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any query strings that are listed in a ``CachePolicy``*are* included in origin requests. + + ``whitelist`` – Only the query strings in viewer requests that are listed in the ``QueryStringNames`` type are included in requests that CloudFront sends to the origin. + + ``all`` – All query strings in viewer requests are included in requests that CloudFront sends to the origin. + + ``allExcept`` – All query strings in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``QueryStringNames`` type, which are not included. QueryStrings: items: type: string type: array uniqueItems: false + description: Contains a list of query string names. required: - QueryStringBehavior type: object + description: An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin. CachePolicy: type: object properties: CachePolicyConfig: $ref: '#/components/schemas/CachePolicyConfig' + description: The cache policy configuration. Id: type: string + description: '' LastModifiedTime: type: string + description: '' required: - CachePolicyConfig x-stackql-resource-name: cache_policy - x-stackql-primaryIdentifier: + description: |- + A cache policy. + When it's attached to a cache behavior, the cache policy determines the following: + + The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. + + The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. + + The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``. + x-type-name: AWS::CloudFront::CachePolicy + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - LastModifiedTime + x-required-properties: + - CachePolicyConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateCachePolicy @@ -129,26 +689,40 @@ components: properties: Comment: type: string + description: A comment to describe the origin access identity. The comment cannot be longer than 128 characters. required: - Comment type: object + description: Origin access identity configuration. Send a ``GET`` request to the ``/CloudFront API version/CloudFront/identity ID/config`` resource. CloudFrontOriginAccessIdentity: type: object properties: CloudFrontOriginAccessIdentityConfig: $ref: '#/components/schemas/CloudFrontOriginAccessIdentityConfig' + description: The current configuration information for the identity. Id: type: string + description: '' S3CanonicalUserId: type: string + description: '' required: - CloudFrontOriginAccessIdentityConfig x-stackql-resource-name: cloud_front_origin_access_identity - x-stackql-primaryIdentifier: + description: The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*. + x-type-name: AWS::CloudFront::CloudFrontOriginAccessIdentity + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - S3CanonicalUserId + x-required-properties: + - CloudFrontOriginAccessIdentityConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateCloudFrontOriginAccessIdentity @@ -162,11 +736,110 @@ components: update: - cloudfront:UpdateCloudFrontOriginAccessIdentity - cloudfront:GetCloudFrontOriginAccessIdentity + ConnectionGroup: + type: object + properties: + Id: + type: string + description: '' + Name: + type: string + description: The name of the connection group. + Arn: + type: string + description: '' + CreatedTime: + format: date-time + type: string + description: '' + LastModifiedTime: + format: date-time + type: string + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + Ipv6Enabled: + type: boolean + description: IPv6 is enabled for the connection group. + RoutingEndpoint: + type: string + description: '' + AnycastIpListId: + type: string + description: The ID of the Anycast static IP list. + Status: + type: string + description: '' + Enabled: + type: boolean + description: Whether the connection group is enabled. + IsDefault: + type: boolean + description: '' + ETag: + type: string + description: '' + required: + - Name + x-stackql-resource-name: connection_group + description: The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant. + x-type-name: AWS::CloudFront::ConnectionGroup + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + x-read-only-properties: + - Id + - Arn + - CreatedTime + - LastModifiedTime + - RoutingEndpoint + - Status + - IsDefault + - ETag + x-required-properties: + - Name + x-tagging: + cloudFormationSystemTags: false + permissions: + - cloudfront:TagResource + - cloudfront:ListTagsForResource + - cloudfront:UntagResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - cloudfront:CreateConnectionGroup + - cloudfront:GetConnectionGroup + - cloudfront:TagResource + delete: + - cloudfront:DeleteConnectionGroup + - cloudfront:GetConnectionGroup + - cloudfront:UpdateConnectionGroup + list: + - cloudfront:ListConnectionGroups + - cloudfront:ListTagsForResource + read: + - cloudfront:GetConnectionGroup + - cloudfront:ListTagsForResource + update: + - cloudfront:GetConnectionGroup + - cloudfront:UpdateConnectionGroup + - cloudfront:ListTagsForResource + - cloudfront:TagResource + - cloudfront:UntagResource ContinuousDeploymentPolicyConfig: additionalProperties: false properties: Enabled: type: boolean + description: A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is ``true``, this policy is enabled and in effect. When this value is ``false``, this policy is not enabled and has no effect. SingleHeaderPolicyConfig: additionalProperties: false properties: @@ -182,6 +855,7 @@ components: - Header - Value type: object + description: This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution. SingleWeightPolicyConfig: additionalProperties: false properties: @@ -195,6 +869,7 @@ components: required: - Weight type: object + description: This configuration determines the percentage of HTTP requests that are sent to the staging distribution. StagingDistributionDnsNames: x-insertionOrder: true items: @@ -202,17 +877,21 @@ components: minItems: 1 type: array uniqueItems: true + description: 'The CloudFront domain name of the staging distribution. For example: ``d111111abcdef8.cloudfront.net``.' TrafficConfig: $ref: '#/components/schemas/TrafficConfig' + description: Contains the parameters for routing production traffic from your primary to staging distributions. Type: enum: - SingleWeight - SingleHeader type: string + description: The type of traffic configuration. required: - Enabled - StagingDistributionDnsNames type: object + description: Contains the configuration for a continuous deployment policy. SessionStickinessConfig: additionalProperties: false properties: @@ -221,15 +900,18 @@ components: minimum: 300 multipleOf: 1 type: integer + description: The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes). MaximumTTL: maximum: 3600 minimum: 300 multipleOf: 1 type: integer + description: The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes). required: - IdleTTL - MaximumTTL type: object + description: Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. SingleHeaderConfig: additionalProperties: false properties: @@ -237,59 +919,84 @@ components: maxLength: 256 minLength: 1 type: string + description: The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix ``aws-cf-cd-``. Value: maxLength: 1783 minLength: 1 type: string + description: The request header value. required: - Header - Value type: object + description: Determines which HTTP requests are sent to the staging distribution. SingleWeightConfig: additionalProperties: false properties: SessionStickinessConfig: $ref: '#/components/schemas/SessionStickinessConfig' + description: Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values. Weight: maximum: 1 minimum: 0 multipleOf: 0.01 type: number + description: The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution. required: - Weight type: object + description: This configuration determines the percentage of HTTP requests that are sent to the staging distribution. TrafficConfig: additionalProperties: false properties: SingleHeaderConfig: $ref: '#/components/schemas/SingleHeaderConfig' + description: Determines which HTTP requests are sent to the staging distribution. SingleWeightConfig: $ref: '#/components/schemas/SingleWeightConfig' + description: Contains the percentage of traffic to send to the staging distribution. Type: enum: - SingleWeight - SingleHeader type: string + description: The type of traffic configuration. required: - Type type: object + description: The traffic configuration of your continuous deployment. ContinuousDeploymentPolicy: type: object properties: ContinuousDeploymentPolicyConfig: $ref: '#/components/schemas/ContinuousDeploymentPolicyConfig' + description: Contains the configuration for a continuous deployment policy. Id: type: string + description: '' LastModifiedTime: type: string + description: '' required: - ContinuousDeploymentPolicyConfig x-stackql-resource-name: continuous_deployment_policy - x-stackql-primaryIdentifier: + description: |- + Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution. + After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration. + For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide*. + x-type-name: AWS::CloudFront::ContinuousDeploymentPolicy + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - LastModifiedTime + x-required-properties: + - ContinuousDeploymentPolicyConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateContinuousDeploymentPolicy @@ -348,8 +1055,9 @@ components: default: 86400 type: number description: |- - This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. - The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. FieldLevelEncryptionId: default: '' type: string @@ -359,13 +1067,18 @@ components: description: |- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. - If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-r + If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. + A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. + A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. FunctionAssociations: items: $ref: '#/components/schemas/FunctionAssociation' type: array uniqueItems: false description: A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior. + GrpcConfig: + $ref: '#/components/schemas/GrpcConfig' + description: The gRPC configuration for your cache behavior. LambdaFunctionAssociations: items: $ref: '#/components/schemas/LambdaFunctionAssociation' @@ -376,15 +1089,17 @@ components: default: 31536000 type: number description: |- - This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. - The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. MinTTL: default: 0 type: number description: |- - This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. - You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``He + You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``). OriginRequestPolicyId: type: string description: >- @@ -406,7 +1121,9 @@ components: SmoothStreaming: default: false type: boolean - description: Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. + description: |- + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. TargetOriginId: type: string description: The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior. @@ -425,18 +1142,19 @@ components: uniqueItems: false description: |- We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. ViewerProtocolPolicy: type: string description: |- The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: - + ``allow-all``: Viewers can use HTTP or HTTPS. - + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. - + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). + + ``allow-all``: Viewers can use HTTP or HTTPS. + + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. - The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol + The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. required: - PathPattern - TargetOriginId @@ -446,8 +1164,15 @@ components: A complex type that describes how CloudFront processes requests. You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used. For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*. - If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't include an empty ``CacheBehavior`` element because this is invalid. - To delete all cache behaviors in an exist + If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't specify an empty individual ``CacheBehavior`` element, because this is invalid. For more information, see [CacheBehaviors](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html). + To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty ``CacheBehaviors`` element. + To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution. + For more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*. + ConnectionMode: + enum: + - direct + - tenant-only + type: string Cookies: additionalProperties: false properties: @@ -458,7 +1183,7 @@ components: If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. - Amazon S3 doesn't process cookies. When the cache behavior is forw + Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element. WhitelistedNames: items: type: string @@ -468,7 +1193,9 @@ components: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. - Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward se + Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. + If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically. + For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*. required: - Forward type: object @@ -476,7 +1203,7 @@ components: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. - A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs C + A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. CustomErrorResponse: additionalProperties: false properties: @@ -506,7 +1233,7 @@ components: + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. - We recommend + We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable. required: - ErrorCode type: object @@ -531,21 +1258,21 @@ components: default: 5 type: integer description: |- - Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. - For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*. + Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. + For more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*. OriginProtocolPolicy: type: string description: |- Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: - + ``http-only`` – CloudFront always uses HTTP to connect to the origin. - + ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. - + ``https-only`` – CloudFront always uses HTTPS to connect to the origin. + + ``http-only`` – CloudFront always uses HTTP to connect to the origin. + + ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. + + ``https-only`` – CloudFront always uses HTTPS to connect to the origin. OriginReadTimeout: default: 30 type: integer description: |- - Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. - For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*. + Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. + For more information, see [Response timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*. OriginSSLProtocols: default: - TLSv1 @@ -556,11 +1283,18 @@ components: uniqueItems: false description: |- Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. - For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*. + For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*. + IpAddressType: + type: string + enum: + - ipv4 + - ipv6 + - dualstack + description: '' required: - OriginProtocolPolicy type: object - description: A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin. + description: A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin. DefaultCacheBehavior: additionalProperties: false properties: @@ -607,8 +1341,9 @@ components: default: 86400 type: number description: |- - This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. - The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. FieldLevelEncryptionId: default: '' type: string @@ -618,13 +1353,18 @@ components: description: |- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. - If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-r + If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. + A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. + A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. FunctionAssociations: items: $ref: '#/components/schemas/FunctionAssociation' type: array uniqueItems: false - description: A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior. + description: A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the ``LIVE`` stage to associate them with a cache behavior. + GrpcConfig: + $ref: '#/components/schemas/GrpcConfig' + description: The gRPC configuration for your cache behavior. LambdaFunctionAssociations: items: $ref: '#/components/schemas/LambdaFunctionAssociation' @@ -635,15 +1375,17 @@ components: default: 31536000 type: number description: |- - This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. - The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. MinTTL: default: 0 type: number description: |- - This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. - You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``He + You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``). OriginRequestPolicyId: default: '' type: string @@ -661,7 +1403,9 @@ components: SmoothStreaming: default: false type: boolean - description: Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. + description: |- + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. TargetOriginId: type: string description: The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior. @@ -680,18 +1424,19 @@ components: uniqueItems: false description: |- We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. ViewerProtocolPolicy: type: string description: |- The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: - + ``allow-all``: Viewers can use HTTP or HTTPS. - + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. - + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). + + ``allow-all``: Viewers can use HTTP or HTTPS. + + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. - The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol + The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. required: - TargetOriginId - ViewerProtocolPolicy @@ -705,13 +1450,22 @@ components: type: string type: array uniqueItems: false - description: A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. + description: |- + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. + AnycastIpListId: + type: string + description: |- + To use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html). + ID of the Anycast static IP list that is associated with the distribution. CNAMEs: items: type: string type: array uniqueItems: false - description: '' + description: |- + An alias for the CF distribution's domain name. + This property is legacy. We recommend that you use [Aliases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases) instead. CacheBehaviors: items: $ref: '#/components/schemas/CacheBehavior' @@ -722,9 +1476,14 @@ components: default: '' type: string description: A comment to describe the distribution. The comment cannot be longer than 128 characters. + ConnectionMode: + $ref: '#/components/schemas/ConnectionMode' + description: This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants(tenant-only). ContinuousDeploymentPolicyId: type: string - description: The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``. + description: |- + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``. CustomErrorResponses: items: $ref: '#/components/schemas/CustomErrorResponse' @@ -738,20 +1497,23 @@ components: For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*. CustomOrigin: $ref: '#/components/schemas/LegacyCustomOrigin' - description: '' + description: |- + The user-defined HTTP server that serves as the origin for content that CF distributes. + This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead. DefaultCacheBehavior: $ref: '#/components/schemas/DefaultCacheBehavior' description: A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. DefaultRootObject: default: '' type: string - description: |- - The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. - Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. + description: >- + When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is ``https://www.example.com``, you can specify CloudFront to return the ``index.html`` file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, + ``https://www.example.com/product-description.html``). A default root object avoids exposing the contents of your distribution. + You can specify the object name or a path to the object name (for example, ``index.html`` or ``exampleFolderName/index.html``). Your string can't begin with a forward slash (``/``). Only specify the object name or the path to the object. If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. To replace the default root object, update the distribution configuration and specify the new object. - For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/D + For more information about the default root object, see [Specify a default root object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*. Enabled: type: boolean description: From this field, you can enable or disable the selected distribution. @@ -759,14 +1521,21 @@ components: default: http1.1 type: string description: |- - (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. + (Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html). IPV6Enabled: type: boolean description: |- - If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. - In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/Devel + To use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html). + If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. + In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. + If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + + You enable IPv6 for the distribution + + You're using alternate domain names in the URLs for your objects + + For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. + If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. Logging: $ref: '#/components/schemas/Logging' description: |- @@ -774,19 +1543,24 @@ components: For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. OriginGroups: $ref: '#/components/schemas/OriginGroups' - description: A complex type that contains information about origin groups for this distribution. + description: |- + A complex type that contains information about origin groups for this distribution. + Specify a value for either the ``Origins`` or ``OriginGroups`` property. Origins: + x-insertionOrder: false items: $ref: '#/components/schemas/Origin' type: array - x-insertionOrder: false uniqueItems: false - description: A complex type that contains information about origins for this distribution. + description: |- + A complex type that contains information about origins for this distribution. + Specify a value for either the ``Origins`` or ``OriginGroups`` property. PriceClass: default: PriceClass_All type: string description: |- - The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/). Restrictions: @@ -797,10 +1571,25 @@ components: description: A complex type that identifies ways in which you want to restrict distribution of your content. S3Origin: $ref: '#/components/schemas/LegacyS3Origin' - description: '' + description: |- + The origin as an S3 bucket. + This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead. Staging: type: boolean - description: A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution. + description: |- + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution. + TenantConfig: + properties: + ParameterDefinitions: + items: + $ref: '#/components/schemas/ParameterDefinition' + type: array + additionalProperties: false + type: object + description: |- + This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + A distribution tenant configuration. ViewerCertificate: $ref: '#/components/schemas/ViewerCertificate' default: @@ -810,8 +1599,9 @@ components: default: '' type: string description: |- - A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. - WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest + Multi-tenant distributions only support WAF V2 web ACLs. + A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``a1b2c3d4-5678-90ab-cdef-EXAMPLE11111``. + WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). required: - Enabled - DefaultCacheBehavior @@ -828,7 +1618,7 @@ components: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. - A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs C + A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. Headers: items: type: string @@ -838,14 +1628,19 @@ components: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. - A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versio + A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. + For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*. QueryString: type: boolean description: |- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. - Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of + Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: + If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. + If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. + If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. + For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*. QueryStringCacheKeys: items: type: string @@ -860,7 +1655,8 @@ components: - QueryString type: object description: |- - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. @@ -891,13 +1687,26 @@ components: type: string description: |- The method that you want to use to restrict distribution of your content by country: - + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content. - + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content. + + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location. + + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content. + + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content. required: - RestrictionType type: object description: A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. + GrpcConfig: + additionalProperties: false + properties: + Enabled: + type: boolean + description: Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins. + required: + - Enabled + type: object + description: |- + Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads, making it suitable for applications that require low latency communications. + To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported ``HTTP`` versions and allow ``HTTP`` methods, including ``POST``. + For more information, see [Using gRPC with CloudFront distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-using-grpc.html) in the *Amazon CloudFront Developer Guide*. LambdaFunctionAssociation: additionalProperties: false properties: @@ -905,10 +1714,10 @@ components: type: string description: |- Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: - + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. - + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. - + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. - + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. + + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute. IncludeBody: type: boolean @@ -923,50 +1732,58 @@ components: properties: DNSName: type: string - description: '' + description: The domain name assigned to your CF distribution. HTTPPort: default: 80 type: integer - description: '' + description: The HTTP port that CF uses to connect to the origin. Specify the HTTP port that the origin listens on. HTTPSPort: default: 443 type: integer - description: '' + description: The HTTPS port that CF uses to connect to the origin. Specify the HTTPS port that the origin listens on. OriginProtocolPolicy: type: string - description: '' + description: Specifies the protocol (HTTP or HTTPS) that CF uses to connect to the origin. OriginSSLProtocols: items: type: string type: array uniqueItems: false - description: '' + description: |- + The minimum SSL/TLS protocol version that CF uses when communicating with your origin server over HTTPs. + For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Developer Guide*. required: - DNSName - OriginProtocolPolicy - OriginSSLProtocols type: object - description: '' + description: |- + A custom origin. A custom origin is any origin that is *not* an S3 bucket, with one exception. An S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin. + This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead. LegacyS3Origin: additionalProperties: false properties: DNSName: type: string - description: '' + description: The domain name assigned to your CF distribution. OriginAccessIdentity: default: '' type: string - description: '' + description: |- + The CF origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an S3 through CF. + This property is legacy. We recommend that you use [OriginAccessControl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html) instead. required: - DNSName type: object - description: '' + description: |- + The origin as an S3 bucket. + This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead. Logging: additionalProperties: false properties: Bucket: type: string - description: The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``. + description: The Amazon S3 bucket to store the access logs in, for example, ``amzn-s3-demo-bucket.s3.amazonaws.com``. IncludeCookies: default: false type: boolean @@ -975,10 +1792,10 @@ components: default: '' type: string description: An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element. - required: - - Bucket type: object - description: A complex type that controls whether access logs are written for the distribution. + description: |- + A complex type that specifies whether access logs are written for the distribution. + If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a *different* Amazon S3 bucket or use a *separate path* in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see [Standard logging (access logs)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. Origin: additionalProperties: false properties: @@ -993,6 +1810,9 @@ components: description: |- The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*. + ResponseCompletionTimeout: + type: integer + description: '' CustomOriginConfig: $ref: '#/components/schemas/CustomOriginConfig' description: Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead. @@ -1033,6 +1853,9 @@ components: S3OriginConfig: $ref: '#/components/schemas/S3OriginConfig' description: Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead. + VpcOriginConfig: + $ref: '#/components/schemas/VpcOriginConfig' + description: The VPC origin configuration. required: - DomainName - Id @@ -1041,6 +1864,7 @@ components: An origin. An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin: + Use ``S3OriginConfig`` to specify an Amazon S3 bucket that is not configured with static website hosting. + + Use ``VpcOriginConfig`` to specify a VPC origin. + Use ``CustomOriginConfig`` to specify all other kinds of origins, including: + An Amazon S3 bucket that is configured with static website hosting + An Elastic Load Balancing load balancer @@ -1076,12 +1900,17 @@ components: Members: $ref: '#/components/schemas/OriginGroupMembers' description: A complex type that contains information about the origins in an origin group. + SelectionCriteria: + $ref: '#/components/schemas/OriginGroupSelectionCriteria' + description: The selection criteria for the origin group. For more information, see [Create an origin group](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating) in the *Amazon CloudFront Developer Guide*. required: - Id - FailoverCriteria - Members type: object - description: An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen. + description: |- + An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen. + Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests. OriginGroupFailoverCriteria: additionalProperties: false properties: @@ -1119,6 +1948,11 @@ components: - Items type: object description: A complex data type for the origins included in an origin group. + OriginGroupSelectionCriteria: + enum: + - default + - media-quality-based + type: string OriginGroups: additionalProperties: false properties: @@ -1153,6 +1987,34 @@ components: description: |- CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*. + ParameterDefinition: + properties: + Name: + type: string + description: The name of the parameter. + Definition: + properties: + StringSchema: + properties: + Comment: + type: string + DefaultValue: + type: string + Required: + type: boolean + additionalProperties: false + required: + - Required + type: object + additionalProperties: false + type: object + description: The value that you assigned to the parameter. + required: + - Name + - Definition + additionalProperties: false + type: object + description: A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. Restrictions: additionalProperties: false properties: @@ -1170,13 +2032,18 @@ components: default: '' type: string description: |- - The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: - origin-access-identity/cloudfront/*ID-of-origin-access-identity* - where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. + If you're using origin access control (OAC) instead of origin access identity, specify an empty ``OriginAccessIdentity`` element. For more information, see [Restricting access to an](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*. + The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: + ``origin-access-identity/cloudfront/ID-of-origin-access-identity`` + The ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. - For more information about the origin access identity, see [Serving Private Content through CloudFront](https://d + For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. + OriginReadTimeout: + default: 30 + type: integer + description: '' type: object description: A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead. StatusCodes: @@ -1196,24 +2063,6 @@ components: - Items type: object description: A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin. - Tag: - additionalProperties: false - properties: - Key: - type: string - description: |- - A string that contains ``Tag`` key. - The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``. - Value: - type: string - description: |- - A string that contains an optional ``Tag`` value. - The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``. - required: - - Value - - Key - type: object - description: A complex type that contains ``Tag`` key and ``Tag`` value. ViewerCertificate: additionalProperties: false properties: @@ -1228,13 +2077,14 @@ components: description: |- If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields: - + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) + + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) + ``MinimumProtocolVersion`` + ``SslSupportMethod`` IamCertificateId: type: string description: |- - In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization. + This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*. + In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) MinimumProtocolVersion: @@ -1246,22 +2096,57 @@ components: For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*. On the CloudFront console, this setting is called *Security Policy*. - When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-onl + When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here. SslSupportMethod: type: string description: |- In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from. - + ``sni-only`` – The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI. - + ``vip`` – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront. - + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home). + + ``sni-only`` – The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI. + + ``vip`` – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront. + + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home). + + If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field. type: object description: |- A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI. - + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field n + + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + + + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*. + + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): + + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.) + + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.) + + + All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``. + For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*. + VpcOriginConfig: + additionalProperties: false + properties: + OriginKeepaliveTimeout: + default: 5 + type: integer + description: |- + Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds. + For more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*. + OriginReadTimeout: + default: 30 + type: integer + description: |- + Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds. + For more information, see [Response timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*. + VpcOriginId: + type: string + description: The VPC origin ID. + required: + - VpcOriginId + type: object + description: An Amazon CloudFront VPC origin configuration. Distribution: type: object properties: @@ -1283,15 +2168,31 @@ components: required: - DistributionConfig x-stackql-resource-name: distribution - x-stackql-primaryIdentifier: + description: A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. + x-type-name: AWS::CloudFront::Distribution + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - DomainName + x-required-properties: + - DistributionConfig + x-tagging: + cloudFormationSystemTags: false + permissions: + - cloudfront:TagResource + - cloudfront:ListTagsForResource + - cloudfront:UntagResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true x-required-permissions: create: + - cloudfront:CreateConnectionGroup - cloudfront:CreateDistribution - cloudfront:CreateDistributionWithTags + - cloudfront:GetConnectionGroup - cloudfront:GetDistribution - cloudfront:GetDistributionConfig - cloudfront:TagResource @@ -1300,11 +2201,14 @@ components: - cloudfront:GetDistribution - cloudfront:GetDistributionConfig list: + - cloudfront:ListTagsForResource - cloudfront:ListDistributions read: - cloudfront:GetDistribution - cloudfront:GetDistributionConfig update: + - cloudfront:CreateConnectionGroup + - cloudfront:GetConnectionGroup - cloudfront:GetDistribution - cloudfront:GetDistributionConfig - cloudfront:UpdateDistribution @@ -1312,64 +2216,337 @@ components: - cloudfront:ListTagsForResource - cloudfront:TagResource - cloudfront:UntagResource + Certificate: + additionalProperties: false + properties: + Arn: + type: string + description: The Amazon Resource Name (ARN) of the ACM certificate. + type: object + description: The ACMlong (ACM) certificate associated with your distribution. + Customizations: + additionalProperties: false + properties: + WebAcl: + $ref: '#/components/schemas/WebAclCustomization' + description: The WAF web ACL. + Certificate: + $ref: '#/components/schemas/Certificate' + description: The ACMlong (ACM) certificate. + GeoRestrictions: + $ref: '#/components/schemas/GeoRestrictionCustomization' + description: The geographic restrictions. + type: object + description: Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. + DomainResult: + additionalProperties: false + properties: + Domain: + type: string + description: The specified domain. + Status: + type: string + enum: + - active + - inactive + description: Whether the domain is active or inactive. + type: object + description: The details about the domain result. + GeoRestrictionCustomization: + additionalProperties: false + properties: + RestrictionType: + enum: + - blacklist + - whitelist + - none + type: string + description: |- + The method that you want to use to restrict distribution of your content by country: + + ``none``: No geographic restriction is enabled, meaning access to content is not restricted by client geo location. + + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content. + + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content. + Locations: + items: + type: string + type: array + uniqueItems: false + description: The locations for geographic restrictions. + type: object + description: The customizations that you specified for the distribution tenant for geographic restrictions. + ManagedCertificateRequest: + additionalProperties: false + properties: + ValidationTokenHost: + enum: + - cloudfront + - self-hosted + type: string + description: |- + Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate. + + For ``cloudfront``, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately. + + For ``self-hosted``, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront. + PrimaryDomainName: + type: string + description: The primary domain name associated with the CloudFront managed ACM certificate. + CertificateTransparencyLoggingPreference: + enum: + - enabled + - disabled + type: string + description: You can opt out of certificate transparency logging by specifying the ``disabled`` option. Opt in by specifying ``enabled``. For more information, see [Certificate Transparency Logging](https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency) in the *User Guide*. + type: object + description: An object that represents the request for the Amazon CloudFront managed ACM certificate. + Parameter: + additionalProperties: false + properties: + Name: + type: string + description: The parameter name. + Value: + type: string + description: The parameter value. + type: object + description: A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. + WebAclCustomization: + additionalProperties: false + properties: + Action: + enum: + - override + - disable + type: string + description: The action for the WAF web ACL customization. You can specify ``override`` to specify a separate WAF web ACL for the distribution tenant. If you specify ``disable``, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution. + Arn: + type: string + description: The Amazon Resource Name (ARN) of the WAF web ACL. + type: object + description: The WAF web ACL customization specified for the distribution tenant. + DistributionTenant: + type: object + properties: + Id: + type: string + description: '' + DistributionId: + type: string + description: The ID of the multi-tenant distribution. + Name: + type: string + description: The name of the distribution tenant. + Arn: + type: string + description: '' + DomainResults: + items: + $ref: '#/components/schemas/DomainResult' + type: array + uniqueItems: false + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + Customizations: + $ref: '#/components/schemas/Customizations' + description: Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. + Parameters: + items: + $ref: '#/components/schemas/Parameter' + type: array + uniqueItems: false + description: A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. + ConnectionGroupId: + type: string + description: The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. + CreatedTime: + format: date-time + type: string + description: '' + LastModifiedTime: + format: date-time + type: string + description: '' + Enabled: + type: boolean + description: Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic. + Status: + type: string + description: '' + ETag: + type: string + description: '' + Domains: + items: + type: string + type: array + uniqueItems: false + description: The domains associated with the distribution tenant. + ManagedCertificateRequest: + $ref: '#/components/schemas/ManagedCertificateRequest' + description: An object that represents the request for the Amazon CloudFront managed ACM certificate. + required: + - DistributionId + - Name + - Domains + x-stackql-resource-name: distribution_tenant + description: The distribution tenant. + x-type-name: AWS::CloudFront::DistributionTenant + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + x-write-only-properties: + - ManagedCertificateRequest + x-read-only-properties: + - Id + - Arn + - DomainResults + - ETag + - Status + - CreatedTime + - LastModifiedTime + x-required-properties: + - DistributionId + - Name + - Domains + x-tagging: + cloudFormationSystemTags: false + permissions: + - cloudfront:TagResource + - cloudfront:ListTagsForResource + - cloudfront:UntagResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - acm:DescribeCertificate + - acm:RequestCertificate + - cloudfront:CreateDistributionTenant + - cloudfront:GetDistributionTenant + - cloudfront:GetManagedCertificateDetails + - cloudfront:TagResource + - cloudfront:VerifyDnsConfiguration + - wafv2:GetWebACL + delete: + - cloudfront:DeleteDistributionTenant + - cloudfront:UpdateDistributionTenant + - cloudfront:GetDistributionTenant + - wafv2:GetWebACL + list: + - cloudfront:ListDistributionTenants + - cloudfront:ListTagsForResource + read: + - cloudfront:GetDistributionTenant + - cloudfront:ListTagsForResource + update: + - acm:DescribeCertificate + - acm:RequestCertificate + - cloudfront:GetDistributionTenant + - cloudfront:GetManagedCertificateDetails + - cloudfront:UpdateDistributionTenant + - cloudfront:ListTagsForResource + - cloudfront:TagResource + - cloudfront:UntagResource + - cloudfront:VerifyDnsConfiguration + - wafv2:GetWebACL FunctionConfig: additionalProperties: false properties: Comment: type: string + description: A comment to describe the function. Runtime: type: string + description: The function's runtime environment version. KeyValueStoreAssociations: items: $ref: '#/components/schemas/KeyValueStoreAssociation' type: array uniqueItems: true + description: The configuration for the key value store associations. required: - Comment - Runtime type: object + description: Contains configuration information about a CloudFront function. FunctionMetadata: additionalProperties: false properties: FunctionARN: type: string + description: The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function. type: object + description: Contains metadata about a CloudFront function. KeyValueStoreAssociation: additionalProperties: false properties: KeyValueStoreARN: type: string + description: The Amazon Resource Name (ARN) of the key value store association. required: - KeyValueStoreARN type: object + description: The key value store association. Function: type: object properties: AutoPublish: type: boolean + description: A flag that determines whether to automatically publish the function to the ``LIVE`` stage when it’s created. To automatically publish to the ``LIVE`` stage, set this property to ``true``. FunctionARN: type: string + description: '' FunctionCode: type: string + description: The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide*. FunctionConfig: $ref: '#/components/schemas/FunctionConfig' + description: Contains configuration information about a CloudFront function. FunctionMetadata: $ref: '#/components/schemas/FunctionMetadata' + description: Contains metadata about a CloudFront function. Name: type: string + description: A name to identify the function. Stage: type: string + description: '' required: - Name - FunctionConfig - FunctionCode x-stackql-resource-name: function - x-stackql-primaryIdentifier: + description: |- + Creates a CF function. + To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage. + By default, when you create a function, it’s in the ``DEVELOPMENT`` stage. In this stage, you can [test the function](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/test-function.html) in the CF console (or with ``TestFunction`` in the CF API). + When you’re ready to use your function with a CF distribution, publish the function to the ``LIVE`` stage. You can do this in the CF console, with ``PublishFunction`` in the CF API, or by updating the ``AWS::CloudFront::Function`` resource with the ``AutoPublish`` property set to ``true``. When the function is published to the ``LIVE`` stage, you can attach it to a distribution’s cache behavior, using the function’s ARN. + To automatically publish the function to the ``LIVE`` stage when it’s created, set the ``AutoPublish`` property to ``true``. + x-type-name: AWS::CloudFront::Function + x-stackql-primary-identifier: - FunctionARN + x-create-only-properties: + - Name + x-write-only-properties: + - AutoPublish x-read-only-properties: - FunctionARN - FunctionMetadata/FunctionARN - Stage + x-required-properties: + - Name + - FunctionConfig + - FunctionCode + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateFunction @@ -1392,34 +2569,54 @@ components: properties: Comment: type: string + description: A comment to describe the key group. The comment cannot be longer than 128 characters. Items: items: type: string type: array uniqueItems: false + description: A list of the identifiers of the public keys in the key group. Name: type: string + description: A name to identify the key group. required: - Name - Items type: object + description: |- + A key group configuration. + A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html). KeyGroup: type: object properties: Id: type: string + description: '' KeyGroupConfig: $ref: '#/components/schemas/KeyGroupConfig' + description: The key group configuration. LastModifiedTime: type: string + description: '' required: - KeyGroupConfig x-stackql-resource-name: key_group - x-stackql-primaryIdentifier: + description: |- + A key group. + A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html). + x-type-name: AWS::CloudFront::KeyGroup + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - LastModifiedTime + x-required-properties: + - KeyGroupConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateKeyGroup @@ -1438,38 +2635,58 @@ components: properties: SourceType: type: string + description: The source type of the import source for the key value store. SourceArn: type: string + description: The Amazon Resource Name (ARN) of the import source for the key value store. required: - SourceType - SourceArn type: object + description: The import source for the key value store. KeyValueStore: type: object properties: Arn: type: string + description: '' Id: type: string + description: '' Status: type: string + description: '' Name: type: string + description: The name of the key value store. Comment: type: string + description: A comment for the key value store. ImportSource: $ref: '#/components/schemas/ImportSource' + description: The import source for the key value store. required: - Name x-stackql-resource-name: key_value_store - x-stackql-primaryIdentifier: + description: The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values. + x-type-name: AWS::CloudFront::KeyValueStore + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - ImportSource x-read-only-properties: - Arn - Id - Status + x-required-properties: + - Name + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateKeyValueStore @@ -1492,16 +2709,28 @@ components: properties: DistributionId: type: string + description: The ID of the distribution that you are enabling metrics for. MonitoringSubscription: $ref: '#/components/schemas/MonitoringSubscription' + description: A subscription configuration for additional CloudWatch metrics. required: - DistributionId - MonitoringSubscription x-stackql-resource-name: monitoring_subscription - x-stackql-primaryIdentifier: + description: A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution. + x-type-name: AWS::CloudFront::MonitoringSubscription + x-stackql-primary-identifier: - DistributionId x-create-only-properties: - DistributionId + x-required-properties: + - DistributionId + - MonitoringSubscription + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateMonitoringSubscription @@ -1517,45 +2746,75 @@ components: - Enabled - Disabled type: string + description: A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution. required: - RealtimeMetricsSubscriptionStatus type: object + description: A subscription configuration for additional CloudWatch metrics. OriginAccessControlConfig: additionalProperties: false properties: Description: type: string + description: A description of the origin access control. Name: type: string + description: A name to identify the origin access control. You can specify up to 64 characters. OriginAccessControlOriginType: - pattern: ^(s3|mediastore)$ + pattern: ^(s3|mediastore|lambda|mediapackagev2)$ type: string + description: The type of origin that this origin access control is for. SigningBehavior: pattern: ^(never|no-override|always)$ type: string + description: |- + Specifies which requests CloudFront signs (adds authentication information to). Specify ``always`` for the most common use case. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*. + This field can have one of the following values: + + ``always`` – CloudFront signs all origin requests, overwriting the ``Authorization`` header from the viewer request if one exists. + + ``never`` – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control. + + ``no-override`` – If the viewer request doesn't contain the ``Authorization`` header, then CloudFront signs the origin request. If the viewer request contains the ``Authorization`` header, then CloudFront doesn't sign the origin request and instead passes along the ``Authorization`` header from the viewer request. *WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.* SigningProtocol: pattern: ^(sigv4)$ type: string + description: The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is ``sigv4``. required: - Name - SigningProtocol - SigningBehavior - OriginAccessControlOriginType type: object + description: |- + Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. + This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. + For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*. OriginAccessControl: type: object properties: Id: type: string + description: '' OriginAccessControlConfig: $ref: '#/components/schemas/OriginAccessControlConfig' + description: The origin access control. required: - OriginAccessControlConfig x-stackql-resource-name: origin_access_control - x-stackql-primaryIdentifier: + description: |- + Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. + This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. + For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*. + x-type-name: AWS::CloudFront::OriginAccessControl + x-stackql-primary-identifier: - Id x-read-only-properties: - Id + x-required-properties: + - OriginAccessControlConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateOriginAccessControl @@ -1574,37 +2833,69 @@ components: properties: Comment: type: string + description: A comment to describe the origin request policy. The comment cannot be longer than 128 characters. CookiesConfig: $ref: '#/components/schemas/CookiesConfig' + description: The cookies from viewer requests to include in origin requests. HeadersConfig: $ref: '#/components/schemas/HeadersConfig' + description: The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront. Name: type: string + description: A unique name to identify the origin request policy. QueryStringsConfig: $ref: '#/components/schemas/QueryStringsConfig' + description: The URL query strings from viewer requests to include in origin requests. required: - Name - HeadersConfig - CookiesConfig - QueryStringsConfig type: object + description: |- + An origin request policy configuration. + This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following: + + The request body and the URL path (without the domain name) from the viewer request. + + The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``. + + All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront. + + CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``. OriginRequestPolicy: type: object properties: Id: type: string + description: '' LastModifiedTime: type: string + description: '' OriginRequestPolicyConfig: $ref: '#/components/schemas/OriginRequestPolicyConfig' + description: The origin request policy configuration. required: - OriginRequestPolicyConfig x-stackql-resource-name: origin_request_policy - x-stackql-primaryIdentifier: + description: |- + An origin request policy. + When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following: + + The request body and the URL path (without the domain name) from the viewer request. + + The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``. + + All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront. + + CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``. + x-type-name: AWS::CloudFront::OriginRequestPolicy + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - LastModifiedTime + x-required-properties: + - OriginRequestPolicyConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateOriginRequestPolicy @@ -1623,34 +2914,51 @@ components: properties: CallerReference: type: string + description: A string included in the request to help make sure that the request can't be replayed. Comment: type: string + description: A comment to describe the public key. The comment cannot be longer than 128 characters. EncodedKey: type: string + description: The public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). Name: type: string + description: A name to help identify the public key. required: - CallerReference - Name - EncodedKey type: object + description: Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). PublicKey: type: object properties: CreatedTime: type: string + description: '' Id: type: string + description: '' PublicKeyConfig: $ref: '#/components/schemas/PublicKeyConfig' + description: Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). required: - PublicKeyConfig x-stackql-resource-name: public_key - x-stackql-primaryIdentifier: + description: A public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). + x-type-name: AWS::CloudFront::PublicKey + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - CreatedTime + x-required-properties: + - PublicKeyConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreatePublicKey @@ -1669,59 +2977,86 @@ components: properties: KinesisStreamConfig: $ref: '#/components/schemas/KinesisStreamConfig' + description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration. StreamType: type: string + description: The type of data stream where you are sending real-time log data. The only valid value is ``Kinesis``. required: - KinesisStreamConfig - StreamType type: object + description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration. KinesisStreamConfig: additionalProperties: false properties: RoleArn: type: string + description: |- + The Amazon Resource Name (ARN) of an IAMlong (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream. + For more information the IAM role, see [Real-time log configuration IAM role](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) in the *Amazon CloudFront Developer Guide*. StreamArn: type: string + description: The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data. required: - RoleArn - StreamArn type: object + description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data. RealtimeLogConfig: type: object properties: Arn: type: string + description: '' EndPoints: items: $ref: '#/components/schemas/EndPoint' minItems: 1 type: array uniqueItems: false + description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration. Fields: items: type: string minItems: 1 type: array uniqueItems: false + description: |- + A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream. + For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*. Name: type: string + description: The unique name of this real-time log configuration. SamplingRate: maximum: 100 minimum: 1 multipleOf: 1 type: number + description: The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive. required: - Name - EndPoints - Fields - SamplingRate x-stackql-resource-name: realtime_log_config - x-stackql-primaryIdentifier: + description: A real-time log configuration. + x-type-name: AWS::CloudFront::RealtimeLogConfig + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + - EndPoints + - Fields + - SamplingRate + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - cloudfront:CreateRealtimeLogConfig @@ -1745,9 +3080,13 @@ components: items: type: string type: array + description: The list of HTTP header names. You can specify ``*`` to allow all headers. required: - Items type: object + description: |- + A list of HTTP header names that CloudFront includes as values for the ``Access-Control-Allow-Headers`` HTTP response header. + For more information about the ``Access-Control-Allow-Headers`` HTTP response header, see [Access-Control-Allow-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs. AccessControlAllowMethods: additionalProperties: false properties: @@ -1756,9 +3095,24 @@ components: items: type: string type: array + description: |- + The list of HTTP methods. Valid values are: + + ``GET`` + + ``DELETE`` + + ``HEAD`` + + ``OPTIONS`` + + ``PATCH`` + + ``POST`` + + ``PUT`` + + ``ALL`` + + ``ALL`` is a special value that includes all of the listed HTTP methods. required: - Items type: object + description: |- + A list of HTTP methods that CloudFront includes as values for the ``Access-Control-Allow-Methods`` HTTP response header. + For more information about the ``Access-Control-Allow-Methods`` HTTP response header, see [Access-Control-Allow-Methods](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs. AccessControlAllowOrigins: additionalProperties: false properties: @@ -1767,9 +3121,13 @@ components: items: type: string type: array + description: The list of origins (domain names). You can specify ``*`` to allow all origins. required: - Items type: object + description: |- + A list of origins (domain names) that CloudFront can use as the value for the ``Access-Control-Allow-Origin`` HTTP response header. + For more information about the ``Access-Control-Allow-Origin`` HTTP response header, see [Access-Control-Allow-Origin](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs. AccessControlExposeHeaders: additionalProperties: false properties: @@ -1778,45 +3136,79 @@ components: items: type: string type: array + description: The list of HTTP headers. You can specify ``*`` to expose all headers. required: - Items type: object + description: |- + A list of HTTP headers that CloudFront includes as values for the ``Access-Control-Expose-Headers`` HTTP response header. + For more information about the ``Access-Control-Expose-Headers`` HTTP response header, see [Access-Control-Expose-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs. ContentSecurityPolicy: additionalProperties: false properties: ContentSecurityPolicy: type: string + description: |- + The policy directives and their values that CloudFront includes as values for the ``Content-Security-Policy`` HTTP response header. + For more information about the ``Content-Security-Policy`` HTTP response header, see [Content-Security-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs. Override: type: boolean + description: A Boolean that determines whether CloudFront overrides the ``Content-Security-Policy`` HTTP response header received from the origin with the one specified in this response headers policy. required: - Override - ContentSecurityPolicy type: object + description: |- + The policy directives and their values that CloudFront includes as values for the ``Content-Security-Policy`` HTTP response header. + For more information about the ``Content-Security-Policy`` HTTP response header, see [Content-Security-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs. ContentTypeOptions: additionalProperties: false properties: Override: type: boolean + description: A Boolean that determines whether CloudFront overrides the ``X-Content-Type-Options`` HTTP response header received from the origin with the one specified in this response headers policy. required: - Override type: object + description: |- + Determines whether CloudFront includes the ``X-Content-Type-Options`` HTTP response header with its value set to ``nosniff``. + For more information about the ``X-Content-Type-Options`` HTTP response header, see [X-Content-Type-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs. CorsConfig: additionalProperties: false properties: AccessControlAllowCredentials: type: boolean + description: |- + A Boolean that CloudFront uses as the value for the ``Access-Control-Allow-Credentials`` HTTP response header. + For more information about the ``Access-Control-Allow-Credentials`` HTTP response header, see [Access-Control-Allow-Credentials](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) in the MDN Web Docs. AccessControlAllowHeaders: $ref: '#/components/schemas/AccessControlAllowHeaders' + description: |- + A list of HTTP header names that CloudFront includes as values for the ``Access-Control-Allow-Headers`` HTTP response header. + For more information about the ``Access-Control-Allow-Headers`` HTTP response header, see [Access-Control-Allow-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs. AccessControlAllowMethods: $ref: '#/components/schemas/AccessControlAllowMethods' + description: |- + A list of HTTP methods that CloudFront includes as values for the ``Access-Control-Allow-Methods`` HTTP response header. + For more information about the ``Access-Control-Allow-Methods`` HTTP response header, see [Access-Control-Allow-Methods](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs. AccessControlAllowOrigins: $ref: '#/components/schemas/AccessControlAllowOrigins' + description: |- + A list of origins (domain names) that CloudFront can use as the value for the ``Access-Control-Allow-Origin`` HTTP response header. + For more information about the ``Access-Control-Allow-Origin`` HTTP response header, see [Access-Control-Allow-Origin](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs. AccessControlExposeHeaders: $ref: '#/components/schemas/AccessControlExposeHeaders' + description: |- + A list of HTTP headers that CloudFront includes as values for the ``Access-Control-Expose-Headers`` HTTP response header. + For more information about the ``Access-Control-Expose-Headers`` HTTP response header, see [Access-Control-Expose-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs. AccessControlMaxAgeSec: type: integer + description: |- + A number that CloudFront uses as the value for the ``Access-Control-Max-Age`` HTTP response header. + For more information about the ``Access-Control-Max-Age`` HTTP response header, see [Access-Control-Max-Age](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age) in the MDN Web Docs. OriginOverride: type: boolean + description: A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy. required: - AccessControlAllowOrigins - AccessControlAllowHeaders @@ -1824,20 +3216,27 @@ components: - AccessControlAllowCredentials - OriginOverride type: object + description: |- + A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy. + For more information about CORS, see [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs. CustomHeader: additionalProperties: false properties: Header: type: string + description: The HTTP response header name. Override: type: boolean + description: A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here. Value: type: string + description: The value for the HTTP response header. required: - Header - Value - Override type: object + description: An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy. CustomHeadersConfig: additionalProperties: false properties: @@ -1847,41 +3246,59 @@ components: $ref: '#/components/schemas/CustomHeader' type: array uniqueItems: false + description: The list of HTTP response headers and their values. required: - Items type: object + description: A list of HTTP response header names and their values. CloudFront includes these headers in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy. FrameOptions: additionalProperties: false properties: FrameOption: pattern: ^(DENY|SAMEORIGIN)$ type: string + description: |- + The value of the ``X-Frame-Options`` HTTP response header. Valid values are ``DENY`` and ``SAMEORIGIN``. + For more information about these values, see [X-Frame-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs. Override: type: boolean + description: A Boolean that determines whether CloudFront overrides the ``X-Frame-Options`` HTTP response header received from the origin with the one specified in this response headers policy. required: - Override - FrameOption type: object + description: |- + Determines whether CloudFront includes the ``X-Frame-Options`` HTTP response header and the header's value. + For more information about the ``X-Frame-Options`` HTTP response header, see [X-Frame-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs. ReferrerPolicy: additionalProperties: false properties: Override: type: boolean + description: A Boolean that determines whether CloudFront overrides the ``Referrer-Policy`` HTTP response header received from the origin with the one specified in this response headers policy. ReferrerPolicy: pattern: ^(no-referrer|no-referrer-when-downgrade|origin|origin-when-cross-origin|same-origin|strict-origin|strict-origin-when-cross-origin|unsafe-url)$ type: string + description: |- + Determines whether CloudFront includes the ``Referrer-Policy`` HTTP response header and the header's value. + For more information about the ``Referrer-Policy`` HTTP response header, see [Referrer-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs. required: - Override - ReferrerPolicy type: object + description: |- + Determines whether CloudFront includes the ``Referrer-Policy`` HTTP response header and the header's value. + For more information about the ``Referrer-Policy`` HTTP response header, see [Referrer-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs. RemoveHeader: additionalProperties: false properties: Header: type: string + description: The HTTP header name. required: - Header type: object + description: The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. RemoveHeadersConfig: additionalProperties: false properties: @@ -1891,127 +3308,1011 @@ components: $ref: '#/components/schemas/RemoveHeader' type: array uniqueItems: true + description: The list of HTTP header names. required: - Items type: object + description: A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to. ResponseHeadersPolicyConfig: additionalProperties: false properties: Comment: type: string + description: |- + A comment to describe the response headers policy. + The comment cannot be longer than 128 characters. CorsConfig: $ref: '#/components/schemas/CorsConfig' + description: A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CustomHeadersConfig: $ref: '#/components/schemas/CustomHeadersConfig' + description: A configuration for a set of custom HTTP response headers. Name: type: string + description: |- + A name to identify the response headers policy. + The name must be unique for response headers policies in this AWS-account. RemoveHeadersConfig: $ref: '#/components/schemas/RemoveHeadersConfig' + description: A configuration for a set of HTTP headers to remove from the HTTP response. SecurityHeadersConfig: $ref: '#/components/schemas/SecurityHeadersConfig' + description: A configuration for a set of security-related HTTP response headers. ServerTimingHeadersConfig: $ref: '#/components/schemas/ServerTimingHeadersConfig' + description: A configuration for enabling the ``Server-Timing`` header in HTTP responses sent from CloudFront. required: - Name type: object + description: |- + A response headers policy configuration. + A response headers policy configuration contains metadata about the response headers policy, and configurations for sets of HTTP response headers. SecurityHeadersConfig: additionalProperties: false properties: ContentSecurityPolicy: $ref: '#/components/schemas/ContentSecurityPolicy' + description: |- + The policy directives and their values that CloudFront includes as values for the ``Content-Security-Policy`` HTTP response header. + For more information about the ``Content-Security-Policy`` HTTP response header, see [Content-Security-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs. ContentTypeOptions: $ref: '#/components/schemas/ContentTypeOptions' + description: |- + Determines whether CloudFront includes the ``X-Content-Type-Options`` HTTP response header with its value set to ``nosniff``. + For more information about the ``X-Content-Type-Options`` HTTP response header, see [X-Content-Type-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs. FrameOptions: $ref: '#/components/schemas/FrameOptions' + description: |- + Determines whether CloudFront includes the ``X-Frame-Options`` HTTP response header and the header's value. + For more information about the ``X-Frame-Options`` HTTP response header, see [X-Frame-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs. ReferrerPolicy: $ref: '#/components/schemas/ReferrerPolicy' + description: |- + Determines whether CloudFront includes the ``Referrer-Policy`` HTTP response header and the header's value. + For more information about the ``Referrer-Policy`` HTTP response header, see [Referrer-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs. StrictTransportSecurity: $ref: '#/components/schemas/StrictTransportSecurity' + description: |- + Determines whether CloudFront includes the ``Strict-Transport-Security`` HTTP response header and the header's value. + For more information about the ``Strict-Transport-Security`` HTTP response header, see [Security headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#understanding-response-headers-policies-security) in the *Amazon CloudFront Developer Guide* and [Strict-Transport-Security](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs. XSSProtection: $ref: '#/components/schemas/XSSProtection' + description: |- + Determines whether CloudFront includes the ``X-XSS-Protection`` HTTP response header and the header's value. + For more information about the ``X-XSS-Protection`` HTTP response header, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs. required: [] type: object + description: A configuration for a set of security-related HTTP response headers. CloudFront adds these headers to HTTP responses that it sends for requests that match a cache behavior associated with this response headers policy. ServerTimingHeadersConfig: additionalProperties: false properties: Enabled: type: boolean + description: A Boolean that determines whether CloudFront adds the ``Server-Timing`` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy. SamplingRate: maximum: 100 minimum: 0 multipleOf: 0.0001 type: number + description: >- + A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the ``Server-Timing`` header to. When you set the sampling rate to 100, CloudFront adds the ``Server-Timing`` header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate + to any number 0–100 with up to four decimal places. required: - Enabled type: object + description: A configuration for enabling the ``Server-Timing`` header in HTTP responses sent from CloudFront. StrictTransportSecurity: additionalProperties: false properties: AccessControlMaxAgeSec: type: integer + description: A number that CloudFront uses as the value for the ``max-age`` directive in the ``Strict-Transport-Security`` HTTP response header. IncludeSubdomains: type: boolean + description: A Boolean that determines whether CloudFront includes the ``includeSubDomains`` directive in the ``Strict-Transport-Security`` HTTP response header. Override: type: boolean + description: A Boolean that determines whether CloudFront overrides the ``Strict-Transport-Security`` HTTP response header received from the origin with the one specified in this response headers policy. Preload: type: boolean + description: A Boolean that determines whether CloudFront includes the ``preload`` directive in the ``Strict-Transport-Security`` HTTP response header. required: - Override - AccessControlMaxAgeSec type: object + description: |- + Determines whether CloudFront includes the ``Strict-Transport-Security`` HTTP response header and the header's value. + For more information about the ``Strict-Transport-Security`` HTTP response header, see [Strict-Transport-Security](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs. XSSProtection: additionalProperties: false properties: ModeBlock: type: boolean + description: |- + A Boolean that determines whether CloudFront includes the ``mode=block`` directive in the ``X-XSS-Protection`` header. + For more information about this directive, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs. Override: type: boolean + description: A Boolean that determines whether CloudFront overrides the ``X-XSS-Protection`` HTTP response header received from the origin with the one specified in this response headers policy. Protection: type: boolean + description: |- + A Boolean that determines the value of the ``X-XSS-Protection`` HTTP response header. When this setting is ``true``, the value of the ``X-XSS-Protection`` header is ``1``. When this setting is ``false``, the value of the ``X-XSS-Protection`` header is ``0``. + For more information about these settings, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs. ReportUri: type: string + description: |- + A reporting URI, which CloudFront uses as the value of the ``report`` directive in the ``X-XSS-Protection`` header. + You cannot specify a ``ReportUri`` when ``ModeBlock`` is ``true``. + For more information about using a reporting URL, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs. required: - Override - Protection type: object + description: |- + Determines whether CloudFront includes the ``X-XSS-Protection`` HTTP response header and the header's value. + For more information about the ``X-XSS-Protection`` HTTP response header, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs. ResponseHeadersPolicy: type: object properties: Id: type: string + description: '' LastModifiedTime: type: string - ResponseHeadersPolicyConfig: - $ref: '#/components/schemas/ResponseHeadersPolicyConfig' - required: - - ResponseHeadersPolicyConfig - x-stackql-resource-name: response_headers_policy - x-stackql-primaryIdentifier: - - Id - x-read-only-properties: + description: '' + ResponseHeadersPolicyConfig: + $ref: '#/components/schemas/ResponseHeadersPolicyConfig' + description: A response headers policy configuration. + required: + - ResponseHeadersPolicyConfig + x-stackql-resource-name: response_headers_policy + description: |- + A response headers policy. + A response headers policy contains information about a set of HTTP response headers. + After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy. + For more information, see [Adding or removing HTTP headers in CloudFront responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) in the *Amazon CloudFront Developer Guide*. + x-type-name: AWS::CloudFront::ResponseHeadersPolicy + x-stackql-primary-identifier: + - Id + x-read-only-properties: + - Id + - LastModifiedTime + x-required-properties: + - ResponseHeadersPolicyConfig + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false + x-required-permissions: + create: + - cloudfront:CreateResponseHeadersPolicy + delete: + - cloudfront:DeleteResponseHeadersPolicy + - cloudfront:GetResponseHeadersPolicy + list: + - cloudfront:ListResponseHeadersPolicies + read: + - cloudfront:GetResponseHeadersPolicy + update: + - cloudfront:UpdateResponseHeadersPolicy + - cloudfront:GetResponseHeadersPolicy + VpcOriginEndpointConfig: + additionalProperties: false + properties: + Arn: + type: string + description: The ARN of the CloudFront VPC origin endpoint configuration. + HTTPPort: + default: 80 + type: integer + description: The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is ``80``. + HTTPSPort: + default: 443 + type: integer + description: The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is ``443``. + Name: + type: string + description: The name of the CloudFront VPC origin endpoint configuration. + OriginProtocolPolicy: + default: match-viewer + type: string + description: The origin protocol policy for the CloudFront VPC origin endpoint configuration. + OriginSSLProtocols: + default: + - TLSv1 + - SSLv3 + items: + type: string + type: array + uniqueItems: false + description: |- + Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. + For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*. + required: + - Name + - Arn + type: object + description: An Amazon CloudFront VPC origin endpoint configuration. + VpcOrigin: + type: object + properties: + Arn: + type: string + description: '' + CreatedTime: + type: string + description: '' + Id: + type: string + description: '' + LastModifiedTime: + type: string + description: '' + Status: + type: string + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + VpcOriginEndpointConfig: + $ref: '#/components/schemas/VpcOriginEndpointConfig' + description: The VPC origin endpoint configuration. + required: + - VpcOriginEndpointConfig + x-stackql-resource-name: vpc_origin + description: An Amazon CloudFront VPC origin. + x-type-name: AWS::CloudFront::VpcOrigin + x-stackql-primary-identifier: + - Id + x-read-only-properties: + - Id + - Arn + - Status + - CreatedTime + - LastModifiedTime + x-required-properties: + - VpcOriginEndpointConfig + x-tagging: + cloudFormationSystemTags: false + permissions: + - cloudfront:TagResource + - cloudfront:UntagResource + - cloudfront:ListTagsForResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - cloudfront:CreateVpcOrigin + - cloudfront:GetVpcOrigin + - cloudfront:TagResource + - ec2:DescribeInstances + - elasticloadbalancing:DescribeLoadBalancers + - ec2:DescribeInternetGateways + - iam:CreateServiceLinkedRole + - sts:AssumeRole + delete: + - cloudfront:DeleteVpcOrigin + - cloudfront:GetVpcOrigin + - elasticloadbalancing:DescribeLoadBalancers + - ec2:DescribeInstances + - ec2:DescribeInternetGateways + - iam:CreateServiceLinkedRole + - sts:AssumeRole + list: + - cloudfront:ListVpcOrigins + read: + - cloudfront:GetVpcOrigin + - cloudfront:ListTagsForResource + update: + - cloudfront:UpdateVpcOrigin + - cloudfront:GetVpcOrigin + - cloudfront:TagResource + - ec2:DescribeInstances + - cloudfront:UntagResource + - cloudfront:ListTagsForResource + - elasticloadbalancing:DescribeLoadBalancers + - ec2:DescribeInternetGateways + - iam:CreateServiceLinkedRole + - sts:AssumeRole + CreateAnycastIpListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AnycastIpList: + $ref: '#/components/schemas/AnycastIpList' + description: '' + ETag: + type: string + description: '' + Id: + type: string + description: '' + IpCount: + type: integer + description: The number of IP addresses in the Anycast static IP list. + Name: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]{1,64}$ + type: string + description: The name of the Anycast static IP list. + Tags: + $ref: '#/components/schemas/Tags' + description: A complex type that contains zero or more ``Tag`` elements. + x-stackQL-stringOnly: true + x-title: CreateAnycastIpListRequest + type: object + required: [] + CreateCachePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CachePolicyConfig: + $ref: '#/components/schemas/CachePolicyConfig' + description: The cache policy configuration. + Id: + type: string + description: '' + LastModifiedTime: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateCachePolicyRequest + type: object + required: [] + CreateCloudFrontOriginAccessIdentityRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CloudFrontOriginAccessIdentityConfig: + $ref: '#/components/schemas/CloudFrontOriginAccessIdentityConfig' + description: The current configuration information for the identity. + Id: + type: string + description: '' + S3CanonicalUserId: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateCloudFrontOriginAccessIdentityRequest + type: object + required: [] + CreateConnectionGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + Name: + type: string + description: The name of the connection group. + Arn: + type: string + description: '' + CreatedTime: + format: date-time + type: string + description: '' + LastModifiedTime: + format: date-time + type: string + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + Ipv6Enabled: + type: boolean + description: IPv6 is enabled for the connection group. + RoutingEndpoint: + type: string + description: '' + AnycastIpListId: + type: string + description: The ID of the Anycast static IP list. + Status: + type: string + description: '' + Enabled: + type: boolean + description: Whether the connection group is enabled. + IsDefault: + type: boolean + description: '' + ETag: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateConnectionGroupRequest + type: object + required: [] + CreateContinuousDeploymentPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContinuousDeploymentPolicyConfig: + $ref: '#/components/schemas/ContinuousDeploymentPolicyConfig' + description: Contains the configuration for a continuous deployment policy. + Id: + type: string + description: '' + LastModifiedTime: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateContinuousDeploymentPolicyRequest + type: object + required: [] + CreateDistributionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DistributionConfig: + $ref: '#/components/schemas/DistributionConfig' + description: The distribution's configuration. + DomainName: + type: string + description: '' + Id: + type: string + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + x-stackQL-stringOnly: true + x-title: CreateDistributionRequest + type: object + required: [] + CreateDistributionTenantRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + DistributionId: + type: string + description: The ID of the multi-tenant distribution. + Name: + type: string + description: The name of the distribution tenant. + Arn: + type: string + description: '' + DomainResults: + items: + $ref: '#/components/schemas/DomainResult' + type: array + uniqueItems: false + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + Customizations: + $ref: '#/components/schemas/Customizations' + description: Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant. + Parameters: + items: + $ref: '#/components/schemas/Parameter' + type: array + uniqueItems: false + description: A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution. + ConnectionGroupId: + type: string + description: The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group. + CreatedTime: + format: date-time + type: string + description: '' + LastModifiedTime: + format: date-time + type: string + description: '' + Enabled: + type: boolean + description: Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic. + Status: + type: string + description: '' + ETag: + type: string + description: '' + Domains: + items: + type: string + type: array + uniqueItems: false + description: The domains associated with the distribution tenant. + ManagedCertificateRequest: + $ref: '#/components/schemas/ManagedCertificateRequest' + description: An object that represents the request for the Amazon CloudFront managed ACM certificate. + x-stackQL-stringOnly: true + x-title: CreateDistributionTenantRequest + type: object + required: [] + CreateFunctionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoPublish: + type: boolean + description: A flag that determines whether to automatically publish the function to the ``LIVE`` stage when it’s created. To automatically publish to the ``LIVE`` stage, set this property to ``true``. + FunctionARN: + type: string + description: '' + FunctionCode: + type: string + description: The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide*. + FunctionConfig: + $ref: '#/components/schemas/FunctionConfig' + description: Contains configuration information about a CloudFront function. + FunctionMetadata: + $ref: '#/components/schemas/FunctionMetadata' + description: Contains metadata about a CloudFront function. + Name: + type: string + description: A name to identify the function. + Stage: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateFunctionRequest + type: object + required: [] + CreateKeyGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + KeyGroupConfig: + $ref: '#/components/schemas/KeyGroupConfig' + description: The key group configuration. + LastModifiedTime: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateKeyGroupRequest + type: object + required: [] + CreateKeyValueStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: '' + Id: + type: string + description: '' + Status: + type: string + description: '' + Name: + type: string + description: The name of the key value store. + Comment: + type: string + description: A comment for the key value store. + ImportSource: + $ref: '#/components/schemas/ImportSource' + description: The import source for the key value store. + x-stackQL-stringOnly: true + x-title: CreateKeyValueStoreRequest + type: object + required: [] + CreateMonitoringSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DistributionId: + type: string + description: The ID of the distribution that you are enabling metrics for. + MonitoringSubscription: + $ref: '#/components/schemas/MonitoringSubscription' + description: A subscription configuration for additional CloudWatch metrics. + x-stackQL-stringOnly: true + x-title: CreateMonitoringSubscriptionRequest + type: object + required: [] + CreateOriginAccessControlRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + OriginAccessControlConfig: + $ref: '#/components/schemas/OriginAccessControlConfig' + description: The origin access control. + x-stackQL-stringOnly: true + x-title: CreateOriginAccessControlRequest + type: object + required: [] + CreateOriginRequestPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + LastModifiedTime: + type: string + description: '' + OriginRequestPolicyConfig: + $ref: '#/components/schemas/OriginRequestPolicyConfig' + description: The origin request policy configuration. + x-stackQL-stringOnly: true + x-title: CreateOriginRequestPolicyRequest + type: object + required: [] + CreatePublicKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedTime: + type: string + description: '' + Id: + type: string + description: '' + PublicKeyConfig: + $ref: '#/components/schemas/PublicKeyConfig' + description: Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). + x-stackQL-stringOnly: true + x-title: CreatePublicKeyRequest + type: object + required: [] + CreateRealtimeLogConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: '' + EndPoints: + items: + $ref: '#/components/schemas/EndPoint' + minItems: 1 + type: array + uniqueItems: false + description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration. + Fields: + items: + type: string + minItems: 1 + type: array + uniqueItems: false + description: |- + A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream. + For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide*. + Name: + type: string + description: The unique name of this real-time log configuration. + SamplingRate: + maximum: 100 + minimum: 1 + multipleOf: 1 + type: number + description: The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive. + x-stackQL-stringOnly: true + x-title: CreateRealtimeLogConfigRequest + type: object + required: [] + CreateResponseHeadersPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + LastModifiedTime: + type: string + description: '' + ResponseHeadersPolicyConfig: + $ref: '#/components/schemas/ResponseHeadersPolicyConfig' + description: A response headers policy configuration. + x-stackQL-stringOnly: true + x-title: CreateResponseHeadersPolicyRequest + type: object + required: [] + CreateVpcOriginRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: '' + CreatedTime: + type: string + description: '' + Id: + type: string + description: '' + LastModifiedTime: + type: string + description: '' + Status: + type: string + description: '' + Tags: + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: false + description: A complex type that contains zero or more ``Tag`` elements. + VpcOriginEndpointConfig: + $ref: '#/components/schemas/VpcOriginEndpointConfig' + description: The VPC origin endpoint configuration. + x-stackQL-stringOnly: true + x-title: CreateVpcOriginRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + anycast_ip_lists: + name: anycast_ip_lists + id: awscc.cloudfront.anycast_ip_lists + x-cfn-schema-name: AnycastIpList + x-cfn-type-name: AWS::CloudFront::AnycastIpList + x-identifiers: - Id - - LastModifiedTime - x-required-permissions: - create: - - cloudfront:CreateResponseHeadersPolicy + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AnycastIpList&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::AnycastIpList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::AnycastIpList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/anycast_ip_lists/methods/create_resource' delete: - - cloudfront:DeleteResponseHeadersPolicy - - cloudfront:GetResponseHeadersPolicy - list: - - cloudfront:ListResponseHeadersPolicies - read: - - cloudfront:GetResponseHeadersPolicy - update: - - cloudfront:UpdateResponseHeadersPolicy - - cloudfront:GetResponseHeadersPolicy - x-stackQL-resources: - cache_policies: - name: cache_policies - id: awscc.cloudfront.cache_policies - x-cfn-schema-name: CachePolicy - x-type: list + - $ref: '#/components/x-stackQL-resources/anycast_ip_lists/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AnycastIpList') as anycast_ip_list, + JSON_EXTRACT(Properties, '$.ETag') as e_tag, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.IpCount') as ip_count, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::AnycastIpList' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AnycastIpList') as anycast_ip_list, + json_extract_path_text(Properties, 'ETag') as e_tag, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IpCount') as ip_count, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::AnycastIpList' + AND data__Identifier = '' + AND region = 'us-east-1' + anycast_ip_lists_list_only: + name: anycast_ip_lists_list_only + id: awscc.cloudfront.anycast_ip_lists_list_only + x-cfn-schema-name: AnycastIpList + x-cfn-type-name: AWS::CloudFront::AnycastIpList x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2020,7 +4321,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::AnycastIpList' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2028,19 +4329,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::AnycastIpList' AND region = 'us-east-1' - cache_policy: - name: cache_policy - id: awscc.cloudfront.cache_policy + cache_policies: + name: cache_policies + id: awscc.cloudfront.cache_policies x-cfn-schema-name: CachePolicy - x-type: get + x-cfn-type-name: AWS::CloudFront::CachePolicy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CachePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::CachePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::CachePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::CachePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cache_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cache_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cache_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2052,7 +4401,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2063,13 +4412,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' AND data__Identifier = '' AND region = 'us-east-1' - cloud_front_origin_access_identities: - name: cloud_front_origin_access_identities - id: awscc.cloudfront.cloud_front_origin_access_identities - x-cfn-schema-name: CloudFrontOriginAccessIdentity - x-type: list + cache_policies_list_only: + name: cache_policies_list_only + id: awscc.cloudfront.cache_policies_list_only + x-cfn-schema-name: CachePolicy + x-cfn-type-name: AWS::CloudFront::CachePolicy x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2078,7 +4433,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2086,19 +4441,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' AND region = 'us-east-1' - cloud_front_origin_access_identity: - name: cloud_front_origin_access_identity - id: awscc.cloudfront.cloud_front_origin_access_identity + cloud_front_origin_access_identities: + name: cloud_front_origin_access_identities + id: awscc.cloudfront.cloud_front_origin_access_identities x-cfn-schema-name: CloudFrontOriginAccessIdentity - x-type: get + x-cfn-type-name: AWS::CloudFront::CloudFrontOriginAccessIdentity x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudFrontOriginAccessIdentity&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::CloudFrontOriginAccessIdentity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::CloudFrontOriginAccessIdentity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::CloudFrontOriginAccessIdentity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2110,7 +4513,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2121,13 +4524,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' AND data__Identifier = '' AND region = 'us-east-1' - continuous_deployment_policies: - name: continuous_deployment_policies - id: awscc.cloudfront.continuous_deployment_policies - x-cfn-schema-name: ContinuousDeploymentPolicy - x-type: list + cloud_front_origin_access_identities_list_only: + name: cloud_front_origin_access_identities_list_only + id: awscc.cloudfront.cloud_front_origin_access_identities_list_only + x-cfn-schema-name: CloudFrontOriginAccessIdentity + x-cfn-type-name: AWS::CloudFront::CloudFrontOriginAccessIdentity x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2136,7 +4545,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2144,19 +4553,199 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' AND region = 'us-east-1' - continuous_deployment_policy: - name: continuous_deployment_policy - id: awscc.cloudfront.continuous_deployment_policy - x-cfn-schema-name: ContinuousDeploymentPolicy - x-type: get + connection_groups: + name: connection_groups + id: awscc.cloudfront.connection_groups + x-cfn-schema-name: ConnectionGroup + x-cfn-type-name: AWS::CloudFront::ConnectionGroup + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConnectionGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ConnectionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ConnectionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ConnectionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connection_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connection_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connection_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Ipv6Enabled') as ipv6_enabled, + JSON_EXTRACT(Properties, '$.RoutingEndpoint') as routing_endpoint, + JSON_EXTRACT(Properties, '$.AnycastIpListId') as anycast_ip_list_id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.IsDefault') as is_default, + JSON_EXTRACT(Properties, '$.ETag') as e_tag + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ConnectionGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Ipv6Enabled') as ipv6_enabled, + json_extract_path_text(Properties, 'RoutingEndpoint') as routing_endpoint, + json_extract_path_text(Properties, 'AnycastIpListId') as anycast_ip_list_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'ETag') as e_tag + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ConnectionGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + connection_groups_list_only: + name: connection_groups_list_only + id: awscc.cloudfront.connection_groups_list_only + x-cfn-schema-name: ConnectionGroup + x-cfn-type-name: AWS::CloudFront::ConnectionGroup x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ConnectionGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ConnectionGroup' + AND region = 'us-east-1' + continuous_deployment_policies: + name: continuous_deployment_policies + id: awscc.cloudfront.continuous_deployment_policies + x-cfn-schema-name: ContinuousDeploymentPolicy + x-cfn-type-name: AWS::CloudFront::ContinuousDeploymentPolicy + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContinuousDeploymentPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ContinuousDeploymentPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ContinuousDeploymentPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ContinuousDeploymentPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2168,7 +4757,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2179,13 +4768,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' AND data__Identifier = '' AND region = 'us-east-1' - distributions: - name: distributions - id: awscc.cloudfront.distributions - x-cfn-schema-name: Distribution - x-type: list + continuous_deployment_policies_list_only: + name: continuous_deployment_policies_list_only + id: awscc.cloudfront.continuous_deployment_policies_list_only + x-cfn-schema-name: ContinuousDeploymentPolicy + x-cfn-type-name: AWS::CloudFront::ContinuousDeploymentPolicy x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2194,7 +4789,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2202,19 +4797,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' AND region = 'us-east-1' - distribution: - name: distribution - id: awscc.cloudfront.distribution + distributions: + name: distributions + id: awscc.cloudfront.distributions x-cfn-schema-name: Distribution - x-type: get + x-cfn-type-name: AWS::CloudFront::Distribution x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Distribution&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::Distribution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::Distribution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::Distribution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distributions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distributions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/distributions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2227,7 +4870,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2239,13 +4882,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::Distribution' AND data__Identifier = '' AND region = 'us-east-1' - functions: - name: functions - id: awscc.cloudfront.functions - x-cfn-schema-name: Function - x-type: list + distributions_list_only: + name: distributions_list_only + id: awscc.cloudfront.distributions_list_only + x-cfn-schema-name: Distribution + x-cfn-type-name: AWS::CloudFront::Distribution x-identifiers: - - FunctionARN + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2253,28 +4902,214 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FunctionARN') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FunctionARN') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' + AND region = 'us-east-1' + distribution_tenants: + name: distribution_tenants + id: awscc.cloudfront.distribution_tenants + x-cfn-schema-name: DistributionTenant + x-cfn-type-name: AWS::CloudFront::DistributionTenant + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DistributionTenant&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::DistributionTenant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::DistributionTenant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::DistributionTenant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distribution_tenants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distribution_tenants/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/distribution_tenants/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DistributionId') as distribution_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.DomainResults') as domain_results, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Customizations') as customizations, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.ConnectionGroupId') as connection_group_id, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.ETag') as e_tag, + JSON_EXTRACT(Properties, '$.Domains') as domains, + JSON_EXTRACT(Properties, '$.ManagedCertificateRequest') as managed_certificate_request + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::DistributionTenant' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DistributionId') as distribution_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DomainResults') as domain_results, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Customizations') as customizations, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'ConnectionGroupId') as connection_group_id, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ETag') as e_tag, + json_extract_path_text(Properties, 'Domains') as domains, + json_extract_path_text(Properties, 'ManagedCertificateRequest') as managed_certificate_request + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::DistributionTenant' + AND data__Identifier = '' + AND region = 'us-east-1' + distribution_tenants_list_only: + name: distribution_tenants_list_only + id: awscc.cloudfront.distribution_tenants_list_only + x-cfn-schema-name: DistributionTenant + x-cfn-type-name: AWS::CloudFront::DistributionTenant + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::DistributionTenant' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::DistributionTenant' AND region = 'us-east-1' - function: - name: function - id: awscc.cloudfront.function + functions: + name: functions + id: awscc.cloudfront.functions x-cfn-schema-name: Function - x-type: get + x-cfn-type-name: AWS::CloudFront::Function x-identifiers: - FunctionARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Function&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::Function" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::Function" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::Function" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/functions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2290,7 +5125,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2305,13 +5140,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::Function' AND data__Identifier = '' AND region = 'us-east-1' - key_groups: - name: key_groups - id: awscc.cloudfront.key_groups - x-cfn-schema-name: KeyGroup - x-type: list + functions_list_only: + name: functions_list_only + id: awscc.cloudfront.functions_list_only + x-cfn-schema-name: Function + x-cfn-type-name: AWS::CloudFront::Function x-identifiers: - - Id + - FunctionARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2319,28 +5160,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' + JSON_EXTRACT(Properties, '$.FunctionARN') as function_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' + json_extract_path_text(Properties, 'FunctionARN') as function_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' AND region = 'us-east-1' - key_group: - name: key_group - id: awscc.cloudfront.key_group + key_groups: + name: key_groups + id: awscc.cloudfront.key_groups x-cfn-schema-name: KeyGroup - x-type: get + x-cfn-type-name: AWS::CloudFront::KeyGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KeyGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::KeyGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::KeyGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::KeyGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/key_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2352,7 +5241,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2363,13 +5252,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' AND data__Identifier = '' AND region = 'us-east-1' - key_value_stores: - name: key_value_stores - id: awscc.cloudfront.key_value_stores - x-cfn-schema-name: KeyValueStore - x-type: list + key_groups_list_only: + name: key_groups_list_only + id: awscc.cloudfront.key_groups_list_only + x-cfn-schema-name: KeyGroup + x-cfn-type-name: AWS::CloudFront::KeyGroup x-identifiers: - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2377,28 +5272,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' AND region = 'us-east-1' - key_value_store: - name: key_value_store - id: awscc.cloudfront.key_value_store + key_value_stores: + name: key_value_stores + id: awscc.cloudfront.key_value_stores x-cfn-schema-name: KeyValueStore - x-type: get + x-cfn-type-name: AWS::CloudFront::KeyValueStore x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KeyValueStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::KeyValueStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::KeyValueStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::KeyValueStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2413,7 +5356,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2427,13 +5370,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' AND data__Identifier = '' AND region = 'us-east-1' - monitoring_subscription: - name: monitoring_subscription - id: awscc.cloudfront.monitoring_subscription - x-cfn-schema-name: MonitoringSubscription - x-type: get + key_value_stores_list_only: + name: key_value_stores_list_only + id: awscc.cloudfront.key_value_stores_list_only + x-cfn-schema-name: KeyValueStore + x-cfn-type-name: AWS::CloudFront::KeyValueStore x-identifiers: - - DistributionId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2441,59 +5390,142 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.DistributionId') as distribution_id, - JSON_EXTRACT(Properties, '$.MonitoringSubscription') as monitoring_subscription - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::MonitoringSubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DistributionId') as distribution_id, - json_extract_path_text(Properties, 'MonitoringSubscription') as monitoring_subscription - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::MonitoringSubscription' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' AND region = 'us-east-1' - origin_access_controls: - name: origin_access_controls - id: awscc.cloudfront.origin_access_controls - x-cfn-schema-name: OriginAccessControl - x-type: list + monitoring_subscriptions: + name: monitoring_subscriptions + id: awscc.cloudfront.monitoring_subscriptions + x-cfn-schema-name: MonitoringSubscription + x-cfn-type-name: AWS::CloudFront::MonitoringSubscription x-identifiers: - - Id + - DistributionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MonitoringSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::MonitoringSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::MonitoringSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/monitoring_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/monitoring_subscriptions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' + data__Identifier, + JSON_EXTRACT(Properties, '$.DistributionId') as distribution_id, + JSON_EXTRACT(Properties, '$.MonitoringSubscription') as monitoring_subscription + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::MonitoringSubscription' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' + data__Identifier, + json_extract_path_text(Properties, 'DistributionId') as distribution_id, + json_extract_path_text(Properties, 'MonitoringSubscription') as monitoring_subscription + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::MonitoringSubscription' + AND data__Identifier = '' AND region = 'us-east-1' - origin_access_control: - name: origin_access_control - id: awscc.cloudfront.origin_access_control + origin_access_controls: + name: origin_access_controls + id: awscc.cloudfront.origin_access_controls x-cfn-schema-name: OriginAccessControl - x-type: get + x-cfn-type-name: AWS::CloudFront::OriginAccessControl x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OriginAccessControl&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::OriginAccessControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::OriginAccessControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::OriginAccessControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2504,7 +5536,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2514,13 +5546,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' AND data__Identifier = '' AND region = 'us-east-1' - origin_request_policies: - name: origin_request_policies - id: awscc.cloudfront.origin_request_policies - x-cfn-schema-name: OriginRequestPolicy - x-type: list + origin_access_controls_list_only: + name: origin_access_controls_list_only + id: awscc.cloudfront.origin_access_controls_list_only + x-cfn-schema-name: OriginAccessControl + x-cfn-type-name: AWS::CloudFront::OriginAccessControl x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2529,7 +5567,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2537,19 +5575,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' AND region = 'us-east-1' - origin_request_policy: - name: origin_request_policy - id: awscc.cloudfront.origin_request_policy + origin_request_policies: + name: origin_request_policies + id: awscc.cloudfront.origin_request_policies x-cfn-schema-name: OriginRequestPolicy - x-type: get + x-cfn-type-name: AWS::CloudFront::OriginRequestPolicy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OriginRequestPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::OriginRequestPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::OriginRequestPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::OriginRequestPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2561,7 +5647,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2572,13 +5658,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' AND data__Identifier = '' AND region = 'us-east-1' - public_keys: - name: public_keys - id: awscc.cloudfront.public_keys - x-cfn-schema-name: PublicKey - x-type: list + origin_request_policies_list_only: + name: origin_request_policies_list_only + id: awscc.cloudfront.origin_request_policies_list_only + x-cfn-schema-name: OriginRequestPolicy + x-cfn-type-name: AWS::CloudFront::OriginRequestPolicy x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2587,7 +5679,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2595,19 +5687,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' AND region = 'us-east-1' - public_key: - name: public_key - id: awscc.cloudfront.public_key + public_keys: + name: public_keys + id: awscc.cloudfront.public_keys x-cfn-schema-name: PublicKey - x-type: get + x-cfn-type-name: AWS::CloudFront::PublicKey x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PublicKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::PublicKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::PublicKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::PublicKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2619,7 +5759,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2630,13 +5770,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::PublicKey' AND data__Identifier = '' AND region = 'us-east-1' - realtime_log_configs: - name: realtime_log_configs - id: awscc.cloudfront.realtime_log_configs - x-cfn-schema-name: RealtimeLogConfig - x-type: list + public_keys_list_only: + name: public_keys_list_only + id: awscc.cloudfront.public_keys_list_only + x-cfn-schema-name: PublicKey + x-cfn-type-name: AWS::CloudFront::PublicKey x-identifiers: - - Arn + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2644,28 +5790,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' AND region = 'us-east-1' - realtime_log_config: - name: realtime_log_config - id: awscc.cloudfront.realtime_log_config + realtime_log_configs: + name: realtime_log_configs + id: awscc.cloudfront.realtime_log_configs x-cfn-schema-name: RealtimeLogConfig - x-type: get + x-cfn-type-name: AWS::CloudFront::RealtimeLogConfig x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RealtimeLogConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::RealtimeLogConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::RealtimeLogConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::RealtimeLogConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2679,7 +5873,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2692,13 +5886,131 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' AND data__Identifier = '' AND region = 'us-east-1' + realtime_log_configs_list_only: + name: realtime_log_configs_list_only + id: awscc.cloudfront.realtime_log_configs_list_only + x-cfn-schema-name: RealtimeLogConfig + x-cfn-type-name: AWS::CloudFront::RealtimeLogConfig + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' + AND region = 'us-east-1' response_headers_policies: name: response_headers_policies id: awscc.cloudfront.response_headers_policies x-cfn-schema-name: ResponseHeadersPolicy - x-type: list + x-cfn-type-name: AWS::CloudFront::ResponseHeadersPolicy + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResponseHeadersPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ResponseHeadersPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ResponseHeadersPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::ResponseHeadersPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, + JSON_EXTRACT(Properties, '$.ResponseHeadersPolicyConfig') as response_headers_policy_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'ResponseHeadersPolicyConfig') as response_headers_policy_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + response_headers_policies_list_only: + name: response_headers_policies_list_only + id: awscc.cloudfront.response_headers_policies_list_only + x-cfn-schema-name: ResponseHeadersPolicy + x-cfn-type-name: AWS::CloudFront::ResponseHeadersPolicy x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2717,36 +6029,990 @@ components: json_extract_path_text(Properties, 'Id') as id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' AND region = 'us-east-1' - response_headers_policy: - name: response_headers_policy - id: awscc.cloudfront.response_headers_policy - x-cfn-schema-name: ResponseHeadersPolicy - x-type: get + vpc_origins: + name: vpc_origins + id: awscc.cloudfront.vpc_origins + x-cfn-schema-name: VpcOrigin + x-cfn-type-name: AWS::CloudFront::VpcOrigin x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcOrigin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::VpcOrigin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::VpcOrigin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudFront::VpcOrigin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_origins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_origins/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_origins/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, - JSON_EXTRACT(Properties, '$.ResponseHeadersPolicyConfig') as response_headers_policy_config - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.VpcOriginEndpointConfig') as vpc_origin_endpoint_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::VpcOrigin' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'ResponseHeadersPolicyConfig') as response_headers_policy_config - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcOriginEndpointConfig') as vpc_origin_endpoint_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::VpcOrigin' AND data__Identifier = '' AND region = 'us-east-1' + vpc_origins_list_only: + name: vpc_origins_list_only + id: awscc.cloudfront.vpc_origins_list_only + x-cfn-schema-name: VpcOrigin + x-cfn-type-name: AWS::CloudFront::VpcOrigin + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::VpcOrigin' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::VpcOrigin' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AnycastIpList&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnycastIpList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnycastIpListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CachePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCachePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCachePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudFrontOriginAccessIdentity&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudFrontOriginAccessIdentity + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudFrontOriginAccessIdentityRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConnectionGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnectionGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectionGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContinuousDeploymentPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContinuousDeploymentPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContinuousDeploymentPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Distribution&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDistribution + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDistributionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DistributionTenant&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDistributionTenant + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDistributionTenantRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Function&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFunction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFunctionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__KeyGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKeyGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__KeyValueStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKeyValueStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyValueStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MonitoringSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMonitoringSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMonitoringSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OriginAccessControl&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOriginAccessControl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOriginAccessControlRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OriginRequestPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOriginRequestPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOriginRequestPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PublicKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePublicKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePublicKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RealtimeLogConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRealtimeLogConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRealtimeLogConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResponseHeadersPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResponseHeadersPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResponseHeadersPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcOrigin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcOrigin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcOriginRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cloudtrail.yaml b/providers/src/awscc/v00.00.00000/services/cloudtrail.yaml index cabb8b94..0f3adbcc 100644 --- a/providers/src/awscc/v00.00.00000/services/cloudtrail.yaml +++ b/providers/src/awscc/v00.00.00000/services/cloudtrail.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CloudTrail - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Destination: description: The resource that receives events arriving from a channel. @@ -45,15 +425,15 @@ components: pattern: (^[a-zA-Z0-9._\-]+$) Tag: description: An arbitrary set of tags (key-value pairs) for this trail. - type: object additionalProperties: false + type: object properties: - Key: - description: 'The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string Value: description: 'The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: string + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string required: - Value - Key @@ -87,12 +467,25 @@ components: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: channel - x-stackql-primaryIdentifier: + description: A channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS. + x-type-name: AWS::CloudTrail::Channel + x-stackql-primary-identifier: - ChannelArn x-create-only-properties: - Source x-read-only-properties: - ChannelArn + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - CloudTrail:AddTags + - CloudTrail:RemoveTags + - CloudTrail:ListTags x-required-permissions: create: - CloudTrail:CreateChannel @@ -100,6 +493,7 @@ components: read: - CloudTrail:GetChannel - CloudTrail:ListChannels + - CloudTrail:ListTags update: - CloudTrail:UpdateChannel - CloudTrail:GetChannel @@ -109,113 +503,306 @@ components: - CloudTrail:DeleteChannel list: - CloudTrail:ListChannels + RefreshSchedule: + description: Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule. + type: object + additionalProperties: false + properties: + Frequency: + type: object + additionalProperties: false + properties: + Unit: + description: The frequency unit. Supported values are HOURS and DAYS. + type: string + enum: + - HOURS + - DAYS + Value: + description: The frequency value. + type: integer + required: + - Unit + - Value + TimeOfDay: + type: string + description: StartTime of the automatic schedule refresh. + pattern: ^[0-9]{2}:[0-9]{2} + Status: + type: string + description: The status of the schedule. Supported values are ENABLED and DISABLED. + enum: + - ENABLED + - DISABLED + required: [] + QueryParameter: + type: string + description: 'The value of the QueryParameter. Possible values: $StartTime$, $EndTime$, $Period$.' + minLength: 1 + maxLength: 1024 + pattern: .* + Widget: + description: The dashboard widget + type: object + additionalProperties: false + properties: + QueryStatement: + description: The SQL query statement on one or more event data stores. + type: string + minLength: 1 + maxLength: 10000 + pattern: (?s).* + QueryParameters: + description: 'The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.' + type: array + items: + $ref: '#/components/schemas/QueryParameter' + minItems: 1 + maxItems: 10 + uniqueItems: false + x-insertionOrder: true + ViewProperties: + description: The view properties of the widget. + type: object + additionalProperties: false + x-patternProperties: + ^[a-zA-Z0-9._-]{3,128}$: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9._\- ]+$ + required: + - QueryStatement + Dashboard: + type: object + properties: + Widgets: + description: List of widgets on the dashboard + type: array + items: + $ref: '#/components/schemas/Widget' + uniqueItems: true + x-insertionOrder: true + CreatedTimestamp: + description: The timestamp of the dashboard creation. + $ref: '#/components/schemas/Timestamp' + DashboardArn: + description: The ARN of the dashboard. + type: string + pattern: ^[a-zA-Z0-9._/\-:]+$ + RefreshSchedule: + description: Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule. + $ref: '#/components/schemas/RefreshSchedule' + Name: + description: The name of the dashboard. + type: string + pattern: ^[a-zA-Z0-9_\-]+$ + Status: + description: The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING. + type: string + enum: + - CREATING + - CREATED + - UPDATING + - UPDATED + - DELETING + TerminationProtectionEnabled: + description: Indicates whether the dashboard is protected from termination. + type: boolean + Type: + description: The type of the dashboard. Values are CUSTOM and MANAGED. + type: string + enum: + - MANAGED + - CUSTOM + UpdatedTimestamp: + description: The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp. + $ref: '#/components/schemas/Timestamp' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: [] + x-stackql-resource-name: dashboard + description: The Amazon CloudTrail dashboard resource allows customers to manage managed dashboards and create custom dashboards. You can manually refresh custom and managed dashboards. For custom dashboards, you can also set up an automatic refresh schedule and modify dashboard widgets. + x-type-name: AWS::CloudTrail::Dashboard + x-stackql-primary-identifier: + - DashboardArn + x-read-only-properties: + - DashboardArn + - CreatedTimestamp + - UpdatedTimestamp + - Status + - Type + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - CloudTrail:AddTags + - CloudTrail:RemoveTags + - CloudTrail:ListTags + x-required-permissions: + create: + - CloudTrail:CreateDashboard + - CloudTrail:AddTags + - CloudTrail:StartQuery + - CloudTrail:StartDashboardRefresh + read: + - CloudTrail:GetDashboard + - CloudTrail:ListDashboards + - CloudTrail:ListTags + update: + - CloudTrail:UpdateDashboard + - CloudTrail:AddTags + - CloudTrail:RemoveTags + - CloudTrail:StartQuery + - CloudTrail:StartDashboardRefresh + delete: + - CloudTrail:DeleteDashboard + - CloudTrail:UpdateDashboard + list: + - CloudTrail:ListDashboards + - CloudTrail:GetDashboard + - CloudTrail:ListTags AdvancedFieldSelector: description: A single selector statement in an advanced event selector. - type: object additionalProperties: false + type: object properties: Field: + minLength: 1 + pattern: ([\w|\d|\.|_]+) description: A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN. type: string - pattern: ([\w|\d|\.|_]+) - minLength: 1 maxLength: 1000 Equals: - description: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. - type: array + minItems: 1 uniqueItems: true + description: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. x-insertionOrder: false - minItems: 1 + type: array items: - type: string - pattern: (.+) minLength: 1 + pattern: (.+) + type: string maxLength: 2048 - StartsWith: - description: An operator that includes events that match the first few characters of the event record field specified as the value of Field. - type: array + NotStartsWith: + minItems: 1 uniqueItems: true + description: An operator that excludes events that match the first few characters of the event record field specified as the value of Field. x-insertionOrder: false - minItems: 1 + type: array items: - type: string - pattern: (.+) minLength: 1 + pattern: (.+) + type: string maxLength: 2048 - EndsWith: - description: An operator that includes events that match the last few characters of the event record field specified as the value of Field. - type: array + NotEndsWith: + minItems: 1 uniqueItems: true + description: An operator that excludes events that match the last few characters of the event record field specified as the value of Field. x-insertionOrder: false - minItems: 1 + type: array items: - type: string - pattern: (.+) minLength: 1 + pattern: (.+) + type: string maxLength: 2048 - NotEquals: - description: An operator that excludes events that match the exact value of the event record field specified as the value of Field. - type: array + StartsWith: + minItems: 1 uniqueItems: true + description: An operator that includes events that match the first few characters of the event record field specified as the value of Field. x-insertionOrder: false - minItems: 1 + type: array items: - type: string - pattern: (.+) minLength: 1 + pattern: (.+) + type: string maxLength: 2048 - NotStartsWith: - description: An operator that excludes events that match the first few characters of the event record field specified as the value of Field. - type: array + EndsWith: + minItems: 1 uniqueItems: true + description: An operator that includes events that match the last few characters of the event record field specified as the value of Field. x-insertionOrder: false - minItems: 1 + type: array items: - type: string - pattern: (.+) minLength: 1 + pattern: (.+) + type: string maxLength: 2048 - NotEndsWith: - description: An operator that excludes events that match the last few characters of the event record field specified as the value of Field. - type: array + NotEquals: + minItems: 1 uniqueItems: true + description: An operator that excludes events that match the exact value of the event record field specified as the value of Field. x-insertionOrder: false - minItems: 1 + type: array items: - type: string - pattern: (.+) minLength: 1 + pattern: (.+) + type: string maxLength: 2048 required: - Field AdvancedEventSelector: description: Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record fields. They help you control costs by logging only those events that are important to you. - type: object additionalProperties: false + type: object properties: - Name: - description: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets". - type: string - minLength: 1 - maxLength: 1000 FieldSelectors: - description: Contains all selector statements in an advanced event selector. - type: array + minItems: 1 uniqueItems: true + description: Contains all selector statements in an advanced event selector. x-insertionOrder: false - minItems: 1 + type: array items: $ref: '#/components/schemas/AdvancedFieldSelector' + Name: + minLength: 1 + description: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets". + type: string + maxLength: 1000 required: - FieldSelectors InsightSelector: description: A string that contains insight types that are logged on a trail. - type: object additionalProperties: false + type: object properties: InsightType: description: The type of insight to log on a trail. type: string + ContextKeySelector: + description: An object that contains information types to be included in CloudTrail enriched events. + type: object + additionalProperties: false + properties: + Type: + description: Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext. + type: string + enum: + - RequestContext + - TagContext + Equals: + description: An operator that includes events that match the exact value of the event record field specified in Type. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 50 + items: + type: string + pattern: (.+) + minLength: 1 + maxLength: 128 + required: + - Type + - Equals EventDataStore: type: object properties: @@ -281,12 +868,28 @@ components: InsightsDestination: description: Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store type: string + MaxEventSize: + description: Specifies the maximum size allowed for the event. Valid values are Standard and Large. If you add ContextKeySelectors, this value must be set to Large. + type: string + enum: + - Standard + - Large + ContextKeySelectors: + description: An array that enriches event records in an existing event data store by including additional information specified in individual ContexKeySelector entries. If you add ContextKeySelectors, you must set MaxEventSize to Large. + type: array + items: + $ref: '#/components/schemas/ContextKeySelector' + maxItems: 2 + uniqueItems: true + x-insertionOrder: false IngestionEnabled: description: Indicates whether the event data store is ingesting events. type: boolean required: [] x-stackql-resource-name: event_data_store - x-stackql-primaryIdentifier: + description: A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode. + x-type-name: AWS::CloudTrail::EventDataStore + x-stackql-primary-identifier: - EventDataStoreArn x-read-only-properties: - EventDataStoreArn @@ -294,6 +897,17 @@ components: - UpdatedTimestamp - Status - FederationStatus + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - CloudTrail:AddTags + - CloudTrail:RemoveTags + - CloudTrail:ListTags x-required-permissions: create: - CloudTrail:CreateEventDataStore @@ -301,6 +915,7 @@ components: - CloudTrail:PutInsightSelectors - CloudTrail:EnableFederation - CloudTrail:GetEventDataStore + - CloudTrail:PutEventConfiguration - iam:PassRole - iam:GetRole - iam:CreateServiceLinkedRole @@ -316,6 +931,7 @@ components: - CloudTrail:GetEventDataStore - CloudTrail:ListEventDataStores - CloudTrail:GetInsightSelectors + - CloudTrail:GetEventConfiguration - CloudTrail:ListTags update: - CloudTrail:UpdateEventDataStore @@ -329,6 +945,7 @@ components: - CloudTrail:GetInsightSelectors - CloudTrail:EnableFederation - CloudTrail:DisableFederation + - CloudTrail:PutEventConfiguration - iam:PassRole - iam:GetRole - iam:CreateServiceLinkedRole @@ -365,10 +982,17 @@ components: - ResourceArn - ResourcePolicy x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::CloudTrail::ResourcePolicy + x-type-name: AWS::CloudTrail::ResourcePolicy + x-stackql-primary-identifier: - ResourceArn x-create-only-properties: - ResourceArn + x-required-properties: + - ResourceArn + - ResourcePolicy + x-tagging: + taggable: false x-required-permissions: create: - CloudTrail:PutResourcePolicy @@ -380,34 +1004,11 @@ components: - CloudTrail:GetResourcePolicy delete: - CloudTrail:DeleteResourcePolicy - DataResource: - description: CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. - type: object - additionalProperties: false - properties: - Type: - description: The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. - type: string - Values: - description: An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string - required: - - Type EventSelector: description: The type of email sending events to publish to the event destination. - type: object additionalProperties: false + type: object properties: - DataResources: - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/DataResource' IncludeManagementEvents: description: Specify if you want your event selector to include management events for your trail. type: boolean @@ -419,103 +1020,148 @@ components: - ReadOnly - WriteOnly ExcludeManagementEventSources: + uniqueItems: true description: An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing "kms.amazonaws.com". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail. + x-insertionOrder: false type: array + items: + type: string + DataResources: uniqueItems: true x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/DataResource' + DataResource: + description: CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. + additionalProperties: false + type: object + properties: + Type: + description: The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. + type: string + Values: + uniqueItems: true + description: An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. + x-insertionOrder: false + type: array items: type: string + required: + - Type Trail: type: object properties: - CloudWatchLogsLogGroupArn: - description: Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. + IncludeGlobalServiceEvents: + description: Specifies whether the trail is publishing events from global services such as IAM to the log files. + type: boolean + EventSelectors: + maxItems: 5 + uniqueItems: true + description: >- + Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail + doesn't log the event. You can configure up to five event selectors for a trail. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/EventSelector' + KMSKeyId: + description: Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. type: string CloudWatchLogsRoleArn: description: Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. type: string - EnableLogFileValidation: - description: Specifies whether log file validation is enabled. The default is false. - type: boolean + S3KeyPrefix: + description: Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. + type: string + maxLength: 200 AdvancedEventSelectors: + uniqueItems: true description: The advanced event selectors that were used to select events for the data store. + x-insertionOrder: false type: array items: $ref: '#/components/schemas/AdvancedEventSelector' + TrailName: + minLength: 3 + pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\._-])*[a-zA-Z0-9]$) + type: string + maxLength: 128 + IsOrganizationTrail: + description: Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. + type: boolean + InsightSelectors: uniqueItems: true + description: Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. x-insertionOrder: false - EventSelectors: - description: >- - Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail - doesn't log the event. You can configure up to five event selectors for a trail. type: array items: - $ref: '#/components/schemas/EventSelector' - maxItems: 5 - uniqueItems: true - x-insertionOrder: false - IncludeGlobalServiceEvents: - description: Specifies whether the trail is publishing events from global services such as IAM to the log files. - type: boolean - IsLogging: - description: Whether the CloudTrail is currently logging AWS API calls. - type: boolean + $ref: '#/components/schemas/InsightSelector' + CloudWatchLogsLogGroupArn: + description: Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. + type: string + SnsTopicName: + description: Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. + type: string + maxLength: 256 IsMultiRegionTrail: description: >- Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions. type: boolean - IsOrganizationTrail: - description: Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. - type: boolean - KMSKeyId: - description: Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. - type: string S3BucketName: description: Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements. type: string - S3KeyPrefix: - description: Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. + SnsTopicArn: type: string - maxLength: 200 - SnsTopicName: - description: Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. + EnableLogFileValidation: + description: Specifies whether log file validation is enabled. The default is false. + type: boolean + Arn: type: string - maxLength: 256 Tags: - type: array uniqueItems: false x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - TrailName: - type: string - pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\._-])*[a-zA-Z0-9]$) - minLength: 3 - maxLength: 128 - Arn: - type: string - SnsTopicArn: - type: string - InsightSelectors: - description: Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. type: array items: - $ref: '#/components/schemas/InsightSelector' - uniqueItems: true - x-insertionOrder: false + $ref: '#/components/schemas/Tag' + IsLogging: + description: Whether the CloudTrail is currently logging AWS API calls. + type: boolean required: - S3BucketName - IsLogging x-stackql-resource-name: trail - x-stackql-primaryIdentifier: + description: Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. + x-type-name: AWS::CloudTrail::Trail + x-stackql-primary-identifier: - TrailName x-create-only-properties: - TrailName x-read-only-properties: - Arn - SnsTopicArn + x-required-properties: + - S3BucketName + - IsLogging + x-tagging: + permissions: + - CloudTrail:AddTags + - CloudTrail:RemoveTags + - CloudTrail:ListTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - CloudTrail:GetTrail + - CloudTrail:GetTrailStatus + - CloudTrail:ListTags + - CloudTrail:GetEventSelectors + - CloudTrail:GetInsightSelectors + - CloudTrail:DescribeTrails create: - CloudTrail:CreateTrail - CloudTrail:StartLogging @@ -527,13 +1173,6 @@ components: - iam:CreateServiceLinkedRole - organizations:DescribeOrganization - organizations:ListAWSServiceAccessForOrganization - read: - - CloudTrail:GetTrail - - CloudTrail:GetTrailStatus - - CloudTrail:ListTags - - CloudTrail:GetEventSelectors - - CloudTrail:GetInsightSelectors - - CloudTrail:DescribeTrails update: - CloudTrail:UpdateTrail - CloudTrail:StartLogging @@ -549,8 +1188,6 @@ components: - organizations:ListAWSServiceAccessForOrganization - CloudTrail:GetTrail - CloudTrail:DescribeTrails - delete: - - CloudTrail:DeleteTrail list: - CloudTrail:ListTrails - CloudTrail:GetTrail @@ -559,14 +1196,433 @@ components: - CloudTrail:GetEventSelectors - CloudTrail:GetInsightSelectors - CloudTrail:DescribeTrails + delete: + - CloudTrail:DeleteTrail + CreateChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + $ref: '#/components/schemas/ChannelName' + Source: + description: The ARN of an on-premises storage solution or application, or a partner event source. + type: string + minLength: 1 + maxLength: 256 + pattern: (.*) + Destinations: + description: One or more resources to which events arriving through a channel are logged and stored. + type: array + items: + $ref: '#/components/schemas/Destination' + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + ChannelArn: + $ref: '#/components/schemas/ChannelArn' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateChannelRequest + type: object + required: [] + CreateDashboardRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Widgets: + description: List of widgets on the dashboard + type: array + items: + $ref: '#/components/schemas/Widget' + uniqueItems: true + x-insertionOrder: true + CreatedTimestamp: + description: The timestamp of the dashboard creation. + $ref: '#/components/schemas/Timestamp' + DashboardArn: + description: The ARN of the dashboard. + type: string + pattern: ^[a-zA-Z0-9._/\-:]+$ + RefreshSchedule: + description: Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule. + $ref: '#/components/schemas/RefreshSchedule' + Name: + description: The name of the dashboard. + type: string + pattern: ^[a-zA-Z0-9_\-]+$ + Status: + description: The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING. + type: string + enum: + - CREATING + - CREATED + - UPDATING + - UPDATED + - DELETING + TerminationProtectionEnabled: + description: Indicates whether the dashboard is protected from termination. + type: boolean + Type: + description: The type of the dashboard. Values are CUSTOM and MANAGED. + type: string + enum: + - MANAGED + - CUSTOM + UpdatedTimestamp: + description: The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp. + $ref: '#/components/schemas/Timestamp' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDashboardRequest + type: object + required: [] + CreateEventDataStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdvancedEventSelectors: + description: The advanced event selectors that were used to select events for the data store. + type: array + items: + $ref: '#/components/schemas/AdvancedEventSelector' + uniqueItems: true + x-insertionOrder: false + CreatedTimestamp: + description: The timestamp of the event data store's creation. + $ref: '#/components/schemas/Timestamp' + EventDataStoreArn: + description: The ARN of the event data store. + type: string + FederationEnabled: + description: Indicates whether federation is enabled on an event data store. + type: boolean + FederationRoleArn: + description: The ARN of the role used for event data store federation. + type: string + MultiRegionEnabled: + description: Indicates whether the event data store includes events from all regions, or only from the region in which it was created. + type: boolean + Name: + description: The name of the event data store. + type: string + OrganizationEnabled: + description: Indicates that an event data store is collecting logged events for an organization. + type: boolean + BillingMode: + description: The mode that the event data store will use to charge for event storage. + type: string + RetentionPeriod: + description: The retention period, in days. + type: integer + Status: + description: The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION. + type: string + TerminationProtectionEnabled: + description: Indicates whether the event data store is protected from termination. + type: boolean + UpdatedTimestamp: + description: The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp. + $ref: '#/components/schemas/Timestamp' + KmsKeyId: + description: Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + InsightSelectors: + description: Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store. + type: array + items: + $ref: '#/components/schemas/InsightSelector' + uniqueItems: true + x-insertionOrder: false + InsightsDestination: + description: Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store + type: string + MaxEventSize: + description: Specifies the maximum size allowed for the event. Valid values are Standard and Large. If you add ContextKeySelectors, this value must be set to Large. + type: string + enum: + - Standard + - Large + ContextKeySelectors: + description: An array that enriches event records in an existing event data store by including additional information specified in individual ContexKeySelector entries. If you add ContextKeySelectors, you must set MaxEventSize to Large. + type: array + items: + $ref: '#/components/schemas/ContextKeySelector' + maxItems: 2 + uniqueItems: true + x-insertionOrder: false + IngestionEnabled: + description: Indicates whether the event data store is ingesting events. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateEventDataStoreRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + description: The ARN of the AWS CloudTrail resource to which the policy applies. + type: string + ResourcePolicy: + description: A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + type: object + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateTrailRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IncludeGlobalServiceEvents: + description: Specifies whether the trail is publishing events from global services such as IAM to the log files. + type: boolean + EventSelectors: + maxItems: 5 + uniqueItems: true + description: >- + Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the + trail doesn't log the event. You can configure up to five event selectors for a trail. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/EventSelector' + KMSKeyId: + description: Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. + type: string + CloudWatchLogsRoleArn: + description: Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. + type: string + S3KeyPrefix: + description: Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. + type: string + maxLength: 200 + AdvancedEventSelectors: + uniqueItems: true + description: The advanced event selectors that were used to select events for the data store. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/AdvancedEventSelector' + TrailName: + minLength: 3 + pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9]([a-zA-Z0-9\._-])*[a-zA-Z0-9]$) + type: string + maxLength: 128 + IsOrganizationTrail: + description: Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. + type: boolean + InsightSelectors: + uniqueItems: true + description: Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InsightSelector' + CloudWatchLogsLogGroupArn: + description: Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. + type: string + SnsTopicName: + description: Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. + type: string + maxLength: 256 + IsMultiRegionTrail: + description: >- + Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails + that log events in all regions. + type: boolean + S3BucketName: + description: Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements. + type: string + SnsTopicArn: + type: string + EnableLogFileValidation: + description: Specifies whether log file validation is enabled. The default is false. + type: boolean + Arn: + type: string + Tags: + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + IsLogging: + description: Whether the CloudTrail is currently logging AWS API calls. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateTrailRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: channels: name: channels id: awscc.cloudtrail.channels x-cfn-schema-name: Channel - x-type: list + x-cfn-type-name: AWS::CloudTrail::Channel + x-identifiers: + - ChannelArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.Destinations') as destinations, + JSON_EXTRACT(Properties, '$.ChannelArn') as channel_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destinations') as destinations, + json_extract_path_text(Properties, 'ChannelArn') as channel_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + channels_list_only: + name: channels_list_only + id: awscc.cloudtrail.channels_list_only + x-cfn-schema-name: Channel + x-cfn-type-name: AWS::CloudTrail::Channel x-identifiers: - ChannelArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -585,50 +1641,114 @@ components: json_extract_path_text(Properties, 'ChannelArn') as channel_arn FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Channel' AND region = 'us-east-1' - channel: - name: channel - id: awscc.cloudtrail.channel - x-cfn-schema-name: Channel - x-type: get + dashboards: + name: dashboards + id: awscc.cloudtrail.dashboards + x-cfn-schema-name: Dashboard + x-cfn-type-name: AWS::CloudTrail::Dashboard x-identifiers: - - ChannelArn + - DashboardArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.Widgets') as widgets, + JSON_EXTRACT(Properties, '$.CreatedTimestamp') as created_timestamp, + JSON_EXTRACT(Properties, '$.DashboardArn') as dashboard_arn, + JSON_EXTRACT(Properties, '$.RefreshSchedule') as refresh_schedule, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.Destinations') as destinations, - JSON_EXTRACT(Properties, '$.ChannelArn') as channel_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.TerminationProtectionEnabled') as termination_protection_enabled, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedTimestamp') as updated_timestamp, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Channel' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Dashboard' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'Widgets') as widgets, + json_extract_path_text(Properties, 'CreatedTimestamp') as created_timestamp, + json_extract_path_text(Properties, 'DashboardArn') as dashboard_arn, + json_extract_path_text(Properties, 'RefreshSchedule') as refresh_schedule, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destinations') as destinations, - json_extract_path_text(Properties, 'ChannelArn') as channel_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'TerminationProtectionEnabled') as termination_protection_enabled, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedTimestamp') as updated_timestamp, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Channel' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Dashboard' + AND data__Identifier = '' AND region = 'us-east-1' - event_data_stores: - name: event_data_stores - id: awscc.cloudtrail.event_data_stores - x-cfn-schema-name: EventDataStore - x-type: list + dashboards_list_only: + name: dashboards_list_only + id: awscc.cloudtrail.dashboards_list_only + x-cfn-schema-name: Dashboard + x-cfn-type-name: AWS::CloudTrail::Dashboard x-identifiers: - - EventDataStoreArn + - DashboardArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -636,28 +1756,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EventDataStoreArn') as event_data_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' + JSON_EXTRACT(Properties, '$.DashboardArn') as dashboard_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Dashboard' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EventDataStoreArn') as event_data_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' + json_extract_path_text(Properties, 'DashboardArn') as dashboard_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Dashboard' AND region = 'us-east-1' - event_data_store: - name: event_data_store - id: awscc.cloudtrail.event_data_store + event_data_stores: + name: event_data_stores + id: awscc.cloudtrail.event_data_stores x-cfn-schema-name: EventDataStore - x-type: get + x-cfn-type-name: AWS::CloudTrail::EventDataStore x-identifiers: - EventDataStoreArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventDataStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::EventDataStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::EventDataStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::EventDataStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -679,12 +1847,14 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.InsightSelectors') as insight_selectors, JSON_EXTRACT(Properties, '$.InsightsDestination') as insights_destination, + JSON_EXTRACT(Properties, '$.MaxEventSize') as max_event_size, + JSON_EXTRACT(Properties, '$.ContextKeySelectors') as context_key_selectors, JSON_EXTRACT(Properties, '$.IngestionEnabled') as ingestion_enabled FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -706,21 +1876,102 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors, json_extract_path_text(Properties, 'InsightsDestination') as insights_destination, + json_extract_path_text(Properties, 'MaxEventSize') as max_event_size, + json_extract_path_text(Properties, 'ContextKeySelectors') as context_key_selectors, json_extract_path_text(Properties, 'IngestionEnabled') as ingestion_enabled FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' AND data__Identifier = '' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.cloudtrail.resource_policy + event_data_stores_list_only: + name: event_data_stores_list_only + id: awscc.cloudtrail.event_data_stores_list_only + x-cfn-schema-name: EventDataStore + x-cfn-type-name: AWS::CloudTrail::EventDataStore + x-identifiers: + - EventDataStoreArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EventDataStoreArn') as event_data_store_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EventDataStoreArn') as event_data_store_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' + AND region = 'us-east-1' + resource_policies: + name: resource_policies + id: awscc.cloudtrail.resource_policies x-cfn-schema-name: ResourcePolicy - x-type: get + x-cfn-type-name: AWS::CloudTrail::ResourcePolicy x-identifiers: - ResourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -731,7 +1982,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -745,34 +1996,126 @@ components: name: trails id: awscc.cloudtrail.trails x-cfn-schema-name: Trail - x-type: list + x-cfn-type-name: AWS::CloudTrail::Trail x-identifiers: - TrailName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Trail&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Trail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Trail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudTrail::Trail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trails/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trails/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/trails/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrailName') as trail_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' + data__Identifier, + JSON_EXTRACT(Properties, '$.IncludeGlobalServiceEvents') as include_global_service_events, + JSON_EXTRACT(Properties, '$.EventSelectors') as event_selectors, + JSON_EXTRACT(Properties, '$.KMSKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.CloudWatchLogsRoleArn') as cloud_watch_logs_role_arn, + JSON_EXTRACT(Properties, '$.S3KeyPrefix') as s3_key_prefix, + JSON_EXTRACT(Properties, '$.AdvancedEventSelectors') as advanced_event_selectors, + JSON_EXTRACT(Properties, '$.TrailName') as trail_name, + JSON_EXTRACT(Properties, '$.IsOrganizationTrail') as is_organization_trail, + JSON_EXTRACT(Properties, '$.InsightSelectors') as insight_selectors, + JSON_EXTRACT(Properties, '$.CloudWatchLogsLogGroupArn') as cloud_watch_logs_log_group_arn, + JSON_EXTRACT(Properties, '$.SnsTopicName') as sns_topic_name, + JSON_EXTRACT(Properties, '$.IsMultiRegionTrail') as is_multi_region_trail, + JSON_EXTRACT(Properties, '$.S3BucketName') as s3_bucket_name, + JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, + JSON_EXTRACT(Properties, '$.EnableLogFileValidation') as enable_log_file_validation, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.IsLogging') as is_logging + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Trail' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrailName') as trail_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' + data__Identifier, + json_extract_path_text(Properties, 'IncludeGlobalServiceEvents') as include_global_service_events, + json_extract_path_text(Properties, 'EventSelectors') as event_selectors, + json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, + json_extract_path_text(Properties, 'CloudWatchLogsRoleArn') as cloud_watch_logs_role_arn, + json_extract_path_text(Properties, 'S3KeyPrefix') as s3_key_prefix, + json_extract_path_text(Properties, 'AdvancedEventSelectors') as advanced_event_selectors, + json_extract_path_text(Properties, 'TrailName') as trail_name, + json_extract_path_text(Properties, 'IsOrganizationTrail') as is_organization_trail, + json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors, + json_extract_path_text(Properties, 'CloudWatchLogsLogGroupArn') as cloud_watch_logs_log_group_arn, + json_extract_path_text(Properties, 'SnsTopicName') as sns_topic_name, + json_extract_path_text(Properties, 'IsMultiRegionTrail') as is_multi_region_trail, + json_extract_path_text(Properties, 'S3BucketName') as s3_bucket_name, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'EnableLogFileValidation') as enable_log_file_validation, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IsLogging') as is_logging + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Trail' + AND data__Identifier = '' AND region = 'us-east-1' - trail: - name: trail - id: awscc.cloudtrail.trail + trails_list_only: + name: trails_list_only + id: awscc.cloudtrail.trails_list_only x-cfn-schema-name: Trail - x-type: get + x-cfn-type-name: AWS::CloudTrail::Trail x-identifiers: - TrailName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -780,52 +2123,377 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.CloudWatchLogsLogGroupArn') as cloud_watch_logs_log_group_arn, - JSON_EXTRACT(Properties, '$.CloudWatchLogsRoleArn') as cloud_watch_logs_role_arn, - JSON_EXTRACT(Properties, '$.EnableLogFileValidation') as enable_log_file_validation, - JSON_EXTRACT(Properties, '$.AdvancedEventSelectors') as advanced_event_selectors, - JSON_EXTRACT(Properties, '$.EventSelectors') as event_selectors, - JSON_EXTRACT(Properties, '$.IncludeGlobalServiceEvents') as include_global_service_events, - JSON_EXTRACT(Properties, '$.IsLogging') as is_logging, - JSON_EXTRACT(Properties, '$.IsMultiRegionTrail') as is_multi_region_trail, - JSON_EXTRACT(Properties, '$.IsOrganizationTrail') as is_organization_trail, - JSON_EXTRACT(Properties, '$.KMSKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.S3BucketName') as s3_bucket_name, - JSON_EXTRACT(Properties, '$.S3KeyPrefix') as s3_key_prefix, - JSON_EXTRACT(Properties, '$.SnsTopicName') as sns_topic_name, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TrailName') as trail_name, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, - JSON_EXTRACT(Properties, '$.InsightSelectors') as insight_selectors - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Trail' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrailName') as trail_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CloudWatchLogsLogGroupArn') as cloud_watch_logs_log_group_arn, - json_extract_path_text(Properties, 'CloudWatchLogsRoleArn') as cloud_watch_logs_role_arn, - json_extract_path_text(Properties, 'EnableLogFileValidation') as enable_log_file_validation, - json_extract_path_text(Properties, 'AdvancedEventSelectors') as advanced_event_selectors, - json_extract_path_text(Properties, 'EventSelectors') as event_selectors, - json_extract_path_text(Properties, 'IncludeGlobalServiceEvents') as include_global_service_events, - json_extract_path_text(Properties, 'IsLogging') as is_logging, - json_extract_path_text(Properties, 'IsMultiRegionTrail') as is_multi_region_trail, - json_extract_path_text(Properties, 'IsOrganizationTrail') as is_organization_trail, - json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, - json_extract_path_text(Properties, 'S3BucketName') as s3_bucket_name, - json_extract_path_text(Properties, 'S3KeyPrefix') as s3_key_prefix, - json_extract_path_text(Properties, 'SnsTopicName') as sns_topic_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrailName') as trail_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Trail' - AND data__Identifier = '' + json_extract_path_text(Properties, 'TrailName') as trail_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDashboard + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDashboardRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventDataStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventDataStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventDataStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Trail&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrail + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrailRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cloudwatch.yaml b/providers/src/awscc/v00.00.00000/services/cloudwatch.yaml index de8ac57a..6bf8cc64 100644 --- a/providers/src/awscc/v00.00.00000/services/cloudwatch.yaml +++ b/providers/src/awscc/v00.00.00000/services/cloudwatch.yaml @@ -1,149 +1,582 @@ openapi: 3.0.0 info: title: CloudWatch - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: MetricStat: - description: This structure defines the metric to be returned, along with the statistics, period, and units. + description: |- + This structure defines the metric to be returned, along with the statistics, period, and units. + ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type. type: object additionalProperties: false properties: Period: - description: The granularity, in seconds, of the returned data points. + description: |- + The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. + If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour). type: integer Metric: description: The metric to return, including the metric name, namespace, and dimensions. $ref: '#/components/schemas/Metric' Stat: - description: The statistic to return. + description: The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*. type: string Unit: - description: The unit to use for the returned data points. + description: |- + The unit to use for the returned data points. + Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. type: string required: - Stat - Period - Metric Metric: - description: The Metric property type represents a specific metric. + description: The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type. type: object additionalProperties: false properties: MetricName: - description: The name of the metric. + description: The name of the metric that you want the alarm to watch. This is a required field. type: string Dimensions: - description: The dimensions for the metric. + description: The metric dimensions that you want to be used for the metric that the alarm will watch. type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Dimension' Namespace: - description: The namespace of the metric. + description: The namespace of the metric that the alarm will watch. type: string Dimension: - description: Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. + description: Dimension is an embedded property of the ``AWS::CloudWatch::Alarm`` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 30 dimensions for a given metric. type: object additionalProperties: false properties: Value: - description: The value for the dimension. + description: The value for the dimension, from 1–255 characters in length. type: string Name: - description: The name of the dimension. + description: The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published. type: string required: - Value - Name MetricDataQuery: - description: This property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. + description: |- + The ``MetricDataQuery`` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. + Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. type: object additionalProperties: false properties: Label: - description: A human-readable label for this metric or expression. + description: A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default. type: string MetricStat: - description: The metric to be returned, along with statistics, period, and units. + description: |- + The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. + Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. $ref: '#/components/schemas/MetricStat' Id: - description: A short name used to tie this object to the results in the response. + description: A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. type: string ReturnData: - description: This option indicates whether to return the timestamps and raw data values of this metric. + description: |- + This option indicates whether to return the timestamps and raw data values of this metric. + When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. + This field is required. type: boolean Expression: - description: The math expression to be performed on the returned data. + description: >- + The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User + Guide*. + Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. type: string Period: - description: The period in seconds, over which the statistic is applied. + description: The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``. type: integer AccountId: description: The ID of the account where the metrics are located, if this is a cross-account alarm. type: string required: - Id + Tag: + description: Metadata that you can assign to a Metric Stream, consisting of a key-value pair. + type: object + additionalProperties: false + properties: + Key: + description: A unique identifier for the tag. + type: string + minLength: 1 + maxLength: 128 + Value: + description: String which you can use to describe or define the tag. + type: string + minLength: 0 + maxLength: 256 + required: + - Key + - Value Alarm: type: object properties: ThresholdMetricId: - description: In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. + description: In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm. type: string EvaluateLowSampleCountPercentile: - description: Used only for alarms based on percentiles. + description: Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available. type: string ExtendedStatistic: - description: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. + description: |- + The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. + For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. + For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``. type: string ComparisonOperator: - description: The arithmetic operation to use when comparing the specified statistic and threshold. + description: The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. type: string TreatMissingData: - description: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. + description: |- + Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. + If you omit this parameter, the default behavior of ``missing`` is used. type: string Dimensions: - description: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics. + description: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``. type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Dimension' Period: - description: The period in seconds, over which the statistic is applied. + description: |- + The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 20, 30, 60, and any multiple of 60. + For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. + *Minimum:* 10 type: integer EvaluationPeriods: - description: The number of periods over which data is compared to the specified threshold. + description: |- + The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M. + For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. type: integer Unit: - description: The unit of the metric associated with the alarm. + description: |- + The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. + You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. type: string Namespace: - description: The namespace of the metric associated with the alarm. + description: |- + The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. + For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) type: string OKActions: - description: The actions to execute when this alarm transitions to the OK state from any other state. + description: The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). type: array uniqueItems: false items: type: string AlarmActions: - description: The list of actions to execute when this alarm transitions into an ALARM state from any other state. + description: The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*. type: array uniqueItems: false items: type: string MetricName: - description: The name of the metric associated with the alarm. + description: The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``. type: string ActionsEnabled: description: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. type: boolean default: true Metrics: - description: An array that enables you to create an alarm based on the result of a metric math expression. + description: |- + An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. + If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``. type: array uniqueItems: true items: @@ -152,43 +585,80 @@ components: description: The description of the alarm. type: string AlarmName: - description: The name of the alarm. + description: |- + The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. type: string Statistic: - description: The statistic for the metric associated with the alarm, other than percentile. + description: |- + The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. + For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. + For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``. type: string InsufficientDataActions: - description: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. + description: The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). type: array uniqueItems: false items: type: string Arn: - description: Amazon Resource Name is a unique name for each resource. + description: '' type: string DatapointsToAlarm: - description: The number of datapoints that must be breaching to trigger the alarm. + description: |- + The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. + If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching. type: integer Threshold: - description: In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. + description: The value to compare with the specified statistic. type: number + Tags: + description: |- + A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the ``cloudwatch:TagResource`` permission. + Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' required: - ComparisonOperator - EvaluationPeriods x-stackql-resource-name: alarm - x-stackql-primaryIdentifier: + description: |- + The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression. + When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. + When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. + x-type-name: AWS::CloudWatch::Alarm + x-stackql-primary-identifier: - AlarmName x-create-only-properties: - AlarmName x-read-only-properties: - Arn + x-required-properties: + - ComparisonOperator + - EvaluationPeriods + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cloudwatch:TagResource + - cloudwatch:UntagResource + - cloudwatch:ListTagsForResource x-required-permissions: create: - cloudwatch:PutMetricAlarm - cloudwatch:DescribeAlarms + - cloudwatch:TagResource update: - cloudwatch:PutMetricAlarm - cloudwatch:DescribeAlarms + - cloudwatch:TagResource + - cloudwatch:UntagResource delete: - cloudwatch:DeleteAlarms - cloudwatch:DescribeAlarms @@ -196,6 +666,12 @@ components: - cloudwatch:DescribeAlarms read: - cloudwatch:DescribeAlarms + - cloudwatch:ListTagsForResource + AlarmActionARN: + type: string + description: Amazon Resource Name (ARN) of the action + minLength: 1 + maxLength: 1024 CompositeAlarm: type: object properties: @@ -262,29 +738,92 @@ components: description: Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds. type: integer minimum: 0 + Tags: + description: A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' required: - AlarmRule x-stackql-resource-name: composite_alarm - x-stackql-primaryIdentifier: + description: The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression + x-type-name: AWS::CloudWatch::CompositeAlarm + x-stackql-primary-identifier: - AlarmName x-create-only-properties: - AlarmName x-read-only-properties: - Arn + x-required-properties: + - AlarmRule + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - cloudwatch:TagResource + - cloudwatch:UntagResource + - cloudwatch:ListTagsForResource x-required-permissions: create: - cloudwatch:DescribeAlarms - cloudwatch:PutCompositeAlarm + - cloudwatch:TagResource read: - cloudwatch:DescribeAlarms + - cloudwatch:ListTagsForResource update: - cloudwatch:DescribeAlarms - cloudwatch:PutCompositeAlarm + - cloudwatch:TagResource + - cloudwatch:UntagResource delete: - cloudwatch:DescribeAlarms - cloudwatch:DeleteAlarms list: - cloudwatch:DescribeAlarms + Dashboard: + type: object + properties: + DashboardName: + type: string + description: The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically. + DashboardBody: + type: string + description: The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard + required: + - DashboardBody + x-stackql-resource-name: dashboard + description: Resource Type definition for AWS::CloudWatch::Dashboard + x-type-name: AWS::CloudWatch::Dashboard + x-stackql-primary-identifier: + - DashboardName + x-create-only-properties: + - DashboardName + x-required-properties: + - DashboardBody + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cloudwatch:PutDashboard + - cloudwatch:GetDashboard + read: + - cloudwatch:GetDashboard + update: + - cloudwatch:PutDashboard + delete: + - cloudwatch:DeleteDashboards + - cloudwatch:GetDashboard + list: + - cloudwatch:ListDashboards MetricStreamFilter: description: This structure defines the metrics that will be streamed. type: object @@ -345,24 +884,6 @@ components: required: - MetricName - Namespace - Tag: - description: Metadata that you can assign to a Metric Stream, consisting of a key-value pair. - type: object - additionalProperties: false - properties: - Key: - description: A unique identifier for the tag. - type: string - minLength: 1 - maxLength: 128 - Value: - description: String which you can use to describe or define the tag. - type: string - minLength: 1 - maxLength: 256 - required: - - Key - - Value MetricStream: type: object properties: @@ -439,12 +960,10 @@ components: IncludeLinkedAccountsMetrics: description: If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false. type: boolean - required: - - FirehoseArn - - RoleArn - - OutputFormat x-stackql-resource-name: metric_stream - x-stackql-primaryIdentifier: + description: Resource Type definition for Metric Stream + x-type-name: AWS::CloudWatch::MetricStream + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -453,6 +972,16 @@ components: - CreationDate - LastUpdateDate - State + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - cloudwatch:TagResource + - cloudwatch:UntagResource + - cloudwatch:ListTagsForResource x-required-permissions: create: - cloudwatch:PutMetricStream @@ -472,43 +1001,406 @@ components: - cloudwatch:ListMetricStreams read: - cloudwatch:GetMetricStream + - cloudwatch:ListTagsForResource + CreateAlarmRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ThresholdMetricId: + description: In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm. + type: string + EvaluateLowSampleCountPercentile: + description: Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available. + type: string + ExtendedStatistic: + description: |- + The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. + For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. + For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``. + type: string + ComparisonOperator: + description: The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. + type: string + TreatMissingData: + description: |- + Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. + If you omit this parameter, the default behavior of ``missing`` is used. + type: string + Dimensions: + description: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Dimension' + Period: + description: |- + The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 20, 30, 60, and any multiple of 60. + For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. + *Minimum:* 10 + type: integer + EvaluationPeriods: + description: |- + The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M. + For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. + type: integer + Unit: + description: |- + The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. + You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. + type: string + Namespace: + description: |- + The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. + For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) + type: string + OKActions: + description: The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). + type: array + uniqueItems: false + items: + type: string + AlarmActions: + description: The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*. + type: array + uniqueItems: false + items: + type: string + MetricName: + description: The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``. + type: string + ActionsEnabled: + description: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. + type: boolean + default: true + Metrics: + description: |- + An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. + If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/MetricDataQuery' + AlarmDescription: + description: The description of the alarm. + type: string + AlarmName: + description: |- + The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + type: string + Statistic: + description: |- + The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. + For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. + For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``. + type: string + InsufficientDataActions: + description: The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). + type: array + uniqueItems: false + items: + type: string + Arn: + description: '' + type: string + DatapointsToAlarm: + description: |- + The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. + If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching. + type: integer + Threshold: + description: The value to compare with the specified statistic. + type: number + Tags: + description: |- + A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the ``cloudwatch:TagResource`` permission. + Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAlarmRequest + type: object + required: [] + CreateCompositeAlarmRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: Amazon Resource Name (ARN) of the alarm + minLength: 1 + maxLength: 1600 + AlarmName: + description: The name of the Composite Alarm + type: string + minLength: 1 + maxLength: 255 + AlarmRule: + type: string + description: Expression which aggregates the state of other Alarms (Metric or Composite Alarms) + minLength: 1 + maxLength: 10240 + AlarmDescription: + type: string + description: The description of the alarm + minLength: 0 + maxLength: 1024 + ActionsEnabled: + description: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. + type: boolean + OKActions: + type: array + items: + type: string + description: Amazon Resource Name (ARN) of the action + minLength: 1 + maxLength: 1024 + description: The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). + maxItems: 5 + AlarmActions: + type: array + items: + type: string + description: Amazon Resource Name (ARN) of the action + minLength: 1 + maxLength: 1024 + description: The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). + maxItems: 5 + InsufficientDataActions: + type: array + items: + type: string + description: Amazon Resource Name (ARN) of the action + minLength: 1 + maxLength: 1024 + description: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). + maxItems: 5 + ActionsSuppressor: + description: 'Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. ' + type: string + minLength: 1 + maxLength: 1600 + ActionsSuppressorWaitPeriod: + description: Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds. + type: integer + minimum: 0 + ActionsSuppressorExtensionPeriod: + description: Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds. + type: integer + minimum: 0 + Tags: + description: A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCompositeAlarmRequest + type: object + required: [] + CreateDashboardRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DashboardName: + type: string + description: The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically. + DashboardBody: + type: string + description: The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard + x-stackQL-stringOnly: true + x-title: CreateDashboardRequest + type: object + required: [] + CreateMetricStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Amazon Resource Name of the metric stream. + type: string + minLength: 20 + maxLength: 2048 + CreationDate: + description: The date of creation of the metric stream. + type: string + anyOf: + - format: date-time + - format: timestamp + ExcludeFilters: + description: Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null. + type: array + maxItems: 1000 + uniqueItems: true + items: + $ref: '#/components/schemas/MetricStreamFilter' + FirehoseArn: + description: The ARN of the Kinesis Firehose where to stream the data. + type: string + minLength: 20 + maxLength: 2048 + IncludeFilters: + description: Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null. + type: array + maxItems: 1000 + uniqueItems: true + items: + $ref: '#/components/schemas/MetricStreamFilter' + LastUpdateDate: + description: The date of the last update of the metric stream. + type: string + anyOf: + - format: date-time + - format: timestamp + Name: + description: Name of the metric stream. + type: string + minLength: 1 + maxLength: 255 + RoleArn: + description: The ARN of the role that provides access to the Kinesis Firehose. + type: string + minLength: 20 + maxLength: 2048 + State: + description: Displays the state of the Metric Stream. + type: string + minLength: 1 + maxLength: 255 + OutputFormat: + description: The output format of the data streamed to the Kinesis Firehose. + type: string + minLength: 1 + maxLength: 255 + StatisticsConfigurations: + description: By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members. + type: array + maxItems: 100 + uniqueItems: true + items: + $ref: '#/components/schemas/MetricStreamStatisticsConfiguration' + Tags: + description: A set of tags to assign to the delivery stream. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + IncludeLinkedAccountsMetrics: + description: If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateMetricStreamRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: alarms: name: alarms id: awscc.cloudwatch.alarms x-cfn-schema-name: Alarm - x-type: list - x-identifiers: - - AlarmName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmName') as alarm_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' - AND region = 'us-east-1' - alarm: - name: alarm - id: awscc.cloudwatch.alarm - x-cfn-schema-name: Alarm - x-type: get + x-cfn-type-name: AWS::CloudWatch::Alarm x-identifiers: - AlarmName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alarm&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::Alarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::Alarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::Alarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/alarms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/alarms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/alarms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -534,12 +1426,13 @@ components: JSON_EXTRACT(Properties, '$.InsufficientDataActions') as insufficient_data_actions, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.DatapointsToAlarm') as datapoints_to_alarm, - JSON_EXTRACT(Properties, '$.Threshold') as threshold + JSON_EXTRACT(Properties, '$.Threshold') as threshold, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::Alarm' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -565,17 +1458,24 @@ components: json_extract_path_text(Properties, 'InsufficientDataActions') as insufficient_data_actions, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'DatapointsToAlarm') as datapoints_to_alarm, - json_extract_path_text(Properties, 'Threshold') as threshold + json_extract_path_text(Properties, 'Threshold') as threshold, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::Alarm' AND data__Identifier = '' AND region = 'us-east-1' - composite_alarms: - name: composite_alarms - id: awscc.cloudwatch.composite_alarms - x-cfn-schema-name: CompositeAlarm - x-type: list + alarms_list_only: + name: alarms_list_only + id: awscc.cloudwatch.alarms_list_only + x-cfn-schema-name: Alarm + x-cfn-type-name: AWS::CloudWatch::Alarm x-identifiers: - AlarmName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -584,7 +1484,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -592,19 +1492,67 @@ components: SELECT region, json_extract_path_text(Properties, 'AlarmName') as alarm_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' AND region = 'us-east-1' - composite_alarm: - name: composite_alarm - id: awscc.cloudwatch.composite_alarm + composite_alarms: + name: composite_alarms + id: awscc.cloudwatch.composite_alarms x-cfn-schema-name: CompositeAlarm - x-type: get + x-cfn-type-name: AWS::CloudWatch::CompositeAlarm x-identifiers: - AlarmName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CompositeAlarm&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::CompositeAlarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::CompositeAlarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::CompositeAlarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -619,12 +1567,13 @@ components: JSON_EXTRACT(Properties, '$.InsufficientDataActions') as insufficient_data_actions, JSON_EXTRACT(Properties, '$.ActionsSuppressor') as actions_suppressor, JSON_EXTRACT(Properties, '$.ActionsSuppressorWaitPeriod') as actions_suppressor_wait_period, - JSON_EXTRACT(Properties, '$.ActionsSuppressorExtensionPeriod') as actions_suppressor_extension_period + JSON_EXTRACT(Properties, '$.ActionsSuppressorExtensionPeriod') as actions_suppressor_extension_period, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -639,17 +1588,24 @@ components: json_extract_path_text(Properties, 'InsufficientDataActions') as insufficient_data_actions, json_extract_path_text(Properties, 'ActionsSuppressor') as actions_suppressor, json_extract_path_text(Properties, 'ActionsSuppressorWaitPeriod') as actions_suppressor_wait_period, - json_extract_path_text(Properties, 'ActionsSuppressorExtensionPeriod') as actions_suppressor_extension_period + json_extract_path_text(Properties, 'ActionsSuppressorExtensionPeriod') as actions_suppressor_extension_period, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' AND data__Identifier = '' AND region = 'us-east-1' - metric_streams: - name: metric_streams - id: awscc.cloudwatch.metric_streams - x-cfn-schema-name: MetricStream - x-type: list + composite_alarms_list_only: + name: composite_alarms_list_only + id: awscc.cloudwatch.composite_alarms_list_only + x-cfn-schema-name: CompositeAlarm + x-cfn-type-name: AWS::CloudWatch::CompositeAlarm x-identifiers: - - Name + - AlarmName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -657,28 +1613,186 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' + JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' + json_extract_path_text(Properties, 'AlarmName') as alarm_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' AND region = 'us-east-1' - metric_stream: - name: metric_stream - id: awscc.cloudwatch.metric_stream + dashboards: + name: dashboards + id: awscc.cloudwatch.dashboards + x-cfn-schema-name: Dashboard + x-cfn-type-name: AWS::CloudWatch::Dashboard + x-identifiers: + - DashboardName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DashboardName') as dashboard_name, + JSON_EXTRACT(Properties, '$.DashboardBody') as dashboard_body + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::Dashboard' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DashboardName') as dashboard_name, + json_extract_path_text(Properties, 'DashboardBody') as dashboard_body + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::Dashboard' + AND data__Identifier = '' + AND region = 'us-east-1' + dashboards_list_only: + name: dashboards_list_only + id: awscc.cloudwatch.dashboards_list_only + x-cfn-schema-name: Dashboard + x-cfn-type-name: AWS::CloudWatch::Dashboard + x-identifiers: + - DashboardName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DashboardName') as dashboard_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Dashboard' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DashboardName') as dashboard_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Dashboard' + AND region = 'us-east-1' + metric_streams: + name: metric_streams + id: awscc.cloudwatch.metric_streams x-cfn-schema-name: MetricStream - x-type: get + x-cfn-type-name: AWS::CloudWatch::MetricStream x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MetricStream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::MetricStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::MetricStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CloudWatch::MetricStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/metric_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/metric_streams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/metric_streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -700,7 +1814,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -721,3 +1835,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' AND data__Identifier = '' AND region = 'us-east-1' + metric_streams_list_only: + name: metric_streams_list_only + id: awscc.cloudwatch.metric_streams_list_only + x-cfn-schema-name: MetricStream + x-cfn-type-name: AWS::CloudWatch::MetricStream + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alarm&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlarm + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAlarmRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CompositeAlarm&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCompositeAlarm + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCompositeAlarmRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDashboard + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDashboardRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MetricStream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMetricStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMetricStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codeartifact.yaml b/providers/src/awscc/v00.00.00000/services/codeartifact.yaml index 49f6372b..e3842cb0 100644 --- a/providers/src/awscc/v00.00.00000/services/codeartifact.yaml +++ b/providers/src/awscc/v00.00.00000/services/codeartifact.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeArtifact - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -11,13 +391,13 @@ components: properties: Key: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' minLength: 1 maxLength: 128 Value: type: string - description: 'The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' - minLength: 0 + description: 'The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 1 maxLength: 256 required: - Value @@ -63,7 +443,9 @@ components: required: - DomainName x-stackql-resource-name: domain - x-stackql-primaryIdentifier: + description: The resource schema to create a CodeArtifact domain. + x-type-name: AWS::CodeArtifact::Domain + x-stackql-primary-identifier: - Arn x-create-only-properties: - DomainName @@ -73,6 +455,18 @@ components: - Name - EncryptionKey - Arn + x-required-properties: + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codeartifact:ListTagsForResource + - codeartifact:UntagResource + - codeartifact:TagResource x-required-permissions: create: - codeartifact:CreateDomain @@ -80,21 +474,159 @@ components: - codeartifact:PutDomainPermissionsPolicy - codeartifact:GetDomainPermissionsPolicy - codeartifact:TagResource + - codeartifact:ListTagsForResource read: - codeartifact:DescribeDomain - codeartifact:GetDomainPermissionsPolicy - codeartifact:ListTagsForResource update: + - codeartifact:DescribeDomain - codeartifact:PutDomainPermissionsPolicy - codeartifact:DeleteDomainPermissionsPolicy - codeartifact:GetDomainPermissionsPolicy - codeartifact:TagResource - codeartifact:UntagResource + - codeartifact:ListTagsForResource delete: - codeartifact:DeleteDomain - codeartifact:DescribeDomain list: - codeartifact:ListDomains + OriginConfiguration: + type: object + properties: + Restrictions: + description: The origin configuration that is applied to the package group. + type: object + $ref: '#/components/schemas/Restrictions' + required: + - Restrictions + additionalProperties: false + Restrictions: + type: object + properties: + Publish: + type: object + description: The publish restriction determines if new package versions can be published. + $ref: '#/components/schemas/RestrictionType' + ExternalUpstream: + type: object + description: The external upstream restriction determines if new package versions can be ingested or retained from external connections. + $ref: '#/components/schemas/RestrictionType' + InternalUpstream: + type: object + description: The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories. + $ref: '#/components/schemas/RestrictionType' + additionalProperties: false + RestrictionType: + type: object + properties: + RestrictionMode: + type: string + enum: + - ALLOW + - BLOCK + - ALLOW_SPECIFIC_REPOSITORIES + - INHERIT + Repositories: + type: array + items: + type: string + required: + - RestrictionMode + additionalProperties: false + PackageGroup: + type: object + properties: + DomainName: + description: The name of the domain that contains the package group. + type: string + pattern: ^([a-z][a-z0-9\-]{0,48}[a-z0-9])$ + minLength: 2 + maxLength: 50 + DomainOwner: + description: The 12-digit account ID of the AWS account that owns the domain. + pattern: '[0-9]{12}' + type: string + Pattern: + description: The package group pattern that is used to gather packages. + type: string + minLength: 2 + maxLength: 520 + ContactInfo: + description: The contact info of the package group. + type: string + maxLength: 1000 + Description: + description: The text description of the package group. + type: string + maxLength: 1000 + OriginConfiguration: + description: The package origin configuration of the package group. + type: object + $ref: '#/components/schemas/OriginConfiguration' + Tags: + type: array + description: An array of key-value pairs to apply to the package group. + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The ARN of the package group. + type: string + minLength: 1 + maxLength: 2048 + required: + - Pattern + - DomainName + x-stackql-resource-name: package_group + description: The resource schema to create a CodeArtifact package group. + x-type-name: AWS::CodeArtifact::PackageGroup + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - DomainName + - Pattern + x-read-only-properties: + - Arn + x-required-properties: + - Pattern + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codeartifact:ListTagsForResource + - codeartifact:UntagResource + - codeartifact:TagResource + x-required-permissions: + create: + - codeartifact:CreatePackageGroup + - codeartifact:DescribePackageGroup + - codeartifact:UpdatePackageGroup + - codeartifact:UpdatePackageGroupOriginConfiguration + - codeartifact:ListAllowedRepositoriesForGroup + - codeartifact:ListTagsForResource + - codeartifact:TagResource + read: + - codeartifact:DescribePackageGroup + - codeartifact:ListAllowedRepositoriesForGroup + - codeartifact:ListTagsForResource + update: + - codeartifact:UpdatePackageGroup + - codeartifact:UpdatePackageGroupOriginConfiguration + - codeartifact:DescribePackageGroup + - codeartifact:ListAllowedRepositoriesForGroup + - codeartifact:ListTagsForResource + - codeartifact:TagResource + - codeartifact:UntagResource + delete: + - codeartifact:DeletePackageGroup + - codeartifact:DescribePackageGroup + list: + - codeartifact:ListPackageGroups Repository: type: object properties: @@ -153,7 +685,9 @@ components: - RepositoryName - DomainName x-stackql-resource-name: repository - x-stackql-primaryIdentifier: + description: The resource schema to create a CodeArtifact repository. + x-type-name: AWS::CodeArtifact::Repository + x-stackql-primary-identifier: - Arn x-create-only-properties: - RepositoryName @@ -163,20 +697,36 @@ components: - Name - DomainOwner - Arn + x-required-properties: + - RepositoryName + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codeartifact:ListTagsForResource + - codeartifact:UntagResource + - codeartifact:TagResource x-required-permissions: create: - codeartifact:CreateRepository - codeartifact:DescribeRepository - codeartifact:PutRepositoryPermissionsPolicy + - codeartifact:GetRepositoryPermissionsPolicy - codeartifact:AssociateExternalConnection - codeartifact:AssociateWithDownstreamRepository - codeartifact:TagResource + - codeartifact:ListTagsForResource read: - codeartifact:DescribeRepository - codeartifact:GetRepositoryPermissionsPolicy - codeartifact:ListTagsForResource update: - codeartifact:PutRepositoryPermissionsPolicy + - codeartifact:GetRepositoryPermissionsPolicy - codeartifact:DeleteRepositoryPermissionsPolicy - codeartifact:AssociateExternalConnection - codeartifact:DisassociateExternalConnection @@ -185,19 +735,295 @@ components: - codeartifact:AssociateWithDownstreamRepository - codeartifact:TagResource - codeartifact:UntagResource + - codeartifact:ListTagsForResource delete: - codeartifact:DeleteRepository - codeartifact:DescribeRepository list: - codeartifact:ListRepositories + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The name of the domain. + type: string + pattern: ^([a-z][a-z0-9\-]{0,48}[a-z0-9])$ + minLength: 2 + maxLength: 50 + Name: + description: The name of the domain. This field is used for GetAtt + type: string + pattern: ^([a-z][a-z0-9\-]{0,48}[a-z0-9])$ + minLength: 2 + maxLength: 50 + Owner: + description: The 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt + pattern: '[0-9]{12}' + type: string + EncryptionKey: + description: The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain. + type: string + PermissionsPolicyDocument: + description: The access control resource policy on the provided domain. + type: object + minLength: 2 + maxLength: 5120 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The ARN of the domain. + type: string + minLength: 1 + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + CreatePackageGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The name of the domain that contains the package group. + type: string + pattern: ^([a-z][a-z0-9\-]{0,48}[a-z0-9])$ + minLength: 2 + maxLength: 50 + DomainOwner: + description: The 12-digit account ID of the AWS account that owns the domain. + pattern: '[0-9]{12}' + type: string + Pattern: + description: The package group pattern that is used to gather packages. + type: string + minLength: 2 + maxLength: 520 + ContactInfo: + description: The contact info of the package group. + type: string + maxLength: 1000 + Description: + description: The text description of the package group. + type: string + maxLength: 1000 + OriginConfiguration: + description: The package origin configuration of the package group. + type: object + $ref: '#/components/schemas/OriginConfiguration' + Tags: + type: array + description: An array of key-value pairs to apply to the package group. + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The ARN of the package group. + type: string + minLength: 1 + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreatePackageGroupRequest + type: object + required: [] + CreateRepositoryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RepositoryName: + description: The name of the repository. + type: string + pattern: ^([A-Za-z0-9][A-Za-z0-9._\-]{1,99})$ + minLength: 2 + maxLength: 100 + Name: + description: The name of the repository. This is used for GetAtt + type: string + pattern: ^([A-Za-z0-9][A-Za-z0-9._\-]{1,99})$ + minLength: 2 + maxLength: 100 + DomainName: + description: The name of the domain that contains the repository. + type: string + pattern: ^([a-z][a-z0-9\-]{0,48}[a-z0-9])$ + minLength: 2 + maxLength: 50 + DomainOwner: + description: The 12-digit account ID of the AWS account that owns the domain. + pattern: '[0-9]{12}' + type: string + Description: + description: A text description of the repository. + type: string + maxLength: 1000 + Arn: + description: The ARN of the repository. + type: string + minLength: 1 + maxLength: 2048 + ExternalConnections: + description: A list of external connections associated with the repository. + type: array + items: + type: string + Upstreams: + description: A list of upstream repositories associated with the repository. + type: array + items: + type: string + PermissionsPolicyDocument: + description: The access control resource policy on the provided repository. + type: object + minLength: 2 + maxLength: 5120 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRepositoryRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: domains: name: domains id: awscc.codeartifact.domains x-cfn-schema-name: Domain - x-type: list + x-cfn-type-name: AWS::CodeArtifact::Domain + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Owner') as owner, + JSON_EXTRACT(Properties, '$.EncryptionKey') as encryption_key, + JSON_EXTRACT(Properties, '$.PermissionsPolicyDocument') as permissions_policy_document, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, + json_extract_path_text(Properties, 'PermissionsPolicyDocument') as permissions_policy_document, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + domains_list_only: + name: domains_list_only + id: awscc.codeartifact.domains_list_only + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::CodeArtifact::Domain x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -216,54 +1042,110 @@ components: json_extract_path_text(Properties, 'Arn') as arn FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Domain' AND region = 'us-east-1' - domain: - name: domain - id: awscc.codeartifact.domain - x-cfn-schema-name: Domain - x-type: get + package_groups: + name: package_groups + id: awscc.codeartifact.package_groups + x-cfn-schema-name: PackageGroup + x-cfn-type-name: AWS::CodeArtifact::PackageGroup x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PackageGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::PackageGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::PackageGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::PackageGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/package_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/package_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/package_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Owner') as owner, - JSON_EXTRACT(Properties, '$.EncryptionKey') as encryption_key, - JSON_EXTRACT(Properties, '$.PermissionsPolicyDocument') as permissions_policy_document, + JSON_EXTRACT(Properties, '$.DomainOwner') as domain_owner, + JSON_EXTRACT(Properties, '$.Pattern') as pattern, + JSON_EXTRACT(Properties, '$.ContactInfo') as contact_info, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.OriginConfiguration') as origin_configuration, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Domain' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Owner') as owner, - json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, - json_extract_path_text(Properties, 'PermissionsPolicyDocument') as permissions_policy_document, + json_extract_path_text(Properties, 'DomainOwner') as domain_owner, + json_extract_path_text(Properties, 'Pattern') as pattern, + json_extract_path_text(Properties, 'ContactInfo') as contact_info, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'OriginConfiguration') as origin_configuration, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Domain' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' AND data__Identifier = '' AND region = 'us-east-1' - repositories: - name: repositories - id: awscc.codeartifact.repositories - x-cfn-schema-name: Repository - x-type: list + package_groups_list_only: + name: package_groups_list_only + id: awscc.codeartifact.package_groups_list_only + x-cfn-schema-name: PackageGroup + x-cfn-type-name: AWS::CodeArtifact::PackageGroup x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -272,7 +1154,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -280,19 +1162,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' AND region = 'us-east-1' - repository: - name: repository - id: awscc.codeartifact.repository + repositories: + name: repositories + id: awscc.codeartifact.repositories x-cfn-schema-name: Repository - x-type: get + x-cfn-type-name: AWS::CodeArtifact::Repository x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Repository&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::Repository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::Repository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeArtifact::Repository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repositories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repositories/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/repositories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -311,7 +1241,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -329,3 +1259,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Repository' AND data__Identifier = '' AND region = 'us-east-1' + repositories_list_only: + name: repositories_list_only + id: awscc.codeartifact.repositories_list_only + x-cfn-schema-name: Repository + x-cfn-type-name: AWS::CodeArtifact::Repository + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PackageGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePackageGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePackageGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Repository&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRepository + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRepositoryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codebuild.yaml b/providers/src/awscc/v00.00.00000/services/codebuild.yaml index 1cd5bc7f..bd2b8402 100644 --- a/providers/src/awscc/v00.00.00000/services/codebuild.yaml +++ b/providers/src/awscc/v00.00.00000/services/codebuild.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeBuild - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -24,6 +404,97 @@ components: required: - Value - Key + VpcConfig: + type: object + additionalProperties: false + properties: + VpcId: + type: string + Subnets: + type: array + x-insertionOrder: false + items: + type: string + SecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + ProxyConfiguration: + type: object + additionalProperties: false + properties: + DefaultBehavior: + type: string + enum: + - ALLOW_ALL + - DENY_ALL + OrderedProxyRules: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/FleetProxyRule' + FleetProxyRule: + type: object + additionalProperties: false + properties: + Type: + type: string + enum: + - DOMAIN + - IP + Effect: + type: string + enum: + - ALLOW + - DENY + Entities: + type: array + x-insertionOrder: false + items: + type: string + ScalingConfigurationInput: + type: object + additionalProperties: false + properties: + MaxCapacity: + type: integer + minimum: 1 + ScalingType: + type: string + enum: + - TARGET_TRACKING_SCALING + TargetTrackingScalingConfigs: + type: array + items: + $ref: '#/components/schemas/TargetTrackingScalingConfiguration' + TargetTrackingScalingConfiguration: + type: object + additionalProperties: false + properties: + MetricType: + type: string + enum: + - FLEET_UTILIZATION_RATE + TargetValue: + type: number + ComputeConfiguration: + type: object + additionalProperties: false + properties: + vCpu: + type: integer + memory: + type: integer + disk: + type: integer + machineType: + type: string + enum: + - GENERAL + - NVME + instanceType: + type: string Fleet: type: object properties: @@ -42,13 +513,32 @@ components: - LINUX_CONTAINER - LINUX_GPU_CONTAINER - ARM_CONTAINER + - MAC_ARM + - LINUX_EC2 + - ARM_EC2 + - WINDOWS_EC2 ComputeType: type: string enum: - BUILD_GENERAL1_SMALL - BUILD_GENERAL1_MEDIUM - BUILD_GENERAL1_LARGE + - BUILD_GENERAL1_XLARGE - BUILD_GENERAL1_2XLARGE + - ATTRIBUTE_BASED_COMPUTE + - CUSTOM_INSTANCE_TYPE + OverflowBehavior: + type: string + enum: + - QUEUE + - ON_DEMAND + FleetServiceRole: + type: string + pattern: ^(?:arn:)[a-zA-Z+-=,._:/@]+$ + FleetVpcConfig: + $ref: '#/components/schemas/VpcConfig' + FleetProxyConfiguration: + $ref: '#/components/schemas/ProxyConfiguration' Tags: type: array x-insertionOrder: false @@ -57,15 +547,34 @@ components: Arn: type: string minLength: 1 + ImageId: + type: string + pattern: ^((aws/codebuild/[A-Za-z-]+:[0-9]+(-[0-9._]+)?)|ami-[a-z0-9]{1,1020})$ + ScalingConfiguration: + $ref: '#/components/schemas/ScalingConfigurationInput' + ComputeConfiguration: + $ref: '#/components/schemas/ComputeConfiguration' x-stackql-resource-name: fleet - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::CodeBuild::Fleet + x-type-name: AWS::CodeBuild::Fleet + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codebuild:CreateFleet + - codebuild:UpdateFleet x-required-permissions: create: - codebuild:BatchGetFleets - codebuild:CreateFleet + - iam:PassRole delete: - codebuild:BatchGetFleets - codebuild:DeleteFleet @@ -76,39 +585,202 @@ components: update: - codebuild:BatchGetFleets - codebuild:UpdateFleet + - iam:PassRole + CreateFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + minLength: 2 + maxLength: 128 + BaseCapacity: + type: integer + minimum: 1 + EnvironmentType: + type: string + enum: + - WINDOWS_SERVER_2019_CONTAINER + - WINDOWS_SERVER_2022_CONTAINER + - LINUX_CONTAINER + - LINUX_GPU_CONTAINER + - ARM_CONTAINER + - MAC_ARM + - LINUX_EC2 + - ARM_EC2 + - WINDOWS_EC2 + ComputeType: + type: string + enum: + - BUILD_GENERAL1_SMALL + - BUILD_GENERAL1_MEDIUM + - BUILD_GENERAL1_LARGE + - BUILD_GENERAL1_XLARGE + - BUILD_GENERAL1_2XLARGE + - ATTRIBUTE_BASED_COMPUTE + - CUSTOM_INSTANCE_TYPE + OverflowBehavior: + type: string + enum: + - QUEUE + - ON_DEMAND + FleetServiceRole: + type: string + pattern: ^(?:arn:)[a-zA-Z+-=,._:/@]+$ + FleetVpcConfig: + $ref: '#/components/schemas/VpcConfig' + FleetProxyConfiguration: + $ref: '#/components/schemas/ProxyConfiguration' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + minLength: 1 + ImageId: + type: string + pattern: ^((aws/codebuild/[A-Za-z-]+:[0-9]+(-[0-9._]+)?)|ami-[a-z0-9]{1,1020})$ + ScalingConfiguration: + $ref: '#/components/schemas/ScalingConfigurationInput' + ComputeConfiguration: + $ref: '#/components/schemas/ComputeConfiguration' + x-stackQL-stringOnly: true + x-title: CreateFleetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: fleets: name: fleets id: awscc.codebuild.fleets x-cfn-schema-name: Fleet - x-type: list + x-cfn-type-name: AWS::CodeBuild::Fleet x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeBuild::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeBuild::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeBuild::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.BaseCapacity') as base_capacity, + JSON_EXTRACT(Properties, '$.EnvironmentType') as environment_type, + JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, + JSON_EXTRACT(Properties, '$.OverflowBehavior') as overflow_behavior, + JSON_EXTRACT(Properties, '$.FleetServiceRole') as fleet_service_role, + JSON_EXTRACT(Properties, '$.FleetVpcConfig') as fleet_vpc_config, + JSON_EXTRACT(Properties, '$.FleetProxyConfiguration') as fleet_proxy_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ImageId') as image_id, + JSON_EXTRACT(Properties, '$.ScalingConfiguration') as scaling_configuration, + JSON_EXTRACT(Properties, '$.ComputeConfiguration') as compute_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'BaseCapacity') as base_capacity, + json_extract_path_text(Properties, 'EnvironmentType') as environment_type, + json_extract_path_text(Properties, 'ComputeType') as compute_type, + json_extract_path_text(Properties, 'OverflowBehavior') as overflow_behavior, + json_extract_path_text(Properties, 'FleetServiceRole') as fleet_service_role, + json_extract_path_text(Properties, 'FleetVpcConfig') as fleet_vpc_config, + json_extract_path_text(Properties, 'FleetProxyConfiguration') as fleet_proxy_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ImageId') as image_id, + json_extract_path_text(Properties, 'ScalingConfiguration') as scaling_configuration, + json_extract_path_text(Properties, 'ComputeConfiguration') as compute_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' + AND data__Identifier = '' AND region = 'us-east-1' - fleet: - name: fleet - id: awscc.codebuild.fleet + fleets_list_only: + name: fleets_list_only + id: awscc.codebuild.fleets_list_only x-cfn-schema-name: Fleet - x-type: get + x-cfn-type-name: AWS::CodeBuild::Fleet x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -116,28 +788,209 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.BaseCapacity') as base_capacity, - JSON_EXTRACT(Properties, '$.EnvironmentType') as environment_type, - JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, - JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'BaseCapacity') as base_capacity, - json_extract_path_text(Properties, 'EnvironmentType') as environment_type, - json_extract_path_text(Properties, 'ComputeType') as compute_type, - json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codeconnections.yaml b/providers/src/awscc/v00.00.00000/services/codeconnections.yaml new file mode 100644 index 00000000..a4321985 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/codeconnections.yaml @@ -0,0 +1,861 @@ +openapi: 3.0.0 +info: + title: CodeConnections + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 0 + maxLength: 256 + required: + - Value + - Key + additionalProperties: false + Connection: + type: object + properties: + ConnectionArn: + description: The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + ConnectionName: + description: The name of the connection. Connection names must be unique in an AWS user account. + type: string + minLength: 1 + maxLength: 32 + ConnectionStatus: + description: The current status of the connection. + type: string + OwnerAccountId: + description: The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository. + type: string + minLength: 12 + maxLength: 12 + pattern: '[0-9]{12}' + ProviderType: + description: The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn. + type: string + HostArn: + description: The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + Tags: + description: Specifies the tags applied to a connection. + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + required: + - ConnectionName + x-stackql-resource-name: connection + description: Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline) + x-type-name: AWS::CodeConnections::Connection + x-stackql-primary-identifier: + - ConnectionArn + x-create-only-properties: + - ConnectionName + - ProviderType + - HostArn + x-read-only-properties: + - ConnectionArn + - ConnectionStatus + - OwnerAccountId + x-required-properties: + - ConnectionName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codeconnections:TagResource + - codeconnections:ListTagsForResource + - codeconnections:UntagResource + x-required-permissions: + create: + - codeconnections:CreateConnection + - codeconnections:TagResource + read: + - codeconnections:GetConnection + - codeconnections:ListTagsForResource + update: + - codeconnections:ListTagsForResource + - codeconnections:TagResource + - codeconnections:UntagResource + delete: + - codeconnections:DeleteConnection + list: + - codeconnections:ListConnections + - codeconnections:ListTagsForResource + CreateConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectionArn: + description: The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + ConnectionName: + description: The name of the connection. Connection names must be unique in an AWS user account. + type: string + minLength: 1 + maxLength: 32 + ConnectionStatus: + description: The current status of the connection. + type: string + OwnerAccountId: + description: The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository. + type: string + minLength: 12 + maxLength: 12 + pattern: '[0-9]{12}' + ProviderType: + description: The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn. + type: string + HostArn: + description: The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + Tags: + description: Specifies the tags applied to a connection. + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateConnectionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + connections: + name: connections + id: awscc.codeconnections.connections + x-cfn-schema-name: Connection + x-cfn-type-name: AWS::CodeConnections::Connection + x-identifiers: + - ConnectionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeConnections::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeConnections::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeConnections::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn, + JSON_EXTRACT(Properties, '$.ConnectionName') as connection_name, + JSON_EXTRACT(Properties, '$.ConnectionStatus') as connection_status, + JSON_EXTRACT(Properties, '$.OwnerAccountId') as owner_account_id, + JSON_EXTRACT(Properties, '$.ProviderType') as provider_type, + JSON_EXTRACT(Properties, '$.HostArn') as host_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeConnections::Connection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'ConnectionName') as connection_name, + json_extract_path_text(Properties, 'ConnectionStatus') as connection_status, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'ProviderType') as provider_type, + json_extract_path_text(Properties, 'HostArn') as host_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeConnections::Connection' + AND data__Identifier = '' + AND region = 'us-east-1' + connections_list_only: + name: connections_list_only + id: awscc.codeconnections.connections_list_only + x-cfn-schema-name: Connection + x-cfn-type-name: AWS::CodeConnections::Connection + x-identifiers: + - ConnectionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeConnections::Connection' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeConnections::Connection' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codedeploy.yaml b/providers/src/awscc/v00.00.00000/services/codedeploy.yaml index 6f2793d8..5216f831 100644 --- a/providers/src/awscc/v00.00.00000/services/codedeploy.yaml +++ b/providers/src/awscc/v00.00.00000/services/codedeploy.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeDeploy - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -33,11 +413,22 @@ components: x-insertionOrder: false uniqueItems: false x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: The AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application + x-type-name: AWS::CodeDeploy::Application + x-stackql-primary-identifier: - ApplicationName x-create-only-properties: - ApplicationName - ComputePlatform + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - codedeploy:TagResource + - codedeploy:UntagResource x-required-permissions: create: - codedeploy:CreateApplication @@ -141,7 +532,9 @@ components: description: The configuration that specifies how the deployment traffic is routed. $ref: '#/components/schemas/TrafficRoutingConfig' x-stackql-resource-name: deployment_config - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::CodeDeploy::DeploymentConfig + x-type-name: AWS::CodeDeploy::DeploymentConfig + x-stackql-primary-identifier: - DeploymentConfigName x-create-only-properties: - DeploymentConfigName @@ -149,6 +542,11 @@ components: - ComputePlatform - ZonalConfig - TrafficRoutingConfig + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - codedeploy:CreateDeploymentConfig @@ -159,43 +557,135 @@ components: - codedeploy:DeleteDeploymentConfig list: - codedeploy:ListDeploymentConfigs + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationName: + description: A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. + type: string + ComputePlatform: + description: The compute platform that CodeDeploy deploys the application to. + type: string + Tags: + description: 'The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. ' + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: false + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateDeploymentConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ComputePlatform: + description: The destination platform type for the deployment (Lambda, Server, or ECS). + type: string + DeploymentConfigName: + description: A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type. + type: string + MinimumHealthyHosts: + description: 'The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.' + $ref: '#/components/schemas/MinimumHealthyHosts' + ZonalConfig: + description: The zonal deployment config that specifies how the zonal deployment behaves + $ref: '#/components/schemas/ZonalConfig' + TrafficRoutingConfig: + description: The configuration that specifies how the deployment traffic is routed. + $ref: '#/components/schemas/TrafficRoutingConfig' + x-stackQL-stringOnly: true + x-title: CreateDeploymentConfigRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.codedeploy.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.codedeploy.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::CodeDeploy::Application x-identifiers: - ApplicationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeDeploy::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeDeploy::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeDeploy::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -207,7 +697,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -218,13 +708,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeDeploy::Application' AND data__Identifier = '' AND region = 'us-east-1' - deployment_configs: - name: deployment_configs - id: awscc.codedeploy.deployment_configs - x-cfn-schema-name: DeploymentConfig - x-type: list + applications_list_only: + name: applications_list_only + id: awscc.codedeploy.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::CodeDeploy::Application x-identifiers: - - DeploymentConfigName + - ApplicationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -232,28 +728,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DeploymentConfigName') as deployment_config_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DeploymentConfigName') as deployment_config_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' AND region = 'us-east-1' - deployment_config: - name: deployment_config - id: awscc.codedeploy.deployment_config + deployment_configs: + name: deployment_configs + id: awscc.codedeploy.deployment_configs x-cfn-schema-name: DeploymentConfig - x-type: get + x-cfn-type-name: AWS::CodeDeploy::DeploymentConfig x-identifiers: - DeploymentConfigName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeploymentConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeDeploy::DeploymentConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeDeploy::DeploymentConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployment_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployment_configs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -267,7 +798,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -280,3 +811,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' AND data__Identifier = '' AND region = 'us-east-1' + deployment_configs_list_only: + name: deployment_configs_list_only + id: awscc.codedeploy.deployment_configs_list_only + x-cfn-schema-name: DeploymentConfig + x-cfn-type-name: AWS::CodeDeploy::DeploymentConfig + x-identifiers: + - DeploymentConfigName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DeploymentConfigName') as deployment_config_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeploymentConfigName') as deployment_config_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeploymentConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeploymentConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codeguruprofiler.yaml b/providers/src/awscc/v00.00.00000/services/codeguruprofiler.yaml index b7b89ce0..f65a28fa 100644 --- a/providers/src/awscc/v00.00.00000/services/codeguruprofiler.yaml +++ b/providers/src/awscc/v00.00.00000/services/codeguruprofiler.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeGuruProfiler - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ProfilingGroupArn: type: string @@ -94,13 +474,27 @@ components: required: - ProfilingGroupName x-stackql-resource-name: profiling_group - x-stackql-primaryIdentifier: + description: This resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service. + x-type-name: AWS::CodeGuruProfiler::ProfilingGroup + x-stackql-primary-identifier: - ProfilingGroupName x-create-only-properties: - ProfilingGroupName - ComputePlatform x-read-only-properties: - Arn + x-required-properties: + - ProfilingGroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codeguru-profiler:TagResource + - codeguru-profiler:ListTagsForResource + - codeguru-profiler:UntagResource x-required-permissions: create: - sns:Publish @@ -111,8 +505,11 @@ components: read: - codeguru-profiler:DescribeProfilingGroup - codeguru-profiler:ListTagsForResource + - codeguru-profiler:GetNotificationConfiguration + - codeguru-profiler:GetPolicy update: - sns:Publish + - codeguru-profiler:DescribeProfilingGroup - codeguru-profiler:AddNotificationChannels - codeguru-profiler:GetNotificationConfiguration - codeguru-profiler:RemoveNotificationChannel @@ -127,43 +524,133 @@ components: list: - codeguru-profiler:ListProfilingGroups - codeguru-profiler:ListTagsForResource + - codeguru-profiler:GetNotificationConfiguration + - codeguru-profiler:GetPolicy + CreateProfilingGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProfilingGroupName: + description: The name of the profiling group. + type: string + minLength: 1 + maxLength: 255 + pattern: ^[\w-]+$ + ComputePlatform: + description: The compute platform of the profiling group. + type: string + enum: + - Default + - AWSLambda + AgentPermissions: + description: The agent permissions attached to this profiling group. + type: object + additionalProperties: false + required: + - Principals + properties: + Principals: + description: The principals for the agent permissions. + type: array + items: + $ref: '#/components/schemas/IamArn' + AnomalyDetectionNotificationConfiguration: + description: Configuration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency + type: array + items: + $ref: '#/components/schemas/Channel' + Arn: + description: The Amazon Resource Name (ARN) of the specified profiling group. + $ref: '#/components/schemas/ProfilingGroupArn' + x-examples: + - arn:aws:codeguru-profiler:us-east-1:000000000000:profilingGroup/My-example-profiling-group + Tags: + description: The tags associated with a profiling group. + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateProfilingGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: profiling_groups: name: profiling_groups id: awscc.codeguruprofiler.profiling_groups x-cfn-schema-name: ProfilingGroup - x-type: list - x-identifiers: - - ProfilingGroupName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProfilingGroupName') as profiling_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProfilingGroupName') as profiling_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' - AND region = 'us-east-1' - profiling_group: - name: profiling_group - id: awscc.codeguruprofiler.profiling_group - x-cfn-schema-name: ProfilingGroup - x-type: get + x-cfn-type-name: AWS::CodeGuruProfiler::ProfilingGroup x-identifiers: - ProfilingGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProfilingGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeGuruProfiler::ProfilingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeGuruProfiler::ProfilingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeGuruProfiler::ProfilingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -178,7 +665,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -192,3 +679,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' AND data__Identifier = '' AND region = 'us-east-1' + profiling_groups_list_only: + name: profiling_groups_list_only + id: awscc.codeguruprofiler.profiling_groups_list_only + x-cfn-schema-name: ProfilingGroup + x-cfn-type-name: AWS::CodeGuruProfiler::ProfilingGroup + x-identifiers: + - ProfilingGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ProfilingGroupName') as profiling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProfilingGroupName') as profiling_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProfilingGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfilingGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfilingGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codegurureviewer.yaml b/providers/src/awscc/v00.00.00000/services/codegurureviewer.yaml index 3336e2e7..8f8059bd 100644 --- a/providers/src/awscc/v00.00.00000/services/codegurureviewer.yaml +++ b/providers/src/awscc/v00.00.00000/services/codegurureviewer.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeGuruReviewer - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -75,7 +455,9 @@ components: - Name - Type x-stackql-resource-name: repository_association - x-stackql-primaryIdentifier: + description: This resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service. + x-type-name: AWS::CodeGuruReviewer::RepositoryAssociation + x-stackql-primary-identifier: - AssociationArn x-create-only-properties: - Name @@ -86,6 +468,9 @@ components: - ConnectionArn x-read-only-properties: - AssociationArn + x-required-properties: + - Name + - Type x-required-permissions: create: - codeguru-reviewer:DescribeRepositoryAssociation @@ -117,43 +502,122 @@ components: - codestar-connections:ListTagsForResource list: - codeguru-reviewer:ListRepositoryAssociations + CreateRepositoryAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the repository to be associated. + type: string + minLength: 1 + maxLength: 100 + pattern: ^\S[\w.-]*$ + Type: + description: The type of repository to be associated. + type: string + enum: + - CodeCommit + - Bitbucket + - GitHubEnterpriseServer + - S3Bucket + Owner: + description: The owner of the repository. For a Bitbucket repository, this is the username for the account that owns the repository. + type: string + minLength: 1 + maxLength: 100 + pattern: ^\S(.*\S)?$ + BucketName: + description: The name of the S3 bucket associated with an associated S3 repository. It must start with `codeguru-reviewer-`. + type: string + minLength: 3 + maxLength: 63 + pattern: ^\S(.*\S)?$ + ConnectionArn: + description: The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + AssociationArn: + description: The Amazon Resource Name (ARN) of the repository association. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + Tags: + description: The tags associated with a repository association. + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + uniqueItems: false + x-stackQL-stringOnly: true + x-title: CreateRepositoryAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: repository_associations: name: repository_associations id: awscc.codegurureviewer.repository_associations x-cfn-schema-name: RepositoryAssociation - x-type: list - x-identifiers: - - AssociationArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationArn') as association_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' - AND region = 'us-east-1' - repository_association: - name: repository_association - id: awscc.codegurureviewer.repository_association - x-cfn-schema-name: RepositoryAssociation - x-type: get + x-cfn-type-name: AWS::CodeGuruReviewer::RepositoryAssociation x-identifiers: - AssociationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RepositoryAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeGuruReviewer::RepositoryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeGuruReviewer::RepositoryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repository_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repository_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -169,7 +633,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -184,3 +648,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' AND data__Identifier = '' AND region = 'us-east-1' + repository_associations_list_only: + name: repository_associations_list_only + id: awscc.codegurureviewer.repository_associations_list_only + x-cfn-schema-name: RepositoryAssociation + x-cfn-type-name: AWS::CodeGuruReviewer::RepositoryAssociation + x-identifiers: + - AssociationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationArn') as association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RepositoryAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRepositoryAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRepositoryAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codepipeline.yaml b/providers/src/awscc/v00.00.00000/services/codepipeline.yaml index 8175dcfb..1f0d3f0e 100644 --- a/providers/src/awscc/v00.00.00000/services/codepipeline.yaml +++ b/providers/src/awscc/v00.00.00000/services/codepipeline.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodePipeline - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ConfigurationProperties: additionalProperties: false @@ -70,12 +450,15 @@ components: description: The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service. type: string Tag: + description: A tag is a key-value pair that is used to manage the resource. type: object additionalProperties: false properties: Value: + description: The tag's value. type: string Key: + description: The tag's key. type: string required: - Value @@ -124,7 +507,9 @@ components: - Provider - Version x-stackql-resource-name: custom_action_type - x-stackql-primaryIdentifier: + description: The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. + x-type-name: AWS::CodePipeline::CustomActionType + x-stackql-primary-identifier: - Category - Provider - Version @@ -136,8 +521,26 @@ components: - Provider - Settings - Version + x-write-only-properties: + - ConfigurationProperties/*/Type x-read-only-properties: - Id + x-required-properties: + - Category + - InputArtifactDetails + - OutputArtifactDetails + - Provider + - Version + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - codepipeline:TagResource + - codepipeline:UntagResource + - codepipeline:ListTagsForResource x-required-permissions: create: - codepipeline:CreateCustomActionType @@ -155,82 +558,1612 @@ components: - codepipeline:ListActionTypes list: - codepipeline:ListActionTypes - x-stackQL-resources: - custom_action_types: - name: custom_action_types - id: awscc.codepipeline.custom_action_types - x-cfn-schema-name: CustomActionType - x-type: list - x-identifiers: + BlockerDeclaration: + description: Reserved for future use. + type: object + additionalProperties: false + properties: + Name: + description: Reserved for future use. + type: string + Type: + description: Reserved for future use. + type: string + enum: + - Schedule + required: + - Type + - Name + GitConfiguration: + description: A type of trigger configuration for Git-based source actions. + type: object + additionalProperties: false + properties: + Push: + description: The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/GitPushFilter' + SourceActionName: + description: The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only. + type: string + PullRequest: + description: The field where the repository event that will start the pipeline is specified as pull requests. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/GitPullRequestFilter' + required: + - SourceActionName + ActionTypeId: + description: Represents information about an action type. + type: object + additionalProperties: false + properties: + Owner: + description: 'The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom.' + type: string + Category: + description: A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. + type: string + enum: + - Source + - Build + - Test + - Deploy + - Invoke + - Approval + - Compute + Version: + description: A string that describes the action version. + type: string + Provider: + description: The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. + type: string + required: + - Owner - Category - - Provider - Version - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Category') as category, - JSON_EXTRACT(Properties, '$.Provider') as provider, - JSON_EXTRACT(Properties, '$.Version') as version - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Category') as category, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Version') as version - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND region = 'us-east-1' - custom_action_type: - name: custom_action_type - id: awscc.codepipeline.custom_action_type - x-cfn-schema-name: CustomActionType - x-type: get - x-identifiers: - - Category - Provider - - Version - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Category') as category, - JSON_EXTRACT(Properties, '$.ConfigurationProperties') as configuration_properties, - JSON_EXTRACT(Properties, '$.InputArtifactDetails') as input_artifact_details, - JSON_EXTRACT(Properties, '$.OutputArtifactDetails') as output_artifact_details, - JSON_EXTRACT(Properties, '$.Provider') as provider, - JSON_EXTRACT(Properties, '$.Settings') as settings, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND data__Identifier = '||' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Category') as category, - json_extract_path_text(Properties, 'ConfigurationProperties') as configuration_properties, - json_extract_path_text(Properties, 'InputArtifactDetails') as input_artifact_details, - json_extract_path_text(Properties, 'OutputArtifactDetails') as output_artifact_details, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Settings') as settings, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND data__Identifier = '||' + ArtifactStoreMap: + description: A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. + type: object + additionalProperties: false + properties: + ArtifactStore: + $ref: '#/components/schemas/ArtifactStore' + Region: + description: The action declaration's AWS Region, such as us-east-1. + type: string + required: + - ArtifactStore + - Region + PipelineTriggerDeclaration: + description: Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger. + type: object + additionalProperties: false + properties: + GitConfiguration: + $ref: '#/components/schemas/GitConfiguration' + ProviderType: + description: The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration. + type: string + enum: + - CodeStarSourceConnection + required: + - ProviderType + EncryptionKey: + description: Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key + type: object + additionalProperties: false + properties: + Type: + description: The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'. + type: string + Id: + description: The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. + type: string + required: + - Type + - Id + GitPullRequestFilter: + description: The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude. + type: object + additionalProperties: false + properties: + FilePaths: + $ref: '#/components/schemas/GitFilePathFilterCriteria' + Events: + description: The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration. + type: array + uniqueItems: true + items: + type: string + Branches: + $ref: '#/components/schemas/GitBranchFilterCriteria' + GitPushFilter: + description: The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude. + type: object + additionalProperties: false + properties: + FilePaths: + $ref: '#/components/schemas/GitFilePathFilterCriteria' + Branches: + $ref: '#/components/schemas/GitBranchFilterCriteria' + Tags: + $ref: '#/components/schemas/GitTagFilterCriteria' + ActionDeclaration: + description: Represents information about an action declaration. + type: object + additionalProperties: false + properties: + ActionTypeId: + $ref: '#/components/schemas/ActionTypeId' + Configuration: + description: The action's configuration. These are key-value pairs that specify input values for an action. + type: object + InputArtifacts: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/InputArtifact' + OutputArtifacts: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/OutputArtifact' + Commands: + description: The shell commands to run with your compute action in CodePipeline. + type: array + uniqueItems: false + items: + type: string + OutputVariables: + description: The list of variables that are to be exported from the compute action. + type: array + uniqueItems: true + items: + type: string + EnvironmentVariables: + description: The list of environment variables that are input to a compute based action. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/EnvironmentVariable' + Region: + description: The action declaration's AWS Region, such as us-east-1. + type: string + Namespace: + description: The variable namespace associated with the action. All variables produced as output by this action fall under this namespace. + type: string + RoleArn: + description: The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. + type: string + pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.* + RunOrder: + description: The order in which actions are run. + type: integer + Name: + description: The action declaration's name. + type: string + TimeoutInMinutes: + description: A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the manual approval ActionType. + type: integer + required: + - ActionTypeId + - Name + GitFilePathFilterCriteria: + description: The Git repository file paths specified as filter criteria to start the pipeline. + type: object + additionalProperties: false + properties: + Includes: + description: The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline. + type: array + uniqueItems: true + items: + type: string + Excludes: + description: The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline. + type: array + uniqueItems: true + items: + type: string + StageDeclaration: + description: Represents information about a stage and its definition. + type: object + additionalProperties: false + properties: + Blockers: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/BlockerDeclaration' + Actions: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ActionDeclaration' + Name: + description: The name of the stage. + type: string + OnFailure: + type: object + description: The method to use when a stage has not completed successfully + $ref: '#/components/schemas/FailureConditions' + OnSuccess: + type: object + description: The method to use when a stage has completed successfully + $ref: '#/components/schemas/SuccessConditions' + BeforeEntry: + type: object + description: The method to use before stage runs. + $ref: '#/components/schemas/BeforeEntryConditions' + required: + - Actions + - Name + InputArtifact: + description: Represents information about an artifact to be worked on, such as a test or build artifact. + type: object + additionalProperties: false + properties: + Name: + description: The name of the artifact to be worked on (for example, "My App"). + type: string + required: + - Name + ArtifactStore: + description: The S3 bucket where artifacts for the pipeline are stored. + type: object + additionalProperties: false + properties: + Type: + description: The type of the artifact store, such as S3. + enum: + - S3 + type: string + EncryptionKey: + $ref: '#/components/schemas/EncryptionKey' + Location: + description: The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts. + type: string + required: + - Type + - Location + VariableDeclaration: + description: A variable declared at the pipeline level. + type: object + additionalProperties: false + properties: + DefaultValue: + description: The value of a pipeline-level variable. + type: string + Description: + description: The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes. + type: string + Name: + description: The name of a pipeline-level variable. + type: string + required: + - Name + StageTransition: + description: The name of the pipeline in which you want to disable the flow of artifacts from one stage to another. + type: object + additionalProperties: false + properties: + StageName: + description: The name of the stage where you want to disable the inbound or outbound transition of artifacts. + type: string + Reason: + description: The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI. + type: string + required: + - StageName + - Reason + GitTagFilterCriteria: + description: The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline. + type: object + additionalProperties: false + properties: + Includes: + description: The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline. + type: array + uniqueItems: true + items: + type: string + Excludes: + description: The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline. + type: array + uniqueItems: true + items: + type: string + GitBranchFilterCriteria: + description: The Git repository branches specified as filter criteria to start the pipeline. + type: object + additionalProperties: false + properties: + Includes: + description: The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline. + type: array + uniqueItems: true + items: + type: string + Excludes: + description: The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline. + type: array + uniqueItems: true + items: + type: string + OutputArtifact: + description: Represents information about the output of an action. + type: object + additionalProperties: false + properties: + Name: + description: The name of the output of an artifact, such as "My App". + type: string + Files: + description: The files that you want to associate with the output artifact that will be exported from the compute action. + type: array + uniqueItems: true + items: + type: string + required: + - Name + EnvironmentVariable: + description: Represents information about the environment variable of an action. + type: object + additionalProperties: false + properties: + Name: + description: The name of the environment variable. + type: string + Value: + description: The value of the environment variable. + type: string + Type: + description: The type of the environment variable. + enum: + - PLAINTEXT + - SECRETS_MANAGER + type: string + required: + - Name + - Value + FailureConditions: + description: The configuration that specifies the result, such as rollback, to occur upon stage failure + type: object + additionalProperties: false + properties: + Result: + type: string + description: The specified result for when the failure conditions are met, such as rolling back the stage + enum: + - ROLLBACK + - RETRY + RetryConfiguration: + description: The configuration that specifies the retry configuration for a stage + type: object + additionalProperties: false + properties: + RetryMode: + type: string + description: The specified retry mode type for the given stage. FAILED_ACTIONS will retry only the failed actions. ALL_ACTIONS will retry both failed and successful + enum: + - ALL_ACTIONS + - FAILED_ACTIONS + Conditions: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Condition' + SuccessConditions: + description: The configuration that specifies the result, such as rollback, to occur upon stage failure + type: object + additionalProperties: false + properties: + Conditions: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Condition' + BeforeEntryConditions: + description: The configuration that specifies the rules to run before stage starts. + type: object + additionalProperties: false + properties: + Conditions: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Condition' + Condition: + description: Represents information about condition. + type: object + additionalProperties: false + properties: + Result: + type: string + description: The specified result for when the failure conditions are met, such as rolling back the stage + Rules: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/RuleDeclaration' + RuleDeclaration: + description: Represents information about condition. + type: object + additionalProperties: false + properties: + RuleTypeId: + $ref: '#/components/schemas/RuleTypeId' + Configuration: + description: The rule's configuration. These are key-value pairs that specify input values for a rule. + type: object + Commands: + description: The shell commands to run with your compute action in CodePipeline. + type: array + uniqueItems: false + items: + type: string + InputArtifacts: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/InputArtifact' + Region: + description: The rule declaration's AWS Region, such as us-east-1. + type: string + RoleArn: + description: The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline. + type: string + pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.* + Name: + description: The rule declaration's name. + type: string + RuleTypeId: + description: Represents information about a rule type. + type: object + additionalProperties: false + properties: + Owner: + description: The creator of the rule being called. Only AWS is supported. + type: string + Category: + description: A category for the provider type for the rule. + type: string + Version: + description: A string that describes the rule version. + type: string + Provider: + description: The provider of the service being called by the rule. + type: string + Pipeline: + type: object + properties: + ArtifactStores: + description: A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ArtifactStoreMap' + DisableInboundStageTransitions: + description: Represents the input of a DisableStageTransition action. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/StageTransition' + Stages: + description: Represents information about a stage and its definition. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/StageDeclaration' + ExecutionMode: + description: The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED. + enum: + - QUEUED + - SUPERSEDED + - PARALLEL + default: SUPERSEDED + type: string + RestartExecutionOnUpdate: + description: Indicates whether to rerun the CodePipeline pipeline after you update it. + type: boolean + Triggers: + description: The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/PipelineTriggerDeclaration' + RoleArn: + description: The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn + type: string + pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.* + Name: + description: The name of the pipeline. + type: string + Variables: + description: A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/VariableDeclaration' + Version: + description: The version of the pipeline. + type: string + ArtifactStore: + description: The S3 bucket where artifacts for the pipeline are stored. + $ref: '#/components/schemas/ArtifactStore' + PipelineType: + description: CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications. + type: string + enum: + - V1 + - V2 + Tags: + description: Specifies the tags applied to the pipeline. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + required: + - Stages + - RoleArn + x-stackql-resource-name: pipeline + description: The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process. + x-type-name: AWS::CodePipeline::Pipeline + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + x-write-only-properties: + - RestartExecutionOnUpdate + x-read-only-properties: + - Version + x-required-properties: + - Stages + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - codepipeline:TagResource + - codepipeline:UntagResource + x-required-permissions: + create: + - iam:GetRole + - iam:PassRole + - codepipeline:GetPipeline + - codepipeline:CreatePipeline + - codepipeline:DisableStageTransition + - codepipeline:GetPipelineState + - codepipeline:TagResource + - codestar-connections:PassConnection + read: + - codepipeline:GetPipeline + - codepipeline:ListTagsForResource + - codepipeline:GetPipelineState + update: + - iam:GetRole + - iam:PassRole + - codepipeline:EnableStageTransition + - codepipeline:StartPipelineExecution + - codepipeline:GetPipeline + - codepipeline:UpdatePipeline + - codepipeline:GetPipelineState + - codepipeline:DisableStageTransition + - codepipeline:TagResource + - codepipeline:UntagResource + - codestar-connections:PassConnection + delete: + - codepipeline:GetPipeline + - codepipeline:DeletePipeline + list: + - codepipeline:ListPipelines + WebhookFilterRule: + description: A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started. + type: object + additionalProperties: false + properties: + JsonPath: + description: A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. + type: string + minLength: 1 + maxLength: 150 + MatchEquals: + description: The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. + type: string + minLength: 1 + maxLength: 150 + required: + - JsonPath + WebhookAuthConfiguration: + description: Properties that configure the authentication applied to incoming webhook trigger requests + type: object + additionalProperties: false + properties: + AllowedIPRange: + description: The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range. + type: string + minLength: 1 + maxLength: 100 + SecretToken: + description: The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set. + type: string + minLength: 1 + maxLength: 100 + Webhook: + type: object + properties: + AuthenticationConfiguration: + description: Properties that configure the authentication applied to incoming webhook trigger requests + $ref: '#/components/schemas/WebhookAuthConfiguration' + Filters: + description: A list of rules applied to the body/payload sent in the POST request to a webhook URL + type: array + uniqueItems: false + x-insertionOrder: true + items: + $ref: '#/components/schemas/WebhookFilterRule' + Authentication: + description: Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. + type: string + enum: + - GITHUB_HMAC + - IP + - UNAUTHENTICATED + TargetPipeline: + description: The name of the pipeline you want to connect to the webhook. + type: string + minLength: 1 + maxLength: 100 + pattern: '[A-Za-z0-9.@\-_]+' + TargetAction: + description: The name of the action in a pipeline you want to connect to the webhook. + type: string + minLength: 1 + maxLength: 100 + pattern: '[A-Za-z0-9.@\-_]+' + Id: + description: logical id of the webhook + type: string + Url: + description: The webhook URL generated by AWS CodePipeline + type: string + Name: + description: The name of the webhook + type: string + minLength: 1 + maxLength: 100 + pattern: '[A-Za-z0-9.@\-_]+' + TargetPipelineVersion: + description: The version number of the pipeline to be connected to the trigger request. + type: integer + RegisterWithThirdParty: + description: Configures a connection between the webhook that was created and the external tool with events to be detected. + type: boolean + required: + - AuthenticationConfiguration + - Filters + - Authentication + - TargetPipeline + - TargetAction + x-stackql-resource-name: webhook + description: Resource Type definition for AWS::CodePipeline::Webhook + x-type-name: AWS::CodePipeline::Webhook + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + x-write-only-properties: + - TargetPipelineVersion + - RegisterWithThirdParty + x-read-only-properties: + - Id + - Url + x-required-properties: + - AuthenticationConfiguration + - Filters + - Authentication + - TargetPipeline + - TargetAction + x-tagging: + taggable: false + x-required-permissions: + create: + - codepipeline:ListWebhooks + - codepipeline:RegisterWebhookWithThirdParty + - codepipeline:PutWebhook + read: + - codepipeline:ListWebhooks + update: + - codepipeline:ListWebhooks + - codepipeline:RegisterWebhookWithThirdParty + - codepipeline:PutWebhook + - codepipeline:DeregisterWebhookWithThirdParty + delete: + - codepipeline:ListWebhooks + - codepipeline:DeleteWebhook + - codepipeline:DeregisterWebhookWithThirdParty + list: + - codepipeline:ListWebhooks + CreateCustomActionTypeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Category: + description: The category of the custom action, such as a build action or a test action. + type: string + ConfigurationProperties: + description: The configuration properties for the custom action. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ConfigurationProperties' + InputArtifactDetails: + description: The details of the input artifact for the action, such as its commit ID. + $ref: '#/components/schemas/ArtifactDetails' + OutputArtifactDetails: + description: The details of the output artifact of the action, such as its commit ID. + $ref: '#/components/schemas/ArtifactDetails' + Provider: + description: The provider of the service used in the custom action, such as AWS CodeDeploy. + type: string + Settings: + description: URLs that provide users information about this custom action. + $ref: '#/components/schemas/Settings' + Tags: + description: Any tags assigned to the custom action. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Version: + description: The version identifier of the custom action. + type: string + Id: + type: string + x-stackQL-stringOnly: true + x-title: CreateCustomActionTypeRequest + type: object + required: [] + CreatePipelineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ArtifactStores: + description: A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ArtifactStoreMap' + DisableInboundStageTransitions: + description: Represents the input of a DisableStageTransition action. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/StageTransition' + Stages: + description: Represents information about a stage and its definition. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/StageDeclaration' + ExecutionMode: + description: The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED. + enum: + - QUEUED + - SUPERSEDED + - PARALLEL + default: SUPERSEDED + type: string + RestartExecutionOnUpdate: + description: Indicates whether to rerun the CodePipeline pipeline after you update it. + type: boolean + Triggers: + description: The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/PipelineTriggerDeclaration' + RoleArn: + description: The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn + type: string + pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.* + Name: + description: The name of the pipeline. + type: string + Variables: + description: A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/VariableDeclaration' + Version: + description: The version of the pipeline. + type: string + ArtifactStore: + description: The S3 bucket where artifacts for the pipeline are stored. + $ref: '#/components/schemas/ArtifactStore' + PipelineType: + description: CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications. + type: string + enum: + - V1 + - V2 + Tags: + description: Specifies the tags applied to the pipeline. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePipelineRequest + type: object + required: [] + CreateWebhookRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AuthenticationConfiguration: + description: Properties that configure the authentication applied to incoming webhook trigger requests + $ref: '#/components/schemas/WebhookAuthConfiguration' + Filters: + description: A list of rules applied to the body/payload sent in the POST request to a webhook URL + type: array + uniqueItems: false + x-insertionOrder: true + items: + $ref: '#/components/schemas/WebhookFilterRule' + Authentication: + description: Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. + type: string + enum: + - GITHUB_HMAC + - IP + - UNAUTHENTICATED + TargetPipeline: + description: The name of the pipeline you want to connect to the webhook. + type: string + minLength: 1 + maxLength: 100 + pattern: '[A-Za-z0-9.@\-_]+' + TargetAction: + description: The name of the action in a pipeline you want to connect to the webhook. + type: string + minLength: 1 + maxLength: 100 + pattern: '[A-Za-z0-9.@\-_]+' + Id: + description: logical id of the webhook + type: string + Url: + description: The webhook URL generated by AWS CodePipeline + type: string + Name: + description: The name of the webhook + type: string + minLength: 1 + maxLength: 100 + pattern: '[A-Za-z0-9.@\-_]+' + TargetPipelineVersion: + description: The version number of the pipeline to be connected to the trigger request. + type: integer + RegisterWithThirdParty: + description: Configures a connection between the webhook that was created and the external tool with events to be detected. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateWebhookRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + custom_action_types: + name: custom_action_types + id: awscc.codepipeline.custom_action_types + x-cfn-schema-name: CustomActionType + x-cfn-type-name: AWS::CodePipeline::CustomActionType + x-identifiers: + - Category + - Provider + - Version + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomActionType&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::CustomActionType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::CustomActionType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::CustomActionType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Category') as category, + JSON_EXTRACT(Properties, '$.ConfigurationProperties') as configuration_properties, + JSON_EXTRACT(Properties, '$.InputArtifactDetails') as input_artifact_details, + JSON_EXTRACT(Properties, '$.OutputArtifactDetails') as output_artifact_details, + JSON_EXTRACT(Properties, '$.Provider') as provider, + JSON_EXTRACT(Properties, '$.Settings') as settings, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Category') as category, + json_extract_path_text(Properties, 'ConfigurationProperties') as configuration_properties, + json_extract_path_text(Properties, 'InputArtifactDetails') as input_artifact_details, + json_extract_path_text(Properties, 'OutputArtifactDetails') as output_artifact_details, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Settings') as settings, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' + AND data__Identifier = '||' + AND region = 'us-east-1' + custom_action_types_list_only: + name: custom_action_types_list_only + id: awscc.codepipeline.custom_action_types_list_only + x-cfn-schema-name: CustomActionType + x-cfn-type-name: AWS::CodePipeline::CustomActionType + x-identifiers: + - Category + - Provider + - Version + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Category') as category, + JSON_EXTRACT(Properties, '$.Provider') as provider, + JSON_EXTRACT(Properties, '$.Version') as version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Category') as category, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Version') as version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' + AND region = 'us-east-1' + pipelines: + name: pipelines + id: awscc.codepipeline.pipelines + x-cfn-schema-name: Pipeline + x-cfn-type-name: AWS::CodePipeline::Pipeline + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ArtifactStores') as artifact_stores, + JSON_EXTRACT(Properties, '$.DisableInboundStageTransitions') as disable_inbound_stage_transitions, + JSON_EXTRACT(Properties, '$.Stages') as stages, + JSON_EXTRACT(Properties, '$.ExecutionMode') as execution_mode, + JSON_EXTRACT(Properties, '$.RestartExecutionOnUpdate') as restart_execution_on_update, + JSON_EXTRACT(Properties, '$.Triggers') as triggers, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Variables') as variables, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.ArtifactStore') as artifact_store, + JSON_EXTRACT(Properties, '$.PipelineType') as pipeline_type, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::Pipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ArtifactStores') as artifact_stores, + json_extract_path_text(Properties, 'DisableInboundStageTransitions') as disable_inbound_stage_transitions, + json_extract_path_text(Properties, 'Stages') as stages, + json_extract_path_text(Properties, 'ExecutionMode') as execution_mode, + json_extract_path_text(Properties, 'RestartExecutionOnUpdate') as restart_execution_on_update, + json_extract_path_text(Properties, 'Triggers') as triggers, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Variables') as variables, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'ArtifactStore') as artifact_store, + json_extract_path_text(Properties, 'PipelineType') as pipeline_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::Pipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + pipelines_list_only: + name: pipelines_list_only + id: awscc.codepipeline.pipelines_list_only + x-cfn-schema-name: Pipeline + x-cfn-type-name: AWS::CodePipeline::Pipeline + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::Pipeline' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::Pipeline' + AND region = 'us-east-1' + webhooks: + name: webhooks + id: awscc.codepipeline.webhooks + x-cfn-schema-name: Webhook + x-cfn-type-name: AWS::CodePipeline::Webhook + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Webhook&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::Webhook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::Webhook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodePipeline::Webhook" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AuthenticationConfiguration') as authentication_configuration, + JSON_EXTRACT(Properties, '$.Filters') as filters, + JSON_EXTRACT(Properties, '$.Authentication') as authentication, + JSON_EXTRACT(Properties, '$.TargetPipeline') as target_pipeline, + JSON_EXTRACT(Properties, '$.TargetAction') as target_action, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Url') as url, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.TargetPipelineVersion') as target_pipeline_version, + JSON_EXTRACT(Properties, '$.RegisterWithThirdParty') as register_with_third_party + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::Webhook' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AuthenticationConfiguration') as authentication_configuration, + json_extract_path_text(Properties, 'Filters') as filters, + json_extract_path_text(Properties, 'Authentication') as authentication, + json_extract_path_text(Properties, 'TargetPipeline') as target_pipeline, + json_extract_path_text(Properties, 'TargetAction') as target_action, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'TargetPipelineVersion') as target_pipeline_version, + json_extract_path_text(Properties, 'RegisterWithThirdParty') as register_with_third_party + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::Webhook' + AND data__Identifier = '' + AND region = 'us-east-1' + webhooks_list_only: + name: webhooks_list_only + id: awscc.codepipeline.webhooks_list_only + x-cfn-schema-name: Webhook + x-cfn-type-name: AWS::CodePipeline::Webhook + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::Webhook' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::Webhook' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomActionType&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomActionType + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomActionTypeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePipeline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePipelineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Webhook&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWebhook + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWebhookRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codestarconnections.yaml b/providers/src/awscc/v00.00.00000/services/codestarconnections.yaml index f901a2d7..da013e89 100644 --- a/providers/src/awscc/v00.00.00000/services/codestarconnections.yaml +++ b/providers/src/awscc/v00.00.00000/services/codestarconnections.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeStarConnections - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -64,7 +444,9 @@ components: required: - ConnectionName x-stackql-resource-name: connection - x-stackql-primaryIdentifier: + description: Schema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline + x-type-name: AWS::CodeStarConnections::Connection + x-stackql-primary-identifier: - ConnectionArn x-create-only-properties: - ConnectionName @@ -74,6 +456,18 @@ components: - ConnectionArn - ConnectionStatus - OwnerAccountId + x-required-properties: + - ConnectionName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - codestar-connections:TagResource + - codestar-connections:ListTagsForResource + - codestar-connections:UntagResource x-required-permissions: create: - codestar-connections:CreateConnection @@ -100,7 +494,12 @@ components: ProviderType: description: The name of the external provider where your third-party code repository is configured. type: string - pattern: ^(GitHub|Bitbucket|GitHubEnterprise|GitLab)$ + enum: + - GitHub + - Bitbucket + - GitHubEnterprise + - GitLab + - GitLabSelfManaged OwnerId: description: the ID of the entity that owns the repository. type: string @@ -132,8 +531,12 @@ components: - ConnectionArn - OwnerId x-stackql-resource-name: repository_link - x-stackql-primaryIdentifier: + description: Schema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources. + x-type-name: AWS::CodeStarConnections::RepositoryLink + x-stackql-primary-identifier: - RepositoryLinkArn + x-stackql-additional-identifiers: + - - RepositoryLinkId x-create-only-properties: - RepositoryName - OwnerId @@ -141,6 +544,20 @@ components: - RepositoryLinkArn - RepositoryLinkId - ProviderType + x-required-properties: + - RepositoryName + - ConnectionArn + - OwnerId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - codestar-connections:UntagResource + - codestar-connections:ListTagsForResource + - codestar-connections:TagResource x-required-permissions: update: - codestar-connections:GetConnection @@ -186,7 +603,12 @@ components: ProviderType: description: The name of the external provider where your third-party code repository is configured. type: string - pattern: ^(GitHub|Bitbucket|GitHubEnterprise|GitLab)$ + enum: + - GitHub + - Bitbucket + - GitHubEnterprise + - GitLab + - GitLabSelfManaged Branch: description: The name of the branch of the repository from which resources are to be synchronized, type: string @@ -199,6 +621,18 @@ components: RoleArn: description: The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository. type: string + PublishDeploymentStatus: + description: Whether to enable or disable publishing of deployment status to source providers. + type: string + enum: + - ENABLED + - DISABLED + TriggerResourceUpdateOn: + description: When to trigger Git sync to begin the stack update. + type: string + enum: + - ANY_CHANGE + - FILE_CHANGE RepositoryLinkId: description: A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with. type: string @@ -211,7 +645,9 @@ components: - SyncType - RoleArn x-stackql-resource-name: sync_configuration - x-stackql-primaryIdentifier: + description: Schema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider. + x-type-name: AWS::CodeStarConnections::SyncConfiguration + x-stackql-primary-identifier: - ResourceName - SyncType x-create-only-properties: @@ -221,6 +657,15 @@ components: - ProviderType - OwnerId - RepositoryName + x-required-properties: + - Branch + - ConfigFile + - RepositoryLinkId + - ResourceName + - SyncType + - RoleArn + x-tagging: + taggable: false x-required-permissions: create: - codestar-connections:CreateSyncConfiguration @@ -238,43 +683,247 @@ components: list: - codestar-connections:ListSyncConfigurations - codestar-connections:ListRepositoryLinks + CreateConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectionArn: + description: The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + ConnectionName: + description: The name of the connection. Connection names must be unique in an AWS user account. + type: string + minLength: 1 + maxLength: 32 + ConnectionStatus: + description: The current status of the connection. + type: string + OwnerAccountId: + description: The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository. + type: string + minLength: 12 + maxLength: 12 + pattern: '[0-9]{12}' + ProviderType: + description: The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn. + type: string + HostArn: + description: The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn. + type: string + minLength: 0 + maxLength: 256 + pattern: arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+ + Tags: + description: Specifies the tags applied to a connection. + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateConnectionRequest + type: object + required: [] + CreateRepositoryLinkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectionArn: + description: The Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+ + ProviderType: + description: The name of the external provider where your third-party code repository is configured. + type: string + enum: + - GitHub + - Bitbucket + - GitHubEnterprise + - GitLab + - GitLabSelfManaged + OwnerId: + description: the ID of the entity that owns the repository. + type: string + pattern: '[a-za-z0-9_\.-]+' + RepositoryName: + description: The repository for which the link is being created. + type: string + pattern: '[a-za-z0-9_\.-]+' + EncryptionKeyArn: + description: The ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+ + RepositoryLinkId: + description: A UUID that uniquely identifies the RepositoryLink. + type: string + pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' + RepositoryLinkArn: + description: A unique Amazon Resource Name (ARN) to designate the repository link. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):.+:.+:[0-9]{12}:.+ + Tags: + description: Specifies the tags applied to a RepositoryLink. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRepositoryLinkRequest + type: object + required: [] + CreateSyncConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OwnerId: + description: the ID of the entity that owns the repository. + type: string + pattern: '[a-za-z0-9_\.-]+' + ResourceName: + description: The name of the resource that is being synchronized to the repository. + type: string + pattern: '[a-za-z0-9_\.-]+' + RepositoryName: + description: The name of the repository that is being synced to. + type: string + pattern: '[a-za-z0-9_\.-]+' + ProviderType: + description: The name of the external provider where your third-party code repository is configured. + type: string + enum: + - GitHub + - Bitbucket + - GitHubEnterprise + - GitLab + - GitLabSelfManaged + Branch: + description: The name of the branch of the repository from which resources are to be synchronized, + type: string + ConfigFile: + description: The source provider repository path of the sync configuration file of the respective SyncType. + type: string + SyncType: + description: The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC. + type: string + RoleArn: + description: The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository. + type: string + PublishDeploymentStatus: + description: Whether to enable or disable publishing of deployment status to source providers. + type: string + enum: + - ENABLED + - DISABLED + TriggerResourceUpdateOn: + description: When to trigger Git sync to begin the stack update. + type: string + enum: + - ANY_CHANGE + - FILE_CHANGE + RepositoryLinkId: + description: A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with. + type: string + pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' + x-stackQL-stringOnly: true + x-title: CreateSyncConfigurationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: connections: name: connections id: awscc.codestarconnections.connections x-cfn-schema-name: Connection - x-type: list - x-identifiers: - - ConnectionArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' - AND region = 'us-east-1' - connection: - name: connection - id: awscc.codestarconnections.connection - x-cfn-schema-name: Connection - x-type: get + x-cfn-type-name: AWS::CodeStarConnections::Connection x-identifiers: - ConnectionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -290,7 +939,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -305,13 +954,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' AND data__Identifier = '' AND region = 'us-east-1' - repository_links: - name: repository_links - id: awscc.codestarconnections.repository_links - x-cfn-schema-name: RepositoryLink - x-type: list + connections_list_only: + name: connections_list_only + id: awscc.codestarconnections.connections_list_only + x-cfn-schema-name: Connection + x-cfn-type-name: AWS::CodeStarConnections::Connection x-identifiers: - - RepositoryLinkArn + - ConnectionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -319,28 +974,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RepositoryLinkArn') as repository_link_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' + JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RepositoryLinkArn') as repository_link_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' AND region = 'us-east-1' - repository_link: - name: repository_link - id: awscc.codestarconnections.repository_link + repository_links: + name: repository_links + id: awscc.codestarconnections.repository_links x-cfn-schema-name: RepositoryLink - x-type: get + x-cfn-type-name: AWS::CodeStarConnections::RepositoryLink x-identifiers: - RepositoryLinkArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RepositoryLink&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::RepositoryLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::RepositoryLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::RepositoryLink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repository_links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repository_links/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/repository_links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -357,7 +1060,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -373,14 +1076,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' AND data__Identifier = '' AND region = 'us-east-1' - sync_configurations: - name: sync_configurations - id: awscc.codestarconnections.sync_configurations - x-cfn-schema-name: SyncConfiguration - x-type: list + repository_links_list_only: + name: repository_links_list_only + id: awscc.codestarconnections.repository_links_list_only + x-cfn-schema-name: RepositoryLink + x-cfn-type-name: AWS::CodeStarConnections::RepositoryLink x-identifiers: - - ResourceName - - SyncType + - RepositoryLinkArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -388,31 +1096,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResourceName') as resource_name, - JSON_EXTRACT(Properties, '$.SyncType') as sync_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' + JSON_EXTRACT(Properties, '$.RepositoryLinkArn') as repository_link_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResourceName') as resource_name, - json_extract_path_text(Properties, 'SyncType') as sync_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' + json_extract_path_text(Properties, 'RepositoryLinkArn') as repository_link_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' AND region = 'us-east-1' - sync_configuration: - name: sync_configuration - id: awscc.codestarconnections.sync_configuration + sync_configurations: + name: sync_configurations + id: awscc.codestarconnections.sync_configurations x-cfn-schema-name: SyncConfiguration - x-type: get + x-cfn-type-name: AWS::CodeStarConnections::SyncConfiguration x-identifiers: - ResourceName - SyncType + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SyncConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::SyncConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::SyncConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarConnections::SyncConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -425,12 +1179,14 @@ components: JSON_EXTRACT(Properties, '$.ConfigFile') as config_file, JSON_EXTRACT(Properties, '$.SyncType') as sync_type, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.PublishDeploymentStatus') as publish_deployment_status, + JSON_EXTRACT(Properties, '$.TriggerResourceUpdateOn') as trigger_resource_update_on, JSON_EXTRACT(Properties, '$.RepositoryLinkId') as repository_link_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -443,7 +1199,322 @@ components: json_extract_path_text(Properties, 'ConfigFile') as config_file, json_extract_path_text(Properties, 'SyncType') as sync_type, json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'PublishDeploymentStatus') as publish_deployment_status, + json_extract_path_text(Properties, 'TriggerResourceUpdateOn') as trigger_resource_update_on, json_extract_path_text(Properties, 'RepositoryLinkId') as repository_link_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' AND data__Identifier = '|' AND region = 'us-east-1' + sync_configurations_list_only: + name: sync_configurations_list_only + id: awscc.codestarconnections.sync_configurations_list_only + x-cfn-schema-name: SyncConfiguration + x-cfn-type-name: AWS::CodeStarConnections::SyncConfiguration + x-identifiers: + - ResourceName + - SyncType + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ResourceName') as resource_name, + JSON_EXTRACT(Properties, '$.SyncType') as sync_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceName') as resource_name, + json_extract_path_text(Properties, 'SyncType') as sync_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RepositoryLink&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRepositoryLink + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRepositoryLinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SyncConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSyncConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSyncConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/codestarnotifications.yaml b/providers/src/awscc/v00.00.00000/services/codestarnotifications.yaml index 62d297f5..10e55655 100644 --- a/providers/src/awscc/v00.00.00000/services/codestarnotifications.yaml +++ b/providers/src/awscc/v00.00.00000/services/codestarnotifications.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CodeStarNotifications - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Target: type: object @@ -78,12 +458,23 @@ components: - Targets - Name x-stackql-resource-name: notification_rule - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::CodeStarNotifications::NotificationRule + x-type-name: AWS::CodeStarNotifications::NotificationRule + x-stackql-primary-identifier: - Arn x-create-only-properties: - Resource + x-write-only-properties: + - EventTypeId + - TargetAddress x-read-only-properties: - Arn + x-required-properties: + - EventTypeIds + - Resource + - DetailType + - Targets + - Name x-required-permissions: create: - codestar-notifications:createNotificationRule @@ -98,43 +489,142 @@ components: - codestar-notifications:updateNotificationRule - codestar-notifications:TagResource - codestar-notifications:UntagResource + CreateNotificationRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EventTypeId: + type: string + minLength: 1 + maxLength: 2048 + CreatedBy: + type: string + minLength: 1 + maxLength: 2048 + TargetAddress: + type: string + minLength: 1 + maxLength: 2048 + EventTypeIds: + type: array + uniqueItems: false + items: + type: string + minLength: 1 + maxLength: 200 + Status: + type: string + enum: + - ENABLED + - DISABLED + DetailType: + type: string + enum: + - BASIC + - FULL + Resource: + type: string + pattern: ^arn:aws[^:\s]*:[^:\s]*:[^:\s]*:[0-9]{12}:[^\s]+$ + Targets: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Target' + maxItems: 10 + Tags: + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + Name: + type: string + pattern: '[A-Za-z0-9\-_ ]+$' + minLength: 1 + maxLength: 64 + Arn: + type: string + pattern: ^arn:aws[^:\s]*:codestar-notifications:[^:\s]+:\d{12}:notificationrule\/(.*\S)?$ + x-stackQL-stringOnly: true + x-title: CreateNotificationRuleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: notification_rules: name: notification_rules id: awscc.codestarnotifications.notification_rules x-cfn-schema-name: NotificationRule - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' - AND region = 'us-east-1' - notification_rule: - name: notification_rule - id: awscc.codestarnotifications.notification_rule - x-cfn-schema-name: NotificationRule - x-type: get + x-cfn-type-name: AWS::CodeStarNotifications::NotificationRule x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NotificationRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarNotifications::NotificationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarNotifications::NotificationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CodeStarNotifications::NotificationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -154,7 +644,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -173,3 +663,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' AND data__Identifier = '' AND region = 'us-east-1' + notification_rules_list_only: + name: notification_rules_list_only + id: awscc.codestarnotifications.notification_rules_list_only + x-cfn-schema-name: NotificationRule + x-cfn-type-name: AWS::CodeStarNotifications::NotificationRule + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NotificationRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNotificationRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNotificationRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cognito.yaml b/providers/src/awscc/v00.00.00000/services/cognito.yaml index 481f61ba..42b40d3f 100644 --- a/providers/src/awscc/v00.00.00000/services/cognito.yaml +++ b/providers/src/awscc/v00.00.00000/services/cognito.yaml @@ -1,10 +1,408 @@ openapi: 3.0.0 info: title: Cognito - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false PushSync: type: object additionalProperties: false @@ -81,19 +479,44 @@ components: type: string AllowClassicFlow: type: boolean + IdentityPoolTags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - AllowUnauthenticatedIdentities x-stackql-resource-name: identity_pool - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::IdentityPool + x-type-name: AWS::Cognito::IdentityPool + x-stackql-primary-identifier: - Id + x-write-only-properties: + - PushSync + - CognitoStreams + - CognitoEvents x-read-only-properties: - Id - Name + x-required-properties: + - AllowUnauthenticatedIdentities + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/IdentityPoolTags + permissions: + - cognito-identity:TagResource + - cognito-identity:UntagResource x-required-permissions: create: - cognito-identity:CreateIdentityPool - cognito-sync:SetIdentityPoolConfiguration - cognito-sync:SetCognitoEvents + - cognito-identity:TagResource - iam:PassRole read: - cognito-identity:DescribeIdentityPool @@ -102,6 +525,8 @@ components: - cognito-identity:DescribeIdentityPool - cognito-sync:SetIdentityPoolConfiguration - cognito-sync:SetCognitoEvents + - cognito-identity:TagResource + - cognito-identity:UntagResource - iam:PassRole delete: - cognito-identity:DeleteIdentityPool @@ -122,12 +547,22 @@ components: - IdentityPoolId - IdentityProviderName x-stackql-resource-name: identity_pool_principal_tag - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::IdentityPoolPrincipalTag + x-type-name: AWS::Cognito::IdentityPoolPrincipalTag + x-stackql-primary-identifier: - IdentityPoolId - IdentityProviderName x-create-only-properties: - IdentityPoolId - IdentityProviderName + x-required-properties: + - IdentityPoolId + - IdentityProviderName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-identity:GetPrincipalTagAttributeMap @@ -205,12 +640,23 @@ components: required: - IdentityPoolId x-stackql-resource-name: identity_pool_role_attachment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment + x-type-name: AWS::Cognito::IdentityPoolRoleAttachment + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - IdentityPoolId x-create-only-properties: - IdentityPoolId x-read-only-properties: - Id + x-required-properties: + - IdentityPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-identity:GetIdentityPoolRoles @@ -233,6 +679,18 @@ components: LogGroupArn: type: string additionalProperties: false + S3Configuration: + type: object + properties: + BucketArn: + type: string + additionalProperties: false + FirehoseConfiguration: + type: object + properties: + StreamArn: + type: string + additionalProperties: false LogConfiguration: type: object properties: @@ -242,6 +700,10 @@ components: type: string CloudWatchLogsConfiguration: $ref: '#/components/schemas/CloudWatchLogsConfiguration' + S3Configuration: + $ref: '#/components/schemas/S3Configuration' + FirehoseConfiguration: + $ref: '#/components/schemas/FirehoseConfiguration' additionalProperties: false LogConfigurations: type: array @@ -259,12 +721,21 @@ components: required: - UserPoolId x-stackql-resource-name: log_delivery_configuration - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::LogDeliveryConfiguration + x-type-name: AWS::Cognito::LogDeliveryConfiguration + x-stackql-primary-identifier: - Id x-create-only-properties: - UserPoolId x-read-only-properties: - Id + x-required-properties: + - UserPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-idp:GetLogDeliveryConfiguration @@ -277,6 +748,13 @@ components: - logs:PutResourcePolicy - logs:DescribeResourcePolicies - logs:DescribeLogGroups + - s3:GetBucketPolicy + - s3:PutBucketPolicy + - s3:ListBucket + - s3:PutObject + - s3:GetBucketAcl + - firehose:TagDeliveryStream + - iam:CreateServiceLinkedRole read: - cognito-idp:GetLogDeliveryConfiguration update: @@ -290,6 +768,13 @@ components: - logs:PutResourcePolicy - logs:DescribeResourcePolicies - logs:DescribeLogGroups + - s3:GetBucketPolicy + - s3:PutBucketPolicy + - s3:ListBucket + - s3:PutObject + - s3:GetBucketAcl + - firehose:TagDeliveryStream + - iam:CreateServiceLinkedRole delete: - cognito-idp:GetLogDeliveryConfiguration - cognito-idp:SetLogDeliveryConfiguration @@ -301,6 +786,127 @@ components: - logs:PutResourcePolicy - logs:DescribeResourcePolicies - logs:DescribeLogGroups + - s3:GetBucketPolicy + - s3:PutBucketPolicy + - s3:ListBucket + - s3:PutObject + - s3:GetBucketAcl + - firehose:TagDeliveryStream + - iam:CreateServiceLinkedRole + ManagedLoginBrandingIdType: + type: string + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ + CategoryType: + type: string + enum: + - FAVICON_ICO + - FAVICON_SVG + - EMAIL_GRAPHIC + - SMS_GRAPHIC + - AUTH_APP_GRAPHIC + - PASSWORD_GRAPHIC + - PASSKEY_GRAPHIC + - PAGE_HEADER_LOGO + - PAGE_HEADER_BACKGROUND + - PAGE_FOOTER_LOGO + - PAGE_FOOTER_BACKGROUND + - PAGE_BACKGROUND + - FORM_BACKGROUND + - FORM_LOGO + - IDP_BUTTON_ICON + ColorModeType: + type: string + enum: + - LIGHT + - DARK + - DYNAMIC + ExtensionType: + type: string + enum: + - ICO + - JPEG + - PNG + - SVG + - WEBP + BytesType: + type: string + maxLength: 1000000 + ResourceIdType: + type: string + pattern: ^[\w\- ]+$ + minLength: 1 + maxLength: 40 + AssetType: + type: object + properties: + Category: + $ref: '#/components/schemas/CategoryType' + ColorMode: + $ref: '#/components/schemas/ColorModeType' + Extension: + $ref: '#/components/schemas/ExtensionType' + Bytes: + $ref: '#/components/schemas/BytesType' + ResourceId: + $ref: '#/components/schemas/ResourceIdType' + additionalProperties: false + required: + - Category + - ColorMode + - Extension + AssetList: + type: array + items: + $ref: '#/components/schemas/AssetType' + ManagedLoginBranding: + type: object + properties: + UserPoolId: + type: string + ClientId: + type: string + UseCognitoProvidedValues: + type: boolean + Settings: + type: object + Assets: + $ref: '#/components/schemas/AssetList' + ManagedLoginBrandingId: + $ref: '#/components/schemas/ManagedLoginBrandingIdType' + ReturnMergedResources: + type: boolean + required: + - UserPoolId + x-stackql-resource-name: managed_login_branding + description: Resource Type definition for AWS::Cognito::ManagedLoginBranding + x-type-name: AWS::Cognito::ManagedLoginBranding + x-stackql-primary-identifier: + - UserPoolId + - ManagedLoginBrandingId + x-create-only-properties: + - UserPoolId + - ClientId + x-write-only-properties: + - ClientId + - ReturnMergedResources + x-read-only-properties: + - ManagedLoginBrandingId + x-required-properties: + - UserPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cognito-idp:CreateManagedLoginBranding + read: + - cognito-idp:DescribeManagedLoginBranding + update: + - cognito-idp:UpdateManagedLoginBranding + delete: + - cognito-idp:DeleteManagedLoginBranding PasswordPolicy: type: object properties: @@ -316,12 +922,24 @@ components: type: boolean TemporaryPasswordValidityDays: type: integer + PasswordHistorySize: + type: integer + additionalProperties: false + SignInPolicy: + type: object + properties: + AllowedFirstAuthFactors: + type: array + items: + type: string additionalProperties: false Policies: type: object properties: PasswordPolicy: $ref: '#/components/schemas/PasswordPolicy' + SignInPolicy: + $ref: '#/components/schemas/SignInPolicy' additionalProperties: false InviteMessageTemplate: type: object @@ -513,11 +1131,19 @@ components: SmsMessage: type: string additionalProperties: false + AdvancedSecurityAdditionalFlows: + type: object + properties: + CustomAuthMode: + type: string + additionalProperties: false UserPoolAddOns: type: object properties: AdvancedSecurityMode: type: string + AdvancedSecurityAdditionalFlows: + $ref: '#/components/schemas/AdvancedSecurityAdditionalFlows' additionalProperties: false UserPool: type: object @@ -570,12 +1196,28 @@ components: type: string minLength: 6 maxLength: 140 + EmailAuthenticationMessage: + type: string + minLength: 6 + maxLength: 20000 + EmailAuthenticationSubject: + type: string + minLength: 1 + maxLength: 140 SmsConfiguration: $ref: '#/components/schemas/SmsConfiguration' SmsVerificationMessage: type: string minLength: 6 maxLength: 140 + WebAuthnRelyingPartyID: + type: string + minLength: 1 + maxLength: 63 + WebAuthnUserVerification: + type: string + minLength: 1 + maxLength: 9 Schema: type: array items: @@ -602,14 +1244,34 @@ components: type: string UserPoolId: type: string + UserPoolTier: + type: string + enum: + - LITE + - ESSENTIALS + - PLUS x-stackql-resource-name: user_pool - x-stackql-primaryIdentifier: + description: Definition of AWS::Cognito::UserPool Resource Type + x-type-name: AWS::Cognito::UserPool + x-stackql-primary-identifier: - UserPoolId + x-write-only-properties: + - EnabledMfas x-read-only-properties: - ProviderName - UserPoolId - ProviderURL - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/UserPoolTags + permissions: + - cognito-idp:ListTagsForResource + - cognito-idp:UntagResource + - cognito-idp:TagResource x-required-permissions: create: - cognito-idp:CreateUserPool @@ -618,8 +1280,10 @@ components: - cognito-idp:DescribeUserPool - kms:CreateGrant - iam:CreateServiceLinkedRole + - cognito-idp:TagResource read: - cognito-idp:DescribeUserPool + - cognito-idp:GetUserPoolMfaConfig update: - cognito-idp:UpdateUserPool - cognito-idp:ListTagsForResource @@ -628,6 +1292,7 @@ components: - cognito-idp:SetUserPoolMfaConfig - cognito-idp:AddCustomAttributes - cognito-idp:DescribeUserPool + - cognito-idp:GetUserPoolMfaConfig - iam:PassRole delete: - cognito-idp:DeleteUserPool @@ -657,6 +1322,18 @@ components: RefreshToken: type: string additionalProperties: false + RefreshTokenRotation: + type: object + properties: + Feature: + type: string + enum: + - ENABLED + - DISABLED + RetryGracePeriodSeconds: + type: integer + minimum: 0 + maximum: 60 UserPoolClient: type: object properties: @@ -692,6 +1369,8 @@ components: maximum: 86400 TokenValidityUnits: $ref: '#/components/schemas/TokenValidityUnits' + RefreshTokenRotation: + $ref: '#/components/schemas/RefreshTokenRotation' UserPoolId: type: string WriteAttributes: @@ -739,7 +1418,9 @@ components: required: - UserPoolId x-stackql-resource-name: user_pool_client - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::UserPoolClient + x-type-name: AWS::Cognito::UserPoolClient + x-stackql-primary-identifier: - UserPoolId - ClientId x-create-only-properties: @@ -749,6 +1430,13 @@ components: - ClientSecret - Name - ClientId + x-required-properties: + - UserPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-idp:CreateUserPoolClient @@ -767,6 +1455,63 @@ components: - iam:DeleteRolePolicy list: - cognito-idp:ListUserPoolClients + CustomDomainConfigType: + type: object + properties: + CertificateArn: + type: string + additionalProperties: false + UserPoolDomain: + type: object + properties: + UserPoolId: + type: string + Domain: + type: string + CustomDomainConfig: + $ref: '#/components/schemas/CustomDomainConfigType' + CloudFrontDistribution: + type: string + ManagedLoginVersion: + type: integer + required: + - UserPoolId + - Domain + x-stackql-resource-name: user_pool_domain + description: Resource Type definition for AWS::Cognito::UserPoolDomain + x-type-name: AWS::Cognito::UserPoolDomain + x-stackql-primary-identifier: + - UserPoolId + - Domain + x-create-only-properties: + - UserPoolId + - Domain + x-write-only-properties: + - ManagedLoginVersion + x-read-only-properties: + - CloudFrontDistribution + x-required-properties: + - UserPoolId + - Domain + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cognito-idp:CreateUserPoolDomain + - cognito-idp:DescribeUserPoolDomain + - cloudfront:updateDistribution + read: + - cognito-idp:DescribeUserPoolDomain + update: + - cognito-idp:UpdateUserPoolDomain + - cognito-idp:DescribeUserPoolDomain + - cloudfront:updateDistribution + delete: + - cognito-idp:DeleteUserPoolDomain + - cognito-idp:DescribeUserPoolDomain UserPoolGroup: type: object properties: @@ -785,12 +1530,21 @@ components: required: - UserPoolId x-stackql-resource-name: user_pool_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::UserPoolGroup + x-type-name: AWS::Cognito::UserPoolGroup + x-stackql-primary-identifier: - UserPoolId - GroupName x-create-only-properties: - UserPoolId - GroupName + x-required-properties: + - UserPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-idp:CreateGroup @@ -809,6 +1563,127 @@ components: - iam:PutRolePolicy list: - cognito-idp:ListGroups + UserPoolIdentityProvider: + type: object + properties: + UserPoolId: + type: string + ProviderName: + type: string + ProviderType: + type: string + ProviderDetails: + type: object + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + IdpIdentifiers: + type: array + items: + type: string + AttributeMapping: + type: object + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + required: + - UserPoolId + - ProviderName + - ProviderType + - ProviderDetails + x-stackql-resource-name: user_pool_identity_provider + description: Resource Type definition for AWS::Cognito::UserPoolIdentityProvider + x-type-name: AWS::Cognito::UserPoolIdentityProvider + x-stackql-primary-identifier: + - UserPoolId + - ProviderName + x-create-only-properties: + - UserPoolId + - ProviderName + - ProviderType + x-required-properties: + - UserPoolId + - ProviderName + - ProviderType + - ProviderDetails + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cognito-idp:CreateIdentityProvider + - cognito-idp:DescribeIdentityProvider + read: + - cognito-idp:DescribeIdentityProvider + update: + - cognito-idp:UpdateIdentityProvider + - cognito-idp:DescribeIdentityProvider + delete: + - cognito-idp:DeleteIdentityProvider + - cognito-idp:DescribeIdentityProvider + list: + - cognito-idp:ListIdentityProviders + ResourceServerScopeType: + type: object + properties: + ScopeDescription: + type: string + ScopeName: + type: string + required: + - ScopeDescription + - ScopeName + additionalProperties: false + UserPoolResourceServer: + type: object + properties: + UserPoolId: + type: string + Identifier: + type: string + Name: + type: string + Scopes: + type: array + items: + $ref: '#/components/schemas/ResourceServerScopeType' + required: + - UserPoolId + - Identifier + - Name + x-stackql-resource-name: user_pool_resource_server + description: Resource Type definition for AWS::Cognito::UserPoolResourceServer + x-type-name: AWS::Cognito::UserPoolResourceServer + x-stackql-primary-identifier: + - UserPoolId + - Identifier + x-create-only-properties: + - UserPoolId + - Identifier + x-required-properties: + - UserPoolId + - Identifier + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cognito-idp:CreateResourceServer + read: + - cognito-idp:DescribeResourceServer + update: + - cognito-idp:UpdateResourceServer + delete: + - cognito-idp:DeleteResourceServer + list: + - cognito-idp:ListResourceServers RiskExceptionConfigurationType: type: object properties: @@ -922,12 +1797,22 @@ components: - UserPoolId - ClientId x-stackql-resource-name: user_pool_risk_configuration_attachment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment + x-type-name: AWS::Cognito::UserPoolRiskConfigurationAttachment + x-stackql-primary-identifier: - UserPoolId - ClientId x-create-only-properties: - UserPoolId - ClientId + x-required-properties: + - UserPoolId + - ClientId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-idp:SetRiskConfiguration @@ -942,16 +1827,56 @@ components: delete: - cognito-idp:SetRiskConfiguration - cognito-idp:DescribeRiskConfiguration - AttributeType: + UserPoolUICustomizationAttachment: type: object properties: - Name: + UserPoolId: type: string - Value: + ClientId: type: string - additionalProperties: false - UserPoolUser: - type: object + CSS: + type: string + required: + - UserPoolId + - ClientId + x-stackql-resource-name: user_poolui_customization_attachment + description: Resource Type definition for AWS::Cognito::UserPoolUICustomizationAttachment + x-type-name: AWS::Cognito::UserPoolUICustomizationAttachment + x-stackql-primary-identifier: + - UserPoolId + - ClientId + x-create-only-properties: + - UserPoolId + - ClientId + x-required-properties: + - UserPoolId + - ClientId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - cognito-idp:SetUICustomization + - cognito-idp:GetUICustomization + read: + - cognito-idp:GetUICustomization + update: + - cognito-idp:SetUICustomization + delete: + - cognito-idp:SetUICustomization + - cognito-idp:GetUICustomization + AttributeType: + type: object + properties: + Name: + type: string + Value: + type: string + additionalProperties: false + UserPoolUser: + type: object properties: DesiredDeliveryMediums: type: array @@ -982,7 +1907,9 @@ components: required: - UserPoolId x-stackql-resource-name: user_pool_user - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::UserPoolUser + x-type-name: AWS::Cognito::UserPoolUser + x-stackql-primary-identifier: - UserPoolId - Username x-create-only-properties: @@ -994,6 +1921,19 @@ components: - ValidationData - ClientMetadata - MessageAction + x-write-only-properties: + - DesiredDeliveryMediums + - ForceAliasCreation + - ValidationData + - ClientMetadata + - MessageAction + x-required-properties: + - UserPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-idp:AdminCreateUser @@ -1019,7 +1959,9 @@ components: - Username - GroupName x-stackql-resource-name: user_pool_user_to_group_attachment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment + x-type-name: AWS::Cognito::UserPoolUserToGroupAttachment + x-stackql-primary-identifier: - UserPoolId - GroupName - Username @@ -1027,6 +1969,15 @@ components: - UserPoolId - GroupName - Username + x-required-properties: + - UserPoolId + - Username + - GroupName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - cognito-idp:AdminAddUserToGroup @@ -1036,43 +1987,697 @@ components: - cognito-idp:AdminListGroupsForUser read: - cognito-idp:AdminListGroupsForUser + CreateIdentityPoolRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PushSync: + $ref: '#/components/schemas/PushSync' + CognitoIdentityProviders: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/CognitoIdentityProvider' + DeveloperProviderName: + type: string + CognitoStreams: + $ref: '#/components/schemas/CognitoStreams' + SupportedLoginProviders: + type: object + Name: + type: string + CognitoEvents: + type: object + Id: + type: string + IdentityPoolName: + type: string + AllowUnauthenticatedIdentities: + type: boolean + SamlProviderARNs: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + OpenIdConnectProviderARNs: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + AllowClassicFlow: + type: boolean + IdentityPoolTags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIdentityPoolRequest + type: object + required: [] + CreateIdentityPoolPrincipalTagRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdentityPoolId: + type: string + IdentityProviderName: + type: string + UseDefaults: + type: boolean + PrincipalTags: + type: object + x-stackQL-stringOnly: true + x-title: CreateIdentityPoolPrincipalTagRequest + type: object + required: [] + CreateIdentityPoolRoleAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdentityPoolId: + type: string + Roles: + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + Id: + type: string + RoleMappings: + x-patternProperties: + ^.+$: + $ref: '#/components/schemas/RoleMapping' + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateIdentityPoolRoleAttachmentRequest + type: object + required: [] + CreateLogDeliveryConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + UserPoolId: + type: string + LogConfigurations: + $ref: '#/components/schemas/LogConfigurations' + x-stackQL-stringOnly: true + x-title: CreateLogDeliveryConfigurationRequest + type: object + required: [] + CreateManagedLoginBrandingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + ClientId: + type: string + UseCognitoProvidedValues: + type: boolean + Settings: + type: object + Assets: + $ref: '#/components/schemas/AssetList' + ManagedLoginBrandingId: + $ref: '#/components/schemas/ManagedLoginBrandingIdType' + ReturnMergedResources: + type: boolean + x-stackQL-stringOnly: true + x-title: CreateManagedLoginBrandingRequest + type: object + required: [] + CreateUserPoolRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolName: + type: string + minLength: 1 + maxLength: 128 + Policies: + $ref: '#/components/schemas/Policies' + AccountRecoverySetting: + $ref: '#/components/schemas/AccountRecoverySetting' + AdminCreateUserConfig: + $ref: '#/components/schemas/AdminCreateUserConfig' + AliasAttributes: + type: array + items: + type: string + UsernameAttributes: + type: array + items: + type: string + AutoVerifiedAttributes: + type: array + items: + type: string + DeviceConfiguration: + $ref: '#/components/schemas/DeviceConfiguration' + EmailConfiguration: + $ref: '#/components/schemas/EmailConfiguration' + EmailVerificationMessage: + type: string + minLength: 6 + maxLength: 20000 + EmailVerificationSubject: + type: string + minLength: 1 + maxLength: 140 + DeletionProtection: + type: string + LambdaConfig: + $ref: '#/components/schemas/LambdaConfig' + MfaConfiguration: + type: string + EnabledMfas: + type: array + items: + type: string + SmsAuthenticationMessage: + type: string + minLength: 6 + maxLength: 140 + EmailAuthenticationMessage: + type: string + minLength: 6 + maxLength: 20000 + EmailAuthenticationSubject: + type: string + minLength: 1 + maxLength: 140 + SmsConfiguration: + $ref: '#/components/schemas/SmsConfiguration' + SmsVerificationMessage: + type: string + minLength: 6 + maxLength: 140 + WebAuthnRelyingPartyID: + type: string + minLength: 1 + maxLength: 63 + WebAuthnUserVerification: + type: string + minLength: 1 + maxLength: 9 + Schema: + type: array + items: + $ref: '#/components/schemas/SchemaAttribute' + UsernameConfiguration: + $ref: '#/components/schemas/UsernameConfiguration' + UserAttributeUpdateSettings: + $ref: '#/components/schemas/UserAttributeUpdateSettings' + UserPoolTags: + type: object + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + VerificationMessageTemplate: + $ref: '#/components/schemas/VerificationMessageTemplate' + UserPoolAddOns: + $ref: '#/components/schemas/UserPoolAddOns' + ProviderName: + type: string + ProviderURL: + type: string + Arn: + type: string + UserPoolId: + type: string + UserPoolTier: + type: string + enum: + - LITE + - ESSENTIALS + - PLUS + x-stackQL-stringOnly: true + x-title: CreateUserPoolRequest + type: object + required: [] + CreateUserPoolClientRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClientName: + type: string + minLength: 1 + maxLength: 128 + ExplicitAuthFlows: + type: array + items: + type: string + GenerateSecret: + type: boolean + ReadAttributes: + type: array + items: + type: string + AuthSessionValidity: + type: integer + minimum: 3 + maximum: 15 + RefreshTokenValidity: + type: integer + minimum: 1 + maximum: 315360000 + AccessTokenValidity: + type: integer + minimum: 1 + maximum: 86400 + IdTokenValidity: + type: integer + minimum: 1 + maximum: 86400 + TokenValidityUnits: + $ref: '#/components/schemas/TokenValidityUnits' + RefreshTokenRotation: + $ref: '#/components/schemas/RefreshTokenRotation' + UserPoolId: + type: string + WriteAttributes: + type: array + items: + type: string + AllowedOAuthFlows: + type: array + items: + type: string + AllowedOAuthFlowsUserPoolClient: + type: boolean + AllowedOAuthScopes: + type: array + items: + type: string + CallbackURLs: + type: array + items: + type: string + DefaultRedirectURI: + type: string + LogoutURLs: + type: array + items: + type: string + SupportedIdentityProviders: + type: array + items: + type: string + AnalyticsConfiguration: + $ref: '#/components/schemas/AnalyticsConfiguration' + PreventUserExistenceErrors: + type: string + EnableTokenRevocation: + type: boolean + EnablePropagateAdditionalUserContextData: + type: boolean + Name: + type: string + ClientSecret: + type: string + ClientId: + type: string + x-stackQL-stringOnly: true + x-title: CreateUserPoolClientRequest + type: object + required: [] + CreateUserPoolDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + Domain: + type: string + CustomDomainConfig: + $ref: '#/components/schemas/CustomDomainConfigType' + CloudFrontDistribution: + type: string + ManagedLoginVersion: + type: integer + x-stackQL-stringOnly: true + x-title: CreateUserPoolDomainRequest + type: object + required: [] + CreateUserPoolGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 2048 + GroupName: + type: string + Precedence: + type: integer + minimum: 0 + RoleArn: + type: string + UserPoolId: + type: string + x-stackQL-stringOnly: true + x-title: CreateUserPoolGroupRequest + type: object + required: [] + CreateUserPoolIdentityProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + ProviderName: + type: string + ProviderType: + type: string + ProviderDetails: + type: object + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + IdpIdentifiers: + type: array + items: + type: string + AttributeMapping: + type: object + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateUserPoolIdentityProviderRequest + type: object + required: [] + CreateUserPoolResourceServerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + Identifier: + type: string + Name: + type: string + Scopes: + type: array + items: + $ref: '#/components/schemas/ResourceServerScopeType' + x-stackQL-stringOnly: true + x-title: CreateUserPoolResourceServerRequest + type: object + required: [] + CreateUserPoolRiskConfigurationAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + ClientId: + type: string + RiskExceptionConfiguration: + $ref: '#/components/schemas/RiskExceptionConfigurationType' + CompromisedCredentialsRiskConfiguration: + $ref: '#/components/schemas/CompromisedCredentialsRiskConfigurationType' + AccountTakeoverRiskConfiguration: + $ref: '#/components/schemas/AccountTakeoverRiskConfigurationType' + x-stackQL-stringOnly: true + x-title: CreateUserPoolRiskConfigurationAttachmentRequest + type: object + required: [] + CreateUserPoolUICustomizationAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + ClientId: + type: string + CSS: + type: string + x-stackQL-stringOnly: true + x-title: CreateUserPoolUICustomizationAttachmentRequest + type: object + required: [] + CreateUserPoolUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DesiredDeliveryMediums: + type: array + items: + type: string + ForceAliasCreation: + type: boolean + UserAttributes: + type: array + items: + $ref: '#/components/schemas/AttributeType' + MessageAction: + type: string + Username: + type: string + UserPoolId: + type: string + ValidationData: + type: array + items: + $ref: '#/components/schemas/AttributeType' + ClientMetadata: + type: object + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateUserPoolUserRequest + type: object + required: [] + CreateUserPoolUserToGroupAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + UserPoolId: + type: string + Username: + type: string + GroupName: + type: string + x-stackQL-stringOnly: true + x-title: CreateUserPoolUserToGroupAttachmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: identity_pools: name: identity_pools id: awscc.cognito.identity_pools x-cfn-schema-name: IdentityPool - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' - AND region = 'us-east-1' - identity_pool: - name: identity_pool - id: awscc.cognito.identity_pool - x-cfn-schema-name: IdentityPool - x-type: get + x-cfn-type-name: AWS::Cognito::IdentityPool x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentityPool&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_pools/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1089,12 +2694,13 @@ components: JSON_EXTRACT(Properties, '$.AllowUnauthenticatedIdentities') as allow_unauthenticated_identities, JSON_EXTRACT(Properties, '$.SamlProviderARNs') as saml_provider_arns, JSON_EXTRACT(Properties, '$.OpenIdConnectProviderARNs') as open_id_connect_provider_arns, - JSON_EXTRACT(Properties, '$.AllowClassicFlow') as allow_classic_flow + JSON_EXTRACT(Properties, '$.AllowClassicFlow') as allow_classic_flow, + JSON_EXTRACT(Properties, '$.IdentityPoolTags') as identity_pool_tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPool' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1111,18 +2717,24 @@ components: json_extract_path_text(Properties, 'AllowUnauthenticatedIdentities') as allow_unauthenticated_identities, json_extract_path_text(Properties, 'SamlProviderARNs') as saml_provider_arns, json_extract_path_text(Properties, 'OpenIdConnectProviderARNs') as open_id_connect_provider_arns, - json_extract_path_text(Properties, 'AllowClassicFlow') as allow_classic_flow + json_extract_path_text(Properties, 'AllowClassicFlow') as allow_classic_flow, + json_extract_path_text(Properties, 'IdentityPoolTags') as identity_pool_tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPool' AND data__Identifier = '' AND region = 'us-east-1' - identity_pool_principal_tags: - name: identity_pool_principal_tags - id: awscc.cognito.identity_pool_principal_tags - x-cfn-schema-name: IdentityPoolPrincipalTag - x-type: list + identity_pools_list_only: + name: identity_pools_list_only + id: awscc.cognito.identity_pools_list_only + x-cfn-schema-name: IdentityPool + x-cfn-type-name: AWS::Cognito::IdentityPool x-identifiers: - - IdentityPoolId - - IdentityProviderName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1130,31 +2742,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IdentityPoolId') as identity_pool_id, - JSON_EXTRACT(Properties, '$.IdentityProviderName') as identity_provider_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, - json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' AND region = 'us-east-1' - identity_pool_principal_tag: - name: identity_pool_principal_tag - id: awscc.cognito.identity_pool_principal_tag + identity_pool_principal_tags: + name: identity_pool_principal_tags + id: awscc.cognito.identity_pool_principal_tags x-cfn-schema-name: IdentityPoolPrincipalTag - x-type: get + x-cfn-type-name: AWS::Cognito::IdentityPoolPrincipalTag x-identifiers: - IdentityPoolId - IdentityProviderName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentityPoolPrincipalTag&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPoolPrincipalTag" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPoolPrincipalTag" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPoolPrincipalTag" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1167,7 +2825,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1179,13 +2837,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' AND data__Identifier = '|' AND region = 'us-east-1' - identity_pool_role_attachments: - name: identity_pool_role_attachments - id: awscc.cognito.identity_pool_role_attachments - x-cfn-schema-name: IdentityPoolRoleAttachment - x-type: list + identity_pool_principal_tags_list_only: + name: identity_pool_principal_tags_list_only + id: awscc.cognito.identity_pool_principal_tags_list_only + x-cfn-schema-name: IdentityPoolPrincipalTag + x-cfn-type-name: AWS::Cognito::IdentityPoolPrincipalTag x-identifiers: - - Id + - IdentityPoolId + - IdentityProviderName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1193,28 +2858,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' + JSON_EXTRACT(Properties, '$.IdentityPoolId') as identity_pool_id, + JSON_EXTRACT(Properties, '$.IdentityProviderName') as identity_provider_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' + json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, + json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' AND region = 'us-east-1' - identity_pool_role_attachment: - name: identity_pool_role_attachment - id: awscc.cognito.identity_pool_role_attachment + identity_pool_role_attachments: + name: identity_pool_role_attachments + id: awscc.cognito.identity_pool_role_attachments x-cfn-schema-name: IdentityPoolRoleAttachment - x-type: get + x-cfn-type-name: AWS::Cognito::IdentityPoolRoleAttachment x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentityPoolRoleAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPoolRoleAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPoolRoleAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::IdentityPoolRoleAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1227,7 +2942,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1239,17 +2954,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' AND data__Identifier = '' AND region = 'us-east-1' - log_delivery_configuration: - name: log_delivery_configuration - id: awscc.cognito.log_delivery_configuration - x-cfn-schema-name: LogDeliveryConfiguration - x-type: get + identity_pool_role_attachments_list_only: + name: identity_pool_role_attachments_list_only + id: awscc.cognito.identity_pool_role_attachments_list_only + x-cfn-schema-name: IdentityPoolRoleAttachment + x-cfn-type-name: AWS::Cognito::IdentityPoolRoleAttachment x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' + AND region = 'us-east-1' + log_delivery_configurations: + name: log_delivery_configurations + id: awscc.cognito.log_delivery_configurations + x-cfn-schema-name: LogDeliveryConfiguration + x-cfn-type-name: AWS::Cognito::LogDeliveryConfiguration + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LogDeliveryConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::LogDeliveryConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::LogDeliveryConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::LogDeliveryConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1261,7 +3055,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1272,42 +3066,155 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::LogDeliveryConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - user_pools: - name: user_pools - id: awscc.cognito.user_pools - x-cfn-schema-name: UserPool - x-type: list + managed_login_brandings: + name: managed_login_brandings + id: awscc.cognito.managed_login_brandings + x-cfn-schema-name: ManagedLoginBranding + x-cfn-type-name: AWS::Cognito::ManagedLoginBranding x-identifiers: - UserPoolId + - ManagedLoginBrandingId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ManagedLoginBranding&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::ManagedLoginBranding" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::ManagedLoginBranding" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::ManagedLoginBranding" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/managed_login_brandings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/managed_login_brandings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/managed_login_brandings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' + data__Identifier, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.ClientId') as client_id, + JSON_EXTRACT(Properties, '$.UseCognitoProvidedValues') as use_cognito_provided_values, + JSON_EXTRACT(Properties, '$.Settings') as settings, + JSON_EXTRACT(Properties, '$.Assets') as assets, + JSON_EXTRACT(Properties, '$.ManagedLoginBrandingId') as managed_login_branding_id, + JSON_EXTRACT(Properties, '$.ReturnMergedResources') as return_merged_resources + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::ManagedLoginBranding' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' + data__Identifier, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'ClientId') as client_id, + json_extract_path_text(Properties, 'UseCognitoProvidedValues') as use_cognito_provided_values, + json_extract_path_text(Properties, 'Settings') as settings, + json_extract_path_text(Properties, 'Assets') as assets, + json_extract_path_text(Properties, 'ManagedLoginBrandingId') as managed_login_branding_id, + json_extract_path_text(Properties, 'ReturnMergedResources') as return_merged_resources + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::ManagedLoginBranding' + AND data__Identifier = '|' AND region = 'us-east-1' - user_pool: - name: user_pool - id: awscc.cognito.user_pool + user_pools: + name: user_pools + id: awscc.cognito.user_pools x-cfn-schema-name: UserPool - x-type: get + x-cfn-type-name: AWS::Cognito::UserPool x-identifiers: - UserPoolId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPool&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pools/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1328,8 +3235,12 @@ components: JSON_EXTRACT(Properties, '$.MfaConfiguration') as mfa_configuration, JSON_EXTRACT(Properties, '$.EnabledMfas') as enabled_mfas, JSON_EXTRACT(Properties, '$.SmsAuthenticationMessage') as sms_authentication_message, + JSON_EXTRACT(Properties, '$.EmailAuthenticationMessage') as email_authentication_message, + JSON_EXTRACT(Properties, '$.EmailAuthenticationSubject') as email_authentication_subject, JSON_EXTRACT(Properties, '$.SmsConfiguration') as sms_configuration, JSON_EXTRACT(Properties, '$.SmsVerificationMessage') as sms_verification_message, + JSON_EXTRACT(Properties, '$.WebAuthnRelyingPartyID') as web_authn_relying_party_id, + JSON_EXTRACT(Properties, '$.WebAuthnUserVerification') as web_authn_user_verification, JSON_EXTRACT(Properties, '$.Schema') as _schema, JSON_EXTRACT(Properties, '$.UsernameConfiguration') as username_configuration, JSON_EXTRACT(Properties, '$.UserAttributeUpdateSettings') as user_attribute_update_settings, @@ -1339,12 +3250,13 @@ components: JSON_EXTRACT(Properties, '$.ProviderName') as provider_name, JSON_EXTRACT(Properties, '$.ProviderURL') as provider_url, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.UserPoolTier') as user_pool_tier FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPool' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1365,8 +3277,12 @@ components: json_extract_path_text(Properties, 'MfaConfiguration') as mfa_configuration, json_extract_path_text(Properties, 'EnabledMfas') as enabled_mfas, json_extract_path_text(Properties, 'SmsAuthenticationMessage') as sms_authentication_message, + json_extract_path_text(Properties, 'EmailAuthenticationMessage') as email_authentication_message, + json_extract_path_text(Properties, 'EmailAuthenticationSubject') as email_authentication_subject, json_extract_path_text(Properties, 'SmsConfiguration') as sms_configuration, json_extract_path_text(Properties, 'SmsVerificationMessage') as sms_verification_message, + json_extract_path_text(Properties, 'WebAuthnRelyingPartyID') as web_authn_relying_party_id, + json_extract_path_text(Properties, 'WebAuthnUserVerification') as web_authn_user_verification, json_extract_path_text(Properties, 'Schema') as _schema, json_extract_path_text(Properties, 'UsernameConfiguration') as username_configuration, json_extract_path_text(Properties, 'UserAttributeUpdateSettings') as user_attribute_update_settings, @@ -1376,50 +3292,102 @@ components: json_extract_path_text(Properties, 'ProviderName') as provider_name, json_extract_path_text(Properties, 'ProviderURL') as provider_url, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'UserPoolTier') as user_pool_tier FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPool' AND data__Identifier = '' AND region = 'us-east-1' - user_pool_clients: - name: user_pool_clients - id: awscc.cognito.user_pool_clients - x-cfn-schema-name: UserPoolClient - x-type: list + user_pools_list_only: + name: user_pools_list_only + id: awscc.cognito.user_pools_list_only + x-cfn-schema-name: UserPool + x-cfn-type-name: AWS::Cognito::UserPool x-identifiers: - UserPoolId - - ClientId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" ddl: |- SELECT - region, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, - JSON_EXTRACT(Properties, '$.ClientId') as client_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' + region, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'ClientId') as client_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' AND region = 'us-east-1' - user_pool_client: - name: user_pool_client - id: awscc.cognito.user_pool_client + user_pool_clients: + name: user_pool_clients + id: awscc.cognito.user_pool_clients x-cfn-schema-name: UserPoolClient - x-type: get + x-cfn-type-name: AWS::Cognito::UserPoolClient x-identifiers: - UserPoolId - ClientId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolClient&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolClient" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolClient" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolClient" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1433,6 +3401,7 @@ components: JSON_EXTRACT(Properties, '$.AccessTokenValidity') as access_token_validity, JSON_EXTRACT(Properties, '$.IdTokenValidity') as id_token_validity, JSON_EXTRACT(Properties, '$.TokenValidityUnits') as token_validity_units, + JSON_EXTRACT(Properties, '$.RefreshTokenRotation') as refresh_token_rotation, JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, JSON_EXTRACT(Properties, '$.WriteAttributes') as write_attributes, JSON_EXTRACT(Properties, '$.AllowedOAuthFlows') as allowed_oauth_flows, @@ -1453,7 +3422,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1467,6 +3436,7 @@ components: json_extract_path_text(Properties, 'AccessTokenValidity') as access_token_validity, json_extract_path_text(Properties, 'IdTokenValidity') as id_token_validity, json_extract_path_text(Properties, 'TokenValidityUnits') as token_validity_units, + json_extract_path_text(Properties, 'RefreshTokenRotation') as refresh_token_rotation, json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, json_extract_path_text(Properties, 'WriteAttributes') as write_attributes, json_extract_path_text(Properties, 'AllowedOAuthFlows') as allowed_oauth_flows, @@ -1486,14 +3456,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' AND data__Identifier = '|' AND region = 'us-east-1' - user_pool_groups: - name: user_pool_groups - id: awscc.cognito.user_pool_groups - x-cfn-schema-name: UserPoolGroup - x-type: list + user_pool_clients_list_only: + name: user_pool_clients_list_only + id: awscc.cognito.user_pool_clients_list_only + x-cfn-schema-name: UserPoolClient + x-cfn-type-name: AWS::Cognito::UserPoolClient x-identifiers: - UserPoolId - - GroupName + - ClientId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1502,8 +3478,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' + JSON_EXTRACT(Properties, '$.ClientId') as client_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1511,21 +3487,155 @@ components: SELECT region, json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' + json_extract_path_text(Properties, 'ClientId') as client_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' + AND region = 'us-east-1' + user_pool_domains: + name: user_pool_domains + id: awscc.cognito.user_pool_domains + x-cfn-schema-name: UserPoolDomain + x-cfn-type-name: AWS::Cognito::UserPoolDomain + x-identifiers: + - UserPoolId + - Domain + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolDomain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolDomain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolDomain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolDomain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pool_domains/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.CustomDomainConfig') as custom_domain_config, + JSON_EXTRACT(Properties, '$.CloudFrontDistribution') as cloud_front_distribution, + JSON_EXTRACT(Properties, '$.ManagedLoginVersion') as managed_login_version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolDomain' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'CustomDomainConfig') as custom_domain_config, + json_extract_path_text(Properties, 'CloudFrontDistribution') as cloud_front_distribution, + json_extract_path_text(Properties, 'ManagedLoginVersion') as managed_login_version + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolDomain' + AND data__Identifier = '|' AND region = 'us-east-1' - user_pool_group: - name: user_pool_group - id: awscc.cognito.user_pool_group + user_pool_groups: + name: user_pool_groups + id: awscc.cognito.user_pool_groups x-cfn-schema-name: UserPoolGroup - x-type: get + x-cfn-type-name: AWS::Cognito::UserPoolGroup x-identifiers: - UserPoolId - GroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1539,7 +3649,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1552,18 +3662,340 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' AND data__Identifier = '|' AND region = 'us-east-1' - user_pool_risk_configuration_attachment: - name: user_pool_risk_configuration_attachment - id: awscc.cognito.user_pool_risk_configuration_attachment + user_pool_groups_list_only: + name: user_pool_groups_list_only + id: awscc.cognito.user_pool_groups_list_only + x-cfn-schema-name: UserPoolGroup + x-cfn-type-name: AWS::Cognito::UserPoolGroup + x-identifiers: + - UserPoolId + - GroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'GroupName') as group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' + AND region = 'us-east-1' + user_pool_identity_providers: + name: user_pool_identity_providers + id: awscc.cognito.user_pool_identity_providers + x-cfn-schema-name: UserPoolIdentityProvider + x-cfn-type-name: AWS::Cognito::UserPoolIdentityProvider + x-identifiers: + - UserPoolId + - ProviderName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolIdentityProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolIdentityProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolIdentityProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolIdentityProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_identity_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_identity_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pool_identity_providers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.ProviderName') as provider_name, + JSON_EXTRACT(Properties, '$.ProviderType') as provider_type, + JSON_EXTRACT(Properties, '$.ProviderDetails') as provider_details, + JSON_EXTRACT(Properties, '$.IdpIdentifiers') as idp_identifiers, + JSON_EXTRACT(Properties, '$.AttributeMapping') as attribute_mapping + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolIdentityProvider' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'ProviderName') as provider_name, + json_extract_path_text(Properties, 'ProviderType') as provider_type, + json_extract_path_text(Properties, 'ProviderDetails') as provider_details, + json_extract_path_text(Properties, 'IdpIdentifiers') as idp_identifiers, + json_extract_path_text(Properties, 'AttributeMapping') as attribute_mapping + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolIdentityProvider' + AND data__Identifier = '|' + AND region = 'us-east-1' + user_pool_identity_providers_list_only: + name: user_pool_identity_providers_list_only + id: awscc.cognito.user_pool_identity_providers_list_only + x-cfn-schema-name: UserPoolIdentityProvider + x-cfn-type-name: AWS::Cognito::UserPoolIdentityProvider + x-identifiers: + - UserPoolId + - ProviderName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.ProviderName') as provider_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolIdentityProvider' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'ProviderName') as provider_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolIdentityProvider' + AND region = 'us-east-1' + user_pool_resource_servers: + name: user_pool_resource_servers + id: awscc.cognito.user_pool_resource_servers + x-cfn-schema-name: UserPoolResourceServer + x-cfn-type-name: AWS::Cognito::UserPoolResourceServer + x-identifiers: + - UserPoolId + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolResourceServer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolResourceServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolResourceServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolResourceServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_resource_servers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_resource_servers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pool_resource_servers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Scopes') as scopes + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolResourceServer' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Scopes') as scopes + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolResourceServer' + AND data__Identifier = '|' + AND region = 'us-east-1' + user_pool_resource_servers_list_only: + name: user_pool_resource_servers_list_only + id: awscc.cognito.user_pool_resource_servers_list_only + x-cfn-schema-name: UserPoolResourceServer + x-cfn-type-name: AWS::Cognito::UserPoolResourceServer + x-identifiers: + - UserPoolId + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolResourceServer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolResourceServer' + AND region = 'us-east-1' + user_pool_risk_configuration_attachments: + name: user_pool_risk_configuration_attachments + id: awscc.cognito.user_pool_risk_configuration_attachments x-cfn-schema-name: UserPoolRiskConfigurationAttachment - x-type: get + x-cfn-type-name: AWS::Cognito::UserPoolRiskConfigurationAttachment x-identifiers: - UserPoolId - ClientId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolRiskConfigurationAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolRiskConfigurationAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolRiskConfigurationAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolRiskConfigurationAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1577,7 +4009,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1590,46 +4022,135 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolRiskConfigurationAttachment' AND data__Identifier = '|' AND region = 'us-east-1' - user_pool_users: - name: user_pool_users - id: awscc.cognito.user_pool_users - x-cfn-schema-name: UserPoolUser - x-type: list + user_poolui_customization_attachments: + name: user_poolui_customization_attachments + id: awscc.cognito.user_poolui_customization_attachments + x-cfn-schema-name: UserPoolUICustomizationAttachment + x-cfn-type-name: AWS::Cognito::UserPoolUICustomizationAttachment x-identifiers: - UserPoolId - - Username + - ClientId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolUICustomizationAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUICustomizationAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUICustomizationAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUICustomizationAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_poolui_customization_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_poolui_customization_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_poolui_customization_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, - JSON_EXTRACT(Properties, '$.Username') as username - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' + JSON_EXTRACT(Properties, '$.ClientId') as client_id, + JSON_EXTRACT(Properties, '$.CSS') as c_ss + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolUICustomizationAttachment' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'Username') as username - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' + json_extract_path_text(Properties, 'ClientId') as client_id, + json_extract_path_text(Properties, 'CSS') as c_ss + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolUICustomizationAttachment' + AND data__Identifier = '|' AND region = 'us-east-1' - user_pool_user: - name: user_pool_user - id: awscc.cognito.user_pool_user + user_pool_users: + name: user_pool_users + id: awscc.cognito.user_pool_users x-cfn-schema-name: UserPoolUser - x-type: get + x-cfn-type-name: AWS::Cognito::UserPoolUser x-identifiers: - UserPoolId - Username + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolUser&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUser" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUser" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_users/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1646,7 +4167,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1662,19 +4183,88 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' AND data__Identifier = '|' AND region = 'us-east-1' - user_pool_user_to_group_attachment: - name: user_pool_user_to_group_attachment - id: awscc.cognito.user_pool_user_to_group_attachment + user_pool_users_list_only: + name: user_pool_users_list_only + id: awscc.cognito.user_pool_users_list_only + x-cfn-schema-name: UserPoolUser + x-cfn-type-name: AWS::Cognito::UserPoolUser + x-identifiers: + - UserPoolId + - Username + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.Username') as username + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'Username') as username + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' + AND region = 'us-east-1' + user_pool_user_to_group_attachments: + name: user_pool_user_to_group_attachments + id: awscc.cognito.user_pool_user_to_group_attachments x-cfn-schema-name: UserPoolUserToGroupAttachment - x-type: get + x-cfn-type-name: AWS::Cognito::UserPoolUserToGroupAttachment x-identifiers: - UserPoolId - GroupName - Username + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPoolUserToGroupAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUserToGroupAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Cognito::UserPoolUserToGroupAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_user_to_group_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_user_to_group_attachments/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1686,7 +4276,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1697,3 +4287,786 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolUserToGroupAttachment' AND data__Identifier = '||' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentityPool&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentityPool + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentityPoolRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentityPoolPrincipalTag&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentityPoolPrincipalTag + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentityPoolPrincipalTagRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentityPoolRoleAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentityPoolRoleAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentityPoolRoleAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LogDeliveryConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLogDeliveryConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLogDeliveryConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ManagedLoginBranding&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateManagedLoginBranding + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateManagedLoginBrandingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPool&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPool + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolClient&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolClient + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolClientRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolDomain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolIdentityProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolIdentityProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolIdentityProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolResourceServer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolResourceServer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolResourceServerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolRiskConfigurationAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolRiskConfigurationAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolRiskConfigurationAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolUICustomizationAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolUICustomizationAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolUICustomizationAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolUser&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPoolUserToGroupAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPoolUserToGroupAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPoolUserToGroupAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/comprehend.yaml b/providers/src/awscc/v00.00.00000/services/comprehend.yaml index cc2ab6ae..34efd24b 100644 --- a/providers/src/awscc/v00.00.00000/services/comprehend.yaml +++ b/providers/src/awscc/v00.00.00000/services/comprehend.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Comprehend - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -224,7 +604,9 @@ components: - InputDataConfig - LanguageCode x-stackql-resource-name: document_classifier - x-stackql-primaryIdentifier: + description: Document Classifier enables training document classifier models. + x-type-name: AWS::Comprehend::DocumentClassifier + x-stackql-primary-identifier: - Arn x-create-only-properties: - DataAccessRoleArn @@ -239,6 +621,20 @@ components: - VpcConfig x-read-only-properties: - Arn + x-required-properties: + - DocumentClassifierName + - DataAccessRoleArn + - InputDataConfig + - LanguageCode + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - comprehend:TagResource + - comprehend:UntagResource x-required-permissions: create: - iam:PassRole @@ -385,7 +781,9 @@ components: - DataAccessRoleArn - DataLakeS3Uri x-stackql-resource-name: flywheel - x-stackql-primaryIdentifier: + description: The AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model. + x-type-name: AWS::Comprehend::Flywheel + x-stackql-primary-identifier: - Arn x-create-only-properties: - FlywheelName @@ -394,6 +792,19 @@ components: - TaskConfig x-read-only-properties: - Arn + x-required-properties: + - FlywheelName + - DataAccessRoleArn + - DataLakeS3Uri + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - comprehend:TagResource + - comprehend:UntagResource x-required-permissions: create: - iam:PassRole @@ -415,43 +826,200 @@ components: - comprehend:DescribeFlywheel list: - comprehend:ListFlywheels + CreateDocumentClassifierRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DataAccessRoleArn: + type: string + pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ + minLength: 20 + maxLength: 2048 + InputDataConfig: + $ref: '#/components/schemas/DocumentClassifierInputDataConfig' + OutputDataConfig: + $ref: '#/components/schemas/DocumentClassifierOutputDataConfig' + LanguageCode: + type: string + enum: + - en + - es + - fr + - it + - de + - pt + ModelKmsKeyId: + $ref: '#/components/schemas/KmsKeyId' + ModelPolicy: + type: string + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + minLength: 1 + maxLength: 20000 + DocumentClassifierName: + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + minLength: 1 + maxLength: 63 + Mode: + type: string + enum: + - MULTI_CLASS + - MULTI_LABEL + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + VersionName: + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + minLength: 1 + maxLength: 63 + VolumeKmsKeyId: + $ref: '#/components/schemas/KmsKeyId' + VpcConfig: + $ref: '#/components/schemas/VpcConfig' + Arn: + type: string + pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)? + minLength: 1 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateDocumentClassifierRequest + type: object + required: [] + CreateFlywheelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActiveModelArn: + type: string + pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)? + maxLength: 256 + DataAccessRoleArn: + type: string + pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ + minLength: 20 + maxLength: 2048 + DataLakeS3Uri: + type: string + pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)? + maxLength: 512 + DataSecurityConfig: + $ref: '#/components/schemas/DataSecurityConfig' + FlywheelName: + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + minLength: 1 + maxLength: 63 + ModelType: + type: string + enum: + - DOCUMENT_CLASSIFIER + - ENTITY_RECOGNIZER + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + TaskConfig: + $ref: '#/components/schemas/TaskConfig' + Arn: + type: string + pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])* + minLength: 1 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateFlywheelRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: document_classifiers: name: document_classifiers id: awscc.comprehend.document_classifiers x-cfn-schema-name: DocumentClassifier - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' - AND region = 'us-east-1' - document_classifier: - name: document_classifier - id: awscc.comprehend.document_classifier - x-cfn-schema-name: DocumentClassifier - x-type: get + x-cfn-type-name: AWS::Comprehend::DocumentClassifier x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DocumentClassifier&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Comprehend::DocumentClassifier" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Comprehend::DocumentClassifier" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Comprehend::DocumentClassifier" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -473,7 +1041,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -494,13 +1062,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' AND data__Identifier = '' AND region = 'us-east-1' - flywheels: - name: flywheels - id: awscc.comprehend.flywheels - x-cfn-schema-name: Flywheel - x-type: list + document_classifiers_list_only: + name: document_classifiers_list_only + id: awscc.comprehend.document_classifiers_list_only + x-cfn-schema-name: DocumentClassifier + x-cfn-type-name: AWS::Comprehend::DocumentClassifier x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -509,7 +1083,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -517,19 +1091,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' AND region = 'us-east-1' - flywheel: - name: flywheel - id: awscc.comprehend.flywheel + flywheels: + name: flywheels + id: awscc.comprehend.flywheels x-cfn-schema-name: Flywheel - x-type: get + x-cfn-type-name: AWS::Comprehend::Flywheel x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Flywheel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Comprehend::Flywheel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Comprehend::Flywheel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Comprehend::Flywheel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flywheels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flywheels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flywheels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -547,7 +1169,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -564,3 +1186,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Comprehend::Flywheel' AND data__Identifier = '' AND region = 'us-east-1' + flywheels_list_only: + name: flywheels_list_only + id: awscc.comprehend.flywheels_list_only + x-cfn-schema-name: Flywheel + x-cfn-type-name: AWS::Comprehend::Flywheel + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DocumentClassifier&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDocumentClassifier + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDocumentClassifierRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Flywheel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlywheel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlywheelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/config.yaml b/providers/src/awscc/v00.00.00000/services/config.yaml index e04111ee..652eba1f 100644 --- a/providers/src/awscc/v00.00.00000/services/config.yaml +++ b/providers/src/awscc/v00.00.00000/services/config.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Config - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -43,13 +423,16 @@ components: type: array maxItems: 50 uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - AuthorizedAccountId - AuthorizedAwsRegion x-stackql-resource-name: aggregation_authorization - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Config::AggregationAuthorization + x-type-name: AWS::Config::AggregationAuthorization + x-stackql-primary-identifier: - AuthorizedAccountId - AuthorizedAwsRegion x-create-only-properties: @@ -57,6 +440,19 @@ components: - AuthorizedAwsRegion x-read-only-properties: - AggregationAuthorizationArn + x-required-properties: + - AuthorizedAccountId + - AuthorizedAwsRegion + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - config:TagResource + - config:UntagResource + - config:ListTagsForResource x-required-permissions: create: - config:DescribeAggregationAuthorizations @@ -228,14 +624,31 @@ components: required: - Source x-stackql-resource-name: config_rule - x-stackql-primaryIdentifier: + description: |- + You must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html). + Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*. + There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules. + CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key. + CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*. + If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. + For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules. + If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request. + For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*. + x-type-name: AWS::Config::ConfigRule + x-stackql-primary-identifier: - ConfigRuleName x-create-only-properties: - ConfigRuleName + x-write-only-properties: + - Source/CustomPolicyDetails/PolicyText x-read-only-properties: - ConfigRuleId - Compliance/Type - Arn + x-required-properties: + - Source + x-tagging: + taggable: false x-required-permissions: create: - config:PutConfigRule @@ -311,12 +724,24 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: configuration_aggregator - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Config::ConfigurationAggregator + x-type-name: AWS::Config::ConfigurationAggregator + x-stackql-primary-identifier: - ConfigurationAggregatorName x-create-only-properties: - ConfigurationAggregatorName x-read-only-properties: - ConfigurationAggregatorArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - config:TagResource + - config:UntagResource + - config:ListTagsForResource x-required-permissions: create: - config:PutConfigurationAggregator @@ -414,10 +839,25 @@ components: required: - ConformancePackName x-stackql-resource-name: conformance_pack - x-stackql-primaryIdentifier: + description: A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization. + x-type-name: AWS::Config::ConformancePack + x-documentation-url: https://docs.aws.amazon.com/config/latest/developerguide/conformance-packs.html + x-stackql-primary-identifier: - ConformancePackName x-create-only-properties: - ConformancePackName + x-write-only-properties: + - TemplateBody + - TemplateS3Uri + - TemplateSSMDocumentDetails + x-required-properties: + - ConformancePackName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - config:PutConformancePack @@ -490,10 +930,24 @@ components: required: - OrganizationConformancePackName x-stackql-resource-name: organization_conformance_pack - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Config::OrganizationConformancePack. + x-type-name: AWS::Config::OrganizationConformancePack + x-documentation-url: https://docs.aws.amazon.com/config/latest/developerguide/conformance-pack-organization-apis.html + x-stackql-primary-identifier: - OrganizationConformancePackName x-create-only-properties: - OrganizationConformancePackName + x-write-only-properties: + - TemplateBody + - TemplateS3Uri + x-required-properties: + - OrganizationConformancePackName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - config:PutOrganizationConformancePack @@ -563,13 +1017,28 @@ components: - QueryName - QueryExpression x-stackql-resource-name: stored_query - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Config::StoredQuery + x-type-name: AWS::Config::StoredQuery + x-stackql-primary-identifier: - QueryName x-create-only-properties: - QueryName x-read-only-properties: - QueryId - QueryArn + x-required-properties: + - QueryName + - QueryExpression + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - config:TagResource + - config:UntagResource + - config:ListTagsForResource x-required-permissions: create: - config:PutStoredQuery @@ -589,47 +1058,384 @@ components: - config:UntagResource list: - config:ListStoredQueries + CreateAggregationAuthorizationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AuthorizedAccountId: + description: The 12-digit account ID of the account authorized to aggregate data. + type: string + pattern: ^\d{12}$ + AuthorizedAwsRegion: + description: The region authorized to collect aggregated data. + type: string + minLength: 1 + maxLength: 64 + AggregationAuthorizationArn: + description: The ARN of the AggregationAuthorization. + type: string + Tags: + description: The tags for the AggregationAuthorization. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAggregationAuthorizationRequest + type: object + required: [] + CreateConfigRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConfigRuleId: + type: string + description: '' + Description: + type: string + description: The description that you provide for the CC rule. + Scope: + description: |- + Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes. + The scope can be empty. + $ref: '#/components/schemas/Scope' + ConfigRuleName: + type: string + description: A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + Arn: + type: string + description: '' + Compliance: + type: object + description: Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance. + additionalProperties: false + properties: + Type: + type: string + description: Compliance type determined by the Config rule + MaximumExecutionFrequency: + type: string + description: |- + The maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when: + + You are using an AWS managed rule that is triggered at a periodic frequency. + + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html). + + By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter. + Source: + description: Provides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources. + $ref: '#/components/schemas/Source' + InputParameters: + type: object + description: A string, in JSON format, that is passed to the CC rule Lambda function. + EvaluationModes: + type: array + description: The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only. + uniqueItems: false + items: + description: Mode of evaluation of AWS Config rule + $ref: '#/components/schemas/EvaluationModeConfiguration' + x-stackQL-stringOnly: true + x-title: CreateConfigRuleRequest + type: object + required: [] + CreateConfigurationAggregatorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountAggregationSources: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/AccountAggregationSource' + ConfigurationAggregatorName: + description: The name of the aggregator. + type: string + pattern: '[\w\-]+' + minLength: 1 + maxLength: 256 + ConfigurationAggregatorArn: + description: The Amazon Resource Name (ARN) of the aggregator. + type: string + OrganizationAggregationSource: + $ref: '#/components/schemas/OrganizationAggregationSource' + Tags: + description: The tags for the configuration aggregator. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateConfigurationAggregatorRequest + type: object + required: [] + CreateConformancePackRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConformancePackName: + description: Name of the conformance pack which will be assigned as the unique identifier. + type: string + pattern: '[a-zA-Z][-a-zA-Z0-9]*' + minLength: 1 + maxLength: 256 + DeliveryS3Bucket: + description: AWS Config stores intermediate files while processing conformance pack template. + type: string + minLength: 0 + maxLength: 63 + DeliveryS3KeyPrefix: + description: The prefix for delivery S3 bucket. + type: string + minLength: 0 + maxLength: 1024 + TemplateBody: + description: A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields. + type: string + minLength: 1 + maxLength: 51200 + TemplateS3Uri: + description: Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields. + type: string + pattern: s3://.* + minLength: 1 + maxLength: 1024 + TemplateSSMDocumentDetails: + description: The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document. + type: object + additionalProperties: false + properties: + DocumentName: + type: string + minLength: 3 + maxLength: 128 + DocumentVersion: + type: string + minLength: 1 + maxLength: 128 + ConformancePackInputParameters: + description: A list of ConformancePackInputParameter objects. + type: array + items: + $ref: '#/components/schemas/ConformancePackInputParameter' + minItems: 0 + maxItems: 60 + x-stackQL-stringOnly: true + x-title: CreateConformancePackRequest + type: object + required: [] + CreateOrganizationConformancePackRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OrganizationConformancePackName: + description: The name of the organization conformance pack. + type: string + pattern: '[a-zA-Z][-a-zA-Z0-9]*' + minLength: 1 + maxLength: 128 + TemplateS3Uri: + description: Location of file containing the template body. + type: string + pattern: s3://.* + minLength: 1 + maxLength: 1024 + TemplateBody: + description: A string containing full conformance pack template body. + type: string + minLength: 1 + maxLength: 51200 + DeliveryS3Bucket: + description: AWS Config stores intermediate files while processing conformance pack template. + type: string + minLength: 0 + maxLength: 63 + DeliveryS3KeyPrefix: + description: The prefix for the delivery S3 bucket. + type: string + minLength: 0 + maxLength: 1024 + ConformancePackInputParameters: + description: A list of ConformancePackInputParameter objects. + type: array + items: + $ref: '#/components/schemas/ConformancePackInputParameter' + minItems: 0 + maxItems: 60 + ExcludedAccounts: + description: A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack. + type: array + items: + $ref: '#/components/schemas/AccountId' + minItems: 0 + maxItems: 1000 + x-stackQL-stringOnly: true + x-title: CreateOrganizationConformancePackRequest + type: object + required: [] + CreateStoredQueryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + QueryArn: + type: string + minLength: 1 + maxLength: 500 + QueryId: + type: string + minLength: 1 + maxLength: 36 + pattern: ^\S+$ + QueryName: + type: string + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9-_]+$ + QueryDescription: + type: string + minLength: 0 + maxLength: 256 + pattern: '[\s\S]*' + QueryExpression: + type: string + minLength: 1 + maxLength: 4096 + pattern: '[\s\S]*' + Tags: + description: The tags for the stored query. + type: array + maxItems: 50 + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStoredQueryRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: aggregation_authorizations: name: aggregation_authorizations id: awscc.config.aggregation_authorizations x-cfn-schema-name: AggregationAuthorization - x-type: list - x-identifiers: - - AuthorizedAccountId - - AuthorizedAwsRegion - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AuthorizedAccountId') as authorized_account_id, - JSON_EXTRACT(Properties, '$.AuthorizedAwsRegion') as authorized_aws_region - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AuthorizedAccountId') as authorized_account_id, - json_extract_path_text(Properties, 'AuthorizedAwsRegion') as authorized_aws_region - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' - AND region = 'us-east-1' - aggregation_authorization: - name: aggregation_authorization - id: awscc.config.aggregation_authorization - x-cfn-schema-name: AggregationAuthorization - x-type: get + x-cfn-type-name: AWS::Config::AggregationAuthorization x-identifiers: - AuthorizedAccountId - AuthorizedAwsRegion + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AggregationAuthorization&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::AggregationAuthorization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::AggregationAuthorization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::AggregationAuthorization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -642,7 +1448,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -654,13 +1460,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' AND data__Identifier = '|' AND region = 'us-east-1' - config_rules: - name: config_rules - id: awscc.config.config_rules - x-cfn-schema-name: ConfigRule - x-type: list + aggregation_authorizations_list_only: + name: aggregation_authorizations_list_only + id: awscc.config.aggregation_authorizations_list_only + x-cfn-schema-name: AggregationAuthorization + x-cfn-type-name: AWS::Config::AggregationAuthorization x-identifiers: - - ConfigRuleName + - AuthorizedAccountId + - AuthorizedAwsRegion + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -668,28 +1481,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConfigRuleName') as config_rule_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' + JSON_EXTRACT(Properties, '$.AuthorizedAccountId') as authorized_account_id, + JSON_EXTRACT(Properties, '$.AuthorizedAwsRegion') as authorized_aws_region + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConfigRuleName') as config_rule_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' + json_extract_path_text(Properties, 'AuthorizedAccountId') as authorized_account_id, + json_extract_path_text(Properties, 'AuthorizedAwsRegion') as authorized_aws_region + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' AND region = 'us-east-1' - config_rule: - name: config_rule - id: awscc.config.config_rule + config_rules: + name: config_rules + id: awscc.config.config_rules x-cfn-schema-name: ConfigRule - x-type: get + x-cfn-type-name: AWS::Config::ConfigRule x-identifiers: - ConfigRuleName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConfigRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConfigRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConfigRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/config_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/config_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/config_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -708,7 +1571,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -726,13 +1589,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConfigRule' AND data__Identifier = '' AND region = 'us-east-1' - configuration_aggregators: - name: configuration_aggregators - id: awscc.config.configuration_aggregators - x-cfn-schema-name: ConfigurationAggregator - x-type: list + config_rules_list_only: + name: config_rules_list_only + id: awscc.config.config_rules_list_only + x-cfn-schema-name: ConfigRule + x-cfn-type-name: AWS::Config::ConfigRule x-identifiers: - - ConfigurationAggregatorName + - ConfigRuleName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -740,28 +1609,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConfigurationAggregatorName') as configuration_aggregator_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' + JSON_EXTRACT(Properties, '$.ConfigRuleName') as config_rule_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConfigurationAggregatorName') as configuration_aggregator_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' + json_extract_path_text(Properties, 'ConfigRuleName') as config_rule_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' AND region = 'us-east-1' - configuration_aggregator: - name: configuration_aggregator - id: awscc.config.configuration_aggregator + configuration_aggregators: + name: configuration_aggregators + id: awscc.config.configuration_aggregators x-cfn-schema-name: ConfigurationAggregator - x-type: get + x-cfn-type-name: AWS::Config::ConfigurationAggregator x-identifiers: - ConfigurationAggregatorName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationAggregator&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConfigurationAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConfigurationAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConfigurationAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -775,7 +1692,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -788,13 +1705,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' AND data__Identifier = '' AND region = 'us-east-1' - conformance_packs: - name: conformance_packs - id: awscc.config.conformance_packs - x-cfn-schema-name: ConformancePack - x-type: list + configuration_aggregators_list_only: + name: configuration_aggregators_list_only + id: awscc.config.configuration_aggregators_list_only + x-cfn-schema-name: ConfigurationAggregator + x-cfn-type-name: AWS::Config::ConfigurationAggregator x-identifiers: - - ConformancePackName + - ConfigurationAggregatorName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -802,28 +1725,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConformancePackName') as conformance_pack_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' + JSON_EXTRACT(Properties, '$.ConfigurationAggregatorName') as configuration_aggregator_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConformancePackName') as conformance_pack_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' + json_extract_path_text(Properties, 'ConfigurationAggregatorName') as configuration_aggregator_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' AND region = 'us-east-1' - conformance_pack: - name: conformance_pack - id: awscc.config.conformance_pack + conformance_packs: + name: conformance_packs + id: awscc.config.conformance_packs x-cfn-schema-name: ConformancePack - x-type: get + x-cfn-type-name: AWS::Config::ConformancePack x-identifiers: - ConformancePackName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConformancePack&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConformancePack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConformancePack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::ConformancePack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -839,7 +1810,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -854,13 +1825,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConformancePack' AND data__Identifier = '' AND region = 'us-east-1' - organization_conformance_packs: - name: organization_conformance_packs - id: awscc.config.organization_conformance_packs - x-cfn-schema-name: OrganizationConformancePack - x-type: list + conformance_packs_list_only: + name: conformance_packs_list_only + id: awscc.config.conformance_packs_list_only + x-cfn-schema-name: ConformancePack + x-cfn-type-name: AWS::Config::ConformancePack x-identifiers: - - OrganizationConformancePackName + - ConformancePackName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -868,28 +1845,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.OrganizationConformancePackName') as organization_conformance_pack_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' + JSON_EXTRACT(Properties, '$.ConformancePackName') as conformance_pack_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'OrganizationConformancePackName') as organization_conformance_pack_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' + json_extract_path_text(Properties, 'ConformancePackName') as conformance_pack_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' AND region = 'us-east-1' - organization_conformance_pack: - name: organization_conformance_pack - id: awscc.config.organization_conformance_pack + organization_conformance_packs: + name: organization_conformance_packs + id: awscc.config.organization_conformance_packs x-cfn-schema-name: OrganizationConformancePack - x-type: get + x-cfn-type-name: AWS::Config::OrganizationConformancePack x-identifiers: - OrganizationConformancePackName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationConformancePack&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::OrganizationConformancePack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::OrganizationConformancePack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::OrganizationConformancePack" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -905,7 +1930,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -920,13 +1945,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' AND data__Identifier = '' AND region = 'us-east-1' - stored_queries: - name: stored_queries - id: awscc.config.stored_queries - x-cfn-schema-name: StoredQuery - x-type: list + organization_conformance_packs_list_only: + name: organization_conformance_packs_list_only + id: awscc.config.organization_conformance_packs_list_only + x-cfn-schema-name: OrganizationConformancePack + x-cfn-type-name: AWS::Config::OrganizationConformancePack x-identifiers: - - QueryName + - OrganizationConformancePackName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -934,28 +1965,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.QueryName') as query_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' + JSON_EXTRACT(Properties, '$.OrganizationConformancePackName') as organization_conformance_pack_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'QueryName') as query_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' + json_extract_path_text(Properties, 'OrganizationConformancePackName') as organization_conformance_pack_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' AND region = 'us-east-1' - stored_query: - name: stored_query - id: awscc.config.stored_query + stored_queries: + name: stored_queries + id: awscc.config.stored_queries x-cfn-schema-name: StoredQuery - x-type: get + x-cfn-type-name: AWS::Config::StoredQuery x-identifiers: - QueryName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StoredQuery&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::StoredQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::StoredQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Config::StoredQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stored_queries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stored_queries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stored_queries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -970,7 +2049,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -984,3 +2063,439 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Config::StoredQuery' AND data__Identifier = '' AND region = 'us-east-1' + stored_queries_list_only: + name: stored_queries_list_only + id: awscc.config.stored_queries_list_only + x-cfn-schema-name: StoredQuery + x-cfn-type-name: AWS::Config::StoredQuery + x-identifiers: + - QueryName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.QueryName') as query_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QueryName') as query_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AggregationAuthorization&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAggregationAuthorization + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAggregationAuthorizationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationAggregator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationAggregator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationAggregatorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConformancePack&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConformancePack + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConformancePackRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationConformancePack&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationConformancePack + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationConformancePackRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StoredQuery&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStoredQuery + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStoredQueryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/connect.yaml b/providers/src/awscc/v00.00.00000/services/connect.yaml index f1cc475c..f55ba93e 100644 --- a/providers/src/awscc/v00.00.00000/services/connect.yaml +++ b/providers/src/awscc/v00.00.00000/services/connect.yaml @@ -1,10 +1,505 @@ openapi: 3.0.0 info: title: Connect - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Key: + type: string + description: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters + pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ + minLength: 1 + maxLength: 128 + Value: + type: string + description: The value for the tag. . You can specify a value that is maximum of 256 Unicode characters + maxLength: 256 + required: + - Key + - Value + AgentStatus: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + AgentStatusArn: + description: The Amazon Resource Name (ARN) of the agent status. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-state/[-a-zA-Z0-9]*$ + Description: + description: The description of the status. + type: string + minLength: 1 + maxLength: 250 + Name: + description: The name of the status. + type: string + minLength: 1 + maxLength: 127 + DisplayOrder: + description: The display order of the status. + type: integer + minimum: 1 + maximum: 50 + State: + type: string + description: The state of the status. + enum: + - ENABLED + - DISABLED + Type: + type: string + description: The type of agent status. + enum: + - ROUTABLE + - CUSTOM + - OFFLINE + ResetOrderNumber: + type: boolean + description: A number indicating the reset order of the agent status. + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + LastModifiedRegion: + description: Last modified region. + type: string + pattern: '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?' + LastModifiedTime: + description: Last modified time. + type: number + required: + - InstanceArn + - Name + - State + x-stackql-resource-name: agent_status + description: Resource Type definition for AWS::Connect::AgentStatus + x-type-name: AWS::Connect::AgentStatus + x-stackql-primary-identifier: + - AgentStatusArn + x-read-only-properties: + - AgentStatusArn + - LastModifiedRegion + - LastModifiedTime + x-required-properties: + - InstanceArn + - Name + - State + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource + x-required-permissions: + create: + - connect:CreateAgentStatus + - connect:TagResource + - connect:ListAgentStatuses + read: + - connect:DescribeAgentStatus + delete: [] + update: + - connect:UpdateAgentStatus + - connect:UntagResource + - connect:TagResource + list: + - connect:ListAgentStatuses Origin: description: Domain name to be added to the allowlist of instance type: string @@ -26,12 +521,22 @@ components: - Origin - InstanceId x-stackql-resource-name: approved_origin - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::ApprovedOrigin + x-type-name: AWS::Connect::ApprovedOrigin + x-stackql-primary-identifier: - InstanceId - Origin x-create-only-properties: - InstanceId - Origin + x-required-properties: + - Origin + - InstanceId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - connect:AssociateApprovedOrigin @@ -44,24 +549,6 @@ components: - connect:ListApprovedOrigins list: - connect:ListApprovedOrigins - Tag: - description: A key-value pair to associate with a resource. - type: object - additionalProperties: false - properties: - Key: - type: string - description: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters - pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ - minLength: 1 - maxLength: 128 - Value: - type: string - description: The value for the tag. . You can specify a value that is maximum of 256 Unicode characters - maxLength: 256 - required: - - Key - - Value ContactFlow: type: object properties: @@ -110,6 +597,7 @@ components: - OUTBOUND_WHISPER - AGENT_TRANSFER - QUEUE_TRANSFER + - CAMPAIGN Tags: description: One or more tags. type: array @@ -124,12 +612,29 @@ components: - Name - Type x-stackql-resource-name: contact_flow - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::ContactFlow + x-type-name: AWS::Connect::ContactFlow + x-stackql-primary-identifier: - ContactFlowArn x-create-only-properties: - Type x-read-only-properties: - ContactFlowArn + x-required-properties: + - InstanceArn + - Content + - Name + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:ListTagsForResource + - connect:UntagResource + - connect:TagResource x-required-permissions: create: - connect:CreateContactFlow @@ -198,11 +703,27 @@ components: - Name - Content x-stackql-resource-name: contact_flow_module - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::ContactFlowModule. + x-type-name: AWS::Connect::ContactFlowModule + x-stackql-primary-identifier: - ContactFlowModuleArn x-read-only-properties: - ContactFlowModuleArn - Status + x-required-properties: + - InstanceArn + - Name + - Content + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:ListTagsForResource + - connect:UntagResource + - connect:TagResource x-required-permissions: create: - connect:CreateContactFlowModule @@ -219,355 +740,578 @@ components: - connect:UntagResource list: - connect:ListContactFlowModules - RefId: - description: The identifier to reference the item. - type: string - pattern: ^[a-zA-Z0-9._-]{1,40}$ - Weight: - description: The item weight used for scoring. - type: number - minimum: 0 - maximum: 100 - Score: - description: The score of an answer option. - type: integer - minimum: 0 - maximum: 10 - EvaluationFormBaseItem: - description: The evaluation form base item. - type: object - additionalProperties: false - properties: - Section: - description: The evaluation form section item - $ref: '#/components/schemas/EvaluationFormSection' - required: - - Section - EvaluationFormItem: - description: The evaluation form item. - type: object - additionalProperties: false - properties: - Section: - description: The evaluation form section item - $ref: '#/components/schemas/EvaluationFormSection' - Question: - description: The evaluation form question item - $ref: '#/components/schemas/EvaluationFormQuestion' - EvaluationFormSection: - description: The evaluation form section. + ContactFlowVersion: type: object - additionalProperties: false properties: - Title: - description: The title of the section. + ContactFlowVersionARN: + description: The identifier of the contact flow version (ARN). type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]+:[0-9]{12}:instance/[-a-zA-Z0-9]+/contact-flow/[-a-zA-Z0-9]+:[0-9]+$ minLength: 1 - maxLength: 128 - Instructions: - description: The instructions for the section. + maxLength: 500 + ContactFlowId: + description: The ARN of the contact flow this version is tied to. type: string - maxLength: 1024 - RefId: - description: The identifier to reference the section. - $ref: '#/components/schemas/RefId' - Items: - description: The list of section items. - type: array - x-insertionOrder: true - minItems: 1 - maxItems: 200 - items: - $ref: '#/components/schemas/EvaluationFormItem' - Weight: - description: The item weight used for scoring. - $ref: '#/components/schemas/Weight' - required: - - RefId - - Title - EvaluationFormNumericQuestionOption: - description: The option ranges used for scoring in numeric questions. - type: object - additionalProperties: false - properties: - MinValue: - description: The minimum value of the option range. - type: integer - MaxValue: - description: The maximum value of the option range. + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]+:[0-9]{12}:instance/[-a-zA-Z0-9]+/contact-flow/[-a-zA-Z0-9]+$ + minLength: 1 + maxLength: 500 + Version: + description: The version number of this revision type: integer - Score: - description: The score of the option range. - $ref: '#/components/schemas/Score' - AutomaticFail: - description: The flag to mark the option as automatic fail. - type: boolean - required: - - MinValue - - MaxValue - NumericQuestionPropertyValueAutomation: - description: The automation property name of the question. - type: object - additionalProperties: false - properties: - Label: - description: The automation property label. + Description: + description: The description of the version. type: string - enum: - - OVERALL_CUSTOMER_SENTIMENT_SCORE - - OVERALL_AGENT_SENTIMENT_SCORE - - NON_TALK_TIME - - NON_TALK_TIME_PERCENTAGE - - NUMBER_OF_INTERRUPTIONS - - CONTACT_DURATION - - AGENT_INTERACTION_DURATION - - CUSTOMER_HOLD_TIME - required: - - Label - EvaluationFormNumericQuestionAutomation: - description: The automation properties for the numeric question. - type: object - additionalProperties: false - properties: - PropertyValue: - description: The automation property name of the question. - $ref: '#/components/schemas/NumericQuestionPropertyValueAutomation' + maxLength: 500 + FlowContentSha256: + description: Indicates the checksum value of the latest published flow content + type: string + pattern: ^[a-zA-Z0-9]{64}$ + minLength: 1 + maxLength: 64 required: - - PropertyValue - EvaluationFormNumericQuestionProperties: - description: The properties of the numeric question. + - ContactFlowId + x-stackql-resource-name: contact_flow_version + description: Resource Type Definition for ContactFlowVersion + x-type-name: AWS::Connect::ContactFlowVersion + x-stackql-primary-identifier: + - ContactFlowVersionARN + x-create-only-properties: + - ContactFlowId + - Description + x-read-only-properties: + - ContactFlowVersionARN + - Version + - FlowContentSha256 + x-required-properties: + - ContactFlowId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - connect:CreateContactFlowVersion + - connect:DescribeContactFlow + read: + - connect:DescribeContactFlow + delete: + - connect:DeleteContactFlowVersion + list: + - connect:ListContactFlowVersions + update: + - connect:DescribeContactFlow + EmailAddress: type: object - additionalProperties: false properties: - MinValue: - description: The minimum value for answers of the question. - type: integer - MaxValue: - description: The maximum value for answers of the question. - type: integer - Options: - description: The list of option ranges used for scoring. + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + minLength: 1 + maxLength: 250 + EmailAddressArn: + description: The identifier of the email address. + type: string + pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/email-address/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Description: + description: A description for the email address. + type: string + pattern: (^[\S].*[\S]$)|(^[\S]$) + minLength: 1 + maxLength: 250 + EmailAddress: + description: Email address to be created for this instance + type: string + pattern: ([^\s@]+@[^\s@]+\.[^\s@]+) + minLength: 1 + maxLength: 255 + DisplayName: + description: The display name for the email address. + type: string + pattern: (^[\S].*[\S]$)|(^[\S]$) + minLength: 0 + maxLength: 256 + Tags: type: array - x-insertionOrder: true - minItems: 1 - maxItems: 10 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. items: - $ref: '#/components/schemas/EvaluationFormNumericQuestionOption' - Automation: - description: The automation properties for the numeric question. - $ref: '#/components/schemas/EvaluationFormNumericQuestionAutomation' + $ref: '#/components/schemas/Tag' required: - - MinValue - - MaxValue - EvaluationFormSingleSelectQuestionAutomationOption: - description: The automation option for the single-select question. - type: object + - InstanceArn + - EmailAddress + x-stackql-resource-name: email_address + description: Resource Type definition for AWS::Connect::EmailAddress + x-type-name: AWS::Connect::EmailAddress + x-stackql-primary-identifier: + - EmailAddressArn + x-create-only-properties: + - EmailAddress + x-read-only-properties: + - EmailAddressArn + x-required-properties: + - InstanceArn + - EmailAddress + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource + x-required-permissions: + create: + - connect:CreateEmailAddress + - connect:TagResource + - connect:ListIntegrationAssociations + - ses:GetEmailIdentity + - ses:DescribeReceiptRule + - ses:UpdateReceiptRule + - iam:PassRole + read: + - connect:DescribeEmailAddress + update: + - connect:UpdateEmailAddressMetadata + - connect:TagResource + - connect:UntagResource + delete: + - connect:DeleteEmailAddress + - connect:UntagResource + - iam:PassRole + - ses:DescribeReceiptRule + - ses:UpdateReceiptRule + list: + - connect:DescribeEmailAddress + - connect:SearchEmailAddresses + EvaluationFormBaseItem: + description: An item at the root level. All items must be sections. additionalProperties: false + type: object properties: - RuleCategory: - description: The automation option based on Rules categories. - $ref: '#/components/schemas/SingleSelectQuestionRuleCategoryAutomation' + Section: + description: A subsection or inner section of an item. + $ref: '#/components/schemas/EvaluationFormSection' required: - - RuleCategory - SingleSelectQuestionRuleCategoryAutomation: - description: The automation option based on Rules categories. - type: object + - Section + EvaluationFormSection: + description: Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting). additionalProperties: false + type: object properties: - Category: - description: The category name as defined in Rules. - type: string + Title: minLength: 1 - maxLength: 50 - Condition: - description: The automation condition applied on contact categories. + description: |- + The title of the section. + *Length Constraints*: Minimum length of 1. Maximum length of 128. type: string - enum: - - PRESENT - - NOT_PRESENT - OptionRefId: - description: The option identifier referencing the option to be selected when the automation option is triggered. - $ref: '#/components/schemas/RefId' - required: - - Category - - Condition - - OptionRefId - EvaluationFormSingleSelectQuestionAutomation: - description: The automation properties for the single-select question. - type: object - additionalProperties: false - properties: - Options: - description: The answer options for the automation. - type: array - x-insertionOrder: true + maxLength: 128 + Instructions: + description: The instructions of the section. + type: string + maxLength: 1024 + Items: minItems: 1 - maxItems: 20 + maxItems: 200 + description: |- + The items of the section. + *Minimum*: 1 + x-insertionOrder: true + type: array items: - $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionAutomationOption' - DefaultOptionRefId: - description: The option reference identifier of the default answer. - $ref: '#/components/schemas/RefId' - required: - - Options - EvaluationFormSingleSelectQuestionOption: - description: The option for a question. - type: object - additionalProperties: false - properties: + $ref: '#/components/schemas/EvaluationFormItem' RefId: - description: The identifier used to reference the option. + description: |- + The identifier of the section. An identifier must be unique within the evaluation form. + *Length Constraints*: Minimum length of 1. Maximum length of 40. $ref: '#/components/schemas/RefId' - Text: - description: The title of the option. - type: string - minLength: 1 - maxLength: 128 - Score: - description: The score of the option. - $ref: '#/components/schemas/Score' - AutomaticFail: - description: The flag to mark the option as automatic fail. - type: boolean + Weight: + description: |- + The scoring weight of the section. + *Minimum*: 0 + *Maximum*: 100 + $ref: '#/components/schemas/Weight' required: - RefId - - Text + - Title EvaluationFormSingleSelectQuestionProperties: - description: The properties of the single-select question. - type: object + description: Information about the options in single select questions. additionalProperties: false + type: object properties: - Options: - description: The list of options for the question. - type: array - x-insertionOrder: true - minItems: 2 - maxItems: 256 - items: - $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionOption' DisplayAs: - description: The display mode of the single-select question. + description: |- + The display mode of the single select question. + *Allowed values*: ``DROPDOWN`` | ``RADIO`` type: string enum: - DROPDOWN - RADIO + Options: + minItems: 2 + maxItems: 256 + description: |- + The answer options of the single select question. + *Minimum*: 2 + *Maximum*: 256 + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionOption' Automation: - description: The automation properties for the single-select question. + description: The display mode of the single select question. $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionAutomation' required: - Options - EvaluationFormQuestionTypeProperties: - description: The properties of the question. - type: object - additionalProperties: false - properties: - Numeric: - description: The properties of the numeric question. - $ref: '#/components/schemas/EvaluationFormNumericQuestionProperties' - SingleSelect: - description: The properties of the single-select question. - $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionProperties' EvaluationFormQuestion: - description: The evaluation form question. - type: object + description: Information about a question from an evaluation form. additionalProperties: false + type: object properties: - Title: - description: The title of the question. - type: string - minLength: 1 - maxLength: 350 - Instructions: - description: The instructions for the question. - type: string - maxLength: 1024 - RefId: - description: The identifier used to reference the question. - $ref: '#/components/schemas/RefId' NotApplicableEnabled: description: The flag to enable not applicable answers to the question. type: boolean + Title: + minLength: 1 + description: |- + The title of the question. + *Length Constraints*: Minimum length of 1. Maximum length of 350. + type: string + maxLength: 350 QuestionType: - description: The type of the question. + description: |- + The type of the question. + *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT`` type: string enum: - NUMERIC - SINGLESELECT - TEXT + Instructions: + description: |- + The instructions of the section. + *Length Constraints*: Minimum length of 0. Maximum length of 1024. + type: string + maxLength: 1024 + RefId: + description: |- + The identifier of the question. An identifier must be unique within the evaluation form. + *Length Constraints*: Minimum length of 1. Maximum length of 40. + $ref: '#/components/schemas/RefId' QuestionTypeProperties: - description: The properties of the question + description: The properties of the type of question. Text questions do not have to define question type properties. $ref: '#/components/schemas/EvaluationFormQuestionTypeProperties' Weight: - description: The question weight used for scoring. + description: |- + The scoring weight of the section. + *Minimum*: 0 + *Maximum*: 100 $ref: '#/components/schemas/Weight' required: - RefId - Title - QuestionType - ScoringStrategy: - description: The scoring strategy. + EvaluationFormSingleSelectQuestionAutomation: + description: Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied. + additionalProperties: false type: object + properties: + Options: + minItems: 1 + maxItems: 20 + description: |- + The automation options of the single select question. + *Minimum*: 1 + *Maximum*: 20 + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionAutomationOption' + DefaultOptionRefId: + description: |- + The identifier of the default answer option, when none of the automation options match the criteria. + *Length Constraints*: Minimum length of 1. Maximum length of 40. + $ref: '#/components/schemas/RefId' + required: + - Options + EvaluationFormSingleSelectQuestionAutomationOption: + description: The automation options of the single select question. additionalProperties: false + type: object properties: - Mode: - description: The scoring mode. - type: string - enum: - - QUESTION_ONLY - - SECTION_ONLY - Status: - description: The scoring status. - type: string - enum: - - ENABLED - - DISABLED + RuleCategory: + description: The automation option based on a rule category for the single select question. + $ref: '#/components/schemas/SingleSelectQuestionRuleCategoryAutomation' required: - - Mode - - Status - EvaluationForm: + - RuleCategory + EvaluationFormNumericQuestionAutomation: + description: Information about the automation configuration in numeric questions. + additionalProperties: false type: object properties: - Title: - description: The title of the evaluation form. + AnswerSource: + description: '' + PropertyValue: + description: The property value of the automation. + $ref: '#/components/schemas/NumericQuestionPropertyValueAutomation' + EvaluationFormNumericQuestionOption: + description: Information about the option range used for scoring in numeric questions. + additionalProperties: false + type: object + properties: + Score: + description: |- + The score assigned to answer values within the range option. + *Minimum*: 0 + *Maximum*: 10 + $ref: '#/components/schemas/Score' + MinValue: + description: The minimum answer value of the range option. + type: integer + MaxValue: + description: The maximum answer value of the range option. + type: integer + AutomaticFail: + description: The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. + type: boolean + required: + - MinValue + - MaxValue + RefId: + pattern: ^[a-zA-Z0-9._-]{1,40}$ + description: The identifier to reference the item. + type: string + ScoringStrategy: + description: A scoring strategy of the evaluation form. + additionalProperties: false + type: object + properties: + Status: + description: |- + The scoring status of the evaluation form. + *Allowed values*: ``ENABLED`` | ``DISABLED`` + type: string + enum: + - ENABLED + - DISABLED + Mode: + description: |- + The scoring mode of the evaluation form. + *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY`` + type: string + enum: + - QUESTION_ONLY + - SECTION_ONLY + required: + - Mode + - Status + AutoEvaluationConfiguration: + description: '' + additionalProperties: false + type: object + properties: + Enabled: + description: '' + type: boolean + EvaluationFormQuestionTypeProperties: + description: Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question. + additionalProperties: false + type: object + properties: + Numeric: + description: The properties of the numeric question. + $ref: '#/components/schemas/EvaluationFormNumericQuestionProperties' + SingleSelect: + description: The properties of the numeric question. + $ref: '#/components/schemas/EvaluationFormSingleSelectQuestionProperties' + EvaluationFormItem: + description: Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. + additionalProperties: false + type: object + properties: + Question: + description: The information of the question. + $ref: '#/components/schemas/EvaluationFormQuestion' + Section: + description: The information of the section. + $ref: '#/components/schemas/EvaluationFormSection' + SingleSelectQuestionRuleCategoryAutomation: + description: |- + Information about the automation option based on a rule category for a single select question. + *Length Constraints*: Minimum length of 1. Maximum length of 50. + additionalProperties: false + type: object + properties: + Condition: + description: |- + The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category. + *Allowed values*: ``PRESENT`` | ``NOT_PRESENT`` + *Maximum*: 50 + type: string + enum: + - PRESENT + - NOT_PRESENT + Category: + minLength: 1 + description: |- + The category name, as defined in Rules. + *Minimum*: 1 + *Maximum*: 50 type: string + maxLength: 50 + OptionRefId: + description: |- + The identifier of the answer option. An identifier must be unique within the question. + *Length Constraints*: Minimum length of 1. Maximum length of 40. + $ref: '#/components/schemas/RefId' + required: + - Category + - Condition + - OptionRefId + Weight: + description: The item weight used for scoring. + maximum: 100 + type: number + minimum: 0 + Score: + description: The score of an answer option. + maximum: 10 + type: integer + minimum: 0 + EvaluationFormNumericQuestionProperties: + description: Information about properties for a numeric question in an evaluation form. + additionalProperties: false + type: object + properties: + Options: + minItems: 1 + maxItems: 10 + description: The scoring options of the numeric question. + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/EvaluationFormNumericQuestionOption' + Automation: + description: The automation properties of the numeric question. + $ref: '#/components/schemas/EvaluationFormNumericQuestionAutomation' + MinValue: + description: The minimum answer value. + type: integer + MaxValue: + description: The maximum answer value. + type: integer + required: + - MinValue + - MaxValue + EvaluationFormSingleSelectQuestionOption: + description: Information about the automation configuration in single select questions. + additionalProperties: false + type: object + properties: + Score: + description: |- + The score assigned to the answer option. + *Minimum*: 0 + *Maximum*: 10 + $ref: '#/components/schemas/Score' + Text: minLength: 1 + description: |- + The title of the answer option. + *Length Constraints*: Minimum length of 1. Maximum length of 128. + type: string maxLength: 128 + RefId: + description: |- + The identifier of the answer option. An identifier must be unique within the question. + *Length Constraints*: Minimum length of 1. Maximum length of 40. + $ref: '#/components/schemas/RefId' + AutomaticFail: + description: The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. + type: boolean + required: + - RefId + - Text + NumericQuestionPropertyValueAutomation: + description: Information about the property value used in automation of a numeric questions. + additionalProperties: false + type: object + properties: + Label: + description: The property label of the automation. + type: string + enum: + - OVERALL_CUSTOMER_SENTIMENT_SCORE + - OVERALL_AGENT_SENTIMENT_SCORE + - NON_TALK_TIME + - NON_TALK_TIME_PERCENTAGE + - NUMBER_OF_INTERRUPTIONS + - CONTACT_DURATION + - AGENT_INTERACTION_DURATION + - CUSTOMER_HOLD_TIME + - LONGEST_HOLD_DURATION + - NUMBER_OF_HOLDS + - AGENT_INTERACTION_AND_HOLD_DURATION + required: + - Label + EvaluationForm: + type: object + properties: + ScoringStrategy: + description: A scoring strategy of the evaluation form. + $ref: '#/components/schemas/ScoringStrategy' + Status: + default: DRAFT + description: |- + The status of the evaluation form. + *Allowed values*: ``DRAFT`` | ``ACTIVE`` + type: string + enum: + - DRAFT + - ACTIVE + AutoEvaluationConfiguration: + description: '' + $ref: '#/components/schemas/AutoEvaluationConfiguration' Description: - description: The description of the evaluation form. + description: |- + The description of the evaluation form. + *Length Constraints*: Minimum length of 0. Maximum length of 1024. type: string maxLength: 1024 - EvaluationFormArn: - description: The Amazon Resource Name (ARN) for the evaluation form. - type: string - pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$ InstanceArn: - description: The Amazon Resource Name (ARN) of the instance. - type: string pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + description: The identifier of the Amazon Connect instance. + type: string + Title: + minLength: 1 + description: A title of the evaluation form. + type: string + maxLength: 128 Items: - description: The list of evaluation form items. - type: array - x-insertionOrder: true minItems: 1 maxItems: 200 + description: |- + Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. + *Minimum size*: 1 + *Maximum size*: 100 + x-insertionOrder: true + type: array items: $ref: '#/components/schemas/EvaluationFormBaseItem' - ScoringStrategy: - description: The scoring strategy. - $ref: '#/components/schemas/ScoringStrategy' - Status: - description: The status of the evaluation form. + EvaluationFormArn: + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$ + description: '' type: string - default: DRAFT - enum: - - DRAFT - - ACTIVE Tags: - description: One or more tags. - type: array maxItems: 50 uniqueItems: true + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.' x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' required: @@ -576,20 +1320,35 @@ components: - Items - Status x-stackql-resource-name: evaluation_form - x-stackql-primaryIdentifier: + description: Creates an evaluation form for the specified CON instance. + x-type-name: AWS::Connect::EvaluationForm + x-stackql-primary-identifier: - EvaluationFormArn x-read-only-properties: - EvaluationFormArn + x-required-properties: + - Title + - InstanceArn + - Items + - Status + x-tagging: + permissions: + - connect:ListTagsForResource + - connect:UntagResource + - connect:TagResource + taggable: true + tagOnCreate: false + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - connect:DescribeEvaluationForm + - connect:ListEvaluationFormVersions create: - connect:CreateEvaluationForm - connect:ActivateEvaluationForm - connect:TagResource - read: - - connect:DescribeEvaluationForm - - connect:ListEvaluationFormVersions - list: - - connect:ListEvaluationForms update: - connect:UpdateEvaluationForm - connect:ListEvaluationFormVersions @@ -597,6 +1356,8 @@ components: - connect:DeactivateEvaluationForm - connect:TagResource - connect:UntagResource + list: + - connect:ListEvaluationForms delete: - connect:DeleteEvaluationForm - connect:UntagResource @@ -644,6 +1405,102 @@ components: - Day - StartTime - EndTime + OverrideTimeSlice: + description: The start time or end time for an an hours of operation override. + type: object + additionalProperties: false + properties: + Hours: + type: integer + description: The hours. + minimum: 0 + maximum: 23 + Minutes: + type: integer + description: The minutes. + minimum: 0 + maximum: 59 + required: + - Hours + - Minutes + HoursOfOperationOverrideConfig: + description: Contains information about the hours of operation override. + type: object + additionalProperties: false + properties: + Day: + type: string + description: The day that the hours of operation override applies to. + enum: + - SUNDAY + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + StartTime: + description: The new start time that your contact center opens for the overriden days. + $ref: '#/components/schemas/OverrideTimeSlice' + EndTime: + description: The new end time that your contact center closes for the overriden days. + $ref: '#/components/schemas/OverrideTimeSlice' + required: + - Day + - StartTime + - EndTime + HoursOfOperationOverride: + description: Overrides attached to the hours of operation. + type: object + additionalProperties: false + properties: + OverrideName: + $ref: '#/components/schemas/OverrideName' + OverrideDescription: + $ref: '#/components/schemas/OverrideDescription' + EffectiveFrom: + $ref: '#/components/schemas/EffectiveFrom' + EffectiveTill: + $ref: '#/components/schemas/EffectiveTill' + OverrideConfig: + $ref: '#/components/schemas/OverrideConfig' + HoursOfOperationOverrideId: + $ref: '#/components/schemas/HoursOfOperationOverrideId' + required: + - OverrideName + - EffectiveFrom + - EffectiveTill + - OverrideConfig + OverrideName: + description: The name of the hours of operation override. + type: string + minLength: 1 + maxLength: 127 + OverrideDescription: + description: The description of the hours of operation override. + type: string + minLength: 1 + maxLength: 250 + EffectiveFrom: + description: The date from which the hours of operation override would be effective. + type: string + pattern: ^\d{4}-\d{2}-\d{2}$ + EffectiveTill: + description: The date till which the hours of operation override would be effective. + type: string + pattern: ^\d{4}-\d{2}-\d{2}$ + OverrideConfig: + description: 'Configuration information for the hours of operation override: day, start time, and end time.' + type: array + maxItems: 100 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/HoursOfOperationOverrideConfig' + HoursOfOperationOverrideId: + description: The Resource Identifier for the hours of operation override. + type: string + pattern: ^[-a-zA-Z0-9]*$ HoursOfOperation: type: object properties: @@ -684,27 +1541,56 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/Tag' + HoursOfOperationOverrides: + description: One or more hours of operation overrides assigned to an hour of operation. + type: array + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/HoursOfOperationOverride' required: - InstanceArn - Name - TimeZone - Config x-stackql-resource-name: hours_of_operation - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::HoursOfOperation + x-type-name: AWS::Connect::HoursOfOperation + x-stackql-primary-identifier: - HoursOfOperationArn x-read-only-properties: - HoursOfOperationArn - x-required-permissions: - create: + x-required-properties: + - InstanceArn + - Name + - TimeZone + - Config + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource + x-required-permissions: + create: - connect:CreateHoursOfOperation - connect:TagResource + - connect:CreateHoursOfOperationOverride read: - connect:DescribeHoursOfOperation + - connect:ListHoursOfOperationOverrides delete: - connect:DeleteHoursOfOperation - connect:UntagResource update: - connect:UpdateHoursOfOperation + - connect:CreateHoursOfOperationOverride + - connect:UpdateHoursOfOperationOverride + - connect:DeleteHoursOfOperationOverride + - connect:ListHoursOfOperationOverrides - connect:TagResource - connect:UntagResource list: @@ -730,6 +1616,21 @@ components: EarlyMedia: description: Boolean flag which enables EARLY_MEDIA on an instance. type: boolean + MultiPartyConference: + description: Boolean flag which enables MULTI_PARTY_CONFERENCE on an instance. + type: boolean + HighVolumeOutBound: + description: Boolean flag which enables HIGH_VOLUME_OUTBOUND on an instance. + type: boolean + EnhancedContactMonitoring: + description: Boolean flag which enables ENHANCED_CONTACT_MONITORING on an instance. + type: boolean + EnhancedChatMonitoring: + description: Boolean flag which enables ENHANCED_CHAT_MONITORING on an instance. + type: boolean + MultiPartyChatConference: + description: Boolean flag which enables MULTI_PARTY_CHAT_CONFERENCE on an instance. + type: boolean Attributes: type: object additionalProperties: false @@ -748,6 +1649,16 @@ components: $ref: '#/components/schemas/UseCustomTTSVoices' EarlyMedia: $ref: '#/components/schemas/EarlyMedia' + MultiPartyConference: + $ref: '#/components/schemas/MultiPartyConference' + HighVolumeOutBound: + $ref: '#/components/schemas/HighVolumeOutBound' + EnhancedContactMonitoring: + $ref: '#/components/schemas/EnhancedContactMonitoring' + EnhancedChatMonitoring: + $ref: '#/components/schemas/EnhancedChatMonitoring' + MultiPartyChatConference: + $ref: '#/components/schemas/MultiPartyChatConference' required: - InboundCalls - OutboundCalls @@ -773,7 +1684,7 @@ components: type: string pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$ minLength: 1 - maxLength: 62 + maxLength: 45 CreatedTime: description: Timestamp of instance creation logged as part of instance creation. type: string @@ -808,18 +1719,35 @@ components: - IdentityManagementType - Attributes x-stackql-resource-name: instance - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::Instance + x-type-name: AWS::Connect::Instance + x-stackql-primary-identifier: - Arn x-create-only-properties: - DirectoryId - InstanceAlias - IdentityManagementType + x-write-only-properties: + - DirectoryId x-read-only-properties: - Id - Arn - ServiceRole - CreatedTime - InstanceStatus + x-required-properties: + - IdentityManagementType + - Attributes + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:ListTagsForResource + - connect:UntagResource + - connect:TagResource x-required-permissions: create: - connect:CreateInstance @@ -843,7 +1771,10 @@ components: update: - connect:ListInstanceAttributes - connect:UpdateInstanceAttribute + - ds:DescribeDirectories - iam:CreateServiceLinkedRole + - iam:DeleteRolePolicy + - logs:CreateLogGroup - iam:PutRolePolicy - connect:TagResource - connect:UntagResource @@ -993,7 +1924,9 @@ components: - ResourceType - StorageType x-stackql-resource-name: instance_storage_config - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::InstanceStorageConfig + x-type-name: AWS::Connect::InstanceStorageConfig + x-stackql-primary-identifier: - InstanceArn - AssociationId - ResourceType @@ -1002,6 +1935,15 @@ components: - ResourceType x-read-only-properties: - AssociationId + x-required-properties: + - InstanceArn + - ResourceType + - StorageType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - connect:AssociateInstanceStorageConfig @@ -1074,7 +2016,9 @@ components: - IntegrationType - IntegrationArn x-stackql-resource-name: integration_association - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::IntegrationAssociation + x-type-name: AWS::Connect::IntegrationAssociation + x-stackql-primary-identifier: - InstanceId - IntegrationType - IntegrationArn @@ -1084,6 +2028,15 @@ components: - IntegrationType x-read-only-properties: - IntegrationAssociationId + x-required-properties: + - InstanceId + - IntegrationType + - IntegrationArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - connect:DescribeInstance @@ -1111,6 +2064,7 @@ components: - lex:CreateResourcePolicyStatement - lambda:AddPermission - app-integrations:GetApplication + - app-integrations:CreateApplicationAssociation - iam:AttachRolePolicy - iam:CreateServiceLinkedRole - iam:GetRolePolicy @@ -1124,6 +2078,7 @@ components: - connect:DescribeInstance - ds:DescribeDirectories - app-integrations:DeleteEventIntegrationAssociation + - app-integrations:DeleteApplicationAssociation - events:ListTargetsByRule - events:RemoveTargets - events:DeleteRule @@ -1151,7 +2106,7 @@ components: description: Predefined attribute values of type string list. type: array minItems: 1 - maxItems: 128 + maxItems: 500 x-insertionOrder: false items: $ref: '#/components/schemas/Value' @@ -1160,6 +2115,11 @@ components: description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' minLength: 0 maxLength: 256 + Purpose: + description: A label allowing customers to categorize a predefined attribute. + type: string + minLength: 1 + maxLength: 100 PredefinedAttribute: type: object properties: @@ -1171,7 +2131,7 @@ components: description: The name of the predefined attribute. type: string minLength: 1 - maxLength: 64 + maxLength: 100 Values: description: The values of a predefined attribute. type: object @@ -1179,17 +2139,52 @@ components: StringList: $ref: '#/components/schemas/StringList' additionalProperties: false + Purposes: + description: The assigned purposes of the predefined attribute. + type: array + minItems: 1 + maxItems: 10 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Purpose' + AttributeConfiguration: + description: Custom metadata associated to a Predefined attribute that controls how the attribute behaves when used by upstream services. + type: object + properties: + EnableValueValidationOnAssociation: + type: boolean + description: Enables customers to enforce strict validation on the specific values that this predefined attribute can hold. + IsReadOnly: + type: boolean + description: Allows the predefined attribute to show up and be managed in the Amazon Connect UI. + additionalProperties: false + LastModifiedRegion: + description: Last modified region. + type: string + pattern: '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?' + LastModifiedTime: + description: Last modified time. + type: number required: - InstanceArn - Name - - Values x-stackql-resource-name: predefined_attribute - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::PredefinedAttribute + x-type-name: AWS::Connect::PredefinedAttribute + x-stackql-primary-identifier: - InstanceArn - Name x-create-only-properties: - InstanceArn - Name + x-read-only-properties: + - LastModifiedRegion + - LastModifiedTime + x-required-properties: + - InstanceArn + - Name + x-tagging: + taggable: false x-required-permissions: create: - connect:CreatePredefinedAttribute @@ -1239,10 +2234,26 @@ components: - InstanceArn - Name x-stackql-resource-name: prompt - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::Prompt + x-type-name: AWS::Connect::Prompt + x-stackql-primary-identifier: - PromptArn + x-write-only-properties: + - S3Uri x-read-only-properties: - PromptArn + x-required-properties: + - InstanceArn + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreatePrompt @@ -1275,6 +2286,10 @@ components: pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ minLength: 1 maxLength: 500 + OutboundEmailAddressId: + description: The email address connect resource ID. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/email-address/[-a-zA-Z0-9]*$ Key: description: A valid security key in PEM format. type: string @@ -1291,6 +2306,13 @@ components: $ref: '#/components/schemas/OutboundCallerIdNumberArn' OutboundFlowArn: $ref: '#/components/schemas/OutboundFlowArn' + OutboundEmailConfig: + description: The outbound email address ID. + type: object + additionalProperties: false + properties: + OutboundEmailAddressId: + $ref: '#/components/schemas/OutboundEmailAddressId' QuickConnectArn: description: The Amazon Resource Name (ARN) for the quick connect. type: string @@ -1323,6 +2345,9 @@ components: OutboundCallerConfig: description: The outbound caller ID name, number, and outbound whisper flow. $ref: '#/components/schemas/OutboundCallerConfig' + OutboundEmailConfig: + description: The outbound email address ID. + $ref: '#/components/schemas/OutboundEmailConfig' QueueArn: description: The Amazon Resource Name (ARN) for the queue. type: string @@ -1337,7 +2362,6 @@ components: description: The quick connects available to agents who are working the queue. type: array minItems: 1 - maxItems: 50 x-insertionOrder: false items: $ref: '#/components/schemas/QuickConnectArn' @@ -1360,11 +2384,26 @@ components: - HoursOfOperationArn - Name x-stackql-resource-name: queue - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::Queue + x-type-name: AWS::Connect::Queue + x-stackql-primary-identifier: - QueueArn x-read-only-properties: - QueueArn - Type + x-required-properties: + - InstanceArn + - HoursOfOperationArn + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateQueue @@ -1380,6 +2419,7 @@ components: - connect:UpdateQueueMaxContacts - connect:UpdateQueueName - connect:UpdateQueueOutboundCallerConfig + - connect:UpdateQueueOutboundEmailConfig - connect:UpdateQueueStatus - connect:AssociateQueueQuickConnects - connect:DisassociateQueueQuickConnects @@ -1397,9 +2437,9 @@ components: type: string pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$ UserArn: - description: The Amazon Resource Name (ARN) of the user. + description: The Amazon Resource Name (ARN) of the user or a dynamic recipient string starting with '$.'. type: string - pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$ + pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$|^\$\..+$ PhoneNumberQuickConnectConfig: description: The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER. type: object @@ -1499,11 +2539,26 @@ components: - InstanceArn - QuickConnectConfig x-stackql-resource-name: quick_connect - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::QuickConnect + x-type-name: AWS::Connect::QuickConnect + x-stackql-primary-identifier: - QuickConnectArn x-read-only-properties: - QuickConnectArn - QuickConnectType + x-required-properties: + - Name + - InstanceArn + - QuickConnectConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateQuickConnect @@ -1527,6 +2582,7 @@ components: - VOICE - CHAT - TASK + - EMAIL Concurrency: description: The number of contacts an agent can have on a channel simultaneously. type: integer @@ -1633,7 +2689,6 @@ components: description: The queues to associate with this routing profile. type: array minItems: 1 - maxItems: 10 x-insertionOrder: false items: $ref: '#/components/schemas/RoutingProfileQueueConfig' @@ -1658,10 +2713,27 @@ components: - MediaConcurrencies - DefaultOutboundQueueArn x-stackql-resource-name: routing_profile - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::RoutingProfile + x-type-name: AWS::Connect::RoutingProfile + x-stackql-primary-identifier: - RoutingProfileArn x-read-only-properties: - RoutingProfileArn + x-required-properties: + - InstanceArn + - Name + - Description + - MediaConcurrencies + - DefaultOutboundQueueArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateRoutingProfile @@ -1728,13 +2800,13 @@ components: type: object properties: UserTags: - description: The collection of recipients who are identified by user tags + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.' x-patternProperties: ^(?=.{1,128}$).+$: type: string additionalProperties: false UserArns: - description: The list of recipients by user arns. + description: The Amazon Resource Name (ARN) of the user account. type: array minItems: 1 maxItems: 5 @@ -1744,12 +2816,13 @@ components: $ref: '#/components/schemas/UserArn' additionalProperties: false Reference: - description: A contact reference. + description: Information about the reference when the ``referenceType`` is ``URL``. Otherwise, null. (Supports variable injection in the ``Value`` field.) type: object properties: Value: type: string pattern: ^(/|https:) + description: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP). Type: type: string enum: @@ -1759,30 +2832,33 @@ components: - STRING - DATE - EMAIL + description: |- + The type of the reference. ``DATE`` must be of type Epoch timestamp. + *Allowed values*: ``URL`` | ``ATTACHMENT`` | ``NUMBER`` | ``STRING`` | ``DATE`` | ``EMAIL`` required: - Value - Type additionalProperties: false TaskAction: - description: The definition of task action. + description: 'Information about the task action. This field is required if ``TriggerEventSource`` is one of the following values: ``OnZendeskTicketCreate`` | ``OnZendeskTicketStatusUpdate`` | ``OnSalesforceCaseCreate``' type: object properties: Name: - description: The name which appears in the agent's Contact Control Panel (CCP). + description: The name. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*. type: string minLength: 1 maxLength: 512 Description: - description: The description which appears in the agent's Contact Control Panel (CCP). + description: The description. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*. type: string minLength: 0 maxLength: 4096 ContactFlowArn: - description: The Amazon Resource Name (ARN) of the contact flow. + description: The Amazon Resource Name (ARN) of the flow. type: string pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ References: - description: A formatted URL that is shown to an agent in the Contact Control Panel (CCP). + description: Information about the reference when the ``referenceType`` is ``URL``. Otherwise, null. ``URL`` is the only accepted type. (Supports variable injection in the ``Value`` field.) x-patternProperties: ^(?=.{1,4096}$).+$: $ref: '#/components/schemas/Reference' @@ -1791,12 +2867,23 @@ components: - Name - ContactFlowArn additionalProperties: false + SubmitAutoEvaluationAction: + description: '' + type: object + properties: + EvaluationFormArn: + description: '' + type: string + pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$ + required: + - EvaluationFormArn + additionalProperties: false EventBridgeAction: - description: The definition for event bridge action. + description: The EV action definition. type: object properties: Name: - description: The name of the event bridge action. + description: The name. type: string pattern: ^[a-zA-Z0-9._-]{1,100}$ required: @@ -1806,31 +2893,36 @@ components: description: The definition for assigning contact category action. type: object SendNotificationAction: - description: The definition for sending notification action. + description: Information about the send notification action. type: object properties: DeliveryMethod: - description: The means of delivery. + description: |- + Notification delivery method. + *Allowed value*: ``EMAIL`` type: string enum: - EMAIL Subject: - description: The subject of notification. + description: The subject of the email if the delivery method is ``EMAIL``. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*. type: string minLength: 1 maxLength: 200 Content: - description: The content of notification. + description: Notification content. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*. type: string minLength: 1 maxLength: 1024 ContentType: - description: The type of content. + description: |- + Content type format. + *Allowed value*: ``PLAIN_TEXT`` type: string enum: - PLAIN_TEXT Recipient: $ref: '#/components/schemas/NotificationRecipientType' + description: Notification recipient. required: - DeliveryMethod - Content @@ -1838,13 +2930,14 @@ components: - ContentType additionalProperties: false CreateCaseAction: - description: The definition for create case action. + description: '' type: object properties: Fields: $ref: '#/components/schemas/Fields' + description: '' TemplateId: - description: The Id of template. + description: '' type: string minLength: 1 maxLength: 500 @@ -1853,11 +2946,12 @@ components: - TemplateId additionalProperties: false UpdateCaseAction: - description: The definition for update case action. + description: '' type: object properties: Fields: $ref: '#/components/schemas/Fields' + description: '' required: - Fields additionalProperties: false @@ -1883,11 +2977,11 @@ components: minItems: 1 maxItems: 1 RuleTriggerEventSource: - description: The event source that will trigger the rule. + description: The name of the event source. type: object properties: EventSourceName: - description: The name of event source. + description: The name of the event source. type: string enum: - OnContactEvaluationSubmit @@ -1902,7 +2996,7 @@ components: - OnCaseCreate - OnCaseUpdate IntegrationAssociationArn: - description: The Amazon Resource Name (ARN) for the AppIntegration association. + description: 'The Amazon Resource Name (ARN) of the integration association. ``IntegrationAssociationArn`` is required if ``TriggerEventSource`` is one of the following values: ``OnZendeskTicketCreate`` | ``OnZendeskTicketStatusUpdate`` | ``OnSalesforceCaseCreate``' type: string pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/integration-association/[-a-zA-Z0-9]*$ required: @@ -1953,24 +3047,43 @@ components: $ref: '#/components/schemas/EndAssociatedTasksAction' minItems: 1 maxItems: 1 + SubmitAutoEvaluationActions: + description: This action will submit an auto contact evaluation when a rule is triggered. + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/SubmitAutoEvaluationAction' + minItems: 1 + maxItems: 1 Actions: - description: The list of actions that will be executed when a rule is triggered. + description: A list of actions to be run when the rule is triggered. type: object properties: AssignContactCategoryActions: $ref: '#/components/schemas/AssignContactCategoryActions' + description: Information about the contact category action. The syntax can be empty, for example, ``{}``. EventBridgeActions: $ref: '#/components/schemas/EventBridgeActions' + description: Information about the EV action. TaskActions: $ref: '#/components/schemas/TaskActions' + description: 'Information about the task action. This field is required if ``TriggerEventSource`` is one of the following values: ``OnZendeskTicketCreate`` | ``OnZendeskTicketStatusUpdate`` | ``OnSalesforceCaseCreate``' SendNotificationActions: $ref: '#/components/schemas/SendNotificationActions' + description: Information about the send notification action. CreateCaseActions: $ref: '#/components/schemas/CreateCaseActions' + description: '' UpdateCaseActions: $ref: '#/components/schemas/UpdateCaseActions' + description: '' EndAssociatedTasksActions: $ref: '#/components/schemas/EndAssociatedTasksActions' + description: '' + SubmitAutoEvaluationActions: + $ref: '#/components/schemas/SubmitAutoEvaluationActions' + description: '' additionalProperties: false Rule: type: object @@ -1980,7 +3093,7 @@ components: type: string pattern: ^[a-zA-Z0-9._-]{1,200}$ RuleArn: - description: The Amazon Resource Name (ARN) of the rule. + description: '' type: string pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/rule/[-a-zA-Z0-9]*$ InstanceArn: @@ -1988,22 +3101,24 @@ components: type: string pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ TriggerEventSource: - description: The event source that triggers the rule. + description: The event source to trigger the rule. $ref: '#/components/schemas/RuleTriggerEventSource' Function: - description: The conditions of a rule. + description: The conditions of the rule. type: string Actions: - description: The list of actions that will be executed when a rule is triggered. + description: A list of actions to be run when the rule is triggered. $ref: '#/components/schemas/Actions' PublishStatus: - description: The publish status of a rule, either draft or published. + description: |- + The publish status of the rule. + *Allowed values*: ``DRAFT`` | ``PUBLISHED`` type: string enum: - DRAFT - PUBLISHED Tags: - description: One or more tags. + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.' type: array maxItems: 50 uniqueItems: true @@ -2018,13 +3133,32 @@ components: - Actions - PublishStatus x-stackql-resource-name: rule - x-stackql-primaryIdentifier: + description: Creates a rule for the specified CON instance. + x-type-name: AWS::Connect::Rule + x-stackql-primary-identifier: - RuleArn x-create-only-properties: - TriggerEventSource - InstanceArn x-read-only-properties: - RuleArn + x-required-properties: + - Name + - InstanceArn + - TriggerEventSource + - Function + - Actions + - PublishStatus + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: false + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateRule @@ -2056,7 +3190,9 @@ components: - Key - InstanceId x-stackql-resource-name: security_key - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::SecurityKey + x-type-name: AWS::Connect::SecurityKey + x-stackql-primary-identifier: - InstanceId - AssociationId x-create-only-properties: @@ -2064,6 +3200,14 @@ components: - Key x-read-only-properties: - AssociationId + x-required-properties: + - Key + - InstanceId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - connect:AssociateSecurityKey @@ -2080,10 +3224,36 @@ components: minLength: 1 maxLength: 128 ResourceName: - description: A resource that a security profile applies tag restrictions to in Amazon Connect. + description: A resource that a security profile applies tag or hierarchy restrictions to in Amazon Connect. + type: string + minLength: 1 + maxLength: 128 + ApplicationPermission: + description: The permissions that the agent is granted on the application. type: string minLength: 1 maxLength: 128 + Application: + description: A third-party application's metadata. + type: object + properties: + ApplicationPermissions: + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: The permissions that the agent is granted on the application + items: + $ref: '#/components/schemas/ApplicationPermission' + Namespace: + type: string + description: Namespace of the application that you want to give access to. + minLength: 1 + maxLength: 128 + required: + - ApplicationPermissions + - Namespace + additionalProperties: false SecurityProfile: type: object properties: @@ -2130,6 +3300,28 @@ components: description: The list of resources that a security profile applies tag restrictions to in Amazon Connect. items: $ref: '#/components/schemas/ResourceName' + HierarchyRestrictedResources: + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. + items: + $ref: '#/components/schemas/ResourceName' + AllowedAccessControlHierarchyGroupId: + type: string + pattern: ^[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 127 + description: The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. + Applications: + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: A list of third-party applications that the security profile will give access to. + items: + $ref: '#/components/schemas/Application' Tags: type: array maxItems: 50 @@ -2138,23 +3330,47 @@ components: description: The tags used to organize, track, or control access for this resource. items: $ref: '#/components/schemas/Tag' + LastModifiedRegion: + type: string + pattern: '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?' + description: The AWS Region where this resource was last modified. + LastModifiedTime: + type: number + description: The timestamp when this resource was last modified. required: - InstanceArn - SecurityProfileName x-stackql-resource-name: security_profile - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::SecurityProfile + x-type-name: AWS::Connect::SecurityProfile + x-stackql-primary-identifier: - SecurityProfileArn x-create-only-properties: - SecurityProfileName - InstanceArn x-read-only-properties: - SecurityProfileArn + - LastModifiedRegion + - LastModifiedTime + x-required-properties: + - InstanceArn + - SecurityProfileName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateSecurityProfile - connect:TagResource read: - connect:DescribeSecurityProfile + - connect:ListSecurityProfileApplications - connect:ListSecurityProfilePermissions update: - connect:TagResource @@ -2187,6 +3403,8 @@ components: - BOOLEAN - SINGLE_SELECT - EMAIL + - EXPIRY_DURATION + - SELF_ASSIGN FieldIdentifier: description: the identifier (name) for the task template field type: object @@ -2291,6 +3509,10 @@ components: description: The identifier of the contact flow. type: string pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ + SelfAssignContactFlowArn: + description: The identifier of the contact flow. + type: string + pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ Constraints: description: The constraints for the task template type: object @@ -2329,10 +3551,24 @@ components: required: - InstanceArn x-stackql-resource-name: task_template - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::TaskTemplate. + x-type-name: AWS::Connect::TaskTemplate + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-required-properties: + - InstanceArn + x-tagging: + taggable: true + tagOnCreate: false + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:ListTagsForResource + - connect:UntagResource + - connect:TagResource x-required-permissions: create: - connect:CreateTaskTemplate @@ -2399,7 +3635,9 @@ components: - InstanceArn - Name x-stackql-resource-name: traffic_distribution_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::TrafficDistributionGroup + x-type-name: AWS::Connect::TrafficDistributionGroup + x-stackql-primary-identifier: - TrafficDistributionGroupArn x-create-only-properties: - Description @@ -2408,6 +3646,18 @@ components: - TrafficDistributionGroupArn - Status - IsDefault + x-required-properties: + - InstanceArn + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateTrafficDistributionGroup @@ -2461,6 +3711,9 @@ components: enum: - SOFT_PHONE - DESK_PHONE + PersistentConnection: + description: The Persistent Connection setting. + type: boolean UserIdentityInfo: description: Contains information about the identity of a user. type: object @@ -2489,6 +3742,8 @@ components: $ref: '#/components/schemas/DeskPhoneNumber' PhoneType: $ref: '#/components/schemas/PhoneType' + PersistentConnection: + $ref: '#/components/schemas/PersistentConnection' required: - PhoneType UserProficiency: @@ -2589,10 +3844,29 @@ components: - SecurityProfileArns - Username x-stackql-resource-name: user - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::User + x-type-name: AWS::Connect::User + x-stackql-primary-identifier: - UserArn + x-write-only-properties: + - Password x-read-only-properties: - UserArn + x-required-properties: + - InstanceArn + - PhoneConfig + - RoutingProfileArn + - SecurityProfileArns + - Username + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateUser @@ -2618,7 +3892,7 @@ components: list: - connect:ListUsers UserHierarchyGroupArn: - description: The Amazon Resource Name (ARN) for the user hierarchy group. + description: The Amazon Resource Name (ARN) for the User hierarchy group. type: string pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$ UserHierarchyGroup: @@ -2651,12 +3925,26 @@ components: - Name - InstanceArn x-stackql-resource-name: user_hierarchy_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::UserHierarchyGroup + x-type-name: AWS::Connect::UserHierarchyGroup + x-stackql-primary-identifier: - UserHierarchyGroupArn x-create-only-properties: - ParentGroupArn x-read-only-properties: - UserHierarchyGroupArn + x-required-properties: + - Name + - InstanceArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateUserHierarchyGroup @@ -2672,6 +3960,134 @@ components: - connect:UntagResource list: - connect:ListUserHierarchyGroups + Name: + description: The name of the hierarchy level. + type: string + HierarchyLevelArn: + description: The Amazon Resource Name (ARN) of the hierarchy level. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group-level/[-0-9]*$ + HierarchyLevelId: + description: The identifier of the hierarchy level. + type: string + LevelOne: + description: Information about level one. + type: object + additionalProperties: false + properties: + HierarchyLevelArn: + $ref: '#/components/schemas/HierarchyLevelArn' + HierarchyLevelId: + $ref: '#/components/schemas/HierarchyLevelId' + Name: + $ref: '#/components/schemas/Name' + required: + - Name + LevelTwo: + description: Information about level two. + type: object + additionalProperties: false + properties: + HierarchyLevelArn: + $ref: '#/components/schemas/HierarchyLevelArn' + HierarchyLevelId: + $ref: '#/components/schemas/HierarchyLevelId' + Name: + $ref: '#/components/schemas/Name' + required: + - Name + LevelThree: + description: Information about level three. + type: object + additionalProperties: false + properties: + HierarchyLevelArn: + $ref: '#/components/schemas/HierarchyLevelArn' + HierarchyLevelId: + $ref: '#/components/schemas/HierarchyLevelId' + Name: + $ref: '#/components/schemas/Name' + required: + - Name + LevelFour: + description: Information about level four. + type: object + additionalProperties: false + properties: + HierarchyLevelArn: + $ref: '#/components/schemas/HierarchyLevelArn' + HierarchyLevelId: + $ref: '#/components/schemas/HierarchyLevelId' + Name: + $ref: '#/components/schemas/Name' + required: + - Name + LevelFive: + description: Information about level five. + type: object + additionalProperties: false + properties: + HierarchyLevelArn: + $ref: '#/components/schemas/HierarchyLevelArn' + HierarchyLevelId: + $ref: '#/components/schemas/HierarchyLevelId' + Name: + $ref: '#/components/schemas/Name' + required: + - Name + UserHierarchyStructure: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + UserHierarchyStructureArn: + description: The identifier of the User Hierarchy Structure. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/user-hierarchy-structure + UserHierarchyStructure: + description: Information about the hierarchy structure. + type: object + additionalProperties: false + properties: + LevelOne: + $ref: '#/components/schemas/LevelOne' + LevelTwo: + $ref: '#/components/schemas/LevelTwo' + LevelThree: + $ref: '#/components/schemas/LevelThree' + LevelFour: + $ref: '#/components/schemas/LevelFour' + LevelFive: + $ref: '#/components/schemas/LevelFive' + required: + - InstanceArn + x-stackql-resource-name: user_hierarchy_structure + description: Resource Type definition for AWS::Connect::UserHierarchyStructure + x-type-name: AWS::Connect::UserHierarchyStructure + x-stackql-primary-identifier: + - UserHierarchyStructureArn + x-create-only-properties: + - InstanceArn + x-read-only-properties: + - UserHierarchyStructureArn + x-required-properties: + - InstanceArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - connect:UpdateUserHierarchyStructure + read: + - connect:DescribeUserHierarchyStructure + delete: + - connect:UpdateUserHierarchyStructure + update: + - connect:UpdateUserHierarchyStructure View: type: object properties: @@ -2736,12 +4152,28 @@ components: - Actions - Name x-stackql-resource-name: view - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::View + x-type-name: AWS::Connect::View + x-stackql-primary-identifier: - ViewArn x-read-only-properties: - ViewArn - ViewId - ViewContentSha256 + x-required-properties: + - InstanceArn + - Template + - Actions + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - connect:TagResource + - connect:UntagResource x-required-permissions: create: - connect:CreateView @@ -2791,15 +4223,23 @@ components: required: - ViewArn x-stackql-resource-name: view_version - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Connect::ViewVersion + x-type-name: AWS::Connect::ViewVersion + x-stackql-primary-identifier: - ViewVersionArn x-create-only-properties: - ViewArn - - VersionDescription - ViewContentSha256 x-read-only-properties: - ViewVersionArn - Version + x-required-properties: + - ViewArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - connect:CreateViewVersion @@ -2810,15 +4250,1573 @@ components: update: [] delete: - connect:DeleteViewVersion - x-stackQL-resources: - approved_origins: - name: approved_origins - id: awscc.connect.approved_origins - x-cfn-schema-name: ApprovedOrigin - x-type: list + CreateAgentStatusRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + AgentStatusArn: + description: The Amazon Resource Name (ARN) of the agent status. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-state/[-a-zA-Z0-9]*$ + Description: + description: The description of the status. + type: string + minLength: 1 + maxLength: 250 + Name: + description: The name of the status. + type: string + minLength: 1 + maxLength: 127 + DisplayOrder: + description: The display order of the status. + type: integer + minimum: 1 + maximum: 50 + State: + type: string + description: The state of the status. + enum: + - ENABLED + - DISABLED + Type: + type: string + description: The type of agent status. + enum: + - ROUTABLE + - CUSTOM + - OFFLINE + ResetOrderNumber: + type: boolean + description: A number indicating the reset order of the agent status. + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + LastModifiedRegion: + description: Last modified region. + type: string + pattern: '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?' + LastModifiedTime: + description: Last modified time. + type: number + x-stackQL-stringOnly: true + x-title: CreateAgentStatusRequest + type: object + required: [] + CreateApprovedOriginRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Origin: + $ref: '#/components/schemas/Origin' + InstanceId: + $ref: '#/components/schemas/InstanceId' + x-stackQL-stringOnly: true + x-title: CreateApprovedOriginRequest + type: object + required: [] + CreateContactFlowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance (ARN). + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + minLength: 1 + maxLength: 256 + ContactFlowArn: + description: The identifier of the contact flow (ARN). + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ + minLength: 1 + maxLength: 500 + Name: + description: The name of the contact flow. + type: string + minLength: 1 + maxLength: 127 + Content: + description: The content of the contact flow in JSON format. + type: string + minLength: 1 + maxLength: 256000 + Description: + description: The description of the contact flow. + type: string + maxLength: 500 + State: + type: string + description: The state of the contact flow. + enum: + - ACTIVE + - ARCHIVED + Type: + description: The type of the contact flow. + type: string + enum: + - CONTACT_FLOW + - CUSTOMER_QUEUE + - CUSTOMER_HOLD + - CUSTOMER_WHISPER + - AGENT_HOLD + - AGENT_WHISPER + - OUTBOUND_WHISPER + - AGENT_TRANSFER + - QUEUE_TRANSFER + - CAMPAIGN + Tags: + description: One or more tags. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateContactFlowRequest + type: object + required: [] + CreateContactFlowModuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance (ARN). + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + minLength: 1 + maxLength: 256 + ContactFlowModuleArn: + description: The identifier of the contact flow module (ARN). + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/flow-module/[-a-zA-Z0-9]*$ + minLength: 1 + maxLength: 256 + Name: + description: The name of the contact flow module. + type: string + minLength: 1 + maxLength: 127 + pattern: .*\S.* + Content: + description: The content of the contact flow module in JSON format. + type: string + minLength: 1 + maxLength: 256000 + Description: + description: The description of the contact flow module. + type: string + maxLength: 500 + pattern: .*\S.* + State: + type: string + description: The state of the contact flow module. + maxLength: 500 + Status: + type: string + description: The status of the contact flow module. + maxLength: 500 + Tags: + description: One or more tags. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateContactFlowModuleRequest + type: object + required: [] + CreateContactFlowVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContactFlowVersionARN: + description: The identifier of the contact flow version (ARN). + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]+:[0-9]{12}:instance/[-a-zA-Z0-9]+/contact-flow/[-a-zA-Z0-9]+:[0-9]+$ + minLength: 1 + maxLength: 500 + ContactFlowId: + description: The ARN of the contact flow this version is tied to. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]+:[0-9]{12}:instance/[-a-zA-Z0-9]+/contact-flow/[-a-zA-Z0-9]+$ + minLength: 1 + maxLength: 500 + Version: + description: The version number of this revision + type: integer + Description: + description: The description of the version. + type: string + maxLength: 500 + FlowContentSha256: + description: Indicates the checksum value of the latest published flow content + type: string + pattern: ^[a-zA-Z0-9]{64}$ + minLength: 1 + maxLength: 64 + x-stackQL-stringOnly: true + x-title: CreateContactFlowVersionRequest + type: object + required: [] + CreateEmailAddressRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + minLength: 1 + maxLength: 250 + EmailAddressArn: + description: The identifier of the email address. + type: string + pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/email-address/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Description: + description: A description for the email address. + type: string + pattern: (^[\S].*[\S]$)|(^[\S]$) + minLength: 1 + maxLength: 250 + EmailAddress: + description: Email address to be created for this instance + type: string + pattern: ([^\s@]+@[^\s@]+\.[^\s@]+) + minLength: 1 + maxLength: 255 + DisplayName: + description: The display name for the email address. + type: string + pattern: (^[\S].*[\S]$)|(^[\S]$) + minLength: 0 + maxLength: 256 + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEmailAddressRequest + type: object + required: [] + CreateEvaluationFormRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScoringStrategy: + description: A scoring strategy of the evaluation form. + $ref: '#/components/schemas/ScoringStrategy' + Status: + default: DRAFT + description: |- + The status of the evaluation form. + *Allowed values*: ``DRAFT`` | ``ACTIVE`` + type: string + enum: + - DRAFT + - ACTIVE + AutoEvaluationConfiguration: + description: '' + $ref: '#/components/schemas/AutoEvaluationConfiguration' + Description: + description: |- + The description of the evaluation form. + *Length Constraints*: Minimum length of 0. Maximum length of 1024. + type: string + maxLength: 1024 + InstanceArn: + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + description: The identifier of the Amazon Connect instance. + type: string + Title: + minLength: 1 + description: A title of the evaluation form. + type: string + maxLength: 128 + Items: + minItems: 1 + maxItems: 200 + description: |- + Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. + *Minimum size*: 1 + *Maximum size*: 100 + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/EvaluationFormBaseItem' + EvaluationFormArn: + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$ + description: '' + type: string + Tags: + maxItems: 50 + uniqueItems: true + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEvaluationFormRequest + type: object + required: [] + CreateHoursOfOperationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Name: + description: The name of the hours of operation. + type: string + minLength: 1 + maxLength: 127 + Description: + description: The description of the hours of operation. + type: string + minLength: 1 + maxLength: 250 + TimeZone: + description: The time zone of the hours of operation. + type: string + Config: + description: 'Configuration information for the hours of operation: day, start time, and end time.' + type: array + maxItems: 100 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/HoursOfOperationConfig' + HoursOfOperationArn: + description: The Amazon Resource Name (ARN) for the hours of operation. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$ + Tags: + description: One or more tags. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + HoursOfOperationOverrides: + description: One or more hours of operation overrides assigned to an hour of operation. + type: array + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/HoursOfOperationOverride' + x-stackQL-stringOnly: true + x-title: CreateHoursOfOperationRequest + type: object + required: [] + CreateInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: An instanceId is automatically generated on creation and assigned as the unique identifier. + type: string + Arn: + description: An instanceArn is automatically generated on creation based on instanceId. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + IdentityManagementType: + description: Specifies the type of directory integration for new instance. + type: string + enum: + - SAML + - CONNECT_MANAGED + - EXISTING_DIRECTORY + InstanceAlias: + description: Alias of the new directory created as part of new instance creation. + type: string + pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$ + minLength: 1 + maxLength: 45 + CreatedTime: + description: Timestamp of instance creation logged as part of instance creation. + type: string + format: date-time + ServiceRole: + description: Service linked role created as part of instance creation. + type: string + InstanceStatus: + description: Specifies the creation status of new instance. + type: string + enum: + - CREATION_IN_PROGRESS + - CREATION_FAILED + - ACTIVE + DirectoryId: + description: Existing directoryId user wants to map to the new Connect instance. + type: string + pattern: ^d-[0-9a-f]{10}$ + minLength: 12 + maxLength: 12 + Attributes: + description: The attributes for the instance. + $ref: '#/components/schemas/Attributes' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateInstanceRequest + type: object + required: [] + CreateInstanceStorageConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: Connect Instance ID with which the storage config will be associated + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + ResourceType: + $ref: '#/components/schemas/InstanceStorageResourceType' + AssociationId: + $ref: '#/components/schemas/AssociationId' + StorageType: + $ref: '#/components/schemas/StorageType' + S3Config: + $ref: '#/components/schemas/S3Config' + KinesisVideoStreamConfig: + $ref: '#/components/schemas/KinesisVideoStreamConfig' + KinesisStreamConfig: + $ref: '#/components/schemas/KinesisStreamConfig' + KinesisFirehoseConfig: + $ref: '#/components/schemas/KinesisFirehoseConfig' + x-stackQL-stringOnly: true + x-title: CreateInstanceStorageConfigRequest + type: object + required: [] + CreateIntegrationAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IntegrationAssociationId: + $ref: '#/components/schemas/IntegrationAssociationId' + InstanceId: + $ref: '#/components/schemas/InstanceId' + IntegrationArn: + $ref: '#/components/schemas/IntegrationArn' + IntegrationType: + $ref: '#/components/schemas/IntegrationType' + x-stackQL-stringOnly: true + x-title: CreateIntegrationAssociationRequest + type: object + required: [] + CreatePredefinedAttributeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Name: + description: The name of the predefined attribute. + type: string + minLength: 1 + maxLength: 100 + Values: + description: The values of a predefined attribute. + type: object + properties: + StringList: + $ref: '#/components/schemas/StringList' + additionalProperties: false + Purposes: + description: The assigned purposes of the predefined attribute. + type: array + minItems: 1 + maxItems: 10 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Purpose' + AttributeConfiguration: + description: Custom metadata associated to a Predefined attribute that controls how the attribute behaves when used by upstream services. + type: object + properties: + EnableValueValidationOnAssociation: + type: boolean + description: Enables customers to enforce strict validation on the specific values that this predefined attribute can hold. + IsReadOnly: + type: boolean + description: Allows the predefined attribute to show up and be managed in the Amazon Connect UI. + additionalProperties: false + LastModifiedRegion: + description: Last modified region. + type: string + pattern: '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?' + LastModifiedTime: + description: Last modified time. + type: number + x-stackQL-stringOnly: true + x-title: CreatePredefinedAttributeRequest + type: object + required: [] + CreatePromptRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Name: + description: The name of the prompt. + type: string + minLength: 1 + maxLength: 127 + Description: + description: The description of the prompt. + type: string + minLength: 1 + maxLength: 250 + S3Uri: + description: S3 URI of the customer's audio file for creating prompts resource.. + type: string + minLength: 1 + maxLength: 2000 + pattern: s3://\S+/.+|https://\S+\.s3(\.\S+)?\.amazonaws\.com/\S+ + PromptArn: + description: The Amazon Resource Name (ARN) for the prompt. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/prompt/[-a-zA-Z0-9]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePromptRequest + type: object + required: [] + CreateQueueRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Description: + description: The description of the queue. + type: string + minLength: 1 + maxLength: 250 + HoursOfOperationArn: + description: The identifier for the hours of operation. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$ + MaxContacts: + description: The maximum number of contacts that can be in the queue before it is considered full. + type: integer + minimum: 0 + Name: + description: The name of the queue. + type: string + minLength: 1 + maxLength: 127 + OutboundCallerConfig: + description: The outbound caller ID name, number, and outbound whisper flow. + $ref: '#/components/schemas/OutboundCallerConfig' + OutboundEmailConfig: + description: The outbound email address ID. + $ref: '#/components/schemas/OutboundEmailConfig' + QueueArn: + description: The Amazon Resource Name (ARN) for the queue. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$ + Status: + description: The status of the queue. + type: string + enum: + - ENABLED + - DISABLED + QuickConnectArns: + description: The quick connects available to agents who are working the queue. + type: array + minItems: 1 + x-insertionOrder: false + items: + $ref: '#/components/schemas/QuickConnectArn' + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + Type: + type: string + description: The type of queue. + enum: + - STANDARD + - AGENT + x-stackQL-stringOnly: true + x-title: CreateQueueRequest + type: object + required: [] + CreateQuickConnectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Name: + description: The name of the quick connect. + type: string + minLength: 1 + maxLength: 127 + Description: + description: The description of the quick connect. + type: string + minLength: 1 + maxLength: 250 + QuickConnectConfig: + description: Configuration settings for the quick connect. + $ref: '#/components/schemas/QuickConnectConfig' + QuickConnectArn: + description: The Amazon Resource Name (ARN) for the quick connect. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/transfer-destination/[-a-zA-Z0-9]*$ + Tags: + type: array + maxItems: 200 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + QuickConnectType: + description: 'The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).' + type: string + enum: + - PHONE_NUMBER + - QUEUE + - USER + x-stackQL-stringOnly: true + x-title: CreateQuickConnectRequest + type: object + required: [] + CreateRoutingProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Name: + description: The name of the routing profile. + type: string + minLength: 1 + maxLength: 127 + Description: + description: The description of the routing profile. + type: string + minLength: 1 + maxLength: 250 + MediaConcurrencies: + description: The channels agents can handle in the Contact Control Panel (CCP) for this routing profile. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/MediaConcurrency' + DefaultOutboundQueueArn: + description: The identifier of the default outbound queue for this routing profile. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$ + RoutingProfileArn: + description: The Amazon Resource Name (ARN) of the routing profile. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$ + QueueConfigs: + description: The queues to associate with this routing profile. + type: array + minItems: 1 + x-insertionOrder: false + items: + $ref: '#/components/schemas/RoutingProfileQueueConfig' + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + AgentAvailabilityTimer: + type: string + description: Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact. + enum: + - TIME_SINCE_LAST_ACTIVITY + - TIME_SINCE_LAST_INBOUND + x-stackQL-stringOnly: true + x-title: CreateRoutingProfileRequest + type: object + required: [] + CreateRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the rule. + type: string + pattern: ^[a-zA-Z0-9._-]{1,200}$ + RuleArn: + description: '' + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/rule/[-a-zA-Z0-9]*$ + InstanceArn: + description: The Amazon Resource Name (ARN) of the instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + TriggerEventSource: + description: The event source to trigger the rule. + $ref: '#/components/schemas/RuleTriggerEventSource' + Function: + description: The conditions of the rule. + type: string + Actions: + description: A list of actions to be run when the rule is triggered. + $ref: '#/components/schemas/Actions' + PublishStatus: + description: |- + The publish status of the rule. + *Allowed values*: ``DRAFT`` | ``PUBLISHED`` + type: string + enum: + - DRAFT + - PUBLISHED + Tags: + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.' + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRuleRequest + type: object + required: [] + CreateSecurityKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Key: + $ref: '#/components/schemas/Key' + InstanceId: + $ref: '#/components/schemas/InstanceId' + AssociationId: + $ref: '#/components/schemas/AssociationId' + x-stackQL-stringOnly: true + x-title: CreateSecurityKeyRequest + type: object + required: [] + CreateSecurityProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllowedAccessControlTags: + type: array + maxItems: 2 + uniqueItems: true + x-insertionOrder: false + description: The list of tags that a security profile uses to restrict access to resources in Amazon Connect. + items: + $ref: '#/components/schemas/Tag' + Description: + type: string + minLength: 0 + maxLength: 250 + description: The description of the security profile. + InstanceArn: + type: string + description: The identifier of the Amazon Connect instance. + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Permissions: + type: array + maxItems: 500 + uniqueItems: true + x-insertionOrder: false + description: Permissions assigned to the security profile. + items: + $ref: '#/components/schemas/Permission' + SecurityProfileArn: + type: string + description: The Amazon Resource Name (ARN) for the security profile. + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$ + SecurityProfileName: + type: string + pattern: ^[ a-zA-Z0-9_@-]+$ + minLength: 1 + maxLength: 127 + description: The name of the security profile. + TagRestrictedResources: + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: The list of resources that a security profile applies tag restrictions to in Amazon Connect. + items: + $ref: '#/components/schemas/ResourceName' + HierarchyRestrictedResources: + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. + items: + $ref: '#/components/schemas/ResourceName' + AllowedAccessControlHierarchyGroupId: + type: string + pattern: ^[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 127 + description: The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. + Applications: + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: A list of third-party applications that the security profile will give access to. + items: + $ref: '#/components/schemas/Application' + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: The tags used to organize, track, or control access for this resource. + items: + $ref: '#/components/schemas/Tag' + LastModifiedRegion: + type: string + pattern: '[a-z]{2}(-[a-z]+){1,2}(-[0-9])?' + description: The AWS Region where this resource was last modified. + LastModifiedTime: + type: number + description: The timestamp when this resource was last modified. + x-stackQL-stringOnly: true + x-title: CreateSecurityProfileRequest + type: object + required: [] + CreateTaskTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The identifier (arn) of the task template. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/task-template/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ + InstanceArn: + description: The identifier (arn) of the instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + Name: + description: The name of the task template. + type: string + minLength: 1 + maxLength: 100 + Description: + description: The description of the task template. + type: string + minLength: 0 + maxLength: 255 + ContactFlowArn: + description: The identifier of the contact flow. + type: string + pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ + SelfAssignContactFlowArn: + description: The identifier of the contact flow. + type: string + pattern: ^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$ + Constraints: + description: The constraints for the task template + type: object + additionalProperties: false + properties: + InvisibleFields: + $ref: '#/components/schemas/InvisibleTaskTemplateFields' + RequiredFields: + $ref: '#/components/schemas/RequiredTaskTemplateFields' + ReadOnlyFields: + $ref: '#/components/schemas/ReadOnlyTaskTemplateFields' + Defaults: + description: '' + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/DefaultFieldValue' + Fields: + description: The list of task template's fields + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/Field' + Status: + $ref: '#/components/schemas/Status' + ClientToken: + $ref: '#/components/schemas/ClientToken' + Tags: + description: One or more tags. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTaskTemplateRequest + type: object + required: [] + CreateTrafficDistributionGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance that has been replicated. + type: string + pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + minLength: 1 + maxLength: 250 + TrafficDistributionGroupArn: + description: The identifier of the traffic distribution group. + type: string + pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Description: + description: A description for the traffic distribution group. + type: string + pattern: (^[\S].*[\S]$)|(^[\S]$) + minLength: 1 + maxLength: 250 + Name: + description: The name for the traffic distribution group. + type: string + pattern: (^[\S].*[\S]$)|(^[\S]$) + minLength: 1 + maxLength: 128 + Status: + description: The status of the traffic distribution group. + type: string + enum: + - CREATION_IN_PROGRESS + - ACTIVE + - CREATION_FAILED + - PENDING_DELETION + - DELETION_FAILED + - UPDATE_IN_PROGRESS + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + IsDefault: + description: If this is the default traffic distribution group. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateTrafficDistributionGroupRequest + type: object + required: [] + CreateUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + DirectoryUserId: + description: The identifier of the user account in the directory used for identity management. + type: string + HierarchyGroupArn: + description: The identifier of the hierarchy group for the user. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$ + Username: + description: The user name for the account. + type: string + minLength: 1 + maxLength: 64 + pattern: '[a-zA-Z0-9\_\-\.\@]+' + Password: + description: The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password. + type: string + pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$ + RoutingProfileArn: + description: The identifier of the routing profile for the user. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$ + IdentityInfo: + description: The information about the identity of the user. + $ref: '#/components/schemas/UserIdentityInfo' + PhoneConfig: + description: The phone settings for the user. + $ref: '#/components/schemas/UserPhoneConfig' + SecurityProfileArns: + type: array + minItems: 1 + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + description: One or more security profile arns for the user + items: + $ref: '#/components/schemas/SecurityProfileArn' + UserArn: + description: The Amazon Resource Name (ARN) for the user. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent/[-a-zA-Z0-9]*$ + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + UserProficiencies: + description: One or more predefined attributes assigned to a user, with a level that indicates how skilled they are. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/UserProficiency' + x-stackQL-stringOnly: true + x-title: CreateUserRequest + type: object + required: [] + CreateUserHierarchyGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + UserHierarchyGroupArn: + description: The Amazon Resource Name (ARN) for the user hierarchy group. + $ref: '#/components/schemas/UserHierarchyGroupArn' + ParentGroupArn: + description: The Amazon Resource Name (ARN) for the parent user hierarchy group. + $ref: '#/components/schemas/UserHierarchyGroupArn' + Name: + description: The name of the user hierarchy group. + type: string + minLength: 1 + maxLength: 100 + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateUserHierarchyGroupRequest + type: object + required: [] + CreateUserHierarchyStructureRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The identifier of the Amazon Connect instance. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + UserHierarchyStructureArn: + description: The identifier of the User Hierarchy Structure. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/user-hierarchy-structure + UserHierarchyStructure: + description: Information about the hierarchy structure. + type: object + additionalProperties: false + properties: + LevelOne: + $ref: '#/components/schemas/LevelOne' + LevelTwo: + $ref: '#/components/schemas/LevelTwo' + LevelThree: + $ref: '#/components/schemas/LevelThree' + LevelFour: + $ref: '#/components/schemas/LevelFour' + LevelFive: + $ref: '#/components/schemas/LevelFive' + x-stackQL-stringOnly: true + x-title: CreateUserHierarchyStructureRequest + type: object + required: [] + CreateViewRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The Amazon Resource Name (ARN) of the instance. + type: string + minLength: 1 + maxLength: 100 + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + ViewArn: + description: The Amazon Resource Name (ARN) of the view. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:$a-zA-Z0-9]*$ + minLength: 1 + maxLength: 255 + ViewId: + description: The view id of the view. + type: string + minLength: 1 + maxLength: 500 + pattern: ^[a-zA-Z0-9\_\-:\/$]+$ + Name: + description: The name of the view. + type: string + minLength: 1 + maxLength: 512 + pattern: ^([\p{L}\p{N}_.:\/=+\-@]+[\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$ + Description: + description: The description of the view. + type: string + minLength: 0 + maxLength: 4096 + pattern: ^([\p{L}\p{N}_.:\/=+\-@,]+[\p{L}\p{Z}\p{N}_.:\/=+\-@,]*)$ + Template: + description: The template of the view as JSON. + type: object + Actions: + description: The actions of the view in an array. + type: array + x-insertionOrder: false + maxItems: 1000 + items: + type: string + minLength: 1 + maxLength: 255 + pattern: ^([\p{L}\p{N}_.:\/=+\-@]+[\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$ + ViewContentSha256: + description: The view content hash. + type: string + pattern: ^[a-zA-Z0-9]{64}$ + Tags: + description: One or more tags. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateViewRequest + type: object + required: [] + CreateViewVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ViewArn: + description: The Amazon Resource Name (ARN) of the view for which a version is being created. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:a-zA-Z0-9]*$ + minLength: 1 + maxLength: 255 + ViewVersionArn: + description: The Amazon Resource Name (ARN) of the created view version. + type: string + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/view/[-:a-zA-Z0-9]*$ + minLength: 1 + maxLength: 255 + VersionDescription: + description: The description for the view version. + type: string + minLength: 1 + maxLength: 4096 + pattern: ^([\p{L}\p{N}_.:\/=+\-@,]+[\p{L}\p{Z}\p{N}_.:\/=+\-@,]*)$ + ViewContentSha256: + description: The view content hash to be checked. + type: string + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9]{64}$ + Version: + description: The version of the view. + type: integer + x-stackQL-stringOnly: true + x-title: CreateViewVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + agent_statuses: + name: agent_statuses + id: awscc.connect.agent_statuses + x-cfn-schema-name: AgentStatus + x-cfn-type-name: AWS::Connect::AgentStatus x-identifiers: - - InstanceId - - Origin + - AgentStatusArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AgentStatus&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::AgentStatus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::AgentStatus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agent_statuses/methods/create_resource' + delete: [] + update: + - $ref: '#/components/x-stackQL-resources/agent_statuses/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.AgentStatusArn') as agent_status_arn, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.DisplayOrder') as display_order, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.ResetOrderNumber') as reset_order_number, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.LastModifiedRegion') as last_modified_region, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::AgentStatus' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'AgentStatusArn') as agent_status_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DisplayOrder') as display_order, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ResetOrderNumber') as reset_order_number, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::AgentStatus' + AND data__Identifier = '' + AND region = 'us-east-1' + agent_statuses_list_only: + name: agent_statuses_list_only + id: awscc.connect.agent_statuses_list_only + x-cfn-schema-name: AgentStatus + x-cfn-type-name: AWS::Connect::AgentStatus + x-identifiers: + - AgentStatusArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2826,31 +5824,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.Origin') as origin - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' + JSON_EXTRACT(Properties, '$.AgentStatusArn') as agent_status_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::AgentStatus' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'Origin') as origin - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' + json_extract_path_text(Properties, 'AgentStatusArn') as agent_status_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::AgentStatus' AND region = 'us-east-1' - approved_origin: - name: approved_origin - id: awscc.connect.approved_origin + approved_origins: + name: approved_origins + id: awscc.connect.approved_origins x-cfn-schema-name: ApprovedOrigin - x-type: get + x-cfn-type-name: AWS::Connect::ApprovedOrigin x-identifiers: - InstanceId - Origin + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApprovedOrigin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ApprovedOrigin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ApprovedOrigin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/approved_origins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/approved_origins/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2861,7 +5892,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2871,13 +5902,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' AND data__Identifier = '|' AND region = 'us-east-1' - contact_flows: - name: contact_flows - id: awscc.connect.contact_flows - x-cfn-schema-name: ContactFlow - x-type: list + approved_origins_list_only: + name: approved_origins_list_only + id: awscc.connect.approved_origins_list_only + x-cfn-schema-name: ApprovedOrigin + x-cfn-type-name: AWS::Connect::ApprovedOrigin x-identifiers: - - ContactFlowArn + - InstanceId + - Origin + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2885,28 +5923,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ContactFlowArn') as contact_flow_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.Origin') as origin + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'Origin') as origin + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' AND region = 'us-east-1' - contact_flow: - name: contact_flow - id: awscc.connect.contact_flow + contact_flows: + name: contact_flows + id: awscc.connect.contact_flows x-cfn-schema-name: ContactFlow - x-type: get + x-cfn-type-name: AWS::Connect::ContactFlow x-identifiers: - ContactFlowArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContactFlow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_flows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/contact_flows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2923,7 +6011,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2939,13 +6027,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlow' AND data__Identifier = '' AND region = 'us-east-1' - contact_flow_modules: - name: contact_flow_modules - id: awscc.connect.contact_flow_modules - x-cfn-schema-name: ContactFlowModule - x-type: list + contact_flows_list_only: + name: contact_flows_list_only + id: awscc.connect.contact_flows_list_only + x-cfn-schema-name: ContactFlow + x-cfn-type-name: AWS::Connect::ContactFlow x-identifiers: - - ContactFlowModuleArn + - ContactFlowArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2953,28 +6047,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ContactFlowModuleArn') as contact_flow_module_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' + JSON_EXTRACT(Properties, '$.ContactFlowArn') as contact_flow_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ContactFlowModuleArn') as contact_flow_module_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' + json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' AND region = 'us-east-1' - contact_flow_module: - name: contact_flow_module - id: awscc.connect.contact_flow_module + contact_flow_modules: + name: contact_flow_modules + id: awscc.connect.contact_flow_modules x-cfn-schema-name: ContactFlowModule - x-type: get + x-cfn-type-name: AWS::Connect::ContactFlowModule x-identifiers: - ContactFlowModuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContactFlowModule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlowModule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlowModule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlowModule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2991,7 +6133,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3007,13 +6149,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' AND data__Identifier = '' AND region = 'us-east-1' - evaluation_forms: - name: evaluation_forms - id: awscc.connect.evaluation_forms - x-cfn-schema-name: EvaluationForm - x-type: list + contact_flow_modules_list_only: + name: contact_flow_modules_list_only + id: awscc.connect.contact_flow_modules_list_only + x-cfn-schema-name: ContactFlowModule + x-cfn-type-name: AWS::Connect::ContactFlowModule x-identifiers: - - EvaluationFormArn + - ContactFlowModuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3021,67 +6169,357 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EvaluationFormArn') as evaluation_form_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' + JSON_EXTRACT(Properties, '$.ContactFlowModuleArn') as contact_flow_module_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' + json_extract_path_text(Properties, 'ContactFlowModuleArn') as contact_flow_module_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' + AND region = 'us-east-1' + contact_flow_versions: + name: contact_flow_versions + id: awscc.connect.contact_flow_versions + x-cfn-schema-name: ContactFlowVersion + x-cfn-type-name: AWS::Connect::ContactFlowVersion + x-identifiers: + - ContactFlowVersionARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContactFlowVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ContactFlowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_flow_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_flow_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/contact_flow_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ContactFlowVersionARN') as contact_flow_version_arn, + JSON_EXTRACT(Properties, '$.ContactFlowId') as contact_flow_id, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FlowContentSha256') as flow_content_sha256 + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlowVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContactFlowVersionARN') as contact_flow_version_arn, + json_extract_path_text(Properties, 'ContactFlowId') as contact_flow_id, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FlowContentSha256') as flow_content_sha256 + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlowVersion' + AND data__Identifier = '' AND region = 'us-east-1' - evaluation_form: - name: evaluation_form - id: awscc.connect.evaluation_form + contact_flow_versions_list_only: + name: contact_flow_versions_list_only + id: awscc.connect.contact_flow_versions_list_only + x-cfn-schema-name: ContactFlowVersion + x-cfn-type-name: AWS::Connect::ContactFlowVersion + x-identifiers: + - ContactFlowVersionARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ContactFlowVersionARN') as contact_flow_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ContactFlowVersionARN') as contact_flow_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowVersion' + AND region = 'us-east-1' + email_addresses: + name: email_addresses + id: awscc.connect.email_addresses + x-cfn-schema-name: EmailAddress + x-cfn-type-name: AWS::Connect::EmailAddress + x-identifiers: + - EmailAddressArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EmailAddress&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::EmailAddress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::EmailAddress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::EmailAddress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/email_addresses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/email_addresses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/email_addresses/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.EmailAddressArn') as email_address_arn, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.EmailAddress') as email_address, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::EmailAddress' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'EmailAddressArn') as email_address_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EmailAddress') as email_address, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::EmailAddress' + AND data__Identifier = '' + AND region = 'us-east-1' + email_addresses_list_only: + name: email_addresses_list_only + id: awscc.connect.email_addresses_list_only + x-cfn-schema-name: EmailAddress + x-cfn-type-name: AWS::Connect::EmailAddress + x-identifiers: + - EmailAddressArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EmailAddressArn') as email_address_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EmailAddress' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EmailAddressArn') as email_address_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EmailAddress' + AND region = 'us-east-1' + evaluation_forms: + name: evaluation_forms + id: awscc.connect.evaluation_forms x-cfn-schema-name: EvaluationForm - x-type: get + x-cfn-type-name: AWS::Connect::EvaluationForm x-identifiers: - EvaluationFormArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EvaluationForm&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::EvaluationForm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::EvaluationForm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::EvaluationForm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Title') as title, + JSON_EXTRACT(Properties, '$.ScoringStrategy') as scoring_strategy, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.AutoEvaluationConfiguration') as auto_evaluation_configuration, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.EvaluationFormArn') as evaluation_form_arn, JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.Title') as title, JSON_EXTRACT(Properties, '$.Items') as items, - JSON_EXTRACT(Properties, '$.ScoringStrategy') as scoring_strategy, - JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.EvaluationFormArn') as evaluation_form_arn, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::EvaluationForm' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Title') as title, + json_extract_path_text(Properties, 'ScoringStrategy') as scoring_strategy, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'AutoEvaluationConfiguration') as auto_evaluation_configuration, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn, json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Title') as title, json_extract_path_text(Properties, 'Items') as items, - json_extract_path_text(Properties, 'ScoringStrategy') as scoring_strategy, - json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::EvaluationForm' AND data__Identifier = '' AND region = 'us-east-1' - hours_of_operations: - name: hours_of_operations - id: awscc.connect.hours_of_operations - x-cfn-schema-name: HoursOfOperation - x-type: list + evaluation_forms_list_only: + name: evaluation_forms_list_only + id: awscc.connect.evaluation_forms_list_only + x-cfn-schema-name: EvaluationForm + x-cfn-type-name: AWS::Connect::EvaluationForm x-identifiers: - - HoursOfOperationArn + - EvaluationFormArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3089,28 +6527,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.HoursOfOperationArn') as hours_of_operation_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' + JSON_EXTRACT(Properties, '$.EvaluationFormArn') as evaluation_form_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' + json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' AND region = 'us-east-1' - hours_of_operation: - name: hours_of_operation - id: awscc.connect.hours_of_operation + hours_of_operations: + name: hours_of_operations + id: awscc.connect.hours_of_operations x-cfn-schema-name: HoursOfOperation - x-type: get + x-cfn-type-name: AWS::Connect::HoursOfOperation x-identifiers: - HoursOfOperationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HoursOfOperation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::HoursOfOperation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::HoursOfOperation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::HoursOfOperation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3121,12 +6607,13 @@ components: JSON_EXTRACT(Properties, '$.TimeZone') as time_zone, JSON_EXTRACT(Properties, '$.Config') as config, JSON_EXTRACT(Properties, '$.HoursOfOperationArn') as hours_of_operation_arn, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.HoursOfOperationOverrides') as hours_of_operation_overrides FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3137,17 +6624,24 @@ components: json_extract_path_text(Properties, 'TimeZone') as time_zone, json_extract_path_text(Properties, 'Config') as config, json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'HoursOfOperationOverrides') as hours_of_operation_overrides FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' AND data__Identifier = '' AND region = 'us-east-1' - instances: - name: instances - id: awscc.connect.instances - x-cfn-schema-name: Instance - x-type: list + hours_of_operations_list_only: + name: hours_of_operations_list_only + id: awscc.connect.hours_of_operations_list_only + x-cfn-schema-name: HoursOfOperation + x-cfn-type-name: AWS::Connect::HoursOfOperation x-identifiers: - - Arn + - HoursOfOperationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3155,28 +6649,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' + JSON_EXTRACT(Properties, '$.HoursOfOperationArn') as hours_of_operation_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' + json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' AND region = 'us-east-1' - instance: - name: instance - id: awscc.connect.instance + instances: + name: instances + id: awscc.connect.instances x-cfn-schema-name: Instance - x-type: get + x-cfn-type-name: AWS::Connect::Instance x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3195,7 +6737,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3213,15 +6755,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Instance' AND data__Identifier = '' AND region = 'us-east-1' - instance_storage_configs: - name: instance_storage_configs - id: awscc.connect.instance_storage_configs - x-cfn-schema-name: InstanceStorageConfig - x-type: list + instances_list_only: + name: instances_list_only + id: awscc.connect.instances_list_only + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::Connect::Instance x-identifiers: - - InstanceArn - - AssociationId - - ResourceType + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3229,34 +6775,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' AND region = 'us-east-1' - instance_storage_config: - name: instance_storage_config - id: awscc.connect.instance_storage_config + instance_storage_configs: + name: instance_storage_configs + id: awscc.connect.instance_storage_configs x-cfn-schema-name: InstanceStorageConfig - x-type: get + x-cfn-type-name: AWS::Connect::InstanceStorageConfig x-identifiers: - InstanceArn - AssociationId - ResourceType + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceStorageConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::InstanceStorageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::InstanceStorageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::InstanceStorageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_storage_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_storage_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_storage_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3273,7 +6863,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3289,15 +6879,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' AND data__Identifier = '||' AND region = 'us-east-1' - integration_associations: - name: integration_associations - id: awscc.connect.integration_associations - x-cfn-schema-name: IntegrationAssociation - x-type: list + instance_storage_configs_list_only: + name: instance_storage_configs_list_only + id: awscc.connect.instance_storage_configs_list_only + x-cfn-schema-name: InstanceStorageConfig + x-cfn-type-name: AWS::Connect::InstanceStorageConfig x-identifiers: - - InstanceId - - IntegrationType - - IntegrationArn + - InstanceArn + - AssociationId + - ResourceType + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3305,34 +6901,69 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.IntegrationType') as integration_type, - JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'IntegrationType') as integration_type, - json_extract_path_text(Properties, 'IntegrationArn') as integration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' AND region = 'us-east-1' - integration_association: - name: integration_association - id: awscc.connect.integration_association + integration_associations: + name: integration_associations + id: awscc.connect.integration_associations x-cfn-schema-name: IntegrationAssociation - x-type: get + x-cfn-type-name: AWS::Connect::IntegrationAssociation x-identifiers: - InstanceId - IntegrationType - IntegrationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IntegrationAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::IntegrationAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::IntegrationAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integration_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integration_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3345,7 +6976,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3357,14 +6988,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' AND data__Identifier = '||' AND region = 'us-east-1' - predefined_attributes: - name: predefined_attributes - id: awscc.connect.predefined_attributes - x-cfn-schema-name: PredefinedAttribute - x-type: list + integration_associations_list_only: + name: integration_associations_list_only + id: awscc.connect.integration_associations_list_only + x-cfn-schema-name: IntegrationAssociation + x-cfn-type-name: AWS::Connect::IntegrationAssociation x-identifiers: - - InstanceArn - - Name + - InstanceId + - IntegrationType + - IntegrationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3372,60 +7010,125 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.IntegrationType') as integration_type, + JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'IntegrationType') as integration_type, + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' AND region = 'us-east-1' - predefined_attribute: - name: predefined_attribute - id: awscc.connect.predefined_attribute + predefined_attributes: + name: predefined_attributes + id: awscc.connect.predefined_attributes x-cfn-schema-name: PredefinedAttribute - x-type: get + x-cfn-type-name: AWS::Connect::PredefinedAttribute x-identifiers: - InstanceArn - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PredefinedAttribute&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::PredefinedAttribute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::PredefinedAttribute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::PredefinedAttribute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Values') as _values + JSON_EXTRACT(Properties, '$.Values') as _values, + JSON_EXTRACT(Properties, '$.Purposes') as purposes, + JSON_EXTRACT(Properties, '$.AttributeConfiguration') as attribute_configuration, + JSON_EXTRACT(Properties, '$.LastModifiedRegion') as last_modified_region, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'InstanceArn') as instance_arn, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Values') as _values + json_extract_path_text(Properties, 'Values') as _values, + json_extract_path_text(Properties, 'Purposes') as purposes, + json_extract_path_text(Properties, 'AttributeConfiguration') as attribute_configuration, + json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' AND data__Identifier = '|' AND region = 'us-east-1' - prompts: - name: prompts - id: awscc.connect.prompts - x-cfn-schema-name: Prompt - x-type: list + predefined_attributes_list_only: + name: predefined_attributes_list_only + id: awscc.connect.predefined_attributes_list_only + x-cfn-schema-name: PredefinedAttribute + x-cfn-type-name: AWS::Connect::PredefinedAttribute x-identifiers: - - PromptArn + - InstanceArn + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3433,28 +7136,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PromptArn') as prompt_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PromptArn') as prompt_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' AND region = 'us-east-1' - prompt: - name: prompt - id: awscc.connect.prompt + prompts: + name: prompts + id: awscc.connect.prompts x-cfn-schema-name: Prompt - x-type: get + x-cfn-type-name: AWS::Connect::Prompt x-identifiers: - PromptArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Prompt&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Prompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Prompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Prompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prompts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prompts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/prompts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3469,7 +7222,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3483,13 +7236,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Prompt' AND data__Identifier = '' AND region = 'us-east-1' - queues: - name: queues - id: awscc.connect.queues - x-cfn-schema-name: Queue - x-type: list + prompts_list_only: + name: prompts_list_only + id: awscc.connect.prompts_list_only + x-cfn-schema-name: Prompt + x-cfn-type-name: AWS::Connect::Prompt x-identifiers: - - QueueArn + - PromptArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3497,28 +7256,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.QueueArn') as queue_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' + JSON_EXTRACT(Properties, '$.PromptArn') as prompt_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'QueueArn') as queue_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' + json_extract_path_text(Properties, 'PromptArn') as prompt_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' AND region = 'us-east-1' - queue: - name: queue - id: awscc.connect.queue + queues: + name: queues + id: awscc.connect.queues x-cfn-schema-name: Queue - x-type: get + x-cfn-type-name: AWS::Connect::Queue x-identifiers: - QueueArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3529,6 +7336,7 @@ components: JSON_EXTRACT(Properties, '$.MaxContacts') as max_contacts, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.OutboundCallerConfig') as outbound_caller_config, + JSON_EXTRACT(Properties, '$.OutboundEmailConfig') as outbound_email_config, JSON_EXTRACT(Properties, '$.QueueArn') as queue_arn, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.QuickConnectArns') as quick_connect_arns, @@ -3538,7 +7346,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3549,6 +7357,7 @@ components: json_extract_path_text(Properties, 'MaxContacts') as max_contacts, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'OutboundCallerConfig') as outbound_caller_config, + json_extract_path_text(Properties, 'OutboundEmailConfig') as outbound_email_config, json_extract_path_text(Properties, 'QueueArn') as queue_arn, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'QuickConnectArns') as quick_connect_arns, @@ -3557,13 +7366,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Queue' AND data__Identifier = '' AND region = 'us-east-1' - quick_connects: - name: quick_connects - id: awscc.connect.quick_connects - x-cfn-schema-name: QuickConnect - x-type: list + queues_list_only: + name: queues_list_only + id: awscc.connect.queues_list_only + x-cfn-schema-name: Queue + x-cfn-type-name: AWS::Connect::Queue x-identifiers: - - QuickConnectArn + - QueueArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3571,28 +7386,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.QuickConnectArn') as quick_connect_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' + JSON_EXTRACT(Properties, '$.QueueArn') as queue_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'QuickConnectArn') as quick_connect_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' + json_extract_path_text(Properties, 'QueueArn') as queue_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' AND region = 'us-east-1' - quick_connect: - name: quick_connect - id: awscc.connect.quick_connect + quick_connects: + name: quick_connects + id: awscc.connect.quick_connects x-cfn-schema-name: QuickConnect - x-type: get + x-cfn-type-name: AWS::Connect::QuickConnect x-identifiers: - QuickConnectArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QuickConnect&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::QuickConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::QuickConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::QuickConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/quick_connects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/quick_connects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/quick_connects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3608,7 +7471,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3623,13 +7486,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::QuickConnect' AND data__Identifier = '' AND region = 'us-east-1' - routing_profiles: - name: routing_profiles - id: awscc.connect.routing_profiles - x-cfn-schema-name: RoutingProfile - x-type: list + quick_connects_list_only: + name: quick_connects_list_only + id: awscc.connect.quick_connects_list_only + x-cfn-schema-name: QuickConnect + x-cfn-type-name: AWS::Connect::QuickConnect x-identifiers: - - RoutingProfileArn + - QuickConnectArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3637,28 +7506,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RoutingProfileArn') as routing_profile_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' + JSON_EXTRACT(Properties, '$.QuickConnectArn') as quick_connect_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' + json_extract_path_text(Properties, 'QuickConnectArn') as quick_connect_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' AND region = 'us-east-1' - routing_profile: - name: routing_profile - id: awscc.connect.routing_profile + routing_profiles: + name: routing_profiles + id: awscc.connect.routing_profiles x-cfn-schema-name: RoutingProfile - x-type: get + x-cfn-type-name: AWS::Connect::RoutingProfile x-identifiers: - RoutingProfileArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RoutingProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::RoutingProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::RoutingProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::RoutingProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3676,7 +7593,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3693,17 +7610,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::RoutingProfile' AND data__Identifier = '' AND region = 'us-east-1' - rule: - name: rule - id: awscc.connect.rule + routing_profiles_list_only: + name: routing_profiles_list_only + id: awscc.connect.routing_profiles_list_only + x-cfn-schema-name: RoutingProfile + x-cfn-type-name: AWS::Connect::RoutingProfile + x-identifiers: + - RoutingProfileArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RoutingProfileArn') as routing_profile_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' + AND region = 'us-east-1' + rules: + name: rules + id: awscc.connect.rules x-cfn-schema-name: Rule - x-type: get + x-cfn-type-name: AWS::Connect::Rule x-identifiers: - RuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3720,7 +7716,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3740,42 +7736,49 @@ components: name: security_keys id: awscc.connect.security_keys x-cfn-schema-name: SecurityKey - x-type: list - x-identifiers: - - InstanceId - - AssociationId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' - AND region = 'us-east-1' - security_key: - name: security_key - id: awscc.connect.security_key - x-cfn-schema-name: SecurityKey - x-type: get + x-cfn-type-name: AWS::Connect::SecurityKey x-identifiers: - InstanceId - AssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::SecurityKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::SecurityKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_keys/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3787,7 +7790,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3798,13 +7801,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityKey' AND data__Identifier = '|' AND region = 'us-east-1' - security_profiles: - name: security_profiles - id: awscc.connect.security_profiles - x-cfn-schema-name: SecurityProfile - x-type: list + security_keys_list_only: + name: security_keys_list_only + id: awscc.connect.security_keys_list_only + x-cfn-schema-name: SecurityKey + x-cfn-type-name: AWS::Connect::SecurityKey x-identifiers: - - SecurityProfileArn + - InstanceId + - AssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3812,28 +7822,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SecurityProfileArn') as security_profile_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' AND region = 'us-east-1' - security_profile: - name: security_profile - id: awscc.connect.security_profile + security_profiles: + name: security_profiles + id: awscc.connect.security_profiles x-cfn-schema-name: SecurityProfile - x-type: get + x-cfn-type-name: AWS::Connect::SecurityProfile x-identifiers: - SecurityProfileArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::SecurityProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::SecurityProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::SecurityProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3845,12 +7905,17 @@ components: JSON_EXTRACT(Properties, '$.SecurityProfileArn') as security_profile_arn, JSON_EXTRACT(Properties, '$.SecurityProfileName') as security_profile_name, JSON_EXTRACT(Properties, '$.TagRestrictedResources') as tag_restricted_resources, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.HierarchyRestrictedResources') as hierarchy_restricted_resources, + JSON_EXTRACT(Properties, '$.AllowedAccessControlHierarchyGroupId') as allowed_access_control_hierarchy_group_id, + JSON_EXTRACT(Properties, '$.Applications') as applications, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.LastModifiedRegion') as last_modified_region, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityProfile' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3862,17 +7927,28 @@ components: json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn, json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name, json_extract_path_text(Properties, 'TagRestrictedResources') as tag_restricted_resources, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'HierarchyRestrictedResources') as hierarchy_restricted_resources, + json_extract_path_text(Properties, 'AllowedAccessControlHierarchyGroupId') as allowed_access_control_hierarchy_group_id, + json_extract_path_text(Properties, 'Applications') as applications, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityProfile' AND data__Identifier = '' AND region = 'us-east-1' - task_templates: - name: task_templates - id: awscc.connect.task_templates - x-cfn-schema-name: TaskTemplate - x-type: list + security_profiles_list_only: + name: security_profiles_list_only + id: awscc.connect.security_profiles_list_only + x-cfn-schema-name: SecurityProfile + x-cfn-type-name: AWS::Connect::SecurityProfile x-identifiers: - - Arn + - SecurityProfileArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3880,28 +7956,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' + JSON_EXTRACT(Properties, '$.SecurityProfileArn') as security_profile_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' + json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' AND region = 'us-east-1' - task_template: - name: task_template - id: awscc.connect.task_template + task_templates: + name: task_templates + id: awscc.connect.task_templates x-cfn-schema-name: TaskTemplate - x-type: get + x-cfn-type-name: AWS::Connect::TaskTemplate x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TaskTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::TaskTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::TaskTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::TaskTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/task_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3911,6 +8035,7 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.ContactFlowArn') as contact_flow_arn, + JSON_EXTRACT(Properties, '$.SelfAssignContactFlowArn') as self_assign_contact_flow_arn, JSON_EXTRACT(Properties, '$.Constraints') as constraints, JSON_EXTRACT(Properties, '$.Defaults') as defaults, JSON_EXTRACT(Properties, '$.Fields') as fields, @@ -3921,7 +8046,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3931,6 +8056,7 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn, + json_extract_path_text(Properties, 'SelfAssignContactFlowArn') as self_assign_contact_flow_arn, json_extract_path_text(Properties, 'Constraints') as constraints, json_extract_path_text(Properties, 'Defaults') as defaults, json_extract_path_text(Properties, 'Fields') as fields, @@ -3940,13 +8066,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::TaskTemplate' AND data__Identifier = '' AND region = 'us-east-1' - traffic_distribution_groups: - name: traffic_distribution_groups - id: awscc.connect.traffic_distribution_groups - x-cfn-schema-name: TrafficDistributionGroup - x-type: list + task_templates_list_only: + name: task_templates_list_only + id: awscc.connect.task_templates_list_only + x-cfn-schema-name: TaskTemplate + x-cfn-type-name: AWS::Connect::TaskTemplate x-identifiers: - - TrafficDistributionGroupArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3954,28 +8086,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrafficDistributionGroupArn') as traffic_distribution_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrafficDistributionGroupArn') as traffic_distribution_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' AND region = 'us-east-1' - traffic_distribution_group: - name: traffic_distribution_group - id: awscc.connect.traffic_distribution_group + traffic_distribution_groups: + name: traffic_distribution_groups + id: awscc.connect.traffic_distribution_groups x-cfn-schema-name: TrafficDistributionGroup - x-type: get + x-cfn-type-name: AWS::Connect::TrafficDistributionGroup x-identifiers: - TrafficDistributionGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrafficDistributionGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::TrafficDistributionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::TrafficDistributionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::TrafficDistributionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3991,7 +8171,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4006,13 +8186,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' AND data__Identifier = '' AND region = 'us-east-1' - users: - name: users - id: awscc.connect.users - x-cfn-schema-name: User - x-type: list + traffic_distribution_groups_list_only: + name: traffic_distribution_groups_list_only + id: awscc.connect.traffic_distribution_groups_list_only + x-cfn-schema-name: TrafficDistributionGroup + x-cfn-type-name: AWS::Connect::TrafficDistributionGroup x-identifiers: - - UserArn + - TrafficDistributionGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4020,28 +8206,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserArn') as user_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' + JSON_EXTRACT(Properties, '$.TrafficDistributionGroupArn') as traffic_distribution_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserArn') as user_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' + json_extract_path_text(Properties, 'TrafficDistributionGroupArn') as traffic_distribution_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' AND region = 'us-east-1' - user: - name: user - id: awscc.connect.user + users: + name: users + id: awscc.connect.users x-cfn-schema-name: User - x-type: get + x-cfn-type-name: AWS::Connect::User x-identifiers: - UserArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4062,7 +8296,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4082,13 +8316,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::User' AND data__Identifier = '' AND region = 'us-east-1' - user_hierarchy_groups: - name: user_hierarchy_groups - id: awscc.connect.user_hierarchy_groups - x-cfn-schema-name: UserHierarchyGroup - x-type: list + users_list_only: + name: users_list_only + id: awscc.connect.users_list_only + x-cfn-schema-name: User + x-cfn-type-name: AWS::Connect::User x-identifiers: - - UserHierarchyGroupArn + - UserArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4096,28 +8336,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserHierarchyGroupArn') as user_hierarchy_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' + JSON_EXTRACT(Properties, '$.UserArn') as user_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserHierarchyGroupArn') as user_hierarchy_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' + json_extract_path_text(Properties, 'UserArn') as user_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' AND region = 'us-east-1' - user_hierarchy_group: - name: user_hierarchy_group - id: awscc.connect.user_hierarchy_group + user_hierarchy_groups: + name: user_hierarchy_groups + id: awscc.connect.user_hierarchy_groups x-cfn-schema-name: UserHierarchyGroup - x-type: get + x-cfn-type-name: AWS::Connect::UserHierarchyGroup x-identifiers: - UserHierarchyGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserHierarchyGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::UserHierarchyGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::UserHierarchyGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::UserHierarchyGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4131,7 +8419,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4144,13 +8432,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' AND data__Identifier = '' AND region = 'us-east-1' - views: - name: views - id: awscc.connect.views - x-cfn-schema-name: View - x-type: list + user_hierarchy_groups_list_only: + name: user_hierarchy_groups_list_only + id: awscc.connect.user_hierarchy_groups_list_only + x-cfn-schema-name: UserHierarchyGroup + x-cfn-type-name: AWS::Connect::UserHierarchyGroup x-identifiers: - - ViewArn + - UserHierarchyGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4158,28 +8452,157 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ViewArn') as view_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' + JSON_EXTRACT(Properties, '$.UserHierarchyGroupArn') as user_hierarchy_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ViewArn') as view_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' + json_extract_path_text(Properties, 'UserHierarchyGroupArn') as user_hierarchy_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' + AND region = 'us-east-1' + user_hierarchy_structures: + name: user_hierarchy_structures + id: awscc.connect.user_hierarchy_structures + x-cfn-schema-name: UserHierarchyStructure + x-cfn-type-name: AWS::Connect::UserHierarchyStructure + x-identifiers: + - UserHierarchyStructureArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserHierarchyStructure&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::UserHierarchyStructure" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::UserHierarchyStructure" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::UserHierarchyStructure" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_structures/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_structures/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_structures/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.UserHierarchyStructureArn') as user_hierarchy_structure_arn, + JSON_EXTRACT(Properties, '$.UserHierarchyStructure') as user_hierarchy_structure + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::UserHierarchyStructure' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'UserHierarchyStructureArn') as user_hierarchy_structure_arn, + json_extract_path_text(Properties, 'UserHierarchyStructure') as user_hierarchy_structure + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::UserHierarchyStructure' + AND data__Identifier = '' AND region = 'us-east-1' - view: - name: view - id: awscc.connect.view + views: + name: views + id: awscc.connect.views x-cfn-schema-name: View - x-type: get + x-cfn-type-name: AWS::Connect::View x-identifiers: - ViewArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__View&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::View" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::View" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::View" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4197,7 +8620,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4214,13 +8637,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::View' AND data__Identifier = '' AND region = 'us-east-1' - view_versions: - name: view_versions - id: awscc.connect.view_versions - x-cfn-schema-name: ViewVersion - x-type: list + views_list_only: + name: views_list_only + id: awscc.connect.views_list_only + x-cfn-schema-name: View + x-cfn-type-name: AWS::Connect::View x-identifiers: - - ViewVersionArn + - ViewArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4228,28 +8657,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ViewVersionArn') as view_version_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' + JSON_EXTRACT(Properties, '$.ViewArn') as view_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ViewVersionArn') as view_version_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' + json_extract_path_text(Properties, 'ViewArn') as view_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' AND region = 'us-east-1' - view_version: - name: view_version - id: awscc.connect.view_version + view_versions: + name: view_versions + id: awscc.connect.view_versions x-cfn-schema-name: ViewVersion - x-type: get + x-cfn-type-name: AWS::Connect::ViewVersion x-identifiers: - ViewVersionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ViewVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ViewVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::ViewVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/view_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/view_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4263,7 +8727,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4276,3 +8740,1279 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ViewVersion' AND data__Identifier = '' AND region = 'us-east-1' + view_versions_list_only: + name: view_versions_list_only + id: awscc.connect.view_versions_list_only + x-cfn-schema-name: ViewVersion + x-cfn-type-name: AWS::Connect::ViewVersion + x-identifiers: + - ViewVersionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ViewVersionArn') as view_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ViewVersionArn') as view_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AgentStatus&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAgentStatus + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAgentStatusRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApprovedOrigin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApprovedOrigin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApprovedOriginRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContactFlow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContactFlow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContactFlowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContactFlowModule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContactFlowModule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContactFlowModuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContactFlowVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContactFlowVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContactFlowVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EmailAddress&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEmailAddress + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEmailAddressRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EvaluationForm&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEvaluationForm + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEvaluationFormRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HoursOfOperation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHoursOfOperation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHoursOfOperationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceStorageConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceStorageConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceStorageConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IntegrationAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegrationAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PredefinedAttribute&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePredefinedAttribute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePredefinedAttributeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Prompt&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrompt + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePromptRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueue + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QuickConnect&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQuickConnect + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQuickConnectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RoutingProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoutingProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoutingProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TaskTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTaskTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTaskTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrafficDistributionGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrafficDistributionGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrafficDistributionGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserHierarchyGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserHierarchyGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserHierarchyGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserHierarchyStructure&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserHierarchyStructure + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserHierarchyStructureRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__View&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateView + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateViewRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ViewVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateViewVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateViewVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/connectcampaigns.yaml b/providers/src/awscc/v00.00.00000/services/connectcampaigns.yaml index e15c9f2f..8ef12f05 100644 --- a/providers/src/awscc/v00.00.00000/services/connectcampaigns.yaml +++ b/providers/src/awscc/v00.00.00000/services/connectcampaigns.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ConnectCampaigns - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DialerConfig: type: object @@ -98,6 +478,9 @@ components: EnableAnswerMachineDetection: type: boolean description: Flag to decided whether outbound calls should have answering machine detection enabled or not + AwaitAnswerMachinePrompt: + type: boolean + description: Enables detection of prompts (e.g., beep after after a voicemail greeting) required: - EnableAnswerMachineDetection additionalProperties: false @@ -158,12 +541,28 @@ components: - Name - OutboundCallConfig x-stackql-resource-name: campaign - x-stackql-primaryIdentifier: + description: Definition of AWS::ConnectCampaigns::Campaign Resource Type + x-type-name: AWS::ConnectCampaigns::Campaign + x-stackql-primary-identifier: - Arn x-create-only-properties: - ConnectInstanceArn x-read-only-properties: - Arn + x-required-properties: + - ConnectInstanceArn + - DialerConfig + - Name + - OutboundCallConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - connect-campaigns:UntagResource + - connect-campaigns:TagResource x-required-permissions: create: - connect-campaigns:CreateCampaign @@ -185,43 +584,119 @@ components: - connect-campaigns:TagResource - connect-campaigns:UntagResource - connect-campaigns:DescribeCampaign + CreateCampaignRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectInstanceArn: + type: string + maxLength: 256 + minLength: 0 + description: Amazon Connect Instance Arn + pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$ + DialerConfig: + $ref: '#/components/schemas/DialerConfig' + Arn: + type: string + maxLength: 256 + minLength: 0 + description: Amazon Connect Campaign Arn + pattern: ^arn:aws[-a-z0-9]*:connect-campaigns:[-a-z0-9]*:[0-9]{12}:campaign/[-a-zA-Z0-9]*$ + Name: + type: string + maxLength: 127 + minLength: 1 + description: Amazon Connect Campaign Name + OutboundCallConfig: + $ref: '#/components/schemas/OutboundCallConfig' + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCampaignRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: campaigns: name: campaigns id: awscc.connectcampaigns.campaigns x-cfn-schema-name: Campaign - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' - AND region = 'us-east-1' - campaign: - name: campaign - id: awscc.connectcampaigns.campaign - x-cfn-schema-name: Campaign - x-type: get + x-cfn-type-name: AWS::ConnectCampaigns::Campaign x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Campaign&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ConnectCampaigns::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ConnectCampaigns::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ConnectCampaigns::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -236,7 +711,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -250,3 +725,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' AND data__Identifier = '' AND region = 'us-east-1' + campaigns_list_only: + name: campaigns_list_only + id: awscc.connectcampaigns.campaigns_list_only + x-cfn-schema-name: Campaign + x-cfn-type-name: AWS::ConnectCampaigns::Campaign + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Campaign&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCampaign + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCampaignRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/connectcampaignsv2.yaml b/providers/src/awscc/v00.00.00000/services/connectcampaignsv2.yaml new file mode 100644 index 00000000..e482c79f --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/connectcampaignsv2.yaml @@ -0,0 +1,1334 @@ +openapi: 3.0.0 +info: + title: ConnectCampaignsV2 + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + CampaignName: + type: string + maxLength: 127 + minLength: 1 + description: Campaign name + InstanceId: + type: string + maxLength: 256 + minLength: 0 + description: Amazon Connect Instance Id + pattern: ^[a-zA-Z0-9_\-.]*$ + Capacity: + type: number + maximum: 1 + minimum: 0.01 + description: Allocates outbound capacity for the specific channel of this campaign between multiple active campaigns + QueueId: + type: string + maxLength: 500 + description: The queue for the call + ContactFlowId: + type: string + maxLength: 500 + description: The identifier of the contact flow for the outbound call + SourcePhoneNumber: + type: string + maxLength: 100 + description: The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue. + Arn: + type: string + maxLength: 500 + minLength: 20 + description: Arn + pattern: ^arn:.*$ + EmailAddress: + type: string + maxLength: 255 + minLength: 1 + description: Email address used for Email messages + pattern: ^[\w-\.\+]+@([\w-]+\.)+[\w-]{2,4}$ + SourceEmailAddressDisplayName: + type: string + maxLength: 127 + minLength: 1 + description: The name of the source email address display name + BandwidthAllocation: + type: number + maximum: 1 + minimum: 0 + description: The bandwidth allocation of a queue resource. + TimeStamp: + type: string + description: Timestamp with no UTC offset or timezone + maxLength: 100 + TimeZone: + type: string + description: Time Zone Id in the IANA format + Iso8601Duration: + type: string + description: Time duration in ISO 8601 format + maxLength: 50 + minLength: 0 + pattern: ^[a-zA-Z0-9.]*$ + Iso8601Date: + type: string + description: Date in ISO 8601 format, e.g. 2024-01-01 + pattern: ^\d{4}-\d{2}-\d{2}$ + Iso8601Time: + type: string + description: Time in ISO 8601 format, e.g. T23:11 + pattern: ^T\d{2}:\d{2}$ + DayOfWeek: + type: string + description: Day of week + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + PredictiveConfig: + type: object + description: Predictive config + properties: + BandwidthAllocation: + $ref: '#/components/schemas/BandwidthAllocation' + required: + - BandwidthAllocation + additionalProperties: false + ProgressiveConfig: + type: object + description: Progressive config + properties: + BandwidthAllocation: + $ref: '#/components/schemas/BandwidthAllocation' + required: + - BandwidthAllocation + additionalProperties: false + AgentlessConfig: + type: object + description: Agentless config + required: [] + additionalProperties: false + TelephonyOutboundMode: + type: object + description: Telephony Outbound Mode + properties: + ProgressiveConfig: + $ref: '#/components/schemas/ProgressiveConfig' + PredictiveConfig: + $ref: '#/components/schemas/PredictiveConfig' + AgentlessConfig: + $ref: '#/components/schemas/AgentlessConfig' + oneOf: + - required: + - ProgressiveConfig + - required: + - PredictiveConfig + - required: + - AgentlessConfig + additionalProperties: false + AnswerMachineDetectionConfig: + type: object + description: The configuration used for answering machine detection during outbound calls + properties: + EnableAnswerMachineDetection: + type: boolean + description: Flag to decided whether outbound calls should have answering machine detection enabled or not + AwaitAnswerMachinePrompt: + type: boolean + description: Enables detection of prompts (e.g., beep after after a voicemail greeting) + required: + - EnableAnswerMachineDetection + additionalProperties: false + TelephonyOutboundConfig: + type: object + description: Default Telephone Outbound config + properties: + ConnectContactFlowId: + $ref: '#/components/schemas/ContactFlowId' + ConnectSourcePhoneNumber: + $ref: '#/components/schemas/SourcePhoneNumber' + AnswerMachineDetectionConfig: + $ref: '#/components/schemas/AnswerMachineDetectionConfig' + required: + - ConnectContactFlowId + additionalProperties: false + TelephonyChannelSubtypeConfig: + type: object + description: Telephony Channel Subtype config + properties: + Capacity: + $ref: '#/components/schemas/Capacity' + ConnectQueueId: + $ref: '#/components/schemas/QueueId' + OutboundMode: + $ref: '#/components/schemas/TelephonyOutboundMode' + DefaultOutboundConfig: + $ref: '#/components/schemas/TelephonyOutboundConfig' + required: + - OutboundMode + - DefaultOutboundConfig + additionalProperties: false + SmsOutboundMode: + type: object + description: SMS Outbound Mode + properties: + AgentlessConfig: + $ref: '#/components/schemas/AgentlessConfig' + additionalProperties: false + SmsOutboundConfig: + type: object + description: Default SMS outbound config + properties: + ConnectSourcePhoneNumberArn: + $ref: '#/components/schemas/Arn' + WisdomTemplateArn: + $ref: '#/components/schemas/Arn' + required: + - ConnectSourcePhoneNumberArn + - WisdomTemplateArn + additionalProperties: false + SmsChannelSubtypeConfig: + type: object + description: SMS Channel Subtype config + properties: + Capacity: + $ref: '#/components/schemas/Capacity' + OutboundMode: + $ref: '#/components/schemas/SmsOutboundMode' + DefaultOutboundConfig: + $ref: '#/components/schemas/SmsOutboundConfig' + required: + - OutboundMode + - DefaultOutboundConfig + additionalProperties: false + EmailOutboundMode: + type: object + description: Email Outbound Mode + properties: + AgentlessConfig: + $ref: '#/components/schemas/AgentlessConfig' + additionalProperties: false + EmailOutboundConfig: + type: object + description: Default SMS outbound config + properties: + ConnectSourceEmailAddress: + $ref: '#/components/schemas/EmailAddress' + SourceEmailAddressDisplayName: + $ref: '#/components/schemas/SourceEmailAddressDisplayName' + WisdomTemplateArn: + $ref: '#/components/schemas/Arn' + required: + - ConnectSourceEmailAddress + - WisdomTemplateArn + additionalProperties: false + EmailChannelSubtypeConfig: + type: object + description: Email Channel Subtype config + properties: + Capacity: + $ref: '#/components/schemas/Capacity' + OutboundMode: + $ref: '#/components/schemas/EmailOutboundMode' + DefaultOutboundConfig: + $ref: '#/components/schemas/EmailOutboundConfig' + required: + - OutboundMode + - DefaultOutboundConfig + additionalProperties: false + ChannelSubtypeConfig: + type: object + description: The possible types of channel subtype config parameters + properties: + Telephony: + $ref: '#/components/schemas/TelephonyChannelSubtypeConfig' + Sms: + $ref: '#/components/schemas/SmsChannelSubtypeConfig' + Email: + $ref: '#/components/schemas/EmailChannelSubtypeConfig' + anyOf: + - required: + - Telephony + - required: + - Sms + - required: + - Email + additionalProperties: false + Source: + type: object + description: The possible source of the campaign + properties: + CustomerProfilesSegmentArn: + $ref: '#/components/schemas/Arn' + EventTrigger: + $ref: '#/components/schemas/EventTrigger' + oneOf: + - required: + - CustomerProfilesSegmentArn + - required: + - EventTrigger + additionalProperties: false + EventTrigger: + type: object + description: The event trigger of the campaign + properties: + CustomerProfilesDomainArn: + $ref: '#/components/schemas/Arn' + additionalProperties: false + TimeRange: + type: object + description: Time range in 24 hour format + properties: + StartTime: + $ref: '#/components/schemas/Iso8601Time' + EndTime: + $ref: '#/components/schemas/Iso8601Time' + required: + - StartTime + - EndTime + additionalProperties: false + TimeRangeList: + type: array + description: List of time range + items: + $ref: '#/components/schemas/TimeRange' + x-insertionOrder: false + DailyHour: + type: object + description: Daily Hour + properties: + Key: + $ref: '#/components/schemas/DayOfWeek' + Value: + $ref: '#/components/schemas/TimeRangeList' + additionalProperties: false + DailyHours: + type: array + uniqueItems: true + x-insertionOrder: false + description: Daily Hours map + items: + $ref: '#/components/schemas/DailyHour' + OpenHours: + type: object + description: Open Hours config + properties: + DailyHours: + $ref: '#/components/schemas/DailyHours' + required: + - DailyHours + additionalProperties: false + RestrictedPeriod: + type: object + description: Restricted period + properties: + Name: + type: string + maxLength: 127 + description: The name of a restricted period + StartDate: + $ref: '#/components/schemas/Iso8601Date' + EndDate: + $ref: '#/components/schemas/Iso8601Date' + required: + - StartDate + - EndDate + additionalProperties: false + RestrictedPeriodList: + type: array + description: List of restricted period + items: + $ref: '#/components/schemas/RestrictedPeriod' + x-insertionOrder: false + RestrictedPeriods: + type: object + description: Restricted period config + properties: + RestrictedPeriodList: + $ref: '#/components/schemas/RestrictedPeriodList' + oneOf: + - required: + - RestrictedPeriodList + additionalProperties: false + TimeWindow: + type: object + description: Time window config + properties: + OpenHours: + $ref: '#/components/schemas/OpenHours' + RestrictedPeriods: + $ref: '#/components/schemas/RestrictedPeriods' + required: + - OpenHours + additionalProperties: false + Schedule: + type: object + description: Campaign schedule + properties: + StartTime: + $ref: '#/components/schemas/TimeStamp' + EndTime: + $ref: '#/components/schemas/TimeStamp' + RefreshFrequency: + $ref: '#/components/schemas/Iso8601Duration' + required: + - StartTime + - EndTime + additionalProperties: false + LocalTimeZoneDetectionType: + type: string + description: Local TimeZone Detection method + enum: + - ZIP_CODE + - AREA_CODE + LocalTimeZoneDetection: + type: array + description: Local TimeZone Detection method list + items: + $ref: '#/components/schemas/LocalTimeZoneDetectionType' + x-insertionOrder: false + LocalTimeZoneConfig: + type: object + description: Local time zone config + properties: + DefaultTimeZone: + $ref: '#/components/schemas/TimeZone' + LocalTimeZoneDetection: + $ref: '#/components/schemas/LocalTimeZoneDetection' + additionalProperties: false + CommunicationTimeConfig: + type: object + description: Campaign communication time config + properties: + LocalTimeZoneConfig: + $ref: '#/components/schemas/LocalTimeZoneConfig' + Telephony: + $ref: '#/components/schemas/TimeWindow' + Sms: + $ref: '#/components/schemas/TimeWindow' + Email: + $ref: '#/components/schemas/TimeWindow' + required: + - LocalTimeZoneConfig + additionalProperties: false + CommunicationLimitTimeUnit: + type: string + description: The communication limit time unit + enum: + - DAY + CommunicationLimit: + type: object + description: Communication Limit + properties: + MaxCountPerRecipient: + type: integer + minimum: 1 + Frequency: + type: integer + minimum: 1 + Unit: + $ref: '#/components/schemas/CommunicationLimitTimeUnit' + required: + - MaxCountPerRecipient + - Frequency + - Unit + additionalProperties: false + CommunicationLimitList: + type: array + description: List of communication limit + items: + $ref: '#/components/schemas/CommunicationLimit' + x-insertionOrder: false + CommunicationLimits: + type: object + description: Communication limits + properties: + CommunicationLimitList: + $ref: '#/components/schemas/CommunicationLimitList' + additionalProperties: false + InstanceLimitsHandling: + type: string + description: Enumeration of Instance Limits handling in a Campaign + enum: + - OPT_IN + - OPT_OUT + CommunicationLimitsConfig: + type: object + description: Communication limits config + properties: + AllChannelsSubtypes: + $ref: '#/components/schemas/CommunicationLimits' + InstanceLimitsHandling: + $ref: '#/components/schemas/InstanceLimitsHandling' + additionalProperties: false + Tag: + type: object + properties: + Key: + type: string + description: The key name of the tag. + Value: + type: string + description: The value for the tag. + required: + - Key + - Value + additionalProperties: false + Campaign: + type: object + properties: + Arn: + type: string + maxLength: 256 + minLength: 0 + description: Amazon Connect Campaign Arn + pattern: ^arn:aws[-a-z0-9]*:connect-campaigns:[-a-z0-9]*:[0-9]{12}:campaign/[-a-zA-Z0-9]*$ + Name: + $ref: '#/components/schemas/CampaignName' + ConnectInstanceId: + $ref: '#/components/schemas/InstanceId' + ChannelSubtypeConfig: + $ref: '#/components/schemas/ChannelSubtypeConfig' + Source: + $ref: '#/components/schemas/Source' + ConnectCampaignFlowArn: + $ref: '#/components/schemas/Arn' + Schedule: + $ref: '#/components/schemas/Schedule' + CommunicationTimeConfig: + $ref: '#/components/schemas/CommunicationTimeConfig' + CommunicationLimitsOverride: + $ref: '#/components/schemas/CommunicationLimitsConfig' + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + required: + - Name + - ConnectInstanceId + - ChannelSubtypeConfig + x-stackql-resource-name: campaign + description: Definition of AWS::ConnectCampaignsV2::Campaign Resource Type + x-type-name: AWS::ConnectCampaignsV2::Campaign + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - ConnectInstanceId + x-read-only-properties: + - Arn + x-required-properties: + - Name + - ConnectInstanceId + - ChannelSubtypeConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - connect-campaigns:UntagResource + - connect-campaigns:TagResource + x-required-permissions: + create: + - connect-campaigns:CreateCampaign + - connect-campaigns:DescribeCampaign + - connect-campaigns:TagResource + - connect:DescribeContactFlow + - connect:DescribeEmailAddress + - connect:DescribeInstance + - connect:DescribePhoneNumber + - connect:DescribeQueue + - profile:GetSegmentDefinition + - wisdom:GetMessageTemplate + read: + - connect-campaigns:DescribeCampaign + delete: + - connect-campaigns:DeleteCampaign + - connect-campaigns:DeleteCampaignChannelSubtypeConfig + - connect-campaigns:DeleteCampaignCommunicationLimits + - connect-campaigns:DeleteCampaignCommunicationTime + list: + - connect-campaigns:ListCampaigns + update: + - connect-campaigns:DeleteCampaignChannelSubtypeConfig + - connect-campaigns:DeleteCampaignCommunicationLimits + - connect-campaigns:DeleteCampaignCommunicationTime + - connect-campaigns:UpdateCampaignChannelSubtypeConfig + - connect-campaigns:UpdateCampaignCommunicationLimits + - connect-campaigns:UpdateCampaignCommunicationTime + - connect-campaigns:UpdateCampaignName + - connect-campaigns:UpdateCampaignFlowAssociation + - connect-campaigns:UpdateCampaignSchedule + - connect-campaigns:UpdateCampaignSource + - connect-campaigns:TagResource + - connect-campaigns:UntagResource + - connect-campaigns:DescribeCampaign + - connect:DescribeContactFlow + - connect:DescribeEmailAddress + - connect:DescribePhoneNumber + - connect:DescribeQueue + - profile:GetSegmentDefinition + - wisdom:GetMessageTemplate + CreateCampaignRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 256 + minLength: 0 + description: Amazon Connect Campaign Arn + pattern: ^arn:aws[-a-z0-9]*:connect-campaigns:[-a-z0-9]*:[0-9]{12}:campaign/[-a-zA-Z0-9]*$ + Name: + $ref: '#/components/schemas/CampaignName' + ConnectInstanceId: + $ref: '#/components/schemas/InstanceId' + ChannelSubtypeConfig: + $ref: '#/components/schemas/ChannelSubtypeConfig' + Source: + $ref: '#/components/schemas/Source' + ConnectCampaignFlowArn: + $ref: '#/components/schemas/Arn' + Schedule: + $ref: '#/components/schemas/Schedule' + CommunicationTimeConfig: + $ref: '#/components/schemas/CommunicationTimeConfig' + CommunicationLimitsOverride: + $ref: '#/components/schemas/CommunicationLimitsConfig' + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: One or more tags. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCampaignRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + campaigns: + name: campaigns + id: awscc.connectcampaignsv2.campaigns + x-cfn-schema-name: Campaign + x-cfn-type-name: AWS::ConnectCampaignsV2::Campaign + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Campaign&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ConnectCampaignsV2::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ConnectCampaignsV2::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ConnectCampaignsV2::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ConnectInstanceId') as connect_instance_id, + JSON_EXTRACT(Properties, '$.ChannelSubtypeConfig') as channel_subtype_config, + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.ConnectCampaignFlowArn') as connect_campaign_flow_arn, + JSON_EXTRACT(Properties, '$.Schedule') as schedule, + JSON_EXTRACT(Properties, '$.CommunicationTimeConfig') as communication_time_config, + JSON_EXTRACT(Properties, '$.CommunicationLimitsOverride') as communication_limits_override, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ConnectCampaignsV2::Campaign' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ConnectInstanceId') as connect_instance_id, + json_extract_path_text(Properties, 'ChannelSubtypeConfig') as channel_subtype_config, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'ConnectCampaignFlowArn') as connect_campaign_flow_arn, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'CommunicationTimeConfig') as communication_time_config, + json_extract_path_text(Properties, 'CommunicationLimitsOverride') as communication_limits_override, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ConnectCampaignsV2::Campaign' + AND data__Identifier = '' + AND region = 'us-east-1' + campaigns_list_only: + name: campaigns_list_only + id: awscc.connectcampaignsv2.campaigns_list_only + x-cfn-schema-name: Campaign + x-cfn-type-name: AWS::ConnectCampaignsV2::Campaign + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaignsV2::Campaign' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaignsV2::Campaign' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Campaign&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCampaign + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCampaignRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/controltower.yaml b/providers/src/awscc/v00.00.00000/services/controltower.yaml index ec0e2cdc..007fa97b 100644 --- a/providers/src/awscc/v00.00.00000/services/controltower.yaml +++ b/providers/src/awscc/v00.00.00000/services/controltower.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ControlTower - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Parameter: type: object @@ -16,17 +396,17 @@ components: $ref: '#/components/schemas/AnyType' additionalProperties: false Tag: + additionalProperties: false type: object properties: - Key: + Value: + minLength: 0 type: string maxLength: 256 + Key: minLength: 1 - Value: type: string maxLength: 256 - minLength: 0 - additionalProperties: false AnyType: anyOf: - type: string @@ -77,17 +457,34 @@ components: - TargetIdentifier - BaselineVersion x-stackql-resource-name: enabled_baseline - x-stackql-primaryIdentifier: + description: Definition of AWS::ControlTower::EnabledBaseline Resource Type + x-type-name: AWS::ControlTower::EnabledBaseline + x-stackql-primary-identifier: - EnabledBaselineIdentifier x-create-only-properties: - TargetIdentifier - BaselineIdentifier x-read-only-properties: - EnabledBaselineIdentifier + x-required-properties: + - BaselineIdentifier + - TargetIdentifier + - BaselineVersion + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - controltower:TagResource + - controltower:UntagResource + - controltower:ListTagsForResource x-required-permissions: create: - controltower:EnableBaseline - controltower:TagResource + - controltower:UntagResource - controltower:GetBaselineOperation - controltower:GetEnabledBaseline - controltower:ListTagsForResource @@ -143,7 +540,7 @@ components: - servicecatalog:ListPrincipalsForPortfolio - servicecatalog:DeleteProvisioningArtifact - controltower:TagResource - - controltower:ListTagsForResource + - controltower:UntagResource - controltower:GetEnabledBaseline delete: - controltower:DisableBaseline @@ -230,12 +627,27 @@ components: - TargetIdentifier - ControlIdentifier x-stackql-resource-name: enabled_control - x-stackql-primaryIdentifier: + description: Enables a control on a specified target. + x-type-name: AWS::ControlTower::EnabledControl + x-stackql-primary-identifier: - TargetIdentifier - ControlIdentifier x-create-only-properties: - TargetIdentifier - ControlIdentifier + x-required-properties: + - TargetIdentifier + - ControlIdentifier + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - controltower:UntagResource + - controltower:TagResource + - controltower:ListTagsForResource x-required-permissions: create: - controltower:ListEnabledControls @@ -250,6 +662,7 @@ components: - organizations:ListPoliciesForTarget - organizations:ListTargetsForPolicy - organizations:DescribePolicy + - controltower:ListTagsForResource update: - controltower:ListEnabledControls - controltower:GetEnabledControl @@ -264,7 +677,10 @@ components: - organizations:ListPoliciesForTarget - organizations:ListTargetsForPolicy - organizations:DescribePolicy + - controltower:ListTagsForResource delete: + - controltower:ListEnabledControls + - controltower:GetEnabledControl - controltower:GetControlOperation - controltower:DisableControl - organizations:UpdatePolicy @@ -275,48 +691,49 @@ components: - organizations:ListPoliciesForTarget - organizations:ListTargetsForPolicy - organizations:DescribePolicy + - controltower:ListTagsForResource read: - controltower:ListEnabledControls - controltower:GetEnabledControl - controltower:ListTagsForResource list: - controltower:ListEnabledControls - LandingZoneDriftStatus: - type: string - enum: - - DRIFTED - - IN_SYNC LandingZoneStatus: type: string enum: - ACTIVE - PROCESSING - FAILED + LandingZoneDriftStatus: + type: string + enum: + - DRIFTED + - IN_SYNC LandingZone: type: object properties: - LandingZoneIdentifier: - type: string - Arn: - type: string - maxLength: 2048 - minLength: 20 - pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ Status: $ref: '#/components/schemas/LandingZoneStatus' LatestAvailableVersion: + minLength: 3 + pattern: \d+.\d+ type: string maxLength: 10 + Version: minLength: 3 pattern: \d+.\d+ + type: string + maxLength: 10 DriftStatus: $ref: '#/components/schemas/LandingZoneDriftStatus' + Arn: + minLength: 20 + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + type: string + maxLength: 2048 Manifest: {} - Version: + LandingZoneIdentifier: type: string - maxLength: 10 - minLength: 3 - pattern: \d+.\d+ Tags: type: array items: @@ -325,7 +742,9 @@ components: - Manifest - Version x-stackql-resource-name: landing_zone - x-stackql-primaryIdentifier: + description: Definition of AWS::ControlTower::LandingZone Resource Type + x-type-name: AWS::ControlTower::LandingZone + x-stackql-primary-identifier: - LandingZoneIdentifier x-read-only-properties: - LandingZoneIdentifier @@ -333,7 +752,23 @@ components: - Status - LatestAvailableVersion - DriftStatus + x-required-properties: + - Manifest + - Version + x-tagging: + permissions: + - controltower:UntagResource + - controltower:TagResource + - controltower:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - controltower:GetLandingZone + - controltower:ListTagsForResource create: - controltower:CreateLandingZone - controltower:GetLandingZoneOperation @@ -365,10 +800,9 @@ components: - sso:GetPeregrineStatus - sso:ListDirectoryAssociations - sso:StartPeregrine + - iam:CreateServiceLinkedRole + - cloudformation:EnableOrganizationsAccess - sso:RegisterRegion - read: - - controltower:GetLandingZone - - controltower:ListTagsForResource update: - controltower:UpdateLandingZone - controltower:GetLandingZoneOperation @@ -399,9 +833,13 @@ components: - organizations:EnableAWSServiceAccess - organizations:ListRoots - sso:GetPeregrineStatus + - iam:CreateServiceLinkedRole + - cloudformation:EnableOrganizationsAccess - sso:ListDirectoryAssociations - sso:StartPeregrine - sso:RegisterRegion + list: + - controltower:ListLandingZones delete: - controltower:DeleteLandingZone - controltower:GetLandingZone @@ -422,48 +860,210 @@ components: - organizations:ListRoots - sso:GetPeregrineStatus - sso:ListDirectoryAssociations + - iam:CreateServiceLinkedRole - iam:DeleteRolePolicy - iam:DetachRolePolicy + - cloudformation:EnableOrganizationsAccess - iam:DeleteRole - list: - - controltower:ListLandingZones + CreateEnabledBaselineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BaselineIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + BaselineVersion: + type: string + pattern: ^\d+(?:\.\d+){0,2}$ + EnabledBaselineIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + TargetIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + Parameters: + type: array + items: + $ref: '#/components/schemas/Parameter' + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateEnabledBaselineRequest + type: object + required: [] + CreateEnabledControlRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ControlIdentifier: + description: Arn of the control. + type: string + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + minLength: 20 + maxLength: 2048 + TargetIdentifier: + description: Arn for Organizational unit to which the control needs to be applied + type: string + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + minLength: 20 + maxLength: 2048 + Parameters: + description: Parameters to configure the enabled control behavior. + type: array + items: + $ref: '#/components/schemas/EnabledControlParameter' + minItems: 1 + x-insertionOrder: false + Tags: + description: A set of tags to assign to the enabled control. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateEnabledControlRequest + type: object + required: [] + CreateLandingZoneRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + $ref: '#/components/schemas/LandingZoneStatus' + LatestAvailableVersion: + minLength: 3 + pattern: \d+.\d+ + type: string + maxLength: 10 + Version: + minLength: 3 + pattern: \d+.\d+ + type: string + maxLength: 10 + DriftStatus: + $ref: '#/components/schemas/LandingZoneDriftStatus' + Arn: + minLength: 20 + pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$ + type: string + maxLength: 2048 + Manifest: {} + LandingZoneIdentifier: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateLandingZoneRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: enabled_baselines: name: enabled_baselines id: awscc.controltower.enabled_baselines x-cfn-schema-name: EnabledBaseline - x-type: list - x-identifiers: - - EnabledBaselineIdentifier - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnabledBaselineIdentifier') as enabled_baseline_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnabledBaselineIdentifier') as enabled_baseline_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' - AND region = 'us-east-1' - enabled_baseline: - name: enabled_baseline - id: awscc.controltower.enabled_baseline - x-cfn-schema-name: EnabledBaseline - x-type: get + x-cfn-type-name: AWS::ControlTower::EnabledBaseline x-identifiers: - EnabledBaselineIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnabledBaseline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::EnabledBaseline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::EnabledBaseline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::EnabledBaseline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -478,7 +1078,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -492,14 +1092,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' AND data__Identifier = '' AND region = 'us-east-1' - enabled_controls: - name: enabled_controls - id: awscc.controltower.enabled_controls - x-cfn-schema-name: EnabledControl - x-type: list + enabled_baselines_list_only: + name: enabled_baselines_list_only + id: awscc.controltower.enabled_baselines_list_only + x-cfn-schema-name: EnabledBaseline + x-cfn-type-name: AWS::ControlTower::EnabledBaseline x-identifiers: - - TargetIdentifier - - ControlIdentifier + - EnabledBaselineIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -507,31 +1112,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TargetIdentifier') as target_identifier, - JSON_EXTRACT(Properties, '$.ControlIdentifier') as control_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' + JSON_EXTRACT(Properties, '$.EnabledBaselineIdentifier') as enabled_baseline_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, - json_extract_path_text(Properties, 'ControlIdentifier') as control_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' + json_extract_path_text(Properties, 'EnabledBaselineIdentifier') as enabled_baseline_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' AND region = 'us-east-1' - enabled_control: - name: enabled_control - id: awscc.controltower.enabled_control + enabled_controls: + name: enabled_controls + id: awscc.controltower.enabled_controls x-cfn-schema-name: EnabledControl - x-type: get + x-cfn-type-name: AWS::ControlTower::EnabledControl x-identifiers: - TargetIdentifier - ControlIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnabledControl&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::EnabledControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::EnabledControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::EnabledControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -544,7 +1195,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -556,13 +1207,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' AND data__Identifier = '|' AND region = 'us-east-1' - landing_zones: - name: landing_zones - id: awscc.controltower.landing_zones - x-cfn-schema-name: LandingZone - x-type: list + enabled_controls_list_only: + name: enabled_controls_list_only + id: awscc.controltower.enabled_controls_list_only + x-cfn-schema-name: EnabledControl + x-cfn-type-name: AWS::ControlTower::EnabledControl x-identifiers: - - LandingZoneIdentifier + - TargetIdentifier + - ControlIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -570,57 +1228,417 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LandingZoneIdentifier') as landing_zone_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' + JSON_EXTRACT(Properties, '$.TargetIdentifier') as target_identifier, + JSON_EXTRACT(Properties, '$.ControlIdentifier') as control_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' + json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, + json_extract_path_text(Properties, 'ControlIdentifier') as control_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' AND region = 'us-east-1' - landing_zone: - name: landing_zone - id: awscc.controltower.landing_zone + landing_zones: + name: landing_zones + id: awscc.controltower.landing_zones x-cfn-schema-name: LandingZone - x-type: get + x-cfn-type-name: AWS::ControlTower::LandingZone x-identifiers: - LandingZoneIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LandingZone&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::LandingZone" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::LandingZone" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ControlTower::LandingZone" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/landing_zones/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/landing_zones/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/landing_zones/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LandingZoneIdentifier') as landing_zone_identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.LatestAvailableVersion') as latest_available_version, + JSON_EXTRACT(Properties, '$.Version') as version, JSON_EXTRACT(Properties, '$.DriftStatus') as drift_status, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Manifest') as manifest, - JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.LandingZoneIdentifier') as landing_zone_identifier, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::LandingZone' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier, - json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'LatestAvailableVersion') as latest_available_version, + json_extract_path_text(Properties, 'Version') as version, json_extract_path_text(Properties, 'DriftStatus') as drift_status, + json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Manifest') as manifest, - json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::LandingZone' AND data__Identifier = '' AND region = 'us-east-1' + landing_zones_list_only: + name: landing_zones_list_only + id: awscc.controltower.landing_zones_list_only + x-cfn-schema-name: LandingZone + x-cfn-type-name: AWS::ControlTower::LandingZone + x-identifiers: + - LandingZoneIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LandingZoneIdentifier') as landing_zone_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnabledBaseline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnabledBaseline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnabledBaselineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnabledControl&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnabledControl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnabledControlRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LandingZone&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLandingZone + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLandingZoneRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/cur.yaml b/providers/src/awscc/v00.00.00000/services/cur.yaml index d9557976..395cb32a 100644 --- a/providers/src/awscc/v00.00.00000/services/cur.yaml +++ b/providers/src/awscc/v00.00.00000/services/cur.yaml @@ -1,10 +1,405 @@ openapi: 3.0.0 info: title: CUR - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 0 + required: + - Key + - Value + additionalProperties: false ReportDefinition: type: object properties: @@ -43,6 +438,8 @@ components: type: string enum: - RESOURCES + - SPLIT_COST_ALLOCATION_DATA + - MANUAL_DISCOUNT_COMPATIBILITY S3Bucket: description: The S3 bucket where AWS delivers the report. type: string @@ -96,7 +493,9 @@ components: - RefreshClosedReports - ReportVersioning x-stackql-resource-name: report_definition - x-stackql-primaryIdentifier: + description: The AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports. + x-type-name: AWS::CUR::ReportDefinition + x-stackql-primary-identifier: - ReportName x-create-only-properties: - ReportName @@ -104,56 +503,194 @@ components: - TimeUnit - ReportVersioning - BillingViewArn + x-required-properties: + - ReportName + - TimeUnit + - Format + - Compression + - S3Bucket + - S3Prefix + - S3Region + - RefreshClosedReports + - ReportVersioning + x-tagging: + taggable: false x-required-permissions: create: - cur:PutReportDefinition + - cur:DescribeReportDefinitions read: - cur:DescribeReportDefinitions update: - cur:DescribeReportDefinitions - cur:ModifyReportDefinition delete: - - cur:DescribeReportDefinitions - cur:DeleteReportDefinition list: - cur:DescribeReportDefinitions + CreateReportDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ReportName: + description: The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces. + type: string + minLength: 1 + maxLength: 256 + pattern: '[0-9A-Za-z!\-_.*\''()]+' + TimeUnit: + description: The granularity of the line items in the report. + type: string + enum: + - HOURLY + - DAILY + - MONTHLY + Format: + description: The format that AWS saves the report in. + type: string + enum: + - textORcsv + - Parquet + Compression: + description: The compression format that AWS uses for the report. + type: string + enum: + - ZIP + - GZIP + - Parquet + AdditionalSchemaElements: + description: A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs. + type: array + default: [] + items: + description: Whether or not AWS includes resource IDs in the report. + type: string + enum: + - RESOURCES + - SPLIT_COST_ALLOCATION_DATA + - MANUAL_DISCOUNT_COMPATIBILITY + S3Bucket: + description: The S3 bucket where AWS delivers the report. + type: string + minLength: 1 + maxLength: 256 + pattern: '[A-Za-z0-9_\.\-]+' + S3Prefix: + description: The prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces. + type: string + minLength: 1 + maxLength: 256 + pattern: '[0-9A-Za-z!\-_.*\''()/]*' + S3Region: + description: The region of the S3 bucket that AWS delivers the report into. + type: string + AdditionalArtifacts: + description: A list of manifests that you want Amazon Web Services to create for this report. + type: array + default: [] + items: + description: The types of manifest that you want AWS to create for this report. + type: string + enum: + - REDSHIFT + - QUICKSIGHT + - ATHENA + RefreshClosedReports: + description: Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees. + type: boolean + ReportVersioning: + description: Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions. + type: string + enum: + - CREATE_NEW_REPORT + - OVERWRITE_REPORT + BillingViewArn: + description: The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs. + type: string + default: null + pattern: (arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\+=\.\-@].{1,30} + minLength: 1 + maxLength: 128 + x-stackQL-stringOnly: true + x-title: CreateReportDefinitionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: report_definitions: name: report_definitions id: awscc.cur.report_definitions x-cfn-schema-name: ReportDefinition - x-type: list - x-identifiers: - - ReportName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReportName') as report_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReportName') as report_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' - AND region = 'us-east-1' - report_definition: - name: report_definition - id: awscc.cur.report_definition - x-cfn-schema-name: ReportDefinition - x-type: get + x-cfn-type-name: AWS::CUR::ReportDefinition x-identifiers: - ReportName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReportDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CUR::ReportDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CUR::ReportDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CUR::ReportDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/report_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/report_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/report_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -174,7 +711,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -194,3 +731,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CUR::ReportDefinition' AND data__Identifier = '' AND region = 'us-east-1' + report_definitions_list_only: + name: report_definitions_list_only + id: awscc.cur.report_definitions_list_only + x-cfn-schema-name: ReportDefinition + x-cfn-type-name: AWS::CUR::ReportDefinition + x-identifiers: + - ReportName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ReportName') as report_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReportName') as report_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReportDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReportDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReportDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/customerprofiles.yaml b/providers/src/awscc/v00.00.00000/services/customerprofiles.yaml index 6454c340..35c1ff92 100644 --- a/providers/src/awscc/v00.00.00000/services/customerprofiles.yaml +++ b/providers/src/awscc/v00.00.00000/services/customerprofiles.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: CustomerProfiles - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DomainName: description: The unique name of the domain. @@ -24,7 +404,7 @@ components: minLength: 1 maxLength: 255 Description: - description: The description of the calculated attribute. + description: The description of the event trigger. type: string minLength: 1 maxLength: 1000 @@ -78,7 +458,25 @@ components: description: The amount of time of the specified unit. type: integer minimum: 1 - maximum: 366 + maximum: 2147483647 + ValueRange: + description: A structure specifying the endpoints of the relative time period over which data is included in the aggregation. + type: object + properties: + Start: + description: The starting point for this range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future. + type: integer + minimum: -2147483648 + maximum: 2147483647 + End: + description: The ending point for this range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future. + type: integer + minimum: -2147483648 + maximum: 2147483647 + required: + - Start + - End + additionalProperties: false Range: description: The relative time period over which data is included in the aggregation. type: object @@ -87,15 +485,26 @@ components: $ref: '#/components/schemas/RangeValue' Unit: $ref: '#/components/schemas/RangeUnit' + ValueRange: + $ref: '#/components/schemas/ValueRange' + TimestampSource: + description: 'An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \"{ObjectTypeName.}\". E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}".' + type: string + minLength: 1 + maxLength: 255 + TimestampFormat: + description: 'The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI or ISO_8601. E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235Z"}}, then TimestampFormat should be "ISO_8601".' + type: string + minLength: 1 + maxLength: 255 required: - - Value - Unit additionalProperties: false ObjectCount: description: The number of profile objects used for the calculated attribute. type: integer minimum: 1 - maximum: 100 + maximum: 300 ThresholdValue: description: The value of the threshold. type: string @@ -144,22 +553,38 @@ components: - MAXIMUM - AVERAGE - MAX_OCCURRENCE + Readiness: + description: The readiness status of the calculated attribute. + type: object + properties: + ProgressPercentage: + description: The progress percentage for including historical data in your calculated attribute. + type: integer + minimum: 0 + maximum: 100 + Message: + description: Any information pertaining to the status of the calculated attribute if required. + type: string + additionalProperties: false Tag: + description: A key-value pair to associate with a resource. type: object properties: Key: type: string pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' minLength: 1 maxLength: 128 Value: type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' minLength: 0 maxLength: 256 - additionalProperties: false required: - Key - Value + additionalProperties: false Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -186,12 +611,25 @@ components: $ref: '#/components/schemas/Conditions' Statistic: $ref: '#/components/schemas/Statistic' + UseHistoricalData: + description: Whether to use historical data for the calculated attribute. + type: boolean CreatedAt: description: The timestamp of when the calculated attribute definition was created. type: string LastUpdatedAt: description: The timestamp of when the calculated attribute definition was most recently edited. type: string + Status: + description: The status of the calculated attribute definition. + type: string + enum: + - IN_PROGRESS + - PREPARING + - COMPLETED + - FAILED + Readiness: + $ref: '#/components/schemas/Readiness' Tags: $ref: '#/components/schemas/Tags' required: @@ -200,15 +638,37 @@ components: - AttributeDetails - Statistic x-stackql-resource-name: calculated_attribute_definition - x-stackql-primaryIdentifier: + description: A calculated attribute definition for Customer Profiles + x-type-name: AWS::CustomerProfiles::CalculatedAttributeDefinition + x-stackql-primary-identifier: - DomainName - CalculatedAttributeName x-create-only-properties: - DomainName - CalculatedAttributeName + - UseHistoricalData + - Conditions/Range/TimestampSource + - Conditions/Range/TimestampFormat x-read-only-properties: - CreatedAt - LastUpdatedAt + - Status + - Readiness + x-required-properties: + - DomainName + - CalculatedAttributeName + - AttributeDetails + - Statistic + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource x-required-permissions: create: - profile:CreateCalculatedAttributeDefinition @@ -513,7 +973,9 @@ components: - DomainName - DefaultExpirationDays x-stackql-resource-name: domain - x-stackql-primaryIdentifier: + description: A domain defined for 3rd party data source in Profile Service + x-type-name: AWS::CustomerProfiles::Domain + x-stackql-primary-identifier: - DomainName x-create-only-properties: - DomainName @@ -522,6 +984,19 @@ components: - CreatedAt - RuleBasedMatching/Status - Stats + x-required-properties: + - DomainName + - DefaultExpirationDays + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource x-required-permissions: create: - profile:CreateDomain @@ -605,7 +1080,9 @@ components: - EventStreamName - Uri x-stackql-resource-name: event_stream - x-stackql-primaryIdentifier: + description: An Event Stream resource of Amazon Connect Customer Profiles + x-type-name: AWS::CustomerProfiles::EventStream + x-stackql-primary-identifier: - DomainName - EventStreamName x-create-only-properties: @@ -617,6 +1094,20 @@ components: - CreatedAt - State - EventStreamArn + x-required-properties: + - DomainName + - EventStreamName + - Uri + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource x-required-permissions: create: - profile:CreateEventStream @@ -636,6 +1127,246 @@ components: - iam:DeleteRolePolicy list: - profile:ListEventStreams + EventTriggerName: + description: The unique name of the event trigger. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + ObjectTypeName: + description: The unique name of the object type. + type: string + pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$ + minLength: 1 + maxLength: 255 + EventTriggerConditions: + description: A list of conditions that determine when an event should trigger the destination. + type: array + items: + $ref: '#/components/schemas/EventTriggerCondition' + x-insertionOrder: false + minItems: 1 + maxItems: 5 + EventTriggerCondition: + description: Specifies the circumstances under which the event should trigger the destination. + type: object + properties: + EventTriggerDimensions: + $ref: '#/components/schemas/EventTriggerDimensions' + LogicalOperator: + $ref: '#/components/schemas/EventTriggerLogicalOperator' + required: + - EventTriggerDimensions + - LogicalOperator + additionalProperties: false + EventTriggerDimensions: + description: A list of dimensions to be evaluated for the event. + type: array + items: + $ref: '#/components/schemas/EventTriggerDimension' + x-insertionOrder: false + minItems: 1 + maxItems: 10 + EventTriggerDimension: + description: A specific event dimension to be assessed. + type: object + properties: + ObjectAttributes: + $ref: '#/components/schemas/ObjectAttributes' + required: + - ObjectAttributes + additionalProperties: false + EventTriggerLogicalOperator: + description: The operator used to combine multiple dimensions. + type: string + enum: + - ANY + - ALL + - NONE + ObjectAttributes: + description: A list of object attributes to be evaluated. + type: array + items: + $ref: '#/components/schemas/ObjectAttribute' + x-insertionOrder: false + minItems: 1 + maxItems: 10 + ObjectAttribute: + description: The criteria that a specific object attribute must meet to trigger the destination. + type: object + properties: + Source: + description: An attribute contained within a source object. + type: string + minLength: 1 + maxLength: 1000 + FieldName: + description: A field defined within an object type. + type: string + pattern: ^[a-zA-Z0-9_.-]+$ + minLength: 1 + maxLength: 64 + ComparisonOperator: + description: The operator used to compare an attribute against a list of values. + type: string + enum: + - INCLUSIVE + - EXCLUSIVE + - CONTAINS + - BEGINS_WITH + - ENDS_WITH + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUAL + - LESS_THAN_OR_EQUAL + - EQUAL + - BEFORE + - AFTER + - 'ON' + - BETWEEN + - NOT_BETWEEN + Values: + description: A list of attribute values used for comparison. + type: array + items: + type: string + minLength: 1 + maxLength: 255 + x-insertionOrder: false + minItems: 1 + maxItems: 10 + required: + - ComparisonOperator + - Values + additionalProperties: false + EventTriggerLimits: + description: Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. + type: object + properties: + EventExpiration: + $ref: '#/components/schemas/EventExpiration' + Periods: + $ref: '#/components/schemas/Periods' + additionalProperties: false + EventExpiration: + description: Specifies that an event will only trigger the destination if it is processed within a certain latency period. + type: integer + format: int64 + Periods: + description: A list of time periods during which the limits apply. + type: array + items: + $ref: '#/components/schemas/Period' + x-insertionOrder: false + minItems: 1 + maxItems: 4 + Period: + description: Defines a limit and the time period during which it is enforced. + type: object + properties: + Unit: + description: The unit of time. + type: string + enum: + - HOURS + - DAYS + - WEEKS + - MONTHS + Value: + description: The amount of time of the specified unit. + type: integer + minimum: 1 + maximum: 24 + MaxInvocationsPerProfile: + description: The maximum allowed number of destination invocations per profile. + type: integer + minimum: 1 + maximum: 1000 + Unlimited: + description: If set to true, there is no limit on the number of destination invocations per profile. The default is false. + type: boolean + required: + - Unit + - Value + additionalProperties: false + SegmentFilter: + description: The destination is triggered only for profiles that meet the criteria of a segment definition. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + EventTrigger: + type: object + properties: + DomainName: + $ref: '#/components/schemas/DomainName' + EventTriggerName: + $ref: '#/components/schemas/EventTriggerName' + ObjectTypeName: + $ref: '#/components/schemas/ObjectTypeName' + Description: + $ref: '#/components/schemas/Description' + EventTriggerConditions: + $ref: '#/components/schemas/EventTriggerConditions' + EventTriggerLimits: + $ref: '#/components/schemas/EventTriggerLimits' + SegmentFilter: + $ref: '#/components/schemas/SegmentFilter' + CreatedAt: + description: The timestamp of when the event trigger was created. + type: string + LastUpdatedAt: + description: The timestamp of when the event trigger was most recently updated. + type: string + Tags: + $ref: '#/components/schemas/Tags' + required: + - DomainName + - EventTriggerName + - ObjectTypeName + - EventTriggerConditions + x-stackql-resource-name: event_trigger + description: An event trigger resource of Amazon Connect Customer Profiles + x-type-name: AWS::CustomerProfiles::EventTrigger + x-stackql-primary-identifier: + - DomainName + - EventTriggerName + x-create-only-properties: + - DomainName + - EventTriggerName + x-read-only-properties: + - CreatedAt + - LastUpdatedAt + x-required-properties: + - DomainName + - EventTriggerName + - ObjectTypeName + - EventTriggerConditions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource + x-required-permissions: + create: + - profile:CreateEventTrigger + - profile:TagResource + read: + - profile:GetEventTrigger + update: + - profile:GetEventTrigger + - profile:UpdateEventTrigger + - profile:UntagResource + - profile:TagResource + delete: + - profile:DeleteEventTrigger + list: + - profile:ListEventTriggers Object: type: string maxLength: 512 @@ -1090,18 +1821,45 @@ components: type: array items: $ref: '#/components/schemas/ObjectTypeMapping' + EventTriggerNames: + description: A list of unique names for active event triggers associated with the integration. + type: array + items: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + x-insertionOrder: false + minItems: 1 + maxItems: 1 required: - DomainName x-stackql-resource-name: integration - x-stackql-primaryIdentifier: + description: The resource schema for creating an Amazon Connect Customer Profiles Integration. + x-type-name: AWS::CustomerProfiles::Integration + x-stackql-primary-identifier: - DomainName - Uri x-create-only-properties: - DomainName - Uri + x-write-only-properties: + - FlowDefinition x-read-only-properties: - LastUpdatedAt - CreatedAt + x-required-properties: + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource x-required-permissions: create: - profile:GetIntegration @@ -1109,6 +1867,8 @@ components: - appflow:CreateFlow - app-integrations:CreateEventIntegrationAssociation - app-integrations:GetEventIntegration + - connect:DescribeInstance + - ds:DescribeDirectories - events:ListTargetsByRule - events:PutRule - events:PutTargets @@ -1140,6 +1900,8 @@ components: - events:PutEvents - profile:UntagResource - profile:TagResource + - connect:DescribeInstance + - ds:DescribeDirectories list: - profile:ListIntegrations FieldMap: @@ -1242,7 +2004,7 @@ components: description: Description of the profile object type. type: string minLength: 1 - maxLength: 1000 + maxLength: 10000 EncryptionKey: description: The default encryption key type: string @@ -1289,12 +2051,22 @@ components: pattern: ^[a-zA-Z0-9_-]+$ minLength: 1 maxLength: 64 + MaxProfileObjectCount: + description: The maximum number of profile objects for this object type + type: integer + minimum: 1 + MaxAvailableProfileObjectCount: + description: The maximum available number of profile objects + type: integer + minimum: 0 required: - DomainName - ObjectTypeName - Description x-stackql-resource-name: object_type - x-stackql-primaryIdentifier: + description: An ObjectType resource of Amazon Connect Customer Profiles + x-type-name: AWS::CustomerProfiles::ObjectType + x-stackql-primary-identifier: - DomainName - ObjectTypeName x-create-only-properties: @@ -1303,63 +2075,969 @@ components: x-read-only-properties: - LastUpdatedAt - CreatedAt + - MaxAvailableProfileObjectCount + x-required-properties: + - DomainName + - ObjectTypeName + - Description + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource x-required-permissions: create: - profile:GetProfileObjectType - profile:PutProfileObjectType - profile:TagResource + - kms:GenerateDataKey + - kms:Decrypt read: - profile:GetProfileObjectType + - kms:GenerateDataKey + - kms:Decrypt update: - profile:GetProfileObjectType - profile:PutProfileObjectType - profile:UntagResource - profile:TagResource + - kms:GenerateDataKey + - kms:Decrypt delete: - profile:DeleteProfileObjectType list: - profile:ListProfileObjectTypes - x-stackQL-resources: - calculated_attribute_definitions: - name: calculated_attribute_definitions - id: awscc.customerprofiles.calculated_attribute_definitions - x-cfn-schema-name: CalculatedAttributeDefinition - x-type: list - x-identifiers: + - kms:GenerateDataKey + - kms:Decrypt + ConditionOverrides: + description: Overrides the condition block within the original calculated attribute definition. + type: object + properties: + Range: + $ref: '#/components/schemas/RangeOverride' + additionalProperties: false + RangeOverride: + description: Defines the range to be applied to the calculated attribute definition. + type: object + properties: + Start: + description: The starting point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future. + type: integer + minimum: -2147483648 + maximum: 2147483647 + End: + description: The ending point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future. + type: integer + minimum: -2147483648 + maximum: 2147483647 + Unit: + description: The unit to be applied to the range. + type: string + enum: + - DAYS + required: + - Start + - Unit + additionalProperties: false + AddressDimension: + description: The address based criteria for the segment. + type: object + properties: + City: + $ref: '#/components/schemas/ProfileDimension' + Country: + $ref: '#/components/schemas/ProfileDimension' + County: + $ref: '#/components/schemas/ProfileDimension' + PostalCode: + $ref: '#/components/schemas/ProfileDimension' + Province: + $ref: '#/components/schemas/ProfileDimension' + State: + $ref: '#/components/schemas/ProfileDimension' + additionalProperties: false + AttributeDimension: + description: Specifies attribute based criteria for a segment. + type: object + properties: + DimensionType: + $ref: '#/components/schemas/AttributeDimensionType' + Values: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + x-insertionOrder: false + minItems: 1 + maxItems: 50 + required: + - DimensionType + - Values + additionalProperties: false + AttributeDimensionType: + description: The type of segment dimension to use. + type: string + enum: + - INCLUSIVE + - EXCLUSIVE + - CONTAINS + - BEGINS_WITH + - ENDS_WITH + - BEFORE + - AFTER + - BETWEEN + - NOT_BETWEEN + - 'ON' + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUAL + - LESS_THAN_OR_EQUAL + - EQUAL + CalculatedAttributeDimension: + description: Specifies calculated attribute based criteria for a segment. + type: object + properties: + DimensionType: + $ref: '#/components/schemas/AttributeDimensionType' + Values: + type: array + items: + type: string + minLength: 1 + maxLength: 255 + x-insertionOrder: false + minItems: 1 + maxItems: 50 + ConditionOverrides: + $ref: '#/components/schemas/ConditionOverrides' + required: + - DimensionType + - Values + additionalProperties: false + CustomAttributes: + description: One or more custom attributes to use as criteria for the segment. + type: object + x-patternProperties: + ^[a-zA-Z_][a-zA-Z_0-9-]*$: + $ref: '#/components/schemas/AttributeDimension' + additionalProperties: false + CalculatedCustomAttributes: + description: One or more calculated attributes to use as criteria for the segment. + type: object + x-patternProperties: + ^[a-zA-Z_][a-zA-Z_0-9-]*$: + $ref: '#/components/schemas/CalculatedAttributeDimension' + additionalProperties: false + DateDimension: + description: Specifies date based criteria for a segment. + type: object + properties: + DimensionType: + $ref: '#/components/schemas/DateDimensionType' + Values: + type: array + items: + type: string + x-insertionOrder: false + minItems: 1 + maxItems: 50 + required: + - DimensionType + - Values + additionalProperties: false + DateDimensionType: + description: The type of segment dimension to use for a date dimension. + type: string + enum: + - BEFORE + - AFTER + - BETWEEN + - NOT_BETWEEN + - 'ON' + Dimension: + description: The criteria that define the dimensions for the segment. + oneOf: + - type: object + title: ProfileAttributes + properties: + ProfileAttributes: + $ref: '#/components/schemas/ProfileAttributes' + required: + - ProfileAttributes + additionalProperties: false + - type: object + title: CalculatedAttributes + properties: + CalculatedAttributes: + $ref: '#/components/schemas/CalculatedCustomAttributes' + additionalProperties: false + ExtraLengthValueProfileDimension: + description: Specifies criteria for a segment using extended-length string values. + type: object + properties: + DimensionType: + $ref: '#/components/schemas/StringDimensionType' + Values: + type: array + items: + type: string + maxLength: 1000 + minLength: 1 + x-insertionOrder: false + minItems: 1 + maxItems: 50 + required: + - DimensionType + - Values + additionalProperties: false + Group: + description: An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. + type: object + properties: + Dimensions: + type: array + items: + $ref: '#/components/schemas/Dimension' + SourceSegments: + type: array + items: + $ref: '#/components/schemas/SourceSegment' + SourceType: + $ref: '#/components/schemas/IncludeOptions' + Type: + $ref: '#/components/schemas/IncludeOptions' + additionalProperties: false + IncludeOptions: + description: Specifies the operator on how to handle multiple groups within the same segment. + type: string + enum: + - ALL + - ANY + - NONE + ProfileAttributes: + description: Specifies the dimension settings within profile attributes for a segment. + type: object + properties: + AccountNumber: + $ref: '#/components/schemas/ProfileDimension' + AdditionalInformation: + $ref: '#/components/schemas/ExtraLengthValueProfileDimension' + FirstName: + $ref: '#/components/schemas/ProfileDimension' + LastName: + $ref: '#/components/schemas/ProfileDimension' + MiddleName: + $ref: '#/components/schemas/ProfileDimension' + GenderString: + $ref: '#/components/schemas/ProfileDimension' + PartyTypeString: + $ref: '#/components/schemas/ProfileDimension' + BirthDate: + $ref: '#/components/schemas/DateDimension' + PhoneNumber: + $ref: '#/components/schemas/ProfileDimension' + BusinessName: + $ref: '#/components/schemas/ProfileDimension' + BusinessPhoneNumber: + $ref: '#/components/schemas/ProfileDimension' + HomePhoneNumber: + $ref: '#/components/schemas/ProfileDimension' + MobilePhoneNumber: + $ref: '#/components/schemas/ProfileDimension' + EmailAddress: + $ref: '#/components/schemas/ProfileDimension' + PersonalEmailAddress: + $ref: '#/components/schemas/ProfileDimension' + BusinessEmailAddress: + $ref: '#/components/schemas/ProfileDimension' + Address: + $ref: '#/components/schemas/AddressDimension' + ShippingAddress: + $ref: '#/components/schemas/AddressDimension' + MailingAddress: + $ref: '#/components/schemas/AddressDimension' + BillingAddress: + $ref: '#/components/schemas/AddressDimension' + Attributes: + $ref: '#/components/schemas/CustomAttributes' + ProfileType: + $ref: '#/components/schemas/ProfileTypeDimension' + additionalProperties: false + ProfileDimension: + description: Specifies profile based criteria for a segment. + type: object + properties: + DimensionType: + $ref: '#/components/schemas/StringDimensionType' + Values: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + x-insertionOrder: false + minItems: 1 + maxItems: 50 + required: + - DimensionType + - Values + additionalProperties: false + ProfileTypeDimension: + description: Specifies profile type based criteria for a segment. + type: object + properties: + DimensionType: + $ref: '#/components/schemas/ProfileTypeDimensionType' + Values: + type: array + items: + $ref: '#/components/schemas/ProfileType' + x-insertionOrder: false + minItems: 1 + maxItems: 1 + required: + - DimensionType + - Values + additionalProperties: false + SegmentGroup: + type: object + properties: + Groups: + type: array + items: + $ref: '#/components/schemas/Group' + Include: + $ref: '#/components/schemas/IncludeOptions' + additionalProperties: false + SourceSegment: + description: The base segment to build the segment on. + type: object + properties: + SegmentDefinitionName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + additionalProperties: false + StringDimensionType: + description: The type of segment dimension to use for a string dimension. + type: string + enum: + - INCLUSIVE + - EXCLUSIVE + - CONTAINS + - BEGINS_WITH + - ENDS_WITH + ProfileTypeDimensionType: + description: The type of segment dimension to use for a profile type dimension. + type: string + enum: + - INCLUSIVE + - EXCLUSIVE + ProfileType: + description: The type of profile. + type: string + enum: + - ACCOUNT_PROFILE + - PROFILE + SegmentDefinition: + type: object + properties: + CreatedAt: + description: The time of this segment definition got created. + type: string + format: date-time + Description: + description: The description of the segment definition. + type: string + maxLength: 1000 + minLength: 1 + DisplayName: + description: The display name of the segment definition. + type: string + maxLength: 255 + minLength: 1 + DomainName: + description: The unique name of the domain. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + SegmentDefinitionName: + description: The unique name of the segment definition. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + SegmentGroups: + description: An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. + $ref: '#/components/schemas/SegmentGroup' + SegmentDefinitionArn: + description: The Amazon Resource Name (ARN) of the segment definition. + type: string + maxLength: 255 + minLength: 1 + Tags: + description: The tags used to organize, track, or control access for this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + required: - DomainName - - CalculatedAttributeName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.CalculatedAttributeName') as calculated_attribute_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'CalculatedAttributeName') as calculated_attribute_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' - AND region = 'us-east-1' - calculated_attribute_definition: - name: calculated_attribute_definition - id: awscc.customerprofiles.calculated_attribute_definition + - DisplayName + - SegmentDefinitionName + - SegmentGroups + x-stackql-resource-name: segment_definition + description: A segment definition resource of Amazon Connect Customer Profiles + x-type-name: AWS::CustomerProfiles::SegmentDefinition + x-stackql-primary-identifier: + - DomainName + - SegmentDefinitionName + x-create-only-properties: + - DomainName + - SegmentDefinitionName + - DisplayName + - SegmentGroups + x-read-only-properties: + - CreatedAt + - SegmentDefinitionArn + x-required-properties: + - DomainName + - DisplayName + - SegmentDefinitionName + - SegmentGroups + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - profile:TagResource + - profile:UntagResource + - profile:ListTagsForResource + x-required-permissions: + create: + - profile:CreateSegmentDefinition + - profile:TagResource + read: + - profile:GetSegmentDefinition + update: + - profile:GetSegmentDefinition + - profile:UntagResource + - profile:TagResource + delete: + - profile:DeleteSegmentDefinition + list: + - profile:ListSegmentDefinitions + CreateCalculatedAttributeDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + $ref: '#/components/schemas/DomainName' + CalculatedAttributeName: + $ref: '#/components/schemas/CalculatedAttributeName' + DisplayName: + $ref: '#/components/schemas/DisplayName' + Description: + $ref: '#/components/schemas/Description' + AttributeDetails: + $ref: '#/components/schemas/AttributeDetails' + Conditions: + $ref: '#/components/schemas/Conditions' + Statistic: + $ref: '#/components/schemas/Statistic' + UseHistoricalData: + description: Whether to use historical data for the calculated attribute. + type: boolean + CreatedAt: + description: The timestamp of when the calculated attribute definition was created. + type: string + LastUpdatedAt: + description: The timestamp of when the calculated attribute definition was most recently edited. + type: string + Status: + description: The status of the calculated attribute definition. + type: string + enum: + - IN_PROGRESS + - PREPARING + - COMPLETED + - FAILED + Readiness: + $ref: '#/components/schemas/Readiness' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateCalculatedAttributeDefinitionRequest + type: object + required: [] + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The unique name of the domain. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + DeadLetterQueueUrl: + description: The URL of the SQS dead letter queue + type: string + minLength: 0 + maxLength: 255 + DefaultEncryptionKey: + description: The default encryption key + type: string + minLength: 0 + maxLength: 255 + DefaultExpirationDays: + description: The default number of days until the data within the domain expires. + type: integer + minimum: 1 + maximum: 1098 + Matching: + $ref: '#/components/schemas/Matching' + RuleBasedMatching: + $ref: '#/components/schemas/RuleBasedMatching' + Stats: + $ref: '#/components/schemas/DomainStats' + Tags: + description: The tags (keys and values) associated with the domain + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + CreatedAt: + description: The time of this integration got created + type: string + LastUpdatedAt: + description: The time of this integration got last updated at + type: string + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + CreateEventStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The unique name of the domain. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + EventStreamName: + description: The name of the event stream. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 255 + Uri: + $ref: '#/components/schemas/Uri' + EventStreamArn: + description: A unique identifier for the event stream. + type: string + minLength: 1 + maxLength: 255 + Tags: + description: The tags used to organize, track, or control access for this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + CreatedAt: + description: The timestamp of when the export was created. + type: string + State: + description: The operational state of destination stream for export. + type: string + enum: + - RUNNING + - STOPPED + DestinationDetails: + description: Details regarding the Kinesis stream. + type: object + properties: + Uri: + $ref: '#/components/schemas/Uri' + Status: + $ref: '#/components/schemas/Status' + required: + - Uri + - Status + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateEventStreamRequest + type: object + required: [] + CreateEventTriggerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + $ref: '#/components/schemas/DomainName' + EventTriggerName: + $ref: '#/components/schemas/EventTriggerName' + ObjectTypeName: + $ref: '#/components/schemas/ObjectTypeName' + Description: + $ref: '#/components/schemas/Description' + EventTriggerConditions: + $ref: '#/components/schemas/EventTriggerConditions' + EventTriggerLimits: + $ref: '#/components/schemas/EventTriggerLimits' + SegmentFilter: + $ref: '#/components/schemas/SegmentFilter' + CreatedAt: + description: The timestamp of when the event trigger was created. + type: string + LastUpdatedAt: + description: The timestamp of when the event trigger was most recently updated. + type: string + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateEventTriggerRequest + type: object + required: [] + CreateIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The unique name of the domain. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + Uri: + description: The URI of the S3 bucket or any other type of data source. + type: string + minLength: 1 + maxLength: 255 + FlowDefinition: + $ref: '#/components/schemas/FlowDefinition' + ObjectTypeName: + description: The name of the ObjectType defined for the 3rd party data in Profile Service + type: string + pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$ + minLength: 1 + maxLength: 255 + CreatedAt: + description: The time of this integration got created + type: string + LastUpdatedAt: + description: The time of this integration got last updated at + type: string + Tags: + description: The tags (keys and values) associated with the integration + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + ObjectTypeNames: + description: The mapping between 3rd party event types and ObjectType names + type: array + items: + $ref: '#/components/schemas/ObjectTypeMapping' + EventTriggerNames: + description: A list of unique names for active event triggers associated with the integration. + type: array + items: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + x-insertionOrder: false + minItems: 1 + maxItems: 1 + x-stackQL-stringOnly: true + x-title: CreateIntegrationRequest + type: object + required: [] + CreateObjectTypeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The unique name of the domain. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + ObjectTypeName: + description: The name of the profile object type. + type: string + pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$ + minLength: 1 + maxLength: 255 + AllowProfileCreation: + description: Indicates whether a profile should be created when data is received. + type: boolean + Description: + description: Description of the profile object type. + type: string + minLength: 1 + maxLength: 10000 + EncryptionKey: + description: The default encryption key + type: string + minLength: 0 + maxLength: 255 + ExpirationDays: + description: The default number of days until the data within the domain expires. + type: integer + minimum: 1 + maximum: 1098 + Fields: + description: A list of the name and ObjectType field. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/FieldMap' + Keys: + description: A list of unique keys that can be used to map data to the profile. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/KeyMap' + CreatedAt: + description: The time of this integration got created. + type: string + LastUpdatedAt: + description: The time of this integration got last updated at. + type: string + SourceLastUpdatedTimestampFormat: + description: The format of your sourceLastUpdatedTimestamp that was previously set up. + type: string + minLength: 1 + maxLength: 255 + Tags: + description: The tags (keys and values) associated with the integration. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + TemplateId: + description: A unique identifier for the object template. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + MaxProfileObjectCount: + description: The maximum number of profile objects for this object type + type: integer + minimum: 1 + MaxAvailableProfileObjectCount: + description: The maximum available number of profile objects + type: integer + minimum: 0 + x-stackQL-stringOnly: true + x-title: CreateObjectTypeRequest + type: object + required: [] + CreateSegmentDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + description: The time of this segment definition got created. + type: string + format: date-time + Description: + description: The description of the segment definition. + type: string + maxLength: 1000 + minLength: 1 + DisplayName: + description: The display name of the segment definition. + type: string + maxLength: 255 + minLength: 1 + DomainName: + description: The unique name of the domain. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + SegmentDefinitionName: + description: The unique name of the segment definition. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + SegmentGroups: + description: An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. + $ref: '#/components/schemas/SegmentGroup' + SegmentDefinitionArn: + description: The Amazon Resource Name (ARN) of the segment definition. + type: string + maxLength: 255 + minLength: 1 + Tags: + description: The tags used to organize, track, or control access for this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateSegmentDefinitionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + calculated_attribute_definitions: + name: calculated_attribute_definitions + id: awscc.customerprofiles.calculated_attribute_definitions x-cfn-schema-name: CalculatedAttributeDefinition - x-type: get + x-cfn-type-name: AWS::CustomerProfiles::CalculatedAttributeDefinition x-identifiers: - DomainName - CalculatedAttributeName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CalculatedAttributeDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::CalculatedAttributeDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::CalculatedAttributeDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::CalculatedAttributeDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1371,14 +3049,17 @@ components: JSON_EXTRACT(Properties, '$.AttributeDetails') as attribute_details, JSON_EXTRACT(Properties, '$.Conditions') as conditions, JSON_EXTRACT(Properties, '$.Statistic') as statistic, + JSON_EXTRACT(Properties, '$.UseHistoricalData') as use_historical_data, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Readiness') as readiness, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1390,19 +3071,29 @@ components: json_extract_path_text(Properties, 'AttributeDetails') as attribute_details, json_extract_path_text(Properties, 'Conditions') as conditions, json_extract_path_text(Properties, 'Statistic') as statistic, + json_extract_path_text(Properties, 'UseHistoricalData') as use_historical_data, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Readiness') as readiness, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' AND data__Identifier = '|' AND region = 'us-east-1' - domains: - name: domains - id: awscc.customerprofiles.domains - x-cfn-schema-name: Domain - x-type: list + calculated_attribute_definitions_list_only: + name: calculated_attribute_definitions_list_only + id: awscc.customerprofiles.calculated_attribute_definitions_list_only + x-cfn-schema-name: CalculatedAttributeDefinition + x-cfn-type-name: AWS::CustomerProfiles::CalculatedAttributeDefinition x-identifiers: - DomainName + - CalculatedAttributeName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1410,28 +3101,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.CalculatedAttributeName') as calculated_attribute_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'CalculatedAttributeName') as calculated_attribute_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' AND region = 'us-east-1' - domain: - name: domain - id: awscc.customerprofiles.domain + domains: + name: domains + id: awscc.customerprofiles.domains x-cfn-schema-name: Domain - x-type: get + x-cfn-type-name: AWS::CustomerProfiles::Domain x-identifiers: - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1450,7 +3191,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1468,14 +3209,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' AND data__Identifier = '' AND region = 'us-east-1' - event_streams: - name: event_streams - id: awscc.customerprofiles.event_streams - x-cfn-schema-name: EventStream - x-type: list + domains_list_only: + name: domains_list_only + id: awscc.customerprofiles.domains_list_only + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::CustomerProfiles::Domain x-identifiers: - DomainName - - EventStreamName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1483,31 +3229,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.EventStreamName') as event_stream_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'EventStreamName') as event_stream_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' AND region = 'us-east-1' - event_stream: - name: event_stream - id: awscc.customerprofiles.event_stream + event_streams: + name: event_streams + id: awscc.customerprofiles.event_streams x-cfn-schema-name: EventStream - x-type: get + x-cfn-type-name: AWS::CustomerProfiles::EventStream x-identifiers: - DomainName - EventStreamName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventStream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::EventStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::EventStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::EventStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_streams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1524,7 +3316,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1540,14 +3332,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' AND data__Identifier = '|' AND region = 'us-east-1' - integrations: - name: integrations - id: awscc.customerprofiles.integrations - x-cfn-schema-name: Integration - x-type: list + event_streams_list_only: + name: event_streams_list_only + id: awscc.customerprofiles.event_streams_list_only + x-cfn-schema-name: EventStream + x-cfn-type-name: AWS::CustomerProfiles::EventStream x-identifiers: - DomainName - - Uri + - EventStreamName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1556,8 +3354,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.Uri') as uri - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' + JSON_EXTRACT(Properties, '$.EventStreamName') as event_stream_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1565,21 +3363,199 @@ components: SELECT region, json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Uri') as uri - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' + json_extract_path_text(Properties, 'EventStreamName') as event_stream_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' + AND region = 'us-east-1' + event_triggers: + name: event_triggers + id: awscc.customerprofiles.event_triggers + x-cfn-schema-name: EventTrigger + x-cfn-type-name: AWS::CustomerProfiles::EventTrigger + x-identifiers: + - DomainName + - EventTriggerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventTrigger&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::EventTrigger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::EventTrigger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::EventTrigger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_triggers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_triggers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_triggers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.EventTriggerName') as event_trigger_name, + JSON_EXTRACT(Properties, '$.ObjectTypeName') as object_type_name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.EventTriggerConditions') as event_trigger_conditions, + JSON_EXTRACT(Properties, '$.EventTriggerLimits') as event_trigger_limits, + JSON_EXTRACT(Properties, '$.SegmentFilter') as segment_filter, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::EventTrigger' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'EventTriggerName') as event_trigger_name, + json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EventTriggerConditions') as event_trigger_conditions, + json_extract_path_text(Properties, 'EventTriggerLimits') as event_trigger_limits, + json_extract_path_text(Properties, 'SegmentFilter') as segment_filter, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::EventTrigger' + AND data__Identifier = '|' + AND region = 'us-east-1' + event_triggers_list_only: + name: event_triggers_list_only + id: awscc.customerprofiles.event_triggers_list_only + x-cfn-schema-name: EventTrigger + x-cfn-type-name: AWS::CustomerProfiles::EventTrigger + x-identifiers: + - DomainName + - EventTriggerName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.EventTriggerName') as event_trigger_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventTrigger' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'EventTriggerName') as event_trigger_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventTrigger' AND region = 'us-east-1' - integration: - name: integration - id: awscc.customerprofiles.integration + integrations: + name: integrations + id: awscc.customerprofiles.integrations x-cfn-schema-name: Integration - x-type: get + x-cfn-type-name: AWS::CustomerProfiles::Integration x-identifiers: - DomainName - Uri + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1591,12 +3567,13 @@ components: JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ObjectTypeNames') as object_type_names + JSON_EXTRACT(Properties, '$.ObjectTypeNames') as object_type_names, + JSON_EXTRACT(Properties, '$.EventTriggerNames') as event_trigger_names FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1608,18 +3585,25 @@ components: json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ObjectTypeNames') as object_type_names + json_extract_path_text(Properties, 'ObjectTypeNames') as object_type_names, + json_extract_path_text(Properties, 'EventTriggerNames') as event_trigger_names FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' AND data__Identifier = '|' AND region = 'us-east-1' - object_types: - name: object_types - id: awscc.customerprofiles.object_types - x-cfn-schema-name: ObjectType - x-type: list + integrations_list_only: + name: integrations_list_only + id: awscc.customerprofiles.integrations_list_only + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::CustomerProfiles::Integration x-identifiers: - DomainName - - ObjectTypeName + - Uri + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1628,8 +3612,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.ObjectTypeName') as object_type_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' + JSON_EXTRACT(Properties, '$.Uri') as uri + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1637,21 +3621,69 @@ components: SELECT region, json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' + json_extract_path_text(Properties, 'Uri') as uri + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' AND region = 'us-east-1' - object_type: - name: object_type - id: awscc.customerprofiles.object_type + object_types: + name: object_types + id: awscc.customerprofiles.object_types x-cfn-schema-name: ObjectType - x-type: get + x-cfn-type-name: AWS::CustomerProfiles::ObjectType x-identifiers: - DomainName - ObjectTypeName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ObjectType&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::ObjectType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::ObjectType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::ObjectType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/object_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/object_types/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/object_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1668,12 +3700,14 @@ components: JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, JSON_EXTRACT(Properties, '$.SourceLastUpdatedTimestampFormat') as source_last_updated_timestamp_format, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TemplateId') as template_id + JSON_EXTRACT(Properties, '$.TemplateId') as template_id, + JSON_EXTRACT(Properties, '$.MaxProfileObjectCount') as max_profile_object_count, + JSON_EXTRACT(Properties, '$.MaxAvailableProfileObjectCount') as max_available_profile_object_count FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1690,7 +3724,616 @@ components: json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, json_extract_path_text(Properties, 'SourceLastUpdatedTimestampFormat') as source_last_updated_timestamp_format, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateId') as template_id + json_extract_path_text(Properties, 'TemplateId') as template_id, + json_extract_path_text(Properties, 'MaxProfileObjectCount') as max_profile_object_count, + json_extract_path_text(Properties, 'MaxAvailableProfileObjectCount') as max_available_profile_object_count FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' AND data__Identifier = '|' AND region = 'us-east-1' + object_types_list_only: + name: object_types_list_only + id: awscc.customerprofiles.object_types_list_only + x-cfn-schema-name: ObjectType + x-cfn-type-name: AWS::CustomerProfiles::ObjectType + x-identifiers: + - DomainName + - ObjectTypeName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.ObjectTypeName') as object_type_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' + AND region = 'us-east-1' + segment_definitions: + name: segment_definitions + id: awscc.customerprofiles.segment_definitions + x-cfn-schema-name: SegmentDefinition + x-cfn-type-name: AWS::CustomerProfiles::SegmentDefinition + x-identifiers: + - DomainName + - SegmentDefinitionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SegmentDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::SegmentDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::SegmentDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::CustomerProfiles::SegmentDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/segment_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/segment_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/segment_definitions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.SegmentDefinitionName') as segment_definition_name, + JSON_EXTRACT(Properties, '$.SegmentGroups') as segment_groups, + JSON_EXTRACT(Properties, '$.SegmentDefinitionArn') as segment_definition_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::SegmentDefinition' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'SegmentDefinitionName') as segment_definition_name, + json_extract_path_text(Properties, 'SegmentGroups') as segment_groups, + json_extract_path_text(Properties, 'SegmentDefinitionArn') as segment_definition_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::SegmentDefinition' + AND data__Identifier = '|' + AND region = 'us-east-1' + segment_definitions_list_only: + name: segment_definitions_list_only + id: awscc.customerprofiles.segment_definitions_list_only + x-cfn-schema-name: SegmentDefinition + x-cfn-type-name: AWS::CustomerProfiles::SegmentDefinition + x-identifiers: + - DomainName + - SegmentDefinitionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.SegmentDefinitionName') as segment_definition_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::SegmentDefinition' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'SegmentDefinitionName') as segment_definition_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::SegmentDefinition' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CalculatedAttributeDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCalculatedAttributeDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCalculatedAttributeDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventStream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventTrigger&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventTrigger + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventTriggerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ObjectType&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateObjectType + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateObjectTypeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SegmentDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSegmentDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSegmentDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/databrew.yaml b/providers/src/awscc/v00.00.00000/services/databrew.yaml index 7cb399a4..1cdb2c8d 100644 --- a/providers/src/awscc/v00.00.00000/services/databrew.yaml +++ b/providers/src/awscc/v00.00.00000/services/databrew.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DataBrew - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: JsonOptions: description: Json options @@ -122,6 +502,11 @@ components: description: 'Arn of the source of the dataset. For e.g.: AppFlow Flow ARN.' type: string additionalProperties: false + BucketOwner: + description: Bucket owner + type: string + minLength: 12 + maxLength: 12 PathOptions: description: Path options for dataset type: object @@ -294,6 +679,13 @@ components: Input: description: Input $ref: '#/components/schemas/Input' + Source: + description: Source type of the dataset + type: string + enum: + - S3 + - DATA-CATALOG + - DATABASE PathOptions: description: PathOptions $ref: '#/components/schemas/PathOptions' @@ -307,14 +699,29 @@ components: - Name - Input x-stackql-resource-name: dataset - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataBrew::Dataset. + x-type-name: AWS::DataBrew::Dataset + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - - Tags + x-required-properties: + - Name + - Input + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - databrew:TagResource + - databrew:UntagResource + - databrew:ListTagsForResource x-required-permissions: create: - databrew:CreateDataset + - databrew:DescribeDataset - databrew:TagResource - databrew:UntagResource - glue:GetConnection @@ -322,10 +729,11 @@ components: - iam:PassRole read: - databrew:DescribeDataset - - databrew:ListTagsForResource - iam:ListRoles update: - databrew:UpdateDataset + - databrew:TagResource + - databrew:UntagResource - glue:GetConnection - glue:GetTable delete: @@ -501,14 +909,29 @@ components: - Name - Steps x-stackql-resource-name: recipe - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataBrew::Recipe. + x-type-name: AWS::DataBrew::Recipe + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - - Tags + x-required-properties: + - Name + - Steps + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - databrew:TagResource + - databrew:UntagResource + - databrew:ListTagsForResource x-required-permissions: create: - databrew:CreateRecipe + - databrew:DescribeRecipe - databrew:TagResource - databrew:UntagResource - iam:PassRole @@ -520,10 +943,11 @@ components: - databrew:DeleteRecipeVersion list: - databrew:ListRecipes - - databrew:ListTagsForResource - iam:ListRoles update: - databrew:UpdateRecipe + - databrew:TagResource + - databrew:UntagResource SampleMode: description: Sample configuration mode for profile jobs. enum: @@ -773,26 +1197,43 @@ components: - RoleArn - Type x-stackql-resource-name: job - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataBrew::Job. + x-type-name: AWS::DataBrew::Job + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - Type - - Tags + x-required-properties: + - Name + - RoleArn + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - databrew:TagResource + - databrew:UntagResource + - databrew:ListTagsForResource x-required-permissions: create: - databrew:CreateProfileJob - databrew:CreateRecipeJob + - databrew:DescribeJob - databrew:TagResource - databrew:UntagResource - iam:PassRole read: - databrew:DescribeJob - - databrew:ListTagsForResource - iam:ListRoles update: - databrew:UpdateProfileJob - databrew:UpdateRecipeJob + - databrew:TagResource + - databrew:UntagResource - iam:PassRole delete: - databrew:DeleteJob @@ -853,23 +1294,41 @@ components: - RecipeName - RoleArn x-stackql-resource-name: project - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataBrew::Project. + x-type-name: AWS::DataBrew::Project + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - - Tags + x-required-properties: + - DatasetName + - Name + - RecipeName + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - databrew:TagResource + - databrew:UntagResource + - databrew:ListTagsForResource x-required-permissions: create: - databrew:CreateProject + - databrew:DescribeProject - databrew:TagResource - databrew:UntagResource - iam:PassRole read: - databrew:DescribeProject - - databrew:ListTagsForResource - iam:ListRoles update: - databrew:UpdateProject + - databrew:TagResource + - databrew:UntagResource - iam:PassRole delete: - databrew:DeleteProject @@ -1290,23 +1749,41 @@ components: - TargetArn - Rules x-stackql-resource-name: ruleset - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataBrew::Ruleset. + x-type-name: AWS::DataBrew::Ruleset + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - TargetArn + x-required-properties: + - Name + - TargetArn + - Rules + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - databrew:TagResource + - databrew:UntagResource + - databrew:ListTagsForResource x-required-permissions: create: - databrew:CreateRuleset + - databrew:DescribeRuleset - databrew:TagResource - databrew:UntagResource - iam:PassRole read: - databrew:DescribeRuleset - - databrew:ListTagsForResource - iam:ListRoles update: - databrew:UpdateRuleset + - databrew:TagResource + - databrew:UntagResource delete: - databrew:DeleteRuleset list: @@ -1347,66 +1824,436 @@ components: - Name - CronExpression x-stackql-resource-name: schedule - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataBrew::Schedule. + x-type-name: AWS::DataBrew::Schedule + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - - Tags + x-required-properties: + - Name + - CronExpression + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - databrew:TagResource + - databrew:UntagResource + - databrew:ListTagsForResource x-required-permissions: create: - databrew:CreateSchedule + - databrew:DescribeSchedule - databrew:TagResource - databrew:UntagResource - iam:PassRole read: - databrew:DescribeSchedule - - databrew:ListTagsForResource - iam:ListRoles update: - databrew:UpdateSchedule + - databrew:TagResource + - databrew:UntagResource delete: - databrew:DeleteSchedule list: - databrew:ListSchedules - databrew:ListTagsForResource - iam:ListRoles + CreateDatasetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Dataset name + type: string + minLength: 1 + maxLength: 255 + Format: + description: Dataset format + enum: + - CSV + - JSON + - PARQUET + - EXCEL + - ORC + type: string + FormatOptions: + description: Format options for dataset + $ref: '#/components/schemas/FormatOptions' + Input: + description: Input + $ref: '#/components/schemas/Input' + Source: + description: Source type of the dataset + type: string + enum: + - S3 + - DATA-CATALOG + - DATABASE + PathOptions: + description: PathOptions + $ref: '#/components/schemas/PathOptions' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDatasetRequest + type: object + required: [] + CreateRecipeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: Description of the recipe + minLength: 0 + maxLength: 1024 + type: string + Name: + description: Recipe name + type: string + minLength: 1 + maxLength: 255 + Steps: + type: array + x-insertionOrder: true + items: + type: object + $ref: '#/components/schemas/RecipeStep' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRecipeRequest + type: object + required: [] + CreateJobRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatasetName: + description: Dataset name + type: string + minLength: 1 + maxLength: 255 + EncryptionKeyArn: + description: Encryption Key Arn + type: string + minLength: 20 + maxLength: 2048 + EncryptionMode: + description: Encryption mode + enum: + - SSE-KMS + - SSE-S3 + type: string + Name: + description: Job name + type: string + minLength: 1 + maxLength: 255 + Type: + description: Job type + enum: + - PROFILE + - RECIPE + type: string + LogSubscription: + description: Log subscription + enum: + - ENABLE + - DISABLE + type: string + MaxCapacity: + description: Max capacity + type: integer + MaxRetries: + description: Max retries + type: integer + Outputs: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Output' + DataCatalogOutputs: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/DataCatalogOutput' + DatabaseOutputs: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/DatabaseOutput' + OutputLocation: + description: Output location + $ref: '#/components/schemas/OutputLocation' + ProjectName: + description: Project name + type: string + minLength: 1 + maxLength: 255 + Recipe: + $ref: '#/components/schemas/Recipe' + RoleArn: + description: Role arn + type: string + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Timeout: + description: Timeout + type: integer + JobSample: + description: Job Sample + $ref: '#/components/schemas/JobSample' + ProfileConfiguration: + description: Profile Job configuration + $ref: '#/components/schemas/ProfileConfiguration' + ValidationConfigurations: + description: Data quality rules configuration + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/ValidationConfiguration' + x-stackQL-stringOnly: true + x-title: CreateJobRequest + type: object + required: [] + CreateProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatasetName: + description: Dataset name + type: string + minLength: 1 + maxLength: 255 + Name: + description: Project name + type: string + minLength: 1 + maxLength: 255 + RecipeName: + description: Recipe name + type: string + minLength: 1 + maxLength: 255 + RoleArn: + description: Role arn + type: string + Sample: + description: Sample + $ref: '#/components/schemas/Sample' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateProjectRequest + type: object + required: [] + CreateRulesetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the Ruleset + type: string + minLength: 1 + maxLength: 255 + Description: + description: Description of the Ruleset + type: string + maxLength: 1024 + TargetArn: + description: Arn of the target resource (dataset) to apply the ruleset to + type: string + minLength: 20 + maxLength: 2048 + Rules: + description: List of the data quality rules in the ruleset + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Rule' + minItems: 1 + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRulesetRequest + type: object + required: [] + CreateScheduleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + JobNames: + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/JobName' + CronExpression: + description: Schedule cron + type: string + minLength: 1 + maxLength: 512 + Name: + description: Schedule Name + type: string + minLength: 1 + maxLength: 255 + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateScheduleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: datasets: name: datasets id: awscc.databrew.datasets x-cfn-schema-name: Dataset - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: awscc.databrew.dataset - x-cfn-schema-name: Dataset - x-type: get + x-cfn-type-name: AWS::DataBrew::Dataset x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1415,13 +2262,14 @@ components: JSON_EXTRACT(Properties, '$.Format') as _format, JSON_EXTRACT(Properties, '$.FormatOptions') as format_options, JSON_EXTRACT(Properties, '$.Input') as input, + JSON_EXTRACT(Properties, '$.Source') as source, JSON_EXTRACT(Properties, '$.PathOptions') as path_options, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Dataset' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1430,18 +2278,25 @@ components: json_extract_path_text(Properties, 'Format') as _format, json_extract_path_text(Properties, 'FormatOptions') as format_options, json_extract_path_text(Properties, 'Input') as input, + json_extract_path_text(Properties, 'Source') as source, json_extract_path_text(Properties, 'PathOptions') as path_options, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Dataset' AND data__Identifier = '' AND region = 'us-east-1' - recipes: - name: recipes - id: awscc.databrew.recipes - x-cfn-schema-name: Recipe - x-type: list + datasets_list_only: + name: datasets_list_only + id: awscc.databrew.datasets_list_only + x-cfn-schema-name: Dataset + x-cfn-type-name: AWS::DataBrew::Dataset x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1450,7 +2305,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1458,19 +2313,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' AND region = 'us-east-1' - recipe: - name: recipe - id: awscc.databrew.recipe + recipes: + name: recipes + id: awscc.databrew.recipes x-cfn-schema-name: Recipe - x-type: get + x-cfn-type-name: AWS::DataBrew::Recipe x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Recipe&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Recipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Recipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Recipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/recipes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/recipes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/recipes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1483,7 +2386,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1495,13 +2398,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Recipe' AND data__Identifier = '' AND region = 'us-east-1' - jobs: - name: jobs - id: awscc.databrew.jobs - x-cfn-schema-name: Job - x-type: list + recipes_list_only: + name: recipes_list_only + id: awscc.databrew.recipes_list_only + x-cfn-schema-name: Recipe + x-cfn-type-name: AWS::DataBrew::Recipe x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1510,7 +2419,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1518,19 +2427,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' AND region = 'us-east-1' - job: - name: job - id: awscc.databrew.job + jobs: + name: jobs + id: awscc.databrew.jobs x-cfn-schema-name: Job - x-type: get + x-cfn-type-name: AWS::DataBrew::Job x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Job&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Job" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Job" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Job" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1559,7 +2516,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1587,13 +2544,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Job' AND data__Identifier = '' AND region = 'us-east-1' - projects: - name: projects - id: awscc.databrew.projects - x-cfn-schema-name: Project - x-type: list + jobs_list_only: + name: jobs_list_only + id: awscc.databrew.jobs_list_only + x-cfn-schema-name: Job + x-cfn-type-name: AWS::DataBrew::Job x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1602,7 +2565,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1610,19 +2573,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' AND region = 'us-east-1' - project: - name: project - id: awscc.databrew.project + projects: + name: projects + id: awscc.databrew.projects x-cfn-schema-name: Project - x-type: get + x-cfn-type-name: AWS::DataBrew::Project x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1637,7 +2648,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1651,13 +2662,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Project' AND data__Identifier = '' AND region = 'us-east-1' - rulesets: - name: rulesets - id: awscc.databrew.rulesets - x-cfn-schema-name: Ruleset - x-type: list + projects_list_only: + name: projects_list_only + id: awscc.databrew.projects_list_only + x-cfn-schema-name: Project + x-cfn-type-name: AWS::DataBrew::Project x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1666,7 +2683,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1674,19 +2691,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' AND region = 'us-east-1' - ruleset: - name: ruleset - id: awscc.databrew.ruleset + rulesets: + name: rulesets + id: awscc.databrew.rulesets x-cfn-schema-name: Ruleset - x-type: get + x-cfn-type-name: AWS::DataBrew::Ruleset x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Ruleset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Ruleset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Ruleset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Ruleset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1700,7 +2765,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1713,13 +2778,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Ruleset' AND data__Identifier = '' AND region = 'us-east-1' - schedules: - name: schedules - id: awscc.databrew.schedules - x-cfn-schema-name: Schedule - x-type: list + rulesets_list_only: + name: rulesets_list_only + id: awscc.databrew.rulesets_list_only + x-cfn-schema-name: Ruleset + x-cfn-type-name: AWS::DataBrew::Ruleset x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1728,7 +2799,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1736,19 +2807,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' AND region = 'us-east-1' - schedule: - name: schedule - id: awscc.databrew.schedule + schedules: + name: schedules + id: awscc.databrew.schedules x-cfn-schema-name: Schedule - x-type: get + x-cfn-type-name: AWS::DataBrew::Schedule x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Schedule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Schedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Schedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataBrew::Schedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1761,7 +2880,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1773,3 +2892,439 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Schedule' AND data__Identifier = '' AND region = 'us-east-1' + schedules_list_only: + name: schedules_list_only + id: awscc.databrew.schedules_list_only + x-cfn-schema-name: Schedule + x-cfn-type-name: AWS::DataBrew::Schedule + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Recipe&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRecipe + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRecipeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Job&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateJob + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateJobRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Ruleset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRuleset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRulesetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Schedule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchedule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/datapipeline.yaml b/providers/src/awscc/v00.00.00000/services/datapipeline.yaml index efa85ddb..04350240 100644 --- a/providers/src/awscc/v00.00.00000/services/datapipeline.yaml +++ b/providers/src/awscc/v00.00.00000/services/datapipeline.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DataPipeline - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ParameterObject: type: object @@ -142,13 +522,26 @@ components: required: - Name x-stackql-resource-name: pipeline - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::DataPipeline::Pipeline + x-stackql-primary-identifier: - PipelineId x-create-only-properties: - Description - Name x-read-only-properties: - PipelineId + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/PipelineTags + permissions: + - datapipeline:AddTags + - datapipeline:RemoveTags x-required-permissions: create: - datapipeline:CreatePipeline @@ -181,43 +574,129 @@ components: - datapipeline:RemoveTags list: - datapipeline:ListPipelines + CreatePipelineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Activate: + description: Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true. + type: boolean + Description: + description: A description of the pipeline. + type: string + Name: + description: The name of the pipeline. + type: string + ParameterObjects: + description: The parameter objects used with the pipeline. + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ParameterObject' + ParameterValues: + description: The parameter values used with the pipeline. + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ParameterValue' + PipelineObjects: + description: The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide. + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PipelineObject' + PipelineTags: + description: A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide. + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PipelineTag' + PipelineId: + type: string + x-stackQL-stringOnly: true + x-title: CreatePipelineRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: pipelines: name: pipelines id: awscc.datapipeline.pipelines x-cfn-schema-name: Pipeline - x-type: list - x-identifiers: - - PipelineId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PipelineId') as pipeline_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PipelineId') as pipeline_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' - AND region = 'us-east-1' - pipeline: - name: pipeline - id: awscc.datapipeline.pipeline - x-cfn-schema-name: Pipeline - x-type: get + x-cfn-type-name: AWS::DataPipeline::Pipeline x-identifiers: - PipelineId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataPipeline::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataPipeline::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataPipeline::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -234,7 +713,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -250,3 +729,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' AND data__Identifier = '' AND region = 'us-east-1' + pipelines_list_only: + name: pipelines_list_only + id: awscc.datapipeline.pipelines_list_only + x-cfn-schema-name: Pipeline + x-cfn-type-name: AWS::DataPipeline::Pipeline + x-identifiers: + - PipelineId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PipelineId') as pipeline_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineId') as pipeline_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePipeline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePipelineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/datasync.yaml b/providers/src/awscc/v00.00.00000/services/datasync.yaml index 1cd7d251..56617967 100644 --- a/providers/src/awscc/v00.00.00000/services/datasync.yaml +++ b/providers/src/awscc/v00.00.00000/services/datasync.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DataSync - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: additionalProperties: false @@ -33,7 +413,7 @@ components: type: string pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ maxLength: 256 - minLength: 1 + minLength: 0 ActivationKey: description: Activation key of the Agent. type: string @@ -81,16 +461,31 @@ components: maxLength: 128 required: [] x-stackql-resource-name: agent - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::Agent. + x-type-name: AWS::DataSync::Agent + x-stackql-primary-identifier: - AgentArn x-create-only-properties: - ActivationKey - SecurityGroupArns - SubnetArns - VpcEndpointId + x-write-only-properties: + - ActivationKey x-read-only-properties: - AgentArn - EndpointType + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateAgent @@ -127,11 +522,56 @@ components: maxLength: 255 required: - AzureBlobSasToken + CmkSecretConfig: + additionalProperties: false + description: Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key. + type: object + properties: + SecretArn: + description: Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync. + type: string + pattern: ^(arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$ + maxLength: 2048 + KmsKeyArn: + description: Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager. + type: string + pattern: ^(arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$ + maxLength: 2048 + CustomSecretConfig: + additionalProperties: false + description: Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret. + type: object + properties: + SecretArn: + description: Specifies the ARN for a customer created AWS Secrets Manager secret. + type: string + pattern: ^(arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$ + maxLength: 2048 + SecretAccessRoleArn: + description: Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn. + type: string + pattern: ^(arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$ + maxLength: 2048 + required: + - SecretArn + - SecretAccessRoleArn + ManagedSecretConfig: + additionalProperties: false + description: Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. + type: object + properties: + SecretArn: + description: Specifies the ARN for an AWS Secrets Manager secret. + type: string + pattern: ^(arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$ + maxLength: 2048 + required: + - SecretArn LocationAzureBlob: type: object properties: AgentArns: - description: The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location. + description: Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. type: array items: type: string @@ -145,6 +585,7 @@ components: type: string enum: - SAS + - NONE default: SAS AzureBlobSasConfiguration: $ref: '#/components/schemas/AzureBlobSasConfiguration' @@ -190,23 +631,56 @@ components: type: string pattern: ^(azure-blob)://[a-zA-Z0-9./\-]+$ maxLength: 4356 + CmkSecretConfig: + $ref: '#/components/schemas/CmkSecretConfig' + CustomSecretConfig: + $ref: '#/components/schemas/CustomSecretConfig' + ManagedSecretConfig: + $ref: '#/components/schemas/ManagedSecretConfig' required: - AzureBlobAuthenticationType - - AgentArns x-stackql-resource-name: location_azure_blob - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::DataSync::LocationAzureBlob. + x-type-name: AWS::DataSync::LocationAzureBlob + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - AzureBlobContainerUrl + x-write-only-properties: + - Subdirectory + - AzureBlobSasConfiguration + - AzureBlobContainerUrl x-read-only-properties: - LocationArn - LocationUri + - ManagedSecretConfig + - CmkSecretConfig/SecretArn + x-required-properties: + - AzureBlobAuthenticationType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationAzureBlob - datasync:DescribeLocationAzureBlob - datasync:TagResource - datasync:ListTagsForResource + - secretsmanager:CreateSecret + - secretsmanager:PutSecretValue + - secretsmanager:DeleteSecret + - iam:CreateServiceLinkedRole + - iam:PassRole + - kms:Encrypt + - kms:Decrypt + - kms:GenerateDataKey read: - datasync:DescribeLocationAzureBlob - datasync:ListTagsForResource @@ -216,8 +690,18 @@ components: - datasync:TagResource - datasync:UntagResource - datasync:UpdateLocationAzureBlob + - secretsmanager:UpdateSecret + - secretsmanager:DeleteSecret + - secretsmanager:PutSecretValue + - secretsmanager:CreateSecret + - iam:CreateServiceLinkedRole + - iam:PassRole + - kms:Encrypt + - kms:Decrypt + - kms:GenerateDataKey delete: - datasync:DeleteLocation + - secretsmanager:DeleteSecret list: - datasync:ListLocations Ec2Config: @@ -295,18 +779,31 @@ components: required: - Ec2Config x-stackql-resource-name: location_efs - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationEFS. + x-type-name: AWS::DataSync::LocationEFS + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - Ec2Config - EfsFilesystemArn + x-write-only-properties: + - EfsFilesystemArn - Subdirectory - - FileSystemAccessRoleArn - - InTransitEncryption - - AccessPointArn x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - Ec2Config + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationEfs @@ -323,10 +820,14 @@ components: - datasync:DescribeLocationEfs - datasync:ListTagsForResource update: + - datasync:UpdateLocationEfs - datasync:DescribeLocationEfs - datasync:ListTagsForResource - datasync:TagResource - datasync:UntagResource + - elasticfilesystem:DescribeFileSystems + - elasticfilesystem:DescribeAccessPoints + - iam:PassRole delete: - datasync:DeleteLocation list: @@ -376,15 +877,31 @@ components: required: - SecurityGroupArns x-stackql-resource-name: locationf_sx_lustre - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationFSxLustre. + x-type-name: AWS::DataSync::LocationFSxLustre + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - FsxFilesystemArn - SecurityGroupArns + x-write-only-properties: - Subdirectory + - FsxFilesystemArn x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - SecurityGroupArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationFsxLustre @@ -401,8 +918,11 @@ components: update: - datasync:DescribeLocationFsxLustre - datasync:ListTagsForResource + - datasync:UpdateLocationFsxLustre - datasync:TagResource - datasync:UntagResource + - fsx:DescribeFileSystems + - ec2:DescribeNetworkInterfaces delete: - datasync:DeleteLocation list: @@ -527,17 +1047,33 @@ components: - SecurityGroupArns - StorageVirtualMachineArn x-stackql-resource-name: locationf_sx_ontap - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationFSxONTAP. + x-type-name: AWS::DataSync::LocationFSxONTAP + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - StorageVirtualMachineArn - SecurityGroupArns + x-write-only-properties: - Protocol - Subdirectory x-read-only-properties: - LocationArn - LocationUri - FsxFilesystemArn + x-required-properties: + - SecurityGroupArns + - StorageVirtualMachineArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationFsxOntap @@ -553,10 +1089,14 @@ components: - datasync:DescribeLocationFsxOntap - datasync:ListTagsForResource update: + - datasync:UpdateLocationFsxOntap - datasync:DescribeLocationFsxOntap - datasync:ListTagsForResource - datasync:TagResource - datasync:UntagResource + - fsx:DescribeFileSystems + - fsx:DescribeStorageVirtualMachines + - ec2:DescribeNetworkInterfaces delete: - datasync:DeleteLocation list: @@ -623,16 +1163,32 @@ components: - SecurityGroupArns - Protocol x-stackql-resource-name: locationf_sx_open_zfs - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationFSxOpenZFS. + x-type-name: AWS::DataSync::LocationFSxOpenZFS + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - FsxFilesystemArn - SecurityGroupArns - - Protocol + x-write-only-properties: - Subdirectory + - FsxFilesystemArn x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - SecurityGroupArns + - Protocol + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationFsxOpenZfs @@ -648,9 +1204,12 @@ components: - datasync:ListTagsForResource update: - datasync:DescribeLocationFsxOpenZfs + - datasync:UpdateLocationFsxOpenZfs - datasync:ListTagsForResource - datasync:TagResource - datasync:UntagResource + - fsx:DescribeFileSystems + - ec2:DescribeNetworkInterfaces delete: - datasync:DeleteLocation list: @@ -713,18 +1272,33 @@ components: - User - SecurityGroupArns x-stackql-resource-name: locationf_sx_windows - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationFSxWindows. + x-type-name: AWS::DataSync::LocationFSxWindows + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - - Domain - FsxFilesystemArn - - Password - SecurityGroupArns + x-write-only-properties: + - Password - Subdirectory - - User + - FsxFilesystemArn x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - User + - SecurityGroupArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationFsxWindows @@ -740,9 +1314,12 @@ components: - datasync:ListTagsForResource update: - datasync:DescribeLocationFsxWindows + - datasync:UpdateLocationFsxWindows - datasync:ListTagsForResource - datasync:TagResource - datasync:UntagResource + - fsx:DescribeFileSystems + - ec2:DescribeNetworkInterfaces delete: - datasync:DeleteLocation list: @@ -883,11 +1460,31 @@ components: - AuthenticationType - AgentArns x-stackql-resource-name: location_hdfs - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationHDFS. + x-type-name: AWS::DataSync::LocationHDFS + x-stackql-primary-identifier: - LocationArn + x-write-only-properties: + - Subdirectory + - KerberosKeytab + - KerberosKrb5Conf x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - NameNodes + - AuthenticationType + - AgentArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationHdfs @@ -964,13 +1561,28 @@ components: required: - OnPremConfig x-stackql-resource-name: location_nfs - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationNFS + x-type-name: AWS::DataSync::LocationNFS + x-stackql-primary-identifier: - LocationArn - x-create-only-properties: + x-write-only-properties: - ServerHostname + - Subdirectory x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - OnPremConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationNfs @@ -1000,7 +1612,7 @@ components: maxLength: 200 pattern: ^.+$ AgentArns: - description: The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location. + description: Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. type: array items: type: string @@ -1064,23 +1676,53 @@ components: type: string pattern: ^(efs|nfs|s3|smb|fsxw|object-storage)://[a-zA-Z0-9./\-]+$ maxLength: 4356 - required: - - AgentArns + CmkSecretConfig: + $ref: '#/components/schemas/CmkSecretConfig' + CustomSecretConfig: + $ref: '#/components/schemas/CustomSecretConfig' + ManagedSecretConfig: + $ref: '#/components/schemas/ManagedSecretConfig' x-stackql-resource-name: location_object_storage - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::DataSync::LocationObjectStorage. + x-type-name: AWS::DataSync::LocationObjectStorage + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - BucketName + x-write-only-properties: + - SecretKey + - BucketName - ServerHostname + - Subdirectory x-read-only-properties: - LocationArn - LocationUri + - ManagedSecretConfig + - CmkSecretConfig/SecretArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationObjectStorage - datasync:DescribeLocationObjectStorage - datasync:ListTagsForResource - datasync:TagResource + - secretsmanager:CreateSecret + - secretsmanager:PutSecretValue + - secretsmanager:DeleteSecret + - iam:CreateServiceLinkedRole + - iam:PassRole + - kms:Encrypt + - kms:Decrypt + - kms:GenerateDataKey read: - datasync:DescribeLocationObjectStorage - datasync:ListTagsForResource @@ -1090,8 +1732,18 @@ components: - datasync:TagResource - datasync:UntagResource - datasync:UpdateLocationObjectStorage + - secretsmanager:UpdateSecret + - secretsmanager:DeleteSecret + - secretsmanager:PutSecretValue + - secretsmanager:CreateSecret + - iam:CreateServiceLinkedRole + - iam:PassRole + - kms:Encrypt + - kms:Decrypt + - kms:GenerateDataKey delete: - datasync:DeleteLocation + - secretsmanager:DeleteSecret list: - datasync:ListLocations S3Config: @@ -1154,16 +1806,30 @@ components: required: - S3Config x-stackql-resource-name: location_s3 - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationS3 + x-type-name: AWS::DataSync::LocationS3 + x-stackql-primary-identifier: - LocationArn x-create-only-properties: - - S3Config - - S3StorageClass + - S3BucketArn + x-write-only-properties: - Subdirectory - S3BucketArn x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - S3Config + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationS3 @@ -1182,6 +1848,8 @@ components: - datasync:ListTagsForResource - datasync:TagResource - datasync:UntagResource + - datasync:UpdateLocationS3 + - iam:PassRole delete: - datasync:DeleteLocation list: @@ -1246,17 +1914,65 @@ components: type: string pattern: ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$ maxLength: 4356 + AuthenticationType: + description: The authentication mode used to determine identity of user. + type: string + enum: + - NTLM + - KERBEROS + DnsIpAddresses: + description: Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server. + type: array + items: + type: string + pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z + minLength: 7 + maxLength: 15 + x-insertionOrder: true + default: null + maxItems: 2 + KerberosPrincipal: + description: Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files. + type: string + pattern: ^.+$ + minLength: 1 + maxLength: 256 + KerberosKeytab: + description: The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file. + type: string + maxLength: 87384 + KerberosKrb5Conf: + description: The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file. + type: string + maxLength: 174764 required: - - User - AgentArns x-stackql-resource-name: location_smb - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::LocationSMB. + x-type-name: AWS::DataSync::LocationSMB + x-stackql-primary-identifier: - LocationArn - x-create-only-properties: + x-write-only-properties: + - Password + - Subdirectory - ServerHostname + - KerberosKeytab + - KerberosKrb5Conf x-read-only-properties: - LocationArn - LocationUri + x-required-properties: + - AgentArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateLocationSmb @@ -1276,185 +1992,37 @@ components: - datasync:DeleteLocation list: - datasync:ListLocations - ServerConfiguration: + FilterRule: additionalProperties: false - description: The server name and network port required to connect with the management interface of the on-premises storage system. + description: Specifies which files folders and objects to include or exclude when transferring files from source to destination. type: object properties: - ServerHostname: + FilterType: + description: The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type. type: string - description: The domain name or IP address of the storage system's management interface. - pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$ - maxLength: 255 - ServerPort: - type: integer - description: The network port needed to access the system's management interface - minimum: 1 - maximum: 65535 - required: - - ServerHostname - ServerCredentials: + enum: + - SIMPLE_PATTERN + pattern: ^[A-Z0-9_]+$ + maxLength: 128 + Value: + description: A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|". + type: string + pattern: ^[^\x00]+$ + maxLength: 409600 + TaskReportConfig: additionalProperties: false - description: The username and password for accessing your on-premises storage system's management interface. + description: Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer. type: object properties: - Username: - type: string - description: The username for your storage system's management interface. - maxLength: 1024 - Password: - type: string - description: The password for your storage system's management interface - maxLength: 1024 - required: - - Username - - Password - StorageSystem: - type: object - properties: - ServerConfiguration: - $ref: '#/components/schemas/ServerConfiguration' - ServerCredentials: - $ref: '#/components/schemas/ServerCredentials' - SecretsManagerArn: - description: The ARN of a secret stored by AWS Secrets Manager. - type: string - pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.* - maxLength: 2048 - SystemType: - description: The type of on-premises storage system that DataSync Discovery will analyze. - type: string - enum: - - NetAppONTAP - AgentArns: - description: The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface. - type: array - items: - type: string - pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ - maxLength: 128 - minItems: 1 - maxItems: 1 - x-insertionOrder: false - CloudWatchLogGroupArn: - description: The ARN of the Amazon CloudWatch log group used to monitor and log discovery job events. - type: string - pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$ - maxLength: 562 - Name: - description: A familiar name for the on-premises storage system. - type: string - pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ - minLength: 1 - maxLength: 256 - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - StorageSystemArn: - description: The ARN of the on-premises storage system added to DataSync Discovery. - type: string - pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - maxLength: 128 - ConnectivityStatus: - description: Indicates whether the DataSync agent can access the on-premises storage system. - type: string - enum: - - PASS - - FAIL - - UNKNOWN - required: - - ServerConfiguration - - SystemType - - AgentArns - x-stackql-resource-name: storage_system - x-stackql-primaryIdentifier: - - StorageSystemArn - x-read-only-properties: - - StorageSystemArn - - ConnectivityStatus - - SecretsManagerArn - x-required-permissions: - create: - - datasync:AddStorageSystem - - datasync:DescribeStorageSystem - - datasync:ListTagsForResource - - datasync:TagResource - - secretsmanager:CreateSecret - - secretsmanager:DescribeSecret - - iam:CreateServiceLinkedRole - read: - - datasync:DescribeStorageSystem - - datasync:ListTagsForResource - - secretsmanager:DescribeSecret - update: - - datasync:UpdateStorageSystem - - datasync:DescribeStorageSystem - - datasync:ListTagsForResource - - datasync:TagResource - - datasync:UntagResource - - secretsmanager:DescribeSecret - - secretsmanager:PutSecretValue - delete: - - datasync:DescribeStorageSystem - - datasync:RemoveStorageSystem - - secretsmanager:DescribeSecret - - secretsmanager:DeleteSecret - list: - - datasync:ListStorageSystems - FilterRule: - additionalProperties: false - description: Specifies which files folders and objects to include or exclude when transferring files from source to destination. - type: object - properties: - FilterType: - description: The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type. - type: string - enum: - - SIMPLE_PATTERN - pattern: ^[A-Z0-9_]+$ - maxLength: 128 - Value: - description: A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|". - type: string - pattern: ^[^\x00]+$ - maxLength: 409600 - TaskReportConfig: - additionalProperties: false - description: Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer. - type: object - properties: - Destination: - additionalProperties: false - description: Specifies where DataSync uploads your task report. - type: object - properties: - S3: - additionalProperties: false - description: Specifies the Amazon S3 bucket where DataSync uploads your task report. - type: object - properties: - Subdirectory: - description: Specifies a bucket prefix for your report. - type: string - maxLength: 4096 - pattern: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$ - BucketAccessRoleArn: - description: Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket. - type: string - maxLength: 2048 - pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$ - S3BucketArn: - description: Specifies the ARN of the S3 bucket where Datasync uploads your report. - type: string - maxLength: 156 - pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$ - OutputType: - description: Specifies the type of task report that you want. + Destination: + additionalProperties: false + description: Specifies where DataSync uploads your task report. + type: object + properties: + S3: + $ref: '#/components/schemas/TaskReportConfigDestinationS3' + OutputType: + description: Specifies the type of task report that you want. type: string enum: - SUMMARY_ONLY @@ -1523,6 +2091,75 @@ components: required: - Destination - OutputType + TaskReportConfigDestinationS3: + additionalProperties: false + description: Specifies the Amazon S3 bucket where DataSync uploads your task report. + type: object + properties: + Subdirectory: + description: Specifies a bucket prefix for your report. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$ + BucketAccessRoleArn: + description: Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket. + type: string + maxLength: 2048 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$ + S3BucketArn: + description: Specifies the ARN of the S3 bucket where Datasync uploads your report. + type: string + maxLength: 156 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$ + ManifestConfig: + additionalProperties: false + description: Configures a manifest, which is a list of files or objects that you want DataSync to transfer. + type: object + properties: + Action: + description: Specifies what DataSync uses the manifest for. + type: string + enum: + - TRANSFER + Format: + description: Specifies the file format of your manifest. + type: string + enum: + - CSV + Source: + additionalProperties: false + description: Specifies the manifest that you want DataSync to use and where it's hosted. + type: object + properties: + S3: + $ref: '#/components/schemas/ManifestConfigSourceS3' + required: + - Source + ManifestConfigSourceS3: + additionalProperties: false + description: Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use. + type: object + properties: + ManifestObjectPath: + description: Specifies the Amazon S3 object key of your manifest. + type: string + maxLength: 1024 + pattern: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$ + BucketAccessRoleArn: + description: Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest. + type: string + maxLength: 2048 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$ + S3BucketArn: + description: Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest. + type: string + maxLength: 156 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$ + ManifestObjectVersionId: + description: Specifies the object version ID of the manifest that you want DataSync to use. + type: string + maxLength: 100 + pattern: ^.+$ TaskSchedule: additionalProperties: false description: Specifies the schedule you want your task to use for repeated executions. @@ -1533,8 +2170,12 @@ components: type: string maxLength: 256 pattern: ^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$ - required: - - ScheduleExpression + Status: + description: Specifies status of a schedule. + type: string + enum: + - ENABLED + - DISABLED Options: additionalProperties: false description: Represents the options that are available to control the behavior of a StartTaskExecution operation. @@ -1697,6 +2338,8 @@ components: $ref: '#/components/schemas/Options' TaskReportConfig: $ref: '#/components/schemas/TaskReportConfig' + ManifestConfig: + $ref: '#/components/schemas/ManifestConfig' Schedule: $ref: '#/components/schemas/TaskSchedule' SourceLocationArn: @@ -1709,6 +2352,12 @@ components: type: string maxLength: 128 pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$ + TaskMode: + description: Specifies the task mode for the task. + type: string + enum: + - BASIC + - ENHANCED Status: description: The status of the task that was described. type: string @@ -1726,16 +2375,32 @@ components: - DestinationLocationArn - SourceLocationArn x-stackql-resource-name: task - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DataSync::Task. + x-type-name: AWS::DataSync::Task + x-stackql-primary-identifier: - TaskArn x-create-only-properties: - DestinationLocationArn - SourceLocationArn + - TaskMode x-read-only-properties: - TaskArn - Status - SourceNetworkInterfaceArns - DestinationNetworkInterfaceArns + x-required-properties: + - DestinationLocationArn + - SourceLocationArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - datasync:TagResource + - datasync:UntagResource + - datasync:ListTagsForResource x-required-permissions: create: - datasync:CreateTask @@ -1744,6 +2409,8 @@ components: - datasync:TagResource - s3:ListAllMyBuckets - s3:ListBucket + - s3:GetObject + - s3:GetObjectVersion - ec2:DescribeNetworkInterfaces - ec2:CreateNetworkInterface - ec2:DeleteNetworkInterface @@ -1780,43 +2447,1038 @@ components: - iam:GetRole list: - datasync:ListTasks + CreateAgentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AgentName: + description: The name configured for the agent. Text reference used to identify the agent in the console. + type: string + pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ + maxLength: 256 + minLength: 0 + ActivationKey: + description: Activation key of the Agent. + type: string + pattern: '[A-Z0-9]{5}(-[A-Z0-9]{5}){4}' + maxLength: 29 + SecurityGroupArns: + description: The ARNs of the security group used to protect your data transfer task subnets. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$ + maxLength: 128 + SubnetArns: + description: The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$ + maxLength: 128 + VpcEndpointId: + description: The ID of the VPC endpoint that the agent has access to. + type: string + pattern: ^vpce-[0-9a-f]{17}$ + EndpointType: + description: The service endpoints that the agent will connect to. + type: string + enum: + - FIPS + - PUBLIC + - PRIVATE_LINK + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AgentArn: + description: The DataSync Agent ARN. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ + maxLength: 128 + x-stackQL-stringOnly: true + x-title: CreateAgentRequest + type: object + required: [] + CreateLocationAzureBlobRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AgentArns: + description: Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. + type: array + items: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ + maxLength: 128 + minItems: 1 + maxItems: 4 + x-insertionOrder: false + AzureBlobAuthenticationType: + description: The specific authentication type that you want DataSync to use to access your Azure Blob Container. + type: string + enum: + - SAS + - NONE + default: SAS + AzureBlobSasConfiguration: + $ref: '#/components/schemas/AzureBlobSasConfiguration' + AzureBlobContainerUrl: + description: The URL of the Azure Blob container that was described. + type: string + pattern: ^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$ + maxLength: 325 + AzureBlobType: + description: Specifies a blob type for the objects you're transferring into your Azure Blob Storage container. + type: string + enum: + - BLOCK + default: BLOCK + AzureAccessTier: + description: Specifies an access tier for the objects you're transferring into your Azure Blob Storage container. + type: string + enum: + - HOT + - COOL + - ARCHIVE + default: HOT + Subdirectory: + description: The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location. + type: string + maxLength: 1024 + pattern: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Azure Blob Location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the Azure Blob Location that was described. + type: string + pattern: ^(azure-blob)://[a-zA-Z0-9./\-]+$ + maxLength: 4356 + CmkSecretConfig: + $ref: '#/components/schemas/CmkSecretConfig' + CustomSecretConfig: + $ref: '#/components/schemas/CustomSecretConfig' + ManagedSecretConfig: + $ref: '#/components/schemas/ManagedSecretConfig' + x-stackQL-stringOnly: true + x-title: CreateLocationAzureBlobRequest + type: object + required: [] + CreateLocationEFSRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Ec2Config: + $ref: '#/components/schemas/Ec2Config' + EfsFilesystemArn: + description: The Amazon Resource Name (ARN) for the Amazon EFS file system. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$ + maxLength: 128 + AccessPointArn: + description: The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$ + maxLength: 128 + FileSystemAccessRoleArn: + description: The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$ + maxLength: 128 + InTransitEncryption: + description: Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system. + type: string + enum: + - NONE + - TLS1_2 + Subdirectory: + description: A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the EFS location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\-/]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationEFSRequest + type: object + required: [] + CreateLocationFSxLustreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FsxFilesystemArn: + description: The Amazon Resource Name (ARN) for the FSx for Lustre file system. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$ + SecurityGroupArns: + description: The ARNs of the security groups that are to use to configure the FSx for Lustre file system. + type: array + items: + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$ + maxItems: 5 + minItems: 1 + x-insertionOrder: false + Subdirectory: + description: A subdirectory in the location's path. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + minItems: 0 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the FSx for Lustre location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw|hdfs|fsxl)://[a-zA-Z0-9.:/\-]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationFSxLustreRequest + type: object + required: [] + CreateLocationFSxONTAPRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StorageVirtualMachineArn: + description: The Amazon Resource Name (ARN) for the FSx ONTAP SVM. + type: string + maxLength: 162 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$ + FsxFilesystemArn: + description: The Amazon Resource Name (ARN) for the FSx ONAP file system. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$ + SecurityGroupArns: + description: The ARNs of the security groups that are to use to configure the FSx ONTAP file system. + type: array + items: + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$ + maxItems: 5 + minItems: 1 + x-insertionOrder: false + Protocol: + $ref: '#/components/schemas/Protocol' + Subdirectory: + description: A subdirectory in the location's path. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + minItems: 0 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the FSx ONTAP file system that was described. + type: string + pattern: ^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$ + maxLength: 4360 + x-stackQL-stringOnly: true + x-title: CreateLocationFSxONTAPRequest + type: object + required: [] + CreateLocationFSxOpenZFSRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FsxFilesystemArn: + description: The Amazon Resource Name (ARN) for the FSx OpenZFS file system. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$ + SecurityGroupArns: + description: The ARNs of the security groups that are to use to configure the FSx OpenZFS file system. + type: array + items: + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$ + maxItems: 5 + minItems: 1 + x-insertionOrder: false + Protocol: + $ref: '#/components/schemas/Protocol' + Subdirectory: + description: A subdirectory in the location's path. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + minItems: 0 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the FSx OpenZFS that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw|hdfs|fsxl|fsxz)://[a-zA-Z0-9.:/\-]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationFSxOpenZFSRequest + type: object + required: [] + CreateLocationFSxWindowsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Domain: + description: The name of the Windows domain that the FSx for Windows server belongs to. + type: string + maxLength: 253 + pattern: ^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$ + FsxFilesystemArn: + description: The Amazon Resource Name (ARN) for the FSx for Windows file system. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$ + Password: + description: The password of the user who has the permissions to access files and folders in the FSx for Windows file system. + type: string + maxLength: 104 + pattern: ^.{0,104}$ + SecurityGroupArns: + description: The ARNs of the security groups that are to use to configure the FSx for Windows file system. + type: array + items: + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$ + x-insertionOrder: false + Subdirectory: + description: A subdirectory in the location's path. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + User: + description: The user who has the permissions to access files and folders in the FSx for Windows file system. + type: string + maxLength: 104 + pattern: ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the FSx for Windows location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationFSxWindowsRequest + type: object + required: [] + CreateLocationHDFSRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NameNodes: + description: An array of Name Node(s) of the HDFS location. + type: array + items: + $ref: '#/components/schemas/NameNode' + minItems: 1 + x-insertionOrder: false + BlockSize: + description: Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster. + type: integer + format: int64 + minimum: 1048576 + maximum: 1073741824 + ReplicationFactor: + description: Number of copies of each block that exists inside the HDFS cluster. + type: integer + format: int64 + default: 3 + minimum: 1 + maximum: 512 + KmsKeyProviderUri: + description: The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored. + type: string + minLength: 1 + maxLength: 255 + pattern: ^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$ + QopConfiguration: + $ref: '#/components/schemas/QopConfiguration' + AuthenticationType: + description: The authentication mode used to determine identity of user. + type: string + enum: + - SIMPLE + - KERBEROS + SimpleUser: + description: The user name that has read and write permissions on the specified HDFS cluster. + type: string + pattern: ^[_.A-Za-z0-9][-_.A-Za-z0-9]*$ + minLength: 1 + maxLength: 256 + KerberosPrincipal: + description: The unique identity, or principal, to which Kerberos can assign tickets. + type: string + pattern: ^.+$ + minLength: 1 + maxLength: 256 + KerberosKeytab: + description: The Base64 string representation of the Keytab file. + type: string + maxLength: 87384 + KerberosKrb5Conf: + description: The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. + type: string + maxLength: 174764 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AgentArns: + description: ARN(s) of the agent(s) to use for an HDFS location. + type: array + items: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ + maxLength: 128 + minItems: 1 + maxItems: 4 + x-insertionOrder: false + Subdirectory: + description: The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + LocationArn: + description: The Amazon Resource Name (ARN) of the HDFS location. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the HDFS location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw|hdfs)://[a-zA-Z0-9.:/\-]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationHDFSRequest + type: object + required: [] + CreateLocationNFSRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MountOptions: + $ref: '#/components/schemas/MountOptions' + default: + Version: AUTOMATIC + OnPremConfig: + $ref: '#/components/schemas/OnPremConfig' + ServerHostname: + description: The name of the NFS server. This value is the IP address or DNS name of the NFS server. + type: string + pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$ + maxLength: 255 + Subdirectory: + description: The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the NFS location. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the NFS location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationNFSRequest + type: object + required: [] + CreateLocationObjectStorageRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessKey: + description: Optional. The access key is used if credentials are required to access the self-managed object storage server. + type: string + minLength: 1 + maxLength: 200 + pattern: ^.+$ + AgentArns: + description: Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. + type: array + items: + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ + minItems: 1 + maxItems: 4 + x-insertionOrder: false + BucketName: + description: The name of the bucket on the self-managed object storage server. + type: string + maxLength: 63 + minLength: 3 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + SecretKey: + description: Optional. The secret key is used if credentials are required to access the self-managed object storage server. + type: string + minLength: 8 + maxLength: 200 + pattern: ^.+$ + ServerCertificate: + description: X.509 PEM content containing a certificate authority or chain to trust. + type: string + maxLength: 32768 + ServerHostname: + description: The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. + type: string + maxLength: 255 + pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$ + ServerPort: + description: The port that your self-managed server accepts inbound network traffic on. + type: integer + minimum: 1 + maximum: 65536 + ServerProtocol: + description: The protocol that the object storage server uses to communicate. + type: string + enum: + - HTTPS + - HTTP + Subdirectory: + description: The subdirectory in the self-managed object storage server that is used to read data from. + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the object storage location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw|object-storage)://[a-zA-Z0-9./\-]+$ + maxLength: 4356 + CmkSecretConfig: + $ref: '#/components/schemas/CmkSecretConfig' + CustomSecretConfig: + $ref: '#/components/schemas/CustomSecretConfig' + ManagedSecretConfig: + $ref: '#/components/schemas/ManagedSecretConfig' + x-stackQL-stringOnly: true + x-title: CreateLocationObjectStorageRequest + type: object + required: [] + CreateLocationS3Request: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + S3Config: + $ref: '#/components/schemas/S3Config' + S3BucketArn: + description: The Amazon Resource Name (ARN) of the Amazon S3 bucket. + type: string + maxLength: 156 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]*:.*$ + Subdirectory: + description: A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination. + type: string + maxLength: 1024 + pattern: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$ + S3StorageClass: + description: The Amazon S3 storage class you want to store your files in when this location is used as a task destination. + type: string + enum: + - STANDARD + - STANDARD_IA + - ONEZONE_IA + - INTELLIGENT_TIERING + - GLACIER + - GLACIER_INSTANT_RETRIEVAL + - DEEP_ARCHIVE + default: STANDARD + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the Amazon S3 bucket location. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the S3 location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\-/]+$ + maxLength: 4356 + x-stackQL-stringOnly: true + x-title: CreateLocationS3Request + type: object + required: [] + CreateLocationSMBRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AgentArns: + description: The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. + type: array + items: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ + maxLength: 128 + minItems: 1 + maxItems: 4 + x-insertionOrder: false + Domain: + description: The name of the Windows domain that the SMB server belongs to. + type: string + maxLength: 253 + pattern: ^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$ + MountOptions: + $ref: '#/components/schemas/MountOptions' + default: + Version: AUTOMATIC + Password: + description: The password of the user who can mount the share and has the permissions to access files and folders in the SMB share. + type: string + maxLength: 104 + pattern: ^.{0,104}$ + ServerHostname: + description: The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. + type: string + maxLength: 255 + pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$ + Subdirectory: + description: The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination + type: string + maxLength: 4096 + pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$ + User: + description: The user who can mount the share, has the permissions to access files and folders in the SMB share. + type: string + maxLength: 104 + pattern: ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LocationArn: + description: The Amazon Resource Name (ARN) of the SMB location that is created. + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + maxLength: 128 + LocationUri: + description: The URL of the SMB location that was described. + type: string + pattern: ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$ + maxLength: 4356 + AuthenticationType: + description: The authentication mode used to determine identity of user. + type: string + enum: + - NTLM + - KERBEROS + DnsIpAddresses: + description: Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server. + type: array + items: + type: string + pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z + minLength: 7 + maxLength: 15 + x-insertionOrder: true + default: null + maxItems: 2 + KerberosPrincipal: + description: Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files. + type: string + pattern: ^.+$ + minLength: 1 + maxLength: 256 + KerberosKeytab: + description: The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file. + type: string + maxLength: 87384 + KerberosKrb5Conf: + description: The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file. + type: string + maxLength: 174764 + x-stackQL-stringOnly: true + x-title: CreateLocationSMBRequest + type: object + required: [] + CreateTaskRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Excludes: + type: array + minItems: 0 + maxItems: 1 + items: + $ref: '#/components/schemas/FilterRule' + x-insertionOrder: false + Includes: + type: array + minItems: 0 + maxItems: 1 + items: + $ref: '#/components/schemas/FilterRule' + x-insertionOrder: false + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CloudWatchLogGroupArn: + description: The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task. + type: string + maxLength: 562 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]*:[0-9]{12}:log-group:([^:\*]*)(:\*)?$ + DestinationLocationArn: + description: The ARN of an AWS storage resource's location. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + Name: + description: The name of a task. This value is a text reference that is used to identify the task in the console. + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9\s+=._:@/-]+$ + Options: + $ref: '#/components/schemas/Options' + TaskReportConfig: + $ref: '#/components/schemas/TaskReportConfig' + ManifestConfig: + $ref: '#/components/schemas/ManifestConfig' + Schedule: + $ref: '#/components/schemas/TaskSchedule' + SourceLocationArn: + description: The ARN of the source location for the task. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ + TaskArn: + description: The ARN of the task. + type: string + maxLength: 128 + pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$ + TaskMode: + description: Specifies the task mode for the task. + type: string + enum: + - BASIC + - ENHANCED + Status: + description: The status of the task that was described. + type: string + enum: + - AVAILABLE + - CREATING + - QUEUED + - RUNNING + - UNAVAILABLE + SourceNetworkInterfaceArns: + $ref: '#/components/schemas/SourceNetworkInterfaceArns' + DestinationNetworkInterfaceArns: + $ref: '#/components/schemas/DestinationNetworkInterfaceArns' + x-stackQL-stringOnly: true + x-title: CreateTaskRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: agents: name: agents id: awscc.datasync.agents x-cfn-schema-name: Agent - x-type: list - x-identifiers: - - AgentArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AgentArn') as agent_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AgentArn') as agent_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' - AND region = 'us-east-1' - agent: - name: agent - id: awscc.datasync.agent - x-cfn-schema-name: Agent - x-type: get + x-cfn-type-name: AWS::DataSync::Agent x-identifiers: - AgentArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Agent&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::Agent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::Agent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::Agent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agents/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/agents/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1833,7 +3495,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1849,13 +3511,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::Agent' AND data__Identifier = '' AND region = 'us-east-1' - location_azure_blobs: - name: location_azure_blobs - id: awscc.datasync.location_azure_blobs - x-cfn-schema-name: LocationAzureBlob - x-type: list + agents_list_only: + name: agents_list_only + id: awscc.datasync.agents_list_only + x-cfn-schema-name: Agent + x-cfn-type-name: AWS::DataSync::Agent x-identifiers: - - LocationArn + - AgentArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1863,28 +3531,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' + JSON_EXTRACT(Properties, '$.AgentArn') as agent_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' + json_extract_path_text(Properties, 'AgentArn') as agent_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' AND region = 'us-east-1' - location_azure_blob: - name: location_azure_blob - id: awscc.datasync.location_azure_blob + location_azure_blobs: + name: location_azure_blobs + id: awscc.datasync.location_azure_blobs x-cfn-schema-name: LocationAzureBlob - x-type: get + x-cfn-type-name: AWS::DataSync::LocationAzureBlob x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationAzureBlob&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationAzureBlob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationAzureBlob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationAzureBlob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1898,12 +3614,15 @@ components: JSON_EXTRACT(Properties, '$.Subdirectory') as subdirectory, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, - JSON_EXTRACT(Properties, '$.LocationUri') as location_uri + JSON_EXTRACT(Properties, '$.LocationUri') as location_uri, + JSON_EXTRACT(Properties, '$.CmkSecretConfig') as cmk_secret_config, + JSON_EXTRACT(Properties, '$.CustomSecretConfig') as custom_secret_config, + JSON_EXTRACT(Properties, '$.ManagedSecretConfig') as managed_secret_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1917,21 +3636,103 @@ components: json_extract_path_text(Properties, 'Subdirectory') as subdirectory, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri + json_extract_path_text(Properties, 'LocationUri') as location_uri, + json_extract_path_text(Properties, 'CmkSecretConfig') as cmk_secret_config, + json_extract_path_text(Properties, 'CustomSecretConfig') as custom_secret_config, + json_extract_path_text(Properties, 'ManagedSecretConfig') as managed_secret_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' AND data__Identifier = '' AND region = 'us-east-1' + location_azure_blobs_list_only: + name: location_azure_blobs_list_only + id: awscc.datasync.location_azure_blobs_list_only + x-cfn-schema-name: LocationAzureBlob + x-cfn-type-name: AWS::DataSync::LocationAzureBlob + x-identifiers: + - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' + AND region = 'us-east-1' location_efs: name: location_efs id: awscc.datasync.location_efs x-cfn-schema-name: LocationEFS - x-type: get + x-cfn-type-name: AWS::DataSync::LocationEFS x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationEFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationEFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationEFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationEFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_efs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_efs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_efs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1949,7 +3750,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1966,13 +3767,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationEFS' AND data__Identifier = '' AND region = 'us-east-1' - locationf_sx_lustres: - name: locationf_sx_lustres - id: awscc.datasync.locationf_sx_lustres - x-cfn-schema-name: LocationFSxLustre - x-type: list + location_efs_list_only: + name: location_efs_list_only + id: awscc.datasync.location_efs_list_only + x-cfn-schema-name: LocationEFS + x-cfn-type-name: AWS::DataSync::LocationEFS x-identifiers: - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1981,7 +3788,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationEFS' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1989,19 +3796,67 @@ components: SELECT region, json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationEFS' AND region = 'us-east-1' - locationf_sx_lustre: - name: locationf_sx_lustre - id: awscc.datasync.locationf_sx_lustre + locationf_sx_lustres: + name: locationf_sx_lustres + id: awscc.datasync.locationf_sx_lustres x-cfn-schema-name: LocationFSxLustre - x-type: get + x-cfn-type-name: AWS::DataSync::LocationFSxLustre x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationFSxLustre&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxLustre" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxLustre" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxLustre" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2016,7 +3871,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2030,13 +3885,141 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' AND data__Identifier = '' AND region = 'us-east-1' + locationf_sx_lustres_list_only: + name: locationf_sx_lustres_list_only + id: awscc.datasync.locationf_sx_lustres_list_only + x-cfn-schema-name: LocationFSxLustre + x-cfn-type-name: AWS::DataSync::LocationFSxLustre + x-identifiers: + - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' + AND region = 'us-east-1' locationf_sx_ontaps: name: locationf_sx_ontaps id: awscc.datasync.locationf_sx_ontaps x-cfn-schema-name: LocationFSxONTAP - x-type: list + x-cfn-type-name: AWS::DataSync::LocationFSxONTAP + x-identifiers: + - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationFSxONTAP&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxONTAP" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxONTAP" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxONTAP" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.StorageVirtualMachineArn') as storage_virtual_machine_arn, + JSON_EXTRACT(Properties, '$.FsxFilesystemArn') as fsx_filesystem_arn, + JSON_EXTRACT(Properties, '$.SecurityGroupArns') as security_group_arns, + JSON_EXTRACT(Properties, '$.Protocol') as protocol, + JSON_EXTRACT(Properties, '$.Subdirectory') as subdirectory, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, + JSON_EXTRACT(Properties, '$.LocationUri') as location_uri + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StorageVirtualMachineArn') as storage_virtual_machine_arn, + json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, + json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' + AND data__Identifier = '' + AND region = 'us-east-1' + locationf_sx_ontaps_list_only: + name: locationf_sx_ontaps_list_only + id: awscc.datasync.locationf_sx_ontaps_list_only + x-cfn-schema-name: LocationFSxONTAP + x-cfn-type-name: AWS::DataSync::LocationFSxONTAP x-identifiers: - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2055,22 +4038,69 @@ components: json_extract_path_text(Properties, 'LocationArn') as location_arn FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' AND region = 'us-east-1' - locationf_sx_ontap: - name: locationf_sx_ontap - id: awscc.datasync.locationf_sx_ontap - x-cfn-schema-name: LocationFSxONTAP - x-type: get + locationf_sx_open_zfs: + name: locationf_sx_open_zfs + id: awscc.datasync.locationf_sx_open_zfs + x-cfn-schema-name: LocationFSxOpenZFS + x-cfn-type-name: AWS::DataSync::LocationFSxOpenZFS x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationFSxOpenZFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxOpenZFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxOpenZFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxOpenZFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_open_zfs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_open_zfs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/locationf_sx_open_zfs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.StorageVirtualMachineArn') as storage_virtual_machine_arn, JSON_EXTRACT(Properties, '$.FsxFilesystemArn') as fsx_filesystem_arn, JSON_EXTRACT(Properties, '$.SecurityGroupArns') as security_group_arns, JSON_EXTRACT(Properties, '$.Protocol') as protocol, @@ -2078,16 +4108,15 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, JSON_EXTRACT(Properties, '$.LocationUri') as location_uri - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'StorageVirtualMachineArn') as storage_virtual_machine_arn, json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, json_extract_path_text(Properties, 'Protocol') as protocol, @@ -2095,16 +4124,22 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'LocationArn') as location_arn, json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' AND data__Identifier = '' AND region = 'us-east-1' - locationf_sx_open_zfs: - name: locationf_sx_open_zfs - id: awscc.datasync.locationf_sx_open_zfs + locationf_sx_open_zfs_list_only: + name: locationf_sx_open_zfs_list_only + id: awscc.datasync.locationf_sx_open_zfs_list_only x-cfn-schema-name: LocationFSxOpenZFS - x-type: get + x-cfn-type-name: AWS::DataSync::LocationFSxOpenZFS x-identifiers: - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2112,44 +4147,76 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.FsxFilesystemArn') as fsx_filesystem_arn, - JSON_EXTRACT(Properties, '$.SecurityGroupArns') as security_group_arns, - JSON_EXTRACT(Properties, '$.Protocol') as protocol, - JSON_EXTRACT(Properties, '$.Subdirectory') as subdirectory, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, - JSON_EXTRACT(Properties, '$.LocationUri') as location_uri - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, - json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' - AND data__Identifier = '' + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' AND region = 'us-east-1' locationf_sx_windows: name: locationf_sx_windows id: awscc.datasync.locationf_sx_windows x-cfn-schema-name: LocationFSxWindows - x-type: get + x-cfn-type-name: AWS::DataSync::LocationFSxWindows x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationFSxWindows&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxWindows" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxWindows" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxWindows" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_windows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_windows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/locationf_sx_windows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2167,7 +4234,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2184,17 +4251,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' AND data__Identifier = '' AND region = 'us-east-1' + locationf_sx_windows_list_only: + name: locationf_sx_windows_list_only + id: awscc.datasync.locationf_sx_windows_list_only + x-cfn-schema-name: LocationFSxWindows + x-cfn-type-name: AWS::DataSync::LocationFSxWindows + x-identifiers: + - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' + AND region = 'us-east-1' location_hdfs: name: location_hdfs id: awscc.datasync.location_hdfs x-cfn-schema-name: LocationHDFS - x-type: get + x-cfn-type-name: AWS::DataSync::LocationHDFS x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationHDFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationHDFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationHDFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationHDFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_hdfs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_hdfs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_hdfs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2218,7 +4364,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2241,17 +4387,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' AND data__Identifier = '' AND region = 'us-east-1' + location_hdfs_list_only: + name: location_hdfs_list_only + id: awscc.datasync.location_hdfs_list_only + x-cfn-schema-name: LocationHDFS + x-cfn-type-name: AWS::DataSync::LocationHDFS + x-identifiers: + - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' + AND region = 'us-east-1' location_nfs: name: location_nfs id: awscc.datasync.location_nfs x-cfn-schema-name: LocationNFS - x-type: get + x-cfn-type-name: AWS::DataSync::LocationNFS x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationNFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationNFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationNFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationNFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_nfs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_nfs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_nfs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2267,7 +4492,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2282,13 +4507,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationNFS' AND data__Identifier = '' AND region = 'us-east-1' - location_object_storages: - name: location_object_storages - id: awscc.datasync.location_object_storages - x-cfn-schema-name: LocationObjectStorage - x-type: list + location_nfs_list_only: + name: location_nfs_list_only + id: awscc.datasync.location_nfs_list_only + x-cfn-schema-name: LocationNFS + x-cfn-type-name: AWS::DataSync::LocationNFS x-identifiers: - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2297,7 +4528,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationNFS' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2305,19 +4536,67 @@ components: SELECT region, json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationNFS' AND region = 'us-east-1' - location_object_storage: - name: location_object_storage - id: awscc.datasync.location_object_storage + location_object_storages: + name: location_object_storages + id: awscc.datasync.location_object_storages x-cfn-schema-name: LocationObjectStorage - x-type: get + x-cfn-type-name: AWS::DataSync::LocationObjectStorage x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationObjectStorage&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationObjectStorage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationObjectStorage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationObjectStorage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2333,12 +4612,15 @@ components: JSON_EXTRACT(Properties, '$.Subdirectory') as subdirectory, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, - JSON_EXTRACT(Properties, '$.LocationUri') as location_uri + JSON_EXTRACT(Properties, '$.LocationUri') as location_uri, + JSON_EXTRACT(Properties, '$.CmkSecretConfig') as cmk_secret_config, + JSON_EXTRACT(Properties, '$.CustomSecretConfig') as custom_secret_config, + JSON_EXTRACT(Properties, '$.ManagedSecretConfig') as managed_secret_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2354,17 +4636,26 @@ components: json_extract_path_text(Properties, 'Subdirectory') as subdirectory, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri + json_extract_path_text(Properties, 'LocationUri') as location_uri, + json_extract_path_text(Properties, 'CmkSecretConfig') as cmk_secret_config, + json_extract_path_text(Properties, 'CustomSecretConfig') as custom_secret_config, + json_extract_path_text(Properties, 'ManagedSecretConfig') as managed_secret_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' AND data__Identifier = '' AND region = 'us-east-1' - location_s3s: - name: location_s3s - id: awscc.datasync.location_s3s - x-cfn-schema-name: LocationS3 - x-type: list + location_object_storages_list_only: + name: location_object_storages_list_only + id: awscc.datasync.location_object_storages_list_only + x-cfn-schema-name: LocationObjectStorage + x-cfn-type-name: AWS::DataSync::LocationObjectStorage x-identifiers: - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2373,7 +4664,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2381,19 +4672,67 @@ components: SELECT region, json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' AND region = 'us-east-1' - location_s3: - name: location_s3 - id: awscc.datasync.location_s3 + location_s3s: + name: location_s3s + id: awscc.datasync.location_s3s x-cfn-schema-name: LocationS3 - x-type: get + x-cfn-type-name: AWS::DataSync::LocationS3 x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationS3&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationS3" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationS3" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationS3" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_s3s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_s3s/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_s3s/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2409,7 +4748,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2424,13 +4763,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationS3' AND data__Identifier = '' AND region = 'us-east-1' - location_smbs: - name: location_smbs - id: awscc.datasync.location_smbs - x-cfn-schema-name: LocationSMB - x-type: list + location_s3s_list_only: + name: location_s3s_list_only + id: awscc.datasync.location_s3s_list_only + x-cfn-schema-name: LocationS3 + x-cfn-type-name: AWS::DataSync::LocationS3 x-identifiers: - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2439,7 +4784,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2447,19 +4792,67 @@ components: SELECT region, json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' AND region = 'us-east-1' - location_smb: - name: location_smb - id: awscc.datasync.location_smb + location_smbs: + name: location_smbs + id: awscc.datasync.location_smbs x-cfn-schema-name: LocationSMB - x-type: get + x-cfn-type-name: AWS::DataSync::LocationSMB x-identifiers: - LocationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationSMB&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationSMB" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationSMB" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationSMB" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_smbs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_smbs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/location_smbs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2473,12 +4866,17 @@ components: JSON_EXTRACT(Properties, '$.User') as user, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, - JSON_EXTRACT(Properties, '$.LocationUri') as location_uri + JSON_EXTRACT(Properties, '$.LocationUri') as location_uri, + JSON_EXTRACT(Properties, '$.AuthenticationType') as authentication_type, + JSON_EXTRACT(Properties, '$.DnsIpAddresses') as dns_ip_addresses, + JSON_EXTRACT(Properties, '$.KerberosPrincipal') as kerberos_principal, + JSON_EXTRACT(Properties, '$.KerberosKeytab') as kerberos_keytab, + JSON_EXTRACT(Properties, '$.KerberosKrb5Conf') as kerberos_krb5_conf FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationSMB' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2492,42 +4890,28 @@ components: json_extract_path_text(Properties, 'User') as user, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri + json_extract_path_text(Properties, 'LocationUri') as location_uri, + json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, + json_extract_path_text(Properties, 'DnsIpAddresses') as dns_ip_addresses, + json_extract_path_text(Properties, 'KerberosPrincipal') as kerberos_principal, + json_extract_path_text(Properties, 'KerberosKeytab') as kerberos_keytab, + json_extract_path_text(Properties, 'KerberosKrb5Conf') as kerberos_krb5_conf FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationSMB' AND data__Identifier = '' AND region = 'us-east-1' - storage_systems: - name: storage_systems - id: awscc.datasync.storage_systems - x-cfn-schema-name: StorageSystem - x-type: list - x-identifiers: - - StorageSystemArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StorageSystemArn') as storage_system_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StorageSystemArn') as storage_system_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND region = 'us-east-1' - storage_system: - name: storage_system - id: awscc.datasync.storage_system - x-cfn-schema-name: StorageSystem - x-type: get + location_smbs_list_only: + name: location_smbs_list_only + id: awscc.datasync.location_smbs_list_only + x-cfn-schema-name: LocationSMB + x-cfn-type-name: AWS::DataSync::LocationSMB x-identifiers: - - StorageSystemArn + - LocationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2535,75 +4919,76 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ServerConfiguration') as server_configuration, - JSON_EXTRACT(Properties, '$.ServerCredentials') as server_credentials, - JSON_EXTRACT(Properties, '$.SecretsManagerArn') as secrets_manager_arn, - JSON_EXTRACT(Properties, '$.SystemType') as system_type, - JSON_EXTRACT(Properties, '$.AgentArns') as agent_arns, - JSON_EXTRACT(Properties, '$.CloudWatchLogGroupArn') as cloud_watch_log_group_arn, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.StorageSystemArn') as storage_system_arn, - JSON_EXTRACT(Properties, '$.ConnectivityStatus') as connectivity_status - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ServerConfiguration') as server_configuration, - json_extract_path_text(Properties, 'ServerCredentials') as server_credentials, - json_extract_path_text(Properties, 'SecretsManagerArn') as secrets_manager_arn, - json_extract_path_text(Properties, 'SystemType') as system_type, - json_extract_path_text(Properties, 'AgentArns') as agent_arns, - json_extract_path_text(Properties, 'CloudWatchLogGroupArn') as cloud_watch_log_group_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'StorageSystemArn') as storage_system_arn, - json_extract_path_text(Properties, 'ConnectivityStatus') as connectivity_status - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND data__Identifier = '' + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' AND region = 'us-east-1' tasks: name: tasks id: awscc.datasync.tasks x-cfn-schema-name: Task - x-type: list - x-identifiers: - - TaskArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TaskArn') as task_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TaskArn') as task_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' - AND region = 'us-east-1' - task: - name: task - id: awscc.datasync.task - x-cfn-schema-name: Task - x-type: get + x-cfn-type-name: AWS::DataSync::Task x-identifiers: - TaskArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Task&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::Task" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::Task" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::Task" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tasks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tasks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2616,9 +5001,11 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Options') as options, JSON_EXTRACT(Properties, '$.TaskReportConfig') as task_report_config, + JSON_EXTRACT(Properties, '$.ManifestConfig') as manifest_config, JSON_EXTRACT(Properties, '$.Schedule') as schedule, JSON_EXTRACT(Properties, '$.SourceLocationArn') as source_location_arn, JSON_EXTRACT(Properties, '$.TaskArn') as task_arn, + JSON_EXTRACT(Properties, '$.TaskMode') as task_mode, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.SourceNetworkInterfaceArns') as source_network_interface_arns, JSON_EXTRACT(Properties, '$.DestinationNetworkInterfaceArns') as destination_network_interface_arns @@ -2626,7 +5013,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2639,12 +5026,744 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Options') as options, json_extract_path_text(Properties, 'TaskReportConfig') as task_report_config, + json_extract_path_text(Properties, 'ManifestConfig') as manifest_config, json_extract_path_text(Properties, 'Schedule') as schedule, json_extract_path_text(Properties, 'SourceLocationArn') as source_location_arn, json_extract_path_text(Properties, 'TaskArn') as task_arn, + json_extract_path_text(Properties, 'TaskMode') as task_mode, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'SourceNetworkInterfaceArns') as source_network_interface_arns, json_extract_path_text(Properties, 'DestinationNetworkInterfaceArns') as destination_network_interface_arns FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::Task' AND data__Identifier = '' AND region = 'us-east-1' + tasks_list_only: + name: tasks_list_only + id: awscc.datasync.tasks_list_only + x-cfn-schema-name: Task + x-cfn-type-name: AWS::DataSync::Task + x-identifiers: + - TaskArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TaskArn') as task_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TaskArn') as task_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Agent&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAgent + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAgentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationAzureBlob&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationAzureBlob + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationAzureBlobRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationEFS&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationEFS + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationEFSRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationFSxLustre&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationFSxLustre + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationFSxLustreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationFSxONTAP&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationFSxONTAP + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationFSxONTAPRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationFSxOpenZFS&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationFSxOpenZFS + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationFSxOpenZFSRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationFSxWindows&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationFSxWindows + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationFSxWindowsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationHDFS&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationHDFS + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationHDFSRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationNFS&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationNFS + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationNFSRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationObjectStorage&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationObjectStorage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationObjectStorageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationS3&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationS3 + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationS3Request' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocationSMB&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocationSMB + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationSMBRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Task&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTask + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTaskRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/datazone.yaml b/providers/src/awscc/v00.00.00000/services/datazone.yaml index 56f6c021..f2215a73 100644 --- a/providers/src/awscc/v00.00.00000/services/datazone.yaml +++ b/providers/src/awscc/v00.00.00000/services/datazone.yaml @@ -1,1101 +1,5796 @@ openapi: 3.0.0 info: title: DataZone - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - AccountId: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' type: string - maxLength: 12 - minLength: 12 - pattern: ^\d{12}$ - DataAccessRole: + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure type: string - description: The data access role included in the configuration details of the AWS Glue data source. - pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]{1,128}$ - DataSourceConfigurationInput: - description: Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration. - oneOf: - - type: object - title: GlueRunConfiguration - properties: - GlueRunConfiguration: - $ref: '#/components/schemas/GlueRunConfigurationInput' - additionalProperties: false - - type: object - title: RedshiftRunConfiguration - properties: - RedshiftRunConfiguration: - $ref: '#/components/schemas/RedshiftRunConfigurationInput' - additionalProperties: false - DataSourceStatus: + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ type: string - description: The status of the data source. + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: enum: - - CREATING - - FAILED_CREATION - - READY - - UPDATING - - FAILED_UPDATE - - RUNNING - - DELETING - - FAILED_DELETION - EnableSetting: + - CREATE + - DELETE + - UPDATE type: string - description: Specifies whether the data source is enabled. + OperationStatus: enum: - - ENABLED - - DISABLED - FilterExpression: - type: object - description: The search filter expression. + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string properties: - Type: - $ref: '#/components/schemas/FilterExpressionType' - Expression: + ErrorCode: type: string - maxLength: 2048 - minLength: 1 - required: - - Expression - - Type - additionalProperties: false - FilterExpressionType: - type: string - description: The search filter expression type. - enum: - - INCLUDE - - EXCLUDE - FormName: + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' type: string - description: The name of the metadata form. + RequestToken: maxLength: 128 minLength: 1 - pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$ - FormInput: - type: object - description: The details of a metadata form. + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. properties: - FormName: - description: The name of the metadata form. - $ref: '#/components/schemas/FormName' - TypeIdentifier: + Identifier: type: string - description: The ID of the metadata form type. - maxLength: 385 - minLength: 1 - pattern: ^(?!\.)[\w\.]*\w$ - TypeRevision: - description: The revision of the metadata form type. - $ref: '#/components/schemas/TypeRevision' - Content: + Properties: type: string - description: The content of the metadata form. - maxLength: 75000 + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' required: - - FormName - additionalProperties: false - GlueRunConfigurationInput: + - Identifier + - PatchDocument + title: UpdateResourceInput type: object + UpdateResourceOutput: properties: - DataAccessRole: - description: The data access role included in the configuration details of the AWS Glue data source. - $ref: '#/components/schemas/DataAccessRole' - RelationalFilterConfigurations: - type: array - description: The relational filter configurations included in the configuration details of the AWS Glue data source. - items: - $ref: '#/components/schemas/RelationalFilterConfiguration' - x-insertionOrder: false + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + AthenaPropertiesInput: + type: object + description: Athena Properties Input + properties: + WorkgroupName: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9._-]+$ required: - - RelationalFilterConfigurations + - WorkgroupName additionalProperties: false - RecommendationConfiguration: + AuthenticationConfigurationInput: type: object - description: The recommendation to be updated as part of the UpdateDataSource action. + description: Authentication Configuration Input properties: - EnableBusinessNameGeneration: - type: boolean - description: Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. + AuthenticationType: + $ref: '#/components/schemas/AuthenticationType' + OAuth2Properties: + $ref: '#/components/schemas/OAuth2Properties' + SecretArn: + type: string + pattern: ^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$ + KmsKeyArn: + type: string + pattern: ^$|arn:aws[a-z0-9-]*:kms:.*$ + BasicAuthenticationCredentials: + $ref: '#/components/schemas/BasicAuthenticationCredentials' + CustomAuthenticationCredentials: + $ref: '#/components/schemas/CredentialMap' additionalProperties: false - RedshiftClusterStorage: + AuthenticationType: + type: string + description: Authentication Type + enum: + - BASIC + - OAUTH2 + - CUSTOM + AuthorizationCodeProperties: type: object - description: The name of an Amazon Redshift cluster. + description: Authorization Code Properties properties: - ClusterName: + AuthorizationCode: type: string - description: The name of an Amazon Redshift cluster. - maxLength: 63 + maxLength: 4096 minLength: 1 - pattern: ^[0-9a-z].[a-z0-9\-]*$ - required: - - ClusterName + RedirectUri: + type: string + maxLength: 512 additionalProperties: false - RedshiftCredentialConfiguration: + AwsLocation: type: object - description: The ARN of a secret manager for an Amazon Redshift cluster. + description: AWS Location of project properties: - SecretManagerArn: + AccessRole: type: string - description: The ARN of a secret manager for an Amazon Redshift cluster. - maxLength: 256 - pattern: ^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:secret:.*$ - required: - - SecretManagerArn + maxLength: 2048 + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + AwsAccountId: + type: string + pattern: ^\d{12}$ + AwsRegion: + type: string + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + IamConnectionId: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9]+$ additionalProperties: false - RedshiftRunConfigurationInput: + BasicAuthenticationCredentials: type: object - description: The configuration details of the Amazon Redshift data source. + description: Basic Authentication Credentials properties: - DataAccessRole: - description: The data access role included in the configuration details of the Amazon Redshift data source. - $ref: '#/components/schemas/DataAccessRole' - RelationalFilterConfigurations: - $ref: '#/components/schemas/RelationalFilterConfigurations' - RedshiftCredentialConfiguration: - description: The details of the credentials required to access an Amazon Redshift cluster. - $ref: '#/components/schemas/RedshiftCredentialConfiguration' - RedshiftStorage: - description: The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. - $ref: '#/components/schemas/RedshiftStorage' - required: - - RedshiftCredentialConfiguration - - RedshiftStorage - - RelationalFilterConfigurations + UserName: + type: string + maxLength: 512 + pattern: ^\S+$ + Password: + type: string + maxLength: 512 + pattern: ^.*$ additionalProperties: false - RedshiftServerlessStorage: + ComputeEnvironments: + type: string + description: Compute Environments + ConnectionProperties: type: object - description: The details of the Amazon Redshift Serverless workgroup storage. - properties: - WorkgroupName: + description: Connection Properties + x-patternProperties: + .+: type: string - description: The name of the Amazon Redshift Serverless workgroup. - maxLength: 64 - minLength: 3 - pattern: ^[a-z0-9-]+$ - required: - - WorkgroupName + maxLength: 2048 + minLength: 1 additionalProperties: false - RedshiftStorage: - description: The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. + ConnectionPropertiesInput: oneOf: - type: object - title: RedshiftClusterSource - description: The details of the Amazon Redshift cluster source. + title: AthenaProperties properties: - RedshiftClusterSource: - $ref: '#/components/schemas/RedshiftClusterStorage' + AthenaProperties: + $ref: '#/components/schemas/AthenaPropertiesInput' required: - - RedshiftClusterSource + - AthenaProperties additionalProperties: false - type: object - title: RedshiftServerlessSource - description: The details of the Amazon Redshift Serverless workgroup source. + title: GlueProperties properties: - RedshiftServerlessSource: - $ref: '#/components/schemas/RedshiftServerlessStorage' + GlueProperties: + $ref: '#/components/schemas/GluePropertiesInput' required: - - RedshiftServerlessSource + - GlueProperties additionalProperties: false - Region: - type: string - maxLength: 16 - minLength: 4 - pattern: '[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]' - RelationalFilterConfiguration: - type: object - description: The relational filter configuration for the data source. - properties: - DatabaseName: + - type: object + title: HyperPodProperties + properties: + HyperPodProperties: + $ref: '#/components/schemas/HyperPodPropertiesInput' + required: + - HyperPodProperties + additionalProperties: false + - type: object + title: IamProperties + properties: + IamProperties: + $ref: '#/components/schemas/IamPropertiesInput' + required: + - IamProperties + additionalProperties: false + - type: object + title: RedshiftProperties + properties: + RedshiftProperties: + $ref: '#/components/schemas/RedshiftPropertiesInput' + required: + - RedshiftProperties + additionalProperties: false + - type: object + title: SparkEmrProperties + properties: + SparkEmrProperties: + $ref: '#/components/schemas/SparkEmrPropertiesInput' + required: + - SparkEmrProperties + additionalProperties: false + - type: object + title: SparkGlueProperties + properties: + SparkGlueProperties: + $ref: '#/components/schemas/SparkGluePropertiesInput' + required: + - SparkGlueProperties + additionalProperties: false + ConnectionStatus: + type: string + description: Connection Status + enum: + - CREATING + - CREATE_FAILED + - DELETING + - DELETE_FAILED + - READY + - UPDATING + - UPDATE_FAILED + - DELETED + ConnectionType: + type: string + description: Connection Type + CredentialMap: + type: object + description: Credential Map + x-patternProperties: + .+: type: string - description: The database name specified in the relational filter configuration for the data source. - maxLength: 128 + maxLength: 2048 minLength: 1 - SchemaName: + additionalProperties: false + GlueConnectionInput: + type: object + description: Glue Connection Input + properties: + ConnectionProperties: + $ref: '#/components/schemas/ConnectionProperties' + PhysicalConnectionRequirements: + $ref: '#/components/schemas/PhysicalConnectionRequirements' + Name: type: string - description: The schema name specified in the relational filter configuration for the data source. - maxLength: 128 + maxLength: 255 minLength: 1 - FilterExpressions: + pattern: ^[\u0020-\uD7FF\uE000-\uFFFF\t]*$ + Description: + type: string + maxLength: 2048 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFF\r\n\t]*$ + ConnectionType: + $ref: '#/components/schemas/GlueConnectionType' + MatchCriteria: + type: string + maxLength: 10 + minLength: 0 + ValidateCredentials: + type: boolean + ValidateForComputeEnvironments: type: array - description: The filter expressions specified in the relational filter configuration for the data source. - items: - $ref: '#/components/schemas/FilterExpression' x-insertionOrder: false + items: + $ref: '#/components/schemas/ComputeEnvironments' + maxItems: 50 + minItems: 1 + SparkProperties: + $ref: '#/components/schemas/PropertyMap' + AthenaProperties: + $ref: '#/components/schemas/PropertyMap' + PythonProperties: + $ref: '#/components/schemas/PropertyMap' + AuthenticationConfiguration: + $ref: '#/components/schemas/AuthenticationConfigurationInput' + additionalProperties: false + GlueConnectionType: + type: string + description: Glue Connection Type + GlueOAuth2Credentials: + type: object + description: Glue OAuth2 Credentials + properties: + UserManagedClientApplicationClientSecret: + type: string + maxLength: 512 + pattern: ^[\x20-\x7E]*$ + AccessToken: + type: string + maxLength: 4096 + pattern: ^[\x20-\x7E]*$ + RefreshToken: + type: string + maxLength: 4096 + pattern: ^[\x20-\x7E]*$ + JwtToken: + type: string + maxLength: 8000 + pattern: ^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)$ + additionalProperties: false + GluePropertiesInput: + type: object + description: Glue Properties Input + properties: + GlueConnectionInput: + $ref: '#/components/schemas/GlueConnectionInput' + additionalProperties: false + HyperPodPropertiesInput: + type: object + description: HyperPod Properties Input + properties: + ClusterName: + type: string + maxLength: 63 + minLength: 1 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ required: - - DatabaseName + - ClusterName additionalProperties: false - RelationalFilterConfigurations: - type: array - description: The relational filter configurations included in the configuration details of the Amazon Redshift data source. - items: - $ref: '#/components/schemas/RelationalFilterConfiguration' - x-insertionOrder: false - ScheduleConfiguration: + IamPropertiesInput: type: object - description: The schedule of the data source runs. + description: IAM Properties Input + properties: + GlueLineageSyncEnabled: + type: boolean + additionalProperties: false + LineageSyncSchedule: + type: object + description: Lineage Sync Schedule properties: - Timezone: - description: The timezone of the data source run. - $ref: '#/components/schemas/Timezone' Schedule: type: string - description: The schedule of the data source runs. - maxLength: 256 - minLength: 1 - pattern: cron\((\b[0-5]?[0-9]\b) (\b2[0-3]\b|\b[0-1]?[0-9]\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\) + pattern: ^cron\((\b[0-5]?[0-9]\b) (\b2[0-3]\b|\b[0-1]?[0-9]\b) ([-?*,/\dLW]){1,83} ([-*,/\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\dL]|[a-zA-Z]{3}){1,13} ([^\)]+)\)$ additionalProperties: false - Timezone: - type: string - TypeRevision: + OAuth2ClientApplication: + type: object + description: OAuth2 Client Application + properties: + UserManagedClientApplicationClientId: + type: string + maxLength: 2048 + pattern: ^\S+$ + AWSManagedClientApplicationReference: + type: string + maxLength: 2048 + pattern: ^\S+$ + additionalProperties: false + OAuth2GrantType: type: string - description: The revision of the metadata form type. - maxLength: 64 - minLength: 1 - DataSource: + description: OAuth2 Grant Type + enum: + - AUTHORIZATION_CODE + - CLIENT_CREDENTIALS + - JWT_BEARER + OAuth2Properties: type: object + description: OAuth2 Properties properties: - AssetFormsInput: + OAuth2GrantType: + $ref: '#/components/schemas/OAuth2GrantType' + OAuth2ClientApplication: + $ref: '#/components/schemas/OAuth2ClientApplication' + TokenUrl: + type: string + maxLength: 256 + pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$ + TokenUrlParametersMap: + $ref: '#/components/schemas/TokenUrlParametersMap' + AuthorizationCodeProperties: + $ref: '#/components/schemas/AuthorizationCodeProperties' + OAuth2Credentials: + $ref: '#/components/schemas/GlueOAuth2Credentials' + additionalProperties: false + PhysicalConnectionRequirements: + type: object + description: Physical Connection Requirements + properties: + SubnetId: + type: string + maxLength: 32 + pattern: ^subnet-[a-z0-9]+$ + SubnetIdList: type: array - description: The metadata forms that are to be attached to the assets that this data source works with. + x-insertionOrder: false items: - $ref: '#/components/schemas/FormInput' - maxItems: 10 - minItems: 0 + type: string + maxLength: 32 + pattern: ^subnet-[a-z0-9]+$ + maxItems: 50 + minItems: 1 + SecurityGroupIdList: + type: array x-insertionOrder: false - CreatedAt: + items: + type: string + maxLength: 255 + minLength: 1 + maxItems: 50 + minItems: 0 + AvailabilityZone: type: string - description: The timestamp of when the data source was created. - format: date-time - Description: + maxLength: 255 + minLength: 1 + additionalProperties: false + PropertyMap: + type: object + description: Property Map + x-patternProperties: + ^[\u0020-\uD7FF\uE000-\uFFFF\t]*$: type: string - description: The description of the data source. maxLength: 2048 - DomainId: - type: string - description: The ID of the Amazon DataZone domain where the data source is created. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - DomainIdentifier: + minLength: 1 + pattern: ^[\u0020-\uD7FF\uE000-\uFFFF\t]*$ + additionalProperties: false + RedshiftCredentials: + oneOf: + - type: object + title: SecretArn + properties: + SecretArn: + type: string + maxLength: 2048 + pattern: ^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:secret:.*$ + required: + - SecretArn + additionalProperties: false + - type: object + title: UsernamePassword + properties: + UsernamePassword: + $ref: '#/components/schemas/UsernamePassword' + required: + - UsernamePassword + additionalProperties: false + RedshiftLineageSyncConfigurationInput: + type: object + description: Redshift Lineage Sync Configuration Input + properties: + Enabled: + type: boolean + Schedule: + $ref: '#/components/schemas/LineageSyncSchedule' + additionalProperties: false + RedshiftPropertiesInput: + type: object + description: Redshift Properties Input + properties: + Storage: + $ref: '#/components/schemas/RedshiftStorageProperties' + DatabaseName: type: string - description: The ID of the Amazon DataZone domain where the data source is created. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - EnableSetting: - description: Specifies whether the data source is enabled. - $ref: '#/components/schemas/EnableSetting' - EnvironmentId: + maxLength: 64 + minLength: 1 + pattern: ^[a-z0-9_-]+$ + Host: type: string - description: The unique identifier of the Amazon DataZone environment to which the data source publishes assets. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - EnvironmentIdentifier: - description: The unique identifier of the Amazon DataZone environment to which the data source publishes assets. + maxLength: 256 + pattern: ^[\S]*$ + Port: + type: number + maximum: 65535 + minimum: 0 + Credentials: + $ref: '#/components/schemas/RedshiftCredentials' + LineageSync: + $ref: '#/components/schemas/RedshiftLineageSyncConfigurationInput' + additionalProperties: false + RedshiftStorageProperties: + oneOf: + - type: object + title: ClusterName + properties: + ClusterName: + type: string + maxLength: 63 + minLength: 0 + pattern: ^[a-z0-9-]+$ + required: + - ClusterName + additionalProperties: false + - type: object + title: WorkgroupName + properties: + WorkgroupName: + type: string + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9-]+$ + required: + - WorkgroupName + additionalProperties: false + SparkEmrPropertiesInput: + type: object + description: Spark EMR Properties Input. + properties: + ComputeArn: type: string - Id: + maxLength: 2048 + pattern: ^arn:aws(-(cn|us-gov|iso(-[bef])?))?:(elasticmapreduce|emr-serverless):.* + InstanceProfileArn: type: string - description: The unique identifier of the data source. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - Configuration: - description: Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration. - $ref: '#/components/schemas/DataSourceConfigurationInput' - LastRunAssetCount: - description: The number of assets created by the data source during its last run. - type: number - LastRunAt: + maxLength: 2048 + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + JavaVirtualEnv: type: string - description: The timestamp that specifies when the data source was last run. - LastRunStatus: - description: The status of the last run of this data source. + maxLength: 256 + pattern: ^[\S]*$ + LogUri: type: string - Name: + maxLength: 2048 + pattern: ^s3://.+$ + PythonVirtualEnv: type: string - description: The name of the data source. maxLength: 256 + pattern: ^[\S]*$ + RuntimeRole: + type: string + maxLength: 2048 + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + TrustedCertificatesS3Uri: + type: string + maxLength: 2048 + pattern: ^s3://.+$ + additionalProperties: false + SparkGlueArgs: + type: object + description: Spark Glue Args. + properties: + Connection: + type: string + maxLength: 128 + pattern: ^[a-zA-Z0-9]+$ + additionalProperties: false + SparkGluePropertiesInput: + type: object + description: Spark Glue Properties Input. + properties: + AdditionalArgs: + $ref: '#/components/schemas/SparkGlueArgs' + GlueConnectionName: + type: string + maxLength: 255 minLength: 1 - ProjectId: + pattern: ^[\S]*$ + GlueVersion: type: string - description: The ID of the Amazon DataZone project to which the data source is added. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - ProjectIdentifier: + maxLength: 256 + pattern: ^\w+\.\w+$ + IdleTimeout: + type: number + maximum: 3000 + minimum: 1 + JavaVirtualEnv: type: string - description: The identifier of the Amazon DataZone project in which you want to add the data source. - PublishOnImport: - type: boolean - description: Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. - Recommendation: - $ref: '#/components/schemas/RecommendationConfiguration' - description: Specifies whether the business name generation is to be enabled for this data source. - Schedule: - description: The schedule of the data source runs. - $ref: '#/components/schemas/ScheduleConfiguration' - Status: - description: The status of the data source. - $ref: '#/components/schemas/DataSourceStatus' - Type: + maxLength: 256 + pattern: ^[\S]*$ + NumberOfWorkers: + type: number + maximum: 1000 + minimum: 1 + PythonVirtualEnv: type: string - description: The type of the data source. maxLength: 256 - minLength: 1 - UpdatedAt: + pattern: ^[\S]*$ + WorkerType: type: string - description: The timestamp of when this data source was updated. - format: date-time - required: - - Name - - DomainIdentifier - - ProjectIdentifier - - EnvironmentIdentifier - - Type - x-stackql-resource-name: data_source - x-stackql-primaryIdentifier: - - DomainId - - Id - x-create-only-properties: - - EnvironmentIdentifier - - DomainIdentifier - - ProjectIdentifier - - Type - x-read-only-properties: - - CreatedAt - - DomainId - - EnvironmentId - - Id - - LastRunAssetCount - - LastRunAt - - LastRunStatus - - ProjectId - - Status - - UpdatedAt - x-required-permissions: - create: - - datazone:CreateDataSource - - iam:PassRole - - datazone:GetDataSource - - datazone:DeleteDataSource - read: - - datazone:GetDataSource - update: - - datazone:UpdateDataSource - - datazone:GetDataSource - - datazone:DeleteDataSource - delete: - - datazone:DeleteDataSource - - datazone:GetDataSource - list: - - datazone:ListDataSources - AuthType: - type: string - description: The type of single sign-on in Amazon DataZone. - enum: - - IAM_IDC - - DISABLED - DomainStatus: - type: string - description: The status of the Amazon DataZone domain. - enum: - - CREATING - - AVAILABLE - - CREATION_FAILED - - DELETING - - DELETED - - DELETION_FAILED - SingleSignOn: + maxLength: 256 + pattern: ^[G|Z].*$ + additionalProperties: false + TokenUrlParametersMap: type: object - description: The single-sign on configuration of the Amazon DataZone domain. - properties: - Type: - $ref: '#/components/schemas/AuthType' - UserAssignment: - $ref: '#/components/schemas/UserAssignment' + description: The token URL parameters. + x-patternProperties: + .+: + type: string + maxLength: 512 + minLength: 1 additionalProperties: false - Tag: - description: A key-value pair to associate with the domain. + UsernamePassword: type: object + description: The username and password to be used for authentication. properties: - Key: + Password: type: string - description: The key name of the tag. - minLength: 1 - maxLength: 128 - Value: + maxLength: 64 + pattern: ^[\S]*$ + Username: type: string - description: The value for the tag. - minLength: 0 - maxLength: 256 + maxLength: 127 + minLength: 1 + pattern: ^[\S]*$ required: - - Key - - Value + - Password + - Username additionalProperties: false - UserAssignment: - type: string - description: The single sign-on user assignment in Amazon DataZone. - enum: - - AUTOMATIC - - MANUAL - Domain: + Connection: type: object properties: - Arn: - type: string - description: The ARN of the Amazon DataZone domain. - pattern: ^arn:aws(|-cn|-us-gov):datazone:\w+(?:-\w+)+:\d{12}:domain/dzd[-_][a-zA-Z0-9_-]{1,36}$ - CreatedAt: + AwsLocation: + $ref: '#/components/schemas/AwsLocation' + ConnectionId: type: string - description: The timestamp of when the Amazon DataZone domain was last updated. - format: date-time + description: The ID of the connection. + maxLength: 128 + pattern: ^[a-zA-Z0-9]+$ Description: type: string - description: The description of the Amazon DataZone domain. - DomainExecutionRole: + description: The description of the connection. + maxLength: 128 + pattern: ^[\S\s]*$ + DomainId: type: string - description: The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain. - pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ - Id: + description: The ID of the domain in which the connection is created. + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: type: string - description: The id of the Amazon DataZone domain. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - KmsKeyIdentifier: + description: The identifier of the domain in which the connection is created. + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainUnitId: type: string - maxLength: 1024 - description: The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. + description: The ID of the domain unit in which the connection is created. + maxLength: 256 minLength: 1 - pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ - LastUpdatedAt: + pattern: ^[a-z0-9_\-]+$ + EnvironmentId: type: string - description: The timestamp of when the Amazon DataZone domain was last updated. - format: date-time - ManagedAccountId: + description: The ID of the environment in which the connection is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentIdentifier: type: string - description: The identifier of the AWS account that manages the domain. + description: The identifier of the environment in which the connection is created. + EnvironmentUserRole: + type: string + description: The role of the user in the environment. Name: type: string - description: The name of the Amazon DataZone domain. - PortalUrl: + description: The name of the connection. + maxLength: 64 + pattern: ^[\w][\w\.\-\_]*$ + ProjectId: type: string - description: The URL of the data portal for this Amazon DataZone domain. - SingleSignOn: - $ref: '#/components/schemas/SingleSignOn' - description: The single-sign on configuration of the Amazon DataZone domain. - Status: - $ref: '#/components/schemas/DomainStatus' - description: The status of the Amazon DataZone domain. - Tags: - type: array - description: The tags specified for the Amazon DataZone domain. - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' + description: The ID of the project in which the connection is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Props: + $ref: '#/components/schemas/ConnectionPropertiesInput' + Type: + $ref: '#/components/schemas/ConnectionType' required: - - DomainExecutionRole + - DomainIdentifier + - EnvironmentIdentifier - Name - x-stackql-resource-name: domain - x-stackql-primaryIdentifier: - - Id + x-stackql-resource-name: connection + description: Connections enables users to connect their DataZone resources (domains, projects, and environments) to external resources/services (data, compute, etc) + x-type-name: AWS::DataZone::Connection + x-stackql-primary-identifier: + - DomainId + - ConnectionId x-create-only-properties: - - KmsKeyIdentifier + - DomainIdentifier + - EnvironmentIdentifier + - Name + x-write-only-properties: + - AwsLocation + - DomainIdentifier + - EnvironmentIdentifier + - Props x-read-only-properties: - - Arn - - CreatedAt - - Id - - LastUpdatedAt - - ManagedAccountId - - PortalUrl - - Status + - ConnectionId + - DomainId + - DomainUnitId + - EnvironmentId + - EnvironmentUserRole + - ProjectId + - Type + x-required-properties: + - DomainIdentifier + - EnvironmentIdentifier + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - datazone:CreateDomain - - datazone:UpdateDomain - - datazone:GetDomain - - datazone:TagResource - - sso:CreateManagedApplicationInstance - - sso:DeleteManagedApplicationInstance - - sso:PutApplicationAssignmentConfiguration + - datazone:CreateConnection + - datazone:GetConnection + - datazone:DeleteConnection read: - - datazone:GetDomain + - datazone:GetConnection update: - - datazone:UpdateDomain - - datazone:GetDomain - - datazone:TagResource - - datazone:UntagResource - - sso:CreateManagedApplicationInstance - - sso:DeleteManagedApplicationInstance - - sso:PutApplicationAssignmentConfiguration + - datazone:UpdateConnection + - datazone:GetConnection + - datazone:DeleteConnection delete: - - datazone:DeleteDomain - - datazone:GetDomain + - datazone:DeleteConnection + - datazone:GetConnection list: - - datazone:ListDomains - EnvironmentParameter: - type: object - description: The parameter details of an environment profile. - properties: - Name: - type: string - description: The name of an environment profile parameter. - Value: - type: string - description: The value of an environment profile parameter. - additionalProperties: false - EnvironmentStatus: + - datazone:ListConnections + AccountId: type: string - description: The status of the Amazon DataZone environment. + maxLength: 12 + minLength: 12 + pattern: ^\d{12}$ + DataAccessRole: + type: string + description: The data access role included in the configuration details of the AWS Glue data source. + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]{1,128}$ + DataSourceConfigurationInput: + description: Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration or sageMakerRunConfiguration. + oneOf: + - type: object + title: GlueRunConfiguration + properties: + GlueRunConfiguration: + $ref: '#/components/schemas/GlueRunConfigurationInput' + additionalProperties: false + - type: object + title: RedshiftRunConfiguration + properties: + RedshiftRunConfiguration: + $ref: '#/components/schemas/RedshiftRunConfigurationInput' + additionalProperties: false + - type: object + title: SageMakerRunConfiguration + properties: + SageMakerRunConfiguration: + $ref: '#/components/schemas/SageMakerRunConfigurationInput' + additionalProperties: false + DataSourceStatus: + type: string + description: The status of the data source. enum: - - ACTIVE - CREATING + - FAILED_CREATION + - READY - UPDATING + - FAILED_UPDATE + - RUNNING - DELETING - - CREATE_FAILED - - UPDATE_FAILED - - DELETE_FAILED - - VALIDATION_FAILED - - SUSPENDED + - FAILED_DELETION + EnableSetting: + type: string + description: Specifies whether the data source is enabled. + enum: + - ENABLED - DISABLED - - EXPIRED - - DELETED - - INACCESSIBLE - Environment: + FilterExpression: type: object + description: The search filter expression. properties: - AwsAccountId: - type: string - description: The AWS account in which the Amazon DataZone environment is created. - pattern: ^\d{12}$ - AwsAccountRegion: - type: string - description: The AWS region in which the Amazon DataZone environment is created. - pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ - CreatedAt: + Type: + $ref: '#/components/schemas/FilterExpressionType' + Expression: type: string - description: The timestamp of when the environment was created. - format: date-time - CreatedBy: - type: string - description: The Amazon DataZone user who created the environment. - Description: - type: string - description: The description of the Amazon DataZone environment. maxLength: 2048 - DomainId: - type: string - description: The identifier of the Amazon DataZone domain in which the environment is created. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - DomainIdentifier: - type: string - description: The identifier of the Amazon DataZone domain in which the environment would be created. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - EnvironmentBlueprintId: - type: string - description: The ID of the blueprint with which the Amazon DataZone environment was created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - EnvironmentProfileId: - type: string - description: The ID of the environment profile with which the Amazon DataZone environment was created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - EnvironmentProfileIdentifier: - type: string - description: The ID of the environment profile with which the Amazon DataZone environment would be created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - GlossaryTerms: - type: array - x-insertionOrder: false - description: The glossary terms that can be used in the Amazon DataZone environment. - items: - type: string - pattern: ^[a-zA-Z0-9_-]{1,36}$ - maxItems: 20 - minItems: 1 - Id: - type: string - description: The ID of the Amazon DataZone environment. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - Name: - type: string - description: The name of the environment. - maxLength: 64 minLength: 1 - pattern: ^[\w -]+$ - ProjectId: - type: string - description: The ID of the Amazon DataZone project in which the environment is created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - ProjectIdentifier: + required: + - Expression + - Type + additionalProperties: false + FilterExpressionType: + type: string + description: The search filter expression type. + enum: + - INCLUDE + - EXCLUDE + FormName: + type: string + description: The name of the metadata form. + maxLength: 128 + minLength: 1 + pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$ + FormInput: + type: object + description: The details of a metadata form. + properties: + FormName: + description: The name of the metadata form. + $ref: '#/components/schemas/FormName' + TypeIdentifier: type: string - description: The ID of the Amazon DataZone project in which the environment would be created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - Provider: + description: The ID of the metadata form type. + maxLength: 385 + minLength: 1 + pattern: ^(?!\.)[\w\.]*\w$ + TypeRevision: + description: The revision of the metadata form type. + $ref: '#/components/schemas/TypeRevision' + Content: type: string - description: The provider of the Amazon DataZone environment. - Status: - $ref: '#/components/schemas/EnvironmentStatus' - description: The status of the Amazon DataZone environment. - UpdatedAt: + description: The content of the metadata form. + maxLength: 75000 + required: + - FormName + additionalProperties: false + GlueRunConfigurationInput: + type: object + properties: + AutoImportDataQualityResult: + description: Specifies whether to automatically import data quality metrics as part of the data source run. + type: boolean + CatalogName: type: string - description: The timestamp of when the environment was updated. - format: date-time - UserParameters: + description: The catalog name in the AWS Glue run configuration. + maxLength: 128 + minLength: 1 + DataAccessRole: + description: The data access role included in the configuration details of the AWS Glue data source. + $ref: '#/components/schemas/DataAccessRole' + RelationalFilterConfigurations: type: array - x-insertionOrder: false - description: The user parameters of the Amazon DataZone environment. + description: The relational filter configurations included in the configuration details of the AWS Glue data source. items: - $ref: '#/components/schemas/EnvironmentParameter' + $ref: '#/components/schemas/RelationalFilterConfiguration' + x-insertionOrder: false required: - - EnvironmentProfileIdentifier - - Name - - ProjectIdentifier - - DomainIdentifier - x-stackql-resource-name: environment - x-stackql-primaryIdentifier: - - DomainId - - Id - x-create-only-properties: - - DomainIdentifier - - EnvironmentProfileIdentifier - - ProjectIdentifier - - UserParameters - x-read-only-properties: - - AwsAccountId - - AwsAccountRegion - - CreatedAt - - CreatedBy - - DomainId - - EnvironmentBlueprintId - - EnvironmentProfileId - - Id - - ProjectId - - Provider - - Status - - UpdatedAt - x-required-permissions: - create: - - datazone:CreateEnvironment - - datazone:GetEnvironment - - datazone:DeleteEnvironment - read: - - datazone:GetEnvironment - update: - - datazone:UpdateEnvironment - - datazone:GetEnvironment - - datazone:DeleteEnvironment - delete: - - datazone:DeleteEnvironment - - datazone:GetEnvironment - list: - - datazone:ListEnvironments - RegionalParameter: + - RelationalFilterConfigurations additionalProperties: false + RecommendationConfiguration: type: object + description: The recommendation to be updated as part of the UpdateDataSource action. properties: - Parameters: - $ref: '#/components/schemas/Parameter' - Region: - pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$ + EnableBusinessNameGeneration: + type: boolean + description: Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. + additionalProperties: false + RedshiftClusterStorage: + type: object + description: The name of an Amazon Redshift cluster. + properties: + ClusterName: type: string - Parameter: - x-patternProperties: - .+: + description: The name of an Amazon Redshift cluster. + maxLength: 63 + minLength: 1 + pattern: ^[0-9a-z].[a-z0-9\-]*$ + required: + - ClusterName + additionalProperties: false + RedshiftCredentialConfiguration: + type: object + description: The ARN of a secret manager for an Amazon Redshift cluster. + properties: + SecretManagerArn: type: string + description: The ARN of a secret manager for an Amazon Redshift cluster. + maxLength: 256 + pattern: ^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:secret:.*$ + required: + - SecretManagerArn additionalProperties: false + RedshiftRunConfigurationInput: type: object - EnvironmentBlueprintConfiguration: + description: The configuration details of the Amazon Redshift data source. + properties: + DataAccessRole: + description: The data access role included in the configuration details of the Amazon Redshift data source. + $ref: '#/components/schemas/DataAccessRole' + RelationalFilterConfigurations: + $ref: '#/components/schemas/RelationalFilterConfigurations' + RedshiftCredentialConfiguration: + description: The details of the credentials required to access an Amazon Redshift cluster. + $ref: '#/components/schemas/RedshiftCredentialConfiguration' + RedshiftStorage: + description: The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. + $ref: '#/components/schemas/RedshiftStorage' + required: + - RelationalFilterConfigurations + additionalProperties: false + RedshiftServerlessStorage: type: object + description: The details of the Amazon Redshift Serverless workgroup storage. properties: - RegionalParameters: - uniqueItems: true - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/RegionalParameter' - ProvisioningRoleArn: - pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ - type: string - DomainId: - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - type: string - CreatedAt: - format: date-time - type: string - EnabledRegions: - minItems: 0 - x-insertionOrder: false - type: array - items: - minLength: 4 - pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$ - type: string - maxLength: 16 - EnvironmentBlueprintIdentifier: - pattern: ^[a-zA-Z0-9_-]{1,36}$ - type: string - EnvironmentBlueprintId: - pattern: ^[a-zA-Z0-9_-]{1,36}$ - type: string - UpdatedAt: - format: date-time - type: string - DomainIdentifier: - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - type: string - ManageAccessRoleArn: - pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + WorkgroupName: type: string + description: The name of the Amazon Redshift Serverless workgroup. + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9-]+$ required: - - DomainIdentifier - - EnvironmentBlueprintIdentifier - - EnabledRegions - x-stackql-resource-name: environment_blueprint_configuration - x-stackql-primaryIdentifier: - - DomainId - - EnvironmentBlueprintId - x-create-only-properties: - - DomainIdentifier - - EnvironmentBlueprintIdentifier - x-read-only-properties: - - CreatedAt - - DomainId - - EnvironmentBlueprintId - - UpdatedAt - x-required-permissions: - read: - - datazone:GetEnvironmentBlueprintConfiguration - create: - - datazone:ListEnvironmentBlueprints - - iam:PassRole - - datazone:GetEnvironmentBlueprintConfiguration - - datazone:PutEnvironmentBlueprintConfiguration - update: - - datazone:DeleteEnvironmentBlueprintConfiguration - - iam:PassRole - - datazone:GetEnvironmentBlueprintConfiguration - - datazone:PutEnvironmentBlueprintConfiguration - list: - - datazone:ListEnvironmentBlueprintConfigurations - delete: - - datazone:GetEnvironmentBlueprintConfiguration - - datazone:DeleteEnvironmentBlueprintConfiguration - EnvironmentProfile: + - WorkgroupName + additionalProperties: false + RedshiftStorage: + description: The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. + oneOf: + - type: object + title: RedshiftClusterSource + description: The details of the Amazon Redshift cluster source. + properties: + RedshiftClusterSource: + $ref: '#/components/schemas/RedshiftClusterStorage' + required: + - RedshiftClusterSource + additionalProperties: false + - type: object + title: RedshiftServerlessSource + description: The details of the Amazon Redshift Serverless workgroup source. + properties: + RedshiftServerlessSource: + $ref: '#/components/schemas/RedshiftServerlessStorage' + required: + - RedshiftServerlessSource + additionalProperties: false + Region: type: object properties: - AwsAccountId: - description: The AWS account in which the Amazon DataZone environment is created. + RegionName: type: string - pattern: ^\d{12}$ - AwsAccountRegion: - description: The AWS region in which this environment profile is created. + maxLength: 16 + minLength: 4 + pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$ + required: + - RegionName + additionalProperties: false + RelationalFilterConfiguration: + type: object + description: The relational filter configuration for the data source. + properties: + DatabaseName: type: string - pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + description: The database name specified in the relational filter configuration for the data source. + maxLength: 128 + minLength: 1 + SchemaName: + type: string + description: The schema name specified in the relational filter configuration for the data source. + maxLength: 128 + minLength: 1 + FilterExpressions: + type: array + description: The filter expressions specified in the relational filter configuration for the data source. + items: + $ref: '#/components/schemas/FilterExpression' + x-insertionOrder: false + required: + - DatabaseName + additionalProperties: false + RelationalFilterConfigurations: + type: array + description: The relational filter configurations included in the configuration details of the Amazon Redshift data source. + items: + $ref: '#/components/schemas/RelationalFilterConfiguration' + x-insertionOrder: false + SageMakerRunConfigurationInput: + type: object + description: The configuration details of the Amazon SageMaker data source. + properties: + TrackingAssets: + description: The tracking assets of the Amazon SageMaker run. + $ref: '#/components/schemas/TrackingAssets' + required: + - TrackingAssets + additionalProperties: false + ScheduleConfiguration: + type: object + description: The schedule of the data source runs. + properties: + Timezone: + description: The timezone of the data source run. + $ref: '#/components/schemas/Timezone' + Schedule: + type: string + description: The schedule of the data source runs. + maxLength: 256 + minLength: 1 + pattern: cron\((\b[0-5]?[0-9]\b) (\b2[0-3]\b|\b[0-1]?[0-9]\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}\) + additionalProperties: false + Timezone: + type: string + TrackingAssets: + type: object + description: The tracking assets of the Amazon SageMaker run. + x-patternProperties: + ^.{1,64}$: + type: array + items: + type: string + pattern: ^arn:aws[^:]*:sagemaker:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:[\w+=,.@-]{1,128}/[\w+=,.@-]{1,256}$ + minItems: 0 + maxItems: 500 + maxProperties: 1 + additionalProperties: false + TypeRevision: + type: string + description: The revision of the metadata form type. + maxLength: 64 + minLength: 1 + DataSource: + type: object + properties: + AssetFormsInput: + type: array + description: The metadata forms that are to be attached to the assets that this data source works with. + items: + $ref: '#/components/schemas/FormInput' + maxItems: 10 + minItems: 0 + x-insertionOrder: false + ConnectionId: + type: string + description: The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run + ConnectionIdentifier: + type: string + description: The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run CreatedAt: - description: The timestamp of when this environment profile was created. type: string + description: The timestamp of when the data source was created. format: date-time - CreatedBy: - description: The Amazon DataZone user who created this environment profile. - type: string Description: - description: The description of this Amazon DataZone environment profile. type: string + description: The description of the data source. maxLength: 2048 DomainId: - description: The ID of the Amazon DataZone domain in which this environment profile is created. type: string + description: The ID of the Amazon DataZone domain where the data source is created. pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ DomainIdentifier: - description: The ID of the Amazon DataZone domain in which this environment profile is created. type: string + description: The ID of the Amazon DataZone domain where the data source is created. pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - EnvironmentBlueprintId: - description: The ID of the blueprint with which this environment profile is created. + EnableSetting: + description: Specifies whether the data source is enabled. + $ref: '#/components/schemas/EnableSetting' + EnvironmentId: type: string - pattern: ^[a-zA-Z0-9_-]{1,36}$ - EnvironmentBlueprintIdentifier: - description: The ID of the blueprint with which this environment profile is created. + description: The unique identifier of the Amazon DataZone environment to which the data source publishes assets. + EnvironmentIdentifier: + description: The unique identifier of the Amazon DataZone environment to which the data source publishes assets. type: string - pattern: ^[a-zA-Z0-9_-]{1,36}$ Id: - description: The ID of this Amazon DataZone environment profile. type: string + description: The unique identifier of the data source. pattern: ^[a-zA-Z0-9_-]{1,36}$ + Configuration: + description: Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration. + $ref: '#/components/schemas/DataSourceConfigurationInput' + LastRunAssetCount: + description: The number of assets created by the data source during its last run. + type: number + LastRunAt: + type: string + description: The timestamp that specifies when the data source was last run. + LastRunStatus: + description: The status of the last run of this data source. + type: string Name: - description: The name of this Amazon DataZone environment profile. type: string - maxLength: 64 + description: The name of the data source. + maxLength: 256 minLength: 1 - pattern: ^[\w -]+$ ProjectId: - description: The identifier of the project in which to create the environment profile. type: string + description: The ID of the Amazon DataZone project to which the data source is added. pattern: ^[a-zA-Z0-9_-]{1,36}$ ProjectIdentifier: - description: The identifier of the project in which to create the environment profile. type: string - pattern: ^[a-zA-Z0-9_-]{1,36}$ + description: The identifier of the Amazon DataZone project in which you want to add the data source. + PublishOnImport: + type: boolean + description: Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. + Recommendation: + $ref: '#/components/schemas/RecommendationConfiguration' + description: Specifies whether the business name generation is to be enabled for this data source. + Schedule: + description: The schedule of the data source runs. + $ref: '#/components/schemas/ScheduleConfiguration' + Status: + description: The status of the data source. + $ref: '#/components/schemas/DataSourceStatus' + Type: + type: string + description: The type of the data source. + maxLength: 256 + minLength: 1 UpdatedAt: - description: The timestamp of when this environment profile was updated. type: string + description: The timestamp of when this data source was updated. format: date-time - UserParameters: - description: The user parameters of this Amazon DataZone environment profile. - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/EnvironmentParameter' required: - - EnvironmentBlueprintIdentifier - - ProjectIdentifier - - DomainIdentifier - - AwsAccountId - - AwsAccountRegion - Name - x-stackql-resource-name: environment_profile - x-stackql-primaryIdentifier: + - DomainIdentifier + - ProjectIdentifier + - Type + x-stackql-resource-name: data_source + description: 'A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. ' + x-type-name: AWS::DataZone::DataSource + x-stackql-primary-identifier: - DomainId - Id x-create-only-properties: + - ConnectionIdentifier + - EnvironmentIdentifier - DomainIdentifier - - EnvironmentBlueprintIdentifier + - ProjectIdentifier + - Type + x-write-only-properties: + - AssetFormsInput + - ConnectionIdentifier + - EnvironmentIdentifier + - DomainIdentifier + - Configuration - ProjectIdentifier x-read-only-properties: + - ConnectionId - CreatedAt - - CreatedBy - DomainId - - EnvironmentBlueprintId + - EnvironmentId - Id + - LastRunAssetCount + - LastRunAt + - LastRunStatus - ProjectId + - Status - UpdatedAt + x-required-properties: + - Name + - DomainIdentifier + - ProjectIdentifier + - Type + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - datazone:CreateEnvironmentProfile - - datazone:GetEnvironmentProfile + - datazone:CreateDataSource + - iam:PassRole + - datazone:GetDataSource + - datazone:DeleteDataSource read: - - datazone:GetEnvironmentProfile + - datazone:GetDataSource update: - - datazone:UpdateEnvironmentProfile - - datazone:GetEnvironmentProfile + - datazone:UpdateDataSource + - datazone:GetDataSource + - datazone:DeleteDataSource delete: - - datazone:DeleteEnvironmentProfile - - datazone:GetEnvironmentProfile + - datazone:DeleteDataSource + - datazone:GetDataSource list: - - datazone:ListEnvironmentProfiles - Project: + - datazone:ListDataSources + AuthType: + type: string + description: The type of single sign-on in Amazon DataZone. + enum: + - IAM_IDC + - DISABLED + DomainStatus: + type: string + description: The status of the Amazon DataZone domain. + enum: + - CREATING + - AVAILABLE + - CREATION_FAILED + - DELETING + - DELETED + - DELETION_FAILED + SingleSignOn: + type: object + description: The single-sign on configuration of the Amazon DataZone domain. + properties: + Type: + $ref: '#/components/schemas/AuthType' + UserAssignment: + $ref: '#/components/schemas/UserAssignment' + IdcInstanceArn: + $ref: '#/components/schemas/IdcInstanceArn' + additionalProperties: false + Tag: + description: A key-value pair to associate with the domain. + type: object + properties: + Key: + type: string + description: The key name of the tag. + minLength: 1 + maxLength: 128 + Value: + type: string + description: The value for the tag. + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + UserAssignment: + type: string + description: The single sign-on user assignment in Amazon DataZone. + enum: + - AUTOMATIC + - MANUAL + IdcInstanceArn: + type: string + description: The ARN of the AWS Identity Center instance. + minLength: 10 + maxLength: 1224 + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + Domain: type: object properties: + RootDomainUnitId: + type: string + description: The ID of the root domain in Amazon Datazone. + pattern: ^[a-z0-9_\-]+$ + minLength: 1 + maxLength: 256 + Arn: + type: string + description: The ARN of the Amazon DataZone domain. + pattern: ^arn:aws(|-cn|-us-gov):datazone:\w+(?:-\w+)+:\d{12}:domain/dzd[-_][a-zA-Z0-9_-]{1,36}$ CreatedAt: - description: The timestamp of when the project was created. type: string + description: The timestamp of when the Amazon DataZone domain was last updated. format: date-time - CreatedBy: - description: The Amazon DataZone user who created the project. - type: string Description: - description: The description of the Amazon DataZone project. type: string - maxLength: 2048 - DomainId: - description: The identifier of the Amazon DataZone domain in which the project was created. + description: The description of the Amazon DataZone domain. + DomainExecutionRole: type: string - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - DomainIdentifier: - description: The ID of the Amazon DataZone domain in which this project is created. + description: The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain. + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + ServiceRole: type: string - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - GlossaryTerms: - description: The glossary terms that can be used in this Amazon DataZone project. - type: array - x-insertionOrder: false - items: - type: string - pattern: ^[a-zA-Z0-9_-]{1,36}$ - maxItems: 20 - minItems: 1 + description: The service role of the domain that is created. + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + DomainVersion: + type: string + description: The version of the domain. + enum: + - V1 + - V2 Id: - description: The ID of the Amazon DataZone project. type: string - pattern: ^[a-zA-Z0-9_-]{1,36}$ + description: The id of the Amazon DataZone domain. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + KmsKeyIdentifier: + type: string + maxLength: 1024 + description: The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ LastUpdatedAt: - description: The timestamp of when the project was last updated. type: string + description: The timestamp of when the Amazon DataZone domain was last updated. format: date-time + ManagedAccountId: + type: string + description: The identifier of the AWS account that manages the domain. Name: - description: The name of the Amazon DataZone project. type: string - maxLength: 64 - minLength: 1 - pattern: ^[\w -]+$ + description: The name of the Amazon DataZone domain. + PortalUrl: + type: string + description: The URL of the data portal for this Amazon DataZone domain. + SingleSignOn: + $ref: '#/components/schemas/SingleSignOn' + description: The single-sign on configuration of the Amazon DataZone domain. + Status: + $ref: '#/components/schemas/DomainStatus' + description: The status of the Amazon DataZone domain. + Tags: + type: array + description: The tags specified for the Amazon DataZone domain. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - - DomainIdentifier + - DomainExecutionRole - Name - x-stackql-resource-name: project - x-stackql-primaryIdentifier: - - DomainId + x-stackql-resource-name: domain + description: A domain is an organizing entity for connecting together assets, users, and their projects + x-type-name: AWS::DataZone::Domain + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Name x-create-only-properties: - - DomainIdentifier + - KmsKeyIdentifier + - DomainVersion x-read-only-properties: - - Id + - RootDomainUnitId + - Arn - CreatedAt - - CreatedBy - - DomainId + - Id - LastUpdatedAt + - ManagedAccountId + - PortalUrl + - Status + x-required-properties: + - DomainExecutionRole + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - datazone:TagResource + - datazone:UntagResource x-required-permissions: create: - - datazone:CreateProject - - datazone:GetProject + - datazone:CreateDomain + - datazone:UpdateDomain + - datazone:GetDomain + - datazone:TagResource + - sso:CreateManagedApplicationInstance + - sso:DeleteManagedApplicationInstance + - sso:PutApplicationAssignmentConfiguration + - sso:ListInstances + - sso:PutApplicationAccessScope + - sso:PutApplicationGrant + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationAccessScope + - sso:CreateApplication + - sso:DeleteApplication + - sso:CreateApplicationAssignment + - sso:DeleteApplicationAssignment + - iam:PassRole read: - - datazone:GetProject + - datazone:GetDomain update: - - datazone:UpdateProject - - datazone:GetProject + - datazone:UpdateDomain + - datazone:GetDomain + - datazone:TagResource + - datazone:UntagResource + - sso:CreateManagedApplicationInstance + - sso:DeleteManagedApplicationInstance + - sso:PutApplicationAssignmentConfiguration + - sso:ListInstances + - sso:PutApplicationAccessScope + - iam:PassRole delete: - - datazone:DeleteProject - - datazone:GetProject + - datazone:DeleteDomain + - datazone:GetDomain + - sso:DeleteManagedApplicationInstance + - sso:PutApplicationAssignmentConfiguration + - sso:DeleteApplication + - sso:DeleteApplicationAssignment + - sso:ListInstances list: - - datazone:ListProjects - SubscriptionTargetForm: + - datazone:ListDomains + DomainUnitGroupProperties: type: object - description: The details of the subscription target configuration. + description: The properties of a domain unit group. properties: - FormName: + GroupId: type: string - description: The form name included in the subscription target configuration. - maxLength: 128 - minLength: 1 - pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$ - Content: + description: The ID of the domain unit group. + additionalProperties: false + DomainUnitUserProperties: + type: object + description: The properties of the domain unit user. + properties: + UserId: type: string - description: The content of the subscription target configuration. - required: - - Content - - FormName + description: The ID of the domain unit user. additionalProperties: false - SubscriptionTarget: + DomainUnitOwnerProperties: type: object + description: The properties of the domain unit owner. properties: - ApplicableAssetTypes: - type: array - description: The asset types that can be included in the subscription target. - x-insertionOrder: false - items: - type: string - maxLength: 256 - minLength: 1 - pattern: ^[^\.]* - AuthorizedPrincipals: - type: array - description: The authorized principals of the subscription target. - x-insertionOrder: false - items: - type: string - pattern: ^[a-zA-Z0-9:/_-]*$ - maxItems: 10 - minItems: 1 - CreatedAt: + Group: + $ref: '#/components/schemas/DomainUnitGroupProperties' + User: + $ref: '#/components/schemas/DomainUnitUserProperties' + additionalProperties: false + DomainUnit: + type: object + properties: + DomainIdentifier: type: string - description: The timestamp of when the subscription target was created. - format: date-time - CreatedBy: + description: The ID of the domain where you want to create a domain unit. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Description: type: string - description: The Amazon DataZone user who created the subscription target. - DomainId: + description: The description of the domain unit. + minLength: 0 + maxLength: 2048 + Name: type: string - description: The ID of the Amazon DataZone domain in which subscription target is created. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - DomainIdentifier: + description: The name of the domain unit. + pattern: ^[\w -]+$ + minLength: 1 + maxLength: 128 + ParentDomainUnitIdentifier: type: string - description: The ID of the Amazon DataZone domain in which subscription target would be created. - pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ - EnvironmentId: + description: The ID of the parent domain unit. + pattern: ^[a-z0-9_-]+$ + minLength: 1 + maxLength: 256 + CreatedAt: type: string - description: The ID of the environment in which subscription target is created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - EnvironmentIdentifier: + description: The timestamp at which the domain unit was created. + format: date-time + DomainId: type: string - description: The ID of the environment in which subscription target would be created. - pattern: ^[a-zA-Z0-9_-]{1,36}$ + description: The ID of the domain where the domain unit was created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ Id: type: string - description: The ID of the subscription target. - pattern: ^[a-zA-Z0-9_-]{1,36}$ - ManageAccessRole: - type: string - description: The manage access role that is used to create the subscription target. - Name: + description: The ID of the domain unit. + pattern: ^[a-z0-9_-]+$ + minLength: 1 + maxLength: 256 + ParentDomainUnitId: type: string - description: The name of the subscription target. + description: The ID of the parent domain unit. + pattern: ^[a-z0-9_-]+$ + minLength: 1 maxLength: 256 + Identifier: + type: string + description: The identifier of the domain unit that you want to get. + pattern: ^[a-z0-9_-]+$ minLength: 1 - ProjectId: + maxLength: 256 + LastUpdatedAt: type: string - description: The identifier of the project specified in the subscription target. + description: The timestamp at which the domain unit was last updated. + format: date-time + required: + - DomainIdentifier + - Name + - ParentDomainUnitIdentifier + x-stackql-resource-name: domain_unit + description: A domain unit enables you to easily organize your assets and other domain entities under specific business units and teams. + x-type-name: AWS::DataZone::DomainUnit + x-stackql-primary-identifier: + - DomainId + - Id + x-create-only-properties: + - DomainIdentifier + - ParentDomainUnitIdentifier + x-read-only-properties: + - CreatedAt + - DomainId + - Id + - Identifier + - ParentDomainUnitId + - LastUpdatedAt + x-required-properties: + - DomainIdentifier + - Name + - ParentDomainUnitIdentifier + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateDomainUnit + - datazone:GetDomainUnit + read: + - datazone:GetDomainUnit + update: + - datazone:UpdateDomainUnit + - datazone:GetDomainUnit + delete: + - datazone:DeleteDomainUnit + - datazone:GetDomainUnit + list: + - datazone:ListDomainUnitsForParent + EnvironmentParameter: + type: object + properties: + Name: + type: string + Value: + type: string + additionalProperties: false + EnvironmentStatus: + type: string + description: The status of the Amazon DataZone environment. + enum: + - ACTIVE + - CREATING + - UPDATING + - DELETING + - CREATE_FAILED + - UPDATE_FAILED + - DELETE_FAILED + - VALIDATION_FAILED + - SUSPENDED + - DISABLED + - EXPIRED + - DELETED + - INACCESSIBLE + Environment: + type: object + properties: + AwsAccountId: + type: string + description: The AWS account in which the Amazon DataZone environment is created. + pattern: ^\d{12}$ + AwsAccountRegion: + type: string + description: The AWS region in which the Amazon DataZone environment is created. + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + EnvironmentAccountIdentifier: + type: string + description: The AWS account in which the Amazon DataZone environment is created. + pattern: ^\d{12}$ + EnvironmentAccountRegion: + type: string + description: The AWS region in which the Amazon DataZone environment is created. + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + CreatedAt: + type: string + description: The timestamp of when the environment was created. + format: date-time + CreatedBy: + type: string + description: The Amazon DataZone user who created the environment. + Description: + type: string + description: The description of the Amazon DataZone environment. + maxLength: 2048 + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the environment is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the environment would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintId: + type: string + description: The ID of the blueprint with which the Amazon DataZone environment was created. pattern: ^[a-zA-Z0-9_-]{1,36}$ - Provider: + EnvironmentProfileId: type: string - description: The provider of the subscription target. - SubscriptionTargetConfig: + description: The ID of the environment profile with which the Amazon DataZone environment was created. + pattern: ^[a-zA-Z0-9_-]{0,36}$ + EnvironmentProfileIdentifier: + type: string + description: The ID of the environment profile with which the Amazon DataZone environment would be created. + pattern: ^[a-zA-Z0-9_-]{0,36}$ + GlossaryTerms: type: array - description: The configuration of the subscription target. x-insertionOrder: false + description: The glossary terms that can be used in the Amazon DataZone environment. items: - $ref: '#/components/schemas/SubscriptionTargetForm' - Type: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxItems: 20 + minItems: 1 + EnvironmentRoleArn: type: string - description: The type of the subscription target. + description: Environment role arn for custom aws environment permissions + Id: + type: string + description: The ID of the Amazon DataZone environment. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Name: + type: string + description: The name of the environment. + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + ProjectId: + type: string + description: The ID of the Amazon DataZone project in which the environment is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectIdentifier: + type: string + description: The ID of the Amazon DataZone project in which the environment would be created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Provider: + type: string + description: The provider of the Amazon DataZone environment. + Status: + $ref: '#/components/schemas/EnvironmentStatus' + description: The status of the Amazon DataZone environment. UpdatedAt: type: string - description: The timestamp of when the subscription target was updated. + description: The timestamp of when the environment was updated. format: date-time - UpdatedBy: - type: string - description: The Amazon DataZone user who updated the subscription target. + UserParameters: + type: array + x-insertionOrder: false + description: The user parameters of the Amazon DataZone environment. + items: + $ref: '#/components/schemas/EnvironmentParameter' required: - - ApplicableAssetTypes - - AuthorizedPrincipals - - DomainIdentifier - - EnvironmentIdentifier - - ManageAccessRole - Name - - SubscriptionTargetConfig - - Type - x-stackql-resource-name: subscription_target - x-stackql-primaryIdentifier: + - ProjectIdentifier + - DomainIdentifier + x-stackql-resource-name: environment + description: Definition of AWS::DataZone::Environment Resource Type + x-type-name: AWS::DataZone::Environment + x-stackql-primary-identifier: - DomainId - - EnvironmentId - Id + x-stackql-additional-identifiers: + - - DomainIdentifier x-create-only-properties: - - Type - DomainIdentifier - - EnvironmentIdentifier + - EnvironmentProfileIdentifier + - ProjectIdentifier + - UserParameters + - EnvironmentAccountIdentifier + - EnvironmentAccountRegion + x-write-only-properties: + - EnvironmentProfileIdentifier + - ProjectIdentifier + - DomainIdentifier + - EnvironmentAccountIdentifier + - EnvironmentAccountRegion + - EnvironmentRoleArn x-read-only-properties: + - AwsAccountId + - AwsAccountRegion - CreatedAt - CreatedBy - DomainId - - EnvironmentId + - EnvironmentBlueprintId + - EnvironmentProfileId - Id - ProjectId + - Provider + - Status - UpdatedAt - - UpdatedBy + x-required-properties: + - Name + - ProjectIdentifier + - DomainIdentifier + x-tagging: + taggable: false x-required-permissions: create: - - datazone:CreateSubscriptionTarget - - datazone:GetSubscriptionTarget + - datazone:CreateEnvironment + - datazone:GetEnvironment + - datazone:DeleteEnvironment + - datazone:AssociateEnvironmentRole - iam:PassRole read: - - datazone:GetSubscriptionTarget + - datazone:GetEnvironment update: - - datazone:UpdateSubscriptionTarget - - datazone:GetSubscriptionTarget + - datazone:UpdateEnvironment + - datazone:GetEnvironment + - datazone:DeleteEnvironment + - datazone:AssociateEnvironmentRole + - datazone:DisassociateEnvironmentRole - iam:PassRole delete: - - datazone:DeleteSubscriptionTarget + - datazone:DeleteEnvironment + - datazone:GetEnvironment list: - - datazone:ListSubscriptionTargets - x-stackQL-resources: - data_sources: - name: data_sources - id: awscc.datazone.data_sources - x-cfn-schema-name: DataSource - x-type: list + - datazone:ListEnvironments + EnvironmentActionURI: + type: string + description: The URI of the console link specified as part of the environment action. + minLength: 1 + maxLength: 2048 + AwsConsoleLinkParameters: + type: object + description: The parameters of the console link specified as part of the environment action + properties: + Uri: + $ref: '#/components/schemas/EnvironmentActionURI' + additionalProperties: false + EnvironmentActions: + type: object + properties: + Description: + type: string + description: The description of the Amazon DataZone environment action. + maxLength: 2048 + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the environment is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the environment would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentId: + type: string + description: The identifier of the Amazon DataZone environment in which the action is taking place + pattern: '[a-zA-Z0-9_-]{1,36}$' + maxLength: 36 + minLength: 1 + EnvironmentIdentifier: + type: string + description: The identifier of the Amazon DataZone environment in which the action is taking place + pattern: '[a-zA-Z0-9_-]{1,36}$' + maxLength: 36 + minLength: 1 + Id: + type: string + description: The ID of the Amazon DataZone environment action. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxLength: 36 + minLength: 1 + Identifier: + type: string + description: The ID of the Amazon DataZone environment action. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxLength: 36 + minLength: 1 + Name: + type: string + description: The name of the environment action. + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + Parameters: + description: The parameters of the environment action. + $ref: '#/components/schemas/AwsConsoleLinkParameters' + required: + - Name + x-stackql-resource-name: environment_actions + description: Definition of AWS::DataZone::EnvironmentActions Resource Type + x-type-name: AWS::DataZone::EnvironmentActions + x-stackql-primary-identifier: + - DomainId + - EnvironmentId + - Id + x-stackql-additional-identifiers: + - - EnvironmentIdentifier + x-create-only-properties: + - DomainIdentifier + - EnvironmentIdentifier + x-write-only-properties: + - EnvironmentIdentifier + - DomainIdentifier + - Identifier + x-read-only-properties: + - DomainId + - EnvironmentId + - Id + x-required-properties: + - Name + x-tagging: + taggable: false + x-required-permissions: + create: + - datazone:CreateEnvironmentAction + - datazone:GetEnvironmentAction + - datazone:DeleteEnvironmentAction + read: + - datazone:GetEnvironmentAction + update: + - datazone:UpdateEnvironmentAction + - datazone:GetEnvironmentAction + - datazone:DeleteEnvironmentAction + delete: + - datazone:DeleteEnvironmentAction + - datazone:GetEnvironmentAction + list: + - datazone:ListEnvironmentActions + ProvisioningConfiguration: + oneOf: + - additionalProperties: false + type: object + title: LakeFormationConfiguration + properties: + LakeFormationConfiguration: + $ref: '#/components/schemas/LakeFormationConfiguration' + required: + - LakeFormationConfiguration + LakeFormationConfiguration: + additionalProperties: false + type: object + properties: + LocationRegistrationExcludeS3Locations: + minItems: 0 + maxItems: 20 + type: array + items: + minLength: 1 + pattern: ^s3://.+$ + type: string + maxLength: 1024 + LocationRegistrationRole: + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + type: string + RegionalParameter: + additionalProperties: false + type: object + properties: + Parameters: + $ref: '#/components/schemas/Parameter' + Region: + pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$ + type: string + Parameter: + x-patternProperties: + .+: + type: string + additionalProperties: false + type: object + EnvironmentBlueprintConfiguration: + type: object + properties: + CreatedAt: + format: date-time + type: string + EnabledRegions: + minItems: 0 + x-insertionOrder: false + type: array + items: + minLength: 4 + pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$ + type: string + maxLength: 16 + EnvironmentBlueprintIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + EnvironmentBlueprintId: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + UpdatedAt: + format: date-time + type: string + RegionalParameters: + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/RegionalParameter' + ProvisioningRoleArn: + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + type: string + DomainId: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + ProvisioningConfigurations: + type: array + items: + $ref: '#/components/schemas/ProvisioningConfiguration' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + EnvironmentRolePermissionBoundary: + pattern: ^arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*$ + type: string + ManageAccessRoleArn: + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + type: string + required: + - DomainIdentifier + - EnvironmentBlueprintIdentifier + - EnabledRegions + x-stackql-resource-name: environment_blueprint_configuration + description: Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type + x-type-name: AWS::DataZone::EnvironmentBlueprintConfiguration + x-stackql-primary-identifier: + - DomainId + - EnvironmentBlueprintId + x-stackql-additional-identifiers: + - - DomainIdentifier + - EnvironmentBlueprintIdentifier + x-create-only-properties: + - DomainIdentifier + - EnvironmentBlueprintIdentifier + x-write-only-properties: + - DomainIdentifier + - EnvironmentBlueprintIdentifier + - EnvironmentRolePermissionBoundary + - ProvisioningConfigurations + x-read-only-properties: + - CreatedAt + - DomainId + - EnvironmentBlueprintId + - UpdatedAt + x-required-properties: + - DomainIdentifier + - EnvironmentBlueprintIdentifier + - EnabledRegions + x-tagging: + taggable: false + x-required-permissions: + read: + - datazone:GetEnvironmentBlueprintConfiguration + create: + - datazone:ListEnvironmentBlueprints + - iam:PassRole + - datazone:GetEnvironmentBlueprintConfiguration + - datazone:PutEnvironmentBlueprintConfiguration + update: + - datazone:DeleteEnvironmentBlueprintConfiguration + - iam:PassRole + - datazone:GetEnvironmentBlueprintConfiguration + - datazone:PutEnvironmentBlueprintConfiguration + list: + - datazone:ListEnvironmentBlueprintConfigurations + delete: + - datazone:GetEnvironmentBlueprintConfiguration + - datazone:DeleteEnvironmentBlueprintConfiguration + EnvironmentProfile: + type: object + properties: + AwsAccountId: + description: The AWS account in which the Amazon DataZone environment is created. + type: string + pattern: ^\d{12}$ + AwsAccountRegion: + description: The AWS region in which this environment profile is created. + type: string + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + CreatedAt: + description: The timestamp of when this environment profile was created. + type: string + format: date-time + CreatedBy: + description: The Amazon DataZone user who created this environment profile. + type: string + Description: + description: The description of this Amazon DataZone environment profile. + type: string + maxLength: 2048 + DomainId: + description: The ID of the Amazon DataZone domain in which this environment profile is created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + description: The ID of the Amazon DataZone domain in which this environment profile is created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintId: + description: The ID of the blueprint with which this environment profile is created. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintIdentifier: + description: The ID of the blueprint with which this environment profile is created. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Id: + description: The ID of this Amazon DataZone environment profile. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Name: + description: The name of this Amazon DataZone environment profile. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + ProjectId: + description: The identifier of the project in which to create the environment profile. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectIdentifier: + description: The identifier of the project in which to create the environment profile. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + UpdatedAt: + description: The timestamp of when this environment profile was updated. + type: string + format: date-time + UserParameters: + description: The user parameters of this Amazon DataZone environment profile. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EnvironmentParameter' + required: + - EnvironmentBlueprintIdentifier + - ProjectIdentifier + - DomainIdentifier + - AwsAccountId + - AwsAccountRegion + - Name + x-stackql-resource-name: environment_profile + description: AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments. + x-type-name: AWS::DataZone::EnvironmentProfile + x-stackql-primary-identifier: + - DomainId + - Id + x-stackql-additional-identifiers: + - - DomainIdentifier + x-create-only-properties: + - DomainIdentifier + - EnvironmentBlueprintIdentifier + - ProjectIdentifier + x-write-only-properties: + - EnvironmentBlueprintIdentifier + - ProjectIdentifier + - DomainIdentifier + x-read-only-properties: + - CreatedAt + - CreatedBy + - DomainId + - EnvironmentBlueprintId + - Id + - ProjectId + - UpdatedAt + x-required-properties: + - EnvironmentBlueprintIdentifier + - ProjectIdentifier + - DomainIdentifier + - AwsAccountId + - AwsAccountRegion + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateEnvironmentProfile + - datazone:GetEnvironmentProfile + read: + - datazone:GetEnvironmentProfile + update: + - datazone:UpdateEnvironmentProfile + - datazone:GetEnvironmentProfile + delete: + - datazone:DeleteEnvironmentProfile + - datazone:GetEnvironmentProfile + list: + - datazone:ListEnvironmentProfiles + GroupProfileStatus: + type: string + description: The status of the group profile. + enum: + - ASSIGNED + - NOT_ASSIGNED + GroupProfile: + type: object + properties: + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + GroupIdentifier: + type: string + description: The ID of the group. + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+) + GroupName: + type: string + description: The group-name of the Group Profile. + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z_0-9+=,.@-]+$ + Id: + type: string + description: The ID of the Amazon DataZone group profile. + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + Status: + $ref: '#/components/schemas/GroupProfileStatus' + required: + - DomainIdentifier + - GroupIdentifier + x-stackql-resource-name: group_profile + description: >- + Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user + statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies. + x-type-name: AWS::DataZone::GroupProfile + x-stackql-primary-identifier: + - DomainId + - Id + x-create-only-properties: + - DomainIdentifier + - GroupIdentifier + x-write-only-properties: + - DomainIdentifier + - GroupIdentifier + x-read-only-properties: + - DomainId + - GroupName + - Id + x-required-properties: + - DomainIdentifier + - GroupIdentifier + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateGroupProfile + - datazone:GetGroupProfile + - datazone:UpdateGroupProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + read: + - datazone:GetGroupProfile + update: + - datazone:UpdateGroupProfile + - datazone:GetGroupProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + delete: + - datazone:DeleteGroupProfile + - datazone:GetGroupProfile + - datazone:UpdateGroupProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + list: + - datazone:SearchGroupProfiles + OwnerUserPropertiesOutput: + description: The properties of the owner user. + additionalProperties: false + type: object + properties: + UserId: + description: The ID of the owner user. + type: string + OwnerUserProperties: + description: The properties of the owner user. + additionalProperties: false + type: object + properties: + UserIdentifier: + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$) + description: The ID of the owner user. + type: string + OwnerGroupPropertiesOutput: + description: The properties of the domain unit owners group. + additionalProperties: false + type: object + properties: + GroupId: + description: The ID of the domain unit owners group. + type: string + OwnerGroupProperties: + description: The properties of the domain unit owners group. + additionalProperties: false + type: object + properties: + GroupIdentifier: + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+) + description: The ID of the domain unit owners group. + type: string + OwnerPropertiesOutput: + description: The ID of the domain unit owners group. + additionalProperties: false + type: object + properties: + Group: + $ref: '#/components/schemas/OwnerGroupPropertiesOutput' + User: + $ref: '#/components/schemas/OwnerUserPropertiesOutput' + OwnerProperties: + oneOf: + - additionalProperties: false + properties: + Group: + $ref: '#/components/schemas/OwnerGroupProperties' + - additionalProperties: false + properties: + User: + $ref: '#/components/schemas/OwnerUserProperties' + description: The properties of a domain unit's owner. + type: object + Owner: + type: object + properties: + EntityType: + description: The type of an entity. + type: string + enum: + - DOMAIN_UNIT + Owner: + description: The owner that you want to add to the entity. + $ref: '#/components/schemas/OwnerProperties' + EntityIdentifier: + description: The ID of the entity to which you want to add an owner. + type: string + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + description: The ID of the domain in which you want to add the entity owner. + type: string + required: + - DomainIdentifier + - EntityIdentifier + - EntityType + - Owner + x-stackql-resource-name: owner + description: A owner can set up authorization permissions on their resources. + x-type-name: AWS::DataZone::Owner + x-stackql-primary-identifier: + - DomainIdentifier + - EntityType + - EntityIdentifier + - OwnerType + - OwnerIdentifier + x-create-only-properties: + - DomainIdentifier + - EntityIdentifier + - EntityType + - Owner + x-write-only-properties: + - Owner + x-required-properties: + - DomainIdentifier + - EntityIdentifier + - EntityType + - Owner + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - datazone:ListEntityOwners + - iam:GetRole + create: + - datazone:AddEntityOwner + - datazone:ListEntityOwners + - datazone:GetGroupProfile + - datazone:GetUserProfile + - iam:GetRole + list: + - datazone:ListEntityOwners + - iam:GetRole + delete: + - datazone:RemoveEntityOwner + - datazone:GetUserProfile + - iam:GetRole + AllUsersGrantFilter: + additionalProperties: false + type: object + ProjectDesignation: + type: string + enum: + - OWNER + - CONTRIBUTOR + - PROJECT_CATALOG_STEWARD + CreateProjectFromProjectProfilePolicyGrantDetail: + additionalProperties: false + type: object + properties: + ProjectProfiles: + x-insertionOrder: false + type: array + items: + type: string + IncludeChildDomainUnits: + type: boolean + OverrideProjectOwnersPolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + Unit: + additionalProperties: false + type: object + CreateEnvironmentProfilePolicyGrantDetail: + additionalProperties: false + type: object + properties: + DomainUnitId: + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + type: string + maxLength: 256 + GroupPolicyGrantPrincipal: + oneOf: + - additionalProperties: false + type: object + title: GroupIdentifier + properties: + GroupIdentifier: + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+) + type: string + required: + - GroupIdentifier + TargetEntityType: + type: string + enum: + - DomainUnit + - EnvironmentBlueprintConfiguration + - EnvironmentProfile + - DOMAIN_UNIT + - ENVIRONMENT_BLUEPRINT_CONFIGURATION + - ENVIRONMENT_PROFILE + - ASSET_TYPE + DomainUnitFilterForProject: + additionalProperties: false + type: object + properties: + DomainUnit: + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + type: string + maxLength: 256 + IncludeChildDomainUnits: + default: false + type: boolean + required: + - DomainUnit + UserPolicyGrantPrincipal: + oneOf: + - additionalProperties: false + type: object + title: UserIdentifier + properties: + UserIdentifier: + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws[^:]*:iam::\d{12}:.+$) + type: string + required: + - UserIdentifier + - additionalProperties: false + type: object + title: AllUsersGrantFilter + properties: + AllUsersGrantFilter: + $ref: '#/components/schemas/AllUsersGrantFilter' + required: + - AllUsersGrantFilter + PolicyGrantPrincipal: + oneOf: + - additionalProperties: false + type: object + title: User + properties: + User: + $ref: '#/components/schemas/UserPolicyGrantPrincipal' + required: + - User + - additionalProperties: false + type: object + title: Group + properties: + Group: + $ref: '#/components/schemas/GroupPolicyGrantPrincipal' + required: + - Group + - additionalProperties: false + type: object + title: Project + properties: + Project: + $ref: '#/components/schemas/ProjectPolicyGrantPrincipal' + required: + - Project + - additionalProperties: false + type: object + title: DomainUnit + properties: + DomainUnit: + $ref: '#/components/schemas/DomainUnitPolicyGrantPrincipal' + required: + - DomainUnit + CreateAssetTypePolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + DomainUnitDesignation: + type: string + enum: + - OWNER + DomainUnitGrantFilter: + oneOf: + - additionalProperties: false + type: object + title: AllDomainUnitsGrantFilter + properties: + AllDomainUnitsGrantFilter: + $ref: '#/components/schemas/AllDomainUnitsGrantFilter' + required: + - AllDomainUnitsGrantFilter + ProjectPolicyGrantPrincipal: + additionalProperties: false + type: object + properties: + ProjectIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + ProjectDesignation: + $ref: '#/components/schemas/ProjectDesignation' + ProjectGrantFilter: + $ref: '#/components/schemas/ProjectGrantFilter' + CreateFormTypePolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + DomainUnitPolicyGrantPrincipal: + additionalProperties: false + type: object + properties: + DomainUnitGrantFilter: + $ref: '#/components/schemas/DomainUnitGrantFilter' + DomainUnitDesignation: + $ref: '#/components/schemas/DomainUnitDesignation' + DomainUnitIdentifier: + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + type: string + maxLength: 256 + CreateDomainUnitPolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + PolicyGrantDetail: + oneOf: + - additionalProperties: false + type: object + title: CreateDomainUnit + properties: + CreateDomainUnit: + $ref: '#/components/schemas/CreateDomainUnitPolicyGrantDetail' + required: + - CreateDomainUnit + - additionalProperties: false + type: object + title: OverrideDomainUnitOwners + properties: + OverrideDomainUnitOwners: + $ref: '#/components/schemas/OverrideDomainUnitOwnersPolicyGrantDetail' + required: + - OverrideDomainUnitOwners + - additionalProperties: false + type: object + title: AddToProjectMemberPool + properties: + AddToProjectMemberPool: + $ref: '#/components/schemas/AddToProjectMemberPoolPolicyGrantDetail' + required: + - AddToProjectMemberPool + - additionalProperties: false + type: object + title: OverrideProjectOwners + properties: + OverrideProjectOwners: + $ref: '#/components/schemas/OverrideProjectOwnersPolicyGrantDetail' + required: + - OverrideProjectOwners + - additionalProperties: false + type: object + title: CreateGlossary + properties: + CreateGlossary: + $ref: '#/components/schemas/CreateGlossaryPolicyGrantDetail' + required: + - CreateGlossary + - additionalProperties: false + type: object + title: CreateFormType + properties: + CreateFormType: + $ref: '#/components/schemas/CreateFormTypePolicyGrantDetail' + required: + - CreateFormType + - additionalProperties: false + type: object + title: CreateAssetType + properties: + CreateAssetType: + $ref: '#/components/schemas/CreateAssetTypePolicyGrantDetail' + required: + - CreateAssetType + - additionalProperties: false + type: object + title: CreateProject + properties: + CreateProject: + $ref: '#/components/schemas/CreateProjectPolicyGrantDetail' + required: + - CreateProject + - additionalProperties: false + type: object + title: CreateEnvironmentProfile + properties: + CreateEnvironmentProfile: + $ref: '#/components/schemas/CreateEnvironmentProfilePolicyGrantDetail' + required: + - CreateEnvironmentProfile + - additionalProperties: false + type: object + title: DelegateCreateEnvironmentProfile + properties: + DelegateCreateEnvironmentProfile: + $ref: '#/components/schemas/Unit' + required: + - DelegateCreateEnvironmentProfile + - additionalProperties: false + type: object + title: CreateEnvironment + properties: + CreateEnvironment: + $ref: '#/components/schemas/Unit' + required: + - CreateEnvironment + - additionalProperties: false + type: object + title: CreateEnvironmentFromBlueprint + properties: + CreateEnvironmentFromBlueprint: + $ref: '#/components/schemas/Unit' + required: + - CreateEnvironmentFromBlueprint + - additionalProperties: false + type: object + title: CreateProjectFromProjectProfile + properties: + CreateProjectFromProjectProfile: + $ref: '#/components/schemas/CreateProjectFromProjectProfilePolicyGrantDetail' + required: + - CreateProjectFromProjectProfile + ProjectGrantFilter: + oneOf: + - additionalProperties: false + type: object + title: DomainUnitFilter + properties: + DomainUnitFilter: + $ref: '#/components/schemas/DomainUnitFilterForProject' + required: + - DomainUnitFilter + AllDomainUnitsGrantFilter: + additionalProperties: false + type: object + CreateGlossaryPolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + ManagedPolicyType: + type: string + OverrideDomainUnitOwnersPolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + CreateProjectPolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + AddToProjectMemberPoolPolicyGrantDetail: + additionalProperties: false + type: object + properties: + IncludeChildDomainUnits: + type: boolean + PolicyGrant: + type: object + properties: + EntityType: + $ref: '#/components/schemas/TargetEntityType' + PolicyType: + $ref: '#/components/schemas/ManagedPolicyType' + CreatedBy: + description: Specifies the user who created the policy grant member. + type: string + CreatedAt: + format: date-time + description: Specifies the timestamp at which policy grant member was created. + type: string + GrantId: + pattern: ^[A-Za-z0-9+/]{10}$ + description: The unique identifier of the policy grant returned by the AddPolicyGrant API + type: string + EntityIdentifier: + type: string + Detail: + type: object + $ref: '#/components/schemas/PolicyGrantDetail' + Principal: + type: object + $ref: '#/components/schemas/PolicyGrantPrincipal' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + required: + - DomainIdentifier + - EntityIdentifier + - EntityType + - PolicyType + x-stackql-resource-name: policy_grant + description: Policy Grant in AWS DataZone is an explicit authorization assignment that allows a specific principal (user, group, or project) to perform particular actions (such as creating glossary terms, managing projects, or accessing resources) on governed resources within a certain scope (like a Domain Unit or Project). Policy Grants are essentially the mechanism by which DataZone enforces fine-grained, role-based access control beyond what is possible through AWS IAM alone. + x-type-name: AWS::DataZone::PolicyGrant + x-stackql-primary-identifier: + - DomainIdentifier + - GrantId + - EntityIdentifier + - EntityType + - PolicyType + x-create-only-properties: + - Detail + - DomainIdentifier + - EntityIdentifier + - EntityType + - PolicyType + - Principal + x-write-only-properties: + - Principal/Project/ProjectGrantFilter + - Principal/Project/ProjectGrantFilter/DomainUnitFilter + - Principal/Project/ProjectGrantFilter/DomainUnitFilter/DomainUnit + - Principal/Project/ProjectGrantFilter/DomainUnitFilter/IncludeChildDomainUnits + - Principal/DomainUnit/DomainUnitGrantFilter + - Principal/DomainUnit/DomainUnitGrantFilter/AllDomainUnitsGrantFilter + x-read-only-properties: + - GrantId + - CreatedAt + - CreatedBy + x-required-properties: + - DomainIdentifier + - EntityIdentifier + - EntityType + - PolicyType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - datazone:ListPolicyGrants + create: + - datazone:AddPolicyGrant + - datazone:ListPolicyGrants + list: + - datazone:ListPolicyGrants + delete: + - datazone:RemovePolicyGrant + - datazone:ListPolicyGrants + EnvironmentConfigurationUserParameter: + type: object + properties: + EnvironmentId: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentConfigurationName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + EnvironmentParameters: + type: array + items: + $ref: '#/components/schemas/EnvironmentParameter' + additionalProperties: false + EnvironmentDeploymentDetails: + type: object + properties: + OverallDeploymentStatus: + $ref: '#/components/schemas/OverallDeploymentStatus' + EnvironmentFailureReasons: + $ref: '#/components/schemas/EnvironmentFailureReasons' + additionalProperties: false + EnvironmentError: + type: object + properties: + Code: + type: string + Message: + type: string + required: + - Message + additionalProperties: false + EnvironmentFailureReasons: + type: object + x-patternProperties: + .+: + type: array + items: + $ref: '#/components/schemas/EnvironmentError' + additionalProperties: false + EnvironmentResolvedAccount: + type: object + properties: + AwsAccountId: + type: string + pattern: ^\d{12}$ + RegionName: + type: string + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + SourceAccountPoolId: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + required: + - AwsAccountId + - RegionName + - SourceAccountPoolId + additionalProperties: false + OverallDeploymentStatus: + type: string + enum: + - PENDING_DEPLOYMENT + - IN_PROGRESS + - SUCCESSFUL + - FAILED_VALIDATION + - FAILED_DEPLOYMENT + ProjectDeletionError: + type: object + description: Error that occurred during project deletion + properties: + Code: + type: string + description: Project Deletion Error Code + Message: + type: string + description: Project Deletion Error Message + additionalProperties: false + ProjectStatus: + type: string + enum: + - ACTIVE + - MOVING + - DELETING + - DELETE_FAILED + - UPDATING + - UPDATE_FAILED + Tags: + type: object + x-patternProperties: + ^[\w \.:/=+@-]+$: + type: string + maxLength: 256 + pattern: ^[\w \.:/=+@-]*$ + additionalProperties: false + Project: + type: object + properties: + CreatedAt: + description: The timestamp of when the project was created. + type: string + format: date-time + CreatedBy: + description: The Amazon DataZone user who created the project. + type: string + Description: + description: The description of the Amazon DataZone project. + type: string + maxLength: 2048 + DomainId: + description: The identifier of the Amazon DataZone domain in which the project was created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + description: The ID of the Amazon DataZone domain in which this project is created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainUnitId: + description: The ID of the domain unit. + type: string + pattern: ^[a-z0-9_\-]+$ + GlossaryTerms: + description: The glossary terms that can be used in this Amazon DataZone project. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxItems: 20 + minItems: 1 + Id: + description: The ID of the Amazon DataZone project. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + LastUpdatedAt: + description: The timestamp of when the project was last updated. + type: string + format: date-time + Name: + description: The name of the Amazon DataZone project. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + ProjectProfileId: + description: The project profile ID. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectProfileVersion: + description: 'The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.' + type: string + ProjectStatus: + description: The status of the project. + $ref: '#/components/schemas/ProjectStatus' + UserParameters: + description: The user parameters of the project. + type: array + items: + $ref: '#/components/schemas/EnvironmentConfigurationUserParameter' + required: + - DomainIdentifier + - Name + x-stackql-resource-name: project + description: Amazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics. + x-type-name: AWS::DataZone::Project + x-stackql-primary-identifier: + - DomainId + - Id + x-stackql-additional-identifiers: + - - DomainIdentifier + x-create-only-properties: + - ProjectProfileId + - DomainIdentifier + x-write-only-properties: + - DomainIdentifier + - ProjectProfileVersion + - ProjectProfileId + - UserParameters + x-read-only-properties: + - Id + - CreatedAt + - CreatedBy + - DomainId + - LastUpdatedAt + - ProjectStatus + x-required-properties: + - DomainIdentifier + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateProject + - datazone:GetProject + read: + - datazone:GetProject + update: + - datazone:UpdateProject + - datazone:GetProject + delete: + - datazone:DeleteProject + - datazone:GetProject + list: + - datazone:ListProjects + UserDesignation: + type: string + enum: + - PROJECT_OWNER + - PROJECT_CONTRIBUTOR + - PROJECT_CATALOG_VIEWER + - PROJECT_CATALOG_CONSUMER + - PROJECT_CATALOG_STEWARD + MemberIdentifierType: + type: string + enum: + - USER_IDENTIFIER + - GROUP_IDENTIFIER + Member: + oneOf: + - additionalProperties: false + type: object + title: UserIdentifier + properties: + UserIdentifier: + type: string + required: + - UserIdentifier + - additionalProperties: false + type: object + title: GroupIdentifier + properties: + GroupIdentifier: + type: string + required: + - GroupIdentifier + ProjectMembership: + type: object + properties: + ProjectIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + Designation: + $ref: '#/components/schemas/UserDesignation' + Member: + $ref: '#/components/schemas/Member' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + required: + - Designation + - DomainIdentifier + - ProjectIdentifier + - Member + x-stackql-resource-name: project_membership + description: Definition of AWS::DataZone::ProjectMembership Resource Type + x-type-name: AWS::DataZone::ProjectMembership + x-stackql-primary-identifier: + - DomainIdentifier + - MemberIdentifier + - MemberIdentifierType + - ProjectIdentifier + x-create-only-properties: + - DomainIdentifier + - ProjectIdentifier + - Member + x-write-only-properties: + - Designation + - Member + x-required-properties: + - Designation + - DomainIdentifier + - ProjectIdentifier + - Member + x-tagging: + taggable: false + x-required-permissions: + read: + - datazone:ListProjectMemberships + create: + - datazone:CreateProjectMembership + - datazone:ListProjectMemberships + - iam:GetRole + - datazone:GetGroupProfile + - datazone:GetUserProfile + update: + - datazone:CreateProjectMembership + - datazone:DeleteProjectMembership + list: + - datazone:ListProjectMemberships + delete: + - datazone:DeleteProjectMembership + AwsAccount: + type: object + properties: + AwsAccountId: + type: string + pattern: ^\d{12}$ + required: + - AwsAccountId + additionalProperties: false + DeploymentMode: + type: string + enum: + - ON_CREATE + - ON_DEMAND + DesignationConfiguration: + type: object + properties: + DesignationId: + type: string + maxLength: 36 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + required: + - DesignationId + additionalProperties: false + EnvironmentConfiguration: + type: object + properties: + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + Id: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintId: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Description: + type: string + maxLength: 2048 + DeploymentMode: + $ref: '#/components/schemas/DeploymentMode' + ConfigurationParameters: + $ref: '#/components/schemas/EnvironmentConfigurationParametersDetails' + AwsAccount: + $ref: '#/components/schemas/AwsAccount' + AwsRegion: + $ref: '#/components/schemas/Region' + DeploymentOrder: + type: number + maximum: 16 + minimum: 0 + required: + - AwsRegion + - EnvironmentBlueprintId + - Name + additionalProperties: false + EnvironmentConfigurationParameter: + type: object + properties: + Name: + type: string + pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ + Value: + type: string + IsEditable: + type: boolean + additionalProperties: false + EnvironmentConfigurationParametersDetails: + type: object + properties: + SsmPath: + type: string + maxLength: 2048 + minLength: 1 + ParameterOverrides: + type: array + items: + $ref: '#/components/schemas/EnvironmentConfigurationParameter' + ResolvedParameters: + type: array + items: + $ref: '#/components/schemas/EnvironmentConfigurationParameter' + additionalProperties: false + ProjectScope: + type: object + properties: + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + Policy: + type: string + required: + - Name + additionalProperties: false + Status: + type: string + enum: + - ENABLED + - DISABLED + ProjectProfile: + type: object + properties: + CreatedAt: + type: string + format: date-time + CreatedBy: + type: string + Description: + type: string + maxLength: 2048 + DomainId: + type: string + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainUnitId: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + DomainUnitIdentifier: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + EnvironmentConfigurations: + type: array + items: + $ref: '#/components/schemas/EnvironmentConfiguration' + Id: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Identifier: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + LastUpdatedAt: + type: string + format: date-time + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + Status: + $ref: '#/components/schemas/Status' + required: + - Name + x-stackql-resource-name: project_profile + description: Definition of AWS::DataZone::ProjectProfile Resource Type + x-type-name: AWS::DataZone::ProjectProfile + x-stackql-primary-identifier: + - DomainIdentifier + - Identifier + x-create-only-properties: + - DomainIdentifier + x-write-only-properties: + - DomainUnitIdentifier + x-read-only-properties: + - CreatedAt + - CreatedBy + - DomainId + - DomainUnitId + - Id + - Identifier + - LastUpdatedAt + - EnvironmentConfigurations/*/Id + - EnvironmentConfigurations/*/ConfigurationParameters/ResolvedParameters + x-required-properties: + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateProjectProfile + - datazone:GetProjectProfile + - ssm:GetParameter + read: + - datazone:GetProjectProfile + - ssm:GetParameter + update: + - datazone:UpdateProjectProfile + - datazone:GetProjectProfile + - ssm:GetParameter + delete: + - datazone:DeleteProjectProfile + - datazone:GetProjectProfile + list: + - datazone:ListProjectProfiles + SubscriptionTargetForm: + type: object + description: The details of the subscription target configuration. + properties: + FormName: + type: string + description: The form name included in the subscription target configuration. + maxLength: 128 + minLength: 1 + pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$ + Content: + type: string + description: The content of the subscription target configuration. + required: + - Content + - FormName + additionalProperties: false + SubscriptionTarget: + type: object + properties: + ApplicableAssetTypes: + type: array + description: The asset types that can be included in the subscription target. + x-insertionOrder: false + items: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[^\.]* + AuthorizedPrincipals: + type: array + description: The authorized principals of the subscription target. + x-insertionOrder: false + items: + type: string + pattern: ^[a-zA-Z0-9:/_-]*$ + maxItems: 10 + minItems: 1 + CreatedAt: + type: string + description: The timestamp of when the subscription target was created. + format: date-time + CreatedBy: + type: string + description: The Amazon DataZone user who created the subscription target. + DomainId: + type: string + description: The ID of the Amazon DataZone domain in which subscription target is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The ID of the Amazon DataZone domain in which subscription target would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentId: + type: string + description: The ID of the environment in which subscription target is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentIdentifier: + type: string + description: The ID of the environment in which subscription target would be created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the subscription target. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ManageAccessRole: + type: string + description: The manage access role that is used to create the subscription target. + Name: + type: string + description: The name of the subscription target. + maxLength: 256 + minLength: 1 + ProjectId: + type: string + description: The identifier of the project specified in the subscription target. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Provider: + type: string + description: The provider of the subscription target. + SubscriptionTargetConfig: + type: array + description: The configuration of the subscription target. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubscriptionTargetForm' + Type: + type: string + description: The type of the subscription target. + UpdatedAt: + type: string + description: The timestamp of when the subscription target was updated. + format: date-time + UpdatedBy: + type: string + description: The Amazon DataZone user who updated the subscription target. + required: + - ApplicableAssetTypes + - AuthorizedPrincipals + - DomainIdentifier + - EnvironmentIdentifier + - Name + - SubscriptionTargetConfig + - Type + x-stackql-resource-name: subscription_target + description: Subscription targets enables one to access the data to which you have subscribed in your projects. + x-type-name: AWS::DataZone::SubscriptionTarget + x-stackql-primary-identifier: + - DomainId + - EnvironmentId + - Id + x-create-only-properties: + - Type + - DomainIdentifier + - EnvironmentIdentifier + x-write-only-properties: + - DomainIdentifier + - EnvironmentIdentifier + x-read-only-properties: + - CreatedAt + - CreatedBy + - DomainId + - EnvironmentId + - Id + - ProjectId + - UpdatedAt + - UpdatedBy + x-required-properties: + - ApplicableAssetTypes + - AuthorizedPrincipals + - DomainIdentifier + - EnvironmentIdentifier + - Name + - SubscriptionTargetConfig + - Type + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateSubscriptionTarget + - datazone:GetSubscriptionTarget + - iam:PassRole + read: + - datazone:GetSubscriptionTarget + update: + - datazone:UpdateSubscriptionTarget + - datazone:GetSubscriptionTarget + - iam:PassRole + delete: + - datazone:DeleteSubscriptionTarget + list: + - datazone:ListSubscriptionTargets + IamUserProfileDetails: + type: object + description: The details of the IAM User Profile. + properties: + Arn: + type: string + description: The ARN of the IAM User Profile. + additionalProperties: false + SsoUserProfileDetails: + type: object + description: The details of the SSO User Profile. + properties: + Username: + type: string + description: The username of the SSO User Profile. + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z_0-9+=,.@-]+$ + FirstName: + type: string + description: The First Name of the IAM User Profile. + LastName: + type: string + description: The Last Name of the IAM User Profile. + additionalProperties: false + UserProfileDetails: + oneOf: + - type: object + title: Iam + properties: + Iam: + $ref: '#/components/schemas/IamUserProfileDetails' + required: + - Iam + additionalProperties: false + - type: object + title: Sso + properties: + Sso: + $ref: '#/components/schemas/SsoUserProfileDetails' + required: + - Sso + additionalProperties: false + UserProfileStatus: + type: string + description: The status of the user profile. + enum: + - ASSIGNED + - NOT_ASSIGNED + - ACTIVATED + - DEACTIVATED + UserProfileType: + type: string + description: The type of the user profile. + enum: + - IAM + - SSO + UserType: + type: string + description: The type of the user. + enum: + - IAM_USER + - IAM_ROLE + - SSO_USER + UserProfile: + type: object + properties: + Details: + $ref: '#/components/schemas/UserProfileDetails' + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the Amazon DataZone user profile. + Status: + $ref: '#/components/schemas/UserProfileStatus' + Type: + $ref: '#/components/schemas/UserProfileType' + UserIdentifier: + type: string + description: The ID of the user. + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$) + UserType: + $ref: '#/components/schemas/UserType' + required: + - DomainIdentifier + - UserIdentifier + x-stackql-resource-name: user_profile + description: >- + A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate + identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships. + x-type-name: AWS::DataZone::UserProfile + x-stackql-primary-identifier: + - DomainId + - Id + x-create-only-properties: + - DomainIdentifier + - UserIdentifier + - UserType + x-write-only-properties: + - DomainIdentifier + - UserIdentifier + - UserType + x-read-only-properties: + - DomainId + - Type + - Id + - Details + x-required-properties: + - DomainIdentifier + - UserIdentifier + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateUserProfile + - datazone:GetUserProfile + - datazone:UpdateUserProfile + - datazone:GetDomain + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + - iam:GetRole + - iam:GetUser + read: + - datazone:GetUserProfile + update: + - datazone:UpdateUserProfile + - datazone:GetUserProfile + - datazone:UpdateUserProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + - iam:GetRole + - iam:GetUser + delete: + - datazone:DeleteUserProfile + - datazone:GetUserProfile + - datazone:UpdateUserProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + - iam:GetRole + - iam:GetUser + list: + - datazone:SearchUserProfiles + CreateConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AwsLocation: + $ref: '#/components/schemas/AwsLocation' + ConnectionId: + type: string + description: The ID of the connection. + maxLength: 128 + pattern: ^[a-zA-Z0-9]+$ + Description: + type: string + description: The description of the connection. + maxLength: 128 + pattern: ^[\S\s]*$ + DomainId: + type: string + description: The ID of the domain in which the connection is created. + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the domain in which the connection is created. + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainUnitId: + type: string + description: The ID of the domain unit in which the connection is created. + maxLength: 256 + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + EnvironmentId: + type: string + description: The ID of the environment in which the connection is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentIdentifier: + type: string + description: The identifier of the environment in which the connection is created. + EnvironmentUserRole: + type: string + description: The role of the user in the environment. + Name: + type: string + description: The name of the connection. + maxLength: 64 + pattern: ^[\w][\w\.\-\_]*$ + ProjectId: + type: string + description: The ID of the project in which the connection is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Props: + $ref: '#/components/schemas/ConnectionPropertiesInput' + Type: + $ref: '#/components/schemas/ConnectionType' + x-stackQL-stringOnly: true + x-title: CreateConnectionRequest + type: object + required: [] + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssetFormsInput: + type: array + description: The metadata forms that are to be attached to the assets that this data source works with. + items: + $ref: '#/components/schemas/FormInput' + maxItems: 10 + minItems: 0 + x-insertionOrder: false + ConnectionId: + type: string + description: The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run + ConnectionIdentifier: + type: string + description: The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run + CreatedAt: + type: string + description: The timestamp of when the data source was created. + format: date-time + Description: + type: string + description: The description of the data source. + maxLength: 2048 + DomainId: + type: string + description: The ID of the Amazon DataZone domain where the data source is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The ID of the Amazon DataZone domain where the data source is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnableSetting: + description: Specifies whether the data source is enabled. + $ref: '#/components/schemas/EnableSetting' + EnvironmentId: + type: string + description: The unique identifier of the Amazon DataZone environment to which the data source publishes assets. + EnvironmentIdentifier: + description: The unique identifier of the Amazon DataZone environment to which the data source publishes assets. + type: string + Id: + type: string + description: The unique identifier of the data source. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Configuration: + description: Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration. + $ref: '#/components/schemas/DataSourceConfigurationInput' + LastRunAssetCount: + description: The number of assets created by the data source during its last run. + type: number + LastRunAt: + type: string + description: The timestamp that specifies when the data source was last run. + LastRunStatus: + description: The status of the last run of this data source. + type: string + Name: + type: string + description: The name of the data source. + maxLength: 256 + minLength: 1 + ProjectId: + type: string + description: The ID of the Amazon DataZone project to which the data source is added. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectIdentifier: + type: string + description: The identifier of the Amazon DataZone project in which you want to add the data source. + PublishOnImport: + type: boolean + description: Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. + Recommendation: + $ref: '#/components/schemas/RecommendationConfiguration' + description: Specifies whether the business name generation is to be enabled for this data source. + Schedule: + description: The schedule of the data source runs. + $ref: '#/components/schemas/ScheduleConfiguration' + Status: + description: The status of the data source. + $ref: '#/components/schemas/DataSourceStatus' + Type: + type: string + description: The type of the data source. + maxLength: 256 + minLength: 1 + UpdatedAt: + type: string + description: The timestamp of when this data source was updated. + format: date-time + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RootDomainUnitId: + type: string + description: The ID of the root domain in Amazon Datazone. + pattern: ^[a-z0-9_\-]+$ + minLength: 1 + maxLength: 256 + Arn: + type: string + description: The ARN of the Amazon DataZone domain. + pattern: ^arn:aws(|-cn|-us-gov):datazone:\w+(?:-\w+)+:\d{12}:domain/dzd[-_][a-zA-Z0-9_-]{1,36}$ + CreatedAt: + type: string + description: The timestamp of when the Amazon DataZone domain was last updated. + format: date-time + Description: + type: string + description: The description of the Amazon DataZone domain. + DomainExecutionRole: + type: string + description: The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain. + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + ServiceRole: + type: string + description: The service role of the domain that is created. + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + DomainVersion: + type: string + description: The version of the domain. + enum: + - V1 + - V2 + Id: + type: string + description: The id of the Amazon DataZone domain. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + KmsKeyIdentifier: + type: string + maxLength: 1024 + description: The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. + minLength: 1 + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + LastUpdatedAt: + type: string + description: The timestamp of when the Amazon DataZone domain was last updated. + format: date-time + ManagedAccountId: + type: string + description: The identifier of the AWS account that manages the domain. + Name: + type: string + description: The name of the Amazon DataZone domain. + PortalUrl: + type: string + description: The URL of the data portal for this Amazon DataZone domain. + SingleSignOn: + $ref: '#/components/schemas/SingleSignOn' + description: The single-sign on configuration of the Amazon DataZone domain. + Status: + $ref: '#/components/schemas/DomainStatus' + description: The status of the Amazon DataZone domain. + Tags: + type: array + description: The tags specified for the Amazon DataZone domain. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + CreateDomainUnitRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainIdentifier: + type: string + description: The ID of the domain where you want to create a domain unit. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Description: + type: string + description: The description of the domain unit. + minLength: 0 + maxLength: 2048 + Name: + type: string + description: The name of the domain unit. + pattern: ^[\w -]+$ + minLength: 1 + maxLength: 128 + ParentDomainUnitIdentifier: + type: string + description: The ID of the parent domain unit. + pattern: ^[a-z0-9_-]+$ + minLength: 1 + maxLength: 256 + CreatedAt: + type: string + description: The timestamp at which the domain unit was created. + format: date-time + DomainId: + type: string + description: The ID of the domain where the domain unit was created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the domain unit. + pattern: ^[a-z0-9_-]+$ + minLength: 1 + maxLength: 256 + ParentDomainUnitId: + type: string + description: The ID of the parent domain unit. + pattern: ^[a-z0-9_-]+$ + minLength: 1 + maxLength: 256 + Identifier: + type: string + description: The identifier of the domain unit that you want to get. + pattern: ^[a-z0-9_-]+$ + minLength: 1 + maxLength: 256 + LastUpdatedAt: + type: string + description: The timestamp at which the domain unit was last updated. + format: date-time + x-stackQL-stringOnly: true + x-title: CreateDomainUnitRequest + type: object + required: [] + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AwsAccountId: + type: string + description: The AWS account in which the Amazon DataZone environment is created. + pattern: ^\d{12}$ + AwsAccountRegion: + type: string + description: The AWS region in which the Amazon DataZone environment is created. + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + EnvironmentAccountIdentifier: + type: string + description: The AWS account in which the Amazon DataZone environment is created. + pattern: ^\d{12}$ + EnvironmentAccountRegion: + type: string + description: The AWS region in which the Amazon DataZone environment is created. + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + CreatedAt: + type: string + description: The timestamp of when the environment was created. + format: date-time + CreatedBy: + type: string + description: The Amazon DataZone user who created the environment. + Description: + type: string + description: The description of the Amazon DataZone environment. + maxLength: 2048 + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the environment is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the environment would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintId: + type: string + description: The ID of the blueprint with which the Amazon DataZone environment was created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentProfileId: + type: string + description: The ID of the environment profile with which the Amazon DataZone environment was created. + pattern: ^[a-zA-Z0-9_-]{0,36}$ + EnvironmentProfileIdentifier: + type: string + description: The ID of the environment profile with which the Amazon DataZone environment would be created. + pattern: ^[a-zA-Z0-9_-]{0,36}$ + GlossaryTerms: + type: array + x-insertionOrder: false + description: The glossary terms that can be used in the Amazon DataZone environment. + items: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxItems: 20 + minItems: 1 + EnvironmentRoleArn: + type: string + description: Environment role arn for custom aws environment permissions + Id: + type: string + description: The ID of the Amazon DataZone environment. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Name: + type: string + description: The name of the environment. + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + ProjectId: + type: string + description: The ID of the Amazon DataZone project in which the environment is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectIdentifier: + type: string + description: The ID of the Amazon DataZone project in which the environment would be created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Provider: + type: string + description: The provider of the Amazon DataZone environment. + Status: + $ref: '#/components/schemas/EnvironmentStatus' + description: The status of the Amazon DataZone environment. + UpdatedAt: + type: string + description: The timestamp of when the environment was updated. + format: date-time + UserParameters: + type: array + x-insertionOrder: false + description: The user parameters of the Amazon DataZone environment. + items: + $ref: '#/components/schemas/EnvironmentParameter' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + CreateEnvironmentActionsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: The description of the Amazon DataZone environment action. + maxLength: 2048 + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the environment is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the environment would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentId: + type: string + description: The identifier of the Amazon DataZone environment in which the action is taking place + pattern: '[a-zA-Z0-9_-]{1,36}$' + maxLength: 36 + minLength: 1 + EnvironmentIdentifier: + type: string + description: The identifier of the Amazon DataZone environment in which the action is taking place + pattern: '[a-zA-Z0-9_-]{1,36}$' + maxLength: 36 + minLength: 1 + Id: + type: string + description: The ID of the Amazon DataZone environment action. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxLength: 36 + minLength: 1 + Identifier: + type: string + description: The ID of the Amazon DataZone environment action. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxLength: 36 + minLength: 1 + Name: + type: string + description: The name of the environment action. + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + Parameters: + description: The parameters of the environment action. + $ref: '#/components/schemas/AwsConsoleLinkParameters' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentActionsRequest + type: object + required: [] + CreateEnvironmentBlueprintConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + format: date-time + type: string + EnabledRegions: + minItems: 0 + x-insertionOrder: false + type: array + items: + minLength: 4 + pattern: ^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$ + type: string + maxLength: 16 + EnvironmentBlueprintIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + EnvironmentBlueprintId: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + UpdatedAt: + format: date-time + type: string + RegionalParameters: + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/RegionalParameter' + ProvisioningRoleArn: + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + type: string + DomainId: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + ProvisioningConfigurations: + type: array + items: + $ref: '#/components/schemas/ProvisioningConfiguration' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + EnvironmentRolePermissionBoundary: + pattern: ^arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*$ + type: string + ManageAccessRoleArn: + pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$ + type: string + x-stackQL-stringOnly: true + x-title: CreateEnvironmentBlueprintConfigurationRequest + type: object + required: [] + CreateEnvironmentProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AwsAccountId: + description: The AWS account in which the Amazon DataZone environment is created. + type: string + pattern: ^\d{12}$ + AwsAccountRegion: + description: The AWS region in which this environment profile is created. + type: string + pattern: ^[a-z]{2}-[a-z]{4,10}-\d$ + CreatedAt: + description: The timestamp of when this environment profile was created. + type: string + format: date-time + CreatedBy: + description: The Amazon DataZone user who created this environment profile. + type: string + Description: + description: The description of this Amazon DataZone environment profile. + type: string + maxLength: 2048 + DomainId: + description: The ID of the Amazon DataZone domain in which this environment profile is created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + description: The ID of the Amazon DataZone domain in which this environment profile is created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintId: + description: The ID of the blueprint with which this environment profile is created. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentBlueprintIdentifier: + description: The ID of the blueprint with which this environment profile is created. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Id: + description: The ID of this Amazon DataZone environment profile. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Name: + description: The name of this Amazon DataZone environment profile. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + ProjectId: + description: The identifier of the project in which to create the environment profile. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectIdentifier: + description: The identifier of the project in which to create the environment profile. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + UpdatedAt: + description: The timestamp of when this environment profile was updated. + type: string + format: date-time + UserParameters: + description: The user parameters of this Amazon DataZone environment profile. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EnvironmentParameter' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentProfileRequest + type: object + required: [] + CreateGroupProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + GroupIdentifier: + type: string + description: The ID of the group. + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+) + GroupName: + type: string + description: The group-name of the Group Profile. + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z_0-9+=,.@-]+$ + Id: + type: string + description: The ID of the Amazon DataZone group profile. + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + Status: + $ref: '#/components/schemas/GroupProfileStatus' + x-stackQL-stringOnly: true + x-title: CreateGroupProfileRequest + type: object + required: [] + CreateOwnerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EntityType: + description: The type of an entity. + type: string + enum: + - DOMAIN_UNIT + Owner: + description: The owner that you want to add to the entity. + $ref: '#/components/schemas/OwnerProperties' + EntityIdentifier: + description: The ID of the entity to which you want to add an owner. + type: string + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + description: The ID of the domain in which you want to add the entity owner. + type: string + x-stackQL-stringOnly: true + x-title: CreateOwnerRequest + type: object + required: [] + CreatePolicyGrantRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EntityType: + $ref: '#/components/schemas/TargetEntityType' + PolicyType: + $ref: '#/components/schemas/ManagedPolicyType' + CreatedBy: + description: Specifies the user who created the policy grant member. + type: string + CreatedAt: + format: date-time + description: Specifies the timestamp at which policy grant member was created. + type: string + GrantId: + pattern: ^[A-Za-z0-9+/]{10}$ + description: The unique identifier of the policy grant returned by the AddPolicyGrant API + type: string + EntityIdentifier: + type: string + Detail: + type: object + $ref: '#/components/schemas/PolicyGrantDetail' + Principal: + type: object + $ref: '#/components/schemas/PolicyGrantPrincipal' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + x-stackQL-stringOnly: true + x-title: CreatePolicyGrantRequest + type: object + required: [] + CreateProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + description: The timestamp of when the project was created. + type: string + format: date-time + CreatedBy: + description: The Amazon DataZone user who created the project. + type: string + Description: + description: The description of the Amazon DataZone project. + type: string + maxLength: 2048 + DomainId: + description: The identifier of the Amazon DataZone domain in which the project was created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + description: The ID of the Amazon DataZone domain in which this project is created. + type: string + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainUnitId: + description: The ID of the domain unit. + type: string + pattern: ^[a-z0-9_\-]+$ + GlossaryTerms: + description: The glossary terms that can be used in this Amazon DataZone project. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + maxItems: 20 + minItems: 1 + Id: + description: The ID of the Amazon DataZone project. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + LastUpdatedAt: + description: The timestamp of when the project was last updated. + type: string + format: date-time + Name: + description: The name of the Amazon DataZone project. + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + ProjectProfileId: + description: The project profile ID. + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectProfileVersion: + description: 'The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.' + type: string + ProjectStatus: + description: The status of the project. + $ref: '#/components/schemas/ProjectStatus' + UserParameters: + description: The user parameters of the project. + type: array + items: + $ref: '#/components/schemas/EnvironmentConfigurationUserParameter' + x-stackQL-stringOnly: true + x-title: CreateProjectRequest + type: object + required: [] + CreateProjectMembershipRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProjectIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + Designation: + $ref: '#/components/schemas/UserDesignation' + Member: + $ref: '#/components/schemas/Member' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + x-stackQL-stringOnly: true + x-title: CreateProjectMembershipRequest + type: object + required: [] + CreateProjectProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + type: string + format: date-time + CreatedBy: + type: string + Description: + type: string + maxLength: 2048 + DomainId: + type: string + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + pattern: ^dzd[_][a-zA-Z0-9_-]{1,36}$ + DomainUnitId: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + DomainUnitIdentifier: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-z0-9_\-]+$ + EnvironmentConfigurations: + type: array + items: + $ref: '#/components/schemas/EnvironmentConfiguration' + Id: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Identifier: + type: string + pattern: ^[a-zA-Z0-9_-]{1,36}$ + LastUpdatedAt: + type: string + format: date-time + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\w -]+$ + Status: + $ref: '#/components/schemas/Status' + x-stackQL-stringOnly: true + x-title: CreateProjectProfileRequest + type: object + required: [] + CreateSubscriptionTargetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicableAssetTypes: + type: array + description: The asset types that can be included in the subscription target. + x-insertionOrder: false + items: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[^\.]* + AuthorizedPrincipals: + type: array + description: The authorized principals of the subscription target. + x-insertionOrder: false + items: + type: string + pattern: ^[a-zA-Z0-9:/_-]*$ + maxItems: 10 + minItems: 1 + CreatedAt: + type: string + description: The timestamp of when the subscription target was created. + format: date-time + CreatedBy: + type: string + description: The Amazon DataZone user who created the subscription target. + DomainId: + type: string + description: The ID of the Amazon DataZone domain in which subscription target is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The ID of the Amazon DataZone domain in which subscription target would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + EnvironmentId: + type: string + description: The ID of the environment in which subscription target is created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentIdentifier: + type: string + description: The ID of the environment in which subscription target would be created. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the subscription target. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ManageAccessRole: + type: string + description: The manage access role that is used to create the subscription target. + Name: + type: string + description: The name of the subscription target. + maxLength: 256 + minLength: 1 + ProjectId: + type: string + description: The identifier of the project specified in the subscription target. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + Provider: + type: string + description: The provider of the subscription target. + SubscriptionTargetConfig: + type: array + description: The configuration of the subscription target. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubscriptionTargetForm' + Type: + type: string + description: The type of the subscription target. + UpdatedAt: + type: string + description: The timestamp of when the subscription target was updated. + format: date-time + UpdatedBy: + type: string + description: The Amazon DataZone user who updated the subscription target. + x-stackQL-stringOnly: true + x-title: CreateSubscriptionTargetRequest + type: object + required: [] + CreateUserProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Details: + $ref: '#/components/schemas/UserProfileDetails' + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the Amazon DataZone user profile. + Status: + $ref: '#/components/schemas/UserProfileStatus' + Type: + $ref: '#/components/schemas/UserProfileType' + UserIdentifier: + type: string + description: The ID of the user. + pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$) + UserType: + $ref: '#/components/schemas/UserType' + x-stackQL-stringOnly: true + x-title: CreateUserProfileRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + connections: + name: connections + id: awscc.datazone.connections + x-cfn-schema-name: Connection + x-cfn-type-name: AWS::DataZone::Connection + x-identifiers: + - DomainId + - ConnectionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AwsLocation') as aws_location, + JSON_EXTRACT(Properties, '$.ConnectionId') as connection_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.DomainUnitId') as domain_unit_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentUserRole') as environment_user_role, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ProjectId') as project_id, + JSON_EXTRACT(Properties, '$.Props') as props, + JSON_EXTRACT(Properties, '$.Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Connection' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AwsLocation') as aws_location, + json_extract_path_text(Properties, 'ConnectionId') as connection_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'DomainUnitId') as domain_unit_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'EnvironmentUserRole') as environment_user_role, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'Props') as props, + json_extract_path_text(Properties, 'Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Connection' + AND data__Identifier = '|' + AND region = 'us-east-1' + connections_list_only: + name: connections_list_only + id: awscc.datazone.connections_list_only + x-cfn-schema-name: Connection + x-cfn-type-name: AWS::DataZone::Connection + x-identifiers: + - DomainId + - ConnectionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.ConnectionId') as connection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Connection' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'ConnectionId') as connection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Connection' + AND region = 'us-east-1' + data_sources: + name: data_sources + id: awscc.datazone.data_sources + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::DataZone::DataSource + x-identifiers: + - DomainId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AssetFormsInput') as asset_forms_input, + JSON_EXTRACT(Properties, '$.ConnectionId') as connection_id, + JSON_EXTRACT(Properties, '$.ConnectionIdentifier') as connection_identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.EnableSetting') as enable_setting, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.LastRunAssetCount') as last_run_asset_count, + JSON_EXTRACT(Properties, '$.LastRunAt') as last_run_at, + JSON_EXTRACT(Properties, '$.LastRunStatus') as last_run_status, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ProjectId') as project_id, + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, + JSON_EXTRACT(Properties, '$.PublishOnImport') as publish_on_import, + JSON_EXTRACT(Properties, '$.Recommendation') as recommendation, + JSON_EXTRACT(Properties, '$.Schedule') as schedule, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssetFormsInput') as asset_forms_input, + json_extract_path_text(Properties, 'ConnectionId') as connection_id, + json_extract_path_text(Properties, 'ConnectionIdentifier') as connection_identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnableSetting') as enable_setting, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'LastRunAssetCount') as last_run_asset_count, + json_extract_path_text(Properties, 'LastRunAt') as last_run_at, + json_extract_path_text(Properties, 'LastRunStatus') as last_run_status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'PublishOnImport') as publish_on_import, + json_extract_path_text(Properties, 'Recommendation') as recommendation, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + data_sources_list_only: + name: data_sources_list_only + id: awscc.datazone.data_sources_list_only + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::DataZone::DataSource + x-identifiers: + - DomainId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' + AND region = 'us-east-1' + domains: + name: domains + id: awscc.datazone.domains + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::DataZone::Domain + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RootDomainUnitId') as root_domain_unit_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DomainExecutionRole') as domain_execution_role, + JSON_EXTRACT(Properties, '$.ServiceRole') as service_role, + JSON_EXTRACT(Properties, '$.DomainVersion') as domain_version, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, + JSON_EXTRACT(Properties, '$.ManagedAccountId') as managed_account_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.PortalUrl') as portal_url, + JSON_EXTRACT(Properties, '$.SingleSignOn') as single_sign_on, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RootDomainUnitId') as root_domain_unit_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainExecutionRole') as domain_execution_role, + json_extract_path_text(Properties, 'ServiceRole') as service_role, + json_extract_path_text(Properties, 'DomainVersion') as domain_version, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'ManagedAccountId') as managed_account_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PortalUrl') as portal_url, + json_extract_path_text(Properties, 'SingleSignOn') as single_sign_on, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + domains_list_only: + name: domains_list_only + id: awscc.datazone.domains_list_only + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::DataZone::Domain + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' + AND region = 'us-east-1' + domain_units: + name: domain_units + id: awscc.datazone.domain_units + x-cfn-schema-name: DomainUnit + x-cfn-type-name: AWS::DataZone::DomainUnit + x-identifiers: + - DomainId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainUnit&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DomainUnit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DomainUnit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DomainUnit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_units/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_units/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_units/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ParentDomainUnitIdentifier') as parent_domain_unit_identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.ParentDomainUnitId') as parent_domain_unit_id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DomainUnit' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ParentDomainUnitIdentifier') as parent_domain_unit_identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ParentDomainUnitId') as parent_domain_unit_id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DomainUnit' + AND data__Identifier = '|' + AND region = 'us-east-1' + domain_units_list_only: + name: domain_units_list_only + id: awscc.datazone.domain_units_list_only + x-cfn-schema-name: DomainUnit + x-cfn-type-name: AWS::DataZone::DomainUnit + x-identifiers: + - DomainId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DomainUnit' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DomainUnit' + AND region = 'us-east-1' + environments: + name: environments + id: awscc.datazone.environments + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::DataZone::Environment + x-identifiers: + - DomainId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.AwsAccountRegion') as aws_account_region, + JSON_EXTRACT(Properties, '$.EnvironmentAccountIdentifier') as environment_account_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentAccountRegion') as environment_account_region, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, + JSON_EXTRACT(Properties, '$.EnvironmentProfileId') as environment_profile_id, + JSON_EXTRACT(Properties, '$.EnvironmentProfileIdentifier') as environment_profile_identifier, + JSON_EXTRACT(Properties, '$.GlossaryTerms') as glossary_terms, + JSON_EXTRACT(Properties, '$.EnvironmentRoleArn') as environment_role_arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ProjectId') as project_id, + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, + JSON_EXTRACT(Properties, '$.Provider') as provider, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.UserParameters') as user_parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Environment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, + json_extract_path_text(Properties, 'EnvironmentAccountIdentifier') as environment_account_identifier, + json_extract_path_text(Properties, 'EnvironmentAccountRegion') as environment_account_region, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, + json_extract_path_text(Properties, 'EnvironmentProfileId') as environment_profile_id, + json_extract_path_text(Properties, 'EnvironmentProfileIdentifier') as environment_profile_identifier, + json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, + json_extract_path_text(Properties, 'EnvironmentRoleArn') as environment_role_arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'UserParameters') as user_parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Environment' + AND data__Identifier = '|' + AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.datazone.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::DataZone::Environment + x-identifiers: + - DomainId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' + AND region = 'us-east-1' + environment_actions: + name: environment_actions + id: awscc.datazone.environment_actions + x-cfn-schema-name: EnvironmentActions + x-cfn-type-name: AWS::DataZone::EnvironmentActions + x-identifiers: + - DomainId + - EnvironmentId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnvironmentActions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentActions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentActions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentActions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environment_actions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Parameters') as parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentActions' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Parameters') as parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentActions' + AND data__Identifier = '||' + AND region = 'us-east-1' + environment_actions_list_only: + name: environment_actions_list_only + id: awscc.datazone.environment_actions_list_only + x-cfn-schema-name: EnvironmentActions + x-cfn-type-name: AWS::DataZone::EnvironmentActions + x-identifiers: + - DomainId + - EnvironmentId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentActions' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentActions' + AND region = 'us-east-1' + environment_blueprint_configurations: + name: environment_blueprint_configurations + id: awscc.datazone.environment_blueprint_configurations + x-cfn-schema-name: EnvironmentBlueprintConfiguration + x-cfn-type-name: AWS::DataZone::EnvironmentBlueprintConfiguration x-identifiers: - DomainId - - Id + - EnvironmentBlueprintId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnvironmentBlueprintConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentBlueprintConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentBlueprintConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentBlueprintConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.EnabledRegions') as enabled_regions, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.RegionalParameters') as regional_parameters, + JSON_EXTRACT(Properties, '$.ProvisioningRoleArn') as provisioning_role_arn, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.ProvisioningConfigurations') as provisioning_configurations, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentRolePermissionBoundary') as environment_role_permission_boundary, + JSON_EXTRACT(Properties, '$.ManageAccessRoleArn') as manage_access_role_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'EnabledRegions') as enabled_regions, + json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'RegionalParameters') as regional_parameters, + json_extract_path_text(Properties, 'ProvisioningRoleArn') as provisioning_role_arn, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'ProvisioningConfigurations') as provisioning_configurations, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnvironmentRolePermissionBoundary') as environment_role_permission_boundary, + json_extract_path_text(Properties, 'ManageAccessRoleArn') as manage_access_role_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' + AND data__Identifier = '|' + AND region = 'us-east-1' + environment_blueprint_configurations_list_only: + name: environment_blueprint_configurations_list_only + id: awscc.datazone.environment_blueprint_configurations_list_only + x-cfn-schema-name: EnvironmentBlueprintConfiguration + x-cfn-type-name: AWS::DataZone::EnvironmentBlueprintConfiguration + x-identifiers: + - DomainId + - EnvironmentBlueprintId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1104,8 +5799,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1113,88 +5808,129 @@ components: SELECT region, json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' AND region = 'us-east-1' - data_source: - name: data_source - id: awscc.datazone.data_source - x-cfn-schema-name: DataSource - x-type: get + environment_profiles: + name: environment_profiles + id: awscc.datazone.environment_profiles + x-cfn-schema-name: EnvironmentProfile + x-cfn-type-name: AWS::DataZone::EnvironmentProfile x-identifiers: - DomainId - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnvironmentProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environment_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AssetFormsInput') as asset_forms_input, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.AwsAccountRegion') as aws_account_region, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.EnableSetting') as enable_setting, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Configuration') as configuration, - JSON_EXTRACT(Properties, '$.LastRunAssetCount') as last_run_asset_count, - JSON_EXTRACT(Properties, '$.LastRunAt') as last_run_at, - JSON_EXTRACT(Properties, '$.LastRunStatus') as last_run_status, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.ProjectId') as project_id, JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, - JSON_EXTRACT(Properties, '$.PublishOnImport') as publish_on_import, - JSON_EXTRACT(Properties, '$.Recommendation') as recommendation, - JSON_EXTRACT(Properties, '$.Schedule') as schedule, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DataSource' + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.UserParameters') as user_parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AssetFormsInput') as asset_forms_input, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'DomainId') as domain_id, json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnableSetting') as enable_setting, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, + json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'LastRunAssetCount') as last_run_asset_count, - json_extract_path_text(Properties, 'LastRunAt') as last_run_at, - json_extract_path_text(Properties, 'LastRunStatus') as last_run_status, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'ProjectId') as project_id, json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, - json_extract_path_text(Properties, 'PublishOnImport') as publish_on_import, - json_extract_path_text(Properties, 'Recommendation') as recommendation, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DataSource' + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'UserParameters') as user_parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' AND data__Identifier = '|' AND region = 'us-east-1' - domains: - name: domains - id: awscc.datazone.domains - x-cfn-schema-name: Domain - x-type: list + environment_profiles_list_only: + name: environment_profiles_list_only + id: awscc.datazone.environment_profiles_list_only + x-cfn-schema-name: EnvironmentProfile + x-cfn-type-name: AWS::DataZone::EnvironmentProfile x-identifiers: + - DomainId - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1202,78 +5938,121 @@ components: ddl: |- SELECT region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, + json_extract_path_text(Properties, 'DomainId') as domain_id, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' AND region = 'us-east-1' - domain: - name: domain - id: awscc.datazone.domain - x-cfn-schema-name: Domain - x-type: get + group_profiles: + name: group_profiles + id: awscc.datazone.group_profiles + x-cfn-schema-name: GroupProfile + x-cfn-type-name: AWS::DataZone::GroupProfile x-identifiers: + - DomainId - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GroupProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::GroupProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::GroupProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::GroupProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/group_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/group_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/group_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.DomainExecutionRole') as domain_execution_role, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.GroupIdentifier') as group_identifier, + JSON_EXTRACT(Properties, '$.GroupName') as group_name, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, - JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, - JSON_EXTRACT(Properties, '$.ManagedAccountId') as managed_account_id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.PortalUrl') as portal_url, - JSON_EXTRACT(Properties, '$.SingleSignOn') as single_sign_on, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::GroupProfile' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainExecutionRole') as domain_execution_role, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'GroupIdentifier') as group_identifier, + json_extract_path_text(Properties, 'GroupName') as group_name, json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'ManagedAccountId') as managed_account_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PortalUrl') as portal_url, - json_extract_path_text(Properties, 'SingleSignOn') as single_sign_on, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Domain' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::GroupProfile' + AND data__Identifier = '|' AND region = 'us-east-1' - environments: - name: environments - id: awscc.datazone.environments - x-cfn-schema-name: Environment - x-type: list + group_profiles_list_only: + name: group_profiles_list_only + id: awscc.datazone.group_profiles_list_only + x-cfn-schema-name: GroupProfile + x-cfn-type-name: AWS::DataZone::GroupProfile x-identifiers: - DomainId - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1283,7 +6062,7 @@ components: region, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::GroupProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1292,82 +6071,99 @@ components: region, json_extract_path_text(Properties, 'DomainId') as domain_id, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::GroupProfile' AND region = 'us-east-1' - environment: - name: environment - id: awscc.datazone.environment - x-cfn-schema-name: Environment - x-type: get + owners: + name: owners + id: awscc.datazone.owners + x-cfn-schema-name: Owner + x-cfn-type-name: AWS::DataZone::Owner x-identifiers: - - DomainId - - Id + - DomainIdentifier + - EntityType + - EntityIdentifier + - OwnerType + - OwnerIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Owner&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Owner" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Owner" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/owners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/owners/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.AwsAccountRegion') as aws_account_region, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, - JSON_EXTRACT(Properties, '$.EnvironmentProfileId') as environment_profile_id, - JSON_EXTRACT(Properties, '$.EnvironmentProfileIdentifier') as environment_profile_identifier, - JSON_EXTRACT(Properties, '$.GlossaryTerms') as glossary_terms, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ProjectId') as project_id, - JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, - JSON_EXTRACT(Properties, '$.Provider') as provider, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, - JSON_EXTRACT(Properties, '$.UserParameters') as user_parameters - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Environment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.EntityType') as entity_type, + JSON_EXTRACT(Properties, '$.Owner') as owner, + JSON_EXTRACT(Properties, '$.EntityIdentifier') as entity_identifier, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Owner' + AND data__Identifier = '||||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, - json_extract_path_text(Properties, 'EnvironmentProfileId') as environment_profile_id, - json_extract_path_text(Properties, 'EnvironmentProfileIdentifier') as environment_profile_identifier, - json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'UserParameters') as user_parameters - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Environment' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'EntityType') as entity_type, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'EntityIdentifier') as entity_identifier, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Owner' + AND data__Identifier = '||||' AND region = 'us-east-1' - environment_blueprint_configurations: - name: environment_blueprint_configurations - id: awscc.datazone.environment_blueprint_configurations - x-cfn-schema-name: EnvironmentBlueprintConfiguration - x-type: list + owners_list_only: + name: owners_list_only + id: awscc.datazone.owners_list_only + x-cfn-schema-name: Owner + x-cfn-type-name: AWS::DataZone::Owner x-identifiers: - - DomainId - - EnvironmentBlueprintId + - DomainIdentifier + - EntityType + - EntityIdentifier + - OwnerType + - OwnerIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1375,75 +6171,126 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.EntityType') as entity_type, + JSON_EXTRACT(Properties, '$.EntityIdentifier') as entity_identifier, + JSON_EXTRACT(Properties, '$.OwnerType') as owner_type, + JSON_EXTRACT(Properties, '$.OwnerIdentifier') as owner_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Owner' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EntityType') as entity_type, + json_extract_path_text(Properties, 'EntityIdentifier') as entity_identifier, + json_extract_path_text(Properties, 'OwnerType') as owner_type, + json_extract_path_text(Properties, 'OwnerIdentifier') as owner_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Owner' AND region = 'us-east-1' - environment_blueprint_configuration: - name: environment_blueprint_configuration - id: awscc.datazone.environment_blueprint_configuration - x-cfn-schema-name: EnvironmentBlueprintConfiguration - x-type: get + policy_grants: + name: policy_grants + id: awscc.datazone.policy_grants + x-cfn-schema-name: PolicyGrant + x-cfn-type-name: AWS::DataZone::PolicyGrant x-identifiers: - - DomainId - - EnvironmentBlueprintId + - DomainIdentifier + - GrantId + - EntityIdentifier + - EntityType + - PolicyType + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PolicyGrant&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::PolicyGrant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::PolicyGrant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_grants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_grants/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RegionalParameters') as regional_parameters, - JSON_EXTRACT(Properties, '$.ProvisioningRoleArn') as provisioning_role_arn, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.EntityType') as entity_type, + JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.EnabledRegions') as enabled_regions, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, - JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.ManageAccessRoleArn') as manage_access_role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GrantId') as grant_id, + JSON_EXTRACT(Properties, '$.EntityIdentifier') as entity_identifier, + JSON_EXTRACT(Properties, '$.Detail') as detail, + JSON_EXTRACT(Properties, '$.Principal') as principal, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::PolicyGrant' + AND data__Identifier = '||||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'RegionalParameters') as regional_parameters, - json_extract_path_text(Properties, 'ProvisioningRoleArn') as provisioning_role_arn, - json_extract_path_text(Properties, 'DomainId') as domain_id, + region, + data__Identifier, + json_extract_path_text(Properties, 'EntityType') as entity_type, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'CreatedBy') as created_by, json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'EnabledRegions') as enabled_regions, - json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'ManageAccessRoleArn') as manage_access_role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'GrantId') as grant_id, + json_extract_path_text(Properties, 'EntityIdentifier') as entity_identifier, + json_extract_path_text(Properties, 'Detail') as detail, + json_extract_path_text(Properties, 'Principal') as principal, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::PolicyGrant' + AND data__Identifier = '||||' AND region = 'us-east-1' - environment_profiles: - name: environment_profiles - id: awscc.datazone.environment_profiles - x-cfn-schema-name: EnvironmentProfile - x-type: list + policy_grants_list_only: + name: policy_grants_list_only + id: awscc.datazone.policy_grants_list_only + x-cfn-schema-name: PolicyGrant + x-cfn-type-name: AWS::DataZone::PolicyGrant x-identifiers: - - DomainId - - Id + - DomainIdentifier + - GrantId + - EntityIdentifier + - EntityType + - PolicyType + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1451,85 +6298,143 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.GrantId') as grant_id, + JSON_EXTRACT(Properties, '$.EntityIdentifier') as entity_identifier, + JSON_EXTRACT(Properties, '$.EntityType') as entity_type, + JSON_EXTRACT(Properties, '$.PolicyType') as policy_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::PolicyGrant' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'GrantId') as grant_id, + json_extract_path_text(Properties, 'EntityIdentifier') as entity_identifier, + json_extract_path_text(Properties, 'EntityType') as entity_type, + json_extract_path_text(Properties, 'PolicyType') as policy_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::PolicyGrant' AND region = 'us-east-1' - environment_profile: - name: environment_profile - id: awscc.datazone.environment_profile - x-cfn-schema-name: EnvironmentProfile - x-type: get + projects: + name: projects + id: awscc.datazone.projects + x-cfn-schema-name: Project + x-cfn-type-name: AWS::DataZone::Project x-identifiers: - DomainId - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.AwsAccountRegion') as aws_account_region, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + JSON_EXTRACT(Properties, '$.DomainUnitId') as domain_unit_id, + JSON_EXTRACT(Properties, '$.GlossaryTerms') as glossary_terms, JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ProjectId') as project_id, - JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.ProjectProfileId') as project_profile_id, + JSON_EXTRACT(Properties, '$.ProjectProfileVersion') as project_profile_version, + JSON_EXTRACT(Properties, '$.ProjectStatus') as project_status, JSON_EXTRACT(Properties, '$.UserParameters') as user_parameters - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'CreatedBy') as created_by, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'DomainId') as domain_id, json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, - json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + json_extract_path_text(Properties, 'DomainUnitId') as domain_unit_id, + json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'ProjectProfileId') as project_profile_id, + json_extract_path_text(Properties, 'ProjectProfileVersion') as project_profile_version, + json_extract_path_text(Properties, 'ProjectStatus') as project_status, json_extract_path_text(Properties, 'UserParameters') as user_parameters - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' AND data__Identifier = '|' AND region = 'us-east-1' - projects: - name: projects - id: awscc.datazone.projects + projects_list_only: + name: projects_list_only + id: awscc.datazone.projects_list_only x-cfn-schema-name: Project - x-type: list + x-cfn-type-name: AWS::DataZone::Project x-identifiers: - DomainId - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1550,18 +6455,192 @@ components: json_extract_path_text(Properties, 'Id') as id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Project' AND region = 'us-east-1' - project: - name: project - id: awscc.datazone.project - x-cfn-schema-name: Project - x-type: get + project_memberships: + name: project_memberships + id: awscc.datazone.project_memberships + x-cfn-schema-name: ProjectMembership + x-cfn-type-name: AWS::DataZone::ProjectMembership x-identifiers: - - DomainId - - Id + - DomainIdentifier + - MemberIdentifier + - MemberIdentifierType + - ProjectIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProjectMembership&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/project_memberships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/project_memberships/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/project_memberships/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, + JSON_EXTRACT(Properties, '$.Designation') as designation, + JSON_EXTRACT(Properties, '$.Member') as member, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND data__Identifier = '|||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'Designation') as designation, + json_extract_path_text(Properties, 'Member') as member, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND data__Identifier = '|||' + AND region = 'us-east-1' + project_memberships_list_only: + name: project_memberships_list_only + id: awscc.datazone.project_memberships_list_only + x-cfn-schema-name: ProjectMembership + x-cfn-type-name: AWS::DataZone::ProjectMembership + x-identifiers: + - DomainIdentifier + - MemberIdentifier + - MemberIdentifierType + - ProjectIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.MemberIdentifier') as member_identifier, + JSON_EXTRACT(Properties, '$.MemberIdentifierType') as member_identifier_type, + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'MemberIdentifier') as member_identifier, + json_extract_path_text(Properties, 'MemberIdentifierType') as member_identifier_type, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND region = 'us-east-1' + project_profiles: + name: project_profiles + id: awscc.datazone.project_profiles + x-cfn-schema-name: ProjectProfile + x-cfn-type-name: AWS::DataZone::ProjectProfile + x-identifiers: + - DomainIdentifier + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProjectProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/project_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/project_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/project_profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1571,15 +6650,19 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.GlossaryTerms') as glossary_terms, + JSON_EXTRACT(Properties, '$.DomainUnitId') as domain_unit_id, + JSON_EXTRACT(Properties, '$.DomainUnitIdentifier') as domain_unit_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentConfigurations') as environment_configurations, JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::ProjectProfile' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1589,22 +6672,31 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'DomainId') as domain_id, json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, + json_extract_path_text(Properties, 'DomainUnitId') as domain_unit_id, + json_extract_path_text(Properties, 'DomainUnitIdentifier') as domain_unit_identifier, + json_extract_path_text(Properties, 'EnvironmentConfigurations') as environment_configurations, json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::ProjectProfile' + AND data__Identifier = '|' AND region = 'us-east-1' - subscription_targets: - name: subscription_targets - id: awscc.datazone.subscription_targets - x-cfn-schema-name: SubscriptionTarget - x-type: list + project_profiles_list_only: + name: project_profiles_list_only + id: awscc.datazone.project_profiles_list_only + x-cfn-schema-name: ProjectProfile + x-cfn-type-name: AWS::DataZone::ProjectProfile x-identifiers: - - DomainId - - EnvironmentId - - Id + - DomainIdentifier + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1612,34 +6704,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::ProjectProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::ProjectProfile' AND region = 'us-east-1' - subscription_target: - name: subscription_target - id: awscc.datazone.subscription_target + subscription_targets: + name: subscription_targets + id: awscc.datazone.subscription_targets x-cfn-schema-name: SubscriptionTarget - x-type: get + x-cfn-type-name: AWS::DataZone::SubscriptionTarget x-identifiers: - DomainId - EnvironmentId - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubscriptionTarget&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::SubscriptionTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::SubscriptionTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::SubscriptionTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subscription_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subscription_targets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subscription_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1665,7 +6803,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1690,3 +6828,991 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' AND data__Identifier = '||' AND region = 'us-east-1' + subscription_targets_list_only: + name: subscription_targets_list_only + id: awscc.datazone.subscription_targets_list_only + x-cfn-schema-name: SubscriptionTarget + x-cfn-type-name: AWS::DataZone::SubscriptionTarget + x-identifiers: + - DomainId + - EnvironmentId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + AND region = 'us-east-1' + user_profiles: + name: user_profiles + id: awscc.datazone.user_profiles + x-cfn-schema-name: UserProfile + x-cfn-type-name: AWS::DataZone::UserProfile + x-identifiers: + - DomainId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Details') as details, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UserIdentifier') as user_identifier, + JSON_EXTRACT(Properties, '$.UserType') as user_type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Details') as details, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UserIdentifier') as user_identifier, + json_extract_path_text(Properties, 'UserType') as user_type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + user_profiles_list_only: + name: user_profiles_list_only + id: awscc.datazone.user_profiles_list_only + x-cfn-schema-name: UserProfile + x-cfn-type-name: AWS::DataZone::UserProfile + x-identifiers: + - DomainId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainUnit&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainUnit + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainUnitRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnvironmentActions&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironmentActions + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentActionsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnvironmentBlueprintConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironmentBlueprintConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentBlueprintConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnvironmentProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironmentProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GroupProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroupProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Owner&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOwner + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOwnerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PolicyGrant&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicyGrant + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyGrantRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProjectMembership&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProjectMembership + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectMembershipRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProjectProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProjectProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubscriptionTarget&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubscriptionTarget + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubscriptionTargetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/deadline.yaml b/providers/src/awscc/v00.00.00000/services/deadline.yaml new file mode 100644 index 00000000..cc5c661f --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/deadline.yaml @@ -0,0 +1,4235 @@ +openapi: 3.0.0 +info: + title: Deadline + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 1 + maxLength: 127 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 1 + maxLength: 255 + required: + - Key + - Value + additionalProperties: false + Farm: + type: object + properties: + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + KmsKeyArn: + type: string + pattern: ^arn:aws[-a-z]*:kms:.*:key/.* + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}$ + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + required: + - DisplayName + x-stackql-resource-name: farm + description: Definition of AWS::Deadline::Farm Resource Type + x-type-name: AWS::Deadline::Farm + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - KmsKeyArn + x-read-only-properties: + - FarmId + - Arn + x-required-properties: + - DisplayName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + x-required-permissions: + create: + - deadline:CreateFarm + - deadline:GetFarm + - deadline:TagResource + - deadline:ListTagsForResource + - identitystore:ListGroupMembershipsForMember + - kms:Encrypt + - kms:Decrypt + - kms:CreateGrant + - kms:GenerateDataKey + read: + - deadline:GetFarm + - deadline:ListTagsForResource + - identitystore:ListGroupMembershipsForMember + - kms:Encrypt + - kms:Decrypt + - kms:CreateGrant + - kms:GenerateDataKey + update: + - deadline:UpdateFarm + - deadline:GetFarm + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + - identitystore:ListGroupMembershipsForMember + - kms:Encrypt + - kms:Decrypt + - kms:CreateGrant + - kms:GenerateDataKey + delete: + - deadline:DeleteFarm + - deadline:GetFarm + - identitystore:ListGroupMembershipsForMember + - kms:Encrypt + - kms:Decrypt + - kms:CreateGrant + - kms:GenerateDataKey + list: + - deadline:ListFarms + - identitystore:ListGroupMembershipsForMember + AcceleratorCountRange: + type: object + properties: + Min: + type: integer + maximum: 2147483647 + minimum: 0 + Max: + type: integer + maximum: 2147483647 + minimum: 0 + required: + - Min + additionalProperties: false + AcceleratorTotalMemoryMiBRange: + type: object + properties: + Min: + type: integer + maximum: 2147483647 + minimum: 0 + Max: + type: integer + maximum: 2147483647 + minimum: 0 + required: + - Min + additionalProperties: false + AcceleratorType: + type: string + enum: + - gpu + AutoScalingMode: + type: string + enum: + - NO_SCALING + - EVENT_BASED_AUTO_SCALING + CpuArchitectureType: + type: string + enum: + - x86_64 + - arm64 + CustomerManagedFleetConfiguration: + type: object + properties: + Mode: + $ref: '#/components/schemas/AutoScalingMode' + WorkerCapabilities: + $ref: '#/components/schemas/CustomerManagedWorkerCapabilities' + StorageProfileId: + type: string + pattern: ^sp-[0-9a-f]{32}$ + TagPropagationMode: + $ref: '#/components/schemas/TagPropagationMode' + required: + - Mode + - WorkerCapabilities + additionalProperties: false + CustomerManagedFleetOperatingSystemFamily: + type: string + enum: + - WINDOWS + - LINUX + - MACOS + CustomerManagedWorkerCapabilities: + type: object + properties: + VCpuCount: + $ref: '#/components/schemas/VCpuCountRange' + MemoryMiB: + $ref: '#/components/schemas/MemoryMiBRange' + AcceleratorTypes: + type: array + items: + $ref: '#/components/schemas/AcceleratorType' + AcceleratorCount: + $ref: '#/components/schemas/AcceleratorCountRange' + AcceleratorTotalMemoryMiB: + $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRange' + OsFamily: + $ref: '#/components/schemas/CustomerManagedFleetOperatingSystemFamily' + CpuArchitectureType: + $ref: '#/components/schemas/CpuArchitectureType' + CustomAmounts: + type: array + items: + $ref: '#/components/schemas/FleetAmountCapability' + maxItems: 15 + minItems: 1 + CustomAttributes: + type: array + items: + $ref: '#/components/schemas/FleetAttributeCapability' + maxItems: 15 + minItems: 1 + required: + - CpuArchitectureType + - MemoryMiB + - OsFamily + - VCpuCount + additionalProperties: false + Ec2EbsVolume: + type: object + properties: + SizeGiB: + type: integer + default: 250 + Iops: + type: integer + default: 3000 + maximum: 16000 + minimum: 3000 + ThroughputMiB: + type: integer + default: 125 + maximum: 1000 + minimum: 125 + additionalProperties: false + AcceleratorSelection: + type: object + properties: + Name: + type: string + enum: + - t4 + - a10g + - l4 + - l40s + Runtime: + type: string + maxLength: 100 + minLength: 1 + required: + - Name + additionalProperties: false + AcceleratorCapabilities: + type: object + properties: + Selections: + type: array + items: + $ref: '#/components/schemas/AcceleratorSelection' + minItems: 1 + Count: + $ref: '#/components/schemas/AcceleratorCountRange' + required: + - Selections + additionalProperties: false + Ec2MarketType: + type: string + enum: + - on-demand + - spot + - wait-and-save + FleetAmountCapability: + type: object + properties: + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\.[a-zA-Z][a-zA-Z0-9]{0,63})+$ + Min: + type: number + Max: + type: number + required: + - Min + - Name + additionalProperties: false + FleetAttributeCapability: + type: object + properties: + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^([a-zA-Z][a-zA-Z0-9]{0,63}:)?attr(\.[a-zA-Z][a-zA-Z0-9]{0,63})+$ + Values: + type: array + items: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z_]([a-zA-Z0-9_\-]{0,99})$ + maxItems: 10 + minItems: 1 + required: + - Name + - Values + additionalProperties: false + FleetCapabilities: + type: object + properties: + Amounts: + type: array + items: + $ref: '#/components/schemas/FleetAmountCapability' + maxItems: 15 + minItems: 1 + Attributes: + type: array + items: + $ref: '#/components/schemas/FleetAttributeCapability' + maxItems: 15 + minItems: 1 + additionalProperties: false + FleetConfiguration: + oneOf: + - type: object + title: CustomerManaged + properties: + CustomerManaged: + $ref: '#/components/schemas/CustomerManagedFleetConfiguration' + required: + - CustomerManaged + additionalProperties: false + - type: object + title: ServiceManagedEc2 + properties: + ServiceManagedEc2: + $ref: '#/components/schemas/ServiceManagedEc2FleetConfiguration' + required: + - ServiceManagedEc2 + additionalProperties: false + FleetStatus: + type: string + enum: + - ACTIVE + - CREATE_IN_PROGRESS + - UPDATE_IN_PROGRESS + - CREATE_FAILED + - UPDATE_FAILED + - SUSPENDED + HostConfiguration: + type: object + properties: + ScriptBody: + type: string + maxLength: 15000 + minLength: 0 + ScriptTimeoutSeconds: + type: integer + default: 300 + maximum: 3600 + minimum: 300 + required: + - ScriptBody + additionalProperties: false + MemoryMiBRange: + type: object + properties: + Min: + type: integer + maximum: 2147483647 + minimum: 512 + Max: + type: integer + maximum: 2147483647 + minimum: 512 + required: + - Min + additionalProperties: false + ServiceManagedEc2FleetConfiguration: + type: object + properties: + InstanceCapabilities: + $ref: '#/components/schemas/ServiceManagedEc2InstanceCapabilities' + InstanceMarketOptions: + $ref: '#/components/schemas/ServiceManagedEc2InstanceMarketOptions' + VpcConfiguration: + $ref: '#/components/schemas/VpcConfiguration' + StorageProfileId: + type: string + pattern: ^sp-[0-9a-f]{32}$ + required: + - InstanceCapabilities + - InstanceMarketOptions + additionalProperties: false + ServiceManagedEc2InstanceMarketOptions: + type: object + properties: + Type: + $ref: '#/components/schemas/Ec2MarketType' + required: + - Type + additionalProperties: false + ServiceManagedEc2InstanceCapabilities: + type: object + properties: + VCpuCount: + $ref: '#/components/schemas/VCpuCountRange' + MemoryMiB: + $ref: '#/components/schemas/MemoryMiBRange' + OsFamily: + $ref: '#/components/schemas/ServiceManagedFleetOperatingSystemFamily' + CpuArchitectureType: + $ref: '#/components/schemas/CpuArchitectureType' + RootEbsVolume: + $ref: '#/components/schemas/Ec2EbsVolume' + AcceleratorCapabilities: + $ref: '#/components/schemas/AcceleratorCapabilities' + AllowedInstanceTypes: + type: array + items: + type: string + pattern: ^[a-zA-Z0-9]+\.[a-zA-Z0-9]+$ + maxItems: 100 + minItems: 1 + ExcludedInstanceTypes: + type: array + items: + type: string + pattern: ^[a-zA-Z0-9]+\.[a-zA-Z0-9]+$ + maxItems: 100 + minItems: 1 + CustomAmounts: + type: array + items: + $ref: '#/components/schemas/FleetAmountCapability' + maxItems: 15 + minItems: 1 + CustomAttributes: + type: array + items: + $ref: '#/components/schemas/FleetAttributeCapability' + maxItems: 15 + minItems: 1 + required: + - CpuArchitectureType + - MemoryMiB + - OsFamily + - VCpuCount + additionalProperties: false + ServiceManagedFleetOperatingSystemFamily: + type: string + enum: + - LINUX + - WINDOWS + TagPropagationMode: + type: string + enum: + - NO_PROPAGATION + - PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH + VCpuCountRange: + type: object + properties: + Min: + type: integer + maximum: 10000 + minimum: 1 + Max: + type: integer + maximum: 10000 + minimum: 1 + required: + - Min + additionalProperties: false + VpcConfiguration: + type: object + properties: + ResourceConfigurationArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 1 + additionalProperties: false + Fleet: + type: object + properties: + Capabilities: + $ref: '#/components/schemas/FleetCapabilities' + Configuration: + $ref: '#/components/schemas/FleetConfiguration' + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + FleetId: + type: string + pattern: ^fleet-[0-9a-f]{32}$ + HostConfiguration: + $ref: '#/components/schemas/HostConfiguration' + MaxWorkerCount: + type: integer + maximum: 2147483647 + minimum: 0 + MinWorkerCount: + type: integer + default: 0 + maximum: 2147483647 + minimum: 0 + RoleArn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$ + Status: + $ref: '#/components/schemas/FleetStatus' + StatusMessage: + type: string + WorkerCount: + type: integer + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}/fleet/fleet-[0-9a-z]{32} + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + required: + - Configuration + - DisplayName + - FarmId + - MaxWorkerCount + - RoleArn + x-stackql-resource-name: fleet + description: Definition of AWS::Deadline::Fleet Resource Type + x-type-name: AWS::Deadline::Fleet + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - FarmId + x-read-only-properties: + - Capabilities + - FleetId + - Status + - StatusMessage + - WorkerCount + - Arn + x-required-properties: + - Configuration + - DisplayName + - FarmId + - MaxWorkerCount + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + x-required-permissions: + create: + - deadline:CreateFleet + - deadline:GetFleet + - iam:PassRole + - identitystore:ListGroupMembershipsForMember + - logs:CreateLogGroup + - deadline:TagResource + - deadline:ListTagsForResource + - vpc-lattice:GetResourceGateway + - vpc-lattice:GetResourceConfiguration + - ec2:CreateVpcEndpoint + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeVpcs + read: + - deadline:GetFleet + - identitystore:ListGroupMembershipsForMember + - deadline:ListTagsForResource + update: + - deadline:UpdateFleet + - deadline:GetFleet + - iam:PassRole + - identitystore:ListGroupMembershipsForMember + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + - vpc-lattice:GetResourceGateway + - vpc-lattice:GetResourceConfiguration + - ec2:CreateVpcEndpoint + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeVpcs + delete: + - deadline:DeleteFleet + - deadline:GetFleet + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListFleets + - identitystore:DescribeGroup + - identitystore:DescribeUser + - identitystore:ListGroupMembershipsForMember + LicenseEndpointStatus: + type: string + enum: + - CREATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - READY + - NOT_READY + LicenseEndpoint: + type: object + properties: + DnsName: + type: string + LicenseEndpointId: + type: string + pattern: ^le-[0-9a-f]{32}$ + SecurityGroupIds: + type: array + items: + type: string + maxItems: 10 + minItems: 1 + Status: + $ref: '#/components/schemas/LicenseEndpointStatus' + StatusMessage: + type: string + maxLength: 1024 + minLength: 0 + SubnetIds: + type: array + items: + type: string + maxLength: 32 + minLength: 1 + maxItems: 10 + minItems: 1 + VpcId: + type: string + maxLength: 32 + minLength: 1 + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32} + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + required: + - SecurityGroupIds + - SubnetIds + - VpcId + x-stackql-resource-name: license_endpoint + description: Definition of AWS::Deadline::LicenseEndpoint Resource Type + x-type-name: AWS::Deadline::LicenseEndpoint + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - SecurityGroupIds + - SubnetIds + - VpcId + x-read-only-properties: + - DnsName + - LicenseEndpointId + - Status + - StatusMessage + - Arn + x-required-properties: + - SecurityGroupIds + - SubnetIds + - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + x-required-permissions: + create: + - deadline:CreateLicenseEndpoint + - deadline:GetLicenseEndpoint + - ec2:CreateTags + - ec2:CreateVpcEndpoint + - ec2:DescribeVpcEndpoints + - deadline:TagResource + - deadline:ListTagsForResource + read: + - deadline:GetLicenseEndpoint + - deadline:ListTagsForResource + update: + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + - deadline:GetLicenseEndpoint + delete: + - deadline:GetLicenseEndpoint + - deadline:DeleteLicenseEndpoint + - ec2:DeleteVpcEndpoints + - ec2:DescribeVpcEndpoints + list: + - deadline:ListLicenseEndpoints + Limit: + type: object + properties: + AmountRequirementName: + type: string + maxLength: 1024 + CurrentCount: + type: integer + maximum: 2147483647 + minimum: 0 + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + LimitId: + type: string + pattern: ^limit-[0-9a-f]{32}$ + MaxCount: + type: integer + maximum: 2147483647 + minimum: -1 + required: + - AmountRequirementName + - DisplayName + - MaxCount + - FarmId + x-stackql-resource-name: limit + description: Definition of AWS::Deadline::Limit Resource Type + x-type-name: AWS::Deadline::Limit + x-stackql-primary-identifier: + - FarmId + - LimitId + x-create-only-properties: + - AmountRequirementName + - FarmId + x-read-only-properties: + - CurrentCount + - LimitId + x-required-properties: + - AmountRequirementName + - DisplayName + - MaxCount + - FarmId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - deadline:CreateLimit + - deadline:GetLimit + - kms:Encrypt + - identitystore:ListGroupMembershipsForMember + read: + - deadline:GetLimit + - kms:Decrypt + - identitystore:ListGroupMembershipsForMember + update: + - deadline:UpdateLimit + - deadline:GetLimit + - kms:Encrypt + - identitystore:ListGroupMembershipsForMember + delete: + - deadline:DeleteLimit + - deadline:GetLimit + - kms:Decrypt + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListLimits + - identitystore:ListGroupMembershipsForMember + MeteredProduct: + type: object + properties: + LicenseEndpointId: + type: string + pattern: ^le-[0-9a-f]{32}$ + ProductId: + type: string + pattern: ^[0-9a-z]{1,32}-[.0-9a-z]{1,32}$ + Port: + type: integer + minimum: 1024 + maximum: 65535 + Family: + type: string + minLength: 1 + maxLength: 64 + Vendor: + type: string + minLength: 1 + maxLength: 64 + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}/metered-product/[0-9a-z]{1,32}-[.0-9a-z]{1,32} + x-stackql-resource-name: metered_product + description: Definition of AWS::Deadline::MeteredProduct Resource Type + x-type-name: AWS::Deadline::MeteredProduct + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - LicenseEndpointId + - ProductId + x-read-only-properties: + - Arn + - Port + - Family + - Vendor + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - deadline:PutMeteredProduct + - deadline:ListMeteredProducts + read: + - deadline:GetMeteredProduct + - deadline:ListMeteredProducts + delete: + - deadline:DeleteMeteredProduct + - deadline:ListMeteredProducts + list: + - deadline:ListMeteredProducts + Monitor: + type: object + properties: + DisplayName: + type: string + maxLength: 100 + minLength: 1 + IdentityCenterApplicationArn: + type: string + IdentityCenterInstanceArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + MonitorId: + type: string + pattern: ^monitor-[0-9a-f]{32}$ + RoleArn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$ + Subdomain: + type: string + pattern: ^[a-z0-9-]{1,100}$ + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + Url: + type: string + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:monitor/monitor-[0-9a-z]{32}$ + required: + - DisplayName + - IdentityCenterInstanceArn + - RoleArn + - Subdomain + x-stackql-resource-name: monitor + description: Definition of AWS::Deadline::Monitor Resource Type + x-type-name: AWS::Deadline::Monitor + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - IdentityCenterInstanceArn + x-read-only-properties: + - IdentityCenterApplicationArn + - MonitorId + - Url + - Arn + x-required-properties: + - DisplayName + - IdentityCenterInstanceArn + - RoleArn + - Subdomain + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + x-required-permissions: + create: + - deadline:CreateMonitor + - deadline:GetMonitor + - deadline:TagResource + - deadline:ListTagsForResource + - iam:PassRole + - kms:CreateGrant + - sso:CreateApplication + - sso:DeleteApplication + - sso:PutApplicationAssignmentConfiguration + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + read: + - deadline:GetMonitor + - deadline:ListTagsForResource + update: + - deadline:GetMonitor + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + - deadline:UpdateMonitor + - iam:PassRole + - kms:CreateGrant + - sso:PutApplicationGrant + - sso:UpdateApplication + delete: + - deadline:DeleteMonitor + - deadline:GetMonitor + - sso:DeleteApplication + list: + - deadline:ListMonitors + DefaultQueueBudgetAction: + type: string + default: NONE + enum: + - NONE + - STOP_SCHEDULING_AND_COMPLETE_TASKS + - STOP_SCHEDULING_AND_CANCEL_TASKS + JobAttachmentSettings: + type: object + properties: + S3BucketName: + type: string + maxLength: 63 + minLength: 3 + pattern: (?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$) + RootPrefix: + type: string + maxLength: 63 + minLength: 1 + required: + - RootPrefix + - S3BucketName + additionalProperties: false + JobRunAsUser: + type: object + properties: + Posix: + $ref: '#/components/schemas/PosixUser' + Windows: + $ref: '#/components/schemas/WindowsUser' + RunAs: + $ref: '#/components/schemas/RunAs' + required: + - RunAs + additionalProperties: false + PosixUser: + type: object + properties: + User: + type: string + maxLength: 31 + minLength: 0 + pattern: ^(?:[a-z][a-z0-9-]{0,30})?$ + Group: + type: string + maxLength: 31 + minLength: 0 + pattern: ^(?:[a-z][a-z0-9-]{0,30})?$ + required: + - Group + - User + additionalProperties: false + RunAs: + type: string + enum: + - QUEUE_CONFIGURED_USER + - WORKER_AGENT_USER + WindowsUser: + type: object + properties: + User: + type: string + maxLength: 111 + minLength: 0 + pattern: ^[^"'/\[\]:;|=,+*?<>\s]*$ + PasswordArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:(aws[a-zA-Z-]*):secretsmanager:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:secret:[a-zA-Z0-9-/_+=.@]{1,2028}$ + required: + - PasswordArn + - User + additionalProperties: false + Queue: + type: object + properties: + AllowedStorageProfileIds: + type: array + items: + type: string + pattern: ^sp-[0-9a-f]{32}$ + maxItems: 20 + minItems: 0 + uniqueItems: true + DefaultBudgetAction: + $ref: '#/components/schemas/DefaultQueueBudgetAction' + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + JobAttachmentSettings: + $ref: '#/components/schemas/JobAttachmentSettings' + JobRunAsUser: + $ref: '#/components/schemas/JobRunAsUser' + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + RequiredFileSystemLocationNames: + type: array + items: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[0-9A-Za-z ]*$ + maxItems: 20 + minItems: 0 + uniqueItems: true + RoleArn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$ + Arn: + type: string + pattern: ^arn:* + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + required: + - DisplayName + - FarmId + x-stackql-resource-name: queue + description: Definition of AWS::Deadline::Queue Resource Type + x-type-name: AWS::Deadline::Queue + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - FarmId + x-read-only-properties: + - QueueId + - Arn + x-required-properties: + - DisplayName + - FarmId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + x-required-permissions: + create: + - deadline:CreateQueue + - deadline:GetQueue + - iam:PassRole + - identitystore:ListGroupMembershipsForMember + - logs:CreateLogGroup + - s3:ListBucket + - deadline:TagResource + - deadline:ListTagsForResource + read: + - deadline:GetQueue + - identitystore:ListGroupMembershipsForMember + - deadline:ListTagsForResource + update: + - deadline:UpdateQueue + - deadline:GetQueue + - iam:PassRole + - identitystore:ListGroupMembershipsForMember + - logs:CreateLogGroup + - s3:ListBucket + - deadline:TagResource + - deadline:UntagResource + - deadline:ListTagsForResource + delete: + - deadline:DeleteQueue + - deadline:GetQueue + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListQueues + - identitystore:DescribeGroup + - identitystore:DescribeUser + - identitystore:ListGroupMembershipsForMember + EnvironmentTemplateType: + type: string + enum: + - JSON + - YAML + QueueEnvironment: + type: object + properties: + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + Name: + type: string + Priority: + type: integer + maximum: 10000 + minimum: 0 + QueueEnvironmentId: + type: string + pattern: ^queueenv-[0-9a-f]{32}$ + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + Template: + type: string + maxLength: 15000 + minLength: 1 + TemplateType: + $ref: '#/components/schemas/EnvironmentTemplateType' + required: + - FarmId + - QueueId + - Priority + - Template + - TemplateType + x-stackql-resource-name: queue_environment + description: Definition of AWS::Deadline::QueueEnvironment Resource Type + x-type-name: AWS::Deadline::QueueEnvironment + x-stackql-primary-identifier: + - FarmId + - QueueId + - QueueEnvironmentId + x-create-only-properties: + - FarmId + - QueueId + x-read-only-properties: + - Name + - QueueEnvironmentId + x-required-properties: + - FarmId + - QueueId + - Priority + - Template + - TemplateType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - deadline:CreateQueueEnvironment + - identitystore:ListGroupMembershipsForMember + read: + - deadline:GetQueueEnvironment + - identitystore:ListGroupMembershipsForMember + update: + - deadline:UpdateQueueEnvironment + - identitystore:ListGroupMembershipsForMember + delete: + - deadline:DeleteQueueEnvironment + - deadline:GetQueueEnvironment + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListQueueEnvironments + - identitystore:ListGroupMembershipsForMember + QueueFleetAssociation: + type: object + properties: + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + FleetId: + type: string + pattern: ^fleet-[0-9a-f]{32}$ + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + required: + - FarmId + - FleetId + - QueueId + x-stackql-resource-name: queue_fleet_association + description: Definition of AWS::Deadline::QueueFleetAssociation Resource Type + x-type-name: AWS::Deadline::QueueFleetAssociation + x-stackql-primary-identifier: + - FarmId + - FleetId + - QueueId + x-create-only-properties: + - FarmId + - FleetId + - QueueId + x-required-properties: + - FarmId + - FleetId + - QueueId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - deadline:CreateQueueFleetAssociation + - deadline:GetQueueFleetAssociation + - identitystore:ListGroupMembershipsForMember + read: + - deadline:GetQueueFleetAssociation + - identitystore:ListGroupMembershipsForMember + delete: + - deadline:DeleteQueueFleetAssociation + - deadline:GetQueueFleetAssociation + - deadline:UpdateQueueFleetAssociation + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListQueueFleetAssociations + - identitystore:ListGroupMembershipsForMember + QueueLimitAssociation: + type: object + properties: + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + LimitId: + type: string + pattern: ^limit-[0-9a-f]{32}$ + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + required: + - FarmId + - LimitId + - QueueId + x-stackql-resource-name: queue_limit_association + description: Definition of AWS::Deadline::QueueLimitAssociation Resource Type + x-type-name: AWS::Deadline::QueueLimitAssociation + x-stackql-primary-identifier: + - FarmId + - LimitId + - QueueId + x-create-only-properties: + - FarmId + - LimitId + - QueueId + x-required-properties: + - FarmId + - LimitId + - QueueId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - deadline:CreateQueueLimitAssociation + - deadline:GetQueueLimitAssociation + - identitystore:ListGroupMembershipsForMember + read: + - deadline:GetQueueLimitAssociation + - identitystore:ListGroupMembershipsForMember + delete: + - deadline:DeleteQueueLimitAssociation + - deadline:GetQueueLimitAssociation + - deadline:UpdateQueueLimitAssociation + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListQueueLimitAssociations + - identitystore:ListGroupMembershipsForMember + FileSystemLocation: + type: object + properties: + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[0-9A-Za-z ]*$ + Path: + type: string + maxLength: 1024 + minLength: 0 + Type: + $ref: '#/components/schemas/FileSystemLocationType' + required: + - Name + - Path + - Type + additionalProperties: false + FileSystemLocationType: + type: string + enum: + - SHARED + - LOCAL + StorageProfileOperatingSystemFamily: + type: string + enum: + - WINDOWS + - LINUX + - MACOS + StorageProfile: + type: object + properties: + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + FileSystemLocations: + type: array + items: + $ref: '#/components/schemas/FileSystemLocation' + maxItems: 20 + minItems: 0 + OsFamily: + $ref: '#/components/schemas/StorageProfileOperatingSystemFamily' + StorageProfileId: + type: string + pattern: ^sp-[0-9a-f]{32}$ + required: + - DisplayName + - FarmId + - OsFamily + x-stackql-resource-name: storage_profile + description: Definition of AWS::Deadline::StorageProfile Resource Type + x-type-name: AWS::Deadline::StorageProfile + x-stackql-primary-identifier: + - FarmId + - StorageProfileId + x-create-only-properties: + - FarmId + x-read-only-properties: + - StorageProfileId + x-required-properties: + - DisplayName + - FarmId + - OsFamily + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - deadline:CreateStorageProfile + - deadline:GetStorageProfile + - identitystore:ListGroupMembershipsForMember + read: + - deadline:GetStorageProfile + - identitystore:ListGroupMembershipsForMember + update: + - deadline:UpdateStorageProfile + - deadline:GetStorageProfile + - identitystore:ListGroupMembershipsForMember + delete: + - deadline:DeleteStorageProfile + - deadline:GetStorageProfile + - identitystore:ListGroupMembershipsForMember + list: + - deadline:ListStorageProfiles + - identitystore:ListGroupMembershipsForMember + CreateFarmRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + KmsKeyArn: + type: string + pattern: ^arn:aws[-a-z]*:kms:.*:key/.* + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}$ + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateFarmRequest + type: object + required: [] + CreateFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Capabilities: + $ref: '#/components/schemas/FleetCapabilities' + Configuration: + $ref: '#/components/schemas/FleetConfiguration' + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + FleetId: + type: string + pattern: ^fleet-[0-9a-f]{32}$ + HostConfiguration: + $ref: '#/components/schemas/HostConfiguration' + MaxWorkerCount: + type: integer + maximum: 2147483647 + minimum: 0 + MinWorkerCount: + type: integer + default: 0 + maximum: 2147483647 + minimum: 0 + RoleArn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$ + Status: + $ref: '#/components/schemas/FleetStatus' + StatusMessage: + type: string + WorkerCount: + type: integer + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}/fleet/fleet-[0-9a-z]{32} + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateFleetRequest + type: object + required: [] + CreateLicenseEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DnsName: + type: string + LicenseEndpointId: + type: string + pattern: ^le-[0-9a-f]{32}$ + SecurityGroupIds: + type: array + items: + type: string + maxItems: 10 + minItems: 1 + Status: + $ref: '#/components/schemas/LicenseEndpointStatus' + StatusMessage: + type: string + maxLength: 1024 + minLength: 0 + SubnetIds: + type: array + items: + type: string + maxLength: 32 + minLength: 1 + maxItems: 10 + minItems: 1 + VpcId: + type: string + maxLength: 32 + minLength: 1 + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32} + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateLicenseEndpointRequest + type: object + required: [] + CreateLimitRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AmountRequirementName: + type: string + maxLength: 1024 + CurrentCount: + type: integer + maximum: 2147483647 + minimum: 0 + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + LimitId: + type: string + pattern: ^limit-[0-9a-f]{32}$ + MaxCount: + type: integer + maximum: 2147483647 + minimum: -1 + x-stackQL-stringOnly: true + x-title: CreateLimitRequest + type: object + required: [] + CreateMeteredProductRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LicenseEndpointId: + type: string + pattern: ^le-[0-9a-f]{32}$ + ProductId: + type: string + pattern: ^[0-9a-z]{1,32}-[.0-9a-z]{1,32}$ + Port: + type: integer + minimum: 1024 + maximum: 65535 + Family: + type: string + minLength: 1 + maxLength: 64 + Vendor: + type: string + minLength: 1 + maxLength: 64 + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}/metered-product/[0-9a-z]{1,32}-[.0-9a-z]{1,32} + x-stackQL-stringOnly: true + x-title: CreateMeteredProductRequest + type: object + required: [] + CreateMonitorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DisplayName: + type: string + maxLength: 100 + minLength: 1 + IdentityCenterApplicationArn: + type: string + IdentityCenterInstanceArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + MonitorId: + type: string + pattern: ^monitor-[0-9a-f]{32}$ + RoleArn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$ + Subdomain: + type: string + pattern: ^[a-z0-9-]{1,100}$ + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + Url: + type: string + Arn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:monitor/monitor-[0-9a-z]{32}$ + x-stackQL-stringOnly: true + x-title: CreateMonitorRequest + type: object + required: [] + CreateQueueRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllowedStorageProfileIds: + type: array + items: + type: string + pattern: ^sp-[0-9a-f]{32}$ + maxItems: 20 + minItems: 0 + uniqueItems: true + DefaultBudgetAction: + $ref: '#/components/schemas/DefaultQueueBudgetAction' + Description: + type: string + default: '' + maxLength: 100 + minLength: 0 + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + JobAttachmentSettings: + $ref: '#/components/schemas/JobAttachmentSettings' + JobRunAsUser: + $ref: '#/components/schemas/JobRunAsUser' + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + RequiredFileSystemLocationNames: + type: array + items: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[0-9A-Za-z ]*$ + maxItems: 20 + minItems: 0 + uniqueItems: true + RoleArn: + type: string + pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$ + Arn: + type: string + pattern: ^arn:* + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateQueueRequest + type: object + required: [] + CreateQueueEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + Name: + type: string + Priority: + type: integer + maximum: 10000 + minimum: 0 + QueueEnvironmentId: + type: string + pattern: ^queueenv-[0-9a-f]{32}$ + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + Template: + type: string + maxLength: 15000 + minLength: 1 + TemplateType: + $ref: '#/components/schemas/EnvironmentTemplateType' + x-stackQL-stringOnly: true + x-title: CreateQueueEnvironmentRequest + type: object + required: [] + CreateQueueFleetAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + FleetId: + type: string + pattern: ^fleet-[0-9a-f]{32}$ + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + x-stackQL-stringOnly: true + x-title: CreateQueueFleetAssociationRequest + type: object + required: [] + CreateQueueLimitAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + LimitId: + type: string + pattern: ^limit-[0-9a-f]{32}$ + QueueId: + type: string + pattern: ^queue-[0-9a-f]{32}$ + x-stackQL-stringOnly: true + x-title: CreateQueueLimitAssociationRequest + type: object + required: [] + CreateStorageProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DisplayName: + type: string + maxLength: 100 + minLength: 1 + FarmId: + type: string + pattern: ^farm-[0-9a-f]{32}$ + FileSystemLocations: + type: array + items: + $ref: '#/components/schemas/FileSystemLocation' + maxItems: 20 + minItems: 0 + OsFamily: + $ref: '#/components/schemas/StorageProfileOperatingSystemFamily' + StorageProfileId: + type: string + pattern: ^sp-[0-9a-f]{32}$ + x-stackQL-stringOnly: true + x-title: CreateStorageProfileRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + farms: + name: farms + id: awscc.deadline.farms + x-cfn-schema-name: Farm + x-cfn-type-name: AWS::Deadline::Farm + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Farm&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Farm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Farm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Farm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/farms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/farms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/farms/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Farm' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Farm' + AND data__Identifier = '' + AND region = 'us-east-1' + farms_list_only: + name: farms_list_only + id: awscc.deadline.farms_list_only + x-cfn-schema-name: Farm + x-cfn-type-name: AWS::Deadline::Farm + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Farm' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Farm' + AND region = 'us-east-1' + fleets: + name: fleets + id: awscc.deadline.fleets + x-cfn-schema-name: Fleet + x-cfn-type-name: AWS::Deadline::Fleet + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Capabilities') as capabilities, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.HostConfiguration') as host_configuration, + JSON_EXTRACT(Properties, '$.MaxWorkerCount') as max_worker_count, + JSON_EXTRACT(Properties, '$.MinWorkerCount') as min_worker_count, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.WorkerCount') as worker_count, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'HostConfiguration') as host_configuration, + json_extract_path_text(Properties, 'MaxWorkerCount') as max_worker_count, + json_extract_path_text(Properties, 'MinWorkerCount') as min_worker_count, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'WorkerCount') as worker_count, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fleets_list_only: + name: fleets_list_only + id: awscc.deadline.fleets_list_only + x-cfn-schema-name: Fleet + x-cfn-type-name: AWS::Deadline::Fleet + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Fleet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Fleet' + AND region = 'us-east-1' + license_endpoints: + name: license_endpoints + id: awscc.deadline.license_endpoints + x-cfn-schema-name: LicenseEndpoint + x-cfn-type-name: AWS::Deadline::LicenseEndpoint + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LicenseEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::LicenseEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::LicenseEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::LicenseEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/license_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/license_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/license_endpoints/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DnsName') as dns_name, + JSON_EXTRACT(Properties, '$.LicenseEndpointId') as license_endpoint_id, + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DnsName') as dns_name, + json_extract_path_text(Properties, 'LicenseEndpointId') as license_endpoint_id, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + license_endpoints_list_only: + name: license_endpoints_list_only + id: awscc.deadline.license_endpoints_list_only + x-cfn-schema-name: LicenseEndpoint + x-cfn-type-name: AWS::Deadline::LicenseEndpoint + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' + AND region = 'us-east-1' + limits: + name: limits + id: awscc.deadline.limits + x-cfn-schema-name: Limit + x-cfn-type-name: AWS::Deadline::Limit + x-identifiers: + - FarmId + - LimitId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Limit&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Limit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Limit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Limit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/limits/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/limits/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/limits/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AmountRequirementName') as amount_requirement_name, + JSON_EXTRACT(Properties, '$.CurrentCount') as current_count, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.LimitId') as limit_id, + JSON_EXTRACT(Properties, '$.MaxCount') as max_count + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Limit' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AmountRequirementName') as amount_requirement_name, + json_extract_path_text(Properties, 'CurrentCount') as current_count, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'LimitId') as limit_id, + json_extract_path_text(Properties, 'MaxCount') as max_count + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Limit' + AND data__Identifier = '|' + AND region = 'us-east-1' + limits_list_only: + name: limits_list_only + id: awscc.deadline.limits_list_only + x-cfn-schema-name: Limit + x-cfn-type-name: AWS::Deadline::Limit + x-identifiers: + - FarmId + - LimitId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.LimitId') as limit_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Limit' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'LimitId') as limit_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Limit' + AND region = 'us-east-1' + metered_products: + name: metered_products + id: awscc.deadline.metered_products + x-cfn-schema-name: MeteredProduct + x-cfn-type-name: AWS::Deadline::MeteredProduct + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MeteredProduct&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::MeteredProduct" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::MeteredProduct" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/metered_products/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/metered_products/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.LicenseEndpointId') as license_endpoint_id, + JSON_EXTRACT(Properties, '$.ProductId') as product_id, + JSON_EXTRACT(Properties, '$.Port') as port, + JSON_EXTRACT(Properties, '$.Family') as family, + JSON_EXTRACT(Properties, '$.Vendor') as vendor, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LicenseEndpointId') as license_endpoint_id, + json_extract_path_text(Properties, 'ProductId') as product_id, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Vendor') as vendor, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' + AND data__Identifier = '' + AND region = 'us-east-1' + metered_products_list_only: + name: metered_products_list_only + id: awscc.deadline.metered_products_list_only + x-cfn-schema-name: MeteredProduct + x-cfn-type-name: AWS::Deadline::MeteredProduct + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' + AND region = 'us-east-1' + monitors: + name: monitors + id: awscc.deadline.monitors + x-cfn-schema-name: Monitor + x-cfn-type-name: AWS::Deadline::Monitor + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Monitor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Monitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Monitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Monitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/monitors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/monitors/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.IdentityCenterApplicationArn') as identity_center_application_arn, + JSON_EXTRACT(Properties, '$.IdentityCenterInstanceArn') as identity_center_instance_arn, + JSON_EXTRACT(Properties, '$.MonitorId') as monitor_id, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Subdomain') as subdomain, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Url') as url, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Monitor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'IdentityCenterApplicationArn') as identity_center_application_arn, + json_extract_path_text(Properties, 'IdentityCenterInstanceArn') as identity_center_instance_arn, + json_extract_path_text(Properties, 'MonitorId') as monitor_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Subdomain') as subdomain, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Monitor' + AND data__Identifier = '' + AND region = 'us-east-1' + monitors_list_only: + name: monitors_list_only + id: awscc.deadline.monitors_list_only + x-cfn-schema-name: Monitor + x-cfn-type-name: AWS::Deadline::Monitor + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Monitor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Monitor' + AND region = 'us-east-1' + queues: + name: queues + id: awscc.deadline.queues + x-cfn-schema-name: Queue + x-cfn-type-name: AWS::Deadline::Queue + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AllowedStorageProfileIds') as allowed_storage_profile_ids, + JSON_EXTRACT(Properties, '$.DefaultBudgetAction') as default_budget_action, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.JobAttachmentSettings') as job_attachment_settings, + JSON_EXTRACT(Properties, '$.JobRunAsUser') as job_run_as_user, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id, + JSON_EXTRACT(Properties, '$.RequiredFileSystemLocationNames') as required_file_system_location_names, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllowedStorageProfileIds') as allowed_storage_profile_ids, + json_extract_path_text(Properties, 'DefaultBudgetAction') as default_budget_action, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'JobAttachmentSettings') as job_attachment_settings, + json_extract_path_text(Properties, 'JobRunAsUser') as job_run_as_user, + json_extract_path_text(Properties, 'QueueId') as queue_id, + json_extract_path_text(Properties, 'RequiredFileSystemLocationNames') as required_file_system_location_names, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + queues_list_only: + name: queues_list_only + id: awscc.deadline.queues_list_only + x-cfn-schema-name: Queue + x-cfn-type-name: AWS::Deadline::Queue + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Queue' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Queue' + AND region = 'us-east-1' + queue_environments: + name: queue_environments + id: awscc.deadline.queue_environments + x-cfn-schema-name: QueueEnvironment + x-cfn-type-name: AWS::Deadline::QueueEnvironment + x-identifiers: + - FarmId + - QueueId + - QueueEnvironmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QueueEnvironment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueEnvironment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queue_environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queue_environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/queue_environments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Priority') as priority, + JSON_EXTRACT(Properties, '$.QueueEnvironmentId') as queue_environment_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id, + JSON_EXTRACT(Properties, '$.Template') as template, + JSON_EXTRACT(Properties, '$.TemplateType') as template_type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'QueueEnvironmentId') as queue_environment_id, + json_extract_path_text(Properties, 'QueueId') as queue_id, + json_extract_path_text(Properties, 'Template') as template, + json_extract_path_text(Properties, 'TemplateType') as template_type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' + AND data__Identifier = '||' + AND region = 'us-east-1' + queue_environments_list_only: + name: queue_environments_list_only + id: awscc.deadline.queue_environments_list_only + x-cfn-schema-name: QueueEnvironment + x-cfn-type-name: AWS::Deadline::QueueEnvironment + x-identifiers: + - FarmId + - QueueId + - QueueEnvironmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id, + JSON_EXTRACT(Properties, '$.QueueEnvironmentId') as queue_environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'QueueId') as queue_id, + json_extract_path_text(Properties, 'QueueEnvironmentId') as queue_environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' + AND region = 'us-east-1' + queue_fleet_associations: + name: queue_fleet_associations + id: awscc.deadline.queue_fleet_associations + x-cfn-schema-name: QueueFleetAssociation + x-cfn-type-name: AWS::Deadline::QueueFleetAssociation + x-identifiers: + - FarmId + - FleetId + - QueueId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QueueFleetAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueFleetAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueFleetAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queue_fleet_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queue_fleet_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'QueueId') as queue_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + queue_fleet_associations_list_only: + name: queue_fleet_associations_list_only + id: awscc.deadline.queue_fleet_associations_list_only + x-cfn-schema-name: QueueFleetAssociation + x-cfn-type-name: AWS::Deadline::QueueFleetAssociation + x-identifiers: + - FarmId + - FleetId + - QueueId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'QueueId') as queue_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' + AND region = 'us-east-1' + queue_limit_associations: + name: queue_limit_associations + id: awscc.deadline.queue_limit_associations + x-cfn-schema-name: QueueLimitAssociation + x-cfn-type-name: AWS::Deadline::QueueLimitAssociation + x-identifiers: + - FarmId + - LimitId + - QueueId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QueueLimitAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueLimitAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::QueueLimitAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queue_limit_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queue_limit_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.LimitId') as limit_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueLimitAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'LimitId') as limit_id, + json_extract_path_text(Properties, 'QueueId') as queue_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueLimitAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + queue_limit_associations_list_only: + name: queue_limit_associations_list_only + id: awscc.deadline.queue_limit_associations_list_only + x-cfn-schema-name: QueueLimitAssociation + x-cfn-type-name: AWS::Deadline::QueueLimitAssociation + x-identifiers: + - FarmId + - LimitId + - QueueId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.LimitId') as limit_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueLimitAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'LimitId') as limit_id, + json_extract_path_text(Properties, 'QueueId') as queue_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueLimitAssociation' + AND region = 'us-east-1' + storage_profiles: + name: storage_profiles + id: awscc.deadline.storage_profiles + x-cfn-schema-name: StorageProfile + x-cfn-type-name: AWS::Deadline::StorageProfile + x-identifiers: + - FarmId + - StorageProfileId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StorageProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::StorageProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::StorageProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Deadline::StorageProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.FileSystemLocations') as file_system_locations, + JSON_EXTRACT(Properties, '$.OsFamily') as os_family, + JSON_EXTRACT(Properties, '$.StorageProfileId') as storage_profile_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::StorageProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FileSystemLocations') as file_system_locations, + json_extract_path_text(Properties, 'OsFamily') as os_family, + json_extract_path_text(Properties, 'StorageProfileId') as storage_profile_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::StorageProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + storage_profiles_list_only: + name: storage_profiles_list_only + id: awscc.deadline.storage_profiles_list_only + x-cfn-schema-name: StorageProfile + x-cfn-type-name: AWS::Deadline::StorageProfile + x-identifiers: + - FarmId + - StorageProfileId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.StorageProfileId') as storage_profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::StorageProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'StorageProfileId') as storage_profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::StorageProfile' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Farm&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFarm + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFarmRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LicenseEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLicenseEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLicenseEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Limit&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLimit + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLimitRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MeteredProduct&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMeteredProduct + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMeteredProductRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Monitor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMonitor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMonitorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueue + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QueueEnvironment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueueEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QueueFleetAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueueFleetAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueFleetAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QueueLimitAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueueLimitAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueLimitAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StorageProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStorageProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStorageProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/detective.yaml b/providers/src/awscc/v00.00.00000/services/detective.yaml index 2fb8f645..5beb552a 100644 --- a/providers/src/awscc/v00.00.00000/services/detective.yaml +++ b/providers/src/awscc/v00.00.00000/services/detective.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Detective - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -35,16 +415,31 @@ components: default: false description: Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph. x-stackql-resource-name: graph - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Detective::Graph + x-type-name: AWS::Detective::Graph + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - detective:UntagResource + - detective:TagResource + - detective:ListTagsForResource x-required-permissions: create: - detective:CreateGraph + - detective:ListGraphs + - detective:TagResource - detective:UpdateOrganizationConfiguration - organizations:DescribeOrganization update: + - detective:ListGraphs - detective:UntagResource - detective:TagResource - detective:ListTagsForResource @@ -57,6 +452,7 @@ components: - organizations:DescribeOrganization delete: - detective:DeleteGraph + - detective:ListGraphs list: - detective:ListGraphs - detective:ListTagsForResource @@ -91,12 +487,23 @@ components: - MemberId - MemberEmailAddress x-stackql-resource-name: member_invitation - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Detective::MemberInvitation + x-type-name: AWS::Detective::MemberInvitation + x-stackql-primary-identifier: - GraphArn - MemberId x-create-only-properties: - GraphArn - MemberId + x-write-only-properties: + - Message + - DisableEmailNotification + x-required-properties: + - GraphArn + - MemberId + - MemberEmailAddress + x-tagging: + taggable: false x-required-permissions: create: - detective:CreateMembers @@ -122,12 +529,21 @@ components: required: - AccountId x-stackql-resource-name: organization_admin - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Detective::OrganizationAdmin + x-type-name: AWS::Detective::OrganizationAdmin + x-stackql-primary-identifier: - AccountId x-create-only-properties: - AccountId x-read-only-properties: - GraphArn + x-required-properties: + - AccountId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - detective:EnableOrganizationAdminAccount @@ -148,43 +564,163 @@ components: list: - detective:ListOrganizationAdminAccount - organizations:DescribeOrganization + CreateGraphRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The Detective graph ARN + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + AutoEnableMembers: + type: boolean + default: false + description: Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph. + x-stackQL-stringOnly: true + x-title: CreateGraphRequest + type: object + required: [] + CreateMemberInvitationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GraphArn: + description: The ARN of the graph to which the member account will be invited + type: string + pattern: arn:aws(-[\w]+)*:detective:(([a-z]+-)+[0-9]+):[0-9]{12}:graph:[0-9a-f]{32} + MemberId: + description: The AWS account ID to be invited to join the graph as a member + type: string + pattern: '[0-9]{12}' + MemberEmailAddress: + description: The root email address for the account to be invited, for validation. Updating this field has no effect. + type: string + pattern: .*@.* + DisableEmailNotification: + description: When set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect. + type: boolean + default: false + Message: + description: A message to be included in the email invitation sent to the invited account. Updating this field has no effect. + type: string + minLength: 1 + maxLength: 1000 + x-stackQL-stringOnly: true + x-title: CreateMemberInvitationRequest + type: object + required: [] + CreateOrganizationAdminRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + description: The account ID of the account that should be registered as your Organization's delegated administrator for Detective + type: string + pattern: '[0-9]{12}' + GraphArn: + type: string + description: The Detective graph ARN + x-stackQL-stringOnly: true + x-title: CreateOrganizationAdminRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: graphs: name: graphs id: awscc.detective.graphs x-cfn-schema-name: Graph - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' - AND region = 'us-east-1' - graph: - name: graph - id: awscc.detective.graph - x-cfn-schema-name: Graph - x-type: get + x-cfn-type-name: AWS::Detective::Graph x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Graph&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::Graph" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::Graph" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::Graph" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/graphs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/graphs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/graphs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -196,7 +732,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -207,14 +743,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::Graph' AND data__Identifier = '' AND region = 'us-east-1' - member_invitations: - name: member_invitations - id: awscc.detective.member_invitations - x-cfn-schema-name: MemberInvitation - x-type: list + graphs_list_only: + name: graphs_list_only + id: awscc.detective.graphs_list_only + x-cfn-schema-name: Graph + x-cfn-type-name: AWS::Detective::Graph x-identifiers: - - GraphArn - - MemberId + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -222,31 +763,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GraphArn') as graph_arn, - JSON_EXTRACT(Properties, '$.MemberId') as member_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GraphArn') as graph_arn, - json_extract_path_text(Properties, 'MemberId') as member_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' AND region = 'us-east-1' - member_invitation: - name: member_invitation - id: awscc.detective.member_invitation + member_invitations: + name: member_invitations + id: awscc.detective.member_invitations x-cfn-schema-name: MemberInvitation - x-type: get + x-cfn-type-name: AWS::Detective::MemberInvitation x-identifiers: - GraphArn - MemberId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MemberInvitation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::MemberInvitation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::MemberInvitation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/member_invitations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/member_invitations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -260,7 +834,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -273,13 +847,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::MemberInvitation' AND data__Identifier = '|' AND region = 'us-east-1' - organization_admins: - name: organization_admins - id: awscc.detective.organization_admins - x-cfn-schema-name: OrganizationAdmin - x-type: list + member_invitations_list_only: + name: member_invitations_list_only + id: awscc.detective.member_invitations_list_only + x-cfn-schema-name: MemberInvitation + x-cfn-type-name: AWS::Detective::MemberInvitation x-identifiers: - - AccountId + - GraphArn + - MemberId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -287,28 +868,65 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' + JSON_EXTRACT(Properties, '$.GraphArn') as graph_arn, + JSON_EXTRACT(Properties, '$.MemberId') as member_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' + json_extract_path_text(Properties, 'GraphArn') as graph_arn, + json_extract_path_text(Properties, 'MemberId') as member_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' AND region = 'us-east-1' - organization_admin: - name: organization_admin - id: awscc.detective.organization_admin + organization_admins: + name: organization_admins + id: awscc.detective.organization_admins x-cfn-schema-name: OrganizationAdmin - x-type: get + x-cfn-type-name: AWS::Detective::OrganizationAdmin x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationAdmin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::OrganizationAdmin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Detective::OrganizationAdmin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organization_admins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organization_admins/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -319,7 +937,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -329,3 +947,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' AND data__Identifier = '' AND region = 'us-east-1' + organization_admins_list_only: + name: organization_admins_list_only + id: awscc.detective.organization_admins_list_only + x-cfn-schema-name: OrganizationAdmin + x-cfn-type-name: AWS::Detective::OrganizationAdmin + x-identifiers: + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Graph&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGraph + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGraphRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MemberInvitation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMemberInvitation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMemberInvitationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationAdmin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationAdmin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationAdminRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/devopsguru.yaml b/providers/src/awscc/v00.00.00000/services/devopsguru.yaml index 6792a2e7..b663b327 100644 --- a/providers/src/awscc/v00.00.00000/services/devopsguru.yaml +++ b/providers/src/awscc/v00.00.00000/services/devopsguru.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DevOpsGuru - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AccountId: description: User account id, used as the primary identifier for the resource @@ -15,10 +395,14 @@ components: AccountId: $ref: '#/components/schemas/AccountId' x-stackql-resource-name: log_anomaly_detection_integration - x-stackql-primaryIdentifier: + description: This resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru. + x-type-name: AWS::DevOpsGuru::LogAnomalyDetectionIntegration + x-stackql-primary-identifier: - AccountId x-read-only-properties: - AccountId + x-tagging: + taggable: false x-required-permissions: create: - devops-guru:DescribeServiceIntegration @@ -112,12 +496,18 @@ components: required: - Config x-stackql-resource-name: notification_channel - x-stackql-primaryIdentifier: + description: This resource schema represents the NotificationChannel resource in the Amazon DevOps Guru. + x-type-name: AWS::DevOpsGuru::NotificationChannel + x-stackql-primary-identifier: - Id x-create-only-properties: - Config x-read-only-properties: - Id + x-required-properties: + - Config + x-tagging: + taggable: false x-required-permissions: create: - devops-guru:AddNotificationChannel @@ -197,10 +587,16 @@ components: required: - ResourceCollectionFilter x-stackql-resource-name: resource_collection - x-stackql-primaryIdentifier: + description: This resource schema represents the ResourceCollection resource in the Amazon DevOps Guru. + x-type-name: AWS::DevOpsGuru::ResourceCollection + x-stackql-primary-identifier: - ResourceCollectionType x-read-only-properties: - ResourceCollectionType + x-required-properties: + - ResourceCollectionFilter + x-tagging: + taggable: false x-required-permissions: create: - devops-guru:UpdateResourceCollection @@ -215,39 +611,173 @@ components: update: - devops-guru:UpdateResourceCollection - devops-guru:GetResourceCollection + CreateLogAnomalyDetectionIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + $ref: '#/components/schemas/AccountId' + x-stackQL-stringOnly: true + x-title: CreateLogAnomalyDetectionIntegrationRequest + type: object + required: [] + CreateNotificationChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Config: + $ref: '#/components/schemas/NotificationChannelConfig' + Id: + description: The ID of a notification channel. + type: string + minLength: 36 + maxLength: 36 + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + x-stackQL-stringOnly: true + x-title: CreateNotificationChannelRequest + type: object + required: [] + CreateResourceCollectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceCollectionFilter: + $ref: '#/components/schemas/ResourceCollectionFilter' + ResourceCollectionType: + description: The type of ResourceCollection + type: string + enum: + - AWS_CLOUD_FORMATION + - AWS_TAGS + x-stackQL-stringOnly: true + x-title: CreateResourceCollectionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: log_anomaly_detection_integrations: name: log_anomaly_detection_integrations id: awscc.devopsguru.log_anomaly_detection_integrations x-cfn-schema-name: LogAnomalyDetectionIntegration - x-type: list + x-cfn-type-name: AWS::DevOpsGuru::LogAnomalyDetectionIntegration x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LogAnomalyDetectionIntegration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::LogAnomalyDetectionIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::LogAnomalyDetectionIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::LogAnomalyDetectionIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' + AND data__Identifier = '' AND region = 'us-east-1' - log_anomaly_detection_integration: - name: log_anomaly_detection_integration - id: awscc.devopsguru.log_anomaly_detection_integration + log_anomaly_detection_integrations_list_only: + name: log_anomaly_detection_integrations_list_only + id: awscc.devopsguru.log_anomaly_detection_integrations_list_only x-cfn-schema-name: LogAnomalyDetectionIntegration - x-type: get + x-cfn-type-name: AWS::DevOpsGuru::LogAnomalyDetectionIntegration x-identifiers: - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -255,53 +785,96 @@ components: ddl: |- SELECT region, - data__Identifier, JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' AND region = 'us-east-1' notification_channels: name: notification_channels id: awscc.devopsguru.notification_channels x-cfn-schema-name: NotificationChannel - x-type: list + x-cfn-type-name: AWS::DevOpsGuru::NotificationChannel x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NotificationChannel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::NotificationChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::NotificationChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Config') as config, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'Config') as config, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' + AND data__Identifier = '' AND region = 'us-east-1' - notification_channel: - name: notification_channel - id: awscc.devopsguru.notification_channel + notification_channels_list_only: + name: notification_channels_list_only + id: awscc.devopsguru.notification_channels_list_only x-cfn-schema-name: NotificationChannel - x-type: get + x-cfn-type-name: AWS::DevOpsGuru::NotificationChannel x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -309,55 +882,109 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Config') as config, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Config') as config, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' AND region = 'us-east-1' resource_collections: name: resource_collections id: awscc.devopsguru.resource_collections x-cfn-schema-name: ResourceCollection - x-type: list + x-cfn-type-name: AWS::DevOpsGuru::ResourceCollection x-identifiers: - ResourceCollectionType + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceCollection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::ResourceCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::ResourceCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DevOpsGuru::ResourceCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_collections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourceCollectionFilter') as resource_collection_filter, JSON_EXTRACT(Properties, '$.ResourceCollectionType') as resource_collection_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceCollectionFilter') as resource_collection_filter, json_extract_path_text(Properties, 'ResourceCollectionType') as resource_collection_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' + AND data__Identifier = '' AND region = 'us-east-1' - resource_collection: - name: resource_collection - id: awscc.devopsguru.resource_collection + resource_collections_list_only: + name: resource_collections_list_only + id: awscc.devopsguru.resource_collections_list_only x-cfn-schema-name: ResourceCollection - x-type: get + x-cfn-type-name: AWS::DevOpsGuru::ResourceCollection x-identifiers: - ResourceCollectionType + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -365,20 +992,293 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ResourceCollectionFilter') as resource_collection_filter, JSON_EXTRACT(Properties, '$.ResourceCollectionType') as resource_collection_type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceCollectionFilter') as resource_collection_filter, json_extract_path_text(Properties, 'ResourceCollectionType') as resource_collection_type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LogAnomalyDetectionIntegration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLogAnomalyDetectionIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLogAnomalyDetectionIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NotificationChannel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNotificationChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNotificationChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceCollection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceCollection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceCollectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/directoryservice.yaml b/providers/src/awscc/v00.00.00000/services/directoryservice.yaml index 639a1ffc..7515c45e 100644 --- a/providers/src/awscc/v00.00.00000/services/directoryservice.yaml +++ b/providers/src/awscc/v00.00.00000/services/directoryservice.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DirectoryService - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: VpcSettings: x-$comment: Contains VPC information @@ -68,7 +448,10 @@ components: - Size - Name x-stackql-resource-name: simple_ad - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::DirectoryService::SimpleAD + x-type-name: AWS::DirectoryService::SimpleAD + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html + x-stackql-primary-identifier: - DirectoryId x-create-only-properties: - Size @@ -78,10 +461,21 @@ components: - ShortName - Description - CreateAlias + x-write-only-properties: + - Password x-read-only-properties: - Alias - DnsIpAddresses - DirectoryId + x-required-properties: + - VpcSettings + - Size + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - ds:CreateDirectory @@ -96,6 +490,8 @@ components: - ec2:AuthorizeSecurityGroupIngress - ec2:AuthorizeSecurityGroupEgress - ec2:CreateTags + - ec2:RevokeSecurityGroupIngress + - ec2:RevokeSecurityGroupEgress read: - ds:DescribeDirectories update: @@ -113,43 +509,127 @@ components: - ec2:DeleteTags list: - ds:DescribeDirectories + CreateSimpleADRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DirectoryId: + description: The unique identifier for a directory. + type: string + Alias: + description: The alias for a directory. + type: string + DnsIpAddresses: + description: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ]. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + CreateAlias: + description: The name of the configuration set. + type: boolean + Description: + description: Description for the directory. + type: string + EnableSso: + description: Whether to enable single sign-on for a Simple Active Directory in AWS. + type: boolean + Name: + description: The fully qualified domain name for the AWS Managed Simple AD directory. + type: string + Password: + description: The password for the default administrative user named Admin. + type: string + ShortName: + description: The NetBIOS name for your domain. + type: string + Size: + description: The size of the directory. + type: string + VpcSettings: + description: VPC settings of the Simple AD directory server in AWS. + $ref: '#/components/schemas/VpcSettings' + x-stackQL-stringOnly: true + x-title: CreateSimpleADRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: simple_ads: name: simple_ads id: awscc.directoryservice.simple_ads x-cfn-schema-name: SimpleAD - x-type: list - x-identifiers: - - DirectoryId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DirectoryId') as directory_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DirectoryId') as directory_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' - AND region = 'us-east-1' - simple_ad: - name: simple_ad - id: awscc.directoryservice.simple_ad - x-cfn-schema-name: SimpleAD - x-type: get + x-cfn-type-name: AWS::DirectoryService::SimpleAD x-identifiers: - DirectoryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SimpleAD&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DirectoryService::SimpleAD" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DirectoryService::SimpleAD" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DirectoryService::SimpleAD" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simple_ads/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simple_ads/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/simple_ads/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -169,7 +649,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -188,3 +668,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' AND data__Identifier = '' AND region = 'us-east-1' + simple_ads_list_only: + name: simple_ads_list_only + id: awscc.directoryservice.simple_ads_list_only + x-cfn-schema-name: SimpleAD + x-cfn-type-name: AWS::DirectoryService::SimpleAD + x-identifiers: + - DirectoryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DirectoryId') as directory_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DirectoryId') as directory_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SimpleAD&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSimpleAD + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSimpleADRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/dms.yaml b/providers/src/awscc/v00.00.00000/services/dms.yaml index 70930108..7605efb6 100644 --- a/providers/src/awscc/v00.00.00000/services/dms.yaml +++ b/providers/src/awscc/v00.00.00000/services/dms.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DMS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -25,13 +405,179 @@ components: - Key - Value additionalProperties: false + DataMigrationSettings: + type: object + properties: + CloudwatchLogsEnabled: + type: boolean + description: The property specifies whether to enable the CloudWatch log. + NumberOfJobs: + type: integer + description: The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target. + minimum: 1 + maximum: 50 + SelectionRules: + type: string + description: The property specifies the rules of selecting objects for data migration. + additionalProperties: false + SourceDataSettings: + type: object + properties: + CDCStartPosition: + type: string + description: The property is a point in the database engine's log that defines a time where you can begin CDC. + maxLength: 40 + CDCStartTime: + type: string + description: The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format. + maxLength: 40 + CDCStopTime: + type: string + description: The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format. + maxLength: 40 + SlotName: + type: string + description: The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance. + maxLength: 255 + additionalProperties: false + DataMigration: + type: object + properties: + DataMigrationName: + description: The property describes a name to identify the data migration. + type: string + minLength: 1 + maxLength: 300 + DataMigrationArn: + description: The property describes an ARN of the data migration. + type: string + minLength: 1 + maxLength: 300 + DataMigrationIdentifier: + description: The property describes an ARN of the data migration. + type: string + minLength: 1 + maxLength: 300 + DataMigrationCreateTime: + description: The property describes the create time of the data migration. + type: string + minLength: 1 + maxLength: 40 + ServiceAccessRoleArn: + description: The property describes Amazon Resource Name (ARN) of the service access role. + type: string + minLength: 1 + maxLength: 300 + MigrationProjectIdentifier: + description: The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn + type: string + minLength: 1 + maxLength: 255 + DataMigrationType: + description: The property describes the type of migration. + type: string + enum: + - full-load + - cdc + - full-load-and-cdc + DataMigrationSettings: + description: The property describes the settings for the data migration. + $ref: '#/components/schemas/DataMigrationSettings' + SourceDataSettings: + description: The property describes the settings for the data migration. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SourceDataSettings' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - DataMigrationType + - MigrationProjectIdentifier + - ServiceAccessRoleArn + x-stackql-resource-name: data_migration + description: Resource schema for AWS::DMS::DataMigration. + x-type-name: AWS::DMS::DataMigration + x-stackql-primary-identifier: + - DataMigrationArn + x-stackql-additional-identifiers: + - - DataMigrationName + x-write-only-properties: + - DataMigrationIdentifier + x-read-only-properties: + - DataMigrationArn + - DataMigrationCreateTime + x-required-properties: + - DataMigrationType + - MigrationProjectIdentifier + - ServiceAccessRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - dms:AddTagsToResource + - dms:RemoveTagsFromResource + - dms:ListTagsForResource + x-required-permissions: + create: + - dms:CreateDataMigration + - dms:DescribeDataMigrations + - dms:AddTagsToResource + - dms:ListTagsForResource + - iam:PassRole + read: + - dms:DescribeDataMigrations + - dms:ListTagsForResource + update: + - dms:ModifyDataMigration + - dms:AddTagsToResource + - dms:RemoveTagsFromResource + - dms:ListTagsForResource + - iam:PassRole + delete: + - dms:DeleteDataMigration + - dms:RemoveTagsFromResource + list: + - dms:DescribeDataMigrations + - dms:ListTagsForResource DmsSslModeValue: type: string enum: - none - require - - verify_ca - - verify_full + - verify-ca + - verify-full + Db2SslModeValue: + type: string + enum: + - none + - verify-ca + MongoDbSslModeValue: + type: string + enum: + - none + - require + - verify-full + MongoDbAuthType: + type: string + enum: + - 'no' + - password + MongoDbAuthMechanism: + type: string + enum: + - default + - mongodb_cr + - scram_sha_1 DataProvider: type: object properties: @@ -64,12 +610,18 @@ components: description: The property describes a data engine for the data provider. type: string enum: - - postgres + - aurora + - aurora_postgresql - mysql - oracle + - postgres - sqlserver - - aurora - - aurora_postgresql + - redshift + - mariadb + - mongodb + - docdb + - db2 + - db2_zos ExactSettings: description: The property describes the exact settings which can be modified type: boolean @@ -77,91 +629,231 @@ components: Settings: description: The property identifies the exact type of settings for the data provider. type: object - oneOf: - - description: PostgreSqlSettings property identifier. + properties: + PostgreSqlSettings: + description: PostgreSqlSettings property identifier. type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName additionalProperties: false + MySqlSettings: + description: MySqlSettings property identifier. + type: object properties: - PostgreSqlSettings: - type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - - description: MySqlSettings property identifier. + ServerName: + type: string + Port: + type: integer + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + additionalProperties: false + OracleSettings: + description: OracleSettings property identifier. type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + AsmServer: + type: string + SecretsManagerOracleAsmSecretId: + type: string + SecretsManagerOracleAsmAccessRoleArn: + type: string + SecretsManagerSecurityDbEncryptionSecretId: + type: string + SecretsManagerSecurityDbEncryptionAccessRoleArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName additionalProperties: false + MicrosoftSqlServerSettings: + description: MicrosoftSqlServerSettings property identifier. + type: object properties: - MySqlSettings: - type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - - description: OracleSettings property identifier. + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + RedshiftSettings: + description: RedshiftSettings property identifier. type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + required: + - ServerName + - Port + - DatabaseName additionalProperties: false + MariaDbSettings: + description: MariaDbSettings property identifier. + type: object properties: - OracleSettings: - type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - AsmServer: - type: string - SecretsManagerOracleAsmSecretId: - type: string - SecretsManagerOracleAsmAccessRoleArn: - type: string - SecretsManagerSecurityDbEncryptionSecretId: - type: string - SecretsManagerSecurityDbEncryptionAccessRoleArn: - type: string - - description: MicrosoftSqlServerSettings property identifier. + ServerName: + type: string + Port: + type: integer + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + additionalProperties: false + DocDbSettings: + description: DocDbSettings property identifier. type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/MongoDbSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - DatabaseName additionalProperties: false + MongoDbSettings: + description: MongoDbSettings property identifier. + type: object properties: - MicrosoftSqlServerSettings: - type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/MongoDbSslModeValue' + CertificateArn: + type: string + AuthType: + $ref: '#/components/schemas/MongoDbAuthType' + AuthSource: + type: string + AuthMechanism: + $ref: '#/components/schemas/MongoDbAuthMechanism' + required: + - ServerName + - Port + additionalProperties: false + IbmDb2LuwSettings: + description: IbmDb2LuwSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/Db2SslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + IbmDb2zOsSettings: + description: IbmDb2zOsSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/Db2SslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + anyOf: + - required: + - PostgreSqlSettings + - required: + - MySqlSettings + - required: + - OracleSettings + - required: + - MicrosoftSqlServerSettings + - required: + - RedshiftSettings + - required: + - DocDbSettings + - required: + - MariaDbSettings + - required: + - MongoDbSettings + - required: + - IbmDb2LuwSettings + - required: + - IbmDb2zOsSettings + additionalProperties: false Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -172,11 +864,30 @@ components: required: - Engine x-stackql-resource-name: data_provider - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DMS::DataProvider + x-type-name: AWS::DMS::DataProvider + x-stackql-primary-identifier: - DataProviderArn + x-stackql-additional-identifiers: + - - DataProviderName + x-write-only-properties: + - DataProviderIdentifier + - ExactSettings x-read-only-properties: - DataProviderArn - DataProviderCreationTime + x-required-properties: + - Engine + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - dms:AddTagsToResource + - dms:RemoveTagsFromResource + - dms:ListTagsForResource x-required-permissions: create: - dms:CreateDataProvider @@ -184,6 +895,8 @@ components: - dms:DescribeDataProviders - dms:AddTagsToResource - dms:ListTagsForResource + - iam:GetRole + - iam:PassRole read: - dms:ListDataProviders - dms:DescribeDataProviders @@ -192,7 +905,7 @@ components: - dms:UpdateDataProvider - dms:ModifyDataProvider - dms:AddTagsToResource - - dms:RemoveTagsToResource + - dms:RemoveTagsFromResource - dms:ListTagsForResource delete: - dms:DeleteDataProvider @@ -237,7 +950,6 @@ components: type: string enum: - IPV4 - - IPV6 - DUAL InstanceProfileName: description: The property describes a name for the instance profile. @@ -269,11 +981,27 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: instance_profile - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DMS::InstanceProfile. + x-type-name: AWS::DMS::InstanceProfile + x-stackql-primary-identifier: - InstanceProfileArn + x-stackql-additional-identifiers: + - - InstanceProfileName + x-write-only-properties: + - InstanceProfileIdentifier x-read-only-properties: - InstanceProfileArn - InstanceProfileCreationTime + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - dms:AddTagsToResource + - dms:RemoveTagsFromResource + - dms:ListTagsForResource x-required-permissions: create: - dms:CreateInstanceProfile @@ -289,7 +1017,7 @@ components: - dms:UpdateInstanceProfile - dms:ModifyInstanceProfile - dms:AddTagsToResource - - dms:RemoveTagsToResource + - dms:RemoveTagsFromResource - dms:ListTagsForResource delete: - dms:DeleteInstanceProfile @@ -389,10 +1117,29 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: migration_project - x-stackql-primaryIdentifier: + description: Resource schema for AWS::DMS::MigrationProject + x-type-name: AWS::DMS::MigrationProject + x-stackql-primary-identifier: - MigrationProjectArn + x-stackql-additional-identifiers: + - - MigrationProjectName + x-write-only-properties: + - MigrationProjectIdentifier + - InstanceProfileIdentifier + - SourceDataProviderDescriptors/*/DataProviderIdentifier + - TargetDataProviderDescriptors/*/DataProviderIdentifier x-read-only-properties: - MigrationProjectArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - dms:AddTagsToResource + - dms:RemoveTagsFromResource + - dms:ListTagsForResource x-required-permissions: create: - dms:CreateMigrationProject @@ -409,7 +1156,7 @@ components: - dms:UpdateMigrationProject - dms:ModifyMigrationProject - dms:AddTagsToResource - - dms:RemoveTagsToResource + - dms:RemoveTagsFromResource - dms:ListTagsForResource - iam:PassRole delete: @@ -489,13 +1236,43 @@ components: maxItems: 200 minItems: 1 description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+ required: + - ReplicationConfigIdentifier + - SourceEndpointArn + - TargetEndpointArn + - ReplicationType + - ComputeConfig + - TableMappings x-stackql-resource-name: replication_config - x-stackql-primaryIdentifier: + description: A replication configuration that you later provide to configure and start a AWS DMS Serverless replication + x-type-name: AWS::DMS::ReplicationConfig + x-stackql-primary-identifier: - ReplicationConfigArn + x-stackql-additional-identifiers: + - - ReplicationConfigIdentifier x-create-only-properties: - ResourceIdentifier + x-write-only-properties: + - ResourceIdentifier x-read-only-properties: - - /Properties/ReplicationConfigArn + - ReplicationConfigArn + x-required-properties: + - ReplicationConfigIdentifier + - SourceEndpointArn + - TargetEndpointArn + - ReplicationType + - ComputeConfig + - TableMappings + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - dms:AddTagsToResource + - dms:ListTagsForResource + - dms:RemoveTagsFromResource x-required-permissions: create: - dms:CreateReplicationConfig @@ -511,7 +1288,7 @@ components: update: - dms:ModifyReplicationConfig - dms:AddTagsToResource - - dms:RemoveTagsToResource + - dms:RemoveTagsFromResource - dms:ListTagsForResource - iam:CreateServiceLinkedRole - iam:AttachRolePolicy @@ -526,14 +1303,719 @@ components: - dms:ListTagsForResource - iam:DeleteServiceLinkedRole - iam:GetServiceLinkedRoleDeletionStatus + CreateDataMigrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DataMigrationName: + description: The property describes a name to identify the data migration. + type: string + minLength: 1 + maxLength: 300 + DataMigrationArn: + description: The property describes an ARN of the data migration. + type: string + minLength: 1 + maxLength: 300 + DataMigrationIdentifier: + description: The property describes an ARN of the data migration. + type: string + minLength: 1 + maxLength: 300 + DataMigrationCreateTime: + description: The property describes the create time of the data migration. + type: string + minLength: 1 + maxLength: 40 + ServiceAccessRoleArn: + description: The property describes Amazon Resource Name (ARN) of the service access role. + type: string + minLength: 1 + maxLength: 300 + MigrationProjectIdentifier: + description: The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn + type: string + minLength: 1 + maxLength: 255 + DataMigrationType: + description: The property describes the type of migration. + type: string + enum: + - full-load + - cdc + - full-load-and-cdc + DataMigrationSettings: + description: The property describes the settings for the data migration. + $ref: '#/components/schemas/DataMigrationSettings' + SourceDataSettings: + description: The property describes the settings for the data migration. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SourceDataSettings' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDataMigrationRequest + type: object + required: [] + CreateDataProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DataProviderName: + description: The property describes a name to identify the data provider. + type: string + minLength: 1 + maxLength: 255 + DataProviderIdentifier: + description: The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn + type: string + minLength: 1 + maxLength: 255 + DataProviderArn: + description: The data provider ARN. + type: string + minLength: 1 + maxLength: 255 + DataProviderCreationTime: + description: The data provider creation time. + type: string + minLength: 1 + maxLength: 40 + Description: + description: The optional description of the data provider. + type: string + minLength: 1 + maxLength: 255 + Engine: + description: The property describes a data engine for the data provider. + type: string + enum: + - aurora + - aurora_postgresql + - mysql + - oracle + - postgres + - sqlserver + - redshift + - mariadb + - mongodb + - docdb + - db2 + - db2_zos + ExactSettings: + description: The property describes the exact settings which can be modified + type: boolean + default: false + Settings: + description: The property identifies the exact type of settings for the data provider. + type: object + properties: + PostgreSqlSettings: + description: PostgreSqlSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + MySqlSettings: + description: MySqlSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + additionalProperties: false + OracleSettings: + description: OracleSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + AsmServer: + type: string + SecretsManagerOracleAsmSecretId: + type: string + SecretsManagerOracleAsmAccessRoleArn: + type: string + SecretsManagerSecurityDbEncryptionSecretId: + type: string + SecretsManagerSecurityDbEncryptionAccessRoleArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + MicrosoftSqlServerSettings: + description: MicrosoftSqlServerSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + RedshiftSettings: + description: RedshiftSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + required: + - ServerName + - Port + - DatabaseName + additionalProperties: false + MariaDbSettings: + description: MariaDbSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + SslMode: + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + additionalProperties: false + DocDbSettings: + description: DocDbSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/MongoDbSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - DatabaseName + additionalProperties: false + MongoDbSettings: + description: MongoDbSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/MongoDbSslModeValue' + CertificateArn: + type: string + AuthType: + $ref: '#/components/schemas/MongoDbAuthType' + AuthSource: + type: string + AuthMechanism: + $ref: '#/components/schemas/MongoDbAuthMechanism' + required: + - ServerName + - Port + additionalProperties: false + IbmDb2LuwSettings: + description: IbmDb2LuwSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/Db2SslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + IbmDb2zOsSettings: + description: IbmDb2zOsSettings property identifier. + type: object + properties: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: + $ref: '#/components/schemas/Db2SslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + anyOf: + - required: + - PostgreSqlSettings + - required: + - MySqlSettings + - required: + - OracleSettings + - required: + - MicrosoftSqlServerSettings + - required: + - RedshiftSettings + - required: + - DocDbSettings + - required: + - MariaDbSettings + - required: + - MongoDbSettings + - required: + - IbmDb2LuwSettings + - required: + - IbmDb2zOsSettings + additionalProperties: false + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDataProviderRequest + type: object + required: [] + CreateInstanceProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceProfileArn: + description: The property describes an ARN of the instance profile. + type: string + minLength: 1 + maxLength: 255 + InstanceProfileIdentifier: + description: The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn + type: string + minLength: 1 + maxLength: 255 + AvailabilityZone: + description: The property describes an availability zone of the instance profile. + type: string + minLength: 1 + maxLength: 255 + Description: + description: The optional description of the instance profile. + type: string + minLength: 1 + maxLength: 255 + KmsKeyArn: + description: The property describes kms key arn for the instance profile. + type: string + minLength: 1 + maxLength: 255 + PubliclyAccessible: + description: The property describes the publicly accessible of the instance profile + type: boolean + default: false + NetworkType: + description: The property describes a network type for the instance profile. + type: string + enum: + - IPV4 + - DUAL + InstanceProfileName: + description: The property describes a name for the instance profile. + type: string + minLength: 1 + maxLength: 255 + InstanceProfileCreationTime: + description: The property describes a creating time of the instance profile. + type: string + minLength: 1 + maxLength: 40 + SubnetGroupIdentifier: + description: The property describes a subnet group identifier for the instance profile. + type: string + minLength: 1 + maxLength: 255 + VpcSecurityGroups: + description: The property describes vps security groups for the instance profile. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateInstanceProfileRequest + type: object + required: [] + CreateMigrationProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MigrationProjectName: + description: The property describes a name to identify the migration project. + type: string + minLength: 1 + maxLength: 255 + MigrationProjectIdentifier: + description: The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn + type: string + minLength: 1 + maxLength: 255 + MigrationProjectArn: + description: The property describes an ARN of the migration project. + type: string + minLength: 1 + maxLength: 255 + MigrationProjectCreationTime: + description: The property describes a creating time of the migration project. + type: string + minLength: 1 + maxLength: 40 + InstanceProfileIdentifier: + description: The property describes an instance profile identifier for the migration project. For create + type: string + minLength: 1 + maxLength: 255 + InstanceProfileName: + description: The property describes an instance profile name for the migration project. For read + type: string + minLength: 1 + maxLength: 255 + InstanceProfileArn: + description: The property describes an instance profile arn for the migration project. For read + type: string + minLength: 1 + maxLength: 255 + TransformationRules: + description: The property describes transformation rules for the migration project. + type: string + Description: + description: The optional description of the migration project. + type: string + minLength: 1 + maxLength: 255 + SchemaConversionApplicationAttributes: + description: The property describes schema conversion application attributes for the migration project. + type: object + additionalProperties: false + properties: + S3BucketPath: + type: string + S3BucketRoleArn: + type: string + SourceDataProviderDescriptors: + description: The property describes source data provider descriptors for the migration project. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/DataProviderDescriptor' + TargetDataProviderDescriptors: + description: The property describes target data provider descriptors for the migration project. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/DataProviderDescriptor' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateMigrationProjectRequest + type: object + required: [] + CreateReplicationConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ReplicationConfigIdentifier: + description: A unique identifier of replication configuration + type: string + ReplicationConfigArn: + description: The Amazon Resource Name (ARN) of the Replication Config + type: string + SourceEndpointArn: + description: The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration + type: string + TargetEndpointArn: + description: The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration + type: string + ReplicationType: + description: The type of AWS DMS Serverless replication to provision using this replication configuration + type: string + enum: + - full-load + - full-load-and-cdc + - cdc + ComputeConfig: + $ref: '#/components/schemas/ComputeConfig' + ReplicationSettings: + description: JSON settings for Servereless replications that are provisioned using this replication configuration + type: object + SupplementalSettings: + description: JSON settings for specifying supplemental data + type: object + ResourceIdentifier: + description: A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource + type: string + TableMappings: + description: JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration + type: object + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+ x-stackQL-stringOnly: true + x-title: CreateReplicationConfigRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - data_providers: - name: data_providers - id: awscc.dms.data_providers - x-cfn-schema-name: DataProvider - x-type: list + data_migrations: + name: data_migrations + id: awscc.dms.data_migrations + x-cfn-schema-name: DataMigration + x-cfn-type-name: AWS::DMS::DataMigration x-identifiers: - - DataProviderArn + - DataMigrationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataMigration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::DataMigration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::DataMigration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::DataMigration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_migrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_migrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_migrations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DataMigrationName') as data_migration_name, + JSON_EXTRACT(Properties, '$.DataMigrationArn') as data_migration_arn, + JSON_EXTRACT(Properties, '$.DataMigrationIdentifier') as data_migration_identifier, + JSON_EXTRACT(Properties, '$.DataMigrationCreateTime') as data_migration_create_time, + JSON_EXTRACT(Properties, '$.ServiceAccessRoleArn') as service_access_role_arn, + JSON_EXTRACT(Properties, '$.MigrationProjectIdentifier') as migration_project_identifier, + JSON_EXTRACT(Properties, '$.DataMigrationType') as data_migration_type, + JSON_EXTRACT(Properties, '$.DataMigrationSettings') as data_migration_settings, + JSON_EXTRACT(Properties, '$.SourceDataSettings') as source_data_settings, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::DataMigration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DataMigrationName') as data_migration_name, + json_extract_path_text(Properties, 'DataMigrationArn') as data_migration_arn, + json_extract_path_text(Properties, 'DataMigrationIdentifier') as data_migration_identifier, + json_extract_path_text(Properties, 'DataMigrationCreateTime') as data_migration_create_time, + json_extract_path_text(Properties, 'ServiceAccessRoleArn') as service_access_role_arn, + json_extract_path_text(Properties, 'MigrationProjectIdentifier') as migration_project_identifier, + json_extract_path_text(Properties, 'DataMigrationType') as data_migration_type, + json_extract_path_text(Properties, 'DataMigrationSettings') as data_migration_settings, + json_extract_path_text(Properties, 'SourceDataSettings') as source_data_settings, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::DataMigration' + AND data__Identifier = '' + AND region = 'us-east-1' + data_migrations_list_only: + name: data_migrations_list_only + id: awscc.dms.data_migrations_list_only + x-cfn-schema-name: DataMigration + x-cfn-type-name: AWS::DMS::DataMigration + x-identifiers: + - DataMigrationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -541,28 +2023,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DataProviderArn') as data_provider_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' + JSON_EXTRACT(Properties, '$.DataMigrationArn') as data_migration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataMigration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DataProviderArn') as data_provider_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' + json_extract_path_text(Properties, 'DataMigrationArn') as data_migration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataMigration' AND region = 'us-east-1' - data_provider: - name: data_provider - id: awscc.dms.data_provider + data_providers: + name: data_providers + id: awscc.dms.data_providers x-cfn-schema-name: DataProvider - x-type: get + x-cfn-type-name: AWS::DMS::DataProvider x-identifiers: - DataProviderArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::DataProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::DataProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::DataProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -580,7 +2110,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -597,13 +2127,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::DataProvider' AND data__Identifier = '' AND region = 'us-east-1' - instance_profiles: - name: instance_profiles - id: awscc.dms.instance_profiles - x-cfn-schema-name: InstanceProfile - x-type: list + data_providers_list_only: + name: data_providers_list_only + id: awscc.dms.data_providers_list_only + x-cfn-schema-name: DataProvider + x-cfn-type-name: AWS::DMS::DataProvider x-identifiers: - - InstanceProfileArn + - DataProviderArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -611,28 +2147,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceProfileArn') as instance_profile_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' + JSON_EXTRACT(Properties, '$.DataProviderArn') as data_provider_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' + json_extract_path_text(Properties, 'DataProviderArn') as data_provider_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' AND region = 'us-east-1' - instance_profile: - name: instance_profile - id: awscc.dms.instance_profile + instance_profiles: + name: instance_profiles + id: awscc.dms.instance_profiles x-cfn-schema-name: InstanceProfile - x-type: get + x-cfn-type-name: AWS::DMS::InstanceProfile x-identifiers: - InstanceProfileArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::InstanceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::InstanceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::InstanceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -653,7 +2237,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -673,13 +2257,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::InstanceProfile' AND data__Identifier = '' AND region = 'us-east-1' - migration_projects: - name: migration_projects - id: awscc.dms.migration_projects - x-cfn-schema-name: MigrationProject - x-type: list + instance_profiles_list_only: + name: instance_profiles_list_only + id: awscc.dms.instance_profiles_list_only + x-cfn-schema-name: InstanceProfile + x-cfn-type-name: AWS::DMS::InstanceProfile x-identifiers: - - MigrationProjectArn + - InstanceProfileArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -687,28 +2277,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MigrationProjectArn') as migration_project_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' + JSON_EXTRACT(Properties, '$.InstanceProfileArn') as instance_profile_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'MigrationProjectArn') as migration_project_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' + json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' AND region = 'us-east-1' - migration_project: - name: migration_project - id: awscc.dms.migration_project + migration_projects: + name: migration_projects + id: awscc.dms.migration_projects x-cfn-schema-name: MigrationProject - x-type: get + x-cfn-type-name: AWS::DMS::MigrationProject x-identifiers: - MigrationProjectArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MigrationProject&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::MigrationProject" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::MigrationProject" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::MigrationProject" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/migration_projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/migration_projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/migration_projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -730,7 +2368,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -751,13 +2389,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::MigrationProject' AND data__Identifier = '' AND region = 'us-east-1' - replication_configs: - name: replication_configs - id: awscc.dms.replication_configs - x-cfn-schema-name: ReplicationConfig - x-type: list + migration_projects_list_only: + name: migration_projects_list_only + id: awscc.dms.migration_projects_list_only + x-cfn-schema-name: MigrationProject + x-cfn-type-name: AWS::DMS::MigrationProject x-identifiers: - - ReplicationConfigArn + - MigrationProjectArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -765,28 +2409,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ReplicationConfigArn') as replication_config_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' + JSON_EXTRACT(Properties, '$.MigrationProjectArn') as migration_project_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ReplicationConfigArn') as replication_config_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' + json_extract_path_text(Properties, 'MigrationProjectArn') as migration_project_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' AND region = 'us-east-1' - replication_config: - name: replication_config - id: awscc.dms.replication_config + replication_configs: + name: replication_configs + id: awscc.dms.replication_configs x-cfn-schema-name: ReplicationConfig - x-type: get + x-cfn-type-name: AWS::DMS::ReplicationConfig x-identifiers: - ReplicationConfigArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReplicationConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::ReplicationConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::ReplicationConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DMS::ReplicationConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replication_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replication_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/replication_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -806,7 +2498,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -825,3 +2517,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' AND data__Identifier = '' AND region = 'us-east-1' + replication_configs_list_only: + name: replication_configs_list_only + id: awscc.dms.replication_configs_list_only + x-cfn-schema-name: ReplicationConfig + x-cfn-type-name: AWS::DMS::ReplicationConfig + x-identifiers: + - ReplicationConfigArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ReplicationConfigArn') as replication_config_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReplicationConfigArn') as replication_config_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataMigration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataMigration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataMigrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MigrationProject&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMigrationProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMigrationProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReplicationConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReplicationConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReplicationConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/docdbelastic.yaml b/providers/src/awscc/v00.00.00000/services/docdbelastic.yaml index 00fc76a6..00eb63f2 100644 --- a/providers/src/awscc/v00.00.00000/services/docdbelastic.yaml +++ b/providers/src/awscc/v00.00.00000/services/docdbelastic.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DocDBElastic - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -55,6 +435,12 @@ components: type: string PreferredMaintenanceWindow: type: string + PreferredBackupWindow: + type: string + BackupRetentionPeriod: + type: integer + ShardInstanceCount: + type: integer KmsKeyId: type: string Tags: @@ -74,19 +460,42 @@ components: - ShardCount - AuthType x-stackql-resource-name: cluster - x-stackql-primaryIdentifier: + description: The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster + x-type-name: AWS::DocDBElastic::Cluster + x-stackql-primary-identifier: - ClusterArn x-create-only-properties: - AdminUserName - AuthType - ClusterName - KmsKeyId + x-write-only-properties: + - AdminUserPassword x-read-only-properties: - ClusterArn - ClusterEndpoint + x-required-properties: + - ClusterName + - AdminUserName + - ShardCapacity + - ShardCount + - AuthType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - docdb-elastic:TagResource + - docdb-elastic:UntagResource + - docdb-elastic:ListTagsForResource x-required-permissions: create: - docdb-elastic:CreateCluster + - docdb-elastic:TagResource + - docdb-elastic:GetCluster + - docdb-elastic:ListTagsForResource - ec2:CreateVpcEndpoint - ec2:DescribeVpcEndpoints - ec2:DeleteVpcEndpoints @@ -113,6 +522,8 @@ components: - docdb-elastic:UpdateCluster - docdb-elastic:TagResource - docdb-elastic:UntagResource + - docdb-elastic:GetCluster + - docdb-elastic:ListTagsForResource - ec2:CreateVpcEndpoint - ec2:DescribeVpcEndpoints - ec2:DeleteVpcEndpoints @@ -133,6 +544,7 @@ components: - kms:Decrypt delete: - docdb-elastic:DeleteCluster + - docdb-elastic:GetCluster - ec2:DescribeVpcEndpoints - ec2:DeleteVpcEndpoints - ec2:ModifyVpcEndpoint @@ -143,43 +555,139 @@ components: - ec2:DescribeAvailabilityZones list: - docdb-elastic:ListClusters + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + type: string + pattern: '[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*' + maxLength: 50 + minLength: 1 + ClusterArn: + type: string + ClusterEndpoint: + type: string + AdminUserName: + type: string + AdminUserPassword: + type: string + ShardCapacity: + type: integer + ShardCount: + type: integer + VpcSecurityGroupIds: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + SubnetIds: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + PreferredMaintenanceWindow: + type: string + PreferredBackupWindow: + type: string + BackupRetentionPeriod: + type: integer + ShardInstanceCount: + type: integer + KmsKeyId: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + minItems: 0 + AuthType: + type: string + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: clusters: name: clusters id: awscc.docdbelastic.clusters x-cfn-schema-name: Cluster - x-type: list - x-identifiers: - - ClusterArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: awscc.docdbelastic.cluster - x-cfn-schema-name: Cluster - x-type: get + x-cfn-type-name: AWS::DocDBElastic::Cluster x-identifiers: - ClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DocDBElastic::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DocDBElastic::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DocDBElastic::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -194,6 +702,9 @@ components: JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, + JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, + JSON_EXTRACT(Properties, '$.ShardInstanceCount') as shard_instance_count, JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.AuthType') as auth_type @@ -201,7 +712,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -216,9 +727,238 @@ components: json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'ShardInstanceCount') as shard_instance_count, json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'AuthType') as auth_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' AND data__Identifier = '' AND region = 'us-east-1' + clusters_list_only: + name: clusters_list_only + id: awscc.docdbelastic.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::DocDBElastic::Cluster + x-identifiers: + - ClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/dsql.yaml b/providers/src/awscc/v00.00.00000/services/dsql.yaml new file mode 100644 index 00000000..656b0086 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/dsql.yaml @@ -0,0 +1,938 @@ +openapi: 3.0.0 +info: + title: DSQL + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + description: A map of key and value pairs to use to tag your cluster. + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + Cluster: + type: object + properties: + DeletionProtectionEnabled: + description: Whether deletion protection is enabled in this cluster. + type: boolean + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + uniqueItems: false + x-insertionOrder: false + ResourceArn: + description: The Amazon Resource Name (ARN) for the cluster. + type: string + Identifier: + description: The ID of the created cluster. + type: string + CreationTime: + description: The time of when the cluster was created in ISO-8601 format. + type: string + Status: + description: The status of the cluster. + type: string + VpcEndpointServiceName: + description: The VPC endpoint service name. + type: string + MultiRegionProperties: + description: The Multi-region properties associated to this cluster. + type: object + additionalProperties: false + properties: + WitnessRegion: + description: The witness region in a multi-region cluster. + type: string + Clusters: + type: array + items: + description: The cluster Amazon Resource Name (ARN) in a multi-region cluster. + type: string + uniqueItems: true + x-insertionOrder: false + KmsEncryptionKey: + description: The KMS key that encrypts data on the cluster. + type: string + EncryptionDetails: + description: The encryption configuration details for the cluster. + type: object + additionalProperties: false + properties: + EncryptionStatus: + description: The status of encryption for the cluster. + type: string + EncryptionType: + description: The type of encryption that protects data in the cluster. + type: string + KmsKeyArn: + description: The Amazon Resource Name (ARN) of the KMS key that encrypts data in the cluster. + type: string + required: [] + x-stackql-resource-name: cluster + description: Resource Type definition for AWS::DSQL::Cluster + x-type-name: AWS::DSQL::Cluster + x-stackql-primary-identifier: + - Identifier + x-write-only-properties: + - KmsEncryptionKey + x-read-only-properties: + - ResourceArn + - Identifier + - CreationTime + - Status + - VpcEndpointServiceName + - EncryptionDetails + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - dsql:UntagResource + - dsql:TagResource + - dsql:ListTagsForResource + x-required-permissions: + create: + - dsql:CreateCluster + - dsql:UpdateCluster + - dsql:GetCluster + - dsql:TagResource + - dsql:GetVpcEndpointServiceName + - dsql:ListTagsForResource + - iam:CreateServiceLinkedRole + - dsql:PutMultiRegionProperties + - dsql:AddPeerCluster + - dsql:PutWitnessRegion + - kms:Decrypt + - kms:Encrypt + - kms:GenerateDataKey + - kms:DescribeKey + read: + - dsql:GetCluster + - dsql:GetVpcEndpointServiceName + - dsql:ListTagsForResource + - tag:GetTagKeys + - tag:GetTagValues + update: + - dsql:UpdateCluster + - dsql:GetCluster + - dsql:UntagResource + - dsql:TagResource + - dsql:GetVpcEndpointServiceName + - dsql:ListTagsForResource + - dsql:PutMultiRegionProperties + - dsql:PutWitnessRegion + - dsql:AddPeerCluster + - dsql:RemovePeerCluster + - kms:Decrypt + - kms:Encrypt + - kms:GenerateDataKey + - kms:DescribeKey + delete: + - dsql:DeleteCluster + - dsql:GetCluster + - dsql:ListTagsForResource + list: + - dsql:ListClusters + - dsql:ListTagsForResource + - tag:GetTagKeys + - tag:GetTagValues + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeletionProtectionEnabled: + description: Whether deletion protection is enabled in this cluster. + type: boolean + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + uniqueItems: false + x-insertionOrder: false + ResourceArn: + description: The Amazon Resource Name (ARN) for the cluster. + type: string + Identifier: + description: The ID of the created cluster. + type: string + CreationTime: + description: The time of when the cluster was created in ISO-8601 format. + type: string + Status: + description: The status of the cluster. + type: string + VpcEndpointServiceName: + description: The VPC endpoint service name. + type: string + MultiRegionProperties: + description: The Multi-region properties associated to this cluster. + type: object + additionalProperties: false + properties: + WitnessRegion: + description: The witness region in a multi-region cluster. + type: string + Clusters: + type: array + items: + description: The cluster Amazon Resource Name (ARN) in a multi-region cluster. + type: string + uniqueItems: true + x-insertionOrder: false + KmsEncryptionKey: + description: The KMS key that encrypts data on the cluster. + type: string + EncryptionDetails: + description: The encryption configuration details for the cluster. + type: object + additionalProperties: false + properties: + EncryptionStatus: + description: The status of encryption for the cluster. + type: string + EncryptionType: + description: The type of encryption that protects data in the cluster. + type: string + KmsKeyArn: + description: The Amazon Resource Name (ARN) of the KMS key that encrypts data in the cluster. + type: string + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + clusters: + name: clusters + id: awscc.dsql.clusters + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::DSQL::Cluster + x-identifiers: + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DSQL::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DSQL::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DSQL::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DeletionProtectionEnabled') as deletion_protection_enabled, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.VpcEndpointServiceName') as vpc_endpoint_service_name, + JSON_EXTRACT(Properties, '$.MultiRegionProperties') as multi_region_properties, + JSON_EXTRACT(Properties, '$.KmsEncryptionKey') as kms_encryption_key, + JSON_EXTRACT(Properties, '$.EncryptionDetails') as encryption_details + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DSQL::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeletionProtectionEnabled') as deletion_protection_enabled, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'VpcEndpointServiceName') as vpc_endpoint_service_name, + json_extract_path_text(Properties, 'MultiRegionProperties') as multi_region_properties, + json_extract_path_text(Properties, 'KmsEncryptionKey') as kms_encryption_key, + json_extract_path_text(Properties, 'EncryptionDetails') as encryption_details + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DSQL::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + clusters_list_only: + name: clusters_list_only + id: awscc.dsql.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::DSQL::Cluster + x-identifiers: + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DSQL::Cluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DSQL::Cluster' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/dynamodb.yaml b/providers/src/awscc/v00.00.00000/services/dynamodb.yaml index 73d6e008..58379fc1 100644 --- a/providers/src/awscc/v00.00.00000/services/dynamodb.yaml +++ b/providers/src/awscc/v00.00.00000/services/dynamodb.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: DynamoDB - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: LocalSecondaryIndex: description: Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created. @@ -20,8 +400,8 @@ components: uniqueItems: true description: |- The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - + ``HASH`` - partition key - + ``RANGE`` - sort key + + ``HASH`` - partition key + + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. @@ -32,67 +412,6 @@ components: - IndexName - Projection - KeySchema - SSESpecification: - description: Represents the settings used to enable server-side encryption. - additionalProperties: false - type: object - properties: - SSEEnabled: - description: Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - type: boolean - SSEType: - description: |- - Server-side encryption type. The only supported value is: - + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply). - type: string - KMSMasterKeyId: - description: The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``. - type: string - required: - - SSEEnabled - KinesisStreamSpecification: - description: The Kinesis Data Streams configuration for the specified table. - additionalProperties: false - type: object - properties: - ApproximateCreationDateTimePrecision: - description: The precision for the time and date that the stream was created. - type: string - enum: - - MICROSECOND - - MILLISECOND - StreamArn: - description: |- - The ARN for a specific Kinesis data stream. - Length Constraints: Minimum length of 37. Maximum length of 1024. - type: string - required: - - StreamArn - StreamSpecification: - description: Represents the DynamoDB Streams configuration for a table in DynamoDB. - additionalProperties: false - type: object - properties: - StreamViewType: - description: |- - When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: - + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. - + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. - + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. - + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream. - type: string - required: - - StreamViewType - ContributorInsightsSpecification: - description: The settings used to enable or disable CloudWatch Contributor Insights. - additionalProperties: false - type: object - properties: - Enabled: - description: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false). - type: boolean - required: - - Enabled ReplicaSpecification: additionalProperties: false type: object @@ -103,6 +422,10 @@ components: $ref: '#/components/schemas/KinesisStreamSpecification' ContributorInsightsSpecification: $ref: '#/components/schemas/ContributorInsightsSpecification' + PointInTimeRecoverySpecification: + $ref: '#/components/schemas/PointInTimeRecoverySpecification' + ReplicaStreamSpecification: + $ref: '#/components/schemas/ReplicaStreamSpecification' GlobalSecondaryIndexes: uniqueItems: true x-insertionOrder: false @@ -111,8 +434,8 @@ components: $ref: '#/components/schemas/ReplicaGlobalSecondaryIndexSpecification' Region: type: string - PointInTimeRecoverySpecification: - $ref: '#/components/schemas/PointInTimeRecoverySpecification' + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' ReadProvisionedThroughputSettings: $ref: '#/components/schemas/ReadProvisionedThroughputSettings' TableClass: @@ -125,27 +448,10 @@ components: type: array items: $ref: '#/components/schemas/Tag' + ReadOnDemandThroughputSettings: + $ref: '#/components/schemas/ReadOnDemandThroughputSettings' required: - Region - CapacityAutoScalingSettings: - additionalProperties: false - type: object - properties: - MinCapacity: - type: integer - minimum: 1 - SeedCapacity: - type: integer - minimum: 1 - TargetTrackingScalingPolicyConfiguration: - $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration' - MaxCapacity: - type: integer - minimum: 1 - required: - - MinCapacity - - MaxCapacity - - TargetTrackingScalingPolicyConfiguration AttributeDefinition: description: Represents an attribute for describing the schema for the table and indexes. additionalProperties: false @@ -154,9 +460,9 @@ components: AttributeType: description: |- The data type for the attribute, where: - + ``S`` - the attribute is of type String - + ``N`` - the attribute is of type Number - + ``B`` - the attribute is of type Binary + + ``S`` - the attribute is of type String + + ``N`` - the attribute is of type Number + + ``B`` - the attribute is of type Binary type: string AttributeName: description: A name for the attribute. @@ -173,16 +479,16 @@ components: uniqueItems: false description: |- Represents the non-key attribute names which will be projected into the index. - For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. + For global and local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. This limit only applies when you specify the ProjectionType of ``INCLUDE``. You still can specify the ProjectionType of ``ALL`` to project all attributes from the source table, even if the table has more than 100 attributes. type: array items: type: string ProjectionType: description: |- The set of attributes that are projected into the index: - + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. - + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. - + ``ALL`` - All of the table attributes are projected into the index. + + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + + ``ALL`` - All of the table attributes are projected into the index. When using the DynamoDB console, ``ALL`` is selected by default. type: string @@ -194,6 +500,14 @@ components: PointInTimeRecoveryEnabled: description: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table. type: boolean + RecoveryPeriodInDays: + maximum: 35 + description: The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35. + type: integer + minimum: 1 + x-dependencies: + RecoveryPeriodInDays: + - PointInTimeRecoveryEnabled ReplicaGlobalSecondaryIndexSpecification: additionalProperties: false type: object @@ -206,25 +520,10 @@ components: $ref: '#/components/schemas/ContributorInsightsSpecification' ReadProvisionedThroughputSettings: $ref: '#/components/schemas/ReadProvisionedThroughputSettings' + ReadOnDemandThroughputSettings: + $ref: '#/components/schemas/ReadOnDemandThroughputSettings' required: - IndexName - TargetTrackingScalingPolicyConfiguration: - additionalProperties: false - type: object - properties: - ScaleOutCooldown: - type: integer - minimum: 0 - TargetValue: - format: double - type: number - DisableScaleIn: - type: boolean - ScaleInCooldown: - type: integer - minimum: 0 - required: - - TargetValue GlobalSecondaryIndex: description: Represents the properties of a global secondary index. additionalProperties: false @@ -233,6 +532,9 @@ components: IndexName: description: The name of the global secondary index. The name must be unique among all other indexes on this table. type: string + OnDemandThroughput: + description: The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. You must use either ``OnDemandThroughput`` or ``ProvisionedThroughput`` based on your table's capacity mode. + $ref: '#/components/schemas/OnDemandThroughput' ContributorInsightsSpecification: description: The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. $ref: '#/components/schemas/ContributorInsightsSpecification' @@ -241,21 +543,24 @@ components: $ref: '#/components/schemas/Projection' ProvisionedThroughput: description: |- - Represents the provisioned throughput settings for the specified global secondary index. + Represents the provisioned throughput settings for the specified global secondary index. You must use either ``OnDemandThroughput`` or ``ProvisionedThroughput`` based on your table's capacity mode. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. $ref: '#/components/schemas/ProvisionedThroughput' KeySchema: uniqueItems: true description: |- The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - + ``HASH`` - partition key - + ``RANGE`` - sort key + + ``HASH`` - partition key + + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. type: array items: $ref: '#/components/schemas/KeySchema' + WarmThroughput: + description: Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ``ReadUnitsPerSecond``, ``WriteUnitsPerSecond``, or both. + $ref: '#/components/schemas/WarmThroughput' required: - IndexName - Projection @@ -266,14 +571,210 @@ components: properties: WriteCapacityAutoScalingSettings: $ref: '#/components/schemas/CapacityAutoScalingSettings' + WriteOnDemandThroughputSettings: + additionalProperties: false + type: object + properties: + MaxWriteRequestUnits: + type: integer + minimum: 1 + ReplicaStreamSpecification: + additionalProperties: false + type: object + properties: + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + required: + - ResourcePolicy + GlobalTableWitness: + additionalProperties: false + type: object + properties: + Region: + type: string + ReadOnDemandThroughputSettings: + additionalProperties: false + type: object + properties: + MaxReadRequestUnits: + type: integer + minimum: 1 + SSESpecification: + description: Represents the settings used to enable server-side encryption. + additionalProperties: false + type: object + properties: + SSEEnabled: + description: Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. + type: boolean + SSEType: + description: |- + Server-side encryption type. The only supported value is: + + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply). + type: string + KMSMasterKeyId: + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Alias + propertyPath: /properties/AliasName + description: The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``. + type: string + required: + - SSEEnabled + KinesisStreamSpecification: + description: The Kinesis Data Streams configuration for the specified table. + additionalProperties: false + type: object + properties: + ApproximateCreationDateTimePrecision: + description: The precision for the time and date that the stream was created. + type: string + enum: + - MICROSECOND + - MILLISECOND + StreamArn: + description: |- + The ARN for a specific Kinesis data stream. + Length Constraints: Minimum length of 37. Maximum length of 1024. + type: string + required: + - StreamArn + StreamSpecification: + description: Represents the DynamoDB Streams configuration for a table in DynamoDB. + additionalProperties: false + type: object + properties: + StreamViewType: + description: |- + When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: + + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. + + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. + + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. + + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream. + type: string + ResourcePolicy: + description: |- + Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. + In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + $ref: '#/components/schemas/ResourcePolicy' + required: + - StreamViewType + ContributorInsightsSpecification: + description: The settings used to enable or disable CloudWatch Contributor Insights. + additionalProperties: false + type: object + properties: + Mode: + description: '' + type: string + enum: + - ACCESSED_AND_THROTTLED_KEYS + - THROTTLED_KEYS + Enabled: + description: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false). + type: boolean + required: + - Enabled + CapacityAutoScalingSettings: + additionalProperties: false + type: object + properties: + MinCapacity: + type: integer + minimum: 1 + SeedCapacity: + type: integer + minimum: 1 + TargetTrackingScalingPolicyConfiguration: + $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration' + MaxCapacity: + type: integer + minimum: 1 + required: + - MinCapacity + - MaxCapacity + - TargetTrackingScalingPolicyConfiguration + WarmThroughput: + anyOf: + - required: + - ReadUnitsPerSecond + - required: + - WriteUnitsPerSecond + description: Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the ``UpdateTable`` operation to meet the throughput requirements of an upcoming peak event. + additionalProperties: false + type: object + properties: + ReadUnitsPerSecond: + description: Represents the number of read operations your base table can instantaneously support. + type: integer + minimum: 1 + WriteUnitsPerSecond: + description: Represents the number of write operations your base table can instantaneously support. + type: integer + minimum: 1 + TargetTrackingScalingPolicyConfiguration: + additionalProperties: false + type: object + properties: + ScaleOutCooldown: + type: integer + minimum: 0 + TargetValue: + format: double + type: number + DisableScaleIn: + type: boolean + ScaleInCooldown: + type: integer + minimum: 0 + required: + - TargetValue ReplicaSSESpecification: additionalProperties: false type: object properties: KMSMasterKeyId: + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Alias + propertyPath: /properties/AliasName type: string required: - KMSMasterKeyId + ResourcePolicy: + description: |- + Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. + In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + While defining resource-based policies in your CFNshort templates, the following considerations apply: + + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. + For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. + Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. + + For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). + additionalProperties: false + type: object + properties: + PolicyDocument: + description: >- + A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy + examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + type: object + required: + - PolicyDocument KeySchema: description: |- Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. @@ -285,8 +786,8 @@ components: KeyType: description: |- The role that this key attribute will assume: - + ``HASH`` - partition key - + ``RANGE`` - sort key + + ``HASH`` - partition key + + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. @@ -300,7 +801,7 @@ components: Tag: description: |- Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. - AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag. + AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag. For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*. additionalProperties: false type: object @@ -334,7 +835,7 @@ components: AttributeName: description: |- The name of the TTL attribute used to store the expiration time for items in the table. - + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. type: string required: @@ -342,12 +843,19 @@ components: GlobalTable: type: object properties: + MultiRegionConsistency: + type: string + enum: + - EVENTUAL + - STRONG TableId: type: string SSESpecification: $ref: '#/components/schemas/SSESpecification' StreamSpecification: $ref: '#/components/schemas/StreamSpecification' + WarmThroughput: + $ref: '#/components/schemas/WarmThroughput' Replicas: minItems: 1 uniqueItems: true @@ -357,6 +865,16 @@ components: $ref: '#/components/schemas/ReplicaSpecification' WriteProvisionedThroughputSettings: $ref: '#/components/schemas/WriteProvisionedThroughputSettings' + WriteOnDemandThroughputSettings: + $ref: '#/components/schemas/WriteOnDemandThroughputSettings' + GlobalTableWitnesses: + minItems: 1 + maxItems: 1 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/GlobalTableWitness' TableName: type: string AttributeDefinitions: @@ -398,16 +916,30 @@ components: - AttributeDefinitions - Replicas x-stackql-resource-name: global_table - x-stackql-primaryIdentifier: + description: 'Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable' + x-type-name: AWS::DynamoDB::GlobalTable + x-stackql-primary-identifier: - TableName + x-stackql-additional-identifiers: + - - Arn + - - StreamArn x-create-only-properties: - LocalSecondaryIndexes - TableName - KeySchema + x-write-only-properties: + - Replicas/*/ReadProvisionedThroughputSettings/ReadCapacityAutoScalingSettings/SeedCapacity + - Replicas/*/GlobalSecondaryIndexes/*/ReadProvisionedThroughputSettings/ReadCapacityAutoScalingSettings/SeedCapacity + - WriteProvisionedThroughputSettings/WriteCapacityAutoScalingSettings/SeedCapacity + - GlobalSecondaryIndexes/*/WriteProvisionedThroughputSettings/WriteCapacityAutoScalingSettings/SeedCapacity x-read-only-properties: - Arn - StreamArn - TableId + x-required-properties: + - KeySchema + - AttributeDefinitions + - Replicas x-required-permissions: read: - dynamodb:Describe* @@ -510,6 +1042,23 @@ components: - application-autoscaling:PutScalingPolicy - application-autoscaling:PutScheduledAction - application-autoscaling:RegisterScalableTarget + OnDemandThroughput: + description: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + additionalProperties: false + type: object + properties: + MaxReadRequestUnits: + description: |- + Maximum number of read request units for the specified table. + To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1. + type: integer + minimum: 1 + MaxWriteRequestUnits: + description: |- + Maximum number of write request units for the specified table. + To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1. + type: integer + minimum: 1 InputFormatOptions: description: The format options for the data that was imported into the target table. There is one value, CsvOption. additionalProperties: false @@ -610,6 +1159,9 @@ components: Table: type: object properties: + OnDemandThroughput: + description: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + $ref: '#/components/schemas/OnDemandThroughput' SSESpecification: description: Specifies the settings to enable server-side encryption. $ref: '#/components/schemas/SSESpecification' @@ -624,8 +1176,8 @@ components: $ref: '#/components/schemas/ContributorInsightsSpecification' ImportSourceSpecification: description: |- - Specifies the properties of data being imported from the S3 bucket source to the table. - If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. + Specifies the properties of data being imported from the S3 bucket source to the" table. + If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, the ``DeletionProtectionEnabled`` property, or the ``WarmThroughput`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. $ref: '#/components/schemas/ImportSourceSpecification' PointInTimeRecoverySpecification: description: The settings used to enable point in time recovery. @@ -635,6 +1187,9 @@ components: Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. $ref: '#/components/schemas/ProvisionedThroughput' + WarmThroughput: + description: Represents the warm throughput (in read units per second and write units per second) for creating a table. + $ref: '#/components/schemas/WarmThroughput' TableName: description: |- A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). @@ -653,8 +1208,8 @@ components: description: |- Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: - + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). - + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for most DynamoDB workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html). + + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. ``PROVISIONED`` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html). If not specified, the default is ``PROVISIONED``. type: string @@ -665,10 +1220,18 @@ components: If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: - + If you update either the contributor insights specification or the provisioned throughput value + + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. type: array items: $ref: '#/components/schemas/GlobalSecondaryIndex' + ResourcePolicy: + description: |- + An AWS resource-based policy document in JSON format that will be attached to the table. + When you attach a resource-based policy while creating a table, the policy application is *strongly consistent*. + The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). + You need to specify the ``CreateTable`` and ``PutResourcePolicy`` IAM actions for authorizing a user to create a table with a resource-based policy. + $ref: '#/components/schemas/ResourcePolicy' KeySchema: oneOf: - uniqueItems: true @@ -711,14 +1274,37 @@ components: required: - KeySchema x-stackql-resource-name: table - x-stackql-primaryIdentifier: + description: |- + The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*. + You should be aware of the following behaviors when working with DDB tables: + + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute). + + Our guidance is to use the latest schema documented for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes. + x-type-name: AWS::DynamoDB::Table + x-stackql-primary-identifier: - TableName x-create-only-properties: - TableName - ImportSourceSpecification + x-conditional-create-only-properties: + - KeySchema + x-write-only-properties: + - ImportSourceSpecification x-read-only-properties: - Arn - StreamArn + x-required-properties: + - KeySchema + x-tagging: + permissions: + - dynamodb:TagResource + - dynamodb:UntagResource + - dynamodb:ListTagsOfResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: read: - dynamodb:DescribeTable @@ -795,52 +1381,300 @@ components: delete: - dynamodb:DeleteTable - dynamodb:DescribeTable + CreateGlobalTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MultiRegionConsistency: + type: string + enum: + - EVENTUAL + - STRONG + TableId: + type: string + SSESpecification: + $ref: '#/components/schemas/SSESpecification' + StreamSpecification: + $ref: '#/components/schemas/StreamSpecification' + WarmThroughput: + $ref: '#/components/schemas/WarmThroughput' + Replicas: + minItems: 1 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ReplicaSpecification' + WriteProvisionedThroughputSettings: + $ref: '#/components/schemas/WriteProvisionedThroughputSettings' + WriteOnDemandThroughputSettings: + $ref: '#/components/schemas/WriteOnDemandThroughputSettings' + GlobalTableWitnesses: + minItems: 1 + maxItems: 1 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/GlobalTableWitness' + TableName: + type: string + AttributeDefinitions: + minItems: 1 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + BillingMode: + type: string + GlobalSecondaryIndexes: + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/GlobalSecondaryIndex' + KeySchema: + minItems: 1 + maxItems: 2 + uniqueItems: true + type: array + items: + $ref: '#/components/schemas/KeySchema' + LocalSecondaryIndexes: + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/LocalSecondaryIndex' + Arn: + type: string + StreamArn: + type: string + TimeToLiveSpecification: + $ref: '#/components/schemas/TimeToLiveSpecification' + x-stackQL-stringOnly: true + x-title: CreateGlobalTableRequest + type: object + required: [] + CreateTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OnDemandThroughput: + description: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + $ref: '#/components/schemas/OnDemandThroughput' + SSESpecification: + description: Specifies the settings to enable server-side encryption. + $ref: '#/components/schemas/SSESpecification' + KinesisStreamSpecification: + description: The Kinesis Data Streams configuration for the specified table. + $ref: '#/components/schemas/KinesisStreamSpecification' + StreamSpecification: + description: The settings for the DDB table stream, which capture changes to items stored in the table. + $ref: '#/components/schemas/StreamSpecification' + ContributorInsightsSpecification: + description: The settings used to enable or disable CloudWatch Contributor Insights for the specified table. + $ref: '#/components/schemas/ContributorInsightsSpecification' + ImportSourceSpecification: + description: |- + Specifies the properties of data being imported from the S3 bucket source to the" table. + If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, the ``DeletionProtectionEnabled`` property, or the ``WarmThroughput`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. + $ref: '#/components/schemas/ImportSourceSpecification' + PointInTimeRecoverySpecification: + description: The settings used to enable point in time recovery. + $ref: '#/components/schemas/PointInTimeRecoverySpecification' + ProvisionedThroughput: + description: |- + Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). + If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. + $ref: '#/components/schemas/ProvisionedThroughput' + WarmThroughput: + description: Represents the warm throughput (in read units per second and write units per second) for creating a table. + $ref: '#/components/schemas/WarmThroughput' + TableName: + description: |- + A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + type: string + AttributeDefinitions: + uniqueItems: true + description: |- + A list of attributes that describe the key schema for the table and indexes. + This property is required to create a DDB table. + Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition. + type: array + items: + $ref: '#/components/schemas/AttributeDefinition' + BillingMode: + description: |- + Specify how you are charged for read and write throughput and how you manage capacity. + Valid values include: + + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for most DynamoDB workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html). + + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. ``PROVISIONED`` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html). + + If not specified, the default is ``PROVISIONED``. + type: string + GlobalSecondaryIndexes: + uniqueItems: false + description: |- + Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. + If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. + If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. + Updates are not supported. The following are exceptions: + + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. + type: array + items: + $ref: '#/components/schemas/GlobalSecondaryIndex' + ResourcePolicy: + description: |- + An AWS resource-based policy document in JSON format that will be attached to the table. + When you attach a resource-based policy while creating a table, the policy application is *strongly consistent*. + The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). + You need to specify the ``CreateTable`` and ``PutResourcePolicy`` IAM actions for authorizing a user to create a table with a resource-based policy. + $ref: '#/components/schemas/ResourcePolicy' + KeySchema: + oneOf: + - uniqueItems: true + type: array + items: + $ref: '#/components/schemas/KeySchema' + - type: object + description: Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. + LocalSecondaryIndexes: + uniqueItems: false + description: Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. + type: array + items: + $ref: '#/components/schemas/LocalSecondaryIndex' + Arn: + description: '' + type: string + StreamArn: + description: '' + type: string + DeletionProtectionEnabled: + description: Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*. + type: boolean + TableClass: + description: The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``. + type: string + Tags: + uniqueItems: false + description: |- + An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + type: array + items: + $ref: '#/components/schemas/Tag' + TimeToLiveSpecification: + description: |- + Specifies the Time to Live (TTL) settings for the table. + For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. + $ref: '#/components/schemas/TimeToLiveSpecification' + x-stackQL-stringOnly: true + x-title: CreateTableRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: global_tables: name: global_tables id: awscc.dynamodb.global_tables x-cfn-schema-name: GlobalTable - x-type: list - x-identifiers: - - TableName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' - AND region = 'us-east-1' - global_table: - name: global_table - id: awscc.dynamodb.global_table - x-cfn-schema-name: GlobalTable - x-type: get + x-cfn-type-name: AWS::DynamoDB::GlobalTable x-identifiers: - TableName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GlobalTable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DynamoDB::GlobalTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DynamoDB::GlobalTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DynamoDB::GlobalTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/global_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.MultiRegionConsistency') as multi_region_consistency, JSON_EXTRACT(Properties, '$.TableId') as table_id, JSON_EXTRACT(Properties, '$.SSESpecification') as sse_specification, JSON_EXTRACT(Properties, '$.StreamSpecification') as stream_specification, + JSON_EXTRACT(Properties, '$.WarmThroughput') as warm_throughput, JSON_EXTRACT(Properties, '$.Replicas') as replicas, JSON_EXTRACT(Properties, '$.WriteProvisionedThroughputSettings') as write_provisioned_throughput_settings, + JSON_EXTRACT(Properties, '$.WriteOnDemandThroughputSettings') as write_on_demand_throughput_settings, + JSON_EXTRACT(Properties, '$.GlobalTableWitnesses') as global_table_witnesses, JSON_EXTRACT(Properties, '$.TableName') as table_name, JSON_EXTRACT(Properties, '$.AttributeDefinitions') as attribute_definitions, JSON_EXTRACT(Properties, '$.BillingMode') as billing_mode, @@ -854,16 +1688,20 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'MultiRegionConsistency') as multi_region_consistency, json_extract_path_text(Properties, 'TableId') as table_id, json_extract_path_text(Properties, 'SSESpecification') as sse_specification, json_extract_path_text(Properties, 'StreamSpecification') as stream_specification, + json_extract_path_text(Properties, 'WarmThroughput') as warm_throughput, json_extract_path_text(Properties, 'Replicas') as replicas, json_extract_path_text(Properties, 'WriteProvisionedThroughputSettings') as write_provisioned_throughput_settings, + json_extract_path_text(Properties, 'WriteOnDemandThroughputSettings') as write_on_demand_throughput_settings, + json_extract_path_text(Properties, 'GlobalTableWitnesses') as global_table_witnesses, json_extract_path_text(Properties, 'TableName') as table_name, json_extract_path_text(Properties, 'AttributeDefinitions') as attribute_definitions, json_extract_path_text(Properties, 'BillingMode') as billing_mode, @@ -876,13 +1714,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' AND data__Identifier = '' AND region = 'us-east-1' - tables: - name: tables - id: awscc.dynamodb.tables - x-cfn-schema-name: Table - x-type: list + global_tables_list_only: + name: global_tables_list_only + id: awscc.dynamodb.global_tables_list_only + x-cfn-schema-name: GlobalTable + x-cfn-type-name: AWS::DynamoDB::GlobalTable x-identifiers: - TableName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -891,7 +1735,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -899,23 +1743,72 @@ components: SELECT region, json_extract_path_text(Properties, 'TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' AND region = 'us-east-1' - table: - name: table - id: awscc.dynamodb.table + tables: + name: tables + id: awscc.dynamodb.tables x-cfn-schema-name: Table - x-type: get + x-cfn-type-name: AWS::DynamoDB::Table x-identifiers: - TableName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DynamoDB::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DynamoDB::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DynamoDB::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.OnDemandThroughput') as on_demand_throughput, JSON_EXTRACT(Properties, '$.SSESpecification') as sse_specification, JSON_EXTRACT(Properties, '$.KinesisStreamSpecification') as kinesis_stream_specification, JSON_EXTRACT(Properties, '$.StreamSpecification') as stream_specification, @@ -923,10 +1816,12 @@ components: JSON_EXTRACT(Properties, '$.ImportSourceSpecification') as import_source_specification, JSON_EXTRACT(Properties, '$.PointInTimeRecoverySpecification') as point_in_time_recovery_specification, JSON_EXTRACT(Properties, '$.ProvisionedThroughput') as provisioned_throughput, + JSON_EXTRACT(Properties, '$.WarmThroughput') as warm_throughput, JSON_EXTRACT(Properties, '$.TableName') as table_name, JSON_EXTRACT(Properties, '$.AttributeDefinitions') as attribute_definitions, JSON_EXTRACT(Properties, '$.BillingMode') as billing_mode, JSON_EXTRACT(Properties, '$.GlobalSecondaryIndexes') as global_secondary_indexes, + JSON_EXTRACT(Properties, '$.ResourcePolicy') as resource_policy, JSON_EXTRACT(Properties, '$.KeySchema') as key_schema, JSON_EXTRACT(Properties, '$.LocalSecondaryIndexes') as local_secondary_indexes, JSON_EXTRACT(Properties, '$.Arn') as arn, @@ -939,11 +1834,12 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'OnDemandThroughput') as on_demand_throughput, json_extract_path_text(Properties, 'SSESpecification') as sse_specification, json_extract_path_text(Properties, 'KinesisStreamSpecification') as kinesis_stream_specification, json_extract_path_text(Properties, 'StreamSpecification') as stream_specification, @@ -951,10 +1847,12 @@ components: json_extract_path_text(Properties, 'ImportSourceSpecification') as import_source_specification, json_extract_path_text(Properties, 'PointInTimeRecoverySpecification') as point_in_time_recovery_specification, json_extract_path_text(Properties, 'ProvisionedThroughput') as provisioned_throughput, + json_extract_path_text(Properties, 'WarmThroughput') as warm_throughput, json_extract_path_text(Properties, 'TableName') as table_name, json_extract_path_text(Properties, 'AttributeDefinitions') as attribute_definitions, json_extract_path_text(Properties, 'BillingMode') as billing_mode, json_extract_path_text(Properties, 'GlobalSecondaryIndexes') as global_secondary_indexes, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, json_extract_path_text(Properties, 'KeySchema') as key_schema, json_extract_path_text(Properties, 'LocalSecondaryIndexes') as local_secondary_indexes, json_extract_path_text(Properties, 'Arn') as arn, @@ -966,3 +1864,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::Table' AND data__Identifier = '' AND region = 'us-east-1' + tables_list_only: + name: tables_list_only + id: awscc.dynamodb.tables_list_only + x-cfn-schema-name: Table + x-cfn-type-name: AWS::DynamoDB::Table + x-identifiers: + - TableName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableName') as table_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GlobalTable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGlobalTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGlobalTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ec2.yaml b/providers/src/awscc/v00.00.00000/services/ec2.yaml index 0bbe6b4e..3ebc7ba2 100644 --- a/providers/src/awscc/v00.00.00000/services/ec2.yaml +++ b/providers/src/awscc/v00.00.00000/services/ec2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EC2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -11,22 +391,24 @@ components: properties: Key: type: string + description: The tag key. Value: type: string + description: The tag value. required: - Value - Key + description: Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). TagSpecification: description: |- - Specifies the tags to apply to a resource when the resource is created for the launch template. + Specifies the tags to apply to resources that are created during instance launch. ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). additionalProperties: false type: object properties: ResourceType: description: |- - The type of resource to tag. - Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume. + The type of resource to tag. You can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume. To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). type: string Tags: @@ -35,6 +417,14 @@ components: type: array items: $ref: '#/components/schemas/Tag' + CapacityAllocation: + type: object + additionalProperties: false + properties: + AllocationType: + type: string + Count: + type: integer CapacityReservation: type: object properties: @@ -74,17 +464,51 @@ components: type: boolean InstanceMatchCriteria: type: string + UnusedReservationBillingOwnerId: + type: string + AvailabilityZoneId: + type: string + StartDate: + type: string + CapacityReservationArn: + type: string + CreateDate: + type: string + State: + type: string + OwnerId: + type: string + DeliveryPreference: + type: string + CapacityReservationFleetId: + type: string + ReservationType: + type: string + CapacityAllocationSet: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/CapacityAllocation' + CommitmentInfo: + type: object + additionalProperties: false + properties: + CommitmentEndDate: + type: string + CommittedInstanceCount: + type: integer required: - InstanceCount - - AvailabilityZone - InstancePlatform - InstanceType x-stackql-resource-name: capacity_reservation - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EC2::CapacityReservation + x-type-name: AWS::EC2::CapacityReservation + x-stackql-primary-identifier: - Id x-create-only-properties: - Tenancy - - InstanceMatchCriteria - InstancePlatform - InstanceType - AvailabilityZone @@ -93,10 +517,36 @@ components: - EphemeralStorage - EbsOptimized - PlacementGroupArn + - AvailabilityZoneId + x-write-only-properties: + - UnusedReservationBillingOwnerId x-read-only-properties: - Id - AvailableInstanceCount - TotalInstanceCount + - StartDate + - CapacityReservationArn + - CreateDate + - State + - OwnerId + - ReservationType + - CapacityAllocationSet + - CommitmentInfo + - DeliveryPreference + - CapacityReservationFleetId + x-required-properties: + - InstanceCount + - InstancePlatform + - InstanceType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/TagSpecifications + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - ec2:CreateCapacityReservation @@ -117,6 +567,7 @@ components: - ec2:CreateCapacityReservation - ec2:DescribeCapacityReservations - ec2:CancelCapacityReservation + - ec2:AssociateCapacityReservationBillingOwner - ec2:CreateTags - ec2:DeleteTags InstanceTypeSpecification: @@ -178,7 +629,9 @@ components: NoRemoveEndDate: type: boolean x-stackql-resource-name: capacity_reservation_fleet - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EC2::CapacityReservationFleet + x-type-name: AWS::EC2::CapacityReservationFleet + x-stackql-primary-identifier: - CapacityReservationFleetId x-create-only-properties: - InstanceTypeSpecifications @@ -189,6 +642,15 @@ components: - InstanceMatchCriteria x-read-only-properties: - CapacityReservationFleetId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/TagSpecifications + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - ec2:CreateCapacityReservationFleet @@ -255,7 +717,9 @@ components: required: - VpcId x-stackql-resource-name: carrier_gateway - x-stackql-primaryIdentifier: + description: Resource Type definition for Carrier Gateway which describes the Carrier Gateway resource + x-type-name: AWS::EC2::CarrierGateway + x-stackql-primary-identifier: - CarrierGatewayId x-create-only-properties: - VpcId @@ -263,6 +727,18 @@ components: - CarrierGatewayId - OwnerId - State + x-required-properties: + - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags x-required-permissions: create: - ec2:CreateCarrierGateway @@ -270,107 +746,147 @@ components: - ec2:CreateTags read: - ec2:DescribeCarrierGateways + - ec2:DescribeTags update: - ec2:DescribeCarrierGateways - ec2:CreateTags - ec2:DeleteTags + - ec2:DescribeTags delete: - ec2:DeleteCarrierGateway - ec2:DescribeCarrierGateways + - ec2:DeleteTags list: - ec2:DescribeCarrierGateways CustomerGateway: type: object properties: + Type: + description: The type of VPN connection that this customer gateway supports (``ipsec.1``). + type: string CustomerGatewayId: + description: '' type: string - description: CustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID. - BgpAsn: - type: integer - default: 65000 - description: For devices that support BGP, the customer gateway's BGP ASN. IpAddress: + description: The IP address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``Ipv6``, you can use an IPv6 address. type: string - description: The internet-routable IP address for the customer gateway's outside interface. The address must be static. + BgpAsnExtended: + multipleOf: 1 + maximum: 4294967294 + description: |- + For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``. + Valid values: ``2,147,483,648`` to ``4,294,967,295`` + type: number + minimum: 2147483648 + BgpAsn: + default: 65000 + description: |- + For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``. + Default: 65000 + Valid values: ``1`` to ``2,147,483,647`` + type: integer Tags: - type: array uniqueItems: false + description: One or more tags for the customer gateway. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - description: One or more tags for the customer gateway. - Type: + CertificateArn: + pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso([a-z]{1})?))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$ + description: The Amazon Resource Name (ARN) for the customer gateway certificate. type: string - description: The type of VPN connection that this customer gateway supports. DeviceName: + description: The name of customer gateway device. type: string - description: A name for the customer gateway device. required: - - BgpAsn - IpAddress - Type x-stackql-resource-name: customer_gateway - x-stackql-primaryIdentifier: + description: Specifies a customer gateway. + x-type-name: AWS::EC2::CustomerGateway + x-stackql-primary-identifier: - CustomerGatewayId x-create-only-properties: + - CertificateArn - BgpAsn + - BgpAsnExtended - Type - IpAddress - DeviceName x-read-only-properties: - CustomerGatewayId + x-required-properties: + - IpAddress + - Type + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ec2:DescribeCustomerGateways create: - ec2:CreateCustomerGateway - ec2:DescribeCustomerGateways - read: - - ec2:DescribeCustomerGateways + - ec2:CreateTags update: - ec2:CreateTags - ec2:DeleteTags - delete: - - ec2:DeleteCustomerGateway - ec2:DescribeCustomerGateways list: - ec2:DescribeCustomerGateways + delete: + - ec2:DeleteCustomerGateway + - ec2:DescribeCustomerGateways DHCPOptions: type: object properties: - NetbiosNameServers: - uniqueItems: true - description: The IPv4 addresses of up to four NetBIOS name servers. + DhcpOptionsId: + type: string + DomainName: + type: string + description: This value is used to complete unqualified DNS hostnames. + DomainNameServers: type: array + description: The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS. + uniqueItems: true items: type: string - NtpServers: - uniqueItems: false - description: The IPv4 addresses of up to four Network Time Protocol (NTP) servers. + NetbiosNameServers: type: array + description: The IPv4 addresses of up to four NetBIOS name servers. + uniqueItems: true items: type: string - DhcpOptionsId: - type: string - DomainName: - description: This value is used to complete unqualified DNS hostnames. - type: string NetbiosNodeType: - description: The NetBIOS node type (1, 2, 4, or 8). type: integer - DomainNameServers: - uniqueItems: true - description: The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS. + description: The NetBIOS node type (1, 2, 4, or 8). + NtpServers: type: array + description: The IPv4 addresses of up to four Network Time Protocol (NTP) servers. + uniqueItems: false items: type: string + Ipv6AddressPreferredLeaseTime: + type: integer + description: The preferred Lease Time for ipV6 address in seconds. Tags: - uniqueItems: false + type: array description: Any tags assigned to the DHCP options set. + uniqueItems: false x-insertionOrder: false - type: array items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: dhcp_options - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EC2::DHCPOptions + x-type-name: AWS::EC2::DHCPOptions + x-stackql-primary-identifier: - DhcpOptionsId x-create-only-properties: - NetbiosNameServers @@ -378,26 +894,36 @@ components: - NtpServers - DomainName - DomainNameServers + - Ipv6AddressPreferredLeaseTime x-read-only-properties: - DhcpOptionsId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: - read: - - ec2:DescribeDhcpOptions - - ec2:DescribeTags create: - ec2:CreateDhcpOptions - ec2:DescribeDhcpOptions - ec2:CreateTags + read: + - ec2:DescribeDhcpOptions + - ec2:DescribeTags update: - ec2:CreateTags - ec2:DescribeDhcpOptions - ec2:DeleteTags - list: - - ec2:DescribeDhcpOptions delete: - ec2:DeleteDhcpOptions - ec2:DeleteTags - ec2:DescribeDhcpOptions + list: + - ec2:DescribeDhcpOptions OnDemandOptionsRequest: type: object additionalProperties: false @@ -520,26 +1046,64 @@ components: GroupId: description: The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group. type: string - FleetLaunchTemplateConfigRequest: + BlockDeviceMapping: type: object additionalProperties: false properties: - LaunchTemplateSpecification: - $ref: '#/components/schemas/FleetLaunchTemplateSpecificationRequest' - Overrides: - type: array - uniqueItems: false - items: - $ref: '#/components/schemas/FleetLaunchTemplateOverridesRequest' - CapacityReservationOptionsRequest: + DeviceName: + type: string + Ebs: + $ref: '#/components/schemas/EbsBlockDevice' + NoDevice: + type: string + VirtualName: + type: string + required: + - DeviceName + EbsBlockDevice: type: object additionalProperties: false properties: - UsageStrategy: + DeleteOnTermination: + type: boolean + Encrypted: + type: boolean + Iops: + type: integer + SnapshotId: + type: string + VolumeSize: + type: integer + VolumeType: type: string enum: - - use-capacity-reservations-first - FleetLaunchTemplateOverridesRequest: + - gp2 + - gp3 + - io1 + - io2 + - sc1 + - st1 + - standard + FleetLaunchTemplateConfigRequest: + type: object + additionalProperties: false + properties: + LaunchTemplateSpecification: + $ref: '#/components/schemas/FleetLaunchTemplateSpecificationRequest' + Overrides: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/FleetLaunchTemplateOverridesRequest' + CapacityReservationOptionsRequest: + type: object + additionalProperties: false + properties: + UsageStrategy: + type: string + enum: + - use-capacity-reservations-first + FleetLaunchTemplateOverridesRequest: type: object additionalProperties: false properties: @@ -559,6 +1123,11 @@ components: $ref: '#/components/schemas/InstanceRequirementsRequest' MaxPrice: type: string + BlockDeviceMappings: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/BlockDeviceMapping' InstanceRequirementsRequest: type: object additionalProperties: false @@ -576,6 +1145,7 @@ components: - intel - amd - amazon-web-services + - apple MemoryGiBPerVCpu: $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' AllowedInstanceTypes: @@ -686,6 +1256,8 @@ components: - v100 AcceleratorTotalMemoryMiB: $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' + BaselinePerformanceFactors: + $ref: '#/components/schemas/BaselinePerformanceFactorsRequest' VCpuCountRangeRequest: type: object additionalProperties: false @@ -758,6 +1330,27 @@ components: type: integer Max: type: integer + BaselinePerformanceFactorsRequest: + type: object + additionalProperties: false + properties: + Cpu: + $ref: '#/components/schemas/CpuPerformanceFactorRequest' + CpuPerformanceFactorRequest: + type: object + additionalProperties: false + properties: + References: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/PerformanceFactorReferenceRequest' + PerformanceFactorReferenceRequest: + type: object + additionalProperties: false + properties: + InstanceFamily: + type: string MaintenanceStrategies: type: object additionalProperties: false @@ -822,7 +1415,9 @@ components: - TargetCapacitySpecification - LaunchTemplateConfigs x-stackql-resource-name: ec2fleet - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EC2::EC2Fleet + x-type-name: AWS::EC2::EC2Fleet + x-stackql-primary-identifier: - FleetId x-create-only-properties: - LaunchTemplateConfigs @@ -836,6 +1431,11 @@ components: - ValidUntil x-read-only-properties: - FleetId + x-required-properties: + - TargetCapacitySpecification + - LaunchTemplateConfigs + x-tagging: + taggable: false x-required-permissions: create: - ec2:CreateFleet @@ -859,25 +1459,52 @@ components: VpcId: description: The ID of the VPC for which to create the egress-only internet gateway. type: string + Tags: + type: array + description: Any tags assigned to the egress only internet gateway. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - VpcId x-stackql-resource-name: egress_only_internet_gateway - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EC2::EgressOnlyInternetGateway + x-type-name: AWS::EC2::EgressOnlyInternetGateway + x-stackql-primary-identifier: - Id x-create-only-properties: - VpcId x-read-only-properties: - Id + x-required-properties: + - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - ec2:CreateEgressOnlyInternetGateway + - ec2:CreateTags - ec2:DescribeEgressOnlyInternetGateways read: - ec2:DescribeEgressOnlyInternetGateways + - ec2:DescribeTags delete: - ec2:DeleteEgressOnlyInternetGateway - ec2:DescribeEgressOnlyInternetGateways - ec2:DescribeVpcs + - ec2:DeleteTags + update: + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeEgressOnlyInternetGateways list: - ec2:DescribeEgressOnlyInternetGateways EIP: @@ -912,6 +1539,12 @@ components: The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. type: string + IpamPoolId: + description: '' + type: string + Address: + description: '' + type: string Tags: description: |- Any tags assigned to the Elastic IP address. @@ -922,16 +1555,36 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: eip - x-stackql-primaryIdentifier: + description: |- + Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance. + You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*. + For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*. + x-type-name: AWS::EC2::EIP + x-stackql-primary-identifier: - PublicIp - AllocationId x-create-only-properties: - - Domain - NetworkBorderGroup - TransferAddress + - IpamPoolId + - Address + x-write-only-properties: + - TransferAddress + - IpamPoolId + - Address x-read-only-properties: - PublicIp - AllocationId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags x-required-permissions: create: - ec2:AllocateAddress @@ -956,26 +1609,39 @@ components: EIPAssociation: type: object properties: - Id: - description: Composite ID of non-empty properties, to determine the identification. + PrivateIpAddress: + description: The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. type: string - AllocationId: - description: The allocation ID. This is required for EC2-VPC. + InstanceId: + description: The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both. type: string - NetworkInterfaceId: - description: The ID of the network interface. + AllocationId: + description: The allocation ID. This is required. type: string - InstanceId: - description: The ID of the instance. + Id: + description: '' type: string - PrivateIpAddress: - description: The primary or secondary private IP address to associate with the Elastic IP address. + NetworkInterfaceId: + description: |- + The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. + You can specify either the instance ID or the network interface ID, but not both. type: string EIP: - description: The Elastic IP address to associate with the instance. + description: '' + anyOf: + - relationshipRef: + typeName: AWS::EC2::EIP + propertyPath: /properties/PublicIp + - relationshipRef: + typeName: AWS::EC2::EIP + propertyPath: /properties/AllocationId type: string x-stackql-resource-name: eip_association - x-stackql-primaryIdentifier: + description: |- + Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview). + You must specify ``AllocationId`` and either ``InstanceId``, ``NetworkInterfaceId``, or ``PrivateIpAddress``. + x-type-name: AWS::EC2::EIPAssociation + x-stackql-primary-identifier: - Id x-create-only-properties: - AllocationId @@ -985,17 +1651,20 @@ components: - EIP x-read-only-properties: - Id + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false x-required-permissions: + read: + - ec2:DescribeAddresses create: - ec2:DescribeAddresses - ec2:AssociateAddress - read: + list: - ec2:DescribeAddresses delete: - ec2:DisassociateAddress - ec2:DescribeAddresses - list: - - ec2:DescribeAddresses EnclaveCertificateIamRoleAssociation: type: object properties: @@ -1024,7 +1693,9 @@ components: - CertificateArn - RoleArn x-stackql-resource-name: enclave_certificate_iam_role_association - x-stackql-primaryIdentifier: + description: Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. + x-type-name: AWS::EC2::EnclaveCertificateIamRoleAssociation + x-stackql-primary-identifier: - CertificateArn - RoleArn x-create-only-properties: @@ -1034,13 +1705,18 @@ components: - CertificateS3BucketName - CertificateS3ObjectKey - EncryptionKmsKeyId + x-required-properties: + - CertificateArn + - RoleArn x-required-permissions: create: - ec2:AssociateEnclaveCertificateIamRole + - ec2:GetAssociatedEnclaveCertificateIamRoles read: - ec2:GetAssociatedEnclaveCertificateIamRoles delete: - ec2:DisassociateEnclaveCertificateIamRole + - ec2:GetAssociatedEnclaveCertificateIamRoles list: - ec2:GetAssociatedEnclaveCertificateIamRoles FlowLog: @@ -1120,7 +1796,9 @@ components: - ResourceType - ResourceId x-stackql-resource-name: flow_log - x-stackql-primaryIdentifier: + description: Specifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC. + x-type-name: AWS::EC2::FlowLog + x-stackql-primary-identifier: - Id x-create-only-properties: - DeliverCrossAccountRole @@ -1136,6 +1814,18 @@ components: - DestinationOptions x-read-only-properties: - Id + x-required-properties: + - ResourceType + - ResourceId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - ec2:CreateFlowLogs @@ -1173,12 +1863,22 @@ components: - RouteTableId - GatewayId x-stackql-resource-name: gateway_route_table_association - x-stackql-primaryIdentifier: + description: Associates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table. + x-type-name: AWS::EC2::GatewayRouteTableAssociation + x-stackql-primary-identifier: - GatewayId x-create-only-properties: - GatewayId x-read-only-properties: - AssociationId + x-required-properties: + - RouteTableId + - GatewayId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - ec2:DescribeRouteTables @@ -1221,10 +1921,19 @@ components: AssetId: description: The ID of the Outpost hardware asset. type: string + Tags: + description: Any tags assigned to the Host. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - AvailabilityZone x-stackql-resource-name: host - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EC2::Host + x-type-name: AWS::EC2::Host + x-stackql-primary-identifier: - HostId x-create-only-properties: - AvailabilityZone @@ -1234,6852 +1943,15850 @@ components: - AssetId x-read-only-properties: - HostId + x-required-properties: + - AvailabilityZone + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - ec2:AllocateHosts - ec2:DescribeHosts + - ec2:CreateTags read: - ec2:DescribeHosts update: - ec2:ModifyHosts - ec2:DescribeHosts + - ec2:DeleteTags + - ec2:CreateTags delete: - ec2:ReleaseHosts - ec2:DescribeHosts list: - ec2:DescribeHosts - SecurityGroupId: - description: The ID of a security group for the endpoint. - type: string - InstanceConnectEndpoint: + LaunchTemplateSpecification: + oneOf: + - required: + - LaunchTemplateName + - Version + - required: + - LaunchTemplateId + - Version + additionalProperties: false type: object properties: - Id: - description: The id of the instance connect endpoint + LaunchTemplateName: + description: The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both. type: string - SubnetId: - description: The subnet id of the instance connect endpoint + Version: + description: The version number of the launch template. type: string - ClientToken: - description: The client token of the instance connect endpoint. + LaunchTemplateId: + description: The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both. type: string - PreserveClientIp: - description: If true, the address of the instance connect endpoint client is preserved when connecting to the end resource - type: boolean - Tags: - description: The tags of the instance connect endpoint. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - SecurityGroupIds: - description: The security group IDs of the instance connect endpoint. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/SecurityGroupId' - required: - - SubnetId - x-stackql-resource-name: instance_connect_endpoint - x-stackql-primaryIdentifier: - - Id - x-create-only-properties: - - SubnetId - - ClientToken - - PreserveClientIp - - SecurityGroupIds - x-read-only-properties: - - Id - x-required-permissions: - create: - - ec2:CreateInstanceConnectEndpoint - - ec2:DescribeInstanceConnectEndpoints - - ec2:CreateTags - - ec2:CreateNetworkInterface - - iam:CreateServiceLinkedRole - read: - - ec2:DescribeInstanceConnectEndpoints - update: - - ec2:DescribeInstanceConnectEndpoints - - ec2:CreateTags - - ec2:DeleteTags - delete: - - ec2:DeleteInstanceConnectEndpoint - - ec2:DescribeInstanceConnectEndpoints - list: - - ec2:DescribeInstanceConnectEndpoints - InternetGateway: + MetadataOptions: + description: |- + The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*. + ``MetadataOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false type: object properties: - InternetGatewayId: - description: ID of internet gateway. + HttpPutResponseHopLimit: + description: |- + The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. + Default: ``1`` + Possible values: Integers from 1 to 64 + type: integer + HttpTokens: + description: |- + Indicates whether IMDSv2 is required. + + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. + + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. + + Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``. type: string - Tags: - description: Any tags to assign to the internet gateway. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - x-stackql-resource-name: internet_gateway - x-stackql-primaryIdentifier: - - InternetGatewayId - x-read-only-properties: - - InternetGatewayId - x-required-permissions: - create: - - ec2:CreateInternetGateway - - ec2:CreateTags - - ec2:DescribeInternetGateways - read: - - ec2:DescribeInternetGateways - delete: - - ec2:DeleteInternetGateway - - ec2:DescribeInternetGateways - update: - - ec2:DeleteTags - - ec2:CreateTags - - ec2:DescribeInternetGateways - list: - - ec2:DescribeInternetGateways - IpamOperatingRegion: - description: The regions IPAM Resource Discovery is enabled for. Allows for monitoring. + HttpProtocolIpv6: + description: |- + Enables or disables the IPv6 endpoint for the instance metadata service. + Default: ``disabled`` + type: string + InstanceMetadataTags: + description: |- + Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [View tags for your EC2 instances using instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html). + Default: ``disabled`` + type: string + HttpEndpoint: + description: |- + Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``. + If you specify a value of ``disabled``, you will not be able to access your instance metadata. + type: string + LicenseSpecification: + description: |- + Specifies a license configuration for an instance. + ``LicenseSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false type: object properties: - RegionName: + LicenseConfigurationArn: + description: The Amazon Resource Name (ARN) of the license configuration. type: string - description: The name of the region. - required: - - RegionName + ElasticGpuSpecification: additionalProperties: false - IPAM: type: object properties: - IpamId: - description: Id of the IPAM. + Type: + description: The type of Elastic Graphics accelerator. Amazon Elastic Graphics is no longer available. type: string - Arn: - description: The Amazon Resource Name (ARN) of the IPAM. - type: string - DefaultResourceDiscoveryId: - description: The Id of the default resource discovery, created with this IPAM. - type: string - DefaultResourceDiscoveryAssociationId: - description: The Id of the default association to the default resource discovery, created with this IPAM. + required: + - Type + InstanceIpv6Address: + type: object + additionalProperties: false + properties: + Ipv6Address: type: string - ResourceDiscoveryAssociationCount: - description: The count of resource discoveries associated with this IPAM. - type: integer + required: + - Ipv6Address + NetworkInterface: + type: object + properties: Description: + description: A description for the network interface. type: string - PublicDefaultScopeId: - description: The Id of the default scope for publicly routable IP space, created with this IPAM. + PrivateIpAddress: + description: 'Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. ' type: string - maxLength: 255 - PrivateDefaultScopeId: - description: The Id of the default scope for publicly routable IP space, created with this IPAM. + PrimaryIpv6Address: + description: The primary IPv6 address type: string - ScopeCount: - description: The number of scopes that currently exist in this IPAM. + PrivateIpAddresses: + uniqueItems: false + description: Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PrivateIpAddressSpecification' + SecondaryPrivateIpAddressCount: + description: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses type: integer - OperatingRegions: - description: The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring + Ipv6PrefixCount: + description: 'The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can''t specify a count of IPv6 prefixes if you''ve specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.' + type: integer + PrimaryPrivateIpAddress: + description: Returns the primary private IP address of the network interface. + type: string + Ipv4Prefixes: + uniqueItems: false + description: 'Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can''t specify IPv4 prefixes if you''ve specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ipv4PrefixSpecification' + Ipv4PrefixCount: + description: 'The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can''t specify a count of IPv4 prefixes if you''ve specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.' + type: integer + EnablePrimaryIpv6: + description: >- + If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you + have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address. + type: boolean + GroupSet: + uniqueItems: false + description: A list of security group IDs associated with this network interface. + x-insertionOrder: false type: array + items: + type: string + Ipv6Addresses: uniqueItems: true + description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/IpamOperatingRegion' - Tier: - description: The tier of the IPAM. + $ref: '#/components/schemas/InstanceIpv6Address' + Ipv6Prefixes: + uniqueItems: false + description: 'Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can''t specify IPv6 prefixes if you''ve specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixSpecification' + SubnetId: + description: The ID of the subnet to associate with the network interface. type: string - enum: - - free - - advanced - Tags: - description: An array of key-value pairs to apply to this resource. + SourceDestCheck: + description: Indicates whether traffic to or from the instance is validated. + type: boolean + InterfaceType: + description: Indicates the type of network interface. + type: string + SecondaryPrivateIpAddresses: + uniqueItems: false + description: Returns the secondary private IP addresses of the network interface. + x-insertionOrder: false type: array - uniqueItems: true + items: + type: string + VpcId: + description: The ID of the VPC + type: string + Ipv6AddressCount: + description: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. + type: integer + Id: + description: Network interface id. + type: string + Tags: + uniqueItems: false + description: An arbitrary set of tags (key-value pairs) for this network interface. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - required: [] - x-stackql-resource-name: ipam - x-stackql-primaryIdentifier: - - IpamId + ConnectionTrackingSpecification: + $ref: '#/components/schemas/ConnectionTrackingSpecification' + required: + - SubnetId + x-stackql-resource-name: network_interface + description: The AWS::EC2::NetworkInterface resource creates network interface + x-type-name: AWS::EC2::NetworkInterface + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - PrivateIpAddress + - InterfaceType + - SubnetId + x-conditional-create-only-properties: + - PrivateIpAddresses + - EnablePrimaryIpv6 + - ConnectionTrackingSpecification x-read-only-properties: - - IpamId - - Arn - - PublicDefaultScopeId - - PrivateDefaultScopeId - - ScopeCount - - ResourceDiscoveryAssociationCount - - DefaultResourceDiscoveryId - - DefaultResourceDiscoveryAssociationId + - Id + - SecondaryPrivateIpAddresses + - PrimaryPrivateIpAddress + - PrimaryIpv6Address + - VpcId + x-required-properties: + - SubnetId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ec2:DescribeNetworkInterfaces create: - - ec2:CreateIpam - - iam:CreateServiceLinkedRole + - ec2:CreateNetworkInterface + - ec2:DescribeNetworkInterfaces - ec2:CreateTags - - ec2:DescribeIpams - read: - - ec2:DescribeIpams + - ec2:ModifyNetworkInterfaceAttribute + - ec2:ModifyPublicIpDnsNameOptions update: - - ec2:ModifyIpam - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeIpams - delete: - - ec2:DeleteIpam + - ec2:DescribeNetworkInterfaces + - ec2:ModifyNetworkInterfaceAttribute + - ec2:UnassignIpv6Addresses + - ec2:AssignIpv6Addresses - ec2:DeleteTags - - ec2:DescribeIpams + - ec2:CreateTags + - ec2:UnassignPrivateIpAddresses + - ec2:AssignPrivateIpAddresses + - ec2:ModifyPublicIpDnsNameOptions list: - - ec2:DescribeIpams - Cidr: - description: Represents a single IPv4 or IPv6 CIDR - type: string - IPAMAllocation: + - ec2:DescribeNetworkInterfaces + delete: + - ec2:DescribeNetworkInterfaces + - ec2:DeleteNetworkInterface + PrivateDnsNameOptions: + description: The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. + additionalProperties: false type: object properties: - IpamPoolAllocationId: - description: Id of the allocation. + EnableResourceNameDnsARecord: + description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. + type: boolean + HostnameType: + description: The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. type: string - IpamPoolId: - description: Id of the IPAM Pool. + EnableResourceNameDnsAAAARecord: + description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. + type: boolean + ElasticInferenceAccelerator: + additionalProperties: false + type: object + properties: + Type: + description: The type of elastic inference accelerator. Amazon Elastic Inference is no longer available. type: string - Cidr: - $ref: '#/components/schemas/Cidr' - NetmaskLength: - description: The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it. + Count: + description: The number of elastic inference accelerators to attach to the instance. Amazon Elastic Inference is no longer available. type: integer - Description: - type: string + minimum: 0 required: - - IpamPoolId - x-stackql-resource-name: ipam_allocation - x-stackql-primaryIdentifier: - - IpamPoolId - - IpamPoolAllocationId - - Cidr - x-create-only-properties: - - IpamPoolId - - Cidr - - Description - - NetmaskLength - x-read-only-properties: - - IpamPoolAllocationId - x-required-permissions: - create: - - ec2:AllocateIpamPoolCidr - - ec2:GetIpamPoolAllocations - read: - - ec2:GetIpamPoolAllocations - delete: - - ec2:ReleaseIpamPoolAllocation - list: - - ec2:GetIpamPoolAllocations - ProvisionedCidr: - description: An address space to be inserted into this pool. All allocations must be made from this address space. + - Type + AssociationParameter: + additionalProperties: false type: object properties: - Cidr: - $ref: '#/components/schemas/Cidr' + Value: + uniqueItems: false + description: The value of an input parameter. + x-insertionOrder: false + type: array + items: + type: string + Key: + description: The name of an input parameter that is in the associated SSM document. + type: string required: - - Cidr + - Value + - Key + SsmAssociation: additionalProperties: false - SourceResource: - description: The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations type: object properties: - ResourceId: - type: string - ResourceType: - type: string - ResourceRegion: + AssociationParameters: + uniqueItems: false + description: The input parameter values to use with the associated SSM document. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/AssociationParameter' + DocumentName: + description: The name of an SSM document to associate with the instance. type: string - ResourceOwner: + required: + - DocumentName + PrivateIpAddressSpecification: + type: object + additionalProperties: false + properties: + Primary: + type: boolean + PrivateIpAddress: type: string required: - - ResourceId - - ResourceType - - ResourceRegion - - ResourceOwner + - PrivateIpAddress + EnaSrdSpecification: + type: object + additionalProperties: false + properties: + EnaSrdEnabled: + type: boolean + description: Indicates whether ENA Express is enabled for the network interface. + EnaSrdUdpSpecification: + type: object + additionalProperties: false + properties: + EnaSrdUdpEnabled: + type: boolean + description: Configures ENA Express for UDP network traffic. + description: |- + ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled. + To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it. + EnaSrdUdpSpecification: + description: ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs. additionalProperties: false - IPAMPool: type: object properties: - IpamPoolId: - description: Id of the IPAM Pool. - type: string - AddressFamily: - description: The address family of the address space in this pool. Either IPv4 or IPv6. + EnaSrdUdpEnabled: + description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. + type: boolean + Volume: + type: object + properties: + MultiAttachEnabled: + description: |- + Indicates whether Amazon EBS Multi-Attach is enabled. + CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. + type: boolean + KmsKeyId: + description: |- + The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. + If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. + Alternatively, if you want to specify a different key, you can specify one of the following: + + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. type: string - AllocationMinNetmaskLength: - description: The minimum allowed netmask length for allocations made from this pool. - type: integer - AllocationDefaultNetmaskLength: - description: The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified. - type: integer - AllocationMaxNetmaskLength: - description: The maximum allowed netmask length for allocations made from this pool. + Encrypted: + description: |- + Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide*. + Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances). + type: boolean + Size: + description: |- + The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. + The following are the supported volumes sizes for each volume type: + + ``gp2`` and ``gp3``: 1 - 16,384 GiB + + ``io1``: 4 - 16,384 GiB + + ``io2``: 4 - 65,536 GiB + + ``st1`` and ``sc1``: 125 - 16,384 GiB + + ``standard``: 1 - 1024 GiB type: integer - AllocationResourceTags: - description: When specified, an allocation will not be allowed unless a resource has a matching set of tags. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Arn: - description: The Amazon Resource Name (ARN) of the IPAM Pool. - type: string - AutoImport: - description: Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically. + AutoEnableIO: + description: Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. type: boolean - AwsService: - description: Limits which service in Amazon Web Services that the pool can be used in. - type: string - enum: - - ec2 - Description: - type: string - IpamScopeId: - description: The Id of the scope this pool is a part of. - type: string - IpamScopeArn: - description: The Amazon Resource Name (ARN) of the scope this pool is a part of. - type: string - IpamScopeType: - description: Determines whether this scope contains publicly routable space or space for a private network - type: string - enum: - - public - - private - IpamArn: - description: The Amazon Resource Name (ARN) of the IPAM this pool is a part of. + OutpostArn: + description: The Amazon Resource Name (ARN) of the Outpost. type: string - Locale: - description: The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match. + AvailabilityZone: + description: |- + The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. + Either ``AvailabilityZone`` or ``AvailabilityZoneId`` must be specified, but not both. type: string - PoolDepth: - description: The depth of this pool in the source pool hierarchy. + Throughput: + description: |- + The throughput to provision for a volume, with a maximum of 1,000 MiB/s. + This parameter is valid only for ``gp3`` volumes. The default value is 125. + Valid Range: Minimum value of 125. Maximum value of 1000. type: integer - ProvisionedCidrs: - description: A list of cidrs representing the address space available for allocation in this pool. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/ProvisionedCidr' - PublicIpSource: - description: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`. - type: string - enum: - - byoip - - amazon - PubliclyAdvertisable: - description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. - type: boolean - SourceIpamPoolId: - description: The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool. + Iops: + description: |- + The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type: + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS. + This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. + type: integer + VolumeInitializationRate: + description: |- + Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. + This parameter is supported only for volumes created from snapshots. Omit this parameter if: + + You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. + If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. + + You want to create a volume that is initialized at the default rate. + + For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*. + Valid range: 100 - 300 MiB/s + type: integer + SnapshotId: + description: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. type: string - SourceResource: - $ref: '#/components/schemas/SourceResource' - State: - description: 'The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"' + VolumeId: + description: '' type: string - enum: - - create-in-progress - - create-complete - - modify-in-progress - - modify-complete - - delete-in-progress - - delete-complete - StateMessage: - description: An explanation of how the pool arrived at it current state. + VolumeType: + description: |- + The volume type. This parameter can be one of the following values: + + General Purpose SSD: ``gp2`` | ``gp3`` + + Provisioned IOPS SSD: ``io1`` | ``io2`` + + Throughput Optimized HDD: ``st1`` + + Cold HDD: ``sc1`` + + Magnetic: ``standard`` + + For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html). + Default: ``gp2`` type: string Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true + uniqueItems: false + description: The tags to apply to the volume during creation. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' required: - - IpamScopeId - - AddressFamily - x-stackql-resource-name: ipam_pool - x-stackql-primaryIdentifier: - - IpamPoolId - x-create-only-properties: - - IpamScopeId - - SourceIpamPoolId - - Locale - - AddressFamily - - PubliclyAdvertisable - - PublicIpSource - - AwsService - - SourceResource + - AvailabilityZone + x-stackql-resource-name: volume + description: |- + Specifies an Amazon Elastic Block Store (Amazon EBS) volume. + When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time. + Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback. + Some common scenarios when you might encounter a cooldown period for Amazon EBS include: + + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period. + + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period. + + For more information, see [Requirements for EBS volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/modify-volume-requirements.html). + *DeletionPolicy attribute* + To control how CFNlong handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html). + If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot. + x-type-name: AWS::EC2::Volume + x-stackql-primary-identifier: + - VolumeId x-read-only-properties: - - IpamPoolId - - Arn - - IpamScopeArn - - IpamScopeType - - IpamArn - - PoolDepth - - State - - StateMessage + - VolumeId + x-required-properties: + - AvailabilityZone + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - ec2:DescribeVolumes + - ec2:DescribeVolumeAttribute + - ec2:DescribeTags create: - - ec2:CreateIpamPool - - ec2:DescribeIpamPools - - ec2:ProvisionIpamPoolCidr - - ec2:GetIpamPoolCidrs + - ec2:CreateVolume + - ec2:DescribeVolumes + - ec2:DescribeVolumeAttribute + - ec2:ModifyVolumeAttribute - ec2:CreateTags - read: - - ec2:DescribeIpamPools - - ec2:GetIpamPoolCidrs + - kms:GenerateDataKeyWithoutPlaintext + - kms:CreateGrant update: - - ec2:ModifyIpamPool - - ec2:DescribeIpamPools - - ec2:GetIpamPoolCidrs - - ec2:ProvisionIpamPoolCidr - - ec2:DeprovisionIpamPoolCidr + - ec2:ModifyVolume + - ec2:ModifyVolumeAttribute + - ec2:DescribeVolumeAttribute + - ec2:DescribeVolumesModifications + - ec2:DescribeVolumes - ec2:CreateTags - ec2:DeleteTags + list: + - ec2:DescribeVolumes + - ec2:DescribeTags + - ec2:DescribeVolumeAttribute delete: - - ec2:DeleteIpamPool - - ec2:DescribeIpamPools - - ec2:GetIpamPoolCidrs - - ec2:DeprovisionIpamPoolCidr + - ec2:DeleteVolume + - ec2:CreateSnapshot + - ec2:DescribeSnapshots - ec2:DeleteTags - list: - - ec2:DescribeIpamPools - IPAMPoolCidr: + - ec2:DescribeVolumes + State: + description: The current state of the instance + additionalProperties: false type: object properties: - IpamPoolCidrId: - description: Id of the IPAM Pool Cidr. + Code: + description: The state of the instance as a 16-bit unsigned integer. type: string - IpamPoolId: - description: Id of the IPAM Pool. + Name: + description: The current state of the instance. type: string - Cidr: - description: Represents a single IPv4 or IPv6 CIDR + Ebs: + description: |- + Parameters for a block device for an EBS volume in an Amazon EC2 launch template. + ``Ebs`` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html). + additionalProperties: false + type: object + properties: + SnapshotId: + description: The ID of the snapshot. type: string - NetmaskLength: - description: The desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it. - type: integer - State: - description: Provisioned state of the cidr. + VolumeType: + description: The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*. type: string - required: - - IpamPoolId - x-stackql-resource-name: ipam_pool_cidr - x-stackql-primaryIdentifier: - - IpamPoolId - - IpamPoolCidrId - x-create-only-properties: - - IpamPoolId - - Cidr - - NetmaskLength - x-read-only-properties: - - IpamPoolCidrId - - State - x-required-permissions: - create: - - ec2:ProvisionIpamPoolCidr - - ec2:GetIpamPoolCidrs - read: - - ec2:GetIpamPoolCidrs - delete: - - ec2:DeprovisionIpamPoolCidr - - ec2:GetIpamPoolCidrs - list: - - ec2:GetIpamPoolCidrs - IPAMResourceDiscovery: + KmsKeyId: + description: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + type: string + Encrypted: + description: Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. + type: boolean + Throughput: + description: |- + The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s. + Valid Range: Minimum value of 125. Maximum value of 1000. + type: integer + Iops: + description: |- + The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type: + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS. + This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. + type: integer + VolumeInitializationRate: + description: |- + Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. + This parameter is supported only for volumes created from snapshots. Omit this parameter if: + + You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. + If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. + + You want to create a volume that is initialized at the default rate. + + For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*. + Valid range: 100 - 300 MiB/s + type: integer + VolumeSize: + description: |- + The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type: + + ``gp2`` and ``gp3``: 1 - 16,384 GiB + + ``io1``: 4 - 16,384 GiB + + ``io2``: 4 - 65,536 GiB + + ``st1`` and ``sc1``: 125 - 16,384 GiB + + ``standard``: 1 - 1024 GiB + type: integer + DeleteOnTermination: + description: Indicates whether the EBS volume is deleted on instance termination. + type: boolean + Instance: type: object properties: - IpamResourceDiscoveryId: - description: Id of the IPAM Pool. - type: string - OwnerId: - description: Owner Account ID of the Resource Discovery + PrivateDnsName: + description: 'The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.' type: string - OperatingRegions: - description: The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring - type: array - uniqueItems: true + Volumes: + uniqueItems: false + description: The volumes to attach to the instance. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/IpamOperatingRegion' - IpamResourceDiscoveryRegion: - description: 'The region the resource discovery is setup in. ' - type: string - Description: - type: string - IsDefault: - description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. - type: boolean - IpamResourceDiscoveryArn: - description: Amazon Resource Name (Arn) for the Resource Discovery. + $ref: '#/components/schemas/Volume' + PrivateIp: + description: 'The private IP address of the specified instance. For example: 10.24.34.0.' type: string - State: - description: The state of this Resource Discovery. + EnclaveOptions: + description: Indicates whether the instance is enabled for AWS Nitro Enclaves. + additionalProperties: false + type: object + properties: + Enabled: + description: If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. + type: boolean + ImageId: + description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. type: string Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true + uniqueItems: false + description: The tags to add to the instance. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - required: [] - x-stackql-resource-name: ipam_resource_discovery - x-stackql-primaryIdentifier: - - IpamResourceDiscoveryId - x-read-only-properties: - - IpamResourceDiscoveryId - - IpamResourceDiscoveryArn - - OwnerId - - IpamResourceDiscoveryRegion - - IsDefault - - State - x-required-permissions: - create: - - ec2:CreateIpamResourceDiscovery - - ec2:DescribeIpamResourceDiscoveries - - ec2:CreateTags - read: - - ec2:DescribeIpamResourceDiscoveries - update: - - ec2:ModifyIpamResourceDiscovery - - ec2:DescribeIpamResourceDiscoveries - - ec2:CreateTags - - ec2:DeleteTags - delete: - - ec2:DeleteIpamResourceDiscovery - - ec2:DescribeIpamResourceDiscoveries - - ec2:DeleteTags - list: - - ec2:DescribeIpamResourceDiscoveries - IPAMResourceDiscoveryAssociation: - type: object - properties: - IpamArn: - description: Arn of the IPAM. + AdditionalInfo: + description: 'This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).' type: string - IpamRegion: - description: The home region of the IPAM. + HibernationOptions: + description: Indicates whether an instance is enabled for hibernation. + additionalProperties: false + type: object + properties: + Configured: + default: false + description: If you set this parameter to true, your instance is enabled for hibernation. + type: boolean + LicenseSpecifications: + uniqueItems: false + description: The license configurations. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/LicenseSpecification' + MetadataOptions: + description: The metadata options for the instance + type: object + $ref: '#/components/schemas/MetadataOptions' + InstanceId: + description: The EC2 Instance ID. type: string - IpamResourceDiscoveryAssociationId: - description: Id of the IPAM Resource Discovery Association. + CpuOptions: + description: The CPU options for the instance. + additionalProperties: false + type: object + properties: + ThreadsPerCore: + type: integer + CoreCount: + type: integer + AvailabilityZone: + description: The Availability Zone of the instance. type: string - IpamResourceDiscoveryId: - description: The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association. + PrivateDnsNameOptions: + description: The options for the instance hostname. + type: object + $ref: '#/components/schemas/PrivateDnsNameOptions' + HostId: + description: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. type: string - IpamId: - description: The Id of the IPAM this Resource Discovery is associated to. + PublicDnsName: + description: 'The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.' type: string - IpamResourceDiscoveryAssociationArn: - description: The Amazon Resource Name (ARN) of the resource discovery association is a part of. + SecurityGroupIds: + uniqueItems: false + description: The IDs of the security groups. + x-insertionOrder: false + type: array + items: + type: string + PlacementGroupName: + description: The name of an existing placement group that you want to launch the instance into (cluster | partition | spread). type: string - IsDefault: - description: If the Resource Discovery Association exists due as part of CreateIpam. - type: boolean - OwnerId: - description: The AWS Account ID for the account where the shared IPAM exists. + SsmAssociations: + uniqueItems: false + description: The SSM document and parameter values in AWS Systems Manager to associate with this instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SsmAssociation' + VpcId: + description: The ID of the VPC that the instance is running in. type: string State: - description: The operational state of the Resource Discovery Association. Related to Create/Delete activities. + description: The current state of the instance. + type: object + $ref: '#/components/schemas/State' + Affinity: + description: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default. type: string - ResourceDiscoveryStatus: - description: The status of the resource discovery. + enum: + - default + - host + Tenancy: + description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. type: string - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true + SecurityGroups: + uniqueItems: false + description: the names of the security groups. For a nondefault VPC, you must use security group IDs instead. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Tag' - required: - - IpamId - - IpamResourceDiscoveryId - x-stackql-resource-name: ipam_resource_discovery_association - x-stackql-primaryIdentifier: - - IpamResourceDiscoveryAssociationId - x-create-only-properties: - - IpamId - - IpamResourceDiscoveryId - x-read-only-properties: - - IpamArn - - IpamRegion - - IpamResourceDiscoveryAssociationId - - IpamResourceDiscoveryAssociationArn - - IsDefault - - ResourceDiscoveryStatus - - State - - OwnerId - x-required-permissions: - create: - - ec2:AssociateIpamResourceDiscovery - - ec2:DescribeIpamResourceDiscoveryAssociations - - ec2:CreateTags - read: - - ec2:DescribeIpamResourceDiscoveryAssociations - update: - - ec2:DescribeIpamResourceDiscoveryAssociations - - ec2:CreateTags - - ec2:DeleteTags - delete: - - ec2:DisassociateIpamResourceDiscovery - - ec2:DescribeIpamResourceDiscoveryAssociations - - ec2:DeleteTags - list: - - ec2:DescribeIpamResourceDiscoveryAssociations - IPAMScope: - type: object - properties: - IpamScopeId: - description: Id of the IPAM scope. + type: string + PrivateIpAddress: + description: '[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.' type: string - Arn: - description: The Amazon Resource Name (ARN) of the IPAM scope. + UserData: + description: The user data to make available to the instance. type: string - IpamId: - description: The Id of the IPAM this scope is a part of. + BlockDeviceMappings: + uniqueItems: false + description: The block device mapping entries that defines the block devices to attach to the instance at launch. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' + IamInstanceProfile: + description: The IAM instance profile. type: string - IpamArn: - description: The Amazon Resource Name (ARN) of the IPAM this scope is a part of. + Ipv6Addresses: + uniqueItems: false + description: '[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InstanceIpv6Address' + KernelId: + description: The ID of the kernel. type: string - IpamScopeType: - description: Determines whether this scope contains publicly routable space or space for a private network + SubnetId: + description: |+ + [EC2-VPC] The ID of the subnet to launch the instance into. + type: string - enum: - - public - - private - IsDefault: - description: Is this one of the default scopes created with the IPAM. + EbsOptimized: + description: Indicates whether the instance is optimized for Amazon EBS I/O. type: boolean - Description: - type: string - PoolCount: - description: The number of pools that currently exist in this scope. - type: integer - Tags: - description: An array of key-value pairs to apply to this resource. + PropagateTagsToVolumeOnCreation: + description: Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes. + type: boolean + ElasticGpuSpecifications: + uniqueItems: false + description: An elastic GPU to associate with the instance. Amazon Elastic Graphics is no longer available. + x-insertionOrder: false type: array - uniqueItems: true + items: + $ref: '#/components/schemas/ElasticGpuSpecification' + ElasticInferenceAccelerators: + uniqueItems: false + description: An elastic inference accelerator to associate with the instance. Amazon Elastic Inference is no longer available. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Tag' - required: - - IpamId - x-stackql-resource-name: ipam_scope - x-stackql-primaryIdentifier: - - IpamScopeId + $ref: '#/components/schemas/ElasticInferenceAccelerator' + Ipv6AddressCount: + description: '[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.' + type: integer + LaunchTemplate: + description: The launch template to use to launch the instances. + type: object + $ref: '#/components/schemas/LaunchTemplateSpecification' + NetworkInterfaces: + uniqueItems: false + description: The network interfaces to associate with the instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + InstanceType: + description: The instance type. + type: string + Monitoring: + description: Specifies whether detailed monitoring is enabled for the instance. + type: boolean + PublicIp: + description: 'The public IP address of the specified instance. For example: 192.0.2.0.' + type: string + InstanceInitiatedShutdownBehavior: + description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + type: string + HostResourceGroupArn: + description: The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host. + type: string + DisableApiTermination: + description: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. + type: boolean + KeyName: + description: The name of the key pair. + type: string + RamdiskId: + description: The ID of the RAM disk to select. + type: string + SourceDestCheck: + description: Specifies whether to enable an instance launched in a VPC to perform NAT. + type: boolean + CreditSpecification: + description: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. + additionalProperties: false + type: object + properties: + CPUCredits: + type: string + x-stackql-resource-name: instance + description: Resource Type definition for AWS::EC2::Instance + x-type-name: AWS::EC2::Instance + x-stackql-primary-identifier: + - InstanceId x-create-only-properties: - - IpamId + - AvailabilityZone + - CpuOptions + - ElasticGpuSpecifications + - ElasticInferenceAccelerators + - EnclaveOptions + - HibernationOptions + - HostResourceGroupArn + - ImageId + - Ipv6AddressCount + - Ipv6Addresses + - KeyName + - LaunchTemplate + - LicenseSpecifications + - NetworkInterfaces + - PlacementGroupName + - PrivateIpAddress + - SecurityGroups + - SubnetId + x-conditional-create-only-properties: + - AdditionalInfo + - Affinity + - EbsOptimized + - HostId + - InstanceType + - KernelId + - PrivateDnsNameOptions + - RamdiskId + - Tenancy + - UserData + - BlockDeviceMappings + - SecurityGroupIds + x-write-only-properties: + - BlockDeviceMappings/*/NoDevice + - BlockDeviceMappings/*/VirtualName + - LicenseSpecification + - AdditionalInfo + - Ipv6AddressCount + - Ipv6Addresses + - PropagateTagsToVolumeOnCreation + - LaunchTemplate x-read-only-properties: - - IpamScopeId - - Arn - - IpamArn - - IsDefault - - PoolCount - - IpamScopeType + - InstanceId + - PrivateIp + - PublicDnsName + - PublicIp + - PrivateDnsName + - VpcId + - State + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVolumes + - ec2:DescribeInstances + - ec2:DescribeInstanceAttribute + - ec2:DescribeInstanceCreditSpecifications + - ec2:DescribeLaunchTemplates + - ssm:DescribeAssociation + - ssm:ListAssociations create: - - ec2:CreateIpamScope - - ec2:DescribeIpamScopes + - iam:PassRole + - ec2:ModifyPrivateDnsNameOptions + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVolumes + - ec2:RunInstances + - ec2:AssociateIamInstanceProfile + - ec2:DescribeIamInstanceProfileAssociations + - ec2:DescribeInstances + - ec2:DescribeSubnets + - ec2:DescribeKeyPairs + - ec2:DescribeSecurityGroups + - ec2:DescribeVpcs + - ec2:DescribeInstanceAttribute + - ec2:DescribeInstanceCreditSpecifications + - ec2:DescribeLaunchTemplates + - ec2:DescribeLaunchTemplateVersions + - ec2:DetachVolume + - ec2:DisassociateIamInstanceProfile + - ec2:ModifyInstanceAttribute + - ec2:ModifyInstanceCreditSpecification + - ec2:ModifyInstancePlacement + - ec2:MonitorInstances + - ec2:AttachVolume - ec2:CreateTags - read: - - ec2:DescribeIpamScopes + - ec2:ReplaceIamInstanceProfileAssociation + - ec2:StartInstances + - ssm:CreateAssociation + - ssm:DescribeAssociation + - ssm:ListAssociations update: - - ec2:ModifyIpamScope - - ec2:DescribeIpamScopes + - ec2:ModifyPrivateDnsNameOptions + - ec2:DescribeNetworkInterfaces + - ec2:AssociateIamInstanceProfile + - ec2:DescribeIamInstanceProfileAssociations + - ec2:DescribeInstances + - ec2:DescribeSubnets + - ec2:DescribeKeyPairs + - ec2:DescribeSecurityGroups + - ec2:DescribeVpcs + - ec2:DescribeInstanceAttribute + - ec2:DescribeInstanceCreditSpecifications + - ec2:DescribeLaunchTemplates + - ec2:DetachVolume + - ec2:DisassociateIamInstanceProfile + - ec2:ModifyInstanceAttribute + - ec2:ModifyInstanceCreditSpecification + - ec2:ModifyInstanceMaintenanceOptions + - ec2:ModifyInstanceMetadataOptions + - ec2:ModifyInstancePlacement + - ec2:MonitorInstances + - ec2:AttachVolume - ec2:CreateTags - ec2:DeleteTags - delete: - - ec2:DeleteIpamScope - - ec2:DescribeIpamScopes - - ec2:DeleteTags + - ec2:ReplaceIamInstanceProfileAssociation + - ec2:StartInstances + - ec2:StopInstances + - ec2:UnmonitorInstances + - ssm:CreateAssociation + - ssm:DeleteAssociation + - ssm:DescribeAssociation + - ssm:ListAssociations list: - - ec2:DescribeIpamScopes - KeyPair: + - ec2:DescribeInstances + delete: + - ec2:DescribeInstances + - ec2:TerminateInstances + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVolumes + - ec2:DescribeInstances + - ec2:DescribeInstanceAttribute + - ec2:DescribeInstanceCreditSpecifications + - ec2:DescribeLaunchTemplates + - ssm:DescribeAssociation + - ssm:ListAssociations + SecurityGroupId: + description: The ID of a security group for the endpoint. + type: string + InstanceConnectEndpoint: type: object properties: - KeyName: - description: The name of the SSH key pair - type: string - KeyType: - description: The crypto-system used to generate a key pair. - type: string - default: rsa - enum: - - rsa - - ed25519 - KeyFormat: - description: The format of the private key - type: string - default: pem - enum: - - pem - - ppk - PublicKeyMaterial: - description: Plain text public key to import + Id: + description: The id of the instance connect endpoint type: string - KeyFingerprint: - description: A short sequence of bytes used for public key verification + SubnetId: + description: The subnet id of the instance connect endpoint type: string - KeyPairId: - description: An AWS generated ID for the key pair + ClientToken: + description: The client token of the instance connect endpoint. type: string + PreserveClientIp: + description: If true, the address of the instance connect endpoint client is preserved when connecting to the end resource + type: boolean Tags: - description: An array of key-value pairs to apply to this resource. + description: The tags of the instance connect endpoint. type: array - uniqueItems: true + uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' + SecurityGroupIds: + description: The security group IDs of the instance connect endpoint. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' required: - - KeyName - x-stackql-resource-name: key_pair - x-stackql-primaryIdentifier: - - KeyName + - SubnetId + x-stackql-resource-name: instance_connect_endpoint + description: Resource Type definition for AWS::EC2::InstanceConnectEndpoint + x-type-name: AWS::EC2::InstanceConnectEndpoint + x-stackql-primary-identifier: + - Id x-create-only-properties: - - KeyName - - KeyType - - KeyFormat - - PublicKeyMaterial - - Tags + - SubnetId + - ClientToken + - PreserveClientIp + - SecurityGroupIds + x-write-only-properties: + - ClientToken x-read-only-properties: - - KeyPairId - - KeyFingerprint + - Id + x-required-properties: + - SubnetId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateKeyPair - - ec2:ImportKeyPair + - ec2:CreateInstanceConnectEndpoint + - ec2:DescribeInstanceConnectEndpoints - ec2:CreateTags - - ssm:PutParameter + - ec2:CreateNetworkInterface + - iam:CreateServiceLinkedRole read: - - ec2:DescribeKeyPairs - list: - - ec2:DescribeKeyPairs + - ec2:DescribeInstanceConnectEndpoints + update: + - ec2:DescribeInstanceConnectEndpoints + - ec2:CreateTags + - ec2:DeleteTags delete: - - ec2:DeleteKeyPair - - ssm:DeleteParameter - - ec2:DescribeKeyPairs - LaunchTemplateData: - description: |- - The information to include in the launch template. - You must specify at least one parameter for the launch template data. - additionalProperties: false + - ec2:DeleteInstanceConnectEndpoint + - ec2:DescribeInstanceConnectEndpoints + list: + - ec2:DescribeInstanceConnectEndpoints + InternetGateway: type: object properties: - SecurityGroups: - uniqueItems: false - description: One or more security group names. For a nondefault VPC, you must use security group IDs instead. + InternetGatewayId: + description: '' + type: string + Tags: + description: Any tags to assign to the internet gateway. type: array - items: - type: string - TagSpecifications: uniqueItems: false - description: |- - The tags to apply to the resources that are created during instance launch. - To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). - To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). - type: array + x-insertionOrder: false items: - $ref: '#/components/schemas/TagSpecification' - UserData: - description: |- - The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide*. - If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*. - type: string - BlockDeviceMappings: - uniqueItems: false - description: The block device mapping. - type: array - items: - $ref: '#/components/schemas/BlockDeviceMapping' - MaintenanceOptions: - description: The maintenance options of your instance. - $ref: '#/components/schemas/MaintenanceOptions' - IamInstanceProfile: - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - $ref: '#/components/schemas/IamInstanceProfile' - KernelId: - description: |- - The ID of the kernel. - We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*. - type: string - EbsOptimized: - description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. - type: boolean - ElasticGpuSpecifications: - uniqueItems: false - description: |- - Deprecated. - Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. - type: array - items: - $ref: '#/components/schemas/ElasticGpuSpecification' - ElasticInferenceAccelerators: - uniqueItems: false - description: |- - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. - You cannot specify accelerators from different generations in the same request. - Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - type: array - items: - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAccelerator' - Placement: - description: The placement for the instance. - $ref: '#/components/schemas/Placement' - NetworkInterfaces: - uniqueItems: false - description: One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface. - type: array - items: - $ref: '#/components/schemas/NetworkInterface' - EnclaveOptions: - description: |- - Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*. - You can't enable AWS Nitro Enclaves and hibernation on the same instance. - $ref: '#/components/schemas/EnclaveOptions' - ImageId: - description: |- - The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch. - Valid formats: - + ``ami-17characters00000`` - + ``resolve:ssm:parameter-name`` - + ``resolve:ssm:parameter-name:version-number`` - + ``resolve:ssm:parameter-name:label`` - - For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide*. - type: string - InstanceType: - description: |- - The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. - If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. - type: string - Monitoring: - description: The monitoring for the instance. - $ref: '#/components/schemas/Monitoring' - HibernationOptions: - description: Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide*. - $ref: '#/components/schemas/HibernationOptions' - MetadataOptions: - description: The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon Elastic Compute Cloud User Guide*. - $ref: '#/components/schemas/MetadataOptions' - LicenseSpecifications: - uniqueItems: false - description: The license configurations. - type: array - items: - $ref: '#/components/schemas/LicenseSpecification' - InstanceInitiatedShutdownBehavior: - description: |- - Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - Default: ``stop`` - type: string - DisableApiStop: - description: Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide*. - type: boolean - CpuOptions: - description: The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*. - $ref: '#/components/schemas/CpuOptions' - PrivateDnsNameOptions: - description: The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. - $ref: '#/components/schemas/PrivateDnsNameOptions' - SecurityGroupIds: - uniqueItems: false - description: The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template. - type: array - items: - type: string - KeyName: - description: |- - The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html). - If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. - type: string - DisableApiTermination: - description: If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance. - type: boolean - InstanceMarketOptions: - description: The market (purchasing) option for the instances. - $ref: '#/components/schemas/InstanceMarketOptions' - InstanceRequirements: - description: |- - The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. - You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. - When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. - To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request: - + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. - - If you specify ``InstanceReq - $ref: '#/components/schemas/InstanceRequirements' - RamDiskId: - description: |- - The ID of the RAM disk. - We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide*. - type: string - CapacityReservationSpecification: - description: The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). - $ref: '#/components/schemas/CapacityReservationSpecification' - CreditSpecification: - description: The credit option for CPU usage of the instance. Valid only for T instances. - $ref: '#/components/schemas/CreditSpecification' - Ipv6Add: - description: |- - Specifies an IPv6 address in an Amazon EC2 launch template. - ``Ipv6Add`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html). - additionalProperties: false - type: object - properties: - Ipv6Address: - description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. - type: string - LicenseSpecification: - description: |- - Specifies a license configuration for an instance. - ``LicenseSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). - additionalProperties: false + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: internet_gateway + description: Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC. + x-type-name: AWS::EC2::InternetGateway + x-stackql-primary-identifier: + - InternetGatewayId + x-read-only-properties: + - InternetGatewayId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateInternetGateway + - ec2:CreateTags + - ec2:DescribeInternetGateways + read: + - ec2:DescribeInternetGateways + delete: + - ec2:DeleteInternetGateway + - ec2:DescribeInternetGateways + update: + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeInternetGateways + list: + - ec2:DescribeInternetGateways + IpamOperatingRegion: + description: The regions IPAM Resource Discovery is enabled for. Allows for monitoring. type: object properties: - LicenseConfigurationArn: - description: The Amazon Resource Name (ARN) of the license configuration. + RegionName: type: string - MaintenanceOptions: - description: The maintenance options of your instance. + description: The name of the region. + required: + - RegionName additionalProperties: false + IpamOrganizationalUnitExclusion: + description: If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. type: object properties: - AutoRecovery: - description: Disables the automatic recovery behavior of your instance or sets it to default. - type: string - RebootMigration: - description: '' + OrganizationsEntityPath: type: string - ElasticGpuSpecification: - description: |- - Specifies a specification for an Elastic GPU for an Amazon EC2 launch template. - ``ElasticGpuSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + description: An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'. + minLength: 1 + required: + - OrganizationsEntityPath additionalProperties: false + IPAM: type: object properties: - Type: - description: The type of Elastic Graphics accelerator. For more information about the values to specify for ``Type``, see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics), specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. + IpamId: + description: Id of the IPAM. type: string - IamInstanceProfile: - description: |- - Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances. - If you are creating the launch template for use with an Amazon EC2 Auto Scaling group, you can specify either the name or the ARN of the instance profile, but not both. - ``IamInstanceProfile`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). - additionalProperties: false - type: object - properties: Arn: - description: The Amazon Resource Name (ARN) of the instance profile. + description: The Amazon Resource Name (ARN) of the IPAM. type: string - Name: - description: The name of the instance profile. + DefaultResourceDiscoveryId: + description: The Id of the default resource discovery, created with this IPAM. type: string - MemoryGiBPerVCpu: - description: The minimum and maximum amount of memory per vCPU, in GiB. - additionalProperties: false - type: object - properties: - Min: - description: The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. - type: number - Max: - description: The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. - type: number - VCpuCount: - description: The minimum and maximum number of vCPUs. - additionalProperties: false - type: object - properties: - Min: - description: The minimum number of vCPUs. To specify no minimum limit, specify ``0``. - type: integer - Max: - description: The maximum number of vCPUs. To specify no maximum limit, omit this parameter. + DefaultResourceDiscoveryAssociationId: + description: The Id of the default association to the default resource discovery, created with this IPAM. + type: string + ResourceDiscoveryAssociationCount: + description: The count of resource discoveries associated with this IPAM. type: integer - Ipv4PrefixSpecification: - type: object - additionalProperties: false - properties: - Ipv4Prefix: + Description: type: string - required: - - Ipv4Prefix - EnaSrdSpecification: - type: object - additionalProperties: false - properties: - EnaSrdEnabled: - type: boolean - EnaSrdUdpSpecification: - type: object - additionalProperties: false - properties: - EnaSrdUdpEnabled: - type: boolean - EnclaveOptions: - description: Indicates whether the instance is enabled for AWS Nitro Enclaves. - additionalProperties: false - type: object - properties: - Enabled: - description: If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. - type: boolean - Ebs: - description: |- - Parameters for a block device for an EBS volume in an Amazon EC2 launch template. - ``Ebs`` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html). - additionalProperties: false - type: object - properties: - SnapshotId: - description: The ID of the snapshot. + PublicDefaultScopeId: + description: The Id of the default scope for publicly routable IP space, created with this IPAM. type: string - VolumeType: - description: The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. + maxLength: 255 + PrivateDefaultScopeId: + description: The Id of the default scope for publicly routable IP space, created with this IPAM. type: string - KmsKeyId: - description: The ARN of the symmetric KMSlong (KMS) CMK used for encryption. - type: string - Encrypted: - description: Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. - type: boolean - Throughput: - description: |- - The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s. - Valid Range: Minimum value of 125. Maximum value of 1000. - type: integer - Iops: - description: |- - The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. - The following are the supported values for each volume type: - + ``gp3``: 3,000 - 16,000 IOPS - + ``io1``: 100 - 64,000 IOPS - + ``io2``: 100 - 256,000 IOPS - - For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. - This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. - type: integer - VolumeSize: - description: |- - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type: - + ``gp2`` and ``gp3``: 1 - 16,384 GiB - + ``io1``: 4 - 16,384 GiB - + ``io2``: 4 - 65,536 GiB - + ``st1`` and ``sc1``: 125 - 16,384 GiB - + ``standard``: 1 - 1024 GiB + ScopeCount: + description: The number of scopes that currently exist in this IPAM. type: integer - DeleteOnTermination: - description: Indicates whether the EBS volume is deleted on instance termination. + OperatingRegions: + description: The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpamOperatingRegion' + Tier: + description: The tier of the IPAM. + type: string + enum: + - free + - advanced + EnablePrivateGua: + description: Enable provisioning of GUA space in private pools. type: boolean - BlockDeviceMapping: + MeteredAccount: + description: A metered account is an account that is charged for active IP addresses managed in IPAM + type: string + enum: + - ipam-owner + - resource-owner + DefaultResourceDiscoveryOrganizationalUnitExclusions: + description: A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpamOrganizationalUnitExclusion' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: [] + x-stackql-resource-name: ipam + description: Resource Schema of AWS::EC2::IPAM Type + x-type-name: AWS::EC2::IPAM + x-stackql-primary-identifier: + - IpamId + x-read-only-properties: + - IpamId + - Arn + - PublicDefaultScopeId + - PrivateDefaultScopeId + - ScopeCount + - ResourceDiscoveryAssociationCount + - DefaultResourceDiscoveryId + - DefaultResourceDiscoveryAssociationId + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + x-required-permissions: + create: + - ec2:CreateIpam + - iam:CreateServiceLinkedRole + - ec2:CreateTags + - ec2:DescribeIpams + - ec2:DescribeIpamResourceDiscoveries + - ec2:ModifyIpamResourceDiscovery + read: + - ec2:DescribeIpams + - ec2:DescribeIpamResourceDiscoveries + update: + - ec2:ModifyIpam + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeIpams + - ec2:DescribeIpamResourceDiscoveries + - ec2:ModifyIpamResourceDiscovery + delete: + - ec2:DeleteIpam + - ec2:DeleteTags + - ec2:DescribeIpams + list: + - ec2:DescribeIpams + Cidr: + description: Represents a single IPv4 or IPv6 CIDR + type: string + IPAMAllocation: type: object - additionalProperties: false properties: - DeviceName: + IpamPoolAllocationId: + description: Id of the allocation. type: string - Ebs: - $ref: '#/components/schemas/EbsBlockDevice' - NoDevice: + IpamPoolId: + description: Id of the IPAM Pool. type: string - VirtualName: + Cidr: + $ref: '#/components/schemas/Cidr' + NetmaskLength: + description: The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it. + type: integer + Description: type: string required: - - DeviceName - Monitoring: - description: |- - Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *User Guide*. - ``Monitoring`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). - additionalProperties: false - type: object - properties: - Enabled: - description: Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled. - type: boolean - MemoryMiB: - description: The minimum and maximum amount of memory, in MiB. - additionalProperties: false - type: object - properties: - Min: - description: The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``. - type: integer - Max: - description: The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. - type: integer - HibernationOptions: - description: |- - Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*. - ``HibernationOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). - additionalProperties: false + - IpamPoolId + x-stackql-resource-name: ipam_allocation + description: Resource Schema of AWS::EC2::IPAMAllocation Type + x-type-name: AWS::EC2::IPAMAllocation + x-stackql-primary-identifier: + - IpamPoolId + - IpamPoolAllocationId + - Cidr + x-create-only-properties: + - IpamPoolId + - Cidr + - Description + - NetmaskLength + x-write-only-properties: + - NetmaskLength + x-read-only-properties: + - IpamPoolAllocationId + x-required-properties: + - IpamPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:AllocateIpamPoolCidr + - ec2:GetIpamPoolAllocations + read: + - ec2:GetIpamPoolAllocations + delete: + - ec2:ReleaseIpamPoolAllocation + list: + - ec2:GetIpamPoolAllocations + ProvisionedCidr: + description: An address space to be inserted into this pool. All allocations must be made from this address space. type: object properties: - Configured: - description: |- - If you set this parameter to ``true``, the instance is enabled for hibernation. - Default: ``false`` - type: boolean - MetadataOptions: - description: |- - The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*. - ``MetadataOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + Cidr: + $ref: '#/components/schemas/Cidr' + required: + - Cidr additionalProperties: false + SourceResource: + description: The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations type: object properties: - HttpPutResponseHopLimit: - description: |- - The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. - Default: ``1`` - Possible values: Integers from 1 to 64 - type: integer - HttpTokens: - description: |- - Indicates whether IMDSv2 is required. - + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. - + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. - - Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``. + ResourceId: type: string - HttpProtocolIpv6: - description: |- - Enables or disables the IPv6 endpoint for the instance metadata service. - Default: ``disabled`` + ResourceType: type: string - InstanceMetadataTags: - description: |- - Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). - Default: ``disabled`` + ResourceRegion: type: string - HttpEndpoint: - description: |- - Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``. - If you specify a value of ``disabled``, you will not be able to access your instance metadata. + ResourceOwner: type: string - NetworkInterfaceCount: - description: The minimum and maximum number of network interfaces. + required: + - ResourceId + - ResourceType + - ResourceRegion + - ResourceOwner additionalProperties: false + IPAMPool: type: object properties: - Min: - description: The minimum number of network interfaces. To specify no minimum limit, omit this parameter. + IpamPoolId: + description: Id of the IPAM Pool. + type: string + AddressFamily: + description: The address family of the address space in this pool. Either IPv4 or IPv6. + type: string + AllocationMinNetmaskLength: + description: The minimum allowed netmask length for allocations made from this pool. type: integer - Max: - description: The maximum number of network interfaces. To specify no maximum limit, omit this parameter. + AllocationDefaultNetmaskLength: + description: The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified. type: integer - CpuOptions: - description: |- - Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*. - ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). - additionalProperties: false - type: object - properties: - ThreadsPerCore: - description: The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``. + AllocationMaxNetmaskLength: + description: The maximum allowed netmask length for allocations made from this pool. type: integer - AmdSevSnp: - description: Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html). + AllocationResourceTags: + description: When specified, an allocation will not be allowed unless a resource has a matching set of tags. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The Amazon Resource Name (ARN) of the IPAM Pool. + type: string + AutoImport: + description: Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically. + type: boolean + AwsService: + description: Limits which service in Amazon Web Services that the pool can be used in. type: string enum: - - enabled - - disabled - CoreCount: - description: The number of CPU cores for the instance. - type: integer - SpotOptions: - description: |- - Specifies options for Spot Instances. - ``SpotOptions`` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html). - additionalProperties: false - type: object - properties: - SpotInstanceType: - description: |- - The Spot Instance request type. - If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the Amazon EC2 Auto Scaling service handles requesting new Spot Instances whenever the group is below its desired capacity. - type: string - InstanceInterruptionBehavior: - description: The behavior when a Spot Instance is interrupted. The default is ``terminate``. + - ec2 + Description: type: string - MaxPrice: - description: |- - The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. - If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter. + IpamScopeId: + description: The Id of the scope this pool is a part of. type: string - BlockDurationMinutes: - description: Deprecated. - type: integer - ValidUntil: - description: |- - The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests. - + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it. - + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request. - - Default: 7 days from the current date + IpamScopeArn: + description: The Amazon Resource Name (ARN) of the scope this pool is a part of. type: string - NetworkInterface: - type: object - properties: - Description: - description: A description for the network interface. + IpamScopeType: + description: Determines whether this scope contains publicly routable space or space for a private network type: string - PrivateIpAddress: - description: 'Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. ' + enum: + - public + - private + IpamArn: + description: The Amazon Resource Name (ARN) of the IPAM this pool is a part of. type: string - PrivateIpAddresses: - description: Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/PrivateIpAddressSpecification' - SecondaryPrivateIpAddressCount: - description: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses - type: integer - PrimaryPrivateIpAddress: - description: Returns the primary private IP address of the network interface. + Locale: + description: The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match. type: string - Ipv4Prefixes: - description: 'Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can''t specify IPv4 prefixes if you''ve specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.' - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Ipv4PrefixSpecification' - Ipv4PrefixCount: - description: 'The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can''t specify a count of IPv4 prefixes if you''ve specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.' + PoolDepth: + description: The depth of this pool in the source pool hierarchy. type: integer - GroupSet: - description: A list of security group IDs associated with this network interface. - type: array - uniqueItems: false - x-insertionOrder: false - items: - type: string - Ipv6Addresses: - description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. + ProvisionedCidrs: + description: A list of cidrs representing the address space available for allocation in this pool. type: array uniqueItems: true x-insertionOrder: false items: - $ref: '#/components/schemas/InstanceIpv6Address' - Ipv6Prefixes: - description: 'Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can''t specify IPv6 prefixes if you''ve specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.' - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Ipv6PrefixSpecification' - Ipv6PrefixCount: - description: 'The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can''t specify a count of IPv6 prefixes if you''ve specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.' - type: integer - SubnetId: - description: The ID of the subnet to associate with the network interface. + $ref: '#/components/schemas/ProvisionedCidr' + PublicIpSource: + description: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`. type: string - SourceDestCheck: - description: Indicates whether traffic to or from the instance is validated. + enum: + - byoip + - amazon + PubliclyAdvertisable: + description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. type: boolean - InterfaceType: - description: Indicates the type of network interface. + SourceIpamPoolId: + description: The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool. type: string - SecondaryPrivateIpAddresses: - description: Returns the secondary private IP addresses of the network interface. - type: array - uniqueItems: false - x-insertionOrder: false - items: - type: string - Ipv6AddressCount: - description: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. - type: integer - EnablePrimaryIpv6: - description: >- - If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you - have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address. - type: boolean - PrimaryIpv6Address: - description: The primary IPv6 address + SourceResource: + $ref: '#/components/schemas/SourceResource' + State: + description: 'The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"' type: string - ConnectionTrackingSpecification: - $ref: '#/components/schemas/ConnectionTrackingSpecification' - Id: - description: Network interface id. + enum: + - create-in-progress + - create-complete + - modify-in-progress + - modify-complete + - delete-in-progress + - delete-complete + StateMessage: + description: An explanation of how the pool arrived at it current state. type: string Tags: - description: An arbitrary set of tags (key-value pairs) for this network interface. + description: An array of key-value pairs to apply to this resource. type: array - uniqueItems: false + uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - - SubnetId - x-stackql-resource-name: network_interface - x-stackql-primaryIdentifier: - - Id + - IpamScopeId + - AddressFamily + x-stackql-resource-name: ipam_pool + description: Resource Schema of AWS::EC2::IPAMPool Type + x-type-name: AWS::EC2::IPAMPool + x-stackql-primary-identifier: + - IpamPoolId x-create-only-properties: - - PrivateIpAddress - - InterfaceType - - SubnetId + - IpamScopeId + - SourceIpamPoolId + - Locale + - AddressFamily + - PubliclyAdvertisable + - PublicIpSource + - AwsService + - SourceResource x-read-only-properties: - - Id - - SecondaryPrivateIpAddresses - - PrimaryPrivateIpAddress - - PrimaryIpv6Address + - IpamPoolId + - Arn + - IpamScopeArn + - IpamScopeType + - IpamArn + - PoolDepth + - State + - StateMessage + x-required-properties: + - IpamScopeId + - AddressFamily + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags x-required-permissions: create: - - ec2:CreateNetworkInterface - - ec2:DescribeNetworkInterfaces + - ec2:CreateIpamPool + - ec2:DescribeIpamPools + - ec2:ProvisionIpamPoolCidr + - ec2:GetIpamPoolCidrs - ec2:CreateTags - - ec2:ModifyNetworkInterfaceAttribute - delete: - - ec2:DescribeNetworkInterfaces - - ec2:DeleteNetworkInterface - list: - - ec2:DescribeNetworkInterfaces read: - - ec2:DescribeNetworkInterfaces + - ec2:DescribeIpamPools + - ec2:GetIpamPoolCidrs update: - - ec2:DescribeNetworkInterfaces - - ec2:ModifyNetworkInterfaceAttribute - - ec2:UnassignIpv6Addresses - - ec2:AssignIpv6Addresses - - ec2:DeleteTags + - ec2:ModifyIpamPool + - ec2:DescribeIpamPools + - ec2:GetIpamPoolCidrs + - ec2:ProvisionIpamPoolCidr + - ec2:DeprovisionIpamPoolCidr - ec2:CreateTags - - ec2:UnassignPrivateIpAddresses - - ec2:AssignPrivateIpAddresses - PrivateDnsNameOptions: - description: The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. - additionalProperties: false + - ec2:DeleteTags + delete: + - ec2:DeleteIpamPool + - ec2:DescribeIpamPools + - ec2:GetIpamPoolCidrs + - ec2:DeprovisionIpamPoolCidr + - ec2:DeleteTags + list: + - ec2:DescribeIpamPools + IPAMPoolCidr: type: object properties: - EnableResourceNameDnsARecord: - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. - type: boolean - HostnameType: - description: The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. + IpamPoolCidrId: + description: Id of the IPAM Pool Cidr. type: string - EnableResourceNameDnsAAAARecord: - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - type: boolean - PrivateIpAdd: - description: |- - Specifies a secondary private IPv4 address for a network interface. - ``PrivateIpAdd`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html). - additionalProperties: false - type: object - properties: - PrivateIpAddress: - description: The private IPv4 address. + IpamPoolId: + description: Id of the IPAM Pool. type: string - Primary: - description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. - type: boolean - Ipv6PrefixSpecification: - type: object - additionalProperties: false - properties: - Ipv6Prefix: + Cidr: + description: Represents a single IPv4 or IPv6 CIDR + type: string + NetmaskLength: + description: The desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it. + type: integer + State: + description: Provisioned state of the cidr. type: string required: - - Ipv6Prefix - LaunchTemplateTagSpecification: - description: |- - Specifies the tags to apply to the launch template during creation. - ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). - additionalProperties: false + - IpamPoolId + x-stackql-resource-name: ipam_pool_cidr + description: Resource Schema of AWS::EC2::IPAMPoolCidr Type + x-type-name: AWS::EC2::IPAMPoolCidr + x-stackql-primary-identifier: + - IpamPoolId + - IpamPoolCidrId + x-create-only-properties: + - IpamPoolId + - Cidr + - NetmaskLength + x-read-only-properties: + - IpamPoolCidrId + - State + x-required-properties: + - IpamPoolId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:ProvisionIpamPoolCidr + - ec2:GetIpamPoolCidrs + read: + - ec2:GetIpamPoolCidrs + delete: + - ec2:DeprovisionIpamPoolCidr + - ec2:GetIpamPoolCidrs + list: + - ec2:GetIpamPoolCidrs + IpamResourceDiscoveryOrganizationalUnitExclusion: + description: If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. type: object properties: - ResourceType: - description: The type of resource. To tag the launch template, ``ResourceType`` must be ``launch-template``. + OrganizationsEntityPath: type: string - Tags: - uniqueItems: false - description: The tags for the resource. - type: array - items: - $ref: '#/components/schemas/Tag' - EnaSrdUdpSpecification: - description: ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs. - additionalProperties: false - type: object - properties: - EnaSrdUdpEnabled: - description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. - type: boolean - NetworkBandwidthGbps: - description: |- - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). - Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*. - additionalProperties: false - type: object - properties: - Min: - description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. - type: number - Max: - description: The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. - type: number - AcceleratorCount: - description: The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. - additionalProperties: false - type: object - properties: - Min: - description: The minimum number of accelerators. To specify no minimum limit, omit this parameter. - type: integer - Max: - description: The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. - type: integer - InstanceMarketOptions: - description: |- - Specifies the market (purchasing) option for an instance. - ``InstanceMarketOptions`` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + description: An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'. + minLength: 1 + required: + - OrganizationsEntityPath additionalProperties: false + IPAMResourceDiscovery: type: object properties: - SpotOptions: - description: The options for Spot Instances. - $ref: '#/components/schemas/SpotOptions' - MarketType: - description: The market type. + IpamResourceDiscoveryId: + description: Id of the IPAM Pool. type: string - LaunchTemplateElasticInferenceAccelerator: - description: |- - Specifies an elastic inference accelerator. - ``LaunchTemplateElasticInferenceAccelerator`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). - additionalProperties: false - type: object - properties: - Type: - description: The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. + OwnerId: + description: Owner Account ID of the Resource Discovery type: string - Count: - description: |- - The number of elastic inference accelerators to attach to the instance. - Default: 1 - type: integer - BaselineEbsBandwidthMbps: - description: The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. - additionalProperties: false - type: object - properties: - Min: - description: The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. - type: integer - Max: - description: The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. - type: integer - InstanceRequirements: - description: |- - The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. - You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. - When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. - To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request: - + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. - - If you specify ``InstanceReq - additionalProperties: false - type: object - properties: - LocalStorageTypes: - uniqueItems: false - description: |- - The type of local storage that is required. - + For instance types with hard disk drive (HDD) storage, specify ``hdd``. - + For instance types with solid state drive (SSD) storage, specify ``ssd``. - - Default: ``hdd`` and ``ssd`` + OperatingRegions: + description: The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring type: array + uniqueItems: true + x-insertionOrder: false items: - type: string - InstanceGenerations: - uniqueItems: false - description: |- - Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. - For current generation instance types, specify ``current``. - For previous generation instance types, specify ``previous``. - Default: Current and previous generation instance types + $ref: '#/components/schemas/IpamOperatingRegion' + IpamResourceDiscoveryRegion: + description: 'The region the resource discovery is setup in. ' + type: string + Description: + type: string + OrganizationalUnitExclusions: + description: A set of organizational unit (OU) exclusions for this resource. type: array + uniqueItems: true + x-insertionOrder: false items: - type: string - NetworkInterfaceCount: - description: |- - The minimum and maximum number of network interfaces. - Default: No minimum or maximum limits - $ref: '#/components/schemas/NetworkInterfaceCount' - MemoryGiBPerVCpu: - description: |- - The minimum and maximum amount of memory per vCPU, in GiB. - Default: No minimum or maximum limits - $ref: '#/components/schemas/MemoryGiBPerVCpu' - AcceleratorTypes: - uniqueItems: false - description: |- - The accelerator types that must be on the instance type. - + For instance types with GPU accelerators, specify ``gpu``. - + For instance types with FPGA accelerators, specify ``fpga``. - + For instance types with inference accelerators, specify ``inference``. - - Default: Any accelerator type + $ref: '#/components/schemas/IpamResourceDiscoveryOrganizationalUnitExclusion' + IsDefault: + description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. + type: boolean + IpamResourceDiscoveryArn: + description: Amazon Resource Name (Arn) for the Resource Discovery. + type: string + State: + description: The state of this Resource Discovery. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. type: array + uniqueItems: true + x-insertionOrder: false items: - type: string - VCpuCount: - description: The minimum and maximum number of vCPUs. - $ref: '#/components/schemas/VCpuCount' - ExcludedInstanceTypes: - uniqueItems: false - description: |- - The instance types to exclude. - You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. - For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. - If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. - Default: No excluded instance types + $ref: '#/components/schemas/Tag' + required: [] + x-stackql-resource-name: ipam_resource_discovery + description: Resource Schema of AWS::EC2::IPAMResourceDiscovery Type + x-type-name: AWS::EC2::IPAMResourceDiscovery + x-stackql-primary-identifier: + - IpamResourceDiscoveryId + x-read-only-properties: + - IpamResourceDiscoveryId + - IpamResourceDiscoveryArn + - OwnerId + - IpamResourceDiscoveryRegion + - IsDefault + - State + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + x-required-permissions: + create: + - ec2:CreateIpamResourceDiscovery + - ec2:DescribeIpamResourceDiscoveries + - ec2:ModifyIpamResourceDiscovery + - ec2:CreateTags + - iam:CreateServiceLinkedRole + read: + - ec2:DescribeIpamResourceDiscoveries + update: + - ec2:ModifyIpamResourceDiscovery + - ec2:DescribeIpamResourceDiscoveries + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteIpamResourceDiscovery + - ec2:DescribeIpamResourceDiscoveries + - ec2:DeleteTags + list: + - ec2:DescribeIpamResourceDiscoveries + IPAMResourceDiscoveryAssociation: + type: object + properties: + IpamArn: + description: Arn of the IPAM. + type: string + IpamRegion: + description: The home region of the IPAM. + type: string + IpamResourceDiscoveryAssociationId: + description: Id of the IPAM Resource Discovery Association. + type: string + IpamResourceDiscoveryId: + description: The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association. + type: string + IpamId: + description: The Id of the IPAM this Resource Discovery is associated to. + type: string + IpamResourceDiscoveryAssociationArn: + description: The Amazon Resource Name (ARN) of the resource discovery association is a part of. + type: string + IsDefault: + description: If the Resource Discovery Association exists due as part of CreateIpam. + type: boolean + OwnerId: + description: The AWS Account ID for the account where the shared IPAM exists. + type: string + State: + description: The operational state of the Resource Discovery Association. Related to Create/Delete activities. + type: string + ResourceDiscoveryStatus: + description: The status of the resource discovery. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. type: array + uniqueItems: true + x-insertionOrder: false items: - description: The user data to make available to the instance. - type: string - AcceleratorManufacturers: + $ref: '#/components/schemas/Tag' + required: + - IpamId + - IpamResourceDiscoveryId + x-stackql-resource-name: ipam_resource_discovery_association + description: Resource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type + x-type-name: AWS::EC2::IPAMResourceDiscoveryAssociation + x-stackql-primary-identifier: + - IpamResourceDiscoveryAssociationId + x-create-only-properties: + - IpamId + - IpamResourceDiscoveryId + x-read-only-properties: + - IpamArn + - IpamRegion + - IpamResourceDiscoveryAssociationId + - IpamResourceDiscoveryAssociationArn + - IsDefault + - ResourceDiscoveryStatus + - State + - OwnerId + x-required-properties: + - IpamId + - IpamResourceDiscoveryId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + x-required-permissions: + create: + - ec2:AssociateIpamResourceDiscovery + - ec2:DescribeIpamResourceDiscoveryAssociations + - ec2:CreateTags + read: + - ec2:DescribeIpamResourceDiscoveryAssociations + update: + - ec2:DescribeIpamResourceDiscoveryAssociations + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DisassociateIpamResourceDiscovery + - ec2:DescribeIpamResourceDiscoveryAssociations + - ec2:DeleteTags + list: + - ec2:DescribeIpamResourceDiscoveryAssociations + IPAMScope: + type: object + properties: + IpamScopeId: + description: Id of the IPAM scope. + type: string + Arn: + description: The Amazon Resource Name (ARN) of the IPAM scope. + type: string + IpamId: + description: The Id of the IPAM this scope is a part of. + type: string + IpamArn: + description: The Amazon Resource Name (ARN) of the IPAM this scope is a part of. + type: string + IpamScopeType: + description: Determines whether this scope contains publicly routable space or space for a private network + type: string + enum: + - public + - private + IsDefault: + description: Is this one of the default scopes created with the IPAM. + type: boolean + Description: + type: string + PoolCount: + description: The number of pools that currently exist in this scope. + type: integer + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - IpamId + x-stackql-resource-name: ipam_scope + description: Resource Schema of AWS::EC2::IPAMScope Type + x-type-name: AWS::EC2::IPAMScope + x-stackql-primary-identifier: + - IpamScopeId + x-create-only-properties: + - IpamId + x-read-only-properties: + - IpamScopeId + - Arn + - IpamArn + - IsDefault + - PoolCount + - IpamScopeType + x-required-properties: + - IpamId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + x-required-permissions: + create: + - ec2:CreateIpamScope + - ec2:DescribeIpamScopes + - ec2:CreateTags + read: + - ec2:DescribeIpamScopes + update: + - ec2:ModifyIpamScope + - ec2:DescribeIpamScopes + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteIpamScope + - ec2:DescribeIpamScopes + - ec2:DeleteTags + list: + - ec2:DescribeIpamScopes + IpPoolRouteTableAssociation: + type: object + properties: + AssociationId: + description: The route table association ID. + type: string + PublicIpv4Pool: + description: The ID of the public IPv4 pool. + type: string + RouteTableId: + description: The ID of the route table. + type: string + required: + - PublicIpv4Pool + - RouteTableId + x-stackql-resource-name: ip_pool_route_table_association + description: Resource Type definition for AWS::EC2::IpPoolRouteTableAssociation + x-type-name: AWS::EC2::IpPoolRouteTableAssociation + x-stackql-primary-identifier: + - AssociationId + x-create-only-properties: + - PublicIpv4Pool + - RouteTableId + x-read-only-properties: + - AssociationId + x-required-properties: + - PublicIpv4Pool + - RouteTableId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:AssociateRouteTable + - ec2:DescribeRouteTables + read: + - ec2:DescribeRouteTables + delete: + - ec2:DisassociateRouteTable + - ec2:DescribeRouteTables + list: + - ec2:DescribeRouteTables + KeyPair: + type: object + properties: + KeyName: + description: |- + A unique name for the key pair. + Constraints: Up to 255 ASCII characters + type: string + KeyType: + description: |- + The type of key pair. Note that ED25519 keys are not supported for Windows instances. + If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. + Default: ``rsa`` + type: string + default: rsa + enum: + - rsa + - ed25519 + KeyFormat: + description: |- + The format of the key pair. + Default: ``pem`` + type: string + default: pem + enum: + - pem + - ppk + PublicKeyMaterial: + description: The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created. + type: string + KeyFingerprint: + description: '' + type: string + KeyPairId: + description: '' + type: string + Tags: + description: The tags to apply to the key pair. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - KeyName + x-stackql-resource-name: key_pair + description: |- + Specifies a key pair for use with an EC2long instance as follows: + + To import an existing key pair, include the ``PublicKeyMaterial`` property. + + To create a new key pair, omit the ``PublicKeyMaterial`` property. + + When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair. + When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: ``/ec2/keypair/{key_pair_id}``. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*. + When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store. + x-type-name: AWS::EC2::KeyPair + x-stackql-primary-identifier: + - KeyName + x-stackql-additional-identifiers: + - - KeyPairId + x-create-only-properties: + - KeyName + - KeyType + - KeyFormat + - PublicKeyMaterial + - Tags + x-write-only-properties: + - KeyFormat + x-read-only-properties: + - KeyPairId + - KeyFingerprint + x-required-properties: + - KeyName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + x-required-permissions: + create: + - ec2:CreateKeyPair + - ec2:ImportKeyPair + - ec2:CreateTags + - ssm:PutParameter + read: + - ec2:DescribeKeyPairs + list: + - ec2:DescribeKeyPairs + delete: + - ec2:DeleteKeyPair + - ssm:DeleteParameter + - ec2:DescribeKeyPairs + LaunchTemplateData: + description: |- + The information to include in the launch template. + You must specify at least one parameter for the launch template data. + additionalProperties: false + type: object + properties: + SecurityGroups: uniqueItems: false description: |- - Indicates whether instance types must have accelerators by specific manufacturers. - + For instance types with AWS devices, specify ``amazon-web-services``. - + For instance types with AMD devices, specify ``amd``. - + For instance types with Habana devices, specify ``habana``. - + For instance types with NVIDIA devices, specify ``nvidia``. - + For instance types with Xilinx devices, specify ``xilinx``. - - Default: Any manufacturer + The names of the security groups. For a nondefault VPC, you must use security group IDs instead. + If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. type: array items: type: string - AllowedInstanceTypes: + TagSpecifications: uniqueItems: false description: |- - The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. - You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. - For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. - If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. - Default: All instance types + The tags to apply to resources that are created during instance launch. + To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). type: array items: - type: string - LocalStorage: + $ref: '#/components/schemas/TagSpecification' + NetworkPerformanceOptions: + description: The settings for the network performance options for the instance. For more information, see [EC2 instance bandwidth weighting configuration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-bandwidth-weighting.html). + $ref: '#/components/schemas/NetworkPerformanceOptions' + UserData: description: |- - Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*. - + To include instance types with instance store volumes, specify ``included``. - + To require only instance types with instance store volumes, specify ``required``. - + To exclude instance types with instance store volumes, specify ``excluded``. - - Default: ``included`` + The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands when you launch an EC2 instance with user data input](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*. + If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html#lt-user-data) in the *User Guide*. type: string - CpuManufacturers: + BlockDeviceMappings: uniqueItems: false - description: |- - The CPU manufacturers to include. - + For instance types with Intel CPUs, specify ``intel``. - + For instance types with AMD CPUs, specify ``amd``. - + For instance types with AWS CPUs, specify ``amazon-web-services``. - - Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. - Default: Any manufacturer + description: The block device mapping. type: array items: - type: string - AcceleratorCount: - description: |- - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. - To exclude accelerator-enabled instance types, set ``Max`` to ``0``. - Default: No minimum or maximum limits - $ref: '#/components/schemas/AcceleratorCount' - NetworkBandwidthGbps: + $ref: '#/components/schemas/BlockDeviceMapping' + MaintenanceOptions: + description: The maintenance options of your instance. + $ref: '#/components/schemas/MaintenanceOptions' + IamInstanceProfile: + description: The name or Amazon Resource Name (ARN) of an IAM instance profile. + $ref: '#/components/schemas/IamInstanceProfile' + KernelId: description: |- - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). - Default: No minimum or maximum limits - $ref: '#/components/schemas/NetworkBandwidthGbps' - BareMetal: + The ID of the kernel. + We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*. + type: string + EbsOptimized: + description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. + type: boolean + Placement: + description: The placement for the instance. + $ref: '#/components/schemas/Placement' + NetworkInterfaces: + uniqueItems: false + description: The network interfaces for the instance. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + EnclaveOptions: description: |- - Indicates whether bare metal instance types must be included, excluded, or required. - + To include bare metal instance types, specify ``included``. - + To require only bare metal instance types, specify ``required``. - + To exclude bare metal instance types, specify ``excluded``. + Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*. + You can't enable AWS Nitro Enclaves and hibernation on the same instance. + $ref: '#/components/schemas/EnclaveOptions' + ImageId: + description: |- + The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch. + Valid formats: + + ``ami-0ac394d6a3example`` + + ``resolve:ssm:parameter-name`` + + ``resolve:ssm:parameter-name:version-number`` + + ``resolve:ssm:parameter-name:label`` - Default: ``excluded`` + For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide*. type: string - RequireHibernateSupport: - description: |- - Indicates whether instance types must support hibernation for On-Demand Instances. - This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html). - Default: ``false`` - type: boolean - MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: - description: >- - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation - instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. - The parameter accepts an integer, which Amazon EC2 interprets as a percentage. - To indicate no price protection threshold, specify a high value, such as ``999999``. - If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instanc - type: integer - SpotMaxPricePercentageOverLowestPrice: - description: >- - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous - generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. - The parameter accepts an integer, which Amazon EC2 interprets as a percentage. - To indicate no price protection threshold, specify a high value, such as ``999999``. - If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price i - type: integer - BaselineEbsBandwidthMbps: + InstanceType: description: |- - The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. - Default: No minimum or maximum limits - $ref: '#/components/schemas/BaselineEbsBandwidthMbps' - OnDemandMaxPricePercentageOverLowestPrice: + The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. + If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. + type: string + Monitoring: + description: The monitoring for the instance. + $ref: '#/components/schemas/Monitoring' + HibernationOptions: + description: Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*. + $ref: '#/components/schemas/HibernationOptions' + MetadataOptions: + description: The metadata options for the instance. For more information, see [Configure the Instance Metadata Service options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) in the *Amazon EC2 User Guide*. + $ref: '#/components/schemas/MetadataOptions' + LicenseSpecifications: + uniqueItems: false + description: The license configurations. + type: array + items: + $ref: '#/components/schemas/LicenseSpecification' + InstanceInitiatedShutdownBehavior: description: |- - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. - The parameter accepts an integer, which Amazon EC2 interprets as a percentage. - To turn off price protection, specify a high value, such as ``999999``. - This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). - If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per- - type: integer - AcceleratorNames: + Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + Default: ``stop`` + type: string + DisableApiStop: + description: Indicates whether to enable the instance for stop protection. For more information, see [Enable stop protection for your EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html) in the *Amazon EC2 User Guide*. + type: boolean + CpuOptions: + description: The CPU options for the instance. For more information, see [CPU options for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon EC2 User Guide*. + $ref: '#/components/schemas/CpuOptions' + PrivateDnsNameOptions: + description: The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. + $ref: '#/components/schemas/PrivateDnsNameOptions' + SecurityGroupIds: uniqueItems: false description: |- - The accelerators that must be on the instance type. - + For instance types with NVIDIA A10G GPUs, specify ``a10g``. - + For instance types with NVIDIA A100 GPUs, specify ``a100``. - + For instance types with NVIDIA H100 GPUs, specify ``h100``. - + For instance types with AWS Inferentia chips, specify ``inferentia``. - + For instance types with NVIDIA GRID K520 GPUs, specify ``k520``. - + For instance types with NVIDIA K80 GPUs, specify ``k80``. - + For instance types with NVIDIA M60 GPUs, specify ``m60``. - + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. - + For instance types with NVIDIA T4 GPUs, specify ``t4``. - + For instance types with NVIDIA T4G GPUs, specify ``t4g``. - + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. - + For instance types with NVIDIA V100 GPUs, specify ``v100``. - - Default: Any accelerator + The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template. + If you specify a network interface, you must specify any security groups as part of the network interface instead. type: array items: type: string - AcceleratorTotalMemoryMiB: + KeyName: description: |- - The minimum and maximum amount of total accelerator memory, in MiB. - Default: No minimum or maximum limits - $ref: '#/components/schemas/AcceleratorTotalMemoryMiB' - BurstablePerformance: + The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html). + If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. + type: string + DisableApiTermination: + description: Indicates whether termination protection is enabled for the instance. The default is ``false``, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped. + type: boolean + InstanceMarketOptions: + description: The market (purchasing) option for the instances. + $ref: '#/components/schemas/InstanceMarketOptions' + InstanceRequirements: description: |- - Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). - + To include burstable performance instance types, specify ``included``. - + To require only burstable performance instance types, specify ``required``. - + To exclude burstable performance instance types, specify ``excluded``. + The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. + You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. + When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. + To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request: + + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. - Default: ``excluded`` - type: string - MemoryMiB: - description: The minimum and maximum amount of memory, in MiB. - $ref: '#/components/schemas/MemoryMiB' - TotalLocalStorageGB: + If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. + Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify ``InstanceRequirements``. + For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + $ref: '#/components/schemas/InstanceRequirements' + RamDiskId: description: |- - The minimum and maximum amount of total local storage, in GB. - Default: No minimum or maximum limits - $ref: '#/components/schemas/TotalLocalStorageGB' - AcceleratorTotalMemoryMiB: - description: The minimum and maximum amount of total accelerator memory, in MiB. + The ID of the RAM disk. + We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*. + type: string + CapacityReservationSpecification: + description: The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + $ref: '#/components/schemas/CapacityReservationSpecification' + CreditSpecification: + description: The credit option for CPU usage of the instance. Valid only for T instances. + $ref: '#/components/schemas/CreditSpecification' + Ipv6Add: + description: |- + Specifies an IPv6 address in an Amazon EC2 launch template. + ``Ipv6Add`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html). additionalProperties: false type: object properties: - Min: - description: The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. - type: integer - Max: - description: The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. - type: integer - CapacityReservationTarget: - description: |- - Specifies a target Capacity Reservation. - ``CapacityReservationTarget`` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type. + Ipv6Address: + description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. + type: string + NetworkPerformanceOptions: + description: Contains settings for the network performance options for the instance. additionalProperties: false type: object properties: - CapacityReservationResourceGroupArn: - description: The ARN of the Capacity Reservation resource group in which to run the instance. - type: string - CapacityReservationId: - description: The ID of the Capacity Reservation in which to run the instance. + BandwidthWeighting: + description: |- + Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows: + + default This option uses the standard bandwidth configuration for your instance type. + vpc-1 This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth. + ebs-1 This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth. type: string - CapacityReservationSpecification: - description: |- - Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time. - ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + MaintenanceOptions: + description: The maintenance options of your instance. additionalProperties: false type: object properties: - CapacityReservationPreference: - description: |- - Indicates the instance's Capacity Reservation preferences. Possible preferences include: - + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). - + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. + AutoRecovery: + description: Disables the automatic recovery behavior of your instance or sets it to default. type: string - CapacityReservationTarget: - description: Information about the target Capacity Reservation or Capacity Reservation group. - $ref: '#/components/schemas/CapacityReservationTarget' - CreditSpecification: + Cpu: + description: Specifies the CPU performance to consider when using an instance family as the baseline reference. + additionalProperties: false + type: object + properties: + References: + description: The instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes are compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. + $ref: '#/components/schemas/References' + IamInstanceProfile: description: |- - Specifies the credit option for CPU usage of a T2, T3, or T3a instance. - ``CreditSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances. + If you are creating the launch template for use with an ASlong group, you can specify either the name or the ARN of the instance profile, but not both. + ``IamInstanceProfile`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). additionalProperties: false type: object properties: - CpuCredits: - description: |- - The credit option for CPU usage of a T instance. - Valid values: ``standard`` | ``unlimited`` + Arn: + description: The Amazon Resource Name (ARN) of the instance profile. type: string - TotalLocalStorageGB: - description: The minimum and maximum amount of total local storage, in GB. + Name: + description: The name of the instance profile. + type: string + MemoryGiBPerVCpu: + description: The minimum and maximum amount of memory per vCPU, in GiB. additionalProperties: false type: object properties: Min: - description: The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. + description: The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. type: number Max: - description: The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. + description: The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. type: number - ConnectionTrackingSpecification: - type: object + VCpuCount: + description: The minimum and maximum number of vCPUs. additionalProperties: false + type: object properties: - TcpEstablishedTimeout: - type: integer - UdpStreamTimeout: + Min: + description: The minimum number of vCPUs. To specify no minimum limit, specify ``0``. type: integer - UdpTimeout: + Max: + description: The maximum number of vCPUs. To specify no maximum limit, omit this parameter. type: integer - LaunchTemplate: + Ipv4PrefixSpecification: + additionalProperties: false type: object properties: - LaunchTemplateName: - description: A name for the launch template. - type: string - LaunchTemplateData: - description: The information for the launch template. - $ref: '#/components/schemas/LaunchTemplateData' - VersionDescription: - description: A description for the first version of the launch template. - type: string - TagSpecifications: - uniqueItems: false - description: |- - The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). - type: array - items: - $ref: '#/components/schemas/LaunchTemplateTagSpecification' - LatestVersionNumber: - description: '' - type: string - LaunchTemplateId: - description: '' - type: string - DefaultVersionNumber: - description: '' + Ipv4Prefix: type: string required: - - LaunchTemplateData - x-stackql-resource-name: launch_template - x-stackql-primaryIdentifier: - - LaunchTemplateId - x-create-only-properties: - - LaunchTemplateName - x-read-only-properties: - - DefaultVersionNumber - - LaunchTemplateId - - LatestVersionNumber - x-required-permissions: - read: - - ec2:DescribeLaunchTemplates - create: - - ec2:CreateLaunchTemplate - - ec2:CreateTags - update: - - ec2:CreateLaunchTemplateVersion - list: - - ec2:DescribeLaunchTemplates - delete: - - ec2:DeleteLaunchTemplate - - ec2:DeleteTags - - ec2:DescribeLaunchTemplates - LocalGatewayRoute: + - Ipv4Prefix + EnclaveOptions: + description: Indicates whether the instance is enabled for AWS Nitro Enclaves. + additionalProperties: false type: object properties: - DestinationCidrBlock: - description: The CIDR block used for destination matches. - type: string - LocalGatewayRouteTableId: - description: The ID of the local gateway route table. - type: string - LocalGatewayVirtualInterfaceGroupId: - description: The ID of the virtual interface group. - type: string - NetworkInterfaceId: - description: The ID of the network interface. - type: string - State: - description: The state of the route. - type: string - Type: - description: The route type. + Enabled: + description: If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. + type: boolean + Monitoring: + description: |- + Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *User Guide*. + ``Monitoring`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false + type: object + properties: + Enabled: + description: Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled. + type: boolean + MemoryMiB: + description: The minimum and maximum amount of memory, in MiB. + additionalProperties: false + type: object + properties: + Min: + description: The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``. + type: integer + Max: + description: The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. + type: integer + HibernationOptions: + description: |- + Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*. + ``HibernationOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false + type: object + properties: + Configured: + description: |- + If you set this parameter to ``true``, the instance is enabled for hibernation. + Default: ``false`` + type: boolean + NetworkInterfaceCount: + description: The minimum and maximum number of network interfaces. + additionalProperties: false + type: object + properties: + Min: + description: The minimum number of network interfaces. To specify no minimum limit, omit this parameter. + type: integer + Max: + description: The maximum number of network interfaces. To specify no maximum limit, omit this parameter. + type: integer + Reference: + description: Specifies an instance family to use as the baseline reference for CPU performance. + additionalProperties: false + type: object + properties: + InstanceFamily: + description: |- + The instance family to use as a baseline reference. + Ensure that you specify the correct value for the instance family. The instance family is everything before the period (``.``) in the instance type name. For example, in the instance type ``c6i.large``, the instance family is ``c6i``, not ``c6``. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types*. + The following instance families are *not supported* for performance protection: + + ``c1`` + + ``g3`` | ``g3s`` + + ``hpc7g`` + + ``m1`` | ``m2`` + + ``mac1`` | ``mac2`` | ``mac2-m1ultra`` | ``mac2-m2`` | ``mac2-m2pro`` + + ``p3dn`` | ``p4d`` | ``p5`` + + ``t1`` + + ``u-12tb1`` | ``u-18tb1`` | ``u-24tb1`` | ``u-3tb1`` | ``u-6tb1`` | ``u-9tb1`` | ``u7i-12tb`` | ``u7in-16tb`` | ``u7in-24tb`` | ``u7in-32tb`` + + If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. type: string - x-stackql-resource-name: local_gateway_route - x-stackql-primaryIdentifier: - - DestinationCidrBlock - - LocalGatewayRouteTableId - x-create-only-properties: - - DestinationCidrBlock - - LocalGatewayRouteTableId - x-read-only-properties: - - State - - Type - x-required-permissions: - create: - - ec2:CreateLocalGatewayRoute - - ec2:SearchLocalGatewayRoutes - read: - - ec2:SearchLocalGatewayRoutes - delete: - - ec2:DeleteLocalGatewayRoute - - ec2:SearchLocalGatewayRoutes - list: - - ec2:DescribeLocalGatewayRouteTables - - ec2:SearchLocalGatewayRoutes - update: - - ec2:ModifyLocalGatewayRoute - - ec2:SearchLocalGatewayRoutes - LocalGatewayRouteTable: + CpuOptions: + description: |- + Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*. + ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false type: object properties: - LocalGatewayRouteTableId: - description: The ID of the local gateway route table. + ThreadsPerCore: + description: The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``. + type: integer + AmdSevSnp: + description: Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html). type: string - LocalGatewayRouteTableArn: - description: The ARN of the local gateway route table. + enum: + - enabled + - disabled + CoreCount: + description: The number of CPU cores for the instance. + type: integer + SpotOptions: + description: |- + Specifies options for Spot Instances. + ``SpotOptions`` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html). + additionalProperties: false + type: object + properties: + SpotInstanceType: + description: |- + The Spot Instance request type. + If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity. type: string - LocalGatewayId: - description: The ID of the local gateway. + InstanceInterruptionBehavior: + description: The behavior when a Spot Instance is interrupted. The default is ``terminate``. type: string - OutpostArn: - description: The ARN of the outpost. + MaxPrice: + description: |- + The maximum hourly price you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. If you do specify this parameter, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an ``InvalidParameterValue`` error message when the launch template is used to launch an instance. + If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter. type: string - OwnerId: - description: The owner of the local gateway route table. + BlockDurationMinutes: + description: Deprecated. + type: integer + ValidUntil: + description: |- + The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests. + + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it. + + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request. + + Default: 7 days from the current date type: string - State: - description: The state of the local gateway route table. + PrivateIpAdd: + description: |- + Specifies a secondary private IPv4 address for a network interface. + ``PrivateIpAdd`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html). + additionalProperties: false + type: object + properties: + PrivateIpAddress: + description: The private IPv4 address. type: string - Mode: - description: The mode of the local gateway route table. + Primary: + description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. + type: boolean + Ipv6PrefixSpecification: + additionalProperties: false + type: object + properties: + Ipv6Prefix: type: string - Tags: - description: The tags for the local gateway route table. - $ref: '#/components/schemas/Tags' required: - - LocalGatewayId - x-stackql-resource-name: local_gateway_route_table - x-stackql-primaryIdentifier: - - LocalGatewayRouteTableId - x-create-only-properties: - - LocalGatewayId - - Mode - x-read-only-properties: - - LocalGatewayRouteTableId - - LocalGatewayRouteTableArn - - OutpostArn - - OwnerId - - State - x-required-permissions: - create: - - ec2:CreateLocalGatewayRouteTable - - ec2:DescribeLocalGatewayRouteTables - - ec2:CreateTags - read: - - ec2:DescribeLocalGatewayRouteTables - update: - - ec2:DescribeLocalGatewayRouteTables - - ec2:CreateTags - - ec2:DeleteTags - delete: - - ec2:DeleteLocalGatewayRouteTable - - ec2:DescribeLocalGatewayRouteTables - - ec2:DeleteTags - list: - - ec2:DescribeLocalGatewayRouteTables - LocalGatewayRouteTableVirtualInterfaceGroupAssociation: + - Ipv6Prefix + LaunchTemplateTagSpecification: + description: |- + Specifies the tags to apply to the launch template during creation. + To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). + ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). + additionalProperties: false type: object properties: - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId: - description: The ID of the local gateway route table virtual interface group association. - type: string - LocalGatewayId: - description: The ID of the local gateway. - type: string - LocalGatewayRouteTableId: - description: The ID of the local gateway route table. - type: string - LocalGatewayRouteTableArn: - description: The ARN of the local gateway route table. - type: string - LocalGatewayVirtualInterfaceGroupId: - description: The ID of the local gateway route table virtual interface group. - type: string - OwnerId: - description: The owner of the local gateway route table virtual interface group association. - type: string - State: - description: The state of the local gateway route table virtual interface group association. + ResourceType: + description: The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``. type: string Tags: - description: The tags for the local gateway route table virtual interface group association. - $ref: '#/components/schemas/Tags' - required: - - LocalGatewayRouteTableId - - LocalGatewayVirtualInterfaceGroupId - x-stackql-resource-name: local_gateway_route_table_virtual_interface_group_association - x-stackql-primaryIdentifier: - - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId - x-create-only-properties: - - LocalGatewayRouteTableId - - LocalGatewayVirtualInterfaceGroupId - x-read-only-properties: - - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId - - LocalGatewayId - - LocalGatewayRouteTableArn - - OwnerId - - State - x-required-permissions: - create: - - ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation - - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - - ec2:CreateTags - read: - - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - update: - - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - - ec2:CreateTags - - ec2:DeleteTags - delete: - - ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation - - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - - ec2:DeleteTags - list: - - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - LocalGatewayRouteTableVPCAssociation: + uniqueItems: false + description: The tags for the resource. + type: array + items: + $ref: '#/components/schemas/Tag' + NetworkBandwidthGbps: + description: |- + The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). + Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*. + additionalProperties: false type: object properties: - LocalGatewayId: - description: The ID of the local gateway. - type: string - LocalGatewayRouteTableId: - description: The ID of the local gateway route table. - type: string - LocalGatewayRouteTableVpcAssociationId: - description: The ID of the association. - type: string - State: - description: The state of the association. - type: string - VpcId: - description: The ID of the VPC. - type: string - Tags: - description: The tags for the association. - $ref: '#/components/schemas/Tags' - required: - - LocalGatewayRouteTableId - - VpcId - x-stackql-resource-name: local_gateway_route_tablevpc_association - x-stackql-primaryIdentifier: - - LocalGatewayRouteTableVpcAssociationId - x-create-only-properties: - - LocalGatewayRouteTableId - - VpcId - x-read-only-properties: - - LocalGatewayId - - LocalGatewayRouteTableVpcAssociationId - - State - x-required-permissions: - create: - - ec2:CreateLocalGatewayRouteTableVpcAssociation - - ec2:DescribeLocalGatewayRouteTableVpcAssociations - - ec2:CreateTags - read: - - ec2:DescribeLocalGatewayRouteTableVpcAssociations - update: - - ec2:DescribeLocalGatewayRouteTableVpcAssociations - - ec2:CreateTags - - ec2:DeleteTags - delete: - - ec2:DeleteLocalGatewayRouteTableVpcAssociation - - ec2:DescribeLocalGatewayRouteTableVpcAssociations - - ec2:DeleteTags - list: - - ec2:DescribeLocalGatewayRouteTableVpcAssociations - NatGateway: + Min: + description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. + type: number + Max: + description: The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. + type: number + AcceleratorCount: + description: The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. + additionalProperties: false type: object properties: - SubnetId: - type: string - description: The ID of the subnet in which the NAT gateway is located. - NatGatewayId: - type: string - description: '' - ConnectivityType: - type: string - description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. - PrivateIpAddress: - type: string - description: The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. - Tags: - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - description: The tags for the NAT gateway. - AllocationId: - type: string - description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.' - SecondaryAllocationIds: - type: array - uniqueItems: true - x-insertionOrder: true - items: - type: string - description: Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*. - SecondaryPrivateIpAddresses: - type: array - uniqueItems: true - x-insertionOrder: true - items: - type: string - description: |- - Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. - ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. - SecondaryPrivateIpAddressCount: + Min: + description: The minimum number of accelerators. To specify no minimum limit, omit this parameter. type: integer - minimum: 1 - description: |- - [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. - ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. - MaxDrainDurationSeconds: + Max: + description: The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. type: integer - description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. - required: - - SubnetId - x-stackql-resource-name: nat_gateway - x-stackql-primaryIdentifier: - - NatGatewayId - x-create-only-properties: - - SubnetId - - ConnectivityType - - AllocationId - - PrivateIpAddress - x-read-only-properties: - - NatGatewayId - x-required-permissions: - create: - - ec2:CreateNatGateway - - ec2:DescribeNatGateways - - ec2:CreateTags - delete: - - ec2:DeleteNatGateway - - ec2:DescribeNatGateways - list: - - ec2:DescribeNatGateways - read: - - ec2:DescribeNatGateways - update: - - ec2:DescribeNatGateways - - ec2:CreateTags - - ec2:DeleteTags - - ec2:AssociateNatGatewayAddress - - ec2:DisassociateNatGatewayAddress - - ec2:AssignPrivateNatGatewayAddress - - ec2:UnassignPrivateNatGatewayAddress - NetworkAcl: + InstanceMarketOptions: + description: |- + Specifies the market (purchasing) option for an instance. + ``InstanceMarketOptions`` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false type: object properties: - Id: - type: string - Tags: - description: The tags to assign to the network ACL. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - VpcId: - description: The ID of the VPC. + SpotOptions: + description: The options for Spot Instances. + $ref: '#/components/schemas/SpotOptions' + MarketType: + description: The market type. type: string - required: - - VpcId - x-stackql-resource-name: network_acl - x-stackql-primaryIdentifier: - - Id - x-create-only-properties: - - VpcId - x-read-only-properties: - - Id - x-required-permissions: - create: - - ec2:CreateNetworkAcl - - ec2:DescribeNetworkAcls - - ec2:CreateTags - read: - - ec2:DescribeNetworkAcls - - ec2:DescribeTags - update: - - ec2:DescribeNetworkAcls - - ec2:DeleteTags - - ec2:CreateTags - delete: - - ec2:DeleteTags - - ec2:DeleteNetworkAcl - - ec2:DescribeNetworkAcls - list: - - ec2:DescribeNetworkAcls - PortRange: + References: + uniqueItems: true + description: A list of references to be used as baseline for the CPU performance. Currently, you can only specify a single reference across different instance type variations such as CPU manufacturers, architectures etc. + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Reference' + BaselinePerformanceFactors: + description: |- + The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. + Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. additionalProperties: false type: object properties: - From: - type: integer - To: - type: integer - Icmp: - type: object + Cpu: + description: The CPU performance to consider, using an instance family as the baseline reference. + $ref: '#/components/schemas/Cpu' + BaselineEbsBandwidthMbps: + description: The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. additionalProperties: false + type: object properties: - Code: + Min: + description: The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. type: integer - Type: + Max: + description: The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. type: integer - NetworkAclEntry: + InstanceRequirements: + description: |- + The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. + You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. + When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. + To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request: + + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. + + If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. + Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify ``InstanceRequirements``. + For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + additionalProperties: false type: object properties: - Id: - type: string - PortRange: - description: The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18 - $ref: '#/components/schemas/PortRange' - NetworkAclId: - description: The ID of the network ACL - type: string - RuleAction: - description: Indicates whether to allow or deny the traffic that matches the rule - type: string - CidrBlock: - description: 'The IPv4 CIDR range to allow or deny, in CIDR notation (for example, 172.16.0.0/24). Requirement is conditional: You must specify the CidrBlock or Ipv6CidrBlock property' - type: string - Egress: - description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet) - type: boolean - RuleNumber: - description: Rule number to assign to the entry, such as 100. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule - type: integer - Ipv6CidrBlock: - description: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64) - type: string - Protocol: - description: >- - The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an - ICMP type and code - type: integer - Icmp: - description: 'The Internet Control Message Protocol (ICMP) code and type. Requirement is conditional: Required if specifying 1 (ICMP) for the protocol parameter' - $ref: '#/components/schemas/Icmp' - required: - - NetworkAclId - - RuleAction - - RuleNumber - - Protocol - x-stackql-resource-name: network_acl_entry - x-stackql-primaryIdentifier: - - Id - x-create-only-properties: - - Egress - - RuleNumber - - NetworkAclId - x-read-only-properties: - - Id - x-required-permissions: - create: - - ec2:CreateNetworkAclEntry - - ec2:DescribeNetworkAcls - update: - - ec2:ReplaceNetworkAclEntry - - ec2:DescribeNetworkAcls - delete: - - ec2:DeleteNetworkAclEntry - - ec2:DescribeNetworkAcls - AccessScopePathRequest: - type: object - additionalProperties: false - properties: - Source: - $ref: '#/components/schemas/PathStatementRequest' - Destination: - $ref: '#/components/schemas/PathStatementRequest' - ThroughResources: - type: array - x-insertionOrder: true - items: - $ref: '#/components/schemas/ThroughResourcesStatementRequest' - PathStatementRequest: - type: object - additionalProperties: false - properties: - PacketHeaderStatement: - $ref: '#/components/schemas/PacketHeaderStatementRequest' - ResourceStatement: - $ref: '#/components/schemas/ResourceStatementRequest' - PacketHeaderStatementRequest: - type: object - additionalProperties: false - properties: - SourceAddresses: + InstanceGenerations: + uniqueItems: false + description: |- + Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. + For current generation instance types, specify ``current``. + For previous generation instance types, specify ``previous``. + Default: Current and previous generation instance types type: array - x-insertionOrder: true items: type: string - DestinationAddresses: + MemoryGiBPerVCpu: + description: |- + The minimum and maximum amount of memory per vCPU, in GiB. + Default: No minimum or maximum limits + $ref: '#/components/schemas/MemoryGiBPerVCpu' + AcceleratorTypes: + uniqueItems: false + description: |- + The accelerator types that must be on the instance type. + + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with GPU accelerators, specify ``gpu``. + + For instance types with Inference accelerators, specify ``inference``. + + Default: Any accelerator type type: array - x-insertionOrder: true items: type: string - SourcePorts: + VCpuCount: + description: The minimum and maximum number of vCPUs. + $ref: '#/components/schemas/VCpuCount' + AcceleratorManufacturers: + uniqueItems: false + description: |- + Indicates whether instance types must have accelerators by specific manufacturers. + + For instance types with AWS devices, specify ``amazon-web-services``. + + For instance types with AMD devices, specify ``amd``. + + For instance types with Habana devices, specify ``habana``. + + For instance types with NVIDIA devices, specify ``nvidia``. + + For instance types with Xilinx devices, specify ``xilinx``. + + Default: Any manufacturer type: array - x-insertionOrder: true items: type: string - DestinationPorts: + LocalStorage: + description: |- + Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*. + + To include instance types with instance store volumes, specify ``included``. + + To require only instance types with instance store volumes, specify ``required``. + + To exclude instance types with instance store volumes, specify ``excluded``. + + Default: ``included`` + type: string + CpuManufacturers: + uniqueItems: false + description: |- + The CPU manufacturers to include. + + For instance types with Intel CPUs, specify ``intel``. + + For instance types with AMD CPUs, specify ``amd``. + + For instance types with AWS CPUs, specify ``amazon-web-services``. + + For instance types with Apple CPUs, specify ``apple``. + + Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. + Default: Any manufacturer type: array - x-insertionOrder: true items: type: string - SourcePrefixLists: + BareMetal: + description: |- + Indicates whether bare metal instance types must be included, excluded, or required. + + To include bare metal instance types, specify ``included``. + + To require only bare metal instance types, specify ``required``. + + To exclude bare metal instance types, specify ``excluded``. + + Default: ``excluded`` + type: string + RequireHibernateSupport: + description: |- + Indicates whether instance types must support hibernation for On-Demand Instances. + This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html). + Default: ``false`` + type: boolean + MaxSpotPriceAsPercentageOfOptimalOnDemandPrice: + description: >- + [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation + instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. + type: integer + OnDemandMaxPricePercentageOverLowestPrice: + description: |- + [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + To turn off price protection, specify a high value, such as ``999999``. + This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). + If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. + Default: ``20`` + type: integer + MemoryMiB: + description: The minimum and maximum amount of memory, in MiB. + $ref: '#/components/schemas/MemoryMiB' + LocalStorageTypes: + uniqueItems: false + description: |- + The type of local storage that is required. + + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + + For instance types with solid state drive (SSD) storage, specify ``ssd``. + + Default: ``hdd`` and ``ssd`` type: array - x-insertionOrder: true items: type: string - DestinationPrefixLists: + NetworkInterfaceCount: + description: |- + The minimum and maximum number of network interfaces. + Default: No minimum or maximum limits + $ref: '#/components/schemas/NetworkInterfaceCount' + ExcludedInstanceTypes: + uniqueItems: false + description: |- + The instance types to exclude. + You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. + If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. + Default: No excluded instance types type: array - x-insertionOrder: true items: + description: The user data to make available to the instance. type: string - Protocols: - type: array - x-insertionOrder: true - items: - $ref: '#/components/schemas/Protocol' - Protocol: - type: string - enum: - - tcp - - udp - ResourceStatementRequest: - type: object - additionalProperties: false - properties: - Resources: + AllowedInstanceTypes: + uniqueItems: false + description: |- + The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. + You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. + If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. + Default: All instance types type: array - x-insertionOrder: true items: type: string - ResourceTypes: + AcceleratorCount: + description: |- + The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. + To exclude accelerator-enabled instance types, set ``Max`` to ``0``. + Default: No minimum or maximum limits + $ref: '#/components/schemas/AcceleratorCount' + NetworkBandwidthGbps: + description: |- + The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). + Default: No minimum or maximum limits + $ref: '#/components/schemas/NetworkBandwidthGbps' + BaselinePerformanceFactors: + description: >- + The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance + protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + $ref: '#/components/schemas/BaselinePerformanceFactors' + SpotMaxPricePercentageOverLowestPrice: + description: >- + [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous + generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. + This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. + Default: ``100`` + type: integer + BaselineEbsBandwidthMbps: + description: |- + The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. + Default: No minimum or maximum limits + $ref: '#/components/schemas/BaselineEbsBandwidthMbps' + AcceleratorNames: + uniqueItems: false + description: |- + The accelerators that must be on the instance type. + + For instance types with NVIDIA A10G GPUs, specify ``a10g``. + + For instance types with NVIDIA A100 GPUs, specify ``a100``. + + For instance types with NVIDIA H100 GPUs, specify ``h100``. + + For instance types with AWS Inferentia chips, specify ``inferentia``. + + For instance types with NVIDIA GRID K520 GPUs, specify ``k520``. + + For instance types with NVIDIA K80 GPUs, specify ``k80``. + + For instance types with NVIDIA M60 GPUs, specify ``m60``. + + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + + For instance types with NVIDIA T4 GPUs, specify ``t4``. + + For instance types with NVIDIA T4G GPUs, specify ``t4g``. + + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. + + For instance types with NVIDIA V100 GPUs, specify ``v100``. + + Default: Any accelerator type: array - x-insertionOrder: true items: type: string - ThroughResourcesStatementRequest: - type: object - additionalProperties: false - properties: - ResourceStatement: - $ref: '#/components/schemas/ResourceStatementRequest' - NetworkInsightsAccessScope: - type: object - properties: - NetworkInsightsAccessScopeId: + AcceleratorTotalMemoryMiB: + description: |- + The minimum and maximum amount of total accelerator memory, in MiB. + Default: No minimum or maximum limits + $ref: '#/components/schemas/AcceleratorTotalMemoryMiB' + BurstablePerformance: + description: |- + Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). + + To include burstable performance instance types, specify ``included``. + + To require only burstable performance instance types, specify ``required``. + + To exclude burstable performance instance types, specify ``excluded``. + + Default: ``excluded`` type: string - NetworkInsightsAccessScopeArn: + TotalLocalStorageGB: + description: |- + The minimum and maximum amount of total local storage, in GB. + Default: No minimum or maximum limits + $ref: '#/components/schemas/TotalLocalStorageGB' + AcceleratorTotalMemoryMiB: + description: The minimum and maximum amount of total accelerator memory, in MiB. + additionalProperties: false + type: object + properties: + Min: + description: The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. + type: integer + Max: + description: The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. + type: integer + CapacityReservationTarget: + description: |- + Specifies a target Capacity Reservation. + ``CapacityReservationTarget`` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type. + additionalProperties: false + type: object + properties: + CapacityReservationResourceGroupArn: + description: The ARN of the Capacity Reservation resource group in which to run the instance. type: string - CreatedDate: + CapacityReservationId: + description: The ID of the Capacity Reservation in which to run the instance. type: string - UpdatedDate: + CapacityReservationSpecification: + description: |- + Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time. + ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false + type: object + properties: + CapacityReservationPreference: + description: |- + Indicates the instance's Capacity Reservation preferences. Possible preferences include: + + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. type: string - Tags: - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - MatchPaths: - type: array - x-insertionOrder: true - items: - $ref: '#/components/schemas/AccessScopePathRequest' - ExcludePaths: + CapacityReservationTarget: + description: Information about the target Capacity Reservation or Capacity Reservation group. + $ref: '#/components/schemas/CapacityReservationTarget' + CreditSpecification: + description: |- + Specifies the credit option for CPU usage of a T2, T3, or T3a instance. + ``CreditSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false + type: object + properties: + CpuCredits: + description: |- + The credit option for CPU usage of a T instance. + Valid values: ``standard`` | ``unlimited`` + type: string + TotalLocalStorageGB: + description: The minimum and maximum amount of total local storage, in GB. + additionalProperties: false + type: object + properties: + Min: + description: The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. + type: number + Max: + description: The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. + type: number + ConnectionTrackingSpecification: + additionalProperties: false + type: object + properties: + UdpTimeout: + type: integer + TcpEstablishedTimeout: + type: integer + UdpStreamTimeout: + type: integer + LaunchTemplate: + type: object + properties: + LaunchTemplateName: + description: A name for the launch template. + type: string + LaunchTemplateData: + description: The information for the launch template. + $ref: '#/components/schemas/LaunchTemplateData' + VersionDescription: + description: A description for the first version of the launch template. + type: string + TagSpecifications: + uniqueItems: false + description: |- + The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. + To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). type: array - x-insertionOrder: true items: - $ref: '#/components/schemas/AccessScopePathRequest' - x-stackql-resource-name: network_insights_access_scope - x-stackql-primaryIdentifier: - - NetworkInsightsAccessScopeId + $ref: '#/components/schemas/LaunchTemplateTagSpecification' + LatestVersionNumber: + description: '' + type: string + LaunchTemplateId: + description: '' + type: string + DefaultVersionNumber: + description: '' + type: string + required: + - LaunchTemplateData + x-stackql-resource-name: launch_template + description: |- + Specifies the properties for creating a launch template. + The minimum required properties for specifying a launch template are as follows: + + You must specify at least one property for the launch template data. + + You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you. + + A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property. + For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*. + x-type-name: AWS::EC2::LaunchTemplate + x-stackql-primary-identifier: + - LaunchTemplateId x-create-only-properties: - - MatchPaths - - ExcludePaths + - LaunchTemplateName + x-write-only-properties: + - LaunchTemplateData + - VersionDescription + - TagSpecifications x-read-only-properties: - - NetworkInsightsAccessScopeId - - NetworkInsightsAccessScopeArn - - CreatedDate - - UpdatedDate + - DefaultVersionNumber + - LaunchTemplateId + - LatestVersionNumber + x-required-properties: + - LaunchTemplateData + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - ec2:DescribeLaunchTemplates create: - - ec2:CreateNetworkInsightsAccessScope + - ec2:CreateLaunchTemplate - ec2:CreateTags - - tiros:CreateQuery - read: - - ec2:DescribeNetworkInsightsAccessScopes - - ec2:GetNetworkInsightsAccessScopeContent update: - - ec2:DescribeNetworkInsightsAccessScopes - - ec2:GetNetworkInsightsAccessScopeContent - - ec2:CreateTags - - ec2:DeleteTags + - ec2:CreateLaunchTemplateVersion + list: + - ec2:DescribeLaunchTemplates delete: - - ec2:DeleteNetworkInsightsAccessScope + - ec2:DeleteLaunchTemplate - ec2:DeleteTags - list: - - ec2:DescribeNetworkInsightsAccessScopes - NetworkInsightsAccessScopeAnalysis: + - ec2:DescribeLaunchTemplates + LocalGatewayRoute: type: object properties: - NetworkInsightsAccessScopeAnalysisId: - type: string - NetworkInsightsAccessScopeAnalysisArn: - type: string - NetworkInsightsAccessScopeId: + DestinationCidrBlock: + description: The CIDR block used for destination matches. type: string - Status: + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. type: string - enum: - - running - - failed - - succeeded - StatusMessage: + LocalGatewayVirtualInterfaceGroupId: + description: The ID of the virtual interface group. type: string - StartDate: + NetworkInterfaceId: + description: The ID of the network interface. type: string - EndDate: + State: + description: The state of the route. type: string - FindingsFound: + Type: + description: The route type. type: string - enum: - - 'true' - - 'false' - - unknown - AnalyzedEniCount: - type: integer - Tags: - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - required: - - NetworkInsightsAccessScopeId - x-stackql-resource-name: network_insights_access_scope_analysis - x-stackql-primaryIdentifier: - - NetworkInsightsAccessScopeAnalysisId + x-stackql-resource-name: local_gateway_route + description: Resource Type definition for Local Gateway Route which describes a route for a local gateway route table. + x-type-name: AWS::EC2::LocalGatewayRoute + x-stackql-primary-identifier: + - DestinationCidrBlock + - LocalGatewayRouteTableId x-create-only-properties: - - NetworkInsightsAccessScopeId + - DestinationCidrBlock + - LocalGatewayRouteTableId x-read-only-properties: - - NetworkInsightsAccessScopeAnalysisId - - NetworkInsightsAccessScopeAnalysisArn - - Status - - StatusMessage - - StartDate - - EndDate - - FindingsFound - - AnalyzedEniCount + - State + - Type + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:CreateTags - - ec2:StartNetworkInsightsAccessScopeAnalysis - - ec2:GetTransitGatewayRouteTablePropagations - - ec2:Describe* - - elasticloadbalancing:Describe* - - directconnect:Describe* - - tiros:CreateQuery - - tiros:GetQueryAnswer - - tiros:GetQueryExplanation + - ec2:CreateLocalGatewayRoute + - ec2:SearchLocalGatewayRoutes read: - - ec2:DescribeNetworkInsightsAccessScopeAnalyses - update: - - ec2:DescribeNetworkInsightsAccessScopeAnalyses - - ec2:CreateTags - - ec2:DeleteTags + - ec2:SearchLocalGatewayRoutes delete: - - ec2:DeleteNetworkInsightsAccessScopeAnalysis - - ec2:DeleteTags + - ec2:DeleteLocalGatewayRoute + - ec2:SearchLocalGatewayRoutes list: - - ec2:DescribeNetworkInsightsAccessScopeAnalyses - PathComponent: - additionalProperties: false + - ec2:DescribeLocalGatewayRouteTables + - ec2:SearchLocalGatewayRoutes + update: + - ec2:ModifyLocalGatewayRoute + - ec2:SearchLocalGatewayRoutes + LocalGatewayRouteTable: type: object properties: - AdditionalDetails: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/AdditionalDetail' - InboundHeader: - $ref: '#/components/schemas/AnalysisPacketHeader' - Vpc: - $ref: '#/components/schemas/AnalysisComponent' - DestinationVpc: - $ref: '#/components/schemas/AnalysisComponent' - SecurityGroupRule: - $ref: '#/components/schemas/AnalysisSecurityGroupRule' - TransitGateway: - $ref: '#/components/schemas/AnalysisComponent' - ElasticLoadBalancerListener: - $ref: '#/components/schemas/AnalysisComponent' - Explanations: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/Explanation' - ServiceName: + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. type: string - SequenceNumber: - type: integer - SourceVpc: - $ref: '#/components/schemas/AnalysisComponent' - OutboundHeader: - $ref: '#/components/schemas/AnalysisPacketHeader' - AclRule: - $ref: '#/components/schemas/AnalysisAclRule' - TransitGatewayRouteTableRoute: - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' - Component: - $ref: '#/components/schemas/AnalysisComponent' - Subnet: - $ref: '#/components/schemas/AnalysisComponent' - RouteTableRoute: - $ref: '#/components/schemas/AnalysisRouteTableRoute' - AnalysisLoadBalancerListener: - additionalProperties: false + LocalGatewayRouteTableArn: + description: The ARN of the local gateway route table. + type: string + LocalGatewayId: + description: The ID of the local gateway. + type: string + OutpostArn: + description: The ARN of the outpost. + type: string + OwnerId: + description: The owner of the local gateway route table. + type: string + State: + description: The state of the local gateway route table. + type: string + Mode: + description: The mode of the local gateway route table. + type: string + Tags: + description: The tags for the local gateway route table. + $ref: '#/components/schemas/Tags' + required: + - LocalGatewayId + x-stackql-resource-name: local_gateway_route_table + description: Resource Type definition for Local Gateway Route Table which describes a route table for a local gateway. + x-type-name: AWS::EC2::LocalGatewayRouteTable + x-stackql-primary-identifier: + - LocalGatewayRouteTableId + x-create-only-properties: + - LocalGatewayId + - Mode + x-read-only-properties: + - LocalGatewayRouteTableId + - LocalGatewayRouteTableArn + - OutpostArn + - OwnerId + - State + x-required-properties: + - LocalGatewayId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeTags + x-required-permissions: + create: + - ec2:CreateLocalGatewayRouteTable + - ec2:DescribeLocalGatewayRouteTables + - ec2:CreateTags + read: + - ec2:DescribeLocalGatewayRouteTables + - ec2:DescribeTags + update: + - ec2:DescribeLocalGatewayRouteTables + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags + delete: + - ec2:DeleteLocalGatewayRouteTable + - ec2:DescribeLocalGatewayRouteTables + - ec2:DeleteTags + list: + - ec2:DescribeLocalGatewayRouteTables + LocalGatewayRouteTableVirtualInterfaceGroupAssociation: type: object properties: - InstancePort: - $ref: '#/components/schemas/Port' - LoadBalancerPort: - $ref: '#/components/schemas/Port' - AnalysisLoadBalancerTarget: - additionalProperties: false + LocalGatewayRouteTableVirtualInterfaceGroupAssociationId: + description: The ID of the local gateway route table virtual interface group association. + type: string + LocalGatewayId: + description: The ID of the local gateway. + type: string + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. + type: string + LocalGatewayRouteTableArn: + description: The ARN of the local gateway route table. + type: string + LocalGatewayVirtualInterfaceGroupId: + description: The ID of the local gateway route table virtual interface group. + type: string + OwnerId: + description: The owner of the local gateway route table virtual interface group association. + type: string + State: + description: The state of the local gateway route table virtual interface group association. + type: string + Tags: + description: The tags for the local gateway route table virtual interface group association. + $ref: '#/components/schemas/Tags' + required: + - LocalGatewayRouteTableId + - LocalGatewayVirtualInterfaceGroupId + x-stackql-resource-name: local_gateway_route_table_virtual_interface_group_association + description: Resource Type definition for Local Gateway Route Table Virtual Interface Group Association which describes a local gateway route table virtual interface group association for a local gateway. + x-type-name: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation + x-stackql-primary-identifier: + - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId + x-create-only-properties: + - LocalGatewayRouteTableId + - LocalGatewayVirtualInterfaceGroupId + x-read-only-properties: + - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId + - LocalGatewayId + - LocalGatewayRouteTableArn + - OwnerId + - State + x-required-properties: + - LocalGatewayRouteTableId + - LocalGatewayVirtualInterfaceGroupId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeTags + x-required-permissions: + create: + - ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation + - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations + - ec2:CreateTags + read: + - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations + - ec2:DescribeTags + update: + - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags + delete: + - ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation + - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations + - ec2:DeleteTags + list: + - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations + LocalGatewayRouteTableVPCAssociation: type: object properties: - Address: - $ref: '#/components/schemas/IpAddress' - Instance: - $ref: '#/components/schemas/AnalysisComponent' - Port: - $ref: '#/components/schemas/Port' - AvailabilityZone: + LocalGatewayId: + description: The ID of the local gateway. type: string - Explanation: + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. + type: string + LocalGatewayRouteTableVpcAssociationId: + description: The ID of the association. + type: string + State: + description: The state of the association. + type: string + VpcId: + description: The ID of the VPC. + type: string + Tags: + description: The tags for the association. + $ref: '#/components/schemas/Tags' + required: + - LocalGatewayRouteTableId + - VpcId + x-stackql-resource-name: local_gateway_route_tablevpc_association + description: Resource Type definition for Local Gateway Route Table VPC Association which describes an association between a local gateway route table and a VPC. + x-type-name: AWS::EC2::LocalGatewayRouteTableVPCAssociation + x-stackql-primary-identifier: + - LocalGatewayRouteTableVpcAssociationId + x-create-only-properties: + - LocalGatewayRouteTableId + - VpcId + x-read-only-properties: + - LocalGatewayId + - LocalGatewayRouteTableVpcAssociationId + - State + x-required-properties: + - LocalGatewayRouteTableId + - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeTags + x-required-permissions: + create: + - ec2:CreateLocalGatewayRouteTableVpcAssociation + - ec2:DescribeLocalGatewayRouteTableVpcAssociations + - ec2:CreateTags + read: + - ec2:DescribeLocalGatewayRouteTableVpcAssociations + - ec2:DescribeTags + update: + - ec2:DescribeLocalGatewayRouteTableVpcAssociations + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags + delete: + - ec2:DeleteLocalGatewayRouteTableVpcAssociation + - ec2:DescribeLocalGatewayRouteTableVpcAssociations + - ec2:DeleteTags + list: + - ec2:DescribeLocalGatewayRouteTableVpcAssociations + AvailabilityZoneAddress: + description: '' additionalProperties: false type: object properties: - VpnGateway: - $ref: '#/components/schemas/AnalysisComponent' - PacketField: + AvailabilityZone: type: string - TransitGatewayAttachment: - $ref: '#/components/schemas/AnalysisComponent' - Protocols: - uniqueItems: false + AllocationIds: + uniqueItems: true + x-insertionOrder: false + type: array + items: + type: string + required: + - AvailabilityZone + - AllocationIds + NatGateway: + type: object + properties: + SecondaryAllocationIds: + uniqueItems: true + description: Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. x-insertionOrder: true type: array items: - $ref: '#/components/schemas/Protocol' - IngressRouteTable: - $ref: '#/components/schemas/AnalysisComponent' - ClassicLoadBalancerListener: - $ref: '#/components/schemas/AnalysisLoadBalancerListener' - VpcPeeringConnection: - $ref: '#/components/schemas/AnalysisComponent' - Address: - $ref: '#/components/schemas/IpAddress' - Port: - $ref: '#/components/schemas/Port' - Addresses: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/IpAddress' - ElasticLoadBalancerListener: - $ref: '#/components/schemas/AnalysisComponent' - TransitGatewayRouteTable: - $ref: '#/components/schemas/AnalysisComponent' - ExplanationCode: + type: string + PrivateIpAddress: + description: The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. type: string - InternetGateway: - $ref: '#/components/schemas/AnalysisComponent' - SourceVpc: - $ref: '#/components/schemas/AnalysisComponent' - AttachedTo: - $ref: '#/components/schemas/AnalysisComponent' - PrefixList: - $ref: '#/components/schemas/AnalysisComponent' - TransitGatewayRouteTableRoute: - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' - ComponentRegion: + SecondaryPrivateIpAddressCount: + description: |- + [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. + ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. + type: integer + minimum: 1 + AllocationId: + description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.' type: string - LoadBalancerTargetGroup: - $ref: '#/components/schemas/AnalysisComponent' - NetworkInterface: - $ref: '#/components/schemas/AnalysisComponent' - CustomerGateway: - $ref: '#/components/schemas/AnalysisComponent' - DestinationVpc: - $ref: '#/components/schemas/AnalysisComponent' - SecurityGroup: - $ref: '#/components/schemas/AnalysisComponent' - TransitGateway: - $ref: '#/components/schemas/AnalysisComponent' - RouteTable: - $ref: '#/components/schemas/AnalysisComponent' - State: + SubnetId: + description: The ID of the subnet in which the NAT gateway is located. type: string - LoadBalancerListenerPort: - $ref: '#/components/schemas/Port' - vpcEndpoint: - $ref: '#/components/schemas/AnalysisComponent' - Subnet: - $ref: '#/components/schemas/AnalysisComponent' - Cidrs: - uniqueItems: false + ConnectivityType: + description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. + type: string + SecondaryPrivateIpAddresses: + uniqueItems: true + description: |- + Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. + ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. x-insertionOrder: true type: array items: type: string - Destination: - $ref: '#/components/schemas/AnalysisComponent' - SecurityGroups: + NatGatewayId: + description: '' + type: string + Tags: uniqueItems: false - x-insertionOrder: true + description: The tags for the NAT gateway. + x-insertionOrder: false type: array items: - $ref: '#/components/schemas/AnalysisComponent' - ComponentAccount: + $ref: '#/components/schemas/Tag' + MaxDrainDurationSeconds: + description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. + type: integer + x-stackql-resource-name: nat_gateway + description: |- + Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address. + With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*. + If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property. + When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*. + x-type-name: AWS::EC2::NatGateway + x-stackql-primary-identifier: + - NatGatewayId + x-create-only-properties: + - SubnetId + - ConnectivityType + - AllocationId + - PrivateIpAddress + x-write-only-properties: + - MaxDrainDurationSeconds + x-read-only-properties: + - NatGatewayId + x-tagging: + permissions: + - ec2:DeleteTags + - ec2:CreateTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - ec2:DescribeNatGateways + create: + - ec2:CreateNatGateway + - ec2:DescribeNatGateways + - ec2:CreateTags + update: + - ec2:DescribeNatGateways + - ec2:CreateTags + - ec2:DeleteTags + - ec2:AssociateNatGatewayAddress + - ec2:DisassociateNatGatewayAddress + - ec2:AssignPrivateNatGatewayAddress + - ec2:UnassignPrivateNatGatewayAddress + list: + - ec2:DescribeNatGateways + delete: + - ec2:DeleteNatGateway + - ec2:DescribeNatGateways + NetworkAcl: + type: object + properties: + VpcId: + description: The ID of the VPC for the network ACL. type: string - VpnConnection: - $ref: '#/components/schemas/AnalysisComponent' - Vpc: - $ref: '#/components/schemas/AnalysisComponent' - NatGateway: - $ref: '#/components/schemas/AnalysisComponent' - Direction: + Id: + description: '' type: string - LoadBalancerTargetPort: - $ref: '#/components/schemas/Port' - LoadBalancerTarget: - $ref: '#/components/schemas/AnalysisLoadBalancerTarget' - LoadBalancerTargetGroups: + Tags: uniqueItems: false - x-insertionOrder: true + description: The tags for the network ACL. + x-insertionOrder: false type: array items: - $ref: '#/components/schemas/AnalysisComponent' - Component: - $ref: '#/components/schemas/AnalysisComponent' - MissingComponent: - type: string - RouteTableRoute: - $ref: '#/components/schemas/AnalysisRouteTableRoute' - AvailabilityZones: - uniqueItems: false - x-insertionOrder: true + $ref: '#/components/schemas/Tag' + required: + - VpcId + x-stackql-resource-name: network_acl + description: |- + Specifies a network ACL for your VPC. + To add a network ACL entry, see [AWS::EC2::NetworkAclEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkaclentry.html). + x-type-name: AWS::EC2::NetworkAcl + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - VpcId + x-read-only-properties: + - Id + x-required-properties: + - VpcId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - ec2:DescribeNetworkAcls + - ec2:DescribeTags + create: + - ec2:CreateNetworkAcl + - ec2:DescribeNetworkAcls + - ec2:CreateTags + update: + - ec2:DescribeNetworkAcls + - ec2:DeleteTags + - ec2:CreateTags + list: + - ec2:DescribeNetworkAcls + delete: + - ec2:DeleteTags + - ec2:DeleteNetworkAcl + - ec2:DescribeNetworkAcls + AccessScopePathRequest: + type: object + additionalProperties: false + properties: + Source: + $ref: '#/components/schemas/PathStatementRequest' + Destination: + $ref: '#/components/schemas/PathStatementRequest' + ThroughResources: type: array - items: - type: string - PortRanges: - uniqueItems: false x-insertionOrder: true - type: array items: - $ref: '#/components/schemas/PortRange' - Acl: - $ref: '#/components/schemas/AnalysisComponent' - SecurityGroupRule: - $ref: '#/components/schemas/AnalysisSecurityGroupRule' - SubnetRouteTable: - $ref: '#/components/schemas/AnalysisComponent' - LoadBalancerArn: - $ref: '#/components/schemas/ResourceArn' - AclRule: - $ref: '#/components/schemas/AnalysisAclRule' - Port: - type: integer - AnalysisPacketHeader: + $ref: '#/components/schemas/ThroughResourcesStatementRequest' + PathStatementRequest: + type: object additionalProperties: false + properties: + PacketHeaderStatement: + $ref: '#/components/schemas/PacketHeaderStatementRequest' + ResourceStatement: + $ref: '#/components/schemas/ResourceStatementRequest' + PacketHeaderStatementRequest: type: object + additionalProperties: false properties: - DestinationPortRanges: - uniqueItems: false - x-insertionOrder: true + SourceAddresses: type: array - items: - $ref: '#/components/schemas/PortRange' - SourcePortRanges: - uniqueItems: false x-insertionOrder: true - type: array items: - $ref: '#/components/schemas/PortRange' + type: string DestinationAddresses: - uniqueItems: false + type: array x-insertionOrder: true + items: + type: string + SourcePorts: type: array + x-insertionOrder: true items: - $ref: '#/components/schemas/IpAddress' - Protocol: - $ref: '#/components/schemas/Protocol' - SourceAddresses: - uniqueItems: false + type: string + DestinationPorts: + type: array x-insertionOrder: true + items: + type: string + SourcePrefixLists: type: array + x-insertionOrder: true items: - $ref: '#/components/schemas/IpAddress' - AdditionalDetail: - additionalProperties: false - type: object - properties: - ServiceName: - type: string - AdditionalDetailType: - type: string - LoadBalancers: - uniqueItems: false + type: string + DestinationPrefixLists: + type: array x-insertionOrder: true + items: + type: string + Protocols: type: array + x-insertionOrder: true items: - $ref: '#/components/schemas/AnalysisComponent' - Component: - $ref: '#/components/schemas/AnalysisComponent' - AlternatePathHint: - additionalProperties: false + $ref: '#/components/schemas/Protocol' + Protocol: + type: string + enum: + - tcp + - udp + ResourceStatementRequest: type: object - properties: - ComponentArn: - type: string - ComponentId: - type: string - TransitGatewayRouteTableRoute: additionalProperties: false - type: object properties: - PrefixListId: - type: string - ResourceId: - type: string - State: - type: string - ResourceType: - type: string - RouteOrigin: - type: string - DestinationCidr: - type: string - AttachmentId: - type: string - AnalysisSecurityGroupRule: - additionalProperties: false + Resources: + type: array + x-insertionOrder: true + items: + type: string + ResourceTypes: + type: array + x-insertionOrder: true + items: + type: string + ThroughResourcesStatementRequest: type: object - properties: - PortRange: - $ref: '#/components/schemas/PortRange' - Cidr: - type: string - PrefixListId: - type: string - SecurityGroupId: - type: string - Protocol: - $ref: '#/components/schemas/Protocol' - Direction: - type: string - AnalysisComponent: additionalProperties: false + properties: + ResourceStatement: + $ref: '#/components/schemas/ResourceStatementRequest' + NetworkInsightsAccessScope: type: object properties: - Id: + NetworkInsightsAccessScopeId: type: string - Arn: + NetworkInsightsAccessScopeArn: type: string - AnalysisAclRule: - additionalProperties: false - type: object - properties: - PortRange: - $ref: '#/components/schemas/PortRange' - Cidr: + CreatedDate: type: string - RuleAction: + UpdatedDate: type: string - Egress: - type: boolean - RuleNumber: - type: integer - Protocol: - $ref: '#/components/schemas/Protocol' - AnalysisRouteTableRoute: - additionalProperties: false + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + MatchPaths: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/AccessScopePathRequest' + ExcludePaths: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/AccessScopePathRequest' + x-stackql-resource-name: network_insights_access_scope + description: Resource schema for AWS::EC2::NetworkInsightsAccessScope + x-type-name: AWS::EC2::NetworkInsightsAccessScope + x-stackql-primary-identifier: + - NetworkInsightsAccessScopeId + x-stackql-additional-identifiers: + - - NetworkInsightsAccessScopeArn + x-create-only-properties: + - MatchPaths + - ExcludePaths + x-write-only-properties: + - MatchPaths + - ExcludePaths + x-read-only-properties: + - NetworkInsightsAccessScopeId + - NetworkInsightsAccessScopeArn + - CreatedDate + - UpdatedDate + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateNetworkInsightsAccessScope + - ec2:CreateTags + - tiros:CreateQuery + read: + - ec2:DescribeNetworkInsightsAccessScopes + - ec2:GetNetworkInsightsAccessScopeContent + update: + - ec2:DescribeNetworkInsightsAccessScopes + - ec2:GetNetworkInsightsAccessScopeContent + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteNetworkInsightsAccessScope + - ec2:DeleteTags + list: + - ec2:DescribeNetworkInsightsAccessScopes + NetworkInsightsAccessScopeAnalysis: type: object properties: - Origin: - type: string - destinationPrefixListId: - type: string - destinationCidr: - type: string - NetworkInterfaceId: - type: string - TransitGatewayId: - type: string - VpcPeeringConnectionId: - type: string - instanceId: - type: string - State: - type: string - egressOnlyInternetGatewayId: + NetworkInsightsAccessScopeAnalysisId: type: string - NatGatewayId: + NetworkInsightsAccessScopeAnalysisArn: type: string - gatewayId: + NetworkInsightsAccessScopeId: type: string - ResourceArn: - type: string - IpAddress: - type: string - NetworkInsightsAnalysis: - type: object - properties: Status: type: string enum: - running - failed - succeeded - ReturnPathComponents: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/PathComponent' - NetworkInsightsAnalysisId: - type: string - NetworkInsightsPathId: - type: string - NetworkPathFound: - type: boolean - SuggestedAccounts: - uniqueItems: true - x-insertionOrder: true - type: array - items: - type: string - FilterInArns: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/ResourceArn' - NetworkInsightsAnalysisArn: - type: string StatusMessage: type: string StartDate: type: string - AlternatePathHints: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/AlternatePathHint' - Explanations: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/Explanation' - ForwardPathComponents: - uniqueItems: false - x-insertionOrder: true - type: array - items: - $ref: '#/components/schemas/PathComponent' - AdditionalAccounts: - uniqueItems: true - x-insertionOrder: true - type: array - items: - type: string + EndDate: + type: string + FindingsFound: + type: string + enum: + - 'true' + - 'false' + - unknown + AnalyzedEniCount: + type: integer Tags: - uniqueItems: true type: array + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - - NetworkInsightsPathId - x-stackql-resource-name: network_insights_analysis - x-stackql-primaryIdentifier: - - NetworkInsightsAnalysisId + - NetworkInsightsAccessScopeId + x-stackql-resource-name: network_insights_access_scope_analysis + description: Resource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis + x-type-name: AWS::EC2::NetworkInsightsAccessScopeAnalysis + x-stackql-primary-identifier: + - NetworkInsightsAccessScopeAnalysisId + x-stackql-additional-identifiers: + - - NetworkInsightsAccessScopeAnalysisArn x-create-only-properties: - - NetworkInsightsPathId - - FilterInArns + - NetworkInsightsAccessScopeId x-read-only-properties: - - NetworkInsightsAnalysisId - - NetworkInsightsAnalysisArn - - StartDate + - NetworkInsightsAccessScopeAnalysisId + - NetworkInsightsAccessScopeAnalysisArn - Status - StatusMessage - - ErrorCode - - ErrorMessage - - NetworkPathFound - - ForwardPathComponents - - ReturnPathComponents - - Explanations - - AlternatePathHints - - SuggestedAccounts + - StartDate + - EndDate + - FindingsFound + - AnalyzedEniCount + x-required-properties: + - NetworkInsightsAccessScopeId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: - read: - - ec2:Describe* create: - ec2:CreateTags - - ec2:StartNetworkInsightsAnalysis + - ec2:StartNetworkInsightsAccessScopeAnalysis - ec2:GetTransitGatewayRouteTablePropagations - - ec2:SearchTransitGatewayRoutes - ec2:Describe* - - ec2:GetManagedPrefixListEntries - elasticloadbalancing:Describe* - directconnect:Describe* - tiros:CreateQuery - tiros:GetQueryAnswer - tiros:GetQueryExplanation + read: + - ec2:DescribeNetworkInsightsAccessScopeAnalyses update: + - ec2:DescribeNetworkInsightsAccessScopeAnalyses - ec2:CreateTags - - ec2:Describe* - ec2:DeleteTags - list: - - ec2:Describe* delete: - - ec2:DeleteNetworkInsightsAnalysis + - ec2:DeleteNetworkInsightsAccessScopeAnalysis - ec2:DeleteTags - FilterPortRange: - type: object + list: + - ec2:DescribeNetworkInsightsAccessScopeAnalyses + PathComponent: additionalProperties: false + type: object properties: - FromPort: - type: integer - ToPort: + AdditionalDetails: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AdditionalDetail' + InboundHeader: + $ref: '#/components/schemas/AnalysisPacketHeader' + Vpc: + $ref: '#/components/schemas/AnalysisComponent' + DestinationVpc: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroupRule: + $ref: '#/components/schemas/AnalysisSecurityGroupRule' + TransitGateway: + $ref: '#/components/schemas/AnalysisComponent' + ElasticLoadBalancerListener: + $ref: '#/components/schemas/AnalysisComponent' + Explanations: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Explanation' + ServiceName: + type: string + SequenceNumber: type: integer - PathFilter: + SourceVpc: + $ref: '#/components/schemas/AnalysisComponent' + OutboundHeader: + $ref: '#/components/schemas/AnalysisPacketHeader' + AclRule: + $ref: '#/components/schemas/AnalysisAclRule' + TransitGatewayRouteTableRoute: + $ref: '#/components/schemas/TransitGatewayRouteTableRoute' + Component: + $ref: '#/components/schemas/AnalysisComponent' + Subnet: + $ref: '#/components/schemas/AnalysisComponent' + RouteTableRoute: + $ref: '#/components/schemas/AnalysisRouteTableRoute' + AnalysisLoadBalancerListener: + additionalProperties: false type: object + properties: + InstancePort: + $ref: '#/components/schemas/Port' + LoadBalancerPort: + $ref: '#/components/schemas/Port' + AnalysisLoadBalancerTarget: additionalProperties: false + type: object properties: - SourceAddress: - $ref: '#/components/schemas/IpAddress' - SourcePortRange: - $ref: '#/components/schemas/FilterPortRange' - DestinationAddress: + Address: $ref: '#/components/schemas/IpAddress' - DestinationPortRange: - $ref: '#/components/schemas/FilterPortRange' - NetworkInsightsPath: + Instance: + $ref: '#/components/schemas/AnalysisComponent' + Port: + $ref: '#/components/schemas/Port' + AvailabilityZone: + type: string + Explanation: + additionalProperties: false type: object properties: - NetworkInsightsPathId: - type: string - NetworkInsightsPathArn: - type: string - CreatedDate: + VpnGateway: + $ref: '#/components/schemas/AnalysisComponent' + PacketField: type: string - SourceIp: - $ref: '#/components/schemas/IpAddress' - FilterAtSource: - $ref: '#/components/schemas/PathFilter' - FilterAtDestination: - $ref: '#/components/schemas/PathFilter' - DestinationIp: + TransitGatewayAttachment: + $ref: '#/components/schemas/AnalysisComponent' + Protocols: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Protocol' + IngressRouteTable: + $ref: '#/components/schemas/AnalysisComponent' + ClassicLoadBalancerListener: + $ref: '#/components/schemas/AnalysisLoadBalancerListener' + VpcPeeringConnection: + $ref: '#/components/schemas/AnalysisComponent' + Address: $ref: '#/components/schemas/IpAddress' - Source: - type: string - Destination: + Port: + $ref: '#/components/schemas/Port' + Addresses: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + ElasticLoadBalancerListener: + $ref: '#/components/schemas/AnalysisComponent' + TransitGatewayRouteTable: + $ref: '#/components/schemas/AnalysisComponent' + ExplanationCode: type: string - SourceArn: + InternetGateway: + $ref: '#/components/schemas/AnalysisComponent' + SourceVpc: + $ref: '#/components/schemas/AnalysisComponent' + AttachedTo: + $ref: '#/components/schemas/AnalysisComponent' + PrefixList: + $ref: '#/components/schemas/AnalysisComponent' + TransitGatewayRouteTableRoute: + $ref: '#/components/schemas/TransitGatewayRouteTableRoute' + ComponentRegion: type: string - DestinationArn: + LoadBalancerTargetGroup: + $ref: '#/components/schemas/AnalysisComponent' + NetworkInterface: + $ref: '#/components/schemas/AnalysisComponent' + CustomerGateway: + $ref: '#/components/schemas/AnalysisComponent' + DestinationVpc: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroup: + $ref: '#/components/schemas/AnalysisComponent' + TransitGateway: + $ref: '#/components/schemas/AnalysisComponent' + RouteTable: + $ref: '#/components/schemas/AnalysisComponent' + State: type: string - Protocol: - $ref: '#/components/schemas/Protocol' - DestinationPort: + LoadBalancerListenerPort: $ref: '#/components/schemas/Port' - Tags: + vpcEndpoint: + $ref: '#/components/schemas/AnalysisComponent' + Subnet: + $ref: '#/components/schemas/AnalysisComponent' + Cidrs: + uniqueItems: false + x-insertionOrder: true type: array - x-insertionOrder: false items: - $ref: '#/components/schemas/Tag' - required: - - Protocol - - Source - x-stackql-resource-name: network_insights_path - x-stackql-primaryIdentifier: - - NetworkInsightsPathId - x-create-only-properties: - - SourceIp - - DestinationIp - - Source - - Destination - - Protocol - - DestinationPort - - FilterAtSource - - FilterAtDestination - x-read-only-properties: - - NetworkInsightsPathId - - NetworkInsightsPathArn - - CreatedDate - - SourceArn - - DestinationArn - x-required-permissions: - create: - - ec2:CreateNetworkInsightsPath - - ec2:CreateTags - delete: - - ec2:DeleteNetworkInsightsPath - - ec2:DeleteTags - read: - - ec2:DescribeNetworkInsightsPaths - list: - - ec2:DescribeNetworkInsightsPaths - update: - - ec2:DescribeNetworkInsightsPaths - - ec2:CreateTags - - ec2:DeleteTags - PrivateIpAddressSpecification: - type: object - additionalProperties: false - properties: - Primary: - type: boolean - PrivateIpAddress: + type: string + Destination: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroups: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AnalysisComponent' + ComponentAccount: type: string - required: - - PrivateIpAddress - InstanceIpv6Address: - type: object - additionalProperties: false - properties: - Ipv6Address: + VpnConnection: + $ref: '#/components/schemas/AnalysisComponent' + Vpc: + $ref: '#/components/schemas/AnalysisComponent' + NatGateway: + $ref: '#/components/schemas/AnalysisComponent' + Direction: type: string - required: - - Ipv6Address - NetworkInterfaceAttachment: + LoadBalancerTargetPort: + $ref: '#/components/schemas/Port' + LoadBalancerTarget: + $ref: '#/components/schemas/AnalysisLoadBalancerTarget' + LoadBalancerTargetGroups: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AnalysisComponent' + Component: + $ref: '#/components/schemas/AnalysisComponent' + MissingComponent: + type: string + RouteTableRoute: + $ref: '#/components/schemas/AnalysisRouteTableRoute' + AvailabilityZones: + uniqueItems: false + x-insertionOrder: true + type: array + items: + type: string + PortRanges: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PortRange' + Acl: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroupRule: + $ref: '#/components/schemas/AnalysisSecurityGroupRule' + SubnetRouteTable: + $ref: '#/components/schemas/AnalysisComponent' + LoadBalancerArn: + $ref: '#/components/schemas/ResourceArn' + AclRule: + $ref: '#/components/schemas/AnalysisAclRule' + Port: + type: integer + AnalysisPacketHeader: + additionalProperties: false type: object properties: - AttachmentId: - description: The ID of the network interface attachment. + DestinationPortRanges: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PortRange' + SourcePortRanges: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PortRange' + DestinationAddresses: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + Protocol: + $ref: '#/components/schemas/Protocol' + SourceAddresses: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + AdditionalDetail: + additionalProperties: false + type: object + properties: + ServiceName: type: string - DeleteOnTermination: - description: Whether to delete the network interface when the instance terminates. By default, this value is set to true. - type: boolean - default: true - DeviceIndex: - description: The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0. + AdditionalDetailType: type: string - InstanceId: - description: The ID of the instance to which you will attach the ENI. + LoadBalancers: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AnalysisComponent' + Component: + $ref: '#/components/schemas/AnalysisComponent' + AlternatePathHint: + additionalProperties: false + type: object + properties: + ComponentArn: type: string - NetworkInterfaceId: - description: The ID of the ENI that you want to attach. + ComponentId: type: string - EnaSrdSpecification: - $ref: '#/components/schemas/EnaSrdSpecification' - required: - - DeviceIndex - - InstanceId - - NetworkInterfaceId - x-stackql-resource-name: network_interface_attachment - x-stackql-primaryIdentifier: - - AttachmentId - x-create-only-properties: - - DeviceIndex - - InstanceId - - NetworkInterfaceId - x-read-only-properties: - - AttachmentId - x-required-permissions: - create: - - ec2:AttachNetworkInterface - - ec2:DescribeNetworkInterfaces - - ec2:ModifyNetworkInterfaceAttribute - read: - - ec2:DescribeNetworkInterfaces - list: - - ec2:DescribeNetworkInterfaces - update: - - ec2:ModifyNetworkInterfaceAttribute - - ec2:DescribeNetworkInterfaces - - ec2:AttachNetworkInterface - - ec2:DetachNetworkInterface - delete: - - ec2:DetachNetworkInterface - - ec2:DescribeNetworkInterfaces - NetworkPerformanceMetricSubscription: + TransitGatewayRouteTableRoute: + additionalProperties: false type: object properties: - Source: - description: The starting Region or Availability Zone for metric to subscribe to. + PrefixListId: type: string - Destination: - description: The target Region or Availability Zone for the metric to subscribe to. + ResourceId: type: string - Metric: - description: The metric type to subscribe to. + State: type: string - Statistic: - description: The statistic to subscribe to. + ResourceType: type: string - required: - - Source - - Destination - - Metric - - Statistic - x-stackql-resource-name: network_performance_metric_subscription - x-stackql-primaryIdentifier: - - Source - - Destination - - Metric - - Statistic - x-create-only-properties: - - Source - - Destination - - Metric - - Statistic - x-required-permissions: - create: - - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions - - ec2:EnableAwsNetworkPerformanceMetricSubscription - read: - - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions - delete: - - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions - - ec2:DisableAwsNetworkPerformanceMetricSubscription - list: - - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions - PlacementGroup: - type: object - properties: - Strategy: - description: The placement strategy. + RouteOrigin: type: string - GroupName: - description: The Group Name of Placement Group. + DestinationCidr: type: string - SpreadLevel: - description: The Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread + AttachmentId: type: string - PartitionCount: - description: The number of partitions. Valid only when **Strategy** is set to `partition` - type: integer - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - x-stackql-resource-name: placement_group - x-stackql-primaryIdentifier: - - GroupName - x-create-only-properties: - - Tags - - Strategy - - SpreadLevel - - PartitionCount - x-read-only-properties: - - GroupName - x-required-permissions: - create: - - ec2:CreatePlacementGroup - - ec2:DescribePlacementGroups - - ec2:CreateTags - read: - - ec2:DescribePlacementGroups - delete: - - ec2:DeletePlacementGroup - - ec2:DescribePlacementGroups - list: - - ec2:DescribePlacementGroups - Entry: + AnalysisSecurityGroupRule: + additionalProperties: false type: object properties: + PortRange: + $ref: '#/components/schemas/PortRange' Cidr: type: string - minLength: 1 - maxLength: 46 - Description: + PrefixListId: type: string - minLength: 0 - maxLength: 255 - required: - - Cidr + SecurityGroupId: + type: string + Protocol: + $ref: '#/components/schemas/Protocol' + Direction: + type: string + AnalysisComponent: additionalProperties: false - PrefixList: type: object properties: - PrefixListName: - description: Name of Prefix List. + Id: type: string - minLength: 1 - maxLength: 255 - PrefixListId: - description: Id of Prefix List. + Arn: type: string - OwnerId: - description: Owner Id of Prefix List. + AnalysisAclRule: + additionalProperties: false + type: object + properties: + PortRange: + $ref: '#/components/schemas/PortRange' + Cidr: type: string - AddressFamily: - description: Ip Version of Prefix List. + RuleAction: type: string - enum: - - IPv4 - - IPv6 - MaxEntries: - description: Max Entries of Prefix List. - type: integer - minimum: 1 - Version: - description: Version of Prefix List. + Egress: + type: boolean + RuleNumber: type: integer - Tags: - description: Tags for Prefix List - type: array - items: - $ref: '#/components/schemas/Tag' - Entries: - description: Entries of Prefix List. - type: array - items: - $ref: '#/components/schemas/Entry' - Arn: - description: The Amazon Resource Name (ARN) of the Prefix List. - type: string - required: - - PrefixListName - - AddressFamily - x-stackql-resource-name: prefix_list - x-stackql-primaryIdentifier: - - PrefixListId - x-read-only-properties: - - PrefixListId - - OwnerId - - Version - - Arn - x-required-permissions: - create: - - EC2:CreateManagedPrefixList - - EC2:DescribeManagedPrefixLists - - EC2:CreateTags - read: - - EC2:GetManagedPrefixListEntries - - EC2:DescribeManagedPrefixLists - update: - - EC2:DescribeManagedPrefixLists - - EC2:GetManagedPrefixListEntries - - EC2:ModifyManagedPrefixList - - EC2:CreateTags - - EC2:DeleteTags - delete: - - EC2:DeleteManagedPrefixList - - EC2:DescribeManagedPrefixLists - list: - - EC2:DescribeManagedPrefixLists - - EC2:GetManagedPrefixListEntries - Route: + Protocol: + $ref: '#/components/schemas/Protocol' + AnalysisRouteTableRoute: + additionalProperties: false type: object properties: - CarrierGatewayId: - type: string - description: The ID of the carrier gateway. - CidrBlock: + Origin: type: string - description: The primary identifier of the resource generated by the service. - CoreNetworkArn: + destinationPrefixListId: type: string - description: The Amazon Resource Name (ARN) of the core network. - DestinationCidrBlock: + destinationCidr: type: string - description: The IPv4 CIDR block used for the destination match. - DestinationIpv6CidrBlock: + NetworkInterfaceId: type: string - description: The IPv6 CIDR block used for the destination match. - DestinationPrefixListId: + TransitGatewayId: type: string - description: The ID of managed prefix list, it's a set of one or more CIDR blocks. - EgressOnlyInternetGatewayId: + VpcPeeringConnectionId: type: string - description: The ID of the egress-only internet gateway. - GatewayId: + instanceId: type: string - description: The ID of an internet gateway or virtual private gateway attached to your VPC. - InstanceId: + State: type: string - description: The ID of a NAT instance in your VPC. - LocalGatewayId: + egressOnlyInternetGatewayId: type: string - description: The ID of the local gateway. NatGatewayId: type: string - description: The ID of a NAT gateway. - NetworkInterfaceId: + gatewayId: type: string - description: The ID of the network interface. - RouteTableId: + ResourceArn: + type: string + PortRange: + description: The IP port range. + type: object + properties: + FromPort: + description: The first port in the range. + type: integer + minimum: 1 + maximum: 65535 + ToPort: + description: The last port in the range. + type: integer + minimum: 1 + maximum: 65535 + additionalProperties: false + IpAddress: + type: string + NetworkInsightsAnalysis: + type: object + properties: + Status: type: string - description: The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. - TransitGatewayId: + enum: + - running + - failed + - succeeded + ReturnPathComponents: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PathComponent' + NetworkInsightsAnalysisId: type: string - description: The ID of a transit gateway. - VpcEndpointId: + FilterOutArns: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/ResourceArn' + NetworkInsightsPathId: type: string - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. - VpcPeeringConnectionId: + NetworkPathFound: + type: boolean + SuggestedAccounts: + uniqueItems: true + x-insertionOrder: true + type: array + items: + type: string + FilterInArns: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/ResourceArn' + NetworkInsightsAnalysisArn: type: string - description: The ID of a VPC peering connection. - required: - - RouteTableId - x-stackql-resource-name: route - x-stackql-primaryIdentifier: - - RouteTableId - - CidrBlock - x-create-only-properties: - - RouteTableId - - DestinationCidrBlock - - DestinationIpv6CidrBlock - - DestinationPrefixListId - x-read-only-properties: - - CidrBlock - x-required-permissions: - create: - - ec2:CreateRoute - - ec2:DescribeRouteTables - - ec2:DescribeNetworkInterfaces - read: - - ec2:DescribeRouteTables - update: - - ec2:ReplaceRoute - - ec2:DescribeRouteTables - - ec2:DescribeNetworkInterfaces - delete: - - ec2:DeleteRoute - - ec2:DescribeRouteTables - list: - - ec2:DescribeRouteTables - RouteTable: - type: object - properties: - RouteTableId: - description: '' + StatusMessage: type: string - Tags: - description: Any tags assigned to the route table. + StartDate: + type: string + AlternatePathHints: + uniqueItems: false + x-insertionOrder: true type: array + items: + $ref: '#/components/schemas/AlternatePathHint' + Explanations: uniqueItems: false - x-insertionOrder: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Explanation' + ForwardPathComponents: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PathComponent' + AdditionalAccounts: + uniqueItems: true + x-insertionOrder: true + type: array + items: + type: string + Tags: + uniqueItems: true + type: array items: $ref: '#/components/schemas/Tag' - VpcId: - description: The ID of the VPC. - type: string required: - - VpcId - x-stackql-resource-name: route_table - x-stackql-primaryIdentifier: - - RouteTableId + - NetworkInsightsPathId + x-stackql-resource-name: network_insights_analysis + description: Resource schema for AWS::EC2::NetworkInsightsAnalysis + x-type-name: AWS::EC2::NetworkInsightsAnalysis + x-stackql-primary-identifier: + - NetworkInsightsAnalysisId + x-stackql-additional-identifiers: + - - NetworkInsightsAnalysisArn x-create-only-properties: - - VpcId + - NetworkInsightsPathId + - FilterInArns + - FilterOutArns x-read-only-properties: - - RouteTableId + - NetworkInsightsAnalysisId + - NetworkInsightsAnalysisArn + - StartDate + - Status + - StatusMessage + - NetworkPathFound + - ForwardPathComponents + - ReturnPathComponents + - Explanations + - AlternatePathHints + - SuggestedAccounts + x-required-properties: + - NetworkInsightsPathId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - ec2:Describe* create: - - ec2:CreateRouteTable - ec2:CreateTags - - ec2:DescribeRouteTables - read: - - ec2:DescribeRouteTables + - ec2:StartNetworkInsightsAnalysis + - ec2:GetTransitGatewayRouteTablePropagations + - ec2:SearchTransitGatewayRoutes + - ec2:Describe* + - ec2:GetManagedPrefixListEntries + - elasticloadbalancing:Describe* + - directconnect:Describe* + - tiros:CreateQuery + - tiros:GetQueryAnswer + - tiros:GetQueryExplanation update: - ec2:CreateTags + - ec2:Describe* - ec2:DeleteTags - - ec2:DescribeRouteTables - delete: - - ec2:DescribeRouteTables - - ec2:DeleteRouteTable list: - - ec2:DescribeRouteTables - SecurityGroupEgress: + - ec2:Describe* + delete: + - ec2:DeleteNetworkInsightsAnalysis + - ec2:DeleteTags + FilterPortRange: type: object + additionalProperties: false properties: - CidrIp: - description: |- - The IPv4 address range, in CIDR format. - You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``). - For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*. - type: string - CidrIpv6: - description: |- - The IPv6 address range, in CIDR format. - You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``). - For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*. - type: string - Description: - description: |- - The description of an egress (outbound) security group rule. - Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* - type: string FromPort: - description: If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). type: integer ToPort: - description: If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). type: integer - IpProtocol: - description: |- - The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). - Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + PathFilter: + type: object + additionalProperties: false + properties: + SourceAddress: + $ref: '#/components/schemas/IpAddress' + SourcePortRange: + $ref: '#/components/schemas/FilterPortRange' + DestinationAddress: + $ref: '#/components/schemas/IpAddress' + DestinationPortRange: + $ref: '#/components/schemas/FilterPortRange' + NetworkInsightsPath: + type: object + properties: + NetworkInsightsPathId: type: string - DestinationSecurityGroupId: - description: |- - The ID of the security group. - You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``). + NetworkInsightsPathArn: type: string - Id: - description: '' + CreatedDate: type: string - DestinationPrefixListId: - description: |- - The prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. - You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``). + SourceIp: + $ref: '#/components/schemas/IpAddress' + FilterAtSource: + $ref: '#/components/schemas/PathFilter' + FilterAtDestination: + $ref: '#/components/schemas/PathFilter' + DestinationIp: + $ref: '#/components/schemas/IpAddress' + Source: type: string - GroupId: - description: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + Destination: + type: string + SourceArn: type: string + DestinationArn: + type: string + Protocol: + $ref: '#/components/schemas/Protocol' + DestinationPort: + $ref: '#/components/schemas/Port' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - - IpProtocol - - GroupId - x-stackql-resource-name: security_group_egress - x-stackql-primaryIdentifier: - - Id + - Protocol + - Source + x-stackql-resource-name: network_insights_path + description: Resource schema for AWS::EC2::NetworkInsightsPath + x-type-name: AWS::EC2::NetworkInsightsPath + x-stackql-primary-identifier: + - NetworkInsightsPathId + x-stackql-additional-identifiers: + - - NetworkInsightsPathArn x-create-only-properties: - - IpProtocol - - DestinationSecurityGroupId - - ToPort - - CidrIp - - FromPort - - GroupId - - CidrIpv6 - - DestinationPrefixListId + - SourceIp + - DestinationIp + - Source + - Destination + - Protocol + - DestinationPort + - FilterAtSource + - FilterAtDestination x-read-only-properties: - - Id + - NetworkInsightsPathId + - NetworkInsightsPathArn + - CreatedDate + - SourceArn + - DestinationArn + x-required-properties: + - Protocol + - Source + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: - read: - - ec2:DescribeSecurityGroupRules create: - - ec2:AuthorizeSecurityGroupEgress - - ec2:RevokeSecurityGroupEgress - - ec2:DescribeSecurityGroupRules - update: - - ec2:UpdateSecurityGroupRuleDescriptionsEgress - list: - - ec2:DescribeSecurityGroupRules + - ec2:CreateNetworkInsightsPath + - ec2:CreateTags delete: - - ec2:RevokeSecurityGroupEgress - - ec2:DescribeSecurityGroupRules - SecurityGroupIngress: + - ec2:DeleteNetworkInsightsPath + - ec2:DeleteTags + read: + - ec2:DescribeNetworkInsightsPaths + list: + - ec2:DescribeNetworkInsightsPaths + update: + - ec2:DescribeNetworkInsightsPaths + - ec2:CreateTags + - ec2:DeleteTags + NetworkInterfaceAttachment: type: object properties: - Id: - description: The Security Group Rule Id - type: string - CidrIp: - description: The IPv4 ranges - type: string - CidrIpv6: - description: '[VPC only] The IPv6 ranges' - type: string - Description: - description: Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously - type: string - FromPort: - description: |- - The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. - - Use this for ICMP and any protocol that uses ports. - type: integer - GroupId: - description: |- - The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. - - You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. - type: string - GroupName: - description: The name of the security group. - type: string - IpProtocol: - description: |- - The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers). - - [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. - type: string - SourcePrefixListId: - description: |+ - [EC2-VPC only] The ID of a prefix list. - + AttachmentId: + description: '' type: string - SourceSecurityGroupId: - description: The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID. + DeleteOnTermination: + description: Whether to delete the network interface when the instance terminates. By default, this value is set to ``true``. + type: boolean + default: true + DeviceIndex: + description: The network interface's position in the attachment order. For example, the first attached network interface has a ``DeviceIndex`` of 0. type: string - SourceSecurityGroupName: - description: |- - [EC2-Classic, default VPC] The name of the source security group. - - You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. + InstanceId: + description: The ID of the instance to which you will attach the ENI. type: string - SourceSecurityGroupOwnerId: - description: |- - [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range. - - If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. + NetworkInterfaceId: + description: The ID of the ENI that you want to attach. type: string - ToPort: - description: |- - The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes. - - Use this for ICMP and any protocol that uses ports. - type: integer + EnaSrdSpecification: + $ref: '#/components/schemas/EnaSrdSpecification' + description: Configures ENA Express for the network interface that this action attaches to the instance. required: - - IpProtocol - x-stackql-resource-name: security_group_ingress - x-stackql-primaryIdentifier: - - Id + - DeviceIndex + - InstanceId + - NetworkInterfaceId + x-stackql-resource-name: network_interface_attachment + description: Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instance without interruption. + x-type-name: AWS::EC2::NetworkInterfaceAttachment + x-stackql-primary-identifier: + - AttachmentId + x-stackql-additional-identifiers: + - - NetworkInterfaceId x-create-only-properties: - - GroupName - - IpProtocol - - SourceSecurityGroupId - - SourcePrefixListId - - ToPort - - CidrIp - - SourceSecurityGroupName - - SourceSecurityGroupOwnerId - - FromPort - - GroupId - - CidrIpv6 + - DeviceIndex + - InstanceId + - NetworkInterfaceId x-read-only-properties: - - Id + - AttachmentId + x-required-properties: + - DeviceIndex + - InstanceId + - NetworkInterfaceId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:DescribeSecurityGroupRules - - ec2:AuthorizeSecurityGroupIngress - update: - - ec2:UpdateSecurityGroupRuleDescriptionsIngress - delete: - - ec2:DescribeSecurityGroupRules - - ec2:RevokeSecurityGroupIngress + - ec2:AttachNetworkInterface + - ec2:DescribeNetworkInterfaces + - ec2:ModifyNetworkInterfaceAttribute read: - - ec2:DescribeSecurityGroups - - ec2:DescribeSecurityGroupRules + - ec2:DescribeNetworkInterfaces list: - - ec2:DescribeSecurityGroupRules - SnapshotBlockPublicAccess: - type: object - properties: - State: - type: string - description: The state of EBS Snapshot Block Public Access. - enum: - - block-all-sharing - - block-new-sharing - AccountId: + - ec2:DescribeNetworkInterfaces + update: + - ec2:ModifyNetworkInterfaceAttribute + - ec2:DescribeNetworkInterfaces + - ec2:AttachNetworkInterface + - ec2:DetachNetworkInterface + delete: + - ec2:DetachNetworkInterface + - ec2:DescribeNetworkInterfaces + NetworkPerformanceMetricSubscription: + type: object + properties: + Source: + description: The starting Region or Availability Zone for metric to subscribe to. + type: string + Destination: + description: The target Region or Availability Zone for the metric to subscribe to. + type: string + Metric: + description: The metric type to subscribe to. + type: string + Statistic: + description: The statistic to subscribe to. type: string - description: The identifier for the specified AWS account. required: - - State - x-stackql-resource-name: snapshot_block_public_access - x-stackql-primaryIdentifier: - - AccountId - x-read-only-properties: - - AccountId + - Source + - Destination + - Metric + - Statistic + x-stackql-resource-name: network_performance_metric_subscription + description: Resource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription + x-type-name: AWS::EC2::NetworkPerformanceMetricSubscription + x-stackql-primary-identifier: + - Source + - Destination + - Metric + - Statistic + x-create-only-properties: + - Source + - Destination + - Metric + - Statistic + x-required-properties: + - Source + - Destination + - Metric + - Statistic + x-tagging: + taggable: false x-required-permissions: create: - - ec2:EnableSnapshotBlockPublicAccess - - ec2:GetSnapshotBlockPublicAccessState + - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions + - ec2:EnableAwsNetworkPerformanceMetricSubscription read: - - ec2:GetSnapshotBlockPublicAccessState - update: - - ec2:EnableSnapshotBlockPublicAccess - - ec2:GetSnapshotBlockPublicAccessState + - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions delete: - - ec2:DisableSnapshotBlockPublicAccess - - ec2:GetSnapshotBlockPublicAccessState + - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions + - ec2:DisableAwsNetworkPerformanceMetricSubscription list: - - ec2:GetSnapshotBlockPublicAccessState - SpotFleetRequestConfigData: + - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions + PlacementGroup: type: object - additionalProperties: false properties: - AllocationStrategy: - type: string - enum: - - capacityOptimized - - capacityOptimizedPrioritized - - diversified - - lowestPrice - - priceCapacityOptimized - Context: - type: string - ExcessCapacityTerminationPolicy: + Strategy: + description: The placement strategy. type: string - enum: - - Default - - NoTermination - - default - - noTermination - IamFleetRole: + GroupName: + description: The Group Name of Placement Group. type: string - InstanceInterruptionBehavior: + SpreadLevel: + description: The Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread type: string - enum: - - hibernate - - stop - - terminate - InstancePoolsToUseCount: + PartitionCount: + description: The number of partitions. Valid only when **Strategy** is set to `partition` type: integer - LaunchSpecifications: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/SpotFleetLaunchSpecification' - LaunchTemplateConfigs: + Tags: + description: An array of key-value pairs to apply to this resource. type: array uniqueItems: true + x-insertionOrder: false items: - $ref: '#/components/schemas/LaunchTemplateConfig' - LoadBalancersConfig: - $ref: '#/components/schemas/LoadBalancersConfig' - OnDemandAllocationStrategy: - type: string - OnDemandMaxTotalPrice: - type: string - OnDemandTargetCapacity: - type: integer - ReplaceUnhealthyInstances: - type: boolean - SpotMaintenanceStrategies: - $ref: '#/components/schemas/SpotMaintenanceStrategies' - SpotMaxTotalPrice: - type: string - SpotPrice: - type: string - TargetCapacity: - type: integer - TerminateInstancesWithExpiration: - type: boolean - Type: - type: string - enum: - - maintain - - request - ValidFrom: - type: string - ValidUntil: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: placement_group + description: Resource Type definition for AWS::EC2::PlacementGroup + x-type-name: AWS::EC2::PlacementGroup + x-stackql-primary-identifier: + - GroupName + x-create-only-properties: + - Tags + - Strategy + - SpreadLevel + - PartitionCount + x-read-only-properties: + - GroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + x-required-permissions: + create: + - ec2:CreatePlacementGroup + - ec2:DescribePlacementGroups + - ec2:CreateTags + read: + - ec2:DescribePlacementGroups + delete: + - ec2:DeletePlacementGroup + - ec2:DescribePlacementGroups + list: + - ec2:DescribePlacementGroups + Entry: + type: object + properties: + Cidr: type: string - TagSpecifications: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/SpotFleetTagSpecification' - TargetCapacityUnitType: + minLength: 1 + maxLength: 46 + Description: type: string - enum: - - vcpu - - memory-mib - - units + minLength: 0 + maxLength: 255 required: - - IamFleetRole - - TargetCapacity - SpotFleetLaunchSpecification: - type: object + - Cidr additionalProperties: false + PrefixList: + type: object properties: - BlockDeviceMappings: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/BlockDeviceMapping' - EbsOptimized: - type: boolean - default: false - IamInstanceProfile: - $ref: '#/components/schemas/IamInstanceProfileSpecification' - ImageId: - type: string - InstanceType: + PrefixListName: + description: Name of Prefix List. type: string - KernelId: + minLength: 1 + maxLength: 255 + PrefixListId: + description: Id of Prefix List. type: string - KeyName: + OwnerId: + description: Owner Id of Prefix List. type: string - Monitoring: - $ref: '#/components/schemas/SpotFleetMonitoring' - NetworkInterfaces: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification' - Placement: - $ref: '#/components/schemas/SpotPlacement' - RamdiskId: + AddressFamily: + description: Ip Version of Prefix List. type: string - SecurityGroups: + enum: + - IPv4 + - IPv6 + MaxEntries: + description: Max Entries of Prefix List. + type: integer + minimum: 1 + Version: + description: Version of Prefix List. + type: integer + Tags: + description: Tags for Prefix List type: array - uniqueItems: true items: - $ref: '#/components/schemas/GroupIdentifier' - SpotPrice: - type: string - SubnetId: - type: string - TagSpecifications: + $ref: '#/components/schemas/Tag' + Entries: + description: Entries of Prefix List. type: array - uniqueItems: true items: - $ref: '#/components/schemas/SpotFleetTagSpecification' - UserData: + $ref: '#/components/schemas/Entry' + Arn: + description: The Amazon Resource Name (ARN) of the Prefix List. type: string - WeightedCapacity: - type: number - InstanceRequirements: - $ref: '#/components/schemas/InstanceRequirementsRequest' required: - - ImageId - LoadBalancersConfig: - type: object - additionalProperties: false - properties: - ClassicLoadBalancersConfig: - $ref: '#/components/schemas/ClassicLoadBalancersConfig' - TargetGroupsConfig: - $ref: '#/components/schemas/TargetGroupsConfig' - SpotMaintenanceStrategies: - type: object - additionalProperties: false - properties: - CapacityRebalance: - $ref: '#/components/schemas/SpotCapacityRebalance' - SpotCapacityRebalance: + - PrefixListName + - AddressFamily + x-stackql-resource-name: prefix_list + description: Resource schema of AWS::EC2::PrefixList Type + x-type-name: AWS::EC2::PrefixList + x-stackql-primary-identifier: + - PrefixListId + x-read-only-properties: + - PrefixListId + - OwnerId + - Version + - Arn + x-required-properties: + - PrefixListName + - AddressFamily + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - EC2:DeleteTags + - EC2:CreateTags + x-required-permissions: + create: + - EC2:CreateManagedPrefixList + - EC2:DescribeManagedPrefixLists + - EC2:CreateTags + read: + - EC2:GetManagedPrefixListEntries + - EC2:DescribeManagedPrefixLists + update: + - EC2:DescribeManagedPrefixLists + - EC2:GetManagedPrefixListEntries + - EC2:ModifyManagedPrefixList + - EC2:CreateTags + - EC2:DeleteTags + delete: + - EC2:DeleteManagedPrefixList + - EC2:DescribeManagedPrefixLists + list: + - EC2:DescribeManagedPrefixLists + - EC2:GetManagedPrefixListEntries + Route: type: object - additionalProperties: false properties: - ReplacementStrategy: + CarrierGatewayId: type: string - enum: - - launch - - launch-before-terminate - TerminationDelay: - type: integer - LaunchTemplateConfig: - type: object - additionalProperties: false - properties: - LaunchTemplateSpecification: - $ref: '#/components/schemas/FleetLaunchTemplateSpecification' - Overrides: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/LaunchTemplateOverrides' - SpotFleetTagSpecification: + description: |- + The ID of the carrier gateway. + You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone. + CidrBlock: + type: string + description: '' + CoreNetworkArn: + type: string + description: The Amazon Resource Name (ARN) of the core network. + DestinationCidrBlock: + type: string + description: The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. + DestinationIpv6CidrBlock: + type: string + description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. + DestinationPrefixListId: + type: string + description: The ID of a prefix list used for the destination match. + EgressOnlyInternetGatewayId: + type: string + description: '[IPv6 traffic only] The ID of an egress-only internet gateway.' + GatewayId: + type: string + description: The ID of an internet gateway or virtual private gateway attached to your VPC. + InstanceId: + type: string + description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. + LocalGatewayId: + type: string + description: The ID of the local gateway. + NatGatewayId: + type: string + description: '[IPv4 traffic only] The ID of a NAT gateway.' + NetworkInterfaceId: + type: string + description: The ID of a network interface. + RouteTableId: + type: string + description: The ID of the route table for the route. + TransitGatewayId: + type: string + description: The ID of a transit gateway. + VpcEndpointId: + type: string + description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. + VpcPeeringConnectionId: + type: string + description: The ID of a VPC peering connection. + required: + - RouteTableId + x-stackql-resource-name: route + description: |- + Specifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*. + You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target. + If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource. + x-type-name: AWS::EC2::Route + x-stackql-primary-identifier: + - RouteTableId + - CidrBlock + x-create-only-properties: + - RouteTableId + - DestinationCidrBlock + - DestinationIpv6CidrBlock + - DestinationPrefixListId + x-read-only-properties: + - CidrBlock + x-required-properties: + - RouteTableId + x-tagging: + taggable: false + x-required-permissions: + create: + - ec2:CreateRoute + - ec2:DescribeRouteTables + - ec2:DescribeNetworkInterfaces + read: + - ec2:DescribeRouteTables + update: + - ec2:ReplaceRoute + - ec2:DescribeRouteTables + - ec2:DescribeNetworkInterfaces + delete: + - ec2:DeleteRoute + - ec2:DescribeRouteTables + list: + - ec2:DescribeRouteTables + RouteServer: type: object - additionalProperties: false properties: - ResourceType: + AmazonSideAsn: + description: The Amazon-side ASN of the Route Server. + type: integer + format: int64 + minimum: 1 + maximum: 4294967294 + Arn: + description: The Amazon Resource Name (ARN) of the Route Server. + type: string + Id: + description: The ID of the Route Server. + type: string + PersistRoutes: + description: Whether to enable persistent routes type: string enum: - - client-vpn-endpoint - - customer-gateway - - dedicated-host - - dhcp-options - - egress-only-internet-gateway - - elastic-gpu - - elastic-ip - - export-image-task - - export-instance-task - - fleet - - fpga-image - - host-reservation - - image - - import-image-task - - import-snapshot-task - - instance - - internet-gateway - - key-pair - - launch-template - - local-gateway-route-table-vpc-association - - natgateway - - network-acl - - network-insights-analysis - - network-insights-path - - network-interface - - placement-group - - reserved-instances - - route-table - - security-group - - snapshot - - spot-fleet-request - - spot-instances-request - - subnet - - traffic-mirror-filter - - traffic-mirror-session - - traffic-mirror-target - - transit-gateway - - transit-gateway-attachment - - transit-gateway-connect-peer - - transit-gateway-multicast-domain - - transit-gateway-route-table - - volume - - vpc - - vpc-flow-log - - vpc-peering-connection - - vpn-connection - - vpn-gateway + - enable + - disable + PersistRoutesDuration: + description: The duration of persistent routes in minutes + type: integer + format: int64 + minimum: 0 + maximum: 5 + SnsNotificationsEnabled: + description: Whether to enable SNS notifications + type: boolean Tags: + description: An array of key-value pairs to apply to this resource. type: array uniqueItems: false + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - FleetLaunchTemplateSpecification: + required: + - AmazonSideAsn + x-stackql-resource-name: route_server + description: VPC Route Server + x-type-name: AWS::EC2::RouteServer + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - AmazonSideAsn + x-write-only-properties: + - PersistRoutesDuration + x-read-only-properties: + - Arn + - Id + x-required-properties: + - AmazonSideAsn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateRouteServer + - ec2:CreateTags + - ec2:DescribeRouteServers + - sns:CreateTopic + read: + - ec2:DescribeRouteServers + - ec2:DescribeTags + update: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeRouteServers + - ec2:DescribeTags + - ec2:ModifyRouteServer + - sns:CreateTopic + - sns:DeleteTopic + delete: + - ec2:DescribeTags + - ec2:DescribeRouteServers + - ec2:DeleteRouteServer + - ec2:DeleteTags + - sns:DeleteTopic + list: + - ec2:DescribeTags + - ec2:DescribeRouteServers + RouteServerAssociation: type: object - additionalProperties: false properties: - LaunchTemplateId: - type: string - LaunchTemplateName: + RouteServerId: + description: Route Server ID type: string - minLength: 3 - maxLength: 128 - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - Version: + VpcId: + description: VPC ID type: string required: - - Version - GroupIdentifier: + - RouteServerId + - VpcId + x-stackql-resource-name: route_server_association + description: VPC Route Server Association + x-type-name: AWS::EC2::RouteServerAssociation + x-stackql-primary-identifier: + - RouteServerId + - VpcId + x-create-only-properties: + - RouteServerId + - VpcId + x-required-properties: + - RouteServerId + - VpcId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:AssociateRouteServer + - ec2:GetRouteServerAssociations + read: + - ec2:GetRouteServerAssociations + delete: + - ec2:GetRouteServerAssociations + - ec2:DisassociateRouteServer + list: + - ec2:DescribeRouteServers + - ec2:GetRouteServerAssociations + RouteServerEndpoint: type: object - additionalProperties: false properties: - GroupId: + RouteServerId: + description: Route Server ID type: string - required: - - GroupId - IamInstanceProfileSpecification: - type: object - additionalProperties: false - properties: Arn: + description: The Amazon Resource Name (ARN) of the Route Server Endpoint. type: string - ClassicLoadBalancersConfig: - type: object - additionalProperties: false - properties: - ClassicLoadBalancers: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/ClassicLoadBalancer' - required: - - ClassicLoadBalancers - LaunchTemplateOverrides: - type: object - additionalProperties: false - properties: - AvailabilityZone: - type: string - InstanceType: - type: string - SpotPrice: + Id: + description: The ID of the Route Server Endpoint. type: string SubnetId: + description: Subnet ID type: string - WeightedCapacity: - type: number - InstanceRequirements: - $ref: '#/components/schemas/InstanceRequirementsRequest' - Priority: - type: number - SpotFleetMonitoring: - type: object - additionalProperties: false - properties: - Enabled: - type: boolean - default: false - SpotPlacement: - type: object - additionalProperties: false - properties: - AvailabilityZone: - type: string - GroupName: - type: string - Tenancy: - type: string - enum: - - dedicated - - default - - host - InstanceNetworkInterfaceSpecification: - type: object - additionalProperties: false - properties: - AssociatePublicIpAddress: - type: boolean - DeleteOnTermination: - type: boolean - Description: + VpcId: + description: VPC ID type: string - DeviceIndex: - type: integer - Groups: - type: array - uniqueItems: true - items: - type: string - Ipv6AddressCount: - type: integer - Ipv6Addresses: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/InstanceIpv6Address' - NetworkInterfaceId: + EniId: + description: Elastic Network Interface ID owned by the Route Server Endpoint type: string - PrivateIpAddresses: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/PrivateIpAddressSpecification' - SecondaryPrivateIpAddressCount: - type: integer - SubnetId: + EniAddress: + description: Elastic Network Interface IP address owned by the Route Server Endpoint type: string - TargetGroupsConfig: - type: object - additionalProperties: false - properties: - TargetGroups: + Tags: + description: An array of key-value pairs to apply to this resource. type: array - uniqueItems: true + uniqueItems: false + x-insertionOrder: false items: - $ref: '#/components/schemas/TargetGroup' + $ref: '#/components/schemas/Tag' required: - - TargetGroups - EbsBlockDevice: + - RouteServerId + - SubnetId + x-stackql-resource-name: route_server_endpoint + description: VPC Route Server Endpoint + x-type-name: AWS::EC2::RouteServerEndpoint + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - RouteServerId + - SubnetId + x-read-only-properties: + - Arn + - Id + - EniId + - EniAddress + - VpcId + x-required-properties: + - RouteServerId + - SubnetId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateRouteServerEndpoint + - ec2:CreateTags + - ec2:DescribeRouteServerEndpoints + - ec2:CreateNetworkInterface + - ec2:CreateNetworkInterfacePermission + - ec2:CreateSecurityGroup + - ec2:DescribeSecurityGroups + - ec2:AuthorizeSecurityGroupIngress + read: + - ec2:DescribeRouteServerEndpoints + - ec2:DescribeTags + update: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeRouteServerEndpoints + - ec2:DescribeTags + - ec2:ModifyRouteServerEndpoint + delete: + - ec2:DescribeTags + - ec2:DescribeRouteServerEndpoints + - ec2:DeleteRouteServerEndpoint + - ec2:DeleteTags + - ec2:DeleteNetworkInterface + - ec2:DeleteSecurityGroup + - ec2:DescribeSecurityGroups + - ec2:RevokeSecurityGroupIngress + list: + - ec2:DescribeTags + - ec2:DescribeRouteServerEndpoints + BgpOptions: + description: BGP Options type: object - additionalProperties: false properties: - DeleteOnTermination: - type: boolean - Encrypted: - type: boolean - Iops: - type: integer - SnapshotId: - type: string - VolumeSize: + PeerAsn: + description: BGP ASN of the Route Server Peer type: integer - VolumeType: + format: int64 + minimum: 1 + maximum: 4294967294 + PeerLivenessDetection: + description: BGP Liveness Detection type: string enum: - - gp2 - - gp3 - - io1 - - io2 - - sc1 - - st1 - - standard - TargetGroup: - type: object + - bfd + - bgp-keepalive additionalProperties: false - properties: - Arn: - type: string - required: - - Arn - ClassicLoadBalancer: + RouteServerPeer: type: object - additionalProperties: false properties: - Name: + RouteServerId: + description: Route Server ID + type: string + RouteServerEndpointId: + description: Route Server Endpoint ID + type: string + Arn: + description: The Amazon Resource Name (ARN) of the Route Server Peer. type: string - required: - - Name - SpotFleet: - type: object - properties: Id: + description: The ID of the Route Server Peer. type: string - SpotFleetRequestConfigData: - $ref: '#/components/schemas/SpotFleetRequestConfigData' + SubnetId: + description: Subnet ID + type: string + VpcId: + description: VPC ID + type: string + EndpointEniId: + description: Elastic Network Interface ID owned by the Route Server Endpoint + type: string + EndpointEniAddress: + description: Elastic Network Interface IP address owned by the Route Server Endpoint + type: string + PeerAddress: + description: IP address of the Route Server Peer + type: string + BgpOptions: + $ref: '#/components/schemas/BgpOptions' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - - SpotFleetRequestConfigData - x-stackql-resource-name: spot_fleet - x-stackql-primaryIdentifier: + - RouteServerEndpointId + - PeerAddress + - BgpOptions + x-stackql-resource-name: route_server_peer + description: VPC Route Server Peer + x-type-name: AWS::EC2::RouteServerPeer + x-stackql-primary-identifier: - Id x-create-only-properties: - - SpotFleetRequestConfigData/AllocationStrategy - - SpotFleetRequestConfigData/IamFleetRole - - SpotFleetRequestConfigData/InstanceInterruptionBehavior - - SpotFleetRequestConfigData/InstancePoolsToUseCount - - SpotFleetRequestConfigData/LaunchSpecifications - - SpotFleetRequestConfigData/LaunchTemplateConfigs - - SpotFleetRequestConfigData/LoadBalancersConfig - - SpotFleetRequestConfigData/OnDemandAllocationStrategy - - SpotFleetRequestConfigData/OnDemandMaxTotalPrice - - SpotFleetRequestConfigData/OnDemandTargetCapacity - - SpotFleetRequestConfigData/ReplaceUnhealthyInstances - - SpotFleetRequestConfigData/SpotMaintenanceStrategies - - SpotFleetRequestConfigData/SpotMaxTotalPrice - - SpotFleetRequestConfigData/SpotPrice - - SpotFleetRequestConfigData/TagSpecifications - - SpotFleetRequestConfigData/TerminateInstancesWithExpiration - - SpotFleetRequestConfigData/Type - - SpotFleetRequestConfigData/ValidFrom - - SpotFleetRequestConfigData/ValidUntil + - RouteServerEndpointId + - PeerAddress + - BgpOptions x-read-only-properties: + - Arn - Id + - RouteServerId + - EndpointEniId + - EndpointEniAddress + - SubnetId + - VpcId + x-required-properties: + - RouteServerEndpointId + - PeerAddress + - BgpOptions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags x-required-permissions: create: - - iam:PassRole + - ec2:CreateRouteServerPeer - ec2:CreateTags - - ec2:RequestSpotFleet - - ec2:DescribeSpotFleetRequests - - ec2:RunInstances + - ec2:DescribeRouteServerPeers + - ec2:AuthorizeSecurityGroupIngress + read: + - ec2:DescribeRouteServerPeers + - ec2:DescribeTags + update: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeRouteServerPeers + - ec2:DescribeTags + - ec2:ModifyRouteServerPeer delete: - - ec2:DescribeSpotFleetRequests - - ec2:CancelSpotFleetRequests + - ec2:DescribeTags + - ec2:DescribeRouteServerPeers + - ec2:DeleteRouteServerPeer + - ec2:DeleteTags + - ec2:RevokeSecurityGroupIngress list: - - ec2:DescribeSpotFleetRequests + - ec2:DescribeTags + - ec2:DescribeRouteServerPeers + RouteServerPropagation: + type: object + properties: + RouteServerId: + description: Route Server ID + type: string + RouteTableId: + description: Route Table ID + type: string + required: + - RouteServerId + - RouteTableId + x-stackql-resource-name: route_server_propagation + description: VPC Route Server Propagation + x-type-name: AWS::EC2::RouteServerPropagation + x-stackql-primary-identifier: + - RouteServerId + - RouteTableId + x-create-only-properties: + - RouteServerId + - RouteTableId + x-required-properties: + - RouteServerId + - RouteTableId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:EnableRouteServerPropagation + - ec2:GetRouteServerPropagations read: - - ec2:DescribeSpotFleetRequests - update: - - ec2:ModifySpotFleetRequest - - ec2:DescribeSpotFleetRequests - Subnet: + - ec2:GetRouteServerPropagations + delete: + - ec2:GetRouteServerPropagations + - ec2:DisableRouteServerPropagation + list: + - ec2:DescribeRouteServers + - ec2:GetRouteServerPropagations + RouteTable: type: object properties: - AssignIpv6AddressOnCreation: - type: boolean - description: |- - Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. - If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. + RouteTableId: + description: '' + type: string VpcId: + description: The ID of the VPC. type: string - description: |- - The ID of the VPC the subnet is in. - If you update this property, you must also update the ``CidrBlock`` property. - MapPublicIpOnLaunch: - type: boolean - description: |- - Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. - AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/). - NetworkAclAssociationId: - type: string - description: '' - AvailabilityZone: - type: string - description: |- - The Availability Zone of the subnet. - If you update this property, you must also update the ``CidrBlock`` property. - AvailabilityZoneId: - type: string - description: The AZ ID of the subnet. - CidrBlock: - type: string - description: |- - The IPv4 CIDR block assigned to the subnet. - If you update this property, we create a new subnet, and then delete the existing one. - SubnetId: - type: string - description: '' - Ipv6CidrBlocks: - type: array - uniqueItems: false - items: - type: string - description: The IPv6 network ranges for the subnet, in CIDR notation. - Ipv6CidrBlock: - type: string - description: |- - The IPv6 CIDR block. - If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. - OutpostArn: - type: string - description: The Amazon Resource Name (ARN) of the Outpost. - Ipv6Native: - type: boolean - description: Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*. - EnableDns64: - type: boolean - description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*. - PrivateDnsNameOptionsOnLaunch: - type: object - additionalProperties: false - properties: - HostnameType: - type: string - EnableResourceNameDnsARecord: - type: boolean - EnableResourceNameDnsAAAARecord: - type: boolean - description: |- - The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. - Available options: - + EnableResourceNameDnsAAAARecord (true | false) - + EnableResourceNameDnsARecord (true | false) - + HostnameType (ip-name | resource-name) Tags: - type: array uniqueItems: false + description: Any tags assigned to the route table. + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - description: Any tags assigned to the subnet. - Ipv4IpamPoolId: - type: string - description: An IPv4 IPAM pool ID for the subnet. - Ipv4NetmaskLength: - type: integer - description: An IPv4 netmask length for the subnet. - Ipv6IpamPoolId: - type: string - description: An IPv6 IPAM pool ID for the subnet. - Ipv6NetmaskLength: - type: integer - description: An IPv6 netmask length for the subnet. required: - VpcId - x-stackql-resource-name: subnet - x-stackql-primaryIdentifier: - - SubnetId + x-stackql-resource-name: route_table + description: |- + Specifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. + For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. + x-type-name: AWS::EC2::RouteTable + x-stackql-primary-identifier: + - RouteTableId x-create-only-properties: - VpcId - - AvailabilityZone - - AvailabilityZoneId - - CidrBlock - - OutpostArn - - Ipv6Native - - Ipv4IpamPoolId - - Ipv4NetmaskLength - - Ipv6IpamPoolId - - Ipv6NetmaskLength x-read-only-properties: - - NetworkAclAssociationId - - SubnetId + - RouteTableId + x-required-properties: + - VpcId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ec2:DescribeRouteTables create: - - ec2:DescribeSubnets - - ec2:CreateSubnet + - ec2:CreateRouteTable - ec2:CreateTags - - ec2:ModifySubnetAttribute - read: - - ec2:DescribeSubnets - - ec2:DescribeNetworkAcls + - ec2:DescribeRouteTables update: - - ec2:DescribeSubnets - - ec2:ModifySubnetAttribute - ec2:CreateTags - ec2:DeleteTags - - ec2:AssociateSubnetCidrBlock - - ec2:DisassociateSubnetCidrBlock - delete: - - ec2:DescribeSubnets - - ec2:DeleteSubnet + - ec2:DescribeRouteTables list: - - ec2:DescribeSubnets - - ec2:DescribeNetworkAcls - SubnetCidrBlock: + - ec2:DescribeRouteTables + delete: + - ec2:DescribeRouteTables + - ec2:DeleteRouteTable + Ingress: + additionalProperties: false type: object properties: - Id: - description: Information about the IPv6 association. + CidrIp: type: string - Ipv6CidrBlock: - description: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length + CidrIpv6: type: string - maxLength: 42 - Ipv6IpamPoolId: - description: The ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR + Description: type: string - Ipv6NetmaskLength: - description: The netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool + FromPort: type: integer - minimum: 0 - maximum: 128 - SubnetId: - description: The ID of the subnet + SourceSecurityGroupName: + type: string + ToPort: + type: integer + SourceSecurityGroupOwnerId: + type: string + IpProtocol: + type: string + SourceSecurityGroupId: + type: string + SourcePrefixListId: type: string required: - - SubnetId - x-stackql-resource-name: subnet_cidr_block - x-stackql-primaryIdentifier: - - Id - x-create-only-properties: - - Ipv6CidrBlock - - SubnetId - - Ipv6IpamPoolId - - Ipv6NetmaskLength - x-read-only-properties: - - Id - x-required-permissions: - create: - - ec2:AssociateSubnetCidrBlock - - ec2:DescribeSubnets - delete: - - ec2:DisassociateSubnetCidrBlock - - ec2:DescribeSubnets - list: - - ec2:DescribeSubnets - read: - - ec2:DescribeSubnets - SubnetNetworkAclAssociation: + - IpProtocol + Egress: + additionalProperties: false type: object properties: - SubnetId: + CidrIp: type: string - description: The ID of the subnet - NetworkAclId: + CidrIpv6: type: string - description: The ID of the network ACL - AssociationId: + Description: + type: string + FromPort: + type: integer + ToPort: + type: integer + IpProtocol: + type: string + DestinationSecurityGroupId: + type: string + DestinationPrefixListId: type: string required: - - NetworkAclId - - SubnetId - x-stackql-resource-name: subnet_network_acl_association - x-stackql-primaryIdentifier: - - AssociationId - x-create-only-properties: - - SubnetId - - NetworkAclId - x-read-only-properties: - - AssociationId - x-required-permissions: - create: - - ec2:DescribeNetworkAcls - - ec2:ReplaceNetworkAclAssociation - read: - - ec2:DescribeNetworkAcls - delete: - - ec2:DescribeNetworkAcls - - ec2:ReplaceNetworkAclAssociation - list: - - ec2:DescribeNetworkAcls - SubnetRouteTableAssociation: + - IpProtocol + SecurityGroup: type: object properties: - Id: + GroupDescription: + description: A description for the security group. type: string - description: '' - RouteTableId: + GroupName: + description: The name of the security group. type: string - description: |- - The ID of the route table. - The physical ID changes when the route table ID is changed. - SubnetId: + VpcId: + description: The ID of the VPC for the security group. + type: string + Id: + description: The group name or group ID depending on whether the SG is created in default or specific VPC + type: string + SecurityGroupIngress: + uniqueItems: false + description: The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ingress' + SecurityGroupEgress: + uniqueItems: false + description: '[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Egress' + Tags: + uniqueItems: false + description: Any tags assigned to the security group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + GroupId: + description: The group ID of the specified security group. type: string - description: The ID of the subnet. required: - - RouteTableId - - SubnetId - x-stackql-resource-name: subnet_route_table_association - x-stackql-primaryIdentifier: + - GroupDescription + x-stackql-resource-name: security_group + description: Resource Type definition for AWS::EC2::SecurityGroup + x-type-name: AWS::EC2::SecurityGroup + x-stackql-primary-identifier: - Id x-create-only-properties: - - SubnetId - - RouteTableId + - GroupDescription + - GroupName + - VpcId + x-write-only-properties: + - SecurityGroupIngress/*/SourceSecurityGroupName x-read-only-properties: - Id + - GroupId + x-required-properties: + - GroupDescription + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: - create: - - ec2:AssociateRouteTable - - ec2:ReplaceRouteTableAssociation - - ec2:DescribeSubnets - - ec2:DescribeRouteTables read: - - ec2:DescribeRouteTables - delete: - - ec2:DisassociateRouteTable - - ec2:DescribeSubnets - - ec2:DescribeRouteTables + - ec2:DescribeSecurityGroups + create: + - ec2:CreateSecurityGroup + - ec2:DescribeSecurityGroups + - ec2:RevokeSecurityGroupEgress + - ec2:AuthorizeSecurityGroupEgress + - ec2:AuthorizeSecurityGroupIngress + - ec2:CreateTags + update: + - ec2:RevokeSecurityGroupEgress + - ec2:RevokeSecurityGroupIngress + - ec2:DescribeSecurityGroups + - ec2:AuthorizeSecurityGroupEgress + - ec2:AuthorizeSecurityGroupIngress + - ec2:UpdateSecurityGroupRuleDescriptionsIngress + - ec2:UpdateSecurityGroupRuleDescriptionsEgress + - ec2:CreateTags + - ec2:DeleteTags list: - - ec2:DescribeRouteTables - TransitGateway: + - ec2:DescribeSecurityGroups + delete: + - ec2:DescribeSecurityGroups + - ec2:DeleteSecurityGroup + - ec2:DescribeInstances + SecurityGroupEgress: type: object properties: - Description: - type: string - AssociationDefaultRouteTableId: - type: string - AutoAcceptSharedAttachments: + CidrIp: + description: |- + The IPv4 address range, in CIDR format. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*. type: string - TransitGatewayArn: + CidrIpv6: + description: |- + The IPv6 address range, in CIDR format. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*. type: string - DefaultRouteTablePropagation: + Description: + description: |- + The description of an egress (outbound) security group rule. + Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* type: string - TransitGatewayCidrBlocks: - type: array - items: - type: string - PropagationDefaultRouteTableId: + FromPort: + description: If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). + type: integer + ToPort: + description: If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). + type: integer + IpProtocol: + description: |- + The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). + Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. type: string - DefaultRouteTableAssociation: + DestinationSecurityGroupId: + description: |- + The ID of the security group. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. type: string Id: + description: '' type: string - VpnEcmpSupport: - type: string - DnsSupport: + DestinationPrefixListId: + description: |- + The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. type: string - MulticastSupport: + GroupId: + description: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. type: string - AmazonSideAsn: - format: int64 - type: integer - Tags: - uniqueItems: false - type: array - items: - $ref: '#/components/schemas/Tag' - x-stackql-resource-name: transit_gateway - x-stackql-primaryIdentifier: + required: + - IpProtocol + - GroupId + x-stackql-resource-name: security_group_egress + description: |- + Adds the specified outbound (egress) rule to a security group. + An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html). + You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group. + You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1. + Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. + x-type-name: AWS::EC2::SecurityGroupEgress + x-stackql-primary-identifier: - Id x-create-only-properties: - - AmazonSideAsn - - MulticastSupport + - IpProtocol + - DestinationSecurityGroupId + - ToPort + - CidrIp + - FromPort + - GroupId + - CidrIpv6 + - DestinationPrefixListId x-read-only-properties: - Id - - TransitGatewayArn + x-required-properties: + - IpProtocol + - GroupId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: read: - - ec2:CreateTransitGateway - - ec2:CreateTags - - ec2:DescribeTransitGateways - - ec2:DescribeTags - - ec2:DeleteTransitGateway - - ec2:DeleteTags - - ec2:ModifyTransitGateway - - ec2:ModifyTransitGatewayOptions + - ec2:DescribeSecurityGroupRules create: - - ec2:CreateTransitGateway - - ec2:CreateTags - - ec2:DescribeTransitGateways - - ec2:DescribeTags - - ec2:DeleteTransitGateway - - ec2:DeleteTags - - ec2:ModifyTransitGateway - - ec2:ModifyTransitGatewayOptions + - ec2:AuthorizeSecurityGroupEgress + - ec2:RevokeSecurityGroupEgress + - ec2:DescribeSecurityGroupRules update: - - ec2:CreateTransitGateway - - ec2:CreateTags - - ec2:DescribeTransitGateways - - ec2:DescribeTags - - ec2:DeleteTransitGateway - - ec2:DeleteTags - - ec2:ModifyTransitGateway - - ec2:ModifyTransitGatewayOptions + - ec2:UpdateSecurityGroupRuleDescriptionsEgress list: - - ec2:CreateTransitGateway - - ec2:CreateTags - - ec2:DescribeTransitGateways - - ec2:DescribeTags - - ec2:DeleteTransitGateway - - ec2:DeleteTags - - ec2:ModifyTransitGateway - - ec2:ModifyTransitGatewayOptions + - ec2:DescribeSecurityGroupRules delete: - - ec2:CreateTransitGateway - - ec2:CreateTags - - ec2:DescribeTransitGateways - - ec2:DescribeTags - - ec2:DeleteTransitGateway - - ec2:DeleteTags - - ec2:ModifyTransitGateway - - ec2:ModifyTransitGatewayOptions - TransitGatewayAttachment: + - ec2:RevokeSecurityGroupEgress + - ec2:DescribeSecurityGroupRules + SecurityGroupIngress: type: object properties: Id: + description: The Security Group Rule Id type: string - TransitGatewayId: + CidrIp: + description: The IPv4 ranges type: string - VpcId: + CidrIpv6: + description: '[VPC only] The IPv6 ranges' type: string - SubnetIds: - type: array - x-insertionOrder: false - uniqueItems: false - items: - type: string - Tags: - type: array - x-insertionOrder: false - uniqueItems: false - items: - $ref: '#/components/schemas/Tag' - Options: - description: The options for the transit gateway vpc attachment. - type: object - properties: - DnsSupport: - description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable' - type: string - Ipv6Support: - description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' - type: string - ApplianceModeSupport: - description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' - type: string - SecurityGroupReferencingSupport: - description: 'Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid Values: enable | disable' - type: string - additionalProperties: false + Description: + description: Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously + type: string + FromPort: + description: |- + The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. + + Use this for ICMP and any protocol that uses ports. + type: integer + GroupId: + description: |- + The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + + You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. + type: string + GroupName: + description: The name of the security group. + type: string + IpProtocol: + description: |- + The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers). + + [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + type: string + SourcePrefixListId: + description: |+ + [EC2-VPC only] The ID of a prefix list. + + type: string + SourceSecurityGroupId: + description: The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID. + type: string + SourceSecurityGroupName: + description: |- + [EC2-Classic, default VPC] The name of the source security group. + + You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. + type: string + SourceSecurityGroupOwnerId: + description: |- + [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range. + + If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. + type: string + ToPort: + description: |- + The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes. + + Use this for ICMP and any protocol that uses ports. + type: integer required: - - VpcId - - SubnetIds - - TransitGatewayId - x-stackql-resource-name: transit_gateway_attachment - x-stackql-primaryIdentifier: + - IpProtocol + x-stackql-resource-name: security_group_ingress + description: Resource Type definition for AWS::EC2::SecurityGroupIngress + x-type-name: AWS::EC2::SecurityGroupIngress + x-stackql-primary-identifier: - Id x-create-only-properties: - - TransitGatewayId - - VpcId + - GroupName + - IpProtocol + - SourceSecurityGroupId + - SourcePrefixListId + - ToPort + - CidrIp + - SourceSecurityGroupName + - SourceSecurityGroupOwnerId + - FromPort + - GroupId + - CidrIpv6 x-read-only-properties: - Id + x-required-properties: + - IpProtocol + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:CreateTransitGatewayVpcAttachment - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeTags - - ec2:DescribeTransitGatewayAttachments - - ec2:ModifyTransitGatewayVpcAttachment - read: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:CreateTransitGatewayVpcAttachment - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeTags - - ec2:DescribeTransitGatewayAttachments - - ec2:ModifyTransitGatewayVpcAttachment + - ec2:DescribeSecurityGroupRules + - ec2:AuthorizeSecurityGroupIngress + update: + - ec2:UpdateSecurityGroupRuleDescriptionsIngress delete: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:CreateTransitGatewayVpcAttachment - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeTags - - ec2:DescribeTransitGatewayAttachments - - ec2:ModifyTransitGatewayVpcAttachment + - ec2:DescribeSecurityGroupRules + - ec2:RevokeSecurityGroupIngress + read: + - ec2:DescribeSecurityGroups + - ec2:DescribeSecurityGroupRules list: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:DescribeTags - - ec2:CreateTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:DeleteTags - - ec2:ModifyTransitGatewayVpcAttachment - update: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:DescribeTags - - ec2:CreateTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:DeleteTags - - ec2:ModifyTransitGatewayVpcAttachment - TransitGatewayConnectOptions: - type: object - properties: - Protocol: - description: The tunnel protocol. - type: string + - ec2:DescribeSecurityGroupRules + SecurityGroupVpcAssociationState: + type: string additionalProperties: false - TransitGatewayConnect: + enum: + - associating + - associated + - association-failed + - disassociating + - disassociated + - disassociation-failed + SecurityGroupVpcAssociation: type: object properties: - TransitGatewayAttachmentId: - description: The ID of the Connect attachment. + GroupId: + description: The group ID of the specified security group. type: string - TransportTransitGatewayAttachmentId: - description: The ID of the attachment from which the Connect attachment was created. + VpcId: + description: The ID of the VPC in the security group vpc association. type: string - TransitGatewayId: - description: The ID of the transit gateway. + VpcOwnerId: + description: The owner of the VPC in the security group vpc association. type: string State: - description: The state of the attachment. - type: string - CreationTime: - description: The creation time. + description: The state of the security group vpc association. + $ref: '#/components/schemas/SecurityGroupVpcAssociationState' + StateReason: + description: The reason for the state of the security group vpc association. type: string - Tags: - description: The tags for the attachment. - type: array - items: - $ref: '#/components/schemas/Tag' - Options: - $ref: '#/components/schemas/TransitGatewayConnectOptions' - description: The Connect attachment options. required: - - TransportTransitGatewayAttachmentId - - Options - x-stackql-resource-name: transit_gateway_connect - x-stackql-primaryIdentifier: - - TransitGatewayAttachmentId + - GroupId + - VpcId + x-stackql-resource-name: security_group_vpc_association + description: Resource type definition for the AWS::EC2::SecurityGroupVpcAssociation resource + x-type-name: AWS::EC2::SecurityGroupVpcAssociation + x-stackql-primary-identifier: + - GroupId + - VpcId x-create-only-properties: - - TransportTransitGatewayAttachmentId - - Options + - GroupId + - VpcId x-read-only-properties: - - TransitGatewayAttachmentId + - VpcOwnerId - State - - CreationTime - - TransitGatewayId + - StateReason + x-required-properties: + - GroupId + - VpcId + x-tagging: + taggable: false x-required-permissions: create: - - ec2:CreateTransitGatewayConnect - - ec2:DescribeTransitGatewayConnects - - ec2:CreateTags + - ec2:AssociateSecurityGroupVpc + - ec2:DescribeSecurityGroupVpcAssociations read: - - ec2:DescribeTransitGatewayConnects - update: - - ec2:DescribeTransitGatewayConnects - - ec2:DeleteTags - - ec2:CreateTags + - ec2:DescribeSecurityGroupVpcAssociations delete: - - ec2:DeleteTransitGatewayConnect - - ec2:DescribeTransitGatewayConnects - - ec2:DeleteTags + - ec2:DisassociateSecurityGroupVpc + - ec2:DescribeSecurityGroupVpcAssociations list: - - ec2:DescribeTransitGatewayConnects - TransitGatewayMulticastDomain: + - ec2:DescribeSecurityGroupVpcAssociations + SnapshotBlockPublicAccess: type: object properties: - TransitGatewayMulticastDomainId: - description: The ID of the transit gateway multicast domain. - type: string - TransitGatewayMulticastDomainArn: - description: The Amazon Resource Name (ARN) of the transit gateway multicast domain. - type: string - TransitGatewayId: - description: The ID of the transit gateway. - type: string State: - description: The state of the transit gateway multicast domain. type: string - CreationTime: - description: The time the transit gateway multicast domain was created. + description: The state of EBS Snapshot Block Public Access. + enum: + - block-all-sharing + - block-new-sharing + AccountId: type: string - format: date-time - Tags: - description: The tags for the transit gateway multicast domain. - type: array - items: - $ref: '#/components/schemas/Tag' - Options: - description: The options for the transit gateway multicast domain. - type: object - properties: - AutoAcceptSharedAssociations: - description: 'Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable' - type: string - Igmpv2Support: - description: 'Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable' - type: string - StaticSourcesSupport: - description: 'Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable' - type: string - additionalProperties: false + description: The identifier for the specified AWS account. required: - - TransitGatewayId - x-stackql-resource-name: transit_gateway_multicast_domain - x-stackql-primaryIdentifier: - - TransitGatewayMulticastDomainId - x-create-only-properties: - - TransitGatewayId + - State + x-stackql-resource-name: snapshot_block_public_access + description: Resource Type definition for AWS::EC2::SnapshotBlockPublicAccess + x-type-name: AWS::EC2::SnapshotBlockPublicAccess + x-stackql-primary-identifier: + - AccountId x-read-only-properties: - - TransitGatewayMulticastDomainId + - AccountId + x-required-properties: - State - - CreationTime - - TransitGatewayMulticastDomainArn + x-tagging: + taggable: false x-required-permissions: create: - - ec2:DescribeTransitGatewayMulticastDomains - - ec2:CreateTransitGatewayMulticastDomain - - ec2:CreateTags + - ec2:EnableSnapshotBlockPublicAccess + - ec2:GetSnapshotBlockPublicAccessState read: - - ec2:DescribeTransitGatewayMulticastDomains + - ec2:GetSnapshotBlockPublicAccessState update: - - ec2:DescribeTransitGatewayMulticastDomains - - ec2:DeleteTags - - ec2:CreateTags + - ec2:EnableSnapshotBlockPublicAccess + - ec2:GetSnapshotBlockPublicAccessState delete: - - ec2:DescribeTransitGatewayMulticastDomains - - ec2:DeleteTransitGatewayMulticastDomain - - ec2:DeleteTags + - ec2:DisableSnapshotBlockPublicAccess + - ec2:GetSnapshotBlockPublicAccessState list: - - ec2:DescribeTransitGatewayMulticastDomains - TransitGatewayMulticastDomainAssociation: + - ec2:GetSnapshotBlockPublicAccessState + SpotFleetRequestConfigData: type: object + additionalProperties: false properties: - TransitGatewayMulticastDomainId: - description: The ID of the transit gateway multicast domain. + AllocationStrategy: type: string - TransitGatewayAttachmentId: - description: The ID of the transit gateway attachment. + enum: + - capacityOptimized + - capacityOptimizedPrioritized + - diversified + - lowestPrice + - priceCapacityOptimized + Context: type: string - ResourceId: - description: The ID of the resource. + ExcessCapacityTerminationPolicy: type: string - ResourceType: - description: The type of resource, for example a VPC attachment. + enum: + - Default + - NoTermination + - default + - noTermination + IamFleetRole: type: string - State: - description: The state of the subnet association. + InstanceInterruptionBehavior: type: string - SubnetId: - description: The IDs of the subnets to associate with the transit gateway multicast domain. + enum: + - hibernate + - stop + - terminate + InstancePoolsToUseCount: + type: integer + LaunchSpecifications: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/SpotFleetLaunchSpecification' + LaunchTemplateConfigs: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/LaunchTemplateConfig' + LoadBalancersConfig: + $ref: '#/components/schemas/LoadBalancersConfig' + OnDemandAllocationStrategy: type: string - required: - - TransitGatewayMulticastDomainId - - TransitGatewayAttachmentId - - SubnetId - x-stackql-resource-name: transit_gateway_multicast_domain_association - x-stackql-primaryIdentifier: - - TransitGatewayMulticastDomainId - - TransitGatewayAttachmentId - - SubnetId - x-create-only-properties: - - TransitGatewayMulticastDomainId - - TransitGatewayAttachmentId - - SubnetId - x-read-only-properties: - - ResourceId - - ResourceType - - State - x-required-permissions: - create: - - ec2:AssociateTransitGatewayMulticastDomain - - ec2:GetTransitGatewayMulticastDomainAssociations - read: - - ec2:GetTransitGatewayMulticastDomainAssociations - delete: - - ec2:DisassociateTransitGatewayMulticastDomain - - ec2:GetTransitGatewayMulticastDomainAssociations - list: - - ec2:GetTransitGatewayMulticastDomainAssociations - TransitGatewayMulticastGroupMember: - type: object - properties: - GroupIpAddress: - description: The IP address assigned to the transit gateway multicast group. - type: string - TransitGatewayAttachmentId: - description: The ID of the transit gateway attachment. - type: string - TransitGatewayMulticastDomainId: - description: The ID of the transit gateway multicast domain. + OnDemandMaxTotalPrice: type: string - SubnetId: - description: The ID of the subnet. + OnDemandTargetCapacity: + type: integer + ReplaceUnhealthyInstances: + type: boolean + SpotMaintenanceStrategies: + $ref: '#/components/schemas/SpotMaintenanceStrategies' + SpotMaxTotalPrice: type: string - ResourceId: - description: The ID of the resource. + SpotPrice: type: string - ResourceType: - description: The type of resource, for example a VPC attachment. + TargetCapacity: + type: integer + TerminateInstancesWithExpiration: + type: boolean + Type: type: string - NetworkInterfaceId: - description: The ID of the transit gateway attachment. + enum: + - maintain + - request + ValidFrom: type: string - GroupMember: - description: Indicates that the resource is a transit gateway multicast group member. - type: boolean - GroupSource: - description: Indicates that the resource is a transit gateway multicast group member. - type: boolean - MemberType: - description: The member type (for example, static). + ValidUntil: type: string - SourceType: - description: The source type. + TagSpecifications: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/SpotFleetTagSpecification' + TargetCapacityUnitType: type: string + enum: + - vcpu + - memory-mib + - units required: - - GroupIpAddress - - NetworkInterfaceId - - TransitGatewayMulticastDomainId - x-stackql-resource-name: transit_gateway_multicast_group_member - x-stackql-primaryIdentifier: - - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId - x-create-only-properties: - - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId - x-read-only-properties: - - SubnetId - - ResourceId - - ResourceType - - GroupSource - - GroupMember - - MemberType - - SourceType - - TransitGatewayAttachmentId - x-required-permissions: - create: - - ec2:RegisterTransitGatewayMulticastGroupMembers - - ec2:SearchTransitGatewayMulticastGroups - read: - - ec2:SearchTransitGatewayMulticastGroups - delete: - - ec2:DeregisterTransitGatewayMulticastGroupMembers - - ec2:SearchTransitGatewayMulticastGroups - list: - - ec2:SearchTransitGatewayMulticastGroups - TransitGatewayMulticastGroupSource: + - IamFleetRole + - TargetCapacity + SpotFleetLaunchSpecification: type: object + additionalProperties: false properties: - GroupIpAddress: - description: The IP address assigned to the transit gateway multicast group. - type: string - TransitGatewayAttachmentId: - description: The ID of the transit gateway attachment. + BlockDeviceMappings: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/BlockDeviceMapping' + EbsOptimized: + type: boolean + default: false + IamInstanceProfile: + $ref: '#/components/schemas/IamInstanceProfileSpecification' + ImageId: type: string - TransitGatewayMulticastDomainId: - description: The ID of the transit gateway multicast domain. + InstanceType: type: string - SubnetId: - description: The ID of the subnet. + KernelId: type: string - ResourceId: - description: The ID of the resource. + KeyName: type: string - ResourceType: - description: The type of resource, for example a VPC attachment. + Monitoring: + $ref: '#/components/schemas/SpotFleetMonitoring' + NetworkInterfaces: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification' + Placement: + $ref: '#/components/schemas/SpotPlacement' + RamdiskId: type: string - NetworkInterfaceId: - description: The ID of the transit gateway attachment. + SecurityGroups: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/GroupIdentifier' + SpotPrice: type: string - GroupMember: - description: Indicates that the resource is a transit gateway multicast group member. - type: boolean - GroupSource: - description: Indicates that the resource is a transit gateway multicast group member. - type: boolean - MemberType: - description: The member type (for example, static). + SubnetId: type: string - SourceType: - description: The source type. + TagSpecifications: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/SpotFleetTagSpecification' + UserData: type: string + WeightedCapacity: + type: number + InstanceRequirements: + $ref: '#/components/schemas/InstanceRequirementsRequest' required: - - TransitGatewayMulticastDomainId - - NetworkInterfaceId - - GroupIpAddress - x-stackql-resource-name: transit_gateway_multicast_group_source - x-stackql-primaryIdentifier: - - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId - x-create-only-properties: - - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId - x-read-only-properties: - - SubnetId - - ResourceId - - ResourceType - - GroupSource - - GroupMember - - MemberType - - SourceType - - TransitGatewayAttachmentId - x-required-permissions: - create: - - ec2:RegisterTransitGatewayMulticastGroupSources - - ec2:SearchTransitGatewayMulticastGroups - read: - - ec2:SearchTransitGatewayMulticastGroups - delete: - - ec2:DeregisterTransitGatewayMulticastGroupSources - - ec2:SearchTransitGatewayMulticastGroups - list: - - ec2:SearchTransitGatewayMulticastGroups - PeeringAttachmentStatus: + - ImageId + LoadBalancersConfig: + type: object additionalProperties: false + properties: + ClassicLoadBalancersConfig: + $ref: '#/components/schemas/ClassicLoadBalancersConfig' + TargetGroupsConfig: + $ref: '#/components/schemas/TargetGroupsConfig' + SpotMaintenanceStrategies: type: object + additionalProperties: false properties: - Message: - description: The status message, if applicable. - type: string - Code: - description: The status code. - type: string - TransitGatewayPeeringAttachment: + CapacityRebalance: + $ref: '#/components/schemas/SpotCapacityRebalance' + SpotCapacityRebalance: type: object + additionalProperties: false properties: - Status: - description: The status of the transit gateway peering attachment. - $ref: '#/components/schemas/PeeringAttachmentStatus' - TransitGatewayId: - description: The ID of the transit gateway. - type: string - PeerTransitGatewayId: - description: The ID of the peer transit gateway. - type: string - PeerAccountId: - description: The ID of the peer account - type: string - State: - description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. - type: string - CreationTime: - format: date-time - description: The time the transit gateway peering attachment was created. - type: string - PeerRegion: - description: Peer Region + ReplacementStrategy: type: string - Tags: - description: The tags for the transit gateway peering attachment. + enum: + - launch + - launch-before-terminate + TerminationDelay: + type: integer + LaunchTemplateConfig: + type: object + additionalProperties: false + properties: + LaunchTemplateSpecification: + $ref: '#/components/schemas/FleetLaunchTemplateSpecification' + Overrides: type: array + uniqueItems: true items: - $ref: '#/components/schemas/Tag' - TransitGatewayAttachmentId: - description: The ID of the transit gateway peering attachment. + $ref: '#/components/schemas/LaunchTemplateOverrides' + SpotFleetTagSpecification: + type: object + additionalProperties: false + properties: + ResourceType: + type: string + enum: + - client-vpn-endpoint + - customer-gateway + - dedicated-host + - dhcp-options + - egress-only-internet-gateway + - elastic-gpu + - elastic-ip + - export-image-task + - export-instance-task + - fleet + - fpga-image + - host-reservation + - image + - import-image-task + - import-snapshot-task + - instance + - internet-gateway + - key-pair + - launch-template + - local-gateway-route-table-vpc-association + - natgateway + - network-acl + - network-insights-analysis + - network-insights-path + - network-interface + - placement-group + - reserved-instances + - route-table + - security-group + - snapshot + - spot-fleet-request + - spot-instances-request + - subnet + - traffic-mirror-filter + - traffic-mirror-session + - traffic-mirror-target + - transit-gateway + - transit-gateway-attachment + - transit-gateway-connect-peer + - transit-gateway-multicast-domain + - transit-gateway-route-table + - volume + - vpc + - vpc-flow-log + - vpc-peering-connection + - vpn-connection + - vpn-gateway + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + FleetLaunchTemplateSpecification: + type: object + additionalProperties: false + properties: + LaunchTemplateId: + type: string + LaunchTemplateName: + type: string + minLength: 3 + maxLength: 128 + pattern: '[a-zA-Z0-9\(\)\.\-/_]+' + Version: type: string required: - - TransitGatewayId - - PeerTransitGatewayId - - PeerAccountId - - PeerRegion - x-stackql-resource-name: transit_gateway_peering_attachment - x-stackql-primaryIdentifier: - - TransitGatewayAttachmentId - x-create-only-properties: - - TransitGatewayId - - PeerTransitGatewayId - - PeerRegion - - PeerAccountId - x-read-only-properties: - - TransitGatewayAttachmentId - - Status - - State - - CreationTime - x-required-permissions: - read: - - ec2:DescribeTransitGatewayPeeringAttachments - create: - - ec2:CreateTransitGatewayPeeringAttachment - - ec2:DescribeTransitGatewayPeeringAttachments - update: - - ec2:DescribeTransitGatewayPeeringAttachments - list: - - ec2:DescribeTransitGatewayPeeringAttachments - delete: - - ec2:DeleteTransitGatewayPeeringAttachment - - ec2:DescribeTransitGatewayPeeringAttachments - TransitGatewayRouteTable: + - Version + GroupIdentifier: type: object + additionalProperties: false properties: - TransitGatewayRouteTableId: - description: Transit Gateway Route Table primary identifier + GroupId: type: string - TransitGatewayId: - description: The ID of the transit gateway. + required: + - GroupId + IamInstanceProfileSpecification: + type: object + additionalProperties: false + properties: + Arn: type: string - Tags: + ClassicLoadBalancersConfig: + type: object + additionalProperties: false + properties: + ClassicLoadBalancers: type: array - description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. + uniqueItems: true items: - $ref: '#/components/schemas/Tag' - x-insertionOrder: false - uniqueItems: false + $ref: '#/components/schemas/ClassicLoadBalancer' required: - - TransitGatewayId - x-stackql-resource-name: transit_gateway_route_table - x-stackql-primaryIdentifier: - - TransitGatewayRouteTableId - x-create-only-properties: - - TransitGatewayId - - Tags - x-read-only-properties: - - TransitGatewayRouteTableId - x-required-permissions: - create: - - ec2:CreateTransitGatewayRouteTable - - ec2:CreateTags - - ec2:DescribeTransitGatewayRouteTables - read: - - ec2:DescribeTransitGatewayRouteTables - delete: - - ec2:DeleteTransitGatewayRouteTable - - ec2:DescribeTransitGatewayRouteTables - - ec2:GetTransitGatewayRouteTableAssociations - - ec2:DisassociateTransitGatewayRouteTable - list: - - ec2:DescribeTransitGatewayRouteTables - TransitGatewayVpcAttachment: + - ClassicLoadBalancers + LaunchTemplateOverrides: type: object + additionalProperties: false properties: - Options: - description: The options for the transit gateway vpc attachment. - additionalProperties: false - type: object - properties: - Ipv6Support: - description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' - type: string - ApplianceModeSupport: - description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' - type: string - DnsSupport: - description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable' - type: string - TransitGatewayId: + AvailabilityZone: type: string - VpcId: + InstanceType: type: string - RemoveSubnetIds: - uniqueItems: false - x-insertionOrder: false + SpotPrice: + type: string + SubnetId: + type: string + WeightedCapacity: + type: number + InstanceRequirements: + $ref: '#/components/schemas/InstanceRequirementsRequest' + Priority: + type: number + SpotFleetMonitoring: + type: object + additionalProperties: false + properties: + Enabled: + type: boolean + default: false + SpotPlacement: + type: object + additionalProperties: false + properties: + AvailabilityZone: + type: string + GroupName: + type: string + Tenancy: + type: string + enum: + - dedicated + - default + - host + InstanceNetworkInterfaceSpecification: + type: object + additionalProperties: false + properties: + AssociatePublicIpAddress: + type: boolean + DeleteOnTermination: + type: boolean + Description: + type: string + DeviceIndex: + type: integer + Groups: type: array + uniqueItems: true items: type: string - Id: - type: string - SubnetIds: - uniqueItems: false - x-insertionOrder: false + Ipv6AddressCount: + type: integer + Ipv6Addresses: type: array + uniqueItems: true items: - type: string - AddSubnetIds: - uniqueItems: false - x-insertionOrder: false + $ref: '#/components/schemas/InstanceIpv6Address' + NetworkInterfaceId: + type: string + PrivateIpAddresses: type: array + uniqueItems: true items: - type: string - Tags: - uniqueItems: false - x-insertionOrder: false + $ref: '#/components/schemas/PrivateIpAddressSpecification' + SecondaryPrivateIpAddressCount: + type: integer + SubnetId: + type: string + TargetGroupsConfig: + type: object + additionalProperties: false + properties: + TargetGroups: type: array + uniqueItems: true items: - $ref: '#/components/schemas/Tag' + $ref: '#/components/schemas/TargetGroup' required: - - SubnetIds - - VpcId - - TransitGatewayId - x-stackql-resource-name: transit_gateway_vpc_attachment - x-stackql-primaryIdentifier: - - Id - x-create-only-properties: - - TransitGatewayId - - SubnetIds - - VpcId - x-read-only-properties: - - Id - x-required-permissions: - read: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:CreateTransitGatewayVpcAttachment - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeTags - - ec2:DescribeTransitGatewayAttachments - - ec2:ModifyTransitGatewayVpcAttachment - create: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:CreateTransitGatewayVpcAttachment - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeTags - - ec2:DescribeTransitGatewayAttachments - - ec2:ModifyTransitGatewayVpcAttachment - update: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:DescribeTags - - ec2:CreateTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:DeleteTags - - ec2:ModifyTransitGatewayVpcAttachment - list: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:DescribeTags - - ec2:CreateTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:DeleteTags - - ec2:ModifyTransitGatewayVpcAttachment - delete: - - ec2:DescribeTransitGatewayAttachments - - ec2:DescribeTransitGatewayVpcAttachments - - ec2:CreateTransitGatewayVpcAttachment - - ec2:DeleteTransitGatewayVpcAttachment - - ec2:CreateTags - - ec2:DeleteTags - - ec2:DescribeTags - - ec2:DescribeTransitGatewayAttachments - - ec2:ModifyTransitGatewayVpcAttachment - NetworkInterfaceOptions: - description: The options for network-interface type endpoint. + - TargetGroups + TargetGroup: type: object + additionalProperties: false properties: - NetworkInterfaceId: - description: The ID of the network interface. - type: string - Port: - description: The IP port number. - type: integer - minimum: 1 - maximum: 65535 - Protocol: - description: The IP protocol. + Arn: type: string - additionalProperties: false - LoadBalancerOptions: - description: The load balancer details if creating the AWS Verified Access endpoint as load-balancertype. + required: + - Arn + ClassicLoadBalancer: type: object + additionalProperties: false properties: - LoadBalancerArn: - description: The ARN of the load balancer. - type: string - Port: - description: The IP port number. - type: integer - minimum: 1 - maximum: 65535 - Protocol: - description: The IP protocol. + Name: type: string - SubnetIds: - description: The IDs of the subnets. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/SubnetId' - additionalProperties: false - SubnetId: - description: The IDs of the subnet. - type: string - SseSpecification: - description: The configuration options for customer provided KMS encryption. + required: + - Name + SpotFleet: type: object properties: - KmsKeyArn: - description: KMS Key Arn used to encrypt the group policy + Id: type: string - CustomerManagedKeyEnabled: - description: Whether to encrypt the policy with the provided key or disable encryption - type: boolean - additionalProperties: false - VerifiedAccessEndpoint: + SpotFleetRequestConfigData: + $ref: '#/components/schemas/SpotFleetRequestConfigData' + required: + - SpotFleetRequestConfigData + x-stackql-resource-name: spot_fleet + description: Resource Type definition for AWS::EC2::SpotFleet + x-type-name: AWS::EC2::SpotFleet + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SpotFleetRequestConfigData/AllocationStrategy + - SpotFleetRequestConfigData/IamFleetRole + - SpotFleetRequestConfigData/InstanceInterruptionBehavior + - SpotFleetRequestConfigData/InstancePoolsToUseCount + - SpotFleetRequestConfigData/LaunchSpecifications + - SpotFleetRequestConfigData/LaunchTemplateConfigs + - SpotFleetRequestConfigData/LoadBalancersConfig + - SpotFleetRequestConfigData/OnDemandAllocationStrategy + - SpotFleetRequestConfigData/OnDemandMaxTotalPrice + - SpotFleetRequestConfigData/OnDemandTargetCapacity + - SpotFleetRequestConfigData/ReplaceUnhealthyInstances + - SpotFleetRequestConfigData/SpotMaintenanceStrategies + - SpotFleetRequestConfigData/SpotMaxTotalPrice + - SpotFleetRequestConfigData/SpotPrice + - SpotFleetRequestConfigData/TagSpecifications + - SpotFleetRequestConfigData/TerminateInstancesWithExpiration + - SpotFleetRequestConfigData/Type + - SpotFleetRequestConfigData/ValidFrom + - SpotFleetRequestConfigData/ValidUntil + x-write-only-properties: + - SpotFleetRequestConfigData/TagSpecifications + - SpotFleetRequestConfigData/LaunchSpecifications/*/NetworkInterfaces/*/Groups + x-read-only-properties: + - Id + x-required-properties: + - SpotFleetRequestConfigData + x-tagging: + taggable: false + x-required-permissions: + create: + - iam:PassRole + - ec2:CreateTags + - ec2:RequestSpotFleet + - ec2:DescribeSpotFleetRequests + - ec2:RunInstances + delete: + - ec2:DescribeSpotFleetRequests + - ec2:CancelSpotFleetRequests + list: + - ec2:DescribeSpotFleetRequests + read: + - ec2:DescribeSpotFleetRequests + update: + - ec2:ModifySpotFleetRequest + - ec2:DescribeSpotFleetRequests + Subnet: type: object properties: - VerifiedAccessEndpointId: - description: The ID of the AWS Verified Access endpoint. + AssignIpv6AddressOnCreation: + type: boolean + description: |- + Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. + If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. + VpcId: type: string - VerifiedAccessGroupId: - description: The ID of the AWS Verified Access group. + description: |- + The ID of the VPC the subnet is in. + If you update this property, you must also update the ``CidrBlock`` property. + MapPublicIpOnLaunch: + type: boolean + description: |- + Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. + AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/). + EnableLniAtDeviceIndex: + type: integer + description: Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1). + NetworkAclAssociationId: type: string - VerifiedAccessInstanceId: - description: The ID of the AWS Verified Access instance. + description: '' + AvailabilityZone: type: string - Status: - description: The endpoint status. + description: |- + The Availability Zone of the subnet. + If you update this property, you must also update the ``CidrBlock`` property. + AvailabilityZoneId: type: string - SecurityGroupIds: - description: The IDs of the security groups for the endpoint. + description: The AZ ID of the subnet. + CidrBlock: + type: string + description: |- + The IPv4 CIDR block assigned to the subnet. + If you update this property, we create a new subnet, and then delete the existing one. + SubnetId: + type: string + description: '' + Ipv6CidrBlocks: type: array - uniqueItems: true - x-insertionOrder: false + uniqueItems: false items: - $ref: '#/components/schemas/SecurityGroupId' - NetworkInterfaceOptions: - description: The options for network-interface type endpoint. - $ref: '#/components/schemas/NetworkInterfaceOptions' - LoadBalancerOptions: - description: The load balancer details if creating the AWS Verified Access endpoint as load-balancer type. - $ref: '#/components/schemas/LoadBalancerOptions' - EndpointType: - description: The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. - type: string - EndpointDomain: - description: A DNS name that is generated for the endpoint. + type: string + description: '' + Ipv6CidrBlock: type: string - EndpointDomainPrefix: - description: A custom identifier that gets prepended to a DNS name that is generated for the endpoint. + description: |- + The IPv6 CIDR block. + If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. + OutpostArn: type: string - DeviceValidationDomain: - description: Returned if endpoint has a device trust provider attached. + description: The Amazon Resource Name (ARN) of the Outpost. + Ipv6Native: + type: boolean + description: Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*. + EnableDns64: + type: boolean + description: |- + Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. + You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a ``0.0.0.0/0`` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *User Guide*. + PrivateDnsNameOptionsOnLaunch: + type: object + additionalProperties: false + properties: + HostnameType: + type: string + EnableResourceNameDnsARecord: + type: boolean + EnableResourceNameDnsAAAARecord: + type: boolean + description: |- + The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. + Available options: + + EnableResourceNameDnsAAAARecord (true | false) + + EnableResourceNameDnsARecord (true | false) + + HostnameType (ip-name | resource-name) + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + description: Any tags assigned to the subnet. + Ipv4IpamPoolId: type: string - DomainCertificateArn: - description: The ARN of a public TLS/SSL certificate imported into or created with ACM. + description: An IPv4 IPAM pool ID for the subnet. + Ipv4NetmaskLength: + type: integer + description: An IPv4 netmask length for the subnet. + Ipv6IpamPoolId: type: string - AttachmentType: - description: The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. - type: string - ApplicationDomain: - description: The DNS name for users to reach your application. - type: string - CreationTime: - description: The creation time. - type: string - LastUpdatedTime: - description: The last updated time. - type: string - Description: - description: A description for the AWS Verified Access endpoint. - type: string - PolicyDocument: - description: The AWS Verified Access policy document. - type: string - PolicyEnabled: - description: The status of the Verified Access policy. - type: boolean - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - SseSpecification: - description: The configuration options for customer provided KMS encryption. - $ref: '#/components/schemas/SseSpecification' + description: An IPv6 IPAM pool ID for the subnet. + Ipv6NetmaskLength: + type: integer + description: An IPv6 netmask length for the subnet. + BlockPublicAccessStates: + type: object + additionalProperties: false + description: '' + properties: + InternetGatewayBlockMode: + type: string + description: 'The mode of VPC BPA. Options here are off, block-bidirectional, block-ingress ' required: - - ApplicationDomain - - AttachmentType - - DomainCertificateArn - - EndpointType - - VerifiedAccessGroupId - - EndpointDomainPrefix - x-stackql-resource-name: verified_access_endpoint - x-stackql-primaryIdentifier: - - VerifiedAccessEndpointId + - VpcId + x-stackql-resource-name: subnet + description: |- + Specifies a subnet for the specified VPC. + For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block. + For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*. + x-type-name: AWS::EC2::Subnet + x-stackql-primary-identifier: + - SubnetId x-create-only-properties: - - ApplicationDomain - - AttachmentType - - DomainCertificateArn - - EndpointDomainPrefix - - EndpointType - - SecurityGroupIds - - NetworkInterfaceOptions/NetworkInterfaceId - - LoadBalancerOptions/LoadBalancerArn + - VpcId + - AvailabilityZone + - AvailabilityZoneId + - CidrBlock + - OutpostArn + - Ipv6Native + - Ipv4IpamPoolId + - Ipv4NetmaskLength + - Ipv6IpamPoolId + - Ipv6NetmaskLength + x-conditional-create-only-properties: + - Ipv6CidrBlock + x-write-only-properties: + - EnableLniAtDeviceIndex + - Ipv4IpamPoolId + - Ipv4NetmaskLength + - Ipv6IpamPoolId + - Ipv6NetmaskLength x-read-only-properties: - - VerifiedAccessEndpointId - - EndpointDomain - - CreationTime - - LastUpdatedTime - - Status - - DeviceValidationDomain - - VerifiedAccessInstanceId + - NetworkAclAssociationId + - SubnetId + - Ipv6CidrBlocks + - BlockPublicAccessStates + x-required-properties: + - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVerifiedAccessEndpoint - - ec2:DescribeVerifiedAccessEndpoints - - ec2:CreateTags - - ec2:DescribeTags - - iam:CreateServiceLinkedRole - - iam:ListRoles - - acm:GetCertificateWithPK - - acm:DescribeCertificate - - acm:CreateCertificateRelation - - sso:GetManagedApplicationInstance - - sso:GetPeregrineStatus - - sso:GetSharedSsoConfiguration - - sso:CreateManagedApplicationInstance - ec2:DescribeSubnets - - ec2:DescribeSecurityGroups - - ec2:DescribeNetworkInterfaces - - ec2:DescribeAccountAttributes - - elasticloadbalancing:DescribeLoadBalancers - - elasticloadbalancing:DescribeListeners - - elasticloadbalancing:DescribeListenerCertificates - - acm:DeleteCertificateRelation - - ec2:DeleteTags - - ec2:DeleteVerifiedAccessEndpoint - - ec2:GetVerifiedAccessEndpointPolicy - - ec2:ModifyVerifiedAccessEndpoint - - ec2:ModifyVerifiedAccessEndpointPolicy - - sso:DeleteManagedApplicationInstance - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt - read: - - ec2:DescribeVerifiedAccessEndpoints - - ec2:GetVerifiedAccessEndpointPolicy - - ec2:DescribeTags - - acm:CreateCertificateRelation - - acm:DeleteCertificateRelation - - acm:DescribeCertificate - - acm:GetCertificateWithPK + - ec2:CreateSubnet - ec2:CreateTags - - ec2:CreateVerifiedAccessEndpoint - - ec2:DeleteTags - - ec2:DeleteVerifiedAccessEndpoint - - ec2:DescribeAccountAttributes - - ec2:DescribeNetworkInterfaces - - ec2:DescribeSecurityGroups + - ec2:ModifySubnetAttribute + read: - ec2:DescribeSubnets - - ec2:ModifyVerifiedAccessEndpoint - - ec2:ModifyVerifiedAccessEndpointPolicy - - elasticloadbalancing:DescribeListenerCertificates - - elasticloadbalancing:DescribeListeners - - elasticloadbalancing:DescribeLoadBalancers - - iam:CreateServiceLinkedRole - - iam:ListRoles - - sso:CreateManagedApplicationInstance - - sso:DeleteManagedApplicationInstance - - sso:GetManagedApplicationInstance - - sso:GetPeregrineStatus - - sso:GetSharedSsoConfiguration - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt + - ec2:DescribeNetworkAcls update: - - ec2:ModifyVerifiedAccessEndpoint - - ec2:ModifyVerifiedAccessEndpointPolicy - - ec2:DescribeVerifiedAccessEndpoints - - ec2:GetVerifiedAccessEndpointPolicy - - ec2:DescribeTags - - ec2:DeleteTags - - ec2:CreateTags - - acm:GetCertificateWithPK - - acm:DescribeCertificate - - acm:CreateCertificateRelation - - acm:DeleteCertificateRelation - - sso:GetManagedApplicationInstance - - sso:GetPeregrineStatus - - sso:GetSharedSsoConfiguration - - sso:CreateManagedApplicationInstance - - sso:DeleteManagedApplicationInstance - ec2:DescribeSubnets - - ec2:DescribeSecurityGroups - - ec2:DescribeNetworkInterfaces - - ec2:DescribeAccountAttributes - - elasticloadbalancing:DescribeLoadBalancers - - elasticloadbalancing:DescribeListeners - - elasticloadbalancing:DescribeListenerCertificates - - ec2:CreateVerifiedAccessEndpoint - - ec2:DeleteVerifiedAccessEndpoint - - iam:CreateServiceLinkedRole - - iam:ListRoles - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt - delete: - - ec2:DescribeVerifiedAccessEndpoints - - ec2:DescribeTags - - ec2:DeleteVerifiedAccessEndpoint - - ec2:DeleteTags - - sso:DeleteManagedApplicationInstance - - acm:DeleteCertificateRelation - - acm:DescribeCertificate - - acm:CreateCertificateRelation - - acm:GetCertificateWithPK + - ec2:ModifySubnetAttribute - ec2:CreateTags - - ec2:CreateVerifiedAccessEndpoint - - ec2:DescribeAccountAttributes - - ec2:DescribeNetworkInterfaces - - ec2:DescribeSecurityGroups + - ec2:DeleteTags + - ec2:AssociateSubnetCidrBlock + - ec2:DisassociateSubnetCidrBlock + delete: - ec2:DescribeSubnets - - ec2:GetVerifiedAccessEndpointPolicy - - ec2:ModifyVerifiedAccessEndpoint - - ec2:ModifyVerifiedAccessEndpointPolicy - - elasticloadbalancing:DescribeListenerCertificates - - elasticloadbalancing:DescribeListeners - - elasticloadbalancing:DescribeLoadBalancers - - iam:CreateServiceLinkedRole - - iam:ListRoles - - sso:CreateManagedApplicationInstance - - sso:GetManagedApplicationInstance - - sso:GetPeregrineStatus - - sso:GetSharedSsoConfiguration - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt + - ec2:DeleteSubnet list: - - ec2:DescribeVerifiedAccessEndpoints - - ec2:DescribeTags - - acm:CreateCertificateRelation - - acm:DeleteCertificateRelation - - acm:DescribeCertificate - - acm:GetCertificateWithPK - - ec2:CreateTags - - ec2:CreateVerifiedAccessEndpoint - - ec2:DeleteTags - - ec2:DeleteVerifiedAccessEndpoint - - ec2:DescribeAccountAttributes - - ec2:DescribeNetworkInterfaces - - ec2:DescribeSecurityGroups - ec2:DescribeSubnets - - ec2:GetVerifiedAccessEndpointPolicy - - ec2:ModifyVerifiedAccessEndpoint - - ec2:ModifyVerifiedAccessEndpointPolicy - - elasticloadbalancing:DescribeListenerCertificates - - elasticloadbalancing:DescribeListeners - - elasticloadbalancing:DescribeLoadBalancers - - iam:CreateServiceLinkedRole - - iam:ListRoles - - sso:CreateManagedApplicationInstance - - sso:DeleteManagedApplicationInstance - - sso:GetManagedApplicationInstance - - sso:GetPeregrineStatus - - sso:GetSharedSsoConfiguration - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt - VerifiedAccessGroup: + - ec2:DescribeNetworkAcls + SubnetCidrBlock: type: object properties: - VerifiedAccessGroupId: - description: The ID of the AWS Verified Access group. - type: string - VerifiedAccessInstanceId: - description: The ID of the AWS Verified Access instance. - type: string - VerifiedAccessGroupArn: - description: The ARN of the Verified Access group. + Id: + description: Information about the IPv6 association. type: string - Owner: - description: The AWS account number that owns the group. + Ipv6CidrBlock: + description: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length type: string - CreationTime: - description: Time this Verified Access Group was created. + maxLength: 42 + Ipv6IpamPoolId: + description: The ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR type: string - LastUpdatedTime: - description: Time this Verified Access Group was last updated. + Ipv6NetmaskLength: + description: The netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool + type: integer + minimum: 0 + maximum: 128 + SubnetId: + description: The ID of the subnet type: string - Description: - description: A description for the AWS Verified Access group. + Ipv6AddressAttribute: type: string - PolicyDocument: - description: The AWS Verified Access policy document. + description: The value denoting whether an IPv6 Subnet CIDR Block is public or private. + IpSource: type: string - PolicyEnabled: - description: The status of the Verified Access policy. - type: boolean - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - SseSpecification: - description: The configuration options for customer provided KMS encryption. - $ref: '#/components/schemas/SseSpecification' + description: The IP Source of an IPv6 Subnet CIDR Block. required: - - VerifiedAccessInstanceId - x-stackql-resource-name: verified_access_group - x-stackql-primaryIdentifier: - - VerifiedAccessGroupId + - SubnetId + x-stackql-resource-name: subnet_cidr_block + description: The AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR + x-type-name: AWS::EC2::SubnetCidrBlock + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Ipv6CidrBlock + - SubnetId + - Ipv6IpamPoolId + - Ipv6NetmaskLength + x-write-only-properties: + - Ipv6IpamPoolId + - Ipv6NetmaskLength x-read-only-properties: - - VerifiedAccessGroupId - - CreationTime - - LastUpdatedTime - - Owner - - VerifiedAccessGroupArn + - Id + - Ipv6AddressAttribute + - IpSource + x-required-properties: + - SubnetId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:CreateVerifiedAccessGroup - - ec2:DescribeVerifiedAccessGroups - - ec2:GetVerifiedAccessGroupPolicy - - ec2:CreateTags - - ec2:DescribeTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt - read: - - ec2:DescribeVerifiedAccessGroups - - ec2:GetVerifiedAccessGroupPolicy - - ec2:DescribeTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt - update: - - ec2:ModifyVerifiedAccessGroup - - ec2:ModifyVerifiedAccessGroupPolicy - - ec2:DescribeVerifiedAccessGroups - - ec2:GetVerifiedAccessGroupPolicy - - ec2:DescribeTags - - ec2:DeleteTags - - ec2:CreateTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt + - ec2:AssociateSubnetCidrBlock + - ec2:DescribeSubnets delete: - - ec2:DeleteVerifiedAccessGroup - - ec2:DeleteTags - - ec2:DescribeVerifiedAccessGroups - - ec2:DescribeTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt + - ec2:DisassociateSubnetCidrBlock + - ec2:DescribeSubnets list: - - ec2:DescribeVerifiedAccessGroups - - ec2:DescribeTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt - VerifiedAccessTrustProvider: + - ec2:DescribeSubnets + read: + - ec2:DescribeSubnets + SubnetNetworkAclAssociation: type: object properties: - TrustProviderType: - description: 'Type of trust provider. Possible values: user|device' + SubnetId: type: string - DeviceTrustProviderType: - description: 'The type of device-based trust provider. Possible values: jamf|crowdstrike' + description: The ID of the subnet + NetworkAclId: type: string - UserTrustProviderType: - description: 'The type of device-based trust provider. Possible values: oidc|iam-identity-center' + description: The ID of the network ACL + AssociationId: type: string - OidcOptions: - $ref: '#/components/schemas/OidcOptions' - DeviceOptions: - $ref: '#/components/schemas/DeviceOptions' - PolicyReferenceName: - description: The identifier to be used when working with policy rules. + required: + - NetworkAclId + - SubnetId + x-stackql-resource-name: subnet_network_acl_association + description: Resource Type definition for AWS::EC2::SubnetNetworkAclAssociation + x-type-name: AWS::EC2::SubnetNetworkAclAssociation + x-stackql-primary-identifier: + - AssociationId + x-create-only-properties: + - SubnetId + - NetworkAclId + x-read-only-properties: + - AssociationId + x-required-properties: + - NetworkAclId + - SubnetId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:DescribeNetworkAcls + - ec2:ReplaceNetworkAclAssociation + read: + - ec2:DescribeNetworkAcls + delete: + - ec2:DescribeNetworkAcls + - ec2:ReplaceNetworkAclAssociation + list: + - ec2:DescribeNetworkAcls + SubnetRouteTableAssociation: + type: object + properties: + RouteTableId: + description: |- + The ID of the route table. + The physical ID changes when the route table ID is changed. type: string - CreationTime: - description: The creation time. + Id: + description: '' type: string - LastUpdatedTime: - description: The last updated time. + SubnetId: + description: The ID of the subnet. type: string - VerifiedAccessTrustProviderId: - description: The ID of the Amazon Web Services Verified Access trust provider. + required: + - RouteTableId + - SubnetId + x-stackql-resource-name: subnet_route_table_association + description: Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html). + x-type-name: AWS::EC2::SubnetRouteTableAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SubnetId + - RouteTableId + x-read-only-properties: + - Id + x-required-properties: + - RouteTableId + - SubnetId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:DescribeRouteTables + create: + - ec2:AssociateRouteTable + - ec2:ReplaceRouteTableAssociation + - ec2:DescribeSubnets + - ec2:DescribeRouteTables + list: + - ec2:DescribeRouteTables + delete: + - ec2:DisassociateRouteTable + - ec2:DescribeSubnets + - ec2:DescribeRouteTables + TrafficMirrorNetworkService: + description: The network service traffic that is associated with the traffic mirror filter. + type: string + enum: + - amazon-dns + TrafficMirrorFilter: + type: object + properties: + Id: + description: The ID of a traffic mirror filter. type: string + NetworkServices: + description: The network service that is associated with the traffic mirror filter. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TrafficMirrorNetworkService' Description: - description: A description for the Amazon Web Services Verified Access trust provider. + description: The description of a traffic mirror filter. type: string Tags: - description: An array of key-value pairs to apply to this resource. + description: The tags for a traffic mirror filter. type: array - uniqueItems: true + uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - SseSpecification: - description: The configuration options for customer provided KMS encryption. - type: object - properties: - KmsKeyArn: - description: KMS Key Arn used to encrypt the group policy - type: string - CustomerManagedKeyEnabled: - description: Whether to encrypt the policy with the provided key or disable encryption - type: boolean - additionalProperties: false - required: - - TrustProviderType - - PolicyReferenceName - x-stackql-resource-name: verified_access_trust_provider - x-stackql-primaryIdentifier: - - VerifiedAccessTrustProviderId + x-stackql-resource-name: traffic_mirror_filter + description: Resource schema for AWS::EC2::TrafficMirrorFilter + x-type-name: AWS::EC2::TrafficMirrorFilter + x-stackql-primary-identifier: + - Id x-create-only-properties: - - PolicyReferenceName - - DeviceOptions - - DeviceTrustProviderType - - TrustProviderType - - UserTrustProviderType + - Description x-read-only-properties: - - VerifiedAccessTrustProviderId - - CreationTime - - LastUpdatedTime + - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVerifiedAccessTrustProvider - - ec2:DescribeVerifiedAccessTrustProviders + - ec2:CreateTrafficMirrorFilter + - ec2:DescribeTrafficMirrorFilters - ec2:CreateTags + - ec2:ModifyTrafficMirrorFilterNetworkServices - ec2:DescribeTags - - sso:GetSharedSsoConfiguration - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt read: - - ec2:DescribeVerifiedAccessTrustProviders + - ec2:DescribeTrafficMirrorFilters - ec2:DescribeTags - - kms:DescribeKey - - kms:GenerateDataKey - - kms:Decrypt update: - - ec2:ModifyVerifiedAccessTrustProvider - - ec2:DescribeVerifiedAccessTrustProviders - - ec2:DescribeTags - - ec2:DeleteTags + - ec2:ModifyTrafficMirrorFilterNetworkServices + - ec2:DescribeTrafficMirrorFilters - ec2:CreateTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt + - ec2:DeleteTags + - ec2:DescribeTags delete: - - ec2:DeleteVerifiedAccessTrustProvider + - ec2:DescribeTrafficMirrorFilters + - ec2:DeleteTrafficMirrorFilter - ec2:DeleteTags - - ec2:DescribeVerifiedAccessTrustProviders - ec2:DescribeTags - - kms:DescribeKey - - kms:RetireGrant - - kms:CreateGrant - - kms:GenerateDataKey - - kms:Decrypt list: - - ec2:DescribeVerifiedAccessTrustProviders + - ec2:DescribeTrafficMirrorFilters - ec2:DescribeTags - - kms:DescribeKey - - kms:GenerateDataKey - - kms:Decrypt - VerifiedAccessTrustProviderId: - description: The ID of the AWS Verified Access trust provider. - type: string - VerifiedAccessLogs: - description: The configuration options for AWS Verified Access instances. + TrafficMirrorPortRange: type: object + additionalProperties: false properties: - LogVersion: - description: Select log version for Verified Access logs. - type: string - IncludeTrustContext: - description: Include claims from trust providers in Verified Access logs. - type: boolean - CloudWatchLogs: - description: Sends Verified Access logs to CloudWatch Logs. - type: object - properties: - Enabled: - description: Indicates whether logging is enabled. - type: boolean - LogGroup: - description: The ID of the CloudWatch Logs log group. - type: string - additionalProperties: false - KinesisDataFirehose: - description: Sends Verified Access logs to Kinesis. - type: object - properties: - Enabled: - description: Indicates whether logging is enabled. - type: boolean - DeliveryStream: - description: The ID of the delivery stream. - type: string - additionalProperties: false - S3: - description: Sends Verified Access logs to Amazon S3. - type: object - properties: - Enabled: - description: Indicates whether logging is enabled. - type: boolean - BucketName: - description: The bucket name. - type: string - BucketOwner: - description: The ID of the AWS account that owns the Amazon S3 bucket. - type: string - Prefix: - description: The bucket prefix. - type: string - additionalProperties: false - additionalProperties: false - VerifiedAccessInstance: + FromPort: + description: The first port in the Traffic Mirror port range. + type: integer + ToPort: + description: The last port in the Traffic Mirror port range. + type: integer + required: + - FromPort + - ToPort + TrafficMirrorRuleAction: + description: The action to take on the filtered traffic. + type: string + TrafficDirection: + description: The type of traffic. + type: string + TrafficMirrorFilterRule: type: object properties: - VerifiedAccessInstanceId: - description: The ID of the AWS Verified Access instance. + DestinationPortRange: + description: The destination port range. + $ref: '#/components/schemas/TrafficMirrorPortRange' + Description: + description: The description of the Traffic Mirror Filter rule. type: string - VerifiedAccessTrustProviders: - description: AWS Verified Access trust providers. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/VerifiedAccessTrustProvider' - VerifiedAccessTrustProviderIds: - description: The IDs of the AWS Verified Access trust providers. + SourcePortRange: + description: The source port range. + $ref: '#/components/schemas/TrafficMirrorPortRange' + RuleAction: + description: The action to take on the filtered traffic (accept/reject). + $ref: '#/components/schemas/TrafficMirrorRuleAction' + SourceCidrBlock: + description: The source CIDR block to assign to the Traffic Mirror Filter rule. + type: string + RuleNumber: + description: The number of the Traffic Mirror rule. + type: integer + DestinationCidrBlock: + description: The destination CIDR block to assign to the Traffic Mirror rule. + type: string + TrafficMirrorFilterRuleId: + description: The ID of the Traffic Mirror Filter rule. + type: string + TrafficMirrorFilterId: + description: The ID of the filter that this rule is associated with. + type: string + TrafficDirection: + description: The direction of traffic (ingress/egress). + $ref: '#/components/schemas/TrafficDirection' + Protocol: + description: The number of protocol, for example 17 (UDP), to assign to the Traffic Mirror rule. + type: integer + Tags: + description: Any tags assigned to the Traffic Mirror Filter rule. type: array - uniqueItems: true + uniqueItems: false x-insertionOrder: false items: - $ref: '#/components/schemas/VerifiedAccessTrustProviderId' - CreationTime: - description: Time this Verified Access Instance was created. + $ref: '#/components/schemas/Tag' + required: + - RuleAction + - SourceCidrBlock + - RuleNumber + - DestinationCidrBlock + - TrafficMirrorFilterId + - TrafficDirection + x-stackql-resource-name: traffic_mirror_filter_rule + description: Resource Type definition for for AWS::EC2::TrafficMirrorFilterRule + x-type-name: AWS::EC2::TrafficMirrorFilterRule + x-stackql-primary-identifier: + - TrafficMirrorFilterRuleId + x-create-only-properties: + - TrafficMirrorFilterId + x-read-only-properties: + - TrafficMirrorFilterRuleId + x-required-properties: + - RuleAction + - SourceCidrBlock + - RuleNumber + - DestinationCidrBlock + - TrafficMirrorFilterId + - TrafficDirection + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateTrafficMirrorFilterRule + - ec2:CreateTags + - ec2:DescribeTrafficMirrorFilterRules + read: + - ec2:DescribeTrafficMirrorFilterRules + update: + - ec2:ModifyTrafficMirrorFilterRule + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteTrafficMirrorFilterRule + list: + - ec2:DescribeTrafficMirrorFilterRules + TrafficMirrorSessionField: + type: string + enum: + - packet-length + - description + - virtual-network-id + TrafficMirrorSession: + type: object + properties: + Id: + description: The ID of a Traffic Mirror session. type: string - LastUpdatedTime: - description: Time this Verified Access Instance was last updated. + NetworkInterfaceId: + description: The ID of the source network interface. + type: string + TrafficMirrorTargetId: + description: The ID of a Traffic Mirror target. + type: string + TrafficMirrorFilterId: + description: The ID of a Traffic Mirror filter. type: string + PacketLength: + description: The number of bytes in each packet to mirror. + type: integer + SessionNumber: + description: The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. + type: integer + VirtualNetworkId: + description: The VXLAN ID for the Traffic Mirror session. + type: integer Description: - description: A description for the AWS Verified Access instance. + description: The description of the Traffic Mirror session. + type: string + OwnerId: + description: The ID of the account that owns the Traffic Mirror session. type: string - LoggingConfigurations: - description: The configuration options for AWS Verified Access instances. - $ref: '#/components/schemas/VerifiedAccessLogs' Tags: - description: An array of key-value pairs to apply to this resource. + description: The tags assigned to the Traffic Mirror session. type: array - uniqueItems: true + uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - FipsEnabled: - description: Indicates whether FIPS is enabled - type: boolean - x-stackql-resource-name: verified_access_instance - x-stackql-primaryIdentifier: - - VerifiedAccessInstanceId + required: + - NetworkInterfaceId + - TrafficMirrorFilterId + - SessionNumber + - TrafficMirrorTargetId + x-stackql-resource-name: traffic_mirror_session + description: Resource schema for AWS::EC2::TrafficMirrorSession + x-type-name: AWS::EC2::TrafficMirrorSession + x-stackql-primary-identifier: + - Id x-read-only-properties: - - VerifiedAccessInstanceId - - CreationTime - - LastUpdatedTime + - Id + x-required-properties: + - NetworkInterfaceId + - TrafficMirrorFilterId + - SessionNumber + - TrafficMirrorTargetId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVerifiedAccessInstance - - ec2:AttachVerifiedAccessTrustProvider - - ec2:ModifyVerifiedAccessInstanceLoggingConfiguration - - ec2:DescribeVerifiedAccessInstances - - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations + - ec2:CreateTrafficMirrorSession + - ec2:DescribeTrafficMirrorSessions - ec2:CreateTags - ec2:DescribeTags - - logs:CreateLogDelivery - - logs:GetLogDelivery - - logs:UpdateLogDelivery - - logs:PutDestination - - logs:DeleteLogDelivery - - logs:ListLogDeliveries - - logs:PutLogEvents - - logs:DescribeLogStreams - - s3:listBuckets - - s3:PutObject - - s3:GetBucketPolicy - - s3:PutBucketPolicy - - logs:DescribeLogGroups - - logs:PutResourcePolicy - - firehose:TagDeliveryStream - - logs:DescribeResourcePolicies - - iam:CreateServiceLinkedRole - - verified-access:AllowVerifiedAccess read: - - ec2:DescribeVerifiedAccessInstances - - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations + - ec2:DescribeTrafficMirrorSessions - ec2:DescribeTags - - logs:GetLogDelivery - - logs:ListLogDeliveries update: - - ec2:ModifyVerifiedAccessInstance - - ec2:ModifyVerifiedAccessInstanceLoggingConfiguration - - ec2:DescribeVerifiedAccessInstances - - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations - - ec2:DescribeTags - - ec2:AttachVerifiedAccessTrustProvider - - ec2:DetachVerifiedAccessTrustProvider - - ec2:DeleteTags + - ec2:ModifyTrafficMirrorSession - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTrafficMirrorSessions - ec2:DescribeTags - - logs:CreateLogDelivery - - logs:GetLogDelivery - - logs:ListLogDeliveries - - logs:UpdateLogDelivery - - logs:DeleteLogDelivery - - logs:PutDestination - - logs:PutLogEvents - - logs:DescribeLogStreams - - s3:listBuckets - - s3:PutObject - - s3:GetBucketPolicy - - s3:PutBucketPolicy - - logs:DescribeLogGroups - - logs:PutResourcePolicy - - firehose:TagDeliveryStream - - iam:CreateServiceLinkedRole - - logs:DescribeResourcePolicies delete: - - ec2:DeleteVerifiedAccessInstance + - ec2:DeleteTrafficMirrorSession - ec2:DeleteTags - - ec2:DescribeVerifiedAccessInstances - - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations - - ec2:DetachVerifiedAccessTrustProvider - - ec2:GetVerifiedAccessGroupPolicy - - ec2:DescribeTags - - logs:ListLogDeliveries - - logs:GetLogDelivery - - logs:DeleteLogDelivery list: - - ec2:DescribeVerifiedAccessInstances + - ec2:DescribeTrafficMirrorSessions - ec2:DescribeTags - - logs:ListLogDeliveries - - logs:GetLogDelivery - OidcOptions: - description: The OpenID Connect details for an oidc -type, user-identity based trust provider. + TrafficMirrorTarget: type: object properties: - Issuer: + NetworkLoadBalancerArn: + description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. type: string - description: The OIDC issuer. - AuthorizationEndpoint: + Description: + description: The description of the Traffic Mirror target. type: string - description: The OIDC authorization endpoint. - TokenEndpoint: + Id: type: string - description: The OIDC token endpoint. - UserInfoEndpoint: + NetworkInterfaceId: + description: The network interface ID that is associated with the target. type: string - description: The OIDC user info endpoint. - ClientId: + GatewayLoadBalancerEndpointId: + description: The ID of the Gateway Load Balancer endpoint. type: string - description: The client identifier. - ClientSecret: + Tags: + description: ' The tags to assign to the Traffic Mirror target.' + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: traffic_mirror_target + description: The description of the Traffic Mirror target. + x-type-name: AWS::EC2::TrafficMirrorTarget + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - GatewayLoadBalancerEndpointId + - NetworkLoadBalancerArn + - NetworkInterfaceId + - Description + x-read-only-properties: + - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateTrafficMirrorTarget + - ec2:CreateTags + read: + - ec2:DescribeTrafficMirrorTargets + - ec2:DescribeTags + update: + - ec2:DescribeTrafficMirrorTargets + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeTags + delete: + - ec2:DeleteTrafficMirrorTarget + - ec2:DeleteTags + list: + - ec2:DescribeTrafficMirrorTargets + - ec2:DescribeTags + TransitGateway: + type: object + properties: + DefaultRouteTablePropagation: type: string - description: The client secret. - Scope: + TransitGatewayArn: type: string - description: OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes. - additionalProperties: false - DeviceOptions: - description: The options for device identity based trust providers. - type: object - properties: - TenantId: + Description: type: string - description: The ID of the tenant application with the device-identity provider. - PublicSigningKeyUrl: + AutoAcceptSharedAttachments: type: string - description: URL Verified Access will use to verify authenticity of the device tokens. - additionalProperties: false - Volume: - type: object - properties: - MultiAttachEnabled: - type: boolean - description: |- - Indicates whether Amazon EBS Multi-Attach is enabled. - CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. - KmsKeyId: + DefaultRouteTableAssociation: type: string - description: |- - The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. - If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. - Alternatively, if you want to specify a different key, you can specify one of the following: - + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. - + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. - + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - Encrypted: - type: boolean - description: |- - Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. - Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). - Size: - type: integer - description: |- - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. - The following are the supported volumes sizes for each volume type: - + ``gp2`` and ``gp3``: 1 - 16,384 GiB - + ``io1``: 4 - 16,384 GiB - + ``io2``: 4 - 65,536 GiB - + ``st1`` and ``sc1``: 125 - 16,384 GiB - + ``standard``: 1 - 1024 GiB - AutoEnableIO: - type: boolean - description: Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. - OutpostArn: + Id: type: string - description: The Amazon Resource Name (ARN) of the Outpost. - AvailabilityZone: + VpnEcmpSupport: type: string - description: The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. - Throughput: - type: integer - description: |- - The throughput to provision for a volume, with a maximum of 1,000 MiB/s. - This parameter is valid only for ``gp3`` volumes. The default value is 125. - Valid Range: Minimum value of 125. Maximum value of 1000. - Iops: - type: integer - description: |- - The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. - The following are the supported values for each volume type: - + ``gp3``: 3,000 - 16,000 IOPS - + ``io1``: 100 - 64,000 IOPS - + ``io2``: 100 - 256,000 IOPS - - For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. - This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. - SnapshotId: + DnsSupport: type: string - description: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. - VolumeType: + SecurityGroupReferencingSupport: type: string - description: |- - The volume type. This parameter can be one of the following values: - + General Purpose SSD: ``gp2`` | ``gp3`` - + Provisioned IOPS SSD: ``io1`` | ``io2`` - + Throughput Optimized HDD: ``st1`` - + Cold HDD: ``sc1`` - + Magnetic: ``standard`` - - For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. - Default: ``gp2`` - VolumeId: + MulticastSupport: type: string - description: '' + AmazonSideAsn: + type: integer + format: int64 + TransitGatewayCidrBlocks: + type: array + items: + type: string Tags: type: array uniqueItems: false - description: The tags to apply to the volume during creation. - x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - required: - - AvailabilityZone - x-stackql-resource-name: volume - x-stackql-primaryIdentifier: - - VolumeId + AssociationDefaultRouteTableId: + type: string + PropagationDefaultRouteTableId: + type: string + x-stackql-resource-name: transit_gateway + description: Resource Type definition for AWS::EC2::TransitGateway + x-type-name: AWS::EC2::TransitGateway + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - AmazonSideAsn + - MulticastSupport x-read-only-properties: - - VolumeId + - Id + - TransitGatewayArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVolume - - ec2:DescribeVolumes - - ec2:DescribeVolumeAttribute - - ec2:ModifyVolumeAttribute + - ec2:CreateTransitGateway - ec2:CreateTags - - kms:GenerateDataKeyWithoutPlaintext - - kms:CreateGrant + - ec2:DescribeTransitGateways + - ec2:DescribeTags read: - - ec2:DescribeVolumes - - ec2:DescribeVolumeAttribute + - ec2:DescribeTransitGateways - ec2:DescribeTags + delete: + - ec2:DescribeTransitGateways + - ec2:DescribeTags + - ec2:DeleteTransitGateway + - ec2:DeleteTags update: - - ec2:ModifyVolume - - ec2:ModifyVolumeAttribute - - ec2:DescribeVolumeAttribute - - ec2:DescribeVolumesModifications - - ec2:DescribeVolumes + - ec2:CreateTransitGateway - ec2:CreateTags + - ec2:DescribeTransitGateways + - ec2:DescribeTags + - ec2:DeleteTransitGateway - ec2:DeleteTags - delete: - - ec2:DeleteVolume - - ec2:CreateSnapshot - - ec2:DescribeSnapshots - - ec2:DeleteTags - - ec2:DescribeVolumes + - ec2:ModifyTransitGateway + - ec2:ModifyTransitGatewayOptions list: - - ec2:DescribeVolumes + - ec2:DescribeTransitGateways - ec2:DescribeTags - - ec2:DescribeVolumeAttribute - VolumeId: - description: The ID of the Amazon EBS volume - type: string - Id: - description: '' - type: string - InstanceId: - description: The ID of the instance to which the volume attaches - type: string - Device: - description: The device name - type: string - VolumeAttachment: - type: object - properties: - VolumeId: - $ref: '#/components/schemas/VolumeId' - description: The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume. - InstanceId: - $ref: '#/components/schemas/InstanceId' - description: The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance. - Device: - $ref: '#/components/schemas/Device' - description: The device name (for example, ``/dev/sdh`` or ``xvdh``). - required: - - VolumeId - - InstanceId - x-stackql-resource-name: volume_attachment - x-stackql-primaryIdentifier: - - VolumeId - - InstanceId - x-create-only-properties: - - Device - - InstanceId - - VolumeId - x-required-permissions: - create: - - ec2:AttachVolume - - ec2:DescribeVolumes - read: - - ec2:DescribeVolumes - delete: - - ec2:DetachVolume - - ec2:DescribeVolumes - list: - - ec2:DescribeVolumes - VPC: + TransitGatewayAttachment: type: object properties: + Options: + description: The options for the transit gateway vpc attachment. + additionalProperties: false + type: object + properties: + Ipv6Support: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + ApplianceModeSupport: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + SecurityGroupReferencingSupport: + description: 'Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid Values: enable | disable' + type: string + DnsSupport: + description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable' + type: string + TransitGatewayId: + type: string VpcId: type: string - description: '' - CidrBlock: + Id: type: string - description: |- - The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. - You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. - CidrBlockAssociations: - type: array - description: '' + SubnetIds: uniqueItems: false x-insertionOrder: false - items: - type: string - DefaultNetworkAcl: - type: string - x-insertionOrder: false - description: '' - DefaultSecurityGroup: - type: string - x-insertionOrder: false - description: '' - Ipv6CidrBlocks: type: array - description: '' - uniqueItems: false - x-insertionOrder: false items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId type: string - EnableDnsHostnames: - type: boolean - description: |- - Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). - You can only enable DNS hostnames if you've enabled DNS support. - EnableDnsSupport: - type: boolean - description: >- - Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your - VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). - InstanceTenancy: - type: string - description: |- - The allowed tenancy of instances launched into the VPC. - + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. - + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. - - Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement. - Ipv4IpamPoolId: - type: string - description: |- - The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. - You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. - Ipv4NetmaskLength: - type: integer - description: The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Tags: - type: array - description: The tags for the VPC. uniqueItems: false x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - x-stackql-resource-name: vpc - x-stackql-primaryIdentifier: + required: - VpcId + - SubnetIds + - TransitGatewayId + x-stackql-resource-name: transit_gateway_attachment + description: Resource Type definition for AWS::EC2::TransitGatewayAttachment + x-type-name: AWS::EC2::TransitGatewayAttachment + x-stackql-primary-identifier: + - Id x-create-only-properties: - - CidrBlock - - Ipv4IpamPoolId - - Ipv4NetmaskLength + - TransitGatewayId + - VpcId x-read-only-properties: - - CidrBlockAssociations - - DefaultNetworkAcl - - DefaultSecurityGroup - - Ipv6CidrBlocks + - Id + x-required-properties: - VpcId + - SubnetIds + - TransitGatewayId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DescribeTags create: - - ec2:CreateVpc - - ec2:DescribeVpcs - - ec2:ModifyVpcAttribute + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:CreateTransitGatewayVpcAttachment - ec2:CreateTags - read: - - ec2:DescribeVpcs - - ec2:DescribeSecurityGroups - - ec2:DescribeNetworkAcls - - ec2:DescribeVpcAttribute + - ec2:DescribeTags update: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DescribeTags + - ec2:CreateTransitGatewayVpcAttachment - ec2:CreateTags - - ec2:ModifyVpcAttribute + - ec2:DeleteTransitGatewayVpcAttachment - ec2:DeleteTags - - ec2:ModifyVpcTenancy - delete: - - ec2:DeleteVpc - - ec2:DescribeVpcs + - ec2:ModifyTransitGatewayVpcAttachment list: - - ec2:DescribeVpcs - VPCDHCPOptionsAssociation: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DescribeTags + delete: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DeleteTransitGatewayVpcAttachment + - ec2:DeleteTags + - ec2:DescribeTags + TransitGatewayConnectOptions: type: object properties: - DhcpOptionsId: + Protocol: + description: The tunnel protocol. type: string - description: The ID of the DHCP options set, or default to associate no DHCP options with the VPC. - VpcId: + additionalProperties: false + TransitGatewayConnect: + type: object + properties: + TransitGatewayAttachmentId: + description: The ID of the Connect attachment. type: string - description: The ID of the VPC. + TransportTransitGatewayAttachmentId: + description: The ID of the attachment from which the Connect attachment was created. + type: string + TransitGatewayId: + description: The ID of the transit gateway. + type: string + State: + description: The state of the attachment. + type: string + CreationTime: + description: The creation time. + type: string + Tags: + description: The tags for the attachment. + type: array + items: + $ref: '#/components/schemas/Tag' + Options: + $ref: '#/components/schemas/TransitGatewayConnectOptions' + description: The Connect attachment options. required: - - VpcId - - DhcpOptionsId - x-stackql-resource-name: vpcdhcp_options_association - x-stackql-primaryIdentifier: - - DhcpOptionsId - - VpcId + - TransportTransitGatewayAttachmentId + - Options + x-stackql-resource-name: transit_gateway_connect + description: The AWS::EC2::TransitGatewayConnect type + x-type-name: AWS::EC2::TransitGatewayConnect + x-stackql-primary-identifier: + - TransitGatewayAttachmentId x-create-only-properties: - - DhcpOptionsId - - VpcId + - TransportTransitGatewayAttachmentId + - Options + x-read-only-properties: + - TransitGatewayAttachmentId + - State + - CreationTime + - TransitGatewayId + x-required-properties: + - TransportTransitGatewayAttachmentId + - Options + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:AssociateDhcpOptions + - ec2:CreateTransitGatewayConnect + - ec2:DescribeTransitGatewayConnects + - ec2:CreateTags + - ec2:DescribeTags + read: + - ec2:DescribeTransitGatewayConnects + - ec2:DescribeTags update: - - ec2:AssociateDhcpOptions + - ec2:DescribeTransitGatewayConnects + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeTags delete: - - ec2:AssociateDhcpOptions - read: - - ec2:DescribeVpcs + - ec2:DeleteTransitGatewayConnect + - ec2:DescribeTransitGatewayConnects + - ec2:DeleteTags + - ec2:DescribeTags list: - - ec2:DescribeVpcs - VPCEndpoint: + - ec2:DescribeTransitGatewayConnects + - ec2:DescribeTags + TransitGatewayConnectPeerConfiguration: type: object properties: - Id: + TransitGatewayAddress: + description: The Connect peer IP address on the transit gateway side of the tunnel. type: string - description: '' - CreationTimestamp: + PeerAddress: + description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer. type: string - description: '' - DnsEntries: - type: array - uniqueItems: false - x-insertionOrder: false - items: - type: string - description: '' - NetworkInterfaceIds: - type: array - uniqueItems: false - x-insertionOrder: false - items: - type: string - description: '' - PolicyDocument: - type: object - description: |- - An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. - For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint. - PrivateDnsEnabled: - type: boolean - description: >- - Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC - endpoint service. - To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. - This property is supported only for interface endpoints. - Default: ``false`` - RouteTableIds: - type: array - description: The IDs of the route tables. Routing is supported only for gateway endpoints. - uniqueItems: true - x-insertionOrder: false - items: - type: string - SecurityGroupIds: + InsideCidrBlocks: + description: The range of interior BGP peer IP addresses. type: array - description: The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints. - uniqueItems: true - x-insertionOrder: false items: type: string - ServiceName: + Protocol: + description: The tunnel protocol. type: string - description: The name of the endpoint service. - SubnetIds: + BgpConfigurations: + description: The BGP configuration details. type: array - description: The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. - uniqueItems: true - x-insertionOrder: false items: - type: string - VpcEndpointType: + $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfiguration' + required: + - PeerAddress + - InsideCidrBlocks + additionalProperties: false + TransitGatewayAttachmentBgpConfiguration: + type: object + properties: + TransitGatewayAsn: + description: The transit gateway Autonomous System Number (ASN). + type: number + PeerAsn: + description: The peer Autonomous System Number (ASN). + type: number + TransitGatewayAddress: + description: The interior BGP peer IP address for the transit gateway. type: string - enum: - - Interface - - Gateway - - GatewayLoadBalancer - description: |- - The type of endpoint. - Default: Gateway - VpcId: + PeerAddress: + description: The interior BGP peer IP address for the appliance. type: string - description: The ID of the VPC. + BgpStatus: + description: The BGP status. + type: string + additionalProperties: false + TransitGatewayConnectPeer: + type: object + properties: + TransitGatewayAttachmentId: + description: The ID of the Connect attachment. + type: string + TransitGatewayConnectPeerId: + description: The ID of the Connect peer. + type: string + State: + description: The state of the Connect peer. + type: string + CreationTime: + description: The creation time. + type: string + ConnectPeerConfiguration: + description: The Connect peer details. + $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration' + Tags: + description: The tags for the Connect Peer. + type: array + items: + $ref: '#/components/schemas/Tag' required: - - VpcId - - ServiceName - x-stackql-resource-name: vpc_endpoint - x-stackql-primaryIdentifier: - - Id + - TransitGatewayAttachmentId + - ConnectPeerConfiguration + x-stackql-resource-name: transit_gateway_connect_peer + description: Resource Type definition for AWS::EC2::TransitGatewayConnectPeer + x-type-name: AWS::EC2::TransitGatewayConnectPeer + x-stackql-primary-identifier: + - TransitGatewayConnectPeerId x-create-only-properties: - - ServiceName - - VpcEndpointType - - VpcId + - TransitGatewayAttachmentId + - ConnectPeerConfiguration + - ConnectPeerConfiguration/PeerAddress + - ConnectPeerConfiguration/InsideCidrBlocks + - ConnectPeerConfiguration/TransitGatewayAddress + - ConnectPeerConfiguration/BgpConfigurations/*/PeerAsn x-read-only-properties: - - NetworkInterfaceIds - - CreationTimestamp - - DnsEntries - - Id + - TransitGatewayConnectPeerId + - ConnectPeerConfiguration/Protocol + - ConnectPeerConfiguration/BgpConfigurations + - ConnectPeerConfiguration/BgpConfigurations/*/TransitGatewayAddress + - ConnectPeerConfiguration/BgpConfigurations/*/BgpStatus + - ConnectPeerConfiguration/BgpConfigurations/*/PeerAddress + - ConnectPeerConfiguration/BgpConfigurations/*/TransitGatewayAsn + - State + - CreationTime + x-required-properties: + - TransitGatewayAttachmentId + - ConnectPeerConfiguration + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVpcEndpoint - - ec2:DescribeVpcEndpoints + - ec2:CreateTransitGatewayConnectPeer + - ec2:DescribeTransitGatewayConnectPeers + - ec2:CreateTags + - ec2:DescribeTags read: - - ec2:DescribeVpcEndpoints + - ec2:DescribeTransitGatewayConnectPeers + - ec2:DescribeTags update: - - ec2:ModifyVpcEndpoint - - ec2:DescribeVpcEndpoints + - ec2:DescribeTransitGatewayConnectPeers + - ec2:DeleteTags + - ec2:CreateTags delete: - - ec2:DeleteVpcEndpoints - - ec2:DescribeVpcEndpoints + - ec2:DeleteTransitGatewayConnectPeer + - ec2:DescribeTransitGatewayConnectPeers + - ec2:DeleteTags + - ec2:DescribeTags list: - - ec2:DescribeVpcEndpoints - VPCEndpointConnectionNotification: + - ec2:DescribeTransitGatewayConnectPeers + - ec2:DescribeTags + TransitGatewayMulticastDomain: type: object properties: - VPCEndpointConnectionNotificationId: - description: VPC Endpoint Connection ID generated by service + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. type: string - ConnectionEvents: - description: The endpoint events for which to receive notifications. - type: array - uniqueItems: false - x-insertionOrder: false - items: - type: string - ConnectionNotificationArn: - description: The ARN of the SNS topic for the notifications. + TransitGatewayMulticastDomainArn: + description: The Amazon Resource Name (ARN) of the transit gateway multicast domain. type: string - ServiceId: - description: The ID of the endpoint service. + TransitGatewayId: + description: The ID of the transit gateway. type: string - VPCEndpointId: - description: The ID of the endpoint. + State: + description: The state of the transit gateway multicast domain. + type: string + CreationTime: + description: The time the transit gateway multicast domain was created. type: string + format: date-time + Tags: + description: The tags for the transit gateway multicast domain. + type: array + items: + $ref: '#/components/schemas/Tag' + Options: + description: The options for the transit gateway multicast domain. + type: object + properties: + AutoAcceptSharedAssociations: + description: 'Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable' + type: string + Igmpv2Support: + description: 'Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable' + type: string + StaticSourcesSupport: + description: 'Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable' + type: string + additionalProperties: false required: - - ConnectionEvents - - ConnectionNotificationArn - x-stackql-resource-name: vpc_endpoint_connection_notification - x-stackql-primaryIdentifier: - - VPCEndpointConnectionNotificationId + - TransitGatewayId + x-stackql-resource-name: transit_gateway_multicast_domain + description: The AWS::EC2::TransitGatewayMulticastDomain type + x-type-name: AWS::EC2::TransitGatewayMulticastDomain + x-stackql-primary-identifier: + - TransitGatewayMulticastDomainId x-create-only-properties: - - ServiceId - - VPCEndpointId + - TransitGatewayId x-read-only-properties: - - VPCEndpointConnectionNotificationId + - TransitGatewayMulticastDomainId + - State + - CreationTime + - TransitGatewayMulticastDomainArn + x-required-properties: + - TransitGatewayId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVpcEndpointConnectionNotification + - ec2:DescribeTransitGatewayMulticastDomains + - ec2:CreateTransitGatewayMulticastDomain + - ec2:CreateTags + - ec2:DescribeTags read: - - ec2:DescribeVpcEndpointConnectionNotifications + - ec2:DescribeTransitGatewayMulticastDomains + - ec2:DescribeTags update: - - ec2:ModifyVpcEndpointConnectionNotification - - ec2:DescribeVpcEndpointConnectionNotifications + - ec2:DescribeTransitGatewayMulticastDomains + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeTags delete: - - ec2:DeleteVpcEndpointConnectionNotifications + - ec2:DescribeTransitGatewayMulticastDomains + - ec2:DeleteTransitGatewayMulticastDomain + - ec2:DeleteTags + - ec2:DescribeTags list: - - ec2:DescribeVpcEndpointConnectionNotifications - VPCEndpointService: + - ec2:DescribeTransitGatewayMulticastDomains + - ec2:DescribeTags + TransitGatewayMulticastDomainAssociation: type: object properties: - NetworkLoadBalancerArns: - type: array - uniqueItems: false - items: - type: string - ContributorInsightsEnabled: - type: boolean - PayerResponsibility: + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. type: string - ServiceId: + TransitGatewayAttachmentId: + description: The ID of the transit gateway attachment. type: string - AcceptanceRequired: - type: boolean - GatewayLoadBalancerArns: - type: array - uniqueItems: false - items: - type: string - x-stackql-resource-name: vpc_endpoint_service - x-stackql-primaryIdentifier: - - ServiceId + ResourceId: + description: The ID of the resource. + type: string + ResourceType: + description: The type of resource, for example a VPC attachment. + type: string + State: + description: The state of the subnet association. + type: string + SubnetId: + description: The IDs of the subnets to associate with the transit gateway multicast domain. + type: string + required: + - TransitGatewayMulticastDomainId + - TransitGatewayAttachmentId + - SubnetId + x-stackql-resource-name: transit_gateway_multicast_domain_association + description: The AWS::EC2::TransitGatewayMulticastDomainAssociation type + x-type-name: AWS::EC2::TransitGatewayMulticastDomainAssociation + x-stackql-primary-identifier: + - TransitGatewayMulticastDomainId + - TransitGatewayAttachmentId + - SubnetId + x-create-only-properties: + - TransitGatewayMulticastDomainId + - TransitGatewayAttachmentId + - SubnetId x-read-only-properties: - - ServiceId + - ResourceId + - ResourceType + - State + x-required-properties: + - TransitGatewayMulticastDomainId + - TransitGatewayAttachmentId + - SubnetId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:CreateVpcEndpointServiceConfiguration - - ec2:ModifyVpcEndpointServiceConfiguration - - ec2:ModifyVpcEndpointServicePayerResponsibility - - cloudwatch:ListManagedInsightRules - - cloudwatch:DeleteInsightRules - - cloudwatch:PutManagedInsightRules - - ec2:DescribeVpcEndpointServiceConfigurations - update: - - ec2:ModifyVpcEndpointServiceConfiguration - - ec2:DeleteVpcEndpointServiceConfigurations - - ec2:DescribeVpcEndpointServiceConfigurations - - ec2:ModifyVpcEndpointServicePayerResponsibility - - cloudwatch:ListManagedInsightRules - - cloudwatch:DeleteInsightRules - - cloudwatch:PutManagedInsightRules + - ec2:AssociateTransitGatewayMulticastDomain + - ec2:GetTransitGatewayMulticastDomainAssociations read: - - ec2:DescribeVpcEndpointServiceConfigurations - - cloudwatch:ListManagedInsightRules + - ec2:GetTransitGatewayMulticastDomainAssociations delete: - - ec2:DeleteVpcEndpointServiceConfigurations - - ec2:DescribeVpcEndpointServiceConfigurations - - cloudwatch:ListManagedInsightRules - - cloudwatch:DeleteInsightRules + - ec2:DisassociateTransitGatewayMulticastDomain + - ec2:GetTransitGatewayMulticastDomainAssociations list: - - ec2:DescribeVpcEndpointServiceConfigurations - - cloudwatch:ListManagedInsightRules - VPCEndpointServicePermissions: + - ec2:GetTransitGatewayMulticastDomainAssociations + TransitGatewayMulticastGroupMember: type: object properties: - AllowedPrincipals: - type: array - uniqueItems: false - items: - type: string - ServiceId: + GroupIpAddress: + description: The IP address assigned to the transit gateway multicast group. + type: string + TransitGatewayAttachmentId: + description: The ID of the transit gateway attachment. + type: string + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. + type: string + SubnetId: + description: The ID of the subnet. + type: string + ResourceId: + description: The ID of the resource. + type: string + ResourceType: + description: The type of resource, for example a VPC attachment. + type: string + NetworkInterfaceId: + description: The ID of the transit gateway attachment. + type: string + GroupMember: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + GroupSource: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + MemberType: + description: The member type (for example, static). type: string required: - - ServiceId - x-stackql-resource-name: vpc_endpoint_service_permissions - x-stackql-primaryIdentifier: - - ServiceId + - GroupIpAddress + - NetworkInterfaceId + - TransitGatewayMulticastDomainId + x-stackql-resource-name: transit_gateway_multicast_group_member + description: The AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group + x-type-name: AWS::EC2::TransitGatewayMulticastGroupMember + x-stackql-primary-identifier: + - TransitGatewayMulticastDomainId + - GroupIpAddress + - NetworkInterfaceId x-create-only-properties: - - ServiceId + - TransitGatewayMulticastDomainId + - GroupIpAddress + - NetworkInterfaceId + x-read-only-properties: + - SubnetId + - ResourceId + - ResourceType + - GroupSource + - GroupMember + - MemberType + - TransitGatewayAttachmentId + x-required-properties: + - GroupIpAddress + - NetworkInterfaceId + - TransitGatewayMulticastDomainId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:CreateVpcEndpointServicePermissions - - ec2:ModifyVpcEndpointServicePermissions - - ec2:DeleteVpcEndpointServicePermissions - - ec2:DescribeVpcEndpointServicePermissions - update: - - ec2:CreateVpcEndpointServicePermissions - - ec2:ModifyVpcEndpointServicePermissions - - ec2:DeleteVpcEndpointServicePermissions - - ec2:DescribeVpcEndpointServicePermissions + - ec2:RegisterTransitGatewayMulticastGroupMembers + - ec2:SearchTransitGatewayMulticastGroups read: - - ec2:CreateVpcEndpointServicePermissions - - ec2:ModifyVpcEndpointServicePermissions - - ec2:DeleteVpcEndpointServicePermissions - - ec2:DescribeVpcEndpointServicePermissions + - ec2:SearchTransitGatewayMulticastGroups delete: - - ec2:CreateVpcEndpointServicePermissions - - ec2:ModifyVpcEndpointServicePermissions - - ec2:DeleteVpcEndpointServicePermissions - - ec2:DescribeVpcEndpointServicePermissions + - ec2:DeregisterTransitGatewayMulticastGroupMembers + - ec2:SearchTransitGatewayMulticastGroups list: - - ec2:CreateVpcEndpointServicePermissions - - ec2:ModifyVpcEndpointServicePermissions - - ec2:DeleteVpcEndpointServicePermissions - - ec2:DescribeVpcEndpointServicePermissions - VPCGatewayAttachment: + - ec2:SearchTransitGatewayMulticastGroups + TransitGatewayMulticastGroupSource: type: object properties: - AttachmentType: + GroupIpAddress: + description: The IP address assigned to the transit gateway multicast group. type: string - description: 'Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment ' - InternetGatewayId: + TransitGatewayAttachmentId: + description: The ID of the transit gateway attachment. type: string - description: The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. - VpcId: + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. type: string - description: The ID of the VPC. - VpnGatewayId: + SubnetId: + description: The ID of the subnet. + type: string + ResourceId: + description: The ID of the resource. + type: string + ResourceType: + description: The type of resource, for example a VPC attachment. + type: string + NetworkInterfaceId: + description: The ID of the transit gateway attachment. + type: string + GroupMember: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + GroupSource: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + SourceType: + description: The source type. type: string - description: The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. required: - - VpcId - x-stackql-resource-name: vpc_gateway_attachment - x-stackql-primaryIdentifier: - - AttachmentType - - VpcId + - TransitGatewayMulticastDomainId + - NetworkInterfaceId + - GroupIpAddress + x-stackql-resource-name: transit_gateway_multicast_group_source + description: The AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group + x-type-name: AWS::EC2::TransitGatewayMulticastGroupSource + x-stackql-primary-identifier: + - TransitGatewayMulticastDomainId + - GroupIpAddress + - NetworkInterfaceId x-create-only-properties: - - VpcId + - TransitGatewayMulticastDomainId + - GroupIpAddress + - NetworkInterfaceId x-read-only-properties: - - AttachmentType + - SubnetId + - ResourceId + - ResourceType + - GroupSource + - GroupMember + - SourceType + - TransitGatewayAttachmentId + x-required-properties: + - TransitGatewayMulticastDomainId + - NetworkInterfaceId + - GroupIpAddress + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - ec2:AttachInternetGateway - - ec2:AttachVpnGateway - - ec2:DescribeInternetGateways - - ec2:DescribeVpnGateways + - ec2:RegisterTransitGatewayMulticastGroupSources + - ec2:SearchTransitGatewayMulticastGroups read: - - ec2:DescribeInternetGateways - - ec2:DescribeVpnGateways - update: - - ec2:AttachInternetGateway - - ec2:AttachVpnGateway - - ec2:DetachInternetGateway - - ec2:DetachVpnGateway - - ec2:DescribeInternetGateways - - ec2:DescribeVpnGateways + - ec2:SearchTransitGatewayMulticastGroups delete: - - ec2:DetachInternetGateway - - ec2:DetachVpnGateway - - ec2:DescribeInternetGateways - - ec2:DescribeVpnGateways + - ec2:DeregisterTransitGatewayMulticastGroupSources + - ec2:SearchTransitGatewayMulticastGroups list: - - ec2:DescribeInternetGateways - - ec2:DescribeVpnGateways - VPCPeeringConnection: + - ec2:SearchTransitGatewayMulticastGroups + PeeringAttachmentStatus: + additionalProperties: false type: object properties: - Id: + Message: + description: The status message, if applicable. type: string - PeerOwnerId: - description: The AWS account ID of the owner of the accepter VPC. + Code: + description: The status code. type: string - PeerRegion: - description: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. + TransitGatewayPeeringAttachment: + type: object + properties: + Status: + description: The status of the transit gateway peering attachment. + $ref: '#/components/schemas/PeeringAttachmentStatus' + TransitGatewayId: + description: The ID of the transit gateway. type: string - PeerRoleArn: - description: The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. + PeerTransitGatewayId: + description: The ID of the peer transit gateway. type: string - PeerVpcId: - description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + PeerAccountId: + description: The ID of the peer account type: string - VpcId: - description: The ID of the VPC. + State: + description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. + type: string + CreationTime: + format: date-time + description: The time the transit gateway peering attachment was created. + type: string + PeerRegion: + description: Peer Region type: string Tags: + description: The tags for the transit gateway peering attachment. type: array - uniqueItems: false - x-insertionOrder: false items: $ref: '#/components/schemas/Tag' + TransitGatewayAttachmentId: + description: The ID of the transit gateway peering attachment. + type: string required: - - VpcId - - PeerVpcId - x-stackql-resource-name: vpc_peering_connection - x-stackql-primaryIdentifier: - - Id + - TransitGatewayId + - PeerTransitGatewayId + - PeerAccountId + - PeerRegion + x-stackql-resource-name: transit_gateway_peering_attachment + description: The AWS::EC2::TransitGatewayPeeringAttachment type + x-type-name: AWS::EC2::TransitGatewayPeeringAttachment + x-stackql-primary-identifier: + - TransitGatewayAttachmentId x-create-only-properties: + - TransitGatewayId + - PeerTransitGatewayId - PeerRegion - - PeerOwnerId - - PeerVpcId - - PeerRoleArn - - VpcId + - PeerAccountId x-read-only-properties: - - Id + - TransitGatewayAttachmentId + - Status + - State + - CreationTime + x-required-properties: + - TransitGatewayId + - PeerTransitGatewayId + - PeerAccountId + - PeerRegion + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ec2:DescribeTransitGatewayPeeringAttachments + - ec2:DescribeTags create: - - ec2:CreateVpcPeeringConnection - - ec2:DescribeVpcPeeringConnections - - ec2:AcceptVpcPeeringConnection + - ec2:CreateTransitGatewayPeeringAttachment + - ec2:DescribeTransitGatewayPeeringAttachments - ec2:CreateTags - - sts:AssumeRole - read: - - ec2:DescribeVpcPeeringConnections + - ec2:DescribeTags update: + - ec2:DescribeTransitGatewayPeeringAttachments - ec2:CreateTags - ec2:DeleteTags - - ec2:DescribeVpcPeeringConnections - delete: - - ec2:DeleteVpcPeeringConnection - - ec2:DescribeVpcPeeringConnections + - ec2:DescribeTags list: - - ec2:DescribeVpcPeeringConnections - VpnTunnelOptionsSpecification: + - ec2:DescribeTransitGatewayPeeringAttachments + - ec2:DescribeTags + delete: + - ec2:DeleteTransitGatewayPeeringAttachment + - ec2:DescribeTransitGatewayPeeringAttachments + - ec2:DeleteTags + - ec2:DescribeTags + TransitGatewayRoute: type: object - additionalProperties: false properties: - PreSharedKey: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. type: string - TunnelInsideCidr: + DestinationCidrBlock: + description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. type: string - VPNConnection: + Blackhole: + description: Indicates whether to drop traffic that matches this route. + type: boolean + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + required: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-stackql-resource-name: transit_gateway_route + description: Resource Type definition for AWS::EC2::TransitGatewayRoute + x-type-name: AWS::EC2::TransitGatewayRoute + x-stackql-primary-identifier: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-create-only-properties: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + - DestinationCidrBlock + - Blackhole + x-required-properties: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:SearchTransitGatewayRoutes + create: + - ec2:CreateTransitGatewayRoute + - ec2:SearchTransitGatewayRoutes + list: + - ec2:SearchTransitGatewayRoutes + delete: + - ec2:DeleteTransitGatewayRoute + - ec2:SearchTransitGatewayRoutes + TransitGatewayRouteTable: type: object properties: - VpnConnectionId: - description: The provider-assigned unique ID for this managed resource + TransitGatewayRouteTableId: + description: Transit Gateway Route Table primary identifier type: string - CustomerGatewayId: - description: The ID of the customer gateway at your end of the VPN connection. + TransitGatewayId: + description: The ID of the transit gateway. type: string - StaticRoutesOnly: - description: Indicates whether the VPN connection uses static routes only. - type: boolean Tags: - description: Any tags assigned to the VPN connection. - type: array uniqueItems: false + description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - TransitGatewayId: - description: The ID of the transit gateway associated with the VPN connection. - type: string - Type: - description: The type of VPN connection. - type: string - VpnGatewayId: - description: The ID of the virtual private gateway at the AWS side of the VPN connection. - type: string - VpnTunnelOptionsSpecifications: - description: The tunnel options for the VPN connection. type: array - uniqueItems: false - x-insertionOrder: false items: - $ref: '#/components/schemas/VpnTunnelOptionsSpecification' + $ref: '#/components/schemas/Tag' required: - - Type - - CustomerGatewayId - x-stackql-resource-name: vpn_connection - x-stackql-primaryIdentifier: - - VpnConnectionId + - TransitGatewayId + x-stackql-resource-name: transit_gateway_route_table + description: Resource Type definition for AWS::EC2::TransitGatewayRouteTable + x-type-name: AWS::EC2::TransitGatewayRouteTable + x-stackql-primary-identifier: + - TransitGatewayRouteTableId x-create-only-properties: - - Type - - CustomerGatewayId - - VpnGatewayId - TransitGatewayId - - VpnTunnelOptionsSpecifications - - StaticRoutesOnly x-read-only-properties: - - VpnConnectionId - x-required-permissions: - create: - - ec2:DescribeVpnConnections - - ec2:CreateVpnConnection + - TransitGatewayRouteTableId + x-required-properties: + - TransitGatewayId + x-tagging: + permissions: - ec2:CreateTags - delete: - - ec2:DescribeVpnConnections - - ec2:DeleteVpnConnection - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:DescribeTransitGatewayRouteTables + create: + - ec2:CreateTransitGatewayRouteTable + - ec2:CreateTags + - ec2:DescribeTransitGatewayRouteTables update: - - ec2:DescribeVpnConnections + - ec2:DescribeTransitGatewayRouteTables - ec2:CreateTags - ec2:DeleteTags - read: - - ec2:DescribeVpnConnections list: - - ec2:DescribeVpnConnections - VPNConnectionRoute: + - ec2:DescribeTransitGatewayRouteTables + delete: + - ec2:DeleteTransitGatewayRouteTable + - ec2:DescribeTransitGatewayRouteTables + - ec2:GetTransitGatewayRouteTableAssociations + - ec2:DisassociateTransitGatewayRouteTable + TransitGatewayRouteTableAssociation: type: object properties: - DestinationCidrBlock: - description: The CIDR block associated with the local subnet of the customer network. + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. type: string - VpnConnectionId: - description: The ID of the VPN connection. + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. type: string required: - - DestinationCidrBlock - - VpnConnectionId - x-stackql-resource-name: vpn_connection_route - x-stackql-primaryIdentifier: - - DestinationCidrBlock - - VpnConnectionId + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-stackql-resource-name: transit_gateway_route_table_association + description: Resource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation + x-type-name: AWS::EC2::TransitGatewayRouteTableAssociation + x-stackql-primary-identifier: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId x-create-only-properties: - - DestinationCidrBlock - - VpnConnectionId + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-required-properties: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: - create: - - ec2:CreateVpnConnectionRoute - - ec2:DescribeVpnConnections read: - - ec2:DescribeVpnConnections + - ec2:GetTransitGatewayRouteTableAssociations + create: + - ec2:AssociateTransitGatewayRouteTable + - ec2:GetTransitGatewayRouteTableAssociations + list: + - ec2:GetTransitGatewayRouteTableAssociations delete: - - ec2:DeleteVpnConnectionRoute - - ec2:DescribeVpnConnections + - ec2:GetTransitGatewayRouteTableAssociations + - ec2:DisassociateTransitGatewayRouteTable + TransitGatewayRouteTablePropagation: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + required: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-stackql-resource-name: transit_gateway_route_table_propagation + description: AWS::EC2::TransitGatewayRouteTablePropagation Type + x-type-name: AWS::EC2::TransitGatewayRouteTablePropagation + x-stackql-primary-identifier: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-create-only-properties: + - TransitGatewayAttachmentId + - TransitGatewayRouteTableId + x-required-properties: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:GetTransitGatewayRouteTablePropagations + create: + - ec2:GetTransitGatewayRouteTablePropagations + - ec2:EnableTransitGatewayRouteTablePropagation list: - - ec2:DescribeVpnConnections - VPNGateway: + - ec2:GetTransitGatewayRouteTablePropagations + delete: + - ec2:GetTransitGatewayRouteTablePropagations + - ec2:DisableTransitGatewayRouteTablePropagation + TransitGatewayVpcAttachment: type: object properties: - VPNGatewayId: - description: VPN Gateway ID generated by service + Id: type: string - AmazonSideAsn: - description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session. - type: integer - format: int64 - Tags: - description: Any tags assigned to the virtual private gateway. + TransitGatewayId: + type: string + VpcId: + type: string + SubnetIds: + type: array + x-insertionOrder: false + uniqueItems: false + items: + type: string + AddSubnetIds: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + RemoveSubnetIds: type: array + uniqueItems: false x-insertionOrder: false + items: + type: string + Tags: + type: array uniqueItems: false + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - Type: - description: The type of VPN connection the virtual private gateway supports. - type: string + Options: + description: The options for the transit gateway vpc attachment. + type: object + properties: + DnsSupport: + description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable' + type: string + Ipv6Support: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + ApplianceModeSupport: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + SecurityGroupReferencingSupport: + description: 'Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid values: enable | disable' + type: string + additionalProperties: false required: - - Type - x-stackql-resource-name: vpn_gateway - x-stackql-primaryIdentifier: - - VPNGatewayId + - SubnetIds + - VpcId + - TransitGatewayId + x-stackql-resource-name: transit_gateway_vpc_attachment + description: Resource Type definition for AWS::EC2::TransitGatewayVpcAttachment + x-type-name: AWS::EC2::TransitGatewayVpcAttachment + x-stackql-primary-identifier: + - Id x-create-only-properties: - - AmazonSideAsn - - Type + - TransitGatewayId + - SubnetIds + - VpcId + x-write-only-properties: + - AddSubnetIds + - RemoveSubnetIds x-read-only-properties: - - VPNGatewayId + - Id + x-required-properties: + - SubnetIds + - VpcId + - TransitGatewayId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags x-required-permissions: create: - - ec2:CreateVpnGateway - - ec2:DescribeVpnGateways + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:CreateTransitGatewayVpcAttachment + - ec2:CreateTags + - ec2:DescribeTags read: - - ec2:DescribeVpnGateways + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DescribeTags + delete: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DeleteTransitGatewayVpcAttachment + - ec2:DeleteTags + - ec2:DescribeTags + list: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DescribeTags update: + - ec2:DescribeTransitGatewayVpcAttachments + - ec2:DescribeTags + - ec2:CreateTransitGatewayVpcAttachment - ec2:CreateTags + - ec2:DeleteTransitGatewayVpcAttachment - ec2:DeleteTags - delete: - - ec2:DeleteVpnGateway - list: - - ec2:DescribeVpnGateways - region: - type: string - description: The AWS region - outpostArn: - type: string - description: The Amazon Resource Name (ARN) of the Outpost. - ownerId: - type: string - description: The ID of the Amazon Web Services account that owns the resource. - vpcId: - type: string - description: '[EC2-VPC] The ID of the VPC in which the resource is located.' - subnetId: - type: string - description: '[EC2-VPC] The ID of the subnet in which the resource is located.' - tagSet: - type: array - description: Any tags assigned to the resource. - availabilityZone: - type: string - description: The Availability Zone where the resource was created, if applicable. - instances: - description: List of ec2 instances by region (requires `aws` provider to be installed) + - ec2:ModifyTransitGatewayVpcAttachment + NetworkInterfaceOptions: + description: The options for network-interface type endpoint. type: object - additionalProperties: false properties: - instanceId: + NetworkInterfaceId: + description: The ID of the network interface. type: string - description: The ID of the instance. - instanceState: - type: object - description: Describes the current state of an instance. - instanceType: + Port: + description: The IP port number. + type: integer + minimum: 1 + maximum: 65535 + PortRanges: + description: The list of port ranges. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PortRange' + Protocol: + description: The IP protocol. type: string - description: The instance type. - vpcId: - $ref: '#/components/schemas/vpcId' - subnetId: - $ref: '#/components/schemas/subnetId' - amiLaunchIndex: + additionalProperties: false + LoadBalancerOptions: + description: The load balancer details if creating the AWS Verified Access endpoint as load-balancertype. + type: object + properties: + LoadBalancerArn: + description: The ARN of the load balancer. + type: string + Port: + description: The IP port number. type: integer - description: The AMI launch index, which can be used to find this instance in the launch group. - architecture: + minimum: 1 + maximum: 65535 + PortRanges: + description: The list of port range. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PortRange' + Protocol: + description: The IP protocol. type: string - description: The architecture of the image. - blockDeviceMapping: + SubnetIds: + description: The IDs of the subnets. type: array - description: Any block device mapping entries for the instance. - bootMode: + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetId' + additionalProperties: false + RdsOptions: + description: The options for rds type endpoint. + type: object + properties: + Protocol: + description: The IP protocol. type: string - description: The boot mode of the instance. - capacityReservationId: + Port: + description: The IP port number. + type: integer + minimum: 1 + maximum: 65535 + RdsDbInstanceArn: + description: The ARN of the RDS DB instance. type: string - description: The ID of the Capacity Reservation. - capacityReservationSpecification: - type: object - description: Describes the instances Capacity Reservation targeting preferences - clientToken: + RdsDbClusterArn: + description: The ARN of the RDS DB cluster. type: string - description: The idempotency token you provided when you launched the instance, if applicable. - cpuOptions: - type: object - description: The CPU options for the instance. - dnsName: + RdsDbProxyArn: + description: The ARN of the RDS DB proxy. type: string - description: (IPv4 only) The public DNS name assigned to the instance. - ebsOptimized: - type: boolean - description: Indicates whether the instance is optimized for Amazon EBS I/O. - elasticGpuAssociationSet: - type: array - description: The Elastic GPU associated with the instance. - elasticInferenceAcceleratorAssociationSet: - type: array - description: The elastic inference accelerator associated with the instance. - enaSupport: - type: boolean - description: Specifies whether enhanced networking with ENA is enabled. - enclaveOptions: - type: object - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. - groupSet: - type: array - description: The security groups for the instance. - hibernationOptions: - type: object - description: Indicates whether your instance is configured for hibernation. - hypervisor: + RdsEndpoint: + description: The RDS endpoint. type: string - description: The hypervisor type of the instance. - iamInstanceProfile: - type: object - description: Describes an IAM instance profile. - imageId: + SubnetIds: + description: The IDs of the subnets. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetId' + additionalProperties: false + CidrOptions: + description: The options for cidr type endpoint. + type: object + properties: + Cidr: + description: The IP address range, in CIDR notation. type: string - description: The ID of the AMI used to launch the instance. - instanceLifecycle: + PortRanges: + description: The list of port range. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PortRange' + Protocol: + description: The IP protocol. type: string - description: Indicates whether this is a Spot Instance or a Scheduled Instance. - ipAddress: + SubnetIds: + description: The IDs of the subnets. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetId' + additionalProperties: false + SubnetId: + description: The IDs of the subnet. + type: string + SseSpecification: + description: The configuration options for customer provided KMS encryption. + type: object + properties: + KmsKeyArn: + description: KMS Key Arn used to encrypt the group policy type: string - description: The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. - ipv6Address: + CustomerManagedKeyEnabled: + description: Whether to encrypt the policy with the provided key or disable encryption + type: boolean + additionalProperties: false + VerifiedAccessEndpoint: + type: object + properties: + VerifiedAccessEndpointId: + description: The ID of the AWS Verified Access endpoint. type: string - description: The IPv6 address assigned to the instance. - kernelId: + VerifiedAccessGroupId: + description: The ID of the AWS Verified Access group. type: string - description: The kernel associated with this instance, if applicable. - keyName: + VerifiedAccessInstanceId: + description: The ID of the AWS Verified Access instance. type: string - description: The name of the key pair, if this instance was launched with an associated key pair. - launchTime: + Status: + description: The endpoint status. type: string - description: The time the instance was launched. - licenseSet: - type: array - description: The license configurations for the instance. - maintenanceOptions: - type: object - description: The maintenance options for the instance. - metadataOptions: - type: object - description: The metadata options for the instance. - monitoring: - type: object - description: Describes the monitoring of an instance. - networkInterfaceSet: + SecurityGroupIds: + description: The IDs of the security groups for the endpoint. type: array - description: '[EC2-VPC] The network interfaces for the instance.' - outpostArn: - $ref: '#/components/schemas/outpostArn' - placement: - type: object - description: Describes the placement of an instance. - platform: - type: string - description: The value is Windows instances; otherwise blank. - platformDetails: - type: string - description: The platform details value for the instance. - privateDnsName: - type: string - description: (IPv4 only) The private DNS hostname name assigned to the instance. - privateDnsNameOptions: - type: object - description: Describes the options for instance hostnames. - privateIpAddress: + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' + NetworkInterfaceOptions: + description: The options for network-interface type endpoint. + $ref: '#/components/schemas/NetworkInterfaceOptions' + LoadBalancerOptions: + description: The load balancer details if creating the AWS Verified Access endpoint as load-balancer type. + $ref: '#/components/schemas/LoadBalancerOptions' + RdsOptions: + description: The options for rds type endpoint. + $ref: '#/components/schemas/RdsOptions' + CidrOptions: + description: The options for cidr type endpoint. + $ref: '#/components/schemas/CidrOptions' + EndpointType: + description: The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. type: string - description: The private IPv4 address assigned to the instance. - productCodes: - type: array - description: The product codes attached to this instance, if applicable. - ramdiskId: + EndpointDomain: + description: A DNS name that is generated for the endpoint. type: string - description: The RAM disk associated with this instance, if applicable. - reason: + EndpointDomainPrefix: + description: A custom identifier that gets prepended to a DNS name that is generated for the endpoint. type: string - description: The reason for the most recent state transition. This might be an empty string. - rootDeviceName: + DeviceValidationDomain: + description: Returned if endpoint has a device trust provider attached. type: string - description: The device name of the root device volume. - rootDeviceType: + DomainCertificateArn: + description: The ARN of a public TLS/SSL certificate imported into or created with ACM. type: string - description: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. - sourceDestCheck: - type: boolean - description: Indicates whether source/destination checking is enabled. - spotInstanceRequestId: + AttachmentType: + description: The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. type: string - description: If the request is a Spot Instance request, the ID of the request. - sriovNetSupport: + ApplicationDomain: + description: The DNS name for users to reach your application. type: string - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. - stateReason: - type: object - description: Describes a state change. - tagSet: - $ref: '#/components/schemas/tagSet' - tpmSupport: + CreationTime: + description: The creation time. type: string - description: If the instance is configured for NitroTPM support - usageOperation: + LastUpdatedTime: + description: The last updated time. type: string - description: The usage operation value for the instance. - usageOperationUpdateTime: + Description: + description: A description for the AWS Verified Access endpoint. type: string - description: The time that the usage operation was last updated. - virtualizationType: + PolicyDocument: + description: The AWS Verified Access policy document. type: string - description: The virtualization type of the instance. - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' - snapshots: - description: List of snapshots by region (requires `aws` provider to be installed) + PolicyEnabled: + description: The status of the Verified Access policy. + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SseSpecification: + description: The configuration options for customer provided KMS encryption. + $ref: '#/components/schemas/SseSpecification' + required: + - AttachmentType + - EndpointType + - VerifiedAccessGroupId + x-stackql-resource-name: verified_access_endpoint + description: The AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint. + x-type-name: AWS::EC2::VerifiedAccessEndpoint + x-stackql-primary-identifier: + - VerifiedAccessEndpointId + x-create-only-properties: + - ApplicationDomain + - AttachmentType + - DomainCertificateArn + - EndpointDomainPrefix + - EndpointType + - SecurityGroupIds + - NetworkInterfaceOptions/NetworkInterfaceId + - LoadBalancerOptions/LoadBalancerArn + - RdsOptions/Protocol + - RdsOptions/RdsDbInstanceArn + - RdsOptions/RdsDbClusterArn + - RdsOptions/RdsDbProxyArn + - CidrOptions/Cidr + - CidrOptions/Protocol + - CidrOptions/SubnetIds + x-read-only-properties: + - VerifiedAccessEndpointId + - EndpointDomain + - CreationTime + - LastUpdatedTime + - Status + - DeviceValidationDomain + - VerifiedAccessInstanceId + x-required-properties: + - AttachmentType + - EndpointType + - VerifiedAccessGroupId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateVerifiedAccessEndpoint + - ec2:DescribeVerifiedAccessEndpoints + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeNetworkInterfaces + - ec2:DescribeAccountAttributes + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DescribeVpcs + - ec2:GetVerifiedAccessEndpointPolicy + - elasticloadbalancing:DescribeLoadBalancers + - elasticloadbalancing:DescribeListeners + - elasticloadbalancing:DescribeListenerCertificates + - iam:CreateServiceLinkedRole + - acm:DescribeCertificate + - sso:PutApplicationAccessScope + - sso:GetSharedSsoConfiguration + - sso:CreateManagedApplicationInstance + - sso:DeleteManagedApplicationInstance + - kms:DescribeKey + - kms:GenerateDataKey + - kms:RetireGrant + - kms:CreateGrant + - kms:Decrypt + - rds:DescribeDbInstances + - rds:DescribeDbProxies + - rds:DescribeDbClusters + - ec2:DescribeAvailabilityZones + - ec2:DescribeVpcEndpointServiceConfigurations + read: + - ec2:DescribeVerifiedAccessEndpoints + - ec2:GetVerifiedAccessEndpointPolicy + - ec2:DescribeTags + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + update: + - ec2:ModifyVerifiedAccessEndpoint + - ec2:ModifyVerifiedAccessEndpointPolicy + - ec2:DescribeVerifiedAccessEndpoints + - ec2:GetVerifiedAccessEndpointPolicy + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVpcs + - ec2:DescribeTags + - ec2:DeleteTags + - ec2:CreateTags + - elasticloadbalancing:DescribeLoadBalancers + - elasticloadbalancing:DescribeListeners + - elasticloadbalancing:DescribeListenerCertificates + - kms:DescribeKey + - kms:GenerateDataKey + - kms:RetireGrant + - kms:CreateGrant + - kms:Decrypt + - rds:DescribeDbInstances + - rds:DescribeDbProxies + - rds:DescribeDbClusters + delete: + - ec2:DescribeVerifiedAccessEndpoints + - ec2:DeleteVerifiedAccessEndpoint + - ec2:GetVerifiedAccessEndpointPolicy + - ec2:DescribeTags + - ec2:DeleteTags + - sso:DeleteManagedApplicationInstance + - kms:DescribeKey + - kms:RetireGrant + - kms:Decrypt + - kms:GenerateDataKey + list: + - ec2:DescribeVerifiedAccessEndpoints + - ec2:GetVerifiedAccessEndpointPolicy + - ec2:DescribeTags + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + VerifiedAccessGroup: type: object - additionalProperties: false properties: - description: - type: string - description: The description for the snapshot. - dataEncryptionKeyId: - type: string - description: The data encryption key identifier for the snapshot. - encrypted: - type: boolean - description: Indicates whether the snapshot is encrypted. - kmsKeyId: - type: string - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. - outpostArn: - $ref: '#/components/schemas/outpostArn' - ownerAlias: - type: string - description: The Amazon Web Services owner alias. - ownerId: - $ref: '#/components/schemas/ownerId' - progress: + VerifiedAccessGroupId: + description: The ID of the AWS Verified Access group. type: string - description: The progress of the snapshot, as a percentage. - restoreExpiryTime: + VerifiedAccessInstanceId: + description: The ID of the AWS Verified Access instance. type: string - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. - snapshotId: + VerifiedAccessGroupArn: + description: The ARN of the Verified Access group. type: string - description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. - startTime: + Owner: + description: The AWS account number that owns the group. type: string - description: The time stamp when the snapshot was initiated. - status: + CreationTime: + description: Time this Verified Access Group was created. type: string - description: The snapshot state. - statusMessage: + LastUpdatedTime: + description: Time this Verified Access Group was last updated. type: string - description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details. - storageTier: + Description: + description: A description for the AWS Verified Access group. type: string - description: The storage tier in which the snapshot is stored. - tagSet: - $ref: '#/components/schemas/tagSet' - volumeId: + PolicyDocument: + description: The AWS Verified Access policy document. type: string - description: The ID of the volume that was used to create the snapshot. - volumeSize: - type: integer - description: The size of the volume, in GiB. - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' - x-stackQL-resources: - capacity_reservations: - name: capacity_reservations - id: awscc.ec2.capacity_reservations - x-cfn-schema-name: CapacityReservation - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' - AND region = 'us-east-1' + PolicyEnabled: + description: The status of the Verified Access policy. + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SseSpecification: + description: The configuration options for customer provided KMS encryption. + $ref: '#/components/schemas/SseSpecification' + required: + - VerifiedAccessInstanceId + x-stackql-resource-name: verified_access_group + description: The AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group. + x-type-name: AWS::EC2::VerifiedAccessGroup + x-stackql-primary-identifier: + - VerifiedAccessGroupId + x-read-only-properties: + - VerifiedAccessGroupId + - CreationTime + - LastUpdatedTime + - Owner + - VerifiedAccessGroupArn + x-required-properties: + - VerifiedAccessInstanceId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateVerifiedAccessGroup + - ec2:DescribeVerifiedAccessGroups + - ec2:GetVerifiedAccessGroupPolicy + - ec2:CreateTags + - ec2:DescribeTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + read: + - ec2:DescribeVerifiedAccessGroups + - ec2:GetVerifiedAccessGroupPolicy + - ec2:DescribeTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + update: + - ec2:ModifyVerifiedAccessGroup + - ec2:ModifyVerifiedAccessGroupPolicy + - ec2:DescribeVerifiedAccessGroups + - ec2:GetVerifiedAccessGroupPolicy + - ec2:DescribeTags + - ec2:DeleteTags + - ec2:CreateTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + delete: + - ec2:DeleteVerifiedAccessGroup + - ec2:DeleteTags + - ec2:DescribeVerifiedAccessGroups + - ec2:DescribeTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + list: + - ec2:DescribeVerifiedAccessGroups + - ec2:DescribeTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + VerifiedAccessTrustProvider: + type: object + properties: + TrustProviderType: + description: 'Type of trust provider. Possible values: user|device' + type: string + DeviceTrustProviderType: + description: 'The type of device-based trust provider. Possible values: jamf|crowdstrike' + type: string + UserTrustProviderType: + description: 'The type of device-based trust provider. Possible values: oidc|iam-identity-center' + type: string + OidcOptions: + $ref: '#/components/schemas/OidcOptions' + DeviceOptions: + $ref: '#/components/schemas/DeviceOptions' + PolicyReferenceName: + description: The identifier to be used when working with policy rules. + type: string + CreationTime: + description: The creation time. + type: string + LastUpdatedTime: + description: The last updated time. + type: string + VerifiedAccessTrustProviderId: + description: The ID of the Amazon Web Services Verified Access trust provider. + type: string + Description: + description: A description for the Amazon Web Services Verified Access trust provider. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SseSpecification: + description: The configuration options for customer provided KMS encryption. + type: object + properties: + KmsKeyArn: + description: KMS Key Arn used to encrypt the group policy + type: string + CustomerManagedKeyEnabled: + description: Whether to encrypt the policy with the provided key or disable encryption + type: boolean + additionalProperties: false + NativeApplicationOidcOptions: + $ref: '#/components/schemas/NativeApplicationOidcOptions' + required: + - TrustProviderType + - PolicyReferenceName + x-stackql-resource-name: verified_access_trust_provider + description: The AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider + x-type-name: AWS::EC2::VerifiedAccessTrustProvider + x-stackql-primary-identifier: + - VerifiedAccessTrustProviderId + x-create-only-properties: + - PolicyReferenceName + - DeviceOptions + - DeviceTrustProviderType + - TrustProviderType + - UserTrustProviderType + x-write-only-properties: + - NativeApplicationOidcOptions/ClientSecret + x-read-only-properties: + - VerifiedAccessTrustProviderId + - CreationTime + - LastUpdatedTime + x-required-properties: + - TrustProviderType + - PolicyReferenceName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateVerifiedAccessTrustProvider + - ec2:DescribeVerifiedAccessTrustProviders + - ec2:CreateTags + - ec2:DescribeTags + - sso:GetSharedSsoConfiguration + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + read: + - ec2:DescribeVerifiedAccessTrustProviders + - ec2:DescribeTags + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + update: + - ec2:ModifyVerifiedAccessTrustProvider + - ec2:DescribeVerifiedAccessTrustProviders + - ec2:DescribeTags + - ec2:DeleteTags + - ec2:CreateTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + delete: + - ec2:DeleteVerifiedAccessTrustProvider + - ec2:DeleteTags + - ec2:DescribeVerifiedAccessTrustProviders + - ec2:DescribeTags + - kms:DescribeKey + - kms:RetireGrant + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + list: + - ec2:DescribeVerifiedAccessTrustProviders + - ec2:DescribeTags + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + VerifiedAccessTrustProviderId: + description: The ID of the AWS Verified Access trust provider. + type: string + VerifiedAccessLogs: + description: The configuration options for AWS Verified Access instances. + type: object + properties: + LogVersion: + description: Select log version for Verified Access logs. + type: string + IncludeTrustContext: + description: Include claims from trust providers in Verified Access logs. + type: boolean + CloudWatchLogs: + description: Sends Verified Access logs to CloudWatch Logs. + type: object + properties: + Enabled: + description: Indicates whether logging is enabled. + type: boolean + LogGroup: + description: The ID of the CloudWatch Logs log group. + type: string + additionalProperties: false + KinesisDataFirehose: + description: Sends Verified Access logs to Kinesis. + type: object + properties: + Enabled: + description: Indicates whether logging is enabled. + type: boolean + DeliveryStream: + description: The ID of the delivery stream. + type: string + additionalProperties: false + S3: + description: Sends Verified Access logs to Amazon S3. + type: object + properties: + Enabled: + description: Indicates whether logging is enabled. + type: boolean + BucketName: + description: The bucket name. + type: string + BucketOwner: + description: The ID of the AWS account that owns the Amazon S3 bucket. + type: string + Prefix: + description: The bucket prefix. + type: string + additionalProperties: false + additionalProperties: false + Nameserver: + description: The value of the name server + type: string + VerifiedAccessInstance: + type: object + properties: + VerifiedAccessInstanceId: + description: The ID of the AWS Verified Access instance. + type: string + VerifiedAccessTrustProviders: + description: AWS Verified Access trust providers. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/VerifiedAccessTrustProvider' + VerifiedAccessTrustProviderIds: + description: The IDs of the AWS Verified Access trust providers. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/VerifiedAccessTrustProviderId' + CreationTime: + description: Time this Verified Access Instance was created. + type: string + LastUpdatedTime: + description: Time this Verified Access Instance was last updated. + type: string + Description: + description: A description for the AWS Verified Access instance. + type: string + LoggingConfigurations: + description: The configuration options for AWS Verified Access instances. + $ref: '#/components/schemas/VerifiedAccessLogs' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + FipsEnabled: + description: Indicates whether FIPS is enabled + type: boolean + CidrEndpointsCustomSubDomain: + description: Introduce CidrEndpointsCustomSubDomain property to represent the domain (say, ava.my-company.com) + type: string + CidrEndpointsCustomSubDomainNameServers: + description: Property to represent the name servers assoicated with the domain that AVA manages (say, ['ns1.amazonaws.com', 'ns2.amazonaws.com', 'ns3.amazonaws.com', 'ns4.amazonaws.com']). + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Nameserver' + x-stackql-resource-name: verified_access_instance + description: The AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance. + x-type-name: AWS::EC2::VerifiedAccessInstance + x-stackql-primary-identifier: + - VerifiedAccessInstanceId + x-read-only-properties: + - VerifiedAccessInstanceId + - CreationTime + - LastUpdatedTime + - CidrEndpointsCustomSubDomainNameServers + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DescribeTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateVerifiedAccessInstance + - ec2:AttachVerifiedAccessTrustProvider + - ec2:ModifyVerifiedAccessInstanceLoggingConfiguration + - ec2:DescribeVerifiedAccessInstances + - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations + - ec2:DetachVerifiedAccessTrustProvider + - ec2:DeleteVerifiedAccessInstance + - ec2:CreateTags + - ec2:DescribeTags + - logs:CreateLogDelivery + - logs:GetLogDelivery + - logs:UpdateLogDelivery + - logs:PutDestination + - logs:DeleteLogDelivery + - logs:ListLogDeliveries + - logs:PutLogEvents + - logs:DescribeLogStreams + - s3:listBuckets + - s3:PutObject + - s3:GetBucketPolicy + - s3:PutBucketPolicy + - logs:DescribeLogGroups + - logs:PutResourcePolicy + - firehose:TagDeliveryStream + - logs:DescribeResourcePolicies + - iam:CreateServiceLinkedRole + - verified-access:AllowVerifiedAccess + read: + - ec2:DescribeVerifiedAccessInstances + - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations + - ec2:DescribeTags + - logs:GetLogDelivery + - logs:ListLogDeliveries + update: + - ec2:ModifyVerifiedAccessInstance + - ec2:ModifyVerifiedAccessInstanceLoggingConfiguration + - ec2:DescribeVerifiedAccessInstances + - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations + - ec2:DescribeTags + - ec2:AttachVerifiedAccessTrustProvider + - ec2:DetachVerifiedAccessTrustProvider + - ec2:DeleteTags + - ec2:CreateTags + - ec2:DescribeTags + - logs:CreateLogDelivery + - logs:GetLogDelivery + - logs:ListLogDeliveries + - logs:UpdateLogDelivery + - logs:DeleteLogDelivery + - logs:PutDestination + - logs:PutLogEvents + - logs:DescribeLogStreams + - s3:listBuckets + - s3:PutObject + - s3:GetBucketPolicy + - s3:PutBucketPolicy + - logs:DescribeLogGroups + - logs:PutResourcePolicy + - firehose:TagDeliveryStream + - iam:CreateServiceLinkedRole + - logs:DescribeResourcePolicies + delete: + - ec2:DeleteVerifiedAccessInstance + - ec2:DeleteTags + - ec2:DescribeVerifiedAccessInstances + - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations + - ec2:DetachVerifiedAccessTrustProvider + - ec2:GetVerifiedAccessGroupPolicy + - ec2:DescribeTags + - logs:ListLogDeliveries + - logs:GetLogDelivery + - logs:DeleteLogDelivery + list: + - ec2:DescribeVerifiedAccessInstances + - ec2:DescribeTags + - logs:ListLogDeliveries + - logs:GetLogDelivery + OidcOptions: + description: The OpenID Connect details for an oidc -type, user-identity based trust provider. + type: object + properties: + Issuer: + type: string + description: The OIDC issuer. + AuthorizationEndpoint: + type: string + description: The OIDC authorization endpoint. + TokenEndpoint: + type: string + description: The OIDC token endpoint. + UserInfoEndpoint: + type: string + description: The OIDC user info endpoint. + ClientId: + type: string + description: The client identifier. + ClientSecret: + type: string + description: The client secret. + Scope: + type: string + description: OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes. + additionalProperties: false + DeviceOptions: + description: The options for device identity based trust providers. + type: object + properties: + TenantId: + type: string + description: The ID of the tenant application with the device-identity provider. + PublicSigningKeyUrl: + type: string + description: URL Verified Access will use to verify authenticity of the device tokens. + additionalProperties: false + NativeApplicationOidcOptions: + description: The OpenID Connect details for an oidc -type, user-identity based trust provider for L4. + type: object + properties: + Issuer: + type: string + description: The OIDC issuer. + AuthorizationEndpoint: + type: string + description: The OIDC authorization endpoint. + TokenEndpoint: + type: string + description: The OIDC token endpoint. + UserInfoEndpoint: + type: string + description: The OIDC user info endpoint. + ClientId: + type: string + description: The client identifier. + ClientSecret: + type: string + description: The client secret. + Scope: + type: string + description: OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes. + PublicSigningKeyEndpoint: + type: string + description: The public signing key for endpoint + additionalProperties: false + VolumeId: + description: The ID of the Amazon EBS volume + type: string + Id: + description: '' + type: string + InstanceId: + description: The ID of the instance to which the volume attaches + type: string + Device: + description: The device name + type: string + VolumeAttachment: + type: object + properties: + VolumeId: + $ref: '#/components/schemas/VolumeId' + description: The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume. + InstanceId: + $ref: '#/components/schemas/InstanceId' + description: The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance. + Device: + $ref: '#/components/schemas/Device' + description: The device name (for example, ``/dev/sdh`` or ``xvdh``). + required: + - VolumeId + - InstanceId + x-stackql-resource-name: volume_attachment + description: |- + Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name. + Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains. + If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first. + If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance. + x-type-name: AWS::EC2::VolumeAttachment + x-stackql-primary-identifier: + - VolumeId + - InstanceId + x-create-only-properties: + - Device + - InstanceId + - VolumeId + x-required-properties: + - VolumeId + - InstanceId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:AttachVolume + - ec2:DescribeVolumes + read: + - ec2:DescribeVolumes + delete: + - ec2:DetachVolume + - ec2:DescribeVolumes + list: + - ec2:DescribeVolumes + VPC: + type: object + properties: + VpcId: + description: '' + type: string + InstanceTenancy: + description: |- + The allowed tenancy of instances launched into the VPC. + + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. + + Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement. + type: string + Ipv4NetmaskLength: + description: The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. + type: integer + CidrBlockAssociations: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + CidrBlock: + description: |- + The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. + You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. + type: string + Ipv4IpamPoolId: + description: |- + The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. + You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. + type: string + DefaultNetworkAcl: + description: '' + x-insertionOrder: false + type: string + EnableDnsSupport: + description: >- + Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your + VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). + type: boolean + Ipv6CidrBlocks: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + DefaultSecurityGroup: + description: '' + x-insertionOrder: false + type: string + EnableDnsHostnames: + description: |- + Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). + You can only enable DNS hostnames if you've enabled DNS support. + type: boolean + Tags: + uniqueItems: false + description: The tags for the VPC. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: vpc + description: |- + Specifies a virtual private cloud (VPC). + To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html). + For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*. + x-type-name: AWS::EC2::VPC + x-stackql-primary-identifier: + - VpcId + x-create-only-properties: + - CidrBlock + - Ipv4IpamPoolId + - Ipv4NetmaskLength + x-conditional-create-only-properties: + - InstanceTenancy + x-write-only-properties: + - Ipv4IpamPoolId + - Ipv4NetmaskLength + x-read-only-properties: + - CidrBlockAssociations + - DefaultNetworkAcl + - DefaultSecurityGroup + - Ipv6CidrBlocks + - VpcId + x-tagging: + permissions: + - ec2:DeleteTags + - ec2:CreateTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - ec2:DescribeVpcs + - ec2:DescribeSecurityGroups + - ec2:DescribeNetworkAcls + - ec2:DescribeVpcAttribute + create: + - ec2:CreateVpc + - ec2:DescribeVpcs + - ec2:DescribeVpcAttribute + - ec2:ModifyVpcAttribute + - ec2:CreateTags + update: + - ec2:CreateTags + - ec2:ModifyVpcAttribute + - ec2:DescribeVpcAttribute + - ec2:DeleteTags + - ec2:ModifyVpcTenancy + list: + - ec2:DescribeVpcs + delete: + - ec2:DeleteVpc + - ec2:DescribeVpcs + VPCBlockPublicAccessExclusion: + type: object + properties: + ExclusionId: + type: string + description: The ID of the exclusion + InternetGatewayExclusionMode: + description: The desired Block Public Access Exclusion Mode for a specific VPC/Subnet. + type: string + enum: + - allow-bidirectional + - allow-egress + VpcId: + type: string + description: The ID of the vpc. Required only if you don't specify SubnetId. + SubnetId: + type: string + description: The ID of the subnet. Required only if you don't specify VpcId + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - InternetGatewayExclusionMode + x-stackql-resource-name: vpc_block_public_access_exclusion + description: Resource Type definition for AWS::EC2::VPCBlockPublicAccessExclusion. + x-type-name: AWS::EC2::VPCBlockPublicAccessExclusion + x-stackql-primary-identifier: + - ExclusionId + x-create-only-properties: + - VpcId + - SubnetId + x-read-only-properties: + - ExclusionId + x-required-properties: + - InternetGatewayExclusionMode + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:DescribeVpcBlockPublicAccessExclusions + - ec2:CreateVpcBlockPublicAccessExclusion + - ec2:CreateTags + read: + - ec2:DescribeVpcBlockPublicAccessExclusions + update: + - ec2:DescribeVpcBlockPublicAccessExclusions + - ec2:ModifyVpcBlockPublicAccessExclusion + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DescribeVpcBlockPublicAccessExclusions + - ec2:DeleteVpcBlockPublicAccessExclusion + list: + - ec2:DescribeVpcBlockPublicAccessExclusions + VPCBlockPublicAccessOptions: + type: object + properties: + InternetGatewayBlockMode: + description: The desired Block Public Access mode for Internet Gateways in your account. We do not allow to create in a off mode as this is the default value + type: string + enum: + - block-bidirectional + - block-ingress + AccountId: + type: string + description: The identifier for the specified AWS account. + ExclusionsAllowed: + type: string + description: Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be not-allowed. Otherwise, they are allowed. + required: + - InternetGatewayBlockMode + x-stackql-resource-name: vpc_block_public_access_options + description: Resource Type definition for AWS::EC2::VPCBlockPublicAccessOptions + x-type-name: AWS::EC2::VPCBlockPublicAccessOptions + x-stackql-primary-identifier: + - AccountId + x-read-only-properties: + - AccountId + - ExclusionsAllowed + x-required-properties: + - InternetGatewayBlockMode + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:DescribeVpcBlockPublicAccessOptions + - ec2:ModifyVpcBlockPublicAccessOptions + read: + - ec2:DescribeVpcBlockPublicAccessOptions + update: + - ec2:DescribeVpcBlockPublicAccessOptions + - ec2:ModifyVpcBlockPublicAccessOptions + delete: + - ec2:DescribeVpcBlockPublicAccessOptions + - ec2:ModifyVpcBlockPublicAccessOptions + VPCCidrBlock: + type: object + properties: + CidrBlock: + type: string + description: An IPv4 CIDR block to associate with the VPC. + Ipv6Pool: + type: string + description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. + Id: + type: string + description: The Id of the VPC associated CIDR Block. + VpcId: + type: string + description: The ID of the VPC. + Ipv6CidrBlock: + type: string + description: An IPv6 CIDR block from the IPv6 address pool. + Ipv4IpamPoolId: + type: string + description: The ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC. + Ipv4NetmaskLength: + type: integer + description: The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. + Ipv6IpamPoolId: + type: string + description: The ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC. + Ipv6NetmaskLength: + type: integer + description: The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. + AmazonProvidedIpv6CidrBlock: + type: boolean + description: Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. + Ipv6AddressAttribute: + type: string + description: The value denoting whether an IPv6 VPC CIDR Block is public or private. + IpSource: + type: string + description: The IP Source of an IPv6 VPC CIDR Block. + Ipv6CidrBlockNetworkBorderGroup: + type: string + description: The name of the location from which we advertise the IPV6 CIDR block. + required: + - VpcId + x-stackql-resource-name: vpc_cidr_block + description: Resource Type definition for AWS::EC2::VPCCidrBlock + x-type-name: AWS::EC2::VPCCidrBlock + x-stackql-primary-identifier: + - Id + - VpcId + x-create-only-properties: + - Ipv6Pool + - VpcId + - AmazonProvidedIpv6CidrBlock + - Ipv6CidrBlock + - CidrBlock + - Ipv4IpamPoolId + - Ipv4NetmaskLength + - Ipv6IpamPoolId + - Ipv6NetmaskLength + - Ipv6CidrBlockNetworkBorderGroup + x-write-only-properties: + - Ipv4IpamPoolId + - Ipv4NetmaskLength + - Ipv6IpamPoolId + - Ipv6NetmaskLength + x-read-only-properties: + - Id + - Ipv6AddressAttribute + - IpSource + x-required-properties: + - VpcId + x-tagging: + taggable: false + x-required-permissions: + create: + - ec2:AssociateVpcCidrBlock + - ec2:DescribeVpcs + - ec2:AllocateIpamPoolCidr + read: + - ec2:DescribeVpcs + delete: + - ec2:DescribeVpcs + - ec2:DisassociateVpcCidrBlock + list: + - ec2:DescribeVpcs + VPCDHCPOptionsAssociation: + type: object + properties: + DhcpOptionsId: + type: string + description: The ID of the DHCP options set, or default to associate no DHCP options with the VPC. + VpcId: + type: string + description: The ID of the VPC. + required: + - VpcId + - DhcpOptionsId + x-stackql-resource-name: vpcdhcp_options_association + description: Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC. + x-type-name: AWS::EC2::VPCDHCPOptionsAssociation + x-stackql-primary-identifier: + - DhcpOptionsId + - VpcId + x-create-only-properties: + - DhcpOptionsId + - VpcId + x-required-properties: + - VpcId + - DhcpOptionsId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:AssociateDhcpOptions + update: + - ec2:AssociateDhcpOptions + delete: + - ec2:AssociateDhcpOptions + read: + - ec2:DescribeVpcs + list: + - ec2:DescribeVpcs + DnsOptionsSpecification: + description: Describes the DNS options for an endpoint. + additionalProperties: false + type: object + properties: + PrivateDnsOnlyForInboundResolverEndpoint: + description: Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint. + type: string + enum: + - OnlyInboundResolver + - AllResolvers + - NotSpecified + DnsRecordIpType: + description: The DNS records created for the endpoint. + type: string + enum: + - ipv4 + - ipv6 + - dualstack + - service-defined + - not-specified + VPCEndpoint: + type: object + properties: + PrivateDnsEnabled: + description: >- + Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC + endpoint service. + To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. + This property is supported only for interface endpoints. + Default: ``false`` + type: boolean + IpAddressType: + description: The supported IP address types. + type: string + enum: + - ipv4 + - ipv6 + - dualstack + - not-specified + ServiceRegion: + description: Describes a Region. + type: string + CreationTimestamp: + description: '' + type: string + DnsOptions: + description: Describes the DNS options for an endpoint. + $ref: '#/components/schemas/DnsOptionsSpecification' + NetworkInterfaceIds: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + DnsEntries: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + ResourceConfigurationArn: + description: The Amazon Resource Name (ARN) of the resource configuration. + type: string + SecurityGroupIds: + uniqueItems: true + description: The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints. + x-insertionOrder: false + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/DefaultSecurityGroup + type: string + SubnetIds: + uniqueItems: true + description: The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + type: string + ServiceNetworkArn: + description: The Amazon Resource Name (ARN) of the service network. + type: string + VpcId: + description: The ID of the VPC. + type: string + RouteTableIds: + uniqueItems: true + description: The IDs of the route tables. Routing is supported only for gateway endpoints. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::RouteTable + propertyPath: /properties/RouteTableId + type: string + ServiceName: + description: The name of the endpoint service. + type: string + PolicyDocument: + description: |- + An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. + For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and CFNlong converts the policy to JSON format before calling the API actions for privatelink. Alternatively, you can include the JSON directly in the YAML, as shown in the following ``Properties`` section: + ``Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'`` + type: object + VpcEndpointType: + description: |- + The type of endpoint. + Default: Gateway + type: string + enum: + - Interface + - Gateway + - GatewayLoadBalancer + - ServiceNetwork + - Resource + Id: + description: '' + type: string + Tags: + uniqueItems: false + description: The tags to associate with the endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - VpcId + x-stackql-resource-name: vpc_endpoint + description: |- + Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/). + An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces. + An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint) + An endpoint of type ``GatewayLoadBalancer`` provides private connectivity between your VPC and virtual appliances from a service provider. + x-type-name: AWS::EC2::VPCEndpoint + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - ServiceName + - VpcEndpointType + - VpcId + - ServiceNetworkArn + - ResourceConfigurationArn + - ServiceRegion + x-read-only-properties: + - NetworkInterfaceIds + - CreationTimestamp + - DnsEntries + - Id + x-required-properties: + - VpcId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeVpcEndpoints + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - ec2:DescribeVpcEndpoints + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation + - ec2:DescribeVpcs + create: + - ec2:CreateVpcEndpoint + - ec2:DescribeVpcEndpoints + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - vpc-lattice:CreateServiceNetworkVpcEndpointAssociation + - vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation + - ec2:CreateTags + - ec2:DeleteTags + - vpce:AllowMultiRegion + - ec2:DescribeVpcs + update: + - ec2:ModifyVpcEndpoint + - ec2:DescribeVpcEndpoints + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - vpc-lattice:CreateServiceNetworkVpcEndpointAssociation + - vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation + - ec2:CreateTags + - ec2:DeleteTags + - vpce:AllowMultiRegion + - ec2:DescribeVpcs + list: + - ec2:DescribeVpcEndpoints + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation + - ec2:DescribeVpcs + delete: + - ec2:DeleteVpcEndpoints + - ec2:DescribeVpcEndpoints + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation + - ec2:CreateTags + - ec2:DeleteTags + - vpce:AllowMultiRegion + - ec2:DescribeVpcs + VPCEndpointConnectionNotification: + type: object + properties: + ConnectionEvents: + uniqueItems: false + description: The endpoint events for which to receive notifications. + x-insertionOrder: false + type: array + items: + type: string + VPCEndpointId: + description: The ID of the endpoint. + type: string + VPCEndpointConnectionNotificationId: + description: VPC Endpoint Connection ID generated by service + type: string + ConnectionNotificationArn: + description: The ARN of the SNS topic for the notifications. + type: string + ServiceId: + description: The ID of the endpoint service. + type: string + required: + - ConnectionEvents + - ConnectionNotificationArn + x-stackql-resource-name: vpc_endpoint_connection_notification + description: Resource Type definition for AWS::EC2::VPCEndpointConnectionNotification + x-type-name: AWS::EC2::VPCEndpointConnectionNotification + x-stackql-primary-identifier: + - VPCEndpointConnectionNotificationId + x-create-only-properties: + - ServiceId + - VPCEndpointId + x-read-only-properties: + - VPCEndpointConnectionNotificationId + x-required-properties: + - ConnectionEvents + - ConnectionNotificationArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:DescribeVpcEndpointConnectionNotifications + create: + - ec2:CreateVpcEndpointConnectionNotification + update: + - ec2:ModifyVpcEndpointConnectionNotification + - ec2:DescribeVpcEndpointConnectionNotifications + list: + - ec2:DescribeVpcEndpointConnectionNotifications + delete: + - ec2:DeleteVpcEndpointConnectionNotifications + IpAddressType: + type: string + enum: + - ipv4 + - ipv6 + VPCEndpointService: + type: object + properties: + NetworkLoadBalancerArns: + type: array + uniqueItems: false + items: + type: string + relationshipRef: + typeName: AWS::ElasticLoadBalancingV2::LoadBalancer + propertyPath: /properties/LoadBalancerArn + ContributorInsightsEnabled: + type: boolean + PayerResponsibility: + type: string + ServiceId: + type: string + AcceptanceRequired: + type: boolean + GatewayLoadBalancerArns: + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + description: The tags to add to the VPC endpoint service. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SupportedIpAddressTypes: + type: array + description: Specify which Ip Address types are supported for VPC endpoint service. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpAddressType' + SupportedRegions: + type: array + description: The Regions from which service consumers can access the service. + uniqueItems: true + x-insertionOrder: false + items: + type: string + x-stackql-resource-name: vpc_endpoint_service + description: Resource Type definition for AWS::EC2::VPCEndpointService + x-type-name: AWS::EC2::VPCEndpointService + x-stackql-primary-identifier: + - ServiceId + x-write-only-properties: + - ContributorInsightsEnabled + x-read-only-properties: + - ServiceId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateVpcEndpointServiceConfiguration + - ec2:ModifyVpcEndpointServicePayerResponsibility + - cloudwatch:ListManagedInsightRules + - cloudwatch:DeleteInsightRules + - cloudwatch:PutManagedInsightRules + - ec2:DescribeVpcEndpointServiceConfigurations + - vpce:AllowMultiRegion + - ec2:CreateTags + update: + - ec2:ModifyVpcEndpointServiceConfiguration + - ec2:DescribeVpcEndpointServiceConfigurations + - ec2:ModifyVpcEndpointServicePayerResponsibility + - cloudwatch:ListManagedInsightRules + - cloudwatch:DeleteInsightRules + - cloudwatch:PutManagedInsightRules + - ec2:CreateTags + - ec2:DeleteTags + - vpce:AllowMultiRegion + read: + - ec2:DescribeVpcEndpointServiceConfigurations + - cloudwatch:ListManagedInsightRules + delete: + - ec2:DeleteVpcEndpointServiceConfigurations + - ec2:DescribeVpcEndpointServiceConfigurations + - cloudwatch:ListManagedInsightRules + - cloudwatch:DeleteInsightRules + - ec2:DeleteTags + - vpce:AllowMultiRegion + list: + - ec2:DescribeVpcEndpointServiceConfigurations + - cloudwatch:ListManagedInsightRules + VPCEndpointServicePermissions: + type: object + properties: + AllowedPrincipals: + uniqueItems: false + type: array + items: + type: string + ServiceId: + type: string + required: + - ServiceId + x-stackql-resource-name: vpc_endpoint_service_permissions + description: Resource Type definition for AWS::EC2::VPCEndpointServicePermissions + x-type-name: AWS::EC2::VPCEndpointServicePermissions + x-stackql-primary-identifier: + - ServiceId + x-create-only-properties: + - ServiceId + x-required-properties: + - ServiceId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:CreateVpcEndpointServicePermissions + - ec2:ModifyVpcEndpointServicePermissions + - ec2:DeleteVpcEndpointServicePermissions + - ec2:DescribeVpcEndpointServicePermissions + create: + - ec2:CreateVpcEndpointServicePermissions + - ec2:ModifyVpcEndpointServicePermissions + - ec2:DeleteVpcEndpointServicePermissions + - ec2:DescribeVpcEndpointServicePermissions + update: + - ec2:CreateVpcEndpointServicePermissions + - ec2:ModifyVpcEndpointServicePermissions + - ec2:DeleteVpcEndpointServicePermissions + - ec2:DescribeVpcEndpointServicePermissions + list: + - ec2:CreateVpcEndpointServicePermissions + - ec2:ModifyVpcEndpointServicePermissions + - ec2:DeleteVpcEndpointServicePermissions + - ec2:DescribeVpcEndpointServicePermissions + delete: + - ec2:CreateVpcEndpointServicePermissions + - ec2:ModifyVpcEndpointServicePermissions + - ec2:DeleteVpcEndpointServicePermissions + - ec2:DescribeVpcEndpointServicePermissions + VPCGatewayAttachment: + type: object + properties: + AttachmentType: + type: string + description: 'Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment ' + InternetGatewayId: + type: string + description: The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. + VpcId: + type: string + description: The ID of the VPC. + VpnGatewayId: + type: string + description: The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. + required: + - VpcId + x-stackql-resource-name: vpc_gateway_attachment + description: Resource Type definition for AWS::EC2::VPCGatewayAttachment + x-type-name: AWS::EC2::VPCGatewayAttachment + x-stackql-primary-identifier: + - AttachmentType + - VpcId + x-create-only-properties: + - VpcId + x-read-only-properties: + - AttachmentType + x-required-properties: + - VpcId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:AttachInternetGateway + - ec2:AttachVpnGateway + - ec2:DescribeInternetGateways + - ec2:DescribeVpnGateways + read: + - ec2:DescribeInternetGateways + - ec2:DescribeVpnGateways + update: + - ec2:AttachInternetGateway + - ec2:AttachVpnGateway + - ec2:DetachInternetGateway + - ec2:DetachVpnGateway + - ec2:DescribeInternetGateways + - ec2:DescribeVpnGateways + delete: + - ec2:DetachInternetGateway + - ec2:DetachVpnGateway + - ec2:DescribeInternetGateways + - ec2:DescribeVpnGateways + list: + - ec2:DescribeInternetGateways + - ec2:DescribeVpnGateways + VPCPeeringConnection: + type: object + properties: + PeerRoleArn: + description: The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. + type: string + VpcId: + description: The ID of the VPC. + type: string + PeerVpcId: + description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + type: string + Id: + type: string + PeerRegion: + description: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. + type: string + PeerOwnerId: + description: The AWS account ID of the owner of the accepter VPC. + type: string + Tags: + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - VpcId + - PeerVpcId + x-stackql-resource-name: vpc_peering_connection + description: Resource Type definition for AWS::EC2::VPCPeeringConnection + x-type-name: AWS::EC2::VPCPeeringConnection + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - PeerRegion + - PeerOwnerId + - PeerVpcId + - PeerRoleArn + - VpcId + x-write-only-properties: + - PeerRoleArn + x-read-only-properties: + - Id + x-required-properties: + - VpcId + - PeerVpcId + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - ec2:DescribeVpcPeeringConnections + create: + - ec2:CreateVpcPeeringConnection + - ec2:DescribeVpcPeeringConnections + - ec2:AcceptVpcPeeringConnection + - ec2:CreateTags + - sts:AssumeRole + update: + - ec2:CreateTags + - ec2:DeleteTags + - ec2:DescribeVpcPeeringConnections + list: + - ec2:DescribeVpcPeeringConnections + delete: + - ec2:DeleteVpcPeeringConnection + - ec2:DescribeVpcPeeringConnections + CloudwatchLogOptionsSpecification: + description: Options for sending VPN tunnel logs to CloudWatch. + additionalProperties: false + type: object + properties: + LogEnabled: + description: |- + Enable or disable VPN tunnel logging feature. Default value is ``False``. + Valid values: ``True`` | ``False`` + type: boolean + LogOutputFormat: + description: |- + Set log format. Default format is ``json``. + Valid values: ``json`` | ``text`` + type: string + enum: + - json + - text + LogGroupArn: + description: The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. + type: string + Phase1IntegrityAlgorithmsRequestListValue: + description: Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations. + additionalProperties: false + type: object + properties: + Value: + description: The value for the integrity algorithm. + type: string + enum: + - SHA1 + - SHA2-256 + - SHA2-384 + - SHA2-512 + Phase2EncryptionAlgorithmsRequestListValue: + description: Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations. + additionalProperties: false + type: object + properties: + Value: + description: The encryption algorithm. + type: string + enum: + - AES128 + - AES256 + - AES128-GCM-16 + - AES256-GCM-16 + Phase2IntegrityAlgorithmsRequestListValue: + description: Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations. + additionalProperties: false + type: object + properties: + Value: + description: The integrity algorithm. + type: string + enum: + - SHA1 + - SHA2-256 + - SHA2-384 + - SHA2-512 + Phase1DHGroupNumbersRequestListValue: + description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations. + additionalProperties: false + type: object + properties: + Value: + description: The Diffie-Hellmann group number. + type: integer + enum: + - 2 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + VpnTunnelOptionsSpecification: + description: The tunnel options for a single VPN tunnel. + additionalProperties: false + type: object + properties: + Phase2EncryptionAlgorithms: + uniqueItems: false + description: |- + One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations. + Valid values: ``AES128`` | ``AES256`` | ``AES128-GCM-16`` | ``AES256-GCM-16`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestListValue' + Phase2DHGroupNumbers: + uniqueItems: false + description: |- + One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations. + Valid values: ``2`` | ``5`` | ``14`` | ``15`` | ``16`` | ``17`` | ``18`` | ``19`` | ``20`` | ``21`` | ``22`` | ``23`` | ``24`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Phase2DHGroupNumbersRequestListValue' + TunnelInsideIpv6Cidr: + description: |- + The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway. + Constraints: A size /126 CIDR block from the local ``fd00::/8`` range. + type: string + StartupAction: + description: |- + The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify ``start`` for AWS to initiate the IKE negotiation. + Valid Values: ``add`` | ``start`` + Default: ``add`` + type: string + enum: + - add + - start + TunnelInsideCidr: + description: |- + The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. + Constraints: A size /30 CIDR block from the ``169.254.0.0/16`` range. The following CIDR blocks are reserved and cannot be used: + + ``169.254.0.0/30`` + + ``169.254.1.0/30`` + + ``169.254.2.0/30`` + + ``169.254.3.0/30`` + + ``169.254.4.0/30`` + + ``169.254.5.0/30`` + + ``169.254.169.252/30`` + type: string + IKEVersions: + uniqueItems: false + description: |- + The IKE versions that are permitted for the VPN tunnel. + Valid values: ``ikev1`` | ``ikev2`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/IKEVersionsRequestListValue' + LogOptions: + description: Options for logging VPN tunnel activity. + $ref: '#/components/schemas/VpnTunnelLogOptionsSpecification' + Phase1DHGroupNumbers: + uniqueItems: false + description: |- + One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations. + Valid values: ``2`` | ``14`` | ``15`` | ``16`` | ``17`` | ``18`` | ``19`` | ``20`` | ``21`` | ``22`` | ``23`` | ``24`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Phase1DHGroupNumbersRequestListValue' + ReplayWindowSize: + description: |- + The number of packets in an IKE replay window. + Constraints: A value between 64 and 2048. + Default: ``1024`` + maximum: 2048 + type: integer + minimum: 64 + EnableTunnelLifecycleControl: + description: Turn on or off tunnel endpoint lifecycle control feature. + type: boolean + RekeyMarginTimeSeconds: + description: |- + The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for ``RekeyFuzzPercentage``. + Constraints: A value between 60 and half of ``Phase2LifetimeSeconds``. + Default: ``270`` + type: integer + minimum: 60 + DPDTimeoutAction: + description: |- + The action to take after DPD timeout occurs. Specify ``restart`` to restart the IKE initiation. Specify ``clear`` to end the IKE session. + Valid Values: ``clear`` | ``none`` | ``restart`` + Default: ``clear`` + type: string + enum: + - clear + - none + - restart + Phase2LifetimeSeconds: + description: |- + The lifetime for phase 2 of the IKE negotiation, in seconds. + Constraints: A value between 900 and 3,600. The value must be less than the value for ``Phase1LifetimeSeconds``. + Default: ``3600`` + maximum: 3600 + type: integer + minimum: 900 + Phase2IntegrityAlgorithms: + uniqueItems: false + description: |- + One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations. + Valid values: ``SHA1`` | ``SHA2-256`` | ``SHA2-384`` | ``SHA2-512`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestListValue' + Phase1IntegrityAlgorithms: + uniqueItems: false + description: |- + One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations. + Valid values: ``SHA1`` | ``SHA2-256`` | ``SHA2-384`` | ``SHA2-512`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestListValue' + PreSharedKey: + description: |- + The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway. + Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0). + type: string + Phase1LifetimeSeconds: + description: |- + The lifetime for phase 1 of the IKE negotiation, in seconds. + Constraints: A value between 900 and 28,800. + Default: ``28800`` + maximum: 28800 + type: integer + minimum: 900 + RekeyFuzzPercentage: + description: |- + The percentage of the rekey window (determined by ``RekeyMarginTimeSeconds``) during which the rekey time is randomly selected. + Constraints: A value between 0 and 100. + Default: ``100`` + maximum: 100 + type: integer + minimum: 0 + Phase1EncryptionAlgorithms: + uniqueItems: false + description: |- + One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations. + Valid values: ``AES128`` | ``AES256`` | ``AES128-GCM-16`` | ``AES256-GCM-16`` + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestListValue' + DPDTimeoutSeconds: + description: |- + The number of seconds after which a DPD timeout occurs. + Constraints: A value greater than or equal to 30. + Default: ``30`` + type: integer + minimum: 30 + Phase1EncryptionAlgorithmsRequestListValue: + description: Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations. + additionalProperties: false + type: object + properties: + Value: + description: The value for the encryption algorithm. + type: string + enum: + - AES128 + - AES256 + - AES128-GCM-16 + - AES256-GCM-16 + IKEVersionsRequestListValue: + description: The IKE version that is permitted for the VPN tunnel. + additionalProperties: false + type: object + properties: + Value: + description: The IKE version. + type: string + enum: + - ikev1 + - ikev2 + VpnTunnelLogOptionsSpecification: + description: Options for logging VPN tunnel activity. + additionalProperties: false + type: object + properties: + CloudwatchLogOptions: + description: Options for sending VPN tunnel logs to CloudWatch. + $ref: '#/components/schemas/CloudwatchLogOptionsSpecification' + Phase2DHGroupNumbersRequestListValue: + description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations. + additionalProperties: false + type: object + properties: + Value: + description: The Diffie-Hellmann group number. + type: integer + enum: + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + VPNConnection: + type: object + properties: + RemoteIpv6NetworkCidr: + description: |- + The IPv6 CIDR on the AWS side of the VPN connection. + Default: ``::/0`` + type: string + RemoteIpv4NetworkCidr: + description: |- + The IPv4 CIDR on the AWS side of the VPN connection. + Default: ``0.0.0.0/0`` + type: string + VpnTunnelOptionsSpecifications: + uniqueItems: false + description: The tunnel options for the VPN connection. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/VpnTunnelOptionsSpecification' + CustomerGatewayId: + description: The ID of the customer gateway at your end of the VPN connection. + type: string + OutsideIpAddressType: + description: |- + The type of IP address assigned to the outside interface of the customer gateway device. + Valid values: ``PrivateIpv4`` | ``PublicIpv4`` | ``Ipv6`` + Default: ``PublicIpv4`` + type: string + StaticRoutesOnly: + description: |- + Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. + If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify ``true``. + type: boolean + EnableAcceleration: + description: |- + Indicate whether to enable acceleration for the VPN connection. + Default: ``false`` + type: boolean + TransitGatewayId: + description: |- + The ID of the transit gateway associated with the VPN connection. + You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both. + type: string + Type: + description: The type of VPN connection. + type: string + LocalIpv4NetworkCidr: + description: |- + The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. + Default: ``0.0.0.0/0`` + type: string + VpnGatewayId: + description: |- + The ID of the virtual private gateway at the AWS side of the VPN connection. + You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both. + type: string + PreSharedKeyStorage: + description: Describes the storage location for an instance store-backed AMI. + type: string + enum: + - Standard + - SecretsManager + TransportTransitGatewayAttachmentId: + description: |- + The transit gateway attachment ID to use for the VPN tunnel. + Required if ``OutsideIpAddressType`` is set to ``PrivateIpv4``. + type: string + LocalIpv6NetworkCidr: + description: |- + The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. + Default: ``::/0`` + type: string + VpnConnectionId: + description: '' + type: string + TunnelInsideIpVersion: + description: |- + Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. + Default: ``ipv4`` + type: string + Tags: + uniqueItems: false + description: Any tags assigned to the VPN connection. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - Type + - CustomerGatewayId + x-stackql-resource-name: vpn_connection + description: |- + Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway. + To specify a VPN connection between a transit gateway and customer gateway, use the ``TransitGatewayId`` and ``CustomerGatewayId`` properties. + To specify a VPN connection between a virtual private gateway and customer gateway, use the ``VpnGatewayId`` and ``CustomerGatewayId`` properties. + For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*. + x-type-name: AWS::EC2::VPNConnection + x-stackql-primary-identifier: + - VpnConnectionId + x-create-only-properties: + - Type + - CustomerGatewayId + - VpnGatewayId + - TransitGatewayId + - EnableAcceleration + - LocalIpv4NetworkCidr + - LocalIpv6NetworkCidr + - OutsideIpAddressType + - RemoteIpv4NetworkCidr + - RemoteIpv6NetworkCidr + - StaticRoutesOnly + - TransportTransitGatewayAttachmentId + - TunnelInsideIpVersion + - PreSharedKeyStorage + - VpnTunnelOptionsSpecifications + x-write-only-properties: + - PreSharedKeyStorage + - VpnTunnelOptionsSpecifications/*/PreSharedKey + x-read-only-properties: + - VpnConnectionId + x-required-properties: + - Type + - CustomerGatewayId + x-replacement-strategy: delete_then_create + x-tagging: + permissions: + - ec2:CreateTags + - ec2:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:DescribeVpnConnections + create: + - ec2:DescribeVpnConnections + - ec2:CreateVpnConnection + - ec2:CreateTags + update: + - ec2:DescribeVpnConnections + - ec2:CreateTags + - ec2:DeleteTags + list: + - ec2:DescribeVpnConnections + delete: + - ec2:DescribeVpnConnections + - ec2:DeleteVpnConnection + VPNConnectionRoute: + type: object + properties: + DestinationCidrBlock: + description: The CIDR block associated with the local subnet of the customer network. + type: string + VpnConnectionId: + description: The ID of the VPN connection. + type: string + required: + - DestinationCidrBlock + - VpnConnectionId + x-stackql-resource-name: vpn_connection_route + description: |- + Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. + For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*. + x-type-name: AWS::EC2::VPNConnectionRoute + x-stackql-primary-identifier: + - DestinationCidrBlock + - VpnConnectionId + x-create-only-properties: + - DestinationCidrBlock + - VpnConnectionId + x-required-properties: + - DestinationCidrBlock + - VpnConnectionId + x-tagging: + taggable: false + x-required-permissions: + read: + - ec2:DescribeVpnConnections + create: + - ec2:CreateVpnConnectionRoute + - ec2:DescribeVpnConnections + list: + - ec2:DescribeVpnConnections + delete: + - ec2:DeleteVpnConnectionRoute + - ec2:DescribeVpnConnections + VPNGateway: + type: object + properties: + VPNGatewayId: + description: '' + type: string + AmazonSideAsn: + description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session. + type: integer + format: int64 + Tags: + description: Any tags assigned to the virtual private gateway. + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Type: + description: The type of VPN connection the virtual private gateway supports. + type: string + required: + - Type + x-stackql-resource-name: vpn_gateway + description: |- + Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. + For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*. + x-type-name: AWS::EC2::VPNGateway + x-stackql-primary-identifier: + - VPNGatewayId + x-create-only-properties: + - AmazonSideAsn + - Type + x-read-only-properties: + - VPNGatewayId + x-required-properties: + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ec2:CreateTags + - ec2:DeleteTags + x-required-permissions: + create: + - ec2:CreateVpnGateway + - ec2:DescribeVpnGateways + - ec2:CreateTags + read: + - ec2:DescribeVpnGateways + update: + - ec2:DescribeVpnGateways + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteVpnGateway + - ec2:DescribeVpnGateways + list: + - ec2:DescribeVpnGateways + CreateCapacityReservationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Tenancy: + type: string + EndDateType: + type: string + TagSpecifications: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/TagSpecification' + AvailabilityZone: + type: string + TotalInstanceCount: + type: integer + EndDate: + type: string + EbsOptimized: + type: boolean + OutPostArn: + type: string + InstanceCount: + type: integer + PlacementGroupArn: + type: string + AvailableInstanceCount: + type: integer + InstancePlatform: + type: string + Id: + type: string + InstanceType: + type: string + EphemeralStorage: + type: boolean + InstanceMatchCriteria: + type: string + UnusedReservationBillingOwnerId: + type: string + AvailabilityZoneId: + type: string + StartDate: + type: string + CapacityReservationArn: + type: string + CreateDate: + type: string + State: + type: string + OwnerId: + type: string + DeliveryPreference: + type: string + CapacityReservationFleetId: + type: string + ReservationType: + type: string + CapacityAllocationSet: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/CapacityAllocation' + CommitmentInfo: + type: object + additionalProperties: false + properties: + CommitmentEndDate: + type: string + CommittedInstanceCount: + type: integer + x-stackQL-stringOnly: true + x-title: CreateCapacityReservationRequest + type: object + required: [] + CreateCapacityReservationFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllocationStrategy: + type: string + TagSpecifications: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/TagSpecification' + InstanceTypeSpecifications: + type: array + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + items: + $ref: '#/components/schemas/InstanceTypeSpecification' + TotalTargetCapacity: + type: integer + minimum: 1 + maximum: 25000 + EndDate: + type: string + InstanceMatchCriteria: + type: string + enum: + - open + CapacityReservationFleetId: + type: string + Tenancy: + type: string + enum: + - default + RemoveEndDate: + type: boolean + NoRemoveEndDate: + type: boolean + x-stackQL-stringOnly: true + x-title: CreateCapacityReservationFleetRequest + type: object + required: [] + CreateCarrierGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CarrierGatewayId: + description: The ID of the carrier gateway. + type: string + State: + description: The state of the carrier gateway. + type: string + VpcId: + description: The ID of the VPC. + type: string + OwnerId: + description: The ID of the owner. + type: string + Tags: + description: The tags for the carrier gateway. + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateCarrierGatewayRequest + type: object + required: [] + CreateCustomerGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Type: + description: The type of VPN connection that this customer gateway supports (``ipsec.1``). + type: string + CustomerGatewayId: + description: '' + type: string + IpAddress: + description: The IP address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``Ipv6``, you can use an IPv6 address. + type: string + BgpAsnExtended: + multipleOf: 1 + maximum: 4294967294 + description: |- + For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``. + Valid values: ``2,147,483,648`` to ``4,294,967,295`` + type: number + minimum: 2147483648 + BgpAsn: + default: 65000 + description: |- + For customer gateway devices that support BGP, specify the device's ASN. You must specify either ``BgpAsn`` or ``BgpAsnExtended`` when creating the customer gateway. If the ASN is larger than ``2,147,483,647``, you must use ``BgpAsnExtended``. + Default: 65000 + Valid values: ``1`` to ``2,147,483,647`` + type: integer + Tags: + uniqueItems: false + description: One or more tags for the customer gateway. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + CertificateArn: + pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso([a-z]{1})?))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$ + description: The Amazon Resource Name (ARN) for the customer gateway certificate. + type: string + DeviceName: + description: The name of customer gateway device. + type: string + x-stackQL-stringOnly: true + x-title: CreateCustomerGatewayRequest + type: object + required: [] + CreateDHCPOptionsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DhcpOptionsId: + type: string + DomainName: + type: string + description: This value is used to complete unqualified DNS hostnames. + DomainNameServers: + type: array + description: The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS. + uniqueItems: true + items: + type: string + NetbiosNameServers: + type: array + description: The IPv4 addresses of up to four NetBIOS name servers. + uniqueItems: true + items: + type: string + NetbiosNodeType: + type: integer + description: The NetBIOS node type (1, 2, 4, or 8). + NtpServers: + type: array + description: The IPv4 addresses of up to four Network Time Protocol (NTP) servers. + uniqueItems: false + items: + type: string + Ipv6AddressPreferredLeaseTime: + type: integer + description: The preferred Lease Time for ipV6 address in seconds. + Tags: + type: array + description: Any tags assigned to the DHCP options set. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDHCPOptionsRequest + type: object + required: [] + CreateEC2FleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TargetCapacitySpecification: + $ref: '#/components/schemas/TargetCapacitySpecificationRequest' + OnDemandOptions: + $ref: '#/components/schemas/OnDemandOptionsRequest' + Type: + type: string + enum: + - maintain + - request + - instant + ExcessCapacityTerminationPolicy: + type: string + enum: + - termination + - no-termination + TagSpecifications: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/TagSpecification' + SpotOptions: + $ref: '#/components/schemas/SpotOptionsRequest' + ValidFrom: + type: string + ReplaceUnhealthyInstances: + type: boolean + LaunchTemplateConfigs: + type: array + uniqueItems: false + maxItems: 50 + items: + $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest' + FleetId: + type: string + TerminateInstancesWithExpiration: + type: boolean + ValidUntil: + type: string + Context: + type: string + x-stackQL-stringOnly: true + x-title: CreateEC2FleetRequest + type: object + required: [] + CreateEgressOnlyInternetGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Service Generated ID of the EgressOnlyInternetGateway + type: string + VpcId: + description: The ID of the VPC for which to create the egress-only internet gateway. + type: string + Tags: + type: array + description: Any tags assigned to the egress only internet gateway. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEgressOnlyInternetGatewayRequest + type: object + required: [] + CreateEIPRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PublicIp: + description: '' + type: string + AllocationId: + description: '' + type: string + Domain: + description: |- + The network (``vpc``). + If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource. + type: string + NetworkBorderGroup: + description: |- + A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups. + Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups. + type: string + TransferAddress: + description: The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*. + type: string + InstanceId: + description: |- + The ID of the instance. + Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + type: string + PublicIpv4Pool: + description: |- + The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. + Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + type: string + IpamPoolId: + description: '' + type: string + Address: + description: '' + type: string + Tags: + description: |- + Any tags assigned to the Elastic IP address. + Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEIPRequest + type: object + required: [] + CreateEIPAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PrivateIpAddress: + description: The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. + type: string + InstanceId: + description: The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both. + type: string + AllocationId: + description: The allocation ID. This is required. + type: string + Id: + description: '' + type: string + NetworkInterfaceId: + description: |- + The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. + You can specify either the instance ID or the network interface ID, but not both. + type: string + EIP: + description: '' + anyOf: + - relationshipRef: + typeName: AWS::EC2::EIP + propertyPath: /properties/PublicIp + - relationshipRef: + typeName: AWS::EC2::EIP + propertyPath: /properties/AllocationId + type: string + x-stackQL-stringOnly: true + x-title: CreateEIPAssociationRequest + type: object + required: [] + CreateEnclaveCertificateIamRoleAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateArn: + description: The Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role. + type: string + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:acm:[A-Za-z0-9-]{1,64}:([0-9]{12})?:certificate/.+$ + minLength: 1 + maxLength: 1283 + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate. + type: string + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:iam:.*:([0-9]{12})?:role/.+$ + minLength: 1 + maxLength: 1283 + CertificateS3BucketName: + description: The name of the Amazon S3 bucket to which the certificate was uploaded. + type: string + CertificateS3ObjectKey: + description: The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. + type: string + EncryptionKmsKeyId: + description: The ID of the AWS KMS CMK used to encrypt the private key of the certificate. + type: string + x-stackQL-stringOnly: true + x-title: CreateEnclaveCertificateIamRoleAssociationRequest + type: object + required: [] + CreateFlowLogRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The Flow Log ID + type: string + DeliverCrossAccountRole: + description: The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. + type: string + DeliverLogsPermissionArn: + description: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. + type: string + LogDestination: + description: Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType. + type: string + LogDestinationType: + description: Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. + type: string + enum: + - cloud-watch-logs + - s3 + - kinesis-data-firehose + LogFormat: + description: The fields to include in the flow log record, in the order in which they should appear. + type: string + LogGroupName: + description: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. + type: string + MaxAggregationInterval: + description: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). + type: integer + ResourceId: + description: The ID of the subnet, network interface, or VPC for which you want to create a flow log. + type: string + ResourceType: + description: The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. + type: string + enum: + - NetworkInterface + - Subnet + - VPC + - TransitGateway + - TransitGatewayAttachment + Tags: + description: The tags to apply to the flow logs. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TrafficType: + description: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. + type: string + enum: + - ACCEPT + - ALL + - REJECT + DestinationOptions: + type: object + additionalProperties: false + properties: + FileFormat: + type: string + enum: + - plain-text + - parquet + HiveCompatiblePartitions: + type: boolean + PerHourPartition: + type: boolean + required: + - FileFormat + - HiveCompatiblePartitions + - PerHourPartition + x-stackQL-stringOnly: true + x-title: CreateFlowLogRequest + type: object + required: [] + CreateGatewayRouteTableAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteTableId: + description: The ID of the route table. + type: string + GatewayId: + description: The ID of the gateway. + type: string + AssociationId: + description: The route table association ID. + type: string + x-stackQL-stringOnly: true + x-title: CreateGatewayRouteTableAssociationRequest + type: object + required: [] + CreateHostRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HostId: + description: ID of the host created. + type: string + AutoPlacement: + description: Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. + type: string + AvailabilityZone: + description: The Availability Zone in which to allocate the Dedicated Host. + type: string + HostRecovery: + description: Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. + type: string + InstanceType: + description: Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. + type: string + InstanceFamily: + description: Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. + type: string + OutpostArn: + description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. + type: string + HostMaintenance: + description: Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host. + type: string + AssetId: + description: The ID of the Outpost hardware asset. + type: string + Tags: + description: Any tags assigned to the Host. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateHostRequest + type: object + required: [] + CreateNetworkInterfaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A description for the network interface. + type: string + PrivateIpAddress: + description: 'Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. ' + type: string + PrimaryIpv6Address: + description: The primary IPv6 address + type: string + PrivateIpAddresses: + uniqueItems: false + description: Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PrivateIpAddressSpecification' + SecondaryPrivateIpAddressCount: + description: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses + type: integer + Ipv6PrefixCount: + description: 'The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can''t specify a count of IPv6 prefixes if you''ve specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.' + type: integer + PrimaryPrivateIpAddress: + description: Returns the primary private IP address of the network interface. + type: string + Ipv4Prefixes: + uniqueItems: false + description: 'Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can''t specify IPv4 prefixes if you''ve specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ipv4PrefixSpecification' + Ipv4PrefixCount: + description: 'The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can''t specify a count of IPv4 prefixes if you''ve specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.' + type: integer + EnablePrimaryIpv6: + description: >- + If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If + you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address. + type: boolean + GroupSet: + uniqueItems: false + description: A list of security group IDs associated with this network interface. + x-insertionOrder: false + type: array + items: + type: string + Ipv6Addresses: + uniqueItems: true + description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InstanceIpv6Address' + Ipv6Prefixes: + uniqueItems: false + description: 'Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can''t specify IPv6 prefixes if you''ve specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixSpecification' + SubnetId: + description: The ID of the subnet to associate with the network interface. + type: string + SourceDestCheck: + description: Indicates whether traffic to or from the instance is validated. + type: boolean + InterfaceType: + description: Indicates the type of network interface. + type: string + SecondaryPrivateIpAddresses: + uniqueItems: false + description: Returns the secondary private IP addresses of the network interface. + x-insertionOrder: false + type: array + items: + type: string + VpcId: + description: The ID of the VPC + type: string + Ipv6AddressCount: + description: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. + type: integer + Id: + description: Network interface id. + type: string + Tags: + uniqueItems: false + description: An arbitrary set of tags (key-value pairs) for this network interface. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + ConnectionTrackingSpecification: + $ref: '#/components/schemas/ConnectionTrackingSpecification' + x-stackQL-stringOnly: true + x-title: CreateNetworkInterfaceRequest + type: object + required: [] + CreateVolumeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MultiAttachEnabled: + description: |- + Indicates whether Amazon EBS Multi-Attach is enabled. + CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. + type: boolean + KmsKeyId: + description: |- + The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. + If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. + Alternatively, if you want to specify a different key, you can specify one of the following: + + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + type: string + Encrypted: + description: |- + Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide*. + Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances). + type: boolean + Size: + description: |- + The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. + The following are the supported volumes sizes for each volume type: + + ``gp2`` and ``gp3``: 1 - 16,384 GiB + + ``io1``: 4 - 16,384 GiB + + ``io2``: 4 - 65,536 GiB + + ``st1`` and ``sc1``: 125 - 16,384 GiB + + ``standard``: 1 - 1024 GiB + type: integer + AutoEnableIO: + description: Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. + type: boolean + OutpostArn: + description: The Amazon Resource Name (ARN) of the Outpost. + type: string + AvailabilityZone: + description: |- + The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. + Either ``AvailabilityZone`` or ``AvailabilityZoneId`` must be specified, but not both. + type: string + Throughput: + description: |- + The throughput to provision for a volume, with a maximum of 1,000 MiB/s. + This parameter is valid only for ``gp3`` volumes. The default value is 125. + Valid Range: Minimum value of 125. Maximum value of 1000. + type: integer + Iops: + description: |- + The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type: + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS. + This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. + type: integer + VolumeInitializationRate: + description: |- + Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. + This parameter is supported only for volumes created from snapshots. Omit this parameter if: + + You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. + If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. + + You want to create a volume that is initialized at the default rate. + + For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*. + Valid range: 100 - 300 MiB/s + type: integer + SnapshotId: + description: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. + type: string + VolumeId: + description: '' + type: string + VolumeType: + description: |- + The volume type. This parameter can be one of the following values: + + General Purpose SSD: ``gp2`` | ``gp3`` + + Provisioned IOPS SSD: ``io1`` | ``io2`` + + Throughput Optimized HDD: ``st1`` + + Cold HDD: ``sc1`` + + Magnetic: ``standard`` + + For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html). + Default: ``gp2`` + type: string + Tags: + uniqueItems: false + description: The tags to apply to the volume during creation. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVolumeRequest + type: object + required: [] + CreateInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PrivateDnsName: + description: 'The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.' + type: string + Volumes: + uniqueItems: false + description: The volumes to attach to the instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Volume' + PrivateIp: + description: 'The private IP address of the specified instance. For example: 10.24.34.0.' + type: string + EnclaveOptions: + description: Indicates whether the instance is enabled for AWS Nitro Enclaves. + additionalProperties: false + type: object + properties: + Enabled: + description: If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. + type: boolean + ImageId: + description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. + type: string + Tags: + uniqueItems: false + description: The tags to add to the instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + AdditionalInfo: + description: 'This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).' + type: string + HibernationOptions: + description: Indicates whether an instance is enabled for hibernation. + additionalProperties: false + type: object + properties: + Configured: + default: false + description: If you set this parameter to true, your instance is enabled for hibernation. + type: boolean + LicenseSpecifications: + uniqueItems: false + description: The license configurations. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/LicenseSpecification' + MetadataOptions: + description: The metadata options for the instance + type: object + $ref: '#/components/schemas/MetadataOptions' + InstanceId: + description: The EC2 Instance ID. + type: string + CpuOptions: + description: The CPU options for the instance. + additionalProperties: false + type: object + properties: + ThreadsPerCore: + type: integer + CoreCount: + type: integer + AvailabilityZone: + description: The Availability Zone of the instance. + type: string + PrivateDnsNameOptions: + description: The options for the instance hostname. + type: object + $ref: '#/components/schemas/PrivateDnsNameOptions' + HostId: + description: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. + type: string + PublicDnsName: + description: 'The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.' + type: string + SecurityGroupIds: + uniqueItems: false + description: The IDs of the security groups. + x-insertionOrder: false + type: array + items: + type: string + PlacementGroupName: + description: The name of an existing placement group that you want to launch the instance into (cluster | partition | spread). + type: string + SsmAssociations: + uniqueItems: false + description: The SSM document and parameter values in AWS Systems Manager to associate with this instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SsmAssociation' + VpcId: + description: The ID of the VPC that the instance is running in. + type: string + State: + description: The current state of the instance. + type: object + $ref: '#/components/schemas/State' + Affinity: + description: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default. + type: string + enum: + - default + - host + Tenancy: + description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. + type: string + SecurityGroups: + uniqueItems: false + description: the names of the security groups. For a nondefault VPC, you must use security group IDs instead. + x-insertionOrder: false + type: array + items: + type: string + PrivateIpAddress: + description: '[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.' + type: string + UserData: + description: The user data to make available to the instance. + type: string + BlockDeviceMappings: + uniqueItems: false + description: The block device mapping entries that defines the block devices to attach to the instance at launch. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' + IamInstanceProfile: + description: The IAM instance profile. + type: string + Ipv6Addresses: + uniqueItems: false + description: '[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InstanceIpv6Address' + KernelId: + description: The ID of the kernel. + type: string + SubnetId: + description: |+ + [EC2-VPC] The ID of the subnet to launch the instance into. + + type: string + EbsOptimized: + description: Indicates whether the instance is optimized for Amazon EBS I/O. + type: boolean + PropagateTagsToVolumeOnCreation: + description: Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes. + type: boolean + ElasticGpuSpecifications: + uniqueItems: false + description: An elastic GPU to associate with the instance. Amazon Elastic Graphics is no longer available. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ElasticGpuSpecification' + ElasticInferenceAccelerators: + uniqueItems: false + description: An elastic inference accelerator to associate with the instance. Amazon Elastic Inference is no longer available. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ElasticInferenceAccelerator' + Ipv6AddressCount: + description: '[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.' + type: integer + LaunchTemplate: + description: The launch template to use to launch the instances. + type: object + $ref: '#/components/schemas/LaunchTemplateSpecification' + NetworkInterfaces: + uniqueItems: false + description: The network interfaces to associate with the instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + InstanceType: + description: The instance type. + type: string + Monitoring: + description: Specifies whether detailed monitoring is enabled for the instance. + type: boolean + PublicIp: + description: 'The public IP address of the specified instance. For example: 192.0.2.0.' + type: string + InstanceInitiatedShutdownBehavior: + description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + type: string + HostResourceGroupArn: + description: The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host. + type: string + DisableApiTermination: + description: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. + type: boolean + KeyName: + description: The name of the key pair. + type: string + RamdiskId: + description: The ID of the RAM disk to select. + type: string + SourceDestCheck: + description: Specifies whether to enable an instance launched in a VPC to perform NAT. + type: boolean + CreditSpecification: + description: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. + additionalProperties: false + type: object + properties: + CPUCredits: + type: string + x-stackQL-stringOnly: true + x-title: CreateInstanceRequest + type: object + required: [] + CreateInstanceConnectEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The id of the instance connect endpoint + type: string + SubnetId: + description: The subnet id of the instance connect endpoint + type: string + ClientToken: + description: The client token of the instance connect endpoint. + type: string + PreserveClientIp: + description: If true, the address of the instance connect endpoint client is preserved when connecting to the end resource + type: boolean + Tags: + description: The tags of the instance connect endpoint. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SecurityGroupIds: + description: The security group IDs of the instance connect endpoint. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' + x-stackQL-stringOnly: true + x-title: CreateInstanceConnectEndpointRequest + type: object + required: [] + CreateInternetGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InternetGatewayId: + description: '' + type: string + Tags: + description: Any tags to assign to the internet gateway. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateInternetGatewayRequest + type: object + required: [] + CreateIPAMRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamId: + description: Id of the IPAM. + type: string + Arn: + description: The Amazon Resource Name (ARN) of the IPAM. + type: string + DefaultResourceDiscoveryId: + description: The Id of the default resource discovery, created with this IPAM. + type: string + DefaultResourceDiscoveryAssociationId: + description: The Id of the default association to the default resource discovery, created with this IPAM. + type: string + ResourceDiscoveryAssociationCount: + description: The count of resource discoveries associated with this IPAM. + type: integer + Description: + type: string + PublicDefaultScopeId: + description: The Id of the default scope for publicly routable IP space, created with this IPAM. + type: string + maxLength: 255 + PrivateDefaultScopeId: + description: The Id of the default scope for publicly routable IP space, created with this IPAM. + type: string + ScopeCount: + description: The number of scopes that currently exist in this IPAM. + type: integer + OperatingRegions: + description: The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpamOperatingRegion' + Tier: + description: The tier of the IPAM. + type: string + enum: + - free + - advanced + EnablePrivateGua: + description: Enable provisioning of GUA space in private pools. + type: boolean + MeteredAccount: + description: A metered account is an account that is charged for active IP addresses managed in IPAM + type: string + enum: + - ipam-owner + - resource-owner + DefaultResourceDiscoveryOrganizationalUnitExclusions: + description: A set of organizational unit (OU) exclusions for the default resource discovery, created with this IPAM. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpamOrganizationalUnitExclusion' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIPAMRequest + type: object + required: [] + CreateIPAMAllocationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamPoolAllocationId: + description: Id of the allocation. + type: string + IpamPoolId: + description: Id of the IPAM Pool. + type: string + Cidr: + $ref: '#/components/schemas/Cidr' + NetmaskLength: + description: The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it. + type: integer + Description: + type: string + x-stackQL-stringOnly: true + x-title: CreateIPAMAllocationRequest + type: object + required: [] + CreateIPAMPoolRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamPoolId: + description: Id of the IPAM Pool. + type: string + AddressFamily: + description: The address family of the address space in this pool. Either IPv4 or IPv6. + type: string + AllocationMinNetmaskLength: + description: The minimum allowed netmask length for allocations made from this pool. + type: integer + AllocationDefaultNetmaskLength: + description: The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified. + type: integer + AllocationMaxNetmaskLength: + description: The maximum allowed netmask length for allocations made from this pool. + type: integer + AllocationResourceTags: + description: When specified, an allocation will not be allowed unless a resource has a matching set of tags. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The Amazon Resource Name (ARN) of the IPAM Pool. + type: string + AutoImport: + description: Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically. + type: boolean + AwsService: + description: Limits which service in Amazon Web Services that the pool can be used in. + type: string + enum: + - ec2 + Description: + type: string + IpamScopeId: + description: The Id of the scope this pool is a part of. + type: string + IpamScopeArn: + description: The Amazon Resource Name (ARN) of the scope this pool is a part of. + type: string + IpamScopeType: + description: Determines whether this scope contains publicly routable space or space for a private network + type: string + enum: + - public + - private + IpamArn: + description: The Amazon Resource Name (ARN) of the IPAM this pool is a part of. + type: string + Locale: + description: The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match. + type: string + PoolDepth: + description: The depth of this pool in the source pool hierarchy. + type: integer + ProvisionedCidrs: + description: A list of cidrs representing the address space available for allocation in this pool. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ProvisionedCidr' + PublicIpSource: + description: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`. + type: string + enum: + - byoip + - amazon + PubliclyAdvertisable: + description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. + type: boolean + SourceIpamPoolId: + description: The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool. + type: string + SourceResource: + $ref: '#/components/schemas/SourceResource' + State: + description: 'The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"' + type: string + enum: + - create-in-progress + - create-complete + - modify-in-progress + - modify-complete + - delete-in-progress + - delete-complete + StateMessage: + description: An explanation of how the pool arrived at it current state. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIPAMPoolRequest + type: object + required: [] + CreateIPAMPoolCidrRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamPoolCidrId: + description: Id of the IPAM Pool Cidr. + type: string + IpamPoolId: + description: Id of the IPAM Pool. + type: string + Cidr: + description: Represents a single IPv4 or IPv6 CIDR + type: string + NetmaskLength: + description: The desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it. + type: integer + State: + description: Provisioned state of the cidr. + type: string + x-stackQL-stringOnly: true + x-title: CreateIPAMPoolCidrRequest + type: object + required: [] + CreateIPAMResourceDiscoveryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamResourceDiscoveryId: + description: Id of the IPAM Pool. + type: string + OwnerId: + description: Owner Account ID of the Resource Discovery + type: string + OperatingRegions: + description: The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpamOperatingRegion' + IpamResourceDiscoveryRegion: + description: 'The region the resource discovery is setup in. ' + type: string + Description: + type: string + OrganizationalUnitExclusions: + description: A set of organizational unit (OU) exclusions for this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpamResourceDiscoveryOrganizationalUnitExclusion' + IsDefault: + description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. + type: boolean + IpamResourceDiscoveryArn: + description: Amazon Resource Name (Arn) for the Resource Discovery. + type: string + State: + description: The state of this Resource Discovery. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIPAMResourceDiscoveryRequest + type: object + required: [] + CreateIPAMResourceDiscoveryAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamArn: + description: Arn of the IPAM. + type: string + IpamRegion: + description: The home region of the IPAM. + type: string + IpamResourceDiscoveryAssociationId: + description: Id of the IPAM Resource Discovery Association. + type: string + IpamResourceDiscoveryId: + description: The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association. + type: string + IpamId: + description: The Id of the IPAM this Resource Discovery is associated to. + type: string + IpamResourceDiscoveryAssociationArn: + description: The Amazon Resource Name (ARN) of the resource discovery association is a part of. + type: string + IsDefault: + description: If the Resource Discovery Association exists due as part of CreateIpam. + type: boolean + OwnerId: + description: The AWS Account ID for the account where the shared IPAM exists. + type: string + State: + description: The operational state of the Resource Discovery Association. Related to Create/Delete activities. + type: string + ResourceDiscoveryStatus: + description: The status of the resource discovery. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIPAMResourceDiscoveryAssociationRequest + type: object + required: [] + CreateIPAMScopeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpamScopeId: + description: Id of the IPAM scope. + type: string + Arn: + description: The Amazon Resource Name (ARN) of the IPAM scope. + type: string + IpamId: + description: The Id of the IPAM this scope is a part of. + type: string + IpamArn: + description: The Amazon Resource Name (ARN) of the IPAM this scope is a part of. + type: string + IpamScopeType: + description: Determines whether this scope contains publicly routable space or space for a private network + type: string + enum: + - public + - private + IsDefault: + description: Is this one of the default scopes created with the IPAM. + type: boolean + Description: + type: string + PoolCount: + description: The number of pools that currently exist in this scope. + type: integer + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIPAMScopeRequest + type: object + required: [] + CreateIpPoolRouteTableAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssociationId: + description: The route table association ID. + type: string + PublicIpv4Pool: + description: The ID of the public IPv4 pool. + type: string + RouteTableId: + description: The ID of the route table. + type: string + x-stackQL-stringOnly: true + x-title: CreateIpPoolRouteTableAssociationRequest + type: object + required: [] + CreateKeyPairRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + KeyName: + description: |- + A unique name for the key pair. + Constraints: Up to 255 ASCII characters + type: string + KeyType: + description: |- + The type of key pair. Note that ED25519 keys are not supported for Windows instances. + If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. + Default: ``rsa`` + type: string + default: rsa + enum: + - rsa + - ed25519 + KeyFormat: + description: |- + The format of the key pair. + Default: ``pem`` + type: string + default: pem + enum: + - pem + - ppk + PublicKeyMaterial: + description: The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created. + type: string + KeyFingerprint: + description: '' + type: string + KeyPairId: + description: '' + type: string + Tags: + description: The tags to apply to the key pair. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateKeyPairRequest + type: object + required: [] + CreateLaunchTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LaunchTemplateName: + description: A name for the launch template. + type: string + LaunchTemplateData: + description: The information for the launch template. + $ref: '#/components/schemas/LaunchTemplateData' + VersionDescription: + description: A description for the first version of the launch template. + type: string + TagSpecifications: + uniqueItems: false + description: |- + The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. + To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + type: array + items: + $ref: '#/components/schemas/LaunchTemplateTagSpecification' + LatestVersionNumber: + description: '' + type: string + LaunchTemplateId: + description: '' + type: string + DefaultVersionNumber: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateLaunchTemplateRequest + type: object + required: [] + CreateLocalGatewayRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DestinationCidrBlock: + description: The CIDR block used for destination matches. + type: string + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. + type: string + LocalGatewayVirtualInterfaceGroupId: + description: The ID of the virtual interface group. + type: string + NetworkInterfaceId: + description: The ID of the network interface. + type: string + State: + description: The state of the route. + type: string + Type: + description: The route type. + type: string + x-stackQL-stringOnly: true + x-title: CreateLocalGatewayRouteRequest + type: object + required: [] + CreateLocalGatewayRouteTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. + type: string + LocalGatewayRouteTableArn: + description: The ARN of the local gateway route table. + type: string + LocalGatewayId: + description: The ID of the local gateway. + type: string + OutpostArn: + description: The ARN of the outpost. + type: string + OwnerId: + description: The owner of the local gateway route table. + type: string + State: + description: The state of the local gateway route table. + type: string + Mode: + description: The mode of the local gateway route table. + type: string + Tags: + description: The tags for the local gateway route table. + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateLocalGatewayRouteTableRequest + type: object + required: [] + CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LocalGatewayRouteTableVirtualInterfaceGroupAssociationId: + description: The ID of the local gateway route table virtual interface group association. + type: string + LocalGatewayId: + description: The ID of the local gateway. + type: string + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. + type: string + LocalGatewayRouteTableArn: + description: The ARN of the local gateway route table. + type: string + LocalGatewayVirtualInterfaceGroupId: + description: The ID of the local gateway route table virtual interface group. + type: string + OwnerId: + description: The owner of the local gateway route table virtual interface group association. + type: string + State: + description: The state of the local gateway route table virtual interface group association. + type: string + Tags: + description: The tags for the local gateway route table virtual interface group association. + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest + type: object + required: [] + CreateLocalGatewayRouteTableVPCAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LocalGatewayId: + description: The ID of the local gateway. + type: string + LocalGatewayRouteTableId: + description: The ID of the local gateway route table. + type: string + LocalGatewayRouteTableVpcAssociationId: + description: The ID of the association. + type: string + State: + description: The state of the association. + type: string + VpcId: + description: The ID of the VPC. + type: string + Tags: + description: The tags for the association. + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateLocalGatewayRouteTableVPCAssociationRequest + type: object + required: [] + CreateNatGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SecondaryAllocationIds: + uniqueItems: true + description: Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. + x-insertionOrder: true + type: array + items: + type: string + PrivateIpAddress: + description: The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. + type: string + SecondaryPrivateIpAddressCount: + description: |- + [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. + ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. + type: integer + minimum: 1 + AllocationId: + description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.' + type: string + SubnetId: + description: The ID of the subnet in which the NAT gateway is located. + type: string + ConnectivityType: + description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. + type: string + SecondaryPrivateIpAddresses: + uniqueItems: true + description: |- + Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. + ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. + x-insertionOrder: true + type: array + items: + type: string + NatGatewayId: + description: '' + type: string + Tags: + uniqueItems: false + description: The tags for the NAT gateway. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + MaxDrainDurationSeconds: + description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. + type: integer + x-stackQL-stringOnly: true + x-title: CreateNatGatewayRequest + type: object + required: [] + CreateNetworkAclRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VpcId: + description: The ID of the VPC for the network ACL. + type: string + Id: + description: '' + type: string + Tags: + uniqueItems: false + description: The tags for the network ACL. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateNetworkAclRequest + type: object + required: [] + CreateNetworkInsightsAccessScopeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NetworkInsightsAccessScopeId: + type: string + NetworkInsightsAccessScopeArn: + type: string + CreatedDate: + type: string + UpdatedDate: + type: string + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + MatchPaths: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/AccessScopePathRequest' + ExcludePaths: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/AccessScopePathRequest' + x-stackQL-stringOnly: true + x-title: CreateNetworkInsightsAccessScopeRequest + type: object + required: [] + CreateNetworkInsightsAccessScopeAnalysisRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NetworkInsightsAccessScopeAnalysisId: + type: string + NetworkInsightsAccessScopeAnalysisArn: + type: string + NetworkInsightsAccessScopeId: + type: string + Status: + type: string + enum: + - running + - failed + - succeeded + StatusMessage: + type: string + StartDate: + type: string + EndDate: + type: string + FindingsFound: + type: string + enum: + - 'true' + - 'false' + - unknown + AnalyzedEniCount: + type: integer + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateNetworkInsightsAccessScopeAnalysisRequest + type: object + required: [] + CreateNetworkInsightsAnalysisRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + type: string + enum: + - running + - failed + - succeeded + ReturnPathComponents: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PathComponent' + NetworkInsightsAnalysisId: + type: string + FilterOutArns: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/ResourceArn' + NetworkInsightsPathId: + type: string + NetworkPathFound: + type: boolean + SuggestedAccounts: + uniqueItems: true + x-insertionOrder: true + type: array + items: + type: string + FilterInArns: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/ResourceArn' + NetworkInsightsAnalysisArn: + type: string + StatusMessage: + type: string + StartDate: + type: string + AlternatePathHints: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AlternatePathHint' + Explanations: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Explanation' + ForwardPathComponents: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PathComponent' + AdditionalAccounts: + uniqueItems: true + x-insertionOrder: true + type: array + items: + type: string + Tags: + uniqueItems: true + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateNetworkInsightsAnalysisRequest + type: object + required: [] + CreateNetworkInsightsPathRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NetworkInsightsPathId: + type: string + NetworkInsightsPathArn: + type: string + CreatedDate: + type: string + SourceIp: + $ref: '#/components/schemas/IpAddress' + FilterAtSource: + $ref: '#/components/schemas/PathFilter' + FilterAtDestination: + $ref: '#/components/schemas/PathFilter' + DestinationIp: + $ref: '#/components/schemas/IpAddress' + Source: + type: string + Destination: + type: string + SourceArn: + type: string + DestinationArn: + type: string + Protocol: + $ref: '#/components/schemas/Protocol' + DestinationPort: + $ref: '#/components/schemas/Port' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateNetworkInsightsPathRequest + type: object + required: [] + CreateNetworkInterfaceAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AttachmentId: + description: '' + type: string + DeleteOnTermination: + description: Whether to delete the network interface when the instance terminates. By default, this value is set to ``true``. + type: boolean + default: true + DeviceIndex: + description: The network interface's position in the attachment order. For example, the first attached network interface has a ``DeviceIndex`` of 0. + type: string + InstanceId: + description: The ID of the instance to which you will attach the ENI. + type: string + NetworkInterfaceId: + description: The ID of the ENI that you want to attach. + type: string + EnaSrdSpecification: + $ref: '#/components/schemas/EnaSrdSpecification' + description: Configures ENA Express for the network interface that this action attaches to the instance. + x-stackQL-stringOnly: true + x-title: CreateNetworkInterfaceAttachmentRequest + type: object + required: [] + CreateNetworkPerformanceMetricSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Source: + description: The starting Region or Availability Zone for metric to subscribe to. + type: string + Destination: + description: The target Region or Availability Zone for the metric to subscribe to. + type: string + Metric: + description: The metric type to subscribe to. + type: string + Statistic: + description: The statistic to subscribe to. + type: string + x-stackQL-stringOnly: true + x-title: CreateNetworkPerformanceMetricSubscriptionRequest + type: object + required: [] + CreatePlacementGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Strategy: + description: The placement strategy. + type: string + GroupName: + description: The Group Name of Placement Group. + type: string + SpreadLevel: + description: The Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread + type: string + PartitionCount: + description: The number of partitions. Valid only when **Strategy** is set to `partition` + type: integer + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePlacementGroupRequest + type: object + required: [] + CreatePrefixListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PrefixListName: + description: Name of Prefix List. + type: string + minLength: 1 + maxLength: 255 + PrefixListId: + description: Id of Prefix List. + type: string + OwnerId: + description: Owner Id of Prefix List. + type: string + AddressFamily: + description: Ip Version of Prefix List. + type: string + enum: + - IPv4 + - IPv6 + MaxEntries: + description: Max Entries of Prefix List. + type: integer + minimum: 1 + Version: + description: Version of Prefix List. + type: integer + Tags: + description: Tags for Prefix List + type: array + items: + $ref: '#/components/schemas/Tag' + Entries: + description: Entries of Prefix List. + type: array + items: + $ref: '#/components/schemas/Entry' + Arn: + description: The Amazon Resource Name (ARN) of the Prefix List. + type: string + x-stackQL-stringOnly: true + x-title: CreatePrefixListRequest + type: object + required: [] + CreateRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CarrierGatewayId: + type: string + description: |- + The ID of the carrier gateway. + You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone. + CidrBlock: + type: string + description: '' + CoreNetworkArn: + type: string + description: The Amazon Resource Name (ARN) of the core network. + DestinationCidrBlock: + type: string + description: The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. + DestinationIpv6CidrBlock: + type: string + description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. + DestinationPrefixListId: + type: string + description: The ID of a prefix list used for the destination match. + EgressOnlyInternetGatewayId: + type: string + description: '[IPv6 traffic only] The ID of an egress-only internet gateway.' + GatewayId: + type: string + description: The ID of an internet gateway or virtual private gateway attached to your VPC. + InstanceId: + type: string + description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. + LocalGatewayId: + type: string + description: The ID of the local gateway. + NatGatewayId: + type: string + description: '[IPv4 traffic only] The ID of a NAT gateway.' + NetworkInterfaceId: + type: string + description: The ID of a network interface. + RouteTableId: + type: string + description: The ID of the route table for the route. + TransitGatewayId: + type: string + description: The ID of a transit gateway. + VpcEndpointId: + type: string + description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. + VpcPeeringConnectionId: + type: string + description: The ID of a VPC peering connection. + x-stackQL-stringOnly: true + x-title: CreateRouteRequest + type: object + required: [] + CreateRouteServerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AmazonSideAsn: + description: The Amazon-side ASN of the Route Server. + type: integer + format: int64 + minimum: 1 + maximum: 4294967294 + Arn: + description: The Amazon Resource Name (ARN) of the Route Server. + type: string + Id: + description: The ID of the Route Server. + type: string + PersistRoutes: + description: Whether to enable persistent routes + type: string + enum: + - enable + - disable + PersistRoutesDuration: + description: The duration of persistent routes in minutes + type: integer + format: int64 + minimum: 0 + maximum: 5 + SnsNotificationsEnabled: + description: Whether to enable SNS notifications + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRouteServerRequest + type: object + required: [] + CreateRouteServerAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteServerId: + description: Route Server ID + type: string + VpcId: + description: VPC ID + type: string + x-stackQL-stringOnly: true + x-title: CreateRouteServerAssociationRequest + type: object + required: [] + CreateRouteServerEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteServerId: + description: Route Server ID + type: string + Arn: + description: The Amazon Resource Name (ARN) of the Route Server Endpoint. + type: string + Id: + description: The ID of the Route Server Endpoint. + type: string + SubnetId: + description: Subnet ID + type: string + VpcId: + description: VPC ID + type: string + EniId: + description: Elastic Network Interface ID owned by the Route Server Endpoint + type: string + EniAddress: + description: Elastic Network Interface IP address owned by the Route Server Endpoint + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRouteServerEndpointRequest + type: object + required: [] + CreateRouteServerPeerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteServerId: + description: Route Server ID + type: string + RouteServerEndpointId: + description: Route Server Endpoint ID + type: string + Arn: + description: The Amazon Resource Name (ARN) of the Route Server Peer. + type: string + Id: + description: The ID of the Route Server Peer. + type: string + SubnetId: + description: Subnet ID + type: string + VpcId: + description: VPC ID + type: string + EndpointEniId: + description: Elastic Network Interface ID owned by the Route Server Endpoint + type: string + EndpointEniAddress: + description: Elastic Network Interface IP address owned by the Route Server Endpoint + type: string + PeerAddress: + description: IP address of the Route Server Peer + type: string + BgpOptions: + $ref: '#/components/schemas/BgpOptions' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRouteServerPeerRequest + type: object + required: [] + CreateRouteServerPropagationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteServerId: + description: Route Server ID + type: string + RouteTableId: + description: Route Table ID + type: string + x-stackQL-stringOnly: true + x-title: CreateRouteServerPropagationRequest + type: object + required: [] + CreateRouteTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteTableId: + description: '' + type: string + VpcId: + description: The ID of the VPC. + type: string + Tags: + uniqueItems: false + description: Any tags assigned to the route table. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRouteTableRequest + type: object + required: [] + CreateSecurityGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GroupDescription: + description: A description for the security group. + type: string + GroupName: + description: The name of the security group. + type: string + VpcId: + description: The ID of the VPC for the security group. + type: string + Id: + description: The group name or group ID depending on whether the SG is created in default or specific VPC + type: string + SecurityGroupIngress: + uniqueItems: false + description: The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ingress' + SecurityGroupEgress: + uniqueItems: false + description: '[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Egress' + Tags: + uniqueItems: false + description: Any tags assigned to the security group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + GroupId: + description: The group ID of the specified security group. + type: string + x-stackQL-stringOnly: true + x-title: CreateSecurityGroupRequest + type: object + required: [] + CreateSecurityGroupEgressRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CidrIp: + description: |- + The IPv4 address range, in CIDR format. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*. + type: string + CidrIpv6: + description: |- + The IPv6 address range, in CIDR format. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*. + type: string + Description: + description: |- + The description of an egress (outbound) security group rule. + Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* + type: string + FromPort: + description: If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). + type: integer + ToPort: + description: If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). + type: integer + IpProtocol: + description: |- + The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). + Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + type: string + DestinationSecurityGroupId: + description: |- + The ID of the security group. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + type: string + Id: + description: '' + type: string + DestinationPrefixListId: + description: |- + The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + type: string + GroupId: + description: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + type: string + x-stackQL-stringOnly: true + x-title: CreateSecurityGroupEgressRequest + type: object + required: [] + CreateSecurityGroupIngressRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The Security Group Rule Id + type: string + CidrIp: + description: The IPv4 ranges + type: string + CidrIpv6: + description: '[VPC only] The IPv6 ranges' + type: string + Description: + description: Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously + type: string + FromPort: + description: |- + The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. + + Use this for ICMP and any protocol that uses ports. + type: integer + GroupId: + description: |- + The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. + + You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. + type: string + GroupName: + description: The name of the security group. + type: string + IpProtocol: + description: |- + The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers). + + [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. + type: string + SourcePrefixListId: + description: |+ + [EC2-VPC only] The ID of a prefix list. + + type: string + SourceSecurityGroupId: + description: The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID. + type: string + SourceSecurityGroupName: + description: |- + [EC2-Classic, default VPC] The name of the source security group. + + You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. + type: string + SourceSecurityGroupOwnerId: + description: |- + [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range. + + If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. + type: string + ToPort: + description: |- + The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes. + + Use this for ICMP and any protocol that uses ports. + type: integer + x-stackQL-stringOnly: true + x-title: CreateSecurityGroupIngressRequest + type: object + required: [] + CreateSecurityGroupVpcAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GroupId: + description: The group ID of the specified security group. + type: string + VpcId: + description: The ID of the VPC in the security group vpc association. + type: string + VpcOwnerId: + description: The owner of the VPC in the security group vpc association. + type: string + State: + description: The state of the security group vpc association. + $ref: '#/components/schemas/SecurityGroupVpcAssociationState' + StateReason: + description: The reason for the state of the security group vpc association. + type: string + x-stackQL-stringOnly: true + x-title: CreateSecurityGroupVpcAssociationRequest + type: object + required: [] + CreateSnapshotBlockPublicAccessRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + State: + type: string + description: The state of EBS Snapshot Block Public Access. + enum: + - block-all-sharing + - block-new-sharing + AccountId: + type: string + description: The identifier for the specified AWS account. + x-stackQL-stringOnly: true + x-title: CreateSnapshotBlockPublicAccessRequest + type: object + required: [] + CreateSpotFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + SpotFleetRequestConfigData: + $ref: '#/components/schemas/SpotFleetRequestConfigData' + x-stackQL-stringOnly: true + x-title: CreateSpotFleetRequest + type: object + required: [] + CreateSubnetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssignIpv6AddressOnCreation: + type: boolean + description: |- + Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. + If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. + VpcId: + type: string + description: |- + The ID of the VPC the subnet is in. + If you update this property, you must also update the ``CidrBlock`` property. + MapPublicIpOnLaunch: + type: boolean + description: |- + Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. + AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/). + EnableLniAtDeviceIndex: + type: integer + description: Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1). + NetworkAclAssociationId: + type: string + description: '' + AvailabilityZone: + type: string + description: |- + The Availability Zone of the subnet. + If you update this property, you must also update the ``CidrBlock`` property. + AvailabilityZoneId: + type: string + description: The AZ ID of the subnet. + CidrBlock: + type: string + description: |- + The IPv4 CIDR block assigned to the subnet. + If you update this property, we create a new subnet, and then delete the existing one. + SubnetId: + type: string + description: '' + Ipv6CidrBlocks: + type: array + uniqueItems: false + items: + type: string + description: '' + Ipv6CidrBlock: + type: string + description: |- + The IPv6 CIDR block. + If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. + OutpostArn: + type: string + description: The Amazon Resource Name (ARN) of the Outpost. + Ipv6Native: + type: boolean + description: Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*. + EnableDns64: + type: boolean + description: |- + Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. + You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a ``0.0.0.0/0`` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *User Guide*. + PrivateDnsNameOptionsOnLaunch: + type: object + additionalProperties: false + properties: + HostnameType: + type: string + EnableResourceNameDnsARecord: + type: boolean + EnableResourceNameDnsAAAARecord: + type: boolean + description: |- + The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. + Available options: + + EnableResourceNameDnsAAAARecord (true | false) + + EnableResourceNameDnsARecord (true | false) + + HostnameType (ip-name | resource-name) + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + description: Any tags assigned to the subnet. + Ipv4IpamPoolId: + type: string + description: An IPv4 IPAM pool ID for the subnet. + Ipv4NetmaskLength: + type: integer + description: An IPv4 netmask length for the subnet. + Ipv6IpamPoolId: + type: string + description: An IPv6 IPAM pool ID for the subnet. + Ipv6NetmaskLength: + type: integer + description: An IPv6 netmask length for the subnet. + BlockPublicAccessStates: + type: object + additionalProperties: false + description: '' + properties: + InternetGatewayBlockMode: + type: string + description: 'The mode of VPC BPA. Options here are off, block-bidirectional, block-ingress ' + x-stackQL-stringOnly: true + x-title: CreateSubnetRequest + type: object + required: [] + CreateSubnetCidrBlockRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Information about the IPv6 association. + type: string + Ipv6CidrBlock: + description: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length + type: string + maxLength: 42 + Ipv6IpamPoolId: + description: The ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR + type: string + Ipv6NetmaskLength: + description: The netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool + type: integer + minimum: 0 + maximum: 128 + SubnetId: + description: The ID of the subnet + type: string + Ipv6AddressAttribute: + type: string + description: The value denoting whether an IPv6 Subnet CIDR Block is public or private. + IpSource: + type: string + description: The IP Source of an IPv6 Subnet CIDR Block. + x-stackQL-stringOnly: true + x-title: CreateSubnetCidrBlockRequest + type: object + required: [] + CreateSubnetNetworkAclAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SubnetId: + type: string + description: The ID of the subnet + NetworkAclId: + type: string + description: The ID of the network ACL + AssociationId: + type: string + x-stackQL-stringOnly: true + x-title: CreateSubnetNetworkAclAssociationRequest + type: object + required: [] + CreateSubnetRouteTableAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RouteTableId: + description: |- + The ID of the route table. + The physical ID changes when the route table ID is changed. + type: string + Id: + description: '' + type: string + SubnetId: + description: The ID of the subnet. + type: string + x-stackQL-stringOnly: true + x-title: CreateSubnetRouteTableAssociationRequest + type: object + required: [] + CreateTrafficMirrorFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The ID of a traffic mirror filter. + type: string + NetworkServices: + description: The network service that is associated with the traffic mirror filter. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TrafficMirrorNetworkService' + Description: + description: The description of a traffic mirror filter. + type: string + Tags: + description: The tags for a traffic mirror filter. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTrafficMirrorFilterRequest + type: object + required: [] + CreateTrafficMirrorFilterRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DestinationPortRange: + description: The destination port range. + $ref: '#/components/schemas/TrafficMirrorPortRange' + Description: + description: The description of the Traffic Mirror Filter rule. + type: string + SourcePortRange: + description: The source port range. + $ref: '#/components/schemas/TrafficMirrorPortRange' + RuleAction: + description: The action to take on the filtered traffic (accept/reject). + $ref: '#/components/schemas/TrafficMirrorRuleAction' + SourceCidrBlock: + description: The source CIDR block to assign to the Traffic Mirror Filter rule. + type: string + RuleNumber: + description: The number of the Traffic Mirror rule. + type: integer + DestinationCidrBlock: + description: The destination CIDR block to assign to the Traffic Mirror rule. + type: string + TrafficMirrorFilterRuleId: + description: The ID of the Traffic Mirror Filter rule. + type: string + TrafficMirrorFilterId: + description: The ID of the filter that this rule is associated with. + type: string + TrafficDirection: + description: The direction of traffic (ingress/egress). + $ref: '#/components/schemas/TrafficDirection' + Protocol: + description: The number of protocol, for example 17 (UDP), to assign to the Traffic Mirror rule. + type: integer + Tags: + description: Any tags assigned to the Traffic Mirror Filter rule. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTrafficMirrorFilterRuleRequest + type: object + required: [] + CreateTrafficMirrorSessionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The ID of a Traffic Mirror session. + type: string + NetworkInterfaceId: + description: The ID of the source network interface. + type: string + TrafficMirrorTargetId: + description: The ID of a Traffic Mirror target. + type: string + TrafficMirrorFilterId: + description: The ID of a Traffic Mirror filter. + type: string + PacketLength: + description: The number of bytes in each packet to mirror. + type: integer + SessionNumber: + description: The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. + type: integer + VirtualNetworkId: + description: The VXLAN ID for the Traffic Mirror session. + type: integer + Description: + description: The description of the Traffic Mirror session. + type: string + OwnerId: + description: The ID of the account that owns the Traffic Mirror session. + type: string + Tags: + description: The tags assigned to the Traffic Mirror session. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTrafficMirrorSessionRequest + type: object + required: [] + CreateTrafficMirrorTargetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NetworkLoadBalancerArn: + description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. + type: string + Description: + description: The description of the Traffic Mirror target. + type: string + Id: + type: string + NetworkInterfaceId: + description: The network interface ID that is associated with the target. + type: string + GatewayLoadBalancerEndpointId: + description: The ID of the Gateway Load Balancer endpoint. + type: string + Tags: + description: ' The tags to assign to the Traffic Mirror target.' + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTrafficMirrorTargetRequest + type: object + required: [] + CreateTransitGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DefaultRouteTablePropagation: + type: string + TransitGatewayArn: + type: string + Description: + type: string + AutoAcceptSharedAttachments: + type: string + DefaultRouteTableAssociation: + type: string + Id: + type: string + VpnEcmpSupport: + type: string + DnsSupport: + type: string + SecurityGroupReferencingSupport: + type: string + MulticastSupport: + type: string + AmazonSideAsn: + type: integer + format: int64 + TransitGatewayCidrBlocks: + type: array + items: + type: string + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + AssociationDefaultRouteTableId: + type: string + PropagationDefaultRouteTableId: + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRequest + type: object + required: [] + CreateTransitGatewayAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Options: + description: The options for the transit gateway vpc attachment. + additionalProperties: false + type: object + properties: + Ipv6Support: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + ApplianceModeSupport: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + SecurityGroupReferencingSupport: + description: 'Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid Values: enable | disable' + type: string + DnsSupport: + description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable' + type: string + TransitGatewayId: + type: string + VpcId: + type: string + Id: + type: string + SubnetIds: + uniqueItems: false + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + type: string + Tags: + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayAttachmentRequest + type: object + required: [] + CreateTransitGatewayConnectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayAttachmentId: + description: The ID of the Connect attachment. + type: string + TransportTransitGatewayAttachmentId: + description: The ID of the attachment from which the Connect attachment was created. + type: string + TransitGatewayId: + description: The ID of the transit gateway. + type: string + State: + description: The state of the attachment. + type: string + CreationTime: + description: The creation time. + type: string + Tags: + description: The tags for the attachment. + type: array + items: + $ref: '#/components/schemas/Tag' + Options: + $ref: '#/components/schemas/TransitGatewayConnectOptions' + description: The Connect attachment options. + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayConnectRequest + type: object + required: [] + CreateTransitGatewayConnectPeerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayAttachmentId: + description: The ID of the Connect attachment. + type: string + TransitGatewayConnectPeerId: + description: The ID of the Connect peer. + type: string + State: + description: The state of the Connect peer. + type: string + CreationTime: + description: The creation time. + type: string + ConnectPeerConfiguration: + description: The Connect peer details. + $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration' + Tags: + description: The tags for the Connect Peer. + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayConnectPeerRequest + type: object + required: [] + CreateTransitGatewayMulticastDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. + type: string + TransitGatewayMulticastDomainArn: + description: The Amazon Resource Name (ARN) of the transit gateway multicast domain. + type: string + TransitGatewayId: + description: The ID of the transit gateway. + type: string + State: + description: The state of the transit gateway multicast domain. + type: string + CreationTime: + description: The time the transit gateway multicast domain was created. + type: string + format: date-time + Tags: + description: The tags for the transit gateway multicast domain. + type: array + items: + $ref: '#/components/schemas/Tag' + Options: + description: The options for the transit gateway multicast domain. + type: object + properties: + AutoAcceptSharedAssociations: + description: 'Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable' + type: string + Igmpv2Support: + description: 'Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable' + type: string + StaticSourcesSupport: + description: 'Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable' + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayMulticastDomainRequest + type: object + required: [] + CreateTransitGatewayMulticastDomainAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. + type: string + TransitGatewayAttachmentId: + description: The ID of the transit gateway attachment. + type: string + ResourceId: + description: The ID of the resource. + type: string + ResourceType: + description: The type of resource, for example a VPC attachment. + type: string + State: + description: The state of the subnet association. + type: string + SubnetId: + description: The IDs of the subnets to associate with the transit gateway multicast domain. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayMulticastDomainAssociationRequest + type: object + required: [] + CreateTransitGatewayMulticastGroupMemberRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GroupIpAddress: + description: The IP address assigned to the transit gateway multicast group. + type: string + TransitGatewayAttachmentId: + description: The ID of the transit gateway attachment. + type: string + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. + type: string + SubnetId: + description: The ID of the subnet. + type: string + ResourceId: + description: The ID of the resource. + type: string + ResourceType: + description: The type of resource, for example a VPC attachment. + type: string + NetworkInterfaceId: + description: The ID of the transit gateway attachment. + type: string + GroupMember: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + GroupSource: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + MemberType: + description: The member type (for example, static). + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayMulticastGroupMemberRequest + type: object + required: [] + CreateTransitGatewayMulticastGroupSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GroupIpAddress: + description: The IP address assigned to the transit gateway multicast group. + type: string + TransitGatewayAttachmentId: + description: The ID of the transit gateway attachment. + type: string + TransitGatewayMulticastDomainId: + description: The ID of the transit gateway multicast domain. + type: string + SubnetId: + description: The ID of the subnet. + type: string + ResourceId: + description: The ID of the resource. + type: string + ResourceType: + description: The type of resource, for example a VPC attachment. + type: string + NetworkInterfaceId: + description: The ID of the transit gateway attachment. + type: string + GroupMember: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + GroupSource: + description: Indicates that the resource is a transit gateway multicast group member. + type: boolean + SourceType: + description: The source type. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayMulticastGroupSourceRequest + type: object + required: [] + CreateTransitGatewayPeeringAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: The status of the transit gateway peering attachment. + $ref: '#/components/schemas/PeeringAttachmentStatus' + TransitGatewayId: + description: The ID of the transit gateway. + type: string + PeerTransitGatewayId: + description: The ID of the peer transit gateway. + type: string + PeerAccountId: + description: The ID of the peer account + type: string + State: + description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. + type: string + CreationTime: + format: date-time + description: The time the transit gateway peering attachment was created. + type: string + PeerRegion: + description: Peer Region + type: string + Tags: + description: The tags for the transit gateway peering attachment. + type: array + items: + $ref: '#/components/schemas/Tag' + TransitGatewayAttachmentId: + description: The ID of the transit gateway peering attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayPeeringAttachmentRequest + type: object + required: [] + CreateTransitGatewayRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + DestinationCidrBlock: + description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. + type: string + Blackhole: + description: Indicates whether to drop traffic that matches this route. + type: boolean + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteRequest + type: object + required: [] + CreateTransitGatewayRouteTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayRouteTableId: + description: Transit Gateway Route Table primary identifier + type: string + TransitGatewayId: + description: The ID of the transit gateway. + type: string + Tags: + uniqueItems: false + description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteTableRequest + type: object + required: [] + CreateTransitGatewayRouteTableAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteTableAssociationRequest + type: object + required: [] + CreateTransitGatewayRouteTablePropagationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteTablePropagationRequest + type: object + required: [] + CreateTransitGatewayVpcAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + TransitGatewayId: + type: string + VpcId: + type: string + SubnetIds: + type: array + x-insertionOrder: false + uniqueItems: false + items: + type: string + AddSubnetIds: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + RemoveSubnetIds: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Options: + description: The options for the transit gateway vpc attachment. + type: object + properties: + DnsSupport: + description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable' + type: string + Ipv6Support: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + ApplianceModeSupport: + description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable' + type: string + SecurityGroupReferencingSupport: + description: 'Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid values: enable | disable' + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayVpcAttachmentRequest + type: object + required: [] + CreateVerifiedAccessEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VerifiedAccessEndpointId: + description: The ID of the AWS Verified Access endpoint. + type: string + VerifiedAccessGroupId: + description: The ID of the AWS Verified Access group. + type: string + VerifiedAccessInstanceId: + description: The ID of the AWS Verified Access instance. + type: string + Status: + description: The endpoint status. + type: string + SecurityGroupIds: + description: The IDs of the security groups for the endpoint. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' + NetworkInterfaceOptions: + description: The options for network-interface type endpoint. + $ref: '#/components/schemas/NetworkInterfaceOptions' + LoadBalancerOptions: + description: The load balancer details if creating the AWS Verified Access endpoint as load-balancer type. + $ref: '#/components/schemas/LoadBalancerOptions' + RdsOptions: + description: The options for rds type endpoint. + $ref: '#/components/schemas/RdsOptions' + CidrOptions: + description: The options for cidr type endpoint. + $ref: '#/components/schemas/CidrOptions' + EndpointType: + description: The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. + type: string + EndpointDomain: + description: A DNS name that is generated for the endpoint. + type: string + EndpointDomainPrefix: + description: A custom identifier that gets prepended to a DNS name that is generated for the endpoint. + type: string + DeviceValidationDomain: + description: Returned if endpoint has a device trust provider attached. + type: string + DomainCertificateArn: + description: The ARN of a public TLS/SSL certificate imported into or created with ACM. + type: string + AttachmentType: + description: The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. + type: string + ApplicationDomain: + description: The DNS name for users to reach your application. + type: string + CreationTime: + description: The creation time. + type: string + LastUpdatedTime: + description: The last updated time. + type: string + Description: + description: A description for the AWS Verified Access endpoint. + type: string + PolicyDocument: + description: The AWS Verified Access policy document. + type: string + PolicyEnabled: + description: The status of the Verified Access policy. + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SseSpecification: + description: The configuration options for customer provided KMS encryption. + $ref: '#/components/schemas/SseSpecification' + x-stackQL-stringOnly: true + x-title: CreateVerifiedAccessEndpointRequest + type: object + required: [] + CreateVerifiedAccessGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VerifiedAccessGroupId: + description: The ID of the AWS Verified Access group. + type: string + VerifiedAccessInstanceId: + description: The ID of the AWS Verified Access instance. + type: string + VerifiedAccessGroupArn: + description: The ARN of the Verified Access group. + type: string + Owner: + description: The AWS account number that owns the group. + type: string + CreationTime: + description: Time this Verified Access Group was created. + type: string + LastUpdatedTime: + description: Time this Verified Access Group was last updated. + type: string + Description: + description: A description for the AWS Verified Access group. + type: string + PolicyDocument: + description: The AWS Verified Access policy document. + type: string + PolicyEnabled: + description: The status of the Verified Access policy. + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SseSpecification: + description: The configuration options for customer provided KMS encryption. + $ref: '#/components/schemas/SseSpecification' + x-stackQL-stringOnly: true + x-title: CreateVerifiedAccessGroupRequest + type: object + required: [] + CreateVerifiedAccessTrustProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TrustProviderType: + description: 'Type of trust provider. Possible values: user|device' + type: string + DeviceTrustProviderType: + description: 'The type of device-based trust provider. Possible values: jamf|crowdstrike' + type: string + UserTrustProviderType: + description: 'The type of device-based trust provider. Possible values: oidc|iam-identity-center' + type: string + OidcOptions: + $ref: '#/components/schemas/OidcOptions' + DeviceOptions: + $ref: '#/components/schemas/DeviceOptions' + PolicyReferenceName: + description: The identifier to be used when working with policy rules. + type: string + CreationTime: + description: The creation time. + type: string + LastUpdatedTime: + description: The last updated time. + type: string + VerifiedAccessTrustProviderId: + description: The ID of the Amazon Web Services Verified Access trust provider. + type: string + Description: + description: A description for the Amazon Web Services Verified Access trust provider. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SseSpecification: + description: The configuration options for customer provided KMS encryption. + type: object + properties: + KmsKeyArn: + description: KMS Key Arn used to encrypt the group policy + type: string + CustomerManagedKeyEnabled: + description: Whether to encrypt the policy with the provided key or disable encryption + type: boolean + additionalProperties: false + NativeApplicationOidcOptions: + $ref: '#/components/schemas/NativeApplicationOidcOptions' + x-stackQL-stringOnly: true + x-title: CreateVerifiedAccessTrustProviderRequest + type: object + required: [] + CreateVerifiedAccessInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VerifiedAccessInstanceId: + description: The ID of the AWS Verified Access instance. + type: string + VerifiedAccessTrustProviders: + description: AWS Verified Access trust providers. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/VerifiedAccessTrustProvider' + VerifiedAccessTrustProviderIds: + description: The IDs of the AWS Verified Access trust providers. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/VerifiedAccessTrustProviderId' + CreationTime: + description: Time this Verified Access Instance was created. + type: string + LastUpdatedTime: + description: Time this Verified Access Instance was last updated. + type: string + Description: + description: A description for the AWS Verified Access instance. + type: string + LoggingConfigurations: + description: The configuration options for AWS Verified Access instances. + $ref: '#/components/schemas/VerifiedAccessLogs' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + FipsEnabled: + description: Indicates whether FIPS is enabled + type: boolean + CidrEndpointsCustomSubDomain: + description: Introduce CidrEndpointsCustomSubDomain property to represent the domain (say, ava.my-company.com) + type: string + CidrEndpointsCustomSubDomainNameServers: + description: Property to represent the name servers assoicated with the domain that AVA manages (say, ['ns1.amazonaws.com', 'ns2.amazonaws.com', 'ns3.amazonaws.com', 'ns4.amazonaws.com']). + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Nameserver' + x-stackQL-stringOnly: true + x-title: CreateVerifiedAccessInstanceRequest + type: object + required: [] + CreateVolumeAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VolumeId: + $ref: '#/components/schemas/VolumeId' + description: The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume. + InstanceId: + $ref: '#/components/schemas/InstanceId' + description: The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance. + Device: + $ref: '#/components/schemas/Device' + description: The device name (for example, ``/dev/sdh`` or ``xvdh``). + x-stackQL-stringOnly: true + x-title: CreateVolumeAttachmentRequest + type: object + required: [] + CreateVPCRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VpcId: + description: '' + type: string + InstanceTenancy: + description: |- + The allowed tenancy of instances launched into the VPC. + + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. + + Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement. + type: string + Ipv4NetmaskLength: + description: The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. + type: integer + CidrBlockAssociations: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + CidrBlock: + description: |- + The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. + You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. + type: string + Ipv4IpamPoolId: + description: |- + The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. + You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. + type: string + DefaultNetworkAcl: + description: '' + x-insertionOrder: false + type: string + EnableDnsSupport: + description: >- + Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your + VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). + type: boolean + Ipv6CidrBlocks: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + DefaultSecurityGroup: + description: '' + x-insertionOrder: false + type: string + EnableDnsHostnames: + description: |- + Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). + You can only enable DNS hostnames if you've enabled DNS support. + type: boolean + Tags: + uniqueItems: false + description: The tags for the VPC. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVPCRequest + type: object + required: [] + CreateVPCBlockPublicAccessExclusionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ExclusionId: + type: string + description: The ID of the exclusion + InternetGatewayExclusionMode: + description: The desired Block Public Access Exclusion Mode for a specific VPC/Subnet. + type: string + enum: + - allow-bidirectional + - allow-egress + VpcId: + type: string + description: The ID of the vpc. Required only if you don't specify SubnetId. + SubnetId: + type: string + description: The ID of the subnet. Required only if you don't specify VpcId + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVPCBlockPublicAccessExclusionRequest + type: object + required: [] + CreateVPCBlockPublicAccessOptionsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InternetGatewayBlockMode: + description: The desired Block Public Access mode for Internet Gateways in your account. We do not allow to create in a off mode as this is the default value + type: string + enum: + - block-bidirectional + - block-ingress + AccountId: + type: string + description: The identifier for the specified AWS account. + ExclusionsAllowed: + type: string + description: Determines if exclusions are allowed. If you have enabled VPC BPA at the Organization level, exclusions may be not-allowed. Otherwise, they are allowed. + x-stackQL-stringOnly: true + x-title: CreateVPCBlockPublicAccessOptionsRequest + type: object + required: [] + CreateVPCCidrBlockRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CidrBlock: + type: string + description: An IPv4 CIDR block to associate with the VPC. + Ipv6Pool: + type: string + description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. + Id: + type: string + description: The Id of the VPC associated CIDR Block. + VpcId: + type: string + description: The ID of the VPC. + Ipv6CidrBlock: + type: string + description: An IPv6 CIDR block from the IPv6 address pool. + Ipv4IpamPoolId: + type: string + description: The ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC. + Ipv4NetmaskLength: + type: integer + description: The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. + Ipv6IpamPoolId: + type: string + description: The ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC. + Ipv6NetmaskLength: + type: integer + description: The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. + AmazonProvidedIpv6CidrBlock: + type: boolean + description: Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. + Ipv6AddressAttribute: + type: string + description: The value denoting whether an IPv6 VPC CIDR Block is public or private. + IpSource: + type: string + description: The IP Source of an IPv6 VPC CIDR Block. + Ipv6CidrBlockNetworkBorderGroup: + type: string + description: The name of the location from which we advertise the IPV6 CIDR block. + x-stackQL-stringOnly: true + x-title: CreateVPCCidrBlockRequest + type: object + required: [] + CreateVPCDHCPOptionsAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DhcpOptionsId: + type: string + description: The ID of the DHCP options set, or default to associate no DHCP options with the VPC. + VpcId: + type: string + description: The ID of the VPC. + x-stackQL-stringOnly: true + x-title: CreateVPCDHCPOptionsAssociationRequest + type: object + required: [] + CreateVPCEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PrivateDnsEnabled: + description: >- + Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC + endpoint service. + To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. + This property is supported only for interface endpoints. + Default: ``false`` + type: boolean + IpAddressType: + description: The supported IP address types. + type: string + enum: + - ipv4 + - ipv6 + - dualstack + - not-specified + ServiceRegion: + description: Describes a Region. + type: string + CreationTimestamp: + description: '' + type: string + DnsOptions: + description: Describes the DNS options for an endpoint. + $ref: '#/components/schemas/DnsOptionsSpecification' + NetworkInterfaceIds: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + DnsEntries: + uniqueItems: false + description: '' + x-insertionOrder: false + type: array + items: + type: string + ResourceConfigurationArn: + description: The Amazon Resource Name (ARN) of the resource configuration. + type: string + SecurityGroupIds: + uniqueItems: true + description: The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints. + x-insertionOrder: false + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/DefaultSecurityGroup + type: string + SubnetIds: + uniqueItems: true + description: The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + type: string + ServiceNetworkArn: + description: The Amazon Resource Name (ARN) of the service network. + type: string + VpcId: + description: The ID of the VPC. + type: string + RouteTableIds: + uniqueItems: true + description: The IDs of the route tables. Routing is supported only for gateway endpoints. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::RouteTable + propertyPath: /properties/RouteTableId + type: string + ServiceName: + description: The name of the endpoint service. + type: string + PolicyDocument: + description: |- + An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. + For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and CFNlong converts the policy to JSON format before calling the API actions for privatelink. Alternatively, you can include the JSON directly in the YAML, as shown in the following ``Properties`` section: + ``Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'`` + type: object + VpcEndpointType: + description: |- + The type of endpoint. + Default: Gateway + type: string + enum: + - Interface + - Gateway + - GatewayLoadBalancer + - ServiceNetwork + - Resource + Id: + description: '' + type: string + Tags: + uniqueItems: false + description: The tags to associate with the endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVPCEndpointRequest + type: object + required: [] + CreateVPCEndpointConnectionNotificationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectionEvents: + uniqueItems: false + description: The endpoint events for which to receive notifications. + x-insertionOrder: false + type: array + items: + type: string + VPCEndpointId: + description: The ID of the endpoint. + type: string + VPCEndpointConnectionNotificationId: + description: VPC Endpoint Connection ID generated by service + type: string + ConnectionNotificationArn: + description: The ARN of the SNS topic for the notifications. + type: string + ServiceId: + description: The ID of the endpoint service. + type: string + x-stackQL-stringOnly: true + x-title: CreateVPCEndpointConnectionNotificationRequest + type: object + required: [] + CreateVPCEndpointServiceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NetworkLoadBalancerArns: + type: array + uniqueItems: false + items: + type: string + relationshipRef: + typeName: AWS::ElasticLoadBalancingV2::LoadBalancer + propertyPath: /properties/LoadBalancerArn + ContributorInsightsEnabled: + type: boolean + PayerResponsibility: + type: string + ServiceId: + type: string + AcceptanceRequired: + type: boolean + GatewayLoadBalancerArns: + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + description: The tags to add to the VPC endpoint service. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SupportedIpAddressTypes: + type: array + description: Specify which Ip Address types are supported for VPC endpoint service. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpAddressType' + SupportedRegions: + type: array + description: The Regions from which service consumers can access the service. + uniqueItems: true + x-insertionOrder: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateVPCEndpointServiceRequest + type: object + required: [] + CreateVPCEndpointServicePermissionsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllowedPrincipals: + uniqueItems: false + type: array + items: + type: string + ServiceId: + type: string + x-stackQL-stringOnly: true + x-title: CreateVPCEndpointServicePermissionsRequest + type: object + required: [] + CreateVPCGatewayAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AttachmentType: + type: string + description: 'Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment ' + InternetGatewayId: + type: string + description: The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. + VpcId: + type: string + description: The ID of the VPC. + VpnGatewayId: + type: string + description: The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. + x-stackQL-stringOnly: true + x-title: CreateVPCGatewayAttachmentRequest + type: object + required: [] + CreateVPCPeeringConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PeerRoleArn: + description: The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. + type: string + VpcId: + description: The ID of the VPC. + type: string + PeerVpcId: + description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + type: string + Id: + type: string + PeerRegion: + description: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. + type: string + PeerOwnerId: + description: The AWS account ID of the owner of the accepter VPC. + type: string + Tags: + uniqueItems: false + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVPCPeeringConnectionRequest + type: object + required: [] + CreateVPNConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RemoteIpv6NetworkCidr: + description: |- + The IPv6 CIDR on the AWS side of the VPN connection. + Default: ``::/0`` + type: string + RemoteIpv4NetworkCidr: + description: |- + The IPv4 CIDR on the AWS side of the VPN connection. + Default: ``0.0.0.0/0`` + type: string + VpnTunnelOptionsSpecifications: + uniqueItems: false + description: The tunnel options for the VPN connection. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/VpnTunnelOptionsSpecification' + CustomerGatewayId: + description: The ID of the customer gateway at your end of the VPN connection. + type: string + OutsideIpAddressType: + description: |- + The type of IP address assigned to the outside interface of the customer gateway device. + Valid values: ``PrivateIpv4`` | ``PublicIpv4`` | ``Ipv6`` + Default: ``PublicIpv4`` + type: string + StaticRoutesOnly: + description: |- + Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. + If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify ``true``. + type: boolean + EnableAcceleration: + description: |- + Indicate whether to enable acceleration for the VPN connection. + Default: ``false`` + type: boolean + TransitGatewayId: + description: |- + The ID of the transit gateway associated with the VPN connection. + You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both. + type: string + Type: + description: The type of VPN connection. + type: string + LocalIpv4NetworkCidr: + description: |- + The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. + Default: ``0.0.0.0/0`` + type: string + VpnGatewayId: + description: |- + The ID of the virtual private gateway at the AWS side of the VPN connection. + You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both. + type: string + PreSharedKeyStorage: + description: Describes the storage location for an instance store-backed AMI. + type: string + enum: + - Standard + - SecretsManager + TransportTransitGatewayAttachmentId: + description: |- + The transit gateway attachment ID to use for the VPN tunnel. + Required if ``OutsideIpAddressType`` is set to ``PrivateIpv4``. + type: string + LocalIpv6NetworkCidr: + description: |- + The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. + Default: ``::/0`` + type: string + VpnConnectionId: + description: '' + type: string + TunnelInsideIpVersion: + description: |- + Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. + Default: ``ipv4`` + type: string + Tags: + uniqueItems: false + description: Any tags assigned to the VPN connection. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVPNConnectionRequest + type: object + required: [] + CreateVPNConnectionRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DestinationCidrBlock: + description: The CIDR block associated with the local subnet of the customer network. + type: string + VpnConnectionId: + description: The ID of the VPN connection. + type: string + x-stackQL-stringOnly: true + x-title: CreateVPNConnectionRouteRequest + type: object + required: [] + CreateVPNGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VPNGatewayId: + description: '' + type: string + AmazonSideAsn: + description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session. + type: integer + format: int64 + Tags: + description: Any tags assigned to the virtual private gateway. + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Type: + description: The type of VPN connection the virtual private gateway supports. + type: string + x-stackQL-stringOnly: true + x-title: CreateVPNGatewayRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + capacity_reservations: + name: capacity_reservations + id: awscc.ec2.capacity_reservations + x-cfn-schema-name: CapacityReservation + x-cfn-type-name: AWS::EC2::CapacityReservation + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CapacityReservation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CapacityReservation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CapacityReservation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CapacityReservation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Tenancy') as tenancy, + JSON_EXTRACT(Properties, '$.EndDateType') as end_date_type, + JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.TotalInstanceCount') as total_instance_count, + JSON_EXTRACT(Properties, '$.EndDate') as end_date, + JSON_EXTRACT(Properties, '$.EbsOptimized') as ebs_optimized, + JSON_EXTRACT(Properties, '$.OutPostArn') as out_post_arn, + JSON_EXTRACT(Properties, '$.InstanceCount') as instance_count, + JSON_EXTRACT(Properties, '$.PlacementGroupArn') as placement_group_arn, + JSON_EXTRACT(Properties, '$.AvailableInstanceCount') as available_instance_count, + JSON_EXTRACT(Properties, '$.InstancePlatform') as instance_platform, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, + JSON_EXTRACT(Properties, '$.EphemeralStorage') as ephemeral_storage, + JSON_EXTRACT(Properties, '$.InstanceMatchCriteria') as instance_match_criteria, + JSON_EXTRACT(Properties, '$.UnusedReservationBillingOwnerId') as unused_reservation_billing_owner_id, + JSON_EXTRACT(Properties, '$.AvailabilityZoneId') as availability_zone_id, + JSON_EXTRACT(Properties, '$.StartDate') as start_date, + JSON_EXTRACT(Properties, '$.CapacityReservationArn') as capacity_reservation_arn, + JSON_EXTRACT(Properties, '$.CreateDate') as create_date, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.DeliveryPreference') as delivery_preference, + JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id, + JSON_EXTRACT(Properties, '$.ReservationType') as reservation_type, + JSON_EXTRACT(Properties, '$.CapacityAllocationSet') as capacity_allocation_set, + JSON_EXTRACT(Properties, '$.CommitmentInfo') as commitment_info + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tenancy') as tenancy, + json_extract_path_text(Properties, 'EndDateType') as end_date_type, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'TotalInstanceCount') as total_instance_count, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, + json_extract_path_text(Properties, 'OutPostArn') as out_post_arn, + json_extract_path_text(Properties, 'InstanceCount') as instance_count, + json_extract_path_text(Properties, 'PlacementGroupArn') as placement_group_arn, + json_extract_path_text(Properties, 'AvailableInstanceCount') as available_instance_count, + json_extract_path_text(Properties, 'InstancePlatform') as instance_platform, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, + json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria, + json_extract_path_text(Properties, 'UnusedReservationBillingOwnerId') as unused_reservation_billing_owner_id, + json_extract_path_text(Properties, 'AvailabilityZoneId') as availability_zone_id, + json_extract_path_text(Properties, 'StartDate') as start_date, + json_extract_path_text(Properties, 'CapacityReservationArn') as capacity_reservation_arn, + json_extract_path_text(Properties, 'CreateDate') as create_date, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'DeliveryPreference') as delivery_preference, + json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id, + json_extract_path_text(Properties, 'ReservationType') as reservation_type, + json_extract_path_text(Properties, 'CapacityAllocationSet') as capacity_allocation_set, + json_extract_path_text(Properties, 'CommitmentInfo') as commitment_info + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + AND data__Identifier = '' + AND region = 'us-east-1' + capacity_reservations_list_only: + name: capacity_reservations_list_only + id: awscc.ec2.capacity_reservations_list_only + x-cfn-schema-name: CapacityReservation + x-cfn-type-name: AWS::EC2::CapacityReservation + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + AND region = 'us-east-1' + capacity_reservation_fleets: + name: capacity_reservation_fleets + id: awscc.ec2.capacity_reservation_fleets + x-cfn-schema-name: CapacityReservationFleet + x-cfn-type-name: AWS::EC2::CapacityReservationFleet + x-identifiers: + - CapacityReservationFleetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CapacityReservationFleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CapacityReservationFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CapacityReservationFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CapacityReservationFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AllocationStrategy') as allocation_strategy, + JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, + JSON_EXTRACT(Properties, '$.InstanceTypeSpecifications') as instance_type_specifications, + JSON_EXTRACT(Properties, '$.TotalTargetCapacity') as total_target_capacity, + JSON_EXTRACT(Properties, '$.EndDate') as end_date, + JSON_EXTRACT(Properties, '$.InstanceMatchCriteria') as instance_match_criteria, + JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id, + JSON_EXTRACT(Properties, '$.Tenancy') as tenancy, + JSON_EXTRACT(Properties, '$.RemoveEndDate') as remove_end_date, + JSON_EXTRACT(Properties, '$.NoRemoveEndDate') as no_remove_end_date + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllocationStrategy') as allocation_strategy, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'InstanceTypeSpecifications') as instance_type_specifications, + json_extract_path_text(Properties, 'TotalTargetCapacity') as total_target_capacity, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria, + json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id, + json_extract_path_text(Properties, 'Tenancy') as tenancy, + json_extract_path_text(Properties, 'RemoveEndDate') as remove_end_date, + json_extract_path_text(Properties, 'NoRemoveEndDate') as no_remove_end_date + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + AND data__Identifier = '' + AND region = 'us-east-1' + capacity_reservation_fleets_list_only: + name: capacity_reservation_fleets_list_only + id: awscc.ec2.capacity_reservation_fleets_list_only + x-cfn-schema-name: CapacityReservationFleet + x-cfn-type-name: AWS::EC2::CapacityReservationFleet + x-identifiers: + - CapacityReservationFleetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + AND region = 'us-east-1' + carrier_gateways: + name: carrier_gateways + id: awscc.ec2.carrier_gateways + x-cfn-schema-name: CarrierGateway + x-cfn-type-name: AWS::EC2::CarrierGateway + x-identifiers: + - CarrierGatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CarrierGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CarrierGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CarrierGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CarrierGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + carrier_gateways_list_only: + name: carrier_gateways_list_only + id: awscc.ec2.carrier_gateways_list_only + x-cfn-schema-name: CarrierGateway + x-cfn-type-name: AWS::EC2::CarrierGateway + x-identifiers: + - CarrierGatewayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + AND region = 'us-east-1' + customer_gateways: + name: customer_gateways + id: awscc.ec2.customer_gateways + x-cfn-schema-name: CustomerGateway + x-cfn-type-name: AWS::EC2::CustomerGateway + x-identifiers: + - CustomerGatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomerGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CustomerGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CustomerGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::CustomerGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id, + JSON_EXTRACT(Properties, '$.IpAddress') as ip_address, + JSON_EXTRACT(Properties, '$.BgpAsnExtended') as bgp_asn_extended, + JSON_EXTRACT(Properties, '$.BgpAsn') as bgp_asn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.DeviceName') as device_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, + json_extract_path_text(Properties, 'IpAddress') as ip_address, + json_extract_path_text(Properties, 'BgpAsnExtended') as bgp_asn_extended, + json_extract_path_text(Properties, 'BgpAsn') as bgp_asn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'DeviceName') as device_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + customer_gateways_list_only: + name: customer_gateways_list_only + id: awscc.ec2.customer_gateways_list_only + x-cfn-schema-name: CustomerGateway + x-cfn-type-name: AWS::EC2::CustomerGateway + x-identifiers: + - CustomerGatewayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + AND region = 'us-east-1' + dhcp_options: + name: dhcp_options + id: awscc.ec2.dhcp_options + x-cfn-schema-name: DHCPOptions + x-cfn-type-name: AWS::EC2::DHCPOptions + x-identifiers: + - DhcpOptionsId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DHCPOptions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::DHCPOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::DHCPOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::DHCPOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.DomainNameServers') as domain_name_servers, + JSON_EXTRACT(Properties, '$.NetbiosNameServers') as netbios_name_servers, + JSON_EXTRACT(Properties, '$.NetbiosNodeType') as netbios_node_type, + JSON_EXTRACT(Properties, '$.NtpServers') as ntp_servers, + JSON_EXTRACT(Properties, '$.Ipv6AddressPreferredLeaseTime') as ipv6_address_preferred_lease_time, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::DHCPOptions' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainNameServers') as domain_name_servers, + json_extract_path_text(Properties, 'NetbiosNameServers') as netbios_name_servers, + json_extract_path_text(Properties, 'NetbiosNodeType') as netbios_node_type, + json_extract_path_text(Properties, 'NtpServers') as ntp_servers, + json_extract_path_text(Properties, 'Ipv6AddressPreferredLeaseTime') as ipv6_address_preferred_lease_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::DHCPOptions' + AND data__Identifier = '' + AND region = 'us-east-1' + dhcp_options_list_only: + name: dhcp_options_list_only + id: awscc.ec2.dhcp_options_list_only + x-cfn-schema-name: DHCPOptions + x-cfn-type-name: AWS::EC2::DHCPOptions + x-identifiers: + - DhcpOptionsId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::DHCPOptions' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::DHCPOptions' + AND region = 'us-east-1' + ec2fleets: + name: ec2fleets + id: awscc.ec2.ec2fleets + x-cfn-schema-name: EC2Fleet + x-cfn-type-name: AWS::EC2::EC2Fleet + x-identifiers: + - FleetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EC2Fleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EC2Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EC2Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EC2Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TargetCapacitySpecification') as target_capacity_specification, + JSON_EXTRACT(Properties, '$.OnDemandOptions') as on_demand_options, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.ExcessCapacityTerminationPolicy') as excess_capacity_termination_policy, + JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, + JSON_EXTRACT(Properties, '$.SpotOptions') as spot_options, + JSON_EXTRACT(Properties, '$.ValidFrom') as valid_from, + JSON_EXTRACT(Properties, '$.ReplaceUnhealthyInstances') as replace_unhealthy_instances, + JSON_EXTRACT(Properties, '$.LaunchTemplateConfigs') as launch_template_configs, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.TerminateInstancesWithExpiration') as terminate_instances_with_expiration, + JSON_EXTRACT(Properties, '$.ValidUntil') as valid_until, + JSON_EXTRACT(Properties, '$.Context') as context + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TargetCapacitySpecification') as target_capacity_specification, + json_extract_path_text(Properties, 'OnDemandOptions') as on_demand_options, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ExcessCapacityTerminationPolicy') as excess_capacity_termination_policy, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'SpotOptions') as spot_options, + json_extract_path_text(Properties, 'ValidFrom') as valid_from, + json_extract_path_text(Properties, 'ReplaceUnhealthyInstances') as replace_unhealthy_instances, + json_extract_path_text(Properties, 'LaunchTemplateConfigs') as launch_template_configs, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'TerminateInstancesWithExpiration') as terminate_instances_with_expiration, + json_extract_path_text(Properties, 'ValidUntil') as valid_until, + json_extract_path_text(Properties, 'Context') as context + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + ec2fleets_list_only: + name: ec2fleets_list_only + id: awscc.ec2.ec2fleets_list_only + x-cfn-schema-name: EC2Fleet + x-cfn-type-name: AWS::EC2::EC2Fleet + x-identifiers: + - FleetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FleetId') as fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + AND region = 'us-east-1' + egress_only_internet_gateways: + name: egress_only_internet_gateways + id: awscc.ec2.egress_only_internet_gateways + x-cfn-schema-name: EgressOnlyInternetGateway + x-cfn-type-name: AWS::EC2::EgressOnlyInternetGateway + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EgressOnlyInternetGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EgressOnlyInternetGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EgressOnlyInternetGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EgressOnlyInternetGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + egress_only_internet_gateways_list_only: + name: egress_only_internet_gateways_list_only + id: awscc.ec2.egress_only_internet_gateways_list_only + x-cfn-schema-name: EgressOnlyInternetGateway + x-cfn-type-name: AWS::EC2::EgressOnlyInternetGateway + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + AND region = 'us-east-1' + eips: + name: eips + id: awscc.ec2.eips + x-cfn-schema-name: EIP + x-cfn-type-name: AWS::EC2::EIP + x-identifiers: + - PublicIp + - AllocationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EIP&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EIP" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EIP" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EIP" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/eips/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/eips/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/eips/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, + JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.NetworkBorderGroup') as network_border_group, + JSON_EXTRACT(Properties, '$.TransferAddress') as transfer_address, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.PublicIpv4Pool') as public_ipv4_pool, + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.Address') as address, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIP' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PublicIp') as public_ip, + json_extract_path_text(Properties, 'AllocationId') as allocation_id, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'NetworkBorderGroup') as network_border_group, + json_extract_path_text(Properties, 'TransferAddress') as transfer_address, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'PublicIpv4Pool') as public_ipv4_pool, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'Address') as address, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIP' + AND data__Identifier = '|' + AND region = 'us-east-1' + eips_list_only: + name: eips_list_only + id: awscc.ec2.eips_list_only + x-cfn-schema-name: EIP + x-cfn-type-name: AWS::EC2::EIP + x-identifiers: + - PublicIp + - AllocationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, + JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' + AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + json_extract_path_text(Properties, 'PublicIp') as public_ip, + json_extract_path_text(Properties, 'AllocationId') as allocation_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' AND region = 'us-east-1' - capacity_reservation: - name: capacity_reservation - id: awscc.ec2.capacity_reservation - x-cfn-schema-name: CapacityReservation - x-type: get + eip_associations: + name: eip_associations + id: awscc.ec2.eip_associations + x-cfn-schema-name: EIPAssociation + x-cfn-type-name: AWS::EC2::EIPAssociation x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EIPAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EIPAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EIPAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/eip_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/eip_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Tenancy') as tenancy, - JSON_EXTRACT(Properties, '$.EndDateType') as end_date_type, - JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, - JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, - JSON_EXTRACT(Properties, '$.TotalInstanceCount') as total_instance_count, - JSON_EXTRACT(Properties, '$.EndDate') as end_date, - JSON_EXTRACT(Properties, '$.EbsOptimized') as ebs_optimized, - JSON_EXTRACT(Properties, '$.OutPostArn') as out_post_arn, - JSON_EXTRACT(Properties, '$.InstanceCount') as instance_count, - JSON_EXTRACT(Properties, '$.PlacementGroupArn') as placement_group_arn, - JSON_EXTRACT(Properties, '$.AvailableInstanceCount') as available_instance_count, - JSON_EXTRACT(Properties, '$.InstancePlatform') as instance_platform, + JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, - JSON_EXTRACT(Properties, '$.EphemeralStorage') as ephemeral_storage, - JSON_EXTRACT(Properties, '$.InstanceMatchCriteria') as instance_match_criteria - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, + JSON_EXTRACT(Properties, '$.EIP') as e_ip + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIPAssociation' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Tenancy') as tenancy, - json_extract_path_text(Properties, 'EndDateType') as end_date_type, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'TotalInstanceCount') as total_instance_count, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, - json_extract_path_text(Properties, 'OutPostArn') as out_post_arn, - json_extract_path_text(Properties, 'InstanceCount') as instance_count, - json_extract_path_text(Properties, 'PlacementGroupArn') as placement_group_arn, - json_extract_path_text(Properties, 'AvailableInstanceCount') as available_instance_count, - json_extract_path_text(Properties, 'InstancePlatform') as instance_platform, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'AllocationId') as allocation_id, json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, - json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'EIP') as e_ip + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIPAssociation' AND data__Identifier = '' AND region = 'us-east-1' - capacity_reservation_fleets: - name: capacity_reservation_fleets - id: awscc.ec2.capacity_reservation_fleets - x-cfn-schema-name: CapacityReservationFleet - x-type: list + eip_associations_list_only: + name: eip_associations_list_only + id: awscc.ec2.eip_associations_list_only + x-cfn-schema-name: EIPAssociation + x-cfn-type-name: AWS::EC2::EIPAssociation x-identifiers: - - CapacityReservationFleetId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8087,96 +17794,445 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' AND region = 'us-east-1' - capacity_reservation_fleet: - name: capacity_reservation_fleet - id: awscc.ec2.capacity_reservation_fleet - x-cfn-schema-name: CapacityReservationFleet - x-type: get + enclave_certificate_iam_role_associations: + name: enclave_certificate_iam_role_associations + id: awscc.ec2.enclave_certificate_iam_role_associations + x-cfn-schema-name: EnclaveCertificateIamRoleAssociation + x-cfn-type-name: AWS::EC2::EnclaveCertificateIamRoleAssociation x-identifiers: - - CapacityReservationFleetId + - CertificateArn + - RoleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnclaveCertificateIamRoleAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EnclaveCertificateIamRoleAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::EnclaveCertificateIamRoleAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/enclave_certificate_iam_role_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/enclave_certificate_iam_role_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.CertificateS3BucketName') as certificate_s3_bucket_name, + JSON_EXTRACT(Properties, '$.CertificateS3ObjectKey') as certificate_s3_object_key, + JSON_EXTRACT(Properties, '$.EncryptionKmsKeyId') as encryption_kms_key_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'CertificateS3BucketName') as certificate_s3_bucket_name, + json_extract_path_text(Properties, 'CertificateS3ObjectKey') as certificate_s3_object_key, + json_extract_path_text(Properties, 'EncryptionKmsKeyId') as encryption_kms_key_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + enclave_certificate_iam_role_associations_list_only: + name: enclave_certificate_iam_role_associations_list_only + id: awscc.ec2.enclave_certificate_iam_role_associations_list_only + x-cfn-schema-name: EnclaveCertificateIamRoleAssociation + x-cfn-type-name: AWS::EC2::EnclaveCertificateIamRoleAssociation + x-identifiers: + - CertificateArn + - RoleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + AND region = 'us-east-1' + flow_logs: + name: flow_logs + id: awscc.ec2.flow_logs + x-cfn-schema-name: FlowLog + x-cfn-type-name: AWS::EC2::FlowLog + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowLog&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::FlowLog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::FlowLog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::FlowLog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AllocationStrategy') as allocation_strategy, - JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, - JSON_EXTRACT(Properties, '$.InstanceTypeSpecifications') as instance_type_specifications, - JSON_EXTRACT(Properties, '$.TotalTargetCapacity') as total_target_capacity, - JSON_EXTRACT(Properties, '$.EndDate') as end_date, - JSON_EXTRACT(Properties, '$.InstanceMatchCriteria') as instance_match_criteria, - JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id, - JSON_EXTRACT(Properties, '$.Tenancy') as tenancy, - JSON_EXTRACT(Properties, '$.RemoveEndDate') as remove_end_date, - JSON_EXTRACT(Properties, '$.NoRemoveEndDate') as no_remove_end_date - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DeliverCrossAccountRole') as deliver_cross_account_role, + JSON_EXTRACT(Properties, '$.DeliverLogsPermissionArn') as deliver_logs_permission_arn, + JSON_EXTRACT(Properties, '$.LogDestination') as log_destination, + JSON_EXTRACT(Properties, '$.LogDestinationType') as log_destination_type, + JSON_EXTRACT(Properties, '$.LogFormat') as log_format, + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, + JSON_EXTRACT(Properties, '$.MaxAggregationInterval') as max_aggregation_interval, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TrafficType') as traffic_type, + JSON_EXTRACT(Properties, '$.DestinationOptions') as destination_options + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::FlowLog' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DeliverCrossAccountRole') as deliver_cross_account_role, + json_extract_path_text(Properties, 'DeliverLogsPermissionArn') as deliver_logs_permission_arn, + json_extract_path_text(Properties, 'LogDestination') as log_destination, + json_extract_path_text(Properties, 'LogDestinationType') as log_destination_type, + json_extract_path_text(Properties, 'LogFormat') as log_format, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'MaxAggregationInterval') as max_aggregation_interval, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrafficType') as traffic_type, + json_extract_path_text(Properties, 'DestinationOptions') as destination_options + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::FlowLog' + AND data__Identifier = '' + AND region = 'us-east-1' + flow_logs_list_only: + name: flow_logs_list_only + id: awscc.ec2.flow_logs_list_only + x-cfn-schema-name: FlowLog + x-cfn-type-name: AWS::EC2::FlowLog + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' + AND region = 'us-east-1' + gateway_route_table_associations: + name: gateway_route_table_associations + id: awscc.ec2.gateway_route_table_associations + x-cfn-schema-name: GatewayRouteTableAssociation + x-cfn-type-name: AWS::EC2::GatewayRouteTableAssociation + x-identifiers: + - GatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GatewayRouteTableAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::GatewayRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::GatewayRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::GatewayRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, + JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::GatewayRouteTableAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AllocationStrategy') as allocation_strategy, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'InstanceTypeSpecifications') as instance_type_specifications, - json_extract_path_text(Properties, 'TotalTargetCapacity') as total_target_capacity, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria, - json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id, - json_extract_path_text(Properties, 'Tenancy') as tenancy, - json_extract_path_text(Properties, 'RemoveEndDate') as remove_end_date, - json_extract_path_text(Properties, 'NoRemoveEndDate') as no_remove_end_date - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' - AND data__Identifier = '' + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'GatewayId') as gateway_id, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::GatewayRouteTableAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - carrier_gateways: - name: carrier_gateways - id: awscc.ec2.carrier_gateways - x-cfn-schema-name: CarrierGateway - x-type: list + hosts: + name: hosts + id: awscc.ec2.hosts + x-cfn-schema-name: Host + x-cfn-type-name: AWS::EC2::Host x-identifiers: - - CarrierGatewayId + - HostId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Host&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Host" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Host" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Host" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hosts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hosts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hosts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + data__Identifier, + JSON_EXTRACT(Properties, '$.HostId') as host_id, + JSON_EXTRACT(Properties, '$.AutoPlacement') as auto_placement, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.HostRecovery') as host_recovery, + JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, + JSON_EXTRACT(Properties, '$.InstanceFamily') as instance_family, + JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, + JSON_EXTRACT(Properties, '$.HostMaintenance') as host_maintenance, + JSON_EXTRACT(Properties, '$.AssetId') as asset_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Host' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + data__Identifier, + json_extract_path_text(Properties, 'HostId') as host_id, + json_extract_path_text(Properties, 'AutoPlacement') as auto_placement, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'HostRecovery') as host_recovery, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'InstanceFamily') as instance_family, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'HostMaintenance') as host_maintenance, + json_extract_path_text(Properties, 'AssetId') as asset_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Host' + AND data__Identifier = '' AND region = 'us-east-1' - carrier_gateway: - name: carrier_gateway - id: awscc.ec2.carrier_gateway - x-cfn-schema-name: CarrierGateway - x-type: get + hosts_list_only: + name: hosts_list_only + id: awscc.ec2.hosts_list_only + x-cfn-schema-name: Host + x-cfn-type-name: AWS::EC2::Host x-identifiers: - - CarrierGatewayId + - HostId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8184,61 +18240,149 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id, - JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, - JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CarrierGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.HostId') as host_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CarrierGateway' - AND data__Identifier = '' + json_extract_path_text(Properties, 'HostId') as host_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' AND region = 'us-east-1' - customer_gateways: - name: customer_gateways - id: awscc.ec2.customer_gateways - x-cfn-schema-name: CustomerGateway - x-type: list + network_interfaces: + name: network_interfaces + id: awscc.ec2.network_interfaces + x-cfn-schema-name: NetworkInterface + x-cfn-type-name: AWS::EC2::NetworkInterface x-identifiers: - - CustomerGatewayId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkInterface&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInterface" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInterface" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInterface" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, + JSON_EXTRACT(Properties, '$.PrimaryIpv6Address') as primary_ipv6_address, + JSON_EXTRACT(Properties, '$.PrivateIpAddresses') as private_ip_addresses, + JSON_EXTRACT(Properties, '$.SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, + JSON_EXTRACT(Properties, '$.Ipv6PrefixCount') as ipv6_prefix_count, + JSON_EXTRACT(Properties, '$.PrimaryPrivateIpAddress') as primary_private_ip_address, + JSON_EXTRACT(Properties, '$.Ipv4Prefixes') as ipv4_prefixes, + JSON_EXTRACT(Properties, '$.Ipv4PrefixCount') as ipv4_prefix_count, + JSON_EXTRACT(Properties, '$.EnablePrimaryIpv6') as enable_primary_ipv6, + JSON_EXTRACT(Properties, '$.GroupSet') as group_set, + JSON_EXTRACT(Properties, '$.Ipv6Addresses') as ipv6_addresses, + JSON_EXTRACT(Properties, '$.Ipv6Prefixes') as ipv6_prefixes, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.SourceDestCheck') as source_dest_check, + JSON_EXTRACT(Properties, '$.InterfaceType') as interface_type, + JSON_EXTRACT(Properties, '$.SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Ipv6AddressCount') as ipv6_address_count, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.ConnectionTrackingSpecification') as connection_tracking_specification + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterface' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'PrimaryIpv6Address') as primary_ipv6_address, + json_extract_path_text(Properties, 'PrivateIpAddresses') as private_ip_addresses, + json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, + json_extract_path_text(Properties, 'Ipv6PrefixCount') as ipv6_prefix_count, + json_extract_path_text(Properties, 'PrimaryPrivateIpAddress') as primary_private_ip_address, + json_extract_path_text(Properties, 'Ipv4Prefixes') as ipv4_prefixes, + json_extract_path_text(Properties, 'Ipv4PrefixCount') as ipv4_prefix_count, + json_extract_path_text(Properties, 'EnablePrimaryIpv6') as enable_primary_ipv6, + json_extract_path_text(Properties, 'GroupSet') as group_set, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, + json_extract_path_text(Properties, 'Ipv6Prefixes') as ipv6_prefixes, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, + json_extract_path_text(Properties, 'InterfaceType') as interface_type, + json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ConnectionTrackingSpecification') as connection_tracking_specification + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterface' + AND data__Identifier = '' AND region = 'us-east-1' - customer_gateway: - name: customer_gateway - id: awscc.ec2.customer_gateway - x-cfn-schema-name: CustomerGateway - x-type: get + network_interfaces_list_only: + name: network_interfaces_list_only + id: awscc.ec2.network_interfaces_list_only + x-cfn-schema-name: NetworkInterface + x-cfn-type-name: AWS::EC2::NetworkInterface x-identifiers: - - CustomerGatewayId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8246,79 +18390,133 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id, - JSON_EXTRACT(Properties, '$.BgpAsn') as bgp_asn, - JSON_EXTRACT(Properties, '$.IpAddress') as ip_address, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.DeviceName') as device_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, - json_extract_path_text(Properties, 'BgpAsn') as bgp_asn, - json_extract_path_text(Properties, 'IpAddress') as ip_address, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'DeviceName') as device_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' AND region = 'us-east-1' - dhcp_options: - name: dhcp_options - id: awscc.ec2.dhcp_options - x-cfn-schema-name: DHCPOptions - x-type: get + volumes: + name: volumes + id: awscc.ec2.volumes + x-cfn-schema-name: Volume + x-cfn-type-name: AWS::EC2::Volume x-identifiers: - - DhcpOptionsId + - VolumeId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Volume&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Volume" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Volume" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Volume" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/volumes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.NetbiosNameServers') as netbios_name_servers, - JSON_EXTRACT(Properties, '$.NtpServers') as ntp_servers, - JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.NetbiosNodeType') as netbios_node_type, - JSON_EXTRACT(Properties, '$.DomainNameServers') as domain_name_servers, + JSON_EXTRACT(Properties, '$.MultiAttachEnabled') as multi_attach_enabled, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.Encrypted') as encrypted, + JSON_EXTRACT(Properties, '$.Size') as size, + JSON_EXTRACT(Properties, '$.AutoEnableIO') as auto_enable_io, + JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.Throughput') as throughput, + JSON_EXTRACT(Properties, '$.Iops') as iops, + JSON_EXTRACT(Properties, '$.VolumeInitializationRate') as volume_initialization_rate, + JSON_EXTRACT(Properties, '$.SnapshotId') as snapshot_id, + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, + JSON_EXTRACT(Properties, '$.VolumeType') as volume_type, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::DHCPOptions' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Volume' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'NetbiosNameServers') as netbios_name_servers, - json_extract_path_text(Properties, 'NtpServers') as ntp_servers, - json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'NetbiosNodeType') as netbios_node_type, - json_extract_path_text(Properties, 'DomainNameServers') as domain_name_servers, + json_extract_path_text(Properties, 'MultiAttachEnabled') as multi_attach_enabled, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Encrypted') as encrypted, + json_extract_path_text(Properties, 'Size') as size, + json_extract_path_text(Properties, 'AutoEnableIO') as auto_enable_io, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'Throughput') as throughput, + json_extract_path_text(Properties, 'Iops') as iops, + json_extract_path_text(Properties, 'VolumeInitializationRate') as volume_initialization_rate, + json_extract_path_text(Properties, 'SnapshotId') as snapshot_id, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'VolumeType') as volume_type, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::DHCPOptions' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Volume' + AND data__Identifier = '' AND region = 'us-east-1' - ec2fleets: - name: ec2fleets - id: awscc.ec2.ec2fleets - x-cfn-schema-name: EC2Fleet - x-type: list + volumes_list_only: + name: volumes_list_only + id: awscc.ec2.volumes_list_only + x-cfn-schema-name: Volume + x-cfn-type-name: AWS::EC2::Volume x-identifiers: - - FleetId + - VolumeId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8326,77 +18524,201 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FleetId') as fleet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + json_extract_path_text(Properties, 'VolumeId') as volume_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' AND region = 'us-east-1' - ec2fleet: - name: ec2fleet - id: awscc.ec2.ec2fleet - x-cfn-schema-name: EC2Fleet - x-type: get + instances: + name: instances + id: awscc.ec2.instances + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::EC2::Instance x-identifiers: - - FleetId + - InstanceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.TargetCapacitySpecification') as target_capacity_specification, - JSON_EXTRACT(Properties, '$.OnDemandOptions') as on_demand_options, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.ExcessCapacityTerminationPolicy') as excess_capacity_termination_policy, - JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, - JSON_EXTRACT(Properties, '$.SpotOptions') as spot_options, - JSON_EXTRACT(Properties, '$.ValidFrom') as valid_from, - JSON_EXTRACT(Properties, '$.ReplaceUnhealthyInstances') as replace_unhealthy_instances, - JSON_EXTRACT(Properties, '$.LaunchTemplateConfigs') as launch_template_configs, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, - JSON_EXTRACT(Properties, '$.TerminateInstancesWithExpiration') as terminate_instances_with_expiration, - JSON_EXTRACT(Properties, '$.ValidUntil') as valid_until, - JSON_EXTRACT(Properties, '$.Context') as context - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EC2Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PrivateDnsName') as private_dns_name, + JSON_EXTRACT(Properties, '$.Volumes') as volumes, + JSON_EXTRACT(Properties, '$.PrivateIp') as private_ip, + JSON_EXTRACT(Properties, '$.EnclaveOptions') as enclave_options, + JSON_EXTRACT(Properties, '$.ImageId') as image_id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AdditionalInfo') as additional_info, + JSON_EXTRACT(Properties, '$.HibernationOptions') as hibernation_options, + JSON_EXTRACT(Properties, '$.LicenseSpecifications') as license_specifications, + JSON_EXTRACT(Properties, '$.MetadataOptions') as metadata_options, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.CpuOptions') as cpu_options, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.PrivateDnsNameOptions') as private_dns_name_options, + JSON_EXTRACT(Properties, '$.HostId') as host_id, + JSON_EXTRACT(Properties, '$.PublicDnsName') as public_dns_name, + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, + JSON_EXTRACT(Properties, '$.PlacementGroupName') as placement_group_name, + JSON_EXTRACT(Properties, '$.SsmAssociations') as ssm_associations, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Affinity') as affinity, + JSON_EXTRACT(Properties, '$.Tenancy') as tenancy, + JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, + JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, + JSON_EXTRACT(Properties, '$.UserData') as user_data, + JSON_EXTRACT(Properties, '$.BlockDeviceMappings') as block_device_mappings, + JSON_EXTRACT(Properties, '$.IamInstanceProfile') as iam_instance_profile, + JSON_EXTRACT(Properties, '$.Ipv6Addresses') as ipv6_addresses, + JSON_EXTRACT(Properties, '$.KernelId') as kernel_id, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.EbsOptimized') as ebs_optimized, + JSON_EXTRACT(Properties, '$.PropagateTagsToVolumeOnCreation') as propagate_tags_to_volume_on_creation, + JSON_EXTRACT(Properties, '$.ElasticGpuSpecifications') as elastic_gpu_specifications, + JSON_EXTRACT(Properties, '$.ElasticInferenceAccelerators') as elastic_inference_accelerators, + JSON_EXTRACT(Properties, '$.Ipv6AddressCount') as ipv6_address_count, + JSON_EXTRACT(Properties, '$.LaunchTemplate') as launch_template, + JSON_EXTRACT(Properties, '$.NetworkInterfaces') as network_interfaces, + JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, + JSON_EXTRACT(Properties, '$.Monitoring') as monitoring, + JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, + JSON_EXTRACT(Properties, '$.InstanceInitiatedShutdownBehavior') as instance_initiated_shutdown_behavior, + JSON_EXTRACT(Properties, '$.HostResourceGroupArn') as host_resource_group_arn, + JSON_EXTRACT(Properties, '$.DisableApiTermination') as disable_api_termination, + JSON_EXTRACT(Properties, '$.KeyName') as key_name, + JSON_EXTRACT(Properties, '$.RamdiskId') as ramdisk_id, + JSON_EXTRACT(Properties, '$.SourceDestCheck') as source_dest_check, + JSON_EXTRACT(Properties, '$.CreditSpecification') as credit_specification + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Instance' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'TargetCapacitySpecification') as target_capacity_specification, - json_extract_path_text(Properties, 'OnDemandOptions') as on_demand_options, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'ExcessCapacityTerminationPolicy') as excess_capacity_termination_policy, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'SpotOptions') as spot_options, - json_extract_path_text(Properties, 'ValidFrom') as valid_from, - json_extract_path_text(Properties, 'ReplaceUnhealthyInstances') as replace_unhealthy_instances, - json_extract_path_text(Properties, 'LaunchTemplateConfigs') as launch_template_configs, - json_extract_path_text(Properties, 'FleetId') as fleet_id, - json_extract_path_text(Properties, 'TerminateInstancesWithExpiration') as terminate_instances_with_expiration, - json_extract_path_text(Properties, 'ValidUntil') as valid_until, - json_extract_path_text(Properties, 'Context') as context - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EC2Fleet' - AND data__Identifier = '' + json_extract_path_text(Properties, 'PrivateDnsName') as private_dns_name, + json_extract_path_text(Properties, 'Volumes') as volumes, + json_extract_path_text(Properties, 'PrivateIp') as private_ip, + json_extract_path_text(Properties, 'EnclaveOptions') as enclave_options, + json_extract_path_text(Properties, 'ImageId') as image_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AdditionalInfo') as additional_info, + json_extract_path_text(Properties, 'HibernationOptions') as hibernation_options, + json_extract_path_text(Properties, 'LicenseSpecifications') as license_specifications, + json_extract_path_text(Properties, 'MetadataOptions') as metadata_options, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'CpuOptions') as cpu_options, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'PrivateDnsNameOptions') as private_dns_name_options, + json_extract_path_text(Properties, 'HostId') as host_id, + json_extract_path_text(Properties, 'PublicDnsName') as public_dns_name, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'PlacementGroupName') as placement_group_name, + json_extract_path_text(Properties, 'SsmAssociations') as ssm_associations, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Affinity') as affinity, + json_extract_path_text(Properties, 'Tenancy') as tenancy, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'UserData') as user_data, + json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, + json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, + json_extract_path_text(Properties, 'KernelId') as kernel_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, + json_extract_path_text(Properties, 'PropagateTagsToVolumeOnCreation') as propagate_tags_to_volume_on_creation, + json_extract_path_text(Properties, 'ElasticGpuSpecifications') as elastic_gpu_specifications, + json_extract_path_text(Properties, 'ElasticInferenceAccelerators') as elastic_inference_accelerators, + json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, + json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, + json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'Monitoring') as monitoring, + json_extract_path_text(Properties, 'PublicIp') as public_ip, + json_extract_path_text(Properties, 'InstanceInitiatedShutdownBehavior') as instance_initiated_shutdown_behavior, + json_extract_path_text(Properties, 'HostResourceGroupArn') as host_resource_group_arn, + json_extract_path_text(Properties, 'DisableApiTermination') as disable_api_termination, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'RamdiskId') as ramdisk_id, + json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, + json_extract_path_text(Properties, 'CreditSpecification') as credit_specification + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Instance' + AND data__Identifier = '' AND region = 'us-east-1' - egress_only_internet_gateways: - name: egress_only_internet_gateways - id: awscc.ec2.egress_only_internet_gateways - x-cfn-schema-name: EgressOnlyInternetGateway - x-type: list + instances_list_only: + name: instances_list_only + id: awscc.ec2.instances_list_only + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::EC2::Instance x-identifiers: - - Id + - InstanceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8404,56 +18726,117 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Instance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + json_extract_path_text(Properties, 'InstanceId') as instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Instance' AND region = 'us-east-1' - egress_only_internet_gateway: - name: egress_only_internet_gateway - id: awscc.ec2.egress_only_internet_gateway - x-cfn-schema-name: EgressOnlyInternetGateway - x-type: get + instance_connect_endpoints: + name: instance_connect_endpoints + id: awscc.ec2.instance_connect_endpoints + x-cfn-schema-name: InstanceConnectEndpoint + x-cfn-type-name: AWS::EC2::InstanceConnectEndpoint x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceConnectEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::InstanceConnectEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::InstanceConnectEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::InstanceConnectEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.ClientToken') as client_token, + JSON_EXTRACT(Properties, '$.PreserveClientIp') as preserve_client_ip, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'PreserveClientIp') as preserve_client_ip, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' AND data__Identifier = '' AND region = 'us-east-1' - eips: - name: eips - id: awscc.ec2.eips - x-cfn-schema-name: EIP - x-type: list + instance_connect_endpoints_list_only: + name: instance_connect_endpoints_list_only + id: awscc.ec2.instance_connect_endpoints_list_only + x-cfn-schema-name: InstanceConnectEndpoint + x-cfn-type-name: AWS::EC2::InstanceConnectEndpoint x-identifiers: - - PublicIp - - AllocationId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8461,70 +18844,109 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, - JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PublicIp') as public_ip, - json_extract_path_text(Properties, 'AllocationId') as allocation_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' AND region = 'us-east-1' - eip: - name: eip - id: awscc.ec2.eip - x-cfn-schema-name: EIP - x-type: get + internet_gateways: + name: internet_gateways + id: awscc.ec2.internet_gateways + x-cfn-schema-name: InternetGateway + x-cfn-type-name: AWS::EC2::InternetGateway x-identifiers: - - PublicIp - - AllocationId + - InternetGatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InternetGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::InternetGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::InternetGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::InternetGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, - JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id, - JSON_EXTRACT(Properties, '$.Domain') as domain, - JSON_EXTRACT(Properties, '$.NetworkBorderGroup') as network_border_group, - JSON_EXTRACT(Properties, '$.TransferAddress') as transfer_address, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.PublicIpv4Pool') as public_ipv4_pool, + JSON_EXTRACT(Properties, '$.InternetGatewayId') as internet_gateway_id, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIP' - AND data__Identifier = '|' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InternetGateway' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'PublicIp') as public_ip, - json_extract_path_text(Properties, 'AllocationId') as allocation_id, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'NetworkBorderGroup') as network_border_group, - json_extract_path_text(Properties, 'TransferAddress') as transfer_address, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'PublicIpv4Pool') as public_ipv4_pool, + json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIP' - AND data__Identifier = '|' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InternetGateway' + AND data__Identifier = '' AND region = 'us-east-1' - eip_associations: - name: eip_associations - id: awscc.ec2.eip_associations - x-cfn-schema-name: EIPAssociation - x-type: list + internet_gateways_list_only: + name: internet_gateways_list_only + id: awscc.ec2.internet_gateways_list_only + x-cfn-schema-name: InternetGateway + x-cfn-type-name: AWS::EC2::InternetGateway x-identifiers: - - Id + - InternetGatewayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8532,92 +18954,135 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' + JSON_EXTRACT(Properties, '$.InternetGatewayId') as internet_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' + json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' AND region = 'us-east-1' - eip_association: - name: eip_association - id: awscc.ec2.eip_association - x-cfn-schema-name: EIPAssociation - x-type: get + ipams: + name: ipams + id: awscc.ec2.ipams + x-cfn-schema-name: IPAM + x-cfn-type-name: AWS::EC2::IPAM x-identifiers: - - Id + - IpamId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAM&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAM" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAM" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAM" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ipams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, - JSON_EXTRACT(Properties, '$.EIP') as e_ip - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIPAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamId') as ipam_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.DefaultResourceDiscoveryId') as default_resource_discovery_id, + JSON_EXTRACT(Properties, '$.DefaultResourceDiscoveryAssociationId') as default_resource_discovery_association_id, + JSON_EXTRACT(Properties, '$.ResourceDiscoveryAssociationCount') as resource_discovery_association_count, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.PublicDefaultScopeId') as public_default_scope_id, + JSON_EXTRACT(Properties, '$.PrivateDefaultScopeId') as private_default_scope_id, + JSON_EXTRACT(Properties, '$.ScopeCount') as scope_count, + JSON_EXTRACT(Properties, '$.OperatingRegions') as operating_regions, + JSON_EXTRACT(Properties, '$.Tier') as tier, + JSON_EXTRACT(Properties, '$.EnablePrivateGua') as enable_private_gua, + JSON_EXTRACT(Properties, '$.MeteredAccount') as metered_account, + JSON_EXTRACT(Properties, '$.DefaultResourceDiscoveryOrganizationalUnitExclusions') as default_resource_discovery_organizational_unit_exclusions, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAM' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'AllocationId') as allocation_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'EIP') as e_ip - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIPAssociation' - AND data__Identifier = '' - AND region = 'us-east-1' - enclave_certificate_iam_role_associations: - name: enclave_certificate_iam_role_associations - id: awscc.ec2.enclave_certificate_iam_role_associations - x-cfn-schema-name: EnclaveCertificateIamRoleAssociation - x-type: list - x-identifiers: - - CertificateArn - - RoleArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DefaultResourceDiscoveryId') as default_resource_discovery_id, + json_extract_path_text(Properties, 'DefaultResourceDiscoveryAssociationId') as default_resource_discovery_association_id, + json_extract_path_text(Properties, 'ResourceDiscoveryAssociationCount') as resource_discovery_association_count, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PublicDefaultScopeId') as public_default_scope_id, + json_extract_path_text(Properties, 'PrivateDefaultScopeId') as private_default_scope_id, + json_extract_path_text(Properties, 'ScopeCount') as scope_count, + json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'EnablePrivateGua') as enable_private_gua, + json_extract_path_text(Properties, 'MeteredAccount') as metered_account, + json_extract_path_text(Properties, 'DefaultResourceDiscoveryOrganizationalUnitExclusions') as default_resource_discovery_organizational_unit_exclusions, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAM' + AND data__Identifier = '' AND region = 'us-east-1' - enclave_certificate_iam_role_association: - name: enclave_certificate_iam_role_association - id: awscc.ec2.enclave_certificate_iam_role_association - x-cfn-schema-name: EnclaveCertificateIamRoleAssociation - x-type: get + ipams_list_only: + name: ipams_list_only + id: awscc.ec2.ipams_list_only + x-cfn-schema-name: IPAM + x-cfn-type-name: AWS::EC2::IPAM x-identifiers: - - CertificateArn - - RoleArn + - IpamId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8625,61 +19090,106 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.CertificateS3BucketName') as certificate_s3_bucket_name, - JSON_EXTRACT(Properties, '$.CertificateS3ObjectKey') as certificate_s3_object_key, - JSON_EXTRACT(Properties, '$.EncryptionKmsKeyId') as encryption_kms_key_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.IpamId') as ipam_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'CertificateS3BucketName') as certificate_s3_bucket_name, - json_extract_path_text(Properties, 'CertificateS3ObjectKey') as certificate_s3_object_key, - json_extract_path_text(Properties, 'EncryptionKmsKeyId') as encryption_kms_key_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' - AND data__Identifier = '|' - AND region = 'us-east-1' - flow_logs: - name: flow_logs - id: awscc.ec2.flow_logs - x-cfn-schema-name: FlowLog - x-type: list + json_extract_path_text(Properties, 'IpamId') as ipam_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' + AND region = 'us-east-1' + ipam_allocations: + name: ipam_allocations + id: awscc.ec2.ipam_allocations + x-cfn-schema-name: IPAMAllocation + x-cfn-type-name: AWS::EC2::IPAMAllocation x-identifiers: - - Id + - IpamPoolId + - IpamPoolAllocationId + - Cidr + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAMAllocation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMAllocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMAllocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_allocations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_allocations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' + data__Identifier, + JSON_EXTRACT(Properties, '$.IpamPoolAllocationId') as ipam_pool_allocation_id, + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.Cidr') as cidr, + JSON_EXTRACT(Properties, '$.NetmaskLength') as netmask_length, + JSON_EXTRACT(Properties, '$.Description') as description + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' + data__Identifier, + json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'Cidr') as cidr, + json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, + json_extract_path_text(Properties, 'Description') as description + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' + AND data__Identifier = '||' AND region = 'us-east-1' - flow_log: - name: flow_log - id: awscc.ec2.flow_log - x-cfn-schema-name: FlowLog - x-type: get + ipam_allocations_list_only: + name: ipam_allocations_list_only + id: awscc.ec2.ipam_allocations_list_only + x-cfn-schema-name: IPAMAllocation + x-cfn-type-name: AWS::EC2::IPAMAllocation x-identifiers: - - Id + - IpamPoolId + - IpamPoolAllocationId + - Cidr + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8687,85 +19197,157 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.DeliverCrossAccountRole') as deliver_cross_account_role, - JSON_EXTRACT(Properties, '$.DeliverLogsPermissionArn') as deliver_logs_permission_arn, - JSON_EXTRACT(Properties, '$.LogDestination') as log_destination, - JSON_EXTRACT(Properties, '$.LogDestinationType') as log_destination_type, - JSON_EXTRACT(Properties, '$.LogFormat') as log_format, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.MaxAggregationInterval') as max_aggregation_interval, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TrafficType') as traffic_type, - JSON_EXTRACT(Properties, '$.DestinationOptions') as destination_options - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::FlowLog' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.IpamPoolAllocationId') as ipam_pool_allocation_id, + JSON_EXTRACT(Properties, '$.Cidr') as cidr + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DeliverCrossAccountRole') as deliver_cross_account_role, - json_extract_path_text(Properties, 'DeliverLogsPermissionArn') as deliver_logs_permission_arn, - json_extract_path_text(Properties, 'LogDestination') as log_destination, - json_extract_path_text(Properties, 'LogDestinationType') as log_destination_type, - json_extract_path_text(Properties, 'LogFormat') as log_format, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'MaxAggregationInterval') as max_aggregation_interval, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrafficType') as traffic_type, - json_extract_path_text(Properties, 'DestinationOptions') as destination_options - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::FlowLog' - AND data__Identifier = '' + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, + json_extract_path_text(Properties, 'Cidr') as cidr + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' AND region = 'us-east-1' - gateway_route_table_association: - name: gateway_route_table_association - id: awscc.ec2.gateway_route_table_association - x-cfn-schema-name: GatewayRouteTableAssociation - x-type: get + ipam_pools: + name: ipam_pools + id: awscc.ec2.ipam_pools + x-cfn-schema-name: IPAMPool + x-cfn-type-name: AWS::EC2::IPAMPool x-identifiers: - - GatewayId + - IpamPoolId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAMPool&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, - JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::GatewayRouteTableAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.AddressFamily') as address_family, + JSON_EXTRACT(Properties, '$.AllocationMinNetmaskLength') as allocation_min_netmask_length, + JSON_EXTRACT(Properties, '$.AllocationDefaultNetmaskLength') as allocation_default_netmask_length, + JSON_EXTRACT(Properties, '$.AllocationMaxNetmaskLength') as allocation_max_netmask_length, + JSON_EXTRACT(Properties, '$.AllocationResourceTags') as allocation_resource_tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AutoImport') as auto_import, + JSON_EXTRACT(Properties, '$.AwsService') as aws_service, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id, + JSON_EXTRACT(Properties, '$.IpamScopeArn') as ipam_scope_arn, + JSON_EXTRACT(Properties, '$.IpamScopeType') as ipam_scope_type, + JSON_EXTRACT(Properties, '$.IpamArn') as ipam_arn, + JSON_EXTRACT(Properties, '$.Locale') as locale, + JSON_EXTRACT(Properties, '$.PoolDepth') as pool_depth, + JSON_EXTRACT(Properties, '$.ProvisionedCidrs') as provisioned_cidrs, + JSON_EXTRACT(Properties, '$.PublicIpSource') as public_ip_source, + JSON_EXTRACT(Properties, '$.PubliclyAdvertisable') as publicly_advertisable, + JSON_EXTRACT(Properties, '$.SourceIpamPoolId') as source_ipam_pool_id, + JSON_EXTRACT(Properties, '$.SourceResource') as source_resource, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.StateMessage') as state_message, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPool' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'GatewayId') as gateway_id, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::GatewayRouteTableAssociation' - AND data__Identifier = '' + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'AddressFamily') as address_family, + json_extract_path_text(Properties, 'AllocationMinNetmaskLength') as allocation_min_netmask_length, + json_extract_path_text(Properties, 'AllocationDefaultNetmaskLength') as allocation_default_netmask_length, + json_extract_path_text(Properties, 'AllocationMaxNetmaskLength') as allocation_max_netmask_length, + json_extract_path_text(Properties, 'AllocationResourceTags') as allocation_resource_tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AutoImport') as auto_import, + json_extract_path_text(Properties, 'AwsService') as aws_service, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, + json_extract_path_text(Properties, 'IpamScopeArn') as ipam_scope_arn, + json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, + json_extract_path_text(Properties, 'IpamArn') as ipam_arn, + json_extract_path_text(Properties, 'Locale') as locale, + json_extract_path_text(Properties, 'PoolDepth') as pool_depth, + json_extract_path_text(Properties, 'ProvisionedCidrs') as provisioned_cidrs, + json_extract_path_text(Properties, 'PublicIpSource') as public_ip_source, + json_extract_path_text(Properties, 'PubliclyAdvertisable') as publicly_advertisable, + json_extract_path_text(Properties, 'SourceIpamPoolId') as source_ipam_pool_id, + json_extract_path_text(Properties, 'SourceResource') as source_resource, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'StateMessage') as state_message, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPool' + AND data__Identifier = '' AND region = 'us-east-1' - hosts: - name: hosts - id: awscc.ec2.hosts - x-cfn-schema-name: Host - x-type: list + ipam_pools_list_only: + name: ipam_pools_list_only + id: awscc.ec2.ipam_pools_list_only + x-cfn-schema-name: IPAMPool + x-cfn-type-name: AWS::EC2::IPAMPool x-identifiers: - - HostId + - IpamPoolId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8773,69 +19355,104 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.HostId') as host_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'HostId') as host_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' AND region = 'us-east-1' - host: - name: host - id: awscc.ec2.host - x-cfn-schema-name: Host - x-type: get + ipam_pool_cidrs: + name: ipam_pool_cidrs + id: awscc.ec2.ipam_pool_cidrs + x-cfn-schema-name: IPAMPoolCidr + x-cfn-type-name: AWS::EC2::IPAMPoolCidr x-identifiers: - - HostId + - IpamPoolId + - IpamPoolCidrId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAMPoolCidr&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMPoolCidr" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMPoolCidr" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.HostId') as host_id, - JSON_EXTRACT(Properties, '$.AutoPlacement') as auto_placement, - JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, - JSON_EXTRACT(Properties, '$.HostRecovery') as host_recovery, - JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, - JSON_EXTRACT(Properties, '$.InstanceFamily') as instance_family, - JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, - JSON_EXTRACT(Properties, '$.HostMaintenance') as host_maintenance, - JSON_EXTRACT(Properties, '$.AssetId') as asset_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Host' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamPoolCidrId') as ipam_pool_cidr_id, + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.Cidr') as cidr, + JSON_EXTRACT(Properties, '$.NetmaskLength') as netmask_length, + JSON_EXTRACT(Properties, '$.State') as state + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'HostId') as host_id, - json_extract_path_text(Properties, 'AutoPlacement') as auto_placement, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'HostRecovery') as host_recovery, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'InstanceFamily') as instance_family, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'HostMaintenance') as host_maintenance, - json_extract_path_text(Properties, 'AssetId') as asset_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Host' - AND data__Identifier = '' + json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'Cidr') as cidr, + json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, + json_extract_path_text(Properties, 'State') as state + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' + AND data__Identifier = '|' AND region = 'us-east-1' - instance_connect_endpoints: - name: instance_connect_endpoints - id: awscc.ec2.instance_connect_endpoints - x-cfn-schema-name: InstanceConnectEndpoint - x-type: list + ipam_pool_cidrs_list_only: + name: ipam_pool_cidrs_list_only + id: awscc.ec2.ipam_pool_cidrs_list_only + x-cfn-schema-name: IPAMPoolCidr + x-cfn-type-name: AWS::EC2::IPAMPoolCidr x-identifiers: - - Id + - IpamPoolId + - IpamPoolCidrId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8843,63 +19460,127 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.IpamPoolCidrId') as ipam_pool_cidr_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' AND region = 'us-east-1' - instance_connect_endpoint: - name: instance_connect_endpoint - id: awscc.ec2.instance_connect_endpoint - x-cfn-schema-name: InstanceConnectEndpoint - x-type: get + ipam_resource_discoveries: + name: ipam_resource_discoveries + id: awscc.ec2.ipam_resource_discoveries + x-cfn-schema-name: IPAMResourceDiscovery + x-cfn-type-name: AWS::EC2::IPAMResourceDiscovery x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, - JSON_EXTRACT(Properties, '$.ClientToken') as client_token, - JSON_EXTRACT(Properties, '$.PreserveClientIp') as preserve_client_ip, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' - AND data__Identifier = '' + - IpamResourceDiscoveryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAMResourceDiscovery&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMResourceDiscovery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMResourceDiscovery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMResourceDiscovery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.OperatingRegions') as operating_regions, + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryRegion') as ipam_resource_discovery_region, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.OrganizationalUnitExclusions') as organizational_unit_exclusions, + JSON_EXTRACT(Properties, '$.IsDefault') as is_default, + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryArn') as ipam_resource_discovery_arn, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'PreserveClientIp') as preserve_client_ip, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' - AND data__Identifier = '' + json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, + json_extract_path_text(Properties, 'IpamResourceDiscoveryRegion') as ipam_resource_discovery_region, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'OrganizationalUnitExclusions') as organizational_unit_exclusions, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'IpamResourceDiscoveryArn') as ipam_resource_discovery_arn, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' + AND data__Identifier = '' AND region = 'us-east-1' - internet_gateways: - name: internet_gateways - id: awscc.ec2.internet_gateways - x-cfn-schema-name: InternetGateway - x-type: list + ipam_resource_discoveries_list_only: + name: ipam_resource_discoveries_list_only + id: awscc.ec2.ipam_resource_discoveries_list_only + x-cfn-schema-name: IPAMResourceDiscovery + x-cfn-type-name: AWS::EC2::IPAMResourceDiscovery x-identifiers: - - InternetGatewayId + - IpamResourceDiscoveryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8907,55 +19588,127 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InternetGatewayId') as internet_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' + json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' AND region = 'us-east-1' - internet_gateway: - name: internet_gateway - id: awscc.ec2.internet_gateway - x-cfn-schema-name: InternetGateway - x-type: get + ipam_resource_discovery_associations: + name: ipam_resource_discovery_associations + id: awscc.ec2.ipam_resource_discovery_associations + x-cfn-schema-name: IPAMResourceDiscoveryAssociation + x-cfn-type-name: AWS::EC2::IPAMResourceDiscoveryAssociation x-identifiers: - - InternetGatewayId + - IpamResourceDiscoveryAssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAMResourceDiscoveryAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMResourceDiscoveryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMResourceDiscoveryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMResourceDiscoveryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.InternetGatewayId') as internet_gateway_id, + JSON_EXTRACT(Properties, '$.IpamArn') as ipam_arn, + JSON_EXTRACT(Properties, '$.IpamRegion') as ipam_region, + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id, + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id, + JSON_EXTRACT(Properties, '$.IpamId') as ipam_id, + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationArn') as ipam_resource_discovery_association_arn, + JSON_EXTRACT(Properties, '$.IsDefault') as is_default, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.ResourceDiscoveryStatus') as resource_discovery_status, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InternetGateway' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id, + json_extract_path_text(Properties, 'IpamArn') as ipam_arn, + json_extract_path_text(Properties, 'IpamRegion') as ipam_region, + json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id, + json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, + json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationArn') as ipam_resource_discovery_association_arn, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'ResourceDiscoveryStatus') as resource_discovery_status, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InternetGateway' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - ipams: - name: ipams - id: awscc.ec2.ipams - x-cfn-schema-name: IPAM - x-type: list + ipam_resource_discovery_associations_list_only: + name: ipam_resource_discovery_associations_list_only + id: awscc.ec2.ipam_resource_discovery_associations_list_only + x-cfn-schema-name: IPAMResourceDiscoveryAssociation + x-cfn-type-name: AWS::EC2::IPAMResourceDiscoveryAssociation x-identifiers: - - IpamId + - IpamResourceDiscoveryAssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -8963,77 +19716,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamId') as ipam_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamId') as ipam_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' + json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' AND region = 'us-east-1' - ipam: - name: ipam - id: awscc.ec2.ipam - x-cfn-schema-name: IPAM - x-type: get + ipam_scopes: + name: ipam_scopes + id: awscc.ec2.ipam_scopes + x-cfn-schema-name: IPAMScope + x-cfn-type-name: AWS::EC2::IPAMScope x-identifiers: - - IpamId + - IpamScopeId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPAMScope&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMScope" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMScope" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAMScope" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.IpamId') as ipam_id, + JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.DefaultResourceDiscoveryId') as default_resource_discovery_id, - JSON_EXTRACT(Properties, '$.DefaultResourceDiscoveryAssociationId') as default_resource_discovery_association_id, - JSON_EXTRACT(Properties, '$.ResourceDiscoveryAssociationCount') as resource_discovery_association_count, + JSON_EXTRACT(Properties, '$.IpamId') as ipam_id, + JSON_EXTRACT(Properties, '$.IpamArn') as ipam_arn, + JSON_EXTRACT(Properties, '$.IpamScopeType') as ipam_scope_type, + JSON_EXTRACT(Properties, '$.IsDefault') as is_default, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.PublicDefaultScopeId') as public_default_scope_id, - JSON_EXTRACT(Properties, '$.PrivateDefaultScopeId') as private_default_scope_id, - JSON_EXTRACT(Properties, '$.ScopeCount') as scope_count, - JSON_EXTRACT(Properties, '$.OperatingRegions') as operating_regions, - JSON_EXTRACT(Properties, '$.Tier') as tier, + JSON_EXTRACT(Properties, '$.PoolCount') as pool_count, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAM' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMScope' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DefaultResourceDiscoveryId') as default_resource_discovery_id, - json_extract_path_text(Properties, 'DefaultResourceDiscoveryAssociationId') as default_resource_discovery_association_id, - json_extract_path_text(Properties, 'ResourceDiscoveryAssociationCount') as resource_discovery_association_count, + json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'IpamArn') as ipam_arn, + json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, + json_extract_path_text(Properties, 'IsDefault') as is_default, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PublicDefaultScopeId') as public_default_scope_id, - json_extract_path_text(Properties, 'PrivateDefaultScopeId') as private_default_scope_id, - json_extract_path_text(Properties, 'ScopeCount') as scope_count, - json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, - json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'PoolCount') as pool_count, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAM' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMScope' + AND data__Identifier = '' AND region = 'us-east-1' - ipam_allocations: - name: ipam_allocations - id: awscc.ec2.ipam_allocations - x-cfn-schema-name: IPAMAllocation - x-type: list + ipam_scopes_list_only: + name: ipam_scopes_list_only + id: awscc.ec2.ipam_scopes_list_only + x-cfn-schema-name: IPAMScope + x-cfn-type-name: AWS::EC2::IPAMScope x-identifiers: - - IpamPoolId - - IpamPoolAllocationId - - Cidr + - IpamScopeId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9041,67 +19840,98 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.IpamPoolAllocationId') as ipam_pool_allocation_id, - JSON_EXTRACT(Properties, '$.Cidr') as cidr - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' + JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, - json_extract_path_text(Properties, 'Cidr') as cidr - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' + json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' AND region = 'us-east-1' - ipam_allocation: - name: ipam_allocation - id: awscc.ec2.ipam_allocation - x-cfn-schema-name: IPAMAllocation - x-type: get + ip_pool_route_table_associations: + name: ip_pool_route_table_associations + id: awscc.ec2.ip_pool_route_table_associations + x-cfn-schema-name: IpPoolRouteTableAssociation + x-cfn-type-name: AWS::EC2::IpPoolRouteTableAssociation x-identifiers: - - IpamPoolId - - IpamPoolAllocationId - - Cidr + - AssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IpPoolRouteTableAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IpPoolRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IpPoolRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_pool_route_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_pool_route_table_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.IpamPoolAllocationId') as ipam_pool_allocation_id, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.Cidr') as cidr, - JSON_EXTRACT(Properties, '$.NetmaskLength') as netmask_length, - JSON_EXTRACT(Properties, '$.Description') as description - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.AssociationId') as association_id, + JSON_EXTRACT(Properties, '$.PublicIpv4Pool') as public_ipv4_pool, + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IpPoolRouteTableAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'Cidr') as cidr, - json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, - json_extract_path_text(Properties, 'Description') as description - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' - AND data__Identifier = '||' + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'PublicIpv4Pool') as public_ipv4_pool, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IpPoolRouteTableAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - ipam_pools: - name: ipam_pools - id: awscc.ec2.ipam_pools - x-cfn-schema-name: IPAMPool - x-type: list + ip_pool_route_table_associations_list_only: + name: ip_pool_route_table_associations_list_only + id: awscc.ec2.ip_pool_route_table_associations_list_only + x-cfn-schema-name: IpPoolRouteTableAssociation + x-cfn-type-name: AWS::EC2::IpPoolRouteTableAssociation x-identifiers: - - IpamPoolId + - AssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9109,100 +19939,106 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IpPoolRouteTableAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IpPoolRouteTableAssociation' AND region = 'us-east-1' - ipam_pool: - name: ipam_pool - id: awscc.ec2.ipam_pool - x-cfn-schema-name: IPAMPool - x-type: get + key_pairs: + name: key_pairs + id: awscc.ec2.key_pairs + x-cfn-schema-name: KeyPair + x-cfn-type-name: AWS::EC2::KeyPair x-identifiers: - - IpamPoolId + - KeyName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KeyPair&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::KeyPair" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::KeyPair" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_pairs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_pairs/methods/delete_resource' + update: [] config: views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.AddressFamily') as address_family, - JSON_EXTRACT(Properties, '$.AllocationMinNetmaskLength') as allocation_min_netmask_length, - JSON_EXTRACT(Properties, '$.AllocationDefaultNetmaskLength') as allocation_default_netmask_length, - JSON_EXTRACT(Properties, '$.AllocationMaxNetmaskLength') as allocation_max_netmask_length, - JSON_EXTRACT(Properties, '$.AllocationResourceTags') as allocation_resource_tags, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AutoImport') as auto_import, - JSON_EXTRACT(Properties, '$.AwsService') as aws_service, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id, - JSON_EXTRACT(Properties, '$.IpamScopeArn') as ipam_scope_arn, - JSON_EXTRACT(Properties, '$.IpamScopeType') as ipam_scope_type, - JSON_EXTRACT(Properties, '$.IpamArn') as ipam_arn, - JSON_EXTRACT(Properties, '$.Locale') as locale, - JSON_EXTRACT(Properties, '$.PoolDepth') as pool_depth, - JSON_EXTRACT(Properties, '$.ProvisionedCidrs') as provisioned_cidrs, - JSON_EXTRACT(Properties, '$.PublicIpSource') as public_ip_source, - JSON_EXTRACT(Properties, '$.PubliclyAdvertisable') as publicly_advertisable, - JSON_EXTRACT(Properties, '$.SourceIpamPoolId') as source_ipam_pool_id, - JSON_EXTRACT(Properties, '$.SourceResource') as source_resource, - JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.StateMessage') as state_message, + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.KeyName') as key_name, + JSON_EXTRACT(Properties, '$.KeyType') as key_type, + JSON_EXTRACT(Properties, '$.KeyFormat') as key_format, + JSON_EXTRACT(Properties, '$.PublicKeyMaterial') as public_key_material, + JSON_EXTRACT(Properties, '$.KeyFingerprint') as key_fingerprint, + JSON_EXTRACT(Properties, '$.KeyPairId') as key_pair_id, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPool' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::KeyPair' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'AddressFamily') as address_family, - json_extract_path_text(Properties, 'AllocationMinNetmaskLength') as allocation_min_netmask_length, - json_extract_path_text(Properties, 'AllocationDefaultNetmaskLength') as allocation_default_netmask_length, - json_extract_path_text(Properties, 'AllocationMaxNetmaskLength') as allocation_max_netmask_length, - json_extract_path_text(Properties, 'AllocationResourceTags') as allocation_resource_tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AutoImport') as auto_import, - json_extract_path_text(Properties, 'AwsService') as aws_service, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, - json_extract_path_text(Properties, 'IpamScopeArn') as ipam_scope_arn, - json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, - json_extract_path_text(Properties, 'IpamArn') as ipam_arn, - json_extract_path_text(Properties, 'Locale') as locale, - json_extract_path_text(Properties, 'PoolDepth') as pool_depth, - json_extract_path_text(Properties, 'ProvisionedCidrs') as provisioned_cidrs, - json_extract_path_text(Properties, 'PublicIpSource') as public_ip_source, - json_extract_path_text(Properties, 'PubliclyAdvertisable') as publicly_advertisable, - json_extract_path_text(Properties, 'SourceIpamPoolId') as source_ipam_pool_id, - json_extract_path_text(Properties, 'SourceResource') as source_resource, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'StateMessage') as state_message, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'KeyType') as key_type, + json_extract_path_text(Properties, 'KeyFormat') as key_format, + json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, + json_extract_path_text(Properties, 'KeyFingerprint') as key_fingerprint, + json_extract_path_text(Properties, 'KeyPairId') as key_pair_id, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPool' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::KeyPair' + AND data__Identifier = '' AND region = 'us-east-1' - ipam_pool_cidrs: - name: ipam_pool_cidrs - id: awscc.ec2.ipam_pool_cidrs - x-cfn-schema-name: IPAMPoolCidr - x-type: list + key_pairs_list_only: + name: key_pairs_list_only + id: awscc.ec2.key_pairs_list_only + x-cfn-schema-name: KeyPair + x-cfn-type-name: AWS::EC2::KeyPair x-identifiers: - - IpamPoolId - - IpamPoolCidrId + - KeyName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9210,64 +20046,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.IpamPoolCidrId') as ipam_pool_cidr_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' + JSON_EXTRACT(Properties, '$.KeyName') as key_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' + json_extract_path_text(Properties, 'KeyName') as key_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' AND region = 'us-east-1' - ipam_pool_cidr: - name: ipam_pool_cidr - id: awscc.ec2.ipam_pool_cidr - x-cfn-schema-name: IPAMPoolCidr - x-type: get + launch_templates: + name: launch_templates + id: awscc.ec2.launch_templates + x-cfn-schema-name: LaunchTemplate + x-cfn-type-name: AWS::EC2::LaunchTemplate x-identifiers: - - IpamPoolId - - IpamPoolCidrId + - LaunchTemplateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LaunchTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LaunchTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LaunchTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LaunchTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.IpamPoolCidrId') as ipam_pool_cidr_id, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.Cidr') as cidr, - JSON_EXTRACT(Properties, '$.NetmaskLength') as netmask_length, - JSON_EXTRACT(Properties, '$.State') as state - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LaunchTemplateName') as launch_template_name, + JSON_EXTRACT(Properties, '$.LaunchTemplateData') as launch_template_data, + JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, + JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, + JSON_EXTRACT(Properties, '$.LatestVersionNumber') as latest_version_number, + JSON_EXTRACT(Properties, '$.LaunchTemplateId') as launch_template_id, + JSON_EXTRACT(Properties, '$.DefaultVersionNumber') as default_version_number + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'Cidr') as cidr, - json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, - json_extract_path_text(Properties, 'State') as state - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'LaunchTemplateName') as launch_template_name, + json_extract_path_text(Properties, 'LaunchTemplateData') as launch_template_data, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, + json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id, + json_extract_path_text(Properties, 'DefaultVersionNumber') as default_version_number + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' + AND data__Identifier = '' AND region = 'us-east-1' - ipam_resource_discoveries: - name: ipam_resource_discoveries - id: awscc.ec2.ipam_resource_discoveries - x-cfn-schema-name: IPAMResourceDiscovery - x-type: list + launch_templates_list_only: + name: launch_templates_list_only + id: awscc.ec2.launch_templates_list_only + x-cfn-schema-name: LaunchTemplate + x-cfn-type-name: AWS::EC2::LaunchTemplate x-identifiers: - - IpamResourceDiscoveryId + - LaunchTemplateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9275,69 +20166,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' + JSON_EXTRACT(Properties, '$.LaunchTemplateId') as launch_template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' + json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' AND region = 'us-east-1' - ipam_resource_discovery: - name: ipam_resource_discovery - id: awscc.ec2.ipam_resource_discovery - x-cfn-schema-name: IPAMResourceDiscovery - x-type: get + local_gateway_routes: + name: local_gateway_routes + id: awscc.ec2.local_gateway_routes + x-cfn-schema-name: LocalGatewayRoute + x-cfn-type-name: AWS::EC2::LocalGatewayRoute x-identifiers: - - IpamResourceDiscoveryId + - DestinationCidrBlock + - LocalGatewayRouteTableId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocalGatewayRoute&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id, - JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, - JSON_EXTRACT(Properties, '$.OperatingRegions') as operating_regions, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryRegion') as ipam_resource_discovery_region, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.IsDefault') as is_default, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryArn') as ipam_resource_discovery_arn, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, - json_extract_path_text(Properties, 'IpamResourceDiscoveryRegion') as ipam_resource_discovery_region, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'IsDefault') as is_default, - json_extract_path_text(Properties, 'IpamResourceDiscoveryArn') as ipam_resource_discovery_arn, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' + AND data__Identifier = '|' AND region = 'us-east-1' - ipam_resource_discovery_associations: - name: ipam_resource_discovery_associations - id: awscc.ec2.ipam_resource_discovery_associations - x-cfn-schema-name: IPAMResourceDiscoveryAssociation - x-type: list + local_gateway_routes_list_only: + name: local_gateway_routes_list_only + id: awscc.ec2.local_gateway_routes_list_only + x-cfn-schema-name: LocalGatewayRoute + x-cfn-type-name: AWS::EC2::LocalGatewayRoute x-identifiers: - - IpamResourceDiscoveryAssociationId + - DestinationCidrBlock + - LocalGatewayRouteTableId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9345,73 +20286,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' AND region = 'us-east-1' - ipam_resource_discovery_association: - name: ipam_resource_discovery_association - id: awscc.ec2.ipam_resource_discovery_association - x-cfn-schema-name: IPAMResourceDiscoveryAssociation - x-type: get + local_gateway_route_tables: + name: local_gateway_route_tables + id: awscc.ec2.local_gateway_route_tables + x-cfn-schema-name: LocalGatewayRouteTable + x-cfn-type-name: AWS::EC2::LocalGatewayRouteTable x-identifiers: - - IpamResourceDiscoveryAssociationId + - LocalGatewayRouteTableId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocalGatewayRouteTable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.IpamArn') as ipam_arn, - JSON_EXTRACT(Properties, '$.IpamRegion') as ipam_region, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id, - JSON_EXTRACT(Properties, '$.IpamId') as ipam_id, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationArn') as ipam_resource_discovery_association_arn, - JSON_EXTRACT(Properties, '$.IsDefault') as is_default, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableArn') as local_gateway_route_table_arn, + JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, + JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.ResourceDiscoveryStatus') as resource_discovery_status, + JSON_EXTRACT(Properties, '$.Mode') as mode, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamArn') as ipam_arn, - json_extract_path_text(Properties, 'IpamRegion') as ipam_region, - json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id, - json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, - json_extract_path_text(Properties, 'IpamId') as ipam_id, - json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationArn') as ipam_resource_discovery_association_arn, - json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, json_extract_path_text(Properties, 'OwnerId') as owner_id, json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'ResourceDiscoveryStatus') as resource_discovery_status, + json_extract_path_text(Properties, 'Mode') as mode, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' + AND data__Identifier = '' AND region = 'us-east-1' - ipam_scopes: - name: ipam_scopes - id: awscc.ec2.ipam_scopes - x-cfn-schema-name: IPAMScope - x-type: list + local_gateway_route_tables_list_only: + name: local_gateway_route_tables_list_only + id: awscc.ec2.local_gateway_route_tables_list_only + x-cfn-schema-name: LocalGatewayRouteTable + x-cfn-type-name: AWS::EC2::LocalGatewayRouteTable x-identifiers: - - IpamScopeId + - LocalGatewayRouteTableId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9419,69 +20410,121 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' AND region = 'us-east-1' - ipam_scope: - name: ipam_scope - id: awscc.ec2.ipam_scope - x-cfn-schema-name: IPAMScope - x-type: get + local_gateway_route_table_virtual_interface_group_associations: + name: local_gateway_route_table_virtual_interface_group_associations + id: awscc.ec2.local_gateway_route_table_virtual_interface_group_associations + x-cfn-schema-name: LocalGatewayRouteTableVirtualInterfaceGroupAssociation + x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation x-identifiers: - - IpamScopeId + - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocalGatewayRouteTableVirtualInterfaceGroupAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.IpamId') as ipam_id, - JSON_EXTRACT(Properties, '$.IpamArn') as ipam_arn, - JSON_EXTRACT(Properties, '$.IpamScopeType') as ipam_scope_type, - JSON_EXTRACT(Properties, '$.IsDefault') as is_default, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.PoolCount') as pool_count, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id, + JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableArn') as local_gateway_route_table_arn, + JSON_EXTRACT(Properties, '$.LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.State') as state, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMScope' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'IpamId') as ipam_id, - json_extract_path_text(Properties, 'IpamArn') as ipam_arn, - json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, - json_extract_path_text(Properties, 'IsDefault') as is_default, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PoolCount') as pool_count, + json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, + json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'State') as state, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMScope' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - key_pairs: - name: key_pairs - id: awscc.ec2.key_pairs - x-cfn-schema-name: KeyPair - x-type: list + local_gateway_route_table_virtual_interface_group_associations_list_only: + name: local_gateway_route_table_virtual_interface_group_associations_list_only + id: awscc.ec2.local_gateway_route_table_virtual_interface_group_associations_list_only + x-cfn-schema-name: LocalGatewayRouteTableVirtualInterfaceGroupAssociation + x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation x-identifiers: - - KeyName + - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9489,65 +20532,117 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.KeyName') as key_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'KeyName') as key_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' + json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' AND region = 'us-east-1' - key_pair: - name: key_pair - id: awscc.ec2.key_pair - x-cfn-schema-name: KeyPair - x-type: get + local_gateway_route_tablevpc_associations: + name: local_gateway_route_tablevpc_associations + id: awscc.ec2.local_gateway_route_tablevpc_associations + x-cfn-schema-name: LocalGatewayRouteTableVPCAssociation + x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVPCAssociation x-identifiers: - - KeyName + - LocalGatewayRouteTableVpcAssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocalGatewayRouteTableVPCAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTableVPCAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTableVPCAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::LocalGatewayRouteTableVPCAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.KeyName') as key_name, - JSON_EXTRACT(Properties, '$.KeyType') as key_type, - JSON_EXTRACT(Properties, '$.KeyFormat') as key_format, - JSON_EXTRACT(Properties, '$.PublicKeyMaterial') as public_key_material, - JSON_EXTRACT(Properties, '$.KeyFingerprint') as key_fingerprint, - JSON_EXTRACT(Properties, '$.KeyPairId') as key_pair_id, + JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::KeyPair' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'KeyName') as key_name, - json_extract_path_text(Properties, 'KeyType') as key_type, - json_extract_path_text(Properties, 'KeyFormat') as key_format, - json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, - json_extract_path_text(Properties, 'KeyFingerprint') as key_fingerprint, - json_extract_path_text(Properties, 'KeyPairId') as key_pair_id, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'VpcId') as vpc_id, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::KeyPair' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - network_interfaces: - name: network_interfaces - id: awscc.ec2.network_interfaces - x-cfn-schema-name: NetworkInterface - x-type: list + local_gateway_route_tablevpc_associations_list_only: + name: local_gateway_route_tablevpc_associations_list_only + id: awscc.ec2.local_gateway_route_tablevpc_associations_list_only + x-cfn-schema-name: LocalGatewayRouteTableVPCAssociation + x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVPCAssociation x-identifiers: - - Id + - LocalGatewayRouteTableVpcAssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9555,93 +20650,125 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' + json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' AND region = 'us-east-1' - network_interface: - name: network_interface - id: awscc.ec2.network_interface - x-cfn-schema-name: NetworkInterface - x-type: get + nat_gateways: + name: nat_gateways + id: awscc.ec2.nat_gateways + x-cfn-schema-name: NatGateway + x-cfn-type-name: AWS::EC2::NatGateway x-identifiers: - - Id + - NatGatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NatGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NatGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NatGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NatGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.SecondaryAllocationIds') as secondary_allocation_ids, JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, - JSON_EXTRACT(Properties, '$.PrivateIpAddresses') as private_ip_addresses, JSON_EXTRACT(Properties, '$.SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, - JSON_EXTRACT(Properties, '$.PrimaryPrivateIpAddress') as primary_private_ip_address, - JSON_EXTRACT(Properties, '$.Ipv4Prefixes') as ipv4_prefixes, - JSON_EXTRACT(Properties, '$.Ipv4PrefixCount') as ipv4_prefix_count, - JSON_EXTRACT(Properties, '$.GroupSet') as group_set, - JSON_EXTRACT(Properties, '$.Ipv6Addresses') as ipv6_addresses, - JSON_EXTRACT(Properties, '$.Ipv6Prefixes') as ipv6_prefixes, - JSON_EXTRACT(Properties, '$.Ipv6PrefixCount') as ipv6_prefix_count, + JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id, JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, - JSON_EXTRACT(Properties, '$.SourceDestCheck') as source_dest_check, - JSON_EXTRACT(Properties, '$.InterfaceType') as interface_type, + JSON_EXTRACT(Properties, '$.ConnectivityType') as connectivity_type, JSON_EXTRACT(Properties, '$.SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, - JSON_EXTRACT(Properties, '$.Ipv6AddressCount') as ipv6_address_count, - JSON_EXTRACT(Properties, '$.EnablePrimaryIpv6') as enable_primary_ipv6, - JSON_EXTRACT(Properties, '$.PrimaryIpv6Address') as primary_ipv6_address, - JSON_EXTRACT(Properties, '$.ConnectionTrackingSpecification') as connection_tracking_specification, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterface' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.MaxDrainDurationSeconds') as max_drain_duration_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NatGateway' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SecondaryAllocationIds') as secondary_allocation_ids, json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'PrivateIpAddresses') as private_ip_addresses, json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, - json_extract_path_text(Properties, 'PrimaryPrivateIpAddress') as primary_private_ip_address, - json_extract_path_text(Properties, 'Ipv4Prefixes') as ipv4_prefixes, - json_extract_path_text(Properties, 'Ipv4PrefixCount') as ipv4_prefix_count, - json_extract_path_text(Properties, 'GroupSet') as group_set, - json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, - json_extract_path_text(Properties, 'Ipv6Prefixes') as ipv6_prefixes, - json_extract_path_text(Properties, 'Ipv6PrefixCount') as ipv6_prefix_count, + json_extract_path_text(Properties, 'AllocationId') as allocation_id, json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, - json_extract_path_text(Properties, 'InterfaceType') as interface_type, + json_extract_path_text(Properties, 'ConnectivityType') as connectivity_type, json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, - json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, - json_extract_path_text(Properties, 'EnablePrimaryIpv6') as enable_primary_ipv6, - json_extract_path_text(Properties, 'PrimaryIpv6Address') as primary_ipv6_address, - json_extract_path_text(Properties, 'ConnectionTrackingSpecification') as connection_tracking_specification, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterface' - AND data__Identifier = '' + json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MaxDrainDurationSeconds') as max_drain_duration_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NatGateway' + AND data__Identifier = '' AND region = 'us-east-1' - launch_templates: - name: launch_templates - id: awscc.ec2.launch_templates - x-cfn-schema-name: LaunchTemplate - x-type: list + nat_gateways_list_only: + name: nat_gateways_list_only + id: awscc.ec2.nat_gateways_list_only + x-cfn-schema-name: NatGateway + x-cfn-type-name: AWS::EC2::NatGateway x-identifiers: - - LaunchTemplateId + - NatGatewayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9649,66 +20776,111 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LaunchTemplateId') as launch_template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' + JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' + json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' AND region = 'us-east-1' - launch_template: - name: launch_template - id: awscc.ec2.launch_template - x-cfn-schema-name: LaunchTemplate - x-type: get + network_acls: + name: network_acls + id: awscc.ec2.network_acls + x-cfn-schema-name: NetworkAcl + x-cfn-type-name: AWS::EC2::NetworkAcl x-identifiers: - - LaunchTemplateId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkAcl&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkAcl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkAcl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkAcl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LaunchTemplateName') as launch_template_name, - JSON_EXTRACT(Properties, '$.LaunchTemplateData') as launch_template_data, - JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, - JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications, - JSON_EXTRACT(Properties, '$.LatestVersionNumber') as latest_version_number, - JSON_EXTRACT(Properties, '$.LaunchTemplateId') as launch_template_id, - JSON_EXTRACT(Properties, '$.DefaultVersionNumber') as default_version_number - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LaunchTemplateName') as launch_template_name, - json_extract_path_text(Properties, 'LaunchTemplateData') as launch_template_data, - json_extract_path_text(Properties, 'VersionDescription') as version_description, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, - json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id, - json_extract_path_text(Properties, 'DefaultVersionNumber') as default_version_number - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' - AND data__Identifier = '' + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + AND data__Identifier = '' AND region = 'us-east-1' - local_gateway_routes: - name: local_gateway_routes - id: awscc.ec2.local_gateway_routes - x-cfn-schema-name: LocalGatewayRoute - x-type: list + network_acls_list_only: + name: network_acls_list_only + id: awscc.ec2.network_acls_list_only + x-cfn-schema-name: NetworkAcl + x-cfn-type-name: AWS::EC2::NetworkAcl x-identifiers: - - DestinationCidrBlock - - LocalGatewayRouteTableId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9716,66 +20888,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' AND region = 'us-east-1' - local_gateway_route: - name: local_gateway_route - id: awscc.ec2.local_gateway_route - x-cfn-schema-name: LocalGatewayRoute - x-type: get + network_insights_access_scopes: + name: network_insights_access_scopes + id: awscc.ec2.network_insights_access_scopes + x-cfn-schema-name: NetworkInsightsAccessScope + x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScope x-identifiers: - - DestinationCidrBlock - - LocalGatewayRouteTableId + - NetworkInsightsAccessScopeId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkInsightsAccessScope&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAccessScope" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAccessScope" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAccessScope" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, - JSON_EXTRACT(Properties, '$.LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, - JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.Type') as type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id, + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeArn') as network_insights_access_scope_arn, + JSON_EXTRACT(Properties, '$.CreatedDate') as created_date, + JSON_EXTRACT(Properties, '$.UpdatedDate') as updated_date, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.MatchPaths') as match_paths, + JSON_EXTRACT(Properties, '$.ExcludePaths') as exclude_paths + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Type') as type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeArn') as network_insights_access_scope_arn, + json_extract_path_text(Properties, 'CreatedDate') as created_date, + json_extract_path_text(Properties, 'UpdatedDate') as updated_date, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MatchPaths') as match_paths, + json_extract_path_text(Properties, 'ExcludePaths') as exclude_paths + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' + AND data__Identifier = '' AND region = 'us-east-1' - local_gateway_route_tables: - name: local_gateway_route_tables - id: awscc.ec2.local_gateway_route_tables - x-cfn-schema-name: LocalGatewayRouteTable - x-type: list + network_insights_access_scopes_list_only: + name: network_insights_access_scopes_list_only + id: awscc.ec2.network_insights_access_scopes_list_only + x-cfn-schema-name: NetworkInsightsAccessScope + x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScope x-identifiers: - - LocalGatewayRouteTableId + - NetworkInsightsAccessScopeId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9783,67 +21008,125 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' AND region = 'us-east-1' - local_gateway_route_table: - name: local_gateway_route_table - id: awscc.ec2.local_gateway_route_table - x-cfn-schema-name: LocalGatewayRouteTable - x-type: get + network_insights_access_scope_analyses: + name: network_insights_access_scope_analyses + id: awscc.ec2.network_insights_access_scope_analyses + x-cfn-schema-name: NetworkInsightsAccessScopeAnalysis + x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScopeAnalysis x-identifiers: - - LocalGatewayRouteTableId + - NetworkInsightsAccessScopeAnalysisId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkInsightsAccessScopeAnalysis&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAccessScopeAnalysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAccessScopeAnalysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAccessScopeAnalysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableArn') as local_gateway_route_table_arn, - JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, - JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, - JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, - JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.Mode') as mode, + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id, + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisArn') as network_insights_access_scope_analysis_arn, + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.StartDate') as start_date, + JSON_EXTRACT(Properties, '$.EndDate') as end_date, + JSON_EXTRACT(Properties, '$.FindingsFound') as findings_found, + JSON_EXTRACT(Properties, '$.AnalyzedEniCount') as analyzed_eni_count, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Mode') as mode, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisArn') as network_insights_access_scope_analysis_arn, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StartDate') as start_date, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'FindingsFound') as findings_found, + json_extract_path_text(Properties, 'AnalyzedEniCount') as analyzed_eni_count, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' + AND data__Identifier = '' AND region = 'us-east-1' - local_gateway_route_table_virtual_interface_group_associations: - name: local_gateway_route_table_virtual_interface_group_associations - id: awscc.ec2.local_gateway_route_table_virtual_interface_group_associations - x-cfn-schema-name: LocalGatewayRouteTableVirtualInterfaceGroupAssociation - x-type: list + network_insights_access_scope_analyses_list_only: + name: network_insights_access_scope_analyses_list_only + id: awscc.ec2.network_insights_access_scope_analyses_list_only + x-cfn-schema-name: NetworkInsightsAccessScopeAnalysis + x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScopeAnalysis x-identifiers: - - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId + - NetworkInsightsAccessScopeAnalysisId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9851,67 +21134,137 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' AND region = 'us-east-1' - local_gateway_route_table_virtual_interface_group_association: - name: local_gateway_route_table_virtual_interface_group_association - id: awscc.ec2.local_gateway_route_table_virtual_interface_group_association - x-cfn-schema-name: LocalGatewayRouteTableVirtualInterfaceGroupAssociation - x-type: get + network_insights_analyses: + name: network_insights_analyses + id: awscc.ec2.network_insights_analyses + x-cfn-schema-name: NetworkInsightsAnalysis + x-cfn-type-name: AWS::EC2::NetworkInsightsAnalysis x-identifiers: - - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId + - NetworkInsightsAnalysisId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkInsightsAnalysis&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAnalysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAnalysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsAnalysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id, - JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableArn') as local_gateway_route_table_arn, - JSON_EXTRACT(Properties, '$.LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, - JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, - JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.ReturnPathComponents') as return_path_components, + JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisId') as network_insights_analysis_id, + JSON_EXTRACT(Properties, '$.FilterOutArns') as filter_out_arns, + JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id, + JSON_EXTRACT(Properties, '$.NetworkPathFound') as network_path_found, + JSON_EXTRACT(Properties, '$.SuggestedAccounts') as suggested_accounts, + JSON_EXTRACT(Properties, '$.FilterInArns') as filter_in_arns, + JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisArn') as network_insights_analysis_arn, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.StartDate') as start_date, + JSON_EXTRACT(Properties, '$.AlternatePathHints') as alternate_path_hints, + JSON_EXTRACT(Properties, '$.Explanations') as explanations, + JSON_EXTRACT(Properties, '$.ForwardPathComponents') as forward_path_components, + JSON_EXTRACT(Properties, '$.AdditionalAccounts') as additional_accounts, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, - json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ReturnPathComponents') as return_path_components, + json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id, + json_extract_path_text(Properties, 'FilterOutArns') as filter_out_arns, + json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, + json_extract_path_text(Properties, 'NetworkPathFound') as network_path_found, + json_extract_path_text(Properties, 'SuggestedAccounts') as suggested_accounts, + json_extract_path_text(Properties, 'FilterInArns') as filter_in_arns, + json_extract_path_text(Properties, 'NetworkInsightsAnalysisArn') as network_insights_analysis_arn, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StartDate') as start_date, + json_extract_path_text(Properties, 'AlternatePathHints') as alternate_path_hints, + json_extract_path_text(Properties, 'Explanations') as explanations, + json_extract_path_text(Properties, 'ForwardPathComponents') as forward_path_components, + json_extract_path_text(Properties, 'AdditionalAccounts') as additional_accounts, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' + AND data__Identifier = '' AND region = 'us-east-1' - local_gateway_route_tablevpc_associations: - name: local_gateway_route_tablevpc_associations - id: awscc.ec2.local_gateway_route_tablevpc_associations - x-cfn-schema-name: LocalGatewayRouteTableVPCAssociation - x-type: list + network_insights_analyses_list_only: + name: network_insights_analyses_list_only + id: awscc.ec2.network_insights_analyses_list_only + x-cfn-schema-name: NetworkInsightsAnalysis + x-cfn-type-name: AWS::EC2::NetworkInsightsAnalysis x-identifiers: - - LocalGatewayRouteTableVpcAssociationId + - NetworkInsightsAnalysisId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9919,63 +21272,133 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' + JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisId') as network_insights_analysis_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' + json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' AND region = 'us-east-1' - local_gateway_route_tablevpc_association: - name: local_gateway_route_tablevpc_association - id: awscc.ec2.local_gateway_route_tablevpc_association - x-cfn-schema-name: LocalGatewayRouteTableVPCAssociation - x-type: get + network_insights_paths: + name: network_insights_paths + id: awscc.ec2.network_insights_paths + x-cfn-schema-name: NetworkInsightsPath + x-cfn-type-name: AWS::EC2::NetworkInsightsPath x-identifiers: - - LocalGatewayRouteTableVpcAssociationId + - NetworkInsightsPathId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkInsightsPath&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsPath" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsPath" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInsightsPath" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id, - JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id, + JSON_EXTRACT(Properties, '$.NetworkInsightsPathArn') as network_insights_path_arn, + JSON_EXTRACT(Properties, '$.CreatedDate') as created_date, + JSON_EXTRACT(Properties, '$.SourceIp') as source_ip, + JSON_EXTRACT(Properties, '$.FilterAtSource') as filter_at_source, + JSON_EXTRACT(Properties, '$.FilterAtDestination') as filter_at_destination, + JSON_EXTRACT(Properties, '$.DestinationIp') as destination_ip, + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.Destination') as destination, + JSON_EXTRACT(Properties, '$.SourceArn') as source_arn, + JSON_EXTRACT(Properties, '$.DestinationArn') as destination_arn, + JSON_EXTRACT(Properties, '$.Protocol') as protocol, + JSON_EXTRACT(Properties, '$.DestinationPort') as destination_port, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, + json_extract_path_text(Properties, 'NetworkInsightsPathArn') as network_insights_path_arn, + json_extract_path_text(Properties, 'CreatedDate') as created_date, + json_extract_path_text(Properties, 'SourceIp') as source_ip, + json_extract_path_text(Properties, 'FilterAtSource') as filter_at_source, + json_extract_path_text(Properties, 'FilterAtDestination') as filter_at_destination, + json_extract_path_text(Properties, 'DestinationIp') as destination_ip, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'DestinationArn') as destination_arn, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'DestinationPort') as destination_port, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' + AND data__Identifier = '' AND region = 'us-east-1' - nat_gateways: - name: nat_gateways - id: awscc.ec2.nat_gateways - x-cfn-schema-name: NatGateway - x-type: list + network_insights_paths_list_only: + name: network_insights_paths_list_only + id: awscc.ec2.network_insights_paths_list_only + x-cfn-schema-name: NetworkInsightsPath + x-cfn-type-name: AWS::EC2::NetworkInsightsPath x-identifiers: - - NatGatewayId + - NetworkInsightsPathId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -9983,71 +21406,117 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' + JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' + json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' AND region = 'us-east-1' - nat_gateway: - name: nat_gateway - id: awscc.ec2.nat_gateway - x-cfn-schema-name: NatGateway - x-type: get + network_interface_attachments: + name: network_interface_attachments + id: awscc.ec2.network_interface_attachments + x-cfn-schema-name: NetworkInterfaceAttachment + x-cfn-type-name: AWS::EC2::NetworkInterfaceAttachment x-identifiers: - - NatGatewayId + - AttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkInterfaceAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInterfaceAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInterfaceAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkInterfaceAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, - JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id, - JSON_EXTRACT(Properties, '$.ConnectivityType') as connectivity_type, - JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id, - JSON_EXTRACT(Properties, '$.SecondaryAllocationIds') as secondary_allocation_ids, - JSON_EXTRACT(Properties, '$.SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, - JSON_EXTRACT(Properties, '$.SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, - JSON_EXTRACT(Properties, '$.MaxDrainDurationSeconds') as max_drain_duration_seconds - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NatGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id, + JSON_EXTRACT(Properties, '$.DeleteOnTermination') as delete_on_termination, + JSON_EXTRACT(Properties, '$.DeviceIndex') as device_index, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, + JSON_EXTRACT(Properties, '$.EnaSrdSpecification') as ena_srd_specification + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, - json_extract_path_text(Properties, 'ConnectivityType') as connectivity_type, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AllocationId') as allocation_id, - json_extract_path_text(Properties, 'SecondaryAllocationIds') as secondary_allocation_ids, - json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, - json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, - json_extract_path_text(Properties, 'MaxDrainDurationSeconds') as max_drain_duration_seconds - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NatGateway' - AND data__Identifier = '' + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'DeleteOnTermination') as delete_on_termination, + json_extract_path_text(Properties, 'DeviceIndex') as device_index, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'EnaSrdSpecification') as ena_srd_specification + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' + AND data__Identifier = '' AND region = 'us-east-1' - network_acls: - name: network_acls - id: awscc.ec2.network_acls - x-cfn-schema-name: NetworkAcl - x-type: list + network_interface_attachments_list_only: + name: network_interface_attachments_list_only + id: awscc.ec2.network_interface_attachments_list_only + x-cfn-schema-name: NetworkInterfaceAttachment + x-cfn-type-name: AWS::EC2::NetworkInterfaceAttachment x-identifiers: - - Id + - AttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10055,57 +21524,106 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' AND region = 'us-east-1' - network_acl: - name: network_acl - id: awscc.ec2.network_acl - x-cfn-schema-name: NetworkAcl - x-type: get + network_performance_metric_subscriptions: + name: network_performance_metric_subscriptions + id: awscc.ec2.network_performance_metric_subscriptions + x-cfn-schema-name: NetworkPerformanceMetricSubscription + x-cfn-type-name: AWS::EC2::NetworkPerformanceMetricSubscription x-identifiers: - - Id + - Source + - Destination + - Metric + - Statistic + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkPerformanceMetricSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkPerformanceMetricSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkPerformanceMetricSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_performance_metric_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_performance_metric_subscriptions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.Destination') as destination, + JSON_EXTRACT(Properties, '$.Metric') as metric, + JSON_EXTRACT(Properties, '$.Statistic') as statistic + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + AND data__Identifier = '|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'Metric') as metric, + json_extract_path_text(Properties, 'Statistic') as statistic + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + AND data__Identifier = '|||' AND region = 'us-east-1' - network_insights_access_scopes: - name: network_insights_access_scopes - id: awscc.ec2.network_insights_access_scopes - x-cfn-schema-name: NetworkInsightsAccessScope - x-type: list + network_performance_metric_subscriptions_list_only: + name: network_performance_metric_subscriptions_list_only + id: awscc.ec2.network_performance_metric_subscriptions_list_only + x-cfn-schema-name: NetworkPerformanceMetricSubscription + x-cfn-type-name: AWS::EC2::NetworkPerformanceMetricSubscription x-identifiers: - - NetworkInsightsAccessScopeId + - Source + - Destination + - Metric + - Statistic + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10113,65 +21631,108 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.Destination') as destination, + JSON_EXTRACT(Properties, '$.Metric') as metric, + JSON_EXTRACT(Properties, '$.Statistic') as statistic + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'Metric') as metric, + json_extract_path_text(Properties, 'Statistic') as statistic + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' AND region = 'us-east-1' - network_insights_access_scope: - name: network_insights_access_scope - id: awscc.ec2.network_insights_access_scope - x-cfn-schema-name: NetworkInsightsAccessScope - x-type: get + placement_groups: + name: placement_groups + id: awscc.ec2.placement_groups + x-cfn-schema-name: PlacementGroup + x-cfn-type-name: AWS::EC2::PlacementGroup x-identifiers: - - NetworkInsightsAccessScopeId + - GroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PlacementGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::PlacementGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::PlacementGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/placement_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/placement_groups/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeArn') as network_insights_access_scope_arn, - JSON_EXTRACT(Properties, '$.CreatedDate') as created_date, - JSON_EXTRACT(Properties, '$.UpdatedDate') as updated_date, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.MatchPaths') as match_paths, - JSON_EXTRACT(Properties, '$.ExcludePaths') as exclude_paths - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Strategy') as strategy, + JSON_EXTRACT(Properties, '$.GroupName') as group_name, + JSON_EXTRACT(Properties, '$.SpreadLevel') as spread_level, + JSON_EXTRACT(Properties, '$.PartitionCount') as partition_count, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PlacementGroup' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeArn') as network_insights_access_scope_arn, - json_extract_path_text(Properties, 'CreatedDate') as created_date, - json_extract_path_text(Properties, 'UpdatedDate') as updated_date, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'MatchPaths') as match_paths, - json_extract_path_text(Properties, 'ExcludePaths') as exclude_paths - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Strategy') as strategy, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'SpreadLevel') as spread_level, + json_extract_path_text(Properties, 'PartitionCount') as partition_count, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PlacementGroup' + AND data__Identifier = '' AND region = 'us-east-1' - network_insights_access_scope_analyses: - name: network_insights_access_scope_analyses - id: awscc.ec2.network_insights_access_scope_analyses - x-cfn-schema-name: NetworkInsightsAccessScopeAnalysis - x-type: list + placement_groups_list_only: + name: placement_groups_list_only + id: awscc.ec2.placement_groups_list_only + x-cfn-schema-name: PlacementGroup + x-cfn-type-name: AWS::EC2::PlacementGroup x-identifiers: - - NetworkInsightsAccessScopeAnalysisId + - GroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10179,71 +21740,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' + json_extract_path_text(Properties, 'GroupName') as group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' AND region = 'us-east-1' - network_insights_access_scope_analysis: - name: network_insights_access_scope_analysis - id: awscc.ec2.network_insights_access_scope_analysis - x-cfn-schema-name: NetworkInsightsAccessScopeAnalysis - x-type: get + prefix_lists: + name: prefix_lists + id: awscc.ec2.prefix_lists + x-cfn-schema-name: PrefixList + x-cfn-type-name: AWS::EC2::PrefixList x-identifiers: - - NetworkInsightsAccessScopeAnalysisId + - PrefixListId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PrefixList&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::PrefixList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::PrefixList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::PrefixList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisArn') as network_insights_access_scope_analysis_arn, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, - JSON_EXTRACT(Properties, '$.StartDate') as start_date, - JSON_EXTRACT(Properties, '$.EndDate') as end_date, - JSON_EXTRACT(Properties, '$.FindingsFound') as findings_found, - JSON_EXTRACT(Properties, '$.AnalyzedEniCount') as analyzed_eni_count, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PrefixListName') as prefix_list_name, + JSON_EXTRACT(Properties, '$.PrefixListId') as prefix_list_id, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.AddressFamily') as address_family, + JSON_EXTRACT(Properties, '$.MaxEntries') as max_entries, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Entries') as entries, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PrefixList' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisArn') as network_insights_access_scope_analysis_arn, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StartDate') as start_date, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'FindingsFound') as findings_found, - json_extract_path_text(Properties, 'AnalyzedEniCount') as analyzed_eni_count, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' - AND data__Identifier = '' + json_extract_path_text(Properties, 'PrefixListName') as prefix_list_name, + json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'AddressFamily') as address_family, + json_extract_path_text(Properties, 'MaxEntries') as max_entries, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Entries') as entries, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PrefixList' + AND data__Identifier = '' AND region = 'us-east-1' - network_insights_analyses: - name: network_insights_analyses - id: awscc.ec2.network_insights_analyses - x-cfn-schema-name: NetworkInsightsAnalysis - x-type: list + prefix_lists_list_only: + name: prefix_lists_list_only + id: awscc.ec2.prefix_lists_list_only + x-cfn-schema-name: PrefixList + x-cfn-type-name: AWS::EC2::PrefixList x-identifiers: - - NetworkInsightsAnalysisId + - PrefixListId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10251,81 +21864,139 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisId') as network_insights_analysis_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' + JSON_EXTRACT(Properties, '$.PrefixListId') as prefix_list_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' + json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' AND region = 'us-east-1' - network_insights_analysis: - name: network_insights_analysis - id: awscc.ec2.network_insights_analysis - x-cfn-schema-name: NetworkInsightsAnalysis - x-type: get + routes: + name: routes + id: awscc.ec2.routes + x-cfn-schema-name: Route + x-cfn-type-name: AWS::EC2::Route x-identifiers: - - NetworkInsightsAnalysisId + - RouteTableId + - CidrBlock + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Route&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.ReturnPathComponents') as return_path_components, - JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisId') as network_insights_analysis_id, - JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id, - JSON_EXTRACT(Properties, '$.NetworkPathFound') as network_path_found, - JSON_EXTRACT(Properties, '$.SuggestedAccounts') as suggested_accounts, - JSON_EXTRACT(Properties, '$.FilterInArns') as filter_in_arns, - JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisArn') as network_insights_analysis_arn, - JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, - JSON_EXTRACT(Properties, '$.StartDate') as start_date, - JSON_EXTRACT(Properties, '$.AlternatePathHints') as alternate_path_hints, - JSON_EXTRACT(Properties, '$.Explanations') as explanations, - JSON_EXTRACT(Properties, '$.ForwardPathComponents') as forward_path_components, - JSON_EXTRACT(Properties, '$.AdditionalAccounts') as additional_accounts, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id, + JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block, + JSON_EXTRACT(Properties, '$.CoreNetworkArn') as core_network_arn, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.DestinationIpv6CidrBlock') as destination_ipv6_cidr_block, + JSON_EXTRACT(Properties, '$.DestinationPrefixListId') as destination_prefix_list_id, + JSON_EXTRACT(Properties, '$.EgressOnlyInternetGatewayId') as egress_only_internet_gateway_id, + JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, + JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, + JSON_EXTRACT(Properties, '$.VpcEndpointId') as vpc_endpoint_id, + JSON_EXTRACT(Properties, '$.VpcPeeringConnectionId') as vpc_peering_connection_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Route' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ReturnPathComponents') as return_path_components, - json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id, - json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, - json_extract_path_text(Properties, 'NetworkPathFound') as network_path_found, - json_extract_path_text(Properties, 'SuggestedAccounts') as suggested_accounts, - json_extract_path_text(Properties, 'FilterInArns') as filter_in_arns, - json_extract_path_text(Properties, 'NetworkInsightsAnalysisArn') as network_insights_analysis_arn, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StartDate') as start_date, - json_extract_path_text(Properties, 'AlternatePathHints') as alternate_path_hints, - json_extract_path_text(Properties, 'Explanations') as explanations, - json_extract_path_text(Properties, 'ForwardPathComponents') as forward_path_components, - json_extract_path_text(Properties, 'AdditionalAccounts') as additional_accounts, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' - AND data__Identifier = '' + json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'DestinationIpv6CidrBlock') as destination_ipv6_cidr_block, + json_extract_path_text(Properties, 'DestinationPrefixListId') as destination_prefix_list_id, + json_extract_path_text(Properties, 'EgressOnlyInternetGatewayId') as egress_only_internet_gateway_id, + json_extract_path_text(Properties, 'GatewayId') as gateway_id, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id, + json_extract_path_text(Properties, 'VpcPeeringConnectionId') as vpc_peering_connection_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Route' + AND data__Identifier = '|' AND region = 'us-east-1' - network_insights_paths: - name: network_insights_paths - id: awscc.ec2.network_insights_paths - x-cfn-schema-name: NetworkInsightsPath - x-type: list + routes_list_only: + name: routes_list_only + id: awscc.ec2.routes_list_only + x-cfn-schema-name: Route + x-cfn-type-name: AWS::EC2::Route x-identifiers: - - NetworkInsightsPathId + - RouteTableId + - CidrBlock + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10333,79 +22004,121 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, + JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' AND region = 'us-east-1' - network_insights_path: - name: network_insights_path - id: awscc.ec2.network_insights_path - x-cfn-schema-name: NetworkInsightsPath - x-type: get + route_servers: + name: route_servers + id: awscc.ec2.route_servers + x-cfn-schema-name: RouteServer + x-cfn-type-name: AWS::EC2::RouteServer x-identifiers: - - NetworkInsightsPathId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteServer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_servers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_servers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/route_servers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id, - JSON_EXTRACT(Properties, '$.NetworkInsightsPathArn') as network_insights_path_arn, - JSON_EXTRACT(Properties, '$.CreatedDate') as created_date, - JSON_EXTRACT(Properties, '$.SourceIp') as source_ip, - JSON_EXTRACT(Properties, '$.FilterAtSource') as filter_at_source, - JSON_EXTRACT(Properties, '$.FilterAtDestination') as filter_at_destination, - JSON_EXTRACT(Properties, '$.DestinationIp') as destination_ip, - JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.Destination') as destination, - JSON_EXTRACT(Properties, '$.SourceArn') as source_arn, - JSON_EXTRACT(Properties, '$.DestinationArn') as destination_arn, - JSON_EXTRACT(Properties, '$.Protocol') as protocol, - JSON_EXTRACT(Properties, '$.DestinationPort') as destination_port, + JSON_EXTRACT(Properties, '$.AmazonSideAsn') as amazon_side_asn, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.PersistRoutes') as persist_routes, + JSON_EXTRACT(Properties, '$.PersistRoutesDuration') as persist_routes_duration, + JSON_EXTRACT(Properties, '$.SnsNotificationsEnabled') as sns_notifications_enabled, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServer' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, - json_extract_path_text(Properties, 'NetworkInsightsPathArn') as network_insights_path_arn, - json_extract_path_text(Properties, 'CreatedDate') as created_date, - json_extract_path_text(Properties, 'SourceIp') as source_ip, - json_extract_path_text(Properties, 'FilterAtSource') as filter_at_source, - json_extract_path_text(Properties, 'FilterAtDestination') as filter_at_destination, - json_extract_path_text(Properties, 'DestinationIp') as destination_ip, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'DestinationArn') as destination_arn, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'DestinationPort') as destination_port, + json_extract_path_text(Properties, 'AmazonSideAsn') as amazon_side_asn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PersistRoutes') as persist_routes, + json_extract_path_text(Properties, 'PersistRoutesDuration') as persist_routes_duration, + json_extract_path_text(Properties, 'SnsNotificationsEnabled') as sns_notifications_enabled, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServer' + AND data__Identifier = '' AND region = 'us-east-1' - network_interface_attachments: - name: network_interface_attachments - id: awscc.ec2.network_interface_attachments - x-cfn-schema-name: NetworkInterfaceAttachment - x-type: list + route_servers_list_only: + name: route_servers_list_only + id: awscc.ec2.route_servers_list_only + x-cfn-schema-name: RouteServer + x-cfn-type-name: AWS::EC2::RouteServer x-identifiers: - - AttachmentId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10413,66 +22126,98 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServer' AND region = 'us-east-1' - network_interface_attachment: - name: network_interface_attachment - id: awscc.ec2.network_interface_attachment - x-cfn-schema-name: NetworkInterfaceAttachment - x-type: get + route_server_associations: + name: route_server_associations + id: awscc.ec2.route_server_associations + x-cfn-schema-name: RouteServerAssociation + x-cfn-type-name: AWS::EC2::RouteServerAssociation x-identifiers: - - AttachmentId + - RouteServerId + - VpcId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteServerAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_server_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_server_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id, - JSON_EXTRACT(Properties, '$.DeleteOnTermination') as delete_on_termination, - JSON_EXTRACT(Properties, '$.DeviceIndex') as device_index, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, - JSON_EXTRACT(Properties, '$.EnaSrdSpecification') as ena_srd_specification - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RouteServerId') as route_server_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id, - json_extract_path_text(Properties, 'DeleteOnTermination') as delete_on_termination, - json_extract_path_text(Properties, 'DeviceIndex') as device_index, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'EnaSrdSpecification') as ena_srd_specification - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' - AND data__Identifier = '' + json_extract_path_text(Properties, 'RouteServerId') as route_server_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' - network_performance_metric_subscriptions: - name: network_performance_metric_subscriptions - id: awscc.ec2.network_performance_metric_subscriptions - x-cfn-schema-name: NetworkPerformanceMetricSubscription - x-type: list + route_server_associations_list_only: + name: route_server_associations_list_only + id: awscc.ec2.route_server_associations_list_only + x-cfn-schema-name: RouteServerAssociation + x-cfn-type-name: AWS::EC2::RouteServerAssociation x-identifiers: - - Source - - Destination - - Metric - - Statistic + - RouteServerId + - VpcId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10480,68 +22225,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.Destination') as destination, - JSON_EXTRACT(Properties, '$.Metric') as metric, - JSON_EXTRACT(Properties, '$.Statistic') as statistic - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + JSON_EXTRACT(Properties, '$.RouteServerId') as route_server_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'Metric') as metric, - json_extract_path_text(Properties, 'Statistic') as statistic - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + json_extract_path_text(Properties, 'RouteServerId') as route_server_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerAssociation' AND region = 'us-east-1' - network_performance_metric_subscription: - name: network_performance_metric_subscription - id: awscc.ec2.network_performance_metric_subscription - x-cfn-schema-name: NetworkPerformanceMetricSubscription - x-type: get + route_server_endpoints: + name: route_server_endpoints + id: awscc.ec2.route_server_endpoints + x-cfn-schema-name: RouteServerEndpoint + x-cfn-type-name: AWS::EC2::RouteServerEndpoint x-identifiers: - - Source - - Destination - - Metric - - Statistic + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteServerEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_server_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_server_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/route_server_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.Destination') as destination, - JSON_EXTRACT(Properties, '$.Metric') as metric, - JSON_EXTRACT(Properties, '$.Statistic') as statistic - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' - AND data__Identifier = '|||' + JSON_EXTRACT(Properties, '$.RouteServerId') as route_server_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.EniId') as eni_id, + JSON_EXTRACT(Properties, '$.EniAddress') as eni_address, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerEndpoint' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'Metric') as metric, - json_extract_path_text(Properties, 'Statistic') as statistic - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' - AND data__Identifier = '|||' + json_extract_path_text(Properties, 'RouteServerId') as route_server_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'EniId') as eni_id, + json_extract_path_text(Properties, 'EniAddress') as eni_address, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerEndpoint' + AND data__Identifier = '' AND region = 'us-east-1' - placement_groups: - name: placement_groups - id: awscc.ec2.placement_groups - x-cfn-schema-name: PlacementGroup - x-type: list + route_server_endpoints_list_only: + name: route_server_endpoints_list_only + id: awscc.ec2.route_server_endpoints_list_only + x-cfn-schema-name: RouteServerEndpoint + x-cfn-type-name: AWS::EC2::RouteServerEndpoint x-identifiers: - - GroupName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10549,61 +22349,127 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerEndpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT - region, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerEndpoint' AND region = 'us-east-1' - placement_group: - name: placement_group - id: awscc.ec2.placement_group - x-cfn-schema-name: PlacementGroup - x-type: get + route_server_peers: + name: route_server_peers + id: awscc.ec2.route_server_peers + x-cfn-schema-name: RouteServerPeer + x-cfn-type-name: AWS::EC2::RouteServerPeer x-identifiers: - - GroupName + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteServerPeer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_server_peers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_server_peers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/route_server_peers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Strategy') as strategy, - JSON_EXTRACT(Properties, '$.GroupName') as group_name, - JSON_EXTRACT(Properties, '$.SpreadLevel') as spread_level, - JSON_EXTRACT(Properties, '$.PartitionCount') as partition_count, + JSON_EXTRACT(Properties, '$.RouteServerId') as route_server_id, + JSON_EXTRACT(Properties, '$.RouteServerEndpointId') as route_server_endpoint_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.EndpointEniId') as endpoint_eni_id, + JSON_EXTRACT(Properties, '$.EndpointEniAddress') as endpoint_eni_address, + JSON_EXTRACT(Properties, '$.PeerAddress') as peer_address, + JSON_EXTRACT(Properties, '$.BgpOptions') as bgp_options, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PlacementGroup' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerPeer' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Strategy') as strategy, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'SpreadLevel') as spread_level, - json_extract_path_text(Properties, 'PartitionCount') as partition_count, + json_extract_path_text(Properties, 'RouteServerId') as route_server_id, + json_extract_path_text(Properties, 'RouteServerEndpointId') as route_server_endpoint_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'EndpointEniId') as endpoint_eni_id, + json_extract_path_text(Properties, 'EndpointEniAddress') as endpoint_eni_address, + json_extract_path_text(Properties, 'PeerAddress') as peer_address, + json_extract_path_text(Properties, 'BgpOptions') as bgp_options, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PlacementGroup' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerPeer' + AND data__Identifier = '' AND region = 'us-east-1' - prefix_lists: - name: prefix_lists - id: awscc.ec2.prefix_lists - x-cfn-schema-name: PrefixList - x-type: list + route_server_peers_list_only: + name: route_server_peers_list_only + id: awscc.ec2.route_server_peers_list_only + x-cfn-schema-name: RouteServerPeer + x-cfn-type-name: AWS::EC2::RouteServerPeer x-identifiers: - - PrefixListId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10611,70 +22477,98 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PrefixListId') as prefix_list_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerPeer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerPeer' AND region = 'us-east-1' - prefix_list: - name: prefix_list - id: awscc.ec2.prefix_list - x-cfn-schema-name: PrefixList - x-type: get + route_server_propagations: + name: route_server_propagations + id: awscc.ec2.route_server_propagations + x-cfn-schema-name: RouteServerPropagation + x-cfn-type-name: AWS::EC2::RouteServerPropagation x-identifiers: - - PrefixListId + - RouteServerId + - RouteTableId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteServerPropagation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerPropagation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteServerPropagation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_server_propagations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_server_propagations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.PrefixListName') as prefix_list_name, - JSON_EXTRACT(Properties, '$.PrefixListId') as prefix_list_id, - JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, - JSON_EXTRACT(Properties, '$.AddressFamily') as address_family, - JSON_EXTRACT(Properties, '$.MaxEntries') as max_entries, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Entries') as entries, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PrefixList' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RouteServerId') as route_server_id, + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerPropagation' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'PrefixListName') as prefix_list_name, - json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'AddressFamily') as address_family, - json_extract_path_text(Properties, 'MaxEntries') as max_entries, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Entries') as entries, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PrefixList' - AND data__Identifier = '' + json_extract_path_text(Properties, 'RouteServerId') as route_server_id, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteServerPropagation' + AND data__Identifier = '|' AND region = 'us-east-1' - routes: - name: routes - id: awscc.ec2.routes - x-cfn-schema-name: Route - x-type: list + route_server_propagations_list_only: + name: route_server_propagations_list_only + id: awscc.ec2.route_server_propagations_list_only + x-cfn-schema-name: RouteServerPropagation + x-cfn-type-name: AWS::EC2::RouteServerPropagation x-identifiers: + - RouteServerId - RouteTableId - - CidrBlock + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10682,86 +22576,113 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, - JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' + JSON_EXTRACT(Properties, '$.RouteServerId') as route_server_id, + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerPropagation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' + json_extract_path_text(Properties, 'RouteServerId') as route_server_id, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteServerPropagation' AND region = 'us-east-1' - route: - name: route - id: awscc.ec2.route - x-cfn-schema-name: Route - x-type: get + route_tables: + name: route_tables + id: awscc.ec2.route_tables + x-cfn-schema-name: RouteTable + x-cfn-type-name: AWS::EC2::RouteTable x-identifiers: - RouteTableId - - CidrBlock + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteTable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::RouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id, - JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block, - JSON_EXTRACT(Properties, '$.CoreNetworkArn') as core_network_arn, - JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, - JSON_EXTRACT(Properties, '$.DestinationIpv6CidrBlock') as destination_ipv6_cidr_block, - JSON_EXTRACT(Properties, '$.DestinationPrefixListId') as destination_prefix_list_id, - JSON_EXTRACT(Properties, '$.EgressOnlyInternetGatewayId') as egress_only_internet_gateway_id, - JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.LocalGatewayId') as local_gateway_id, - JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, - JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, - JSON_EXTRACT(Properties, '$.VpcEndpointId') as vpc_endpoint_id, - JSON_EXTRACT(Properties, '$.VpcPeeringConnectionId') as vpc_peering_connection_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Route' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteTable' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'DestinationIpv6CidrBlock') as destination_ipv6_cidr_block, - json_extract_path_text(Properties, 'DestinationPrefixListId') as destination_prefix_list_id, - json_extract_path_text(Properties, 'EgressOnlyInternetGatewayId') as egress_only_internet_gateway_id, - json_extract_path_text(Properties, 'GatewayId') as gateway_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id, - json_extract_path_text(Properties, 'VpcPeeringConnectionId') as vpc_peering_connection_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Route' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteTable' + AND data__Identifier = '' AND region = 'us-east-1' - route_tables: - name: route_tables - id: awscc.ec2.route_tables + route_tables_list_only: + name: route_tables_list_only + id: awscc.ec2.route_tables_list_only x-cfn-schema-name: RouteTable - x-type: list + x-cfn-type-name: AWS::EC2::RouteTable x-identifiers: - RouteTableId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10780,46 +22701,110 @@ components: json_extract_path_text(Properties, 'RouteTableId') as route_table_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteTable' AND region = 'us-east-1' - route_table: - name: route_table - id: awscc.ec2.route_table - x-cfn-schema-name: RouteTable - x-type: get + security_groups: + name: security_groups + id: awscc.ec2.security_groups + x-cfn-schema-name: SecurityGroup + x-cfn-type-name: AWS::EC2::SecurityGroup x-identifiers: - - RouteTableId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, + JSON_EXTRACT(Properties, '$.GroupDescription') as group_description, + JSON_EXTRACT(Properties, '$.GroupName') as group_name, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.SecurityGroupIngress') as security_group_ingress, + JSON_EXTRACT(Properties, '$.SecurityGroupEgress') as security_group_egress, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GroupId') as group_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroup' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'GroupDescription') as group_description, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SecurityGroupIngress') as security_group_ingress, + json_extract_path_text(Properties, 'SecurityGroupEgress') as security_group_egress, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteTable' - AND data__Identifier = '' + json_extract_path_text(Properties, 'GroupId') as group_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroup' + AND data__Identifier = '' AND region = 'us-east-1' - security_group_egresses: - name: security_group_egresses - id: awscc.ec2.security_group_egresses - x-cfn-schema-name: SecurityGroupEgress - x-type: list + security_groups_list_only: + name: security_groups_list_only + id: awscc.ec2.security_groups_list_only + x-cfn-schema-name: SecurityGroup + x-cfn-type-name: AWS::EC2::SecurityGroup x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10828,7 +22813,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -10836,19 +22821,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroup' AND region = 'us-east-1' - security_group_egress: - name: security_group_egress - id: awscc.ec2.security_group_egress + security_group_egresses: + name: security_group_egresses + id: awscc.ec2.security_group_egresses x-cfn-schema-name: SecurityGroupEgress - x-type: get + x-cfn-type-name: AWS::EC2::SecurityGroupEgress x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityGroupEgress&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupEgress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupEgress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupEgress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -10867,7 +22900,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -10885,13 +22918,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' AND data__Identifier = '' AND region = 'us-east-1' - security_group_ingresses: - name: security_group_ingresses - id: awscc.ec2.security_group_ingresses - x-cfn-schema-name: SecurityGroupIngress - x-type: list + security_group_egresses_list_only: + name: security_group_egresses_list_only + id: awscc.ec2.security_group_egresses_list_only + x-cfn-schema-name: SecurityGroupEgress + x-cfn-type-name: AWS::EC2::SecurityGroupEgress x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10900,7 +22939,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -10908,19 +22947,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' AND region = 'us-east-1' - security_group_ingress: - name: security_group_ingress - id: awscc.ec2.security_group_ingress + security_group_ingresses: + name: security_group_ingresses + id: awscc.ec2.security_group_ingresses x-cfn-schema-name: SecurityGroupIngress - x-type: get + x-cfn-type-name: AWS::EC2::SecurityGroupIngress x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityGroupIngress&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupIngress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupIngress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupIngress" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -10942,7 +23029,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -10963,13 +23050,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' AND data__Identifier = '' AND region = 'us-east-1' - snapshot_block_public_accesses: - name: snapshot_block_public_accesses - id: awscc.ec2.snapshot_block_public_accesses - x-cfn-schema-name: SnapshotBlockPublicAccess - x-type: list + security_group_ingresses_list_only: + name: security_group_ingresses_list_only + id: awscc.ec2.security_group_ingresses_list_only + x-cfn-schema-name: SecurityGroupIngress + x-cfn-type-name: AWS::EC2::SecurityGroupIngress x-identifiers: - - AccountId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -10977,28 +23070,183 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' + AND region = 'us-east-1' + security_group_vpc_associations: + name: security_group_vpc_associations + id: awscc.ec2.security_group_vpc_associations + x-cfn-schema-name: SecurityGroupVpcAssociation + x-cfn-type-name: AWS::EC2::SecurityGroupVpcAssociation + x-identifiers: + - GroupId + - VpcId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityGroupVpcAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupVpcAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SecurityGroupVpcAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_group_vpc_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_group_vpc_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.GroupId') as group_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.VpcOwnerId') as vpc_owner_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.StateReason') as state_reason + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupVpcAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'VpcOwnerId') as vpc_owner_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'StateReason') as state_reason + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupVpcAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + security_group_vpc_associations_list_only: + name: security_group_vpc_associations_list_only + id: awscc.ec2.security_group_vpc_associations_list_only + x-cfn-schema-name: SecurityGroupVpcAssociation + x-cfn-type-name: AWS::EC2::SecurityGroupVpcAssociation + x-identifiers: + - GroupId + - VpcId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.GroupId') as group_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupVpcAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupVpcAssociation' AND region = 'us-east-1' - snapshot_block_public_access: - name: snapshot_block_public_access - id: awscc.ec2.snapshot_block_public_access + snapshot_block_public_accesses: + name: snapshot_block_public_accesses + id: awscc.ec2.snapshot_block_public_accesses x-cfn-schema-name: SnapshotBlockPublicAccess - x-type: get + x-cfn-type-name: AWS::EC2::SnapshotBlockPublicAccess x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SnapshotBlockPublicAccess&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SnapshotBlockPublicAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SnapshotBlockPublicAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SnapshotBlockPublicAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11009,7 +23257,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11019,13 +23267,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' AND data__Identifier = '' AND region = 'us-east-1' - spot_fleets: - name: spot_fleets - id: awscc.ec2.spot_fleets - x-cfn-schema-name: SpotFleet - x-type: list + snapshot_block_public_accesses_list_only: + name: snapshot_block_public_accesses_list_only + id: awscc.ec2.snapshot_block_public_accesses_list_only + x-cfn-schema-name: SnapshotBlockPublicAccess + x-cfn-type-name: AWS::EC2::SnapshotBlockPublicAccess x-identifiers: - - Id + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11033,28 +23287,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' AND region = 'us-east-1' - spot_fleet: - name: spot_fleet - id: awscc.ec2.spot_fleet + spot_fleets: + name: spot_fleets + id: awscc.ec2.spot_fleets x-cfn-schema-name: SpotFleet - x-type: get + x-cfn-type-name: AWS::EC2::SpotFleet x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SpotFleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SpotFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SpotFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SpotFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11065,7 +23367,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11075,13 +23377,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SpotFleet' AND data__Identifier = '' AND region = 'us-east-1' - subnets: - name: subnets - id: awscc.ec2.subnets - x-cfn-schema-name: Subnet - x-type: list + spot_fleets_list_only: + name: spot_fleets_list_only + id: awscc.ec2.spot_fleets_list_only + x-cfn-schema-name: SpotFleet + x-cfn-type-name: AWS::EC2::SpotFleet x-identifiers: - - SubnetId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11089,28 +23397,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' AND region = 'us-east-1' - subnet: - name: subnet - id: awscc.ec2.subnet + subnets: + name: subnets + id: awscc.ec2.subnets x-cfn-schema-name: Subnet - x-type: get + x-cfn-type-name: AWS::EC2::Subnet x-identifiers: - SubnetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Subnet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Subnet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Subnet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Subnet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subnets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11118,6 +23474,7 @@ components: JSON_EXTRACT(Properties, '$.AssignIpv6AddressOnCreation') as assign_ipv6_address_on_creation, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, JSON_EXTRACT(Properties, '$.MapPublicIpOnLaunch') as map_public_ip_on_launch, + JSON_EXTRACT(Properties, '$.EnableLniAtDeviceIndex') as enable_lni_at_device_index, JSON_EXTRACT(Properties, '$.NetworkAclAssociationId') as network_acl_association_id, JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, JSON_EXTRACT(Properties, '$.AvailabilityZoneId') as availability_zone_id, @@ -11133,12 +23490,13 @@ components: JSON_EXTRACT(Properties, '$.Ipv4IpamPoolId') as ipv4_ipam_pool_id, JSON_EXTRACT(Properties, '$.Ipv4NetmaskLength') as ipv4_netmask_length, JSON_EXTRACT(Properties, '$.Ipv6IpamPoolId') as ipv6_ipam_pool_id, - JSON_EXTRACT(Properties, '$.Ipv6NetmaskLength') as ipv6_netmask_length + JSON_EXTRACT(Properties, '$.Ipv6NetmaskLength') as ipv6_netmask_length, + JSON_EXTRACT(Properties, '$.BlockPublicAccessStates') as block_public_access_states FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Subnet' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11146,6 +23504,7 @@ components: json_extract_path_text(Properties, 'AssignIpv6AddressOnCreation') as assign_ipv6_address_on_creation, json_extract_path_text(Properties, 'VpcId') as vpc_id, json_extract_path_text(Properties, 'MapPublicIpOnLaunch') as map_public_ip_on_launch, + json_extract_path_text(Properties, 'EnableLniAtDeviceIndex') as enable_lni_at_device_index, json_extract_path_text(Properties, 'NetworkAclAssociationId') as network_acl_association_id, json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, json_extract_path_text(Properties, 'AvailabilityZoneId') as availability_zone_id, @@ -11161,17 +23520,131 @@ components: json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length + json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, + json_extract_path_text(Properties, 'BlockPublicAccessStates') as block_public_access_states FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Subnet' AND data__Identifier = '' AND region = 'us-east-1' + subnets_list_only: + name: subnets_list_only + id: awscc.ec2.subnets_list_only + x-cfn-schema-name: Subnet + x-cfn-type-name: AWS::EC2::Subnet + x-identifiers: + - SubnetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' + AND region = 'us-east-1' subnet_cidr_blocks: name: subnet_cidr_blocks id: awscc.ec2.subnet_cidr_blocks x-cfn-schema-name: SubnetCidrBlock - x-type: list + x-cfn-type-name: AWS::EC2::SubnetCidrBlock + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubnetCidrBlock&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SubnetCidrBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SubnetCidrBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_cidr_blocks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_cidr_blocks/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Ipv6CidrBlock') as ipv6_cidr_block, + JSON_EXTRACT(Properties, '$.Ipv6IpamPoolId') as ipv6_ipam_pool_id, + JSON_EXTRACT(Properties, '$.Ipv6NetmaskLength') as ipv6_netmask_length, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.Ipv6AddressAttribute') as ipv6_address_attribute, + JSON_EXTRACT(Properties, '$.IpSource') as ip_source + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, + json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'Ipv6AddressAttribute') as ipv6_address_attribute, + json_extract_path_text(Properties, 'IpSource') as ip_source + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' + AND data__Identifier = '' + AND region = 'us-east-1' + subnet_cidr_blocks_list_only: + name: subnet_cidr_blocks_list_only + id: awscc.ec2.subnet_cidr_blocks_list_only + x-cfn-schema-name: SubnetCidrBlock + x-cfn-type-name: AWS::EC2::SubnetCidrBlock x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11190,50 +23663,430 @@ components: json_extract_path_text(Properties, 'Id') as id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' AND region = 'us-east-1' - subnet_cidr_block: - name: subnet_cidr_block - id: awscc.ec2.subnet_cidr_block - x-cfn-schema-name: SubnetCidrBlock - x-type: get + subnet_network_acl_associations: + name: subnet_network_acl_associations + id: awscc.ec2.subnet_network_acl_associations + x-cfn-schema-name: SubnetNetworkAclAssociation + x-cfn-type-name: AWS::EC2::SubnetNetworkAclAssociation x-identifiers: - - Id + - AssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubnetNetworkAclAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SubnetNetworkAclAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SubnetNetworkAclAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_network_acl_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_network_acl_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.NetworkAclId') as network_acl_id, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'NetworkAclId') as network_acl_id, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + subnet_network_acl_associations_list_only: + name: subnet_network_acl_associations_list_only + id: awscc.ec2.subnet_network_acl_associations_list_only + x-cfn-schema-name: SubnetNetworkAclAssociation + x-cfn-type-name: AWS::EC2::SubnetNetworkAclAssociation + x-identifiers: + - AssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + AND region = 'us-east-1' + subnet_route_table_associations: + name: subnet_route_table_associations + id: awscc.ec2.subnet_route_table_associations + x-cfn-schema-name: SubnetRouteTableAssociation + x-cfn-type-name: AWS::EC2::SubnetRouteTableAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubnetRouteTableAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SubnetRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SubnetRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_route_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_route_table_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Ipv6CidrBlock') as ipv6_cidr_block, - JSON_EXTRACT(Properties, '$.Ipv6IpamPoolId') as ipv6_ipam_pool_id, - JSON_EXTRACT(Properties, '$.Ipv6NetmaskLength') as ipv6_netmask_length, JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + subnet_route_table_associations_list_only: + name: subnet_route_table_associations_list_only + id: awscc.ec2.subnet_route_table_associations_list_only + x-cfn-schema-name: SubnetRouteTableAssociation + x-cfn-type-name: AWS::EC2::SubnetRouteTableAssociation + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + AND region = 'us-east-1' + traffic_mirror_filters: + name: traffic_mirror_filters + id: awscc.ec2.traffic_mirror_filters + x-cfn-schema-name: TrafficMirrorFilter + x-cfn-type-name: AWS::EC2::TrafficMirrorFilter + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrafficMirrorFilter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.NetworkServices') as network_services, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilter' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'NetworkServices') as network_services, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilter' + AND data__Identifier = '' + AND region = 'us-east-1' + traffic_mirror_filters_list_only: + name: traffic_mirror_filters_list_only + id: awscc.ec2.traffic_mirror_filters_list_only + x-cfn-schema-name: TrafficMirrorFilter + x-cfn-type-name: AWS::EC2::TrafficMirrorFilter + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilter' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilter' + AND region = 'us-east-1' + traffic_mirror_filter_rules: + name: traffic_mirror_filter_rules + id: awscc.ec2.traffic_mirror_filter_rules + x-cfn-schema-name: TrafficMirrorFilterRule + x-cfn-type-name: AWS::EC2::TrafficMirrorFilterRule + x-identifiers: + - TrafficMirrorFilterRuleId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrafficMirrorFilterRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorFilterRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorFilterRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorFilterRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DestinationPortRange') as destination_port_range, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.SourcePortRange') as source_port_range, + JSON_EXTRACT(Properties, '$.RuleAction') as rule_action, + JSON_EXTRACT(Properties, '$.SourceCidrBlock') as source_cidr_block, + JSON_EXTRACT(Properties, '$.RuleNumber') as rule_number, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.TrafficMirrorFilterRuleId') as traffic_mirror_filter_rule_id, + JSON_EXTRACT(Properties, '$.TrafficMirrorFilterId') as traffic_mirror_filter_id, + JSON_EXTRACT(Properties, '$.TrafficDirection') as traffic_direction, + JSON_EXTRACT(Properties, '$.Protocol') as protocol, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilterRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, - json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' - AND data__Identifier = '' + json_extract_path_text(Properties, 'DestinationPortRange') as destination_port_range, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SourcePortRange') as source_port_range, + json_extract_path_text(Properties, 'RuleAction') as rule_action, + json_extract_path_text(Properties, 'SourceCidrBlock') as source_cidr_block, + json_extract_path_text(Properties, 'RuleNumber') as rule_number, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'TrafficMirrorFilterRuleId') as traffic_mirror_filter_rule_id, + json_extract_path_text(Properties, 'TrafficMirrorFilterId') as traffic_mirror_filter_id, + json_extract_path_text(Properties, 'TrafficDirection') as traffic_direction, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilterRule' + AND data__Identifier = '' AND region = 'us-east-1' - subnet_network_acl_associations: - name: subnet_network_acl_associations - id: awscc.ec2.subnet_network_acl_associations - x-cfn-schema-name: SubnetNetworkAclAssociation - x-type: list + traffic_mirror_filter_rules_list_only: + name: traffic_mirror_filter_rules_list_only + id: awscc.ec2.traffic_mirror_filter_rules_list_only + x-cfn-schema-name: TrafficMirrorFilterRule + x-cfn-type-name: AWS::EC2::TrafficMirrorFilterRule x-identifiers: - - AssociationId + - TrafficMirrorFilterRuleId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11241,57 +24094,125 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + JSON_EXTRACT(Properties, '$.TrafficMirrorFilterRuleId') as traffic_mirror_filter_rule_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilterRule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + json_extract_path_text(Properties, 'TrafficMirrorFilterRuleId') as traffic_mirror_filter_rule_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorFilterRule' AND region = 'us-east-1' - subnet_network_acl_association: - name: subnet_network_acl_association - id: awscc.ec2.subnet_network_acl_association - x-cfn-schema-name: SubnetNetworkAclAssociation - x-type: get + traffic_mirror_sessions: + name: traffic_mirror_sessions + id: awscc.ec2.traffic_mirror_sessions + x-cfn-schema-name: TrafficMirrorSession + x-cfn-type-name: AWS::EC2::TrafficMirrorSession x-identifiers: - - AssociationId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrafficMirrorSession&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorSession" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorSession" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorSession" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, - JSON_EXTRACT(Properties, '$.NetworkAclId') as network_acl_id, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, + JSON_EXTRACT(Properties, '$.TrafficMirrorTargetId') as traffic_mirror_target_id, + JSON_EXTRACT(Properties, '$.TrafficMirrorFilterId') as traffic_mirror_filter_id, + JSON_EXTRACT(Properties, '$.PacketLength') as packet_length, + JSON_EXTRACT(Properties, '$.SessionNumber') as session_number, + JSON_EXTRACT(Properties, '$.VirtualNetworkId') as virtual_network_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.OwnerId') as owner_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorSession' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'NetworkAclId') as network_acl_id, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'TrafficMirrorTargetId') as traffic_mirror_target_id, + json_extract_path_text(Properties, 'TrafficMirrorFilterId') as traffic_mirror_filter_id, + json_extract_path_text(Properties, 'PacketLength') as packet_length, + json_extract_path_text(Properties, 'SessionNumber') as session_number, + json_extract_path_text(Properties, 'VirtualNetworkId') as virtual_network_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorSession' + AND data__Identifier = '' AND region = 'us-east-1' - subnet_route_table_associations: - name: subnet_route_table_associations - id: awscc.ec2.subnet_route_table_associations - x-cfn-schema-name: SubnetRouteTableAssociation - x-type: list + traffic_mirror_sessions_list_only: + name: traffic_mirror_sessions_list_only + id: awscc.ec2.traffic_mirror_sessions_list_only + x-cfn-schema-name: TrafficMirrorSession + x-cfn-type-name: AWS::EC2::TrafficMirrorSession x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11300,7 +24221,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorSession' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -11308,48 +24229,108 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorSession' AND region = 'us-east-1' - subnet_route_table_association: - name: subnet_route_table_association - id: awscc.ec2.subnet_route_table_association - x-cfn-schema-name: SubnetRouteTableAssociation - x-type: get + traffic_mirror_targets: + name: traffic_mirror_targets + id: awscc.ec2.traffic_mirror_targets + x-cfn-schema-name: TrafficMirrorTarget + x-cfn-type-name: AWS::EC2::TrafficMirrorTarget x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrafficMirrorTarget&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TrafficMirrorTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.NetworkLoadBalancerArn') as network_load_balancer_arn, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, + JSON_EXTRACT(Properties, '$.GatewayLoadBalancerEndpointId') as gateway_load_balancer_endpoint_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorTarget' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'NetworkLoadBalancerArn') as network_load_balancer_arn, + json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'GatewayLoadBalancerEndpointId') as gateway_load_balancer_endpoint_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TrafficMirrorTarget' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateways: - name: transit_gateways - id: awscc.ec2.transit_gateways - x-cfn-schema-name: TransitGateway - x-type: list + traffic_mirror_targets_list_only: + name: traffic_mirror_targets_list_only + id: awscc.ec2.traffic_mirror_targets_list_only + x-cfn-schema-name: TrafficMirrorTarget + x-cfn-type-name: AWS::EC2::TrafficMirrorTarget x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11358,7 +24339,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorTarget' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -11366,70 +24347,126 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TrafficMirrorTarget' AND region = 'us-east-1' - transit_gateway: - name: transit_gateway - id: awscc.ec2.transit_gateway + transit_gateways: + name: transit_gateways + id: awscc.ec2.transit_gateways x-cfn-schema-name: TransitGateway - x-type: get + x-cfn-type-name: AWS::EC2::TransitGateway x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.DefaultRouteTablePropagation') as default_route_table_propagation, + JSON_EXTRACT(Properties, '$.TransitGatewayArn') as transit_gateway_arn, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.AssociationDefaultRouteTableId') as association_default_route_table_id, JSON_EXTRACT(Properties, '$.AutoAcceptSharedAttachments') as auto_accept_shared_attachments, - JSON_EXTRACT(Properties, '$.TransitGatewayArn') as transit_gateway_arn, - JSON_EXTRACT(Properties, '$.DefaultRouteTablePropagation') as default_route_table_propagation, - JSON_EXTRACT(Properties, '$.TransitGatewayCidrBlocks') as transit_gateway_cidr_blocks, - JSON_EXTRACT(Properties, '$.PropagationDefaultRouteTableId') as propagation_default_route_table_id, JSON_EXTRACT(Properties, '$.DefaultRouteTableAssociation') as default_route_table_association, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.VpnEcmpSupport') as vpn_ecmp_support, JSON_EXTRACT(Properties, '$.DnsSupport') as dns_support, + JSON_EXTRACT(Properties, '$.SecurityGroupReferencingSupport') as security_group_referencing_support, JSON_EXTRACT(Properties, '$.MulticastSupport') as multicast_support, JSON_EXTRACT(Properties, '$.AmazonSideAsn') as amazon_side_asn, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.TransitGatewayCidrBlocks') as transit_gateway_cidr_blocks, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AssociationDefaultRouteTableId') as association_default_route_table_id, + JSON_EXTRACT(Properties, '$.PropagationDefaultRouteTableId') as propagation_default_route_table_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGateway' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'DefaultRouteTablePropagation') as default_route_table_propagation, + json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AssociationDefaultRouteTableId') as association_default_route_table_id, json_extract_path_text(Properties, 'AutoAcceptSharedAttachments') as auto_accept_shared_attachments, - json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn, - json_extract_path_text(Properties, 'DefaultRouteTablePropagation') as default_route_table_propagation, - json_extract_path_text(Properties, 'TransitGatewayCidrBlocks') as transit_gateway_cidr_blocks, - json_extract_path_text(Properties, 'PropagationDefaultRouteTableId') as propagation_default_route_table_id, json_extract_path_text(Properties, 'DefaultRouteTableAssociation') as default_route_table_association, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'VpnEcmpSupport') as vpn_ecmp_support, json_extract_path_text(Properties, 'DnsSupport') as dns_support, + json_extract_path_text(Properties, 'SecurityGroupReferencingSupport') as security_group_referencing_support, json_extract_path_text(Properties, 'MulticastSupport') as multicast_support, json_extract_path_text(Properties, 'AmazonSideAsn') as amazon_side_asn, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'TransitGatewayCidrBlocks') as transit_gateway_cidr_blocks, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AssociationDefaultRouteTableId') as association_default_route_table_id, + json_extract_path_text(Properties, 'PropagationDefaultRouteTableId') as propagation_default_route_table_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGateway' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_attachments: - name: transit_gateway_attachments - id: awscc.ec2.transit_gateway_attachments - x-cfn-schema-name: TransitGatewayAttachment - x-type: list + transit_gateways_list_only: + name: transit_gateways_list_only + id: awscc.ec2.transit_gateways_list_only + x-cfn-schema-name: TransitGateway + x-cfn-type-name: AWS::EC2::TransitGateway x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11438,7 +24475,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -11446,54 +24483,108 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' AND region = 'us-east-1' - transit_gateway_attachment: - name: transit_gateway_attachment - id: awscc.ec2.transit_gateway_attachment + transit_gateway_attachments: + name: transit_gateway_attachments + id: awscc.ec2.transit_gateway_attachments x-cfn-schema-name: TransitGatewayAttachment - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayAttachment x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Options') as options, JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Options') as options + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Options') as options, json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Options') as options + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_connects: - name: transit_gateway_connects - id: awscc.ec2.transit_gateway_connects - x-cfn-schema-name: TransitGatewayConnect - x-type: list + transit_gateway_attachments_list_only: + name: transit_gateway_attachments_list_only + id: awscc.ec2.transit_gateway_attachments_list_only + x-cfn-schema-name: TransitGatewayAttachment + x-cfn-type-name: AWS::EC2::TransitGatewayAttachment x-identifiers: - - TransitGatewayAttachmentId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11501,28 +24592,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' AND region = 'us-east-1' - transit_gateway_connect: - name: transit_gateway_connect - id: awscc.ec2.transit_gateway_connect + transit_gateway_connects: + name: transit_gateway_connects + id: awscc.ec2.transit_gateway_connects x-cfn-schema-name: TransitGatewayConnect - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayConnect x-identifiers: - TransitGatewayAttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayConnect&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11538,7 +24677,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11553,13 +24692,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_multicast_domains: - name: transit_gateway_multicast_domains - id: awscc.ec2.transit_gateway_multicast_domains - x-cfn-schema-name: TransitGatewayMulticastDomain - x-type: list + transit_gateway_connects_list_only: + name: transit_gateway_connects_list_only + id: awscc.ec2.transit_gateway_connects_list_only + x-cfn-schema-name: TransitGatewayConnect + x-cfn-type-name: AWS::EC2::TransitGatewayConnect x-identifiers: - - TransitGatewayMulticastDomainId + - TransitGatewayAttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11567,28 +24712,194 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' + AND region = 'us-east-1' + transit_gateway_connect_peers: + name: transit_gateway_connect_peers + id: awscc.ec2.transit_gateway_connect_peers + x-cfn-schema-name: TransitGatewayConnectPeer + x-cfn-type-name: AWS::EC2::TransitGatewayConnectPeer + x-identifiers: + - TransitGatewayConnectPeerId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayConnectPeer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnectPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnectPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnectPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id, + JSON_EXTRACT(Properties, '$.TransitGatewayConnectPeerId') as transit_gateway_connect_peer_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.ConnectPeerConfiguration') as connect_peer_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnectPeer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'TransitGatewayConnectPeerId') as transit_gateway_connect_peer_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ConnectPeerConfiguration') as connect_peer_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnectPeer' + AND data__Identifier = '' + AND region = 'us-east-1' + transit_gateway_connect_peers_list_only: + name: transit_gateway_connect_peers_list_only + id: awscc.ec2.transit_gateway_connect_peers_list_only + x-cfn-schema-name: TransitGatewayConnectPeer + x-cfn-type-name: AWS::EC2::TransitGatewayConnectPeer + x-identifiers: + - TransitGatewayConnectPeerId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TransitGatewayConnectPeerId') as transit_gateway_connect_peer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnectPeer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayConnectPeerId') as transit_gateway_connect_peer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnectPeer' AND region = 'us-east-1' - transit_gateway_multicast_domain: - name: transit_gateway_multicast_domain - id: awscc.ec2.transit_gateway_multicast_domain + transit_gateway_multicast_domains: + name: transit_gateway_multicast_domains + id: awscc.ec2.transit_gateway_multicast_domains x-cfn-schema-name: TransitGatewayMulticastDomain - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomain x-identifiers: - TransitGatewayMulticastDomainId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastDomain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastDomain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastDomain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastDomain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11604,7 +24915,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11619,15 +24930,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_multicast_domain_associations: - name: transit_gateway_multicast_domain_associations - id: awscc.ec2.transit_gateway_multicast_domain_associations - x-cfn-schema-name: TransitGatewayMulticastDomainAssociation - x-type: list + transit_gateway_multicast_domains_list_only: + name: transit_gateway_multicast_domains_list_only + id: awscc.ec2.transit_gateway_multicast_domains_list_only + x-cfn-schema-name: TransitGatewayMulticastDomain + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomain x-identifiers: - TransitGatewayMulticastDomainId - - TransitGatewayAttachmentId - - SubnetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11635,34 +24950,65 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' + JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' AND region = 'us-east-1' - transit_gateway_multicast_domain_association: - name: transit_gateway_multicast_domain_association - id: awscc.ec2.transit_gateway_multicast_domain_association + transit_gateway_multicast_domain_associations: + name: transit_gateway_multicast_domain_associations + id: awscc.ec2.transit_gateway_multicast_domain_associations x-cfn-schema-name: TransitGatewayMulticastDomainAssociation - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomainAssociation x-identifiers: - TransitGatewayMulticastDomainId - TransitGatewayAttachmentId - SubnetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastDomainAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastDomainAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastDomainAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11677,7 +25023,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11691,15 +25037,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' AND data__Identifier = '||' AND region = 'us-east-1' - transit_gateway_multicast_group_members: - name: transit_gateway_multicast_group_members - id: awscc.ec2.transit_gateway_multicast_group_members - x-cfn-schema-name: TransitGatewayMulticastGroupMember - x-type: list + transit_gateway_multicast_domain_associations_list_only: + name: transit_gateway_multicast_domain_associations_list_only + id: awscc.ec2.transit_gateway_multicast_domain_associations_list_only + x-cfn-schema-name: TransitGatewayMulticastDomainAssociation + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomainAssociation x-identifiers: - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId + - TransitGatewayAttachmentId + - SubnetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11708,9 +25060,9 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -11718,23 +25070,58 @@ components: SELECT region, json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' AND region = 'us-east-1' - transit_gateway_multicast_group_member: - name: transit_gateway_multicast_group_member - id: awscc.ec2.transit_gateway_multicast_group_member + transit_gateway_multicast_group_members: + name: transit_gateway_multicast_group_members + id: awscc.ec2.transit_gateway_multicast_group_members x-cfn-schema-name: TransitGatewayMulticastGroupMember - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastGroupMember x-identifiers: - TransitGatewayMulticastDomainId - GroupIpAddress - NetworkInterfaceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastGroupMember&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastGroupMember" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastGroupMember" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_members/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_members/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11748,13 +25135,12 @@ components: JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, JSON_EXTRACT(Properties, '$.GroupMember') as group_member, JSON_EXTRACT(Properties, '$.GroupSource') as group_source, - JSON_EXTRACT(Properties, '$.MemberType') as member_type, - JSON_EXTRACT(Properties, '$.SourceType') as source_type + JSON_EXTRACT(Properties, '$.MemberType') as member_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11768,20 +25154,25 @@ components: json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, json_extract_path_text(Properties, 'GroupMember') as group_member, json_extract_path_text(Properties, 'GroupSource') as group_source, - json_extract_path_text(Properties, 'MemberType') as member_type, - json_extract_path_text(Properties, 'SourceType') as source_type + json_extract_path_text(Properties, 'MemberType') as member_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' AND data__Identifier = '||' AND region = 'us-east-1' - transit_gateway_multicast_group_sources: - name: transit_gateway_multicast_group_sources - id: awscc.ec2.transit_gateway_multicast_group_sources - x-cfn-schema-name: TransitGatewayMulticastGroupSource - x-type: list + transit_gateway_multicast_group_members_list_only: + name: transit_gateway_multicast_group_members_list_only + id: awscc.ec2.transit_gateway_multicast_group_members_list_only + x-cfn-schema-name: TransitGatewayMulticastGroupMember + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastGroupMember x-identifiers: - TransitGatewayMulticastDomainId - GroupIpAddress - NetworkInterfaceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11792,7 +25183,7 @@ components: JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -11802,21 +25193,56 @@ components: json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' AND region = 'us-east-1' - transit_gateway_multicast_group_source: - name: transit_gateway_multicast_group_source - id: awscc.ec2.transit_gateway_multicast_group_source + transit_gateway_multicast_group_sources: + name: transit_gateway_multicast_group_sources + id: awscc.ec2.transit_gateway_multicast_group_sources x-cfn-schema-name: TransitGatewayMulticastGroupSource - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastGroupSource x-identifiers: - TransitGatewayMulticastDomainId - GroupIpAddress - NetworkInterfaceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastGroupSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastGroupSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayMulticastGroupSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_sources/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11830,13 +25256,12 @@ components: JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id, JSON_EXTRACT(Properties, '$.GroupMember') as group_member, JSON_EXTRACT(Properties, '$.GroupSource') as group_source, - JSON_EXTRACT(Properties, '$.MemberType') as member_type, JSON_EXTRACT(Properties, '$.SourceType') as source_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11850,18 +25275,25 @@ components: json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, json_extract_path_text(Properties, 'GroupMember') as group_member, json_extract_path_text(Properties, 'GroupSource') as group_source, - json_extract_path_text(Properties, 'MemberType') as member_type, json_extract_path_text(Properties, 'SourceType') as source_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' AND data__Identifier = '||' AND region = 'us-east-1' - transit_gateway_peering_attachments: - name: transit_gateway_peering_attachments - id: awscc.ec2.transit_gateway_peering_attachments - x-cfn-schema-name: TransitGatewayPeeringAttachment - x-type: list + transit_gateway_multicast_group_sources_list_only: + name: transit_gateway_multicast_group_sources_list_only + id: awscc.ec2.transit_gateway_multicast_group_sources_list_only + x-cfn-schema-name: TransitGatewayMulticastGroupSource + x-cfn-type-name: AWS::EC2::TransitGatewayMulticastGroupSource x-identifiers: - - TransitGatewayAttachmentId + - TransitGatewayMulticastDomainId + - GroupIpAddress + - NetworkInterfaceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11869,28 +25301,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' AND region = 'us-east-1' - transit_gateway_peering_attachment: - name: transit_gateway_peering_attachment - id: awscc.ec2.transit_gateway_peering_attachment + transit_gateway_peering_attachments: + name: transit_gateway_peering_attachments + id: awscc.ec2.transit_gateway_peering_attachments x-cfn-schema-name: TransitGatewayPeeringAttachment - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayPeeringAttachment x-identifiers: - TransitGatewayAttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayPeeringAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayPeeringAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayPeeringAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayPeeringAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11908,7 +25392,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11925,13 +25409,122 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_route_tables: - name: transit_gateway_route_tables - id: awscc.ec2.transit_gateway_route_tables - x-cfn-schema-name: TransitGatewayRouteTable - x-type: list + transit_gateway_peering_attachments_list_only: + name: transit_gateway_peering_attachments_list_only + id: awscc.ec2.transit_gateway_peering_attachments_list_only + x-cfn-schema-name: TransitGatewayPeeringAttachment + x-cfn-type-name: AWS::EC2::TransitGatewayPeeringAttachment + x-identifiers: + - TransitGatewayAttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + AND region = 'us-east-1' + transit_gateway_routes: + name: transit_gateway_routes + id: awscc.ec2.transit_gateway_routes + x-cfn-schema-name: TransitGatewayRoute + x-cfn-type-name: AWS::EC2::TransitGatewayRoute + x-identifiers: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRoute&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.Blackhole') as blackhole, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'Blackhole') as blackhole, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' + AND data__Identifier = '|' + AND region = 'us-east-1' + transit_gateway_routes_list_only: + name: transit_gateway_routes_list_only + id: awscc.ec2.transit_gateway_routes_list_only + x-cfn-schema-name: TransitGatewayRoute + x-cfn-type-name: AWS::EC2::TransitGatewayRoute x-identifiers: - TransitGatewayRouteTableId + - DestinationCidrBlock + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11939,28 +25532,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' AND region = 'us-east-1' - transit_gateway_route_table: - name: transit_gateway_route_table - id: awscc.ec2.transit_gateway_route_table + transit_gateway_route_tables: + name: transit_gateway_route_tables + id: awscc.ec2.transit_gateway_route_tables x-cfn-schema-name: TransitGatewayRouteTable - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTable x-identifiers: - TransitGatewayRouteTableId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11972,7 +25615,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -11983,13 +25626,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_vpc_attachments: - name: transit_gateway_vpc_attachments - id: awscc.ec2.transit_gateway_vpc_attachments - x-cfn-schema-name: TransitGatewayVpcAttachment - x-type: list + transit_gateway_route_tables_list_only: + name: transit_gateway_route_tables_list_only + id: awscc.ec2.transit_gateway_route_tables_list_only + x-cfn-schema-name: TransitGatewayRouteTable + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTable x-identifiers: - - Id + - TransitGatewayRouteTableId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11997,67 +25646,323 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' + AND region = 'us-east-1' + transit_gateway_route_table_associations: + name: transit_gateway_route_table_associations + id: awscc.ec2.transit_gateway_route_table_associations + x-cfn-schema-name: TransitGatewayRouteTableAssociation + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTableAssociation + x-identifiers: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTableAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTableAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + transit_gateway_route_table_associations_list_only: + name: transit_gateway_route_table_associations_list_only + id: awscc.ec2.transit_gateway_route_table_associations_list_only + x-cfn-schema-name: TransitGatewayRouteTableAssociation + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTableAssociation + x-identifiers: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND region = 'us-east-1' + transit_gateway_route_table_propagations: + name: transit_gateway_route_table_propagations + id: awscc.ec2.transit_gateway_route_table_propagations + x-cfn-schema-name: TransitGatewayRouteTablePropagation + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTablePropagation + x-identifiers: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTablePropagation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTablePropagation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTablePropagation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' + AND data__Identifier = '|' + AND region = 'us-east-1' + transit_gateway_route_table_propagations_list_only: + name: transit_gateway_route_table_propagations_list_only + id: awscc.ec2.transit_gateway_route_table_propagations_list_only + x-cfn-schema-name: TransitGatewayRouteTablePropagation + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTablePropagation + x-identifiers: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' AND region = 'us-east-1' - transit_gateway_vpc_attachment: - name: transit_gateway_vpc_attachment - id: awscc.ec2.transit_gateway_vpc_attachment + transit_gateway_vpc_attachments: + name: transit_gateway_vpc_attachments + id: awscc.ec2.transit_gateway_vpc_attachments x-cfn-schema-name: TransitGatewayVpcAttachment - x-type: get + x-cfn-type-name: AWS::EC2::TransitGatewayVpcAttachment x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayVpcAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayVpcAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayVpcAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayVpcAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Options') as options, + JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, - JSON_EXTRACT(Properties, '$.RemoveSubnetIds') as remove_subnet_ids, - JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, JSON_EXTRACT(Properties, '$.AddSubnetIds') as add_subnet_ids, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.RemoveSubnetIds') as remove_subnet_ids, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Options') as options FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Options') as options, + json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'RemoveSubnetIds') as remove_subnet_ids, - json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, json_extract_path_text(Properties, 'AddSubnetIds') as add_subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'RemoveSubnetIds') as remove_subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Options') as options FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' AND data__Identifier = '' - AND region = 'us-east-1' - verified_access_endpoints: - name: verified_access_endpoints - id: awscc.ec2.verified_access_endpoints - x-cfn-schema-name: VerifiedAccessEndpoint - x-type: list + AND region = 'us-east-1' + transit_gateway_vpc_attachments_list_only: + name: transit_gateway_vpc_attachments_list_only + id: awscc.ec2.transit_gateway_vpc_attachments_list_only + x-cfn-schema-name: TransitGatewayVpcAttachment + x-cfn-type-name: AWS::EC2::TransitGatewayVpcAttachment x-identifiers: - - VerifiedAccessEndpointId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12065,28 +25970,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VerifiedAccessEndpointId') as verified_access_endpoint_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VerifiedAccessEndpointId') as verified_access_endpoint_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' AND region = 'us-east-1' - verified_access_endpoint: - name: verified_access_endpoint - id: awscc.ec2.verified_access_endpoint + verified_access_endpoints: + name: verified_access_endpoints + id: awscc.ec2.verified_access_endpoints x-cfn-schema-name: VerifiedAccessEndpoint - x-type: get + x-cfn-type-name: AWS::EC2::VerifiedAccessEndpoint x-identifiers: - VerifiedAccessEndpointId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VerifiedAccessEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12098,6 +26051,8 @@ components: JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, JSON_EXTRACT(Properties, '$.NetworkInterfaceOptions') as network_interface_options, JSON_EXTRACT(Properties, '$.LoadBalancerOptions') as load_balancer_options, + JSON_EXTRACT(Properties, '$.RdsOptions') as rds_options, + JSON_EXTRACT(Properties, '$.CidrOptions') as cidr_options, JSON_EXTRACT(Properties, '$.EndpointType') as endpoint_type, JSON_EXTRACT(Properties, '$.EndpointDomain') as endpoint_domain, JSON_EXTRACT(Properties, '$.EndpointDomainPrefix') as endpoint_domain_prefix, @@ -12116,7 +26071,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12128,6 +26083,8 @@ components: json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, json_extract_path_text(Properties, 'NetworkInterfaceOptions') as network_interface_options, json_extract_path_text(Properties, 'LoadBalancerOptions') as load_balancer_options, + json_extract_path_text(Properties, 'RdsOptions') as rds_options, + json_extract_path_text(Properties, 'CidrOptions') as cidr_options, json_extract_path_text(Properties, 'EndpointType') as endpoint_type, json_extract_path_text(Properties, 'EndpointDomain') as endpoint_domain, json_extract_path_text(Properties, 'EndpointDomainPrefix') as endpoint_domain_prefix, @@ -12145,13 +26102,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' AND data__Identifier = '' AND region = 'us-east-1' - verified_access_groups: - name: verified_access_groups - id: awscc.ec2.verified_access_groups - x-cfn-schema-name: VerifiedAccessGroup - x-type: list + verified_access_endpoints_list_only: + name: verified_access_endpoints_list_only + id: awscc.ec2.verified_access_endpoints_list_only + x-cfn-schema-name: VerifiedAccessEndpoint + x-cfn-type-name: AWS::EC2::VerifiedAccessEndpoint x-identifiers: - - VerifiedAccessGroupId + - VerifiedAccessEndpointId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12159,28 +26122,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VerifiedAccessGroupId') as verified_access_group_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' + JSON_EXTRACT(Properties, '$.VerifiedAccessEndpointId') as verified_access_endpoint_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' + json_extract_path_text(Properties, 'VerifiedAccessEndpointId') as verified_access_endpoint_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' AND region = 'us-east-1' - verified_access_group: - name: verified_access_group - id: awscc.ec2.verified_access_group + verified_access_groups: + name: verified_access_groups + id: awscc.ec2.verified_access_groups x-cfn-schema-name: VerifiedAccessGroup - x-type: get + x-cfn-type-name: AWS::EC2::VerifiedAccessGroup x-identifiers: - VerifiedAccessGroupId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VerifiedAccessGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12200,7 +26211,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12219,13 +26230,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' AND data__Identifier = '' AND region = 'us-east-1' - verified_access_trust_providers: - name: verified_access_trust_providers - id: awscc.ec2.verified_access_trust_providers - x-cfn-schema-name: VerifiedAccessTrustProvider - x-type: list + verified_access_groups_list_only: + name: verified_access_groups_list_only + id: awscc.ec2.verified_access_groups_list_only + x-cfn-schema-name: VerifiedAccessGroup + x-cfn-type-name: AWS::EC2::VerifiedAccessGroup x-identifiers: - - VerifiedAccessTrustProviderId + - VerifiedAccessGroupId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12233,28 +26250,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VerifiedAccessTrustProviderId') as verified_access_trust_provider_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' + JSON_EXTRACT(Properties, '$.VerifiedAccessGroupId') as verified_access_group_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' + json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' AND region = 'us-east-1' - verified_access_trust_provider: - name: verified_access_trust_provider - id: awscc.ec2.verified_access_trust_provider + verified_access_trust_providers: + name: verified_access_trust_providers + id: awscc.ec2.verified_access_trust_providers x-cfn-schema-name: VerifiedAccessTrustProvider - x-type: get + x-cfn-type-name: AWS::EC2::VerifiedAccessTrustProvider x-identifiers: - VerifiedAccessTrustProviderId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VerifiedAccessTrustProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessTrustProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessTrustProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessTrustProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12270,12 +26335,13 @@ components: JSON_EXTRACT(Properties, '$.VerifiedAccessTrustProviderId') as verified_access_trust_provider_id, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.SseSpecification') as sse_specification + JSON_EXTRACT(Properties, '$.SseSpecification') as sse_specification, + JSON_EXTRACT(Properties, '$.NativeApplicationOidcOptions') as native_application_oidc_options FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12291,17 +26357,24 @@ components: json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SseSpecification') as sse_specification + json_extract_path_text(Properties, 'SseSpecification') as sse_specification, + json_extract_path_text(Properties, 'NativeApplicationOidcOptions') as native_application_oidc_options FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' AND data__Identifier = '' AND region = 'us-east-1' - verified_access_instances: - name: verified_access_instances - id: awscc.ec2.verified_access_instances - x-cfn-schema-name: VerifiedAccessInstance - x-type: list + verified_access_trust_providers_list_only: + name: verified_access_trust_providers_list_only + id: awscc.ec2.verified_access_trust_providers_list_only + x-cfn-schema-name: VerifiedAccessTrustProvider + x-cfn-type-name: AWS::EC2::VerifiedAccessTrustProvider x-identifiers: - - VerifiedAccessInstanceId + - VerifiedAccessTrustProviderId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12309,28 +26382,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VerifiedAccessInstanceId') as verified_access_instance_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' + JSON_EXTRACT(Properties, '$.VerifiedAccessTrustProviderId') as verified_access_trust_provider_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' + json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' AND region = 'us-east-1' - verified_access_instance: - name: verified_access_instance - id: awscc.ec2.verified_access_instance + verified_access_instances: + name: verified_access_instances + id: awscc.ec2.verified_access_instances x-cfn-schema-name: VerifiedAccessInstance - x-type: get + x-cfn-type-name: AWS::EC2::VerifiedAccessInstance x-identifiers: - VerifiedAccessInstanceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VerifiedAccessInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VerifiedAccessInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12343,12 +26464,14 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.LoggingConfigurations') as logging_configurations, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.FipsEnabled') as fips_enabled + JSON_EXTRACT(Properties, '$.FipsEnabled') as fips_enabled, + JSON_EXTRACT(Properties, '$.CidrEndpointsCustomSubDomain') as cidr_endpoints_custom_sub_domain, + JSON_EXTRACT(Properties, '$.CidrEndpointsCustomSubDomainNameServers') as cidr_endpoints_custom_sub_domain_name_servers FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12361,17 +26484,25 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'LoggingConfigurations') as logging_configurations, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'FipsEnabled') as fips_enabled + json_extract_path_text(Properties, 'FipsEnabled') as fips_enabled, + json_extract_path_text(Properties, 'CidrEndpointsCustomSubDomain') as cidr_endpoints_custom_sub_domain, + json_extract_path_text(Properties, 'CidrEndpointsCustomSubDomainNameServers') as cidr_endpoints_custom_sub_domain_name_servers FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' AND data__Identifier = '' AND region = 'us-east-1' - volumes: - name: volumes - id: awscc.ec2.volumes - x-cfn-schema-name: Volume - x-type: list + verified_access_instances_list_only: + name: verified_access_instances_list_only + id: awscc.ec2.verified_access_instances_list_only + x-cfn-schema-name: VerifiedAccessInstance + x-cfn-type-name: AWS::EC2::VerifiedAccessInstance x-identifiers: - - VolumeId + - VerifiedAccessInstanceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12379,78 +26510,100 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VolumeId') as volume_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' + JSON_EXTRACT(Properties, '$.VerifiedAccessInstanceId') as verified_access_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VolumeId') as volume_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' + json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' AND region = 'us-east-1' - volume: - name: volume - id: awscc.ec2.volume - x-cfn-schema-name: Volume - x-type: get + volume_attachments: + name: volume_attachments + id: awscc.ec2.volume_attachments + x-cfn-schema-name: VolumeAttachment + x-cfn-type-name: AWS::EC2::VolumeAttachment x-identifiers: - VolumeId + - InstanceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VolumeAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VolumeAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VolumeAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.MultiAttachEnabled') as multi_attach_enabled, - JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.Encrypted') as encrypted, - JSON_EXTRACT(Properties, '$.Size') as size, - JSON_EXTRACT(Properties, '$.AutoEnableIO') as auto_enable_io, - JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, - JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, - JSON_EXTRACT(Properties, '$.Throughput') as throughput, - JSON_EXTRACT(Properties, '$.Iops') as iops, - JSON_EXTRACT(Properties, '$.SnapshotId') as snapshot_id, - JSON_EXTRACT(Properties, '$.VolumeType') as volume_type, JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Volume' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.Device') as device + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'MultiAttachEnabled') as multi_attach_enabled, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Encrypted') as encrypted, - json_extract_path_text(Properties, 'Size') as size, - json_extract_path_text(Properties, 'AutoEnableIO') as auto_enable_io, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'Throughput') as throughput, - json_extract_path_text(Properties, 'Iops') as iops, - json_extract_path_text(Properties, 'SnapshotId') as snapshot_id, - json_extract_path_text(Properties, 'VolumeType') as volume_type, json_extract_path_text(Properties, 'VolumeId') as volume_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Volume' - AND data__Identifier = '' + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'Device') as device + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' + AND data__Identifier = '|' AND region = 'us-east-1' - volume_attachments: - name: volume_attachments - id: awscc.ec2.volume_attachments + volume_attachments_list_only: + name: volume_attachments_list_only + id: awscc.ec2.volume_attachments_list_only x-cfn-schema-name: VolumeAttachment - x-type: list + x-cfn-type-name: AWS::EC2::VolumeAttachment x-identifiers: - VolumeId - InstanceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12471,124 +26624,436 @@ components: json_extract_path_text(Properties, 'InstanceId') as instance_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' AND region = 'us-east-1' - volume_attachment: - name: volume_attachment - id: awscc.ec2.volume_attachment - x-cfn-schema-name: VolumeAttachment - x-type: get + vpcs: + name: vpcs + id: awscc.ec2.vpcs + x-cfn-schema-name: VPC + x-cfn-type-name: AWS::EC2::VPC x-identifiers: - - VolumeId - - InstanceId + - VpcId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPC&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPC" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPC" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPC" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.Device') as device - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.InstanceTenancy') as instance_tenancy, + JSON_EXTRACT(Properties, '$.Ipv4NetmaskLength') as ipv4_netmask_length, + JSON_EXTRACT(Properties, '$.CidrBlockAssociations') as cidr_block_associations, + JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block, + JSON_EXTRACT(Properties, '$.Ipv4IpamPoolId') as ipv4_ipam_pool_id, + JSON_EXTRACT(Properties, '$.DefaultNetworkAcl') as default_network_acl, + JSON_EXTRACT(Properties, '$.EnableDnsSupport') as enable_dns_support, + JSON_EXTRACT(Properties, '$.Ipv6CidrBlocks') as ipv6_cidr_blocks, + JSON_EXTRACT(Properties, '$.DefaultSecurityGroup') as default_security_group, + JSON_EXTRACT(Properties, '$.EnableDnsHostnames') as enable_dns_hostnames, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPC' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'InstanceTenancy') as instance_tenancy, + json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, + json_extract_path_text(Properties, 'CidrBlockAssociations') as cidr_block_associations, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, + json_extract_path_text(Properties, 'DefaultNetworkAcl') as default_network_acl, + json_extract_path_text(Properties, 'EnableDnsSupport') as enable_dns_support, + json_extract_path_text(Properties, 'Ipv6CidrBlocks') as ipv6_cidr_blocks, + json_extract_path_text(Properties, 'DefaultSecurityGroup') as default_security_group, + json_extract_path_text(Properties, 'EnableDnsHostnames') as enable_dns_hostnames, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPC' + AND data__Identifier = '' + AND region = 'us-east-1' + vpcs_list_only: + name: vpcs_list_only + id: awscc.ec2.vpcs_list_only + x-cfn-schema-name: VPC + x-cfn-type-name: AWS::EC2::VPC + x-identifiers: + - VpcId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' + AND region = 'us-east-1' + vpc_block_public_access_exclusions: + name: vpc_block_public_access_exclusions + id: awscc.ec2.vpc_block_public_access_exclusions + x-cfn-schema-name: VPCBlockPublicAccessExclusion + x-cfn-type-name: AWS::EC2::VPCBlockPublicAccessExclusion + x-identifiers: + - ExclusionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCBlockPublicAccessExclusion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCBlockPublicAccessExclusion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCBlockPublicAccessExclusion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCBlockPublicAccessExclusion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_block_public_access_exclusions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_block_public_access_exclusions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_block_public_access_exclusions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ExclusionId') as exclusion_id, + JSON_EXTRACT(Properties, '$.InternetGatewayExclusionMode') as internet_gateway_exclusion_mode, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCBlockPublicAccessExclusion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'VolumeId') as volume_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'Device') as device - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'ExclusionId') as exclusion_id, + json_extract_path_text(Properties, 'InternetGatewayExclusionMode') as internet_gateway_exclusion_mode, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCBlockPublicAccessExclusion' + AND data__Identifier = '' + AND region = 'us-east-1' + vpc_block_public_access_exclusions_list_only: + name: vpc_block_public_access_exclusions_list_only + id: awscc.ec2.vpc_block_public_access_exclusions_list_only + x-cfn-schema-name: VPCBlockPublicAccessExclusion + x-cfn-type-name: AWS::EC2::VPCBlockPublicAccessExclusion + x-identifiers: + - ExclusionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ExclusionId') as exclusion_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCBlockPublicAccessExclusion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ExclusionId') as exclusion_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCBlockPublicAccessExclusion' AND region = 'us-east-1' - vpcs: - name: vpcs - id: awscc.ec2.vpcs - x-cfn-schema-name: VPC - x-type: list + vpc_block_public_access_options: + name: vpc_block_public_access_options + id: awscc.ec2.vpc_block_public_access_options + x-cfn-schema-name: VPCBlockPublicAccessOptions + x-cfn-type-name: AWS::EC2::VPCBlockPublicAccessOptions x-identifiers: - - VpcId + - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCBlockPublicAccessOptions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCBlockPublicAccessOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCBlockPublicAccessOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCBlockPublicAccessOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_block_public_access_options/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_block_public_access_options/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_block_public_access_options/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' + data__Identifier, + JSON_EXTRACT(Properties, '$.InternetGatewayBlockMode') as internet_gateway_block_mode, + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.ExclusionsAllowed') as exclusions_allowed + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCBlockPublicAccessOptions' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' + data__Identifier, + json_extract_path_text(Properties, 'InternetGatewayBlockMode') as internet_gateway_block_mode, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'ExclusionsAllowed') as exclusions_allowed + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCBlockPublicAccessOptions' + AND data__Identifier = '' AND region = 'us-east-1' - vpc: - name: vpc - id: awscc.ec2.vpc - x-cfn-schema-name: VPC - x-type: get + vpc_cidr_blocks: + name: vpc_cidr_blocks + id: awscc.ec2.vpc_cidr_blocks + x-cfn-schema-name: VPCCidrBlock + x-cfn-type-name: AWS::EC2::VPCCidrBlock x-identifiers: + - Id - VpcId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCCidrBlock&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCCidrBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCCidrBlock" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_cidr_blocks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_cidr_blocks/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block, - JSON_EXTRACT(Properties, '$.CidrBlockAssociations') as cidr_block_associations, - JSON_EXTRACT(Properties, '$.DefaultNetworkAcl') as default_network_acl, - JSON_EXTRACT(Properties, '$.DefaultSecurityGroup') as default_security_group, - JSON_EXTRACT(Properties, '$.Ipv6CidrBlocks') as ipv6_cidr_blocks, - JSON_EXTRACT(Properties, '$.EnableDnsHostnames') as enable_dns_hostnames, - JSON_EXTRACT(Properties, '$.EnableDnsSupport') as enable_dns_support, - JSON_EXTRACT(Properties, '$.InstanceTenancy') as instance_tenancy, + JSON_EXTRACT(Properties, '$.Ipv6Pool') as ipv6_pool, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.Ipv6CidrBlock') as ipv6_cidr_block, JSON_EXTRACT(Properties, '$.Ipv4IpamPoolId') as ipv4_ipam_pool_id, JSON_EXTRACT(Properties, '$.Ipv4NetmaskLength') as ipv4_netmask_length, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPC' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Ipv6IpamPoolId') as ipv6_ipam_pool_id, + JSON_EXTRACT(Properties, '$.Ipv6NetmaskLength') as ipv6_netmask_length, + JSON_EXTRACT(Properties, '$.AmazonProvidedIpv6CidrBlock') as amazon_provided_ipv6_cidr_block, + JSON_EXTRACT(Properties, '$.Ipv6AddressAttribute') as ipv6_address_attribute, + JSON_EXTRACT(Properties, '$.IpSource') as ip_source, + JSON_EXTRACT(Properties, '$.Ipv6CidrBlockNetworkBorderGroup') as ipv6_cidr_block_network_border_group + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'VpcId') as vpc_id, json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'CidrBlockAssociations') as cidr_block_associations, - json_extract_path_text(Properties, 'DefaultNetworkAcl') as default_network_acl, - json_extract_path_text(Properties, 'DefaultSecurityGroup') as default_security_group, - json_extract_path_text(Properties, 'Ipv6CidrBlocks') as ipv6_cidr_blocks, - json_extract_path_text(Properties, 'EnableDnsHostnames') as enable_dns_hostnames, - json_extract_path_text(Properties, 'EnableDnsSupport') as enable_dns_support, - json_extract_path_text(Properties, 'InstanceTenancy') as instance_tenancy, + json_extract_path_text(Properties, 'Ipv6Pool') as ipv6_pool, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPC' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, + json_extract_path_text(Properties, 'AmazonProvidedIpv6CidrBlock') as amazon_provided_ipv6_cidr_block, + json_extract_path_text(Properties, 'Ipv6AddressAttribute') as ipv6_address_attribute, + json_extract_path_text(Properties, 'IpSource') as ip_source, + json_extract_path_text(Properties, 'Ipv6CidrBlockNetworkBorderGroup') as ipv6_cidr_block_network_border_group + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' + AND data__Identifier = '|' AND region = 'us-east-1' - vpcdhcp_options_associations: - name: vpcdhcp_options_associations - id: awscc.ec2.vpcdhcp_options_associations - x-cfn-schema-name: VPCDHCPOptionsAssociation - x-type: list + vpc_cidr_blocks_list_only: + name: vpc_cidr_blocks_list_only + id: awscc.ec2.vpc_cidr_blocks_list_only + x-cfn-schema-name: VPCCidrBlock + x-cfn-type-name: AWS::EC2::VPCCidrBlock x-identifiers: - - DhcpOptionsId + - Id - VpcId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12596,31 +27061,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id, + JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, + json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' AND region = 'us-east-1' - vpcdhcp_options_association: - name: vpcdhcp_options_association - id: awscc.ec2.vpcdhcp_options_association + vpcdhcp_options_associations: + name: vpcdhcp_options_associations + id: awscc.ec2.vpcdhcp_options_associations x-cfn-schema-name: VPCDHCPOptionsAssociation - x-type: get + x-cfn-type-name: AWS::EC2::VPCDHCPOptionsAssociation x-identifiers: - DhcpOptionsId - VpcId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCDHCPOptionsAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCDHCPOptionsAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCDHCPOptionsAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCDHCPOptionsAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12631,7 +27144,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12641,13 +27154,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' AND data__Identifier = '|' AND region = 'us-east-1' - vpc_endpoints: - name: vpc_endpoints - id: awscc.ec2.vpc_endpoints - x-cfn-schema-name: VPCEndpoint - x-type: list + vpcdhcp_options_associations_list_only: + name: vpcdhcp_options_associations_list_only + id: awscc.ec2.vpcdhcp_options_associations_list_only + x-cfn-schema-name: VPCDHCPOptionsAssociation + x-cfn-type-name: AWS::EC2::VPCDHCPOptionsAssociation x-identifiers: - - Id + - DhcpOptionsId + - VpcId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12655,75 +27175,143 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' + JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' AND region = 'us-east-1' - vpc_endpoint: - name: vpc_endpoint - id: awscc.ec2.vpc_endpoint + vpc_endpoints: + name: vpc_endpoints + id: awscc.ec2.vpc_endpoints x-cfn-schema-name: VPCEndpoint - x-type: get + x-cfn-type-name: AWS::EC2::VPCEndpoint x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.PrivateDnsEnabled') as private_dns_enabled, + JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type, + JSON_EXTRACT(Properties, '$.ServiceRegion') as service_region, JSON_EXTRACT(Properties, '$.CreationTimestamp') as creation_timestamp, - JSON_EXTRACT(Properties, '$.DnsEntries') as dns_entries, + JSON_EXTRACT(Properties, '$.DnsOptions') as dns_options, JSON_EXTRACT(Properties, '$.NetworkInterfaceIds') as network_interface_ids, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PrivateDnsEnabled') as private_dns_enabled, - JSON_EXTRACT(Properties, '$.RouteTableIds') as route_table_ids, + JSON_EXTRACT(Properties, '$.DnsEntries') as dns_entries, + JSON_EXTRACT(Properties, '$.ResourceConfigurationArn') as resource_configuration_arn, JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, - JSON_EXTRACT(Properties, '$.ServiceName') as service_name, JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.ServiceNetworkArn') as service_network_arn, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.RouteTableIds') as route_table_ids, + JSON_EXTRACT(Properties, '$.ServiceName') as service_name, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, JSON_EXTRACT(Properties, '$.VpcEndpointType') as vpc_endpoint_type, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PrivateDnsEnabled') as private_dns_enabled, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'ServiceRegion') as service_region, json_extract_path_text(Properties, 'CreationTimestamp') as creation_timestamp, - json_extract_path_text(Properties, 'DnsEntries') as dns_entries, + json_extract_path_text(Properties, 'DnsOptions') as dns_options, json_extract_path_text(Properties, 'NetworkInterfaceIds') as network_interface_ids, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PrivateDnsEnabled') as private_dns_enabled, - json_extract_path_text(Properties, 'RouteTableIds') as route_table_ids, + json_extract_path_text(Properties, 'DnsEntries') as dns_entries, + json_extract_path_text(Properties, 'ResourceConfigurationArn') as resource_configuration_arn, json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'ServiceName') as service_name, json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'ServiceNetworkArn') as service_network_arn, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'RouteTableIds') as route_table_ids, + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, json_extract_path_text(Properties, 'VpcEndpointType') as vpc_endpoint_type, - json_extract_path_text(Properties, 'VpcId') as vpc_id + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' AND data__Identifier = '' AND region = 'us-east-1' - vpc_endpoint_connection_notifications: - name: vpc_endpoint_connection_notifications - id: awscc.ec2.vpc_endpoint_connection_notifications - x-cfn-schema-name: VPCEndpointConnectionNotification - x-type: list + vpc_endpoints_list_only: + name: vpc_endpoints_list_only + id: awscc.ec2.vpc_endpoints_list_only + x-cfn-schema-name: VPCEndpoint + x-cfn-type-name: AWS::EC2::VPCEndpoint x-identifiers: - - VPCEndpointConnectionNotificationId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12731,61 +27319,115 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' AND region = 'us-east-1' - vpc_endpoint_connection_notification: - name: vpc_endpoint_connection_notification - id: awscc.ec2.vpc_endpoint_connection_notification + vpc_endpoint_connection_notifications: + name: vpc_endpoint_connection_notifications + id: awscc.ec2.vpc_endpoint_connection_notifications x-cfn-schema-name: VPCEndpointConnectionNotification - x-type: get + x-cfn-type-name: AWS::EC2::VPCEndpointConnectionNotification x-identifiers: - VPCEndpointConnectionNotificationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCEndpointConnectionNotification&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointConnectionNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointConnectionNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointConnectionNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id, JSON_EXTRACT(Properties, '$.ConnectionEvents') as connection_events, + JSON_EXTRACT(Properties, '$.VPCEndpointId') as vpc_endpoint_id, + JSON_EXTRACT(Properties, '$.VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id, JSON_EXTRACT(Properties, '$.ConnectionNotificationArn') as connection_notification_arn, - JSON_EXTRACT(Properties, '$.ServiceId') as service_id, - JSON_EXTRACT(Properties, '$.VPCEndpointId') as vpc_endpoint_id + JSON_EXTRACT(Properties, '$.ServiceId') as service_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id, json_extract_path_text(Properties, 'ConnectionEvents') as connection_events, + json_extract_path_text(Properties, 'VPCEndpointId') as vpc_endpoint_id, + json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id, json_extract_path_text(Properties, 'ConnectionNotificationArn') as connection_notification_arn, - json_extract_path_text(Properties, 'ServiceId') as service_id, - json_extract_path_text(Properties, 'VPCEndpointId') as vpc_endpoint_id + json_extract_path_text(Properties, 'ServiceId') as service_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' AND data__Identifier = '' AND region = 'us-east-1' - vpc_endpoint_services: - name: vpc_endpoint_services - id: awscc.ec2.vpc_endpoint_services - x-cfn-schema-name: VPCEndpointService - x-type: list + vpc_endpoint_connection_notifications_list_only: + name: vpc_endpoint_connection_notifications_list_only + id: awscc.ec2.vpc_endpoint_connection_notifications_list_only + x-cfn-schema-name: VPCEndpointConnectionNotification + x-cfn-type-name: AWS::EC2::VPCEndpointConnectionNotification x-identifiers: - - ServiceId + - VPCEndpointConnectionNotificationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12793,28 +27435,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ServiceId') as service_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' + JSON_EXTRACT(Properties, '$.VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ServiceId') as service_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' + json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' AND region = 'us-east-1' - vpc_endpoint_service: - name: vpc_endpoint_service - id: awscc.ec2.vpc_endpoint_service + vpc_endpoint_services: + name: vpc_endpoint_services + id: awscc.ec2.vpc_endpoint_services x-cfn-schema-name: VPCEndpointService - x-type: get + x-cfn-type-name: AWS::EC2::VPCEndpointService x-identifiers: - ServiceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCEndpointService&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointService" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointService" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointService" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12824,12 +27514,15 @@ components: JSON_EXTRACT(Properties, '$.PayerResponsibility') as payer_responsibility, JSON_EXTRACT(Properties, '$.ServiceId') as service_id, JSON_EXTRACT(Properties, '$.AcceptanceRequired') as acceptance_required, - JSON_EXTRACT(Properties, '$.GatewayLoadBalancerArns') as gateway_load_balancer_arns + JSON_EXTRACT(Properties, '$.GatewayLoadBalancerArns') as gateway_load_balancer_arns, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.SupportedIpAddressTypes') as supported_ip_address_types, + JSON_EXTRACT(Properties, '$.SupportedRegions') as supported_regions FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12839,21 +27532,103 @@ components: json_extract_path_text(Properties, 'PayerResponsibility') as payer_responsibility, json_extract_path_text(Properties, 'ServiceId') as service_id, json_extract_path_text(Properties, 'AcceptanceRequired') as acceptance_required, - json_extract_path_text(Properties, 'GatewayLoadBalancerArns') as gateway_load_balancer_arns + json_extract_path_text(Properties, 'GatewayLoadBalancerArns') as gateway_load_balancer_arns, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SupportedIpAddressTypes') as supported_ip_address_types, + json_extract_path_text(Properties, 'SupportedRegions') as supported_regions FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' AND data__Identifier = '' AND region = 'us-east-1' + vpc_endpoint_services_list_only: + name: vpc_endpoint_services_list_only + id: awscc.ec2.vpc_endpoint_services_list_only + x-cfn-schema-name: VPCEndpointService + x-cfn-type-name: AWS::EC2::VPCEndpointService + x-identifiers: + - ServiceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ServiceId') as service_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceId') as service_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' + AND region = 'us-east-1' vpc_endpoint_service_permissions: name: vpc_endpoint_service_permissions id: awscc.ec2.vpc_endpoint_service_permissions x-cfn-schema-name: VPCEndpointServicePermissions - x-type: get + x-cfn-type-name: AWS::EC2::VPCEndpointServicePermissions x-identifiers: - ServiceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCEndpointServicePermissions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointServicePermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointServicePermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCEndpointServicePermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12864,7 +27639,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12874,14 +27649,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' AND data__Identifier = '' AND region = 'us-east-1' - vpc_gateway_attachments: - name: vpc_gateway_attachments - id: awscc.ec2.vpc_gateway_attachments - x-cfn-schema-name: VPCGatewayAttachment - x-type: list + vpc_endpoint_service_permissions_list_only: + name: vpc_endpoint_service_permissions_list_only + id: awscc.ec2.vpc_endpoint_service_permissions_list_only + x-cfn-schema-name: VPCEndpointServicePermissions + x-cfn-type-name: AWS::EC2::VPCEndpointServicePermissions x-identifiers: - - AttachmentType - - VpcId + - ServiceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12889,31 +27669,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AttachmentType') as attachment_type, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' + JSON_EXTRACT(Properties, '$.ServiceId') as service_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' + json_extract_path_text(Properties, 'ServiceId') as service_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' AND region = 'us-east-1' - vpc_gateway_attachment: - name: vpc_gateway_attachment - id: awscc.ec2.vpc_gateway_attachment + vpc_gateway_attachments: + name: vpc_gateway_attachments + id: awscc.ec2.vpc_gateway_attachments x-cfn-schema-name: VPCGatewayAttachment - x-type: get + x-cfn-type-name: AWS::EC2::VPCGatewayAttachment x-identifiers: - AttachmentType - VpcId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCGatewayAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12926,7 +27752,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12938,13 +27764,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' AND data__Identifier = '|' AND region = 'us-east-1' - vpc_peering_connections: - name: vpc_peering_connections - id: awscc.ec2.vpc_peering_connections - x-cfn-schema-name: VPCPeeringConnection - x-type: list + vpc_gateway_attachments_list_only: + name: vpc_gateway_attachments_list_only + id: awscc.ec2.vpc_gateway_attachments_list_only + x-cfn-schema-name: VPCGatewayAttachment + x-cfn-type-name: AWS::EC2::VPCGatewayAttachment x-identifiers: - - Id + - AttachmentType + - VpcId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12952,65 +27785,121 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' + JSON_EXTRACT(Properties, '$.AttachmentType') as attachment_type, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' AND region = 'us-east-1' - vpc_peering_connection: - name: vpc_peering_connection - id: awscc.ec2.vpc_peering_connection + vpc_peering_connections: + name: vpc_peering_connections + id: awscc.ec2.vpc_peering_connections x-cfn-schema-name: VPCPeeringConnection - x-type: get + x-cfn-type-name: AWS::EC2::VPCPeeringConnection x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCPeeringConnection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCPeeringConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCPeeringConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCPeeringConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.PeerOwnerId') as peer_owner_id, - JSON_EXTRACT(Properties, '$.PeerRegion') as peer_region, JSON_EXTRACT(Properties, '$.PeerRoleArn') as peer_role_arn, - JSON_EXTRACT(Properties, '$.PeerVpcId') as peer_vpc_id, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.PeerVpcId') as peer_vpc_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.PeerRegion') as peer_region, + JSON_EXTRACT(Properties, '$.PeerOwnerId') as peer_owner_id, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PeerOwnerId') as peer_owner_id, - json_extract_path_text(Properties, 'PeerRegion') as peer_region, json_extract_path_text(Properties, 'PeerRoleArn') as peer_role_arn, - json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PeerRegion') as peer_region, + json_extract_path_text(Properties, 'PeerOwnerId') as peer_owner_id, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' AND data__Identifier = '' AND region = 'us-east-1' - vpn_connections: - name: vpn_connections - id: awscc.ec2.vpn_connections - x-cfn-schema-name: VPNConnection - x-type: list + vpc_peering_connections_list_only: + name: vpc_peering_connections_list_only + id: awscc.ec2.vpc_peering_connections_list_only + x-cfn-schema-name: VPCPeeringConnection + x-cfn-type-name: AWS::EC2::VPCPeeringConnection x-identifiers: - - VpnConnectionId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -13018,68 +27907,139 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' AND region = 'us-east-1' - vpn_connection: - name: vpn_connection - id: awscc.ec2.vpn_connection + vpn_connections: + name: vpn_connections + id: awscc.ec2.vpn_connections x-cfn-schema-name: VPNConnection - x-type: get + x-cfn-type-name: AWS::EC2::VPNConnection x-identifiers: - VpnConnectionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPNConnection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id, + JSON_EXTRACT(Properties, '$.RemoteIpv6NetworkCidr') as remote_ipv6_network_cidr, + JSON_EXTRACT(Properties, '$.RemoteIpv4NetworkCidr') as remote_ipv4_network_cidr, + JSON_EXTRACT(Properties, '$.VpnTunnelOptionsSpecifications') as vpn_tunnel_options_specifications, JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id, + JSON_EXTRACT(Properties, '$.OutsideIpAddressType') as outside_ip_address_type, JSON_EXTRACT(Properties, '$.StaticRoutesOnly') as static_routes_only, - JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.EnableAcceleration') as enable_acceleration, JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.LocalIpv4NetworkCidr') as local_ipv4_network_cidr, JSON_EXTRACT(Properties, '$.VpnGatewayId') as vpn_gateway_id, - JSON_EXTRACT(Properties, '$.VpnTunnelOptionsSpecifications') as vpn_tunnel_options_specifications + JSON_EXTRACT(Properties, '$.PreSharedKeyStorage') as pre_shared_key_storage, + JSON_EXTRACT(Properties, '$.TransportTransitGatewayAttachmentId') as transport_transit_gateway_attachment_id, + JSON_EXTRACT(Properties, '$.LocalIpv6NetworkCidr') as local_ipv6_network_cidr, + JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id, + JSON_EXTRACT(Properties, '$.TunnelInsideIpVersion') as tunnel_inside_ip_version, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnection' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id, + json_extract_path_text(Properties, 'RemoteIpv6NetworkCidr') as remote_ipv6_network_cidr, + json_extract_path_text(Properties, 'RemoteIpv4NetworkCidr') as remote_ipv4_network_cidr, + json_extract_path_text(Properties, 'VpnTunnelOptionsSpecifications') as vpn_tunnel_options_specifications, json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, + json_extract_path_text(Properties, 'OutsideIpAddressType') as outside_ip_address_type, json_extract_path_text(Properties, 'StaticRoutesOnly') as static_routes_only, - json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EnableAcceleration') as enable_acceleration, json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'LocalIpv4NetworkCidr') as local_ipv4_network_cidr, json_extract_path_text(Properties, 'VpnGatewayId') as vpn_gateway_id, - json_extract_path_text(Properties, 'VpnTunnelOptionsSpecifications') as vpn_tunnel_options_specifications + json_extract_path_text(Properties, 'PreSharedKeyStorage') as pre_shared_key_storage, + json_extract_path_text(Properties, 'TransportTransitGatewayAttachmentId') as transport_transit_gateway_attachment_id, + json_extract_path_text(Properties, 'LocalIpv6NetworkCidr') as local_ipv6_network_cidr, + json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id, + json_extract_path_text(Properties, 'TunnelInsideIpVersion') as tunnel_inside_ip_version, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnection' AND data__Identifier = '' AND region = 'us-east-1' - vpn_connection_routes: - name: vpn_connection_routes - id: awscc.ec2.vpn_connection_routes - x-cfn-schema-name: VPNConnectionRoute - x-type: list + vpn_connections_list_only: + name: vpn_connections_list_only + id: awscc.ec2.vpn_connections_list_only + x-cfn-schema-name: VPNConnection + x-cfn-type-name: AWS::EC2::VPNConnection x-identifiers: - - DestinationCidrBlock - VpnConnectionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -13087,31 +28047,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' AND region = 'us-east-1' - vpn_connection_route: - name: vpn_connection_route - id: awscc.ec2.vpn_connection_route + vpn_connection_routes: + name: vpn_connection_routes + id: awscc.ec2.vpn_connection_routes x-cfn-schema-name: VPNConnectionRoute - x-type: get + x-cfn-type-name: AWS::EC2::VPNConnectionRoute x-identifiers: - DestinationCidrBlock - VpnConnectionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPNConnectionRoute&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNConnectionRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNConnectionRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpn_connection_routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpn_connection_routes/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13122,7 +28115,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13132,13 +28125,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' AND data__Identifier = '|' AND region = 'us-east-1' - vpn_gateways: - name: vpn_gateways - id: awscc.ec2.vpn_gateways - x-cfn-schema-name: VPNGateway - x-type: list + vpn_connection_routes_list_only: + name: vpn_connection_routes_list_only + id: awscc.ec2.vpn_connection_routes_list_only + x-cfn-schema-name: VPNConnectionRoute + x-cfn-type-name: AWS::EC2::VPNConnectionRoute x-identifiers: - - VPNGatewayId + - DestinationCidrBlock + - VpnConnectionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -13146,28 +28146,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.VPNGatewayId') as v_pn_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' AND region = 'us-east-1' - vpn_gateway: - name: vpn_gateway - id: awscc.ec2.vpn_gateway + vpn_gateways: + name: vpn_gateways + id: awscc.ec2.vpn_gateways x-cfn-schema-name: VPNGateway - x-type: get + x-cfn-type-name: AWS::EC2::VPNGateway x-identifiers: - VPNGatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPNGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPNGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13180,7 +28230,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13192,104 +28242,4219 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNGateway' AND data__Identifier = '' AND region = 'us-east-1' - instances: - name: instances - id: awscc.ec2.instances - x-cfn-schema-name: instances - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - instanceId, - instanceState, - instanceType, - vpcId, - subnetId, - amiLaunchIndex, - architecture, - blockDeviceMapping, - bootMode, - capacityReservationId, - capacityReservationSpecification, - clientToken, - cpuOptions, - dnsName, - ebsOptimized, - elasticGpuAssociationSet, - elasticInferenceAcceleratorAssociationSet, - enaSupport, - enclaveOptions, - groupSet, - hibernationOptions, - hypervisor, - iamInstanceProfile, - imageId, - instanceLifecycle, - ipAddress, - ipv6Address, - kernelId, - keyName, - launchTime, - licenseSet, - maintenanceOptions, - metadataOptions, - monitoring, - networkInterfaceSet, - outpostArn, - placement, - platform, - platformDetails, - privateDnsName, - privateDnsNameOptions, - privateIpAddress, - productCodes, - ramdiskId, - reason, - rootDeviceName, - rootDeviceType, - sourceDestCheck, - spotInstanceRequestId, - sriovNetSupport, - stateReason, - tagSet, - tpmSupport, - usageOperation, - usageOperationUpdateTime, - virtualizationType, - region - FROM aws.ec2.instances - WHERE region = 'us-east-1' - snapshots: - name: snapshots - id: awscc.ec2.snapshots - x-cfn-schema-name: snapshots - x-type: custom_list + vpn_gateways_list_only: + name: vpn_gateways_list_only + id: awscc.ec2.vpn_gateways_list_only + x-cfn-schema-name: VPNGateway + x-cfn-type-name: AWS::EC2::VPNGateway + x-identifiers: + - VPNGatewayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" ddl: |- SELECT - description, - dataEncryptionKeyId, - encrypted, - kmsKeyId, - outpostArn, - ownerAlias, - ownerId, - progress, - restoreExpiryTime, - snapshotId, - startTime, - status, - statusMessage, - storageTier, - tagSet, - volumeId, - volumeSize, - region - FROM aws.ec2.snapshots - WHERE region = 'us-east-1' + region, + JSON_EXTRACT(Properties, '$.VPNGatewayId') as v_pn_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CapacityReservation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCapacityReservation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCapacityReservationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CapacityReservationFleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCapacityReservationFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCapacityReservationFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CarrierGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCarrierGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCarrierGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomerGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomerGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomerGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DHCPOptions&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDHCPOptions + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDHCPOptionsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EC2Fleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEC2Fleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEC2FleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EgressOnlyInternetGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEgressOnlyInternetGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EIP&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEIP + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEIPRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EIPAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEIPAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEIPAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnclaveCertificateIamRoleAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnclaveCertificateIamRoleAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnclaveCertificateIamRoleAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowLog&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowLog + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowLogRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GatewayRouteTableAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGatewayRouteTableAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGatewayRouteTableAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Host&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHost + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHostRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkInterface&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkInterface + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkInterfaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Volume&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVolume + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVolumeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceConnectEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceConnectEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceConnectEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InternetGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInternetGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInternetGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAM&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAM + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAMAllocation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAMAllocation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMAllocationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAMPool&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAMPool + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMPoolRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAMPoolCidr&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAMPoolCidr + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMPoolCidrRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAMResourceDiscovery&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAMResourceDiscovery + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMResourceDiscoveryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAMResourceDiscoveryAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAMResourceDiscoveryAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMResourceDiscoveryAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPAMScope&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPAMScope + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPAMScopeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IpPoolRouteTableAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIpPoolRouteTableAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIpPoolRouteTableAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__KeyPair&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKeyPair + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyPairRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LaunchTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLaunchTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocalGatewayRoute&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocalGatewayRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocalGatewayRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocalGatewayRouteTable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocalGatewayRouteTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocalGatewayRouteTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocalGatewayRouteTableVirtualInterfaceGroupAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LocalGatewayRouteTableVPCAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocalGatewayRouteTableVPCAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocalGatewayRouteTableVPCAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NatGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNatGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNatGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkAcl&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkAcl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkAclRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkInsightsAccessScope&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkInsightsAccessScope + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkInsightsAccessScopeAnalysis&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkInsightsAccessScopeAnalysis + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeAnalysisRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkInsightsAnalysis&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkInsightsAnalysis + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsAnalysisRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkInsightsPath&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkInsightsPath + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsPathRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkInterfaceAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkInterfaceAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkInterfaceAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkPerformanceMetricSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkPerformanceMetricSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkPerformanceMetricSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PlacementGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlacementGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlacementGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PrefixList&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrefixList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePrefixListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Route&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteServer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteServer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteServerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteServerAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteServerAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteServerAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteServerEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteServerEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteServerEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteServerPeer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteServerPeer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteServerPeerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteServerPropagation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteServerPropagation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteServerPropagationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteTable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityGroupEgress&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityGroupEgress + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityGroupEgressRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityGroupIngress&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityGroupIngress + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityGroupIngressRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityGroupVpcAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityGroupVpcAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityGroupVpcAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SnapshotBlockPublicAccess&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSnapshotBlockPublicAccess + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSnapshotBlockPublicAccessRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SpotFleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSpotFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSpotFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Subnet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubnet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubnetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubnetCidrBlock&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubnetCidrBlock + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubnetCidrBlockRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubnetNetworkAclAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubnetNetworkAclAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubnetNetworkAclAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubnetRouteTableAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubnetRouteTableAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubnetRouteTableAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrafficMirrorFilter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrafficMirrorFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrafficMirrorFilterRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrafficMirrorFilterRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrafficMirrorSession&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrafficMirrorSession + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorSessionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrafficMirrorTarget&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrafficMirrorTarget + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorTargetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayConnect&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayConnect + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayConnectPeer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayConnectPeer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectPeerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastDomain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayMulticastDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastDomainAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayMulticastDomainAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastGroupMember&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayMulticastGroupMember + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastGroupMemberRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayMulticastGroupSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayMulticastGroupSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastGroupSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayPeeringAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayPeeringAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRoute&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRouteTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTableAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRouteTableAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteTableAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTablePropagation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRouteTablePropagation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteTablePropagationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayVpcAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayVpcAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VerifiedAccessEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVerifiedAccessEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVerifiedAccessEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VerifiedAccessGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVerifiedAccessGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVerifiedAccessGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VerifiedAccessTrustProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVerifiedAccessTrustProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVerifiedAccessTrustProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VerifiedAccessInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVerifiedAccessInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVerifiedAccessInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VolumeAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVolumeAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVolumeAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPC&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPC + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCBlockPublicAccessExclusion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCBlockPublicAccessExclusion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCBlockPublicAccessExclusionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCBlockPublicAccessOptions&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCBlockPublicAccessOptions + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCBlockPublicAccessOptionsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCCidrBlock&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCCidrBlock + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCCidrBlockRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCDHCPOptionsAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCDHCPOptionsAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCDHCPOptionsAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCEndpointConnectionNotification&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCEndpointConnectionNotification + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCEndpointConnectionNotificationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCEndpointService&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCEndpointService + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCEndpointServiceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCEndpointServicePermissions&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCEndpointServicePermissions + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCEndpointServicePermissionsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCGatewayAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCGatewayAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCGatewayAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCPeeringConnection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCPeeringConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCPeeringConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPNConnection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPNConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPNConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPNConnectionRoute&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPNConnectionRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPNConnectionRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPNGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPNGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPNGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ecr.yaml b/providers/src/awscc/v00.00.00000/services/ecr.yaml index 20063feb..49514d23 100644 --- a/providers/src/awscc/v00.00.00000/services/ecr.yaml +++ b/providers/src/awscc/v00.00.00000/services/ecr.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ECR - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: RegistryId: type: string @@ -50,40 +430,43 @@ components: description: Provide a detailed description of the repository. Identify what is included in the repository, any licensing details, or other relevant information. maxLength: 10240 Tag: - description: A key-value pair to associate with a resource. + description: The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. type: object properties: Key: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + description: One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values. minLength: 1 - maxLength: 127 + maxLength: 128 Value: type: string - description: 'The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' - minLength: 1 - maxLength: 255 + description: A ``value`` acts as a descriptor within a tag category (key). + minLength: 0 + maxLength: 256 required: - - Value - Key + - Value additionalProperties: false PublicRepository: type: object properties: RepositoryName: type: string - description: The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. + description: |- + The name to use for the public repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. minLength: 2 maxLength: 256 pattern: ^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$ RepositoryPolicyText: type: object - description: 'The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. ' + description: The JSON repository policy text to apply to the public repository. For more information, see [Amazon ECR Public repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon ECR Public User Guide*. Arn: type: string + description: '' RepositoryCatalogData: type: object - description: The CatalogData property type specifies Catalog data for ECR Public Repository. For information about Catalog Data, see + description: The details about the repository that are publicly visible in the Amazon ECR Public Gallery. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*. properties: RepositoryDescription: $ref: '#/components/schemas/RepositoryDescription' @@ -105,12 +488,24 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: public_repository - x-stackql-primaryIdentifier: + description: The ``AWS::ECR::PublicRepository`` resource specifies an Amazon Elastic Container Registry Public (Amazon ECR Public) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR public repositories](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repositories.html) in the *Amazon ECR Public User Guide*. + x-type-name: AWS::ECR::PublicRepository + x-stackql-primary-identifier: - RepositoryName x-create-only-properties: - RepositoryName x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ecr-public:ListTagsForResource + - ecr-public:TagResource + - ecr-public:UntagResource x-required-permissions: create: - ecr-public:CreateRepository @@ -123,6 +518,7 @@ components: - ecr-public:GetRepositoryCatalogData - ecr-public:ListTagsForResource update: + - ecr-public:DescribeRepositories - ecr-public:SetRepositoryPolicy - ecr-public:DeleteRepositoryPolicy - ecr-public:PutRepositoryCatalogData @@ -136,31 +532,41 @@ components: type: object properties: EcrRepositoryPrefix: - type: string - description: The ECRRepositoryPrefix is a custom alias for upstream registry url. - minLength: 2 - maxLength: 30 - pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)* + $ref: '#/components/schemas/EcrRepositoryPrefix' + description: The Amazon ECR repository prefix associated with the pull through cache rule. UpstreamRegistryUrl: - type: string - description: The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached + $ref: '#/components/schemas/UpstreamRegistryUrl' + description: The upstream registry URL associated with the pull through cache rule. CredentialArn: - type: string - description: The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry. - minLength: 50 - maxLength: 612 - pattern: ^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\-pullthroughcache\/[a-zA-Z0-9\/_+=.@-]+$ + $ref: '#/components/schemas/CredentialArn' + description: The ARN of the Secrets Manager secret associated with the pull through cache rule. UpstreamRegistry: - type: string - description: The name of the upstream registry. + $ref: '#/components/schemas/UpstreamRegistry' + description: The name of the upstream source registry associated with the pull through cache rule. + CustomRoleArn: + $ref: '#/components/schemas/CustomRoleArn' + description: The ARN of the IAM role associated with the pull through cache rule. + UpstreamRepositoryPrefix: + $ref: '#/components/schemas/UpstreamRepositoryPrefix' + description: The upstream repository prefix associated with the pull through cache rule. x-stackql-resource-name: pull_through_cache_rule - x-stackql-primaryIdentifier: + description: The ``AWS::ECR::PullThroughCacheRule`` resource creates or updates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry in your Amazon ECR private registry. + x-type-name: AWS::ECR::PullThroughCacheRule + x-stackql-primary-identifier: - EcrRepositoryPrefix x-create-only-properties: - EcrRepositoryPrefix - UpstreamRegistryUrl - CredentialArn - UpstreamRegistry + - CustomRoleArn + - UpstreamRepositoryPrefix + x-write-only-properties: + - CredentialArn + - UpstreamRegistry + - CustomRoleArn + x-tagging: + taggable: false x-required-permissions: create: - ecr:DescribePullThroughCacheRules @@ -168,6 +574,7 @@ components: - ecr:DeletePullThroughCacheRule - iam:CreateServiceLinkedRole - secretsmanager:GetSecretValue + - iam:PassRole read: - ecr:DescribePullThroughCacheRules update: @@ -176,6 +583,7 @@ components: - ecr:DeletePullThroughCacheRule - iam:CreateServiceLinkedRole - secretsmanager:GetSecretValue + - iam:PassRole delete: - ecr:DescribePullThroughCacheRules - ecr:DeletePullThroughCacheRule @@ -186,7 +594,7 @@ components: description: The ECRRepositoryPrefix is a custom alias for upstream registry url. minLength: 2 maxLength: 30 - pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)* + pattern: ^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$ UpstreamRegistryUrl: type: string description: The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached @@ -199,21 +607,40 @@ components: UpstreamRegistry: type: string description: The name of the upstream registry. + CustomRoleArn: + type: string + description: The ARN of the IAM role to be assumed by Amazon ECR to authenticate to ECR upstream registry. This role must be in the same account as the registry that you are configuring. + maxLength: 2048 + UpstreamRepositoryPrefix: + type: string + description: The repository name prefix of upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the `ROOT`. + minLength: 2 + maxLength: 30 + pattern: ^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$ RegistryPolicy: type: object properties: RegistryId: $ref: '#/components/schemas/RegistryId' + description: '' PolicyText: type: object - description: The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the Amazon Elastic Container Registry User Guide. + description: The JSON policy text for your registry. required: - PolicyText x-stackql-resource-name: registry_policy - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry. + A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*. + x-type-name: AWS::ECR::RegistryPolicy + x-stackql-primary-identifier: - RegistryId x-read-only-properties: - RegistryId + x-required-properties: + - PolicyText + x-tagging: + taggable: false x-required-permissions: create: - ecr:GetRegistryPolicy @@ -227,21 +654,142 @@ components: - ecr:PutRegistryPolicy delete: - ecr:DeleteRegistryPolicy + ScanningRules: + type: array + minItems: 0 + maxItems: 2 + x-insertionOrder: false + items: + $ref: '#/components/schemas/ScanningRule' + description: The scanning rules associated with the registry. A registry scanning configuration may contain a maximum of 2 rules. + ScanningRule: + type: object + properties: + RepositoryFilters: + type: array + minItems: 0 + maxItems: 100 + x-insertionOrder: false + items: + $ref: '#/components/schemas/RepositoryFilter' + description: The details of a scanning repository filter. For more information on how to use filters, see [Using filters](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters) in the *Amazon Elastic Container Registry User Guide*. + ScanFrequency: + $ref: '#/components/schemas/ScanFrequency' + description: The frequency that scans are performed at for a private registry. When the ``ENHANCED`` scan type is specified, the supported scan frequencies are ``CONTINUOUS_SCAN`` and ``SCAN_ON_PUSH``. When the ``BASIC`` scan type is specified, the ``SCAN_ON_PUSH`` scan frequency is supported. If scan on push is not specified, then the ``MANUAL`` scan frequency is set by default. + description: The scanning rules associated with the registry. + required: + - ScanFrequency + - RepositoryFilters + additionalProperties: false + RepositoryFilter: + type: object + properties: + Filter: + $ref: '#/components/schemas/Filter' + description: The repository filter details. When the ``PREFIX_MATCH`` filter type is specified, this value is required and should be the repository name prefix to configure replication for. + FilterType: + $ref: '#/components/schemas/FilterType' + description: The repository filter type. The only supported value is ``PREFIX_MATCH``, which is a repository name prefix specified with the ``filter`` parameter. + description: The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated. + required: + - Filter + - FilterType + additionalProperties: false + Filter: + type: string + description: The repository filter to be applied for replication. + pattern: ^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$ + FilterType: + description: Type of repository filter + type: string + enum: + - PREFIX_MATCH + ScanFrequency: + description: The frequency that scans are performed. + type: string + enum: + - SCAN_ON_PUSH + - CONTINUOUS_SCAN + ScanType: + description: The type of scanning configured for the registry. + type: string + enum: + - BASIC + - ENHANCED + RegistryScanningConfiguration: + type: object + properties: + Rules: + $ref: '#/components/schemas/ScanningRules' + description: The scanning rules associated with the registry. + ScanType: + $ref: '#/components/schemas/ScanType' + description: The type of scanning configured for the registry. + RegistryId: + $ref: '#/components/schemas/RegistryId' + description: '' + required: + - Rules + - ScanType + x-stackql-resource-name: registry_scanning_configuration + description: The scanning configuration for a private registry. + x-type-name: AWS::ECR::RegistryScanningConfiguration + x-stackql-primary-identifier: + - RegistryId + x-read-only-properties: + - RegistryId + x-required-properties: + - Rules + - ScanType + x-tagging: + taggable: false + x-required-permissions: + create: + - ecr:PutRegistryScanningConfiguration + - ecr:GetRegistryScanningConfiguration + - inspector2:Enable + - iam:CreateServiceLinkedRole + read: + - ecr:GetRegistryScanningConfiguration + update: + - ecr:PutRegistryScanningConfiguration + - ecr:GetRegistryScanningConfiguration + - inspector2:Enable + - inspector2:Disable + - inspector2:ListAccountPermissions + - iam:CreateServiceLinkedRole + delete: + - ecr:PutRegistryScanningConfiguration + - ecr:GetRegistryScanningConfiguration + - inspector2:ListAccountPermissions + - inspector2:Disable + list: + - ecr:GetRegistryScanningConfiguration ReplicationConfiguration: type: object properties: ReplicationConfiguration: $ref: '#/components/schemas/ReplicationConfiguration' + description: The replication configuration for a registry. RegistryId: type: string - description: The RegistryId associated with the aws account. + description: '' required: - ReplicationConfiguration x-stackql-resource-name: replication_configuration - x-stackql-primaryIdentifier: + description: >- + The ``AWS::ECR::ReplicationConfiguration`` resource creates or updates the replication configuration for a private registry. The first time a replication configuration is applied to a private registry, a service-linked IAM role is created in your account for the replication process. For more information, see [Using Service-Linked Roles for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) in the *Amazon Elastic Container Registry User + Guide*. + When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a private registry permissions policy. For more information, see ``AWS::ECR::RegistryPolicy``. + x-type-name: AWS::ECR::ReplicationConfiguration + x-stackql-primary-identifier: - RegistryId x-read-only-properties: - RegistryId + x-required-properties: + - ReplicationConfiguration + x-tagging: + taggable: false x-required-permissions: create: - ecr:DescribeRegistry @@ -268,47 +816,28 @@ components: maxItems: 100 items: $ref: '#/components/schemas/RepositoryFilter' - description: An array of objects representing the details of a repository filter. + description: An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated. Destinations: type: array minItems: 1 - maxItems: 25 + maxItems: 100 items: $ref: '#/components/schemas/ReplicationDestination' - description: An array of objects representing the details of a replication destination. - description: An array of objects representing the details of a replication destination. + description: An array of objects representing the destination for a replication rule. + description: An array of objects representing the replication destinations and repository filters for a replication configuration. required: - Destinations additionalProperties: false - RepositoryFilter: - type: object - properties: - Filter: - $ref: '#/components/schemas/Filter' - FilterType: - $ref: '#/components/schemas/FilterType' - description: An array of objects representing the details of a repository filter. - required: - - Filter - - FilterType - additionalProperties: false - Filter: - type: string - description: The repository filter to be applied for replication. - pattern: ^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$ - FilterType: - description: Type of repository filter - type: string - enum: - - PREFIX_MATCH ReplicationDestination: type: object properties: Region: $ref: '#/components/schemas/Region' + description: The Region to replicate to. RegistryId: $ref: '#/components/schemas/RegistryId' - description: An array of objects representing the details of a replication destination. + description: The AWS account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID. + description: An array of objects representing the destination for a replication rule. required: - Region - RegistryId @@ -319,12 +848,14 @@ components: pattern: '[0-9a-z-]{2,25}' LifecyclePolicy: type: object - description: The LifecyclePolicy property type specifies a lifecycle policy. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html + description: The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*. properties: LifecyclePolicyText: $ref: '#/components/schemas/LifecyclePolicyText' + description: The JSON repository policy text to apply to the repository. RegistryId: $ref: '#/components/schemas/RegistryId' + description: "The AWS account ID associated with the registry that contains the repository. If you do\L not specify a registry, the default registry is assumed." additionalProperties: false LifecyclePolicyText: type: string @@ -333,10 +864,11 @@ components: maxLength: 30720 ImageScanningConfiguration: type: object - description: The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository. + description: The image scanning configuration for a repository. properties: ScanOnPush: $ref: '#/components/schemas/ScanOnPush' + description: The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. additionalProperties: false ScanOnPush: type: boolean @@ -345,15 +877,20 @@ components: type: object description: |- The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. - - By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part. - - For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html + By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES256 encryption algorithm. This does not require any action on your part. + For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*. properties: EncryptionType: $ref: '#/components/schemas/EncryptionType' + description: |- + The encryption type to use. + If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. + If you use the ``KMS_DSSE`` encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the KMS Management Service key stored in KMS. Similar to the ``KMS`` encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you've already created. + If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm. + For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*. KmsKey: $ref: '#/components/schemas/KmsKey' + description: If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. required: - EncryptionType additionalProperties: false @@ -363,30 +900,66 @@ components: enum: - AES256 - KMS + - KMS_DSSE KmsKey: type: string - description: If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used. + description: If you use the KMS or KMS_DSSE encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used. minLength: 1 maxLength: 2048 EmptyOnDelete: type: boolean description: If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories. + ImageTagMutabilityExclusionFilter: + type: object + description: Overrides the default image tag mutability setting of the repository for image tags that match the specified filters. + properties: + ImageTagMutabilityExclusionFilterType: + type: string + description: '' + enum: + - WILDCARD + ImageTagMutabilityExclusionFilterValue: + type: string + description: '' + minLength: 1 + maxLength: 128 + pattern: ^[0-9a-zA-Z._*-]{1,128} + required: + - ImageTagMutabilityExclusionFilterType + - ImageTagMutabilityExclusionFilterValue + additionalProperties: false + ImageTagMutabilityExclusionFilterType: + type: string + description: Specifies the type of filter to use for excluding image tags from the repository's mutability setting. + enum: + - WILDCARD + ImageTagMutabilityExclusionFilterValue: + type: string + description: The value to use when filtering image tags. + minLength: 1 + maxLength: 128 + pattern: ^[0-9a-zA-Z._*-]{1,128} Repository: type: object properties: EmptyOnDelete: $ref: '#/components/schemas/EmptyOnDelete' + description: If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. LifecyclePolicy: $ref: '#/components/schemas/LifecyclePolicy' + description: Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). RepositoryName: type: string - description: The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. + description: |- + The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. minLength: 2 maxLength: 256 pattern: ^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$ RepositoryPolicyText: type: object - description: 'The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. ' + description: The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*. Tags: type: array maxItems: 50 @@ -397,29 +970,56 @@ components: $ref: '#/components/schemas/Tag' Arn: type: string + description: '' RepositoryUri: type: string + description: '' ImageTagMutability: type: string - description: The image tag mutability setting for the repository. + description: The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. enum: - MUTABLE - IMMUTABLE + - MUTABLE_WITH_EXCLUSION + - IMMUTABLE_WITH_EXCLUSION + ImageTagMutabilityExclusionFilters: + type: array + description: The image tag mutability exclusion filters associated with the repository. These filters specify which image tags can override the repository's default image tag mutability setting. + minItems: 1 + maxItems: 5 + x-insertionOrder: true + items: + $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter' ImageScanningConfiguration: $ref: '#/components/schemas/ImageScanningConfiguration' + description: The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. EncryptionConfiguration: $ref: '#/components/schemas/EncryptionConfiguration' + description: The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. x-stackql-resource-name: repository - x-stackql-primaryIdentifier: + description: The ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*. + x-type-name: AWS::ECR::Repository + x-stackql-primary-identifier: - RepositoryName x-create-only-properties: - RepositoryName - EncryptionConfiguration - EncryptionConfiguration/EncryptionType - EncryptionConfiguration/KmsKey + x-write-only-properties: + - EmptyOnDelete x-read-only-properties: - Arn - RepositoryUri + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ecr:TagResource + - ecr:UntagResource x-required-permissions: create: - ecr:CreateRepository @@ -438,7 +1038,6 @@ components: - ecr:DescribeRepositories - ecr:PutLifecyclePolicy - ecr:SetRepositoryPolicy - - ecr:ListTagsForResource - ecr:TagResource - ecr:UntagResource - ecr:DeleteLifecyclePolicy @@ -453,57 +1052,513 @@ components: - kms:RetireGrant list: - ecr:DescribeRepositories - x-stackQL-resources: - public_repositories: - name: public_repositories - id: awscc.ecr.public_repositories - x-cfn-schema-name: PublicRepository - x-type: list - x-identifiers: - - RepositoryName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RepositoryName') as repository_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' - AND region = 'us-east-1' - public_repository: - name: public_repository - id: awscc.ecr.public_repository - x-cfn-schema-name: PublicRepository - x-type: get - x-identifiers: - - RepositoryName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name, - JSON_EXTRACT(Properties, '$.RepositoryPolicyText') as repository_policy_text, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.RepositoryCatalogData') as repository_catalog_data, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PublicRepository' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" + AppliedForItem: + type: string + description: Enumerable Strings representing the repository creation scenarios that the template will apply towards. + enum: + - REPLICATION + - PULL_THROUGH_CACHE + RepositoryCreationTemplate: + type: object + properties: + Prefix: + description: The repository namespace prefix associated with the repository creation template. + type: string + pattern: ^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$ + minLength: 1 + maxLength: 256 + Description: + description: The description associated with the repository creation template. + type: string + minLength: 0 + maxLength: 256 + ImageTagMutability: + type: string + description: The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. + enum: + - MUTABLE + - IMMUTABLE + - IMMUTABLE_WITH_EXCLUSION + - MUTABLE_WITH_EXCLUSION + ImageTagMutabilityExclusionFilters: + type: array + description: Defines the image tag mutability exclusion filters to apply when creating repositories from this template. These filters specify which image tags can override the repository's default image tag mutability setting. + minItems: 1 + maxItems: 5 + x-insertionOrder: true + items: + $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter' + RepositoryPolicy: + type: string + description: The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions. + LifecyclePolicy: + type: string + description: The lifecycle policy to use for repositories created using the template. + minLength: 100 + maxLength: 30720 + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: The encryption configuration associated with the repository creation template. + ResourceTags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + items: + $ref: '#/components/schemas/Tag' + AppliedFor: + type: array + uniqueItems: true + x-insertionOrder: false + description: A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION + items: + $ref: '#/components/schemas/AppliedForItem' + CustomRoleArn: + type: string + description: The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template. + maxLength: 2048 + pattern: ^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[A-Za-z0-9+=,-.@_]*$ + CreatedAt: + description: '' + type: string + UpdatedAt: + description: '' + type: string + required: + - Prefix + - AppliedFor + x-stackql-resource-name: repository_creation_template + description: The details of the repository creation template associated with the request. + x-type-name: AWS::ECR::RepositoryCreationTemplate + x-stackql-primary-identifier: + - Prefix + x-create-only-properties: + - Prefix + x-read-only-properties: + - CreatedAt + - UpdatedAt + x-required-properties: + - Prefix + - AppliedFor + x-tagging: + taggable: false + x-required-permissions: + create: + - ecr:CreateRepositoryCreationTemplate + - ecr:PutLifecyclePolicy + - ecr:SetRepositoryPolicy + - ecr:CreateRepository + - iam:CreateServiceLinkedRole + - iam:PassRole + read: + - ecr:DescribeRepositoryCreationTemplates + update: + - ecr:DescribeRepositoryCreationTemplates + - ecr:UpdateRepositoryCreationTemplate + - ecr:PutLifecyclePolicy + - ecr:SetRepositoryPolicy + - ecr:CreateRepository + - iam:CreateServiceLinkedRole + - iam:PassRole + delete: + - ecr:DeleteRepositoryCreationTemplate + list: + - ecr:DescribeRepositoryCreationTemplates + CreatePublicRepositoryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RepositoryName: + type: string + description: |- + The name to use for the public repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + minLength: 2 + maxLength: 256 + pattern: ^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$ + RepositoryPolicyText: + type: object + description: The JSON repository policy text to apply to the public repository. For more information, see [Amazon ECR Public repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon ECR Public User Guide*. + Arn: + type: string + description: '' + RepositoryCatalogData: + type: object + description: The details about the repository that are publicly visible in the Amazon ECR Public Gallery. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*. + properties: + RepositoryDescription: + $ref: '#/components/schemas/RepositoryDescription' + Architectures: + $ref: '#/components/schemas/ArchitectureList' + OperatingSystems: + $ref: '#/components/schemas/OperatingSystemList' + AboutText: + $ref: '#/components/schemas/AboutText' + UsageText: + $ref: '#/components/schemas/UsageText' + additionalProperties: false + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePublicRepositoryRequest + type: object + required: [] + CreatePullThroughCacheRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EcrRepositoryPrefix: + $ref: '#/components/schemas/EcrRepositoryPrefix' + description: The Amazon ECR repository prefix associated with the pull through cache rule. + UpstreamRegistryUrl: + $ref: '#/components/schemas/UpstreamRegistryUrl' + description: The upstream registry URL associated with the pull through cache rule. + CredentialArn: + $ref: '#/components/schemas/CredentialArn' + description: The ARN of the Secrets Manager secret associated with the pull through cache rule. + UpstreamRegistry: + $ref: '#/components/schemas/UpstreamRegistry' + description: The name of the upstream source registry associated with the pull through cache rule. + CustomRoleArn: + $ref: '#/components/schemas/CustomRoleArn' + description: The ARN of the IAM role associated with the pull through cache rule. + UpstreamRepositoryPrefix: + $ref: '#/components/schemas/UpstreamRepositoryPrefix' + description: The upstream repository prefix associated with the pull through cache rule. + x-stackQL-stringOnly: true + x-title: CreatePullThroughCacheRuleRequest + type: object + required: [] + CreateRegistryPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RegistryId: + $ref: '#/components/schemas/RegistryId' + description: '' + PolicyText: + type: object + description: The JSON policy text for your registry. + x-stackQL-stringOnly: true + x-title: CreateRegistryPolicyRequest + type: object + required: [] + CreateRegistryScanningConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Rules: + $ref: '#/components/schemas/ScanningRules' + description: The scanning rules associated with the registry. + ScanType: + $ref: '#/components/schemas/ScanType' + description: The type of scanning configured for the registry. + RegistryId: + $ref: '#/components/schemas/RegistryId' + description: '' + x-stackQL-stringOnly: true + x-title: CreateRegistryScanningConfigurationRequest + type: object + required: [] + CreateReplicationConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + description: The replication configuration for a registry. + RegistryId: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateReplicationConfigurationRequest + type: object + required: [] + CreateRepositoryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EmptyOnDelete: + $ref: '#/components/schemas/EmptyOnDelete' + description: If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. + LifecyclePolicy: + $ref: '#/components/schemas/LifecyclePolicy' + description: Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). + RepositoryName: + type: string + description: |- + The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + minLength: 2 + maxLength: 256 + pattern: ^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$ + RepositoryPolicyText: + type: object + description: The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*. + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: '' + RepositoryUri: + type: string + description: '' + ImageTagMutability: + type: string + description: The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. + enum: + - MUTABLE + - IMMUTABLE + - MUTABLE_WITH_EXCLUSION + - IMMUTABLE_WITH_EXCLUSION + ImageTagMutabilityExclusionFilters: + type: array + description: The image tag mutability exclusion filters associated with the repository. These filters specify which image tags can override the repository's default image tag mutability setting. + minItems: 1 + maxItems: 5 + x-insertionOrder: true + items: + $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter' + ImageScanningConfiguration: + $ref: '#/components/schemas/ImageScanningConfiguration' + description: The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. + x-stackQL-stringOnly: true + x-title: CreateRepositoryRequest + type: object + required: [] + CreateRepositoryCreationTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Prefix: + description: The repository namespace prefix associated with the repository creation template. + type: string + pattern: ^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$ + minLength: 1 + maxLength: 256 + Description: + description: The description associated with the repository creation template. + type: string + minLength: 0 + maxLength: 256 + ImageTagMutability: + type: string + description: The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. + enum: + - MUTABLE + - IMMUTABLE + - IMMUTABLE_WITH_EXCLUSION + - MUTABLE_WITH_EXCLUSION + ImageTagMutabilityExclusionFilters: + type: array + description: Defines the image tag mutability exclusion filters to apply when creating repositories from this template. These filters specify which image tags can override the repository's default image tag mutability setting. + minItems: 1 + maxItems: 5 + x-insertionOrder: true + items: + $ref: '#/components/schemas/ImageTagMutabilityExclusionFilter' + RepositoryPolicy: + type: string + description: The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions. + LifecyclePolicy: + type: string + description: The lifecycle policy to use for repositories created using the template. + minLength: 100 + maxLength: 30720 + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: The encryption configuration associated with the repository creation template. + ResourceTags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. + items: + $ref: '#/components/schemas/Tag' + AppliedFor: + type: array + uniqueItems: true + x-insertionOrder: false + description: A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION + items: + $ref: '#/components/schemas/AppliedForItem' + CustomRoleArn: + type: string + description: The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template. + maxLength: 2048 + pattern: ^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[A-Za-z0-9+=,-.@_]*$ + CreatedAt: + description: '' + type: string + UpdatedAt: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateRepositoryCreationTemplateRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + public_repositories: + name: public_repositories + id: awscc.ecr.public_repositories + x-cfn-schema-name: PublicRepository + x-cfn-type-name: AWS::ECR::PublicRepository + x-identifiers: + - RepositoryName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PublicRepository&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::PublicRepository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::PublicRepository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::PublicRepository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/public_repositories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/public_repositories/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/public_repositories/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name, + JSON_EXTRACT(Properties, '$.RepositoryPolicyText') as repository_policy_text, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.RepositoryCatalogData') as repository_catalog_data, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PublicRepository' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -516,13 +1571,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PublicRepository' AND data__Identifier = '' AND region = 'us-east-1' - pull_through_cache_rules: - name: pull_through_cache_rules - id: awscc.ecr.pull_through_cache_rules - x-cfn-schema-name: PullThroughCacheRule - x-type: list + public_repositories_list_only: + name: public_repositories_list_only + id: awscc.ecr.public_repositories_list_only + x-cfn-schema-name: PublicRepository + x-cfn-type-name: AWS::ECR::PublicRepository x-identifiers: - - EcrRepositoryPrefix + - RepositoryName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -530,28 +1591,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EcrRepositoryPrefix') as ecr_repository_prefix - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' + JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' + json_extract_path_text(Properties, 'RepositoryName') as repository_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' AND region = 'us-east-1' - pull_through_cache_rule: - name: pull_through_cache_rule - id: awscc.ecr.pull_through_cache_rule + pull_through_cache_rules: + name: pull_through_cache_rules + id: awscc.ecr.pull_through_cache_rules x-cfn-schema-name: PullThroughCacheRule - x-type: get + x-cfn-type-name: AWS::ECR::PullThroughCacheRule x-identifiers: - EcrRepositoryPrefix + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PullThroughCacheRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::PullThroughCacheRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::PullThroughCacheRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::PullThroughCacheRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -559,12 +1668,14 @@ components: JSON_EXTRACT(Properties, '$.EcrRepositoryPrefix') as ecr_repository_prefix, JSON_EXTRACT(Properties, '$.UpstreamRegistryUrl') as upstream_registry_url, JSON_EXTRACT(Properties, '$.CredentialArn') as credential_arn, - JSON_EXTRACT(Properties, '$.UpstreamRegistry') as upstream_registry + JSON_EXTRACT(Properties, '$.UpstreamRegistry') as upstream_registry, + JSON_EXTRACT(Properties, '$.CustomRoleArn') as custom_role_arn, + JSON_EXTRACT(Properties, '$.UpstreamRepositoryPrefix') as upstream_repository_prefix FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -572,17 +1683,135 @@ components: json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix, json_extract_path_text(Properties, 'UpstreamRegistryUrl') as upstream_registry_url, json_extract_path_text(Properties, 'CredentialArn') as credential_arn, - json_extract_path_text(Properties, 'UpstreamRegistry') as upstream_registry + json_extract_path_text(Properties, 'UpstreamRegistry') as upstream_registry, + json_extract_path_text(Properties, 'CustomRoleArn') as custom_role_arn, + json_extract_path_text(Properties, 'UpstreamRepositoryPrefix') as upstream_repository_prefix FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' AND data__Identifier = '' AND region = 'us-east-1' + pull_through_cache_rules_list_only: + name: pull_through_cache_rules_list_only + id: awscc.ecr.pull_through_cache_rules_list_only + x-cfn-schema-name: PullThroughCacheRule + x-cfn-type-name: AWS::ECR::PullThroughCacheRule + x-identifiers: + - EcrRepositoryPrefix + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EcrRepositoryPrefix') as ecr_repository_prefix + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' + AND region = 'us-east-1' registry_policies: name: registry_policies id: awscc.ecr.registry_policies x-cfn-schema-name: RegistryPolicy - x-type: list + x-cfn-type-name: AWS::ECR::RegistryPolicy x-identifiers: - RegistryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RegistryPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RegistryPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RegistryPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RegistryPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RegistryId') as registry_id, + JSON_EXTRACT(Properties, '$.PolicyText') as policy_text + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RegistryId') as registry_id, + json_extract_path_text(Properties, 'PolicyText') as policy_text + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + registry_policies_list_only: + name: registry_policies_list_only + id: awscc.ecr.registry_policies_list_only + x-cfn-schema-name: RegistryPolicy + x-cfn-type-name: AWS::ECR::RegistryPolicy + x-identifiers: + - RegistryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -601,44 +1830,100 @@ components: json_extract_path_text(Properties, 'RegistryId') as registry_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' AND region = 'us-east-1' - registry_policy: - name: registry_policy - id: awscc.ecr.registry_policy - x-cfn-schema-name: RegistryPolicy - x-type: get + registry_scanning_configurations: + name: registry_scanning_configurations + id: awscc.ecr.registry_scanning_configurations + x-cfn-schema-name: RegistryScanningConfiguration + x-cfn-type-name: AWS::ECR::RegistryScanningConfiguration x-identifiers: - RegistryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RegistryScanningConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RegistryScanningConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RegistryScanningConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RegistryScanningConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registry_scanning_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registry_scanning_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/registry_scanning_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RegistryId') as registry_id, - JSON_EXTRACT(Properties, '$.PolicyText') as policy_text - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' + JSON_EXTRACT(Properties, '$.Rules') as rules, + JSON_EXTRACT(Properties, '$.ScanType') as scan_type, + JSON_EXTRACT(Properties, '$.RegistryId') as registry_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryScanningConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'RegistryId') as registry_id, - json_extract_path_text(Properties, 'PolicyText') as policy_text - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'ScanType') as scan_type, + json_extract_path_text(Properties, 'RegistryId') as registry_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryScanningConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - replication_configurations: - name: replication_configurations - id: awscc.ecr.replication_configurations - x-cfn-schema-name: ReplicationConfiguration - x-type: list + registry_scanning_configurations_list_only: + name: registry_scanning_configurations_list_only + id: awscc.ecr.registry_scanning_configurations_list_only + x-cfn-schema-name: RegistryScanningConfiguration + x-cfn-type-name: AWS::ECR::RegistryScanningConfiguration x-identifiers: - RegistryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -647,7 +1932,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.RegistryId') as registry_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryScanningConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -655,19 +1940,67 @@ components: SELECT region, json_extract_path_text(Properties, 'RegistryId') as registry_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryScanningConfiguration' AND region = 'us-east-1' - replication_configuration: - name: replication_configuration - id: awscc.ecr.replication_configuration + replication_configurations: + name: replication_configurations + id: awscc.ecr.replication_configurations x-cfn-schema-name: ReplicationConfiguration - x-type: get + x-cfn-type-name: AWS::ECR::ReplicationConfiguration x-identifiers: - RegistryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReplicationConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::ReplicationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::ReplicationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::ReplicationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -678,7 +2011,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -688,13 +2021,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - repositories: - name: repositories - id: awscc.ecr.repositories - x-cfn-schema-name: Repository - x-type: list + replication_configurations_list_only: + name: replication_configurations_list_only + id: awscc.ecr.replication_configurations_list_only + x-cfn-schema-name: ReplicationConfiguration + x-cfn-type-name: AWS::ECR::ReplicationConfiguration x-identifiers: - - RepositoryName + - RegistryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -702,28 +2041,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' + JSON_EXTRACT(Properties, '$.RegistryId') as registry_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RepositoryName') as repository_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' + json_extract_path_text(Properties, 'RegistryId') as registry_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' AND region = 'us-east-1' - repository: - name: repository - id: awscc.ecr.repository + repositories: + name: repositories + id: awscc.ecr.repositories x-cfn-schema-name: Repository - x-type: get + x-cfn-type-name: AWS::ECR::Repository x-identifiers: - RepositoryName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Repository&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::Repository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::Repository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::Repository" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repositories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repositories/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/repositories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -736,13 +2123,14 @@ components: JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.RepositoryUri') as repository_uri, JSON_EXTRACT(Properties, '$.ImageTagMutability') as image_tag_mutability, + JSON_EXTRACT(Properties, '$.ImageTagMutabilityExclusionFilters') as image_tag_mutability_exclusion_filters, JSON_EXTRACT(Properties, '$.ImageScanningConfiguration') as image_scanning_configuration, JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::Repository' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -755,8 +2143,617 @@ components: json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'RepositoryUri') as repository_uri, json_extract_path_text(Properties, 'ImageTagMutability') as image_tag_mutability, + json_extract_path_text(Properties, 'ImageTagMutabilityExclusionFilters') as image_tag_mutability_exclusion_filters, json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::Repository' AND data__Identifier = '' AND region = 'us-east-1' + repositories_list_only: + name: repositories_list_only + id: awscc.ecr.repositories_list_only + x-cfn-schema-name: Repository + x-cfn-type-name: AWS::ECR::Repository + x-identifiers: + - RepositoryName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RepositoryName') as repository_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' + AND region = 'us-east-1' + repository_creation_templates: + name: repository_creation_templates + id: awscc.ecr.repository_creation_templates + x-cfn-schema-name: RepositoryCreationTemplate + x-cfn-type-name: AWS::ECR::RepositoryCreationTemplate + x-identifiers: + - Prefix + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RepositoryCreationTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RepositoryCreationTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RepositoryCreationTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECR::RepositoryCreationTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Prefix') as prefix, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ImageTagMutability') as image_tag_mutability, + JSON_EXTRACT(Properties, '$.ImageTagMutabilityExclusionFilters') as image_tag_mutability_exclusion_filters, + JSON_EXTRACT(Properties, '$.RepositoryPolicy') as repository_policy, + JSON_EXTRACT(Properties, '$.LifecyclePolicy') as lifecycle_policy, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration, + JSON_EXTRACT(Properties, '$.ResourceTags') as resource_tags, + JSON_EXTRACT(Properties, '$.AppliedFor') as applied_for, + JSON_EXTRACT(Properties, '$.CustomRoleArn') as custom_role_arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Prefix') as prefix, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ImageTagMutability') as image_tag_mutability, + json_extract_path_text(Properties, 'ImageTagMutabilityExclusionFilters') as image_tag_mutability_exclusion_filters, + json_extract_path_text(Properties, 'RepositoryPolicy') as repository_policy, + json_extract_path_text(Properties, 'LifecyclePolicy') as lifecycle_policy, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags, + json_extract_path_text(Properties, 'AppliedFor') as applied_for, + json_extract_path_text(Properties, 'CustomRoleArn') as custom_role_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + repository_creation_templates_list_only: + name: repository_creation_templates_list_only + id: awscc.ecr.repository_creation_templates_list_only + x-cfn-schema-name: RepositoryCreationTemplate + x-cfn-type-name: AWS::ECR::RepositoryCreationTemplate + x-identifiers: + - Prefix + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Prefix') as prefix + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Prefix') as prefix + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PublicRepository&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePublicRepository + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePublicRepositoryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PullThroughCacheRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePullThroughCacheRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePullThroughCacheRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RegistryPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRegistryPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRegistryPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RegistryScanningConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRegistryScanningConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRegistryScanningConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReplicationConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReplicationConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReplicationConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Repository&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRepository + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRepositoryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RepositoryCreationTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRepositoryCreationTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRepositoryCreationTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ecs.yaml b/providers/src/awscc/v00.00.00000/services/ecs.yaml index fae1bf52..4c89c3ad 100644 --- a/providers/src/awscc/v00.00.00000/services/ecs.yaml +++ b/providers/src/awscc/v00.00.00000/services/ecs.yaml @@ -1,35 +1,398 @@ openapi: 3.0.0 info: title: ECS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - ManagedScaling: - description: The managed scaling settings for the Auto Scaling group capacity provider. + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object + CancelResourceRequestOutput: properties: - MinimumScalingStepSize: - type: integer - MaximumScalingStepSize: - type: integer - Status: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: type: string - enum: - - DISABLED - - ENABLED - TargetCapacity: - type: integer - InstanceWarmupPeriod: - type: integer - additionalProperties: false - AutoScalingGroupProvider: + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput type: object + CreateResourceOutput: properties: - AutoScalingGroupArn: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + AutoScalingGroupProvider: + additionalProperties: false + type: object + properties: ManagedScaling: $ref: '#/components/schemas/ManagedScaling' + AutoScalingGroupArn: + type: string ManagedTerminationProtection: type: string enum: @@ -42,160 +405,243 @@ components: - ENABLED required: - AutoScalingGroupArn + ManagedScaling: + description: The managed scaling settings for the Auto Scaling group capacity provider. additionalProperties: false - Tag: type: object properties: - Key: + Status: type: string + enum: + - DISABLED + - ENABLED + MinimumScalingStepSize: + type: integer + InstanceWarmupPeriod: + type: integer + TargetCapacity: + type: integer + MaximumScalingStepSize: + type: integer + Tag: + additionalProperties: false + type: object + properties: Value: type: string - additionalProperties: false + Key: + type: string CapacityProvider: description: If using ec2 auto-scaling, the name of the associated capacity provider. Otherwise FARGATE, FARGATE_SPOT. - type: string anyOf: - type: string enum: - FARGATE - FARGATE_SPOT - - type: string - minLength: 1 + - minLength: 1 + type: string maxLength: 2048 + type: string CapacityProviderStrategyItem: + additionalProperties: false type: object properties: - Base: - type: integer CapacityProvider: type: string + Base: + type: integer Weight: type: integer - additionalProperties: false ExecuteCommandLogConfiguration: - description: The session logging configuration for ExecuteCommand. + description: The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. additionalProperties: false type: object properties: S3EncryptionEnabled: + description: Determines whether to use encryption on the S3 logs. If not specified, encryption is not used. type: boolean CloudWatchEncryptionEnabled: + description: Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off. type: boolean CloudWatchLogGroupName: + description: |- + The name of the CloudWatch log group to send logs to. + The CloudWatch log group must already be created. type: string S3KeyPrefix: + description: An optional folder in the S3 bucket to place logs in. type: string S3BucketName: + description: |- + The name of the S3 bucket to send logs to. + The S3 bucket must already be created. type: string ClusterSettings: - description: The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. + description: |- + The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights with enhanced observability or CloudWatch Container Insights for a cluster. + Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up. + For more information, see [Monitor Amazon ECS containers using Container Insights with enhanced observability](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false type: object properties: Value: + description: |- + The value to set for the cluster setting. The supported values are ``enhanced``, ``enabled``, and ``disabled``. + To use Container Insights with enhanced observability, set the ``containerInsights`` account setting to ``enhanced``. + To use Container Insights, set the ``containerInsights`` account setting to ``enabled``. + If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html). type: string Name: + description: The name of the cluster setting. The value is ``containerInsights`` . + type: string + ManagedStorageConfiguration: + description: The managed storage configuration for the cluster. + additionalProperties: false + type: object + properties: + FargateEphemeralStorageKmsKeyId: + description: |- + Specify the KMSlong key ID for Fargate ephemeral storage. + When you specify a ``fargateEphemeralStorageKmsKeyId``, AWS Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see [Customer managed keys for Fargate ephemeral storage for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-storage-encryption.html) in the *Amazon Elastic Container Service Developer Guide*. + The key must be a single Region key. + type: string + KmsKeyId: + description: |- + Specify a KMSlong key ID to encrypt Amazon ECS managed storage. + When you specify a ``kmsKeyId``, Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see [Encrypt data stored in Amazon EBS volumes for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html) in the *Amazon Elastic Container Service Developer Guide*. + The key must be a single Region key. type: string ServiceConnectDefaults: - description: Service Connect Configuration default for all services or tasks within this cluster + description: >- + Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default + parameter. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false type: object properties: Namespace: - description: Service Connect Namespace Name or ARN default for all services or tasks within this cluster + description: |- + The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include greater than (>), less than (<), double quotation marks ("), or slash (/). + If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. + If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. + If you update the cluster with an empty string ``""`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. + For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*. type: string ClusterConfiguration: - description: The configurations to be set at cluster level. + description: The execute command and managed storage configuration for the cluster. additionalProperties: false type: object properties: + ManagedStorageConfiguration: + description: The details of the managed storage configuration. + $ref: '#/components/schemas/ManagedStorageConfiguration' ExecuteCommandConfiguration: + description: The details of the execute command configuration. $ref: '#/components/schemas/ExecuteCommandConfiguration' ExecuteCommandConfiguration: - description: The configuration for ExecuteCommand. + description: The details of the execute command configuration. additionalProperties: false type: object properties: Logging: + description: |- + The log setting to use for redirecting logs for your execute command results. The following log settings are available. + + ``NONE``: The execute command session is not logged. + + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required. type: string KmsKeyId: + description: Specify an KMSlong key ID to encrypt the data between the local client and the container. type: string LogConfiguration: + description: The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. $ref: '#/components/schemas/ExecuteCommandLogConfiguration' Cluster: + minLength: 1 description: The name of the cluster type: string - minLength: 1 maxLength: 2048 - CapacityProviders: + DefaultCapacityProviderStrategy: description: List of capacity providers to associate with the cluster type: array items: - $ref: '#/components/schemas/CapacityProvider' + $ref: '#/components/schemas/CapacityProviderStrategy' + CapacityProviders: uniqueItems: true - DefaultCapacityProviderStrategy: description: List of capacity providers to associate with the cluster type: array items: - $ref: '#/components/schemas/CapacityProviderStrategy' + $ref: '#/components/schemas/CapacityProvider' CapacityProviderStrategy: + additionalProperties: false type: object properties: + CapacityProvider: + $ref: '#/components/schemas/CapacityProvider' Base: + maximum: 100000 type: integer minimum: 0 - maximum: 100000 Weight: + maximum: 1000 type: integer minimum: 0 - maximum: 1000 - CapacityProvider: - $ref: '#/components/schemas/CapacityProvider' required: - CapacityProvider - additionalProperties: false ClusterCapacityProviderAssociations: type: object properties: + DefaultCapacityProviderStrategy: + $ref: '#/components/schemas/DefaultCapacityProviderStrategy' CapacityProviders: $ref: '#/components/schemas/CapacityProviders' Cluster: $ref: '#/components/schemas/Cluster' - DefaultCapacityProviderStrategy: - $ref: '#/components/schemas/DefaultCapacityProviderStrategy' required: - CapacityProviders - Cluster - DefaultCapacityProviderStrategy x-stackql-resource-name: cluster_capacity_provider_associations - x-stackql-primaryIdentifier: + description: Associate a set of ECS Capacity Providers with a specified ECS Cluster + x-type-name: AWS::ECS::ClusterCapacityProviderAssociations + x-stackql-primary-identifier: - Cluster x-create-only-properties: - Cluster + x-required-properties: + - CapacityProviders + - Cluster + - DefaultCapacityProviderStrategy + x-tagging: + tagOnCreate: false + taggable: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - ecs:DescribeClusters create: - ecs:DescribeClusters - ecs:PutClusterCapacityProviders - read: - - ecs:DescribeClusters + - ecs:DescribeCapacityProviders update: - ecs:DescribeClusters - ecs:PutClusterCapacityProviders - delete: - - ecs:PutClusterCapacityProviders - - ecs:DescribeClusters list: - ecs:DescribeClusters - ecs:ListClusters + delete: + - ecs:PutClusterCapacityProviders + - ecs:DescribeClusters PrimaryTaskSet: type: object properties: - Cluster: - description: The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. - type: string TaskSetId: description: The ID or full Amazon Resource Name (ARN) of the task set. type: string + Cluster: + description: The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. + type: string Service: description: The short name or full Amazon Resource Name (ARN) of the service to create the task set in. type: string @@ -204,313 +650,621 @@ components: - Service - TaskSetId x-stackql-resource-name: primary_task_set - x-stackql-primaryIdentifier: + description: A pseudo-resource that manages which of your ECS task sets is primary. + x-type-name: AWS::ECS::PrimaryTaskSet + x-stackql-primary-identifier: - Cluster - Service x-create-only-properties: - Cluster - Service + x-required-properties: + - Cluster + - Service + - TaskSetId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: [] create: - ecs:DescribeTaskSets - ecs:UpdateServicePrimaryTaskSet - read: [] update: - ecs:DescribeTaskSets - ecs:UpdateServicePrimaryTaskSet delete: [] - AwsVpcConfiguration: - description: The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC. + TimeoutConfiguration: + description: |- + An object that represents the timeout configurations for Service Connect. + If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``. + additionalProperties: false type: object properties: - AssignPublicIp: - description: Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. + PerRequestTimeoutSeconds: + description: The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP````appProtocol``. + type: integer + IdleTimeoutSeconds: + description: |- + The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``. + The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes. + The ``idleTimeout`` default for ``TCP`` is 1 hour. + type: integer + ServiceConnectTlsCertificateAuthority: + description: The certificate root authority that secures your service. + additionalProperties: false + type: object + properties: + AwsPcaAuthorityArn: + description: The ARN of the AWS Private Certificate Authority certificate. + type: string + VpcLatticeConfiguration: + description: The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to. + additionalProperties: false + type: object + properties: + TargetGroupArn: + description: The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to. + type: string + PortName: + description: The name of the port mapping to register in the VPC Lattice target group. This is the name of the ``portMapping`` you defined in your task definition. + type: string + RoleArn: + description: "The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS\L infrastructure IAM role that is used to manage your VPC Lattice infrastructure." type: string - enum: - - DISABLED - - ENABLED - SecurityGroups: - description: The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. - type: array - items: - type: string - maxItems: 5 - Subnets: - description: The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. - type: array - items: - type: string - maxItems: 16 required: - - Subnets + - RoleArn + - TargetGroupArn + - PortName + PlacementStrategy: + description: The task placement strategy for a task or service. For more information, see [Task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - DeploymentAlarms: - type: object - properties: - AlarmNames: - type: array - items: - type: string - Rollback: - type: boolean - Enable: - type: boolean - required: - - AlarmNames - - Rollback - - Enable - additionalProperties: false - DeploymentCircuitBreaker: - type: object - properties: - Enable: - type: boolean - Rollback: - type: boolean - required: - - Enable - - Rollback - additionalProperties: false - DeploymentConfiguration: - type: object - properties: - DeploymentCircuitBreaker: - $ref: '#/components/schemas/DeploymentCircuitBreaker' - MaximumPercent: - type: integer - MinimumHealthyPercent: - type: integer - Alarms: - $ref: '#/components/schemas/DeploymentAlarms' - additionalProperties: false - DeploymentController: type: object properties: + Field: + description: The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``cpu`` and ``memory``. For the ``random`` placement strategy, this field is not used. + type: string Type: + description: >- + The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least + amount of remaining memory but still enough to run the task. type: string enum: - - CODE_DEPLOY - - ECS - - EXTERNAL - additionalProperties: false - EBSTagSpecification: - type: object + - binpack + - random + - spread required: - - ResourceType - properties: - ResourceType: - type: string - Tags: - type: array - items: - $ref: '#/components/schemas/Tag' - PropagateTags: - type: string - enum: - - SERVICE - - TASK_DEFINITION - LoadBalancer: - description: 'A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. ' - type: object - properties: - ContainerName: - description: The name of the container (as it appears in a container definition) to associate with the load balancer. - type: string - ContainerPort: - description: The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. - type: integer - TargetGroupArn: - description: >- - The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see - https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition - uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. - type: string - additionalProperties: false + - Type LogConfiguration: + description: The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container. + additionalProperties: false type: object required: - LogDriver properties: - LogDriver: - type: string - description: |- - The log driver to use for the container. - For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. - For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. - For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. - For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. - If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs + SecretOptions: + description: The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Secret' Options: - type: object x-patternProperties: .{1,}: type: string + description: |- + The configuration options to send to the log driver. + The options you can specify depend on the log driver. Some of the options you can specify when you use the ``awslogs`` log driver to route logs to Amazon CloudWatch include the following: + + awslogs-create-group Required: No Specify whether you want the log group to be created automatically. If this option isn't specified, it defaults to false. Your IAM policy must include the logs:CreateLogGroup permission before you attempt to use awslogs-create-group. + awslogs-region Required: Yes Specify the Region that the awslogs log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option. + awslogs-group Required: Yes Make sure to specify a log group that the awslogs log driver sends its log streams to. + awslogs-stream-prefix Required: Yes, when using Fargate.Optional when using EC2. Use the awslogs-stream-prefix option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format prefix-name/container-name/ecs-task-id. If you don't specify a prefix with this option, then the log stream is named after the container ID that's assigned by the Docker daemon on the container instance. Because it's difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option. For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to. You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console. + awslogs-datetime-format Required: No This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry. For more information, see awslogs-datetime-format. You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options. Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. + awslogs-multiline-pattern Required: No This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. For more information, see awslogs-multiline-pattern. This option is ignored if awslogs-datetime-format is also configured. You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options. Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. + The following options apply to all supported log drivers. + + mode Required: No Valid values: non-blocking | blocking This option defines the delivery mode of log messages from the container to the log driver specified using logDriver. The delivery mode you choose affects application availability when the flow of logs from container is interrupted. If you use the blocking mode and the flow of logs is interrupted, calls from container code to write to the stdout and stderr streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure. If you use the non-blocking mode, the container's logs are instead stored in an in-memory intermediate buffer configured with the max-buffer-size option. This prevents the application from becoming unresponsive when logs cannot be sent. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver. You can set a default mode for all containers in a specific Region by using the defaultLogDriverMode account setting. If you don't specify the mode option or configure the account setting, Amazon ECS will default to the non-blocking mode. For more information about the account setting, see Default log driver mode in the Amazon Elastic Container Service Developer Guide. On June 25, 2025, Amazon ECS changed the default log driver mode from blocking to non-blocking to prioritize task availability over logging. To continue using the blocking mode after this change, do one of the following: Set the mode option in your container definition's logConfiguration as blocking. Set the defaultLogDriverMode account setting to blocking. + max-buffer-size Required: No Default value: 10m When non-blocking mode is used, the max-buffer-size log option controls the size of the buffer that's used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost. + To route logs using the ``splunk`` log router, you need to specify a ``splunk-token`` and a ``splunk-url``. + When you use the ``awsfirelens`` log router to route logs to an AWS Service or AWS Partner Network destination for log storage and analytics, you can set the ``log-driver-buffer-limit`` option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker. + Other options you can specify when using ``awsfirelens`` to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the AWS Region with ``region`` and a name for the log stream with ``delivery_stream``. + When you export logs to Amazon Kinesis Data Streams, you can specify an AWS Region with ``region`` and a data stream name with ``stream``. + When you export logs to Amazon OpenSearch Service, you can specify options like ``Name``, ``Host`` (OpenSearch Service endpoint without protocol), ``Port``, ``Index``, ``Type``, ``Aws_auth``, ``Aws_region``, ``Suppress_Type_Name``, and ``tls``. For more information, see [Under the hood: FireLens for Amazon ECS Tasks](https://docs.aws.amazon.com/containers/under-the-hood-firelens-for-amazon-ecs-tasks/). + When you export logs to Amazon S3, you can specify the bucket using the ``bucket`` option. You can also specify ``region``, ``total_file_size``, ``upload_timeout``, and ``use_put_object`` as options. + This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` additionalProperties: false - description: 'The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format ''{{.Server.APIVersion}}''``' - SecretOptions: - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/Secret' - description: The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. + type: object + LogDriver: + description: |- + The log driver to use for the container. + For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. + For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``syslog``, ``splunk``, and ``awsfirelens``. + For more information about using the ``awslogs`` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. + For more information about using the ``awsfirelens`` log driver, see [Send Amazon ECS logs to an service or Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html). + If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. + type: string + ServiceConnectTestTrafficRules: + description: |- + The test traffic routing configuration for Amazon ECS blue/green deployments. This configuration allows you to define rules for routing specific traffic to the new service revision during the deployment process, allowing for safe testing before full production traffic shift. + For more information, see [Service Connect for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-blue-green.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - description: The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container. - NetworkConfiguration: - description: An object representing the network configuration for a task or service. type: object properties: - AwsVpcConfiguration: - $ref: '#/components/schemas/AwsVpcConfiguration' + Header: + description: The HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers. + $ref: '#/components/schemas/ServiceConnectTestTrafficRulesHeader' + required: + - Header + ServiceConnectTestTrafficRulesHeader: + description: '' additionalProperties: false - PlacementConstraint: type: object properties: - Expression: - type: string - Type: + Value: + description: '' + $ref: '#/components/schemas/ServiceConnectTestTrafficRulesHeaderValue' + Name: + description: '' type: string - enum: - - distinctInstance - - memberOf required: - - Type + - Name + ServiceConnectClientAlias: + description: |- + Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service. + Each name and port mapping must be unique within the namespace. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - PlacementStrategy: type: object properties: - Field: - type: string - Type: + DnsName: + description: |- + The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. + If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. + To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. type: string - enum: - - binpack - - random - - spread + TestTrafficRules: + description: The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic. + $ref: '#/components/schemas/ServiceConnectTestTrafficRules' + Port: + description: |- + The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. + To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. + type: integer required: - - Type + - Port + ServiceVolumeConfiguration: + description: The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. additionalProperties: false - Secret: type: object required: - Name - - ValueFrom properties: + ManagedEBSVolume: + description: The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. + $ref: '#/components/schemas/ServiceManagedEBSVolumeConfiguration' Name: + description: The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition. type: string - description: The name of the secret. - ValueFrom: - type: string - description: |- - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. - For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. - If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. + NetworkConfiguration: + description: An object representing the network configuration for a task or service. additionalProperties: false - description: |- - An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways: - + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter. - + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter. - - For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. - ServiceConnectClientAlias: type: object properties: - Port: - type: integer - DnsName: + AwsVpcConfiguration: + $ref: '#/components/schemas/AwsVpcConfiguration' + ServiceConnectTestTrafficRulesHeaderValue: + description: '' + additionalProperties: false + type: object + properties: + Exact: + description: '' type: string required: - - Port + - Exact + DeploymentCircuitBreaker: + description: |- + The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. + The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. + For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - ServiceConnectConfiguration: type: object properties: - Enabled: + Enable: + description: Determines whether to use the deployment circuit breaker logic for the service. + type: boolean + Rollback: + description: Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. type: boolean - Namespace: - type: string - Services: - type: array - items: - $ref: '#/components/schemas/ServiceConnectService' - LogConfiguration: - $ref: '#/components/schemas/LogConfiguration' required: - - Enabled + - Enable + - Rollback + EBSTagSpecification: + description: The tag specifications of an Amazon EBS volume. additionalProperties: false - ServiceConnectService: type: object + required: + - ResourceType properties: - PortName: + PropagateTags: + description: "Determines whether to propagate the tags from the task definition to \Lthe Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in \L``ServiceVolumeConfiguration``. If no value is specified, the tags aren't \Lpropagated." type: string - DiscoveryName: + enum: + - SERVICE + - TASK_DEFINITION + ResourceType: + description: The type of volume resource. type: string - ClientAliases: + Tags: + description: The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used. type: array items: - $ref: '#/components/schemas/ServiceConnectClientAlias' - IngressPortOverride: - type: integer - Tls: - $ref: '#/components/schemas/ServiceConnectTlsConfiguration' - Timeout: - $ref: '#/components/schemas/TimeoutConfiguration' - required: - - PortName + $ref: '#/components/schemas/Tag' + AdvancedConfiguration: + description: The advanced settings for a load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. For more information, see [Required resources for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-deployment-implementation.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - ServiceConnectTlsConfiguration: type: object properties: - IssuerCertificateAuthority: - $ref: '#/components/schemas/ServiceConnectTlsCertificateAuthority' - KmsKey: + TestListenerRule: + description: The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic. + type: string + AlternateTargetGroupArn: + description: The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments. + type: string + ProductionListenerRule: + description: The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic. type: string RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you. type: string required: - - IssuerCertificateAuthority + - AlternateTargetGroupArn + ForceNewDeployment: + description: '' additionalProperties: false - ServiceConnectTlsCertificateAuthority: type: object + required: + - EnableForceNewDeployment properties: - AwsPcaAuthorityArn: + EnableForceNewDeployment: + description: '' + type: boolean + ForceNewDeploymentNonce: + minLength: 1 + description: '' + x-$comment: A time-varying value that has at most a negligible chance of repeating; for example, a random value that is generated anew for each use, a time-stamp, a sequence number, or some combination of these. type: string + maxLength: 255 + DeploymentAlarms: + description: |- + One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. + When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. + You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS``. + For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - ServiceManagedEBSVolumeConfiguration: type: object - required: - - RoleArn properties: - Encrypted: - type: boolean - KmsKeyId: - type: string - VolumeType: - type: string - SizeInGiB: - type: integer - SnapshotId: - type: string - Iops: - type: integer - Throughput: - type: integer - TagSpecifications: + AlarmNames: + description: One or more CloudWatch alarm names. Use a "," to separate the alarms. type: array items: - $ref: '#/components/schemas/EBSTagSpecification' - RoleArn: - type: string - FilesystemType: + type: string + Enable: + description: Determines whether to use the CloudWatch alarm option in the service deployment process. + type: boolean + Rollback: + description: Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. + type: boolean + required: + - AlarmNames + - Rollback + - Enable + LoadBalancer: + description: 'A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. ' + additionalProperties: false + type: object + properties: + TargetGroupArn: + description: >- + The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see + https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition + uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. type: string - TimeoutConfiguration: + ContainerName: + description: The name of the container (as it appears in a container definition) to associate with the load balancer. + type: string + ContainerPort: + description: The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. + type: integer + ServiceConnectConfiguration: + description: |- + The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false type: object properties: - IdleTimeoutSeconds: + Services: + description: |- + The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. + This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. + An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service. + type: array + items: + $ref: '#/components/schemas/ServiceConnectService' + Enabled: + description: Specifies whether to use Service Connect with this service. + type: boolean + LogConfiguration: + description: |- + The log configuration for the container. This parameter maps to ``LogConfig`` in the docker container create command and the ``--log-driver`` option to docker run. + By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. + Understand the following when specifying a log configuration for your containers. + + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. + For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. + For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``,``syslog``, ``splunk``, and ``awsfirelens``. + + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. + $ref: '#/components/schemas/LogConfiguration' + Namespace: + description: The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*. + type: string + required: + - Enabled + ServiceConnectTlsConfiguration: + description: The key that encrypts and decrypts your resources for Service Connect TLS. + additionalProperties: false + type: object + properties: + IssuerCertificateAuthority: + description: The signer certificate authority. + $ref: '#/components/schemas/ServiceConnectTlsCertificateAuthority' + KmsKey: + description: The AWS Key Management Service key. + type: string + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS. + type: string + required: + - IssuerCertificateAuthority + DeploymentLifecycleHook: + description: |- + A deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets. + For more information, see [Lifecycle hooks for Amazon ECS service deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html) in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false + type: object + properties: + LifecycleStages: + minItems: 1 + description: |- + The lifecycle stages at which to run the hook. Choose from these valid values: + + RECONCILE_SERVICE + The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. + You can use a lifecycle hook for this stage. + + PRE_SCALE_UP + The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. + You can use a lifecycle hook for this stage. + + POST_SCALE_UP + The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. + You can use a lifecycle hook for this stage. + + TEST_TRAFFIC_SHIFT + The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. + You can use a lifecycle hook for this stage. + + POST_TEST_TRAFFIC_SHIFT + The test traffic shift is complete. The green service revision handles 100% of the test traffic. + You can use a lifecycle hook for this stage. + + PRODUCTION_TRAFFIC_SHIFT + Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. + You can use a lifecycle hook for this stage. + + POST_PRODUCTION_TRAFFIC_SHIFT + The production traffic shift is complete. + You can use a lifecycle hook for this stage. + + You must provide this parameter when configuring a deployment lifecycle hook. + type: array + items: + type: string + enum: + - RECONCILE_SERVICE + - PRE_SCALE_UP + - POST_SCALE_UP + - TEST_TRAFFIC_SHIFT + - POST_TEST_TRAFFIC_SHIFT + - PRODUCTION_TRAFFIC_SHIFT + - POST_PRODUCTION_TRAFFIC_SHIFT + HookTargetArn: + description: |- + The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported. + You must provide this parameter when configuring a deployment lifecycle hook. + type: string + RoleArn: + description: |- + The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf. + For more information, see [Permissions required for Lambda functions in Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + required: + - HookTargetArn + - RoleArn + - LifecycleStages + DeploymentController: + description: The deployment controller to use for the service. + additionalProperties: false + type: object + properties: + Type: + description: |- + The deployment controller type to use. + The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are: + + ECS + When you create a service which uses the ``ECS`` deployment controller, you can choose between the following deployment strategies: + + ``ROLLING``: When you create a service which uses the *rolling update* (``ROLLING``) deployment strategy, the ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. + Rolling update deployments are best suited for the following scenarios: + + Gradual service updates: You need to update your service incrementally without taking the entire service offline at once. + + Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments). + + Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one. + + No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds. + + Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners. + + No load balancer requirement: Your service doesn't use or require a load balancer, ALB, NLB, or Service Connect (which are required for blue/green deployments). + + Stateful applications: Your application maintains state that makes it difficult to run two parallel environments. + + Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment. + + Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios. + + ``BLUE_GREEN``: A *blue/green* deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. + ECS blue/green deployments are best suited for the following scenarios: + + Service validation: When you need to validate new service revisions before directing production traffic to them + + Zero downtime: When your service requires zero-downtime deployments + + Instant roll back: When you need the ability to quickly roll back if issues are detected + + Load balancer requirement: When your service uses ALB, NLB, or Service Connect + + + + External + Use a third-party deployment controller. + + Blue/green deployment (powered by ACD) + ACD installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it. + + When updating the deployment controller for a service, consider the following depending on the type of migration you're performing. + + If you have a template that contains the ``EXTERNAL`` deployment controller information as well as ``TaskSet`` and ``PrimaryTaskSet`` resources, and you remove the task set resources from the template when updating from ``EXTERNAL`` to ``ECS``, the ``DescribeTaskSet`` and ``DeleteTaskSet`` API calls will return a 400 error after the deployment controller is updated to ``ECS``. This results in a delete failure on the task set resources, even though the stack transitions to ``UPDATE_COMPLETE`` status. For more information, see [Resource removed from stack but not deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-resource-removed-not-deleted) in the CFNlong User Guide. To fix this issue, delete the task sets directly using the ECS``DeleteTaskSet`` API. For more information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference. + + If you're migrating from ``CODE_DEPLOY`` to ``ECS`` with a new task definition and CFN performs a rollback operation, the ECS``UpdateService`` request fails with the following error: + Resource handler returned message: "Invalid request provided: Unable to update task definition on services with a CODE_DEPLOY deployment controller. + + After a successful migration from ``ECS`` to ``EXTERNAL`` deployment controller, you need to manually remove the ``ACTIVE`` task set, because ECS no longer manages the deployment. For information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference. + type: string + enum: + - CODE_DEPLOY + - ECS + - EXTERNAL + Secret: + description: |- + An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways: + + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter. + + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter. + + For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false + type: object + required: + - Name + - ValueFrom + properties: + ValueFrom: + description: |- + The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. + For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. + If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. + type: string + Name: + description: The name of the secret. + type: string + AwsVpcConfiguration: + description: The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC. + additionalProperties: false + type: object + properties: + SecurityGroups: + maxItems: 5 + description: The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. + type: array + items: + type: string + Subnets: + maxItems: 16 + description: The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. + type: array + items: + type: string + AssignPublicIp: + description: Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. + type: string + enum: + - DISABLED + - ENABLED + required: + - Subnets + PlacementConstraint: + description: |- + An object representing a constraint on task placement. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*. + If you're using the Fargate launch type, task placement constraints aren't supported. + additionalProperties: false + type: object + properties: + Type: + description: The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates. + type: string + enum: + - distinctInstance + - memberOf + Expression: + description: A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + required: + - Type + ServiceManagedEBSVolumeConfiguration: + description: |- + The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. For information about the supported launch types and operating systems, see [Supported operating systems and launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration) in the*Amazon Elastic Container Service Developer Guide*. + Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters. + additionalProperties: false + type: object + required: + - RoleArn + properties: + SnapshotId: + description: The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either ``snapshotId`` or ``sizeInGiB`` in your volume configuration. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + type: string + VolumeType: + description: |- + The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. + The following are the supported volume types. + + General Purpose SSD: ``gp2``|``gp3`` + + Provisioned IOPS SSD: ``io1``|``io2`` + + Throughput Optimized HDD: ``st1`` + + Cold HDD: ``sc1`` + + Magnetic: ``standard`` + The magnetic volume type is not supported on Fargate. + type: string + KmsKeyId: + description: >- + The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more + information about encrypting Amazon EBS volumes attached to tasks, see [Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html). + AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails. + type: string + TagSpecifications: + description: The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + type: array + items: + $ref: '#/components/schemas/EBSTagSpecification' + FilesystemType: + description: "The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the tasks will fail to start.\n The available Linux filesystem types are\L ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default.\n The available Windows filesystem types are ``NTFS``." + type: string + Encrypted: + description: Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as ``false``, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + type: boolean + Throughput: + description: |- + The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + This parameter is only supported for the ``gp3`` volume type. type: integer - PerRequestTimeoutSeconds: + VolumeInitializationRate: + description: The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a ``snapshotId``. For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EBS User Guide*. type: integer - additionalProperties: false + Iops: + description: |- + The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type. + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. + This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + type: integer + SizeInGiB: + description: |- + The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + The following are the supported volume size values for each volume type. + + ``gp2`` and ``gp3``: 1-16,384 + + ``io1`` and ``io2``: 4-16,384 + + ``st1`` and ``sc1``: 125-16,384 + + ``standard``: 1-1,024 + type: integer + RoleArn: + description: The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*. + type: string ServiceRegistry: + additionalProperties: false type: object properties: ContainerName: @@ -518,787 +1272,950 @@ components: The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. type: string + Port: + description: The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. + type: integer ContainerPort: description: >- The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. type: integer - Port: - description: The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. - type: integer RegistryArn: description: The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html type: string + DeploymentConfiguration: + description: Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks. additionalProperties: false - ServiceVolumeConfiguration: type: object - required: - - Name properties: - Name: + BakeTimeInMinutes: + maximum: 1440 + description: |- + The duration when both blue and green service revisions are running simultaneously after the production traffic has shifted. + The following rules apply when you don't specify a value: + + For rolling deployments, the value is set to 3 hours (180 minutes). + + When you use an external deployment controller (``EXTERNAL``), or the ACD blue/green deployment controller (``CODE_DEPLOY``), the value is set to 3 hours (180 minutes). + + For all other cases, the value is set to 36 hours (2160 minutes). + type: integer + minimum: 0 + LifecycleHooks: + description: An array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle. + type: array + items: + $ref: '#/components/schemas/DeploymentLifecycleHook' + Alarms: + description: Information about the CloudWatch alarms. + $ref: '#/components/schemas/DeploymentAlarms' + Strategy: + description: |- + The deployment strategy for the service. Choose from these valid values: + + ``ROLLING`` - When you create a service which uses the rolling update (``ROLLING``) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. + + ``BLUE_GREEN`` - A blue/green deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. type: string - ManagedEBSVolume: - $ref: '#/components/schemas/ServiceManagedEBSVolumeConfiguration' + enum: + - ROLLING + - BLUE_GREEN + DeploymentCircuitBreaker: + description: |- + The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. + The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* + $ref: '#/components/schemas/DeploymentCircuitBreaker' + MaximumPercent: + description: >- + If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of + four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. + The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting replacement tasks first and then stopping the unhealthy tasks, as long as cluster resources for starting replacement tasks are available. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types, and tasks in the service use the EC2 launch type, the *maximum percent* value is set to the default value. The *maximum percent* value is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. + You can't specify a custom ``maximumPercent`` value for a service that uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and has tasks that use the EC2 launch type. + If the service uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types, and the tasks in the service use the Fargate launch type, the maximum percent value is not used. The value is still returned when describing your service. + type: integer + MinimumHealthyPercent: + description: >- + If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, + the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. + If any tasks are unhealthy and if ``maximumPercent`` doesn't allow the Amazon ECS scheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one — using the ``minimumHealthyPercent`` as a constraint — to clear up capacity to launch replacement tasks. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) . + For services that *do not* use a load balancer, the following should be noted: + + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. + + For services that *do* use a load balancer, the following should be noted: + + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + + The default value for a replica service for ``minimumHealthyPercent`` is 100%. The default ``minimumHealthyPercent`` value for a service using the ``DAEMON`` service schedule is 0% for the CLI, the AWS SDKs, and the APIs and 50% for the AWS Management Console. + The minimum number of healthy tasks during a deployment is the ``desiredCount`` multiplied by the ``minimumHealthyPercent``/100, rounded up to the nearest integer value. + If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value. The *minimum healthy percent* value is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. + You can't specify a custom ``minimumHealthyPercent`` value for a service that uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and has tasks that use the EC2 launch type. + If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. + type: integer + ServiceConnectService: + description: The Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false + type: object + properties: + Timeout: + description: A reference to an object that represents the configured timeouts for Service Connect. + $ref: '#/components/schemas/TimeoutConfiguration' + IngressPortOverride: + description: |- + The port number for the Service Connect proxy to listen on. + Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. + In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy. + type: integer + ClientAliases: + description: |- + The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. + Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service. + Each name and port mapping must be unique within the namespace. + For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``. + type: array + items: + $ref: '#/components/schemas/ServiceConnectClientAlias' + Tls: + description: A reference to an object that represents a Transport Layer Security (TLS) configuration. + $ref: '#/components/schemas/ServiceConnectTlsConfiguration' + DiscoveryName: + description: |- + The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. + If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. + type: string + PortName: + description: The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service. + type: string + required: + - PortName Service: type: object properties: + PlatformVersion: + default: LATEST + description: The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + PropagateTags: + description: |- + Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. + You must set this to a value other than ``NONE`` when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*. + The default is ``NONE``. + type: string + enum: + - SERVICE + - TASK_DEFINITION ServiceArn: + description: '' type: string + PlacementStrategies: + description: |- + The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service. + To remove this property from your service resource, specify an empty ``PlacementStrategy`` array. + type: array + items: + $ref: '#/components/schemas/PlacementStrategy' + ServiceRegistries: + description: |- + The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + Each service may be associated with one service registry. Multiple service registries for each service isn't supported. + To remove this property from your service resource, specify an empty ``ServiceRegistry`` array. + type: array + items: + $ref: '#/components/schemas/ServiceRegistry' + VolumeConfigurations: + description: |- + The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. + To remove this property from your service resource, specify an empty ``ServiceVolumeConfiguration`` array. + type: array + items: + $ref: '#/components/schemas/ServiceVolumeConfiguration' CapacityProviderStrategy: + description: |- + The capacity provider strategy to use for the service. + If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. + A capacity provider strategy can contain a maximum of 20 capacity providers. + To remove this property from your service resource, specify an empty ``CapacityProviderStrategyItem`` array. type: array items: $ref: '#/components/schemas/CapacityProviderStrategyItem' - Cluster: - type: string - DeploymentConfiguration: - $ref: '#/components/schemas/DeploymentConfiguration' - DeploymentController: - $ref: '#/components/schemas/DeploymentController' - DesiredCount: - type: integer - EnableECSManagedTags: - type: boolean - EnableExecuteCommand: - type: boolean - HealthCheckGracePeriodSeconds: - type: integer LaunchType: + description: The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. type: string enum: - EC2 - FARGATE - EXTERNAL - LoadBalancers: - type: array - items: - $ref: '#/components/schemas/LoadBalancer' Name: + description: '' type: string - NetworkConfiguration: - $ref: '#/components/schemas/NetworkConfiguration' - PlacementConstraints: - type: array - items: - $ref: '#/components/schemas/PlacementConstraint' - PlacementStrategies: - type: array - items: - $ref: '#/components/schemas/PlacementStrategy' - PlatformVersion: - type: string - default: LATEST - PropagateTags: + AvailabilityZoneRebalancing: + default: ENABLED + description: |- + Indicates whether to use Availability Zone rebalancing for the service. + For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the *Amazon Elastic Container Service Developer Guide*. type: string enum: - - SERVICE - - TASK_DEFINITION - Role: - type: string + - ENABLED + - DISABLED SchedulingStrategy: + description: |- + The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + There are two service scheduler strategies available: + + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. + Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy. type: string enum: - DAEMON - REPLICA - ServiceConnectConfiguration: - $ref: '#/components/schemas/ServiceConnectConfiguration' - ServiceName: - type: string - ServiceRegistries: - type: array - items: - $ref: '#/components/schemas/ServiceRegistry' + NetworkConfiguration: + description: The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/NetworkConfiguration' Tags: + description: |- + The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. + The following basic restrictions apply to tags: + + Maximum number of tags per resource - 50 + + For each resource, each tag key must be unique, and each tag key can have only one value. + + Maximum key length - 128 Unicode characters in UTF-8 + + Maximum value length - 256 Unicode characters in UTF-8 + + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + + Tag keys and values are case-sensitive. + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. type: array items: $ref: '#/components/schemas/Tag' - TaskDefinition: + ForceNewDeployment: + description: Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (``my_image:latest``) or to roll Fargate tasks onto a newer platform version. + $ref: '#/components/schemas/ForceNewDeployment' + HealthCheckGracePeriodSeconds: + description: |- + The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of ``0`` is used. If you don't use any of the health checks, then ``healthCheckGracePeriodSeconds`` is unused. + If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. + type: integer + EnableECSManagedTags: + description: |- + Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. + When you use Amazon ECS managed tags, you must set the ``propagateTags`` request parameter. + type: boolean + EnableExecuteCommand: + description: Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service. + type: boolean + PlacementConstraints: + description: |- + An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime. + To remove this property from your service resource, specify an empty ``PlacementConstraint`` array. + type: array + items: + $ref: '#/components/schemas/PlacementConstraint' + Cluster: + description: The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed. type: string - VolumeConfigurations: + LoadBalancers: + description: |- + A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*. + To remove this property from your service resource, specify an empty ``LoadBalancer`` array. type: array items: - $ref: '#/components/schemas/ServiceVolumeConfiguration' + $ref: '#/components/schemas/LoadBalancer' + ServiceConnectConfiguration: + description: |- + The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/ServiceConnectConfiguration' + DesiredCount: + description: |- + The number of instantiations of the specified task definition to place and keep running in your service. + For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. + For existing services, if a desired count is not specified, it is omitted from the operation. + type: integer + VpcLatticeConfigurations: + description: The VPC Lattice configuration for the service being created. + type: array + items: + $ref: '#/components/schemas/VpcLatticeConfiguration' + DeploymentController: + description: The deployment controller to use for the service. + $ref: '#/components/schemas/DeploymentController' + Role: + description: |- + The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. + If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*. + type: string + TaskDefinition: + description: |- + The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. + A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. + For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). + type: string + ServiceName: + description: |- + The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. + The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster. + type: string + DeploymentConfiguration: + description: Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. + $ref: '#/components/schemas/DeploymentConfiguration' x-stackql-resource-name: service - x-stackql-primaryIdentifier: + description: |- + The ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers. + The stack update fails if you change any properties that require replacement and at least one ECS Service Connect ``ServiceConnectConfiguration`` property is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace. + Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. + On June 12, 2025, Amazon ECS launched support for updating capacity provider configuration for ECS services. With this launch, ECS also aligned the CFN update behavior for ``CapacityProviderStrategy`` parameter with the standard practice. For more information, see [adds support for updating capacity provider configuration for ECS services](https://docs.aws.amazon.com/about-aws/whats-new/2025/05/amazon-ecs-capacity-provider-configuration-ecs/). Previously ECS ignored the ``CapacityProviderStrategy`` property if it was set to an empty list for example, ``[]`` in CFN, because updating capacity provider configuration was not supported. Now, with support for capacity provider updates, customers can remove capacity providers from a service by passing an empty list. When you specify an empty list (``[]``) for the ``CapacityProviderStrategy`` property in your CFN template, ECS will remove any capacity providers associated with the service, as follows: + + For services created with a capacity provider strategy after the launch: + + If there's a cluster default strategy set, the service will revert to using that default strategy. + + If no cluster default strategy exists, you will receive the following error: + No launch type to fall back to for empty capacity provider strategy. Your service was not created with a launch type. + + + For services created with a capacity provider strategy prior to the launch: + + If ``CapacityProviderStrategy`` had ``FARGATE_SPOT`` or ``FARGATE`` capacity providers, the launch type will be updated to ``FARGATE`` and the capacity provider will be removed. + + If the strategy included Auto Scaling group capacity providers, the service will revert to EC2 launch type, and the Auto Scaling group capacity providers will not be used. + + + Recommended Actions + If you are currently using ``CapacityProviderStrategy: []`` in your CFN templates, you should take one of the following actions: + + If you do not intend to update the Capacity Provider Strategy: + + Remove the ``CapacityProviderStrategy`` property entirely from your CFN template + + Alternatively, use ``!Ref ::NoValue`` for the ``CapacityProviderStrategy`` property in your template + + + If you intend to maintain or update the Capacity Provider Strategy, specify the actual Capacity Provider Strategy for the service in your CFN template. + + If your CFN template had an empty list ([]) for ``CapacityProviderStrategy`` prior to the aforementioned launch on June 12, and you are using the same template with ``CapacityProviderStrategy: []``, you might encounter the following error: + Invalid request provided: When switching from launch type to capacity provider strategy on an existing service, or making a change to a capacity provider strategy on a service that is already using one, you must force a new deployment. (Service: Ecs, Status Code: 400, Request ID: xxx) (SDK Attempt Count: 1)" (RequestToken: xxx HandlerErrorCode: InvalidRequest) + Note that CFN automatically initiates a new deployment when it detects a parameter change, but customers cannot choose to force a deployment through CFN. This is an invalid input scenario that requires one of the remediation actions listed above. + If you are experiencing active production issues related to this change, contact AWS Support or your Technical Account Manager. + x-type-name: AWS::ECS::Service + x-stackql-primary-identifier: - ServiceArn - Cluster x-create-only-properties: - Cluster - - DeploymentController - LaunchType - Role - SchedulingStrategy - ServiceName + x-write-only-properties: + - ServiceConnectConfiguration + - VolumeConfigurations + - ForceNewDeployment x-read-only-properties: - ServiceArn - Name + x-tagging: + permissions: + - ecs:TagResource + - ecs:UntagResource + - ecs:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - ecs:DescribeServices create: - ecs:CreateService + - ecs:DescribeServiceDeployments - ecs:DescribeServices + - ecs:ListServiceDeployments - iam:PassRole - ecs:TagResource - read: - - ecs:DescribeServices update: + - ecs:DescribeServiceDeployments - ecs:DescribeServices + - ecs:ListServiceDeployments - ecs:ListTagsForResource + - ecs:StopServiceDeployment - ecs:TagResource - ecs:UntagResource - ecs:UpdateService - delete: - - ecs:DeleteService - - ecs:DescribeServices list: - ecs:DescribeServices - ecs:ListClusters - ecs:ListServices + delete: + - ecs:DeleteService + - ecs:DescribeServices + VolumeFrom: + description: Details on a data volume from another container in the same task definition. + additionalProperties: false + type: object + properties: + ReadOnly: + description: If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. + type: boolean + SourceContainer: + description: The name of another container within the same task definition to mount volumes from. + type: string + ContainerDependency: + description: |- + The ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. + Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. + additionalProperties: false + type: object + properties: + Condition: + description: |- + The dependency condition of the container. The following are the available conditions and their behavior: + + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. + type: string + ContainerName: + description: The name of a container. + type: string + HealthCheck: + description: |- + The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of docker run. + The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. + If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. + The following are notes about container health check support: + + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). + + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. + additionalProperties: false + type: object + properties: + Command: + description: |- + A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. + When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. + ``[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`` + You don't include the double quotes and brackets when you use the AWS Management Console. + ``CMD-SHELL, curl -f http://localhost/ || exit 1`` + An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the docker container create command. + x-insertionOrder: true + type: array + items: + type: string + Timeout: + description: The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. This value applies only when you specify a ``command``. + type: integer + Retries: + description: The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. This value applies only when you specify a ``command``. + type: integer + Interval: + description: The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. This value applies only when you specify a ``command``. + type: integer + StartPeriod: + description: |- + The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. This value applies only when you specify a ``command``. + If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. + type: integer + HostEntry: + description: The ``HostEntry`` property specifies a hostname and an IP address that are added to the ``/etc/hosts`` file of a container through the ``extraHosts`` parameter of its ``ContainerDefinition`` resource. + additionalProperties: false + type: object + properties: + Hostname: + description: The hostname to use in the ``/etc/hosts`` entry. + type: string + IpAddress: + description: The IP address to use in the ``/etc/hosts`` entry. + type: string ContainerDefinition: description: The ``ContainerDefinition`` property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task. + additionalProperties: false type: object required: - Name - Image properties: - Command: + User: + description: |- + The user to use inside the container. This parameter maps to ``User`` in the docker container create command and the ``--user`` option to docker run. + When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. + You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + + ``user`` + + ``user:group`` + + ``uid`` + + ``uid:gid`` + + ``user:gid`` + + ``uid:group`` + + This parameter is not supported for Windows containers. + type: string + Secrets: + description: The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. + x-insertionOrder: false type: array - x-insertionOrder: true items: - type: string + $ref: '#/components/schemas/Secret' + Memory: description: >- - The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see - [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array. - Cpu: + The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote + API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If using the Fargate launch type, this parameter is optional. + If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. + The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. + The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. type: integer + Privileged: description: |- - The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. - You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024. - Linux containers share unallocated CPU units with other containers on the cont - CredentialSpecs: - type: array - x-insertionOrder: false - items: - type: string + When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the docker container create command and the ``--privileged`` option to docker run + This parameter is not supported for Windows containers or tasks run on FARGATElong. + type: boolean + HealthCheck: + description: The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the docker container create command and the ``HEALTHCHECK`` parameter of docker run. + $ref: '#/components/schemas/HealthCheck' + StartTimeout: description: |- - A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. - There are two formats for each ARN. - + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. - In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. - If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must - DependsOn: - type: array + Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. + When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. + For tasks using the Fargate launch type, the task or service requires the following platforms: + + Linux platform version ``1.3.0`` or later. + + Windows platform version ``1.0.0`` or later. + + For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + The valid values for Fargate are 2-120 seconds. + type: integer + VolumesFrom: + uniqueItems: true + description: Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the docker container create command and the ``--volumes-from`` option to docker run. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/ContainerDependency' + $ref: '#/components/schemas/VolumeFrom' + Cpu: description: |- - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. - For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [ - DisableNetworking: - type: boolean + The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the docker container create commandand the ``--cpu-shares`` option to docker run. + This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. + You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024. + Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. + On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version: + + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. + + *Agent versions greater than or equal to 1.84.0:* CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares. + + On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU. + type: integer + EntryPoint: description: |- - When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/). - This parameter is not supported for Windows containers. - DnsSearchDomains: + Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. + The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the docker container create command and the ``--entrypoint`` option to docker run. + x-insertionOrder: true type: array - x-insertionOrder: false items: type: string + DnsServers: description: |- - A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the docker container create command and the ``--dns`` option to docker run. This parameter is not supported for Windows containers. - DnsServers: - type: array x-insertionOrder: false + type: array items: type: string + ReadonlyRootFilesystem: description: |- - A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the docker container create command and the ``--read-only`` option to docker run. This parameter is not supported for Windows containers. - DockerLabels: - type: object - x-patternProperties: - .{1,}: - type: string - additionalProperties: false + type: boolean + Image: description: >- - A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires - version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` - DockerSecurityOptions: - type: array + The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. For images using tags (repository-url/image:tag), up to 255 characters total are allowed, including letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs (#). For + images using digests (repository-url/image@digest), the 255 character limit applies only to the repository URL and image name (everything before the @ sign). The only supported hash function is sha256, and the hash value after sha256: must be exactly 64 characters (only letters A-F, a-f, and numbers 0-9 are allowed). This parameter maps to ``Image`` in the docker container create command and the ``IMAGE`` parameter of docker run. + + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr..amazonaws.com/:latest`` or ``012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``). + type: string + Essential: + description: |- + If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. + All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*. + type: boolean + LogConfiguration: + description: |- + The log configuration specification for the container. + This parameter maps to ``LogConfig`` in the docker Create a container command and the ``--log-driver`` option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` + The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Developer Guide*. + $ref: '#/components/schemas/LogConfiguration' + ResourceRequirements: + description: The type and amount of a resource to assign to a container. The only supported resource is a GPU. x-insertionOrder: false + type: array items: - type: string + $ref: '#/components/schemas/ResourceRequirement' + EnvironmentFiles: + description: |- + A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to docker run. + You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. + If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*. + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/EnvironmentFile' + Name: + description: The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the docker container create command and the ``--name`` option to docker run. + type: string + FirelensConfiguration: + description: The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/FirelensConfiguration' + DockerSecurityOptions: description: |- - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. + A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. - This parameter maps to ``SecurityOpt`` in the [Create a co - EntryPoint: + This parameter maps to ``SecurityOpt`` in the docker container create command and the ``--security-opt`` option to docker run. + The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath" + x-insertionOrder: false type: array - x-insertionOrder: true items: type: string - description: |- - Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. - The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint). - Environment: - description: |- - The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - type: array + SystemControls: + description: A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the docker container create command and the ``--sysctl`` option to docker run. For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections. x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/KeyValuePair' - EnvironmentFiles: - description: |- - A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/). - If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend t type: array - x-insertionOrder: true items: - $ref: '#/components/schemas/EnvironmentFile' - Essential: + $ref: '#/components/schemas/SystemControl' + Interactive: + description: When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the docker container create command and the ``--interactive`` option to docker run. type: boolean + DnsSearchDomains: description: |- - If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. - All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*. - ExtraHosts: - type: array + A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the docker container create command and the ``--dns-search`` option to docker run. + This parameter is not supported for Windows containers. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/HostEntry' - description: >- - A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode. - FirelensConfiguration: - $ref: '#/components/schemas/FirelensConfiguration' - description: The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. - HealthCheck: - $ref: '#/components/schemas/HealthCheck' - description: >- - The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - Hostname: - type: string + type: string + CredentialSpecs: description: |- - The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode. - Image: - description: >- - The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a - container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image - type: string - Links: - type: array + A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. + There are two formats for each ARN. + + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. + In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. + If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html). x-insertionOrder: false - uniqueItems: true + type: array items: type: string + Ulimits: description: >- - The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container - links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - This parameter is not supported for W - LinuxParameters: - $ref: '#/components/schemas/LinuxParameters' - description: |- - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). + A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the + [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` This parameter is not supported for Windows containers. - LogConfiguration: - $ref: '#/components/schemas/LogConfiguration' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Ulimit' + StopTimeout: description: |- - The log configuration specification for the container. - This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/htt - Memory: - description: >- - The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote - API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - If using the Fargate launch type, this parameter is optional. - If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReserva + Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. + For tasks using the Fargate launch type, the task or service requires the following platforms: + + Linux platform version ``1.3.0`` or later. + + Windows platform version ``1.0.0`` or later. + + For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. + For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + The valid values for Fargate are 2-120 seconds. type: integer + WorkingDirectory: + description: The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the docker container create command and the ``--workdir`` option to docker run. + type: string MemoryReservation: - type: integer description: >- - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a - container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definiti - MountPoints: + The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the docker container create + command and the ``--memory-reservation`` option to docker run. + If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. + For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. + The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. + The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. + type: integer + RepositoryCredentials: + description: The private repository authentication credentials to use. + $ref: '#/components/schemas/RepositoryCredentials' + ExtraHosts: + description: |- + A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the docker container create command and the ``--add-host`` option to docker run. + This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode. + x-insertionOrder: false type: array - x-insertionOrder: true - uniqueItems: true items: - $ref: '#/components/schemas/MountPoint' + $ref: '#/components/schemas/HostEntry' + Hostname: description: |- - The mount points for data volumes in your container. - This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - Name: + The hostname to use for your container. This parameter maps to ``Hostname`` in the docker container create command and the ``--hostname`` option to docker run. + The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode. + type: string + LinuxParameters: + description: |- + Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). + This parameter is not supported for Windows containers. + $ref: '#/components/schemas/LinuxParameters' + VersionConsistency: + default: enabled description: >- - The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote - API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image + resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. type: string - PortMappings: + enum: + - enabled + - disabled + RestartPolicy: + description: The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see [Restart individual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/RestartPolicy' + DisableNetworking: description: |- - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. - For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. - Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. - This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to - type: array - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/PortMapping' - Privileged: + When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the docker container create command. + This parameter is not supported for Windows containers. type: boolean - description: >- - When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - This parameter is not supported for Windows containers or tasks run on FARGATElong. - ReadonlyRootFilesystem: + PseudoTerminal: + description: When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the docker container create command and the ``--tty`` option to docker run. type: boolean - description: >- - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - This parameter is not supported for Windows containers. - RepositoryCredentials: - $ref: '#/components/schemas/RepositoryCredentials' - description: The private repository authentication credentials to use. - ResourceRequirements: - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/ResourceRequirement' - description: The type and amount of a resource to assign to a container. The only supported resource is a GPU. - Secrets: + MountPoints: + uniqueItems: true + description: |- + The mount points for data volumes in your container. + This parameter maps to ``Volumes`` in the docker container create command and the ``--volume`` option to docker run. + Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. + x-insertionOrder: true type: array - x-insertionOrder: false items: - $ref: '#/components/schemas/Secret' - description: The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. - StartTimeout: - type: integer - description: |- - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. - When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. - For tasks using the Fargate launch type, the task or service requires the following platforms: - + Linux platform version ``1.3.0`` or later. - + Windows platform version ``1.0.0`` or later. - - For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However - StopTimeout: - type: integer + $ref: '#/components/schemas/MountPoint' + DependsOn: description: |- - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. + The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. + For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. - The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. - For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recomm - Ulimits: - type: array + If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Ulimit' - description: >- - A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the - [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` - This parameter is not supported for Windows containers. - User: - type: string + $ref: '#/components/schemas/ContainerDependency' + DockerLabels: + x-patternProperties: + .{1,}: + type: string + description: 'A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the docker container create command and the ``--label`` option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format ''{{.Server.APIVersion}}''``' + additionalProperties: false + type: object + PortMappings: + uniqueItems: true description: |- - The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. - You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. - + ``user`` - + ``user:group`` - + ``uid`` - + ``uid:gid`` - + ``user:gid`` - + ``uid:group`` - - This parameter is not supported for Windows containers. - VolumesFrom: - type: array + The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. + For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. + Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. + This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. + After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses. x-insertionOrder: false - uniqueItems: true + type: array items: - $ref: '#/components/schemas/VolumeFrom' - description: Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - WorkingDirectory: - type: string - description: The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - Interactive: - type: boolean - description: >- - When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - PseudoTerminal: - type: boolean - description: When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - SystemControls: + $ref: '#/components/schemas/PortMapping' + Command: + description: The command that's passed to the container. This parameter maps to ``Cmd`` in the docker container create command and the ``COMMAND`` parameter to docker run. If there are multiple arguments, each argument is a separated string in the array. + x-insertionOrder: true type: array + items: + type: string + Environment: + uniqueItems: true + description: |- + The environment variables to pass to a container. This parameter maps to ``Env`` in the docker container create command and the ``--env`` option to docker run. + We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/SystemControl' - description: >- - A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, - you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections. - additionalProperties: false + $ref: '#/components/schemas/KeyValuePair' + Links: + uniqueItems: true + description: |- + The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to ``Links`` in the docker container create command and the ``--link`` option to docker run. + This parameter is not supported for Windows containers. + Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. + x-insertionOrder: false + type: array + items: + type: string SystemControl: + description: |- + A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the docker container create command and the ``--sysctl`` option to docker run. For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections. + We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages: + + For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``systemControls`` for multiple containers in a single task, the container that's started last determines which ``systemControls`` take effect. + + For tasks that use the ``host`` network mode, the network namespace ``systemControls`` aren't supported. + + If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see [IPC mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode). + + For tasks that use the ``host`` IPC mode, IPC namespace ``systemControls`` aren't supported. + + For tasks that use the ``task`` IPC mode, IPC namespace ``systemControls`` values apply to all containers within a task. + + This parameter is not supported for Windows containers. + This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. + additionalProperties: false type: object properties: - Namespace: - type: string - description: The namespaced kernel parameter to set a ``value`` for. Value: - type: string description: |- The namespaced kernel parameter to set a ``value`` for. - Valid IPC namespace values: ``"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"``, and ``Sysctls`` that start with ``"fs.mqueue.*"`` - Valid network namespace values: ``Sysctls`` that start with ``"net.*"`` + Valid IPC namespace values: ``"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"``, and ``Sysctls`` that start with ``"fs.mqueue.*"`` + Valid network namespace values: ``Sysctls`` that start with ``"net.*"``. Only namespaced ``Sysctls`` that exist within the container starting with "net.* are accepted. All of these values are supported by Fargate. - additionalProperties: false - description: >- - A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you - can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections. - We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages: - + For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``sy - ContainerDependency: - type: object - properties: - ContainerName: - type: string - description: The name of a container. - Condition: - type: string - description: |- - The dependency condition of the container. The following are the available conditions and their behavior: - + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. - + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. - + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. - + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confi - additionalProperties: false - description: |- - The ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. - Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For m - Device: - type: object - properties: - ContainerPath: type: string - description: The path inside the container at which to expose the host device. - HostPath: + Namespace: + description: The namespaced kernel parameter to set a ``value`` for. type: string - description: The path for the device on the host container instance. - Permissions: - type: array - x-insertionOrder: false - uniqueItems: true - items: - type: string - description: The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device. - additionalProperties: false - description: The ``Device`` property specifies an object representing a container instance host device. DockerVolumeConfiguration: + description: The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead. + additionalProperties: false type: object properties: - Autoprovision: - type: boolean - description: |- - If this value is ``true``, the Docker volume is created if it doesn't already exist. - This field is only used if the ``scope`` is ``shared``. - Driver: - type: string - description: >- - The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin - discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume - create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/). DriverOpts: - type: object x-patternProperties: .{1,}: type: string + description: A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the docker create-volume command and the ``xxopt`` option to docker volume create. additionalProperties: false - description: A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/). - Labels: type: object - x-patternProperties: - .{1,}: - type: string - additionalProperties: false - description: Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/). Scope: - type: string description: The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops. - additionalProperties: false - description: The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead. - AuthorizationConfig: - type: object - properties: - IAM: - type: string - enum: - - ENABLED - - DISABLED - description: >- - Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service - Developer Guide*. - AccessPointId: - type: string - description: >- - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic - File System User Guide*. - additionalProperties: false - description: The authorization configuration details for the Amazon EFS file system. - EFSVolumeConfiguration: - type: object - required: - - FilesystemId - properties: - FilesystemId: - type: string - description: The Amazon EFS file system ID to use. - RootDirectory: type: string + Autoprovision: description: |- - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. - If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. - TransitEncryption: - type: string - enum: - - ENABLED - - DISABLED - description: Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*. - TransitEncryptionPort: - type: integer - description: The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*. - AuthorizationConfig: - $ref: '#/components/schemas/AuthorizationConfig' - description: The authorization configuration details for the Amazon EFS file system. - additionalProperties: false - description: This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. - EnvironmentFile: - type: object - properties: - Value: - type: string - description: The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. - Type: - type: string - description: The file type to use. The only supported value is ``s3``. - additionalProperties: false - description: |- - A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. - If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying environment variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*. - You must use the following platforms for the Fargate launch type: - + Linux platform version ``1.4.0`` or la - EphemeralStorage: - type: object - properties: - SizeInGiB: - type: integer - description: The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``21`` GiB and the maximum supported value is ``200`` GiB. - additionalProperties: false - description: |- - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. - For tasks using the Fargate launch type, the task requires the following platforms: - + Linux platform version ``1.4.0`` or later. - + Windows platform version ``1.0.0`` or later. - FirelensConfiguration: - type: object - properties: - Type: + If this value is ``true``, the Docker volume is created if it doesn't already exist. + This field is only used if the ``scope`` is ``shared``. + type: boolean + Driver: + description: >- + The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to ``Driver`` in the docker container create command and the ``xxdriver`` option to + docker volume create. type: string - description: The log router to use. The valid values are ``fluentd`` or ``fluentbit``. - Options: - type: object + Labels: x-patternProperties: .{1,}: type: string - additionalProperties: false - description: |- - The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. - If specified, valid option keys are: - + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` - + ``config-file-type``, which can be ``s3`` or ``file`` - + ``config-file-value``, which is either an S3 ARN or a file path - additionalProperties: false - description: The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. - HealthCheck: - description: |- - The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). - The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. - If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a servi - type: object - properties: - Command: - description: |- - A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. - When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. - ``[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`` - You don't include the double quotes and brackets when you use the AWS Management Console. - ``CMD-SHELL, curl -f http://localhost/ || exit 1`` - An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/). - type: array - x-insertionOrder: true - items: - type: string - Interval: - description: The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. - type: integer - Timeout: - description: The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. - type: integer - Retries: - description: The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. - type: integer - StartPeriod: - description: |- - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. - If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - type: integer - additionalProperties: false - HostEntry: - type: object - properties: - Hostname: - type: string - description: The hostname to use in the ``/etc/hosts`` entry. - IpAddress: - type: string - description: The IP address to use in the ``/etc/hosts`` entry. + description: Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the docker container create command and the ``xxlabel`` option to docker volume create. + additionalProperties: false + type: object + FirelensConfiguration: + description: The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - description: The ``HostEntry`` property specifies a hostname and an IP address that are added to the ``/etc/hosts`` file of a container through the ``extraHosts`` parameter of its ``ContainerDefinition`` resource. - HostVolumeProperties: type: object properties: - SourcePath: + Options: + x-patternProperties: + .{1,}: + type: string + description: |- + The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. + If specified, valid option keys are: + + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + + ``config-file-type``, which can be ``s3`` or ``file`` + + ``config-file-value``, which is either an S3 ARN or a file path + additionalProperties: false + type: object + Type: + description: The log router to use. The valid values are ``fluentd`` or ``fluentbit``. type: string - description: >- - When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container - instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. - If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported. + RuntimePlatform: + description: |- + Information about the platform for the Amazon ECS service or task. + For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - description: The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume. - InferenceAccelerator: type: object properties: - DeviceName: + OperatingSystemFamily: + description: The operating system. type: string - description: The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html). - DeviceType: + CpuArchitecture: + description: |- + The CPU architecture. + You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. type: string - description: The Elastic Inference accelerator type to use. - additionalProperties: false - description: Details on an Elastic Inference accelerator. For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*. KernelCapabilities: + description: |- + The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page. + The following describes how Docker processes the Linux capabilities specified in the ``add`` and ``drop`` request parameters. For information about the latest behavior, see [Docker Compose: order of cap_drop and cap_add](https://docs.aws.amazon.com/https://forums.docker.com/t/docker-compose-order-of-cap-drop-and-cap-add/97136/1) in the Docker Community Forum. + + When the container is a privleged container, the container capabilities are all of the default Docker capabilities. The capabilities specified in the ``add`` request parameter, and the ``drop`` request parameter are ignored. + + When the ``add`` request parameter is set to ALL, the container capabilities are all of the default Docker capabilities, excluding those specified in the ``drop`` request parameter. + + When the ``drop`` request parameter is set to ALL, the container capabilities are the capabilities specified in the ``add`` request parameter. + + When the ``add`` request parameter and the ``drop`` request parameter are both empty, the capabilities the container capabilities are all of the default Docker capabilities. + + The default is to first drop the capabilities specified in the ``drop`` request parameter, and then add the capabilities specified in the ``add`` request parameter. + additionalProperties: false type: object properties: Add: - type: array + description: |- + The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the docker container create command and the ``--cap-add`` option to docker run. + Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. + Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"`` x-insertionOrder: false + type: array items: type: string - description: >- - The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. - Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" Drop: - type: array + description: |- + The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the docker container create command and the ``--cap-drop`` option to docker run. + Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"`` x-insertionOrder: false + type: array items: type: string - description: >- - The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker - run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" + Tmpfs: + description: The container path, mount options, and size of the tmpfs mount. additionalProperties: false - description: >- - The ``KernelCapabilities`` property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker. For more information on the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information - on these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page. - KeyValuePair: type: object + required: + - Size properties: - Name: - type: string - description: The name of the key-value pair. For environment variables, this is the name of the environment variable. - Value: + Size: + description: The maximum size (in MiB) of the tmpfs volume. + type: integer + ContainerPath: + description: The absolute file path where the tmpfs volume is to be mounted. type: string - description: The value of the key-value pair. For environment variables, this is the value of the environment variable. - additionalProperties: false - description: A key-value pair object. - LinuxParameters: - type: object - properties: - Capabilities: - $ref: '#/components/schemas/KernelCapabilities' + MountOptions: description: |- - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. - For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. - Devices: - type: array + The list of tmpfs volume mount options. + Valid values: ``"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"`` x-insertionOrder: false - items: - $ref: '#/components/schemas/Device' - description: |- - Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported. - InitProcessEnabled: - type: boolean - description: >- - Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo - docker version --format '{{.Server.APIVersion}}'`` - MaxSwap: - type: integer - description: |- - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. - If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. - If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. - If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. - SharedMemorySize: - type: integer - description: |- - The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported. - Swappiness: - type: integer - description: >- - This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps - to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. - If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. - Tmpfs: type: array - x-insertionOrder: false items: - $ref: '#/components/schemas/Tmpfs' - description: |- - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). - If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported. + type: string + AuthorizationConfig: + description: The authorization configuration details for the Amazon EFS file system. additionalProperties: false - description: The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). - PortMapping: type: object properties: - Name: + IAM: + description: >- + Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service + Developer Guide*. type: string + enum: + - ENABLED + - DISABLED + AccessPointId: + description: >- + The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic + File System User Guide*. + type: string + PortMapping: + description: |- + The ``PortMapping`` property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. + If you are using containers in a task with the ``awsvpc`` or ``host`` network mode, exposed ports should be specified using ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. + After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the ``networkBindings`` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses. + additionalProperties: false + type: object + properties: + AppProtocol: description: |- - The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. - For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. - ContainerPort: - type: integer - description: |- - The port number on the container that's bound to the user-specified or automatically assigned host port. - If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. - If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - ContainerPortRange: + The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. + If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. + ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. type: string + enum: + - http + - http2 + - grpc + ContainerPortRange: description: |- The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a ``containerPortRange``: @@ -1309,9 +2226,19 @@ components: + You can specify a maximum of 100 port ranges per container. + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. - + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host + + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + + + The ``containerPortRange`` valid values are between 1 and 65535. + + A port can only be included in one port mapping per container. + + You cannot specify overlapping port ranges. + + The first port in the range must be less than last port in the range. + + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. + For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website. + For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*. + + You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports. + type: string HostPort: - type: integer description: |- The port number on the container instance to reserve for your container. If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: @@ -1319,328 +2246,500 @@ components: + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. - If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically + If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. + The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. + The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. + type: integer + ContainerPort: + description: |- + The port number on the container that's bound to the user-specified or automatically assigned host port. + If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. + If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. + type: integer Protocol: - type: string description: The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. - AppProtocol: type: string - enum: - - http - - http2 - - grpc - description: |- - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. - If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. - ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. - Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS se + Name: + description: The name that's used for the port mapping. This parameter is the name that you use in the ``serviceConnectConfiguration`` and the ``vpcLatticeConfigurations`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. + type: string + TaskDefinitionPlacementConstraint: + description: |- + The constraint on task placement in the task definition. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*. + Task placement constraints aren't supported for tasks run on FARGATElong. additionalProperties: false + type: object + required: + - Type + properties: + Type: + description: The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates. + type: string + Expression: + description: A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + FSxAuthorizationConfig: description: |- - The ``PortMapping`` property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. - If you are using containers in a task with the ``awsvpc`` or ``host`` network mode, exposed ports should be specified using ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. - After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the ``networkBindings`` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses. - MountPoint: + The authorization configuration details for Amazon FSx for Windows File Server file system. See [FSxWindowsFileServerVolumeConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) in the *Amazon ECS API Reference*. + For more information and the input format, see [Amazon FSx for Windows File Server Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false type: object + required: + - CredentialsParameter + - Domain properties: - ContainerPath: + CredentialsParameter: + description: The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an ASMlong secret or SSM Parameter Store parameter. The ARN refers to the stored credentials. type: string - description: The path on the container to mount the host volume at. - ReadOnly: - type: boolean - description: If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. - SourceVolume: + Domain: + description: A fully qualified domain name hosted by an [](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2. type: string - description: The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``. + EFSVolumeConfiguration: + description: This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. additionalProperties: false - description: The details for a volume mount point that's used in a container definition. - ProxyConfiguration: type: object required: - - ContainerName + - FilesystemId properties: - ContainerName: + FilesystemId: + description: The Amazon EFS file system ID to use. type: string - description: The name of the container that will serve as the App Mesh proxy. - ProxyConfigurationProperties: - type: array - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/KeyValuePair' + TransitEncryption: + description: Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*. + type: string + enum: + - ENABLED + - DISABLED + AuthorizationConfig: + description: The authorization configuration details for the Amazon EFS file system. + $ref: '#/components/schemas/AuthorizationConfig' + RootDirectory: description: |- - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. - + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. - + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. - + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. - + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. - + ``ProxyEgressPort`` - (Required) Specifies the port that outgoi - Type: + The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. + If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. type: string - description: The proxy type. The only supported value is ``APPMESH``. - additionalProperties: false - description: |- - The configuration details for the App Mesh proxy. - For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + TransitEncryptionPort: + description: The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*. + type: integer RepositoryCredentials: + description: The repository credentials for private registry authentication. + additionalProperties: false type: object properties: CredentialsParameter: - type: string description: |- The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret. - additionalProperties: false - description: The repository credentials for private registry authentication. - ResourceRequirement: - type: object - required: - - Type - - Value - properties: - Type: - type: string - description: The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``. - Value: type: string - description: |- - The value for the specified resource type. - If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. - If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition. + KeyValuePair: + description: A key-value pair object. additionalProperties: false - description: The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide* - RuntimePlatform: type: object properties: - CpuArchitecture: + Value: + description: The value of the key-value pair. For environment variables, this is the value of the environment variable. type: string - description: |- - The CPU architecture. - You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - OperatingSystemFamily: + Name: + description: The name of the key-value pair. For environment variables, this is the name of the environment variable. type: string - description: The operating system. + Device: + description: The ``Device`` property specifies an object representing a container instance host device. additionalProperties: false - description: |- - Information about the platform for the Amazon ECS service or task. - For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*. - TaskDefinitionPlacementConstraint: type: object - required: - - Type properties: - Type: + HostPath: + description: The path for the device on the host container instance. type: string - description: The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates. - Expression: + Permissions: + uniqueItems: true + description: The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device. + x-insertionOrder: false + type: array + items: + type: string + ContainerPath: + description: The path inside the container at which to expose the host device. type: string - description: A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. + LinuxParameters: + description: The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). additionalProperties: false - description: |- - The constraint on task placement in the task definition. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*. - Task placement constraints aren't supported for tasks run on FARGATElong. - Tmpfs: type: object - required: - - Size properties: - ContainerPath: - type: string - description: The absolute file path where the tmpfs volume is to be mounted. - MountOptions: + Capabilities: + description: |- + The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. + For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. + $ref: '#/components/schemas/KernelCapabilities' + Swappiness: + description: >- + This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps + to the ``--memory-swappiness`` option to docker run. + If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. + If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. + type: integer + Tmpfs: + description: |- + The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to docker run. + If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported. + x-insertionOrder: false type: array + items: + $ref: '#/components/schemas/Tmpfs' + SharedMemorySize: + description: |- + The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to docker run. + If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported. + type: integer + Devices: + description: |- + Any host devices to expose to the container. This parameter maps to ``Devices`` in the docker container create command and the ``--device`` option to docker run. + If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported. x-insertionOrder: false + type: array items: - type: string + $ref: '#/components/schemas/Device' + InitProcessEnabled: + description: 'Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format ''{{.Server.APIVersion}}''``' + type: boolean + MaxSwap: description: |- - The list of tmpfs volume mount options. - Valid values: ``"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"`` - Size: + The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to docker run where the value would be the sum of the container memory plus the ``maxSwap`` value. + If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. + If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. + If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. type: integer - description: The maximum size (in MiB) of the tmpfs volume. - additionalProperties: false - description: The container path, mount options, and size of the tmpfs mount. Ulimit: + description: |- + The ``ulimit`` settings to pass to the container. + Amazon ECS tasks hosted on FARGATElong use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which FARGATElong overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``65535`` and the default hard limit is ``65535``. + You can specify the ``ulimit`` settings for a container in a task definition. + additionalProperties: false type: object required: - HardLimit - Name - SoftLimit properties: + SoftLimit: + description: The soft limit for the ``ulimit`` type. The value can be specified in bytes, seconds, or as a count, depending on the ``type`` of the ``ulimit``. + type: integer HardLimit: + description: The hard limit for the ``ulimit`` type. The value can be specified in bytes, seconds, or as a count, depending on the ``type`` of the ``ulimit``. type: integer - description: The hard limit for the ``ulimit`` type. Name: - type: string description: The ``type`` of the ``ulimit``. - SoftLimit: + type: string + RestartPolicy: + description: >- + You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability. When you enable a restart policy for a container, Amazon ECS can restart the container if it exits, without needing to replace the task. For more information, see [Restart individual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) + in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false + type: object + properties: + IgnoredExitCodes: + description: A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes. + x-insertionOrder: false + type: array + items: + type: integer + RestartAttemptPeriod: + description: A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every ``restartAttemptPeriod`` seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum ``restartAttemptPeriod`` of 60 seconds and a maximum ``restartAttemptPeriod`` of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted. type: integer - description: The soft limit for the ``ulimit`` type. + Enabled: + description: Specifies whether a restart policy is enabled for the container. + type: boolean + HostVolumeProperties: + description: The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume. + additionalProperties: false + type: object + properties: + SourcePath: + description: >- + When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container + instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. + If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported. + type: string + MountPoint: + description: The details for a volume mount point that's used in a container definition. additionalProperties: false + type: object + properties: + ReadOnly: + description: If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. + type: boolean + SourceVolume: + description: The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``. + type: string + ContainerPath: + description: The path on the container to mount the host volume at. + type: string + ProxyConfiguration: description: |- - The ``ulimit`` settings to pass to the container. - Amazon ECS tasks hosted on FARGATElong use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which FARGATElong overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``1024`` and the default hard limit is ``65535``. - You can specify the ``ulimit`` settings for a container in a task definition. + The configuration details for the App Mesh proxy. + For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + additionalProperties: false + type: object + required: + - ContainerName + properties: + ProxyConfigurationProperties: + uniqueItems: true + description: |- + The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/KeyValuePair' + Type: + description: The proxy type. The only supported value is ``APPMESH``. + type: string + ContainerName: + description: The name of the container that will serve as the App Mesh proxy. + type: string Volume: + description: >- + The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a ``name`` and one of either ``configuredAtLaunch``, ``dockerVolumeConfiguration``, ``efsVolumeConfiguration``, ``fsxWindowsFileServerVolumeConfiguration``, or ``host``. If + an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). + additionalProperties: false type: object properties: + EFSVolumeConfiguration: + description: This parameter is specified when you use an Amazon Elastic File System file system for task storage. + $ref: '#/components/schemas/EFSVolumeConfiguration' + Host: + description: |- + This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. + Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\my\path:C:\my\path`` and ``D:\:D:\``, but not ``D:\my\path:C:\my\path`` or ``D:\:C:\my\path``. + $ref: '#/components/schemas/HostVolumeProperties' ConfiguredAtLaunch: - type: boolean description: |- Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs. + type: boolean DockerVolumeConfiguration: - $ref: '#/components/schemas/DockerVolumeConfiguration' description: |- This parameter is specified when you use Docker volumes. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead. Docker volumes aren't supported by tasks run on FARGATElong. - EFSVolumeConfiguration: - $ref: '#/components/schemas/EFSVolumeConfiguration' - description: This parameter is specified when you use an Amazon Elastic File System file system for task storage. - Host: - $ref: '#/components/schemas/HostVolumeProperties' - description: |- - This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. - Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\my\path:C:\my\path`` and ``D:\:D:\``, but not ``D:\my\path:C:\my\path`` or ``D:\:C:\my\path``. + $ref: '#/components/schemas/DockerVolumeConfiguration' + FSxWindowsFileServerVolumeConfiguration: + description: This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. + $ref: '#/components/schemas/FSxWindowsFileServerVolumeConfiguration' Name: - type: string description: |- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task. For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition. When a volume is using the ``efsVolumeConfiguration``, the name is required. + type: string + EnvironmentFile: + description: |- + A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. + If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Use a file to pass environment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic Container Service Developer Guide*. + Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. + You must use the following platforms for the Fargate launch type: + + Linux platform version ``1.4.0`` or later. + + Windows platform version ``1.0.0`` or later. + + Consider the following when using the Fargate launch type: + + The file is handled like a native Docker env-file. + + There is no support for shell escape handling. + + The container entry point interperts the ``VARIABLE`` values. additionalProperties: false - description: >- - The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a ``name`` and one of either ``configuredAtLaunch``, ``dockerVolumeConfiguration``, ``efsVolumeConfiguration``, ``fsxWindowsFileServerVolumeConfiguration``, or ``host``. If - an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). - VolumeFrom: type: object properties: - ReadOnly: - type: boolean - description: If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. - SourceContainer: + Type: + description: The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``. type: string - description: The name of another container within the same task definition to mount volumes from. + Value: + description: The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. + type: string + ResourceRequirement: + description: The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide* additionalProperties: false - description: Details on a data volume from another container in the same task definition. - TaskDefinition: type: object + required: + - Type + - Value properties: - TaskDefinitionArn: - description: '' - type: string - Family: + Type: + description: The type of resource to assign to a container. type: string + Value: description: |- - The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. - A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. - To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it. - ContainerDefinitions: - type: array - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/ContainerDefinition' - description: A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. - Cpu: + The value for the specified resource type. + When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. + When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition. type: string + InferenceAccelerator: + description: '' + additionalProperties: false + type: object + properties: + DeviceType: + type: string + DeviceName: + type: string + EphemeralStorage: + description: |- + The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. + For tasks using the Fargate launch type, the task requires the following platforms: + + Linux platform version ``1.4.0`` or later. + + Windows platform version ``1.0.0`` or later. + additionalProperties: false + type: object + properties: + SizeInGiB: + description: The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``21`` GiB and the maximum supported value is ``200`` GiB. + type: integer + FSxWindowsFileServerVolumeConfiguration: + description: |- + This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage. + For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. + additionalProperties: false + type: object + required: + - FileSystemId + - RootDirectory + properties: + AuthorizationConfig: + description: The authorization configuration details for the Amazon FSx for Windows File Server file system. + $ref: '#/components/schemas/FSxAuthorizationConfig' + FileSystemId: + description: The Amazon FSx for Windows File Server file system ID to use. + type: string + RootDirectory: + description: The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host. + type: string + TaskDefinition: + type: object + properties: + TaskRoleArn: description: |- - The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. - The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. - + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - + 8192 (8 vCPU) - Available ``memory`` va - ExecutionRoleArn: + The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*. + String validation is done on the ECS side. If an invalid string value is given for ``TaskRoleArn``, it may cause the Cloudformation job to hang. + type: string + IpcMode: + description: >- + The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task + are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. + If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. + If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. + + This parameter is not supported for Windows containers or tasks run on FARGATElong. type: string - description: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*. - EphemeralStorage: - $ref: '#/components/schemas/EphemeralStorage' - description: The ephemeral storage settings to use for tasks run with the task definition. InferenceAccelerators: - type: array - x-insertionOrder: false uniqueItems: true + description: '' + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/InferenceAccelerator' - description: The Elastic Inference accelerators to use for the containers in the task. Memory: - type: string description: |- The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) - + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` va - NetworkMode: + + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) + This option requires Linux platform ``1.4.0`` or later. + + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) + This option requires Linux platform ``1.4.0`` or later. type: string - description: |- - The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. - For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. - With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elasti PlacementConstraints: - type: array - x-insertionOrder: false uniqueItems: true - items: - $ref: '#/components/schemas/TaskDefinitionPlacementConstraint' description: |- An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong. - ProxyConfiguration: - $ref: '#/components/schemas/ProxyConfiguration' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TaskDefinitionPlacementConstraint' + Cpu: description: |- - The configuration details for the App Mesh proxy. - Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. + If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``196608`` CPU units (``192`` vCPUs). + This field is required for Fargate. For information about the valid values, see [Task size](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) in the *Amazon Elastic Container Service Developer Guide*. + type: string RequiresCompatibilities: - type: array - x-insertionOrder: false uniqueItems: true - items: - type: string description: The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. - TaskRoleArn: - type: string - description: |- - The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. - IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*. - Volumes: - type: array x-insertionOrder: false - uniqueItems: true + type: array items: - $ref: '#/components/schemas/Volume' + type: string + NetworkMode: description: |- - The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. - The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong. - PidMode: + The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. + For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. + With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. + When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. + If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. + If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. type: string + PidMode: description: |- The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. - If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. - If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://doc + If no value is specified, the default is a private namespace for each container. + If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. + This parameter is not supported for Windows containers. + This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. + type: string + EnableFaultInjection: + description: Enables fault injection and allows for fault injection requests to be accepted from the task's containers. The default value is ``false``. + type: boolean + ExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string RuntimePlatform: + description: The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. $ref: '#/components/schemas/RuntimePlatform' + ProxyConfiguration: description: |- - The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. - When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. - IpcMode: - type: string - description: >- - The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task - are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. - If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more inform - Tags: + The configuration details for the App Mesh proxy. + Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/ProxyConfiguration' + Volumes: + uniqueItems: true + description: |- + The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. + The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong. + x-insertionOrder: false type: array + items: + $ref: '#/components/schemas/Volume' + ContainerDefinitions: + uniqueItems: true + description: A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Tag' + $ref: '#/components/schemas/ContainerDefinition' + Family: + description: |- + The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. + To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it. + type: string + EphemeralStorage: + description: The ephemeral storage settings to use for tasks run with the task definition. + $ref: '#/components/schemas/EphemeralStorage' + Tags: description: |- The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: @@ -1650,14 +2749,29 @@ components: + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. - + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + TaskDefinitionArn: + description: '' + type: string x-stackql-resource-name: task_definition - x-stackql-primaryIdentifier: + description: |- + Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. + You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. + In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*. + You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself. + x-type-name: AWS::ECS::TaskDefinition + x-stackql-primary-identifier: - TaskDefinitionArn x-create-only-properties: - Family - ContainerDefinitions - Cpu + - EnableFaultInjection - ExecutionRoleArn - InferenceAccelerators - Memory @@ -1673,15 +2787,25 @@ components: - EphemeralStorage x-read-only-properties: - TaskDefinitionArn + x-tagging: + permissions: + - ecs:TagResource + - ecs:UntagResource + - ecs:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ecs:DescribeTaskDefinition create: - ecs:RegisterTaskDefinition - ecs:DescribeTaskDefinition - ecs:TagResource - iam:GetRole - iam:PassRole - read: - - ecs:DescribeTaskDefinition update: - ecs:TagResource - ecs:UntagResource @@ -1689,79 +2813,85 @@ components: - ecs:DescribeTaskDefinition - iam:GetRole - iam:PassRole + list: + - ecs:ListTaskDefinitions + - ecs:DescribeTaskDefinition delete: - ecs:DeregisterTaskDefinition - ecs:DescribeTaskDefinition - iam:GetRole - iam:PassRole - list: - - ecs:ListTaskDefinitions - - ecs:DescribeTaskDefinition Scale: + additionalProperties: false type: object properties: + Value: + description: The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. + maximum: 100 + type: number + minimum: 0 Unit: description: The unit of measure for the scale value. type: string enum: - PERCENT - Value: - description: The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. - type: number - minimum: 0 - maximum: 100 - additionalProperties: false TaskSet: type: object properties: - Cluster: - description: The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. + PlatformVersion: + description: The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. type: string ExternalId: description: 'An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. ' type: string - Id: - description: The ID of the task set. - type: string - LaunchType: - description: 'The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. ' + Cluster: + description: The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. type: string - enum: - - EC2 - - FARGATE LoadBalancers: type: array items: $ref: '#/components/schemas/LoadBalancer' - NetworkConfiguration: - $ref: '#/components/schemas/NetworkConfiguration' - PlatformVersion: - description: The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. + Service: + description: The short name or full Amazon Resource Name (ARN) of the service to create the task set in. type: string Scale: description: A floating-point percentage of the desired number of tasks to place and keep running in the task set. $ref: '#/components/schemas/Scale' - Service: - description: The short name or full Amazon Resource Name (ARN) of the service to create the task set in. - type: string ServiceRegistries: description: The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. type: array items: $ref: '#/components/schemas/ServiceRegistry' - Tags: + CapacityProviderStrategy: type: array items: - $ref: '#/components/schemas/Tag' + $ref: '#/components/schemas/CapacityProviderStrategyItem' + LaunchType: + description: 'The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. ' + type: string + enum: + - EC2 + - FARGATE TaskDefinition: description: The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use. type: string + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + Id: + description: The ID of the task set. + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' required: - Cluster - Service - TaskDefinition x-stackql-resource-name: task_set - x-stackql-primaryIdentifier: + description: Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide. + x-type-name: AWS::ECS::TaskSet + x-stackql-primary-identifier: - Cluster - Service - Id @@ -1775,15 +2905,30 @@ components: - Service - ServiceRegistries - TaskDefinition + - CapacityProviderStrategy x-read-only-properties: - Id + x-required-properties: + - Cluster + - Service + - TaskDefinition + x-tagging: + permissions: + - ecs:TagResource + - ecs:UntagResource + - ecs:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - ecs:DescribeTaskSets create: - ecs:CreateTaskSet - ecs:DescribeTaskSets - ecs:TagResource - read: - - ecs:DescribeTaskSets update: - ecs:DescribeTaskSets - ecs:TagResource @@ -1792,48 +2937,557 @@ components: delete: - ecs:DeleteTaskSet - ecs:DescribeTaskSets + CreateClusterCapacityProviderAssociationsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DefaultCapacityProviderStrategy: + $ref: '#/components/schemas/DefaultCapacityProviderStrategy' + CapacityProviders: + $ref: '#/components/schemas/CapacityProviders' + Cluster: + $ref: '#/components/schemas/Cluster' + x-stackQL-stringOnly: true + x-title: CreateClusterCapacityProviderAssociationsRequest + type: object + required: [] + CreatePrimaryTaskSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TaskSetId: + description: The ID or full Amazon Resource Name (ARN) of the task set. + type: string + Cluster: + description: The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. + type: string + Service: + description: The short name or full Amazon Resource Name (ARN) of the service to create the task set in. + type: string + x-stackQL-stringOnly: true + x-title: CreatePrimaryTaskSetRequest + type: object + required: [] + CreateServiceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PlatformVersion: + default: LATEST + description: The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + PropagateTags: + description: |- + Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. + You must set this to a value other than ``NONE`` when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*. + The default is ``NONE``. + type: string + enum: + - SERVICE + - TASK_DEFINITION + ServiceArn: + description: '' + type: string + PlacementStrategies: + description: |- + The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service. + To remove this property from your service resource, specify an empty ``PlacementStrategy`` array. + type: array + items: + $ref: '#/components/schemas/PlacementStrategy' + ServiceRegistries: + description: |- + The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + Each service may be associated with one service registry. Multiple service registries for each service isn't supported. + To remove this property from your service resource, specify an empty ``ServiceRegistry`` array. + type: array + items: + $ref: '#/components/schemas/ServiceRegistry' + VolumeConfigurations: + description: |- + The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. + To remove this property from your service resource, specify an empty ``ServiceVolumeConfiguration`` array. + type: array + items: + $ref: '#/components/schemas/ServiceVolumeConfiguration' + CapacityProviderStrategy: + description: |- + The capacity provider strategy to use for the service. + If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. + A capacity provider strategy can contain a maximum of 20 capacity providers. + To remove this property from your service resource, specify an empty ``CapacityProviderStrategyItem`` array. + type: array + items: + $ref: '#/components/schemas/CapacityProviderStrategyItem' + LaunchType: + description: The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + enum: + - EC2 + - FARGATE + - EXTERNAL + Name: + description: '' + type: string + AvailabilityZoneRebalancing: + default: ENABLED + description: |- + Indicates whether to use Availability Zone rebalancing for the service. + For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + enum: + - ENABLED + - DISABLED + SchedulingStrategy: + description: |- + The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + There are two service scheduler strategies available: + + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. + Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy. + type: string + enum: + - DAEMON + - REPLICA + NetworkConfiguration: + description: The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/NetworkConfiguration' + Tags: + description: |- + The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. + The following basic restrictions apply to tags: + + Maximum number of tags per resource - 50 + + For each resource, each tag key must be unique, and each tag key can have only one value. + + Maximum key length - 128 Unicode characters in UTF-8 + + Maximum value length - 256 Unicode characters in UTF-8 + + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + + Tag keys and values are case-sensitive. + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. + type: array + items: + $ref: '#/components/schemas/Tag' + ForceNewDeployment: + description: Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (``my_image:latest``) or to roll Fargate tasks onto a newer platform version. + $ref: '#/components/schemas/ForceNewDeployment' + HealthCheckGracePeriodSeconds: + description: |- + The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of ``0`` is used. If you don't use any of the health checks, then ``healthCheckGracePeriodSeconds`` is unused. + If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. + type: integer + EnableECSManagedTags: + description: |- + Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. + When you use Amazon ECS managed tags, you must set the ``propagateTags`` request parameter. + type: boolean + EnableExecuteCommand: + description: Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service. + type: boolean + PlacementConstraints: + description: |- + An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime. + To remove this property from your service resource, specify an empty ``PlacementConstraint`` array. + type: array + items: + $ref: '#/components/schemas/PlacementConstraint' + Cluster: + description: The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed. + type: string + LoadBalancers: + description: |- + A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*. + To remove this property from your service resource, specify an empty ``LoadBalancer`` array. + type: array + items: + $ref: '#/components/schemas/LoadBalancer' + ServiceConnectConfiguration: + description: |- + The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/ServiceConnectConfiguration' + DesiredCount: + description: |- + The number of instantiations of the specified task definition to place and keep running in your service. + For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. + For existing services, if a desired count is not specified, it is omitted from the operation. + type: integer + VpcLatticeConfigurations: + description: The VPC Lattice configuration for the service being created. + type: array + items: + $ref: '#/components/schemas/VpcLatticeConfiguration' + DeploymentController: + description: The deployment controller to use for the service. + $ref: '#/components/schemas/DeploymentController' + Role: + description: |- + The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. + If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*. + type: string + TaskDefinition: + description: |- + The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. + A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. + For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). + type: string + ServiceName: + description: |- + The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. + The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster. + type: string + DeploymentConfiguration: + description: Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. + $ref: '#/components/schemas/DeploymentConfiguration' + x-stackQL-stringOnly: true + x-title: CreateServiceRequest + type: object + required: [] + CreateTaskDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TaskRoleArn: + description: |- + The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*. + String validation is done on the ECS side. If an invalid string value is given for ``TaskRoleArn``, it may cause the Cloudformation job to hang. + type: string + IpcMode: + description: >- + The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a + task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. + If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. + If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. + + This parameter is not supported for Windows containers or tasks run on FARGATElong. + type: string + InferenceAccelerators: + uniqueItems: true + description: '' + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InferenceAccelerator' + Memory: + description: |- + The amount (in MiB) of memory used by the task. + If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). + If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) + This option requires Linux platform ``1.4.0`` or later. + + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) + This option requires Linux platform ``1.4.0`` or later. + type: string + PlacementConstraints: + uniqueItems: true + description: |- + An array of placement constraint objects to use for tasks. + This parameter isn't supported for tasks run on FARGATElong. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TaskDefinitionPlacementConstraint' + Cpu: + description: |- + The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. + If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``196608`` CPU units (``192`` vCPUs). + This field is required for Fargate. For information about the valid values, see [Task size](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) in the *Amazon Elastic Container Service Developer Guide*. + type: string + RequiresCompatibilities: + uniqueItems: true + description: The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. + x-insertionOrder: false + type: array + items: + type: string + NetworkMode: + description: |- + The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. + For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. + With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. + When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. + If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. + If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. + type: string + PidMode: + description: |- + The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. + If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. + If ``task`` is specified, all containers within the specified task share the same process namespace. + If no value is specified, the default is a private namespace for each container. + If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. + This parameter is not supported for Windows containers. + This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. + type: string + EnableFaultInjection: + description: Enables fault injection and allows for fault injection requests to be accepted from the task's containers. The default value is ``false``. + type: boolean + ExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*. + type: string + RuntimePlatform: + description: The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. + $ref: '#/components/schemas/RuntimePlatform' + ProxyConfiguration: + description: |- + The configuration details for the App Mesh proxy. + Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + $ref: '#/components/schemas/ProxyConfiguration' + Volumes: + uniqueItems: true + description: |- + The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. + The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Volume' + ContainerDefinitions: + uniqueItems: true + description: A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ContainerDefinition' + Family: + description: |- + The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. + To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it. + type: string + EphemeralStorage: + description: The ephemeral storage settings to use for tasks run with the task definition. + $ref: '#/components/schemas/EphemeralStorage' + Tags: + description: |- + The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. + The following basic restrictions apply to tags: + + Maximum number of tags per resource - 50 + + For each resource, each tag key must be unique, and each tag key can have only one value. + + Maximum key length - 128 Unicode characters in UTF-8 + + Maximum value length - 256 Unicode characters in UTF-8 + + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + + Tag keys and values are case-sensitive. + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + TaskDefinitionArn: + description: '' + type: string + x-stackQL-stringOnly: true + x-title: CreateTaskDefinitionRequest + type: object + required: [] + CreateTaskSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PlatformVersion: + description: The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. + type: string + ExternalId: + description: 'An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. ' + type: string + Cluster: + description: The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. + type: string + LoadBalancers: + type: array + items: + $ref: '#/components/schemas/LoadBalancer' + Service: + description: The short name or full Amazon Resource Name (ARN) of the service to create the task set in. + type: string + Scale: + description: A floating-point percentage of the desired number of tasks to place and keep running in the task set. + $ref: '#/components/schemas/Scale' + ServiceRegistries: + description: The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. + type: array + items: + $ref: '#/components/schemas/ServiceRegistry' + CapacityProviderStrategy: + type: array + items: + $ref: '#/components/schemas/CapacityProviderStrategyItem' + LaunchType: + description: 'The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. ' + type: string + enum: + - EC2 + - FARGATE + TaskDefinition: + description: The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use. + type: string + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + Id: + description: The ID of the task set. + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTaskSetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: cluster_capacity_provider_associations: name: cluster_capacity_provider_associations id: awscc.ecs.cluster_capacity_provider_associations x-cfn-schema-name: ClusterCapacityProviderAssociations - x-type: get + x-cfn-type-name: AWS::ECS::ClusterCapacityProviderAssociations x-identifiers: - Cluster + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterCapacityProviderAssociations&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::ClusterCapacityProviderAssociations" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::ClusterCapacityProviderAssociations" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::ClusterCapacityProviderAssociations" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_capacity_provider_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_capacity_provider_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cluster_capacity_provider_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.DefaultCapacityProviderStrategy') as default_capacity_provider_strategy, JSON_EXTRACT(Properties, '$.CapacityProviders') as capacity_providers, - JSON_EXTRACT(Properties, '$.Cluster') as cluster, - JSON_EXTRACT(Properties, '$.DefaultCapacityProviderStrategy') as default_capacity_provider_strategy + JSON_EXTRACT(Properties, '$.Cluster') as cluster FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'DefaultCapacityProviderStrategy') as default_capacity_provider_strategy, json_extract_path_text(Properties, 'CapacityProviders') as capacity_providers, - json_extract_path_text(Properties, 'Cluster') as cluster, - json_extract_path_text(Properties, 'DefaultCapacityProviderStrategy') as default_capacity_provider_strategy + json_extract_path_text(Properties, 'Cluster') as cluster FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' AND data__Identifier = '' AND region = 'us-east-1' - primary_task_set: - name: primary_task_set - id: awscc.ecs.primary_task_set - x-cfn-schema-name: PrimaryTaskSet - x-type: get + cluster_capacity_provider_associations_list_only: + name: cluster_capacity_provider_associations_list_only + id: awscc.ecs.cluster_capacity_provider_associations_list_only + x-cfn-schema-name: ClusterCapacityProviderAssociations + x-cfn-type-name: AWS::ECS::ClusterCapacityProviderAssociations x-identifiers: - Cluster - - Service + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1841,138 +3495,206 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Cluster') as cluster, - JSON_EXTRACT(Properties, '$.TaskSetId') as task_set_id, - JSON_EXTRACT(Properties, '$.Service') as service - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::PrimaryTaskSet' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Cluster') as cluster + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Cluster') as cluster, - json_extract_path_text(Properties, 'TaskSetId') as task_set_id, - json_extract_path_text(Properties, 'Service') as service - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::PrimaryTaskSet' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'Cluster') as cluster + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' AND region = 'us-east-1' + primary_task_sets: + name: primary_task_sets + id: awscc.ecs.primary_task_sets + x-cfn-schema-name: PrimaryTaskSet + x-cfn-type-name: AWS::ECS::PrimaryTaskSet + x-identifiers: + - Cluster + - Service + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PrimaryTaskSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::PrimaryTaskSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::PrimaryTaskSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/primary_task_sets/methods/create_resource' + delete: [] + update: + - $ref: '#/components/x-stackQL-resources/primary_task_sets/methods/update_resource' services: name: services id: awscc.ecs.services x-cfn-schema-name: Service - x-type: list - x-identifiers: - - ServiceArn - - Cluster - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn, - JSON_EXTRACT(Properties, '$.Cluster') as cluster - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'Cluster') as cluster - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' - AND region = 'us-east-1' - service: - name: service - id: awscc.ecs.service - x-cfn-schema-name: Service - x-type: get + x-cfn-type-name: AWS::ECS::Service x-identifiers: - ServiceArn - Cluster + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.PlatformVersion') as platform_version, + JSON_EXTRACT(Properties, '$.PropagateTags') as propagate_tags, JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn, + JSON_EXTRACT(Properties, '$.PlacementStrategies') as placement_strategies, + JSON_EXTRACT(Properties, '$.ServiceRegistries') as service_registries, + JSON_EXTRACT(Properties, '$.VolumeConfigurations') as volume_configurations, JSON_EXTRACT(Properties, '$.CapacityProviderStrategy') as capacity_provider_strategy, - JSON_EXTRACT(Properties, '$.Cluster') as cluster, - JSON_EXTRACT(Properties, '$.DeploymentConfiguration') as deployment_configuration, - JSON_EXTRACT(Properties, '$.DeploymentController') as deployment_controller, - JSON_EXTRACT(Properties, '$.DesiredCount') as desired_count, - JSON_EXTRACT(Properties, '$.EnableECSManagedTags') as enable_ecs_managed_tags, - JSON_EXTRACT(Properties, '$.EnableExecuteCommand') as enable_execute_command, - JSON_EXTRACT(Properties, '$.HealthCheckGracePeriodSeconds') as health_check_grace_period_seconds, JSON_EXTRACT(Properties, '$.LaunchType') as launch_type, - JSON_EXTRACT(Properties, '$.LoadBalancers') as load_balancers, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.AvailabilityZoneRebalancing') as availability_zone_rebalancing, + JSON_EXTRACT(Properties, '$.SchedulingStrategy') as scheduling_strategy, JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.ForceNewDeployment') as force_new_deployment, + JSON_EXTRACT(Properties, '$.HealthCheckGracePeriodSeconds') as health_check_grace_period_seconds, + JSON_EXTRACT(Properties, '$.EnableECSManagedTags') as enable_ecs_managed_tags, + JSON_EXTRACT(Properties, '$.EnableExecuteCommand') as enable_execute_command, JSON_EXTRACT(Properties, '$.PlacementConstraints') as placement_constraints, - JSON_EXTRACT(Properties, '$.PlacementStrategies') as placement_strategies, - JSON_EXTRACT(Properties, '$.PlatformVersion') as platform_version, - JSON_EXTRACT(Properties, '$.PropagateTags') as propagate_tags, - JSON_EXTRACT(Properties, '$.Role') as role, - JSON_EXTRACT(Properties, '$.SchedulingStrategy') as scheduling_strategy, + JSON_EXTRACT(Properties, '$.Cluster') as cluster, + JSON_EXTRACT(Properties, '$.LoadBalancers') as load_balancers, JSON_EXTRACT(Properties, '$.ServiceConnectConfiguration') as service_connect_configuration, - JSON_EXTRACT(Properties, '$.ServiceName') as service_name, - JSON_EXTRACT(Properties, '$.ServiceRegistries') as service_registries, - JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.DesiredCount') as desired_count, + JSON_EXTRACT(Properties, '$.VpcLatticeConfigurations') as vpc_lattice_configurations, + JSON_EXTRACT(Properties, '$.DeploymentController') as deployment_controller, + JSON_EXTRACT(Properties, '$.Role') as role, JSON_EXTRACT(Properties, '$.TaskDefinition') as task_definition, - JSON_EXTRACT(Properties, '$.VolumeConfigurations') as volume_configurations + JSON_EXTRACT(Properties, '$.ServiceName') as service_name, + JSON_EXTRACT(Properties, '$.DeploymentConfiguration') as deployment_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::Service' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'PlatformVersion') as platform_version, + json_extract_path_text(Properties, 'PropagateTags') as propagate_tags, json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'PlacementStrategies') as placement_strategies, + json_extract_path_text(Properties, 'ServiceRegistries') as service_registries, + json_extract_path_text(Properties, 'VolumeConfigurations') as volume_configurations, json_extract_path_text(Properties, 'CapacityProviderStrategy') as capacity_provider_strategy, - json_extract_path_text(Properties, 'Cluster') as cluster, - json_extract_path_text(Properties, 'DeploymentConfiguration') as deployment_configuration, - json_extract_path_text(Properties, 'DeploymentController') as deployment_controller, - json_extract_path_text(Properties, 'DesiredCount') as desired_count, - json_extract_path_text(Properties, 'EnableECSManagedTags') as enable_ecs_managed_tags, - json_extract_path_text(Properties, 'EnableExecuteCommand') as enable_execute_command, - json_extract_path_text(Properties, 'HealthCheckGracePeriodSeconds') as health_check_grace_period_seconds, json_extract_path_text(Properties, 'LaunchType') as launch_type, - json_extract_path_text(Properties, 'LoadBalancers') as load_balancers, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AvailabilityZoneRebalancing') as availability_zone_rebalancing, + json_extract_path_text(Properties, 'SchedulingStrategy') as scheduling_strategy, json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ForceNewDeployment') as force_new_deployment, + json_extract_path_text(Properties, 'HealthCheckGracePeriodSeconds') as health_check_grace_period_seconds, + json_extract_path_text(Properties, 'EnableECSManagedTags') as enable_ecs_managed_tags, + json_extract_path_text(Properties, 'EnableExecuteCommand') as enable_execute_command, json_extract_path_text(Properties, 'PlacementConstraints') as placement_constraints, - json_extract_path_text(Properties, 'PlacementStrategies') as placement_strategies, - json_extract_path_text(Properties, 'PlatformVersion') as platform_version, - json_extract_path_text(Properties, 'PropagateTags') as propagate_tags, - json_extract_path_text(Properties, 'Role') as role, - json_extract_path_text(Properties, 'SchedulingStrategy') as scheduling_strategy, + json_extract_path_text(Properties, 'Cluster') as cluster, + json_extract_path_text(Properties, 'LoadBalancers') as load_balancers, json_extract_path_text(Properties, 'ServiceConnectConfiguration') as service_connect_configuration, - json_extract_path_text(Properties, 'ServiceName') as service_name, - json_extract_path_text(Properties, 'ServiceRegistries') as service_registries, - json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DesiredCount') as desired_count, + json_extract_path_text(Properties, 'VpcLatticeConfigurations') as vpc_lattice_configurations, + json_extract_path_text(Properties, 'DeploymentController') as deployment_controller, + json_extract_path_text(Properties, 'Role') as role, json_extract_path_text(Properties, 'TaskDefinition') as task_definition, - json_extract_path_text(Properties, 'VolumeConfigurations') as volume_configurations + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'DeploymentConfiguration') as deployment_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::Service' AND data__Identifier = '|' AND region = 'us-east-1' - task_definitions: - name: task_definitions - id: awscc.ecs.task_definitions - x-cfn-schema-name: TaskDefinition - x-type: list + services_list_only: + name: services_list_only + id: awscc.ecs.services_list_only + x-cfn-schema-name: Service + x-cfn-type-name: AWS::ECS::Service x-identifiers: - - TaskDefinitionArn + - ServiceArn + - Cluster + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1980,130 +3702,626 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TaskDefinitionArn') as task_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' + JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn, + JSON_EXTRACT(Properties, '$.Cluster') as cluster + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'Cluster') as cluster + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' AND region = 'us-east-1' - task_definition: - name: task_definition - id: awscc.ecs.task_definition + task_definitions: + name: task_definitions + id: awscc.ecs.task_definitions x-cfn-schema-name: TaskDefinition - x-type: get + x-cfn-type-name: AWS::ECS::TaskDefinition x-identifiers: - TaskDefinitionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TaskDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::TaskDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::TaskDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::TaskDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.TaskDefinitionArn') as task_definition_arn, - JSON_EXTRACT(Properties, '$.Family') as family, - JSON_EXTRACT(Properties, '$.ContainerDefinitions') as container_definitions, - JSON_EXTRACT(Properties, '$.Cpu') as cpu, - JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, - JSON_EXTRACT(Properties, '$.EphemeralStorage') as ephemeral_storage, + JSON_EXTRACT(Properties, '$.TaskRoleArn') as task_role_arn, + JSON_EXTRACT(Properties, '$.IpcMode') as ipc_mode, JSON_EXTRACT(Properties, '$.InferenceAccelerators') as inference_accelerators, JSON_EXTRACT(Properties, '$.Memory') as memory, - JSON_EXTRACT(Properties, '$.NetworkMode') as network_mode, JSON_EXTRACT(Properties, '$.PlacementConstraints') as placement_constraints, - JSON_EXTRACT(Properties, '$.ProxyConfiguration') as proxy_configuration, + JSON_EXTRACT(Properties, '$.Cpu') as cpu, JSON_EXTRACT(Properties, '$.RequiresCompatibilities') as requires_compatibilities, - JSON_EXTRACT(Properties, '$.TaskRoleArn') as task_role_arn, - JSON_EXTRACT(Properties, '$.Volumes') as volumes, + JSON_EXTRACT(Properties, '$.NetworkMode') as network_mode, JSON_EXTRACT(Properties, '$.PidMode') as pid_mode, + JSON_EXTRACT(Properties, '$.EnableFaultInjection') as enable_fault_injection, + JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, JSON_EXTRACT(Properties, '$.RuntimePlatform') as runtime_platform, - JSON_EXTRACT(Properties, '$.IpcMode') as ipc_mode, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.ProxyConfiguration') as proxy_configuration, + JSON_EXTRACT(Properties, '$.Volumes') as volumes, + JSON_EXTRACT(Properties, '$.ContainerDefinitions') as container_definitions, + JSON_EXTRACT(Properties, '$.Family') as family, + JSON_EXTRACT(Properties, '$.EphemeralStorage') as ephemeral_storage, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TaskDefinitionArn') as task_definition_arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::TaskDefinition' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn, - json_extract_path_text(Properties, 'Family') as family, - json_extract_path_text(Properties, 'ContainerDefinitions') as container_definitions, - json_extract_path_text(Properties, 'Cpu') as cpu, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, + json_extract_path_text(Properties, 'TaskRoleArn') as task_role_arn, + json_extract_path_text(Properties, 'IpcMode') as ipc_mode, json_extract_path_text(Properties, 'InferenceAccelerators') as inference_accelerators, json_extract_path_text(Properties, 'Memory') as memory, - json_extract_path_text(Properties, 'NetworkMode') as network_mode, json_extract_path_text(Properties, 'PlacementConstraints') as placement_constraints, - json_extract_path_text(Properties, 'ProxyConfiguration') as proxy_configuration, + json_extract_path_text(Properties, 'Cpu') as cpu, json_extract_path_text(Properties, 'RequiresCompatibilities') as requires_compatibilities, - json_extract_path_text(Properties, 'TaskRoleArn') as task_role_arn, - json_extract_path_text(Properties, 'Volumes') as volumes, + json_extract_path_text(Properties, 'NetworkMode') as network_mode, json_extract_path_text(Properties, 'PidMode') as pid_mode, + json_extract_path_text(Properties, 'EnableFaultInjection') as enable_fault_injection, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, json_extract_path_text(Properties, 'RuntimePlatform') as runtime_platform, - json_extract_path_text(Properties, 'IpcMode') as ipc_mode, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'ProxyConfiguration') as proxy_configuration, + json_extract_path_text(Properties, 'Volumes') as volumes, + json_extract_path_text(Properties, 'ContainerDefinitions') as container_definitions, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::TaskDefinition' AND data__Identifier = '' AND region = 'us-east-1' - task_set: - name: task_set - id: awscc.ecs.task_set + task_definitions_list_only: + name: task_definitions_list_only + id: awscc.ecs.task_definitions_list_only + x-cfn-schema-name: TaskDefinition + x-cfn-type-name: AWS::ECS::TaskDefinition + x-identifiers: + - TaskDefinitionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TaskDefinitionArn') as task_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' + AND region = 'us-east-1' + task_sets: + name: task_sets + id: awscc.ecs.task_sets x-cfn-schema-name: TaskSet - x-type: get + x-cfn-type-name: AWS::ECS::TaskSet x-identifiers: - Cluster - Service - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TaskSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::TaskSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::TaskSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::TaskSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/task_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Cluster') as cluster, + JSON_EXTRACT(Properties, '$.PlatformVersion') as platform_version, JSON_EXTRACT(Properties, '$.ExternalId') as external_id, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.LaunchType') as launch_type, + JSON_EXTRACT(Properties, '$.Cluster') as cluster, JSON_EXTRACT(Properties, '$.LoadBalancers') as load_balancers, - JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, - JSON_EXTRACT(Properties, '$.PlatformVersion') as platform_version, - JSON_EXTRACT(Properties, '$.Scale') as scale, JSON_EXTRACT(Properties, '$.Service') as service, + JSON_EXTRACT(Properties, '$.Scale') as scale, JSON_EXTRACT(Properties, '$.ServiceRegistries') as service_registries, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TaskDefinition') as task_definition + JSON_EXTRACT(Properties, '$.CapacityProviderStrategy') as capacity_provider_strategy, + JSON_EXTRACT(Properties, '$.LaunchType') as launch_type, + JSON_EXTRACT(Properties, '$.TaskDefinition') as task_definition, + JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::TaskSet' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Cluster') as cluster, + json_extract_path_text(Properties, 'PlatformVersion') as platform_version, json_extract_path_text(Properties, 'ExternalId') as external_id, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LaunchType') as launch_type, + json_extract_path_text(Properties, 'Cluster') as cluster, json_extract_path_text(Properties, 'LoadBalancers') as load_balancers, - json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, - json_extract_path_text(Properties, 'PlatformVersion') as platform_version, - json_extract_path_text(Properties, 'Scale') as scale, json_extract_path_text(Properties, 'Service') as service, + json_extract_path_text(Properties, 'Scale') as scale, json_extract_path_text(Properties, 'ServiceRegistries') as service_registries, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TaskDefinition') as task_definition + json_extract_path_text(Properties, 'CapacityProviderStrategy') as capacity_provider_strategy, + json_extract_path_text(Properties, 'LaunchType') as launch_type, + json_extract_path_text(Properties, 'TaskDefinition') as task_definition, + json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::TaskSet' AND data__Identifier = '||' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ClusterCapacityProviderAssociations&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateClusterCapacityProviderAssociations + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterCapacityProviderAssociationsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PrimaryTaskSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrimaryTaskSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePrimaryTaskSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateService + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TaskDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTaskDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTaskDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TaskSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTaskSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTaskSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/efs.yaml b/providers/src/awscc/v00.00.00000/services/efs.yaml index b2d39ddf..b493b88f 100644 --- a/providers/src/awscc/v00.00.00000/services/efs.yaml +++ b/providers/src/awscc/v00.00.00000/services/efs.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EFS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AccessPointTag: type: object @@ -109,7 +489,12 @@ components: required: - FileSystemId x-stackql-resource-name: access_point - x-stackql-primaryIdentifier: + description: >- + The ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access + data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html). + This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action. + x-type-name: AWS::EFS::AccessPoint + x-stackql-primary-identifier: - AccessPointId x-create-only-properties: - FileSystemId @@ -128,6 +513,18 @@ components: x-read-only-properties: - AccessPointId - Arn + x-required-properties: + - FileSystemId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/AccessPointTags + permissions: + - elasticfilesystem:TagResource + - elasticfilesystem:ListTagsForResource + - elasticfilesystem:UntagResource x-required-permissions: create: - elasticfilesystem:CreateAccessPoint @@ -176,18 +573,21 @@ components: description: The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events. description: |- Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html). - + Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``. - + See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page. + + Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``. + + See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page. BackupPolicy: type: object additionalProperties: false properties: Status: type: string + enum: + - DISABLED + - ENABLED description: |- Set the backup policy status for the file system. - + *ENABLED* - Turns automatic backups on for the file system. - + *DISABLED* - Turns automatic backups off for the file system. + + *ENABLED* - Turns automatic backups on for the file system. + + *DISABLED* - Turns automatic backups off for the file system. required: - Status description: The backup policy turns automatic backups for the file system on or off. @@ -202,9 +602,9 @@ components: - ENABLED description: |- The status of the file system's replication overwrite protection. - + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. - + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. - + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. + + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable. description: Describes the protection on the file system. @@ -212,7 +612,14 @@ components: type: object additionalProperties: false properties: + Status: + type: string + description: Describes the status of the replication configuration. For more information about replication status, see [Viewing replication details](https://docs.aws.amazon.com//efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*. + StatusMessage: + type: string + description: Message that provides details about the ``PAUSED`` or ``ERRROR`` state of the replication destination configuration. For more information about replication status messages, see [Viewing replication details](https://docs.aws.amazon.com//efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*. FileSystemId: + pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$ type: string description: The ID of the destination Amazon EFS file system. Region: @@ -220,10 +627,13 @@ components: description: |- The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located. + RoleArn: + type: string + description: The Amazon Resource Name (ARN) of the current source file system in the replication configuration. AvailabilityZoneName: type: string description: |- - The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. + For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*. One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available. KmsKeyId: @@ -279,17 +689,17 @@ components: description: |- An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + When to move files in the file system from primary storage to IA storage. - + When to move files in the file system from primary storage or IA storage to Archive storage. - + When to move files that are in IA or Archive storage to primary storage. + + When to move files in the file system from primary storage or IA storage to Archive storage. + + When to move files that are in IA or Archive storage to primary storage. - EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information. + EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive````TransitionToPrimaryStorageClass``. See the example requests in the following section for more information. FileSystemProtection: $ref: '#/components/schemas/FileSystemProtection' description: Describes the protection on the file system. PerformanceMode: type: string description: |- - The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. + The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is ``generalPurpose``. ProvisionedThroughputInMibps: @@ -321,16 +731,35 @@ components: $ref: '#/components/schemas/ReplicationConfiguration' description: Describes the replication configuration for a specific file system. x-stackql-resource-name: file_system - x-stackql-primaryIdentifier: + description: The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource. + x-type-name: AWS::EFS::FileSystem + x-stackql-primary-identifier: - FileSystemId x-create-only-properties: - AvailabilityZoneName - Encrypted - KmsKeyId - PerformanceMode + x-write-only-properties: + - BypassPolicyLockoutSafetyCheck + - ReplicationConfiguration/Destinations/0/AvailabilityZoneName + - ReplicationConfiguration/Destinations/0/KmsKeyId x-read-only-properties: - Arn - FileSystemId + - ReplicationConfiguration/Destinations/*/Status + - ReplicationConfiguration/Destinations/*/StatusMessage + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/FileSystemTags + permissions: + - elasticfilesystem:TagResource + - elasticfilesystem:ListTagsForResource + - elasticfilesystem:UntagResource + - elasticfilesystem:DeleteTags x-required-permissions: create: - elasticfilesystem:CreateFileSystem @@ -345,6 +774,8 @@ components: - kms:DescribeKey - kms:GenerateDataKeyWithoutPlaintext - kms:CreateGrant + - iam:PassRole + - iam:CreateServiceLinkedRole read: - elasticfilesystem:DescribeBackupPolicy - elasticfilesystem:DescribeFileSystemPolicy @@ -372,6 +803,8 @@ components: - kms:DescribeKey - kms:GenerateDataKeyWithoutPlaintext - kms:CreateGrant + - iam:PassRole + - iam:CreateServiceLinkedRole delete: - elasticfilesystem:DescribeFileSystems - elasticfilesystem:DeleteFileSystem @@ -391,7 +824,19 @@ components: description: '' IpAddress: type: string - description: Valid IPv4 address within the address range of the specified subnet. + description: If the ``IpAddressType`` for the mount target is IPv4 ( ``IPV4_ONLY`` or ``DUAL_STACK``), then specify the IPv4 address to use. If you do not specify an ``IpAddress``, then Amazon EFS selects an unused IP address from the subnet specified for ``SubnetId``. + Ipv6Address: + type: string + description: If the ``IPAddressType`` for the mount target is IPv6 (``IPV6_ONLY`` or ``DUAL_STACK``), then specify the IPv6 address to use. If you do not specify an ``Ipv6Address``, then Amazon EFS selects an unused IP address from the subnet specified for ``SubnetId``. + IpAddressType: + type: string + enum: + - IPV4_ONLY + - IPV6_ONLY + - DUAL_STACK + description: |- + The IP address type for the mount target. The possible values are ``IPV4_ONLY`` (only IPv4 addresses), ``IPV6_ONLY`` (only IPv6 addresses), and ``DUAL_STACK`` (dual-stack, both IPv4 and IPv6 addresses). If you don’t specify an ``IpAddressType``, then ``IPV4_ONLY`` is used. + The ``IPAddressType`` must match the IP type of the subnet. Additionally, the ``IPAddressType`` parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the ``IPAddressType`` is ``IPV4_ONLY`` and ``AssignIpv6AddressOnCreation`` is ``true``, then IPv4 is used for the mount target. For more information, see [Modify the IP addressing attributes of your subnet](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html). FileSystemId: type: string description: The ID of the file system for which to create the mount target. @@ -401,23 +846,35 @@ components: uniqueItems: true items: type: string - description: Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified. + description: VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see [Amazon VPC Quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) in the *Amazon VPC User Guide* (see the *Security Groups* table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. SubnetId: type: string - description: The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. + description: The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the ``IpAddressType``. required: - FileSystemId - SecurityGroups - SubnetId x-stackql-resource-name: mount_target - x-stackql-primaryIdentifier: + description: The ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target. + x-type-name: AWS::EFS::MountTarget + x-stackql-primary-identifier: - Id x-create-only-properties: - IpAddress + - Ipv6Address + - IpAddressType - SubnetId - FileSystemId + x-write-only-properties: + - IpAddressType x-read-only-properties: - Id + x-required-properties: + - FileSystemId + - SecurityGroups + - SubnetId + x-tagging: + taggable: false x-required-permissions: create: - elasticfilesystem:CreateMountTarget @@ -435,43 +892,256 @@ components: list: - elasticfilesystem:DescribeMountTargets - elasticfilesystem:DescribeMountTargetSecurityGroups + CreateAccessPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessPointId: + type: string + description: '' + Arn: + type: string + description: '' + ClientToken: + description: The opaque string specified in the request to ensure idempotent creation. + type: string + AccessPointTags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/AccessPointTag' + description: |- + An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + FileSystemId: + description: The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``. + type: string + PosixUser: + description: The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point. + $ref: '#/components/schemas/PosixUser' + RootDirectory: + description: The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point. + $ref: '#/components/schemas/RootDirectory' + x-stackQL-stringOnly: true + x-title: CreateAccessPointRequest + type: object + required: [] + CreateFileSystemRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FileSystemId: + type: string + description: '' + Arn: + $ref: '#/components/schemas/Arn' + description: '' + Encrypted: + type: boolean + description: A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system. + FileSystemTags: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ElasticFileSystemTag' + description: Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*. + KmsKeyId: + type: string + description: |- + The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. + + If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true. + LifecyclePolicies: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/LifecyclePolicy' + description: |- + An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + + When to move files in the file system from primary storage to IA storage. + + When to move files in the file system from primary storage or IA storage to Archive storage. + + When to move files that are in IA or Archive storage to primary storage. + + EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive````TransitionToPrimaryStorageClass``. See the example requests in the following section for more information. + FileSystemProtection: + $ref: '#/components/schemas/FileSystemProtection' + description: Describes the protection on the file system. + PerformanceMode: + type: string + description: |- + The performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. + Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. + Default is ``generalPurpose``. + ProvisionedThroughputInMibps: + type: number + description: The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*. + ThroughputMode: + type: string + description: >- + Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned + mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. + Default is ``bursting``. + FileSystemPolicy: + type: object + description: The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*. + BypassPolicyLockoutSafetyCheck: + description: >- + (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent + ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``. + type: boolean + BackupPolicy: + $ref: '#/components/schemas/BackupPolicy' + description: Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. + AvailabilityZoneName: + type: string + description: |- + For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. + One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available. + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + description: Describes the replication configuration for a specific file system. + x-stackQL-stringOnly: true + x-title: CreateFileSystemRequest + type: object + required: [] + CreateMountTargetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: '' + IpAddress: + type: string + description: If the ``IpAddressType`` for the mount target is IPv4 ( ``IPV4_ONLY`` or ``DUAL_STACK``), then specify the IPv4 address to use. If you do not specify an ``IpAddress``, then Amazon EFS selects an unused IP address from the subnet specified for ``SubnetId``. + Ipv6Address: + type: string + description: If the ``IPAddressType`` for the mount target is IPv6 (``IPV6_ONLY`` or ``DUAL_STACK``), then specify the IPv6 address to use. If you do not specify an ``Ipv6Address``, then Amazon EFS selects an unused IP address from the subnet specified for ``SubnetId``. + IpAddressType: + type: string + enum: + - IPV4_ONLY + - IPV6_ONLY + - DUAL_STACK + description: |- + The IP address type for the mount target. The possible values are ``IPV4_ONLY`` (only IPv4 addresses), ``IPV6_ONLY`` (only IPv6 addresses), and ``DUAL_STACK`` (dual-stack, both IPv4 and IPv6 addresses). If you don’t specify an ``IpAddressType``, then ``IPV4_ONLY`` is used. + The ``IPAddressType`` must match the IP type of the subnet. Additionally, the ``IPAddressType`` parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the ``IPAddressType`` is ``IPV4_ONLY`` and ``AssignIpv6AddressOnCreation`` is ``true``, then IPv4 is used for the mount target. For more information, see [Modify the IP addressing attributes of your subnet](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html). + FileSystemId: + type: string + description: The ID of the file system for which to create the mount target. + SecurityGroups: + type: array + x-insertionOrder: false + uniqueItems: true + items: + type: string + description: VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see [Amazon VPC Quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) in the *Amazon VPC User Guide* (see the *Security Groups* table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. + SubnetId: + type: string + description: The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the ``IpAddressType``. + x-stackQL-stringOnly: true + x-title: CreateMountTargetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_points: name: access_points id: awscc.efs.access_points x-cfn-schema-name: AccessPoint - x-type: list - x-identifiers: - - AccessPointId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessPointId') as access_point_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessPointId') as access_point_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: awscc.efs.access_point - x-cfn-schema-name: AccessPoint - x-type: get + x-cfn-type-name: AWS::EFS::AccessPoint x-identifiers: - AccessPointId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -487,7 +1157,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -502,13 +1172,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::AccessPoint' AND data__Identifier = '' AND region = 'us-east-1' - file_systems: - name: file_systems - id: awscc.efs.file_systems - x-cfn-schema-name: FileSystem - x-type: list + access_points_list_only: + name: access_points_list_only + id: awscc.efs.access_points_list_only + x-cfn-schema-name: AccessPoint + x-cfn-type-name: AWS::EFS::AccessPoint x-identifiers: - - FileSystemId + - AccessPointId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -516,28 +1192,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FileSystemId') as file_system_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' + JSON_EXTRACT(Properties, '$.AccessPointId') as access_point_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FileSystemId') as file_system_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' + json_extract_path_text(Properties, 'AccessPointId') as access_point_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' AND region = 'us-east-1' - file_system: - name: file_system - id: awscc.efs.file_system + file_systems: + name: file_systems + id: awscc.efs.file_systems x-cfn-schema-name: FileSystem - x-type: get + x-cfn-type-name: AWS::EFS::FileSystem x-identifiers: - FileSystemId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FileSystem&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::FileSystem" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::FileSystem" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::FileSystem" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/file_systems/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/file_systems/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/file_systems/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -561,7 +1285,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -584,13 +1308,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::FileSystem' AND data__Identifier = '' AND region = 'us-east-1' - mount_targets: - name: mount_targets - id: awscc.efs.mount_targets - x-cfn-schema-name: MountTarget - x-type: list + file_systems_list_only: + name: file_systems_list_only + id: awscc.efs.file_systems_list_only + x-cfn-schema-name: FileSystem + x-cfn-type-name: AWS::EFS::FileSystem x-identifiers: - - Id + - FileSystemId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -598,34 +1328,84 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' + JSON_EXTRACT(Properties, '$.FileSystemId') as file_system_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' + json_extract_path_text(Properties, 'FileSystemId') as file_system_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' AND region = 'us-east-1' - mount_target: - name: mount_target - id: awscc.efs.mount_target + mount_targets: + name: mount_targets + id: awscc.efs.mount_targets x-cfn-schema-name: MountTarget - x-type: get + x-cfn-type-name: AWS::EFS::MountTarget x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MountTarget&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::MountTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::MountTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EFS::MountTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mount_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mount_targets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mount_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.IpAddress') as ip_address, + JSON_EXTRACT(Properties, '$.Ipv6Address') as ipv6_address, + JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type, JSON_EXTRACT(Properties, '$.FileSystemId') as file_system_id, JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id @@ -633,16 +1413,328 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'IpAddress') as ip_address, + json_extract_path_text(Properties, 'Ipv6Address') as ipv6_address, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, json_extract_path_text(Properties, 'FileSystemId') as file_system_id, json_extract_path_text(Properties, 'SecurityGroups') as security_groups, json_extract_path_text(Properties, 'SubnetId') as subnet_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::MountTarget' AND data__Identifier = '' AND region = 'us-east-1' + mount_targets_list_only: + name: mount_targets_list_only + id: awscc.efs.mount_targets_list_only + x-cfn-schema-name: MountTarget + x-cfn-type-name: AWS::EFS::MountTarget + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FileSystem&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFileSystem + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFileSystemRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MountTarget&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMountTarget + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMountTargetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/eks.yaml b/providers/src/awscc/v00.00.00000/services/eks.yaml index 14c3aea9..10a97491 100644 --- a/providers/src/awscc/v00.00.00000/services/eks.yaml +++ b/providers/src/awscc/v00.00.00000/services/eks.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EKS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -102,7 +482,9 @@ components: - PrincipalArn - ClusterName x-stackql-resource-name: access_entry - x-stackql-primaryIdentifier: + description: An object representing an Amazon EKS AccessEntry. + x-type-name: AWS::EKS::AccessEntry + x-stackql-primary-identifier: - PrincipalArn - ClusterName x-create-only-properties: @@ -111,6 +493,19 @@ components: - Type x-read-only-properties: - AccessEntryArn + x-required-properties: + - PrincipalArn + - ClusterName + x-replacement-strategy: create_then_delete + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource x-required-permissions: create: - eks:CreateAccessEntry @@ -134,6 +529,102 @@ components: - eks:DescribeAccessEntry list: - eks:ListAccessEntries + PodIdentityAssociation: + type: object + properties: + ClusterName: + description: The cluster that the pod identity association is created for. + type: string + minLength: 1 + RoleArn: + description: The IAM role ARN that the pod identity association is created for. + type: string + Namespace: + description: The Kubernetes namespace that the pod identity association is created for. + type: string + ServiceAccount: + description: The Kubernetes service account that the pod identity association is created for. + type: string + AssociationArn: + description: The ARN of the pod identity association. + type: string + AssociationId: + description: The ID of the pod identity association. + type: string + minLength: 1 + TargetRoleArn: + description: The Target Role Arn of the pod identity association. + type: string + minLength: 1 + ExternalId: + description: The External Id of the pod identity association. + type: string + minLength: 1 + DisableSessionTags: + description: The Disable Session Tags of the pod identity association. + type: boolean + minLength: 1 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - ClusterName + - RoleArn + - Namespace + - ServiceAccount + x-stackql-resource-name: pod_identity_association + description: An object representing an Amazon EKS PodIdentityAssociation. + x-type-name: AWS::EKS::PodIdentityAssociation + x-stackql-primary-identifier: + - AssociationArn + x-create-only-properties: + - ClusterName + - Namespace + - ServiceAccount + x-read-only-properties: + - AssociationArn + - AssociationId + - ExternalId + x-required-properties: + - ClusterName + - RoleArn + - Namespace + - ServiceAccount + x-replacement-strategy: create_then_delete + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource + x-required-permissions: + create: + - eks:CreatePodIdentityAssociation + - eks:DescribePodIdentityAssociation + - eks:TagResource + - iam:PassRole + - iam:GetRole + read: + - eks:DescribePodIdentityAssociation + update: + - eks:DescribePodIdentityAssociation + - eks:UpdatePodIdentityAssociation + - eks:TagResource + - eks:UntagResource + - iam:PassRole + - iam:GetRole + delete: + - eks:DeletePodIdentityAssociation + - eks:DescribePodIdentityAssociation + list: + - eks:ListPodIdentityAssociations Addon: type: object properties: @@ -164,6 +655,13 @@ components: description: IAM role to bind to the add-on's service account type: string minLength: 1 + PodIdentityAssociations: + description: An array of pod identities to apply to this add-on. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PodIdentityAssociation' ConfigurationValues: description: The configuration values to use with the add-on type: string @@ -171,6 +669,16 @@ components: Arn: description: Amazon Resource Name (ARN) of the add-on type: string + NamespaceConfig: + description: The custom namespace configuration to use with the add-on + type: object + additionalProperties: false + properties: + Namespace: + type: string + description: The custom namespace for creating the add-on + required: + - Namespace Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -182,35 +690,60 @@ components: - ClusterName - AddonName x-stackql-resource-name: addon - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::EKS::Addon + x-type-name: AWS::EKS::Addon + x-stackql-primary-identifier: - ClusterName - AddonName x-create-only-properties: - ClusterName - AddonName + - NamespaceConfig + x-write-only-properties: + - ResolveConflicts + - PreserveOnDelete + - PodIdentityAssociations x-read-only-properties: - Arn + x-required-properties: + - ClusterName + - AddonName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource x-required-permissions: create: - eks:CreateAddon - eks:DescribeAddon - eks:TagResource - iam:PassRole + - iam:GetRole + - eks:CreatePodIdentityAssociation read: - eks:DescribeAddon delete: - eks:DeleteAddon - eks:DescribeAddon + - eks:DeletePodIdentityAssociation list: - eks:ListAddons update: - iam:PassRole + - iam:GetRole - eks:UpdateAddon - eks:DescribeAddon - eks:DescribeUpdate - - eks:ListTagsForResource - eks:TagResource - eks:UntagResource + - eks:CreatePodIdentityAssociation + - eks:DeletePodIdentityAssociation + - eks:UpdatePodIdentityAssociation Provider: type: object additionalProperties: false @@ -303,6 +836,100 @@ components: ClusterLogging: description: 'The cluster control plane logging configuration for your cluster. ' $ref: '#/components/schemas/ClusterLogging' + RemoteNodeNetwork: + description: Network configuration of nodes run on-premises with EKS Hybrid Nodes. + type: object + properties: + Cidrs: + description: Specifies the list of remote node CIDRs. + type: array + x-insertionOrder: false + items: + type: string + minItems: 1 + additionalProperties: false + required: + - Cidrs + RemoteNodeNetworks: + description: Network configuration of nodes run on-premises with EKS Hybrid Nodes. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/RemoteNodeNetwork' + RemotePodNetwork: + description: Network configuration of pods run on-premises with EKS Hybrid Nodes. + type: object + properties: + Cidrs: + description: Specifies the list of remote pod CIDRs. + type: array + x-insertionOrder: false + items: + type: string + minItems: 1 + additionalProperties: false + required: + - Cidrs + RemotePodNetworks: + description: Network configuration of pods run on-premises with EKS Hybrid Nodes. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/RemotePodNetwork' + RemoteNetworkConfig: + description: Configuration fields for specifying on-premises node and pod CIDRs that are external to the VPC passed during cluster creation. + additionalProperties: false + type: object + properties: + RemoteNodeNetworks: + description: Network configuration of nodes run on-premises with EKS Hybrid Nodes. + $ref: '#/components/schemas/RemoteNodeNetworks' + RemotePodNetworks: + description: Network configuration of pods run on-premises with EKS Hybrid Nodes. + $ref: '#/components/schemas/RemotePodNetworks' + required: + - RemoteNodeNetworks + ComputeConfig: + description: 'Todo: add description' + additionalProperties: false + type: object + properties: + Enabled: + description: 'Todo: add description' + type: boolean + NodeRoleArn: + description: 'Todo: add description' + type: string + NodePools: + description: 'Todo: add description' + type: array + x-insertionOrder: false + items: + type: string + BlockStorage: + description: 'Todo: add description' + additionalProperties: false + type: object + properties: + Enabled: + description: 'Todo: add description' + type: boolean + StorageConfig: + description: 'Todo: add description' + additionalProperties: false + type: object + properties: + BlockStorage: + description: 'Todo: add description' + $ref: '#/components/schemas/BlockStorage' + ElasticLoadBalancing: + description: 'Todo: add description' + additionalProperties: false + type: object + properties: + Enabled: + description: 'Todo: add description' + type: boolean KubernetesNetworkConfig: description: The Kubernetes network configuration for the cluster. additionalProperties: false @@ -320,6 +947,9 @@ components: enum: - ipv4 - ipv6 + ElasticLoadBalancing: + description: 'Todo: add description' + $ref: '#/components/schemas/ElasticLoadBalancing' ControlPlanePlacement: description: Specify the placement group of the control plane machines for your cluster. type: object @@ -364,6 +994,28 @@ components: - CONFIG_MAP - API_AND_CONFIG_MAP - API + UpgradePolicy: + description: An object representing the Upgrade Policy to use for the cluster. + additionalProperties: false + type: object + properties: + SupportType: + description: Specify the support type for your cluster. + type: string + enum: + - STANDARD + - EXTENDED + ZonalShiftConfig: + description: The current zonal shift configuration to use for the cluster. + additionalProperties: false + type: object + properties: + Enabled: + description: Set this value to true to enable zonal shift for the cluster. + type: boolean + DeletionProtection: + description: Set this value to true to enable deletion protection for the cluster. + type: boolean Cluster: type: object properties: @@ -392,6 +1044,14 @@ components: $ref: '#/components/schemas/OutpostConfig' AccessConfig: $ref: '#/components/schemas/AccessConfig' + UpgradePolicy: + $ref: '#/components/schemas/UpgradePolicy' + RemoteNetworkConfig: + $ref: '#/components/schemas/RemoteNetworkConfig' + ComputeConfig: + $ref: '#/components/schemas/ComputeConfig' + StorageConfig: + $ref: '#/components/schemas/StorageConfig' RoleArn: description: The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. type: string @@ -399,6 +1059,10 @@ components: description: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. type: string pattern: 1\.\d\d + Force: + description: Force cluster version update + type: boolean + default: false Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -424,19 +1088,35 @@ components: OpenIdConnectIssuerUrl: description: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template. type: string + BootstrapSelfManagedAddons: + description: Set this value to false to avoid creating the default networking add-ons when the cluster is created. + type: boolean + DeletionProtection: + description: Set this value to true to enable deletion protection for the cluster. + type: boolean + ZonalShiftConfig: + $ref: '#/components/schemas/ZonalShiftConfig' required: - RoleArn - ResourcesVpcConfig x-stackql-resource-name: cluster - x-stackql-primaryIdentifier: + description: An object representing an Amazon EKS cluster. + x-type-name: AWS::EKS::Cluster + x-stackql-primary-identifier: - Name x-create-only-properties: - OutpostConfig - EncryptionConfig - - KubernetesNetworkConfig + - KubernetesNetworkConfig/IpFamily + - KubernetesNetworkConfig/ServiceIpv4Cidr - AccessConfig/BootstrapClusterCreatorAdminPermissions - Name - RoleArn + - BootstrapSelfManagedAddons + x-write-only-properties: + - AccessConfig/BootstrapClusterCreatorAdminPermissions + - BootstrapSelfManagedAddons + - Force x-read-only-properties: - Id - Arn @@ -446,11 +1126,24 @@ components: - EncryptionConfigKeyArn - OpenIdConnectIssuerUrl - KubernetesNetworkConfig/ServiceIpv6Cidr + x-required-properties: + - RoleArn + - ResourcesVpcConfig + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource x-required-permissions: create: - eks:CreateCluster - eks:DescribeCluster - eks:TagResource + - eks:CreateAccessEntry - iam:PassRole - iam:GetRole - iam:ListAttachedRolePolicies @@ -548,7 +1241,9 @@ components: - PodExecutionRoleArn - Selectors x-stackql-resource-name: fargate_profile - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::EKS::FargateProfile + x-type-name: AWS::EKS::FargateProfile + x-stackql-primary-identifier: - ClusterName - FargateProfileName x-create-only-properties: @@ -559,6 +1254,19 @@ components: - Selectors x-read-only-properties: - Arn + x-required-properties: + - ClusterName + - PodExecutionRoleArn + - Selectors + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource x-required-permissions: create: - eks:CreateFargateProfile @@ -576,7 +1284,6 @@ components: - eks:ListFargateProfiles update: - eks:DescribeFargateProfile - - eks:ListTagsForResource - eks:TagResource - eks:UntagResource RequiredClaim: @@ -659,7 +1366,9 @@ components: - Type - ClusterName x-stackql-resource-name: identity_provider_config - x-stackql-primaryIdentifier: + description: An object representing an Amazon EKS IdentityProviderConfig. + x-type-name: AWS::EKS::IdentityProviderConfig + x-stackql-primary-identifier: - IdentityProviderConfigName - ClusterName - Type @@ -670,6 +1379,19 @@ components: - ClusterName x-read-only-properties: - IdentityProviderConfigArn + x-required-properties: + - Type + - ClusterName + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource x-required-permissions: create: - eks:DescribeUpdate @@ -758,6 +1480,17 @@ components: type: number minimum: 1 maximum: 100 + UpdateStrategy: + description: The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action. + type: string + NodeRepairConfig: + description: The node auto repair configuration for node group. + type: object + additionalProperties: false + properties: + Enabled: + description: Set this value to true to enable node auto repair for the node group. + type: boolean Nodegroup: type: object properties: @@ -834,6 +1567,9 @@ components: UpdateConfig: description: The node group update configuration. $ref: '#/components/schemas/UpdateConfig' + NodeRepairConfig: + description: The node auto repair configuration for node group. + $ref: '#/components/schemas/NodeRepairConfig' Version: description: The Kubernetes version to use for your managed nodes. type: string @@ -846,7 +1582,9 @@ components: - NodeRole - Subnets x-stackql-resource-name: nodegroup - x-stackql-primaryIdentifier: + description: Resource schema for AWS::EKS::Nodegroup + x-type-name: AWS::EKS::Nodegroup + x-stackql-primary-identifier: - Id x-create-only-properties: - CapacityType @@ -858,9 +1596,24 @@ components: - DiskSize - AmiType - Subnets + x-write-only-properties: + - ForceUpdateEnabled x-read-only-properties: - Id - Arn + x-required-properties: + - ClusterName + - NodeRole + - Subnets + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - eks:TagResource + - eks:UntagResource x-required-permissions: create: - eks:CreateNodegroup @@ -897,81 +1650,589 @@ components: - eks:UntagResource - eks:UpdateNodegroupConfig - eks:UpdateNodegroupVersion - PodIdentityAssociation: - type: object + - ec2:DescribeLaunchTemplateVersions + - ec2:RunInstances + CreateAccessEntryRequest: properties: - ClusterName: - description: The cluster that the pod identity association is created for. + ClientToken: type: string - minLength: 1 RoleArn: - description: The IAM role ARN that the pod identity association is created for. type: string - Namespace: - description: The Kubernetes namespace that the pod identity association is created for. + TypeName: type: string - ServiceAccount: - description: The Kubernetes service account that the pod identity association is created for. + TypeVersionId: type: string - AssociationArn: - description: The ARN of the pod identity association. + DesiredState: + type: object + properties: + ClusterName: + description: The cluster that the access entry is created for. + type: string + minLength: 1 + PrincipalArn: + description: The principal ARN that the access entry is created for. + type: string + minLength: 1 + Username: + description: The Kubernetes user that the access entry is associated with. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AccessEntryArn: + description: The ARN of the access entry. + type: string + KubernetesGroups: + description: The Kubernetes groups that the access entry is associated with. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + AccessPolicies: + description: An array of access policies that are associated with the access entry. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/AccessPolicy' + maxItems: 20 + Type: + description: The node type to associate with the access entry. + type: string + x-stackQL-stringOnly: true + x-title: CreateAccessEntryRequest + type: object + required: [] + CreatePodIdentityAssociationRequest: + properties: + ClientToken: type: string - AssociationId: - description: The ID of the pod identity association. + RoleArn: type: string - minLength: 1 - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - required: - - ClusterName - - RoleArn - - Namespace - - ServiceAccount - x-stackql-resource-name: pod_identity_association - x-stackql-primaryIdentifier: - - AssociationArn - x-create-only-properties: - - ClusterName - - Namespace - - ServiceAccount - x-read-only-properties: - - AssociationArn - - AssociationId - x-required-permissions: - create: - - eks:CreatePodIdentityAssociation - - eks:DescribePodIdentityAssociation - - eks:TagResource - - iam:PassRole - - iam:GetRole - read: - - eks:DescribePodIdentityAssociation - update: - - eks:DescribePodIdentityAssociation - - eks:UpdatePodIdentityAssociation - - eks:TagResource - - eks:UntagResource - - iam:PassRole - - iam:GetRole - delete: - - eks:DeletePodIdentityAssociation - - eks:DescribePodIdentityAssociation - list: - - eks:ListPodIdentityAssociations + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + description: The cluster that the pod identity association is created for. + type: string + minLength: 1 + RoleArn: + description: The IAM role ARN that the pod identity association is created for. + type: string + Namespace: + description: The Kubernetes namespace that the pod identity association is created for. + type: string + ServiceAccount: + description: The Kubernetes service account that the pod identity association is created for. + type: string + AssociationArn: + description: The ARN of the pod identity association. + type: string + AssociationId: + description: The ID of the pod identity association. + type: string + minLength: 1 + TargetRoleArn: + description: The Target Role Arn of the pod identity association. + type: string + minLength: 1 + ExternalId: + description: The External Id of the pod identity association. + type: string + minLength: 1 + DisableSessionTags: + description: The Disable Session Tags of the pod identity association. + type: boolean + minLength: 1 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePodIdentityAssociationRequest + type: object + required: [] + CreateAddonRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + description: Name of Cluster + type: string + minLength: 1 + AddonName: + description: Name of Addon + type: string + minLength: 1 + AddonVersion: + description: Version of Addon + type: string + minLength: 1 + PreserveOnDelete: + description: PreserveOnDelete parameter value + type: boolean + ResolveConflicts: + description: Resolve parameter value conflicts + type: string + minLength: 1 + enum: + - NONE + - OVERWRITE + - PRESERVE + ServiceAccountRoleArn: + description: IAM role to bind to the add-on's service account + type: string + minLength: 1 + PodIdentityAssociations: + description: An array of pod identities to apply to this add-on. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PodIdentityAssociation' + ConfigurationValues: + description: The configuration values to use with the add-on + type: string + minLength: 1 + Arn: + description: Amazon Resource Name (ARN) of the add-on + type: string + NamespaceConfig: + description: The custom namespace configuration to use with the add-on + type: object + additionalProperties: false + properties: + Namespace: + type: string + description: The custom namespace for creating the add-on + required: + - Namespace + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAddonRequest + type: object + required: [] + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EncryptionConfig: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EncryptionConfig' + maxItems: 1 + KubernetesNetworkConfig: + $ref: '#/components/schemas/KubernetesNetworkConfig' + Logging: + $ref: '#/components/schemas/Logging' + Name: + description: The unique name to give to your cluster. + type: string + pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]* + minLength: 1 + maxLength: 100 + Id: + description: The unique ID given to your cluster. + type: string + ResourcesVpcConfig: + $ref: '#/components/schemas/ResourcesVpcConfig' + OutpostConfig: + $ref: '#/components/schemas/OutpostConfig' + AccessConfig: + $ref: '#/components/schemas/AccessConfig' + UpgradePolicy: + $ref: '#/components/schemas/UpgradePolicy' + RemoteNetworkConfig: + $ref: '#/components/schemas/RemoteNetworkConfig' + ComputeConfig: + $ref: '#/components/schemas/ComputeConfig' + StorageConfig: + $ref: '#/components/schemas/StorageConfig' + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. + type: string + Version: + description: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. + type: string + pattern: 1\.\d\d + Force: + description: Force cluster version update + type: boolean + default: false + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. + type: string + Endpoint: + description: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com. + type: string + CertificateAuthorityData: + description: The certificate-authority-data for your cluster. + type: string + ClusterSecurityGroupId: + description: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication. + type: string + EncryptionConfigKeyArn: + description: Amazon Resource Name (ARN) or alias of the customer master key (CMK). + type: string + OpenIdConnectIssuerUrl: + description: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template. + type: string + BootstrapSelfManagedAddons: + description: Set this value to false to avoid creating the default networking add-ons when the cluster is created. + type: boolean + DeletionProtection: + description: Set this value to true to enable deletion protection for the cluster. + type: boolean + ZonalShiftConfig: + $ref: '#/components/schemas/ZonalShiftConfig' + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateFargateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + description: Name of the Cluster + type: string + minLength: 1 + FargateProfileName: + description: Name of FargateProfile + type: string + minLength: 1 + PodExecutionRoleArn: + description: The IAM policy arn for pods + type: string + minLength: 1 + Arn: + type: string + Subnets: + type: array + items: + type: string + Selectors: + type: array + items: + $ref: '#/components/schemas/Selector' + minItems: 1 + Tags: + type: array + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFargateProfileRequest + type: object + required: [] + CreateIdentityProviderConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + description: The name of the identity provider configuration. + type: string + Type: + description: The type of the identity provider configuration. + type: string + enum: + - oidc + IdentityProviderConfigName: + description: The name of the OIDC provider configuration. + type: string + Oidc: + $ref: '#/components/schemas/OidcIdentityProviderConfig' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + IdentityProviderConfigArn: + description: The ARN of the configuration. + type: string + x-stackQL-stringOnly: true + x-title: CreateIdentityProviderConfigRequest + type: object + required: [] + CreateNodegroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AmiType: + description: The AMI type for your node group. + type: string + CapacityType: + description: The capacity type of your managed node group. + type: string + ClusterName: + description: Name of the cluster to create the node group in. + type: string + minLength: 1 + DiskSize: + description: The root device disk size (in GiB) for your node group instances. + type: integer + ForceUpdateEnabled: + description: Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. + type: boolean + default: false + InstanceTypes: + description: Specify the instance types for a node group. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Labels: + description: The Kubernetes labels to be applied to the nodes in the node group when they are created. + type: object + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + LaunchTemplate: + description: An object representing a node group's launch template specification. + $ref: '#/components/schemas/LaunchTemplateSpecification' + NodegroupName: + description: The unique name to give your node group. + type: string + minLength: 1 + NodeRole: + description: The Amazon Resource Name (ARN) of the IAM role to associate with your node group. + type: string + ReleaseVersion: + description: The AMI version of the Amazon EKS-optimized AMI to use with your node group. + type: string + RemoteAccess: + description: The remote access (SSH) configuration to use with your node group. + $ref: '#/components/schemas/RemoteAccess' + ScalingConfig: + description: The scaling configuration details for the Auto Scaling group that is created for your node group. + $ref: '#/components/schemas/ScalingConfig' + Subnets: + description: The subnets to use for the Auto Scaling group that is created for your node group. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Tags: + description: The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency. + type: object + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + Taints: + description: The Kubernetes taints to be applied to the nodes in the node group when they are created. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Taint' + UpdateConfig: + description: The node group update configuration. + $ref: '#/components/schemas/UpdateConfig' + NodeRepairConfig: + description: The node auto repair configuration for node group. + $ref: '#/components/schemas/NodeRepairConfig' + Version: + description: The Kubernetes version to use for your managed nodes. + type: string + Id: + type: string + Arn: + type: string + x-stackQL-stringOnly: true + x-title: CreateNodegroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_entries: name: access_entries id: awscc.eks.access_entries x-cfn-schema-name: AccessEntry - x-type: list + x-cfn-type-name: AWS::EKS::AccessEntry x-identifiers: - PrincipalArn - ClusterName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessEntry&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::AccessEntry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::AccessEntry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::AccessEntry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_entries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_entries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_entries/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.PrincipalArn') as principal_arn, + JSON_EXTRACT(Properties, '$.Username') as username, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AccessEntryArn') as access_entry_arn, + JSON_EXTRACT(Properties, '$.KubernetesGroups') as kubernetes_groups, + JSON_EXTRACT(Properties, '$.AccessPolicies') as access_policies, + JSON_EXTRACT(Properties, '$.Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::AccessEntry' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, + json_extract_path_text(Properties, 'Username') as username, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AccessEntryArn') as access_entry_arn, + json_extract_path_text(Properties, 'KubernetesGroups') as kubernetes_groups, + json_extract_path_text(Properties, 'AccessPolicies') as access_policies, + json_extract_path_text(Properties, 'Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::AccessEntry' + AND data__Identifier = '|' + AND region = 'us-east-1' + access_entries_list_only: + name: access_entries_list_only + id: awscc.eks.access_entries_list_only + x-cfn-schema-name: AccessEntry + x-cfn-type-name: AWS::EKS::AccessEntry + x-identifiers: + - PrincipalArn + - ClusterName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -992,58 +2253,114 @@ components: json_extract_path_text(Properties, 'ClusterName') as cluster_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::AccessEntry' AND region = 'us-east-1' - access_entry: - name: access_entry - id: awscc.eks.access_entry - x-cfn-schema-name: AccessEntry - x-type: get + pod_identity_associations: + name: pod_identity_associations + id: awscc.eks.pod_identity_associations + x-cfn-schema-name: PodIdentityAssociation + x-cfn-type-name: AWS::EKS::PodIdentityAssociation x-identifiers: - - PrincipalArn - - ClusterName + - AssociationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PodIdentityAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::PodIdentityAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::PodIdentityAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::PodIdentityAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.PrincipalArn') as principal_arn, - JSON_EXTRACT(Properties, '$.Username') as username, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.AccessEntryArn') as access_entry_arn, - JSON_EXTRACT(Properties, '$.KubernetesGroups') as kubernetes_groups, - JSON_EXTRACT(Properties, '$.AccessPolicies') as access_policies, - JSON_EXTRACT(Properties, '$.Type') as type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::AccessEntry' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Namespace') as namespace, + JSON_EXTRACT(Properties, '$.ServiceAccount') as service_account, + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id, + JSON_EXTRACT(Properties, '$.TargetRoleArn') as target_role_arn, + JSON_EXTRACT(Properties, '$.ExternalId') as external_id, + JSON_EXTRACT(Properties, '$.DisableSessionTags') as disable_session_tags, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, - json_extract_path_text(Properties, 'Username') as username, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AccessEntryArn') as access_entry_arn, - json_extract_path_text(Properties, 'KubernetesGroups') as kubernetes_groups, - json_extract_path_text(Properties, 'AccessPolicies') as access_policies, - json_extract_path_text(Properties, 'Type') as type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::AccessEntry' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'ServiceAccount') as service_account, + json_extract_path_text(Properties, 'AssociationArn') as association_arn, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'TargetRoleArn') as target_role_arn, + json_extract_path_text(Properties, 'ExternalId') as external_id, + json_extract_path_text(Properties, 'DisableSessionTags') as disable_session_tags, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - addons: - name: addons - id: awscc.eks.addons - x-cfn-schema-name: Addon - x-type: list + pod_identity_associations_list_only: + name: pod_identity_associations_list_only + id: awscc.eks.pod_identity_associations_list_only + x-cfn-schema-name: PodIdentityAssociation + x-cfn-type-name: AWS::EKS::PodIdentityAssociation x-identifiers: - - ClusterName - - AddonName + - AssociationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1051,31 +2368,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.AddonName') as addon_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'AddonName') as addon_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' + json_extract_path_text(Properties, 'AssociationArn') as association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' AND region = 'us-east-1' - addon: - name: addon - id: awscc.eks.addon + addons: + name: addons + id: awscc.eks.addons x-cfn-schema-name: Addon - x-type: get + x-cfn-type-name: AWS::EKS::Addon x-identifiers: - ClusterName - AddonName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Addon&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Addon" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Addon" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Addon" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/addons/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/addons/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/addons/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1086,14 +2449,16 @@ components: JSON_EXTRACT(Properties, '$.PreserveOnDelete') as preserve_on_delete, JSON_EXTRACT(Properties, '$.ResolveConflicts') as resolve_conflicts, JSON_EXTRACT(Properties, '$.ServiceAccountRoleArn') as service_account_role_arn, + JSON_EXTRACT(Properties, '$.PodIdentityAssociations') as pod_identity_associations, JSON_EXTRACT(Properties, '$.ConfigurationValues') as configuration_values, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.NamespaceConfig') as namespace_config, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Addon' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1104,19 +2469,28 @@ components: json_extract_path_text(Properties, 'PreserveOnDelete') as preserve_on_delete, json_extract_path_text(Properties, 'ResolveConflicts') as resolve_conflicts, json_extract_path_text(Properties, 'ServiceAccountRoleArn') as service_account_role_arn, + json_extract_path_text(Properties, 'PodIdentityAssociations') as pod_identity_associations, json_extract_path_text(Properties, 'ConfigurationValues') as configuration_values, json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'NamespaceConfig') as namespace_config, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Addon' AND data__Identifier = '|' AND region = 'us-east-1' - clusters: - name: clusters - id: awscc.eks.clusters - x-cfn-schema-name: Cluster - x-type: list + addons_list_only: + name: addons_list_only + id: awscc.eks.addons_list_only + x-cfn-schema-name: Addon + x-cfn-type-name: AWS::EKS::Addon x-identifiers: - - Name + - ClusterName + - AddonName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1124,28 +2498,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.AddonName') as addon_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'AddonName') as addon_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' AND region = 'us-east-1' - cluster: - name: cluster - id: awscc.eks.cluster + clusters: + name: clusters + id: awscc.eks.clusters x-cfn-schema-name: Cluster - x-type: get + x-cfn-type-name: AWS::EKS::Cluster x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1158,20 +2582,28 @@ components: JSON_EXTRACT(Properties, '$.ResourcesVpcConfig') as resources_vpc_config, JSON_EXTRACT(Properties, '$.OutpostConfig') as outpost_config, JSON_EXTRACT(Properties, '$.AccessConfig') as access_config, + JSON_EXTRACT(Properties, '$.UpgradePolicy') as upgrade_policy, + JSON_EXTRACT(Properties, '$.RemoteNetworkConfig') as remote_network_config, + JSON_EXTRACT(Properties, '$.ComputeConfig') as compute_config, + JSON_EXTRACT(Properties, '$.StorageConfig') as storage_config, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Force') as _force, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, JSON_EXTRACT(Properties, '$.CertificateAuthorityData') as certificate_authority_data, JSON_EXTRACT(Properties, '$.ClusterSecurityGroupId') as cluster_security_group_id, JSON_EXTRACT(Properties, '$.EncryptionConfigKeyArn') as encryption_config_key_arn, - JSON_EXTRACT(Properties, '$.OpenIdConnectIssuerUrl') as open_id_connect_issuer_url + JSON_EXTRACT(Properties, '$.OpenIdConnectIssuerUrl') as open_id_connect_issuer_url, + JSON_EXTRACT(Properties, '$.BootstrapSelfManagedAddons') as bootstrap_self_managed_addons, + JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, + JSON_EXTRACT(Properties, '$.ZonalShiftConfig') as zonal_shift_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Cluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1184,26 +2616,39 @@ components: json_extract_path_text(Properties, 'ResourcesVpcConfig') as resources_vpc_config, json_extract_path_text(Properties, 'OutpostConfig') as outpost_config, json_extract_path_text(Properties, 'AccessConfig') as access_config, + json_extract_path_text(Properties, 'UpgradePolicy') as upgrade_policy, + json_extract_path_text(Properties, 'RemoteNetworkConfig') as remote_network_config, + json_extract_path_text(Properties, 'ComputeConfig') as compute_config, + json_extract_path_text(Properties, 'StorageConfig') as storage_config, json_extract_path_text(Properties, 'RoleArn') as role_arn, json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Force') as _force, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Endpoint') as endpoint, json_extract_path_text(Properties, 'CertificateAuthorityData') as certificate_authority_data, json_extract_path_text(Properties, 'ClusterSecurityGroupId') as cluster_security_group_id, json_extract_path_text(Properties, 'EncryptionConfigKeyArn') as encryption_config_key_arn, - json_extract_path_text(Properties, 'OpenIdConnectIssuerUrl') as open_id_connect_issuer_url + json_extract_path_text(Properties, 'OpenIdConnectIssuerUrl') as open_id_connect_issuer_url, + json_extract_path_text(Properties, 'BootstrapSelfManagedAddons') as bootstrap_self_managed_addons, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'ZonalShiftConfig') as zonal_shift_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Cluster' AND data__Identifier = '' AND region = 'us-east-1' - fargate_profiles: - name: fargate_profiles - id: awscc.eks.fargate_profiles - x-cfn-schema-name: FargateProfile - x-type: list + clusters_list_only: + name: clusters_list_only + id: awscc.eks.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::EKS::Cluster x-identifiers: - - ClusterName - - FargateProfileName + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1211,31 +2656,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.FargateProfileName') as fargate_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'FargateProfileName') as fargate_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' AND region = 'us-east-1' - fargate_profile: - name: fargate_profile - id: awscc.eks.fargate_profile + fargate_profiles: + name: fargate_profiles + id: awscc.eks.fargate_profiles x-cfn-schema-name: FargateProfile - x-type: get + x-cfn-type-name: AWS::EKS::FargateProfile x-identifiers: - ClusterName - FargateProfileName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FargateProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::FargateProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::FargateProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::FargateProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1251,7 +2742,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1266,15 +2757,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::FargateProfile' AND data__Identifier = '|' AND region = 'us-east-1' - identity_provider_configs: - name: identity_provider_configs - id: awscc.eks.identity_provider_configs - x-cfn-schema-name: IdentityProviderConfig - x-type: list + fargate_profiles_list_only: + name: fargate_profiles_list_only + id: awscc.eks.fargate_profiles_list_only + x-cfn-schema-name: FargateProfile + x-cfn-type-name: AWS::EKS::FargateProfile x-identifiers: - - IdentityProviderConfigName - ClusterName - - Type + - FargateProfileName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1282,34 +2778,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IdentityProviderConfigName') as identity_provider_config_name, JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.Type') as type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' + JSON_EXTRACT(Properties, '$.FargateProfileName') as fargate_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IdentityProviderConfigName') as identity_provider_config_name, json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'Type') as type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' + json_extract_path_text(Properties, 'FargateProfileName') as fargate_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' AND region = 'us-east-1' - identity_provider_config: - name: identity_provider_config - id: awscc.eks.identity_provider_config + identity_provider_configs: + name: identity_provider_configs + id: awscc.eks.identity_provider_configs x-cfn-schema-name: IdentityProviderConfig - x-type: get + x-cfn-type-name: AWS::EKS::IdentityProviderConfig x-identifiers: - IdentityProviderConfigName - ClusterName - Type + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentityProviderConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::IdentityProviderConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::IdentityProviderConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::IdentityProviderConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1324,7 +2866,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1338,13 +2880,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' AND data__Identifier = '||' AND region = 'us-east-1' - nodegroups: - name: nodegroups - id: awscc.eks.nodegroups - x-cfn-schema-name: Nodegroup - x-type: list + identity_provider_configs_list_only: + name: identity_provider_configs_list_only + id: awscc.eks.identity_provider_configs_list_only + x-cfn-schema-name: IdentityProviderConfig + x-cfn-type-name: AWS::EKS::IdentityProviderConfig x-identifiers: - - Id + - IdentityProviderConfigName + - ClusterName + - Type + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1352,28 +2902,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' + JSON_EXTRACT(Properties, '$.IdentityProviderConfigName') as identity_provider_config_name, + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.Type') as type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' + json_extract_path_text(Properties, 'IdentityProviderConfigName') as identity_provider_config_name, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'Type') as type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' AND region = 'us-east-1' - nodegroup: - name: nodegroup - id: awscc.eks.nodegroup + nodegroups: + name: nodegroups + id: awscc.eks.nodegroups x-cfn-schema-name: Nodegroup - x-type: get + x-cfn-type-name: AWS::EKS::Nodegroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Nodegroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Nodegroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Nodegroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Nodegroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/nodegroups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/nodegroups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/nodegroups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1395,6 +2997,7 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Taints') as taints, JSON_EXTRACT(Properties, '$.UpdateConfig') as update_config, + JSON_EXTRACT(Properties, '$.NodeRepairConfig') as node_repair_config, JSON_EXTRACT(Properties, '$.Version') as version, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.Arn') as arn @@ -1402,7 +3005,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1424,44 +3027,26 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Taints') as taints, json_extract_path_text(Properties, 'UpdateConfig') as update_config, + json_extract_path_text(Properties, 'NodeRepairConfig') as node_repair_config, json_extract_path_text(Properties, 'Version') as version, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'Arn') as arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Nodegroup' AND data__Identifier = '' AND region = 'us-east-1' - pod_identity_associations: - name: pod_identity_associations - id: awscc.eks.pod_identity_associations - x-cfn-schema-name: PodIdentityAssociation - x-type: list - x-identifiers: - - AssociationArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationArn') as association_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND region = 'us-east-1' - pod_identity_association: - name: pod_identity_association - id: awscc.eks.pod_identity_association - x-cfn-schema-name: PodIdentityAssociation - x-type: get + nodegroups_list_only: + name: nodegroups_list_only + id: awscc.eks.nodegroups_list_only + x-cfn-schema-name: Nodegroup + x-cfn-type-name: AWS::EKS::Nodegroup x-identifiers: - - AssociationArn + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1469,30 +3054,461 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.Namespace') as namespace, - JSON_EXTRACT(Properties, '$.ServiceAccount') as service_account, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Namespace') as namespace, - json_extract_path_text(Properties, 'ServiceAccount') as service_account, - json_extract_path_text(Properties, 'AssociationArn') as association_arn, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessEntry&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessEntry + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessEntryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PodIdentityAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePodIdentityAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePodIdentityAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Addon&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAddon + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAddonRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FargateProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFargateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFargateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentityProviderConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentityProviderConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentityProviderConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Nodegroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNodegroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNodegroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/elasticache.yaml b/providers/src/awscc/v00.00.00000/services/elasticache.yaml index e8615193..03e1a1d8 100644 --- a/providers/src/awscc/v00.00.00000/services/elasticache.yaml +++ b/providers/src/awscc/v00.00.00000/services/elasticache.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ElastiCache - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: GlobalReplicationGroupMember: type: object @@ -65,6 +445,9 @@ components: EngineVersion: description: The engine version of the Global Datastore. type: string + Engine: + description: The engine of the Global Datastore. + type: string CacheParameterGroupName: description: Cache parameter group name to use for the new engine version. This parameter cannot be modified independently. type: string @@ -96,11 +479,22 @@ components: required: - Members x-stackql-resource-name: global_replication_group - x-stackql-primaryIdentifier: + description: The AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group. + x-type-name: AWS::ElastiCache::GlobalReplicationGroup + x-stackql-primary-identifier: - GlobalReplicationGroupId + x-write-only-properties: + - GlobalReplicationGroupIdSuffix + - AutomaticFailoverEnabled + - CacheNodeType + - EngineVersion + - GlobalNodeGroupCount + - RegionalConfigurations x-read-only-properties: - GlobalReplicationGroupId - Status + x-required-properties: + - Members x-required-permissions: create: - elasticache:CreateGlobalReplicationGroup @@ -121,6 +515,100 @@ components: - elasticache:DescribeGlobalReplicationGroups list: - elasticache:DescribeGlobalReplicationGroups + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with ''aws:''. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + pattern: ^(?!aws:)[a-zA-Z0-9 _\.\/=+:\-@]*$ + minLength: 1 + maxLength: 128 + Value: + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + pattern: ^[a-zA-Z0-9 _\.\/=+:\-@]*$ + minLength: 0 + maxLength: 256 + required: + - Key + ParameterGroup: + type: object + properties: + Description: + type: string + description: The description for this cache parameter group. + Properties: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide. + Tags: + type: array + description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: false + CacheParameterGroupName: + type: string + description: The name of the Cache Parameter Group. + CacheParameterGroupFamily: + type: string + description: The name of the cache parameter group family that this cache parameter group is compatible with. + required: + - Description + - CacheParameterGroupFamily + x-stackql-resource-name: parameter_group + description: Resource Type definition for AWS::ElastiCache::ParameterGroup + x-type-name: AWS::ElastiCache::ParameterGroup + x-stackql-primary-identifier: + - CacheParameterGroupName + x-create-only-properties: + - CacheParameterGroupFamily + x-read-only-properties: + - CacheParameterGroupName + x-required-properties: + - Description + - CacheParameterGroupFamily + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticache:AddTagsToResource + - elasticache:RemoveTagsFromResource + - elasticache:ListTagsForResource + x-required-permissions: + create: + - elasticache:CreateCacheParameterGroup + - elasticache:DescribeCacheParameterGroups + - elasticache:AddTagsToResource + - elasticache:ModifyCacheParameterGroup + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + read: + - elasticache:DescribeCacheParameterGroups + - elasticache:DescribeCacheParameters + - elasticache:ListTagsForResource + update: + - elasticache:ModifyCacheParameterGroup + - elasticache:DescribeCacheParameterGroups + - elasticache:DescribeCacheParameters + - elasticache:DescribeEngineDefaultParameters + - elasticache:AddTagsToResource + - elasticache:RemoveTagsFromResource + delete: + - elasticache:DescribeCacheParameterGroups + - elasticache:DeleteCacheParameterGroup + list: + - elasticache:DescribeCacheParameterGroups CacheUsageLimits: description: The cache capacity limit of the Serverless Cache. type: object @@ -134,47 +622,31 @@ components: description: The cached data capacity of the Serverless Cache. type: object properties: + Minimum: + description: The minimum cached data capacity of the Serverless Cache. + type: integer Maximum: description: The maximum cached data capacity of the Serverless Cache. type: integer Unit: - description: The unix of cached data capacity of the Serverless Cache. + description: The unit of cached data capacity of the Serverless Cache. type: string enum: - GB additionalProperties: false required: - - Maximum - Unit ECPUPerSecond: description: The ECPU per second of the Serverless Cache. type: object properties: + Minimum: + description: The minimum ECPU per second of the Serverless Cache. + type: integer Maximum: description: The maximum ECPU per second of the Serverless Cache. type: integer additionalProperties: false - required: - - Maximum - Tag: - description: A key-value pair to associate with a resource. - type: object - additionalProperties: false - properties: - Key: - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with ''aws:''. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string - pattern: ^(?!aws:)[a-zA-Z0-9 _\.\/=+:\-@]*$ - minLength: 1 - maxLength: 128 - Value: - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string - pattern: ^[a-zA-Z0-9 _\.\/=+:\-@]*$ - minLength: 0 - maxLength: 256 - required: - - Key Endpoint: description: The address and the port. type: object @@ -266,15 +738,18 @@ components: - ServerlessCacheName - Engine x-stackql-resource-name: serverless_cache - x-stackql-primaryIdentifier: + description: The AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache. + x-type-name: AWS::ElastiCache::ServerlessCache + x-stackql-primary-identifier: - ServerlessCacheName x-create-only-properties: - ServerlessCacheName - - Engine - - MajorEngineVersion - KmsKeyId - SnapshotArnsToRestore - SubnetIds + x-write-only-properties: + - SnapshotArnsToRestore + - FinalSnapshotName x-read-only-properties: - FullEngineVersion - CreateTime @@ -284,6 +759,18 @@ components: - ReaderEndpoint/Address - ReaderEndpoint/Port - ARN + x-required-properties: + - ServerlessCacheName + - Engine + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticache:AddTagsToResource + - elasticache:RemoveTagsFromResource x-required-permissions: create: - elasticache:CreateServerlessCache @@ -336,10 +823,25 @@ components: - Description - SubnetIds x-stackql-resource-name: subnet_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElastiCache::SubnetGroup + x-type-name: AWS::ElastiCache::SubnetGroup + x-stackql-primary-identifier: - CacheSubnetGroupName x-create-only-properties: - CacheSubnetGroupName + x-required-properties: + - Description + - SubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticache:AddTagsToResource + - elasticache:RemoveTagsFromResource + - elasticache:ListTagsForResource x-required-permissions: create: - elasticache:CreateCacheSubnetGroup @@ -374,10 +876,11 @@ components: description: The username of the user. type: string Engine: - description: Must be redis. + description: The target cache engine for the user. type: string enum: - redis + - valkey AccessString: description: Access permissions string used for this user account. type: string @@ -429,20 +932,40 @@ components: - UserName - Engine x-stackql-resource-name: user - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElastiCache::User + x-type-name: AWS::ElastiCache::User + x-stackql-primary-identifier: - UserId x-create-only-properties: - UserId - UserName - - Engine + x-write-only-properties: + - Passwords + - NoPasswordRequired + - AccessString + - AuthenticationMode x-read-only-properties: - Status - Arn + x-required-properties: + - UserId + - UserName + - Engine + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticache:AddTagsToResource + - elasticache:RemoveTagsFromResource x-required-permissions: create: - elasticache:CreateUser - elasticache:DescribeUsers - elasticache:ListTagsForResource + - elasticache:AddTagsToResource read: - elasticache:DescribeUsers - elasticache:ListTagsForResource @@ -469,10 +992,11 @@ components: pattern: '[a-z][a-z0-9\\-]*' type: string Engine: - description: Must be redis. + description: The target cache engine for the user group. type: string enum: - redis + - valkey UserIds: type: array x-$comment: List of users. @@ -497,19 +1021,34 @@ components: - Engine - UserIds x-stackql-resource-name: user_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElastiCache::UserGroup + x-type-name: AWS::ElastiCache::UserGroup + x-stackql-primary-identifier: - UserGroupId x-create-only-properties: - UserGroupId - - Engine x-read-only-properties: - Status - Arn + x-required-properties: + - UserGroupId + - Engine + - UserIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticache:AddTagsToResource + - elasticache:RemoveTagsFromResource x-required-permissions: create: - elasticache:CreateUserGroup - elasticache:DescribeUserGroups - elasticache:ListTagsForResource + - elasticache:AddTagsToResource read: - elasticache:DescribeUserGroups - elasticache:ListTagsForResource @@ -527,43 +1066,427 @@ components: list: - elasticache:DescribeUserGroups - elasticache:ListTagsForResource + CreateGlobalReplicationGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GlobalReplicationGroupIdSuffix: + description: 'The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. ' + type: string + AutomaticFailoverEnabled: + description: AutomaticFailoverEnabled + type: boolean + CacheNodeType: + description: The cache node type of the Global Datastore + type: string + EngineVersion: + description: The engine version of the Global Datastore. + type: string + Engine: + description: The engine of the Global Datastore. + type: string + CacheParameterGroupName: + description: Cache parameter group name to use for the new engine version. This parameter cannot be modified independently. + type: string + GlobalNodeGroupCount: + description: Indicates the number of node groups in the Global Datastore. + type: integer + GlobalReplicationGroupDescription: + description: The optional description of the Global Datastore + type: string + GlobalReplicationGroupId: + description: The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix. + type: string + Members: + description: The replication groups that comprise the Global Datastore. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/GlobalReplicationGroupMember' + minItems: 1 + Status: + description: The status of the Global Datastore + type: string + RegionalConfigurations: + description: 'Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore ' + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/RegionalConfiguration' + x-stackQL-stringOnly: true + x-title: CreateGlobalReplicationGroupRequest + type: object + required: [] + CreateParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: The description for this cache parameter group. + Properties: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide. + Tags: + type: array + description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: false + CacheParameterGroupName: + type: string + description: The name of the Cache Parameter Group. + CacheParameterGroupFamily: + type: string + description: The name of the cache parameter group family that this cache parameter group is compatible with. + x-stackQL-stringOnly: true + x-title: CreateParameterGroupRequest + type: object + required: [] + CreateServerlessCacheRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ServerlessCacheName: + description: The name of the Serverless Cache. This value must be unique. + type: string + Description: + description: The description of the Serverless Cache. + type: string + Engine: + description: The engine name of the Serverless Cache. + type: string + MajorEngineVersion: + description: The major engine version of the Serverless Cache. + type: string + FullEngineVersion: + description: The full engine version of the Serverless Cache. + type: string + CacheUsageLimits: + $ref: '#/components/schemas/CacheUsageLimits' + KmsKeyId: + description: The ID of the KMS key used to encrypt the cluster. + type: string + SecurityGroupIds: + description: One or more Amazon VPC security groups associated with this Serverless Cache. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + SnapshotArnsToRestore: + description: The ARN's of snapshot to restore Serverless Cache. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Tags: + description: An array of key-value pairs to apply to this Serverless Cache. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + UserGroupId: + description: The ID of the user group. + type: string + SubnetIds: + description: The subnet id's of the Serverless Cache. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + SnapshotRetentionLimit: + description: The snapshot retention limit of the Serverless Cache. + type: integer + DailySnapshotTime: + description: The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache. + type: string + CreateTime: + description: The creation time of the Serverless Cache. + type: string + Status: + description: The status of the Serverless Cache. + type: string + Endpoint: + $ref: '#/components/schemas/Endpoint' + ReaderEndpoint: + $ref: '#/components/schemas/Endpoint' + ARN: + description: The ARN of the Serverless Cache. + type: string + FinalSnapshotName: + description: The final snapshot name which is taken before Serverless Cache is deleted. + type: string + x-stackQL-stringOnly: true + x-title: CreateServerlessCacheRequest + type: object + required: [] + CreateSubnetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: The description for the cache subnet group. + SubnetIds: + description: The EC2 subnet IDs for the cache subnet group. + type: array + items: + type: string + x-insertionOrder: false + uniqueItems: false + CacheSubnetGroupName: + type: string + description: The name for the cache subnet group. This value is stored as a lowercase string. + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSubnetGroupRequest + type: object + required: [] + CreateUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: Indicates the user status. Can be "active", "modifying" or "deleting". + type: string + UserId: + description: The ID of the user. + pattern: '[a-z][a-z0-9\\-]*' + type: string + UserName: + description: The username of the user. + type: string + Engine: + description: The target cache engine for the user. + type: string + enum: + - redis + - valkey + AccessString: + description: Access permissions string used for this user account. + type: string + NoPasswordRequired: + description: Indicates a password is not required for this user account. + type: boolean + Passwords: + type: array + x-$comment: List of passwords. + uniqueItems: true + x-insertionOrder: true + items: + type: string + description: Passwords used for this user account. You can create up to two passwords for each user. + Arn: + description: The Amazon Resource Name (ARN) of the user account. + type: string + AuthenticationMode: + type: object + additionalProperties: false + properties: + Type: + description: Authentication Type + type: string + enum: + - password + - no-password-required + - iam + Passwords: + type: array + x-$comment: List of passwords. + uniqueItems: true + x-insertionOrder: true + items: + type: string + description: Passwords used for this user account. You can create up to two passwords for each user. + required: + - Type + Tags: + description: An array of key-value pairs to apply to this user. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateUserRequest + type: object + required: [] + CreateUserGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: Indicates user group status. Can be "creating", "active", "modifying", "deleting". + type: string + UserGroupId: + description: The ID of the user group. + pattern: '[a-z][a-z0-9\\-]*' + type: string + Engine: + description: The target cache engine for the user group. + type: string + enum: + - redis + - valkey + UserIds: + type: array + x-$comment: List of users. + uniqueItems: true + x-insertionOrder: false + items: + type: string + description: List of users associated to this user group. + Arn: + description: The Amazon Resource Name (ARN) of the user account. + type: string + Tags: + description: An array of key-value pairs to apply to this user. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateUserGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: global_replication_groups: name: global_replication_groups id: awscc.elasticache.global_replication_groups x-cfn-schema-name: GlobalReplicationGroup - x-type: list - x-identifiers: - - GlobalReplicationGroupId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalReplicationGroupId') as global_replication_group_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalReplicationGroupId') as global_replication_group_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' - AND region = 'us-east-1' - global_replication_group: - name: global_replication_group - id: awscc.elasticache.global_replication_group - x-cfn-schema-name: GlobalReplicationGroup - x-type: get + x-cfn-type-name: AWS::ElastiCache::GlobalReplicationGroup x-identifiers: - GlobalReplicationGroupId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GlobalReplicationGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::GlobalReplicationGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::GlobalReplicationGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::GlobalReplicationGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -572,6 +1495,7 @@ components: JSON_EXTRACT(Properties, '$.AutomaticFailoverEnabled') as automatic_failover_enabled, JSON_EXTRACT(Properties, '$.CacheNodeType') as cache_node_type, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, + JSON_EXTRACT(Properties, '$.Engine') as engine, JSON_EXTRACT(Properties, '$.CacheParameterGroupName') as cache_parameter_group_name, JSON_EXTRACT(Properties, '$.GlobalNodeGroupCount') as global_node_group_count, JSON_EXTRACT(Properties, '$.GlobalReplicationGroupDescription') as global_replication_group_description, @@ -583,7 +1507,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -592,6 +1516,7 @@ components: json_extract_path_text(Properties, 'AutomaticFailoverEnabled') as automatic_failover_enabled, json_extract_path_text(Properties, 'CacheNodeType') as cache_node_type, json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'Engine') as engine, json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name, json_extract_path_text(Properties, 'GlobalNodeGroupCount') as global_node_group_count, json_extract_path_text(Properties, 'GlobalReplicationGroupDescription') as global_replication_group_description, @@ -602,13 +1527,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' AND data__Identifier = '' AND region = 'us-east-1' - serverless_caches: - name: serverless_caches - id: awscc.elasticache.serverless_caches - x-cfn-schema-name: ServerlessCache - x-type: list + global_replication_groups_list_only: + name: global_replication_groups_list_only + id: awscc.elasticache.global_replication_groups_list_only + x-cfn-schema-name: GlobalReplicationGroup + x-cfn-type-name: AWS::ElastiCache::GlobalReplicationGroup x-identifiers: - - ServerlessCacheName + - GlobalReplicationGroupId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -616,28 +1547,192 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ServerlessCacheName') as serverless_cache_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' + JSON_EXTRACT(Properties, '$.GlobalReplicationGroupId') as global_replication_group_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ServerlessCacheName') as serverless_cache_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' + json_extract_path_text(Properties, 'GlobalReplicationGroupId') as global_replication_group_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' + AND region = 'us-east-1' + parameter_groups: + name: parameter_groups + id: awscc.elasticache.parameter_groups + x-cfn-schema-name: ParameterGroup + x-cfn-type-name: AWS::ElastiCache::ParameterGroup + x-identifiers: + - CacheParameterGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Properties') as properties, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CacheParameterGroupName') as cache_parameter_group_name, + JSON_EXTRACT(Properties, '$.CacheParameterGroupFamily') as cache_parameter_group_family + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Properties') as properties, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name, + json_extract_path_text(Properties, 'CacheParameterGroupFamily') as cache_parameter_group_family + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + parameter_groups_list_only: + name: parameter_groups_list_only + id: awscc.elasticache.parameter_groups_list_only + x-cfn-schema-name: ParameterGroup + x-cfn-type-name: AWS::ElastiCache::ParameterGroup + x-identifiers: + - CacheParameterGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CacheParameterGroupName') as cache_parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' AND region = 'us-east-1' - serverless_cache: - name: serverless_cache - id: awscc.elasticache.serverless_cache + serverless_caches: + name: serverless_caches + id: awscc.elasticache.serverless_caches x-cfn-schema-name: ServerlessCache - x-type: get + x-cfn-type-name: AWS::ElastiCache::ServerlessCache x-identifiers: - ServerlessCacheName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServerlessCache&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ServerlessCache" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ServerlessCache" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ServerlessCache" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -666,7 +1761,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -694,13 +1789,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' AND data__Identifier = '' AND region = 'us-east-1' - subnet_groups: - name: subnet_groups - id: awscc.elasticache.subnet_groups - x-cfn-schema-name: SubnetGroup - x-type: list + serverless_caches_list_only: + name: serverless_caches_list_only + id: awscc.elasticache.serverless_caches_list_only + x-cfn-schema-name: ServerlessCache + x-cfn-type-name: AWS::ElastiCache::ServerlessCache x-identifiers: - - CacheSubnetGroupName + - ServerlessCacheName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -708,28 +1809,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CacheSubnetGroupName') as cache_subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' + JSON_EXTRACT(Properties, '$.ServerlessCacheName') as serverless_cache_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CacheSubnetGroupName') as cache_subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' + json_extract_path_text(Properties, 'ServerlessCacheName') as serverless_cache_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' AND region = 'us-east-1' - subnet_group: - name: subnet_group - id: awscc.elasticache.subnet_group + subnet_groups: + name: subnet_groups + id: awscc.elasticache.subnet_groups x-cfn-schema-name: SubnetGroup - x-type: get + x-cfn-type-name: AWS::ElastiCache::SubnetGroup x-identifiers: - CacheSubnetGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubnetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::SubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::SubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::SubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -742,7 +1891,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -754,13 +1903,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' AND data__Identifier = '' AND region = 'us-east-1' - users: - name: users - id: awscc.elasticache.users - x-cfn-schema-name: User - x-type: list + subnet_groups_list_only: + name: subnet_groups_list_only + id: awscc.elasticache.subnet_groups_list_only + x-cfn-schema-name: SubnetGroup + x-cfn-type-name: AWS::ElastiCache::SubnetGroup x-identifiers: - - UserId + - CacheSubnetGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -768,28 +1923,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserId') as user_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' + JSON_EXTRACT(Properties, '$.CacheSubnetGroupName') as cache_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserId') as user_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' + json_extract_path_text(Properties, 'CacheSubnetGroupName') as cache_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' AND region = 'us-east-1' - user: - name: user - id: awscc.elasticache.user + users: + name: users + id: awscc.elasticache.users x-cfn-schema-name: User - x-type: get + x-cfn-type-name: AWS::ElastiCache::User x-identifiers: - UserId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -808,7 +2011,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -826,13 +2029,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::User' AND data__Identifier = '' AND region = 'us-east-1' - user_groups: - name: user_groups - id: awscc.elasticache.user_groups - x-cfn-schema-name: UserGroup - x-type: list + users_list_only: + name: users_list_only + id: awscc.elasticache.users_list_only + x-cfn-schema-name: User + x-cfn-type-name: AWS::ElastiCache::User x-identifiers: - - UserGroupId + - UserId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -840,28 +2049,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserGroupId') as user_group_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' + JSON_EXTRACT(Properties, '$.UserId') as user_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserGroupId') as user_group_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' + json_extract_path_text(Properties, 'UserId') as user_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' AND region = 'us-east-1' - user_group: - name: user_group - id: awscc.elasticache.user_group + user_groups: + name: user_groups + id: awscc.elasticache.user_groups x-cfn-schema-name: UserGroup - x-type: get + x-cfn-type-name: AWS::ElastiCache::UserGroup x-identifiers: - UserGroupId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::UserGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::UserGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::UserGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -876,7 +2133,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -890,3 +2147,439 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' AND data__Identifier = '' AND region = 'us-east-1' + user_groups_list_only: + name: user_groups_list_only + id: awscc.elasticache.user_groups_list_only + x-cfn-schema-name: UserGroup + x-cfn-type-name: AWS::ElastiCache::UserGroup + x-identifiers: + - UserGroupId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserGroupId') as user_group_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserGroupId') as user_group_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GlobalReplicationGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGlobalReplicationGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGlobalReplicationGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServerlessCache&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServerlessCache + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServerlessCacheRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubnetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubnetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubnetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/elasticbeanstalk.yaml b/providers/src/awscc/v00.00.00000/services/elasticbeanstalk.yaml index b001edea..dea94daa 100644 --- a/providers/src/awscc/v00.00.00000/services/elasticbeanstalk.yaml +++ b/providers/src/awscc/v00.00.00000/services/elasticbeanstalk.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ElasticBeanstalk - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ApplicationResourceLifecycleConfig: type: object @@ -64,20 +444,45 @@ components: description: Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. $ref: '#/components/schemas/ApplicationResourceLifecycleConfig' x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: The AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application. + x-type-name: AWS::ElasticBeanstalk::Application + x-stackql-primary-identifier: - ApplicationName x-create-only-properties: - ApplicationName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - elasticbeanstalk:CreateApplication + - elasticbeanstalk:DescribeApplications + - s3:CreateBucket + - s3:PutBucketAcl + - s3:PutBucketObjectLockConfiguration + - s3:PutBucketVersioning + - s3:PutBucketOwnershipControls + - s3:PutBucketPolicy + - s3:PutBucketPublicAccessBlock + - s3:PutObject + - s3:ListBucket + - s3:GetObject + - s3:GetBucketLocation + - s3:GetBucketPolicy + - iam:PassRole read: - elasticbeanstalk:DescribeApplications update: - elasticbeanstalk:UpdateApplication - elasticbeanstalk:UpdateApplicationResourceLifecycle + - elasticbeanstalk:DescribeApplications + - iam:PassRole delete: - elasticbeanstalk:DeleteApplication + - elasticbeanstalk:DescribeApplications + - s3:ListBucket list: - elasticbeanstalk:DescribeApplications SourceBundle: @@ -111,7 +516,9 @@ components: - ApplicationName - SourceBundle x-stackql-resource-name: application_version - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElasticBeanstalk::ApplicationVersion + x-type-name: AWS::ElasticBeanstalk::ApplicationVersion + x-stackql-primary-identifier: - ApplicationName - Id x-create-only-properties: @@ -119,6 +526,14 @@ components: - ApplicationName x-read-only-properties: - Id + x-required-properties: + - ApplicationName + - SourceBundle + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - elasticbeanstalk:CreateApplicationVersion @@ -129,8 +544,10 @@ components: - elasticbeanstalk:DescribeApplicationVersions update: - elasticbeanstalk:UpdateApplicationVersion + - elasticbeanstalk:DescribeApplicationVersions delete: - elasticbeanstalk:DeleteApplicationVersion + - elasticbeanstalk:DescribeApplicationVersions list: - elasticbeanstalk:DescribeApplicationVersions SourceConfiguration: @@ -213,7 +630,9 @@ components: required: - ApplicationName x-stackql-resource-name: configuration_template - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate + x-type-name: AWS::ElasticBeanstalk::ConfigurationTemplate + x-stackql-primary-identifier: - ApplicationName - TemplateName x-create-only-properties: @@ -222,18 +641,58 @@ components: - PlatformArn - SolutionStackName - SourceConfiguration + x-write-only-properties: + - EnvironmentId + - SourceConfiguration/ApplicationName + - SourceConfiguration/TemplateName x-read-only-properties: - TemplateName + x-required-properties: + - ApplicationName + x-tagging: + taggable: false x-required-permissions: create: - elasticbeanstalk:CreateConfigurationTemplate + - s3:CreateBucket + - s3:PutBucketAcl + - s3:PutBucketObjectLockConfiguration + - s3:PutBucketVersioning + - s3:PutBucketOwnershipControls + - s3:PutBucketPolicy + - s3:PutBucketPublicAccessBlock + - s3:PutObject + - s3:ListBucket + - s3:GetObject + - s3:GetBucketLocation + - s3:GetBucketPolicy + - ec2:DescribeImages + - ec2:CreateLaunchTemplate read: - elasticbeanstalk:DescribeConfigurationSettings + - ec2:CreateLaunchTemplate + - s3:ListBucket + - s3:GetObject + - s3:GetBucketLocation + - s3:GetBucketPolicy update: - elasticbeanstalk:UpdateConfigurationTemplate + - ec2:CreateLaunchTemplate + - s3:PutObject + - s3:ListBucket + - s3:GetObject + - s3:GetBucketLocation + - s3:GetBucketPolicy + - ec2:DescribeImages delete: - elasticbeanstalk:DeleteConfigurationTemplate - elasticbeanstalk:DescribeConfigurationSettings + - ec2:CreateLaunchTemplate + - s3:ListBucket + - s3:GetObject + - s3:GetBucketLocation + - s3:GetBucketPolicy + - s3:DeleteObject list: - elasticbeanstalk:DescribeApplications Tier: @@ -333,7 +792,9 @@ components: required: - ApplicationName x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElasticBeanstalk::Environment + x-type-name: AWS::ElasticBeanstalk::Environment + x-stackql-primary-identifier: - EnvironmentName x-create-only-properties: - CNAMEPrefix @@ -342,8 +803,27 @@ components: - SolutionStackName - Tier/Name - Tier/Type + x-write-only-properties: + - TemplateName + - OptionSettings + - OptionSettings/*/OptionName + - OptionSettings/*/ResourceName + - OptionSettings/*/Namespace + - OptionSettings/*/Value x-read-only-properties: - EndpointURL + x-required-properties: + - ApplicationName + x-tagging: + permissions: + - elasticbeanstalk:AddTags + - elasticbeanstalk:RemoveTags + - elasticbeanstalk:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: read: - elasticbeanstalk:DescribeEnvironments @@ -352,56 +832,271 @@ components: create: - elasticbeanstalk:DescribeEnvironments - elasticbeanstalk:CreateEnvironment + - elasticbeanstalk:AddTags + - elasticbeanstalk:ListTagsForResource - iam:PassRole update: - elasticbeanstalk:DescribeEnvironments - elasticbeanstalk:UpdateEnvironment - - elasticbeanstalk:UpdateTagsForResource - elasticbeanstalk:AssociateEnvironmentOperationsRole - elasticbeanstalk:DisassociateEnvironmentOperationsRole + - elasticbeanstalk:AddTags + - elasticbeanstalk:ListTagsForResource + - elasticbeanstalk:RemoveTags + - s3:GetBucketLocation + - s3:GetBucketPolicy + - s3:ListBucket + - s3:PutBucketPolicy - iam:PassRole list: - elasticbeanstalk:DescribeEnvironments + - elasticbeanstalk:ListTagsForResource delete: - elasticbeanstalk:DescribeEnvironments - elasticbeanstalk:TerminateEnvironment + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationName: + description: A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. + type: string + Description: + description: Your description of the application. + type: string + ResourceLifecycleConfig: + description: Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. + $ref: '#/components/schemas/ApplicationResourceLifecycleConfig' + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateApplicationVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + ApplicationName: + description: 'The name of the Elastic Beanstalk application that is associated with this application version. ' + type: string + Description: + description: A description of this application version. + type: string + SourceBundle: + description: 'The Amazon S3 bucket and key that identify the location of the source bundle for this version. ' + $ref: '#/components/schemas/SourceBundle' + x-stackQL-stringOnly: true + x-title: CreateApplicationVersionRequest + type: object + required: [] + CreateConfigurationTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationName: + description: 'The name of the Elastic Beanstalk application to associate with this configuration template. ' + type: string + Description: + description: An optional description for this configuration. + type: string + EnvironmentId: + description: 'The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don''t specify PlatformArn, SolutionStackName, or SourceConfiguration. ' + type: string + OptionSettings: + description: 'Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide. ' + type: array + x-arrayType: AttributeList + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ConfigurationOptionSetting' + PlatformArn: + description: 'The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide. ' + type: string + SolutionStackName: + description: >- + The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported + Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. + + You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. + + Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks. + type: string + SourceConfiguration: + description: |- + An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. + + Values specified in OptionSettings override any values obtained from the SourceConfiguration. + + You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName. + + Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. + $ref: '#/components/schemas/SourceConfiguration' + TemplateName: + description: The name of the configuration template + type: string + x-stackQL-stringOnly: true + x-title: CreateConfigurationTemplateRequest + type: object + required: [] + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PlatformArn: + description: The Amazon Resource Name (ARN) of the custom platform to use with the environment. + type: string + ApplicationName: + description: The name of the application that is associated with this environment. + type: string + Description: + description: Your description for this environment. + type: string + EnvironmentName: + description: A unique name for the environment. + type: string + OperationsRole: + description: The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. + type: string + Tier: + description: Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks. + $ref: '#/components/schemas/Tier' + VersionLabel: + description: The name of the application version to deploy. + type: string + EndpointURL: + type: string + OptionSettings: + uniqueItems: false + description: Key-value pairs defining configuration options for this environment, such as the instance type. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/OptionSetting' + TemplateName: + description: The name of the Elastic Beanstalk configuration template to use with the environment. + type: string + SolutionStackName: + description: The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. + type: string + CNAMEPrefix: + description: If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. + type: string + Tags: + uniqueItems: false + description: Specifies the tags applied to resources in the environment. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.elasticbeanstalk.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.elasticbeanstalk.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::ElasticBeanstalk::Application x-identifiers: - ApplicationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -413,7 +1108,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -424,14 +1119,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' AND data__Identifier = '' AND region = 'us-east-1' - application_versions: - name: application_versions - id: awscc.elasticbeanstalk.application_versions - x-cfn-schema-name: ApplicationVersion - x-type: list + applications_list_only: + name: applications_list_only + id: awscc.elasticbeanstalk.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::ElasticBeanstalk::Application x-identifiers: - ApplicationName - - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -439,31 +1139,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' AND region = 'us-east-1' - application_version: - name: application_version - id: awscc.elasticbeanstalk.application_version + application_versions: + name: application_versions + id: awscc.elasticbeanstalk.application_versions x-cfn-schema-name: ApplicationVersion - x-type: get + x-cfn-type-name: AWS::ElasticBeanstalk::ApplicationVersion x-identifiers: - ApplicationName - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::ApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::ApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::ApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/application_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -476,7 +1222,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -488,14 +1234,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' AND data__Identifier = '|' AND region = 'us-east-1' - configuration_templates: - name: configuration_templates - id: awscc.elasticbeanstalk.configuration_templates - x-cfn-schema-name: ConfigurationTemplate - x-type: list + application_versions_list_only: + name: application_versions_list_only + id: awscc.elasticbeanstalk.application_versions_list_only + x-cfn-schema-name: ApplicationVersion + x-cfn-type-name: AWS::ElasticBeanstalk::ApplicationVersion x-identifiers: - ApplicationName - - TemplateName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -504,8 +1256,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, - JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -513,21 +1265,69 @@ components: SELECT region, json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'TemplateName') as template_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' AND region = 'us-east-1' - configuration_template: - name: configuration_template - id: awscc.elasticbeanstalk.configuration_template + configuration_templates: + name: configuration_templates + id: awscc.elasticbeanstalk.configuration_templates x-cfn-schema-name: ConfigurationTemplate - x-type: get + x-cfn-type-name: AWS::ElasticBeanstalk::ConfigurationTemplate x-identifiers: - ApplicationName - TemplateName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::ConfigurationTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::ConfigurationTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::ConfigurationTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -544,7 +1344,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -560,13 +1360,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' AND data__Identifier = '|' AND region = 'us-east-1' - environments: - name: environments - id: awscc.elasticbeanstalk.environments - x-cfn-schema-name: Environment - x-type: list + configuration_templates_list_only: + name: configuration_templates_list_only + id: awscc.elasticbeanstalk.configuration_templates_list_only + x-cfn-schema-name: ConfigurationTemplate + x-cfn-type-name: AWS::ElasticBeanstalk::ConfigurationTemplate x-identifiers: - - EnvironmentName + - ApplicationName + - TemplateName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -574,28 +1381,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, + JSON_EXTRACT(Properties, '$.TemplateName') as template_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' AND region = 'us-east-1' - environment: - name: environment - id: awscc.elasticbeanstalk.environment + environments: + name: environments + id: awscc.elasticbeanstalk.environments x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::ElasticBeanstalk::Environment x-identifiers: - EnvironmentName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticBeanstalk::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -617,7 +1474,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -638,3 +1495,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' AND data__Identifier = '' AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.elasticbeanstalk.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::ElasticBeanstalk::Environment + x-identifiers: + - EnvironmentName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/elasticloadbalancingv2.yaml b/providers/src/awscc/v00.00.00000/services/elasticloadbalancingv2.yaml index 5cfa3af4..034cb3a8 100644 --- a/providers/src/awscc/v00.00.00000/services/elasticloadbalancingv2.yaml +++ b/providers/src/awscc/v00.00.00000/services/elasticloadbalancingv2.yaml @@ -1,164 +1,662 @@ openapi: 3.0.0 info: title: ElasticLoadBalancingV2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: MutualAuthentication: - type: object + description: The mutual authentication configuration information. additionalProperties: false + type: object properties: + IgnoreClientCertificateExpiry: + description: Indicates whether expired client certificates are ignored. + type: boolean Mode: - type: string description: The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``. - TrustStoreArn: type: string + TrustStoreArn: description: The Amazon Resource Name (ARN) of the trust store. - IgnoreClientCertificateExpiry: - type: boolean - description: Indicates whether expired client certificates are ignored. - description: Specifies the configuration information for mutual authentication. - FixedResponseConfig: + type: string + AdvertiseTrustStoreCaNames: + description: Indicates whether trust store CA certificate names are advertised. + type: string + TargetGroupTuple: + description: Information about how traffic will be distributed between multiple target groups in a forward rule. + additionalProperties: false type: object + properties: + TargetGroupArn: + description: The Amazon Resource Name (ARN) of the target group. + type: string + Weight: + description: The weight. The range is 0 to 999. + type: integer + FixedResponseConfig: + description: Specifies information required when returning a custom HTTP response. additionalProperties: false + type: object properties: ContentType: + description: |- + The content type. + Valid Values: text/plain | text/css | text/html | application/javascript | application/json type: string StatusCode: + description: The HTTP response code (2XX, 4XX, or 5XX). type: string MessageBody: + description: The message. type: string required: - StatusCode - TargetGroupTuple: - type: object - additionalProperties: false - properties: - TargetGroupArn: - type: string - Weight: - type: integer Action: - type: object + description: Specifies an action for a listener rule. additionalProperties: false + type: object properties: Order: + description: The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. type: integer TargetGroupArn: + description: The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead. type: string FixedResponseConfig: + description: '[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``.' $ref: '#/components/schemas/FixedResponseConfig' AuthenticateCognitoConfig: + description: '[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``.' $ref: '#/components/schemas/AuthenticateCognitoConfig' Type: + description: The type of action. type: string RedirectConfig: + description: '[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``.' $ref: '#/components/schemas/RedirectConfig' ForwardConfig: + description: Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. $ref: '#/components/schemas/ForwardConfig' AuthenticateOidcConfig: + description: '[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``.' $ref: '#/components/schemas/AuthenticateOidcConfig' required: - Type AuthenticateCognitoConfig: - type: object + description: Specifies information required when integrating with Amazon Cognito to authenticate users. additionalProperties: false + type: object properties: OnUnauthenticatedRequest: + description: |- + The behavior if the user is not authenticated. The following are possible values: + + deny```` - Return an HTTP 401 Unauthorized error. + + allow```` - Allow the request to be forwarded to the target. + + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. type: string UserPoolClientId: + description: The ID of the Amazon Cognito user pool client. type: string UserPoolDomain: + description: The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. type: string SessionTimeout: + description: The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). type: integer Scope: + description: |- + The set of user claims to be requested from the IdP. The default is ``openid``. + To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. type: string SessionCookieName: + description: The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. type: string UserPoolArn: + description: The Amazon Resource Name (ARN) of the Amazon Cognito user pool. type: string AuthenticationRequestExtraParams: - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string + description: The query parameters (up to 10) to include in the redirect request to the authorization endpoint. + additionalProperties: false + type: object required: - UserPoolClientId - UserPoolDomain - UserPoolArn RedirectConfig: - type: object + description: |- + Information about a redirect action. + A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. + You can reuse URI components using the following reserved keywords: + + #{protocol} + + #{host} + + #{port} + + #{path} (the leading "/" is removed) + + #{query} + + For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz". additionalProperties: false + type: object properties: Path: + description: 'The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.' type: string Query: + description: The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. type: string Port: + description: 'The port. You can specify a value from 1 to 65535 or #{port}.' type: string Host: + description: 'The hostname. This component is not percent-encoded. The hostname can contain #{host}.' type: string Protocol: + description: 'The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You can''t redirect HTTPS to HTTP.' type: string StatusCode: + description: The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). type: string required: - StatusCode TargetGroupStickinessConfig: - type: object + description: Information about the target group stickiness for a rule. additionalProperties: false + type: object properties: Enabled: + description: Indicates whether target group stickiness is enabled. type: boolean DurationSeconds: + description: The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). You must specify this value when enabling target group stickiness. type: integer - ForwardConfig: + ListenerAttribute: + description: Information about a listener attribute. + additionalProperties: false type: object + properties: + Value: + description: The value of the attribute. + type: string + Key: + description: |- + The name of the attribute. + The following attribute is supported by Network Load Balancers, and Gateway Load Balancers. + + ``tcp.idle_timeout.seconds`` - The tcp idle timeout value, in seconds. The valid range is 60-6000 seconds. The default is 350 seconds. + + The following attributes are only supported by Application Load Balancers. + + ``routing.http.request.x_amzn_mtls_clientcert_serial_number.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Serial-Number* HTTP request header. + + ``routing.http.request.x_amzn_mtls_clientcert_issuer.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Issuer* HTTP request header. + + ``routing.http.request.x_amzn_mtls_clientcert_subject.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Subject* HTTP request header. + + ``routing.http.request.x_amzn_mtls_clientcert_validity.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Validity* HTTP request header. + + ``routing.http.request.x_amzn_mtls_clientcert_leaf.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Leaf* HTTP request header. + + ``routing.http.request.x_amzn_mtls_clientcert.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert* HTTP request header. + + ``routing.http.request.x_amzn_tls_version.header_name`` - Enables you to modify the header name of the *X-Amzn-Tls-Version* HTTP request header. + + ``routing.http.request.x_amzn_tls_cipher_suite.header_name`` - Enables you to modify the header name of the *X-Amzn-Tls-Cipher-Suite* HTTP request header. + + ``routing.http.response.server.enabled`` - Enables you to allow or remove the HTTP response server header. + + ``routing.http.response.strict_transport_security.header_value`` - Informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS. + + ``routing.http.response.access_control_allow_origin.header_value`` - Specifies which origins are allowed to access the server. + + ``routing.http.response.access_control_allow_methods.header_value`` - Returns which HTTP methods are allowed when accessing the server from a different origin. + + ``routing.http.response.access_control_allow_headers.header_value`` - Specifies which headers can be used during the request. + + ``routing.http.response.access_control_allow_credentials.header_value`` - Indicates whether the browser should include credentials such as cookies or authentication when making requests. + + ``routing.http.response.access_control_expose_headers.header_value`` - Returns which headers the browser can expose to the requesting client. + + ``routing.http.response.access_control_max_age.header_value`` - Specifies how long the results of a preflight request can be cached, in seconds. + + ``routing.http.response.content_security_policy.header_value`` - Specifies restrictions enforced by the browser to help minimize the risk of certain types of security threats. + + ``routing.http.response.x_content_type_options.header_value`` - Indicates whether the MIME types advertised in the *Content-Type* headers should be followed and not be changed. + + ``routing.http.response.x_frame_options.header_value`` - Indicates whether the browser is allowed to render a page in a *frame*, *iframe*, *embed* or *object*. + type: string + ForwardConfig: + description: Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. additionalProperties: false + type: object properties: TargetGroupStickinessConfig: + description: Information about the target group stickiness for a rule. $ref: '#/components/schemas/TargetGroupStickinessConfig' TargetGroups: - type: array uniqueItems: true + description: Information about how traffic will be distributed between multiple target groups in a forward rule. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/TargetGroupTuple' AuthenticateOidcConfig: - type: object + anyOf: + - required: + - ClientSecret + - required: + - UseExistingClientSecret + description: Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users. additionalProperties: false + type: object properties: OnUnauthenticatedRequest: + description: |- + The behavior if the user is not authenticated. The following are possible values: + + deny```` - Return an HTTP 401 Unauthorized error. + + allow```` - Allow the request to be forwarded to the target. + + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. type: string TokenEndpoint: + description: The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. type: string + UseExistingClientSecret: + description: Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. + type: boolean SessionTimeout: + description: The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). type: integer Scope: + description: |- + The set of user claims to be requested from the IdP. The default is ``openid``. + To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. type: string Issuer: + description: The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. type: string ClientSecret: + description: The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true. type: string UserInfoEndpoint: + description: The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. type: string ClientId: + description: The OAuth 2.0 client identifier. type: string AuthorizationEndpoint: + description: The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. type: string SessionCookieName: + description: The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. type: string - UseExistingClientSecret: - type: boolean AuthenticationRequestExtraParams: - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string + description: The query parameters (up to 10) to include in the redirect request to the authorization endpoint. + additionalProperties: false + type: object required: - TokenEndpoint - Issuer @@ -166,228 +664,349 @@ components: - ClientId - AuthorizationEndpoint Certificate: - type: object + description: Specifies an SSL server certificate to use as the default certificate for a secure listener. additionalProperties: false + type: object properties: CertificateArn: - type: string + anyOf: + - relationshipRef: + typeName: AWS::CertificateManager::Certificate + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::IAM::ServerCertificate + propertyPath: /properties/Arn description: The Amazon Resource Name (ARN) of the certificate. - description: Specifies an SSL server certificate to use as the default certificate for a secure listener. + type: string Listener: type: object properties: - SslPolicy: + ListenerArn: + description: '' type: string + MutualAuthentication: + description: The mutual authentication configuration information. + $ref: '#/components/schemas/MutualAuthentication' + ListenerAttributes: + x-arrayType: AttributeList + uniqueItems: true + description: The listener attributes. Attributes that you do not modify retain their current values. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ListenerAttribute' + AlpnPolicy: + description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' + type: array + items: + type: string + SslPolicy: description: |- - [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. - For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*. - LoadBalancerArn: + [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/describe-ssl-policies.html) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/describe-ssl-policies.html) in the *Network Load Balancers Guide*. + [HTTPS listeners] Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. To decrease the possibility of an interruption if your load balancer is handling a high volume of traffic, create an additional load balancer or request an LCU reservation. type: string + LoadBalancerArn: description: The Amazon Resource Name (ARN) of the load balancer. + type: string DefaultActions: - type: array uniqueItems: true - items: - $ref: '#/components/schemas/Action' description: |- The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). + type: array + items: + $ref: '#/components/schemas/Action' Port: + description: The port on which the load balancer is listening. You can't specify a port for a Gateway Load Balancer. type: integer - description: The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. Certificates: - type: array uniqueItems: true - items: - $ref: '#/components/schemas/Certificate' description: |- The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. + For an HTTPS listener, update requires some interruptions. For a TLS listener, update requires no interruption. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). - Protocol: - type: string - description: The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. - ListenerArn: - type: string - description: '' - AlpnPolicy: type: array items: - type: string - description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' - MutualAuthentication: - $ref: '#/components/schemas/MutualAuthentication' - description: The mutual authentication configuration information. + $ref: '#/components/schemas/Certificate' + Protocol: + description: The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer. + type: string required: - LoadBalancerArn - DefaultActions x-stackql-resource-name: listener - x-stackql-primaryIdentifier: + description: Specifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. + x-type-name: AWS::ElasticLoadBalancingV2::Listener + x-stackql-primary-identifier: - ListenerArn x-create-only-properties: - LoadBalancerArn + x-write-only-properties: + - DefaultActions/*/AuthenticateOidcConfig/ClientSecret x-read-only-properties: - ListenerArn + x-required-properties: + - LoadBalancerArn + - DefaultActions + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - elasticloadbalancing:DescribeListeners + - elasticloadbalancing:DescribeListenerAttributes create: - elasticloadbalancing:CreateListener - elasticloadbalancing:DescribeListeners - cognito-idp:DescribeUserPoolClient - delete: - - elasticloadbalancing:DeleteListener - - elasticloadbalancing:DescribeListeners - list: - - elasticloadbalancing:DescribeListeners - read: - - elasticloadbalancing:DescribeListeners + - elasticloadbalancing:ModifyListenerAttributes update: - elasticloadbalancing:ModifyListener - elasticloadbalancing:DescribeListeners - cognito-idp:DescribeUserPoolClient + - elasticloadbalancing:ModifyListenerAttributes + list: + - elasticloadbalancing:DescribeListeners + delete: + - elasticloadbalancing:DeleteListener + - elasticloadbalancing:DescribeListeners RuleCondition: - type: object + description: Specifies a condition for a listener rule. additionalProperties: false + type: object properties: Field: + description: |- + The field in the HTTP request. The following are the possible values: + + ``http-header`` + + ``http-request-method`` + + ``host-header`` + + ``path-pattern`` + + ``query-string`` + + ``source-ip`` type: string + HttpHeaderConfig: + description: Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``. + $ref: '#/components/schemas/HttpHeaderConfig' Values: - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string + description: |- + The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``. + If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. + + A-Z, a-z, 0-9 + + - . + + * (matches 0 or more characters) + + ? (matches exactly 1 character) + + If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. + + A-Z, a-z, 0-9 + + _ - . $ / ~ " ' @ : + + + & (using &) + + * (matches 0 or more characters) + + ? (matches exactly 1 character) + $ref: '#/components/schemas/ListOfStrings' + QueryStringConfig: + description: Information for a query string condition. Specify only when ``Field`` is ``query-string``. + $ref: '#/components/schemas/QueryStringConfig' + HostHeaderConfig: + description: Information for a host header condition. Specify only when ``Field`` is ``host-header``. + $ref: '#/components/schemas/HostHeaderConfig' HttpRequestMethodConfig: + description: Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``. $ref: '#/components/schemas/HttpRequestMethodConfig' PathPatternConfig: + description: Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``. $ref: '#/components/schemas/PathPatternConfig' - HttpHeaderConfig: - $ref: '#/components/schemas/HttpHeaderConfig' SourceIpConfig: + description: Information for a source IP condition. Specify only when ``Field`` is ``source-ip``. $ref: '#/components/schemas/SourceIpConfig' - HostHeaderConfig: - $ref: '#/components/schemas/HostHeaderConfig' - QueryStringConfig: - $ref: '#/components/schemas/QueryStringConfig' + ListOfStrings: + uniqueItems: true + x-insertionOrder: false + type: array + items: + type: string QueryStringConfig: - type: object + description: |- + Information about a query string condition. + The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded. additionalProperties: false + type: object properties: Values: - type: array uniqueItems: true + description: |- + The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\' character. + If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/QueryStringKeyValue' PathPatternConfig: - type: object + description: Information about a path pattern condition. additionalProperties: false + type: object properties: Values: - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string + description: |- + The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). + If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. + $ref: '#/components/schemas/ListOfStrings' HttpHeaderConfig: - type: object + description: |- + Information about an HTTP header condition. + There is a set of standard HTTP header fields. You can also define custom HTTP header fields. additionalProperties: false + type: object properties: Values: - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string + description: |- + The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). + If the same header appears multiple times in the request, we search them in order until a match is found. + If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string. + $ref: '#/components/schemas/ListOfStrings' HttpHeaderName: + description: The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. type: string QueryStringKeyValue: - type: object + description: Information about a key/value pair. additionalProperties: false + type: object properties: Value: + description: The value. type: string Key: + description: The key. You can omit the key. type: string HostHeaderConfig: - type: object + description: Information about a host header condition. additionalProperties: false + type: object properties: Values: - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string + description: |- + The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). You must include at least one "." character. You can include only alphabetical characters after the final "." character. + If you specify multiple strings, the condition is satisfied if one of the strings matches the host name. + $ref: '#/components/schemas/ListOfStrings' HttpRequestMethodConfig: - type: object + description: |- + Information about an HTTP method condition. + HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods. additionalProperties: false + type: object properties: Values: - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string + description: |- + The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. + If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. + $ref: '#/components/schemas/ListOfStrings' SourceIpConfig: - type: object + description: |- + Information about a source IP condition. + You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client. additionalProperties: false + type: object properties: Values: - type: array uniqueItems: true + description: |- + The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. + If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. x-insertionOrder: false + type: array items: type: string ListenerRule: type: object properties: ListenerArn: + description: The Amazon Resource Name (ARN) of the listener. type: string - RuleArn: - type: string + IsDefault: + description: '' + type: boolean Actions: - type: array uniqueItems: true + description: |- + The actions. + The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Action' Priority: + description: |- + The rule priority. A listener can't have multiple rules with the same priority. + If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update. type: integer + RuleArn: + description: '' + type: string Conditions: - type: array uniqueItems: true + description: |- + The conditions. + The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/RuleCondition' - IsDefault: - type: boolean required: - Actions - Priority - Conditions x-stackql-resource-name: listener_rule - x-stackql-primaryIdentifier: + description: |- + Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. + For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*. + x-type-name: AWS::ElasticLoadBalancingV2::ListenerRule + x-stackql-primary-identifier: - RuleArn x-create-only-properties: - ListenerArn + x-write-only-properties: + - Actions/*/AuthenticateOidcConfig/ClientSecret + - ListenerArn x-read-only-properties: - RuleArn - IsDefault + x-required-properties: + - Actions + - Priority + - Conditions + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - elasticloadbalancing:DescribeRules create: - elasticloadbalancing:CreateRule - elasticloadbalancing:DescribeRules - cognito-idp:DescribeUserPoolClient - delete: - - elasticloadbalancing:DeleteRule - - elasticloadbalancing:DescribeRules - list: - - elasticloadbalancing:DescribeRules - read: - - elasticloadbalancing:DescribeRules update: - elasticloadbalancing:ModifyRule - elasticloadbalancing:SetRulePriorities - elasticloadbalancing:DescribeRules + list: + - elasticloadbalancing:DescribeRules + delete: + - elasticloadbalancing:DeleteRule + - elasticloadbalancing:DescribeRules + MinimumLoadBalancerCapacity: + type: object + additionalProperties: false + properties: + CapacityUnits: + type: integer + description: The number of capacity units. + required: + - CapacityUnits + description: The minimum capacity for a load balancer. SubnetMapping: type: object additionalProperties: false @@ -404,6 +1023,9 @@ components: IPv6Address: type: string description: '[Network Load Balancers] The IPv6 address.' + SourceNatIpv6Prefix: + type: string + description: '[Network Load Balancers with UDP listeners] The IPv6 prefix to use for source NAT. Specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or ``auto_assigned`` to use an IPv6 prefix selected at random from the subnet CIDR block.' required: - SubnetId description: Specifies a subnet for a load balancer. @@ -419,12 +1041,37 @@ components: description: |- The name of the attribute. The following attributes are supported by all load balancers: - + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. - + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. + + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and can't be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: - + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. - + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and h + + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. + + ``zonal_shift.config.enabled`` - Indicates whether zonal shift is enabled. The possible values are ``true`` and ``false``. The default is ``false``. + + The following attributes are supported by only Application Load Balancers: + + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + + + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. + + The following attributes are supported by only Network Load Balancers: + + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity. description: Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer. Tag: type: object @@ -442,7 +1089,14 @@ components: properties: IpAddressType: type: string - description: The IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener. + description: |- + The IP address type. Internal load balancers must use ``ipv4``. + [Application Load Balancers] The possible values are ``ipv4`` (IPv4 addresses), ``dualstack`` (IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (public IPv6 addresses and private IPv4 and IPv6 addresses). + Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors. + [Network Load Balancers and Gateway Load Balancers] The possible values are ``ipv4`` (IPv4 addresses) and ``dualstack`` (IPv4 and IPv6 addresses). + EnablePrefixForIpv6SourceNat: + type: string + description: '[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be ``dualstack``. The default value is ``off``.' SecurityGroups: type: array description: '[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.' @@ -452,19 +1106,23 @@ components: type: string LoadBalancerAttributes: type: array - description: The load balancer attributes. + description: The load balancer attributes. Attributes that you do not modify retain their current values. uniqueItems: true x-insertionOrder: false x-arrayType: AttributeList items: $ref: '#/components/schemas/LoadBalancerAttribute' + MinimumLoadBalancerCapacity: + type: object + description: The minimum capacity for a load balancer. + $ref: '#/components/schemas/MinimumLoadBalancerCapacity' Scheme: type: string description: |- The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. - You cannot specify a scheme for a Gateway Load Balancer. + You can't specify a scheme for a Gateway Load Balancer. DNSName: type: string description: '' @@ -482,12 +1140,11 @@ components: Subnets: type: array description: |- - The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. + The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. - [Network Load Balancers] You can specify subnets from one or more Availability Zones. - [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. + [Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones. uniqueItems: true x-insertionOrder: false items: @@ -511,21 +1168,29 @@ components: SubnetMappings: type: array description: |- - The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. - [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. + The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. + [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. - [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP + [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets. uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/SubnetMapping' EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic: type: string - description: Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. + description: |- + Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. The default is ``on``. + You can't configure this property on a Network Load Balancer unless you associated a security group with the load balancer when you created it. + Ipv4IpamPoolId: + type: string + description: The ID of the IPv4 IPAM pool. x-stackql-resource-name: load_balancer - x-stackql-primaryIdentifier: + description: Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer. + x-type-name: AWS::ElasticLoadBalancingV2::LoadBalancer + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html + x-stackql-primary-identifier: - LoadBalancerArn x-create-only-properties: - Name @@ -537,12 +1202,23 @@ components: - CanonicalHostedZoneID - LoadBalancerArn - DNSName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticloadbalancing:AddTags + - elasticloadbalancing:DescribeTags + - elasticloadbalancing:RemoveTags x-required-permissions: create: - elasticloadbalancing:CreateLoadBalancer - elasticloadbalancing:DescribeLoadBalancers - elasticloadbalancing:ModifyLoadBalancerAttributes - elasticloadbalancing:AddTags + - ec2:DescribeIpamPools delete: - elasticloadbalancing:DescribeLoadBalancers - elasticloadbalancing:DeleteLoadBalancer @@ -551,140 +1227,145 @@ components: read: - elasticloadbalancing:DescribeLoadBalancers - elasticloadbalancing:DescribeLoadBalancerAttributes + - elasticloadbalancing:DescribeCapacityReservation - elasticloadbalancing:DescribeTags update: - elasticloadbalancing:ModifyLoadBalancerAttributes + - elasticloadbalancing:ModifyCapacityReservation - elasticloadbalancing:SetSubnets - elasticloadbalancing:SetIpAddressType + - elasticloadbalancing:ModifyIpPools - elasticloadbalancing:SetSecurityGroups - elasticloadbalancing:AddTags - elasticloadbalancing:RemoveTags Matcher: - type: object additionalProperties: false + type: object properties: GrpcCode: - type: string description: You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12. - HttpCode: type: string + HttpCode: description: 'For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. ' + type: string TargetDescription: - type: object additionalProperties: false + type: object properties: + Port: + description: The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function. + type: integer AvailabilityZone: - type: string description: An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. - Id: type: string + Id: description: 'The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. ' - Port: - type: integer - description: The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function. + type: string required: - Id TargetGroupAttribute: - type: object additionalProperties: false + type: object properties: Value: - type: string description: The name of the attribute. - Key: type: string + Key: description: The value of the attribute. + type: string TargetGroup: type: object properties: IpAddressType: - type: string description: 'The type of IP address used for this target group. The possible values are ipv4 and ipv6. ' + type: string + TargetGroupArn: + description: The ARN of the Target Group + type: string HealthCheckIntervalSeconds: - type: integer description: The approximate amount of time, in seconds, between health checks of an individual target. + type: integer LoadBalancerArns: - type: array - x-insertionOrder: false - description: The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group. uniqueItems: false + description: The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group. + x-insertionOrder: false + type: array items: type: string Matcher: - $ref: '#/components/schemas/Matcher' description: '[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.' + $ref: '#/components/schemas/Matcher' HealthCheckPath: - type: string description: '[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.' + type: string Port: - type: integer description: The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. + type: integer Targets: - type: array - description: The targets. uniqueItems: true + description: The targets. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/TargetDescription' HealthCheckEnabled: - type: boolean description: Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled. + type: boolean ProtocolVersion: - type: string description: '[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.' + type: string UnhealthyThresholdCount: - type: integer description: The number of consecutive health check failures required before considering a target unhealthy. - HealthCheckTimeoutSeconds: type: integer + HealthCheckTimeoutSeconds: description: The amount of time, in seconds, during which no response from a target means a failed health check. + type: integer Name: - type: string description: The name of the target group. - VpcId: type: string + VpcId: description: The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. - TargetGroupFullName: type: string + TargetGroupFullName: description: The full name of the target group. + type: string HealthyThresholdCount: - type: integer description: 'The number of consecutive health checks successes required before considering an unhealthy target healthy. ' + type: integer HealthCheckProtocol: - type: string description: 'The protocol the load balancer uses when performing health checks on targets. ' + type: string TargetGroupAttributes: - type: array x-arrayType: AttributeList - description: The attributes. uniqueItems: true + description: The attributes. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/TargetGroupAttribute' TargetType: - type: string description: The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. - HealthCheckPort: type: string + HealthCheckPort: description: 'The port the load balancer uses when performing health checks on targets. ' - TargetGroupArn: type: string - description: The ARN of the Target Group Protocol: - type: string description: The protocol to use for routing traffic to the targets. - TargetGroupName: type: string + TargetGroupName: description: The name of the target group. + type: string Tags: - type: array - description: The tags. uniqueItems: false + description: The tags. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: target_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup + x-type-name: AWS::ElasticLoadBalancingV2::TargetGroup + x-stackql-primary-identifier: - TargetGroupArn x-create-only-properties: - TargetType @@ -699,7 +1380,22 @@ components: - TargetGroupArn - TargetGroupName - TargetGroupFullName + x-tagging: + permissions: + - elasticloadbalancing:AddTags + - elasticloadbalancing:DescribeTags + - elasticloadbalancing:RemoveTags + taggable: true + tagOnCreate: false + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - elasticloadbalancing:DescribeTargetGroups + - elasticloadbalancing:DescribeTargetGroupAttributes + - elasticloadbalancing:DescribeTargetHealth + - elasticloadbalancing:DescribeTags create: - elasticloadbalancing:CreateTargetGroup - elasticloadbalancing:DescribeTargetGroups @@ -707,16 +1403,6 @@ components: - elasticloadbalancing:ModifyTargetGroupAttributes - elasticloadbalancing:DescribeTargetHealth - elasticloadbalancing:AddTags - delete: - - elasticloadbalancing:DeleteTargetGroup - - elasticloadbalancing:DescribeTargetGroups - list: - - elasticloadbalancing:DescribeTargetGroups - read: - - elasticloadbalancing:DescribeTargetGroups - - elasticloadbalancing:DescribeTargetGroupAttributes - - elasticloadbalancing:DescribeTargetHealth - - elasticloadbalancing:DescribeTags update: - elasticloadbalancing:DescribeTargetGroups - elasticloadbalancing:ModifyTargetGroup @@ -726,6 +1412,11 @@ components: - elasticloadbalancing:DeregisterTargets - elasticloadbalancing:AddTags - elasticloadbalancing:RemoveTags + list: + - elasticloadbalancing:DescribeTargetGroups + delete: + - elasticloadbalancing:DeleteTargetGroup + - elasticloadbalancing:DescribeTargetGroups TrustStore: type: object properties: @@ -758,14 +1449,31 @@ components: type: string description: The Amazon Resource Name (ARN) of the trust store. x-stackql-resource-name: trust_store - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStore + x-type-name: AWS::ElasticLoadBalancingV2::TrustStore + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststore.html + x-stackql-primary-identifier: - TrustStoreArn x-create-only-properties: - Name + x-write-only-properties: + - CaCertificatesBundleS3Bucket + - CaCertificatesBundleS3Key + - CaCertificatesBundleS3ObjectVersion x-read-only-properties: - TrustStoreArn - Status - NumberOfCaCertificates + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - elasticloadbalancing:AddTags + - elasticloadbalancing:DescribeTags + - elasticloadbalancing:RemoveTags x-required-permissions: create: - elasticloadbalancing:CreateTrustStore @@ -793,141 +1501,607 @@ components: type: string RevocationContent: type: object - additionalProperties: false + additionalProperties: false + properties: + S3Bucket: + type: string + S3Key: + type: string + S3ObjectVersion: + type: string + RevocationType: + type: string + TrustStoreRevocation: + type: object + properties: + RevocationContents: + type: array + description: The attributes required to create a trust store revocation. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/RevocationContent' + TrustStoreArn: + type: string + description: The Amazon Resource Name (ARN) of the trust store. + RevocationId: + type: integer + format: int64 + description: The ID associated with the revocation. + TrustStoreRevocations: + type: array + description: The data associated with a trust store revocation + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TrustStoreRevocation' + x-stackql-resource-name: trust_store_revocation + description: Resource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation + x-type-name: AWS::ElasticLoadBalancingV2::TrustStoreRevocation + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-truststorerevocation.html + x-stackql-primary-identifier: + - RevocationId + - TrustStoreArn + x-create-only-properties: + - TrustStoreArn + - RevocationContents + x-write-only-properties: + - RevocationContents + x-read-only-properties: + - RevocationId + - TrustStoreRevocations + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - elasticloadbalancing:AddTrustStoreRevocations + - elasticloadbalancing:DescribeTrustStoreRevocations + - s3:GetObject + - s3:GetObjectVersion + delete: + - elasticloadbalancing:DescribeTrustStoreRevocations + - elasticloadbalancing:RemoveTrustStoreRevocations + list: + - elasticloadbalancing:DescribeTrustStoreRevocations + read: + - elasticloadbalancing:DescribeTrustStoreRevocations + CreateListenerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ListenerArn: + description: '' + type: string + MutualAuthentication: + description: The mutual authentication configuration information. + $ref: '#/components/schemas/MutualAuthentication' + ListenerAttributes: + x-arrayType: AttributeList + uniqueItems: true + description: The listener attributes. Attributes that you do not modify retain their current values. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ListenerAttribute' + AlpnPolicy: + description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' + type: array + items: + type: string + SslPolicy: + description: |- + [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/describe-ssl-policies.html) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/describe-ssl-policies.html) in the *Network Load Balancers Guide*. + [HTTPS listeners] Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. To decrease the possibility of an interruption if your load balancer is handling a high volume of traffic, create an additional load balancer or request an LCU reservation. + type: string + LoadBalancerArn: + description: The Amazon Resource Name (ARN) of the load balancer. + type: string + DefaultActions: + uniqueItems: true + description: |- + The actions for the default rule. You cannot define a condition for a default rule. + To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). + type: array + items: + $ref: '#/components/schemas/Action' + Port: + description: The port on which the load balancer is listening. You can't specify a port for a Gateway Load Balancer. + type: integer + Certificates: + uniqueItems: true + description: |- + The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. + For an HTTPS listener, update requires some interruptions. For a TLS listener, update requires no interruption. + To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). + type: array + items: + $ref: '#/components/schemas/Certificate' + Protocol: + description: The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer. + type: string + x-stackQL-stringOnly: true + x-title: CreateListenerRequest + type: object + required: [] + CreateListenerRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ListenerArn: + description: The Amazon Resource Name (ARN) of the listener. + type: string + IsDefault: + description: '' + type: boolean + Actions: + uniqueItems: true + description: |- + The actions. + The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Action' + Priority: + description: |- + The rule priority. A listener can't have multiple rules with the same priority. + If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update. + type: integer + RuleArn: + description: '' + type: string + Conditions: + uniqueItems: true + description: |- + The conditions. + The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/RuleCondition' + x-stackQL-stringOnly: true + x-title: CreateListenerRuleRequest + type: object + required: [] + CreateLoadBalancerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpAddressType: + type: string + description: |- + The IP address type. Internal load balancers must use ``ipv4``. + [Application Load Balancers] The possible values are ``ipv4`` (IPv4 addresses), ``dualstack`` (IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (public IPv6 addresses and private IPv4 and IPv6 addresses). + Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors. + [Network Load Balancers and Gateway Load Balancers] The possible values are ``ipv4`` (IPv4 addresses) and ``dualstack`` (IPv4 and IPv6 addresses). + EnablePrefixForIpv6SourceNat: + type: string + description: '[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be ``dualstack``. The default value is ``off``.' + SecurityGroups: + type: array + description: '[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.' + uniqueItems: true + x-insertionOrder: false + items: + type: string + LoadBalancerAttributes: + type: array + description: The load balancer attributes. Attributes that you do not modify retain their current values. + uniqueItems: true + x-insertionOrder: false + x-arrayType: AttributeList + items: + $ref: '#/components/schemas/LoadBalancerAttribute' + MinimumLoadBalancerCapacity: + type: object + description: The minimum capacity for a load balancer. + $ref: '#/components/schemas/MinimumLoadBalancerCapacity' + Scheme: + type: string + description: |- + The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. + The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. + The default is an Internet-facing load balancer. + You can't specify a scheme for a Gateway Load Balancer. + DNSName: + type: string + description: '' + Name: + type: string + description: |- + The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". + If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. + LoadBalancerName: + type: string + description: '' + LoadBalancerFullName: + type: string + description: '' + Subnets: + type: array + description: |- + The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. + [Application Load Balancers] You must specify subnets from at least two Availability Zones. + [Application Load Balancers on Outposts] You must specify one Outpost subnet. + [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. + [Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones. + uniqueItems: true + x-insertionOrder: false + items: + type: string + Type: + type: string + description: The type of load balancer. The default is ``application``. + CanonicalHostedZoneID: + type: string + description: '' + Tags: + type: array + description: The tags to assign to the load balancer. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LoadBalancerArn: + type: string + description: '' + SubnetMappings: + type: array + description: |- + The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. + [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets. + [Application Load Balancers on Outposts] You must specify one Outpost subnet. + [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. + [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. + [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetMapping' + EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic: + type: string + description: |- + Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. The default is ``on``. + You can't configure this property on a Network Load Balancer unless you associated a security group with the load balancer when you created it. + Ipv4IpamPoolId: + type: string + description: The ID of the IPv4 IPAM pool. + x-stackQL-stringOnly: true + x-title: CreateLoadBalancerRequest + type: object + required: [] + CreateTargetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpAddressType: + description: 'The type of IP address used for this target group. The possible values are ipv4 and ipv6. ' + type: string + TargetGroupArn: + description: The ARN of the Target Group + type: string + HealthCheckIntervalSeconds: + description: The approximate amount of time, in seconds, between health checks of an individual target. + type: integer + LoadBalancerArns: + uniqueItems: false + description: The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group. + x-insertionOrder: false + type: array + items: + type: string + Matcher: + description: '[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.' + $ref: '#/components/schemas/Matcher' + HealthCheckPath: + description: '[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.' + type: string + Port: + description: The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. + type: integer + Targets: + uniqueItems: true + description: The targets. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TargetDescription' + HealthCheckEnabled: + description: Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled. + type: boolean + ProtocolVersion: + description: '[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.' + type: string + UnhealthyThresholdCount: + description: The number of consecutive health check failures required before considering a target unhealthy. + type: integer + HealthCheckTimeoutSeconds: + description: The amount of time, in seconds, during which no response from a target means a failed health check. + type: integer + Name: + description: The name of the target group. + type: string + VpcId: + description: The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. + type: string + TargetGroupFullName: + description: The full name of the target group. + type: string + HealthyThresholdCount: + description: 'The number of consecutive health checks successes required before considering an unhealthy target healthy. ' + type: integer + HealthCheckProtocol: + description: 'The protocol the load balancer uses when performing health checks on targets. ' + type: string + TargetGroupAttributes: + x-arrayType: AttributeList + uniqueItems: true + description: The attributes. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/TargetGroupAttribute' + TargetType: + description: The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. + type: string + HealthCheckPort: + description: 'The port the load balancer uses when performing health checks on targets. ' + type: string + Protocol: + description: The protocol to use for routing traffic to the targets. + type: string + TargetGroupName: + description: The name of the target group. + type: string + Tags: + uniqueItems: false + description: The tags. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTargetGroupRequest + type: object + required: [] + CreateTrustStoreRequest: properties: - S3Bucket: + ClientToken: type: string - S3Key: + RoleArn: type: string - S3ObjectVersion: + TypeName: type: string - RevocationType: + TypeVersionId: type: string - TrustStoreRevocation: + DesiredState: + type: object + properties: + Name: + type: string + description: The name of the trust store. + CaCertificatesBundleS3Bucket: + type: string + description: The name of the S3 bucket to fetch the CA certificate bundle from. + CaCertificatesBundleS3Key: + type: string + description: The name of the S3 object to fetch the CA certificate bundle from. + CaCertificatesBundleS3ObjectVersion: + type: string + description: The version of the S3 bucket that contains the CA certificate bundle. + Status: + type: string + description: The status of the trust store, could be either of ACTIVE or CREATING. + NumberOfCaCertificates: + type: integer + description: The number of certificates associated with the trust store. + Tags: + type: array + description: The tags to assign to the trust store. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + TrustStoreArn: + type: string + description: The Amazon Resource Name (ARN) of the trust store. + x-stackQL-stringOnly: true + x-title: CreateTrustStoreRequest type: object + required: [] + CreateTrustStoreRevocationRequest: properties: - RevocationContents: - type: array - description: The attributes required to create a trust store revocation. - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/RevocationContent' - TrustStoreArn: + ClientToken: type: string - description: The Amazon Resource Name (ARN) of the trust store. - RevocationId: - type: integer - format: int64 - description: The ID associated with the revocation. - TrustStoreRevocations: - type: array - description: The data associated with a trust store revocation - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/TrustStoreRevocation' - x-stackql-resource-name: trust_store_revocation - x-stackql-primaryIdentifier: - - RevocationId - - TrustStoreArn - x-create-only-properties: - - TrustStoreArn - - RevocationContents - x-read-only-properties: - - RevocationId - - TrustStoreRevocations - x-required-permissions: - create: - - elasticloadbalancing:AddTrustStoreRevocations - - elasticloadbalancing:DescribeTrustStoreRevocations - - s3:GetObject - - s3:GetObjectVersion - delete: - - elasticloadbalancing:DescribeTrustStoreRevocations - - elasticloadbalancing:RemoveTrustStoreRevocations - list: - - elasticloadbalancing:DescribeTrustStoreRevocations - read: - - elasticloadbalancing:DescribeTrustStoreRevocations + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RevocationContents: + type: array + description: The attributes required to create a trust store revocation. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/RevocationContent' + TrustStoreArn: + type: string + description: The Amazon Resource Name (ARN) of the trust store. + RevocationId: + type: integer + format: int64 + description: The ID associated with the revocation. + TrustStoreRevocations: + type: array + description: The data associated with a trust store revocation + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/TrustStoreRevocation' + x-stackQL-stringOnly: true + x-title: CreateTrustStoreRevocationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: listeners: name: listeners id: awscc.elasticloadbalancingv2.listeners x-cfn-schema-name: Listener - x-type: list - x-identifiers: - - ListenerArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' - AND region = 'us-east-1' - listener: - name: listener - id: awscc.elasticloadbalancingv2.listener - x-cfn-schema-name: Listener - x-type: get + x-cfn-type-name: AWS::ElasticLoadBalancingV2::Listener x-identifiers: - ListenerArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Listener&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/listeners/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn, + JSON_EXTRACT(Properties, '$.MutualAuthentication') as mutual_authentication, + JSON_EXTRACT(Properties, '$.ListenerAttributes') as listener_attributes, + JSON_EXTRACT(Properties, '$.AlpnPolicy') as alpn_policy, JSON_EXTRACT(Properties, '$.SslPolicy') as ssl_policy, JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn, JSON_EXTRACT(Properties, '$.DefaultActions') as default_actions, JSON_EXTRACT(Properties, '$.Port') as port, JSON_EXTRACT(Properties, '$.Certificates') as certificates, - JSON_EXTRACT(Properties, '$.Protocol') as protocol, - JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn, - JSON_EXTRACT(Properties, '$.AlpnPolicy') as alpn_policy, - JSON_EXTRACT(Properties, '$.MutualAuthentication') as mutual_authentication + JSON_EXTRACT(Properties, '$.Protocol') as protocol FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn, + json_extract_path_text(Properties, 'MutualAuthentication') as mutual_authentication, + json_extract_path_text(Properties, 'ListenerAttributes') as listener_attributes, + json_extract_path_text(Properties, 'AlpnPolicy') as alpn_policy, json_extract_path_text(Properties, 'SslPolicy') as ssl_policy, json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, json_extract_path_text(Properties, 'DefaultActions') as default_actions, json_extract_path_text(Properties, 'Port') as port, json_extract_path_text(Properties, 'Certificates') as certificates, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn, - json_extract_path_text(Properties, 'AlpnPolicy') as alpn_policy, - json_extract_path_text(Properties, 'MutualAuthentication') as mutual_authentication + json_extract_path_text(Properties, 'Protocol') as protocol FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' AND data__Identifier = '' AND region = 'us-east-1' - listener_rules: - name: listener_rules - id: awscc.elasticloadbalancingv2.listener_rules - x-cfn-schema-name: ListenerRule - x-type: list + listeners_list_only: + name: listeners_list_only + id: awscc.elasticloadbalancingv2.listeners_list_only + x-cfn-schema-name: Listener + x-cfn-type-name: AWS::ElasticLoadBalancingV2::Listener x-identifiers: - - RuleArn + - ListenerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -935,63 +2109,117 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' + JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RuleArn') as rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' + json_extract_path_text(Properties, 'ListenerArn') as listener_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' AND region = 'us-east-1' - listener_rule: - name: listener_rule - id: awscc.elasticloadbalancingv2.listener_rule + listener_rules: + name: listener_rules + id: awscc.elasticloadbalancingv2.listener_rules x-cfn-schema-name: ListenerRule - x-type: get + x-cfn-type-name: AWS::ElasticLoadBalancingV2::ListenerRule x-identifiers: - RuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ListenerRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::ListenerRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::ListenerRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::ListenerRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.IsDefault') as is_default, JSON_EXTRACT(Properties, '$.Actions') as actions, JSON_EXTRACT(Properties, '$.Priority') as priority, - JSON_EXTRACT(Properties, '$.Conditions') as conditions, - JSON_EXTRACT(Properties, '$.IsDefault') as is_default + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.Conditions') as conditions FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'ListenerArn') as listener_arn, - json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'IsDefault') as is_default, json_extract_path_text(Properties, 'Actions') as actions, json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'Conditions') as conditions, - json_extract_path_text(Properties, 'IsDefault') as is_default + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'Conditions') as conditions FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' AND data__Identifier = '' AND region = 'us-east-1' - load_balancers: - name: load_balancers - id: awscc.elasticloadbalancingv2.load_balancers - x-cfn-schema-name: LoadBalancer - x-type: list + listener_rules_list_only: + name: listener_rules_list_only + id: awscc.elasticloadbalancingv2.listener_rules_list_only + x-cfn-schema-name: ListenerRule + x-cfn-type-name: AWS::ElasticLoadBalancingV2::ListenerRule x-identifiers: - - LoadBalancerArn + - RuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -999,35 +2227,85 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' AND region = 'us-east-1' - load_balancer: - name: load_balancer - id: awscc.elasticloadbalancingv2.load_balancer + load_balancers: + name: load_balancers + id: awscc.elasticloadbalancingv2.load_balancers x-cfn-schema-name: LoadBalancer - x-type: get + x-cfn-type-name: AWS::ElasticLoadBalancingV2::LoadBalancer x-identifiers: - LoadBalancerArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LoadBalancer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::LoadBalancer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::LoadBalancer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::LoadBalancer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type, + JSON_EXTRACT(Properties, '$.EnablePrefixForIpv6SourceNat') as enable_prefix_for_ipv6_source_nat, JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, JSON_EXTRACT(Properties, '$.LoadBalancerAttributes') as load_balancer_attributes, + JSON_EXTRACT(Properties, '$.MinimumLoadBalancerCapacity') as minimum_load_balancer_capacity, JSON_EXTRACT(Properties, '$.Scheme') as scheme, JSON_EXTRACT(Properties, '$.DNSName') as dns_name, JSON_EXTRACT(Properties, '$.Name') as name, @@ -1039,19 +2317,22 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn, JSON_EXTRACT(Properties, '$.SubnetMappings') as subnet_mappings, - JSON_EXTRACT(Properties, '$.EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic') as enforce_security_group_inbound_rules_on_private_link_traffic + JSON_EXTRACT(Properties, '$.EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic') as enforce_security_group_inbound_rules_on_private_link_traffic, + JSON_EXTRACT(Properties, '$.Ipv4IpamPoolId') as ipv4_ipam_pool_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'EnablePrefixForIpv6SourceNat') as enable_prefix_for_ipv6_source_nat, json_extract_path_text(Properties, 'SecurityGroups') as security_groups, json_extract_path_text(Properties, 'LoadBalancerAttributes') as load_balancer_attributes, + json_extract_path_text(Properties, 'MinimumLoadBalancerCapacity') as minimum_load_balancer_capacity, json_extract_path_text(Properties, 'Scheme') as scheme, json_extract_path_text(Properties, 'DNSName') as dns_name, json_extract_path_text(Properties, 'Name') as name, @@ -1063,17 +2344,24 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, json_extract_path_text(Properties, 'SubnetMappings') as subnet_mappings, - json_extract_path_text(Properties, 'EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic') as enforce_security_group_inbound_rules_on_private_link_traffic + json_extract_path_text(Properties, 'EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic') as enforce_security_group_inbound_rules_on_private_link_traffic, + json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' AND data__Identifier = '' AND region = 'us-east-1' - target_groups: - name: target_groups - id: awscc.elasticloadbalancingv2.target_groups - x-cfn-schema-name: TargetGroup - x-type: list + load_balancers_list_only: + name: load_balancers_list_only + id: awscc.elasticloadbalancingv2.load_balancers_list_only + x-cfn-schema-name: LoadBalancer + x-cfn-type-name: AWS::ElasticLoadBalancingV2::LoadBalancer x-identifiers: - - TargetGroupArn + - LoadBalancerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1081,33 +2369,82 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' + JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' + json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' AND region = 'us-east-1' - target_group: - name: target_group - id: awscc.elasticloadbalancingv2.target_group + target_groups: + name: target_groups + id: awscc.elasticloadbalancingv2.target_groups x-cfn-schema-name: TargetGroup - x-type: get + x-cfn-type-name: AWS::ElasticLoadBalancingV2::TargetGroup x-identifiers: - TargetGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TargetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type, + JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn, JSON_EXTRACT(Properties, '$.HealthCheckIntervalSeconds') as health_check_interval_seconds, JSON_EXTRACT(Properties, '$.LoadBalancerArns') as load_balancer_arns, JSON_EXTRACT(Properties, '$.Matcher') as matcher, @@ -1126,7 +2463,6 @@ components: JSON_EXTRACT(Properties, '$.TargetGroupAttributes') as target_group_attributes, JSON_EXTRACT(Properties, '$.TargetType') as target_type, JSON_EXTRACT(Properties, '$.HealthCheckPort') as health_check_port, - JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn, JSON_EXTRACT(Properties, '$.Protocol') as protocol, JSON_EXTRACT(Properties, '$.TargetGroupName') as target_group_name, JSON_EXTRACT(Properties, '$.Tags') as tags @@ -1134,12 +2470,13 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn, json_extract_path_text(Properties, 'HealthCheckIntervalSeconds') as health_check_interval_seconds, json_extract_path_text(Properties, 'LoadBalancerArns') as load_balancer_arns, json_extract_path_text(Properties, 'Matcher') as matcher, @@ -1158,20 +2495,25 @@ components: json_extract_path_text(Properties, 'TargetGroupAttributes') as target_group_attributes, json_extract_path_text(Properties, 'TargetType') as target_type, json_extract_path_text(Properties, 'HealthCheckPort') as health_check_port, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn, json_extract_path_text(Properties, 'Protocol') as protocol, json_extract_path_text(Properties, 'TargetGroupName') as target_group_name, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' AND data__Identifier = '' AND region = 'us-east-1' - trust_stores: - name: trust_stores - id: awscc.elasticloadbalancingv2.trust_stores - x-cfn-schema-name: TrustStore - x-type: list + target_groups_list_only: + name: target_groups_list_only + id: awscc.elasticloadbalancingv2.target_groups_list_only + x-cfn-schema-name: TargetGroup + x-cfn-type-name: AWS::ElasticLoadBalancingV2::TargetGroup x-identifiers: - - TrustStoreArn + - TargetGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1179,28 +2521,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' + JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' AND region = 'us-east-1' - trust_store: - name: trust_store - id: awscc.elasticloadbalancingv2.trust_store + trust_stores: + name: trust_stores + id: awscc.elasticloadbalancingv2.trust_stores x-cfn-schema-name: TrustStore - x-type: get + x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStore x-identifiers: - TrustStoreArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrustStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TrustStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TrustStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TrustStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1217,7 +2607,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1233,14 +2623,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' AND data__Identifier = '' AND region = 'us-east-1' - trust_store_revocations: - name: trust_store_revocations - id: awscc.elasticloadbalancingv2.trust_store_revocations - x-cfn-schema-name: TrustStoreRevocation - x-type: list + trust_stores_list_only: + name: trust_stores_list_only + id: awscc.elasticloadbalancingv2.trust_stores_list_only + x-cfn-schema-name: TrustStore + x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStore x-identifiers: - - RevocationId - TrustStoreArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1248,31 +2643,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RevocationId') as revocation_id, JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RevocationId') as revocation_id, json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' AND region = 'us-east-1' - trust_store_revocation: - name: trust_store_revocation - id: awscc.elasticloadbalancingv2.trust_store_revocation + trust_store_revocations: + name: trust_store_revocations + id: awscc.elasticloadbalancingv2.trust_store_revocations x-cfn-schema-name: TrustStoreRevocation - x-type: get + x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStoreRevocation x-identifiers: - RevocationId - TrustStoreArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrustStoreRevocation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TrustStoreRevocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElasticLoadBalancingV2::TrustStoreRevocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_store_revocations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_store_revocations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1285,7 +2713,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1297,3 +2725,442 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' AND data__Identifier = '|' AND region = 'us-east-1' + trust_store_revocations_list_only: + name: trust_store_revocations_list_only + id: awscc.elasticloadbalancingv2.trust_store_revocations_list_only + x-cfn-schema-name: TrustStoreRevocation + x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStoreRevocation + x-identifiers: + - RevocationId + - TrustStoreArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RevocationId') as revocation_id, + JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RevocationId') as revocation_id, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Listener&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateListener + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateListenerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ListenerRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateListenerRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateListenerRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LoadBalancer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLoadBalancer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoadBalancerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TargetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTargetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTargetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrustStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrustStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrustStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrustStoreRevocation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrustStoreRevocation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrustStoreRevocationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/emr.yaml b/providers/src/awscc/v00.00.00000/services/emr.yaml index e160ddc3..0cae502b 100644 --- a/providers/src/awscc/v00.00.00000/services/emr.yaml +++ b/providers/src/awscc/v00.00.00000/services/emr.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EMR - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: SecurityConfiguration: type: object @@ -17,11 +397,17 @@ components: required: - SecurityConfiguration x-stackql-resource-name: security_configuration - x-stackql-primaryIdentifier: + description: Use a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS. + x-type-name: AWS::EMR::SecurityConfiguration + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - SecurityConfiguration + x-required-properties: + - SecurityConfiguration + x-tagging: + taggable: false x-required-permissions: create: - elasticmapreduce:CreateSecurityConfiguration @@ -84,7 +470,9 @@ components: - ActionOnFailure - Name x-stackql-resource-name: step - x-stackql-primaryIdentifier: + description: Schema for AWS::EMR::Step + x-type-name: AWS::EMR::Step + x-stackql-primary-identifier: - Id x-create-only-properties: - JobFlowId @@ -93,17 +481,25 @@ components: - ActionOnFailure x-read-only-properties: - Id + x-required-properties: + - JobFlowId + - HadoopJarStep + - ActionOnFailure + - Name + x-tagging: + taggable: false x-required-permissions: create: - emr:AddJobFlowSteps delete: [] + read: [] SubnetId: description: Identifier of a subnet type: string pattern: ^(subnet-[a-f0-9]{13})|(subnet-[a-f0-9]{8})\Z Arn: type: string - pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + pattern: ^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ Tags: type: array x-insertionOrder: false @@ -234,7 +630,10 @@ components: - WorkspaceSecurityGroupId - DefaultS3Location x-stackql-resource-name: studio - x-stackql-primaryIdentifier: + description: Resource schema for AWS::EMR::Studio + x-type-name: AWS::EMR::Studio + x-documentation-url: https://docs.aws.amazon.com/emr/latest/APIReference/API_CreateStudio.html + x-stackql-primary-identifier: - StudioId x-create-only-properties: - AuthMode @@ -251,6 +650,24 @@ components: - StudioId - Arn - Url + x-required-properties: + - AuthMode + - EngineSecurityGroupId + - Name + - ServiceRole + - SubnetIds + - VpcId + - WorkspaceSecurityGroupId + - DefaultS3Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - elasticmapreduce:AddTags + - elasticmapreduce:RemoveTags x-required-permissions: create: - elasticmapreduce:CreateStudio @@ -275,7 +692,7 @@ components: - elasticmapreduce:ListStudios IamPolicyArn: type: string - pattern: ^arn:aws(-(cn|us-gov))?:iam::([0-9]{12})?:policy\/[^.]+$ + pattern: ^arn:aws(-(cn|us-gov|iso-f|iso-e))?:iam::([0-9]{12})?:policy\/[^.]+$ StudioSessionMapping: type: object properties: @@ -303,7 +720,10 @@ components: - IdentityType - SessionPolicyArn x-stackql-resource-name: studio_session_mapping - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::EMR::StudioSessionMapping + x-documentation-url: https://docs.aws.amazon.com/cli/latest/reference/emr/create-studio-session-mapping.html + x-stackql-primary-identifier: - StudioId - IdentityType - IdentityName @@ -311,6 +731,16 @@ components: - StudioId - IdentityType - IdentityName + x-required-properties: + - StudioId + - IdentityName + - IdentityType + - SessionPolicyArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - elasticmapreduce:CreateStudioSessionMapping @@ -318,10 +748,28 @@ components: - sso-directory:SearchGroups - sso-directory:DescribeUser - sso-directory:DescribeGroup + - sso:GetManagedApplicationInstance - sso:ListDirectoryAssociations - sso:GetProfile - sso:ListProfiles - sso:AssociateProfile + - sso:CreateApplication + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + - sso:PutApplicationAccessScope + - sso:PutApplicationAssignmentConfiguration + - sso:DescribeApplication + - sso:DeleteApplication + - sso:DeleteApplicationAuthenticationMethod + - sso:DeleteApplicationAccessScope + - sso:DeleteApplicationGrant + - sso:ListInstances + - sso-directory:CreateUser + - sso-directory:CreateGroup + - sso:CreateApplicationAssignment + - sso:DescribeInstance + - sso:DeleteApplicationAssignment + - sso:ListApplicationAssignments read: - elasticmapreduce:GetStudioSessionMapping - sso-directory:SearchUsers @@ -371,10 +819,22 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: wal_workspace - x-stackql-primaryIdentifier: + description: Resource schema for AWS::EMR::WALWorkspace Type + x-type-name: AWS::EMR::WALWorkspace + x-stackql-primary-identifier: - WALWorkspaceName x-create-only-properties: - WALWorkspaceName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - emrwal:TagResource + - emrwal:UntagResource + - emrwal:ListTagsForResource x-required-permissions: create: - emrwal:CreateWorkspace @@ -390,43 +850,290 @@ components: - emrwal:TagResource - emrwal:UntagResource - emrwal:ListTagsForResource + CreateSecurityConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the security configuration. + type: string + SecurityConfiguration: + description: The security configuration details in JSON format. + type: object + x-stackQL-stringOnly: true + x-title: CreateSecurityConfigurationRequest + type: object + required: [] + CreateStepRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: ID generated by service + type: string + ActionOnFailure: + description: This specifies what action to take when the cluster step fails. Possible values are CANCEL_AND_WAIT and CONTINUE. + type: string + HadoopJarStep: + description: The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps. + $ref: '#/components/schemas/HadoopJarStepConfig' + JobFlowId: + description: A string that uniquely identifies the cluster (job flow). + type: string + Name: + description: The name of the cluster step. + type: string + x-stackQL-stringOnly: true + x-title: CreateStepRequest + type: object + required: [] + CreateStudioRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the EMR Studio. + $ref: '#/components/schemas/Arn' + AuthMode: + type: string + description: Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication. + enum: + - SSO + - IAM + DefaultS3Location: + description: The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace. + type: string + minLength: 6 + maxLength: 10280 + pattern: ^s3://.* + Description: + description: A detailed description of the Studio. + type: string + minLength: 0 + maxLength: 256 + EngineSecurityGroupId: + description: The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId. + type: string + minLength: 4 + maxLength: 256 + pattern: ^sg-[a-zA-Z0-9\-._]+$ + Name: + description: A descriptive name for the Amazon EMR Studio. + type: string + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z0-9_-]+' + ServiceRole: + description: The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services. + $ref: '#/components/schemas/Arn' + StudioId: + description: The ID of the EMR Studio. + type: string + pattern: ^es-[0-9A-Z]+ + minLength: 4 + maxLength: 256 + SubnetIds: + description: A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/SubnetId' + Tags: + description: A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters. + $ref: '#/components/schemas/Tags' + Url: + description: The unique Studio access URL. + type: string + pattern: ^https://[0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$ + maxLength: 4096 + UserRole: + description: The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies. + $ref: '#/components/schemas/Arn' + VpcId: + description: The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. + type: string + pattern: ^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$ + WorkspaceSecurityGroupId: + description: The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId. + type: string + pattern: ^sg-[a-zA-Z0-9\-._]+$ + IdpAuthUrl: + description: Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL. + type: string + pattern: ^https://[0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$ + maxLength: 4096 + IdpRelayStateParameterName: + description: The name of relay state parameter for external Identity Provider. + type: string + minLength: 0 + maxLength: 256 + TrustedIdentityPropagationEnabled: + description: A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false. + type: boolean + IdcUserAssignment: + description: Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio. + type: string + enum: + - REQUIRED + - OPTIONAL + IdcInstanceArn: + description: The ARN of the IAM Identity Center instance to create the Studio application. + type: string + minLength: 20 + maxLength: 2048 + EncryptionKeyArn: + description: The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3. + $ref: '#/components/schemas/Arn' + x-stackQL-stringOnly: true + x-title: CreateStudioRequest + type: object + required: [] + CreateStudioSessionMappingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdentityName: + type: string + description: The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified. + IdentityType: + type: string + description: Specifies whether the identity to map to the Studio is a user or a group. + enum: + - USER + - GROUP + SessionPolicyArn: + description: The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles. + $ref: '#/components/schemas/IamPolicyArn' + StudioId: + description: The ID of the Amazon EMR Studio to which the user or group will be mapped. + type: string + pattern: ^es-[0-9A-Z]+ + minLength: 4 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateStudioSessionMappingRequest + type: object + required: [] + CreateWALWorkspaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WALWorkspaceName: + description: The name of the emrwal container + type: string + minLength: 1 + maxLength: 32 + pattern: ^[a-zA-Z0-9]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateWALWorkspaceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: security_configurations: name: security_configurations id: awscc.emr.security_configurations x-cfn-schema-name: SecurityConfiguration - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' - AND region = 'us-east-1' - security_configuration: - name: security_configuration - id: awscc.emr.security_configuration - x-cfn-schema-name: SecurityConfiguration - x-type: get + x-cfn-type-name: AWS::EMR::SecurityConfiguration x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::SecurityConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::SecurityConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_configurations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -437,7 +1144,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -447,13 +1154,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - studios: - name: studios - id: awscc.emr.studios - x-cfn-schema-name: Studio - x-type: list + security_configurations_list_only: + name: security_configurations_list_only + id: awscc.emr.security_configurations_list_only + x-cfn-schema-name: SecurityConfiguration + x-cfn-type-name: AWS::EMR::SecurityConfiguration x-identifiers: - - StudioId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -461,28 +1174,105 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' AND region = 'us-east-1' - studio: - name: studio - id: awscc.emr.studio + steps: + name: steps + id: awscc.emr.steps + x-cfn-schema-name: Step + x-cfn-type-name: AWS::EMR::Step + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Step&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::Step" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/steps/methods/create_resource' + delete: [] + update: [] + studios: + name: studios + id: awscc.emr.studios x-cfn-schema-name: Studio - x-type: get + x-cfn-type-name: AWS::EMR::Studio x-identifiers: - StudioId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Studio&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::Studio" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::Studio" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::Studio" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studios/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studios/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/studios/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -511,7 +1301,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -539,15 +1329,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::Studio' AND data__Identifier = '' AND region = 'us-east-1' - studio_session_mappings: - name: studio_session_mappings - id: awscc.emr.studio_session_mappings - x-cfn-schema-name: StudioSessionMapping - x-type: list + studios_list_only: + name: studios_list_only + id: awscc.emr.studios_list_only + x-cfn-schema-name: Studio + x-cfn-type-name: AWS::EMR::Studio x-identifiers: - StudioId - - IdentityType - - IdentityName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -555,34 +1349,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.IdentityType') as identity_type, - JSON_EXTRACT(Properties, '$.IdentityName') as identity_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' + JSON_EXTRACT(Properties, '$.StudioId') as studio_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'IdentityType') as identity_type, - json_extract_path_text(Properties, 'IdentityName') as identity_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' + json_extract_path_text(Properties, 'StudioId') as studio_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' AND region = 'us-east-1' - studio_session_mapping: - name: studio_session_mapping - id: awscc.emr.studio_session_mapping + studio_session_mappings: + name: studio_session_mappings + id: awscc.emr.studio_session_mappings x-cfn-schema-name: StudioSessionMapping - x-type: get + x-cfn-type-name: AWS::EMR::StudioSessionMapping x-identifiers: - StudioId - IdentityType - IdentityName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StudioSessionMapping&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::StudioSessionMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::StudioSessionMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::StudioSessionMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -595,7 +1433,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -607,13 +1445,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' AND data__Identifier = '||' AND region = 'us-east-1' - wal_workspaces: - name: wal_workspaces - id: awscc.emr.wal_workspaces - x-cfn-schema-name: WALWorkspace - x-type: list + studio_session_mappings_list_only: + name: studio_session_mappings_list_only + id: awscc.emr.studio_session_mappings_list_only + x-cfn-schema-name: StudioSessionMapping + x-cfn-type-name: AWS::EMR::StudioSessionMapping x-identifiers: - - WALWorkspaceName + - StudioId + - IdentityType + - IdentityName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -621,28 +1467,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.WALWorkspaceName') as wal_workspace_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' + JSON_EXTRACT(Properties, '$.StudioId') as studio_id, + JSON_EXTRACT(Properties, '$.IdentityType') as identity_type, + JSON_EXTRACT(Properties, '$.IdentityName') as identity_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'WALWorkspaceName') as wal_workspace_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'IdentityType') as identity_type, + json_extract_path_text(Properties, 'IdentityName') as identity_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' AND region = 'us-east-1' - wal_workspace: - name: wal_workspace - id: awscc.emr.wal_workspace + wal_workspaces: + name: wal_workspaces + id: awscc.emr.wal_workspaces x-cfn-schema-name: WALWorkspace - x-type: get + x-cfn-type-name: AWS::EMR::WALWorkspace x-identifiers: - WALWorkspaceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WALWorkspace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::WALWorkspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::WALWorkspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMR::WALWorkspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -653,7 +1551,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -663,3 +1561,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::WALWorkspace' AND data__Identifier = '' AND region = 'us-east-1' + wal_workspaces_list_only: + name: wal_workspaces_list_only + id: awscc.emr.wal_workspaces_list_only + x-cfn-schema-name: WALWorkspace + x-cfn-type-name: AWS::EMR::WALWorkspace + x-identifiers: + - WALWorkspaceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WALWorkspaceName') as wal_workspace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WALWorkspaceName') as wal_workspace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Step&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStep + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStepRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Studio&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStudio + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStudioRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StudioSessionMapping&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStudioSessionMapping + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStudioSessionMappingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WALWorkspace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWALWorkspace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWALWorkspaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/emrcontainers.yaml b/providers/src/awscc/v00.00.00000/services/emrcontainers.yaml index feacd47e..cc6715a8 100644 --- a/providers/src/awscc/v00.00.00000/services/emrcontainers.yaml +++ b/providers/src/awscc/v00.00.00000/services/emrcontainers.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EMRContainers - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ContainerProvider: type: object @@ -83,11 +463,19 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/Tag' + SecurityConfigurationId: + description: The ID of the security configuration. + type: string + minLength: 1 + maxLength: 64 + pattern: '[0-9a-z]+' required: - Name - ContainerProvider x-stackql-resource-name: virtual_cluster - x-stackql-primaryIdentifier: + description: Resource Schema of AWS::EMRContainers::VirtualCluster Type + x-type-name: AWS::EMRContainers::VirtualCluster + x-stackql-primary-identifier: - Id x-create-only-properties: - ContainerProvider @@ -95,6 +483,18 @@ components: x-read-only-properties: - Arn - Id + x-required-properties: + - Name + - ContainerProvider + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - emr-containers:TagResource + - emr-containers:UntagResource x-required-permissions: create: - emr-containers:CreateVirtualCluster @@ -104,6 +504,7 @@ components: - emr-containers:DescribeVirtualCluster delete: - emr-containers:DeleteVirtualCluster + - emr-containers:DescribeVirtualCluster list: - emr-containers:ListVirtualClusters update: @@ -111,39 +512,160 @@ components: - emr-containers:ListTagsForResource - emr-containers:TagResource - emr-containers:UntagResource + CreateVirtualClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + ContainerProvider: + description: Container provider of the virtual cluster. + $ref: '#/components/schemas/ContainerProvider' + Id: + description: Id of the virtual cluster. + type: string + minLength: 1 + maxLength: 64 + Name: + description: Name of the virtual cluster. + type: string + minLength: 1 + maxLength: 64 + pattern: '[\.\-_/#A-Za-z0-9]+' + Tags: + description: An array of key-value pairs to apply to this virtual cluster. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SecurityConfigurationId: + description: The ID of the security configuration. + type: string + minLength: 1 + maxLength: 64 + pattern: '[0-9a-z]+' + x-stackQL-stringOnly: true + x-title: CreateVirtualClusterRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: virtual_clusters: name: virtual_clusters id: awscc.emrcontainers.virtual_clusters x-cfn-schema-name: VirtualCluster - x-type: list + x-cfn-type-name: AWS::EMRContainers::VirtualCluster x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VirtualCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMRContainers::VirtualCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMRContainers::VirtualCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMRContainers::VirtualCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ContainerProvider') as container_provider, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.SecurityConfigurationId') as security_configuration_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ContainerProvider') as container_provider, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SecurityConfigurationId') as security_configuration_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' + AND data__Identifier = '' AND region = 'us-east-1' - virtual_cluster: - name: virtual_cluster - id: awscc.emrcontainers.virtual_cluster + virtual_clusters_list_only: + name: virtual_clusters_list_only + id: awscc.emrcontainers.virtual_clusters_list_only x-cfn-schema-name: VirtualCluster - x-type: get + x-cfn-type-name: AWS::EMRContainers::VirtualCluster x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -151,26 +673,209 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.ContainerProvider') as container_provider, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ContainerProvider') as container_provider, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VirtualCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVirtualCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVirtualClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/emrserverless.yaml b/providers/src/awscc/v00.00.00000/services/emrserverless.yaml index b670391b..a46e31fa 100644 --- a/providers/src/awscc/v00.00.00000/services/emrserverless.yaml +++ b/providers/src/awscc/v00.00.00000/services/emrserverless.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EMRServerless - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Architecture: description: The cpu architecture of an application. @@ -22,6 +402,29 @@ components: pattern: ^([a-z0-9]+[a-z0-9-.]*)\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$ description: The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration. additionalProperties: false + InteractiveConfiguration: + additionalProperties: false + type: object + properties: + LivyEndpointEnabled: + description: Enables an Apache Livy endpoint that you can connect to and run interactive jobs + type: boolean + default: false + StudioEnabled: + description: Enabled you to connect an Application to Amazon EMR Studio to run interactive workloads in a notebook + type: boolean + default: false + IdentityCenterConfiguration: + description: The IAM IdentityCenter configuration for trusted-identity-propagation on this application. Supported with release labels emr-7.8.0 and above. + additionalProperties: false + type: object + properties: + IdentityCenterInstanceArn: + description: The IAM IdentityCenter instance arn + type: string + maxLength: 1024 + minLength: 1 + pattern: ^arn:(aws[a-zA-Z0-9-]*):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ ConfigurationList: type: array description: Runtime configuration for batch and interactive JobRun. @@ -29,6 +432,17 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/ConfigurationObject' + SchedulerConfiguration: + type: object + description: The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above. + additionalProperties: false + properties: + QueueTimeoutMinutes: + description: The maximum duration in minutes for the job in QUEUED state. If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720. + type: integer + MaxConcurrentRuns: + description: The maximum concurrent job runs on this application. If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000. + type: integer MonitoringConfiguration: type: object description: Monitoring configuration for batch and interactive JobRun. @@ -43,6 +457,9 @@ components: CloudWatchLoggingConfiguration: description: CloudWatch logging configurations for a JobRun. $ref: '#/components/schemas/CloudWatchLoggingConfiguration' + PrometheusMonitoringConfiguration: + description: Prometheus monitoring configurations for a JobRun. + $ref: '#/components/schemas/PrometheusMonitoringConfiguration' S3MonitoringConfiguration: additionalProperties: false properties: @@ -84,6 +501,12 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/LogTypeMapKeyValuePair' + PrometheusMonitoringConfiguration: + additionalProperties: false + properties: + RemoteWriteUrl: + description: The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to. + $ref: '#/components/schemas/RemoteWriteUrl' LogTypeMapKeyValuePair: type: object additionalProperties: false @@ -153,6 +576,9 @@ components: Disk: description: Per worker Disk resource. GB is the only supported unit and specifying GB is optional $ref: '#/components/schemas/DiskSize' + DiskType: + description: Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional + $ref: '#/components/schemas/DiskType' required: - Cpu - Memory @@ -235,6 +661,11 @@ components: maxLength: 10280 minLength: 1 pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\r\n\t]*' + RemoteWriteUrl: + type: string + maxLength: 10280 + minLength: 1 + pattern: ^https://aps-workspaces.([a-z]{2}-[a-z-]{1,20}-[1-9]).amazonaws(.[0-9A-Za-z]{2,4})+/workspaces/[-_.0-9A-Za-z]{1,100}/api/v1/remote_write$ EncryptionKeyArn: type: string maxLength: 2048 @@ -335,6 +766,10 @@ components: minLength: 1 maxLength: 15 pattern: ^[1-9][0-9]*(\s)?(GB|gb|gB|Gb)$ + DiskType: + description: Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional + type: string + pattern: ^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$ WorkerTypeSpecificationInput: type: object description: The specifications for a worker type. @@ -393,12 +828,15 @@ components: $ref: '#/components/schemas/MonitoringConfiguration' RuntimeConfiguration: $ref: '#/components/schemas/ConfigurationList' + InteractiveConfiguration: + $ref: '#/components/schemas/InteractiveConfiguration' NetworkConfiguration: description: Network Configuration for customer VPC connectivity. $ref: '#/components/schemas/NetworkConfiguration' Arn: description: The Amazon Resource Name (ARN) of the EMR Serverless Application. type: string + pattern: ^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\d{12}):\/applications\/[0-9a-zA-Z]+$ ApplicationId: description: The ID of the EMR Serverless Application. type: string @@ -407,30 +845,74 @@ components: WorkerTypeSpecifications: description: The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types. $ref: '#/components/schemas/WorkerTypeSpecificationInputMap' + SchedulerConfiguration: + description: The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above. + $ref: '#/components/schemas/SchedulerConfiguration' + IdentityCenterConfiguration: + description: The IAM IdentityCenter configuration for trusted-identity-propagation on this application. Supported with release labels emr-7.8.0 and above. + $ref: '#/components/schemas/IdentityCenterConfiguration' required: - ReleaseLabel - Type x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Resource schema for AWS::EMRServerless::Application Type + x-type-name: AWS::EMRServerless::Application + x-stackql-primary-identifier: - ApplicationId x-create-only-properties: - Name - Type + x-conditional-create-only-properties: + - Architecture + - ReleaseLabel + - WorkerTypeSpecifications + - MaximumCapacity + - InitialCapacity + - AutoStartConfiguration + - AutoStopConfiguration + - NetworkConfiguration + - ImageConfiguration + - MonitoringConfiguration + - RuntimeConfiguration + - InteractiveConfiguration + - SchedulerConfiguration x-read-only-properties: - Arn - ApplicationId + x-required-properties: + - ReleaseLabel + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - emr-serverless:TagResource + - emr-serverless:UntagResource + - kms:TagResource + - kms:UntagResource x-required-permissions: create: - - kms:Create* - - kms:Describe* - - kms:Enable* - - kms:List* - - kms:Put* - - kms:Update* - - kms:Revoke* - - kms:Disable* - - kms:Get* - - kms:Delete* + - kms:CreateKey + - kms:CreateAlias + - kms:DescribeKey + - kms:EnableKey + - kms:ListGrants + - kms:ListAliases + - kms:ListKeyPolicies + - kms:ListKeys + - kms:PutKeyPolicy + - kms:UpdateKeyDescription + - kms:UpdateAlias + - kms:UpdatePrimaryRegion + - kms:RevokeGrant + - kms:DisableKey + - kms:DisableKeyRotation + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:DeleteAlias - kms:ScheduleKeyDeletion - kms:CancelKeyDeletion - kms:GenerateDataKey @@ -445,6 +927,13 @@ components: - ecr:BatchGetImage - ecr:DescribeImages - ecr:GetDownloadUrlForLayer + - sso:DescribeInstance + - sso:CreateApplication + - sso:DeleteApplication + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationAssignmentConfiguration + - sso:PutApplicationGrant + - sso:PutApplicationAccessScope read: - emr-serverless:GetApplication update: @@ -456,16 +945,24 @@ components: - ecr:BatchGetImage - ecr:DescribeImages - ecr:GetDownloadUrlForLayer - - kms:Create* - - kms:Describe* - - kms:Enable* - - kms:List* - - kms:Put* - - kms:Update* - - kms:Revoke* - - kms:Disable* - - kms:Get* - - kms:Delete* + - kms:CreateKey + - kms:CreateAlias + - kms:DescribeKey + - kms:EnableKey + - kms:ListGrants + - kms:ListAliases + - kms:ListKeyPolicies + - kms:ListKeys + - kms:PutKeyPolicy + - kms:UpdateKeyDescription + - kms:UpdateAlias + - kms:UpdatePrimaryRegion + - kms:RevokeGrant + - kms:DisableKey + - kms:DisableKeyRotation + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:DeleteAlias - kms:ScheduleKeyDeletion - kms:CancelKeyDeletion - kms:GenerateDataKey @@ -475,45 +972,158 @@ components: delete: - emr-serverless:DeleteApplication - emr-serverless:GetApplication + - sso:DeleteApplication list: - emr-serverless:ListApplications + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Architecture: + $ref: '#/components/schemas/Architecture' + Name: + description: User friendly Application name. + type: string + minLength: 1 + maxLength: 64 + pattern: ^[A-Za-z0-9._\/#-]+$ + ReleaseLabel: + description: EMR release label. + type: string + minLength: 1 + maxLength: 64 + pattern: ^[A-Za-z0-9._/-]+$ + Type: + description: The type of the application + type: string + InitialCapacity: + description: Initial capacity initialized when an Application is started. + $ref: '#/components/schemas/InitialCapacityConfigMap' + MaximumCapacity: + description: Maximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit. + $ref: '#/components/schemas/MaximumAllowedResources' + Tags: + description: Tag map with key and value + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AutoStartConfiguration: + description: Configuration for Auto Start of Application. + $ref: '#/components/schemas/AutoStartConfiguration' + AutoStopConfiguration: + description: Configuration for Auto Stop of Application. + $ref: '#/components/schemas/AutoStopConfiguration' + ImageConfiguration: + $ref: '#/components/schemas/ImageConfigurationInput' + MonitoringConfiguration: + $ref: '#/components/schemas/MonitoringConfiguration' + RuntimeConfiguration: + $ref: '#/components/schemas/ConfigurationList' + InteractiveConfiguration: + $ref: '#/components/schemas/InteractiveConfiguration' + NetworkConfiguration: + description: Network Configuration for customer VPC connectivity. + $ref: '#/components/schemas/NetworkConfiguration' + Arn: + description: The Amazon Resource Name (ARN) of the EMR Serverless Application. + type: string + pattern: ^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\d{12}):\/applications\/[0-9a-zA-Z]+$ + ApplicationId: + description: The ID of the EMR Serverless Application. + type: string + minLength: 1 + maxLength: 64 + WorkerTypeSpecifications: + description: The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types. + $ref: '#/components/schemas/WorkerTypeSpecificationInputMap' + SchedulerConfiguration: + description: The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above. + $ref: '#/components/schemas/SchedulerConfiguration' + IdentityCenterConfiguration: + description: The IAM IdentityCenter configuration for trusted-identity-propagation on this application. Supported with release labels emr-7.8.0 and above. + $ref: '#/components/schemas/IdentityCenterConfiguration' + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.emrserverless.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.emrserverless.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::EMRServerless::Application x-identifiers: - ApplicationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMRServerless::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMRServerless::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EMRServerless::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -530,15 +1140,18 @@ components: JSON_EXTRACT(Properties, '$.ImageConfiguration') as image_configuration, JSON_EXTRACT(Properties, '$.MonitoringConfiguration') as monitoring_configuration, JSON_EXTRACT(Properties, '$.RuntimeConfiguration') as runtime_configuration, + JSON_EXTRACT(Properties, '$.InteractiveConfiguration') as interactive_configuration, JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.WorkerTypeSpecifications') as worker_type_specifications + JSON_EXTRACT(Properties, '$.WorkerTypeSpecifications') as worker_type_specifications, + JSON_EXTRACT(Properties, '$.SchedulerConfiguration') as scheduler_configuration, + JSON_EXTRACT(Properties, '$.IdentityCenterConfiguration') as identity_center_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMRServerless::Application' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -555,10 +1168,239 @@ components: json_extract_path_text(Properties, 'ImageConfiguration') as image_configuration, json_extract_path_text(Properties, 'MonitoringConfiguration') as monitoring_configuration, json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, + json_extract_path_text(Properties, 'InteractiveConfiguration') as interactive_configuration, json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'WorkerTypeSpecifications') as worker_type_specifications + json_extract_path_text(Properties, 'WorkerTypeSpecifications') as worker_type_specifications, + json_extract_path_text(Properties, 'SchedulerConfiguration') as scheduler_configuration, + json_extract_path_text(Properties, 'IdentityCenterConfiguration') as identity_center_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EMRServerless::Application' AND data__Identifier = '' AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.emrserverless.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::EMRServerless::Application + x-identifiers: + - ApplicationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/entityresolution.yaml b/providers/src/awscc/v00.00.00000/services/entityresolution.yaml index b156b1ff..2ee00fcf 100644 --- a/providers/src/awscc/v00.00.00000/services/entityresolution.yaml +++ b/providers/src/awscc/v00.00.00000/services/entityresolution.yaml @@ -1,77 +1,494 @@ openapi: 3.0.0 info: title: EntityResolution - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - EntityName: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' type: string - pattern: ^[a-zA-Z_0-9-]*$ - minLength: 0 - maxLength: 255 - Description: + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure type: string - minLength: 0 - maxLength: 255 - AttributeName: + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ type: string - pattern: ^[a-zA-Z_0-9- \t]*$ - minLength: 0 - maxLength: 255 - SchemaMappingArn: - description: The SchemaMapping arn associated with the Schema + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ type: string - pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$ - KMSArn: + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' type: string - pattern: ^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$ - IdMappingWorkflowArn: - description: The default IdMappingWorkflow arn + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE type: string - pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$ - CreatedAt: - description: The time of this SchemaMapping got created + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE type: string - UpdatedAt: - description: The time of this SchemaMapping got last updated at + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' type: string - IdMappingWorkflowInputSource: + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. properties: - InputSourceARN: - description: An Glue table ARN for the input source table + Identifier: type: string - pattern: arn:(aws|aws-us-gov|aws-cn):.*:.*:[0-9]+:.*$ - SchemaArn: + Properties: type: string - $ref: '#/components/schemas/SchemaMappingArn' + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' required: - - InputSourceARN - - SchemaArn - additionalProperties: false + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: IdMappingWorkflowOutputSource: + additionalProperties: false type: object properties: + KMSArn: + $ref: '#/components/schemas/KMSArn' OutputS3Path: + pattern: ^s3://([^/]+)/?(.*?([^/]+)/?)$ description: The S3 path to which Entity Resolution will write the output table type: string - pattern: ^s3://([^/]+)/?(.*?([^/]+)/?)$ - KMSArn: - $ref: '#/components/schemas/KMSArn' required: - OutputS3Path + Description: + type: string + minLength: 0 + maxLength: 255 + IdMappingWorkflowInputSource: additionalProperties: false + type: object + properties: + Type: + type: string + enum: + - SOURCE + - TARGET + InputSourceARN: + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$ + description: An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN + type: string + SchemaArn: + type: string + $ref: '#/components/schemas/SchemaMappingArn' + required: + - InputSourceARN + EntityName: + type: string + pattern: ^[a-zA-Z_0-9-]*$ + minLength: 0 + maxLength: 255 IdMappingTechniques: + additionalProperties: false type: object properties: + RuleBasedProperties: + $ref: '#/components/schemas/IdMappingRuleBasedProperties' + ProviderProperties: + $ref: '#/components/schemas/ProviderProperties' IdMappingType: type: string enum: - PROVIDER - ProviderProperties: - $ref: '#/components/schemas/ProviderProperties' + - RULE_BASED + CreatedAt: + description: The time of this SchemaMapping got created + type: string + IdMappingWorkflowArn: + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(idmappingworkflow/.*)$ + description: The default IdMappingWorkflow arn + type: string + IdMappingIncrementalRunConfig: additionalProperties: false + type: object + properties: + IncrementalRunType: + type: string + enum: + - ON_DEMAND + required: + - IncrementalRunType + UpdatedAt: + description: The time of this SchemaMapping got last updated at + type: string + IdMappingRuleBasedProperties: + additionalProperties: false + type: object + properties: + AttributeMatchingModel: + type: string + enum: + - ONE_TO_ONE + - MANY_TO_MANY + RuleDefinitionType: + type: string + enum: + - SOURCE + - TARGET + Rules: + minItems: 1 + maxItems: 25 + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Rule' + RecordMatchingModel: + type: string + enum: + - ONE_SOURCE_TO_ONE_TARGET + - MANY_SOURCE_TO_ONE_TARGET + required: + - AttributeMatchingModel + - RecordMatchingModel + KMSArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$ ProviderProperties: type: object properties: @@ -99,6 +516,34 @@ components: required: - IntermediateS3Path additionalProperties: false + SchemaMappingArn: + description: The SchemaMapping arn associated with the Schema + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$ + AttributeName: + type: string + pattern: ^[a-zA-Z_0-9- \t]*$ + minLength: 0 + maxLength: 255 + Rule: + type: object + properties: + RuleName: + type: string + pattern: ^[a-zA-Z_0-9- \t]*$ + minLength: 0 + maxLength: 255 + MatchingKeys: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 15 + items: + $ref: '#/components/schemas/AttributeName' + required: + - RuleName + - MatchingKeys + additionalProperties: false Tag: description: A key-value pair to associate with a resource type: object @@ -120,61 +565,84 @@ components: IdMappingWorkflow: type: object properties: - WorkflowName: - description: The name of the IdMappingWorkflow - $ref: '#/components/schemas/EntityName' Description: description: The description of the IdMappingWorkflow $ref: '#/components/schemas/Description' InputSourceConfig: - type: array - x-insertionOrder: false minItems: 1 maxItems: 20 + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/IdMappingWorkflowInputSource' + IdMappingTechniques: + $ref: '#/components/schemas/IdMappingTechniques' + WorkflowName: + description: The name of the IdMappingWorkflow + $ref: '#/components/schemas/EntityName' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' OutputSourceConfig: - type: array - x-insertionOrder: false minItems: 1 maxItems: 1 + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/IdMappingWorkflowOutputSource' - IdMappingTechniques: - $ref: '#/components/schemas/IdMappingTechniques' + IdMappingIncrementalRunConfig: + $ref: '#/components/schemas/IdMappingIncrementalRunConfig' + WorkflowArn: + $ref: '#/components/schemas/IdMappingWorkflowArn' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' RoleArn: - type: string pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + type: string Tags: - type: array - uniqueItems: true - x-insertionOrder: false minItems: 0 maxItems: 200 + uniqueItems: true + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - WorkflowArn: - $ref: '#/components/schemas/IdMappingWorkflowArn' - CreatedAt: - $ref: '#/components/schemas/CreatedAt' - UpdatedAt: - $ref: '#/components/schemas/UpdatedAt' required: - WorkflowName - InputSourceConfig - - OutputSourceConfig - IdMappingTechniques - RoleArn x-stackql-resource-name: id_mapping_workflow - x-stackql-primaryIdentifier: + description: IdMappingWorkflow defined in AWS Entity Resolution service + x-type-name: AWS::EntityResolution::IdMappingWorkflow + x-stackql-primary-identifier: - WorkflowName x-create-only-properties: - WorkflowName + x-write-only-properties: + - IdMappingTechniques/NormalizationVersion x-read-only-properties: - WorkflowArn - UpdatedAt - CreatedAt + x-required-properties: + - WorkflowName + - InputSourceConfig + - IdMappingTechniques + - RoleArn + x-tagging: + permissions: + - entityresolution:TagResource + - entityresolution:UntagResource + - entityresolution:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - entityresolution:GetIdMappingWorkflow + - entityresolution:ListTagsForResource create: - entityresolution:CreateIdMappingWorkflow - entityresolution:GetIdMappingWorkflow @@ -191,15 +659,192 @@ components: - iam:PassRole - kms:CreateGrant - kms:DescribeKey - read: - - entityresolution:GetIdMappingWorkflow - - entityresolution:ListTagsForResource + list: + - entityresolution:ListIdMappingWorkflows delete: - entityresolution:DeleteIdMappingWorkflow - entityresolution:GetIdMappingWorkflow - entityresolution:UntagResource + IdNamespaceInputSource: + type: object + properties: + InputSourceARN: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$ + SchemaName: + $ref: '#/components/schemas/EntityName' + required: + - InputSourceARN + additionalProperties: false + IdNamespaceIdMappingWorkflowProperties: + type: object + properties: + IdMappingType: + type: string + enum: + - PROVIDER + - RULE_BASED + RuleBasedProperties: + $ref: '#/components/schemas/NamespaceRuleBasedProperties' + ProviderProperties: + $ref: '#/components/schemas/NamespaceProviderProperties' + required: + - IdMappingType + additionalProperties: false + NamespaceRuleBasedProperties: + type: object + properties: + Rules: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 25 + items: + $ref: '#/components/schemas/Rule' + RuleDefinitionTypes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/RuleDefinitionType' + AttributeMatchingModel: + type: string + enum: + - ONE_TO_ONE + - MANY_TO_MANY + RecordMatchingModels: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/RecordMatchingModel' + additionalProperties: false + RecordMatchingModel: + type: string + enum: + - ONE_SOURCE_TO_ONE_TARGET + - MANY_SOURCE_TO_ONE_TARGET + RuleDefinitionType: + type: string + enum: + - SOURCE + - TARGET + NamespaceProviderProperties: + type: object + properties: + ProviderServiceArn: + $ref: '#/components/schemas/ProviderServiceArn' + ProviderConfiguration: + type: object + description: Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + required: + - ProviderServiceArn + additionalProperties: false + ProviderServiceArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$ + minLength: 20 + maxLength: 255 + IdNamespace: + type: object + properties: + IdNamespaceName: + $ref: '#/components/schemas/EntityName' + Description: + type: string + minLength: 0 + maxLength: 255 + InputSourceConfig: + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 20 + items: + $ref: '#/components/schemas/IdNamespaceInputSource' + IdMappingWorkflowProperties: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties' + Type: + type: string + enum: + - SOURCE + - TARGET + RoleArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + minLength: 32 + maxLength: 512 + IdNamespaceArn: + description: The arn associated with the IdNamespace + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$ + CreatedAt: + description: The date and time when the IdNamespace was created + type: string + UpdatedAt: + description: The date and time when the IdNamespace was updated + type: string + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + required: + - IdNamespaceName + - Type + x-stackql-resource-name: id_namespace + description: IdNamespace defined in AWS Entity Resolution service + x-type-name: AWS::EntityResolution::IdNamespace + x-stackql-primary-identifier: + - IdNamespaceName + x-create-only-properties: + - IdNamespaceName + x-read-only-properties: + - IdNamespaceArn + - CreatedAt + - UpdatedAt + x-required-properties: + - IdNamespaceName + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - entityresolution:TagResource + - entityresolution:UntagResource + - entityresolution:ListTagsForResource + x-required-permissions: + create: + - entityresolution:CreateIdNamespace + - entityresolution:TagResource + - iam:PassRole + read: + - entityresolution:GetIdNamespace + - entityresolution:ListTagsForResource + update: + - entityresolution:UpdateIdNamespace + - entityresolution:ListTagsForResource + - entityresolution:TagResource + - entityresolution:UntagResource + - iam:PassRole + delete: + - entityresolution:DeleteIdNamespace + - entityresolution:GetIdNamespace + - entityresolution:UntagResource list: - - entityresolution:ListIdMappingWorkflows + - entityresolution:ListIdNamespaces MatchingWorkflowArn: description: The default MatchingWorkflow arn type: string @@ -252,20 +897,34 @@ components: required: - Name additionalProperties: false + ResolutionType: + type: string + enum: + - RULE_MATCHING + - ML_MATCHING + - PROVIDER ResolutionTechniques: type: object properties: ResolutionType: - type: string - enum: - - RULE_MATCHING - - ML_MATCHING - - PROVIDER + $ref: '#/components/schemas/ResolutionType' RuleBasedProperties: $ref: '#/components/schemas/RuleBasedProperties' + RuleConditionProperties: + $ref: '#/components/schemas/RuleConditionProperties' ProviderProperties: $ref: '#/components/schemas/ProviderProperties' additionalProperties: false + IncrementalRunConfig: + type: object + properties: + IncrementalRunType: + type: string + enum: + - IMMEDIATE + required: + - IncrementalRunType + additionalProperties: false RuleBasedProperties: type: object properties: @@ -281,28 +940,35 @@ components: enum: - ONE_TO_ONE - MANY_TO_MANY + MatchPurpose: + type: string + enum: + - IDENTIFIER_GENERATION + - INDEXING + required: + - AttributeMatchingModel + - Rules + additionalProperties: false + RuleConditionProperties: + type: object + properties: + Rules: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 15 + items: + $ref: '#/components/schemas/RuleCondition' required: - - AttributeMatchingModel - Rules additionalProperties: false - Rule: + RuleCondition: type: object properties: RuleName: + $ref: '#/components/schemas/AttributeName' + Condition: type: string - pattern: ^[a-zA-Z_0-9- \t]*$ - minLength: 0 - maxLength: 255 - MatchingKeys: - type: array - x-insertionOrder: false - minItems: 1 - maxItems: 15 - items: - $ref: '#/components/schemas/AttributeName' - required: - - RuleName - - MatchingKeys additionalProperties: false MatchingWorkflow: type: object @@ -346,6 +1012,8 @@ components: $ref: '#/components/schemas/CreatedAt' UpdatedAt: $ref: '#/components/schemas/UpdatedAt' + IncrementalRunConfig: + $ref: '#/components/schemas/IncrementalRunConfig' required: - WorkflowName - InputSourceConfig @@ -353,7 +1021,9 @@ components: - ResolutionTechniques - RoleArn x-stackql-resource-name: matching_workflow - x-stackql-primaryIdentifier: + description: MatchingWorkflow defined in AWS Entity Resolution service + x-type-name: AWS::EntityResolution::MatchingWorkflow + x-stackql-primary-identifier: - WorkflowName x-create-only-properties: - WorkflowName @@ -361,6 +1031,22 @@ components: - WorkflowArn - UpdatedAt - CreatedAt + x-required-properties: + - WorkflowName + - InputSourceConfig + - OutputSourceConfig + - ResolutionTechniques + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - entityresolution:TagResource + - entityresolution:UntagResource + - entityresolution:ListTagsForResource x-required-permissions: create: - entityresolution:CreateMatchingWorkflow @@ -369,6 +1055,10 @@ components: - kms:CreateGrant - kms:DescribeKey - iam:PassRole + - events:PutRule + - events:DeleteRule + - events:PutTargets + - events:ListTargetsByRule read: - entityresolution:GetMatchingWorkflow - entityresolution:ListTagsForResource @@ -376,6 +1066,11 @@ components: - entityresolution:DeleteMatchingWorkflow - entityresolution:GetMatchingWorkflow - entityresolution:UntagResource + - events:PutRule + - events:DeleteRule + - events:PutTargets + - events:RemoveTargets + - events:ListTargetsByRule list: - entityresolution:ListMatchingWorkflows update: @@ -387,6 +1082,96 @@ components: - iam:PassRole - kms:CreateGrant - kms:DescribeKey + - events:PutRule + - events:DeleteRule + - events:PutTargets + - events:RemoveTargets + - events:ListTargetsByRule + VeniceGlobalArn: + description: Arn of the resource to which the policy statement is being attached. + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:((schemamapping|matchingworkflow|idmappingworkflow|idnamespace)/[a-zA-Z_0-9-]{1,255})$ + StatementId: + description: The Statement Id of the policy statement that is being attached. + type: string + pattern: ^[0-9A-Za-z]+$ + minLength: 1 + maxLength: 64 + StatementEffect: + type: string + enum: + - Allow + - Deny + StatementAction: + type: string + pattern: ^(entityresolution:[a-zA-Z0-9]+)$ + minLength: 3 + maxLength: 64 + StatementActionList: + type: array + items: + $ref: '#/components/schemas/StatementAction' + StatementPrincipal: + type: string + pattern: ^(\\d{12})|([a-z0-9\\.]+)$ + minLength: 12 + maxLength: 64 + StatementPrincipalList: + type: array + items: + $ref: '#/components/schemas/StatementPrincipal' + StatementCondition: + type: string + minLength: 1 + maxLength: 40960 + PolicyStatement: + type: object + properties: + Arn: + $ref: '#/components/schemas/VeniceGlobalArn' + StatementId: + $ref: '#/components/schemas/StatementId' + Effect: + $ref: '#/components/schemas/StatementEffect' + Action: + $ref: '#/components/schemas/StatementActionList' + Principal: + $ref: '#/components/schemas/StatementPrincipalList' + Condition: + $ref: '#/components/schemas/StatementCondition' + required: + - Arn + - StatementId + x-stackql-resource-name: policy_statement + description: Policy Statement defined in AWS Entity Resolution Service + x-type-name: AWS::EntityResolution::PolicyStatement + x-stackql-primary-identifier: + - Arn + - StatementId + x-create-only-properties: + - StatementId + - Arn + x-required-properties: + - Arn + - StatementId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - entityresolution:AddPolicyStatement + read: + - entityresolution:GetPolicy + update: + - entityresolution:AddPolicyStatement + - entityresolution:DeletePolicyStatement + delete: + - entityresolution:DeletePolicyStatement + - entityresolution:GetPolicy + list: + - entityresolution:GetPolicy SchemaAttributeType: type: string enum: @@ -415,8 +1200,10 @@ components: items: $ref: '#/components/schemas/SchemaInputAttribute' minItems: 2 - maxItems: 25 + maxItems: 35 x-insertionOrder: false + Hashed: + type: boolean SchemaInputAttribute: type: object properties: @@ -431,6 +1218,8 @@ components: $ref: '#/components/schemas/AttributeName' MatchKey: $ref: '#/components/schemas/AttributeName' + Hashed: + $ref: '#/components/schemas/Hashed' required: - FieldName - Type @@ -470,7 +1259,9 @@ components: - SchemaName - MappedInputFields x-stackql-resource-name: schema_mapping - x-stackql-primaryIdentifier: + description: SchemaMapping defined in AWS Entity Resolution service + x-type-name: AWS::EntityResolution::SchemaMapping + x-stackql-primary-identifier: - SchemaName x-create-only-properties: - SchemaName @@ -479,6 +1270,19 @@ components: - CreatedAt - UpdatedAt - HasWorkflows + x-required-properties: + - SchemaName + - MappedInputFields + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - entityresolution:TagResource + - entityresolution:UntagResource + - entityresolution:ListTagsForResource x-required-permissions: create: - entityresolution:CreateSchemaMapping @@ -498,14 +1302,376 @@ components: - entityresolution:UntagResource list: - entityresolution:ListSchemaMappings + CreateIdMappingWorkflowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: The description of the IdMappingWorkflow + $ref: '#/components/schemas/Description' + InputSourceConfig: + minItems: 1 + maxItems: 20 + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/IdMappingWorkflowInputSource' + IdMappingTechniques: + $ref: '#/components/schemas/IdMappingTechniques' + WorkflowName: + description: The name of the IdMappingWorkflow + $ref: '#/components/schemas/EntityName' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + OutputSourceConfig: + minItems: 1 + maxItems: 1 + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/IdMappingWorkflowOutputSource' + IdMappingIncrementalRunConfig: + $ref: '#/components/schemas/IdMappingIncrementalRunConfig' + WorkflowArn: + $ref: '#/components/schemas/IdMappingWorkflowArn' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + RoleArn: + pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + type: string + Tags: + minItems: 0 + maxItems: 200 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIdMappingWorkflowRequest + type: object + required: [] + CreateIdNamespaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdNamespaceName: + $ref: '#/components/schemas/EntityName' + Description: + type: string + minLength: 0 + maxLength: 255 + InputSourceConfig: + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 20 + items: + $ref: '#/components/schemas/IdNamespaceInputSource' + IdMappingWorkflowProperties: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties' + Type: + type: string + enum: + - SOURCE + - TARGET + RoleArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + minLength: 32 + maxLength: 512 + IdNamespaceArn: + description: The arn associated with the IdNamespace + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$ + CreatedAt: + description: The date and time when the IdNamespace was created + type: string + UpdatedAt: + description: The date and time when the IdNamespace was updated + type: string + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIdNamespaceRequest + type: object + required: [] + CreateMatchingWorkflowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkflowName: + description: The name of the MatchingWorkflow + $ref: '#/components/schemas/EntityName' + Description: + description: The description of the MatchingWorkflow + $ref: '#/components/schemas/Description' + InputSourceConfig: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 20 + items: + $ref: '#/components/schemas/InputSource' + OutputSourceConfig: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/OutputSource' + ResolutionTechniques: + $ref: '#/components/schemas/ResolutionTechniques' + RoleArn: + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + WorkflowArn: + $ref: '#/components/schemas/MatchingWorkflowArn' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + IncrementalRunConfig: + $ref: '#/components/schemas/IncrementalRunConfig' + x-stackQL-stringOnly: true + x-title: CreateMatchingWorkflowRequest + type: object + required: [] + CreatePolicyStatementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/VeniceGlobalArn' + StatementId: + $ref: '#/components/schemas/StatementId' + Effect: + $ref: '#/components/schemas/StatementEffect' + Action: + $ref: '#/components/schemas/StatementActionList' + Principal: + $ref: '#/components/schemas/StatementPrincipalList' + Condition: + $ref: '#/components/schemas/StatementCondition' + x-stackQL-stringOnly: true + x-title: CreatePolicyStatementRequest + type: object + required: [] + CreateSchemaMappingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SchemaName: + description: The name of the SchemaMapping + $ref: '#/components/schemas/EntityName' + Description: + description: The description of the SchemaMapping + $ref: '#/components/schemas/Description' + MappedInputFields: + description: The SchemaMapping attributes input + $ref: '#/components/schemas/MappedInputFields' + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + SchemaArn: + $ref: '#/components/schemas/SchemaMappingArn' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + HasWorkflows: + $ref: '#/components/schemas/HasWorkflows' + x-stackQL-stringOnly: true + x-title: CreateSchemaMappingRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: id_mapping_workflows: name: id_mapping_workflows id: awscc.entityresolution.id_mapping_workflows x-cfn-schema-name: IdMappingWorkflow - x-type: list + x-cfn-type-name: AWS::EntityResolution::IdMappingWorkflow + x-identifiers: + - WorkflowName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdMappingWorkflow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::IdMappingWorkflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::IdMappingWorkflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::IdMappingWorkflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.InputSourceConfig') as input_source_config, + JSON_EXTRACT(Properties, '$.IdMappingTechniques') as id_mapping_techniques, + JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.OutputSourceConfig') as output_source_config, + JSON_EXTRACT(Properties, '$.IdMappingIncrementalRunConfig') as id_mapping_incremental_run_config, + JSON_EXTRACT(Properties, '$.WorkflowArn') as workflow_arn, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, + json_extract_path_text(Properties, 'IdMappingTechniques') as id_mapping_techniques, + json_extract_path_text(Properties, 'WorkflowName') as workflow_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'OutputSourceConfig') as output_source_config, + json_extract_path_text(Properties, 'IdMappingIncrementalRunConfig') as id_mapping_incremental_run_config, + json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' + AND data__Identifier = '' + AND region = 'us-east-1' + id_mapping_workflows_list_only: + name: id_mapping_workflows_list_only + id: awscc.entityresolution.id_mapping_workflows_list_only + x-cfn-schema-name: IdMappingWorkflow + x-cfn-type-name: AWS::EntityResolution::IdMappingWorkflow x-identifiers: - WorkflowName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -524,60 +1690,114 @@ components: json_extract_path_text(Properties, 'WorkflowName') as workflow_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' AND region = 'us-east-1' - id_mapping_workflow: - name: id_mapping_workflow - id: awscc.entityresolution.id_mapping_workflow - x-cfn-schema-name: IdMappingWorkflow - x-type: get + id_namespaces: + name: id_namespaces + id: awscc.entityresolution.id_namespaces + x-cfn-schema-name: IdNamespace + x-cfn-type-name: AWS::EntityResolution::IdNamespace x-identifiers: - - WorkflowName + - IdNamespaceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdNamespace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::IdNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::IdNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::IdNamespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name, + JSON_EXTRACT(Properties, '$.IdNamespaceName') as id_namespace_name, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.InputSourceConfig') as input_source_config, - JSON_EXTRACT(Properties, '$.OutputSourceConfig') as output_source_config, - JSON_EXTRACT(Properties, '$.IdMappingTechniques') as id_mapping_techniques, + JSON_EXTRACT(Properties, '$.IdMappingWorkflowProperties') as id_mapping_workflow_properties, + JSON_EXTRACT(Properties, '$.Type') as type, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.WorkflowArn') as workflow_arn, + JSON_EXTRACT(Properties, '$.IdNamespaceArn') as id_namespace_arn, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'WorkflowName') as workflow_name, + json_extract_path_text(Properties, 'IdNamespaceName') as id_namespace_name, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, - json_extract_path_text(Properties, 'OutputSourceConfig') as output_source_config, - json_extract_path_text(Properties, 'IdMappingTechniques') as id_mapping_techniques, + json_extract_path_text(Properties, 'IdMappingWorkflowProperties') as id_mapping_workflow_properties, + json_extract_path_text(Properties, 'Type') as type, json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, + json_extract_path_text(Properties, 'IdNamespaceArn') as id_namespace_arn, json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' - AND data__Identifier = '' + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' + AND data__Identifier = '' AND region = 'us-east-1' - matching_workflows: - name: matching_workflows - id: awscc.entityresolution.matching_workflows - x-cfn-schema-name: MatchingWorkflow - x-type: list + id_namespaces_list_only: + name: id_namespaces_list_only + id: awscc.entityresolution.id_namespaces_list_only + x-cfn-schema-name: IdNamespace + x-cfn-type-name: AWS::EntityResolution::IdNamespace x-identifiers: - - WorkflowName + - IdNamespaceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -585,28 +1805,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' + JSON_EXTRACT(Properties, '$.IdNamespaceName') as id_namespace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'WorkflowName') as workflow_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' + json_extract_path_text(Properties, 'IdNamespaceName') as id_namespace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' AND region = 'us-east-1' - matching_workflow: - name: matching_workflow - id: awscc.entityresolution.matching_workflow + matching_workflows: + name: matching_workflows + id: awscc.entityresolution.matching_workflows x-cfn-schema-name: MatchingWorkflow - x-type: get + x-cfn-type-name: AWS::EntityResolution::MatchingWorkflow x-identifiers: - WorkflowName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MatchingWorkflow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::MatchingWorkflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::MatchingWorkflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::MatchingWorkflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -620,12 +1888,13 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.WorkflowArn') as workflow_arn, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.IncrementalRunConfig') as incremental_run_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -639,17 +1908,24 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'IncrementalRunConfig') as incremental_run_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' AND data__Identifier = '' AND region = 'us-east-1' - schema_mappings: - name: schema_mappings - id: awscc.entityresolution.schema_mappings - x-cfn-schema-name: SchemaMapping - x-type: list + matching_workflows_list_only: + name: matching_workflows_list_only + id: awscc.entityresolution.matching_workflows_list_only + x-cfn-schema-name: MatchingWorkflow + x-cfn-type-name: AWS::EntityResolution::MatchingWorkflow x-identifiers: - - SchemaName + - WorkflowName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -657,28 +1933,198 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SchemaName') as schema_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' + JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SchemaName') as schema_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' + json_extract_path_text(Properties, 'WorkflowName') as workflow_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' + AND region = 'us-east-1' + policy_statements: + name: policy_statements + id: awscc.entityresolution.policy_statements + x-cfn-schema-name: PolicyStatement + x-cfn-type-name: AWS::EntityResolution::PolicyStatement + x-identifiers: + - Arn + - StatementId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PolicyStatement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::PolicyStatement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::PolicyStatement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::PolicyStatement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_statements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_statements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policy_statements/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.StatementId') as statement_id, + JSON_EXTRACT(Properties, '$.Effect') as effect, + JSON_EXTRACT(Properties, '$.Action') as action, + JSON_EXTRACT(Properties, '$.Principal') as principal, + JSON_EXTRACT(Properties, '$.Condition') as condition + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StatementId') as statement_id, + json_extract_path_text(Properties, 'Effect') as effect, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'Principal') as principal, + json_extract_path_text(Properties, 'Condition') as condition + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' + AND data__Identifier = '|' + AND region = 'us-east-1' + policy_statements_list_only: + name: policy_statements_list_only + id: awscc.entityresolution.policy_statements_list_only + x-cfn-schema-name: PolicyStatement + x-cfn-type-name: AWS::EntityResolution::PolicyStatement + x-identifiers: + - Arn + - StatementId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.StatementId') as statement_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StatementId') as statement_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' AND region = 'us-east-1' - schema_mapping: - name: schema_mapping - id: awscc.entityresolution.schema_mapping + schema_mappings: + name: schema_mappings + id: awscc.entityresolution.schema_mappings x-cfn-schema-name: SchemaMapping - x-type: get + x-cfn-type-name: AWS::EntityResolution::SchemaMapping x-identifiers: - SchemaName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SchemaMapping&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::SchemaMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::SchemaMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EntityResolution::SchemaMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -695,7 +2141,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -711,3 +2157,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' AND data__Identifier = '' AND region = 'us-east-1' + schema_mappings_list_only: + name: schema_mappings_list_only + id: awscc.entityresolution.schema_mappings_list_only + x-cfn-schema-name: SchemaMapping + x-cfn-type-name: AWS::EntityResolution::SchemaMapping + x-identifiers: + - SchemaName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SchemaName') as schema_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaName') as schema_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdMappingWorkflow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdMappingWorkflow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdMappingWorkflowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdNamespace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdNamespace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdNamespaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MatchingWorkflow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMatchingWorkflow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMatchingWorkflowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PolicyStatement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicyStatement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyStatementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SchemaMapping&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchemaMapping + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSchemaMappingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/events.yaml b/providers/src/awscc/v00.00.00000/services/events.yaml index 5f3b83b3..87d8df9f 100644 --- a/providers/src/awscc/v00.00.00000/services/events.yaml +++ b/providers/src/awscc/v00.00.00000/services/events.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Events - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ApiDestination: type: object @@ -13,21 +393,29 @@ components: type: string minLength: 1 maxLength: 64 + pattern: '[\.\-_A-Za-z0-9]+' Description: type: string maxLength: 512 ConnectionArn: description: The arn of the connection. type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection/[\.\-_A-Za-z0-9]+/[\-A-Za-z0-9]+$ Arn: description: The arn of the api destination. type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination/[\.\-_A-Za-z0-9]+/[\-A-Za-z0-9]+$ + ArnForPolicy: + description: The arn of the api destination to be used in IAM policies. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination/[\.\-_A-Za-z0-9]+$ InvocationRateLimitPerSecond: type: integer minimum: 1 InvocationEndpoint: description: Url endpoint to invoke. type: string + pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$ HttpMethod: type: string enum: @@ -43,12 +431,24 @@ components: - InvocationEndpoint - HttpMethod x-stackql-resource-name: api_destination - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Events::ApiDestination. + x-type-name: AWS::Events::ApiDestination + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + - ArnForPolicy + x-required-properties: + - ConnectionArn + - InvocationEndpoint + - HttpMethod + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - events:CreateApiDestination @@ -70,6 +470,7 @@ components: type: string minLength: 1 maxLength: 48 + pattern: '[\.\-_A-Za-z0-9]+' SourceArn: type: string Description: @@ -78,22 +479,39 @@ components: type: object Arn: type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$ RetentionDays: type: integer + KmsKeyIdentifier: + type: string + maxLength: 2048 + minLength: 0 required: - SourceArn x-stackql-resource-name: archive - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Events::Archive + x-type-name: AWS::Events::Archive + x-stackql-primary-identifier: - ArchiveName x-create-only-properties: - ArchiveName - SourceArn x-read-only-properties: - Arn + x-required-properties: + - SourceArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - events:DescribeArchive - events:CreateArchive + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt delete: - events:DescribeArchive - events:DeleteArchive @@ -102,8 +520,14 @@ components: update: - events:DescribeArchive - events:UpdateArchive + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + - kms:ReEncryptTo + - kms:ReEncryptFrom read: - events:DescribeArchive + - kms:Decrypt AuthParameters: type: object minProperties: 1 @@ -117,6 +541,8 @@ components: $ref: '#/components/schemas/OAuthParameters' InvocationHttpParameters: $ref: '#/components/schemas/ConnectionHttpParameters' + ConnectivityParameters: + $ref: '#/components/schemas/ConnectivityParameters' oneOf: - required: - BasicAuthParameters @@ -130,8 +556,10 @@ components: properties: Username: type: string + pattern: ^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$ Password: type: string + pattern: ^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$ required: - Username - Password @@ -145,6 +573,7 @@ components: type: string minLength: 1 maxLength: 2048 + pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$ HttpMethod: type: string enum: @@ -163,8 +592,10 @@ components: properties: ApiKeyName: type: string + pattern: ^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$ ApiKeyValue: type: string + pattern: ^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$ required: - ApiKeyName - ApiKeyValue @@ -174,8 +605,10 @@ components: properties: ClientID: type: string + pattern: ^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$ ClientSecret: type: string + pattern: ^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$ required: - ClientID - ClientSecret @@ -196,6 +629,29 @@ components: items: $ref: '#/components/schemas/Parameter' additionalProperties: false + ConnectivityParameters: + type: object + properties: + ResourceParameters: + $ref: '#/components/schemas/ResourceParameters' + required: + - ResourceParameters + additionalProperties: false + ResourceParameters: + type: object + properties: + ResourceConfigurationArn: + type: string + maxLength: 2048 + pattern: ^arn:[a-z0-9f\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$ + ResourceAssociationArn: + type: string + minLength: 20 + maxLength: 2048 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-z]{17}$ + required: + - ResourceConfigurationArn + additionalProperties: false Parameter: type: object properties: @@ -218,12 +674,19 @@ components: type: string minLength: 1 maxLength: 64 + pattern: '[\.\-_A-Za-z0-9]+' Arn: description: The arn of the connection resource. type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$ + ArnForPolicy: + description: The arn of the connection resource to be used in IAM policies. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+$ SecretArn: description: The arn of the secrets manager secret created in the customer account. type: string + pattern: ^arn:aws([a-z]|\-)*:secretsmanager:([a-z]|\d|\-)*:([0-9]{12})?:secret:([a-z]|\d|\-)*(!)*[\/_+=\.@\-A-Za-z0-9]+$ Description: description: Description of the connection. type: string @@ -236,14 +699,45 @@ components: - OAUTH_CLIENT_CREDENTIALS AuthParameters: $ref: '#/components/schemas/AuthParameters' + InvocationConnectivityParameters: + description: The private resource the HTTP request will be sent to. + type: object + properties: + ResourceParameters: + $ref: '#/components/schemas/ResourceParameters' + required: + - ResourceParameters + additionalProperties: false + KmsKeyIdentifier: + type: string + maxLength: 2048 + pattern: ^[a-zA-Z0-9_\-/:]*$ x-stackql-resource-name: connection - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Events::Connection. + x-type-name: AWS::Events::Connection + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - AuthParameters/BasicAuthParameters/Password + - AuthParameters/ApiKeyAuthParameters/ApiKeyValue + - AuthParameters/OAuthParameters/ClientParameters/ClientSecret + - AuthParameters/OAuthParameters/OAuthHttpParameters/HeaderParameters + - AuthParameters/OAuthParameters/OAuthHttpParameters/QueryStringParameters + - AuthParameters/OAuthParameters/OAuthHttpParameters/BodyParameters + - AuthParameters/InvocationHttpParameters x-read-only-properties: - Arn + - ArnForPolicy - SecretArn + - AuthParameters/ConnectivityParameters/ResourceParameters/ResourceAssociationArn + - InvocationConnectivityParameters/ResourceParameters/ResourceAssociationArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - events:CreateConnection @@ -252,8 +746,11 @@ components: - secretsmanager:GetSecretValue - secretsmanager:PutSecretValue - iam:CreateServiceLinkedRole + - kms:DescribeKey + - kms:GenerateDataKey read: - events:DescribeConnection + - kms:Decrypt update: - events:UpdateConnection - events:DescribeConnection @@ -261,6 +758,10 @@ components: - secretsmanager:UpdateSecret - secretsmanager:GetSecretValue - secretsmanager:PutSecretValue + - kms:Decrypt + - kms:DescribeKey + - kms:Encrypt + - kms:GenerateDataKey delete: - events:DeleteConnection - events:DescribeConnection @@ -315,7 +816,7 @@ components: type: string minLength: 1 maxLength: 512 - pattern: ^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\d+:\d{12}:event-bus/[\w.-]+$ + pattern: ^arn:aws[a-z-]*:events:[a-z]+-[a-z-]+-\d+:\d{12}:event-bus/[\w.-]+$ EndpointEventBus: type: object additionalProperties: false @@ -400,7 +901,9 @@ components: - RoutingConfig - EventBuses x-stackql-resource-name: endpoint - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Events::Endpoint. + x-type-name: AWS::Events::Endpoint + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -410,6 +913,14 @@ components: - EndpointUrl - State - StateReason + x-required-properties: + - RoutingConfig + - EventBuses + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - events:CreateEndpoint @@ -451,21 +962,69 @@ components: uniqueItems: false items: $ref: '#/components/schemas/Tag' + Description: + description: The description of the event bus. + type: string + KmsKeyIdentifier: + description: Kms Key Identifier used to encrypt events at rest in the event bus. + type: string Policy: description: A JSON string that describes the permission policy statement for the event bus. type: object Arn: description: The Amazon Resource Name (ARN) for the event bus. type: string + DeadLetterConfig: + description: Dead Letter Queue for the event bus. + type: object + additionalProperties: false + properties: + Arn: + type: string + LogConfig: + description: The logging configuration settings for vended logs. + type: object + additionalProperties: false + properties: + IncludeDetail: + type: string + description: Configures whether or not to include event detail, input transformer details, target properties, and target input in the applicable log messages. + enum: + - FULL + - NONE + Level: + type: string + description: Configures the log level of the EventBus and determines which log messages are sent to Ingestion Hub for delivery. + enum: + - INFO + - ERROR + - TRACE + - 'OFF' required: - Name x-stackql-resource-name: event_bus - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::Events::EventBus + x-type-name: AWS::Events::EventBus + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - EventSourceName x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - events:UntagResource + - events:TagResource + - events:ListTagsForResource x-required-permissions: create: - events:CreateEventBus @@ -473,6 +1032,9 @@ components: - events:PutPermission - events:ListTagsForResource - events:TagResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt read: - events:DescribeEventBus - events:ListTagsForResource @@ -481,12 +1043,61 @@ components: - events:UntagResource - events:PutPermission - events:DescribeEventBus + - events:UpdateEventBus + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt delete: - events:DescribeEventBus + - events:UpdateEventBus + - events:ListTagsForResource + - events:UntagResource + - events:RemovePermission - events:DeleteEventBus list: - events:ListEventBuses - events:ListTagsForResource + Condition: + type: object + additionalProperties: false + properties: + Value: + type: string + Type: + type: string + Key: + type: string + EventBusPolicy: + type: object + properties: + EventBusName: + type: string + Condition: + $ref: '#/components/schemas/Condition' + Action: + type: string + StatementId: + type: string + Statement: + type: object + Id: + type: string + Principal: + type: string + required: + - StatementId + x-stackql-resource-name: event_bus_policy + description: Resource Type definition for AWS::Events::EventBusPolicy + x-type-name: AWS::Events::EventBusPolicy + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - EventBusName + - StatementId + x-read-only-properties: + - Id + x-required-properties: + - StatementId CapacityProviderStrategyItem: additionalProperties: false type: object @@ -842,32 +1453,57 @@ components: RoleArn: description: The Amazon Resource Name (ARN) of the role that is used for target invocation. type: string + Tags: + uniqueItems: false + description: Any tags assigned to the event rule. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' Name: description: The name of the rule. type: string x-stackql-resource-name: rule - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Events::Rule + x-type-name: AWS::Events::Rule + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name + x-conditional-create-only-properties: + - EventBusName x-read-only-properties: - Arn + x-tagging: + permissions: + - events:UntagResource + - events:TagResource + - events:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: read: - iam:PassRole - events:DescribeRule - events:ListTargetsByRule + - events:ListTagsForResource create: - iam:PassRole - events:DescribeRule - events:PutRule - events:PutTargets + - events:TagResource update: - iam:PassRole - events:DescribeRule - events:PutRule - events:RemoveTargets - events:PutTargets + - events:UntagResource + - events:TagResource list: - events:ListRules delete: @@ -876,43 +1512,419 @@ components: - events:DeleteRule - events:RemoveTargets - events:ListTargetsByRule + CreateApiDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the apiDestination. + type: string + minLength: 1 + maxLength: 64 + pattern: '[\.\-_A-Za-z0-9]+' + Description: + type: string + maxLength: 512 + ConnectionArn: + description: The arn of the connection. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection/[\.\-_A-Za-z0-9]+/[\-A-Za-z0-9]+$ + Arn: + description: The arn of the api destination. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination/[\.\-_A-Za-z0-9]+/[\-A-Za-z0-9]+$ + ArnForPolicy: + description: The arn of the api destination to be used in IAM policies. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination/[\.\-_A-Za-z0-9]+$ + InvocationRateLimitPerSecond: + type: integer + minimum: 1 + InvocationEndpoint: + description: Url endpoint to invoke. + type: string + pattern: ^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$ + HttpMethod: + type: string + enum: + - GET + - HEAD + - POST + - OPTIONS + - PUT + - DELETE + - PATCH + x-stackQL-stringOnly: true + x-title: CreateApiDestinationRequest + type: object + required: [] + CreateArchiveRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ArchiveName: + type: string + minLength: 1 + maxLength: 48 + pattern: '[\.\-_A-Za-z0-9]+' + SourceArn: + type: string + Description: + type: string + EventPattern: + type: object + Arn: + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$ + RetentionDays: + type: integer + KmsKeyIdentifier: + type: string + maxLength: 2048 + minLength: 0 + x-stackQL-stringOnly: true + x-title: CreateArchiveRequest + type: object + required: [] + CreateConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the connection. + type: string + minLength: 1 + maxLength: 64 + pattern: '[\.\-_A-Za-z0-9]+' + Arn: + description: The arn of the connection resource. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$ + ArnForPolicy: + description: The arn of the connection resource to be used in IAM policies. + type: string + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+$ + SecretArn: + description: The arn of the secrets manager secret created in the customer account. + type: string + pattern: ^arn:aws([a-z]|\-)*:secretsmanager:([a-z]|\d|\-)*:([0-9]{12})?:secret:([a-z]|\d|\-)*(!)*[\/_+=\.@\-A-Za-z0-9]+$ + Description: + description: Description of the connection. + type: string + maxLength: 512 + AuthorizationType: + type: string + enum: + - API_KEY + - BASIC + - OAUTH_CLIENT_CREDENTIALS + AuthParameters: + $ref: '#/components/schemas/AuthParameters' + InvocationConnectivityParameters: + description: The private resource the HTTP request will be sent to. + type: object + properties: + ResourceParameters: + $ref: '#/components/schemas/ResourceParameters' + required: + - ResourceParameters + additionalProperties: false + KmsKeyIdentifier: + type: string + maxLength: 2048 + pattern: ^[a-zA-Z0-9_\-/:]*$ + x-stackQL-stringOnly: true + x-title: CreateConnectionRequest + type: object + required: [] + CreateEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + minLength: 1 + maxLength: 64 + pattern: ^[\.\-_A-Za-z0-9]+$ + Arn: + type: string + minLength: 1 + maxLength: 1600 + pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$ + RoleArn: + type: string + minLength: 1 + maxLength: 256 + pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$ + Description: + type: string + maxLength: 512 + pattern: .* + RoutingConfig: + $ref: '#/components/schemas/RoutingConfig' + ReplicationConfig: + $ref: '#/components/schemas/ReplicationConfig' + EventBuses: + $ref: '#/components/schemas/EventBuses' + EndpointId: + type: string + minLength: 1 + maxLength: 50 + pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$ + EndpointUrl: + type: string + minLength: 1 + maxLength: 256 + pattern: ^(https://)?[\.\-a-z0-9]+$ + State: + type: string + enum: + - ACTIVE + - CREATING + - UPDATING + - DELETING + - CREATE_FAILED + - UPDATE_FAILED + StateReason: + type: string + minLength: 1 + maxLength: 512 + pattern: ^.*$ + x-stackQL-stringOnly: true + x-title: CreateEndpointRequest + type: object + required: [] + CreateEventBusRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EventSourceName: + description: If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. + type: string + Name: + description: The name of the event bus. + type: string + Tags: + description: Any tags assigned to the event bus. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Description: + description: The description of the event bus. + type: string + KmsKeyIdentifier: + description: Kms Key Identifier used to encrypt events at rest in the event bus. + type: string + Policy: + description: A JSON string that describes the permission policy statement for the event bus. + type: object + Arn: + description: The Amazon Resource Name (ARN) for the event bus. + type: string + DeadLetterConfig: + description: Dead Letter Queue for the event bus. + type: object + additionalProperties: false + properties: + Arn: + type: string + LogConfig: + description: The logging configuration settings for vended logs. + type: object + additionalProperties: false + properties: + IncludeDetail: + type: string + description: Configures whether or not to include event detail, input transformer details, target properties, and target input in the applicable log messages. + enum: + - FULL + - NONE + Level: + type: string + description: Configures the log level of the EventBus and determines which log messages are sent to Ingestion Hub for delivery. + enum: + - INFO + - ERROR + - TRACE + - 'OFF' + x-stackQL-stringOnly: true + x-title: CreateEventBusRequest + type: object + required: [] + CreateRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EventBusName: + description: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. + type: string + EventPattern: + description: The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. + type: object + ScheduleExpression: + description: The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule. + type: string + Description: + description: The description of the rule. + type: string + State: + description: The state of the rule. + type: string + enum: + - DISABLED + - ENABLED + - ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS + Targets: + uniqueItems: true + description: |- + Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. + Targets are the resources that are invoked when a rule is triggered. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Target' + Arn: + description: The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example. + type: string + RoleArn: + description: The Amazon Resource Name (ARN) of the role that is used for target invocation. + type: string + Tags: + uniqueItems: false + description: Any tags assigned to the event rule. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + Name: + description: The name of the rule. + type: string + x-stackQL-stringOnly: true + x-title: CreateRuleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: api_destinations: name: api_destinations id: awscc.events.api_destinations x-cfn-schema-name: ApiDestination - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' - AND region = 'us-east-1' - api_destination: - name: api_destination - id: awscc.events.api_destination - x-cfn-schema-name: ApiDestination - x-type: get + x-cfn-type-name: AWS::Events::ApiDestination x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApiDestination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::ApiDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::ApiDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::ApiDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/api_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -921,6 +1933,7 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ArnForPolicy') as arn_for_policy, JSON_EXTRACT(Properties, '$.InvocationRateLimitPerSecond') as invocation_rate_limit_per_second, JSON_EXTRACT(Properties, '$.InvocationEndpoint') as invocation_endpoint, JSON_EXTRACT(Properties, '$.HttpMethod') as http_method @@ -928,7 +1941,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -937,19 +1950,26 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ArnForPolicy') as arn_for_policy, json_extract_path_text(Properties, 'InvocationRateLimitPerSecond') as invocation_rate_limit_per_second, json_extract_path_text(Properties, 'InvocationEndpoint') as invocation_endpoint, json_extract_path_text(Properties, 'HttpMethod') as http_method FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::ApiDestination' AND data__Identifier = '' AND region = 'us-east-1' - archives: - name: archives - id: awscc.events.archives - x-cfn-schema-name: Archive - x-type: list + api_destinations_list_only: + name: api_destinations_list_only + id: awscc.events.api_destinations_list_only + x-cfn-schema-name: ApiDestination + x-cfn-type-name: AWS::Events::ApiDestination x-identifiers: - - ArchiveName + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -957,28 +1977,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ArchiveName') as archive_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ArchiveName') as archive_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' AND region = 'us-east-1' - archive: - name: archive - id: awscc.events.archive + archives: + name: archives + id: awscc.events.archives x-cfn-schema-name: Archive - x-type: get + x-cfn-type-name: AWS::Events::Archive x-identifiers: - ArchiveName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Archive&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Archive" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Archive" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Archive" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/archives/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/archives/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/archives/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -988,12 +2056,13 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.EventPattern') as event_pattern, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.RetentionDays') as retention_days + JSON_EXTRACT(Properties, '$.RetentionDays') as retention_days, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Archive' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1003,17 +2072,24 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'EventPattern') as event_pattern, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RetentionDays') as retention_days + json_extract_path_text(Properties, 'RetentionDays') as retention_days, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Archive' AND data__Identifier = '' AND region = 'us-east-1' - connections: - name: connections - id: awscc.events.connections - x-cfn-schema-name: Connection - x-type: list + archives_list_only: + name: archives_list_only + id: awscc.events.archives_list_only + x-cfn-schema-name: Archive + x-cfn-type-name: AWS::Events::Archive x-identifiers: - - Name + - ArchiveName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1021,63 +2097,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' + JSON_EXTRACT(Properties, '$.ArchiveName') as archive_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' + json_extract_path_text(Properties, 'ArchiveName') as archive_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' AND region = 'us-east-1' - connection: - name: connection - id: awscc.events.connection + connections: + name: connections + id: awscc.events.connections x-cfn-schema-name: Connection - x-type: get + x-cfn-type-name: AWS::Events::Connection x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Connection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ArnForPolicy') as arn_for_policy, JSON_EXTRACT(Properties, '$.SecretArn') as secret_arn, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.AuthorizationType') as authorization_type, - JSON_EXTRACT(Properties, '$.AuthParameters') as auth_parameters + JSON_EXTRACT(Properties, '$.AuthParameters') as auth_parameters, + JSON_EXTRACT(Properties, '$.InvocationConnectivityParameters') as invocation_connectivity_parameters, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Connection' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ArnForPolicy') as arn_for_policy, json_extract_path_text(Properties, 'SecretArn') as secret_arn, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, - json_extract_path_text(Properties, 'AuthParameters') as auth_parameters + json_extract_path_text(Properties, 'AuthParameters') as auth_parameters, + json_extract_path_text(Properties, 'InvocationConnectivityParameters') as invocation_connectivity_parameters, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Connection' AND data__Identifier = '' AND region = 'us-east-1' - endpoints: - name: endpoints - id: awscc.events.endpoints - x-cfn-schema-name: Endpoint - x-type: list + connections_list_only: + name: connections_list_only + id: awscc.events.connections_list_only + x-cfn-schema-name: Connection + x-cfn-type-name: AWS::Events::Connection x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1086,7 +2222,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1094,19 +2230,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' AND region = 'us-east-1' - endpoint: - name: endpoint - id: awscc.events.endpoint + endpoints: + name: endpoints + id: awscc.events.endpoints x-cfn-schema-name: Endpoint - x-type: get + x-cfn-type-name: AWS::Events::Endpoint x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Endpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1126,7 +2310,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1145,13 +2329,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Endpoint' AND data__Identifier = '' AND region = 'us-east-1' - event_buses: - name: event_buses - id: awscc.events.event_buses - x-cfn-schema-name: EventBus - x-type: list + endpoints_list_only: + name: endpoints_list_only + id: awscc.events.endpoints_list_only + x-cfn-schema-name: Endpoint + x-cfn-type-name: AWS::Events::Endpoint x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1160,7 +2350,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1168,19 +2358,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' AND region = 'us-east-1' - event_bus: - name: event_bus - id: awscc.events.event_bus + event_buses: + name: event_buses + id: awscc.events.event_buses x-cfn-schema-name: EventBus - x-type: get + x-cfn-type-name: AWS::Events::EventBus x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventBus&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::EventBus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::EventBus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::EventBus" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_buses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_buses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_buses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1188,13 +2426,17 @@ components: JSON_EXTRACT(Properties, '$.EventSourceName') as event_source_name, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, JSON_EXTRACT(Properties, '$.Policy') as policy, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.DeadLetterConfig') as dead_letter_config, + JSON_EXTRACT(Properties, '$.LogConfig') as log_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::EventBus' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1202,18 +2444,28 @@ components: json_extract_path_text(Properties, 'EventSourceName') as event_source_name, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Arn') as arn + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DeadLetterConfig') as dead_letter_config, + json_extract_path_text(Properties, 'LogConfig') as log_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::EventBus' AND data__Identifier = '' AND region = 'us-east-1' - rules: - name: rules - id: awscc.events.rules - x-cfn-schema-name: Rule - x-type: list + event_buses_list_only: + name: event_buses_list_only + id: awscc.events.event_buses_list_only + x-cfn-schema-name: EventBus + x-cfn-type-name: AWS::Events::EventBus x-identifiers: - - Arn + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1221,28 +2473,89 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' AND region = 'us-east-1' - rule: - name: rule - id: awscc.events.rule + event_bus_policies: + name: event_bus_policies + id: awscc.events.event_bus_policies + x-cfn-schema-name: EventBusPolicy + x-cfn-type-name: AWS::Events::EventBusPolicy + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + rules: + name: rules + id: awscc.events.rules x-cfn-schema-name: Rule - x-type: get + x-cfn-type-name: AWS::Events::Rule x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Events::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1255,12 +2568,13 @@ components: JSON_EXTRACT(Properties, '$.Targets') as targets, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Rule' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1273,7 +2587,444 @@ components: json_extract_path_text(Properties, 'Targets') as targets, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Rule' AND data__Identifier = '' AND region = 'us-east-1' + rules_list_only: + name: rules_list_only + id: awscc.events.rules_list_only + x-cfn-schema-name: Rule + x-cfn-type-name: AWS::Events::Rule + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApiDestination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApiDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApiDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Archive&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateArchive + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateArchiveRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Endpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventBus&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventBus + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventBusRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/eventschemas.yaml b/providers/src/awscc/v00.00.00000/services/eventschemas.yaml index b9d2d9d5..b286ddca 100644 --- a/providers/src/awscc/v00.00.00000/services/eventschemas.yaml +++ b/providers/src/awscc/v00.00.00000/services/eventschemas.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: EventSchemas - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: TagsEntry: type: object @@ -47,7 +427,9 @@ components: required: - SourceArn x-stackql-resource-name: discoverer - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EventSchemas::Discoverer + x-type-name: AWS::EventSchemas::Discoverer + x-stackql-primary-identifier: - DiscovererArn x-create-only-properties: - SourceArn @@ -55,6 +437,18 @@ components: - DiscovererArn - DiscovererId - State + x-required-properties: + - SourceArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - schemas:TagResource + - schemas:UntagResource + - schemas:ListTagsForResource x-required-permissions: create: - schemas:CreateDiscoverer @@ -102,12 +496,24 @@ components: $ref: '#/components/schemas/TagsEntry' description: Tags associated with the resource. x-stackql-resource-name: registry - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EventSchemas::Registry + x-type-name: AWS::EventSchemas::Registry + x-stackql-primary-identifier: - RegistryArn x-create-only-properties: - RegistryName x-read-only-properties: - RegistryArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - schemas:TagResource + - schemas:UntagResource + - schemas:ListTagsForResource x-required-permissions: create: - schemas:DescribeRegistry @@ -141,10 +547,17 @@ components: - RegistryName - Policy x-stackql-resource-name: registry_policy - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EventSchemas::RegistryPolicy + x-type-name: AWS::EventSchemas::RegistryPolicy + x-stackql-primary-identifier: - Id x-read-only-properties: - Id + x-required-properties: + - RegistryName + - Policy + x-tagging: + taggable: false x-required-permissions: create: - schemas:PutResourcePolicy @@ -199,7 +612,9 @@ components: - Content - RegistryName x-stackql-resource-name: schema - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::EventSchemas::Schema + x-type-name: AWS::EventSchemas::Schema + x-stackql-primary-identifier: - SchemaArn x-create-only-properties: - SchemaName @@ -209,6 +624,20 @@ components: - LastModified - VersionCreatedDate - SchemaVersion + x-required-properties: + - Type + - Content + - RegistryName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - schemas:TagResource + - schemas:UntagResource + - schemas:ListTagsForResource x-required-permissions: create: - schemas:DescribeSchema @@ -229,43 +658,222 @@ components: list: - schemas:ListSchemas - schemas:ListSchemaVersions + CreateDiscovererRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DiscovererArn: + type: string + description: The ARN of the discoverer. + DiscovererId: + type: string + description: The Id of the discoverer. + Description: + type: string + description: A description for the discoverer. + SourceArn: + type: string + description: The ARN of the event bus. + CrossAccount: + type: boolean + default: true + description: Defines whether event schemas from other accounts are discovered. Default is True. + State: + type: string + description: Defines the current state of the discoverer. + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/TagsEntry' + description: Tags associated with the resource. + x-stackQL-stringOnly: true + x-title: CreateDiscovererRequest + type: object + required: [] + CreateRegistryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RegistryName: + type: string + description: The name of the schema registry. + Description: + type: string + description: A description of the registry to be created. + RegistryArn: + type: string + description: The ARN of the registry. + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/TagsEntry' + description: Tags associated with the resource. + x-stackQL-stringOnly: true + x-title: CreateRegistryRequest + type: object + required: [] + CreateRegistryPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Policy: + type: object + RegistryName: + type: string + RevisionId: + type: string + x-stackQL-stringOnly: true + x-title: CreateRegistryPolicyRequest + type: object + required: [] + CreateSchemaRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Type: + type: string + description: The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4. + Description: + type: string + description: A description of the schema. + SchemaVersion: + type: string + description: The version number of the schema. + Content: + type: string + description: The source of the schema definition. + RegistryName: + type: string + description: The name of the schema registry. + SchemaArn: + type: string + description: The ARN of the schema. + SchemaName: + type: string + description: The name of the schema. + LastModified: + type: string + description: The last modified time of the schema. + VersionCreatedDate: + type: string + description: The date the schema version was created. + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/TagsEntry' + description: Tags associated with the resource. + x-stackQL-stringOnly: true + x-title: CreateSchemaRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: discoverers: name: discoverers id: awscc.eventschemas.discoverers x-cfn-schema-name: Discoverer - x-type: list - x-identifiers: - - DiscovererArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DiscovererArn') as discoverer_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DiscovererArn') as discoverer_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' - AND region = 'us-east-1' - discoverer: - name: discoverer - id: awscc.eventschemas.discoverer - x-cfn-schema-name: Discoverer - x-type: get + x-cfn-type-name: AWS::EventSchemas::Discoverer x-identifiers: - DiscovererArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Discoverer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Discoverer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Discoverer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Discoverer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/discoverers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/discoverers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/discoverers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -281,7 +889,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -296,13 +904,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' AND data__Identifier = '' AND region = 'us-east-1' - registries: - name: registries - id: awscc.eventschemas.registries - x-cfn-schema-name: Registry - x-type: list + discoverers_list_only: + name: discoverers_list_only + id: awscc.eventschemas.discoverers_list_only + x-cfn-schema-name: Discoverer + x-cfn-type-name: AWS::EventSchemas::Discoverer x-identifiers: - - RegistryArn + - DiscovererArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -310,28 +924,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RegistryArn') as registry_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' + JSON_EXTRACT(Properties, '$.DiscovererArn') as discoverer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RegistryArn') as registry_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' + json_extract_path_text(Properties, 'DiscovererArn') as discoverer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' AND region = 'us-east-1' - eventschemas_registry: - name: eventschemas_registry - id: awscc.eventschemas.eventschemas_registry + registries: + name: registries + id: awscc.eventschemas.registries x-cfn-schema-name: Registry - x-type: get + x-cfn-type-name: AWS::EventSchemas::Registry x-identifiers: - RegistryArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Registry&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Registry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Registry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Registry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/registries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -344,7 +1006,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -356,17 +1018,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Registry' AND data__Identifier = '' AND region = 'us-east-1' - registry_policy: - name: registry_policy - id: awscc.eventschemas.registry_policy + registries_list_only: + name: registries_list_only + id: awscc.eventschemas.registries_list_only + x-cfn-schema-name: Registry + x-cfn-type-name: AWS::EventSchemas::Registry + x-identifiers: + - RegistryArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RegistryArn') as registry_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RegistryArn') as registry_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' + AND region = 'us-east-1' + registry_policies: + name: registry_policies + id: awscc.eventschemas.registry_policies x-cfn-schema-name: RegistryPolicy - x-type: get + x-cfn-type-name: AWS::EventSchemas::RegistryPolicy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RegistryPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::RegistryPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::RegistryPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::RegistryPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -379,7 +1120,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -395,38 +1136,61 @@ components: name: schemata id: awscc.eventschemas.schemata x-cfn-schema-name: Schema - x-type: list - x-identifiers: - - SchemaArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' - AND region = 'us-east-1' - schema: - name: schema - id: awscc.eventschemas.schema - x-cfn-schema-name: Schema - x-type: get + x-cfn-type-name: AWS::EventSchemas::Schema x-identifiers: - SchemaArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Schema&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Schema" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Schema" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EventSchemas::Schema" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schemata/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schemata/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/schemata/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -445,7 +1209,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -463,3 +1227,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Schema' AND data__Identifier = '' AND region = 'us-east-1' + schemata_list_only: + name: schemata_list_only + id: awscc.eventschemas.schemata_list_only + x-cfn-schema-name: Schema + x-cfn-type-name: AWS::EventSchemas::Schema + x-identifiers: + - SchemaArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Discoverer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDiscoverer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDiscovererRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Registry&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRegistry + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRegistryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RegistryPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRegistryPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRegistryPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Schema&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchema + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSchemaRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/evidently.yaml b/providers/src/awscc/v00.00.00000/services/evidently.yaml index 7c051a6d..fa18f0dd 100644 --- a/providers/src/awscc/v00.00.00000/services/evidently.yaml +++ b/providers/src/awscc/v00.00.00000/services/evidently.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Evidently - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: RunningStatusObject: type: object @@ -207,13 +587,22 @@ components: - MetricGoals - OnlineAbConfig x-stackql-resource-name: experiment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Evidently::Experiment. + x-type-name: AWS::Evidently::Experiment + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name - Project x-read-only-properties: - Arn + x-required-properties: + - Name + - Project + - Treatments + - MetricGoals + - OnlineAbConfig + x-taggable: true x-required-permissions: create: - evidently:CreateExperiment @@ -337,13 +726,20 @@ components: - Project - Variations x-stackql-resource-name: feature - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Evidently::Feature. + x-type-name: AWS::Evidently::Feature + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name - Project x-read-only-properties: - Arn + x-required-properties: + - Name + - Project + - Variations + x-taggable: true x-required-permissions: create: - evidently:CreateFeature @@ -546,13 +942,21 @@ components: - Groups - ScheduledSplitsConfig x-stackql-resource-name: launch - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Evidently::Launch. + x-type-name: AWS::Evidently::Launch + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name - Project x-read-only-properties: - Arn + x-required-properties: + - Name + - Project + - Groups + - ScheduledSplitsConfig + x-taggable: true x-required-permissions: create: - evidently:CreateLaunch @@ -651,12 +1055,17 @@ components: required: - Name x-stackql-resource-name: project - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Evidently::Project + x-type-name: AWS::Evidently::Project + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + x-taggable: true x-required-permissions: create: - evidently:CreateProject @@ -751,10 +1160,20 @@ components: required: - Name x-stackql-resource-name: segment - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Evidently::Segment + x-type-name: AWS::Evidently::Segment + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - evidently:CreateSegment @@ -770,18 +1189,377 @@ components: list: - evidently:ListSegment - evidently:ListTagsForResource + CreateExperimentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/experiment/[-a-zA-Z0-9._]* + Name: + type: string + pattern: '[-a-zA-Z0-9._]*' + minLength: 1 + maxLength: 127 + Project: + type: string + pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*) + minLength: 0 + maxLength: 2048 + Description: + type: string + minLength: 0 + maxLength: 160 + RunningStatus: + description: Start Experiment. Default is False + $ref: '#/components/schemas/RunningStatusObject' + RandomizationSalt: + type: string + minLength: 0 + maxLength: 127 + pattern: .* + Treatments: + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/TreatmentObject' + minItems: 2 + maxItems: 5 + MetricGoals: + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/MetricGoalObject' + minItems: 1 + maxItems: 3 + SamplingRate: + type: integer + minimum: 0 + maximum: 100000 + OnlineAbConfig: + $ref: '#/components/schemas/OnlineAbConfigObject' + Segment: + type: string + minLength: 0 + maxLength: 2048 + pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*) + RemoveSegment: + type: boolean + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateExperimentRequest + type: object + required: [] + CreateFeatureRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/feature/[-a-zA-Z0-9._]* + minLength: 0 + maxLength: 2048 + Project: + type: string + pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*) + minLength: 0 + maxLength: 2048 + Name: + type: string + pattern: '[-a-zA-Z0-9._]*' + minLength: 1 + maxLength: 127 + Description: + type: string + minLength: 0 + maxLength: 160 + EvaluationStrategy: + type: string + enum: + - ALL_RULES + - DEFAULT_VARIATION + Variations: + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/VariationObject' + minItems: 1 + maxItems: 5 + DefaultVariation: + type: string + pattern: '[-a-zA-Z0-9._]*' + minLength: 1 + maxLength: 127 + EntityOverrides: + type: array + items: + $ref: '#/components/schemas/EntityOverride' + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 2500 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFeatureRequest + type: object + required: [] + CreateLaunchRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/launch/[-a-zA-Z0-9._]* + Name: + type: string + pattern: '[-a-zA-Z0-9._]*' + minLength: 1 + maxLength: 127 + Project: + type: string + pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*) + minLength: 0 + maxLength: 2048 + Description: + type: string + minLength: 0 + maxLength: 160 + RandomizationSalt: + type: string + minLength: 0 + maxLength: 127 + pattern: .* + ScheduledSplitsConfig: + type: array + items: + $ref: '#/components/schemas/StepConfig' + uniqueItems: true + x-insertionOrder: true + minItems: 1 + maxItems: 6 + Groups: + type: array + items: + $ref: '#/components/schemas/LaunchGroupObject' + uniqueItems: true + x-insertionOrder: true + minItems: 1 + maxItems: 5 + MetricMonitors: + type: array + items: + $ref: '#/components/schemas/MetricDefinitionObject' + uniqueItems: true + x-insertionOrder: true + minItems: 0 + maxItems: 3 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + ExecutionStatus: + description: Start or Stop Launch Launch. Default is not started. + $ref: '#/components/schemas/ExecutionStatusObject' + x-stackQL-stringOnly: true + x-title: CreateLaunchRequest + type: object + required: [] + CreateProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]* + minLength: 0 + maxLength: 2048 + Name: + type: string + pattern: '[-a-zA-Z0-9._]*' + minLength: 1 + maxLength: 127 + Description: + type: string + minLength: 0 + maxLength: 160 + DataDelivery: + $ref: '#/components/schemas/DataDeliveryObject' + AppConfigResource: + $ref: '#/components/schemas/AppConfigResourceObject' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateProjectRequest + type: object + required: [] + CreateSegmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]* + minLength: 0 + maxLength: 2048 + Name: + type: string + pattern: '[-a-zA-Z0-9._]*' + minLength: 1 + maxLength: 127 + Description: + type: string + minLength: 0 + maxLength: 160 + Pattern: + type: string + minLength: 1 + maxLength: 1024 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSegmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - experiment: - name: experiment - id: awscc.evidently.experiment + experiments: + name: experiments + id: awscc.evidently.experiments x-cfn-schema-name: Experiment - x-type: get + x-cfn-type-name: AWS::Evidently::Experiment x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Experiment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Experiment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Experiment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Experiment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/experiments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/experiments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/experiments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -803,7 +1581,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -824,17 +1602,65 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Experiment' AND data__Identifier = '' AND region = 'us-east-1' - feature: - name: feature - id: awscc.evidently.feature + features: + name: features + id: awscc.evidently.features x-cfn-schema-name: Feature - x-type: get + x-cfn-type-name: AWS::Evidently::Feature x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Feature&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Feature" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Feature" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Feature" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/features/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/features/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/features/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -852,7 +1678,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -869,17 +1695,65 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Feature' AND data__Identifier = '' AND region = 'us-east-1' - launch: - name: launch - id: awscc.evidently.launch + launches: + name: launches + id: awscc.evidently.launches x-cfn-schema-name: Launch - x-type: get + x-cfn-type-name: AWS::Evidently::Launch x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Launch&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Launch" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Launch" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Launch" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/launches/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/launches/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/launches/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -898,7 +1772,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -916,17 +1790,65 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Launch' AND data__Identifier = '' AND region = 'us-east-1' - project: - name: project - id: awscc.evidently.project + projects: + name: projects + id: awscc.evidently.projects x-cfn-schema-name: Project - x-type: get + x-cfn-type-name: AWS::Evidently::Project x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -941,7 +1863,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -959,34 +1881,87 @@ components: name: segments id: awscc.evidently.segments x-cfn-schema-name: Segment - x-type: list + x-cfn-type-name: AWS::Evidently::Segment x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Segment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Segment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Evidently::Segment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/segments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/segments/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Pattern') as pattern, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Segment' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Pattern') as pattern, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Segment' + AND data__Identifier = '' AND region = 'us-east-1' - segment: - name: segment - id: awscc.evidently.segment + segments_list_only: + name: segments_list_only + id: awscc.evidently.segments_list_only x-cfn-schema-name: Segment - x-type: get + x-cfn-type-name: AWS::Evidently::Segment x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -994,26 +1969,377 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Pattern') as pattern, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Segment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Pattern') as pattern, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Segment' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Experiment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateExperiment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateExperimentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Feature&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFeature + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFeatureRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Launch&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLaunch + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLaunchRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Segment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSegment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSegmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/evs.yaml b/providers/src/awscc/v00.00.00000/services/evs.yaml new file mode 100644 index 00000000..8e00e06a --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/evs.yaml @@ -0,0 +1,1300 @@ +openapi: 3.0.0 +info: + title: EVS + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + InitialVlanInfo: + type: object + properties: + Cidr: + type: string + pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[1-2][0-9]|[0-9])$ + required: + - Cidr + HostName: + type: string + pattern: ^([a-zA-Z0-9\-]*)$ + HostInfoForCreate: + type: object + properties: + HostName: + $ref: '#/components/schemas/HostName' + KeyName: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 255 + InstanceType: + type: string + enum: + - i4i.metal + PlacementGroupId: + type: string + pattern: ^pg-[a-f0-9]{8}([a-f0-9]{9})?$ + minLength: 1 + maxLength: 25 + DedicatedHostId: + type: string + pattern: ^h-[a-f0-9]{8}([a-f0-9]{9})?$ + minLength: 1 + maxLength: 25 + required: + - HostName + - KeyName + - InstanceType + x-dependencies: + PlacementGroupId: + oneOf: + - required: + - DedicatedHostId + - {} + RouteServerPeering: + type: string + minLength: 3 + maxLength: 21 + EnvironmentState: + type: string + enum: + - CREATING + - CREATED + - DELETING + - DELETED + - CREATE_FAILED + CheckResult: + type: string + enum: + - PASSED + - FAILED + - UNKNOWN + Check: + type: object + properties: + Type: + type: string + enum: + - KEY_REUSE + - KEY_COVERAGE + - REACHABILITY + - VCF_VERSION + - HOST_COUNT + Result: + $ref: '#/components/schemas/CheckResult' + ImpairedSince: + type: string + required: + - Type + - Result + Secret: + type: object + properties: + SecretArn: + type: string + SecurityGroupId: + type: string + pattern: ^sg-[0-9a-zA-Z]*$ + minLength: 3 + maxLength: 25 + Timestamp: + type: string + Environment: + type: object + properties: + EnvironmentName: + description: The name of an EVS environment + type: string + pattern: ^[a-zA-Z0-9_-]{1,100}$ + KmsKeyId: + type: string + VpcId: + type: string + pattern: ^vpc-[a-f0-9]{8}([a-f0-9]{9})?$ + minLength: 12 + maxLength: 21 + ServiceAccessSubnetId: + type: string + pattern: ^subnet-[a-f0-9]{8}([a-f0-9]{9})?$ + minLength: 15 + maxLength: 24 + VcfVersion: + type: string + enum: + - VCF-5.2.1 + TermsAccepted: + type: boolean + LicenseInfo: + description: The license information for an EVS environment + type: object + properties: + SolutionKey: + type: string + pattern: ^[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}$ + VsanKey: + type: string + pattern: ^[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}$ + required: + - SolutionKey + - VsanKey + additionalProperties: false + InitialVlans: + description: The initial Vlan configuration only required upon creation. Modification after creation will have no effect + type: object + properties: + VmkManagement: + $ref: '#/components/schemas/InitialVlanInfo' + VmManagement: + $ref: '#/components/schemas/InitialVlanInfo' + VMotion: + $ref: '#/components/schemas/InitialVlanInfo' + VSan: + $ref: '#/components/schemas/InitialVlanInfo' + VTep: + $ref: '#/components/schemas/InitialVlanInfo' + EdgeVTep: + $ref: '#/components/schemas/InitialVlanInfo' + NsxUpLink: + $ref: '#/components/schemas/InitialVlanInfo' + Hcx: + $ref: '#/components/schemas/InitialVlanInfo' + ExpansionVlan1: + $ref: '#/components/schemas/InitialVlanInfo' + ExpansionVlan2: + $ref: '#/components/schemas/InitialVlanInfo' + required: + - VmkManagement + - VmManagement + - VMotion + - VSan + - VTep + - EdgeVTep + - NsxUpLink + - Hcx + - ExpansionVlan1 + - ExpansionVlan2 + Hosts: + description: The initial hosts for environment only required upon creation. Modification after creation will have no effect + type: array + items: + $ref: '#/components/schemas/HostInfoForCreate' + minItems: 4 + maxItems: 4 + x-insertionOrder: true + ConnectivityInfo: + type: object + properties: + PrivateRouteServerPeerings: + type: array + items: + $ref: '#/components/schemas/RouteServerPeering' + minItems: 2 + maxItems: 2 + required: + - PrivateRouteServerPeerings + VcfHostnames: + type: object + properties: + VCenter: + $ref: '#/components/schemas/HostName' + Nsx: + $ref: '#/components/schemas/HostName' + NsxManager1: + $ref: '#/components/schemas/HostName' + NsxManager2: + $ref: '#/components/schemas/HostName' + NsxManager3: + $ref: '#/components/schemas/HostName' + NsxEdge1: + $ref: '#/components/schemas/HostName' + NsxEdge2: + $ref: '#/components/schemas/HostName' + SddcManager: + $ref: '#/components/schemas/HostName' + CloudBuilder: + $ref: '#/components/schemas/HostName' + required: + - VCenter + - Nsx + - NsxManager1 + - NsxManager2 + - NsxManager3 + - NsxEdge1 + - NsxEdge2 + - SddcManager + - CloudBuilder + SiteId: + type: string + EnvironmentId: + type: string + pattern: ^(env-[a-zA-Z0-9]{10})$ + EnvironmentArn: + type: string + pattern: ^arn:aws:evs:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:environment/[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 1011 + EnvironmentState: + $ref: '#/components/schemas/EnvironmentState' + StateDetails: + type: string + Checks: + type: array + items: + $ref: '#/components/schemas/Check' + Credentials: + type: array + items: + $ref: '#/components/schemas/Secret' + ServiceAccessSecurityGroups: + type: object + properties: + SecurityGroups: + type: array + items: + $ref: '#/components/schemas/SecurityGroupId' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + $ref: '#/components/schemas/Timestamp' + ModifiedAt: + $ref: '#/components/schemas/Timestamp' + required: + - VpcId + - ServiceAccessSubnetId + - VcfVersion + - TermsAccepted + - LicenseInfo + - ConnectivityInfo + - VcfHostnames + - SiteId + x-stackql-resource-name: environment + description: An environment created within the EVS service + x-type-name: AWS::EVS::Environment + x-stackql-primary-identifier: + - EnvironmentId + x-create-only-properties: + - EnvironmentName + - VpcId + - ServiceAccessSubnetId + - VcfVersion + - TermsAccepted + - LicenseInfo + - ConnectivityInfo + - VcfHostnames + - SiteId + - KmsKeyId + - ServiceAccessSecurityGroups + x-write-only-properties: + - Hosts + - InitialVlans + x-read-only-properties: + - EnvironmentId + - Checks + - EnvironmentArn + - Credentials + - EnvironmentState + - StateDetails + - CreatedAt + - ModifiedAt + x-required-properties: + - VpcId + - ServiceAccessSubnetId + - VcfVersion + - TermsAccepted + - LicenseInfo + - ConnectivityInfo + - VcfHostnames + - SiteId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - evs:UntagResource + - evs:TagResource + - evs:ListTagsForResource + x-required-permissions: + create: + - evs:CreateEnvironment + - evs:GetEnvironment + - evs:TagResource + - evs:ListTagsForResource + - iam:CreateServiceLinkedRole + - support:DescribeServices + - support:DescribeSupportLevel + - servicequotas:GetServiceQuota + - servicequotas:ListServiceQuotas + - ec2:CreateNetworkInterface + - ec2:AllocateHosts + - ec2:ModifyNetworkInterfaceAttribute + - ec2:DeleteNetworkInterface + - ec2:RunInstances + - ec2:CreatePlacementGroup + - ec2:CreateSubnet + - ec2:CreateTags + - secretsmanager:GetRandomPassword + - secretsmanager:CreateSecret + - secretsmanager:GetSecretValue + - secretsmanager:BatchGetSecretValue + - secretsmanager:TagResource + - kms:ListKeysForService + - kms:DescribeKey + - secretsmanager:UpdateSecret + - ec2:DeleteVolume + - ec2:DetachVolume + read: + - evs:GetEnvironment + - evs:ListTagsForResource + update: + - evs:TagResource + - evs:UntagResource + - evs:ListTagsForResource + - evs:GetEnvironment + delete: + - evs:DeleteEnvironment + - evs:GetEnvironment + - evs:UntagResource + - ec2:TerminateInstances + - ec2:ReleaseHosts + - ec2:DescribeHosts + - ec2:DeleteSubnet + - ec2:DetachNetworkInterface + - ec2:DeletePlacementGroup + - secretsmanager:DeleteSecret + list: + - evs:ListEnvironments + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EnvironmentName: + description: The name of an EVS environment + type: string + pattern: ^[a-zA-Z0-9_-]{1,100}$ + KmsKeyId: + type: string + VpcId: + type: string + pattern: ^vpc-[a-f0-9]{8}([a-f0-9]{9})?$ + minLength: 12 + maxLength: 21 + ServiceAccessSubnetId: + type: string + pattern: ^subnet-[a-f0-9]{8}([a-f0-9]{9})?$ + minLength: 15 + maxLength: 24 + VcfVersion: + type: string + enum: + - VCF-5.2.1 + TermsAccepted: + type: boolean + LicenseInfo: + description: The license information for an EVS environment + type: object + properties: + SolutionKey: + type: string + pattern: ^[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}$ + VsanKey: + type: string + pattern: ^[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}$ + required: + - SolutionKey + - VsanKey + additionalProperties: false + InitialVlans: + description: The initial Vlan configuration only required upon creation. Modification after creation will have no effect + type: object + properties: + VmkManagement: + $ref: '#/components/schemas/InitialVlanInfo' + VmManagement: + $ref: '#/components/schemas/InitialVlanInfo' + VMotion: + $ref: '#/components/schemas/InitialVlanInfo' + VSan: + $ref: '#/components/schemas/InitialVlanInfo' + VTep: + $ref: '#/components/schemas/InitialVlanInfo' + EdgeVTep: + $ref: '#/components/schemas/InitialVlanInfo' + NsxUpLink: + $ref: '#/components/schemas/InitialVlanInfo' + Hcx: + $ref: '#/components/schemas/InitialVlanInfo' + ExpansionVlan1: + $ref: '#/components/schemas/InitialVlanInfo' + ExpansionVlan2: + $ref: '#/components/schemas/InitialVlanInfo' + required: + - VmkManagement + - VmManagement + - VMotion + - VSan + - VTep + - EdgeVTep + - NsxUpLink + - Hcx + - ExpansionVlan1 + - ExpansionVlan2 + Hosts: + description: The initial hosts for environment only required upon creation. Modification after creation will have no effect + type: array + items: + $ref: '#/components/schemas/HostInfoForCreate' + minItems: 4 + maxItems: 4 + x-insertionOrder: true + ConnectivityInfo: + type: object + properties: + PrivateRouteServerPeerings: + type: array + items: + $ref: '#/components/schemas/RouteServerPeering' + minItems: 2 + maxItems: 2 + required: + - PrivateRouteServerPeerings + VcfHostnames: + type: object + properties: + VCenter: + $ref: '#/components/schemas/HostName' + Nsx: + $ref: '#/components/schemas/HostName' + NsxManager1: + $ref: '#/components/schemas/HostName' + NsxManager2: + $ref: '#/components/schemas/HostName' + NsxManager3: + $ref: '#/components/schemas/HostName' + NsxEdge1: + $ref: '#/components/schemas/HostName' + NsxEdge2: + $ref: '#/components/schemas/HostName' + SddcManager: + $ref: '#/components/schemas/HostName' + CloudBuilder: + $ref: '#/components/schemas/HostName' + required: + - VCenter + - Nsx + - NsxManager1 + - NsxManager2 + - NsxManager3 + - NsxEdge1 + - NsxEdge2 + - SddcManager + - CloudBuilder + SiteId: + type: string + EnvironmentId: + type: string + pattern: ^(env-[a-zA-Z0-9]{10})$ + EnvironmentArn: + type: string + pattern: ^arn:aws:evs:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:environment/[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 1011 + EnvironmentState: + $ref: '#/components/schemas/EnvironmentState' + StateDetails: + type: string + Checks: + type: array + items: + $ref: '#/components/schemas/Check' + Credentials: + type: array + items: + $ref: '#/components/schemas/Secret' + ServiceAccessSecurityGroups: + type: object + properties: + SecurityGroups: + type: array + items: + $ref: '#/components/schemas/SecurityGroupId' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + $ref: '#/components/schemas/Timestamp' + ModifiedAt: + $ref: '#/components/schemas/Timestamp' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + environments: + name: environments + id: awscc.evs.environments + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::EVS::Environment + x-identifiers: + - EnvironmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EVS::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EVS::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EVS::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.ServiceAccessSubnetId') as service_access_subnet_id, + JSON_EXTRACT(Properties, '$.VcfVersion') as vcf_version, + JSON_EXTRACT(Properties, '$.TermsAccepted') as terms_accepted, + JSON_EXTRACT(Properties, '$.LicenseInfo') as license_info, + JSON_EXTRACT(Properties, '$.InitialVlans') as initial_vlans, + JSON_EXTRACT(Properties, '$.Hosts') as hosts, + JSON_EXTRACT(Properties, '$.ConnectivityInfo') as connectivity_info, + JSON_EXTRACT(Properties, '$.VcfHostnames') as vcf_hostnames, + JSON_EXTRACT(Properties, '$.SiteId') as site_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.EnvironmentArn') as environment_arn, + JSON_EXTRACT(Properties, '$.EnvironmentState') as environment_state, + JSON_EXTRACT(Properties, '$.StateDetails') as state_details, + JSON_EXTRACT(Properties, '$.Checks') as checks, + JSON_EXTRACT(Properties, '$.Credentials') as credentials, + JSON_EXTRACT(Properties, '$.ServiceAccessSecurityGroups') as service_access_security_groups, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EVS::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'ServiceAccessSubnetId') as service_access_subnet_id, + json_extract_path_text(Properties, 'VcfVersion') as vcf_version, + json_extract_path_text(Properties, 'TermsAccepted') as terms_accepted, + json_extract_path_text(Properties, 'LicenseInfo') as license_info, + json_extract_path_text(Properties, 'InitialVlans') as initial_vlans, + json_extract_path_text(Properties, 'Hosts') as hosts, + json_extract_path_text(Properties, 'ConnectivityInfo') as connectivity_info, + json_extract_path_text(Properties, 'VcfHostnames') as vcf_hostnames, + json_extract_path_text(Properties, 'SiteId') as site_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn, + json_extract_path_text(Properties, 'EnvironmentState') as environment_state, + json_extract_path_text(Properties, 'StateDetails') as state_details, + json_extract_path_text(Properties, 'Checks') as checks, + json_extract_path_text(Properties, 'Credentials') as credentials, + json_extract_path_text(Properties, 'ServiceAccessSecurityGroups') as service_access_security_groups, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::EVS::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.evs.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::EVS::Environment + x-identifiers: + - EnvironmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EVS::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::EVS::Environment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/finspace.yaml b/providers/src/awscc/v00.00.00000/services/finspace.yaml index 67cd99e6..4dc7ff2d 100644 --- a/providers/src/awscc/v00.00.00000/services/finspace.yaml +++ b/providers/src/awscc/v00.00.00000/services/finspace.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: FinSpace - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: FederationParameters: description: Additional parameters to identify Federation mode @@ -175,7 +555,9 @@ components: required: - Name x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::FinSpace::Environment + x-stackql-primary-identifier: - EnvironmentId x-create-only-properties: - KmsKeyId @@ -183,6 +565,10 @@ components: - FederationParameters - DataBundles - Tags + x-write-only-properties: + - SuperuserParameters + - FederationParameters/AttributeMap + - Tags x-read-only-properties: - EnvironmentId - Status @@ -191,6 +577,14 @@ components: - EnvironmentUrl - AwsAccountId - DedicatedServiceAccountId + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - finspace:CreateEnvironment @@ -206,43 +600,163 @@ components: - finspace:GetEnvironment list: - finspace:ListEnvironments + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EnvironmentId: + description: Unique identifier for representing FinSpace Environment + type: string + pattern: ^[a-zA-Z0-9]{1,26}$ + Name: + description: Name of the Environment + type: string + pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]{1,255}$ + AwsAccountId: + description: AWS account ID associated with the Environment + type: string + pattern: ^[a-zA-Z0-9]{1,26}$ + Description: + description: Description of the Environment + type: string + pattern: ^[a-zA-Z0-9. ]{1,1000}$ + Status: + description: State of the Environment + type: string + enum: + - CREATE_REQUESTED + - CREATING + - CREATED + - DELETE_REQUESTED + - DELETING + - DELETED + - FAILED_CREATION + - FAILED_DELETION + - RETRY_DELETION + - SUSPENDED + EnvironmentUrl: + description: URL used to login to the Environment + type: string + pattern: ^[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000} + EnvironmentArn: + description: ARN of the Environment + type: string + pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$ + SageMakerStudioDomainUrl: + description: SageMaker Studio Domain URL associated with the Environment + type: string + pattern: ^[a-zA-Z-0-9-:\/.]*{1,1000}$ + KmsKeyId: + description: KMS key used to encrypt customer data within FinSpace Environment infrastructure + type: string + pattern: ^[a-zA-Z-0-9-:\/]*{1,1000}$ + DedicatedServiceAccountId: + description: ID for FinSpace created account used to store Environment artifacts + type: string + pattern: ^[a-zA-Z0-9]{1,26}$ + FederationMode: + description: Federation mode used with the Environment + type: string + enum: + - LOCAL + - FEDERATED + FederationParameters: + $ref: '#/components/schemas/FederationParameters' + SuperuserParameters: + $ref: '#/components/schemas/SuperuserParameters' + DataBundles: + description: ARNs of FinSpace Data Bundles to install + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/DataBundleArn' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: environments: name: environments id: awscc.finspace.environments x-cfn-schema-name: Environment - x-type: list - x-identifiers: - - EnvironmentId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: awscc.finspace.environment - x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::FinSpace::Environment x-identifiers: - EnvironmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FinSpace::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FinSpace::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FinSpace::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -266,7 +780,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -289,3 +803,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FinSpace::Environment' AND data__Identifier = '' AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.finspace.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::FinSpace::Environment + x-identifiers: + - EnvironmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/fis.yaml b/providers/src/awscc/v00.00.00000/services/fis.yaml index ba245c50..eeea14c3 100644 --- a/providers/src/awscc/v00.00.00000/services/fis.yaml +++ b/providers/src/awscc/v00.00.00000/services/fis.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: FIS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ExperimentTemplateId: type: string @@ -28,6 +408,16 @@ components: $ref: '#/components/schemas/StopConditionValue' required: - Source + CloudWatchDashboard: + type: object + additionalProperties: false + properties: + DashboardIdentifier: + type: string + minLength: 1 + maxLength: 512 + required: + - DashboardIdentifier ExperimentTemplateStopConditionList: type: array description: One or more stop conditions. @@ -196,7 +586,7 @@ components: Prefix: type: string minLength: 1 - maxLength: 1024 + maxLength: 700 required: - BucketName LogSchemaVersion: @@ -220,6 +610,44 @@ components: enum: - fail - skip + ExperimentTemplateExperimentReportConfiguration: + type: object + additionalProperties: false + required: + - Outputs + properties: + Outputs: + type: object + additionalProperties: false + properties: + ExperimentReportS3Configuration: + type: object + additionalProperties: false + properties: + BucketName: + type: string + minLength: 3 + maxLength: 63 + Prefix: + type: string + minLength: 1 + maxLength: 256 + required: + - BucketName + required: + - ExperimentReportS3Configuration + DataSources: + type: object + additionalProperties: false + properties: + CloudWatchDashboards: + type: array + items: + $ref: '#/components/schemas/CloudWatchDashboard' + PreExperimentDuration: + type: string + PostExperimentDuration: + type: string RoleArn: type: string description: The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf. @@ -250,20 +678,37 @@ components: additionalProperties: false ExperimentOptions: $ref: '#/components/schemas/ExperimentTemplateExperimentOptions' + ExperimentReportConfiguration: + $ref: '#/components/schemas/ExperimentTemplateExperimentReportConfiguration' required: - Description - StopConditions - Targets - RoleArn - - Tags x-stackql-resource-name: experiment_template - x-stackql-primaryIdentifier: + description: Resource schema for AWS::FIS::ExperimentTemplate + x-type-name: AWS::FIS::ExperimentTemplate + x-stackql-primary-identifier: - Id x-create-only-properties: - - Tags - - ExperimentOptions/properties/AccountTargeting + - ExperimentOptions/AccountTargeting x-read-only-properties: - Id + x-required-properties: + - Description + - StopConditions + - Targets + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - fis:TagResource + - fis:UntagResource + - fis:ListTagsForResource x-required-permissions: create: - fis:CreateExperimentTemplate @@ -313,12 +758,23 @@ components: - AccountId - RoleArn x-stackql-resource-name: target_account_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::FIS::TargetAccountConfiguration + x-type-name: AWS::FIS::TargetAccountConfiguration + x-stackql-primary-identifier: - ExperimentTemplateId - AccountId x-create-only-properties: - ExperimentTemplateId - AccountId + x-required-properties: + - ExperimentTemplateId + - AccountId + - RoleArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - fis:CreateTargetAccountConfiguration @@ -330,43 +786,140 @@ components: - fis:DeleteTargetAccountConfiguration list: - fis:ListTargetAccountConfigurations + CreateExperimentTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/ExperimentTemplateId' + Description: + $ref: '#/components/schemas/ExperimentTemplateDescription' + Targets: + $ref: '#/components/schemas/ExperimentTemplateTargetMap' + Actions: + $ref: '#/components/schemas/ExperimentTemplateActionMap' + StopConditions: + $ref: '#/components/schemas/ExperimentTemplateStopConditionList' + LogConfiguration: + $ref: '#/components/schemas/ExperimentTemplateLogConfiguration' + RoleArn: + $ref: '#/components/schemas/RoleArn' + Tags: + type: object + x-patternProperties: + .{1,128}: + type: string + maxLength: 256 + additionalProperties: false + ExperimentOptions: + $ref: '#/components/schemas/ExperimentTemplateExperimentOptions' + ExperimentReportConfiguration: + $ref: '#/components/schemas/ExperimentTemplateExperimentReportConfiguration' + x-stackQL-stringOnly: true + x-title: CreateExperimentTemplateRequest + type: object + required: [] + CreateTargetAccountConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ExperimentTemplateId: + $ref: '#/components/schemas/TargetExperimentTemplateId' + AccountId: + $ref: '#/components/schemas/TargetAccountId' + RoleArn: + $ref: '#/components/schemas/TargetAccountRoleArn' + Description: + $ref: '#/components/schemas/TargetAccountConfigurationDescription' + x-stackQL-stringOnly: true + x-title: CreateTargetAccountConfigurationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: experiment_templates: name: experiment_templates id: awscc.fis.experiment_templates x-cfn-schema-name: ExperimentTemplate - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' - AND region = 'us-east-1' - experiment_template: - name: experiment_template - id: awscc.fis.experiment_template - x-cfn-schema-name: ExperimentTemplate - x-type: get + x-cfn-type-name: AWS::FIS::ExperimentTemplate x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ExperimentTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FIS::ExperimentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FIS::ExperimentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FIS::ExperimentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -379,12 +932,13 @@ components: JSON_EXTRACT(Properties, '$.LogConfiguration') as log_configuration, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ExperimentOptions') as experiment_options + JSON_EXTRACT(Properties, '$.ExperimentOptions') as experiment_options, + JSON_EXTRACT(Properties, '$.ExperimentReportConfiguration') as experiment_report_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -397,18 +951,24 @@ components: json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, json_extract_path_text(Properties, 'RoleArn') as role_arn, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ExperimentOptions') as experiment_options + json_extract_path_text(Properties, 'ExperimentOptions') as experiment_options, + json_extract_path_text(Properties, 'ExperimentReportConfiguration') as experiment_report_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' AND data__Identifier = '' AND region = 'us-east-1' - target_account_configurations: - name: target_account_configurations - id: awscc.fis.target_account_configurations - x-cfn-schema-name: TargetAccountConfiguration - x-type: list + experiment_templates_list_only: + name: experiment_templates_list_only + id: awscc.fis.experiment_templates_list_only + x-cfn-schema-name: ExperimentTemplate + x-cfn-type-name: AWS::FIS::ExperimentTemplate x-identifiers: - - ExperimentTemplateId - - AccountId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -416,31 +976,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ExperimentTemplateId') as experiment_template_id, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ExperimentTemplateId') as experiment_template_id, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' AND region = 'us-east-1' - target_account_configuration: - name: target_account_configuration - id: awscc.fis.target_account_configuration + target_account_configurations: + name: target_account_configurations + id: awscc.fis.target_account_configurations x-cfn-schema-name: TargetAccountConfiguration - x-type: get + x-cfn-type-name: AWS::FIS::TargetAccountConfiguration x-identifiers: - ExperimentTemplateId - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TargetAccountConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FIS::TargetAccountConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FIS::TargetAccountConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FIS::TargetAccountConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -453,7 +1059,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -465,3 +1071,274 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' AND data__Identifier = '|' AND region = 'us-east-1' + target_account_configurations_list_only: + name: target_account_configurations_list_only + id: awscc.fis.target_account_configurations_list_only + x-cfn-schema-name: TargetAccountConfiguration + x-cfn-type-name: AWS::FIS::TargetAccountConfiguration + x-identifiers: + - ExperimentTemplateId + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ExperimentTemplateId') as experiment_template_id, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ExperimentTemplateId') as experiment_template_id, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ExperimentTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateExperimentTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateExperimentTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TargetAccountConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTargetAccountConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTargetAccountConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/fms.yaml b/providers/src/awscc/v00.00.00000/services/fms.yaml index fb391a73..01fd7c64 100644 --- a/providers/src/awscc/v00.00.00000/services/fms.yaml +++ b/providers/src/awscc/v00.00.00000/services/fms.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: FMS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ResourceArn: description: A resource ARN. @@ -22,7 +402,12 @@ components: - SnsRoleName - SnsTopicArn x-stackql-resource-name: notification_channel - x-stackql-primaryIdentifier: + description: Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. + x-type-name: AWS::FMS::NotificationChannel + x-stackql-primary-identifier: + - SnsTopicArn + x-required-properties: + - SnsRoleName - SnsTopicArn x-required-permissions: create: @@ -126,11 +511,105 @@ components: enum: - DISTRIBUTED - CENTRALIZED + NetworkAclEntry: + description: Network ACL entry. + type: object + properties: + CidrBlock: + description: CIDR block. + type: string + pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ + Egress: + description: Whether the entry is an egress entry. + type: boolean + IcmpTypeCode: + description: ICMP type and code. + type: object + properties: + Code: + description: Code. + type: integer + minimum: 0 + maximum: 255 + Type: + description: Type. + type: integer + minimum: 0 + maximum: 255 + additionalProperties: false + required: + - Code + - Type + Ipv6CidrBlock: + type: string + description: IPv6 CIDR block. + pattern: >- + ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))(/(1[0-2]|[0-9]))?$ + PortRange: + type: object + description: Port range. + properties: + From: + description: From Port. + type: integer + minimum: 0 + maximum: 65535 + To: + description: To Port. + type: integer + minimum: 0 + maximum: 65535 + additionalProperties: false + required: + - From + - To + Protocol: + description: Protocol. + type: string + pattern: ^(tcp|udp|icmp|-1|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$ + RuleAction: + description: Rule Action. + type: string + enum: + - allow + - deny + additionalProperties: false + required: + - Egress + - Protocol + - RuleAction + NetworkAclEntryList: + description: NetworkAcl entry list. + type: array + items: + $ref: '#/components/schemas/NetworkAclEntry' + x-insertionOrder: true + NetworkAclEntrySet: + description: Network ACL entry set. + type: object + properties: + FirstEntries: + $ref: '#/components/schemas/NetworkAclEntryList' + ForceRemediateForFirstEntries: + type: boolean + LastEntries: + $ref: '#/components/schemas/NetworkAclEntryList' + ForceRemediateForLastEntries: + type: boolean + additionalProperties: false + required: + - ForceRemediateForFirstEntries + - ForceRemediateForLastEntries + anyOf: + - required: + - FirstEntries + - required: + - LastEntries ManagedServiceData: description: Firewall managed service data. type: string minLength: 1 - maxLength: 8192 + maxLength: 30000 PolicyType: description: Firewall policy type. type: string @@ -145,6 +624,7 @@ components: - THIRD_PARTY_FIREWALL - DNS_FIREWALL - IMPORT_NETWORK_FIREWALL + - NETWORK_ACL_COMMON NetworkFirewallPolicy: description: Network firewall policy. type: object @@ -163,6 +643,15 @@ components: additionalProperties: false required: - FirewallDeploymentModel + NetworkAclCommonPolicy: + description: Network ACL common policy. + type: object + properties: + NetworkAclEntrySet: + $ref: '#/components/schemas/NetworkAclEntrySet' + additionalProperties: false + required: + - NetworkAclEntrySet PolicyOption: description: Firewall policy option. type: object @@ -171,12 +660,16 @@ components: $ref: '#/components/schemas/NetworkFirewallPolicy' ThirdPartyFirewallPolicy: $ref: '#/components/schemas/ThirdPartyFirewallPolicy' + NetworkAclCommonPolicy: + $ref: '#/components/schemas/NetworkAclCommonPolicy' additionalProperties: false oneOf: - required: - NetworkFirewallPolicy - required: - ThirdPartyFirewallPolicy + - required: + - NetworkAclCommonPolicy Policy: type: object properties: @@ -208,6 +701,11 @@ components: $ref: '#/components/schemas/ResourceTag' maxItems: 8 x-insertionOrder: true + ResourceTagLogicalOperator: + type: string + enum: + - AND + - OR ResourceType: $ref: '#/components/schemas/ResourceType' ResourceTypeList: @@ -240,11 +738,29 @@ components: - RemediationEnabled - SecurityServicePolicyData x-stackql-resource-name: policy - x-stackql-primaryIdentifier: + description: Creates an AWS Firewall Manager policy. + x-type-name: AWS::FMS::Policy + x-stackql-primary-identifier: - Id + x-write-only-properties: + - DeleteAllPolicyResources x-read-only-properties: - Arn - Id + x-required-properties: + - ExcludeResourceTags + - PolicyName + - RemediationEnabled + - SecurityServicePolicyData + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - fms:TagResource + - fms:UntagResource x-required-permissions: create: - fms:PutPolicy @@ -344,10 +860,24 @@ components: - Name - ResourceTypeList x-stackql-resource-name: resource_set - x-stackql-primaryIdentifier: + description: Creates an AWS Firewall Manager resource set. + x-type-name: AWS::FMS::ResourceSet + x-stackql-primary-identifier: - Id x-read-only-properties: - Id + x-required-properties: + - Name + - ResourceTypeList + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - fms:TagResource + - fms:UntagResource x-required-permissions: create: - fms:PutResourceSet @@ -371,43 +901,216 @@ components: - fms:DeleteResourceSet list: - fms:ListResourceSets + CreateNotificationChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SnsRoleName: + $ref: '#/components/schemas/ResourceArn' + SnsTopicArn: + $ref: '#/components/schemas/ResourceArn' + x-stackQL-stringOnly: true + x-title: CreateNotificationChannelRequest + type: object + required: [] + CreatePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ExcludeMap: + $ref: '#/components/schemas/IEMap' + ExcludeResourceTags: + type: boolean + IncludeMap: + $ref: '#/components/schemas/IEMap' + Id: + type: string + pattern: ^[a-z0-9A-Z-]{36}$ + minLength: 36 + maxLength: 36 + PolicyName: + type: string + pattern: ^([a-zA-Z0-9_.:/=+\-@\s]+)$ + minLength: 1 + maxLength: 1024 + PolicyDescription: + type: string + pattern: ^([a-zA-Z0-9_.:/=+\-@\s]+)$ + maxLength: 256 + RemediationEnabled: + type: boolean + ResourceTags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' + maxItems: 8 + x-insertionOrder: true + ResourceTagLogicalOperator: + type: string + enum: + - AND + - OR + ResourceType: + $ref: '#/components/schemas/ResourceType' + ResourceTypeList: + type: array + items: + $ref: '#/components/schemas/ResourceType' + x-insertionOrder: true + ResourceSetIds: + type: array + items: + $ref: '#/components/schemas/Base62Id' + x-insertionOrder: true + uniqueItems: true + SecurityServicePolicyData: + $ref: '#/components/schemas/SecurityServicePolicyData' + Arn: + $ref: '#/components/schemas/ResourceArn' + DeleteAllPolicyResources: + type: boolean + ResourcesCleanUp: + type: boolean + Tags: + type: array + items: + $ref: '#/components/schemas/PolicyTag' + x-insertionOrder: true + x-stackQL-stringOnly: true + x-title: CreatePolicyRequest + type: object + required: [] + CreateResourceSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/Base62Id' + Name: + type: string + pattern: ^([a-zA-Z0-9_.:/=+\-@\s]+)$ + minLength: 1 + maxLength: 128 + Description: + type: string + pattern: ^([a-zA-Z0-9_.:/=+\-@\s]*)$ + maxLength: 256 + ResourceTypeList: + type: array + items: + $ref: '#/components/schemas/ResourceType' + x-insertionOrder: true + uniqueItems: true + Resources: + type: array + items: + $ref: '#/components/schemas/Resource' + x-insertionOrder: false + uniqueItems: true + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: true + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateResourceSetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: notification_channels: name: notification_channels id: awscc.fms.notification_channels x-cfn-schema-name: NotificationChannel - x-type: list - x-identifiers: - - SnsTopicArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' - AND region = 'us-east-1' - notification_channel: - name: notification_channel - id: awscc.fms.notification_channel - x-cfn-schema-name: NotificationChannel - x-type: get + x-cfn-type-name: AWS::FMS::NotificationChannel x-identifiers: - SnsTopicArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NotificationChannel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::NotificationChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::NotificationChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::NotificationChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -418,7 +1121,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -428,13 +1131,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::NotificationChannel' AND data__Identifier = '' AND region = 'us-east-1' - policies: - name: policies - id: awscc.fms.policies - x-cfn-schema-name: Policy - x-type: list + notification_channels_list_only: + name: notification_channels_list_only + id: awscc.fms.notification_channels_list_only + x-cfn-schema-name: NotificationChannel + x-cfn-type-name: AWS::FMS::NotificationChannel x-identifiers: - - Id + - SnsTopicArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -442,28 +1151,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' + JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' AND region = 'us-east-1' - policy: - name: policy - id: awscc.fms.policy + policies: + name: policies + id: awscc.fms.policies x-cfn-schema-name: Policy - x-type: get + x-cfn-type-name: AWS::FMS::Policy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -476,6 +1233,7 @@ components: JSON_EXTRACT(Properties, '$.PolicyDescription') as policy_description, JSON_EXTRACT(Properties, '$.RemediationEnabled') as remediation_enabled, JSON_EXTRACT(Properties, '$.ResourceTags') as resource_tags, + JSON_EXTRACT(Properties, '$.ResourceTagLogicalOperator') as resource_tag_logical_operator, JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, JSON_EXTRACT(Properties, '$.ResourceTypeList') as resource_type_list, JSON_EXTRACT(Properties, '$.ResourceSetIds') as resource_set_ids, @@ -488,7 +1246,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -501,6 +1259,7 @@ components: json_extract_path_text(Properties, 'PolicyDescription') as policy_description, json_extract_path_text(Properties, 'RemediationEnabled') as remediation_enabled, json_extract_path_text(Properties, 'ResourceTags') as resource_tags, + json_extract_path_text(Properties, 'ResourceTagLogicalOperator') as resource_tag_logical_operator, json_extract_path_text(Properties, 'ResourceType') as resource_type, json_extract_path_text(Properties, 'ResourceTypeList') as resource_type_list, json_extract_path_text(Properties, 'ResourceSetIds') as resource_set_ids, @@ -512,13 +1271,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::Policy' AND data__Identifier = '' AND region = 'us-east-1' - resource_sets: - name: resource_sets - id: awscc.fms.resource_sets - x-cfn-schema-name: ResourceSet - x-type: list + policies_list_only: + name: policies_list_only + id: awscc.fms.policies_list_only + x-cfn-schema-name: Policy + x-cfn-type-name: AWS::FMS::Policy x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -527,7 +1292,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -535,19 +1300,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' AND region = 'us-east-1' - resource_set: - name: resource_set - id: awscc.fms.resource_set + resource_sets: + name: resource_sets + id: awscc.fms.resource_sets x-cfn-schema-name: ResourceSet - x-type: get + x-cfn-type-name: AWS::FMS::ResourceSet x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::ResourceSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::ResourceSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FMS::ResourceSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -562,7 +1375,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -576,3 +1389,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::ResourceSet' AND data__Identifier = '' AND region = 'us-east-1' + resource_sets_list_only: + name: resource_sets_list_only + id: awscc.fms.resource_sets_list_only + x-cfn-schema-name: ResourceSet + x-cfn-type-name: AWS::FMS::ResourceSet + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NotificationChannel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNotificationChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNotificationChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/forecast.yaml b/providers/src/awscc/v00.00.00000/services/forecast.yaml index bde7b62f..d4805440 100644 --- a/providers/src/awscc/v00.00.00000/services/forecast.yaml +++ b/providers/src/awscc/v00.00.00000/services/forecast.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Forecast - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Attributes: type: array @@ -119,12 +499,19 @@ components: - Domain - Schema x-stackql-resource-name: dataset - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::Forecast::Dataset + x-type-name: AWS::Forecast::Dataset + x-stackql-primary-identifier: - Arn x-create-only-properties: - DatasetName x-read-only-properties: - Arn + x-required-properties: + - DatasetName + - DatasetType + - Domain + - Schema x-required-permissions: create: - forecast:CreateDataset @@ -209,12 +596,18 @@ components: - DatasetGroupName - Domain x-stackql-resource-name: dataset_group - x-stackql-primaryIdentifier: + description: Represents a dataset group that holds a collection of related datasets + x-type-name: AWS::Forecast::DatasetGroup + x-stackql-primary-identifier: - DatasetGroupArn x-create-only-properties: - DatasetGroupName x-read-only-properties: - DatasetGroupArn + x-required-properties: + - DatasetGroupName + - Domain + x-taggable: true x-required-permissions: create: - forecast:CreateDatasetGroup @@ -226,43 +619,193 @@ components: - forecast:DeleteDatasetGroup list: - forecast:ListDatasetGroups + CreateDatasetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 256 + pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$ + DatasetName: + description: A name for the dataset + type: string + minLength: 1 + maxLength: 63 + pattern: ^[a-zA-Z][a-zA-Z0-9_]* + DatasetType: + description: The dataset type + type: string + enum: + - TARGET_TIME_SERIES + - RELATED_TIME_SERIES + - ITEM_METADATA + DataFrequency: + description: Frequency of data collection. This parameter is required for RELATED_TIME_SERIES + type: string + pattern: ^Y|M|W|D|H|30min|15min|10min|5min|1min$ + Domain: + description: The domain associated with the dataset + type: string + enum: + - RETAIL + - CUSTOM + - INVENTORY_PLANNING + - EC2_CAPACITY + - WORK_FORCE + - WEB_TRAFFIC + - METRICS + EncryptionConfig: + type: object + additionalProperties: false + properties: + KmsKeyArn: + $ref: '#/components/schemas/KmsKeyArn' + RoleArn: + $ref: '#/components/schemas/RoleArn' + Schema: + type: object + additionalProperties: false + properties: + Attributes: + $ref: '#/components/schemas/Attributes' + Tags: + type: array + x-insertionOrder: true + items: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + $ref: '#/components/schemas/Key' + Value: + $ref: '#/components/schemas/Value' + required: + - Key + - Value + additionalProperties: false + minItems: 0 + maxItems: 200 + x-stackQL-stringOnly: true + x-title: CreateDatasetRequest + type: object + required: [] + CreateDatasetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatasetArns: + description: An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group. + type: array + items: + $ref: '#/components/schemas/Arn' + x-insertionOrder: true + DatasetGroupName: + description: A name for the dataset group. + type: string + pattern: ^[a-zA-Z][a-zA-Z0-9_]* + minLength: 1 + maxLength: 63 + Domain: + description: The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match. + type: string + enum: + - RETAIL + - CUSTOM + - INVENTORY_PLANNING + - EC2_CAPACITY + - WORK_FORCE + - WEB_TRAFFIC + - METRICS + Tags: + description: The tags of Application Insights application. + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 200 + x-insertionOrder: true + DatasetGroupArn: + description: The Amazon Resource Name (ARN) of the dataset group to delete. + type: string + maxLength: 256 + pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$ + x-stackQL-stringOnly: true + x-title: CreateDatasetGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: datasets: name: datasets id: awscc.forecast.datasets x-cfn-schema-name: Dataset - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: awscc.forecast.dataset - x-cfn-schema-name: Dataset - x-type: get + x-cfn-type-name: AWS::Forecast::Dataset x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Forecast::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Forecast::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -279,7 +822,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -295,13 +838,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Forecast::Dataset' AND data__Identifier = '' AND region = 'us-east-1' - dataset_groups: - name: dataset_groups - id: awscc.forecast.dataset_groups - x-cfn-schema-name: DatasetGroup - x-type: list + datasets_list_only: + name: datasets_list_only + id: awscc.forecast.datasets_list_only + x-cfn-schema-name: Dataset + x-cfn-type-name: AWS::Forecast::Dataset x-identifiers: - - DatasetGroupArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -309,28 +858,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' AND region = 'us-east-1' - dataset_group: - name: dataset_group - id: awscc.forecast.dataset_group + dataset_groups: + name: dataset_groups + id: awscc.forecast.dataset_groups x-cfn-schema-name: DatasetGroup - x-type: get + x-cfn-type-name: AWS::Forecast::DatasetGroup x-identifiers: - DatasetGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DatasetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Forecast::DatasetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Forecast::DatasetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Forecast::DatasetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -344,7 +941,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -357,3 +954,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' AND data__Identifier = '' AND region = 'us-east-1' + dataset_groups_list_only: + name: dataset_groups_list_only + id: awscc.forecast.dataset_groups_list_only + x-cfn-schema-name: DatasetGroup + x-cfn-type-name: AWS::Forecast::DatasetGroup + x-identifiers: + - DatasetGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DatasetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDatasetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/frauddetector.yaml b/providers/src/awscc/v00.00.00000/services/frauddetector.yaml index f22adb02..f53191f6 100644 --- a/providers/src/awscc/v00.00.00000/services/frauddetector.yaml +++ b/providers/src/awscc/v00.00.00000/services/frauddetector.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: FraudDetector - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -132,7 +512,9 @@ components: required: - Name x-stackql-resource-name: label - x-stackql-primaryIdentifier: + description: An label for fraud detector. + x-type-name: AWS::FraudDetector::Label + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -140,6 +522,18 @@ components: - Arn - CreatedTime - LastUpdatedTime + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - frauddetector:ListTagsForResource + - frauddetector:TagResource + - frauddetector:UntagResource x-required-permissions: create: - frauddetector:GetLabels @@ -195,7 +589,9 @@ components: required: - Name x-stackql-resource-name: outcome - x-stackql-primaryIdentifier: + description: An outcome for rule evaluation. + x-type-name: AWS::FraudDetector::Outcome + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -203,6 +599,18 @@ components: - Arn - CreatedTime - LastUpdatedTime + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - frauddetector:ListTagsForResource + - frauddetector:TagResource + - frauddetector:UntagResource x-required-permissions: create: - frauddetector:GetOutcomes @@ -355,7 +763,9 @@ components: - Labels - Name x-stackql-resource-name: event_type - x-stackql-primaryIdentifier: + description: A resource schema for an EventType in Amazon Fraud Detector. + x-type-name: AWS::FraudDetector::EventType + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -372,6 +782,11 @@ components: - EntityTypes/*/Arn - EntityTypes/*/CreatedTime - EntityTypes/*/LastUpdatedTime + x-required-properties: + - EntityTypes + - EventVariables + - Labels + - Name x-required-permissions: create: - frauddetector:BatchCreateVariable @@ -505,7 +920,9 @@ components: - EventType - Rules x-stackql-resource-name: detector - x-stackql-primaryIdentifier: + description: A resource schema for a Detector in Amazon Fraud Detector. + x-type-name: AWS::FraudDetector::Detector + x-stackql-primary-identifier: - Arn x-create-only-properties: - DetectorId @@ -534,6 +951,10 @@ components: - EventType/EntityTypes/*/CreatedTime - EventType/EntityTypes/*/LastUpdatedTime - AssociatedModels/*/Arn + x-required-properties: + - DetectorId + - EventType + - Rules x-required-permissions: create: - frauddetector:PutDetector @@ -687,7 +1108,9 @@ components: required: - Name x-stackql-resource-name: list - x-stackql-primaryIdentifier: + description: A resource schema for a List in Amazon Fraud Detector. + x-type-name: AWS::FraudDetector::List + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -695,6 +1118,18 @@ components: - Arn - CreatedTime - LastUpdatedTime + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - frauddetector:ListTagsForResource + - frauddetector:TagResource + - frauddetector:UntagResource x-required-permissions: create: - frauddetector:CreateList @@ -810,7 +1245,9 @@ components: - DefaultValue - Name x-stackql-resource-name: variable - x-stackql-primaryIdentifier: + description: A resource schema for a Variable in Amazon Fraud Detector. + x-type-name: AWS::FraudDetector::Variable + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -818,6 +1255,21 @@ components: - Arn - CreatedTime - LastUpdatedTime + x-required-properties: + - DataType + - DataSource + - DefaultValue + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - frauddetector:ListTagsForResource + - frauddetector:TagResource + - frauddetector:UntagResource x-required-permissions: create: - frauddetector:GetVariables @@ -839,43 +1291,462 @@ components: list: - frauddetector:GetVariables - frauddetector:ListTagsForResource + CreateLabelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the label. + type: string + pattern: ^[0-9a-z_-]+$ + minLength: 1 + maxLength: 64 + Tags: + description: Tags associated with this label. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + Description: + description: The label description. + type: string + minLength: 1 + maxLength: 128 + Arn: + description: The label ARN. + type: string + CreatedTime: + description: The timestamp when the label was created. + type: string + LastUpdatedTime: + description: The timestamp when the label was last updated. + type: string + x-stackQL-stringOnly: true + x-title: CreateLabelRequest + type: object + required: [] + CreateOutcomeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the outcome. + type: string + pattern: ^[0-9a-z_-]+$ + minLength: 1 + maxLength: 64 + Tags: + description: Tags associated with this outcome. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + Description: + description: The outcome description. + type: string + minLength: 1 + maxLength: 128 + Arn: + description: The outcome ARN. + type: string + CreatedTime: + description: The timestamp when the outcome was created. + type: string + LastUpdatedTime: + description: The timestamp when the outcome was last updated. + type: string + x-stackQL-stringOnly: true + x-title: CreateOutcomeRequest + type: object + required: [] + CreateEventTypeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name for the event type + type: string + pattern: ^[0-9a-z_-]+$ + minLength: 1 + maxLength: 64 + Tags: + description: Tags associated with this event type. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + Description: + description: The description of the event type. + type: string + minLength: 1 + maxLength: 128 + EventVariables: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + items: + $ref: '#/components/schemas/EventVariable' + Labels: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 2 + items: + $ref: '#/components/schemas/Label' + EntityTypes: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + items: + $ref: '#/components/schemas/EntityType' + Arn: + description: The ARN of the event type. + type: string + CreatedTime: + description: The time when the event type was created. + type: string + LastUpdatedTime: + description: The time when the event type was last updated. + type: string + x-stackQL-stringOnly: true + x-title: CreateEventTypeRequest + type: object + required: [] + CreateDetectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DetectorId: + description: The ID of the detector + type: string + pattern: ^[0-9a-z_-]+$ + minLength: 1 + maxLength: 64 + DetectorVersionStatus: + description: The desired detector version status for the detector + type: string + enum: + - DRAFT + - ACTIVE + DetectorVersionId: + description: The active version ID of the detector + type: string + RuleExecutionMode: + type: string + enum: + - FIRST_MATCHED + - ALL_MATCHED + Tags: + description: Tags associated with this detector. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + Description: + description: The description of the detector. + type: string + minLength: 1 + maxLength: 128 + Rules: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + items: + $ref: '#/components/schemas/Rule' + EventType: + description: The event type to associate this detector with. + $ref: '#/components/schemas/EventType' + Arn: + description: The ARN of the detector. + type: string + CreatedTime: + description: The time when the detector was created. + type: string + LastUpdatedTime: + description: The time when the detector was last updated. + type: string + AssociatedModels: + description: The models to associate with this detector. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 10 + items: + $ref: '#/components/schemas/Model' + x-stackQL-stringOnly: true + x-title: CreateDetectorRequest + type: object + required: [] + CreateListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The list ARN. + type: string + Name: + description: The name of the list. + type: string + pattern: ^[0-9a-z_]+$ + minLength: 1 + maxLength: 64 + Description: + description: The description of the list. + type: string + minLength: 1 + maxLength: 128 + VariableType: + description: The variable type of the list. + type: string + pattern: ^[A-Z_]{1,64}$ + minLength: 1 + maxLength: 64 + CreatedTime: + description: The time when the list was created. + type: string + LastUpdatedTime: + description: The time when the list was last updated. + type: string + Tags: + description: Tags associated with this list. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + Elements: + description: The elements in this list. + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 100000 + items: + $ref: '#/components/schemas/Element' + x-stackQL-stringOnly: true + x-title: CreateListRequest + type: object + required: [] + CreateVariableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the variable. + type: string + pattern: ^[a-z_][a-z0-9_]{0,99}?$ + DataSource: + description: The source of the data. + type: string + enum: + - EVENT + - EXTERNAL_MODEL_SCORE + DataType: + description: The data type. + type: string + enum: + - STRING + - INTEGER + - FLOAT + - BOOLEAN + DefaultValue: + description: The default value for the variable when no value is received. + type: string + Description: + description: The description. + type: string + minLength: 1 + maxLength: 256 + Tags: + description: Tags associated with this variable. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + VariableType: + description: The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types + type: string + enum: + - AUTH_CODE + - AVS + - BILLING_ADDRESS_L1 + - BILLING_ADDRESS_L2 + - BILLING_CITY + - BILLING_COUNTRY + - BILLING_NAME + - BILLING_PHONE + - BILLING_STATE + - BILLING_ZIP + - CARD_BIN + - CATEGORICAL + - CURRENCY_CODE + - EMAIL_ADDRESS + - FINGERPRINT + - FRAUD_LABEL + - FREE_FORM_TEXT + - IP_ADDRESS + - NUMERIC + - ORDER_ID + - PAYMENT_TYPE + - PHONE_NUMBER + - PRICE + - PRODUCT_CATEGORY + - SHIPPING_ADDRESS_L1 + - SHIPPING_ADDRESS_L2 + - SHIPPING_CITY + - SHIPPING_COUNTRY + - SHIPPING_NAME + - SHIPPING_PHONE + - SHIPPING_STATE + - SHIPPING_ZIP + - USERAGENT + Arn: + description: The ARN of the variable. + type: string + CreatedTime: + description: The time when the variable was created. + type: string + LastUpdatedTime: + description: The time when the variable was last updated. + type: string + x-stackQL-stringOnly: true + x-title: CreateVariableRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: labels: name: labels id: awscc.frauddetector.labels x-cfn-schema-name: Label - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' - AND region = 'us-east-1' - label: - name: label - id: awscc.frauddetector.label - x-cfn-schema-name: Label - x-type: get + x-cfn-type-name: AWS::FraudDetector::Label x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Label&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Label" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Label" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Label" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/labels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -890,7 +1761,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -904,13 +1775,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Label' AND data__Identifier = '' AND region = 'us-east-1' - outcomes: - name: outcomes - id: awscc.frauddetector.outcomes - x-cfn-schema-name: Outcome - x-type: list + labels_list_only: + name: labels_list_only + id: awscc.frauddetector.labels_list_only + x-cfn-schema-name: Label + x-cfn-type-name: AWS::FraudDetector::Label x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -919,7 +1796,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -927,19 +1804,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' AND region = 'us-east-1' - outcome: - name: outcome - id: awscc.frauddetector.outcome + outcomes: + name: outcomes + id: awscc.frauddetector.outcomes x-cfn-schema-name: Outcome - x-type: get + x-cfn-type-name: AWS::FraudDetector::Outcome x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Outcome&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Outcome" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Outcome" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Outcome" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/outcomes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/outcomes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/outcomes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -954,7 +1879,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -968,13 +1893,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Outcome' AND data__Identifier = '' AND region = 'us-east-1' - event_types: - name: event_types - id: awscc.frauddetector.event_types - x-cfn-schema-name: EventType - x-type: list + outcomes_list_only: + name: outcomes_list_only + id: awscc.frauddetector.outcomes_list_only + x-cfn-schema-name: Outcome + x-cfn-type-name: AWS::FraudDetector::Outcome x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -983,7 +1914,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -991,19 +1922,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' AND region = 'us-east-1' - event_type: - name: event_type - id: awscc.frauddetector.event_type + event_types: + name: event_types + id: awscc.frauddetector.event_types x-cfn-schema-name: EventType - x-type: get + x-cfn-type-name: AWS::FraudDetector::EventType x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventType&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::EventType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::EventType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::EventType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_types/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1021,7 +2000,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1038,13 +2017,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::EventType' AND data__Identifier = '' AND region = 'us-east-1' - detectors: - name: detectors - id: awscc.frauddetector.detectors - x-cfn-schema-name: Detector - x-type: list + event_types_list_only: + name: event_types_list_only + id: awscc.frauddetector.event_types_list_only + x-cfn-schema-name: EventType + x-cfn-type-name: AWS::FraudDetector::EventType x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1053,7 +2038,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1061,19 +2046,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' AND region = 'us-east-1' - detector: - name: detector - id: awscc.frauddetector.detector + detectors: + name: detectors + id: awscc.frauddetector.detectors x-cfn-schema-name: Detector - x-type: get + x-cfn-type-name: AWS::FraudDetector::Detector x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Detector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Detector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Detector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Detector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/detectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/detectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1094,7 +2127,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1114,13 +2147,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Detector' AND data__Identifier = '' AND region = 'us-east-1' - lists: - name: lists - id: awscc.frauddetector.lists - x-cfn-schema-name: List - x-type: list + detectors_list_only: + name: detectors_list_only + id: awscc.frauddetector.detectors_list_only + x-cfn-schema-name: Detector + x-cfn-type-name: AWS::FraudDetector::Detector x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1129,7 +2168,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1137,19 +2176,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' AND region = 'us-east-1' - frauddetector_list: - name: frauddetector_list - id: awscc.frauddetector.frauddetector_list + lists: + name: lists + id: awscc.frauddetector.lists x-cfn-schema-name: List - x-type: get + x-cfn-type-name: AWS::FraudDetector::List x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__List&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::List" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::List" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::List" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lists/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1166,7 +2253,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1182,13 +2269,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::List' AND data__Identifier = '' AND region = 'us-east-1' - variables: - name: variables - id: awscc.frauddetector.variables - x-cfn-schema-name: Variable - x-type: list + lists_list_only: + name: lists_list_only + id: awscc.frauddetector.lists_list_only + x-cfn-schema-name: List + x-cfn-type-name: AWS::FraudDetector::List x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1197,7 +2290,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1205,19 +2298,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' AND region = 'us-east-1' - variable: - name: variable - id: awscc.frauddetector.variable + variables: + name: variables + id: awscc.frauddetector.variables x-cfn-schema-name: Variable - x-type: get + x-cfn-type-name: AWS::FraudDetector::Variable x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Variable&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Variable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Variable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FraudDetector::Variable" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/variables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/variables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/variables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1236,7 +2377,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1254,3 +2395,439 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Variable' AND data__Identifier = '' AND region = 'us-east-1' + variables_list_only: + name: variables_list_only + id: awscc.frauddetector.variables_list_only + x-cfn-schema-name: Variable + x-cfn-type-name: AWS::FraudDetector::Variable + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Label&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLabel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLabelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Outcome&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOutcome + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOutcomeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventType&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventType + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventTypeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Detector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDetector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDetectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__List&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Variable&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVariable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVariableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/fsx.yaml b/providers/src/awscc/v00.00.00000/services/fsx.yaml index 471e77f5..a43c09f8 100644 --- a/providers/src/awscc/v00.00.00000/services/fsx.yaml +++ b/providers/src/awscc/v00.00.00000/services/fsx.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: FSx - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: EventType: type: string @@ -134,7 +514,11 @@ components: - FileSystemPath - DataRepositoryPath x-stackql-resource-name: data_repository_association - x-stackql-primaryIdentifier: + description: |- + Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. + Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). + x-type-name: AWS::FSx::DataRepositoryAssociation + x-stackql-primary-identifier: - AssociationId x-create-only-properties: - FileSystemId @@ -144,6 +528,19 @@ components: x-read-only-properties: - AssociationId - ResourceARN + x-required-properties: + - FileSystemId + - FileSystemPath + - DataRepositoryPath + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - fsx:TagResource + - fsx:UntagResource x-required-permissions: create: - fsx:CreateDataRepositoryAssociation @@ -171,43 +568,327 @@ components: - fsx:DeleteDataRepositoryAssociation list: - fsx:DescribeDataRepositoryAssociations + S3AccessPointVpcConfiguration: + type: object + additionalProperties: false + properties: + VpcId: + description: '' + type: string + minLength: 12 + maxLength: 21 + pattern: ^(vpc-[0-9a-f]{8,})$ + required: + - VpcId + S3AccessPoint: + type: object + additionalProperties: false + properties: + ResourceARN: + description: '' + type: string + minLength: 8 + maxLength: 1024 + pattern: ^arn:[^:]{1,63}:[^:]{0,63}:[^:]{0,63}:(?:|\d{12}):[^/].{0,1023}$ + Alias: + description: '' + type: string + minLength: 1 + maxLength: 63 + pattern: ^[0-9a-z\\-]{1,63} + VpcConfiguration: + description: '' + $ref: '#/components/schemas/S3AccessPointVpcConfiguration' + Policy: + description: '' + type: object + minLength: 1 + maxLength: 200000 + FileSystemGID: + type: object + additionalProperties: false + properties: + Gid: + description: '' + type: number + minimum: 0 + maximum: 4294967295 + required: + - Gid + OpenZFSPosixFileSystemUser: + type: object + additionalProperties: false + properties: + Uid: + description: '' + type: number + minimum: 0 + maximum: 4294967295 + Gid: + description: '' + type: number + minimum: 0 + maximum: 4294967295 + SecondaryGids: + description: '' + type: array + items: + $ref: '#/components/schemas/FileSystemGID' + required: + - Uid + - Gid + OpenZFSFileSystemIdentity: + type: object + additionalProperties: false + properties: + Type: + description: '' + type: string + enum: + - POSIX + PosixUser: + description: '' + $ref: '#/components/schemas/OpenZFSPosixFileSystemUser' + required: + - Type + - PosixUser + S3AccessPointOpenZFSConfiguration: + type: object + additionalProperties: false + properties: + VolumeId: + description: '' + type: string + minLength: 23 + maxLength: 23 + pattern: ^(fsvol-[0-9a-f]{17,})$ + FileSystemIdentity: + description: '' + $ref: '#/components/schemas/OpenZFSFileSystemIdentity' + required: + - VolumeId + - FileSystemIdentity + S3AccessPointAttachment: + type: object + properties: + Name: + description: The Name of the S3AccessPointAttachment + type: string + minLength: 3 + maxLength: 50 + pattern: ^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$ + Type: + description: '' + type: string + enum: + - OPENZFS + OpenZFSConfiguration: + description: '' + $ref: '#/components/schemas/S3AccessPointOpenZFSConfiguration' + S3AccessPoint: + description: '' + $ref: '#/components/schemas/S3AccessPoint' + required: + - Name + - Type + - OpenZFSConfiguration + x-stackql-resource-name: s3access_point_attachment + description: Resource type definition for AWS::FSx::S3AccessPointAttachment + x-type-name: AWS::FSx::S3AccessPointAttachment + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - Type + - OpenZFSConfiguration + - S3AccessPoint + x-write-only-properties: + - S3AccessPoint/Policy + x-read-only-properties: + - S3AccessPoint/ResourceARN + - S3AccessPoint/Alias + x-required-properties: + - Name + - Type + - OpenZFSConfiguration + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + x-required-permissions: + create: + - fsx:CreateAndAttachS3AccessPoint + - fsx:DescribeS3AccessPointAttachments + - s3:CreateAccessPoint + - s3:GetAccessPoint + - s3:PutAccessPointPolicy + read: + - fsx:DescribeS3AccessPointAttachments + - s3:GetAccessPoint + delete: + - fsx:DescribeS3AccessPointAttachments + - fsx:DetachAndDeleteS3AccessPoint + - s3:DeleteAccessPoint + - s3:GetAccessPoint + list: + - fsx:DescribeS3AccessPointAttachments + - s3:GetAccessPoint + CreateDataRepositoryAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssociationId: + type: string + description: '' + ResourceARN: + type: string + description: '' + FileSystemId: + type: string + description: The ID of the file system on which the data repository association is configured. + FileSystemPath: + type: string + description: >- + A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path + ``/ns1/ns2``. + This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. + If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system. + DataRepositoryPath: + type: string + description: The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to. + BatchImportMetaDataOnCreate: + type: boolean + description: A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``. + ImportedFileChunkSize: + type: integer + description: |- + For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache. + The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. + S3: + description: The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository. + $ref: '#/components/schemas/S3' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + description: |- + An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + x-stackQL-stringOnly: true + x-title: CreateDataRepositoryAssociationRequest + type: object + required: [] + CreateS3AccessPointAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The Name of the S3AccessPointAttachment + type: string + minLength: 3 + maxLength: 50 + pattern: ^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$ + Type: + description: '' + type: string + enum: + - OPENZFS + OpenZFSConfiguration: + description: '' + $ref: '#/components/schemas/S3AccessPointOpenZFSConfiguration' + S3AccessPoint: + description: '' + $ref: '#/components/schemas/S3AccessPoint' + x-stackQL-stringOnly: true + x-title: CreateS3AccessPointAttachmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: data_repository_associations: name: data_repository_associations id: awscc.fsx.data_repository_associations x-cfn-schema-name: DataRepositoryAssociation - x-type: list - x-identifiers: - - AssociationId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' - AND region = 'us-east-1' - data_repository_association: - name: data_repository_association - id: awscc.fsx.data_repository_association - x-cfn-schema-name: DataRepositoryAssociation - x-type: get + x-cfn-type-name: AWS::FSx::DataRepositoryAssociation x-identifiers: - AssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataRepositoryAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FSx::DataRepositoryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FSx::DataRepositoryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FSx::DataRepositoryAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -225,7 +906,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -242,3 +923,372 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' AND data__Identifier = '' AND region = 'us-east-1' + data_repository_associations_list_only: + name: data_repository_associations_list_only + id: awscc.fsx.data_repository_associations_list_only + x-cfn-schema-name: DataRepositoryAssociation + x-cfn-type-name: AWS::FSx::DataRepositoryAssociation + x-identifiers: + - AssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' + AND region = 'us-east-1' + s3access_point_attachments: + name: s3access_point_attachments + id: awscc.fsx.s3access_point_attachments + x-cfn-schema-name: S3AccessPointAttachment + x-cfn-type-name: AWS::FSx::S3AccessPointAttachment + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__S3AccessPointAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FSx::S3AccessPointAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::FSx::S3AccessPointAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/s3access_point_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/s3access_point_attachments/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.OpenZFSConfiguration') as open_zf_sconfiguration, + JSON_EXTRACT(Properties, '$.S3AccessPoint') as s3_access_point + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FSx::S3AccessPointAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'OpenZFSConfiguration') as open_zf_sconfiguration, + json_extract_path_text(Properties, 'S3AccessPoint') as s3_access_point + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::FSx::S3AccessPointAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + s3access_point_attachments_list_only: + name: s3access_point_attachments_list_only + id: awscc.fsx.s3access_point_attachments_list_only + x-cfn-schema-name: S3AccessPointAttachment + x-cfn-type-name: AWS::FSx::S3AccessPointAttachment + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::S3AccessPointAttachment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::S3AccessPointAttachment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataRepositoryAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataRepositoryAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataRepositoryAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__S3AccessPointAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateS3AccessPointAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateS3AccessPointAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/gamelift.yaml b/providers/src/awscc/v00.00.00000/services/gamelift.yaml index ac5d7181..eadf529a 100644 --- a/providers/src/awscc/v00.00.00000/services/gamelift.yaml +++ b/providers/src/awscc/v00.00.00000/services/gamelift.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: GameLift - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: RoutingStrategy: type: object @@ -14,7 +394,7 @@ components: FleetId: description: A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property. type: string - pattern: ^fleet-\S+ + pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+ Type: description: Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets. type: string @@ -29,6 +409,24 @@ components: - FleetId - required: - Message + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + type: string + description: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. + minLength: 1 + maxLength: 128 + Value: + type: string + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false Alias: type: object properties: @@ -49,21 +447,55 @@ components: AliasId: description: Unique alias ID type: string + AliasArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Alias resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Alias ARN, the resource ID matches the AliasId value. + pattern: ^arn:.*:alias\/alias-\S+ + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' required: - Name - RoutingStrategy x-stackql-resource-name: alias - x-stackql-primaryIdentifier: + description: The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination. + x-type-name: AWS::GameLift::Alias + x-stackql-primary-identifier: - AliasId x-read-only-properties: - AliasId + - AliasArn + x-required-properties: + - Name + - RoutingStrategy + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: create: - gamelift:CreateAlias + - gamelift:TagResource read: - gamelift:DescribeAlias + - gamelift:ListTagsForResource update: - gamelift:UpdateAlias + - gamelift:DescribeAlias + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource delete: - gamelift:DeleteAlias list: @@ -116,97 +548,296 @@ components: ServerSdkVersion: description: A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2. type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + BuildArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift build ARN, the resource ID matches the BuildId value. + pattern: ^arn:.*:build\/build-\S+ + type: string required: [] x-stackql-resource-name: build - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GameLift::Build + x-type-name: AWS::GameLift::Build + x-stackql-primary-identifier: - BuildId x-create-only-properties: - StorageLocation - OperatingSystem - ServerSdkVersion + x-write-only-properties: + - StorageLocation x-read-only-properties: - BuildId + - BuildArn + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: create: - gamelift:DescribeBuild - gamelift:CreateBuild + - gamelift:ListTagsForResource + - gamelift:TagResource + - iam:PassRole read: - gamelift:DescribeBuild + - gamelift:ListTagsForResource update: - gamelift:UpdateBuild + - gamelift:DescribeBuild + - gamelift:TagResource + - gamelift:UntagResource + - gamelift:ListTagsForResource delete: - gamelift:DescribeBuild - gamelift:DeleteBuild list: - gamelift:ListBuilds - ScalingPolicy: - description: Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID. + ConnectionPortRange: + description: Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet. + type: object + properties: + FromPort: + description: A starting value for a range of allowed port numbers. + type: integer + minimum: 1 + maximum: 60000 + ToPort: + description: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + type: integer + minimum: 1 + maximum: 60000 additionalProperties: false + required: + - FromPort + - ToPort + IpPermission: + description: >- + A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP + messaging and one for UDP, for use by the Realtime servers. type: object properties: - Status: - description: Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. - type: string - enum: - - ACTIVE - - UPDATE_REQUESTED - - UPDATING - - DELETE_REQUESTED - - DELETING - - DELETED - - ERROR - MetricName: - description: Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. - type: string - enum: - - ActivatingGameSessions - - ActiveGameSessions - - ActiveInstances - - AvailableGameSessions - - AvailablePlayerSessions - - CurrentPlayerSessions - - IdleInstances - - PercentAvailableGameSessions - - PercentIdleInstances - - QueueDepth - - WaitTime - - ConcurrentActivatableGameSessions - PolicyType: - description: 'The type of scaling policy to create. For a target-based policy, set the parameter MetricName to ''PercentAvailableGameSessions'' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.' - type: string - enum: - - RuleBased - - TargetBased - ComparisonOperator: - description: Comparison operator to use when measuring a metric against the threshold value. + FromPort: + description: A starting value for a range of allowed port numbers. + type: integer + minimum: 1 + maximum: 60000 + IpRange: + description: 'A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".' type: string - enum: - - GreaterThanOrEqualToThreshold - - GreaterThanThreshold - - LessThanThreshold - - LessThanOrEqualToThreshold - TargetConfiguration: - description: An object that contains settings for a target-based scaling policy. - $ref: '#/components/schemas/TargetConfiguration' - UpdateStatus: - description: The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. + pattern: (^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/([0-9]|[1-2][0-9]|3[0-2]))$) + Protocol: + description: The network communication protocol used by the fleet. type: string enum: - - PENDING_UPDATE - ScalingAdjustment: - description: Amount of adjustment to make, based on the scaling adjustment type. + - TCP + - UDP + ToPort: + description: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. type: integer - EvaluationPeriods: - description: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. + minimum: 1 + maximum: 60000 + additionalProperties: false + required: + - FromPort + - IpRange + - Protocol + - ToPort + GameSessionCreationLimitPolicy: + description: |- + A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". + + The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes. + type: object + properties: + NewGameSessionsPerCreator: + description: The maximum number of game sessions that an individual can create during the policy period. + type: integer + minimum: 0 + PolicyPeriodInMinutes: + description: The time span used in evaluating the resource creation limit policy. + type: integer + minimum: 0 + additionalProperties: false + LogDestination: + description: Configures the service that provides logs. + type: string + enum: + - NONE + - CLOUDWATCH + - S3 + LogConfiguration: + description: A policy the location and provider of logs from the fleet. + type: object + properties: + LogDestination: + $ref: '#/components/schemas/LogDestination' + LogGroupArn: + description: If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch. + type: string + minLength: 1 + maxLength: 512 + pattern: '[a-zA-Z0-9:/\-\*]+' + S3BucketName: + description: The name of the S3 bucket to pull logs from if S3 is the LogDestination + type: string + minLength: 1 + maxLength: 1024 + additionalProperties: false + Location: + type: object + properties: + LocationName: + type: string + minLength: 8 + maxLength: 64 + pattern: ^custom-[A-Za-z0-9\-]+ + LocationArn: + type: string + pattern: ^arn:.*:location/custom-\S+ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + required: + - LocationName + x-stackql-resource-name: location + description: The AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location. + x-type-name: AWS::GameLift::Location + x-stackql-primary-identifier: + - LocationName + x-create-only-properties: + - LocationName + x-read-only-properties: + - LocationArn + x-required-properties: + - LocationName + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + tagOnCreate: true + tagUpdatable: true + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + x-required-permissions: + create: + - gamelift:CreateLocation + - gamelift:ListLocations + - gamelift:ListTagsForResource + - gamelift:TagResource + read: + - gamelift:ListLocations + - gamelift:ListTagsForResource + delete: + - gamelift:DeleteLocation + list: + - gamelift:ListLocations + update: + - gamelift:ListLocations + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + LocationCapacity: + description: Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. + type: object + properties: + DesiredEC2Instances: + description: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. + type: integer + minimum: 0 + MinSize: + description: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. + type: integer + minimum: 0 + MaxSize: + description: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. + type: integer + minimum: 0 + additionalProperties: false + required: + - DesiredEC2Instances + - MinSize + - MaxSize + LocationConfiguration: + description: A remote location where a multi-location fleet can deploy EC2 instances for game hosting. + type: object + properties: + Location: + $ref: '#/components/schemas/Location' + LocationCapacity: + $ref: '#/components/schemas/LocationCapacity' + additionalProperties: false + required: + - Location + ScalingPolicy: + description: Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID. + type: object + properties: + ComparisonOperator: + description: Comparison operator to use when measuring a metric against the threshold value. + type: string + enum: + - GreaterThanOrEqualToThreshold + - GreaterThanThreshold + - LessThanThreshold + - LessThanOrEqualToThreshold + EvaluationPeriods: + description: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. type: integer minimum: 1 Location: $ref: '#/components/schemas/Location' + MetricName: + description: Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. + type: string + enum: + - ActivatingGameSessions + - ActiveGameSessions + - ActiveInstances + - AvailableGameSessions + - AvailablePlayerSessions + - CurrentPlayerSessions + - IdleInstances + - PercentAvailableGameSessions + - PercentIdleInstances + - QueueDepth + - WaitTime + - ConcurrentActivatableGameSessions Name: - minLength: 1 description: A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. type: string + minLength: 1 maxLength: 1024 + PolicyType: + description: 'The type of scaling policy to create. For a target-based policy, set the parameter MetricName to ''PercentAvailableGameSessions'' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.' + type: string + enum: + - RuleBased + - TargetBased + ScalingAdjustment: + description: Amount of adjustment to make, based on the scaling adjustment type. + type: integer ScalingAdjustmentType: description: The type of adjustment to make to a fleet's instance count. type: string @@ -214,386 +845,987 @@ components: - ChangeInCapacity - ExactCapacity - PercentChangeInCapacity + Status: + description: Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. + type: string + enum: + - ACTIVE + - UPDATE_REQUESTED + - UPDATING + - DELETE_REQUESTED + - DELETING + - DELETED + - ERROR + TargetConfiguration: + description: An object that contains settings for a target-based scaling policy. + $ref: '#/components/schemas/TargetConfiguration' Threshold: description: Metric value used to trigger a scaling event. type: number + UpdateStatus: + description: The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. + type: string + enum: + - PENDING_UPDATE + additionalProperties: false required: - MetricName - Name - ServerProcess: - description: A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration. + StoppedActions: + description: A list of fleet actions that have been suspended in the fleet location. + type: array + maxItems: 1 + items: + type: string + enum: + - AUTO_SCALING + x-insertionOrder: false + TargetConfiguration: + description: Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. + type: object + properties: + TargetValue: + description: Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). + type: number + additionalProperties: false + required: + - TargetValue + DeploymentDetails: + description: Provides information about the last deployment ID and its status. + type: object + properties: + LatestDeploymentId: + description: The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached. + type: string + maxLength: 1024 + pattern: ^[a-zA-Z0-9\-]+$|^$ + required: [] + additionalProperties: false + DeploymentConfiguration: + description: Provides details about how to drain old tasks and replace them with new updated tasks. + type: object + properties: + ProtectionStrategy: + description: The protection strategy for deployment on the container fleet; defaults to WITH_PROTECTION. + type: string + enum: + - WITH_PROTECTION + - IGNORE_PROTECTION + MinimumHealthyPercentage: + description: The minimum percentage of healthy required; defaults to 75. + type: integer + minimum: 30 + maximum: 75 + ImpairmentStrategy: + description: The strategy to apply in case of impairment; defaults to MAINTAIN. + type: string + enum: + - MAINTAIN + - ROLLBACK + required: [] + additionalProperties: false + ContainerFleet: + type: object + properties: + FleetId: + description: Unique fleet ID + type: string + pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+ + minLength: 1 + maxLength: 128 + FleetRoleArn: + description: A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. + type: string + pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + minLength: 1 + maxLength: 256 + Description: + description: A human-readable description of a fleet. + type: string + minLength: 1 + maxLength: 1024 + GameServerContainerGroupDefinitionName: + description: The name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group. + type: string + minLength: 1 + maxLength: 512 + pattern: ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$ + GameServerContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified. + type: string + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$|^$ + PerInstanceContainerGroupDefinitionName: + description: The name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName. + type: string + minLength: 1 + maxLength: 512 + pattern: ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$ + PerInstanceContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified. + type: string + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$|^$ + InstanceConnectionPortRange: + $ref: '#/components/schemas/ConnectionPortRange' + InstanceInboundPermissions: + description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/IpPermission' + x-insertionOrder: false + GameServerContainerGroupsPerInstance: + description: The number of desired game server container groups per instance, a number between 1-5000. + type: integer + minimum: 1 + maximum: 5000 + MaximumGameServerContainerGroupsPerInstance: + description: The maximum number of game server container groups per instance, a number between 1-5000. + type: integer + minimum: 1 + maximum: 5000 + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + Status: + description: The current status of the container fleet. + type: string + enum: + - PENDING + - CREATING + - CREATED + - ACTIVATING + - ACTIVE + - UPDATING + - DELETING + DeploymentDetails: + $ref: '#/components/schemas/DeploymentDetails' + DeploymentConfiguration: + $ref: '#/components/schemas/DeploymentConfiguration' + InstanceType: + description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + type: string + minLength: 1 + maxLength: 1024 + BillingType: + description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. + type: string + enum: + - ON_DEMAND + - SPOT + Locations: + type: array + maxItems: 100 + items: + $ref: '#/components/schemas/LocationConfiguration' + x-insertionOrder: false + ScalingPolicies: + description: A list of rules that control how a fleet is scaled. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/ScalingPolicy' + x-insertionOrder: false + MetricGroups: + description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. + type: array + maxItems: 1 + items: + type: string + x-insertionOrder: false + NewGameSessionProtectionPolicy: + description: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. + type: string + enum: + - FullProtection + - NoProtection + GameSessionCreationLimitPolicy: + description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + $ref: '#/components/schemas/GameSessionCreationLimitPolicy' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + FleetArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions. + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$ + required: + - FleetRoleArn + x-stackql-resource-name: container_fleet + description: The AWS::GameLift::ContainerFleet resource creates an Amazon GameLift (GameLift) container fleet to host game servers. + x-type-name: AWS::GameLift::ContainerFleet + x-stackql-primary-identifier: + - FleetId + x-create-only-properties: + - InstanceType + - BillingType + x-write-only-properties: + - DeploymentConfiguration + - GameServerContainerGroupDefinitionName + - PerInstanceContainerGroupDefinitionName + x-read-only-properties: + - CreationTime + - Status + - FleetId + - FleetArn + - DeploymentDetails + - GameServerContainerGroupDefinitionArn + - PerInstanceContainerGroupDefinitionArn + - MaximumGameServerContainerGroupsPerInstance + x-required-properties: + - FleetRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + x-required-permissions: + create: + - gamelift:CreateContainerFleet + - gamelift:DescribeContainerFleet + - gamelift:DescribeFleetDeployment + - gamelift:DescribeFleetLocationAttributes + - gamelift:DescribeFleetLocationCapacity + - gamelift:DescribeScalingPolicies + - gamelift:ListTagsForResource + - gamelift:PutScalingPolicy + - gamelift:StopFleetActions + - gamelift:TagResource + - gamelift:UpdateFleetCapacity + - iam:PassRole + read: + - gamelift:DescribeContainerFleet + - gamelift:DescribeFleetLocationAttributes + - gamelift:DescribeFleetLocationCapacity + - gamelift:DescribeScalingPolicies + - gamelift:ListTagsForResource + delete: + - gamelift:DeleteContainerFleet + - gamelift:DescribeContainerFleet + list: + - gamelift:ListContainerFleets + update: + - gamelift:CreateFleetLocations + - gamelift:DeleteFleetLocations + - gamelift:DeleteScalingPolicy + - gamelift:DescribeContainerFleet + - gamelift:DescribeFleetDeployment + - gamelift:DescribeFleetLocationAttributes + - gamelift:DescribeFleetLocationCapacity + - gamelift:DescribeScalingPolicies + - gamelift:ListTagsForResource + - gamelift:PutScalingPolicy + - gamelift:StartFleetActions + - gamelift:StopFleetActions + - gamelift:TagResource + - gamelift:UntagResource + - gamelift:UpdateContainerFleet + - gamelift:UpdateFleetCapacity + - iam:PassRole + ContainerPortRange: + description: A set of one or more port numbers that can be opened on the container. + type: object + properties: + FromPort: + description: A starting value for the range of allowed port numbers. + type: integer + minimum: 1 + maximum: 60000 + Protocol: + description: Defines the protocol of these ports. + type: string + enum: + - TCP + - UDP + ToPort: + description: An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort. + type: integer + minimum: 1 + maximum: 60000 + required: + - FromPort + - Protocol + - ToPort + additionalProperties: false + ContainerHealthCheck: + description: Specifies how the process manager checks the health of containers. + type: object + properties: + Command: + description: A string array representing the command that the container runs to determine if it is healthy. + type: array + uniqueItems: false + x-insertionOrder: true + minItems: 1 + maxItems: 20 + items: + type: string + minLength: 1 + maxLength: 255 + pattern: ^.*$ + Interval: + description: How often (in seconds) the health is checked. + type: integer + minimum: 60 + maximum: 300 + Timeout: + description: How many seconds the process manager allows the command to run before canceling it. + type: integer + minimum: 30 + maximum: 60 + Retries: + description: How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.) + type: integer + minimum: 5 + maximum: 10 + StartPeriod: + description: The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed. + type: integer + minimum: 0 + maximum: 300 + required: + - Command + additionalProperties: false + PortConfiguration: + description: Defines the ports on a container. + type: object + properties: + ContainerPortRanges: + description: Specifies one or more ranges of ports on a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ContainerPortRange' + required: + - ContainerPortRanges + additionalProperties: false + ContainerEnvironment: + description: An environment variable to set inside a container, in the form of a key-value pair. + type: object + properties: + Name: + description: The environment variable name. + type: string + minLength: 1 + maxLength: 255 + pattern: ^.*$ + Value: + description: The environment variable value. + type: string + minLength: 1 + maxLength: 255 + pattern: ^.*$ + required: + - Name + - Value + additionalProperties: false + ContainerMountPoint: + description: Defines the mount point configuration within a container. + type: object + properties: + InstancePath: + description: The path on the host that will be mounted in the container. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^\/[\s\S]*$ + ContainerPath: + description: The path inside the container where the mount is accessible. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^(\/+[^\/]+\/*)+$ + AccessLevel: + description: The access permissions for the mounted path. + type: string + enum: + - READ_ONLY + - READ_AND_WRITE + required: + - InstancePath + additionalProperties: false + ContainerDependency: + description: A dependency that impacts a container's startup and shutdown. + type: object + properties: + ContainerName: + description: A descriptive label for the container definition. The container being defined depends on this container's condition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + Condition: + description: The type of dependency. + type: string + enum: + - START + - COMPLETE + - SUCCESS + - HEALTHY + required: + - ContainerName + - Condition additionalProperties: false + GameServerContainerDefinition: + description: Specifies the information required to run game servers with this container group type: object properties: - ConcurrentExecutions: - description: The number of server processes that use this configuration to run concurrently on an instance. - type: integer - minimum: 1 - Parameters: + ContainerName: + description: A descriptive label for the container definition. Container definition names must be unique with a container group definition. + type: string minLength: 1 - description: An optional list of parameters to pass to the server executable or Realtime script on launch. + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + DependsOn: + description: A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers. + type: array + uniqueItems: true + x-insertionOrder: true + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerDependency' + ServerSdkVersion: + description: The version of the server SDK used in this container group + type: string + maxLength: 128 + pattern: ^\d+\.\d+\.\d+$ + ImageUri: + description: Specifies the image URI of this container. type: string - maxLength: 1024 - LaunchPath: minLength: 1 - pattern: ^([Cc]:\\game\S+|/local/game/\S+) - description: |- - The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: - - Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" - - Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" + maxLength: 255 + pattern: ^[a-zA-Z0-9-_\.@\/:]+$ + ResolvedImageDigest: + description: The digest of the container image. type: string - maxLength: 1024 + pattern: ^sha256:[a-fA-F0-9]{64}$ + EnvironmentOverride: + description: The environment variables to pass to a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 20 + items: + $ref: '#/components/schemas/ContainerEnvironment' + PortConfiguration: + description: Defines the ports on the container. + $ref: '#/components/schemas/PortConfiguration' + MountPoints: + description: A list of mount point configurations to be used in a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerMountPoint' required: - - ConcurrentExecutions - - LaunchPath - TargetConfiguration: - description: Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. + - ContainerName + - ImageUri + - ServerSdkVersion additionalProperties: false + SupportContainerDefinition: + description: Supports the function of the main container group type: object properties: - TargetValue: - description: Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). + ContainerName: + description: A descriptive label for the container definition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + Vcpu: + description: The number of virtual CPUs to give to the support group type: number + minimum: 0.125 + maximum: 10 + DependsOn: + description: A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers. + type: array + uniqueItems: true + x-insertionOrder: true + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerDependency' + Essential: + description: Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group. + type: boolean + ImageUri: + description: Specifies the image URI of this container. + type: string + minLength: 1 + maxLength: 255 + pattern: ^[a-zA-Z0-9-_\.@\/:]+$ + ResolvedImageDigest: + description: The digest of the container image. + type: string + pattern: ^sha256:[a-fA-F0-9]{64}$ + MemoryHardLimitMebibytes: + description: The total memory limit of container groups following this definition in MiB + type: integer + minimum: 4 + maximum: 1024000 + EnvironmentOverride: + description: The environment variables to pass to a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 20 + items: + $ref: '#/components/schemas/ContainerEnvironment' + PortConfiguration: + description: Defines the ports on the container. + $ref: '#/components/schemas/PortConfiguration' + HealthCheck: + description: Specifies how the health of the containers will be checked. + $ref: '#/components/schemas/ContainerHealthCheck' + MountPoints: + description: A list of mount point configurations to be used in a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerMountPoint' required: - - TargetValue - RuntimeConfiguration: - description: >- - A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. - - - The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each - instance in debug mode. - - - An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration. + - ContainerName + - ImageUri additionalProperties: false + ContainerGroupDefinition: type: object properties: - ServerProcesses: - maxItems: 50 - description: A collection of server process configurations that describe which server processes to run on each instance in a fleet. - x-insertionOrder: false + ContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions. + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$ + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + OperatingSystem: + description: The operating system of the container group + type: string + enum: + - AMAZON_LINUX_2023 + Name: + description: A descriptive label for the container group definition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + ContainerGroupType: + description: The scope of the container group + type: string + enum: + - GAME_SERVER + - PER_INSTANCE + TotalMemoryLimitMebibytes: + description: The total memory limit of container groups following this definition in MiB + type: integer + minimum: 4 + maximum: 1024000 + TotalVcpuLimit: + description: The total amount of virtual CPUs on the container group definition + type: number + minimum: 0.125 + maximum: 10 + GameServerContainerDefinition: + $ref: '#/components/schemas/GameServerContainerDefinition' + SupportContainerDefinitions: + description: A collection of support container definitions that define the containers in this group. type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 10 items: - $ref: '#/components/schemas/ServerProcess' - MaxConcurrentGameSessionActivations: - description: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. - maximum: 2147483647 + $ref: '#/components/schemas/SupportContainerDefinition' + VersionNumber: + description: The version of this ContainerGroupDefinition type: integer - minimum: 1 - GameSessionActivationTimeoutSeconds: - description: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. - maximum: 600 + minimum: 0 + SourceVersionNumber: + description: A specific ContainerGroupDefinition version to be updated type: integer - minimum: 1 - LocationConfiguration: - description: A remote location where a multi-location fleet can deploy EC2 instances for game hosting. - additionalProperties: false - type: object - properties: - LocationCapacity: - $ref: '#/components/schemas/LocationCapacity' - Location: - $ref: '#/components/schemas/Location' + minimum: 0 + VersionDescription: + description: The description of this version + type: string + minLength: 1 + maxLength: 1024 + Status: + description: A string indicating ContainerGroupDefinition status. + type: string + enum: + - READY + - COPYING + - FAILED + StatusReason: + description: A string indicating the reason for ContainerGroupDefinition status. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' required: - - Location + - Name + - OperatingSystem + - TotalMemoryLimitMebibytes + - TotalVcpuLimit + x-stackql-resource-name: container_group_definition + description: The AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition. + x-type-name: AWS::GameLift::ContainerGroupDefinition + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - ContainerGroupType + x-write-only-properties: + - SourceVersionNumber + x-read-only-properties: + - ContainerGroupDefinitionArn + - CreationTime + - VersionNumber + - Status + - StatusReason + x-required-properties: + - Name + - OperatingSystem + - TotalMemoryLimitMebibytes + - TotalVcpuLimit + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + x-required-permissions: + create: + - gamelift:CreateContainerGroupDefinition + - gamelift:DescribeContainerGroupDefinition + - gamelift:ListTagsForResource + - gamelift:TagResource + - ecr:BatchCheckLayerAvailability + - ecr:BatchGetImage + - ecr:GetDownloadUrlForLayer + - ecr:DescribeImages + - ecr:GetAuthorizationToken + read: + - gamelift:DescribeContainerGroupDefinition + - gamelift:ListTagsForResource + update: + - gamelift:DescribeContainerGroupDefinition + - gamelift:UpdateContainerGroupDefinition + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + delete: + - gamelift:DeleteContainerGroupDefinition + list: + - gamelift:ListContainerGroupDefinitions AnywhereConfiguration: description: Configuration for Anywhere fleet. - additionalProperties: false properties: Cost: - minLength: 1 - pattern: ^\d{1,5}(?:\.\d{1,5})?$ description: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost. type: string + pattern: ^\d{1,5}(?:\.\d{1,5})?$ + minLength: 1 maxLength: 11 + additionalProperties: false required: - Cost + CertificateConfiguration: + description: Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate. + type: object + properties: + CertificateType: + type: string + enum: + - DISABLED + - GENERATED + additionalProperties: false + required: + - CertificateType ResourceCreationLimitPolicy: description: |- A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes. - additionalProperties: false type: object properties: - PolicyPeriodInMinutes: - description: The time span used in evaluating the resource creation limit policy. - type: integer - minimum: 0 NewGameSessionsPerCreator: description: The maximum number of game sessions that an individual can create during the policy period. type: integer minimum: 0 - LocationCapacity: - description: Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. - additionalProperties: false - type: object - properties: - MinSize: - description: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. - type: integer - minimum: 0 - DesiredEC2Instances: - description: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. - type: integer - minimum: 0 - MaxSize: - description: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. + PolicyPeriodInMinutes: + description: The time span used in evaluating the resource creation limit policy. type: integer minimum: 0 - required: - - DesiredEC2Instances - - MinSize - - MaxSize - CertificateConfiguration: - description: Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate. additionalProperties: false - type: object - properties: - CertificateType: - type: string - enum: - - DISABLED - - GENERATED - required: - - CertificateType - IpPermission: + RuntimeConfiguration: description: >- - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP - messaging and one for UDP, for use by the Realtime servers. - additionalProperties: false + A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. + + + The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each + instance in debug mode. + + + An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration. type: object properties: - IpRange: - pattern: (^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/([0-9]|[1-2][0-9]|3[0-2]))$) - description: 'A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".' - type: string - FromPort: - description: A starting value for a range of allowed port numbers. - maximum: 60000 + GameSessionActivationTimeoutSeconds: + description: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. type: integer minimum: 1 - ToPort: - description: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. - maximum: 60000 + maximum: 600 + MaxConcurrentGameSessionActivations: + description: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. type: integer minimum: 1 - Protocol: - description: The network communication protocol used by the fleet. - type: string - enum: - - TCP - - UDP - required: - - FromPort - - IpRange - - Protocol - - ToPort - Location: + maximum: 2147483647 + ServerProcesses: + description: A collection of server process configurations that describe which server processes to run on each instance in a fleet. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/ServerProcess' + x-insertionOrder: false + additionalProperties: false + ServerProcess: + description: A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration. type: object properties: - LocationName: + ConcurrentExecutions: + description: The number of server processes that use this configuration to run concurrently on an instance. + type: integer + minimum: 1 + LaunchPath: + description: |- + The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: + + Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" + + Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" type: string - minLength: 8 - maxLength: 64 - pattern: ^custom-[A-Za-z0-9\-]+ - LocationArn: + minLength: 1 + maxLength: 1024 + pattern: ^([Cc]:\\game\S+|/local/game/\S+) + Parameters: + description: An optional list of parameters to pass to the server executable or Realtime script on launch. type: string - pattern: ^arn:.*:location/custom-\S+ - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - maxItems: 200 - items: - $ref: '#/components/schemas/Tag' + minLength: 1 + maxLength: 1024 + additionalProperties: false required: - - LocationName - x-stackql-resource-name: location - x-stackql-primaryIdentifier: - - LocationName - x-create-only-properties: - - LocationName - x-read-only-properties: - - LocationArn - x-required-permissions: - create: - - gamelift:CreateLocation - - gamelift:ListLocations - - gamelift:ListTagsForResource - - gamelift:TagResource - read: - - gamelift:ListLocations - - gamelift:ListTagsForResource - delete: - - gamelift:DeleteLocation - list: - - gamelift:ListLocations - update: - - gamelift:ListLocations - - gamelift:ListTagsForResource - - gamelift:TagResource - - gamelift:UntagResource + - ConcurrentExecutions + - LaunchPath Fleet: type: object properties: ScalingPolicies: - maxItems: 50 description: A list of rules that control how a fleet is scaled. - x-insertionOrder: false type: array + maxItems: 50 items: $ref: '#/components/schemas/ScalingPolicy' - Description: - minLength: 1 - description: A human-readable description of a fleet. - type: string - maxLength: 1024 - PeerVpcId: - minLength: 1 - pattern: ^vpc-\S+ - description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. - type: string - maxLength: 1024 + x-insertionOrder: false + AnywhereConfiguration: + description: Configuration for Anywhere fleet. + $ref: '#/components/schemas/AnywhereConfiguration' ApplyCapacity: - description: Determines whether to apply fleet or location capacities on fleet creation. + description: >- + Determines when and how to apply fleet or location capacities. Allowed options are ON_UPDATE (default), ON_CREATE_AND_UPDATE and ON_CREATE_AND_UPDATE_WITH_AUTOSCALING. If you choose ON_CREATE_AND_UPDATE_WITH_AUTOSCALING, MinSize and MaxSize will still be applied on creation and on updates, but DesiredEC2Instances will only be applied once on fleet creation and will be ignored during updates to prevent conflicts with auto-scaling. During updates with + ON_CREATE_AND_UPDATE_WITH_AUTOSCALING chosen, if current desired instance is lower than the new MinSize, it will be increased to the new MinSize; if current desired instance is larger than the new MaxSize, it will be decreased to the new MaxSize. type: string enum: - ON_UPDATE - ON_CREATE_AND_UPDATE - EC2InboundPermissions: - maxItems: 50 - description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/IpPermission' + - ON_CREATE_AND_UPDATE_WITH_AUTOSCALING + CertificateConfiguration: + description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. + $ref: '#/components/schemas/CertificateConfiguration' ComputeType: description: ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer. type: string enum: - EC2 - ANYWHERE - Name: - minLength: 1 - description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. + Description: + description: A human-readable description of a fleet. type: string - maxLength: 1024 - AnywhereConfiguration: - description: Configuration for Anywhere fleet. - $ref: '#/components/schemas/AnywhereConfiguration' - InstanceRoleARN: minLength: 1 - pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ - description: A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. - type: string - FleetId: - pattern: ^fleet-\S+ - description: Unique fleet ID - type: string - CertificateConfiguration: - description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. - $ref: '#/components/schemas/CertificateConfiguration' - InstanceRoleCredentialsProvider: - description: Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service. - type: string - enum: - - SHARED_CREDENTIAL_FILE + maxLength: 1024 DesiredEC2Instances: description: '[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.' type: integer minimum: 0 - ServerLaunchParameters: - minLength: 1 - description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + EC2InboundPermissions: + description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/IpPermission' + x-insertionOrder: false + EC2InstanceType: + description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. type: string - maxLength: 1024 + pattern: ^.*..*$ FleetType: description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. type: string enum: - ON_DEMAND - SPOT + InstanceRoleARN: + description: A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. + type: string + minLength: 1 + pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + InstanceRoleCredentialsProvider: + description: Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service. + type: string + enum: + - SHARED_CREDENTIAL_FILE Locations: + type: array minItems: 1 maxItems: 100 + items: + $ref: '#/components/schemas/LocationConfiguration' x-insertionOrder: false + LogPaths: + description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() type: array items: - $ref: '#/components/schemas/LocationConfiguration' + type: string + x-insertionOrder: false + MaxSize: + description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' + type: integer + minimum: 0 + MetricGroups: + description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. + type: array + maxItems: 1 + items: + type: string + x-insertionOrder: false + MinSize: + description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' + type: integer + minimum: 0 + Name: + description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 NewGameSessionProtectionPolicy: description: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. type: string enum: - FullProtection - NoProtection + PeerVpcAwsAccountId: + description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^[0-9]{12}$ + PeerVpcId: + description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^vpc-\S+ + ResourceCreationLimitPolicy: + description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + $ref: '#/components/schemas/ResourceCreationLimitPolicy' + FleetId: + description: Unique fleet ID + type: string + pattern: ^fleet-\S+ + BuildId: + description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + type: string + pattern: ^build-\S+|^arn:.*:build/build-\S+ ScriptId: - pattern: ^script-\S+|^arn:.*:script/script-\S+ description: |- A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created. Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually. type: string - MaxSize: - description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' - type: integer - minimum: 0 + pattern: ^script-\S+|^arn:.*:script/script-\S+ RuntimeConfiguration: description: |- Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work. $ref: '#/components/schemas/RuntimeConfiguration' - LogPaths: - description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() - x-insertionOrder: false - type: array - items: - type: string - ServerLaunchPath: + ServerLaunchParameters: + description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + type: string minLength: 1 + maxLength: 1024 + ServerLaunchPath: description: This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. type: string - maxLength: 1024 - MinSize: - description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' - type: integer - minimum: 0 - PeerVpcAwsAccountId: minLength: 1 - pattern: ^[0-9]{12}$ - description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. - type: string maxLength: 1024 - MetricGroups: - maxItems: 1 - description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. - x-insertionOrder: false + Tags: + description: An array of key-value pairs to apply to this resource. type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 items: - type: string - BuildId: - pattern: ^build-\S+|^arn:.*:build/build-\S+ - description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. - type: string - ResourceCreationLimitPolicy: - description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. - $ref: '#/components/schemas/ResourceCreationLimitPolicy' - EC2InstanceType: - pattern: ^.*..*$ - description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + $ref: '#/components/schemas/Tag' + FleetArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers Fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Fleet ARN, the resource ID matches the FleetId value. + pattern: ^arn:.*:fleet/[a-z]*fleet-[a-zA-Z0-9\-]+$ type: string required: - Name x-stackql-resource-name: fleet - x-stackql-primaryIdentifier: + description: The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions. + x-type-name: AWS::GameLift::Fleet + x-stackql-primary-identifier: - FleetId x-create-only-properties: - - ApplyCapacity - BuildId - CertificateConfiguration - EC2InstanceType @@ -606,29 +1838,49 @@ components: - ScriptId - ServerLaunchParameters - ServerLaunchPath - - CertificateType - ComputeType + x-write-only-properties: + - ApplyCapacity x-read-only-properties: - FleetId + - FleetArn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: - read: + create: + - gamelift:CreateFleet + - gamelift:CreateFleetLocations - gamelift:DescribeFleetAttributes - gamelift:DescribeFleetLocationAttributes + - gamelift:UpdateFleetCapacity + - gamelift:DescribeFleetLocationCapacity - gamelift:DescribeFleetCapacity - gamelift:DescribeFleetPortSettings - - gamelift:DescribeFleetUtilization - gamelift:DescribeRuntimeConfiguration - - gamelift:DescribeEC2InstanceLimits - - gamelift:DescribeFleetEvents + - gamelift:PutScalingPolicy - gamelift:DescribeScalingPolicies - create: - - gamelift:CreateFleet + - gamelift:ListTagsForResource + - gamelift:UpdateFleetCapacity + - gamelift:TagResource + read: - gamelift:DescribeFleetAttributes - gamelift:DescribeFleetLocationAttributes - - gamelift:UpdateFleetCapacity - gamelift:DescribeFleetLocationCapacity - - gamelift:PutScalingPolicy + - gamelift:DescribeFleetCapacity + - gamelift:DescribeFleetPortSettings + - gamelift:DescribeRuntimeConfiguration - gamelift:DescribeScalingPolicies + - gamelift:ListTagsForResource update: - gamelift:UpdateFleetAttributes - gamelift:CreateFleetLocations @@ -642,16 +1894,26 @@ components: - gamelift:PutScalingPolicy - gamelift:DescribeScalingPolicies - gamelift:DeleteScalingPolicy - list: - - gamelift:ListFleets + - gamelift:DescribeFleetAttributes + - gamelift:DescribeFleetCapacity + - gamelift:DescribeRuntimeConfiguration + - gamelift:TagResource + - gamelift:UntagResource + - gamelift:ListTagsForResource delete: - gamelift:DeleteFleet - gamelift:DescribeFleetLocationCapacity + - gamelift:DescribeFleetAttributes + - gamelift:DescribeFleetCapacity + - gamelift:DescribeFleetLocationCapacity + - gamelift:UpdateFleetCapacity - gamelift:DescribeScalingPolicies - gamelift:DeleteScalingPolicy + list: + - gamelift:ListFleets AutoScalingPolicy: type: object - description: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting + description: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. properties: EstimatedInstanceWarmup: $ref: '#/components/schemas/EstimatedInstanceWarmup' @@ -735,7 +1997,7 @@ components: pattern: ^[\u0031-\u0039][\u0030-\u0039]{0,2}$ LaunchTemplate: type: object - description: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. + description: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. properties: LaunchTemplateId: $ref: '#/components/schemas/LaunchTemplateId' @@ -755,11 +2017,11 @@ components: description: The version of the EC2 launch template to use. MaxSize: type: number - description: The maximum number of instances allowed in the EC2 Auto Scaling group. + description: The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. minimum: 1 MinSize: type: number - description: The minimum number of instances allowed in the EC2 Auto Scaling group. + description: The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. minimum: 0 RoleArn: type: string @@ -775,27 +2037,9 @@ components: minItems: 0 maxItems: 200 x-insertionOrder: false - Tag: - description: A key-value pair to associate with a resource. - type: object - properties: - Key: - type: string - description: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. - minLength: 1 - maxLength: 128 - Value: - type: string - description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false VpcSubnets: type: array - description: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. + description: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. items: type: string pattern: ^subnet-[0-9a-z]+$ @@ -811,7 +2055,7 @@ components: description: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group. $ref: '#/components/schemas/AutoScalingGroupArn' AutoScalingPolicy: - description: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting + description: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. $ref: '#/components/schemas/AutoScalingPolicy' BalancingStrategy: description: The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting. @@ -832,36 +2076,60 @@ components: description: A set of EC2 instance types to use when creating instances in the group. $ref: '#/components/schemas/InstanceDefinitions' LaunchTemplate: - description: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. + description: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. $ref: '#/components/schemas/LaunchTemplate' MaxSize: - description: The maximum number of instances allowed in the EC2 Auto Scaling group. + description: The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. $ref: '#/components/schemas/MaxSize' MinSize: - description: The minimum number of instances allowed in the EC2 Auto Scaling group. + description: The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. $ref: '#/components/schemas/MinSize' RoleArn: description: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. $ref: '#/components/schemas/RoleArn' Tags: - description: A list of labels to assign to the new game server group resource. + description: A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead. $ref: '#/components/schemas/Tags' VpcSubnets: - description: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. + description: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. $ref: '#/components/schemas/VpcSubnets' required: - GameServerGroupName - InstanceDefinitions - RoleArn x-stackql-resource-name: game_server_group - x-stackql-primaryIdentifier: + description: The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup. + x-type-name: AWS::GameLift::GameServerGroup + x-stackql-primary-identifier: - GameServerGroupArn + x-write-only-properties: + - DeleteOption + - LaunchTemplate + - MinSize + - MaxSize + - AutoScalingPolicy + - VpcSubnets x-read-only-properties: - GameServerGroupArn - AutoScalingGroupArn + x-required-properties: + - GameServerGroupName + - InstanceDefinitions + - RoleArn + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + tagOnCreate: true + tagUpdatable: true + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: create: - gamelift:CreateGameServerGroup + - gamelift:ListTagsForResource - gamelift:TagResource - gamelift:DescribeGameServerGroup - iam:assumeRole @@ -888,8 +2156,12 @@ components: - events:PutTargets read: - gamelift:DescribeGameServerGroup + - gamelift:ListTagsForResource update: - gamelift:UpdateGameServerGroup + - gamelift:TagResource + - gamelift:UntagResource + - gamelift:ListTagsForResource - iam:assumeRole - iam:PassRole - autoscaling:DescribeAutoScalingGroups @@ -1087,15 +2359,30 @@ components: required: - Name x-stackql-resource-name: game_session_queue - x-stackql-primaryIdentifier: + description: The AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue. + x-type-name: AWS::GameLift::GameSessionQueue + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: create: - gamelift:CreateGameSessionQueue + - gamelift:DescribeGameSessionQueues - gamelift:ListTagsForResource - gamelift:TagResource read: @@ -1109,6 +2396,7 @@ components: - gamelift:ListTagsForResource - gamelift:TagResource - gamelift:UntagResource + - gamelift:DescribeGameSessionQueues list: - gamelift:DescribeGameSessionQueues GameProperty: @@ -1232,12 +2520,29 @@ components: - RequestTimeoutSeconds - RuleSetName x-stackql-resource-name: matchmaking_configuration - x-stackql-primaryIdentifier: + description: The AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration. + x-type-name: AWS::GameLift::MatchmakingConfiguration + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - AcceptanceRequired + - Name + - RequestTimeoutSeconds + - RuleSetName + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + tagOnCreate: true + tagUpdatable: true + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: create: - gamelift:CreateMatchmakingConfiguration @@ -1291,7 +2596,9 @@ components: - Name - RuleSetBody x-stackql-resource-name: matchmaking_rule_set - x-stackql-primaryIdentifier: + description: The AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set. + x-type-name: AWS::GameLift::MatchmakingRuleSet + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -1299,6 +2606,19 @@ components: x-read-only-properties: - Arn - CreationTime + x-required-properties: + - Name + - RuleSetBody + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + tagOnCreate: true + tagUpdatable: true + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource x-required-permissions: create: - gamelift:CreateMatchmakingRuleSet @@ -1324,138 +2644,1083 @@ components: type: object additionalProperties: false properties: - Bucket: - description: An Amazon S3 bucket identifier. This is the name of the S3 bucket. + Bucket: + description: An Amazon S3 bucket identifier. This is the name of the S3 bucket. + type: string + minLength: 1 + Key: + description: The name of the zip file that contains the script files. + type: string + minLength: 1 + ObjectVersion: + description: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. + type: string + minLength: 1 + RoleArn: + description: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. + type: string + minLength: 1 + required: + - Bucket + - Key + - RoleArn + Script: + type: object + properties: + Name: + type: string + description: A descriptive label that is associated with a script. Script names do not need to be unique. + minLength: 1 + maxLength: 1024 + StorageLocation: + type: object + description: >- + The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use + the ObjectVersion parameter to specify an earlier version. + $ref: '#/components/schemas/S3Location' + Version: + description: The version that is associated with a script. Version strings do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + Arn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value. + pattern: ^arn:.*:script\/script-\S+ + type: string + Id: + description: A unique identifier for the Realtime script + pattern: ^script-\S+ + type: string + SizeOnDisk: + description: The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". + type: integer + minimum: 1 + required: + - StorageLocation + x-stackql-resource-name: script + description: The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. + x-type-name: AWS::GameLift::Script + x-stackql-primary-identifier: + - Id + x-read-only-properties: + - Id + - CreationTime + - Arn + - SizeOnDisk + x-required-properties: + - StorageLocation + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + tagOnCreate: true + tagUpdatable: true + permissions: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + x-required-permissions: + create: + - gamelift:CreateScript + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:DescribeScript + - iam:PassRole + read: + - gamelift:DescribeScript + - gamelift:ListScripts + - gamelift:ListTagsForResource + delete: + - gamelift:DeleteScript + list: + - gamelift:ListScripts + - gamelift:DescribeScript + update: + - gamelift:DescribeScript + - gamelift:UpdateScript + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + - iam:PassRole + CreateAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A human-readable description of the alias. + type: string + minLength: 1 + maxLength: 1024 + Name: + description: A descriptive label that is associated with an alias. Alias names do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 + pattern: .*\S.* + RoutingStrategy: + description: A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message. + $ref: '#/components/schemas/RoutingStrategy' + AliasId: + description: Unique alias ID + type: string + AliasArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Alias resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Alias ARN, the resource ID matches the AliasId value. + pattern: ^arn:.*:alias\/alias-\S+ + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAliasRequest + type: object + required: [] + CreateBuildRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BuildId: + description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + type: string + Name: + description: A descriptive label that is associated with a build. Build names do not need to be unique. + type: string + OperatingSystem: + description: The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later. + type: string + enum: + - AMAZON_LINUX + - AMAZON_LINUX_2 + - AMAZON_LINUX_2023 + - WINDOWS_2012 + - WINDOWS_2016 + StorageLocation: + description: Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. + $ref: '#/components/schemas/StorageLocation' + Version: + description: Version information that is associated with this build. Version strings do not need to be unique. + type: string + ServerSdkVersion: + description: A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + BuildArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift build ARN, the resource ID matches the BuildId value. + pattern: ^arn:.*:build\/build-\S+ + type: string + x-stackQL-stringOnly: true + x-title: CreateBuildRequest + type: object + required: [] + CreateLocationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LocationName: + type: string + minLength: 8 + maxLength: 64 + pattern: ^custom-[A-Za-z0-9\-]+ + LocationArn: + type: string + pattern: ^arn:.*:location/custom-\S+ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateLocationRequest + type: object + required: [] + CreateContainerFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FleetId: + description: Unique fleet ID + type: string + pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+ + minLength: 1 + maxLength: 128 + FleetRoleArn: + description: A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. + type: string + pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + minLength: 1 + maxLength: 256 + Description: + description: A human-readable description of a fleet. + type: string + minLength: 1 + maxLength: 1024 + GameServerContainerGroupDefinitionName: + description: The name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group. + type: string + minLength: 1 + maxLength: 512 + pattern: ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$ + GameServerContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified. + type: string + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$|^$ + PerInstanceContainerGroupDefinitionName: + description: The name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName. + type: string + minLength: 1 + maxLength: 512 + pattern: ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$ + PerInstanceContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified. + type: string + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$|^$ + InstanceConnectionPortRange: + $ref: '#/components/schemas/ConnectionPortRange' + InstanceInboundPermissions: + description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/IpPermission' + x-insertionOrder: false + GameServerContainerGroupsPerInstance: + description: The number of desired game server container groups per instance, a number between 1-5000. + type: integer + minimum: 1 + maximum: 5000 + MaximumGameServerContainerGroupsPerInstance: + description: The maximum number of game server container groups per instance, a number between 1-5000. + type: integer + minimum: 1 + maximum: 5000 + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + Status: + description: The current status of the container fleet. + type: string + enum: + - PENDING + - CREATING + - CREATED + - ACTIVATING + - ACTIVE + - UPDATING + - DELETING + DeploymentDetails: + $ref: '#/components/schemas/DeploymentDetails' + DeploymentConfiguration: + $ref: '#/components/schemas/DeploymentConfiguration' + InstanceType: + description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + type: string + minLength: 1 + maxLength: 1024 + BillingType: + description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. + type: string + enum: + - ON_DEMAND + - SPOT + Locations: + type: array + maxItems: 100 + items: + $ref: '#/components/schemas/LocationConfiguration' + x-insertionOrder: false + ScalingPolicies: + description: A list of rules that control how a fleet is scaled. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/ScalingPolicy' + x-insertionOrder: false + MetricGroups: + description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. + type: array + maxItems: 1 + items: + type: string + x-insertionOrder: false + NewGameSessionProtectionPolicy: + description: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. + type: string + enum: + - FullProtection + - NoProtection + GameSessionCreationLimitPolicy: + description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + $ref: '#/components/schemas/GameSessionCreationLimitPolicy' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + FleetArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions. + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$ + x-stackQL-stringOnly: true + x-title: CreateContainerFleetRequest + type: object + required: [] + CreateContainerGroupDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions. + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$ + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + OperatingSystem: + description: The operating system of the container group + type: string + enum: + - AMAZON_LINUX_2023 + Name: + description: A descriptive label for the container group definition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + ContainerGroupType: + description: The scope of the container group + type: string + enum: + - GAME_SERVER + - PER_INSTANCE + TotalMemoryLimitMebibytes: + description: The total memory limit of container groups following this definition in MiB + type: integer + minimum: 4 + maximum: 1024000 + TotalVcpuLimit: + description: The total amount of virtual CPUs on the container group definition + type: number + minimum: 0.125 + maximum: 10 + GameServerContainerDefinition: + $ref: '#/components/schemas/GameServerContainerDefinition' + SupportContainerDefinitions: + description: A collection of support container definitions that define the containers in this group. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/SupportContainerDefinition' + VersionNumber: + description: The version of this ContainerGroupDefinition + type: integer + minimum: 0 + SourceVersionNumber: + description: A specific ContainerGroupDefinition version to be updated + type: integer + minimum: 0 + VersionDescription: + description: The description of this version + type: string + minLength: 1 + maxLength: 1024 + Status: + description: A string indicating ContainerGroupDefinition status. + type: string + enum: + - READY + - COPYING + - FAILED + StatusReason: + description: A string indicating the reason for ContainerGroupDefinition status. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateContainerGroupDefinitionRequest + type: object + required: [] + CreateFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScalingPolicies: + description: A list of rules that control how a fleet is scaled. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/ScalingPolicy' + x-insertionOrder: false + AnywhereConfiguration: + description: Configuration for Anywhere fleet. + $ref: '#/components/schemas/AnywhereConfiguration' + ApplyCapacity: + description: >- + Determines when and how to apply fleet or location capacities. Allowed options are ON_UPDATE (default), ON_CREATE_AND_UPDATE and ON_CREATE_AND_UPDATE_WITH_AUTOSCALING. If you choose ON_CREATE_AND_UPDATE_WITH_AUTOSCALING, MinSize and MaxSize will still be applied on creation and on updates, but DesiredEC2Instances will only be applied once on fleet creation and will be ignored during updates to prevent conflicts with auto-scaling. During updates with + ON_CREATE_AND_UPDATE_WITH_AUTOSCALING chosen, if current desired instance is lower than the new MinSize, it will be increased to the new MinSize; if current desired instance is larger than the new MaxSize, it will be decreased to the new MaxSize. + type: string + enum: + - ON_UPDATE + - ON_CREATE_AND_UPDATE + - ON_CREATE_AND_UPDATE_WITH_AUTOSCALING + CertificateConfiguration: + description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. + $ref: '#/components/schemas/CertificateConfiguration' + ComputeType: + description: ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer. + type: string + enum: + - EC2 + - ANYWHERE + Description: + description: A human-readable description of a fleet. + type: string + minLength: 1 + maxLength: 1024 + DesiredEC2Instances: + description: '[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.' + type: integer + minimum: 0 + EC2InboundPermissions: + description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/IpPermission' + x-insertionOrder: false + EC2InstanceType: + description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + type: string + pattern: ^.*..*$ + FleetType: + description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. + type: string + enum: + - ON_DEMAND + - SPOT + InstanceRoleARN: + description: A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. + type: string + minLength: 1 + pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + InstanceRoleCredentialsProvider: + description: Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service. + type: string + enum: + - SHARED_CREDENTIAL_FILE + Locations: + type: array + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/LocationConfiguration' + x-insertionOrder: false + LogPaths: + description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() + type: array + items: + type: string + x-insertionOrder: false + MaxSize: + description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' + type: integer + minimum: 0 + MetricGroups: + description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. + type: array + maxItems: 1 + items: + type: string + x-insertionOrder: false + MinSize: + description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' + type: integer + minimum: 0 + Name: + description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 + NewGameSessionProtectionPolicy: + description: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. + type: string + enum: + - FullProtection + - NoProtection + PeerVpcAwsAccountId: + description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^[0-9]{12}$ + PeerVpcId: + description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^vpc-\S+ + ResourceCreationLimitPolicy: + description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + $ref: '#/components/schemas/ResourceCreationLimitPolicy' + FleetId: + description: Unique fleet ID + type: string + pattern: ^fleet-\S+ + BuildId: + description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + type: string + pattern: ^build-\S+|^arn:.*:build/build-\S+ + ScriptId: + description: |- + A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created. + + Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually. + type: string + pattern: ^script-\S+|^arn:.*:script/script-\S+ + RuntimeConfiguration: + description: >- + Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request + exception. + + + This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work. + $ref: '#/components/schemas/RuntimeConfiguration' + ServerLaunchParameters: + description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + type: string + minLength: 1 + maxLength: 1024 + ServerLaunchPath: + description: This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. + type: string + minLength: 1 + maxLength: 1024 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + FleetArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers Fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Fleet ARN, the resource ID matches the FleetId value. + pattern: ^arn:.*:fleet/[a-z]*fleet-[a-zA-Z0-9\-]+$ + type: string + x-stackQL-stringOnly: true + x-title: CreateFleetRequest + type: object + required: [] + CreateGameServerGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoScalingGroupArn: + description: A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group. + $ref: '#/components/schemas/AutoScalingGroupArn' + AutoScalingPolicy: + description: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. + $ref: '#/components/schemas/AutoScalingPolicy' + BalancingStrategy: + description: The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting. + $ref: '#/components/schemas/BalancingStrategy' + DeleteOption: + description: The type of delete to perform. + $ref: '#/components/schemas/DeleteOption' + GameServerGroupArn: + description: A generated unique ID for the game server group. + $ref: '#/components/schemas/GameServerGroupArn' + GameServerGroupName: + description: An identifier for the new game server group. + $ref: '#/components/schemas/GameServerGroupName' + GameServerProtectionPolicy: + description: A flag that indicates whether instances in the game server group are protected from early termination. + $ref: '#/components/schemas/GameServerProtectionPolicy' + InstanceDefinitions: + description: A set of EC2 instance types to use when creating instances in the group. + $ref: '#/components/schemas/InstanceDefinitions' + LaunchTemplate: + description: The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. + $ref: '#/components/schemas/LaunchTemplate' + MaxSize: + description: The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. + $ref: '#/components/schemas/MaxSize' + MinSize: + description: The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. + $ref: '#/components/schemas/MinSize' + RoleArn: + description: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. + $ref: '#/components/schemas/RoleArn' + Tags: + description: A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead. + $ref: '#/components/schemas/Tags' + VpcSubnets: + description: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. + $ref: '#/components/schemas/VpcSubnets' + x-stackQL-stringOnly: true + x-title: CreateGameServerGroupRequest + type: object + required: [] + CreateGameSessionQueueRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: A descriptive label that is associated with game session queue. Queue names must be unique within each Region. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9-]+' + TimeoutInSeconds: + description: The maximum time, in seconds, that a new game session placement request remains in the queue. + type: integer + minimum: 0 + Destinations: + description: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/GameSessionQueueDestination' + PlayerLatencyPolicies: + description: A set of policies that act as a sliding cap on player latency. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PlayerLatencyPolicy' + CustomEventData: + description: Information that is added to all events that are related to this game session queue. + type: string + minLength: 1 + maxLength: 256 + pattern: '[\s\S]*' + NotificationTarget: + description: An SNS topic ARN that is set up to receive game session placement notifications. + type: string + minLength: 1 + maxLength: 300 + pattern: '[a-zA-Z0-9:_-]*(\.fifo)?' + FilterConfiguration: + description: A list of locations where a queue is allowed to place new game sessions. + type: object + $ref: '#/components/schemas/FilterConfiguration' + PriorityConfiguration: + description: Custom settings to use when prioritizing destinations and locations for game session placements. + type: object + $ref: '#/components/schemas/PriorityConfiguration' + Arn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. + type: string + minLength: 1 + maxLength: 256 + pattern: ^arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateGameSessionQueueRequest + type: object + required: [] + CreateMatchmakingConfigurationRequest: + properties: + ClientToken: type: string - minLength: 1 - Key: - description: The name of the zip file that contains the script files. + RoleArn: type: string - minLength: 1 - ObjectVersion: - description: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. + TypeName: type: string - minLength: 1 - RoleArn: - description: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. + TypeVersionId: type: string - minLength: 1 - required: - - Bucket - - Key - - RoleArn - Script: + DesiredState: + type: object + properties: + AcceptanceRequired: + description: A flag that indicates whether a match that was created with this configuration must be accepted by the matched players + type: boolean + AcceptanceTimeoutSeconds: + description: The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. + type: integer + minimum: 1 + maximum: 600 + AdditionalPlayerCount: + description: The number of player slots in a match to keep open for future players. + type: integer + minimum: 0 + BackfillMode: + description: The method used to backfill game sessions created with this matchmaking configuration. + type: string + enum: + - AUTOMATIC + - MANUAL + Arn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. + type: string + pattern: ^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]* + CreationTime: + description: A time stamp indicating when this data object was created. + type: string + CustomEventData: + description: Information to attach to all events related to the matchmaking configuration. + type: string + minLength: 0 + maxLength: 256 + Description: + description: A descriptive label that is associated with matchmaking configuration. + type: string + minLength: 1 + maxLength: 1024 + FlexMatchMode: + description: Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. + type: string + enum: + - STANDALONE + - WITH_QUEUE + GameProperties: + description: A set of custom properties for a game session, formatted as key:value pairs. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 16 + items: + $ref: '#/components/schemas/GameProperty' + GameSessionData: + description: A set of custom game session properties, formatted as a single string value. + type: string + minLength: 1 + maxLength: 4096 + GameSessionQueueArns: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. + type: array + x-insertionOrder: false + items: + type: string + pattern: '[a-zA-Z0-9:/-]+' + minLength: 1 + maxLength: 256 + Name: + description: A unique identifier for the matchmaking configuration. + type: string + pattern: '[a-zA-Z0-9-\.]*' + maxLength: 128 + NotificationTarget: + description: An SNS topic ARN that is set up to receive matchmaking notifications. + type: string + pattern: '[a-zA-Z0-9:_/-]*(.fifo)?' + minLength: 0 + maxLength: 300 + RequestTimeoutSeconds: + description: The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. + type: integer + minimum: 1 + maximum: 43200 + RuleSetArn: + description: The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses. + type: string + pattern: ^arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]* + RuleSetName: + description: A unique identifier for the matchmaking rule set to use with this configuration. + type: string + pattern: '[a-zA-Z0-9-\.]*' + maxLength: 128 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateMatchmakingConfigurationRequest type: object + required: [] + CreateMatchmakingRuleSetRequest: properties: - Name: + ClientToken: type: string - description: A descriptive label that is associated with a script. Script names do not need to be unique. - minLength: 1 - maxLength: 1024 - StorageLocation: + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object - description: >- - The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use - the ObjectVersion parameter to specify an earlier version. - $ref: '#/components/schemas/S3Location' - Version: - description: The version that is associated with a script. Version strings do not need to be unique. + properties: + Name: + description: A unique identifier for the matchmaking rule set. + type: string + maxLength: 128 + pattern: '[a-zA-Z0-9-\.]*' + RuleSetBody: + description: A collection of matchmaking rules, formatted as a JSON string. + type: string + minLength: 1 + maxLength: 65535 + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds. + type: string + Arn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. + type: string + pattern: ^arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]* + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateMatchmakingRuleSetRequest + type: object + required: [] + CreateScriptRequest: + properties: + ClientToken: type: string - minLength: 1 - maxLength: 1024 - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - maxItems: 200 - items: - $ref: '#/components/schemas/Tag' - CreationTime: - description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + RoleArn: type: string - Arn: - description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value. - pattern: ^arn:.*:script\/script-\S+ + TypeName: type: string - Id: - description: A unique identifier for the Realtime script - pattern: ^script-\S+ + TypeVersionId: type: string - SizeOnDisk: - description: The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". - type: integer - minimum: 1 - required: - - StorageLocation - x-stackql-resource-name: script - x-stackql-primaryIdentifier: - - Id - x-read-only-properties: - - Id - - CreationTime - - Arn - - SizeOnDisk - x-required-permissions: - create: - - gamelift:CreateScript - - gamelift:ListTagsForResource - - gamelift:TagResource - - gamelift:DescribeScript - - iam:PassRole - read: - - gamelift:DescribeScript - - gamelift:ListScripts - - gamelift:ListTagsForResource - delete: - - gamelift:DeleteScript - list: - - gamelift:ListScripts - - gamelift:DescribeScript - update: - - gamelift:DescribeScript - - gamelift:UpdateScript - - gamelift:ListTagsForResource - - gamelift:TagResource - - gamelift:UntagResource - - iam:PassRole + DesiredState: + type: object + properties: + Name: + type: string + description: A descriptive label that is associated with a script. Script names do not need to be unique. + minLength: 1 + maxLength: 1024 + StorageLocation: + type: object + description: >- + The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can + use the ObjectVersion parameter to specify an earlier version. + $ref: '#/components/schemas/S3Location' + Version: + description: The version that is associated with a script. Version strings do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + Arn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value. + pattern: ^arn:.*:script\/script-\S+ + type: string + Id: + description: A unique identifier for the Realtime script + pattern: ^script-\S+ + type: string + SizeOnDisk: + description: The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". + type: integer + minimum: 1 + x-stackQL-stringOnly: true + x-title: CreateScriptRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: aliases: name: aliases id: awscc.gamelift.aliases x-cfn-schema-name: Alias - x-type: list - x-identifiers: - - AliasId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AliasId') as alias_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AliasId') as alias_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' - AND region = 'us-east-1' - alias: - name: alias - id: awscc.gamelift.alias - x-cfn-schema-name: Alias - x-type: get + x-cfn-type-name: AWS::GameLift::Alias x-identifiers: - AliasId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1463,12 +3728,14 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.RoutingStrategy') as routing_strategy, - JSON_EXTRACT(Properties, '$.AliasId') as alias_id + JSON_EXTRACT(Properties, '$.AliasId') as alias_id, + JSON_EXTRACT(Properties, '$.AliasArn') as alias_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Alias' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1476,17 +3743,25 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'RoutingStrategy') as routing_strategy, - json_extract_path_text(Properties, 'AliasId') as alias_id + json_extract_path_text(Properties, 'AliasId') as alias_id, + json_extract_path_text(Properties, 'AliasArn') as alias_arn, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Alias' AND data__Identifier = '' AND region = 'us-east-1' - builds: - name: builds - id: awscc.gamelift.builds - x-cfn-schema-name: Build - x-type: list + aliases_list_only: + name: aliases_list_only + id: awscc.gamelift.aliases_list_only + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::GameLift::Alias x-identifiers: - - BuildId + - AliasId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1494,28 +3769,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BuildId') as build_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' + JSON_EXTRACT(Properties, '$.AliasId') as alias_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BuildId') as build_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' + json_extract_path_text(Properties, 'AliasId') as alias_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' AND region = 'us-east-1' - build: - name: build - id: awscc.gamelift.build + builds: + name: builds + id: awscc.gamelift.builds x-cfn-schema-name: Build - x-type: get + x-cfn-type-name: AWS::GameLift::Build x-identifiers: - BuildId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Build&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Build" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Build" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Build" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/builds/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/builds/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/builds/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1525,12 +3848,14 @@ components: JSON_EXTRACT(Properties, '$.OperatingSystem') as operating_system, JSON_EXTRACT(Properties, '$.StorageLocation') as storage_location, JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.ServerSdkVersion') as server_sdk_version + JSON_EXTRACT(Properties, '$.ServerSdkVersion') as server_sdk_version, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.BuildArn') as build_arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Build' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1540,17 +3865,137 @@ components: json_extract_path_text(Properties, 'OperatingSystem') as operating_system, json_extract_path_text(Properties, 'StorageLocation') as storage_location, json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'ServerSdkVersion') as server_sdk_version + json_extract_path_text(Properties, 'ServerSdkVersion') as server_sdk_version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'BuildArn') as build_arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Build' AND data__Identifier = '' AND region = 'us-east-1' + builds_list_only: + name: builds_list_only + id: awscc.gamelift.builds_list_only + x-cfn-schema-name: Build + x-cfn-type-name: AWS::GameLift::Build + x-identifiers: + - BuildId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.BuildId') as build_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BuildId') as build_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' + AND region = 'us-east-1' locations: name: locations id: awscc.gamelift.locations x-cfn-schema-name: Location - x-type: list + x-cfn-type-name: AWS::GameLift::Location + x-identifiers: + - LocationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Location&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Location" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Location" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Location" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/locations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.LocationName') as location_name, + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Location' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LocationName') as location_name, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Location' + AND data__Identifier = '' + AND region = 'us-east-1' + locations_list_only: + name: locations_list_only + id: awscc.gamelift.locations_list_only + x-cfn-schema-name: Location + x-cfn-type-name: AWS::GameLift::Location x-identifiers: - LocationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1569,46 +4014,280 @@ components: json_extract_path_text(Properties, 'LocationName') as location_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Location' AND region = 'us-east-1' - location: - name: location - id: awscc.gamelift.location - x-cfn-schema-name: Location - x-type: get + container_fleets: + name: container_fleets + id: awscc.gamelift.container_fleets + x-cfn-schema-name: ContainerFleet + x-cfn-type-name: AWS::GameLift::ContainerFleet x-identifiers: - - LocationName + - FleetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContainerFleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/container_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/container_fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/container_fleets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.FleetRoleArn') as fleet_role_arn, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.GameServerContainerGroupDefinitionName') as game_server_container_group_definition_name, + JSON_EXTRACT(Properties, '$.GameServerContainerGroupDefinitionArn') as game_server_container_group_definition_arn, + JSON_EXTRACT(Properties, '$.PerInstanceContainerGroupDefinitionName') as per_instance_container_group_definition_name, + JSON_EXTRACT(Properties, '$.PerInstanceContainerGroupDefinitionArn') as per_instance_container_group_definition_arn, + JSON_EXTRACT(Properties, '$.InstanceConnectionPortRange') as instance_connection_port_range, + JSON_EXTRACT(Properties, '$.InstanceInboundPermissions') as instance_inbound_permissions, + JSON_EXTRACT(Properties, '$.GameServerContainerGroupsPerInstance') as game_server_container_groups_per_instance, + JSON_EXTRACT(Properties, '$.MaximumGameServerContainerGroupsPerInstance') as maximum_game_server_container_groups_per_instance, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.DeploymentDetails') as deployment_details, + JSON_EXTRACT(Properties, '$.DeploymentConfiguration') as deployment_configuration, + JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, + JSON_EXTRACT(Properties, '$.BillingType') as billing_type, + JSON_EXTRACT(Properties, '$.Locations') as locations, + JSON_EXTRACT(Properties, '$.ScalingPolicies') as scaling_policies, + JSON_EXTRACT(Properties, '$.MetricGroups') as metric_groups, + JSON_EXTRACT(Properties, '$.NewGameSessionProtectionPolicy') as new_game_session_protection_policy, + JSON_EXTRACT(Properties, '$.GameSessionCreationLimitPolicy') as game_session_creation_limit_policy, + JSON_EXTRACT(Properties, '$.LogConfiguration') as log_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.FleetArn') as fleet_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::ContainerFleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'FleetRoleArn') as fleet_role_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'GameServerContainerGroupDefinitionName') as game_server_container_group_definition_name, + json_extract_path_text(Properties, 'GameServerContainerGroupDefinitionArn') as game_server_container_group_definition_arn, + json_extract_path_text(Properties, 'PerInstanceContainerGroupDefinitionName') as per_instance_container_group_definition_name, + json_extract_path_text(Properties, 'PerInstanceContainerGroupDefinitionArn') as per_instance_container_group_definition_arn, + json_extract_path_text(Properties, 'InstanceConnectionPortRange') as instance_connection_port_range, + json_extract_path_text(Properties, 'InstanceInboundPermissions') as instance_inbound_permissions, + json_extract_path_text(Properties, 'GameServerContainerGroupsPerInstance') as game_server_container_groups_per_instance, + json_extract_path_text(Properties, 'MaximumGameServerContainerGroupsPerInstance') as maximum_game_server_container_groups_per_instance, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'DeploymentDetails') as deployment_details, + json_extract_path_text(Properties, 'DeploymentConfiguration') as deployment_configuration, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'BillingType') as billing_type, + json_extract_path_text(Properties, 'Locations') as locations, + json_extract_path_text(Properties, 'ScalingPolicies') as scaling_policies, + json_extract_path_text(Properties, 'MetricGroups') as metric_groups, + json_extract_path_text(Properties, 'NewGameSessionProtectionPolicy') as new_game_session_protection_policy, + json_extract_path_text(Properties, 'GameSessionCreationLimitPolicy') as game_session_creation_limit_policy, + json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'FleetArn') as fleet_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::ContainerFleet' + AND data__Identifier = '' + AND region = 'us-east-1' + container_fleets_list_only: + name: container_fleets_list_only + id: awscc.gamelift.container_fleets_list_only + x-cfn-schema-name: ContainerFleet + x-cfn-type-name: AWS::GameLift::ContainerFleet + x-identifiers: + - FleetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::ContainerFleet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FleetId') as fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::ContainerFleet' + AND region = 'us-east-1' + container_group_definitions: + name: container_group_definitions + id: awscc.gamelift.container_group_definitions + x-cfn-schema-name: ContainerGroupDefinition + x-cfn-type-name: AWS::GameLift::ContainerGroupDefinition + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContainerGroupDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerGroupDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerGroupDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerGroupDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/container_group_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/container_group_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/container_group_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LocationName') as location_name, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn, + JSON_EXTRACT(Properties, '$.ContainerGroupDefinitionArn') as container_group_definition_arn, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.OperatingSystem') as operating_system, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ContainerGroupType') as container_group_type, + JSON_EXTRACT(Properties, '$.TotalMemoryLimitMebibytes') as total_memory_limit_mebibytes, + JSON_EXTRACT(Properties, '$.TotalVcpuLimit') as total_vcpu_limit, + JSON_EXTRACT(Properties, '$.GameServerContainerDefinition') as game_server_container_definition, + JSON_EXTRACT(Properties, '$.SupportContainerDefinitions') as support_container_definitions, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number, + JSON_EXTRACT(Properties, '$.SourceVersionNumber') as source_version_number, + JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusReason') as status_reason, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Location' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LocationName') as location_name, - json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'ContainerGroupDefinitionArn') as container_group_definition_arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'OperatingSystem') as operating_system, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ContainerGroupType') as container_group_type, + json_extract_path_text(Properties, 'TotalMemoryLimitMebibytes') as total_memory_limit_mebibytes, + json_extract_path_text(Properties, 'TotalVcpuLimit') as total_vcpu_limit, + json_extract_path_text(Properties, 'GameServerContainerDefinition') as game_server_container_definition, + json_extract_path_text(Properties, 'SupportContainerDefinitions') as support_container_definitions, + json_extract_path_text(Properties, 'VersionNumber') as version_number, + json_extract_path_text(Properties, 'SourceVersionNumber') as source_version_number, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReason') as status_reason, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Location' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' + AND data__Identifier = '' AND region = 'us-east-1' - fleets: - name: fleets - id: awscc.gamelift.fleets - x-cfn-schema-name: Fleet - x-type: list + container_group_definitions_list_only: + name: container_group_definitions_list_only + id: awscc.gamelift.container_group_definitions_list_only + x-cfn-schema-name: ContainerGroupDefinition + x-cfn-type-name: AWS::GameLift::ContainerGroupDefinition x-identifiers: - - FleetId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1616,107 +4295,165 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FleetId') as fleet_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' AND region = 'us-east-1' - fleet: - name: fleet - id: awscc.gamelift.fleet + fleets: + name: fleets + id: awscc.gamelift.fleets x-cfn-schema-name: Fleet - x-type: get + x-cfn-type-name: AWS::GameLift::Fleet x-identifiers: - FleetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.ScalingPolicies') as scaling_policies, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.PeerVpcId') as peer_vpc_id, - JSON_EXTRACT(Properties, '$.ApplyCapacity') as apply_capacity, - JSON_EXTRACT(Properties, '$.EC2InboundPermissions') as e_c2_inbound_permissions, - JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, - JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.AnywhereConfiguration') as anywhere_configuration, - JSON_EXTRACT(Properties, '$.InstanceRoleARN') as instance_role_arn, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.ApplyCapacity') as apply_capacity, JSON_EXTRACT(Properties, '$.CertificateConfiguration') as certificate_configuration, - JSON_EXTRACT(Properties, '$.InstanceRoleCredentialsProvider') as instance_role_credentials_provider, + JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DesiredEC2Instances') as desired_ec2_instances, - JSON_EXTRACT(Properties, '$.ServerLaunchParameters') as server_launch_parameters, + JSON_EXTRACT(Properties, '$.EC2InboundPermissions') as e_c2_inbound_permissions, + JSON_EXTRACT(Properties, '$.EC2InstanceType') as e_c2_instance_type, JSON_EXTRACT(Properties, '$.FleetType') as fleet_type, + JSON_EXTRACT(Properties, '$.InstanceRoleARN') as instance_role_arn, + JSON_EXTRACT(Properties, '$.InstanceRoleCredentialsProvider') as instance_role_credentials_provider, JSON_EXTRACT(Properties, '$.Locations') as locations, - JSON_EXTRACT(Properties, '$.NewGameSessionProtectionPolicy') as new_game_session_protection_policy, - JSON_EXTRACT(Properties, '$.ScriptId') as script_id, - JSON_EXTRACT(Properties, '$.MaxSize') as max_size, - JSON_EXTRACT(Properties, '$.RuntimeConfiguration') as runtime_configuration, JSON_EXTRACT(Properties, '$.LogPaths') as log_paths, - JSON_EXTRACT(Properties, '$.ServerLaunchPath') as server_launch_path, + JSON_EXTRACT(Properties, '$.MaxSize') as max_size, + JSON_EXTRACT(Properties, '$.MetricGroups') as metric_groups, JSON_EXTRACT(Properties, '$.MinSize') as min_size, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.NewGameSessionProtectionPolicy') as new_game_session_protection_policy, JSON_EXTRACT(Properties, '$.PeerVpcAwsAccountId') as peer_vpc_aws_account_id, - JSON_EXTRACT(Properties, '$.MetricGroups') as metric_groups, - JSON_EXTRACT(Properties, '$.BuildId') as build_id, + JSON_EXTRACT(Properties, '$.PeerVpcId') as peer_vpc_id, JSON_EXTRACT(Properties, '$.ResourceCreationLimitPolicy') as resource_creation_limit_policy, - JSON_EXTRACT(Properties, '$.EC2InstanceType') as e_c2_instance_type + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.BuildId') as build_id, + JSON_EXTRACT(Properties, '$.ScriptId') as script_id, + JSON_EXTRACT(Properties, '$.RuntimeConfiguration') as runtime_configuration, + JSON_EXTRACT(Properties, '$.ServerLaunchParameters') as server_launch_parameters, + JSON_EXTRACT(Properties, '$.ServerLaunchPath') as server_launch_path, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.FleetArn') as fleet_arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Fleet' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'ScalingPolicies') as scaling_policies, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, - json_extract_path_text(Properties, 'ApplyCapacity') as apply_capacity, - json_extract_path_text(Properties, 'EC2InboundPermissions') as e_c2_inbound_permissions, - json_extract_path_text(Properties, 'ComputeType') as compute_type, - json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'AnywhereConfiguration') as anywhere_configuration, - json_extract_path_text(Properties, 'InstanceRoleARN') as instance_role_arn, - json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'ApplyCapacity') as apply_capacity, json_extract_path_text(Properties, 'CertificateConfiguration') as certificate_configuration, - json_extract_path_text(Properties, 'InstanceRoleCredentialsProvider') as instance_role_credentials_provider, + json_extract_path_text(Properties, 'ComputeType') as compute_type, + json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'DesiredEC2Instances') as desired_ec2_instances, - json_extract_path_text(Properties, 'ServerLaunchParameters') as server_launch_parameters, + json_extract_path_text(Properties, 'EC2InboundPermissions') as e_c2_inbound_permissions, + json_extract_path_text(Properties, 'EC2InstanceType') as e_c2_instance_type, json_extract_path_text(Properties, 'FleetType') as fleet_type, + json_extract_path_text(Properties, 'InstanceRoleARN') as instance_role_arn, + json_extract_path_text(Properties, 'InstanceRoleCredentialsProvider') as instance_role_credentials_provider, json_extract_path_text(Properties, 'Locations') as locations, - json_extract_path_text(Properties, 'NewGameSessionProtectionPolicy') as new_game_session_protection_policy, - json_extract_path_text(Properties, 'ScriptId') as script_id, - json_extract_path_text(Properties, 'MaxSize') as max_size, - json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, json_extract_path_text(Properties, 'LogPaths') as log_paths, - json_extract_path_text(Properties, 'ServerLaunchPath') as server_launch_path, + json_extract_path_text(Properties, 'MaxSize') as max_size, + json_extract_path_text(Properties, 'MetricGroups') as metric_groups, json_extract_path_text(Properties, 'MinSize') as min_size, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NewGameSessionProtectionPolicy') as new_game_session_protection_policy, json_extract_path_text(Properties, 'PeerVpcAwsAccountId') as peer_vpc_aws_account_id, - json_extract_path_text(Properties, 'MetricGroups') as metric_groups, - json_extract_path_text(Properties, 'BuildId') as build_id, + json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, json_extract_path_text(Properties, 'ResourceCreationLimitPolicy') as resource_creation_limit_policy, - json_extract_path_text(Properties, 'EC2InstanceType') as e_c2_instance_type + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'BuildId') as build_id, + json_extract_path_text(Properties, 'ScriptId') as script_id, + json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, + json_extract_path_text(Properties, 'ServerLaunchParameters') as server_launch_parameters, + json_extract_path_text(Properties, 'ServerLaunchPath') as server_launch_path, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'FleetArn') as fleet_arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Fleet' AND data__Identifier = '' AND region = 'us-east-1' - game_server_groups: - name: game_server_groups - id: awscc.gamelift.game_server_groups - x-cfn-schema-name: GameServerGroup - x-type: list + fleets_list_only: + name: fleets_list_only + id: awscc.gamelift.fleets_list_only + x-cfn-schema-name: Fleet + x-cfn-type-name: AWS::GameLift::Fleet x-identifiers: - - GameServerGroupArn + - FleetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1724,28 +4461,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GameServerGroupArn') as game_server_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GameServerGroupArn') as game_server_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' + json_extract_path_text(Properties, 'FleetId') as fleet_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' AND region = 'us-east-1' - game_server_group: - name: game_server_group - id: awscc.gamelift.game_server_group + game_server_groups: + name: game_server_groups + id: awscc.gamelift.game_server_groups x-cfn-schema-name: GameServerGroup - x-type: get + x-cfn-type-name: AWS::GameLift::GameServerGroup x-identifiers: - GameServerGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GameServerGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::GameServerGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::GameServerGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::GameServerGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1768,7 +4553,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1790,13 +4575,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' AND data__Identifier = '' AND region = 'us-east-1' - game_session_queues: - name: game_session_queues - id: awscc.gamelift.game_session_queues - x-cfn-schema-name: GameSessionQueue - x-type: list + game_server_groups_list_only: + name: game_server_groups_list_only + id: awscc.gamelift.game_server_groups_list_only + x-cfn-schema-name: GameServerGroup + x-cfn-type-name: AWS::GameLift::GameServerGroup x-identifiers: - - Name + - GameServerGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1804,28 +4595,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' + JSON_EXTRACT(Properties, '$.GameServerGroupArn') as game_server_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' + json_extract_path_text(Properties, 'GameServerGroupArn') as game_server_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' AND region = 'us-east-1' - game_session_queue: - name: game_session_queue - id: awscc.gamelift.game_session_queue + game_session_queues: + name: game_session_queues + id: awscc.gamelift.game_session_queues x-cfn-schema-name: GameSessionQueue - x-type: get + x-cfn-type-name: AWS::GameLift::GameSessionQueue x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GameSessionQueue&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::GameSessionQueue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::GameSessionQueue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::GameSessionQueue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1844,7 +4683,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1862,13 +4701,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' AND data__Identifier = '' AND region = 'us-east-1' - matchmaking_configurations: - name: matchmaking_configurations - id: awscc.gamelift.matchmaking_configurations - x-cfn-schema-name: MatchmakingConfiguration - x-type: list + game_session_queues_list_only: + name: game_session_queues_list_only + id: awscc.gamelift.game_session_queues_list_only + x-cfn-schema-name: GameSessionQueue + x-cfn-type-name: AWS::GameLift::GameSessionQueue x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1877,7 +4722,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1885,19 +4730,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' AND region = 'us-east-1' - matchmaking_configuration: - name: matchmaking_configuration - id: awscc.gamelift.matchmaking_configuration + matchmaking_configurations: + name: matchmaking_configurations + id: awscc.gamelift.matchmaking_configurations x-cfn-schema-name: MatchmakingConfiguration - x-type: get + x-cfn-type-name: AWS::GameLift::MatchmakingConfiguration x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MatchmakingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::MatchmakingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::MatchmakingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::MatchmakingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1924,7 +4817,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1950,13 +4843,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - matchmaking_rule_sets: - name: matchmaking_rule_sets - id: awscc.gamelift.matchmaking_rule_sets - x-cfn-schema-name: MatchmakingRuleSet - x-type: list + matchmaking_configurations_list_only: + name: matchmaking_configurations_list_only + id: awscc.gamelift.matchmaking_configurations_list_only + x-cfn-schema-name: MatchmakingConfiguration + x-cfn-type-name: AWS::GameLift::MatchmakingConfiguration x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1965,7 +4864,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1973,19 +4872,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' AND region = 'us-east-1' - matchmaking_rule_set: - name: matchmaking_rule_set - id: awscc.gamelift.matchmaking_rule_set + matchmaking_rule_sets: + name: matchmaking_rule_sets + id: awscc.gamelift.matchmaking_rule_sets x-cfn-schema-name: MatchmakingRuleSet - x-type: get + x-cfn-type-name: AWS::GameLift::MatchmakingRuleSet x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MatchmakingRuleSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::MatchmakingRuleSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::MatchmakingRuleSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::MatchmakingRuleSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1999,7 +4946,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2012,13 +4959,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' AND data__Identifier = '' AND region = 'us-east-1' - scripts: - name: scripts - id: awscc.gamelift.scripts - x-cfn-schema-name: Script - x-type: list + matchmaking_rule_sets_list_only: + name: matchmaking_rule_sets_list_only + id: awscc.gamelift.matchmaking_rule_sets_list_only + x-cfn-schema-name: MatchmakingRuleSet + x-cfn-type-name: AWS::GameLift::MatchmakingRuleSet x-identifiers: - - Id + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2026,28 +4979,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' AND region = 'us-east-1' - script: - name: script - id: awscc.gamelift.script + scripts: + name: scripts + id: awscc.gamelift.scripts x-cfn-schema-name: Script - x-type: get + x-cfn-type-name: AWS::GameLift::Script x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Script&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Script" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Script" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Script" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scripts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scripts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scripts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2064,7 +5065,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2080,3 +5081,649 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Script' AND data__Identifier = '' AND region = 'us-east-1' + scripts_list_only: + name: scripts_list_only + id: awscc.gamelift.scripts_list_only + x-cfn-schema-name: Script + x-cfn-type-name: AWS::GameLift::Script + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Build&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBuild + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBuildRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Location&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLocation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLocationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContainerFleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContainerFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContainerFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContainerGroupDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContainerGroupDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContainerGroupDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GameServerGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGameServerGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGameServerGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GameSessionQueue&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGameSessionQueue + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGameSessionQueueRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MatchmakingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMatchmakingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMatchmakingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MatchmakingRuleSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMatchmakingRuleSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMatchmakingRuleSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Script&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScript + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScriptRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/globalaccelerator.yaml b/providers/src/awscc/v00.00.00000/services/globalaccelerator.yaml index 0cee0c72..bdaf22a0 100644 --- a/providers/src/awscc/v00.00.00000/services/globalaccelerator.yaml +++ b/providers/src/awscc/v00.00.00000/services/globalaccelerator.yaml @@ -1,12 +1,392 @@ openapi: 3.0.0 info: title: GlobalAccelerator - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: - description: Tag is a key-value pair associated with accelerator. + description: Tag is a key-value pair associated with Cross Account Attachment. type: object properties: Key: @@ -84,7 +464,9 @@ components: required: - Name x-stackql-resource-name: accelerator - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GlobalAccelerator::Accelerator + x-type-name: AWS::GlobalAccelerator::Accelerator + x-stackql-primary-identifier: - AcceleratorArn x-read-only-properties: - AcceleratorArn @@ -92,6 +474,14 @@ components: - Ipv4Addresses - Ipv6Addresses - DualStackDnsName + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - globalaccelerator:CreateAccelerator @@ -110,6 +500,79 @@ components: - globalaccelerator:DescribeAccelerator list: - globalaccelerator:ListAccelerators + Resource: + description: ARN of resource to share. + type: object + properties: + EndpointId: + type: string + Cidr: + type: string + Region: + type: string + additionalProperties: false + CrossAccountAttachment: + type: object + properties: + Name: + description: The Friendly identifier of the attachment. + type: string + pattern: ^[a-zA-Z0-9_-]{0,64}$ + minLength: 1 + maxLength: 64 + AttachmentArn: + description: The Amazon Resource Name (ARN) of the attachment. + type: string + Principals: + description: Principals to share the resources with. + type: array + items: + type: string + Resources: + description: Resources shared using the attachment. + type: array + items: + $ref: '#/components/schemas/Resource' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - Name + x-stackql-resource-name: cross_account_attachment + description: Resource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment + x-type-name: AWS::GlobalAccelerator::CrossAccountAttachment + x-stackql-primary-identifier: + - AttachmentArn + x-write-only-properties: + - Resources/*/Region + x-read-only-properties: + - AttachmentArn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - globalaccelerator:DescribeCrossAccountAttachment + - globalaccelerator:CreateCrossAccountAttachment + - globalaccelerator:TagResource + read: + - globalaccelerator:DescribeCrossAccountAttachment + update: + - globalaccelerator:UpdateCrossAccountAttachment + - globalaccelerator:DescribeCrossAccountAttachment + - globalaccelerator:TagResource + - globalaccelerator:UntagResource + delete: + - globalaccelerator:DescribeCrossAccountAttachment + - globalaccelerator:DeleteCrossAccountAttachment + list: + - globalaccelerator:ListCrossAccountAttachments EndpointConfiguration: description: The configuration for a given endpoint type: object @@ -207,13 +670,22 @@ components: - ListenerArn - EndpointGroupRegion x-stackql-resource-name: endpoint_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GlobalAccelerator::EndpointGroup + x-type-name: AWS::GlobalAccelerator::EndpointGroup + x-stackql-primary-identifier: - EndpointGroupArn x-create-only-properties: - EndpointGroupRegion - ListenerArn + x-write-only-properties: + - EndpointConfigurations/*/AttachmentArn x-read-only-properties: - EndpointGroupArn + x-required-properties: + - ListenerArn + - EndpointGroupRegion + x-tagging: + taggable: false x-required-permissions: create: - globalaccelerator:CreateEndpointGroup @@ -279,12 +751,20 @@ components: - PortRanges - Protocol x-stackql-resource-name: listener - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GlobalAccelerator::Listener + x-type-name: AWS::GlobalAccelerator::Listener + x-stackql-primary-identifier: - ListenerArn x-create-only-properties: - AcceleratorArn x-read-only-properties: - ListenerArn + x-required-properties: + - AcceleratorArn + - PortRanges + - Protocol + x-tagging: + taggable: false x-required-permissions: create: - globalaccelerator:CreateListener @@ -302,43 +782,289 @@ components: - globalaccelerator:DescribeAccelerator list: - globalaccelerator:ListListeners + CreateAcceleratorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of accelerator. + type: string + pattern: ^[a-zA-Z0-9_-]{0,64}$ + minLength: 1 + maxLength: 64 + IpAddressType: + description: IP Address type. + type: string + default: IPV4 + enum: + - IPV4 + - DUAL_STACK + IpAddresses: + description: The IP addresses from BYOIP Prefix pool. + default: null + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + Enabled: + description: Indicates whether an accelerator is enabled. The value is true or false. + default: true + type: boolean + DnsName: + description: The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses. + type: string + Ipv4Addresses: + description: The IPv4 addresses assigned to the accelerator. + x-insertionOrder: true + type: array + items: + type: string + Ipv6Addresses: + description: The IPv6 addresses assigned if the accelerator is dualstack + default: null + x-insertionOrder: true + type: array + items: + type: string + DualStackDnsName: + description: The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses. + type: string + AcceleratorArn: + description: The Amazon Resource Name (ARN) of the accelerator. + type: string + Tags: + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAcceleratorRequest + type: object + required: [] + CreateCrossAccountAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The Friendly identifier of the attachment. + type: string + pattern: ^[a-zA-Z0-9_-]{0,64}$ + minLength: 1 + maxLength: 64 + AttachmentArn: + description: The Amazon Resource Name (ARN) of the attachment. + type: string + Principals: + description: Principals to share the resources with. + type: array + items: + type: string + Resources: + description: Resources shared using the attachment. + type: array + items: + $ref: '#/components/schemas/Resource' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCrossAccountAttachmentRequest + type: object + required: [] + CreateEndpointGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ListenerArn: + description: The Amazon Resource Name (ARN) of the listener + type: string + EndpointGroupRegion: + description: The name of the AWS Region where the endpoint group is located + type: string + EndpointConfigurations: + description: The list of endpoint objects. + type: array + items: + $ref: '#/components/schemas/EndpointConfiguration' + TrafficDialPercentage: + description: The percentage of traffic to sent to an AWS Region + type: number + minimum: 0 + maximum: 100 + default: 100 + HealthCheckPort: + description: The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group. + type: integer + minimum: -1 + maximum: 65535 + default: -1 + HealthCheckProtocol: + description: The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group. + type: string + default: TCP + enum: + - TCP + - HTTP + - HTTPS + HealthCheckPath: + description: '' + type: string + default: / + HealthCheckIntervalSeconds: + description: The time in seconds between each health check for an endpoint. Must be a value of 10 or 30 + type: integer + default: 30 + ThresholdCount: + description: The number of consecutive health checks required to set the state of the endpoint to unhealthy. + type: integer + default: 3 + EndpointGroupArn: + description: The Amazon Resource Name (ARN) of the endpoint group + type: string + PortOverrides: + type: array + items: + $ref: '#/components/schemas/PortOverride' + x-stackQL-stringOnly: true + x-title: CreateEndpointGroupRequest + type: object + required: [] + CreateListenerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ListenerArn: + description: The Amazon Resource Name (ARN) of the listener. + type: string + AcceleratorArn: + description: The Amazon Resource Name (ARN) of the accelerator. + type: string + PortRanges: + type: array + items: + $ref: '#/components/schemas/PortRange' + Protocol: + description: The protocol for the listener. + type: string + default: TCP + enum: + - TCP + - UDP + ClientAffinity: + description: Client affinity lets you direct all requests from a user to the same endpoint. + type: string + default: NONE + enum: + - NONE + - SOURCE_IP + x-stackQL-stringOnly: true + x-title: CreateListenerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: accelerators: name: accelerators id: awscc.globalaccelerator.accelerators x-cfn-schema-name: Accelerator - x-type: list - x-identifiers: - - AcceleratorArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AcceleratorArn') as accelerator_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' - AND region = 'us-east-1' - accelerator: - name: accelerator - id: awscc.globalaccelerator.accelerator - x-cfn-schema-name: Accelerator - x-type: get + x-cfn-type-name: AWS::GlobalAccelerator::Accelerator x-identifiers: - AcceleratorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Accelerator&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::Accelerator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::Accelerator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::Accelerator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accelerators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accelerators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/accelerators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -357,7 +1083,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -375,13 +1101,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' AND data__Identifier = '' AND region = 'us-east-1' - endpoint_groups: - name: endpoint_groups - id: awscc.globalaccelerator.endpoint_groups - x-cfn-schema-name: EndpointGroup - x-type: list + accelerators_list_only: + name: accelerators_list_only + id: awscc.globalaccelerator.accelerators_list_only + x-cfn-schema-name: Accelerator + x-cfn-type-name: AWS::GlobalAccelerator::Accelerator x-identifiers: - - EndpointGroupArn + - AcceleratorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -389,28 +1121,192 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EndpointGroupArn') as endpoint_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' + JSON_EXTRACT(Properties, '$.AcceleratorArn') as accelerator_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EndpointGroupArn') as endpoint_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' + json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' + AND region = 'us-east-1' + cross_account_attachments: + name: cross_account_attachments + id: awscc.globalaccelerator.cross_account_attachments + x-cfn-schema-name: CrossAccountAttachment + x-cfn-type-name: AWS::GlobalAccelerator::CrossAccountAttachment + x-identifiers: + - AttachmentArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CrossAccountAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::CrossAccountAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::CrossAccountAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::CrossAccountAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.AttachmentArn') as attachment_arn, + JSON_EXTRACT(Properties, '$.Principals') as principals, + JSON_EXTRACT(Properties, '$.Resources') as resources, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AttachmentArn') as attachment_arn, + json_extract_path_text(Properties, 'Principals') as principals, + json_extract_path_text(Properties, 'Resources') as resources, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + cross_account_attachments_list_only: + name: cross_account_attachments_list_only + id: awscc.globalaccelerator.cross_account_attachments_list_only + x-cfn-schema-name: CrossAccountAttachment + x-cfn-type-name: AWS::GlobalAccelerator::CrossAccountAttachment + x-identifiers: + - AttachmentArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AttachmentArn') as attachment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentArn') as attachment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' AND region = 'us-east-1' - endpoint_group: - name: endpoint_group - id: awscc.globalaccelerator.endpoint_group + endpoint_groups: + name: endpoint_groups + id: awscc.globalaccelerator.endpoint_groups x-cfn-schema-name: EndpointGroup - x-type: get + x-cfn-type-name: AWS::GlobalAccelerator::EndpointGroup x-identifiers: - EndpointGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EndpointGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::EndpointGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::EndpointGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::EndpointGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -430,7 +1326,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -449,13 +1345,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' AND data__Identifier = '' AND region = 'us-east-1' - listeners: - name: listeners - id: awscc.globalaccelerator.listeners - x-cfn-schema-name: Listener - x-type: list + endpoint_groups_list_only: + name: endpoint_groups_list_only + id: awscc.globalaccelerator.endpoint_groups_list_only + x-cfn-schema-name: EndpointGroup + x-cfn-type-name: AWS::GlobalAccelerator::EndpointGroup x-identifiers: - - ListenerArn + - EndpointGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -463,28 +1365,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' + JSON_EXTRACT(Properties, '$.EndpointGroupArn') as endpoint_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' + json_extract_path_text(Properties, 'EndpointGroupArn') as endpoint_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' AND region = 'us-east-1' - listener: - name: listener - id: awscc.globalaccelerator.listener + listeners: + name: listeners + id: awscc.globalaccelerator.listeners x-cfn-schema-name: Listener - x-type: get + x-cfn-type-name: AWS::GlobalAccelerator::Listener x-identifiers: - ListenerArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Listener&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GlobalAccelerator::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/listeners/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -498,7 +1448,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -511,3 +1461,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' AND data__Identifier = '' AND region = 'us-east-1' + listeners_list_only: + name: listeners_list_only + id: awscc.globalaccelerator.listeners_list_only + x-cfn-schema-name: Listener + x-cfn-type-name: AWS::GlobalAccelerator::Listener + x-identifiers: + - ListenerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Accelerator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccelerator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAcceleratorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CrossAccountAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCrossAccountAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCrossAccountAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EndpointGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEndpointGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEndpointGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Listener&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateListener + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateListenerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/glue.yaml b/providers/src/awscc/v00.00.00000/services/glue.yaml index a2822479..03b255eb 100644 --- a/providers/src/awscc/v00.00.00000/services/glue.yaml +++ b/providers/src/awscc/v00.00.00000/services/glue.yaml @@ -1,10 +1,1073 @@ openapi: 3.0.0 info: title: Glue - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + S3Target: + type: object + description: Specifies a data store in Amazon Simple Storage Service (Amazon S3). + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC). + Path: + type: string + description: The path to the Amazon S3 target. + SampleSize: + type: integer + description: Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249. + Exclusions: + type: array + description: A list of glob patterns used to exclude from the crawl. + uniqueItems: false + items: + type: string + DlqEventQueueArn: + type: string + description: A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue. + EventQueueArn: + type: string + description: A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs. + LakeFormationConfiguration: + type: object + description: Specifies AWS Lake Formation configuration settings for the crawler + additionalProperties: false + properties: + UseLakeFormationCredentials: + type: boolean + description: Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. + AccountId: + type: string + description: Required for cross account crawls. For same account crawls as the target data, this can be left as null. + SchemaChangePolicy: + type: object + description: >- + The policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The SchemaChangePolicy does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the SchemaChangePolicy on a crawler. The SchemaChangePolicy consists of two components, UpdateBehavior and + DeleteBehavior. + additionalProperties: false + properties: + UpdateBehavior: + type: string + description: The update behavior when the crawler finds a changed schema. A value of LOG specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected. Add new tables and new partitions (including on existing tables). A value of UPDATE_IN_DATABASE specifies that if a table or partition already exists, and a change is detected, update it. Add new tables and partitions. + DeleteBehavior: + type: string + description: >- + The deletion behavior when the crawler finds a deleted object. A value of LOG specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist. A value of DELETE_FROM_DATABASE specifies that if a table or partition is found to have been removed, delete it from the database. A value of DEPRECATE_IN_DATABASE specifies that if a table has been found to no longer exist, to add a property to the table that says + 'DEPRECATED' and includes a timestamp with the time of deprecation. + IcebergTarget: + type: object + description: Specifies Apache Iceberg data store targets. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection to use to connect to the Iceberg target. + Paths: + type: array + description: One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix . + uniqueItems: false + items: + type: string + Exclusions: + type: array + description: A list of global patterns used to exclude from the crawl. + uniqueItems: false + items: + type: string + MaximumTraversalDepth: + type: integer + description: The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time. + HudiTarget: + type: object + description: Specifies Apache Hudi data store targets. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection to use to connect to the Hudi target. + Paths: + type: array + description: One or more Amazon S3 paths that contains Hudi metadata folders as s3://bucket/prefix . + uniqueItems: false + items: + type: string + Exclusions: + type: array + description: A list of global patterns used to exclude from the crawl. + uniqueItems: false + items: + type: string + MaximumTraversalDepth: + type: integer + description: The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time. + Schedule: + type: object + description: A scheduling object using a cron statement to schedule an event. + additionalProperties: false + properties: + ScheduleExpression: + type: string + description: A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *). + RecrawlPolicy: + type: object + description: When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide. + additionalProperties: false + properties: + RecrawlBehavior: + type: string + description: Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. A value of CRAWL_EVERYTHING specifies crawling the entire dataset again. A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run. A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events. + MongoDBTarget: + type: object + description: Specifies an Amazon DocumentDB or MongoDB data store to crawl. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target. + Path: + type: string + description: The path of the Amazon DocumentDB or MongoDB target (database/collection). + DeltaTarget: + type: object + description: Specifies a Delta data store to crawl one or more Delta tables. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection to use to connect to the Delta table target. + CreateNativeDeltaTable: + type: boolean + description: Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly. + WriteManifest: + type: boolean + description: Specifies whether to write the manifest files to the Delta table path. + DeltaTables: + type: array + description: '' + uniqueItems: false + items: + type: string + description: A list of the Amazon S3 paths to the Delta tables. + JdbcTarget: + type: object + description: Specifies a JDBC data store to crawl. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection to use to connect to the JDBC target. + Path: + type: string + description: The path of the JDBC target. + Exclusions: + type: array + description: A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler. + uniqueItems: false + items: + type: string + EnableAdditionalMetadata: + type: array + description: |- + Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database. + + If you do not need additional metadata, keep the field empty. + uniqueItems: false + items: + type: string + Targets: + type: object + description: Specifies data stores to crawl. + additionalProperties: false + properties: + S3Targets: + type: array + description: Specifies Amazon Simple Storage Service (Amazon S3) targets. + uniqueItems: false + items: + $ref: '#/components/schemas/S3Target' + CatalogTargets: + type: array + description: Specifies AWS Glue Data Catalog targets. + uniqueItems: false + items: + $ref: '#/components/schemas/CatalogTarget' + DeltaTargets: + type: array + description: Specifies an array of Delta data store targets. + uniqueItems: false + items: + $ref: '#/components/schemas/DeltaTarget' + MongoDBTargets: + type: array + description: A list of Mongo DB targets. + uniqueItems: false + items: + $ref: '#/components/schemas/MongoDBTarget' + JdbcTargets: + type: array + description: Specifies JDBC targets. + uniqueItems: false + items: + $ref: '#/components/schemas/JdbcTarget' + DynamoDBTargets: + type: array + description: Specifies Amazon DynamoDB targets. + uniqueItems: false + items: + $ref: '#/components/schemas/DynamoDBTarget' + IcebergTargets: + type: array + description: Specifies Apache Iceberg data store targets. + uniqueItems: false + items: + $ref: '#/components/schemas/IcebergTarget' + HudiTargets: + type: array + description: Specifies Apache Hudi data store targets. + uniqueItems: false + items: + $ref: '#/components/schemas/HudiTarget' + DynamoDBTarget: + type: object + description: Specifies an Amazon DynamoDB table to crawl. + additionalProperties: false + properties: + Path: + type: string + description: The name of the DynamoDB table to crawl. + ScanAll: + type: boolean + description: Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table. A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true. + ScanRate: + type: number + description: |- + The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second. + + The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode). + CatalogTarget: + type: object + description: Specifies an AWS Glue Data Catalog target. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type. + DatabaseName: + type: string + description: The name of the database to be synchronized. + DlqEventQueueArn: + type: string + description: A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue. + Tables: + type: array + description: A list of the tables to be synchronized. + uniqueItems: false + items: + type: string + EventQueueArn: + type: string + description: A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs. + Crawler: + type: object + properties: + Classifiers: + type: array + description: A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. + uniqueItems: false + items: + type: string + Description: + type: string + description: A description of the crawler. + SchemaChangePolicy: + $ref: '#/components/schemas/SchemaChangePolicy' + Configuration: + type: string + description: Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. + RecrawlPolicy: + $ref: '#/components/schemas/RecrawlPolicy' + DatabaseName: + type: string + description: The name of the database in which the crawler's output is stored. + Targets: + $ref: '#/components/schemas/Targets' + CrawlerSecurityConfiguration: + type: string + description: The name of the SecurityConfiguration structure to be used by this crawler. + Name: + type: string + description: The name of the crawler. + Role: + type: string + description: The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data. + LakeFormationConfiguration: + $ref: '#/components/schemas/LakeFormationConfiguration' + Schedule: + $ref: '#/components/schemas/Schedule' + TablePrefix: + type: string + description: The prefix added to the names of tables that are created. + Tags: + type: object + description: The tags to use with this crawler. + required: + - Role + - Targets + x-stackql-resource-name: crawler + description: Resource Type definition for AWS::Glue::Crawler + x-type-name: AWS::Glue::Crawler + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + x-required-properties: + - Role + - Targets + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - glue:TagResource + - glue:UntagResource + x-required-permissions: + create: + - glue:CreateCrawler + - glue:GetCrawler + - glue:TagResource + - iam:PassRole + read: + - glue:GetCrawler + - glue:GetTags + - iam:PassRole + update: + - glue:UpdateCrawler + - glue:UntagResource + - glue:TagResource + - iam:PassRole + delete: + - glue:DeleteCrawler + - glue:GetCrawler + - glue:StopCrawler + - iam:PassRole + list: + - glue:ListCrawlers + - iam:PassRole + DatabaseIdentifier: + type: object + description: A structure that describes a target database for resource linking. + additionalProperties: false + properties: + DatabaseName: + type: string + description: The name of the catalog database. + Region: + type: string + description: Region of the target database. + CatalogId: + type: string + description: The ID of the Data Catalog in which the database resides. + PrincipalPrivileges: + type: object + description: The permissions granted to a principal. + additionalProperties: false + properties: + Permissions: + type: array + description: The permissions that are granted to the principal. + uniqueItems: false + x-insertionOrder: false + items: + type: string + Principal: + $ref: '#/components/schemas/DataLakePrincipal' + description: The principal who is granted permissions. + DataLakePrincipal: + type: object + description: The AWS Lake Formation principal. + additionalProperties: false + properties: + DataLakePrincipalIdentifier: + type: string + description: An identifier for the AWS Lake Formation principal. + FederatedDatabase: + type: object + description: A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog. + additionalProperties: false + properties: + ConnectionName: + type: string + description: The name of the connection to the external metastore. + Identifier: + type: string + description: A unique identifier for the federated database. + DatabaseInput: + type: object + description: The structure used to create or update a database. + additionalProperties: false + properties: + LocationUri: + type: string + description: The location of the database (for example, an HDFS path). + CreateTableDefaultPermissions: + type: array + description: Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/PrincipalPrivileges' + description: The permissions granted to a principal. + Description: + type: string + description: A description of the database. + Parameters: + type: object + description: These key-value pairs define parameters and properties of the database. + TargetDatabase: + $ref: '#/components/schemas/DatabaseIdentifier' + description: A DatabaseIdentifier structure that describes a target database for resource linking. + FederatedDatabase: + $ref: '#/components/schemas/FederatedDatabase' + description: A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog. + Name: + type: string + description: The name of the database. For hive compatibility, this is folded to lowercase when it is stored. + Database: + type: object + properties: + CatalogId: + type: string + description: The AWS account ID for the account in which to create the catalog object. + DatabaseInput: + $ref: '#/components/schemas/DatabaseInput' + description: The metadata for the database. + DatabaseName: + type: string + description: The name of the database. For hive compatibility, this is folded to lowercase when it is store. + required: + - DatabaseInput + - CatalogId + x-stackql-resource-name: database + description: Resource Type definition for AWS::Glue::Database + x-type-name: AWS::Glue::Database + x-stackql-primary-identifier: + - DatabaseName + x-create-only-properties: + - DatabaseName + x-required-properties: + - DatabaseInput + - CatalogId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - glue:CreateDatabase + - glue:GetDatabase + - glue:PassConnection + - glue:CreateConnection + - lakeformation:ListResources + - lakeformation:DescribeResource + - lakeformation:DescribeLakeFormationIdentityCenterConfiguration + read: + - glue:GetDatabase + - glue:GetConnection + - lakeformation:ListResources + - lakeformation:DescribeResource + - lakeformation:DescribeLakeFormationIdentityCenterConfiguration + update: + - glue:UpdateDatabase + - glue:UpdateConnection + - lakeformation:ListResources + - lakeformation:DescribeResource + - lakeformation:DescribeLakeFormationIdentityCenterConfiguration + delete: + - glue:DeleteDatabase + - glue:GetDatabase + - glue:DeleteConnection + - glue:GetConnection + - lakeformation:ListResources + - lakeformation:DescribeResource + - lakeformation:DescribeLakeFormationIdentityCenterConfiguration + list: + - glue:GetDatabases + - lakeformation:ListResources + - lakeformation:DescribeResource + - lakeformation:DescribeLakeFormationIdentityCenterConfiguration + DefaultArguments: + type: object + additionalProperties: false + properties: + Key: + type: string + Value: + type: string + NonOverridableArguments: + type: object + additionalProperties: false + properties: + Key: + type: string + Value: + type: string + JobCommand: + type: object + properties: + Name: + description: The name of the job command + type: string + PythonVersion: + description: The Python version being used to execute a Python shell job. + type: string + Runtime: + description: Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment + type: string + ScriptLocation: + description: Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job + type: string + additionalProperties: false + ConnectionsList: + type: object + properties: + Connections: + description: A list of connections used by the job. + type: array + uniqueItems: false + items: + type: string + additionalProperties: false + ExecutionProperty: + type: object + properties: + MaxConcurrentRuns: + description: The maximum number of concurrent runs allowed for the job. + type: number + additionalProperties: false + NotificationProperty: + type: object + description: Specifies configuration properties of a job run notification. + additionalProperties: false + properties: + NotifyDelayAfter: + type: integer + description: After a job run starts, the number of minutes to wait before sending a job run delay notification + Job: + type: object + properties: + Connections: + $ref: '#/components/schemas/ConnectionsList' + description: Specifies the connections used by a job + MaxRetries: + type: number + description: The maximum number of times to retry this job after a JobRun fails + Description: + type: string + description: A description of the job. + Timeout: + type: integer + description: The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. + AllocatedCapacity: + type: number + description: The number of capacity units that are allocated to this job. + Name: + type: string + description: The name you assign to the job definition + Role: + type: string + description: The name or Amazon Resource Name (ARN) of the IAM role associated with this job. + DefaultArguments: + type: object + description: The default arguments for this job, specified as name-value pairs. + NotificationProperty: + $ref: '#/components/schemas/NotificationProperty' + description: Specifies configuration properties of a notification. + WorkerType: + type: string + description: TThe type of predefined worker that is allocated when a job runs. + enum: + - Standard + - G.1X + - G.2X + - G.025X + - G.4X + - G.8X + - Z.2X + - G.12X + - G.16X + - R.1X + - R.2X + - R.4X + - R.8X + ExecutionClass: + type: string + description: Indicates whether the job is run with a standard or flexible execution class. + LogUri: + type: string + description: This field is reserved for future use. + Command: + $ref: '#/components/schemas/JobCommand' + description: The code that executes a job. + GlueVersion: + type: string + description: Glue version determines the versions of Apache Spark and Python that AWS Glue supports. + ExecutionProperty: + $ref: '#/components/schemas/ExecutionProperty' + description: The maximum number of concurrent runs that are allowed for this job. + SecurityConfiguration: + type: string + description: The name of the SecurityConfiguration structure to be used with this job. + NumberOfWorkers: + type: integer + description: The number of workers of a defined workerType that are allocated when a job runs. + Tags: + type: object + description: The tags to use with this job. + MaxCapacity: + type: number + description: The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. + NonOverridableArguments: + type: object + description: Non-overridable arguments for this job, specified as name-value pairs. + MaintenanceWindow: + type: string + description: Property description not available. + JobMode: + type: string + description: Property description not available. + JobRunQueuingEnabled: + type: boolean + description: Property description not available. + required: + - Role + - Command + x-stackql-resource-name: job + description: Resource Type definition for AWS::Glue::Job + x-type-name: AWS::Glue::Job + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + x-required-properties: + - Role + - Command + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - glue:TagResource + - glue:UntagResource + x-required-permissions: + create: + - iam:GetRole + - iam:PassRole + - glue:CreateJob + - glue:GetJob + - glue:TagResource + read: + - glue:GetJob + - glue:GetTags + delete: + - glue:DeleteJob + - glue:GetJob + - glue:UntagResource + update: + - iam:GetRole + - iam:PassRole + - glue:UpdateJob + - glue:UntagResource + - glue:TagResource + list: + - glue:ListJobs Tag: type: object properties: @@ -54,13 +1117,18 @@ components: - Schema - SchemaDefinition x-stackql-resource-name: schema_version - x-stackql-primaryIdentifier: + description: This resource represents an individual schema version of a schema defined in Glue Schema Registry. + x-type-name: AWS::Glue::SchemaVersion + x-stackql-primary-identifier: - VersionId x-create-only-properties: - Schema - SchemaDefinition x-read-only-properties: - VersionId + x-required-properties: + - Schema + - SchemaDefinition x-required-permissions: create: - glue:RegisterSchemaVersion @@ -114,7 +1182,9 @@ components: - Key - Value x-stackql-resource-name: schema_version_metadata - x-stackql-primaryIdentifier: + description: This resource adds Key-Value metadata to a Schema version of Glue Schema Registry. + x-type-name: AWS::Glue::SchemaVersionMetadata + x-stackql-primary-identifier: - SchemaVersionId - Key - Value @@ -122,6 +1192,10 @@ components: - SchemaVersionId - Key - Value + x-required-properties: + - SchemaVersionId + - Key + - Value x-required-permissions: create: - glue:putSchemaVersionMetadata @@ -131,43 +1205,1061 @@ components: - glue:removeSchemaVersionMetadata list: - glue:querySchemaVersionMetadata - x-stackQL-resources: - schema_versions: - name: schema_versions - id: awscc.glue.schema_versions - x-cfn-schema-name: SchemaVersion - x-type: list - x-identifiers: - - VersionId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VersionId') as version_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' - AND region = 'us-east-1' - schema_version: - name: schema_version - id: awscc.glue.schema_version - x-cfn-schema-name: SchemaVersion - x-type: get - x-identifiers: - - VersionId - config: - views: - select: - predicate: sqlDialect == "sqlite3" + Condition: + type: object + description: Defines a condition under which a trigger fires. + additionalProperties: false + properties: + JobName: + type: string + description: The name of the job whose JobRuns this condition applies to, and on which this trigger waits. + CrawlerName: + type: string + description: The name of the crawler to which this condition applies. + State: + type: string + description: The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED. + CrawlState: + type: string + description: The state of the crawler to which this condition applies. + LogicalOperator: + type: string + description: A logical operator. + Action: + type: object + description: The actions initiated by this trigger. + additionalProperties: false + properties: + NotificationProperty: + $ref: '#/components/schemas/NotificationProperty' + description: Specifies configuration properties of a job run notification. + CrawlerName: + type: string + description: The name of the crawler to be used with this action. + Timeout: + type: integer + description: The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job. + JobName: + type: string + description: The name of a job to be executed. + Arguments: + type: object + description: The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself. + SecurityConfiguration: + type: string + description: The name of the SecurityConfiguration structure to be used with this action. + EventBatchingCondition: + type: object + description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. + additionalProperties: false + properties: + BatchSize: + type: integer + description: Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires. + BatchWindow: + type: integer + description: Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received. + required: + - BatchSize + Predicate: + type: object + description: The predicate of this trigger, which defines when it will fire. + additionalProperties: false + properties: + Logical: + type: string + description: An optional field if only one condition is listed. If multiple conditions are listed, then this field is required. + Conditions: + type: array + description: A list of the conditions that determine when the trigger will fire. + uniqueItems: false + items: + $ref: '#/components/schemas/Condition' + Trigger: + type: object + properties: + Type: + type: string + description: The type of trigger that this is. + StartOnCreation: + type: boolean + description: Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers. + Description: + type: string + description: A description of this trigger. + Actions: + type: array + description: The actions initiated by this trigger. + uniqueItems: false + items: + $ref: '#/components/schemas/Action' + EventBatchingCondition: + $ref: '#/components/schemas/EventBatchingCondition' + description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. + WorkflowName: + type: string + description: The name of the workflow associated with the trigger. + Schedule: + type: string + description: A cron expression used to specify the schedule. + Tags: + type: object + description: The tags to use with this trigger. + Name: + type: string + description: The name of the trigger. + Predicate: + $ref: '#/components/schemas/Predicate' + description: The predicate of this trigger, which defines when it will fire. + required: + - Type + - Actions + x-stackql-resource-name: trigger + description: Resource Type definition for AWS::Glue::Trigger + x-type-name: AWS::Glue::Trigger + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - WorkflowName + - Type + x-write-only-properties: + - StartOnCreation + x-required-properties: + - Type + - Actions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - glue:TagResource + - glue:UntagResource + x-required-permissions: + create: + - glue:CreateTrigger + - glue:GetTrigger + - glue:TagResource + read: + - glue:GetTrigger + - glue:GetTags + update: + - glue:UpdateTrigger + - glue:UntagResource + - glue:TagResource + delete: + - glue:DeleteTrigger + - glue:GetTrigger + list: + - glue:ListTriggers + ProfileConfiguration: + properties: + JobConfiguration: + x-patternProperties: + ^.+$: + $ref: '#/components/schemas/ConfigurationObject' + additionalProperties: false + SessionConfiguration: + x-patternProperties: + ^.+$: + $ref: '#/components/schemas/ConfigurationObject' + additionalProperties: false + anyOf: + - required: + - JobConfiguration + - required: + - SessionConfiguration + additionalProperties: false + ConfigurationObject: + properties: + DefaultValue: + type: string + AllowedValues: + type: array + items: + type: string + x-insertionOrder: false + MinValue: + type: string + MaxValue: + type: string + anyOf: + - required: + - DefaultValue + - oneOf: + - required: + - AllowedValues + - required: + - MinValue + - MaxValue + additionalProperties: false + UsageProfile: + type: object + properties: + Name: + description: The name of the UsageProfile. + type: string + maxLength: 128 + minLength: 5 + Description: + description: The description of the UsageProfile. + type: string + maxLength: 512 + minLength: 1 + pattern: '[a-zA-Z0-9\-\:\_]{1,64}' + Configuration: + description: 'UsageProfile configuration for supported service ex: (Jobs, Sessions).' + $ref: '#/components/schemas/ProfileConfiguration' + minItems: 1 + Tags: + description: The tags to be applied to this UsageProfiles. + type: array + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + x-insertionOrder: false + CreatedOn: + description: Creation time. + type: string + maxLength: 128 + minLength: 1 + required: + - Name + x-stackql-resource-name: usage_profile + description: This creates a Resource of UsageProfile type. + x-type-name: AWS::Glue::UsageProfile + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + x-read-only-properties: + - CreatedOn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - glue:TagResource + - glue:UntagResource + - glue:GetTags + x-required-permissions: + create: + - glue:CreateUsageProfile + - glue:GetUsageProfile + - glue:GetTags + - glue:TagResource + read: + - glue:GetUsageProfile + - glue:GetTags + update: + - glue:UpdateUsageProfile + - glue:GetUsageProfile + - glue:TagResource + - glue:UntagResource + - glue:GetTags + delete: + - glue:DeleteUsageProfile + - glue:GetUsageProfile + list: + - glue:ListUsageProfiles + CreateCrawlerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Classifiers: + type: array + description: A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. + uniqueItems: false + items: + type: string + Description: + type: string + description: A description of the crawler. + SchemaChangePolicy: + $ref: '#/components/schemas/SchemaChangePolicy' + Configuration: + type: string + description: Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. + RecrawlPolicy: + $ref: '#/components/schemas/RecrawlPolicy' + DatabaseName: + type: string + description: The name of the database in which the crawler's output is stored. + Targets: + $ref: '#/components/schemas/Targets' + CrawlerSecurityConfiguration: + type: string + description: The name of the SecurityConfiguration structure to be used by this crawler. + Name: + type: string + description: The name of the crawler. + Role: + type: string + description: The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data. + LakeFormationConfiguration: + $ref: '#/components/schemas/LakeFormationConfiguration' + Schedule: + $ref: '#/components/schemas/Schedule' + TablePrefix: + type: string + description: The prefix added to the names of tables that are created. + Tags: + type: object + description: The tags to use with this crawler. + x-stackQL-stringOnly: true + x-title: CreateCrawlerRequest + type: object + required: [] + CreateDatabaseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CatalogId: + type: string + description: The AWS account ID for the account in which to create the catalog object. + DatabaseInput: + $ref: '#/components/schemas/DatabaseInput' + description: The metadata for the database. + DatabaseName: + type: string + description: The name of the database. For hive compatibility, this is folded to lowercase when it is store. + x-stackQL-stringOnly: true + x-title: CreateDatabaseRequest + type: object + required: [] + CreateJobRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Connections: + $ref: '#/components/schemas/ConnectionsList' + description: Specifies the connections used by a job + MaxRetries: + type: number + description: The maximum number of times to retry this job after a JobRun fails + Description: + type: string + description: A description of the job. + Timeout: + type: integer + description: The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. + AllocatedCapacity: + type: number + description: The number of capacity units that are allocated to this job. + Name: + type: string + description: The name you assign to the job definition + Role: + type: string + description: The name or Amazon Resource Name (ARN) of the IAM role associated with this job. + DefaultArguments: + type: object + description: The default arguments for this job, specified as name-value pairs. + NotificationProperty: + $ref: '#/components/schemas/NotificationProperty' + description: Specifies configuration properties of a notification. + WorkerType: + type: string + description: TThe type of predefined worker that is allocated when a job runs. + enum: + - Standard + - G.1X + - G.2X + - G.025X + - G.4X + - G.8X + - Z.2X + - G.12X + - G.16X + - R.1X + - R.2X + - R.4X + - R.8X + ExecutionClass: + type: string + description: Indicates whether the job is run with a standard or flexible execution class. + LogUri: + type: string + description: This field is reserved for future use. + Command: + $ref: '#/components/schemas/JobCommand' + description: The code that executes a job. + GlueVersion: + type: string + description: Glue version determines the versions of Apache Spark and Python that AWS Glue supports. + ExecutionProperty: + $ref: '#/components/schemas/ExecutionProperty' + description: The maximum number of concurrent runs that are allowed for this job. + SecurityConfiguration: + type: string + description: The name of the SecurityConfiguration structure to be used with this job. + NumberOfWorkers: + type: integer + description: The number of workers of a defined workerType that are allocated when a job runs. + Tags: + type: object + description: The tags to use with this job. + MaxCapacity: + type: number + description: The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. + NonOverridableArguments: + type: object + description: Non-overridable arguments for this job, specified as name-value pairs. + MaintenanceWindow: + type: string + description: Property description not available. + JobMode: + type: string + description: Property description not available. + JobRunQueuingEnabled: + type: boolean + description: Property description not available. + x-stackQL-stringOnly: true + x-title: CreateJobRequest + type: object + required: [] + CreateSchemaVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Schema: + $ref: '#/components/schemas/Schema' + SchemaDefinition: + type: string + description: Complete definition of the schema in plain-text. + minLength: 1 + maxLength: 170000 + VersionId: + type: string + description: Represents the version ID associated with the schema version. + pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' + x-stackQL-stringOnly: true + x-title: CreateSchemaVersionRequest + type: object + required: [] + CreateSchemaVersionMetadataRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SchemaVersionId: + type: string + description: Represents the version ID associated with the schema version. + pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' + Key: + type: string + description: Metadata key + minLength: 1 + maxLength: 128 + Value: + type: string + description: Metadata value + minLength: 1 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateSchemaVersionMetadataRequest + type: object + required: [] + CreateTriggerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Type: + type: string + description: The type of trigger that this is. + StartOnCreation: + type: boolean + description: Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers. + Description: + type: string + description: A description of this trigger. + Actions: + type: array + description: The actions initiated by this trigger. + uniqueItems: false + items: + $ref: '#/components/schemas/Action' + EventBatchingCondition: + $ref: '#/components/schemas/EventBatchingCondition' + description: Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. + WorkflowName: + type: string + description: The name of the workflow associated with the trigger. + Schedule: + type: string + description: A cron expression used to specify the schedule. + Tags: + type: object + description: The tags to use with this trigger. + Name: + type: string + description: The name of the trigger. + Predicate: + $ref: '#/components/schemas/Predicate' + description: The predicate of this trigger, which defines when it will fire. + x-stackQL-stringOnly: true + x-title: CreateTriggerRequest + type: object + required: [] + CreateUsageProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the UsageProfile. + type: string + maxLength: 128 + minLength: 5 + Description: + description: The description of the UsageProfile. + type: string + maxLength: 512 + minLength: 1 + pattern: '[a-zA-Z0-9\-\:\_]{1,64}' + Configuration: + description: 'UsageProfile configuration for supported service ex: (Jobs, Sessions).' + $ref: '#/components/schemas/ProfileConfiguration' + minItems: 1 + Tags: + description: The tags to be applied to this UsageProfiles. + type: array + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + x-insertionOrder: false + CreatedOn: + description: Creation time. + type: string + maxLength: 128 + minLength: 1 + x-stackQL-stringOnly: true + x-title: CreateUsageProfileRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + crawlers: + name: crawlers + id: awscc.glue.crawlers + x-cfn-schema-name: Crawler + x-cfn-type-name: AWS::Glue::Crawler + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Crawler&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Crawler" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Crawler" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Crawler" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/crawlers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/crawlers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/crawlers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Classifiers') as classifiers, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.SchemaChangePolicy') as schema_change_policy, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.RecrawlPolicy') as recrawl_policy, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, + JSON_EXTRACT(Properties, '$.Targets') as targets, + JSON_EXTRACT(Properties, '$.CrawlerSecurityConfiguration') as crawler_security_configuration, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Role') as role, + JSON_EXTRACT(Properties, '$.LakeFormationConfiguration') as lake_formation_configuration, + JSON_EXTRACT(Properties, '$.Schedule') as schedule, + JSON_EXTRACT(Properties, '$.TablePrefix') as table_prefix, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Crawler' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Classifiers') as classifiers, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SchemaChangePolicy') as schema_change_policy, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'RecrawlPolicy') as recrawl_policy, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'CrawlerSecurityConfiguration') as crawler_security_configuration, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'LakeFormationConfiguration') as lake_formation_configuration, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'TablePrefix') as table_prefix, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Crawler' + AND data__Identifier = '' + AND region = 'us-east-1' + crawlers_list_only: + name: crawlers_list_only + id: awscc.glue.crawlers_list_only + x-cfn-schema-name: Crawler + x-cfn-type-name: AWS::Glue::Crawler + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Crawler' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Crawler' + AND region = 'us-east-1' + databases: + name: databases + id: awscc.glue.databases + x-cfn-schema-name: Database + x-cfn-type-name: AWS::Glue::Database + x-identifiers: + - DatabaseName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Database&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CatalogId') as catalog_id, + JSON_EXTRACT(Properties, '$.DatabaseInput') as database_input, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Database' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CatalogId') as catalog_id, + json_extract_path_text(Properties, 'DatabaseInput') as database_input, + json_extract_path_text(Properties, 'DatabaseName') as database_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Database' + AND data__Identifier = '' + AND region = 'us-east-1' + databases_list_only: + name: databases_list_only + id: awscc.glue.databases_list_only + x-cfn-schema-name: Database + x-cfn-type-name: AWS::Glue::Database + x-identifiers: + - DatabaseName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Database' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatabaseName') as database_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Database' + AND region = 'us-east-1' + jobs: + name: jobs + id: awscc.glue.jobs + x-cfn-schema-name: Job + x-cfn-type-name: AWS::Glue::Job + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Job&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Job" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Job" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Job" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Connections') as connections, + JSON_EXTRACT(Properties, '$.MaxRetries') as max_retries, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Timeout') as timeout, + JSON_EXTRACT(Properties, '$.AllocatedCapacity') as allocated_capacity, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Role') as role, + JSON_EXTRACT(Properties, '$.DefaultArguments') as default_arguments, + JSON_EXTRACT(Properties, '$.NotificationProperty') as notification_property, + JSON_EXTRACT(Properties, '$.WorkerType') as worker_type, + JSON_EXTRACT(Properties, '$.ExecutionClass') as execution_class, + JSON_EXTRACT(Properties, '$.LogUri') as log_uri, + JSON_EXTRACT(Properties, '$.Command') as command, + JSON_EXTRACT(Properties, '$.GlueVersion') as glue_version, + JSON_EXTRACT(Properties, '$.ExecutionProperty') as execution_property, + JSON_EXTRACT(Properties, '$.SecurityConfiguration') as security_configuration, + JSON_EXTRACT(Properties, '$.NumberOfWorkers') as number_of_workers, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.MaxCapacity') as max_capacity, + JSON_EXTRACT(Properties, '$.NonOverridableArguments') as non_overridable_arguments, + JSON_EXTRACT(Properties, '$.MaintenanceWindow') as maintenance_window, + JSON_EXTRACT(Properties, '$.JobMode') as job_mode, + JSON_EXTRACT(Properties, '$.JobRunQueuingEnabled') as job_run_queuing_enabled + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Job' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Connections') as connections, + json_extract_path_text(Properties, 'MaxRetries') as max_retries, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Timeout') as timeout, + json_extract_path_text(Properties, 'AllocatedCapacity') as allocated_capacity, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'DefaultArguments') as default_arguments, + json_extract_path_text(Properties, 'NotificationProperty') as notification_property, + json_extract_path_text(Properties, 'WorkerType') as worker_type, + json_extract_path_text(Properties, 'ExecutionClass') as execution_class, + json_extract_path_text(Properties, 'LogUri') as log_uri, + json_extract_path_text(Properties, 'Command') as command, + json_extract_path_text(Properties, 'GlueVersion') as glue_version, + json_extract_path_text(Properties, 'ExecutionProperty') as execution_property, + json_extract_path_text(Properties, 'SecurityConfiguration') as security_configuration, + json_extract_path_text(Properties, 'NumberOfWorkers') as number_of_workers, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, + json_extract_path_text(Properties, 'NonOverridableArguments') as non_overridable_arguments, + json_extract_path_text(Properties, 'MaintenanceWindow') as maintenance_window, + json_extract_path_text(Properties, 'JobMode') as job_mode, + json_extract_path_text(Properties, 'JobRunQueuingEnabled') as job_run_queuing_enabled + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Job' + AND data__Identifier = '' + AND region = 'us-east-1' + jobs_list_only: + name: jobs_list_only + id: awscc.glue.jobs_list_only + x-cfn-schema-name: Job + x-cfn-type-name: AWS::Glue::Job + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Job' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Job' + AND region = 'us-east-1' + schema_versions: + name: schema_versions + id: awscc.glue.schema_versions + x-cfn-schema-name: SchemaVersion + x-cfn-type-name: AWS::Glue::SchemaVersion + x-identifiers: + - VersionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SchemaVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::SchemaVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::SchemaVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schema_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schema_versions/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -179,7 +2271,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -190,19 +2282,85 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::SchemaVersion' AND data__Identifier = '' AND region = 'us-east-1' + schema_versions_list_only: + name: schema_versions_list_only + id: awscc.glue.schema_versions_list_only + x-cfn-schema-name: SchemaVersion + x-cfn-type-name: AWS::Glue::SchemaVersion + x-identifiers: + - VersionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VersionId') as version_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' + AND region = 'us-east-1' schema_version_metadata: name: schema_version_metadata id: awscc.glue.schema_version_metadata x-cfn-schema-name: SchemaVersionMetadata - x-type: get + x-cfn-type-name: AWS::Glue::SchemaVersionMetadata x-identifiers: - SchemaVersionId - Key - Value + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SchemaVersionMetadata&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::SchemaVersionMetadata" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::SchemaVersionMetadata" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schema_version_metadata/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schema_version_metadata/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -214,7 +2372,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -225,3 +2383,729 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' AND data__Identifier = '||' AND region = 'us-east-1' + schema_version_metadata_list_only: + name: schema_version_metadata_list_only + id: awscc.glue.schema_version_metadata_list_only + x-cfn-schema-name: SchemaVersionMetadata + x-cfn-type-name: AWS::Glue::SchemaVersionMetadata + x-identifiers: + - SchemaVersionId + - Key + - Value + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SchemaVersionId') as schema_version_id, + JSON_EXTRACT(Properties, '$.Key') as key, + JSON_EXTRACT(Properties, '$.Value') as value + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaVersionId') as schema_version_id, + json_extract_path_text(Properties, 'Key') as key, + json_extract_path_text(Properties, 'Value') as value + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' + AND region = 'us-east-1' + triggers: + name: triggers + id: awscc.glue.triggers + x-cfn-schema-name: Trigger + x-cfn-type-name: AWS::Glue::Trigger + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Trigger&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Trigger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Trigger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::Trigger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/triggers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/triggers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/triggers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.StartOnCreation') as start_on_creation, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Actions') as actions, + JSON_EXTRACT(Properties, '$.EventBatchingCondition') as event_batching_condition, + JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name, + JSON_EXTRACT(Properties, '$.Schedule') as schedule, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Predicate') as predicate + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Trigger' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'StartOnCreation') as start_on_creation, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'EventBatchingCondition') as event_batching_condition, + json_extract_path_text(Properties, 'WorkflowName') as workflow_name, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Predicate') as predicate + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::Trigger' + AND data__Identifier = '' + AND region = 'us-east-1' + triggers_list_only: + name: triggers_list_only + id: awscc.glue.triggers_list_only + x-cfn-schema-name: Trigger + x-cfn-type-name: AWS::Glue::Trigger + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Trigger' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::Trigger' + AND region = 'us-east-1' + usage_profiles: + name: usage_profiles + id: awscc.glue.usage_profiles + x-cfn-schema-name: UsageProfile + x-cfn-type-name: AWS::Glue::UsageProfile + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UsageProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::UsageProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::UsageProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::UsageProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/usage_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/usage_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/usage_profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CreatedOn') as created_on + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::UsageProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedOn') as created_on + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::UsageProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + usage_profiles_list_only: + name: usage_profiles_list_only + id: awscc.glue.usage_profiles_list_only + x-cfn-schema-name: UsageProfile + x-cfn-type-name: AWS::Glue::UsageProfile + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::UsageProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::UsageProfile' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Crawler&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCrawler + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCrawlerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Database&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDatabase + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatabaseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Job&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateJob + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateJobRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SchemaVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchemaVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSchemaVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SchemaVersionMetadata&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchemaVersionMetadata + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSchemaVersionMetadataRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Trigger&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrigger + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTriggerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UsageProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUsageProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUsageProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/grafana.yaml b/providers/src/awscc/v00.00.00000/services/grafana.yaml index 2f5b2e69..bbf60015 100644 --- a/providers/src/awscc/v00.00.00000/services/grafana.yaml +++ b/providers/src/awscc/v00.00.00000/services/grafana.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Grafana - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AssertionAttributes: type: object @@ -321,10 +701,14 @@ components: - PermissionType - AccountAccessType x-stackql-resource-name: workspace - x-stackql-primaryIdentifier: + description: Definition of AWS::Grafana::Workspace Resource Type + x-type-name: AWS::Grafana::Workspace + x-stackql-primary-identifier: - Id x-create-only-properties: - ClientToken + x-write-only-properties: + - ClientToken x-read-only-properties: - Id - SsoClientId @@ -333,6 +717,15 @@ components: - Status - CreationTimestamp - ModificationTimestamp + x-required-properties: + - AuthenticationProviders + - PermissionType + - AccountAccessType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - grafana:CreateWorkspace @@ -384,43 +777,185 @@ components: - grafana:ListWorkspaces - grafana:DescribeWorkspaceAuthentication - grafana:DescribeWorkspaceConfiguration + CreateWorkspaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AuthenticationProviders: + type: array + x-insertionOrder: false + minItems: 1 + uniqueItems: true + items: + $ref: '#/components/schemas/AuthenticationProviderTypes' + description: List of authentication providers to enable. + SsoClientId: + type: string + description: The client ID of the AWS SSO Managed Application. + SamlConfiguration: + $ref: '#/components/schemas/SamlConfiguration' + NetworkAccessControl: + $ref: '#/components/schemas/NetworkAccessControl' + VpcConfiguration: + $ref: '#/components/schemas/VpcConfiguration' + SamlConfigurationStatus: + $ref: '#/components/schemas/SamlConfigurationStatus' + ClientToken: + type: string + pattern: ^[!-~]{1,64}$ + description: A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. + Status: + $ref: '#/components/schemas/WorkspaceStatus' + CreationTimestamp: + type: string + description: Timestamp when the workspace was created. + format: date-time + ModificationTimestamp: + type: string + description: Timestamp when the workspace was last modified + format: date-time + GrafanaVersion: + type: string + maxLength: 255 + minLength: 1 + description: The version of Grafana to support in your workspace. + Endpoint: + type: string + maxLength: 2048 + minLength: 1 + description: Endpoint for the Grafana workspace. + AccountAccessType: + $ref: '#/components/schemas/AccountAccessType' + OrganizationRoleName: + type: string + maxLength: 2048 + minLength: 1 + description: The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization. + PermissionType: + $ref: '#/components/schemas/PermissionType' + StackSetName: + type: string + description: The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace. + DataSources: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DataSourceType' + description: List of data sources on the service managed IAM role. + Description: + type: string + maxLength: 2048 + minLength: 0 + description: Description of a workspace. + Id: + type: string + pattern: ^g-[0-9a-f]{10}$ + description: The id that uniquely identifies a Grafana workspace. + Name: + type: string + pattern: ^[a-zA-Z0-9-._~]{1,255}$ + description: The user friendly name of a workspace. + NotificationDestinations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/NotificationDestinationType' + description: List of notification destinations on the customers service managed IAM role that the Grafana workspace can query. + OrganizationalUnits: + type: array + x-insertionOrder: false + items: + type: string + description: Id of an organizational unit. + description: List of Organizational Units containing AWS accounts the Grafana workspace can pull data from. + RoleArn: + type: string + maxLength: 2048 + minLength: 1 + description: IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources. + PluginAdminEnabled: + type: boolean + description: Allow workspace admins to install plugins + x-stackQL-stringOnly: true + x-title: CreateWorkspaceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: workspaces: name: workspaces id: awscc.grafana.workspaces x-cfn-schema-name: Workspace - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' - AND region = 'us-east-1' - workspace: - name: workspace - id: awscc.grafana.workspace - x-cfn-schema-name: Workspace - x-type: get + x-cfn-type-name: AWS::Grafana::Workspace x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workspace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Grafana::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Grafana::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Grafana::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -453,7 +988,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -485,3 +1020,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Grafana::Workspace' AND data__Identifier = '' AND region = 'us-east-1' + workspaces_list_only: + name: workspaces_list_only + id: awscc.grafana.workspaces_list_only + x-cfn-schema-name: Workspace + x-cfn-type-name: AWS::Grafana::Workspace + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workspace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkspace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkspaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/greengrassv2.yaml b/providers/src/awscc/v00.00.00000/services/greengrassv2.yaml index 99c7c853..ba6a9d00 100644 --- a/providers/src/awscc/v00.00.00000/services/greengrassv2.yaml +++ b/providers/src/awscc/v00.00.00000/services/greengrassv2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: GreengrassV2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: LambdaFunctionRecipeSource: type: object @@ -184,15 +564,33 @@ components: maxProperties: 50 additionalProperties: false x-stackql-resource-name: component_version - x-stackql-primaryIdentifier: + description: Resource for Greengrass component version. + x-type-name: AWS::GreengrassV2::ComponentVersion + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ComponentName + - ComponentVersion x-create-only-properties: - LambdaFunction - InlineRecipe + x-write-only-properties: + - LambdaFunction + - InlineRecipe x-read-only-properties: - Arn - ComponentName - ComponentVersion + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - greengrass:TagResource + - greengrass:UntagResource + - greengrass:ListTagsForResource x-required-permissions: create: - greengrass:CreateComponentVersion @@ -438,7 +836,9 @@ components: required: - TargetArn x-stackql-resource-name: deployment - x-stackql-primaryIdentifier: + description: Resource for Greengrass V2 deployment. + x-type-name: AWS::GreengrassV2::Deployment + x-stackql-primary-identifier: - DeploymentId x-create-only-properties: - TargetArn @@ -449,6 +849,18 @@ components: - DeploymentPolicies x-read-only-properties: - DeploymentId + x-required-properties: + - TargetArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - greengrass:TagResource + - greengrass:UntagResource + - greengrass:ListTagsForResource x-required-permissions: create: - greengrass:CreateDeployment @@ -486,43 +898,156 @@ components: - iot:DescribeThing - iot:DescribeThingGroup - iot:GetThingShadow + CreateComponentVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + ComponentName: + type: string + ComponentVersion: + type: string + InlineRecipe: + type: string + LambdaFunction: + $ref: '#/components/schemas/LambdaFunctionRecipeSource' + Tags: + type: object + x-patternProperties: + ^(?!aws:)[a-zA-Z+-=._:/]{1,128}$: + type: string + maxLength: 256 + maxProperties: 50 + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateComponentVersionRequest + type: object + required: [] + CreateDeploymentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TargetArn: + type: string + pattern: arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+ + ParentTargetArn: + type: string + pattern: arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+ + DeploymentId: + type: string + pattern: .+ + DeploymentName: + type: string + minLength: 1 + maxLength: 256 + Components: + type: object + x-patternProperties: + .+: + $ref: '#/components/schemas/ComponentDeploymentSpecification' + additionalProperties: false + IotJobConfiguration: + $ref: '#/components/schemas/DeploymentIoTJobConfiguration' + DeploymentPolicies: + $ref: '#/components/schemas/DeploymentPolicies' + Tags: + type: object + x-patternProperties: + .*: + type: string + maxLength: 256 + maxProperties: 200 + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateDeploymentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: component_versions: name: component_versions id: awscc.greengrassv2.component_versions x-cfn-schema-name: ComponentVersion - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' - AND region = 'us-east-1' - component_version: - name: component_version - id: awscc.greengrassv2.component_version - x-cfn-schema-name: ComponentVersion - x-type: get + x-cfn-type-name: AWS::GreengrassV2::ComponentVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ComponentVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GreengrassV2::ComponentVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GreengrassV2::ComponentVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GreengrassV2::ComponentVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/component_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/component_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/component_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -537,7 +1062,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -551,13 +1076,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' AND data__Identifier = '' AND region = 'us-east-1' - deployments: - name: deployments - id: awscc.greengrassv2.deployments - x-cfn-schema-name: Deployment - x-type: list + component_versions_list_only: + name: component_versions_list_only + id: awscc.greengrassv2.component_versions_list_only + x-cfn-schema-name: ComponentVersion + x-cfn-type-name: AWS::GreengrassV2::ComponentVersion x-identifiers: - - DeploymentId + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -565,28 +1096,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' AND region = 'us-east-1' - deployment: - name: deployment - id: awscc.greengrassv2.deployment + deployments: + name: deployments + id: awscc.greengrassv2.deployments x-cfn-schema-name: Deployment - x-type: get + x-cfn-type-name: AWS::GreengrassV2::Deployment x-identifiers: - DeploymentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GreengrassV2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GreengrassV2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GreengrassV2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -603,7 +1182,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -619,3 +1198,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' AND data__Identifier = '' AND region = 'us-east-1' + deployments_list_only: + name: deployments_list_only + id: awscc.greengrassv2.deployments_list_only + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::GreengrassV2::Deployment + x-identifiers: + - DeploymentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ComponentVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComponentVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComponentVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeployment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/groundstation.yaml b/providers/src/awscc/v00.00.00000/services/groundstation.yaml index cea8dfdd..0020f019 100644 --- a/providers/src/awscc/v00.00.00000/services/groundstation.yaml +++ b/providers/src/awscc/v00.00.00000/services/groundstation.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: GroundStation - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: JsonString: type: string @@ -79,8 +459,10 @@ components: pattern: ^([a-zA-Z0-9_\-=/]|\{satellite_id\}|\{config\-name}|\{s3\-config-id}|\{year\}|\{month\}|\{day\}){1,900}$ BucketArn: type: string + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:s3:::[A-Za-z0-9-]{1,64}$ RoleArn: type: string + pattern: ^arn:[^:\n]+:iam::[^:\n]+:role\/.+$ UplinkSpectrumConfig: type: object properties: @@ -162,6 +544,7 @@ components: type: boolean AntennaUplinkConfigArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ additionalProperties: false S3RecordingConfig: type: object @@ -202,18 +585,34 @@ components: $ref: '#/components/schemas/ConfigData' Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Id: type: string required: - Name - ConfigData x-stackql-resource-name: config - x-stackql-primaryIdentifier: + description: AWS Ground Station config resource type for CloudFormation. + x-type-name: AWS::GroundStation::Config + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn - Id - Type + x-required-properties: + - Name + - ConfigData + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - groundstation:TagResource + - groundstation:UntagResource + - groundstation:ListTagsForResource x-required-permissions: create: - groundstation:CreateConfig @@ -336,6 +735,7 @@ components: type: string RoleArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ additionalProperties: false EndpointDetails: type: object @@ -360,6 +760,7 @@ components: type: string Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ EndpointDetails: type: array minItems: 1 @@ -378,11 +779,29 @@ components: required: - EndpointDetails x-stackql-resource-name: dataflow_endpoint_group - x-stackql-primaryIdentifier: + description: AWS Ground Station DataflowEndpointGroup schema for CloudFormation + x-type-name: AWS::GroundStation::DataflowEndpointGroup + x-stackql-primary-identifier: - Id + x-create-only-properties: + - EndpointDetails + - ContactPrePassDurationSeconds + - ContactPostPassDurationSeconds x-read-only-properties: - Id - Arn + x-required-properties: + - EndpointDetails + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - groundstation:TagResource + - groundstation:UntagResource + - groundstation:ListTagsForResource x-required-permissions: create: - groundstation:CreateDataflowEndpointGroup @@ -392,6 +811,10 @@ components: - ec2:describeAddresses - ec2:describeNetworkInterfaces - iam:createServiceLinkedRole + update: + - groundstation:ListTagsForResource + - groundstation:TagResource + - groundstation:UntagResource read: - groundstation:GetDataflowEndpointGroup - groundstation:ListTagsForResource @@ -413,13 +836,20 @@ components: properties: KmsKeyArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ KmsAliasArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + KmsAliasName: + type: string + pattern: ^alias/[a-zA-Z0-9:/_-]+$ oneOf: - required: - KmsKeyArn - required: - KmsAliasArn + - required: + - KmsAliasName additionalProperties: false MissionProfile: type: object @@ -451,6 +881,7 @@ components: $ref: '#/components/schemas/DataflowEdge' TrackingConfigArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Tags: type: array items: @@ -459,6 +890,7 @@ components: type: string Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Region: type: string required: @@ -467,13 +899,30 @@ components: - DataflowEdges - TrackingConfigArn x-stackql-resource-name: mission_profile - x-stackql-primaryIdentifier: + description: AWS Ground Station Mission Profile resource type for CloudFormation. + x-type-name: AWS::GroundStation::MissionProfile + x-stackql-primary-identifier: - Id - Arn x-read-only-properties: - Id - Arn - Region + x-required-properties: + - Name + - MinimumViableContactDurationSeconds + - DataflowEdges + - TrackingConfigArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - groundstation:TagResource + - groundstation:UntagResource + - groundstation:ListTagsForResource x-required-permissions: create: - groundstation:CreateMissionProfile @@ -501,43 +950,199 @@ components: - groundstation:GetMissionProfile list: - groundstation:ListMissionProfiles + CreateConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + pattern: ^[ a-zA-Z0-9_:-]{1,256}$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + Type: + type: string + ConfigData: + $ref: '#/components/schemas/ConfigData' + Arn: + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + Id: + type: string + x-stackQL-stringOnly: true + x-title: CreateConfigRequest + type: object + required: [] + CreateDataflowEndpointGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + EndpointDetails: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/EndpointDetails' + ContactPrePassDurationSeconds: + type: integer + description: Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state. + ContactPostPassDurationSeconds: + type: integer + description: Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state. + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDataflowEndpointGroupRequest + type: object + required: [] + CreateMissionProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: A name used to identify a mission profile. + type: string + pattern: ^[ a-zA-Z0-9_:-]{1,256}$ + ContactPrePassDurationSeconds: + description: Pre-pass time needed before the contact. + type: integer + ContactPostPassDurationSeconds: + description: Post-pass time needed after the contact. + type: integer + MinimumViableContactDurationSeconds: + description: Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts. + type: integer + StreamsKmsKey: + description: The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations. + $ref: '#/components/schemas/StreamsKmsKey' + StreamsKmsRole: + description: The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage. + type: string + DataflowEdges: + description: '' + type: array + minItems: 1 + items: + $ref: '#/components/schemas/DataflowEdge' + TrackingConfigArn: + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + Id: + type: string + Arn: + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + Region: + type: string + x-stackQL-stringOnly: true + x-title: CreateMissionProfileRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: configs: name: configs id: awscc.groundstation.configs x-cfn-schema-name: Config - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' - AND region = 'us-east-1' - config: - name: config - id: awscc.groundstation.config - x-cfn-schema-name: Config - x-type: get + x-cfn-type-name: AWS::GroundStation::Config x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Config&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::Config" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::Config" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::Config" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -552,7 +1157,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -566,13 +1171,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::Config' AND data__Identifier = '' AND region = 'us-east-1' - dataflow_endpoint_groups: - name: dataflow_endpoint_groups - id: awscc.groundstation.dataflow_endpoint_groups - x-cfn-schema-name: DataflowEndpointGroup - x-type: list + configs_list_only: + name: configs_list_only + id: awscc.groundstation.configs_list_only + x-cfn-schema-name: Config + x-cfn-type-name: AWS::GroundStation::Config x-identifiers: - - Id + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -580,28 +1191,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' AND region = 'us-east-1' - dataflow_endpoint_group: - name: dataflow_endpoint_group - id: awscc.groundstation.dataflow_endpoint_group + dataflow_endpoint_groups: + name: dataflow_endpoint_groups + id: awscc.groundstation.dataflow_endpoint_groups x-cfn-schema-name: DataflowEndpointGroup - x-type: get + x-cfn-type-name: AWS::GroundStation::DataflowEndpointGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataflowEndpointGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::DataflowEndpointGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::DataflowEndpointGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::DataflowEndpointGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dataflow_endpoint_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dataflow_endpoint_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dataflow_endpoint_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -616,7 +1275,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -630,14 +1289,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' AND data__Identifier = '' AND region = 'us-east-1' - mission_profiles: - name: mission_profiles - id: awscc.groundstation.mission_profiles - x-cfn-schema-name: MissionProfile - x-type: list + dataflow_endpoint_groups_list_only: + name: dataflow_endpoint_groups_list_only + id: awscc.groundstation.dataflow_endpoint_groups_list_only + x-cfn-schema-name: DataflowEndpointGroup + x-cfn-type-name: AWS::GroundStation::DataflowEndpointGroup x-identifiers: - Id - - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -645,31 +1309,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' AND region = 'us-east-1' - mission_profile: - name: mission_profile - id: awscc.groundstation.mission_profile + mission_profiles: + name: mission_profiles + id: awscc.groundstation.mission_profiles x-cfn-schema-name: MissionProfile - x-type: get + x-cfn-type-name: AWS::GroundStation::MissionProfile x-identifiers: - Id - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MissionProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::MissionProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::MissionProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GroundStation::MissionProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -690,7 +1400,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -710,3 +1420,316 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' AND data__Identifier = '|' AND region = 'us-east-1' + mission_profiles_list_only: + name: mission_profiles_list_only + id: awscc.groundstation.mission_profiles_list_only + x-cfn-schema-name: MissionProfile + x-cfn-type-name: AWS::GroundStation::MissionProfile + x-identifiers: + - Id + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Config&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataflowEndpointGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataflowEndpointGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataflowEndpointGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MissionProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMissionProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMissionProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/guardduty.yaml b/providers/src/awscc/v00.00.00000/services/guardduty.yaml index d3df1b8a..027ac95a 100644 --- a/providers/src/awscc/v00.00.00000/services/guardduty.yaml +++ b/providers/src/awscc/v00.00.00000/services/guardduty.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: GuardDuty - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: TagItem: type: object @@ -80,6 +460,7 @@ components: - DISABLED AdditionalConfiguration: type: array + x-insertionOrder: false items: $ref: '#/components/schemas/CFNFeatureAdditionalConfiguration' required: @@ -108,21 +489,33 @@ components: $ref: '#/components/schemas/CFNDataSourceConfigurations' Features: type: array + x-insertionOrder: false items: $ref: '#/components/schemas/CFNFeatureConfiguration' Id: type: string Tags: type: array + x-insertionOrder: false items: $ref: '#/components/schemas/TagItem' required: - Enable x-stackql-resource-name: detector - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GuardDuty::Detector + x-type-name: AWS::GuardDuty::Detector + x-stackql-primary-identifier: - Id x-read-only-properties: - Id + x-required-properties: + - Enable + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - guardduty:CreateDetector @@ -132,6 +525,7 @@ components: - iam:GetRole read: - guardduty:GetDetector + - guardduty:ListTagsForResource delete: - guardduty:ListDetectors - guardduty:DeleteDetector @@ -142,6 +536,8 @@ components: - guardduty:ListDetectors - iam:CreateServiceLinkedRole - iam:GetRole + - guardduty:TagResource + - guardduty:UntagResource list: - guardduty:ListDetectors Condition: @@ -221,17 +617,36 @@ components: maxLength: 64 Tags: type: array + x-insertionOrder: false items: $ref: '#/components/schemas/TagItem' required: + - DetectorId + - Name - FindingCriteria x-stackql-resource-name: filter - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GuardDuty::Filter + x-type-name: AWS::GuardDuty::Filter + x-stackql-primary-identifier: - DetectorId - Name x-create-only-properties: - DetectorId - Name + x-required-properties: + - DetectorId + - Name + - FindingCriteria + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource x-required-permissions: create: - guardduty:CreateFilter @@ -239,6 +654,7 @@ components: - guardduty:TagResource read: - guardduty:GetFilter + - guardduty:ListTagsForResource delete: - guardduty:ListDetectors - guardduty:ListFilters @@ -248,6 +664,8 @@ components: - guardduty:UpdateFilter - guardduty:GetFilter - guardduty:ListFilters + - guardduty:TagResource + - guardduty:UntagResource list: - guardduty:ListFilters IPSet: @@ -271,22 +689,42 @@ components: type: string minLength: 1 maxLength: 300 + ExpectedBucketOwner: + type: string Tags: type: array + x-insertionOrder: false items: $ref: '#/components/schemas/TagItem' required: - Format - Location x-stackql-resource-name: ip_set - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GuardDuty::IPSet + x-type-name: AWS::GuardDuty::IPSet + x-stackql-primary-identifier: - Id - DetectorId x-create-only-properties: - Format - DetectorId + x-write-only-properties: + - Activate x-read-only-properties: - Id + x-required-properties: + - Format + - Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource x-required-permissions: create: - guardduty:CreateIPSet @@ -307,8 +745,133 @@ components: - guardduty:GetIPSet - guardduty:ListIPSets - iam:PutRolePolicy + - guardduty:TagResource + - guardduty:UntagResource list: - guardduty:ListIPSets + CFNProtectedResource: + type: object + additionalProperties: false + properties: + S3Bucket: + type: object + description: Information about the protected S3 bucket resource. + additionalProperties: false + properties: + BucketName: + type: string + description: Name of the S3 bucket. + ObjectPrefixes: + type: array + description: Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes. + items: + type: string + required: + - S3Bucket + CFNActions: + type: object + additionalProperties: false + properties: + Tagging: + $ref: '#/components/schemas/CFNTagging' + description: Contains information about tagging status of the Malware Protection plan resource. + CFNTagging: + type: object + additionalProperties: false + properties: + Status: + type: string + description: Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object. + CFNStatusReasons: + type: object + additionalProperties: false + properties: + Code: + type: string + description: The status code of the Malware Protection plan. + Message: + type: string + description: Issue message that specifies the reason. + MalwareProtectionPlan: + type: object + properties: + MalwareProtectionPlanId: + type: string + description: A unique identifier associated with Malware Protection plan resource. + Arn: + type: string + description: Amazon Resource Name (ARN) of the protected resource. + Role: + type: string + description: IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource. + ProtectedResource: + $ref: '#/components/schemas/CFNProtectedResource' + description: Information about the protected resource. Presently, S3Bucket is the only supported protected resource. + Actions: + $ref: '#/components/schemas/CFNActions' + description: Specifies the action that is to be applied to the Malware Protection plan resource. + CreatedAt: + type: string + description: The timestamp when the Malware Protection plan resource was created. + Status: + type: string + description: Status of the Malware Protection plan resource. + StatusReasons: + type: array + items: + $ref: '#/components/schemas/CFNStatusReasons' + description: Status details associated with the Malware Protection plan resource status. + Tags: + type: array + description: The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify. + items: + $ref: '#/components/schemas/TagItem' + required: + - Role + - ProtectedResource + x-stackql-resource-name: malware_protection_plan + description: Resource Type definition for AWS::GuardDuty::MalwareProtectionPlan + x-type-name: AWS::GuardDuty::MalwareProtectionPlan + x-stackql-primary-identifier: + - MalwareProtectionPlanId + x-read-only-properties: + - MalwareProtectionPlanId + - Arn + - CreatedAt + - Status + - StatusReasons + x-required-properties: + - Role + - ProtectedResource + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource + x-required-permissions: + create: + - guardduty:CreateMalwareProtectionPlan + - guardduty:GetMalwareProtectionPlan + - guardduty:TagResource + - iam:PassRole + read: + - guardduty:GetMalwareProtectionPlan + delete: + - guardduty:DeleteMalwareProtectionPlan + - guardduty:GetMalwareProtectionPlan + update: + - guardduty:UpdateMalwareProtectionPlan + - guardduty:GetMalwareProtectionPlan + - guardduty:TagResource + - guardduty:UntagResource + - iam:PassRole + list: + - guardduty:ListMalwareProtectionPlans Master: type: object properties: @@ -325,13 +888,23 @@ components: - MasterId - DetectorId x-stackql-resource-name: master - x-stackql-primaryIdentifier: + description: GuardDuty Master resource schema + x-type-name: AWS::GuardDuty::Master + x-stackql-primary-identifier: - DetectorId - MasterId x-create-only-properties: - MasterId - InvitationId - DetectorId + x-required-properties: + - MasterId + - DetectorId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - guardduty:ListInvitations @@ -361,12 +934,24 @@ components: required: - Email x-stackql-resource-name: member - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GuardDuty::Member + x-type-name: AWS::GuardDuty::Member + x-stackql-primary-identifier: - DetectorId - MemberId x-create-only-properties: - DetectorId - MemberId + x-write-only-properties: + - DisableEmailNotification + - Message + x-required-properties: + - Email + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - guardduty:CreateMembers @@ -386,6 +971,192 @@ components: - guardduty:InviteMembers list: - guardduty:ListMembers + CFNDestinationProperties: + type: object + additionalProperties: false + properties: + DestinationArn: + type: string + description: The ARN of the resource to publish to. + KmsKeyArn: + type: string + description: The ARN of the KMS key to use for encryption. + PublishingDestination: + type: object + properties: + Id: + type: string + description: The ID of the publishing destination. + DetectorId: + type: string + description: The ID of the GuardDuty detector associated with the publishing destination. + minLength: 1 + maxLength: 300 + DestinationType: + type: string + description: The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported. + DestinationProperties: + type: object + $ref: '#/components/schemas/CFNDestinationProperties' + Status: + type: string + description: The status of the publishing destination. + PublishingFailureStartTimestamp: + type: string + description: The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination. + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagItem' + required: + - DetectorId + - DestinationType + - DestinationProperties + x-stackql-resource-name: publishing_destination + description: Resource Type definition for AWS::GuardDuty::PublishingDestination. + x-type-name: AWS::GuardDuty::PublishingDestination + x-stackql-primary-identifier: + - DetectorId + - Id + x-create-only-properties: + - DetectorId + x-read-only-properties: + - Id + - Status + - PublishingFailureStartTimestamp + x-required-properties: + - DetectorId + - DestinationType + - DestinationProperties + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource + x-required-permissions: + create: + - guardduty:CreatePublishingDestination + - guardduty:TagResource + - guardduty:DescribePublishingDestination + - guardduty:ListTagsForResource + read: + - guardduty:DescribePublishingDestination + - guardduty:ListTagsForResource + update: + - guardduty:UpdatePublishingDestination + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource + - guardduty:DescribePublishingDestination + delete: + - guardduty:DeletePublishingDestination + - guardduty:DescribePublishingDestination + list: + - guardduty:ListPublishingDestinations + ThreatEntitySet: + type: object + properties: + Id: + type: string + Format: + type: string + minLength: 1 + maxLength: 300 + Activate: + type: boolean + Status: + type: string + enum: + - INACTIVE + - ACTIVATING + - ACTIVE + - DEACTIVATING + - ERROR + - DELETE_PENDING + - DELETED + CreatedAt: + type: string + UpdatedAt: + type: string + ErrorDetails: + type: string + DetectorId: + type: string + minLength: 1 + maxLength: 32 + Name: + type: string + Location: + type: string + minLength: 1 + maxLength: 300 + ExpectedBucketOwner: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/TagItem' + required: + - Format + - Location + x-stackql-resource-name: threat_entity_set + description: Resource Type definition for AWS::GuardDuty::ThreatEntitySet + x-type-name: AWS::GuardDuty::ThreatEntitySet + x-stackql-primary-identifier: + - Id + - DetectorId + x-create-only-properties: + - Format + - DetectorId + x-write-only-properties: + - Activate + x-read-only-properties: + - Id + - Status + - CreatedAt + - UpdatedAt + - ErrorDetails + x-required-properties: + - Format + - Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource + x-required-permissions: + create: + - guardduty:CreateThreatEntitySet + - guardduty:GetThreatEntitySet + - guardduty:TagResource + - s3:GetObject + read: + - guardduty:GetThreatEntitySet + delete: + - guardduty:ListDetectors + - guardduty:ListThreatEntitySets + - guardduty:DeleteThreatEntitySet + - guardduty:GetThreatEntitySet + update: + - guardduty:UpdateThreatEntitySet + - guardduty:GetThreatEntitySet + - guardduty:ListThreatEntitySets + - guardduty:TagResource + - guardduty:UntagResource + - s3:GetObject + list: + - guardduty:ListThreatEntitySets ThreatIntelSet: type: object properties: @@ -407,6 +1178,8 @@ components: type: string minLength: 1 maxLength: 300 + ExpectedBucketOwner: + type: string Tags: type: array items: @@ -415,14 +1188,31 @@ components: - Format - Location x-stackql-resource-name: threat_intel_set - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::GuardDuty::ThreatIntelSet + x-type-name: AWS::GuardDuty::ThreatIntelSet + x-stackql-primary-identifier: - Id - DetectorId x-create-only-properties: - Format - DetectorId + x-write-only-properties: + - Activate x-read-only-properties: - Id + x-required-properties: + - Format + - Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource x-required-permissions: create: - guardduty:CreateThreatIntelSet @@ -442,51 +1232,598 @@ components: - guardduty:GetThreatIntelSet - guardduty:ListThreatIntelSets - iam:PutRolePolicy + - guardduty:TagResource + - guardduty:UntagResource list: - guardduty:ListThreatIntelSets - x-stackQL-resources: - detectors: - name: detectors - id: awscc.guardduty.detectors - x-cfn-schema-name: Detector - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' - AND region = 'us-east-1' - detector: - name: detector - id: awscc.guardduty.detector - x-cfn-schema-name: Detector - x-type: get - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.FindingPublishingFrequency') as finding_publishing_frequency, - JSON_EXTRACT(Properties, '$.Enable') as enable, + TrustedEntitySet: + type: object + properties: + Id: + type: string + Format: + type: string + minLength: 1 + maxLength: 300 + Activate: + type: boolean + Status: + type: string + enum: + - INACTIVE + - ACTIVATING + - ACTIVE + - DEACTIVATING + - ERROR + - DELETE_PENDING + - DELETED + CreatedAt: + type: string + UpdatedAt: + type: string + ErrorDetails: + type: string + DetectorId: + type: string + minLength: 1 + maxLength: 32 + Name: + type: string + Location: + type: string + minLength: 1 + maxLength: 300 + ExpectedBucketOwner: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/TagItem' + required: + - Format + - Location + x-stackql-resource-name: trusted_entity_set + description: Resource Type definition for AWS::GuardDuty::TrustedEntitySet + x-type-name: AWS::GuardDuty::TrustedEntitySet + x-stackql-primary-identifier: + - Id + - DetectorId + x-create-only-properties: + - Format + - DetectorId + x-write-only-properties: + - Activate + x-read-only-properties: + - Id + - Status + - CreatedAt + - UpdatedAt + - ErrorDetails + x-required-properties: + - Format + - Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - guardduty:TagResource + - guardduty:UntagResource + - guardduty:ListTagsForResource + x-required-permissions: + create: + - guardduty:CreateTrustedEntitySet + - guardduty:GetTrustedEntitySet + - guardduty:TagResource + - s3:GetObject + read: + - guardduty:GetTrustedEntitySet + delete: + - guardduty:ListDetectors + - guardduty:ListTrustedEntitySets + - guardduty:DeleteTrustedEntitySet + - guardduty:GetTrustedEntitySet + update: + - guardduty:UpdateTrustedEntitySet + - guardduty:GetTrustedEntitySet + - guardduty:ListTrustedEntitySets + - guardduty:TagResource + - guardduty:UntagResource + - s3:GetObject + list: + - guardduty:ListTrustedEntitySets + CreateDetectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FindingPublishingFrequency: + type: string + Enable: + type: boolean + DataSources: + $ref: '#/components/schemas/CFNDataSourceConfigurations' + Features: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CFNFeatureConfiguration' + Id: + type: string + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateDetectorRequest + type: object + required: [] + CreateFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Action: + type: string + Description: + type: string + DetectorId: + type: string + minLength: 1 + maxLength: 300 + FindingCriteria: + $ref: '#/components/schemas/FindingCriteria' + Rank: + type: integer + minimum: 1 + maximum: 100 + Name: + type: string + minLength: 1 + maxLength: 64 + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateFilterRequest + type: object + required: [] + CreateIPSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Format: + type: string + Activate: + type: boolean + DetectorId: + type: string + minLength: 1 + maxLength: 300 + Name: + type: string + minLength: 1 + maxLength: 300 + Location: + type: string + minLength: 1 + maxLength: 300 + ExpectedBucketOwner: + type: string + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateIPSetRequest + type: object + required: [] + CreateMalwareProtectionPlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MalwareProtectionPlanId: + type: string + description: A unique identifier associated with Malware Protection plan resource. + Arn: + type: string + description: Amazon Resource Name (ARN) of the protected resource. + Role: + type: string + description: IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource. + ProtectedResource: + $ref: '#/components/schemas/CFNProtectedResource' + description: Information about the protected resource. Presently, S3Bucket is the only supported protected resource. + Actions: + $ref: '#/components/schemas/CFNActions' + description: Specifies the action that is to be applied to the Malware Protection plan resource. + CreatedAt: + type: string + description: The timestamp when the Malware Protection plan resource was created. + Status: + type: string + description: Status of the Malware Protection plan resource. + StatusReasons: + type: array + items: + $ref: '#/components/schemas/CFNStatusReasons' + description: Status details associated with the Malware Protection plan resource status. + Tags: + type: array + description: The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify. + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateMalwareProtectionPlanRequest + type: object + required: [] + CreateMasterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MasterId: + description: ID of the account used as the master account. + type: string + InvitationId: + description: Value used to validate the master account to the member account. + type: string + DetectorId: + description: Unique ID of the detector of the GuardDuty member account. + type: string + x-stackQL-stringOnly: true + x-title: CreateMasterRequest + type: object + required: [] + CreateMemberRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + type: string + MemberId: + type: string + Email: + type: string + Message: + type: string + DisableEmailNotification: + type: boolean + DetectorId: + type: string + x-stackQL-stringOnly: true + x-title: CreateMemberRequest + type: object + required: [] + CreatePublishingDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: The ID of the publishing destination. + DetectorId: + type: string + description: The ID of the GuardDuty detector associated with the publishing destination. + minLength: 1 + maxLength: 300 + DestinationType: + type: string + description: The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported. + DestinationProperties: + type: object + $ref: '#/components/schemas/CFNDestinationProperties' + Status: + type: string + description: The status of the publishing destination. + PublishingFailureStartTimestamp: + type: string + description: The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination. + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreatePublishingDestinationRequest + type: object + required: [] + CreateThreatEntitySetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Format: + type: string + minLength: 1 + maxLength: 300 + Activate: + type: boolean + Status: + type: string + enum: + - INACTIVE + - ACTIVATING + - ACTIVE + - DEACTIVATING + - ERROR + - DELETE_PENDING + - DELETED + CreatedAt: + type: string + UpdatedAt: + type: string + ErrorDetails: + type: string + DetectorId: + type: string + minLength: 1 + maxLength: 32 + Name: + type: string + Location: + type: string + minLength: 1 + maxLength: 300 + ExpectedBucketOwner: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateThreatEntitySetRequest + type: object + required: [] + CreateThreatIntelSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Format: + type: string + minLength: 1 + maxLength: 300 + Activate: + type: boolean + DetectorId: + type: string + minLength: 1 + maxLength: 32 + Name: + type: string + Location: + type: string + minLength: 1 + maxLength: 300 + ExpectedBucketOwner: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateThreatIntelSetRequest + type: object + required: [] + CreateTrustedEntitySetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Format: + type: string + minLength: 1 + maxLength: 300 + Activate: + type: boolean + Status: + type: string + enum: + - INACTIVE + - ACTIVATING + - ACTIVE + - DEACTIVATING + - ERROR + - DELETE_PENDING + - DELETED + CreatedAt: + type: string + UpdatedAt: + type: string + ErrorDetails: + type: string + DetectorId: + type: string + minLength: 1 + maxLength: 32 + Name: + type: string + Location: + type: string + minLength: 1 + maxLength: 300 + ExpectedBucketOwner: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/TagItem' + x-stackQL-stringOnly: true + x-title: CreateTrustedEntitySetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + detectors: + name: detectors + id: awscc.guardduty.detectors + x-cfn-schema-name: Detector + x-cfn-type-name: AWS::GuardDuty::Detector + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Detector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Detector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Detector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Detector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/detectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/detectors/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FindingPublishingFrequency') as finding_publishing_frequency, + JSON_EXTRACT(Properties, '$.Enable') as enable, JSON_EXTRACT(Properties, '$.DataSources') as data_sources, JSON_EXTRACT(Properties, '$.Features') as features, JSON_EXTRACT(Properties, '$.Id') as id, @@ -495,7 +1832,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -509,14 +1846,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Detector' AND data__Identifier = '' AND region = 'us-east-1' - filters: - name: filters - id: awscc.guardduty.filters - x-cfn-schema-name: Filter - x-type: list + detectors_list_only: + name: detectors_list_only + id: awscc.guardduty.detectors_list_only + x-cfn-schema-name: Detector + x-cfn-type-name: AWS::GuardDuty::Detector x-identifiers: - - DetectorId - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -524,31 +1866,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' AND region = 'us-east-1' - filter: - name: filter - id: awscc.guardduty.filter + filters: + name: filters + id: awscc.guardduty.filters x-cfn-schema-name: Filter - x-type: get + x-cfn-type-name: AWS::GuardDuty::Filter x-identifiers: - DetectorId - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Filter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Filter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Filter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Filter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/filters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -564,7 +1952,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -579,14 +1967,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Filter' AND data__Identifier = '|' AND region = 'us-east-1' - ip_sets: - name: ip_sets - id: awscc.guardduty.ip_sets - x-cfn-schema-name: IPSet - x-type: list + filters_list_only: + name: filters_list_only + id: awscc.guardduty.filters_list_only + x-cfn-schema-name: Filter + x-cfn-type-name: AWS::GuardDuty::Filter x-identifiers: - - Id - DetectorId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -594,31 +1988,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DetectorId') as detector_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' AND region = 'us-east-1' - ip_set: - name: ip_set - id: awscc.guardduty.ip_set + ip_sets: + name: ip_sets + id: awscc.guardduty.ip_sets x-cfn-schema-name: IPSet - x-type: get + x-cfn-type-name: AWS::GuardDuty::IPSet x-identifiers: - Id - DetectorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::IPSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::IPSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::IPSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -629,12 +2071,13 @@ components: JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.ExpectedBucketOwner') as expected_bucket_owner, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::IPSet' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -645,18 +2088,25 @@ components: json_extract_path_text(Properties, 'DetectorId') as detector_id, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'ExpectedBucketOwner') as expected_bucket_owner, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::IPSet' AND data__Identifier = '|' AND region = 'us-east-1' - masters: - name: masters - id: awscc.guardduty.masters - x-cfn-schema-name: Master - x-type: list + ip_sets_list_only: + name: ip_sets_list_only + id: awscc.guardduty.ip_sets_list_only + x-cfn-schema-name: IPSet + x-cfn-type-name: AWS::GuardDuty::IPSet x-identifiers: + - Id - DetectorId - - MasterId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -664,31 +2114,190 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, - JSON_EXTRACT(Properties, '$.MasterId') as master_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'MasterId') as master_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' + AND region = 'us-east-1' + malware_protection_plans: + name: malware_protection_plans + id: awscc.guardduty.malware_protection_plans + x-cfn-schema-name: MalwareProtectionPlan + x-cfn-type-name: AWS::GuardDuty::MalwareProtectionPlan + x-identifiers: + - MalwareProtectionPlanId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MalwareProtectionPlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::MalwareProtectionPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::MalwareProtectionPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::MalwareProtectionPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/malware_protection_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/malware_protection_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/malware_protection_plans/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.MalwareProtectionPlanId') as malware_protection_plan_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Role') as role, + JSON_EXTRACT(Properties, '$.ProtectedResource') as protected_resource, + JSON_EXTRACT(Properties, '$.Actions') as actions, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusReasons') as status_reasons, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::MalwareProtectionPlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MalwareProtectionPlanId') as malware_protection_plan_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'ProtectedResource') as protected_resource, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReasons') as status_reasons, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::MalwareProtectionPlan' + AND data__Identifier = '' AND region = 'us-east-1' - master: - name: master - id: awscc.guardduty.master + malware_protection_plans_list_only: + name: malware_protection_plans_list_only + id: awscc.guardduty.malware_protection_plans_list_only + x-cfn-schema-name: MalwareProtectionPlan + x-cfn-type-name: AWS::GuardDuty::MalwareProtectionPlan + x-identifiers: + - MalwareProtectionPlanId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.MalwareProtectionPlanId') as malware_protection_plan_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::MalwareProtectionPlan' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MalwareProtectionPlanId') as malware_protection_plan_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::MalwareProtectionPlan' + AND region = 'us-east-1' + masters: + name: masters + id: awscc.guardduty.masters x-cfn-schema-name: Master - x-type: get + x-cfn-type-name: AWS::GuardDuty::Master x-identifiers: - DetectorId - MasterId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Master&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Master" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Master" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/masters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/masters/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -700,7 +2309,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -711,14 +2320,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Master' AND data__Identifier = '|' AND region = 'us-east-1' - members: - name: members - id: awscc.guardduty.members - x-cfn-schema-name: Member - x-type: list + masters_list_only: + name: masters_list_only + id: awscc.guardduty.masters_list_only + x-cfn-schema-name: Master + x-cfn-type-name: AWS::GuardDuty::Master x-identifiers: - DetectorId - - MemberId + - MasterId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -727,8 +2342,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, - JSON_EXTRACT(Properties, '$.MemberId') as member_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' + JSON_EXTRACT(Properties, '$.MasterId') as master_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -736,21 +2351,69 @@ components: SELECT region, json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'MemberId') as member_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' + json_extract_path_text(Properties, 'MasterId') as master_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' AND region = 'us-east-1' - member: - name: member - id: awscc.guardduty.member + members: + name: members + id: awscc.guardduty.members x-cfn-schema-name: Member - x-type: get + x-cfn-type-name: AWS::GuardDuty::Member x-identifiers: - DetectorId - MemberId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Member&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Member" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Member" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::Member" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/members/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/members/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -765,7 +2428,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -779,14 +2442,404 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Member' AND data__Identifier = '|' AND region = 'us-east-1' + members_list_only: + name: members_list_only + id: awscc.guardduty.members_list_only + x-cfn-schema-name: Member + x-cfn-type-name: AWS::GuardDuty::Member + x-identifiers: + - DetectorId + - MemberId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.MemberId') as member_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'MemberId') as member_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' + AND region = 'us-east-1' + publishing_destinations: + name: publishing_destinations + id: awscc.guardduty.publishing_destinations + x-cfn-schema-name: PublishingDestination + x-cfn-type-name: AWS::GuardDuty::PublishingDestination + x-identifiers: + - DetectorId + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PublishingDestination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::PublishingDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::PublishingDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::PublishingDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/publishing_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/publishing_destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/publishing_destinations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.DestinationType') as destination_type, + JSON_EXTRACT(Properties, '$.DestinationProperties') as destination_properties, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.PublishingFailureStartTimestamp') as publishing_failure_start_timestamp, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::PublishingDestination' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'DestinationType') as destination_type, + json_extract_path_text(Properties, 'DestinationProperties') as destination_properties, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'PublishingFailureStartTimestamp') as publishing_failure_start_timestamp, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::PublishingDestination' + AND data__Identifier = '|' + AND region = 'us-east-1' + publishing_destinations_list_only: + name: publishing_destinations_list_only + id: awscc.guardduty.publishing_destinations_list_only + x-cfn-schema-name: PublishingDestination + x-cfn-type-name: AWS::GuardDuty::PublishingDestination + x-identifiers: + - DetectorId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::PublishingDestination' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::PublishingDestination' + AND region = 'us-east-1' + threat_entity_sets: + name: threat_entity_sets + id: awscc.guardduty.threat_entity_sets + x-cfn-schema-name: ThreatEntitySet + x-cfn-type-name: AWS::GuardDuty::ThreatEntitySet + x-identifiers: + - Id + - DetectorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ThreatEntitySet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::ThreatEntitySet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::ThreatEntitySet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::ThreatEntitySet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/threat_entity_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/threat_entity_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/threat_entity_sets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Format') as _format, + JSON_EXTRACT(Properties, '$.Activate') as activate, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.ErrorDetails') as error_details, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.ExpectedBucketOwner') as expected_bucket_owner, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatEntitySet' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Format') as _format, + json_extract_path_text(Properties, 'Activate') as activate, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'ErrorDetails') as error_details, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'ExpectedBucketOwner') as expected_bucket_owner, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatEntitySet' + AND data__Identifier = '|' + AND region = 'us-east-1' + threat_entity_sets_list_only: + name: threat_entity_sets_list_only + id: awscc.guardduty.threat_entity_sets_list_only + x-cfn-schema-name: ThreatEntitySet + x-cfn-type-name: AWS::GuardDuty::ThreatEntitySet + x-identifiers: + - Id + - DetectorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatEntitySet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatEntitySet' + AND region = 'us-east-1' threat_intel_sets: name: threat_intel_sets id: awscc.guardduty.threat_intel_sets x-cfn-schema-name: ThreatIntelSet - x-type: list + x-cfn-type-name: AWS::GuardDuty::ThreatIntelSet x-identifiers: - Id - DetectorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ThreatIntelSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::ThreatIntelSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::ThreatIntelSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::ThreatIntelSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Format') as _format, + JSON_EXTRACT(Properties, '$.Activate') as activate, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.ExpectedBucketOwner') as expected_bucket_owner, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Format') as _format, + json_extract_path_text(Properties, 'Activate') as activate, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'ExpectedBucketOwner') as expected_bucket_owner, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' + AND data__Identifier = '|' + AND region = 'us-east-1' + threat_intel_sets_list_only: + name: threat_intel_sets_list_only + id: awscc.guardduty.threat_intel_sets_list_only + x-cfn-schema-name: ThreatIntelSet + x-cfn-type-name: AWS::GuardDuty::ThreatIntelSet + x-identifiers: + - Id + - DetectorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -807,18 +2860,66 @@ components: json_extract_path_text(Properties, 'DetectorId') as detector_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' AND region = 'us-east-1' - threat_intel_set: - name: threat_intel_set - id: awscc.guardduty.threat_intel_set - x-cfn-schema-name: ThreatIntelSet - x-type: get + trusted_entity_sets: + name: trusted_entity_sets + id: awscc.guardduty.trusted_entity_sets + x-cfn-schema-name: TrustedEntitySet + x-cfn-type-name: AWS::GuardDuty::TrustedEntitySet x-identifiers: - Id - DetectorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrustedEntitySet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::TrustedEntitySet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::TrustedEntitySet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GuardDuty::TrustedEntitySet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trusted_entity_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trusted_entity_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/trusted_entity_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -826,15 +2927,20 @@ components: JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.Format') as _format, JSON_EXTRACT(Properties, '$.Activate') as activate, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.ErrorDetails') as error_details, JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.ExpectedBucketOwner') as expected_bucket_owner, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::TrustedEntitySet' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -842,10 +2948,622 @@ components: json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'Format') as _format, json_extract_path_text(Properties, 'Activate') as activate, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'ErrorDetails') as error_details, json_extract_path_text(Properties, 'DetectorId') as detector_id, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'ExpectedBucketOwner') as expected_bucket_owner, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::TrustedEntitySet' AND data__Identifier = '|' AND region = 'us-east-1' + trusted_entity_sets_list_only: + name: trusted_entity_sets_list_only + id: awscc.guardduty.trusted_entity_sets_list_only + x-cfn-schema-name: TrustedEntitySet + x-cfn-type-name: AWS::GuardDuty::TrustedEntitySet + x-identifiers: + - Id + - DetectorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::TrustedEntitySet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::TrustedEntitySet' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Detector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDetector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDetectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Filter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MalwareProtectionPlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMalwareProtectionPlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMalwareProtectionPlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Master&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMaster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMasterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Member&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMember + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMemberRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PublishingDestination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePublishingDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePublishingDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ThreatEntitySet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateThreatEntitySet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThreatEntitySetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ThreatIntelSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateThreatIntelSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThreatIntelSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrustedEntitySet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrustedEntitySet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrustedEntitySetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/healthimaging.yaml b/providers/src/awscc/v00.00.00000/services/healthimaging.yaml index c54e1ea6..421ac31d 100644 --- a/providers/src/awscc/v00.00.00000/services/healthimaging.yaml +++ b/providers/src/awscc/v00.00.00000/services/healthimaging.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: HealthImaging - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DatastoreArn: type: string @@ -75,7 +455,9 @@ components: $ref: '#/components/schemas/Tags' required: [] x-stackql-resource-name: datastore - x-stackql-primaryIdentifier: + description: Definition of AWS::HealthImaging::Datastore Resource Type + x-type-name: AWS::HealthImaging::Datastore + x-stackql-primary-identifier: - DatastoreId x-create-only-properties: - DatastoreName @@ -87,6 +469,17 @@ components: - UpdatedAt - DatastoreId - DatastoreStatus + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medical-imaging:TagResource + - medical-imaging:UntagResource + - medical-imaging:ListTagsForResource x-required-permissions: create: - medical-imaging:CreateDatastore @@ -113,43 +506,93 @@ components: - kms:Decrypt list: - medical-imaging:ListDatastores + CreateDatastoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatastoreArn: + $ref: '#/components/schemas/DatastoreArn' + DatastoreName: + $ref: '#/components/schemas/DatastoreName' + DatastoreId: + $ref: '#/components/schemas/DatastoreId' + DatastoreStatus: + $ref: '#/components/schemas/DatastoreStatus' + KmsKeyArn: + $ref: '#/components/schemas/KmsKeyArn' + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + UpdatedAt: + $ref: '#/components/schemas/UpdatedAt' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateDatastoreRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: datastores: name: datastores id: awscc.healthimaging.datastores x-cfn-schema-name: Datastore - x-type: list - x-identifiers: - - DatastoreId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatastoreId') as datastore_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' - AND region = 'us-east-1' - datastore: - name: datastore - id: awscc.healthimaging.datastore - x-cfn-schema-name: Datastore - x-type: get + x-cfn-type-name: AWS::HealthImaging::Datastore x-identifiers: - DatastoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Datastore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::HealthImaging::Datastore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::HealthImaging::Datastore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datastores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datastores/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -166,7 +609,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -182,3 +625,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::HealthImaging::Datastore' AND data__Identifier = '' AND region = 'us-east-1' + datastores_list_only: + name: datastores_list_only + id: awscc.healthimaging.datastores_list_only + x-cfn-schema-name: Datastore + x-cfn-type-name: AWS::HealthImaging::Datastore + x-identifiers: + - DatastoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatastoreId') as datastore_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Datastore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDatastore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatastoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/healthlake.yaml b/providers/src/awscc/v00.00.00000/services/healthlake.yaml index c8a1df5e..21550d37 100644 --- a/providers/src/awscc/v00.00.00000/services/healthlake.yaml +++ b/providers/src/awscc/v00.00.00000/services/healthlake.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: HealthLake - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: CreatedAt: description: The time that a Data Store was created. @@ -70,6 +450,9 @@ components: $ref: '#/components/schemas/KmsEncryptionConfig' required: - KmsEncryptionConfig + default: + KmsEncryptionConfig: + CmkType: AWS_OWNED_KMS_KEY additionalProperties: false KmsEncryptionConfig: description: The customer-managed-key (CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption. @@ -100,6 +483,7 @@ components: enum: - SMART_ON_FHIR_V1 - AWS_AUTH + - SMART_ON_FHIR FineGrainedAuthorizationEnabled: description: Flag to indicate if fine-grained authorization will be enabled for the datastore type: boolean @@ -114,6 +498,9 @@ components: pattern: arn:aws[-a-z]*:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9\-_\.]+(:(\$LATEST|[a-zA-Z0-9\-_]+))? required: - AuthorizationStrategy + default: + AuthorizationStrategy: AWS_AUTH + FineGrainedAuthorizationEnabled: false additionalProperties: false Tag: description: A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. @@ -164,14 +551,16 @@ components: required: - DatastoreTypeVersion x-stackql-resource-name: fhir_datastore - x-stackql-primaryIdentifier: + description: HealthLake FHIR Datastore + x-type-name: AWS::HealthLake::FHIRDatastore + x-documentation-url: https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html + x-stackql-primary-identifier: - DatastoreId x-create-only-properties: - DatastoreName - DatastoreTypeVersion - PreloadDataConfig - SseConfiguration - - KmsEncryptionConfig - IdentityProviderConfiguration x-read-only-properties: - CreatedAt @@ -179,6 +568,18 @@ components: - DatastoreEndpoint - DatastoreId - DatastoreStatus + x-required-properties: + - DatastoreTypeVersion + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - healthlake:UntagResource + - healthlake:TagResource + - healthlake:ListTagsForResource x-required-permissions: create: - healthlake:CreateFHIRDatastore @@ -221,43 +622,115 @@ components: - glue:DeleteDatabase list: - healthlake:ListFHIRDatastores + CreateFHIRDatastoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + $ref: '#/components/schemas/CreatedAt' + DatastoreArn: + $ref: '#/components/schemas/DatastoreArn' + DatastoreEndpoint: + $ref: '#/components/schemas/DatastoreEndpoint' + DatastoreId: + $ref: '#/components/schemas/DatastoreId' + DatastoreName: + $ref: '#/components/schemas/DatastoreName' + DatastoreStatus: + $ref: '#/components/schemas/DatastoreStatus' + DatastoreTypeVersion: + $ref: '#/components/schemas/DatastoreTypeVersion' + PreloadDataConfig: + $ref: '#/components/schemas/PreloadDataConfig' + SseConfiguration: + $ref: '#/components/schemas/SseConfiguration' + IdentityProviderConfiguration: + $ref: '#/components/schemas/IdentityProviderConfiguration' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFHIRDatastoreRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: fhir_datastores: name: fhir_datastores id: awscc.healthlake.fhir_datastores x-cfn-schema-name: FHIRDatastore - x-type: list - x-identifiers: - - DatastoreId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatastoreId') as datastore_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' - AND region = 'us-east-1' - fhir_datastore: - name: fhir_datastore - id: awscc.healthlake.fhir_datastore - x-cfn-schema-name: FHIRDatastore - x-type: get + x-cfn-type-name: AWS::HealthLake::FHIRDatastore x-identifiers: - DatastoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FHIRDatastore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::HealthLake::FHIRDatastore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::HealthLake::FHIRDatastore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::HealthLake::FHIRDatastore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -277,7 +750,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -296,3 +769,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' AND data__Identifier = '' AND region = 'us-east-1' + fhir_datastores_list_only: + name: fhir_datastores_list_only + id: awscc.healthlake.fhir_datastores_list_only + x-cfn-schema-name: FHIRDatastore + x-cfn-type-name: AWS::HealthLake::FHIRDatastore + x-identifiers: + - DatastoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatastoreId') as datastore_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FHIRDatastore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFHIRDatastore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFHIRDatastoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iam.yaml b/providers/src/awscc/v00.00.00000/services/iam.yaml index 71bf8009..d2d10484 100644 --- a/providers/src/awscc/v00.00.00000/services/iam.yaml +++ b/providers/src/awscc/v00.00.00000/services/iam.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IAM - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Policy: description: |- @@ -26,35 +406,57 @@ components: type: object properties: Arn: - description: The Arn of the group to create + description: '' type: string GroupName: - description: The name of the group to create + description: |- + The name of the group to create. Do not include the path in this value. + The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. type: string ManagedPolicyArns: - description: 'A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. ' + description: |- + The Amazon Resource Name (ARN) of the IAM policy you want to attach. + For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. type: array uniqueItems: true x-insertionOrder: false items: type: string Path: - description: The path to the group + description: |- + The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. type: string Policies: - description: Adds or updates an inline policy document that is embedded in the specified IAM group + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). + The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Policy' x-stackql-resource-name: group - x-stackql-primaryIdentifier: + description: |- + Creates a new group. + For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + x-type-name: AWS::IAM::Group + x-stackql-primary-identifier: - GroupName x-create-only-properties: - GroupName x-read-only-properties: - Arn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:CreateGroup @@ -111,12 +513,25 @@ components: - PolicyName - GroupName x-stackql-resource-name: group_policy - x-stackql-primaryIdentifier: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM group. + A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::GroupPolicy + x-stackql-primary-identifier: - PolicyName - GroupName x-create-only-properties: - PolicyName - GroupName + x-required-properties: + - PolicyName + - GroupName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:PutGroupPolicy @@ -156,13 +571,23 @@ components: required: - Roles x-stackql-resource-name: instance_profile - x-stackql-primaryIdentifier: + description: |- + Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html). + For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*. + x-type-name: AWS::IAM::InstanceProfile + x-stackql-primary-identifier: - InstanceProfileName x-create-only-properties: - InstanceProfileName - Path x-read-only-properties: - Arn + x-required-properties: + - Roles + x-tagging: + taggable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - iam:CreateInstanceProfile @@ -187,65 +612,99 @@ components: properties: Description: type: string - description: A friendly description of the policy. + description: |- + A friendly description of the policy. + Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." + The policy description is immutable. After a value is assigned, it cannot be changed. Groups: x-insertionOrder: false type: array - description: The name (friendly name, not ARN) of the group to attach the policy to. + description: |- + The name (friendly name, not ARN) of the group to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- uniqueItems: true items: type: string ManagedPolicyName: type: string - description: The friendly name of the policy. + description: |- + The friendly name of the policy. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. Path: type: string - description: The path for the policy. + default: / + description: |- + The path for the policy. + For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + You cannot use an asterisk (*) in the path name. PolicyDocument: type: object - description: The JSON policy document that you want to use as the content for the new policy. + description: |- + The JSON policy document that you want to use as the content for the new policy. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). + To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) Roles: x-insertionOrder: false type: array - description: The name (friendly name, not ARN) of the role to attach the policy to. + description: |- + The name (friendly name, not ARN) of the role to attach the policy to. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. uniqueItems: true items: type: string Users: x-insertionOrder: false type: array - description: The name (friendly name, not ARN) of the IAM user to attach the policy to. + description: |- + The name (friendly name, not ARN) of the IAM user to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- uniqueItems: true items: type: string PolicyArn: type: string - description: Amazon Resource Name (ARN) of the managed policy + description: '' AttachmentCount: type: integer - description: The number of entities (users, groups, and roles) that the policy is attached to. + description: '' CreateDate: type: string - description: The date and time, in ISO 8601 date-time format, when the policy was created. + description: '' UpdateDate: type: string - description: The date and time, in ISO 8601 date-time format, when the policy was last updated. + description: '' DefaultVersionId: type: string - description: The identifier for the version of the policy that is set as the default version. + description: '' IsAttachable: type: boolean - description: Specifies whether the policy can be attached to an IAM user, group, or role. + description: '' PermissionsBoundaryUsageCount: type: integer - description: The number of entities (users and roles) for which the policy is used to set the permissions boundary. + description: '' PolicyId: type: string - description: The stable and unique string identifying the policy. + description: '' required: - PolicyDocument x-stackql-resource-name: managed_policy - x-stackql-primaryIdentifier: + description: |- + Creates a new managed policy for your AWS-account. + This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*. + As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*. + For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::ManagedPolicy + x-stackql-primary-identifier: - PolicyArn x-create-only-properties: - ManagedPolicyName @@ -260,6 +719,13 @@ components: - PermissionsBoundaryUsageCount - PolicyId - UpdateDate + x-required-properties: + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:CreatePolicy @@ -344,15 +810,25 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - required: - - ThumbprintList x-stackql-resource-name: oidc_provider - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IAM::OIDCProvider + x-type-name: AWS::IAM::OIDCProvider + x-stackql-primary-identifier: - Arn x-create-only-properties: - Url x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iam:TagOpenIDConnectProvider + - iam:UntagOpenIDConnectProvider + - iam:ListOpenIDConnectProviderTags x-required-permissions: create: - iam:CreateOpenIDConnectProvider @@ -371,7 +847,7 @@ components: delete: - iam:DeleteOpenIDConnectProvider list: - - iam:ListOpenIDConnectProvider + - iam:ListOpenIDConnectProviders - iam:GetOpenIDConnectProvider Role: type: object @@ -399,7 +875,7 @@ components: MaxSessionDuration: description: |- The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. - Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. + Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds``CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*``CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. type: integer Path: description: |- @@ -419,7 +895,7 @@ components: When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - If an external policy (such as ``AWS::IAM::Policy`` or + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. type: array x-insertionOrder: false uniqueItems: false @@ -433,7 +909,8 @@ components: A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. type: string Tags: description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. @@ -445,7 +922,11 @@ components: required: - AssumeRolePolicyDocument x-stackql-resource-name: role - x-stackql-primaryIdentifier: + description: |- + Creates a new role for your AWS-account. + For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::Role + x-stackql-primary-identifier: - RoleName x-create-only-properties: - Path @@ -453,6 +934,18 @@ components: x-read-only-properties: - Arn - RoleId + x-required-properties: + - AssumeRolePolicyDocument + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iam:TagRole + - iam:UntagRole + - iam:ListRoleTags x-required-permissions: create: - iam:CreateRole @@ -516,12 +1009,26 @@ components: - PolicyName - RoleName x-stackql-resource-name: role_policy - x-stackql-primaryIdentifier: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*. + A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::RolePolicy + x-stackql-primary-identifier: - PolicyName - RoleName x-create-only-properties: - PolicyName - RoleName + x-required-properties: + - PolicyName + - RoleName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:PutRolePolicy @@ -534,6 +1041,24 @@ components: delete: - iam:DeleteRolePolicy - iam:GetRolePolicy + SAMLPrivateKey: + description: The private key metadata for the SAML provider + type: object + additionalProperties: false + properties: + KeyId: + description: The unique identifier for the SAML private key. + minLength: 22 + maxLength: 64 + pattern: '[A-Z0-9]+' + type: string + Timestamp: + description: The date and time, in ISO 8601 date-time format, when the private key was uploaded. + type: string + format: date-time + required: + - KeyId + - Timestamp SAMLProvider: type: object properties: @@ -557,15 +1082,61 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - required: - - SamlMetadataDocument + AssertionEncryptionMode: + description: The encryption setting for the SAML provider + type: string + enum: + - Allowed + - Required + AddPrivateKey: + description: The private key from your external identity provider + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + RemovePrivateKey: + description: The Key ID of the private key to remove + minLength: 22 + maxLength: 64 + pattern: '[A-Z0-9]+' + type: string + PrivateKeyList: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SAMLPrivateKey' + maxItems: 2 + SamlProviderUUID: + description: The unique identifier assigned to the SAML provider + minLength: 22 + maxLength: 64 + pattern: '[A-Z0-9]+' + type: string x-stackql-resource-name: saml_provider - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IAM::SAMLProvider + x-type-name: AWS::IAM::SAMLProvider + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name + - AddPrivateKey + - RemovePrivateKey + x-write-only-properties: + - AddPrivateKey + - RemovePrivateKey x-read-only-properties: - Arn + - SamlProviderUUID + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iam:TagSAMLProvider + - iam:ListSAMLProviderTags + - iam:UntagSAMLProvider x-required-permissions: create: - iam:CreateSAMLProvider @@ -624,15 +1195,31 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: server_certificate - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IAM::ServerCertificate + x-type-name: AWS::IAM::ServerCertificate + x-stackql-primary-identifier: - ServerCertificateName x-create-only-properties: - ServerCertificateName - PrivateKey - CertificateBody - CertificateChain + x-write-only-properties: + - PrivateKey + - CertificateBody + - CertificateChain x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iam:TagServerCertificate + - iam:UntagServerCertificate + - iam:ListServerCertificateTags x-required-permissions: create: - iam:UploadServerCertificate @@ -667,13 +1254,24 @@ components: type: string required: [] x-stackql-resource-name: service_linked_role - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IAM::ServiceLinkedRole + x-type-name: AWS::IAM::ServiceLinkedRole + x-stackql-primary-identifier: - RoleName x-create-only-properties: - CustomSuffix - AWSServiceName + x-write-only-properties: + - CustomSuffix + - AWSServiceName x-read-only-properties: - RoleName + x-required-properties: [] + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -768,12 +1366,28 @@ components: For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*. type: string x-stackql-resource-name: user - x-stackql-primaryIdentifier: + description: |- + Creates a new IAM user for your AWS-account. + For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::User + x-stackql-primary-identifier: - UserName x-create-only-properties: - UserName + x-write-only-properties: + - LoginProfile/Password x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iam:TagUser + - iam:UntagUser + - iam:ListUserTags x-required-permissions: create: - iam:CreateLoginProfile @@ -828,24 +1442,47 @@ components: type: object properties: PolicyDocument: - description: The policy document. + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) type: object PolicyName: - description: The name of the policy document. + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string UserName: - description: The name of the user to associate the policy with. + description: |- + The name of the user to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string required: - PolicyName - UserName x-stackql-resource-name: user_policy - x-stackql-primaryIdentifier: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. + An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::UserPolicy + x-stackql-primary-identifier: - PolicyName - UserName x-create-only-properties: - PolicyName - UserName + x-required-properties: + - PolicyName + - UserName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:PutUserPolicy @@ -889,7 +1526,9 @@ components: required: - Users x-stackql-resource-name: virtualmfa_device - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IAM::VirtualMFADevice + x-type-name: AWS::IAM::VirtualMFADevice + x-stackql-primary-identifier: - SerialNumber x-create-only-properties: - VirtualMfaDeviceName @@ -897,6 +1536,8 @@ components: - Path x-read-only-properties: - SerialNumber + x-required-properties: + - Users x-required-permissions: create: - iam:CreateVirtualMFADevice @@ -912,138 +1553,778 @@ components: - iam:DeactivateMFADevice list: - iam:ListVirtualMFADevices - region: - type: string - description: The AWS region (always `us-east-1` for IAM resources) - user_policies: - description: List of user policies by UserName (requires `aws` provider to be installed) + CreateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: '' + type: string + GroupName: + description: |- + The name of the group to create. Do not include the path in this value. + The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + type: string + ManagedPolicyArns: + description: |- + The Amazon Resource Name (ARN) of the IAM policy you want to attach. + For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Path: + description: |- + The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). + The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Policy' + x-stackQL-stringOnly: true + x-title: CreateGroupRequest type: object - additionalProperties: false + required: [] + CreateGroupPolicyRequest: properties: - UserName: + ClientToken: type: string - description: The IAM user name - member: + RoleArn: type: string - description: The user policy name - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE UserName = '' - group_policies: - description: List of group policies by GroupName (requires `aws` provider to be installed) + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyDocument: + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + type: object + PolicyName: + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + GroupName: + description: |- + The name of the group to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. + type: string + x-stackQL-stringOnly: true + x-title: CreateGroupPolicyRequest type: object - additionalProperties: false + required: [] + CreateInstanceProfileRequest: properties: - GroupName: + ClientToken: type: string - description: The IAM group name - PolicyName: + RoleArn: type: string - description: The group policy name - PolicyDocument: + TypeName: type: string - description: The group policy document - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE GroupName = '' - role_policies: - description: List of policies by RoleName (requires `aws` provider to be installed) + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Path: + type: string + description: |- + The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + Roles: + type: array + description: The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. + uniqueItems: true + x-insertionOrder: false + items: + type: string + InstanceProfileName: + type: string + description: |- + The name of the instance profile to create. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Arn: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateInstanceProfileRequest type: object - additionalProperties: false + required: [] + CreateManagedPolicyRequest: properties: - RoleName: + ClientToken: type: string - description: The IAM role name - PolicyName: + RoleArn: type: string - description: The role policy name - PolicyDocument: + TypeName: + type: string + TypeVersionId: type: string - description: The role policy document - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE RoleName = '' - policies: - description: List of policies (requires `aws` provider to be installed) + DesiredState: + type: object + properties: + Description: + type: string + description: |- + A friendly description of the policy. + Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." + The policy description is immutable. After a value is assigned, it cannot be changed. + Groups: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the group to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true + items: + type: string + ManagedPolicyName: + type: string + description: |- + The friendly name of the policy. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + Path: + type: string + default: / + description: |- + The path for the policy. + For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + You cannot use an asterisk (*) in the path name. + PolicyDocument: + type: object + description: |- + The JSON policy document that you want to use as the content for the new policy. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). + To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + Roles: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the role to attach the policy to. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. + uniqueItems: true + items: + type: string + Users: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the IAM user to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true + items: + type: string + PolicyArn: + type: string + description: '' + AttachmentCount: + type: integer + description: '' + CreateDate: + type: string + description: '' + UpdateDate: + type: string + description: '' + DefaultVersionId: + type: string + description: '' + IsAttachable: + type: boolean + description: '' + PermissionsBoundaryUsageCount: + type: integer + description: '' + PolicyId: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateManagedPolicyRequest type: object - additionalProperties: false + required: [] + CreateOIDCProviderRequest: properties: - PolicyName: + ClientToken: type: string - description: The name for the policy - Arn: + RoleArn: type: string - description: The ARN - AttachmentCount: - type: number - description: The attachment count for the policy - CreateDate: + TypeName: type: string - description: The creation date for the policy - DefaultVersionId: + TypeVersionId: type: string - description: The default version id for the policy - Description: + DesiredState: + type: object + properties: + ClientIdList: + type: array + x-insertionOrder: false + items: + minLength: 1 + maxLength: 255 + type: string + Url: + minLength: 1 + maxLength: 255 + type: string + ThumbprintList: + type: array + x-insertionOrder: false + items: + minLength: 40 + maxLength: 40 + pattern: '[0-9A-Fa-f]{40}' + type: string + maxItems: 5 + Arn: + description: Amazon Resource Name (ARN) of the OIDC provider + minLength: 20 + maxLength: 2048 + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOIDCProviderRequest + type: object + required: [] + CreateRoleRequest: + properties: + ClientToken: type: string - description: The description for the policy - IsAttachable: - type: boolean - description: Is the policy attachable? - Path: + RoleArn: type: string - description: The path for the policy - PermissionsBoundaryUsageCount: - type: number - description: The permissions boundary usage count for the policy - PolicyId: + TypeName: type: string - description: The id for the policy - Tags: - type: array - description: Tags for the policy - UpdateDate: + TypeVersionId: type: string - description: The update date for the policy - region: - $ref: '#/components/schemas/region' - x-example-where-clause: '' - x-stackQL-resources: - groups: - name: groups - id: awscc.iam.groups - x-cfn-schema-name: Group - x-type: list - x-identifiers: - - GroupName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' - AND region = 'us-east-1' - group: - name: group - id: awscc.iam.group - x-cfn-schema-name: Group - x-type: get - x-identifiers: - - GroupName - config: + DesiredState: + type: object + properties: + Arn: + description: '' + type: string + AssumeRolePolicyDocument: + description: >- + The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements + Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. + type: object + Description: + description: A description of the role that you provide. + type: string + ManagedPolicyArns: + description: |- + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + MaxSessionDuration: + description: |- + The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. + Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds``CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*``CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. + type: integer + Path: + description: |- + The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + default: / + type: string + PermissionsBoundary: + description: |- + The ARN of the policy used to set the permissions boundary for the role. + For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). + A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Policy' + RoleId: + description: '' + type: string + RoleName: + description: |- + A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + type: string + Tags: + description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRoleRequest + type: object + required: [] + CreateRolePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyDocument: + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + type: object + PolicyName: + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + RoleName: + description: |- + The name of the role to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + x-stackQL-stringOnly: true + x-title: CreateRolePolicyRequest + type: object + required: [] + CreateSAMLProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + minLength: 1 + maxLength: 128 + pattern: '[\w._-]+' + type: string + SamlMetadataDocument: + minLength: 1000 + maxLength: 10000000 + type: string + Arn: + description: Amazon Resource Name (ARN) of the SAML provider + minLength: 1 + maxLength: 1600 + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AssertionEncryptionMode: + description: The encryption setting for the SAML provider + type: string + enum: + - Allowed + - Required + AddPrivateKey: + description: The private key from your external identity provider + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + RemovePrivateKey: + description: The Key ID of the private key to remove + minLength: 22 + maxLength: 64 + pattern: '[A-Z0-9]+' + type: string + PrivateKeyList: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SAMLPrivateKey' + maxItems: 2 + SamlProviderUUID: + description: The unique identifier assigned to the SAML provider + minLength: 22 + maxLength: 64 + pattern: '[A-Z0-9]+' + type: string + x-stackQL-stringOnly: true + x-title: CreateSAMLProviderRequest + type: object + required: [] + CreateServerCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateBody: + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + CertificateChain: + minLength: 1 + maxLength: 2097152 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + ServerCertificateName: + minLength: 1 + maxLength: 128 + pattern: '[\w+=,.@-]+' + type: string + Path: + minLength: 1 + maxLength: 512 + pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) + type: string + PrivateKey: + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + Arn: + description: Amazon Resource Name (ARN) of the server certificate + minLength: 1 + maxLength: 1600 + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateServerCertificateRequest + type: object + required: [] + CreateServiceLinkedRoleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RoleName: + description: The name of the role. + type: string + CustomSuffix: + description: A string that you provide, which is combined with the service-provided prefix to form the complete role name. + type: string + Description: + description: The description of the role. + type: string + AWSServiceName: + description: The service principal for the AWS service to which this role is attached. + type: string + x-stackQL-stringOnly: true + x-title: CreateServiceLinkedRoleRequest + type: object + required: [] + CreateUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Path: + description: |- + The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + type: string + ManagedPolicyArns: + description: |- + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). + The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Policy' + UserName: + description: |- + The name of the user to create. Do not include the path in this value. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + type: string + Groups: + description: A list of group names to which you want to add the user. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Arn: + description: '' + type: string + LoginProfile: + description: |- + Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console. + You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console. + For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. + $ref: '#/components/schemas/LoginProfile' + Tags: + description: |- + A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. + If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + PermissionsBoundary: + description: |- + The ARN of the managed policy that is used to set the permissions boundary for the user. + A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*. + type: string + x-stackQL-stringOnly: true + x-title: CreateUserRequest + type: object + required: [] + CreateUserPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyDocument: + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + type: object + PolicyName: + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + UserName: + description: |- + The name of the user to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + x-stackQL-stringOnly: true + x-title: CreateUserPolicyRequest + type: object + required: [] + CreateVirtualMFADeviceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VirtualMfaDeviceName: + minLength: 1 + maxLength: 226 + pattern: '[\w+=,.@-]+' + type: string + Path: + minLength: 1 + maxLength: 512 + pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) + type: string + SerialNumber: + minLength: 9 + maxLength: 256 + pattern: '[\w+=/:,.@-]+' + type: string + Users: + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVirtualMFADeviceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + groups: + name: groups + id: awscc.iam.groups + x-cfn-schema-name: Group + x-cfn-type-name: AWS::IAM::Group + x-identifiers: + - GroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' + config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1057,7 +2338,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1070,14 +2351,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::Group' AND data__Identifier = '' AND region = 'us-east-1' - group_policy: - name: group_policy - id: awscc.iam.group_policy - x-cfn-schema-name: GroupPolicy - x-type: get + groups_list_only: + name: groups_list_only + id: awscc.iam.groups_list_only + x-cfn-schema-name: Group + x-cfn-type-name: AWS::IAM::Group x-identifiers: - - PolicyName - GroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1085,61 +2371,158 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, json_extract_path_text(Properties, 'GroupName') as group_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' AND region = 'us-east-1' - instance_profiles: - name: instance_profiles - id: awscc.iam.instance_profiles - x-cfn-schema-name: InstanceProfile - x-type: list + group_policies: + name: group_policies + id: awscc.iam.group_policies + x-cfn-schema-name: GroupPolicy + x-cfn-type-name: AWS::IAM::GroupPolicy x-identifiers: - - InstanceProfileName + - PolicyName + - GroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GroupPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::GroupPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::GroupPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::GroupPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceProfileName') as instance_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' + data__Identifier, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'GroupName') as group_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' + AND data__Identifier = '|' AND region = 'us-east-1' - instance_profile: - name: instance_profile - id: awscc.iam.instance_profile + instance_profiles: + name: instance_profiles + id: awscc.iam.instance_profiles x-cfn-schema-name: InstanceProfile - x-type: get + x-cfn-type-name: AWS::IAM::InstanceProfile x-identifiers: - InstanceProfileName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::InstanceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::InstanceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::InstanceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1152,7 +2535,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1164,13 +2547,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::InstanceProfile' AND data__Identifier = '' AND region = 'us-east-1' - managed_policies: - name: managed_policies - id: awscc.iam.managed_policies - x-cfn-schema-name: ManagedPolicy - x-type: list + instance_profiles_list_only: + name: instance_profiles_list_only + id: awscc.iam.instance_profiles_list_only + x-cfn-schema-name: InstanceProfile + x-cfn-type-name: AWS::IAM::InstanceProfile x-identifiers: - - PolicyArn + - InstanceProfileName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1178,28 +2567,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' + JSON_EXTRACT(Properties, '$.InstanceProfileName') as instance_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyArn') as policy_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' + json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' AND region = 'us-east-1' - managed_policy: - name: managed_policy - id: awscc.iam.managed_policy + managed_policies: + name: managed_policies + id: awscc.iam.managed_policies x-cfn-schema-name: ManagedPolicy - x-type: get + x-cfn-type-name: AWS::IAM::ManagedPolicy x-identifiers: - PolicyArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ManagedPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ManagedPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ManagedPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ManagedPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/managed_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/managed_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/managed_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1223,7 +2660,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1246,13 +2683,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' AND data__Identifier = '' AND region = 'us-east-1' - oidc_providers: - name: oidc_providers - id: awscc.iam.oidc_providers - x-cfn-schema-name: OIDCProvider - x-type: list + managed_policies_list_only: + name: managed_policies_list_only + id: awscc.iam.managed_policies_list_only + x-cfn-schema-name: ManagedPolicy + x-cfn-type-name: AWS::IAM::ManagedPolicy x-identifiers: - - Arn + - PolicyArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1260,28 +2703,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' + json_extract_path_text(Properties, 'PolicyArn') as policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' AND region = 'us-east-1' - oidc_provider: - name: oidc_provider - id: awscc.iam.oidc_provider + oidc_providers: + name: oidc_providers + id: awscc.iam.oidc_providers x-cfn-schema-name: OIDCProvider - x-type: get + x-cfn-type-name: AWS::IAM::OIDCProvider x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OIDCProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::OIDCProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::OIDCProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::OIDCProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1295,7 +2786,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1308,13 +2799,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::OIDCProvider' AND data__Identifier = '' AND region = 'us-east-1' - roles: - name: roles - id: awscc.iam.roles - x-cfn-schema-name: Role - x-type: list + oidc_providers_list_only: + name: oidc_providers_list_only + id: awscc.iam.oidc_providers_list_only + x-cfn-schema-name: OIDCProvider + x-cfn-type-name: AWS::IAM::OIDCProvider x-identifiers: - - RoleName + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1322,28 +2819,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RoleName') as role_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RoleName') as role_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' AND region = 'us-east-1' - role: - name: role - id: awscc.iam.role + roles: + name: roles + id: awscc.iam.roles x-cfn-schema-name: Role - x-type: get + x-cfn-type-name: AWS::IAM::Role x-identifiers: - RoleName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Role&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::Role" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::Role" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::Role" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/roles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/roles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/roles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1363,7 +2908,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1382,14 +2927,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::Role' AND data__Identifier = '' AND region = 'us-east-1' - role_policy: - name: role_policy - id: awscc.iam.role_policy - x-cfn-schema-name: RolePolicy - x-type: get + roles_list_only: + name: roles_list_only + id: awscc.iam.roles_list_only + x-cfn-schema-name: Role + x-cfn-type-name: AWS::IAM::Role x-identifiers: - - PolicyName - RoleName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1397,61 +2947,158 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, JSON_EXTRACT(Properties, '$.RoleName') as role_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, json_extract_path_text(Properties, 'RoleName') as role_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' AND region = 'us-east-1' - saml_providers: - name: saml_providers - id: awscc.iam.saml_providers - x-cfn-schema-name: SAMLProvider - x-type: list + role_policies: + name: role_policies + id: awscc.iam.role_policies + x-cfn-schema-name: RolePolicy + x-cfn-type-name: AWS::IAM::RolePolicy x-identifiers: - - Arn + - PolicyName + - RoleName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RolePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::RolePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::RolePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::RolePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.RoleName') as role_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' + data__Identifier, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'RoleName') as role_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' + AND data__Identifier = '|' AND region = 'us-east-1' - saml_provider: - name: saml_provider - id: awscc.iam.saml_provider + saml_providers: + name: saml_providers + id: awscc.iam.saml_providers x-cfn-schema-name: SAMLProvider - x-type: get + x-cfn-type-name: AWS::IAM::SAMLProvider x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SAMLProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::SAMLProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::SAMLProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::SAMLProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/saml_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/saml_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/saml_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1459,12 +3106,17 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.SamlMetadataDocument') as saml_metadata_document, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AssertionEncryptionMode') as assertion_encryption_mode, + JSON_EXTRACT(Properties, '$.AddPrivateKey') as add_private_key, + JSON_EXTRACT(Properties, '$.RemovePrivateKey') as remove_private_key, + JSON_EXTRACT(Properties, '$.PrivateKeyList') as private_key_list, + JSON_EXTRACT(Properties, '$.SamlProviderUUID') as saml_provider_uu_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::SAMLProvider' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1472,17 +3124,28 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'SamlMetadataDocument') as saml_metadata_document, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AssertionEncryptionMode') as assertion_encryption_mode, + json_extract_path_text(Properties, 'AddPrivateKey') as add_private_key, + json_extract_path_text(Properties, 'RemovePrivateKey') as remove_private_key, + json_extract_path_text(Properties, 'PrivateKeyList') as private_key_list, + json_extract_path_text(Properties, 'SamlProviderUUID') as saml_provider_uu_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::SAMLProvider' AND data__Identifier = '' AND region = 'us-east-1' - server_certificates: - name: server_certificates - id: awscc.iam.server_certificates - x-cfn-schema-name: ServerCertificate - x-type: list + saml_providers_list_only: + name: saml_providers_list_only + id: awscc.iam.saml_providers_list_only + x-cfn-schema-name: SAMLProvider + x-cfn-type-name: AWS::IAM::SAMLProvider x-identifiers: - - ServerCertificateName + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1490,28 +3153,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ServerCertificateName') as server_certificate_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ServerCertificateName') as server_certificate_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' AND region = 'us-east-1' - server_certificate: - name: server_certificate - id: awscc.iam.server_certificate + server_certificates: + name: server_certificates + id: awscc.iam.server_certificates x-cfn-schema-name: ServerCertificate - x-type: get + x-cfn-type-name: AWS::IAM::ServerCertificate x-identifiers: - ServerCertificateName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServerCertificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ServerCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ServerCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ServerCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/server_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/server_certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/server_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1527,7 +3238,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1542,17 +3253,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::ServerCertificate' AND data__Identifier = '' AND region = 'us-east-1' - service_linked_role: - name: service_linked_role - id: awscc.iam.service_linked_role + server_certificates_list_only: + name: server_certificates_list_only + id: awscc.iam.server_certificates_list_only + x-cfn-schema-name: ServerCertificate + x-cfn-type-name: AWS::IAM::ServerCertificate + x-identifiers: + - ServerCertificateName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ServerCertificateName') as server_certificate_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServerCertificateName') as server_certificate_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' + AND region = 'us-east-1' + service_linked_roles: + name: service_linked_roles + id: awscc.iam.service_linked_roles x-cfn-schema-name: ServiceLinkedRole - x-type: get + x-cfn-type-name: AWS::IAM::ServiceLinkedRole x-identifiers: - RoleName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceLinkedRole&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ServiceLinkedRole" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ServiceLinkedRole" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::ServiceLinkedRole" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1565,7 +3355,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1581,38 +3371,61 @@ components: name: users id: awscc.iam.users x-cfn-schema-name: User - x-type: list - x-identifiers: - - UserName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserName') as user_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserName') as user_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' - AND region = 'us-east-1' - user: - name: user - id: awscc.iam.user - x-cfn-schema-name: User - x-type: get + x-cfn-type-name: AWS::IAM::User x-identifiers: - UserName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1630,7 +3443,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1647,14 +3460,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::User' AND data__Identifier = '' AND region = 'us-east-1' - user_policy: - name: user_policy - id: awscc.iam.user_policy - x-cfn-schema-name: UserPolicy - x-type: get + users_list_only: + name: users_list_only + id: awscc.iam.users_list_only + x-cfn-schema-name: User + x-cfn-type-name: AWS::IAM::User x-identifiers: - - PolicyName - UserName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1662,61 +3480,158 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, JSON_EXTRACT(Properties, '$.UserName') as user_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, json_extract_path_text(Properties, 'UserName') as user_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' AND region = 'us-east-1' - virtualmfa_devices: - name: virtualmfa_devices - id: awscc.iam.virtualmfa_devices - x-cfn-schema-name: VirtualMFADevice - x-type: list + user_policies: + name: user_policies + id: awscc.iam.user_policies + x-cfn-schema-name: UserPolicy + x-cfn-type-name: AWS::IAM::UserPolicy x-identifiers: - - SerialNumber + - PolicyName + - UserName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::UserPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::UserPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::UserPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SerialNumber') as serial_number - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.UserName') as user_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'SerialNumber') as serial_number - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' + data__Identifier, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'UserName') as user_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' + AND data__Identifier = '|' AND region = 'us-east-1' - virtualmfa_device: - name: virtualmfa_device - id: awscc.iam.virtualmfa_device + virtualmfa_devices: + name: virtualmfa_devices + id: awscc.iam.virtualmfa_devices x-cfn-schema-name: VirtualMFADevice - x-type: get + x-cfn-type-name: AWS::IAM::VirtualMFADevice x-identifiers: - SerialNumber + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VirtualMFADevice&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::VirtualMFADevice" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::VirtualMFADevice" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::VirtualMFADevice" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1730,7 +3645,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1743,82 +3658,733 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' AND data__Identifier = '' AND region = 'us-east-1' - user_policies: - name: user_policies - id: awscc.iam.user_policies - x-cfn-schema-name: user_policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - UserName, - member, - region - FROM aws.iam.user_policies - WHERE UserName = '' - AND region = 'us-east-1' - group_policies: - name: group_policies - id: awscc.iam.group_policies - x-cfn-schema-name: group_policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - GroupName, - PolicyName, - PolicyDocument, - region - FROM aws.iam.group_policies - WHERE GroupName = '' - AND region = 'us-east-1' - policies: - name: policies - id: awscc.iam.policies - x-cfn-schema-name: policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - PolicyName, - Arn, - AttachmentCount, - CreateDate, - DefaultVersionId, - Description, - IsAttachable, - Path, - PermissionsBoundaryUsageCount, - PolicyId, - Tags, - UpdateDate, - region - FROM aws.iam.policies - WHERE region = 'us-east-1' - role_policies: - name: role_policies - id: awscc.iam.role_policies - x-cfn-schema-name: role_policies - x-type: custom_list + virtualmfa_devices_list_only: + name: virtualmfa_devices_list_only + id: awscc.iam.virtualmfa_devices_list_only + x-cfn-schema-name: VirtualMFADevice + x-cfn-type-name: AWS::IAM::VirtualMFADevice + x-identifiers: + - SerialNumber + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" ddl: |- SELECT - RoleName, - PolicyName, - PolicyDocument, - region - FROM aws.iam.role_policies - WHERE RoleName = '' + region, + JSON_EXTRACT(Properties, '$.SerialNumber') as serial_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SerialNumber') as serial_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GroupPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroupPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ManagedPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateManagedPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateManagedPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OIDCProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOIDCProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOIDCProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Role&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRole + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RolePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRolePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRolePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SAMLProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSAMLProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSAMLProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServerCertificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServerCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServerCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceLinkedRole&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceLinkedRole + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceLinkedRoleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VirtualMFADevice&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVirtualMFADevice + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVirtualMFADeviceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/identitystore.yaml b/providers/src/awscc/v00.00.00000/services/identitystore.yaml index 0fadb0ec..6c1d4d55 100644 --- a/providers/src/awscc/v00.00.00000/services/identitystore.yaml +++ b/providers/src/awscc/v00.00.00000/services/identitystore.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IdentityStore - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Group: type: object @@ -36,13 +416,23 @@ components: - IdentityStoreId - DisplayName x-stackql-resource-name: group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IdentityStore::Group + x-type-name: AWS::IdentityStore::Group + x-stackql-primary-identifier: - GroupId - IdentityStoreId x-create-only-properties: - IdentityStoreId x-read-only-properties: - GroupId + x-required-properties: + - IdentityStoreId + - DisplayName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - identitystore:CreateGroup @@ -100,7 +490,9 @@ components: - GroupId - MemberId x-stackql-resource-name: group_membership - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS:IdentityStore::GroupMembership + x-type-name: AWS::IdentityStore::GroupMembership + x-stackql-primary-identifier: - MembershipId - IdentityStoreId x-create-only-properties: @@ -109,6 +501,15 @@ components: - MemberId x-read-only-properties: - MembershipId + x-required-properties: + - IdentityStoreId + - GroupId + - MemberId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - identitystore:CreateGroupMembership @@ -120,43 +521,191 @@ components: - identitystore:DescribeGroupMembership list: - identitystore:ListGroupMemberships + CreateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A string containing the description of the group. + type: string + maxLength: 1024 + minLength: 1 + pattern: ^[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+$ + DisplayName: + description: A string containing the name of the group. This value is commonly displayed when the group is referenced. + type: string + maxLength: 1024 + minLength: 1 + pattern: ^[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+$ + GroupId: + description: The unique identifier for a group in the identity store. + type: string + maxLength: 47 + minLength: 1 + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + IdentityStoreId: + description: The globally unique identifier for the identity store. + type: string + maxLength: 36 + minLength: 1 + pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + x-stackQL-stringOnly: true + x-title: CreateGroupRequest + type: object + required: [] + CreateGroupMembershipRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GroupId: + description: The unique identifier for a group in the identity store. + type: string + maxLength: 47 + minLength: 1 + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + IdentityStoreId: + description: The globally unique identifier for the identity store. + type: string + maxLength: 36 + minLength: 1 + pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + MemberId: + description: An object containing the identifier of a group member. + $ref: '#/components/schemas/MemberId' + MembershipId: + description: The identifier for a GroupMembership in the identity store. + type: string + maxLength: 47 + minLength: 1 + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + x-stackQL-stringOnly: true + x-title: CreateGroupMembershipRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: groups: name: groups id: awscc.identitystore.groups x-cfn-schema-name: Group - x-type: list + x-cfn-type-name: AWS::IdentityStore::Group x-identifiers: - GroupId - IdentityStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IdentityStore::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IdentityStore::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IdentityStore::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, JSON_EXTRACT(Properties, '$.GroupId') as group_id, JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::Group' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, json_extract_path_text(Properties, 'GroupId') as group_id, json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::Group' + AND data__Identifier = '|' AND region = 'us-east-1' - group: - name: group - id: awscc.identitystore.group + groups_list_only: + name: groups_list_only + id: awscc.identitystore.groups_list_only x-cfn-schema-name: Group - x-type: get + x-cfn-type-name: AWS::IdentityStore::Group x-identifiers: - GroupId - IdentityStoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -164,63 +713,104 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.DisplayName') as display_name, JSON_EXTRACT(Properties, '$.GroupId') as group_id, JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::Group' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, json_extract_path_text(Properties, 'GroupId') as group_id, json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::Group' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' AND region = 'us-east-1' group_memberships: name: group_memberships id: awscc.identitystore.group_memberships x-cfn-schema-name: GroupMembership - x-type: list + x-cfn-type-name: AWS::IdentityStore::GroupMembership x-identifiers: - MembershipId - IdentityStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GroupMembership&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IdentityStore::GroupMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IdentityStore::GroupMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/group_memberships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/group_memberships/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MembershipId') as membership_id, - JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' + data__Identifier, + JSON_EXTRACT(Properties, '$.GroupId') as group_id, + JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id, + JSON_EXTRACT(Properties, '$.MemberId') as member_id, + JSON_EXTRACT(Properties, '$.MembershipId') as membership_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'MembershipId') as membership_id, - json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' + data__Identifier, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id, + json_extract_path_text(Properties, 'MemberId') as member_id, + json_extract_path_text(Properties, 'MembershipId') as membership_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' + AND data__Identifier = '|' AND region = 'us-east-1' - group_membership: - name: group_membership - id: awscc.identitystore.group_membership + group_memberships_list_only: + name: group_memberships_list_only + id: awscc.identitystore.group_memberships_list_only x-cfn-schema-name: GroupMembership - x-type: get + x-cfn-type-name: AWS::IdentityStore::GroupMembership x-identifiers: - MembershipId - IdentityStoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -228,24 +818,253 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.GroupId') as group_id, - JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id, - JSON_EXTRACT(Properties, '$.MemberId') as member_id, - JSON_EXTRACT(Properties, '$.MembershipId') as membership_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.MembershipId') as membership_id, + JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GroupId') as group_id, - json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id, - json_extract_path_text(Properties, 'MemberId') as member_id, - json_extract_path_text(Properties, 'MembershipId') as membership_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'MembershipId') as membership_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GroupMembership&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroupMembership + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupMembershipRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/imagebuilder.yaml b/providers/src/awscc/v00.00.00000/services/imagebuilder.yaml index d8e4348b..a89f10ad 100644 --- a/providers/src/awscc/v00.00.00000/services/imagebuilder.yaml +++ b/providers/src/awscc/v00.00.00000/services/imagebuilder.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ImageBuilder - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Component: type: object @@ -35,6 +415,7 @@ components: enum: - Windows - Linux + - macOS Data: description: The data of the component. type: string @@ -67,7 +448,9 @@ components: - Platform - Version x-stackql-resource-name: component - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::Component + x-type-name: AWS::ImageBuilder::Component + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -79,16 +462,34 @@ components: - Uri - KmsKeyId - SupportedOsVersions - - Tags + x-write-only-properties: + - Data + - Uri x-read-only-properties: - Arn - Type - Encrypted + x-required-properties: + - Name + - Platform + - Version + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:CreateServiceLinkedRole - iam:GetRole - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext - kms:Encrypt - kms:Decrypt - s3:GetObject @@ -97,14 +498,19 @@ components: - imagebuilder:TagResource - imagebuilder:GetComponent - imagebuilder:CreateComponent + update: + - imagebuilder:TagResource + - imagebuilder:UntagResource read: - imagebuilder:GetComponent + - kms:Decrypt delete: - imagebuilder:GetComponent - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:DeleteComponent list: - imagebuilder:ListComponents + - imagebuilder:ListComponentBuildVersions ComponentConfiguration: description: Configuration details of the component. type: object @@ -282,7 +688,9 @@ components: .{1,}: type: string x-stackql-resource-name: container_recipe - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::ContainerRecipe + x-type-name: AWS::ImageBuilder::ContainerRecipe + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -299,9 +707,22 @@ components: - PlatformOverride - WorkingDirectory - Components - - Tags + x-write-only-properties: + - DockerfileTemplateData + - DockerfileTemplateUri + - ImageOsVersionOverride + - PlatformOverride x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:GetRole @@ -315,15 +736,22 @@ components: - kms:Decrypt - kms:ReEncryptFrom - kms:ReEncryptTo - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext - s3:GetObject - s3:ListBucket - ecr:DescribeRepositories - ec2:DescribeImages read: - imagebuilder:GetContainerRecipe + - kms:Decrypt + update: + - imagebuilder:TagResource + - imagebuilder:UntagResource delete: - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:GetContainerRecipe - imagebuilder:DeleteContainerRecipe list: @@ -358,6 +786,12 @@ components: x-insertionOrder: true items: $ref: '#/components/schemas/FastLaunchConfiguration' + SsmParameterConfigurations: + description: The SSM parameter configurations to use for AMI distribution. + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/SsmParameterConfiguration' required: - Region AmiDistributionConfiguration: @@ -494,6 +928,25 @@ components: TargetResourceCount: description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. type: integer + SsmParameterConfiguration: + description: The SSM parameter configuration for AMI distribution. + type: object + additionalProperties: false + properties: + AmiAccountId: + description: The account ID for the AMI to update the parameter with. + type: string + ParameterName: + description: The name of the SSM parameter. + type: string + DataType: + description: The data type of the SSM parameter. + type: string + enum: + - text + - aws:ec2:image + required: + - ParameterName DistributionConfiguration: type: object properties: @@ -523,12 +976,26 @@ components: - Name - Distributions x-stackql-resource-name: distribution_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::DistributionConfiguration + x-type-name: AWS::ImageBuilder::DistributionConfiguration + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + - Distributions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:GetRole @@ -536,6 +1003,7 @@ components: - ec2:DescribeLaunchTemplates - ec2:CreateLaunchTemplateVersion - ec2:ModifyLaunchTemplate + - ssm:GetParameter - imagebuilder:TagResource - imagebuilder:GetDistributionConfiguration - imagebuilder:CreateDistributionConfiguration @@ -543,29 +1011,19 @@ components: - ec2:DescribeLaunchTemplates - ec2:CreateLaunchTemplateVersion - ec2:ModifyLaunchTemplate + - ssm:GetParameter - imagebuilder:GetDistributionConfiguration - imagebuilder:UpdateDistributionConfiguration + - imagebuilder:TagResource + - imagebuilder:UntagResource read: - imagebuilder:GetDistributionConfiguration delete: - imagebuilder:GetDistributionConfiguration - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:DeleteDistributionConfiguration list: - imagebuilder:ListDistributionConfigurations - ImageTestsConfiguration: - description: Image tests configuration. - type: object - additionalProperties: false - properties: - ImageTestsEnabled: - description: Defines if tests should be executed when building this image. - type: boolean - TimeoutMinutes: - description: The maximum time in minutes that tests are permitted to run. - type: integer - minimum: 60 - maximum: 1440 ImageScanningConfiguration: description: Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution. type: object @@ -577,20 +1035,6 @@ components: ImageScanningEnabled: description: This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. type: boolean - EcrConfiguration: - description: Settings for Image Builder to configure the ECR repository and output container images that are scanned. - type: object - additionalProperties: false - properties: - ContainerTags: - description: Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images. - type: array - x-insertionOrder: true - items: - type: string - RepositoryName: - description: The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images. - type: string WorkflowConfiguration: description: The workflow configuration of the image type: object @@ -614,6 +1058,36 @@ components: enum: - CONTINUE - ABORT + EcrConfiguration: + description: Settings for Image Builder to configure the ECR repository and output container images that are scanned. + type: object + additionalProperties: false + properties: + ContainerTags: + description: Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images. + type: array + x-insertionOrder: true + items: + type: string + RepositoryName: + description: The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images. + type: string + WorkflowParameterValue: + description: The value associated with the workflow parameter + type: string + ImageTestsConfiguration: + description: Image tests configuration. + type: object + additionalProperties: false + properties: + ImageTestsEnabled: + description: Defines if tests should be executed when building this image. + type: boolean + TimeoutMinutes: + description: The maximum time in minutes that tests are permitted to run. + type: integer + minimum: 60 + maximum: 1440 WorkflowParameter: description: A parameter associated with the workflow type: object @@ -626,63 +1100,62 @@ components: x-insertionOrder: true items: $ref: '#/components/schemas/WorkflowParameterValue' - WorkflowParameterValue: - description: The value associated with the workflow parameter - type: string Image: type: object properties: - Arn: - description: The Amazon Resource Name (ARN) of the image. + ImageScanningConfiguration: + description: Contains settings for vulnerability scans. + $ref: '#/components/schemas/ImageScanningConfiguration' + ContainerRecipeArn: + description: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. + type: string + Workflows: + description: Workflows to define the image build process + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/WorkflowConfiguration' + ImageUri: + description: URI for containers created in current Region with default ECR image tag type: string Name: description: The name of the image. type: string - ImageTestsConfiguration: - description: The image tests configuration used when creating this image. - $ref: '#/components/schemas/ImageTestsConfiguration' + InfrastructureConfigurationArn: + description: The Amazon Resource Name (ARN) of the infrastructure configuration. + type: string ImageRecipeArn: description: The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. type: string - ContainerRecipeArn: - description: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. - type: string DistributionConfigurationArn: description: The Amazon Resource Name (ARN) of the distribution configuration. type: string - InfrastructureConfigurationArn: - description: The Amazon Resource Name (ARN) of the infrastructure configuration. - type: string - Workflows: - description: Workflows to define the image build process - type: array - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowConfiguration' ImageId: description: The AMI ID of the EC2 AMI in current region. type: string - ImageUri: - description: URI for containers created in current Region with default ECR image tag + ImageTestsConfiguration: + description: The image tests configuration used when creating this image. + $ref: '#/components/schemas/ImageTestsConfiguration' + Arn: + description: The Amazon Resource Name (ARN) of the image. type: string EnhancedImageMetadataEnabled: description: Collects additional information about the image being created, including the operating system (OS) version and package list. type: boolean - ImageScanningConfiguration: - description: Contains settings for vulnerability scans. - $ref: '#/components/schemas/ImageScanningConfiguration' ExecutionRole: description: The execution role name/ARN for the image build, if provided type: string Tags: - description: The tags associated with the image. - type: object - additionalProperties: false x-patternProperties: .{1,}: type: string + description: The tags associated with the image. + additionalProperties: false + type: object x-stackql-resource-name: image - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::Image + x-type-name: AWS::ImageBuilder::Image + x-stackql-primary-identifier: - Arn x-create-only-properties: - ImageRecipeArn @@ -693,13 +1166,23 @@ components: - ImageTestsConfiguration - ImageScanningConfiguration - EnhancedImageMetadataEnabled - - Tags x-read-only-properties: - Arn - Name - ImageId - ImageUri + x-tagging: + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - imagebuilder:GetImage create: - ecr:BatchGetRepositoryScanningConfiguration - iam:GetRole @@ -713,15 +1196,17 @@ components: - imagebuilder:CreateImage - imagebuilder:TagResource - inspector2:BatchGetAccountStatus - read: - - imagebuilder:GetImage + update: + - imagebuilder:TagResource + - imagebuilder:UntagResource + list: + - imagebuilder:ListImages + - imagebuilder:ListImageBuildVersions delete: - imagebuilder:GetImage - imagebuilder:DeleteImage - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:CancelImageCreation - list: - - imagebuilder:ListImages Schedule: description: The schedule of the image pipeline. type: object @@ -795,12 +1280,23 @@ components: .{1,}: type: string x-stackql-resource-name: image_pipeline - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::ImagePipeline + x-type-name: AWS::ImageBuilder::ImagePipeline + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - ecr:BatchGetRepositoryScanningConfiguration @@ -820,10 +1316,12 @@ components: - imagebuilder:GetImagePipeline - imagebuilder:UpdateImagePipeline - imagebuilder:GetWorkflow + - imagebuilder:TagResource + - imagebuilder:UntagResource read: - imagebuilder:GetImagePipeline delete: - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:GetImagePipeline - imagebuilder:DeleteImagePipeline list: @@ -896,7 +1394,9 @@ components: - Components - ParentImage x-stackql-resource-name: image_recipe - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::ImageRecipe + x-type-name: AWS::ImageBuilder::ImageRecipe + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -906,9 +1406,22 @@ components: - Description - BlockDeviceMappings - WorkingDirectory - - Tags x-read-only-properties: - Arn + x-required-properties: + - Name + - Version + - Components + - ParentImage + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:GetRole @@ -921,8 +1434,11 @@ components: - ec2:DescribeImages read: - imagebuilder:GetImageRecipe + update: + - imagebuilder:TagResource + - imagebuilder:UntagResource delete: - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:GetImageRecipe - imagebuilder:DeleteImageRecipe list: @@ -974,6 +1490,27 @@ components: S3KeyPrefix: description: S3KeyPrefix type: string + Placement: + description: The placement options + type: object + additionalProperties: false + properties: + AvailabilityZone: + description: AvailabilityZone + type: string + Tenancy: + description: Tenancy + type: string + enum: + - default + - dedicated + - host + HostId: + description: HostId + type: string + HostResourceGroupArn: + description: HostResourceGroupArn + type: string InfrastructureConfiguration: type: object properties: @@ -1033,16 +1570,33 @@ components: x-patternProperties: .{1,}: type: string + Placement: + description: The placement option settings for the infrastructure configuration. + $ref: '#/components/schemas/Placement' required: - Name - InstanceProfileName x-stackql-resource-name: infrastructure_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::InfrastructureConfiguration + x-type-name: AWS::ImageBuilder::InfrastructureConfiguration + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + - InstanceProfileName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:PassRole @@ -1058,10 +1612,12 @@ components: - sns:Publish - imagebuilder:GetInfrastructureConfiguration - imagebuilder:UpdateInfrastructureConfiguration + - imagebuilder:TagResource + - imagebuilder:UntagResource read: - imagebuilder:GetInfrastructureConfiguration delete: - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:GetInfrastructureConfiguration - imagebuilder:DeleteInfrastructureConfiguration list: @@ -1281,12 +1837,29 @@ components: - PolicyDetails - ResourceSelection x-stackql-resource-name: lifecycle_policy - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::LifecyclePolicy + x-type-name: AWS::ImageBuilder::LifecyclePolicy + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + - ExecutionRole + - ResourceType + - PolicyDetails + - ResourceSelection + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:PassRole @@ -1297,12 +1870,14 @@ components: - iam:PassRole - imagebuilder:GetLifecyclePolicy - imagebuilder:UpdateLifecyclePolicy + - imagebuilder:TagResource + - imagebuilder:UntagResource read: - imagebuilder:GetLifecyclePolicy delete: - imagebuilder:GetLifecyclePolicy - imagebuilder:DeleteLifecyclePolicy - - imagebuilder:UnTagResource + - imagebuilder:UntagResource list: - imagebuilder:ListLifecyclePolicies Workflow: @@ -1353,7 +1928,9 @@ components: - Type - Version x-stackql-resource-name: workflow - x-stackql-primaryIdentifier: + description: Resource schema for AWS::ImageBuilder::Workflow + x-type-name: AWS::ImageBuilder::Workflow + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -1364,13 +1941,31 @@ components: - Uri - Type - KmsKeyId - - Tags + x-write-only-properties: + - Data + - Uri x-read-only-properties: - Arn + x-required-properties: + - Name + - Type + - Version + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - imagebuilder:TagResource + - imagebuilder:UntagResource x-required-permissions: create: - iam:GetRole - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext - kms:Encrypt - kms:Decrypt - s3:GetObject @@ -1381,49 +1976,658 @@ components: - imagebuilder:CreateWorkflow read: - imagebuilder:GetWorkflow + - kms:Decrypt + update: + - imagebuilder:TagResource + - imagebuilder:UntagResource delete: - imagebuilder:GetWorkflow - - imagebuilder:UnTagResource + - imagebuilder:UntagResource - imagebuilder:DeleteWorkflow list: - imagebuilder:ListWorkflows + - imagebuilder:ListWorkflowBuildVersions + CreateComponentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the component. + type: string + Name: + description: The name of the component. + type: string + Version: + description: The version of the component. + type: string + Description: + description: The description of the component. + type: string + ChangeDescription: + description: The change description of the component. + type: string + Type: + description: 'The type of the component denotes whether the component is used to build the image or only to test it. ' + type: string + enum: + - BUILD + - TEST + Platform: + description: The platform of the component. + type: string + enum: + - Windows + - Linux + - macOS + Data: + description: The data of the component. + type: string + minLength: 1 + maxLength: 16000 + KmsKeyId: + description: The KMS key identifier used to encrypt the component. + type: string + Encrypted: + description: The encryption status of the component. + type: boolean + Tags: + description: The tags associated with the component. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + Uri: + description: The uri of the component. + type: string + SupportedOsVersions: + description: The operating system (OS) version supported by the component. + type: array + x-insertionOrder: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateComponentRequest + type: object + required: [] + CreateContainerRecipeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the container recipe. + type: string + Name: + description: The name of the container recipe. + type: string + Description: + description: The description of the container recipe. + type: string + Version: + description: The semantic version of the container recipe (..). + type: string + Components: + description: Components for build and test that are included in the container recipe. + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/ComponentConfiguration' + InstanceConfiguration: + additionalProperties: false + description: A group of options that can be used to configure an instance for building and testing container images. + $ref: '#/components/schemas/InstanceConfiguration' + DockerfileTemplateData: + description: Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe. + type: string + DockerfileTemplateUri: + description: The S3 URI for the Dockerfile that will be used to build your container image. + type: string + PlatformOverride: + description: Specifies the operating system platform when you use a custom source image. + type: string + enum: + - Windows + - Linux + ContainerType: + description: Specifies the type of container, such as Docker. + type: string + enum: + - DOCKER + ImageOsVersionOverride: + description: Specifies the operating system version for the source image. + type: string + TargetRepository: + description: The destination repository for the container image. + $ref: '#/components/schemas/TargetContainerRepository' + KmsKeyId: + description: Identifies which KMS key is used to encrypt the container image. + type: string + ParentImage: + description: The source image for the container recipe. + type: string + WorkingDirectory: + description: The working directory to be used during build and test workflows. + type: string + Tags: + description: Tags that are attached to the container recipe. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + x-stackQL-stringOnly: true + x-title: CreateContainerRecipeRequest + type: object + required: [] + CreateDistributionConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the distribution configuration. + type: string + Name: + description: The name of the distribution configuration. + type: string + Description: + description: The description of the distribution configuration. + type: string + Distributions: + description: The distributions of the distribution configuration. + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Distribution' + Tags: + description: The tags associated with the component. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + x-stackQL-stringOnly: true + x-title: CreateDistributionConfigurationRequest + type: object + required: [] + CreateImageRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ImageScanningConfiguration: + description: Contains settings for vulnerability scans. + $ref: '#/components/schemas/ImageScanningConfiguration' + ContainerRecipeArn: + description: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. + type: string + Workflows: + description: Workflows to define the image build process + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/WorkflowConfiguration' + ImageUri: + description: URI for containers created in current Region with default ECR image tag + type: string + Name: + description: The name of the image. + type: string + InfrastructureConfigurationArn: + description: The Amazon Resource Name (ARN) of the infrastructure configuration. + type: string + ImageRecipeArn: + description: The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. + type: string + DistributionConfigurationArn: + description: The Amazon Resource Name (ARN) of the distribution configuration. + type: string + ImageId: + description: The AMI ID of the EC2 AMI in current region. + type: string + ImageTestsConfiguration: + description: The image tests configuration used when creating this image. + $ref: '#/components/schemas/ImageTestsConfiguration' + Arn: + description: The Amazon Resource Name (ARN) of the image. + type: string + EnhancedImageMetadataEnabled: + description: Collects additional information about the image being created, including the operating system (OS) version and package list. + type: boolean + ExecutionRole: + description: The execution role name/ARN for the image build, if provided + type: string + Tags: + x-patternProperties: + .{1,}: + type: string + description: The tags associated with the image. + additionalProperties: false + type: object + x-stackQL-stringOnly: true + x-title: CreateImageRequest + type: object + required: [] + CreateImagePipelineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the image pipeline. + type: string + Name: + description: The name of the image pipeline. + type: string + Description: + description: The description of the image pipeline. + type: string + ImageTestsConfiguration: + description: The image tests configuration of the image pipeline. + $ref: '#/components/schemas/ImageTestsConfiguration' + Status: + description: The status of the image pipeline. + type: string + enum: + - DISABLED + - ENABLED + Schedule: + description: The schedule of the image pipeline. + $ref: '#/components/schemas/Schedule' + ImageRecipeArn: + description: The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. + type: string + ContainerRecipeArn: + description: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. + type: string + DistributionConfigurationArn: + description: The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. + type: string + InfrastructureConfigurationArn: + description: The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. + type: string + Workflows: + description: Workflows to define the image build process + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowConfiguration' + EnhancedImageMetadataEnabled: + description: Collects additional information about the image being created, including the operating system (OS) version and package list. + type: boolean + ImageScanningConfiguration: + description: Contains settings for vulnerability scans. + $ref: '#/components/schemas/ImageScanningConfiguration' + ExecutionRole: + description: The execution role name/ARN for the image build, if provided + type: string + Tags: + description: The tags of this image pipeline. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + x-stackQL-stringOnly: true + x-title: CreateImagePipelineRequest + type: object + required: [] + CreateImageRecipeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the image recipe. + type: string + Name: + description: The name of the image recipe. + type: string + Description: + description: The description of the image recipe. + type: string + Version: + description: The version of the image recipe. + type: string + Components: + description: The components of the image recipe. + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/ComponentConfiguration' + BlockDeviceMappings: + description: The block device mappings to apply when creating images from this recipe. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/InstanceBlockDeviceMapping' + ParentImage: + description: The parent image of the image recipe. + type: string + WorkingDirectory: + description: The working directory to be used during build and test workflows. + type: string + AdditionalInstanceConfiguration: + description: Specify additional settings and launch scripts for your build instances. + $ref: '#/components/schemas/AdditionalInstanceConfiguration' + Tags: + description: The tags of the image recipe. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + x-stackQL-stringOnly: true + x-title: CreateImageRecipeRequest + type: object + required: [] + CreateInfrastructureConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the infrastructure configuration. + type: string + Name: + description: The name of the infrastructure configuration. + type: string + Description: + description: The description of the infrastructure configuration. + type: string + InstanceTypes: + description: The instance types of the infrastructure configuration. + type: array + x-insertionOrder: true + items: + type: string + SecurityGroupIds: + description: The security group IDs of the infrastructure configuration. + type: array + x-insertionOrder: false + items: + type: string + Logging: + description: The logging configuration of the infrastructure configuration. + $ref: '#/components/schemas/Logging' + SubnetId: + description: The subnet ID of the infrastructure configuration. + type: string + KeyPair: + description: The EC2 key pair of the infrastructure configuration.. + type: string + TerminateInstanceOnFailure: + description: The terminate instance on failure configuration of the infrastructure configuration. + type: boolean + InstanceProfileName: + description: The instance profile of the infrastructure configuration. + type: string + InstanceMetadataOptions: + description: The instance metadata option settings for the infrastructure configuration. + $ref: '#/components/schemas/InstanceMetadataOptions' + SnsTopicArn: + description: The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration. + type: string + ResourceTags: + description: The tags attached to the resource created by Image Builder. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + Tags: + description: The tags associated with the component. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + Placement: + description: The placement option settings for the infrastructure configuration. + $ref: '#/components/schemas/Placement' + x-stackQL-stringOnly: true + x-title: CreateInfrastructureConfigurationRequest + type: object + required: [] + CreateLifecyclePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the lifecycle policy. + type: string + Name: + description: The name of the lifecycle policy. + type: string + Description: + description: The description of the lifecycle policy. + type: string + Status: + description: The status of the lifecycle policy. + type: string + enum: + - DISABLED + - ENABLED + ExecutionRole: + description: The execution role of the lifecycle policy. + type: string + ResourceType: + description: The resource type of the lifecycle policy. + type: string + enum: + - AMI_IMAGE + - CONTAINER_IMAGE + PolicyDetails: + description: The policy details of the lifecycle policy. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/PolicyDetail' + ResourceSelection: + description: The resource selection of the lifecycle policy. + $ref: '#/components/schemas/ResourceSelection' + Tags: + description: The tags associated with the lifecycle policy. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + x-stackQL-stringOnly: true + x-title: CreateLifecyclePolicyRequest + type: object + required: [] + CreateWorkflowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the workflow. + type: string + Name: + description: The name of the workflow. + type: string + Version: + description: The version of the workflow. + type: string + Description: + description: The description of the workflow. + type: string + ChangeDescription: + description: The change description of the workflow. + type: string + Type: + description: The type of the workflow denotes whether the workflow is used to build, test, or distribute. + type: string + enum: + - BUILD + - TEST + - DISTRIBUTION + Data: + description: The data of the workflow. + type: string + minLength: 1 + maxLength: 16000 + Uri: + description: The uri of the workflow. + type: string + KmsKeyId: + description: The KMS key identifier used to encrypt the workflow. + type: string + Tags: + description: The tags associated with the workflow. + type: object + additionalProperties: false + x-patternProperties: + .{1,}: + type: string + x-stackQL-stringOnly: true + x-title: CreateWorkflowRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: components: name: components id: awscc.imagebuilder.components x-cfn-schema-name: Component - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' - AND region = 'us-east-1' - component: - name: component - id: awscc.imagebuilder.component - x-cfn-schema-name: Component - x-type: get + x-cfn-type-name: AWS::ImageBuilder::Component x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Component&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Component" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Component" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Component" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/components/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/components/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/components/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1445,7 +2649,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1466,13 +2670,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Component' AND data__Identifier = '' AND region = 'us-east-1' - container_recipes: - name: container_recipes - id: awscc.imagebuilder.container_recipes - x-cfn-schema-name: ContainerRecipe - x-type: list + components_list_only: + name: components_list_only + id: awscc.imagebuilder.components_list_only + x-cfn-schema-name: Component + x-cfn-type-name: AWS::ImageBuilder::Component x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1481,7 +2691,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1489,19 +2699,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' AND region = 'us-east-1' - container_recipe: - name: container_recipe - id: awscc.imagebuilder.container_recipe + container_recipes: + name: container_recipes + id: awscc.imagebuilder.container_recipes x-cfn-schema-name: ContainerRecipe - x-type: get + x-cfn-type-name: AWS::ImageBuilder::ContainerRecipe x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContainerRecipe&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ContainerRecipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ContainerRecipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ContainerRecipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/container_recipes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/container_recipes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/container_recipes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1526,7 +2784,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1550,13 +2808,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' AND data__Identifier = '' AND region = 'us-east-1' - distribution_configurations: - name: distribution_configurations - id: awscc.imagebuilder.distribution_configurations - x-cfn-schema-name: DistributionConfiguration - x-type: list + container_recipes_list_only: + name: container_recipes_list_only + id: awscc.imagebuilder.container_recipes_list_only + x-cfn-schema-name: ContainerRecipe + x-cfn-type-name: AWS::ImageBuilder::ContainerRecipe x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1565,7 +2829,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1573,19 +2837,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' AND region = 'us-east-1' - distribution_configuration: - name: distribution_configuration - id: awscc.imagebuilder.distribution_configuration + distribution_configurations: + name: distribution_configurations + id: awscc.imagebuilder.distribution_configurations x-cfn-schema-name: DistributionConfiguration - x-type: get + x-cfn-type-name: AWS::ImageBuilder::DistributionConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DistributionConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::DistributionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::DistributionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::DistributionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1599,7 +2911,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1612,13 +2924,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - images: - name: images - id: awscc.imagebuilder.images - x-cfn-schema-name: Image - x-type: list + distribution_configurations_list_only: + name: distribution_configurations_list_only + id: awscc.imagebuilder.distribution_configurations_list_only + x-cfn-schema-name: DistributionConfiguration + x-cfn-type-name: AWS::ImageBuilder::DistributionConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1627,7 +2945,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1635,70 +2953,124 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' AND region = 'us-east-1' - image: - name: image - id: awscc.imagebuilder.image + images: + name: images + id: awscc.imagebuilder.images x-cfn-schema-name: Image - x-type: get + x-cfn-type-name: AWS::ImageBuilder::Image x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Image&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Image" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Image" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Image" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/images/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/images/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/images/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ImageScanningConfiguration') as image_scanning_configuration, + JSON_EXTRACT(Properties, '$.ContainerRecipeArn') as container_recipe_arn, + JSON_EXTRACT(Properties, '$.Workflows') as workflows, + JSON_EXTRACT(Properties, '$.ImageUri') as image_uri, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ImageTestsConfiguration') as image_tests_configuration, + JSON_EXTRACT(Properties, '$.InfrastructureConfigurationArn') as infrastructure_configuration_arn, JSON_EXTRACT(Properties, '$.ImageRecipeArn') as image_recipe_arn, - JSON_EXTRACT(Properties, '$.ContainerRecipeArn') as container_recipe_arn, JSON_EXTRACT(Properties, '$.DistributionConfigurationArn') as distribution_configuration_arn, - JSON_EXTRACT(Properties, '$.InfrastructureConfigurationArn') as infrastructure_configuration_arn, - JSON_EXTRACT(Properties, '$.Workflows') as workflows, JSON_EXTRACT(Properties, '$.ImageId') as image_id, - JSON_EXTRACT(Properties, '$.ImageUri') as image_uri, + JSON_EXTRACT(Properties, '$.ImageTestsConfiguration') as image_tests_configuration, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.EnhancedImageMetadataEnabled') as enhanced_image_metadata_enabled, - JSON_EXTRACT(Properties, '$.ImageScanningConfiguration') as image_scanning_configuration, JSON_EXTRACT(Properties, '$.ExecutionRole') as execution_role, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Image' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, + json_extract_path_text(Properties, 'ContainerRecipeArn') as container_recipe_arn, + json_extract_path_text(Properties, 'Workflows') as workflows, + json_extract_path_text(Properties, 'ImageUri') as image_uri, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ImageTestsConfiguration') as image_tests_configuration, + json_extract_path_text(Properties, 'InfrastructureConfigurationArn') as infrastructure_configuration_arn, json_extract_path_text(Properties, 'ImageRecipeArn') as image_recipe_arn, - json_extract_path_text(Properties, 'ContainerRecipeArn') as container_recipe_arn, json_extract_path_text(Properties, 'DistributionConfigurationArn') as distribution_configuration_arn, - json_extract_path_text(Properties, 'InfrastructureConfigurationArn') as infrastructure_configuration_arn, - json_extract_path_text(Properties, 'Workflows') as workflows, json_extract_path_text(Properties, 'ImageId') as image_id, - json_extract_path_text(Properties, 'ImageUri') as image_uri, + json_extract_path_text(Properties, 'ImageTestsConfiguration') as image_tests_configuration, + json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'EnhancedImageMetadataEnabled') as enhanced_image_metadata_enabled, - json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, json_extract_path_text(Properties, 'ExecutionRole') as execution_role, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Image' AND data__Identifier = '' AND region = 'us-east-1' - image_pipelines: - name: image_pipelines - id: awscc.imagebuilder.image_pipelines - x-cfn-schema-name: ImagePipeline - x-type: list + images_list_only: + name: images_list_only + id: awscc.imagebuilder.images_list_only + x-cfn-schema-name: Image + x-cfn-type-name: AWS::ImageBuilder::Image x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1707,7 +3079,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1715,19 +3087,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' AND region = 'us-east-1' - image_pipeline: - name: image_pipeline - id: awscc.imagebuilder.image_pipeline + image_pipelines: + name: image_pipelines + id: awscc.imagebuilder.image_pipelines x-cfn-schema-name: ImagePipeline - x-type: get + x-cfn-type-name: AWS::ImageBuilder::ImagePipeline x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ImagePipeline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ImagePipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ImagePipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ImagePipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1751,7 +3171,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1774,13 +3194,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' AND data__Identifier = '' AND region = 'us-east-1' - image_recipes: - name: image_recipes - id: awscc.imagebuilder.image_recipes - x-cfn-schema-name: ImageRecipe - x-type: list + image_pipelines_list_only: + name: image_pipelines_list_only + id: awscc.imagebuilder.image_pipelines_list_only + x-cfn-schema-name: ImagePipeline + x-cfn-type-name: AWS::ImageBuilder::ImagePipeline x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1789,7 +3215,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1797,19 +3223,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' AND region = 'us-east-1' - image_recipe: - name: image_recipe - id: awscc.imagebuilder.image_recipe + image_recipes: + name: image_recipes + id: awscc.imagebuilder.image_recipes x-cfn-schema-name: ImageRecipe - x-type: get + x-cfn-type-name: AWS::ImageBuilder::ImageRecipe x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ImageRecipe&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ImageRecipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ImageRecipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::ImageRecipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/image_recipes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/image_recipes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/image_recipes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1828,7 +3302,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1846,13 +3320,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' AND data__Identifier = '' AND region = 'us-east-1' - infrastructure_configurations: - name: infrastructure_configurations - id: awscc.imagebuilder.infrastructure_configurations - x-cfn-schema-name: InfrastructureConfiguration - x-type: list + image_recipes_list_only: + name: image_recipes_list_only + id: awscc.imagebuilder.image_recipes_list_only + x-cfn-schema-name: ImageRecipe + x-cfn-type-name: AWS::ImageBuilder::ImageRecipe x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1861,7 +3341,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1869,19 +3349,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' AND region = 'us-east-1' - infrastructure_configuration: - name: infrastructure_configuration - id: awscc.imagebuilder.infrastructure_configuration + infrastructure_configurations: + name: infrastructure_configurations + id: awscc.imagebuilder.infrastructure_configurations x-cfn-schema-name: InfrastructureConfiguration - x-type: get + x-cfn-type-name: AWS::ImageBuilder::InfrastructureConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InfrastructureConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::InfrastructureConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::InfrastructureConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::InfrastructureConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1899,12 +3427,13 @@ components: JSON_EXTRACT(Properties, '$.InstanceMetadataOptions') as instance_metadata_options, JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, JSON_EXTRACT(Properties, '$.ResourceTags') as resource_tags, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Placement') as placement FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1922,17 +3451,24 @@ components: json_extract_path_text(Properties, 'InstanceMetadataOptions') as instance_metadata_options, json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, json_extract_path_text(Properties, 'ResourceTags') as resource_tags, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Placement') as placement FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - lifecycle_policies: - name: lifecycle_policies - id: awscc.imagebuilder.lifecycle_policies - x-cfn-schema-name: LifecyclePolicy - x-type: list + infrastructure_configurations_list_only: + name: infrastructure_configurations_list_only + id: awscc.imagebuilder.infrastructure_configurations_list_only + x-cfn-schema-name: InfrastructureConfiguration + x-cfn-type-name: AWS::ImageBuilder::InfrastructureConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1941,7 +3477,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1949,19 +3485,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' AND region = 'us-east-1' - lifecycle_policy: - name: lifecycle_policy - id: awscc.imagebuilder.lifecycle_policy + lifecycle_policies: + name: lifecycle_policies + id: awscc.imagebuilder.lifecycle_policies x-cfn-schema-name: LifecyclePolicy - x-type: get + x-cfn-type-name: AWS::ImageBuilder::LifecyclePolicy x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LifecyclePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::LifecyclePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::LifecyclePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::LifecyclePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1979,7 +3563,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1996,13 +3580,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' AND data__Identifier = '' AND region = 'us-east-1' - workflows: - name: workflows - id: awscc.imagebuilder.workflows - x-cfn-schema-name: Workflow - x-type: list + lifecycle_policies_list_only: + name: lifecycle_policies_list_only + id: awscc.imagebuilder.lifecycle_policies_list_only + x-cfn-schema-name: LifecyclePolicy + x-cfn-type-name: AWS::ImageBuilder::LifecyclePolicy x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2011,7 +3601,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2019,19 +3609,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' AND region = 'us-east-1' - workflow: - name: workflow - id: awscc.imagebuilder.workflow + workflows: + name: workflows + id: awscc.imagebuilder.workflows x-cfn-schema-name: Workflow - x-type: get + x-cfn-type-name: AWS::ImageBuilder::Workflow x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ImageBuilder::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2050,7 +3688,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2068,3 +3706,565 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' AND data__Identifier = '' AND region = 'us-east-1' + workflows_list_only: + name: workflows_list_only + id: awscc.imagebuilder.workflows_list_only + x-cfn-schema-name: Workflow + x-cfn-type-name: AWS::ImageBuilder::Workflow + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Component&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComponent + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComponentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContainerRecipe&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContainerRecipe + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContainerRecipeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DistributionConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDistributionConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDistributionConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Image&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateImage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateImageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ImagePipeline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateImagePipeline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateImagePipelineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ImageRecipe&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateImageRecipe + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateImageRecipeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InfrastructureConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInfrastructureConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInfrastructureConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LifecyclePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLifecyclePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLifecyclePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkflow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkflowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/inspector.yaml b/providers/src/awscc/v00.00.00000/services/inspector.yaml index df415e0d..443d667b 100644 --- a/providers/src/awscc/v00.00.00000/services/inspector.yaml +++ b/providers/src/awscc/v00.00.00000/services/inspector.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Inspector - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AssessmentTarget: type: object @@ -15,7 +395,9 @@ components: ResourceGroupArn: type: string x-stackql-resource-name: assessment_target - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Inspector::AssessmentTarget + x-type-name: AWS::Inspector::AssessmentTarget + x-stackql-primary-identifier: - Arn x-create-only-properties: - AssessmentTargetName @@ -72,7 +454,9 @@ components: - DurationInSeconds - RulesPackageArns x-stackql-resource-name: assessment_template - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Inspector::AssessmentTemplate + x-type-name: AWS::Inspector::AssessmentTemplate + x-stackql-primary-identifier: - Arn x-create-only-properties: - DurationInSeconds @@ -82,6 +466,10 @@ components: - RulesPackageArns x-read-only-properties: - Arn + x-required-properties: + - AssessmentTargetArn + - DurationInSeconds + - RulesPackageArns x-required-permissions: create: - inspector:CreateAssessmentTemplate @@ -106,12 +494,16 @@ components: required: - ResourceGroupTags x-stackql-resource-name: resource_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Inspector::ResourceGroup + x-type-name: AWS::Inspector::ResourceGroup + x-stackql-primary-identifier: - Arn x-create-only-properties: - ResourceGroupTags x-read-only-properties: - Arn + x-required-properties: + - ResourceGroupTags x-required-permissions: create: - inspector:CreateResourceGroup @@ -119,43 +511,155 @@ components: - inspector:CreateResourceGroup delete: - inspector:CreateResourceGroup + CreateAssessmentTargetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + AssessmentTargetName: + type: string + ResourceGroupArn: + type: string + x-stackQL-stringOnly: true + x-title: CreateAssessmentTargetRequest + type: object + required: [] + CreateAssessmentTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + AssessmentTargetArn: + type: string + DurationInSeconds: + type: integer + AssessmentTemplateName: + type: string + RulesPackageArns: + type: array + uniqueItems: false + items: + type: string + UserAttributesForFindings: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAssessmentTemplateRequest + type: object + required: [] + CreateResourceGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + ResourceGroupTags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateResourceGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: assessment_targets: name: assessment_targets id: awscc.inspector.assessment_targets x-cfn-schema-name: AssessmentTarget - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' - AND region = 'us-east-1' - assessment_target: - name: assessment_target - id: awscc.inspector.assessment_target - x-cfn-schema-name: AssessmentTarget - x-type: get + x-cfn-type-name: AWS::Inspector::AssessmentTarget x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AssessmentTarget&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::AssessmentTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::AssessmentTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::AssessmentTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -167,7 +671,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -178,13 +682,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' AND data__Identifier = '' AND region = 'us-east-1' - assessment_templates: - name: assessment_templates - id: awscc.inspector.assessment_templates - x-cfn-schema-name: AssessmentTemplate - x-type: list + assessment_targets_list_only: + name: assessment_targets_list_only + id: awscc.inspector.assessment_targets_list_only + x-cfn-schema-name: AssessmentTarget + x-cfn-type-name: AWS::Inspector::AssessmentTarget x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -193,7 +703,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -201,19 +711,54 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' AND region = 'us-east-1' - assessment_template: - name: assessment_template - id: awscc.inspector.assessment_template + assessment_templates: + name: assessment_templates + id: awscc.inspector.assessment_templates x-cfn-schema-name: AssessmentTemplate - x-type: get + x-cfn-type-name: AWS::Inspector::AssessmentTemplate x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AssessmentTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::AssessmentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::AssessmentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assessment_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assessment_templates/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -228,7 +773,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -242,17 +787,83 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' AND data__Identifier = '' AND region = 'us-east-1' - resource_group: - name: resource_group - id: awscc.inspector.resource_group - x-cfn-schema-name: ResourceGroup - x-type: get + assessment_templates_list_only: + name: assessment_templates_list_only + id: awscc.inspector.assessment_templates_list_only + x-cfn-schema-name: AssessmentTemplate + x-cfn-type-name: AWS::Inspector::AssessmentTemplate x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' + AND region = 'us-east-1' + resource_groups: + name: resource_groups + id: awscc.inspector.resource_groups + x-cfn-schema-name: ResourceGroup + x-cfn-type-name: AWS::Inspector::ResourceGroup + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::ResourceGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Inspector::ResourceGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_groups/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -263,7 +874,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -273,3 +884,282 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::ResourceGroup' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AssessmentTarget&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssessmentTarget + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssessmentTargetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AssessmentTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssessmentTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssessmentTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/inspectorv2.yaml b/providers/src/awscc/v00.00.00000/services/inspectorv2.yaml index 96c8e46e..fc75b2fe 100644 --- a/providers/src/awscc/v00.00.00000/services/inspectorv2.yaml +++ b/providers/src/awscc/v00.00.00000/services/inspectorv2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: InspectorV2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: CisSecurityLevel: type: string @@ -90,13 +470,14 @@ components: maxItems: 10000 items: type: string - pattern: ^\d{12}|ALL_MEMBERS|SELF$ + pattern: ^\d{12}|ALL_ACCOUNTS|SELF$ uniqueItems: true TargetResourceTags: $ref: '#/components/schemas/TargetResourceTags' additionalProperties: false required: - AccountIds + - TargetResourceTags TargetResourceTags: x-patternProperties: ^.+$: @@ -135,11 +516,32 @@ components: description: CIS Scan configuration unique identifier Tags: $ref: '#/components/schemas/CisTagMap' + required: + - ScanName + - SecurityLevel + - Schedule + - Targets x-stackql-resource-name: cis_scan_configuration - x-stackql-primaryIdentifier: + description: CIS Scan Configuration resource schema + x-type-name: AWS::InspectorV2::CisScanConfiguration + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-required-properties: + - ScanName + - SecurityLevel + - Schedule + - Targets + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - inspector2:TagResource + - inspector2:UntagResource x-required-permissions: create: - inspector2:CreateCisScanConfiguration @@ -161,6 +563,297 @@ components: list: - inspector2:ListCisScanConfigurations - inspector2:ListTagsForResource + TagMap: + type: object + x-patternProperties: + ^.{2,127}$: + type: string + pattern: ^.{1,255}$ + additionalProperties: false + IntegrationType: + type: string + enum: + - GITLAB_SELF_MANAGED + - GITHUB + IntegrationStatus: + type: string + enum: + - PENDING + - IN_PROGRESS + - ACTIVE + - INACTIVE + - DISABLING + CreateGitLabSelfManagedIntegrationDetail: + type: object + required: + - instanceUrl + - accessToken + properties: + instanceUrl: + type: string + pattern: ^https://[-a-zA-Z0-9()@:%_+.~#?&//=]{1,1024}$ + accessToken: + type: string + additionalProperties: false + CreateDetails: + type: object + properties: + gitlabSelfManaged: + $ref: '#/components/schemas/CreateGitLabSelfManagedIntegrationDetail' + required: + - gitlabSelfManaged + additionalProperties: false + UpdateGitLabSelfManagedIntegrationDetail: + type: object + required: + - authCode + properties: + authCode: + type: string + minLength: 1 + maxLength: 1024 + additionalProperties: false + UpdateGitHubIntegrationDetail: + type: object + required: + - code + - installationId + properties: + code: + type: string + minLength: 1 + maxLength: 1024 + installationId: + type: string + minLength: 1 + maxLength: 1024 + additionalProperties: false + UpdateDetails: + type: object + properties: + gitlabSelfManaged: + $ref: '#/components/schemas/UpdateGitLabSelfManagedIntegrationDetail' + github: + $ref: '#/components/schemas/UpdateGitHubIntegrationDetail' + additionalProperties: false + oneOf: + - required: + - gitlabSelfManaged + - required: + - github + CodeSecurityIntegration: + type: object + properties: + Name: + description: Code Security Integration name + type: string + maxLength: 60 + minLength: 1 + pattern: ^[a-zA-Z0-9-_$:.]*$ + Type: + description: Integration Type + $ref: '#/components/schemas/IntegrationType' + CreateIntegrationDetails: + description: Create Integration Details + $ref: '#/components/schemas/CreateDetails' + UpdateIntegrationDetails: + description: Update Integration Details + $ref: '#/components/schemas/UpdateDetails' + Status: + description: Integration Status + $ref: '#/components/schemas/IntegrationStatus' + StatusReason: + description: Reason for the current status + type: string + Arn: + description: Code Security Integration ARN + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:codesecurity-integration/[a-f0-9-]{36}$ + AuthorizationUrl: + description: Authorization URL for OAuth flow + type: string + pattern: ^https://[-a-zA-Z0-9()@:%_+.~#?&//=]{1,1024}$ + CreatedAt: + description: Creation timestamp + type: string + format: date-time + LastUpdatedAt: + description: Last update timestamp + type: string + format: date-time + Tags: + $ref: '#/components/schemas/TagMap' + x-stackql-resource-name: code_security_integration + description: Inspector CodeSecurityIntegration resource schema + x-type-name: AWS::InspectorV2::CodeSecurityIntegration + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - CreateIntegrationDetails + - Tags + x-write-only-properties: + - CreateIntegrationDetails + - UpdateIntegrationDetails + x-read-only-properties: + - Arn + - Status + - StatusReason + - AuthorizationUrl + - CreatedAt + - LastUpdatedAt + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - inspector2:TagResource + - inspector2:UntagResource + x-required-permissions: + create: + - inspector2:CreateCodeSecurityIntegration + - inspector2:GetCodeSecurityIntegration + - inspector2:TagResource + read: + - inspector2:GetCodeSecurityIntegration + - inspector2:ListTagsForResource + update: + - inspector2:UpdateCodeSecurityIntegration + - inspector2:GetCodeSecurityIntegration + - inspector2:ListTagsForResource + - inspector2:TagResource + - inspector2:UntagResource + delete: + - inspector2:DeleteCodeSecurityIntegration + - inspector2:GetCodeSecurityIntegration + list: + - inspector2:ListCodeSecurityIntegrations + ConfigurationLevel: + type: string + enum: + - ORGANIZATION + - ACCOUNT + PeriodicScanFrequency: + type: string + enum: + - WEEKLY + - MONTHLY + - NEVER + ContinuousIntegrationScanEvent: + type: string + enum: + - PULL_REQUEST + - PUSH + RuleSetCategory: + type: string + enum: + - SAST + - IAC + - SCA + ProjectSelectionScope: + type: string + enum: + - ALL + PeriodicScanConfiguration: + type: object + properties: + frequency: + $ref: '#/components/schemas/PeriodicScanFrequency' + frequencyExpression: + type: string + maxLength: 256 + minLength: 1 + additionalProperties: false + ContinuousIntegrationScanConfiguration: + type: object + required: + - supportedEvents + properties: + supportedEvents: + type: array + items: + $ref: '#/components/schemas/ContinuousIntegrationScanEvent' + minItems: 1 + maxItems: 2 + additionalProperties: false + ScopeSettings: + type: object + properties: + projectSelectionScope: + $ref: '#/components/schemas/ProjectSelectionScope' + additionalProperties: false + CodeSecurityScanConfiguration: + type: object + properties: + Name: + description: Code Security Scan Configuration name + type: string + maxLength: 60 + minLength: 1 + pattern: ^[a-zA-Z0-9-_$:.]*$ + Level: + description: Configuration Level + $ref: '#/components/schemas/ConfigurationLevel' + Configuration: + description: Code Security Scan Configuration + $ref: '#/components/schemas/CodeSecurityScanConfiguration' + ScopeSettings: + description: Scope Settings + $ref: '#/components/schemas/ScopeSettings' + Arn: + description: Code Security Scan Configuration ARN + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/codesecurity-configuration/[a-f0-9-]{36}$ + Tags: + $ref: '#/components/schemas/TagMap' + x-stackql-resource-name: code_security_scan_configuration + description: Inspector CodeSecurityScanConfiguration resource schema + x-type-name: AWS::InspectorV2::CodeSecurityScanConfiguration + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - ScopeSettings + - Level + - Tags + x-read-only-properties: + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - inspector2:TagResource + - inspector2:UntagResource + x-required-permissions: + create: + - inspector2:CreateCodeSecurityScanConfiguration + - inspector2:GetCodeSecurityScanConfiguration + - inspector2:TagResource + read: + - inspector2:GetCodeSecurityScanConfiguration + - inspector2:ListTagsForResource + update: + - inspector2:UpdateCodeSecurityScanConfiguration + - inspector2:GetCodeSecurityScanConfiguration + - inspector2:TagResource + - inspector2:UntagResource + - inspector2:ListTagsForResource + delete: + - inspector2:DeleteCodeSecurityScanConfiguration + - inspector2:GetCodeSecurityScanConfiguration + list: + - inspector2:ListCodeSecurityScanConfigurations + FilterTagMap: + type: object + x-patternProperties: + ^.{2,127}$: + type: string + pattern: ^.{1,255}$ + additionalProperties: false StringComparison: type: string enum: @@ -272,10 +965,14 @@ components: $ref: '#/components/schemas/StringFilter' Epoch: $ref: '#/components/schemas/NumberFilter' + FilePath: + $ref: '#/components/schemas/StringFilter' Name: $ref: '#/components/schemas/StringFilter' Release: $ref: '#/components/schemas/StringFilter' + SourceLambdaLayerArn: + $ref: '#/components/schemas/StringFilter' SourceLayerHash: $ref: '#/components/schemas/StringFilter' Version: @@ -293,6 +990,12 @@ components: properties: AwsAccountId: $ref: '#/components/schemas/StringFilterList' + CodeVulnerabilityDetectorName: + $ref: '#/components/schemas/StringFilterList' + CodeVulnerabilityDetectorTags: + $ref: '#/components/schemas/StringFilterList' + CodeVulnerabilityFilePath: + $ref: '#/components/schemas/StringFilterList' ComponentId: $ref: '#/components/schemas/StringFilterList' ComponentType: @@ -307,14 +1010,18 @@ components: $ref: '#/components/schemas/StringFilterList' EcrImageHash: $ref: '#/components/schemas/StringFilterList' - EcrImageTags: - $ref: '#/components/schemas/StringFilterList' EcrImagePushedAt: $ref: '#/components/schemas/DateFilterList' EcrImageRegistry: $ref: '#/components/schemas/StringFilterList' EcrImageRepositoryName: $ref: '#/components/schemas/StringFilterList' + EcrImageTags: + $ref: '#/components/schemas/StringFilterList' + EpssScore: + $ref: '#/components/schemas/NumberFilterList' + ExploitAvailable: + $ref: '#/components/schemas/StringFilterList' FindingArn: $ref: '#/components/schemas/StringFilterList' FindingStatus: @@ -323,8 +1030,20 @@ components: $ref: '#/components/schemas/StringFilterList' FirstObservedAt: $ref: '#/components/schemas/DateFilterList' + FixAvailable: + $ref: '#/components/schemas/StringFilterList' InspectorScore: $ref: '#/components/schemas/NumberFilterList' + LambdaFunctionExecutionRoleArn: + $ref: '#/components/schemas/StringFilterList' + LambdaFunctionLastModifiedAt: + $ref: '#/components/schemas/DateFilterList' + LambdaFunctionLayers: + $ref: '#/components/schemas/StringFilterList' + LambdaFunctionName: + $ref: '#/components/schemas/StringFilterList' + LambdaFunctionRuntime: + $ref: '#/components/schemas/StringFilterList' LastObservedAt: $ref: '#/components/schemas/DateFilterList' NetworkProtocol: @@ -390,37 +1109,325 @@ components: type: string maxLength: 128 minLength: 1 + Tags: + $ref: '#/components/schemas/FilterTagMap' required: - Name - FilterCriteria - FilterAction x-stackql-resource-name: filter - x-stackql-primaryIdentifier: + description: Inspector Filter resource schema + x-type-name: AWS::InspectorV2::Filter + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-required-properties: + - Name + - FilterCriteria + - FilterAction + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - inspector2:TagResource + - inspector2:UntagResource x-required-permissions: create: - inspector2:CreateFilter - inspector2:ListFilters + - inspector2:TagResource read: - inspector2:ListFilters + - inspector2:ListTagsForResource update: - inspector2:ListFilters - inspector2:UpdateFilter + - inspector2:TagResource + - inspector2:UntagResource + - inspector2:ListTagsForResource delete: - inspector2:DeleteFilter - inspector2:ListFilters list: - inspector2:ListFilters + CreateCisScanConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScanName: + description: Name of the scan + type: string + minLength: 1 + SecurityLevel: + $ref: '#/components/schemas/CisSecurityLevel' + Schedule: + $ref: '#/components/schemas/Schedule' + Targets: + $ref: '#/components/schemas/CisTargets' + Arn: + type: string + description: CIS Scan configuration unique identifier + Tags: + $ref: '#/components/schemas/CisTagMap' + x-stackQL-stringOnly: true + x-title: CreateCisScanConfigurationRequest + type: object + required: [] + CreateCodeSecurityIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Code Security Integration name + type: string + maxLength: 60 + minLength: 1 + pattern: ^[a-zA-Z0-9-_$:.]*$ + Type: + description: Integration Type + $ref: '#/components/schemas/IntegrationType' + CreateIntegrationDetails: + description: Create Integration Details + $ref: '#/components/schemas/CreateDetails' + UpdateIntegrationDetails: + description: Update Integration Details + $ref: '#/components/schemas/UpdateDetails' + Status: + description: Integration Status + $ref: '#/components/schemas/IntegrationStatus' + StatusReason: + description: Reason for the current status + type: string + Arn: + description: Code Security Integration ARN + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:codesecurity-integration/[a-f0-9-]{36}$ + AuthorizationUrl: + description: Authorization URL for OAuth flow + type: string + pattern: ^https://[-a-zA-Z0-9()@:%_+.~#?&//=]{1,1024}$ + CreatedAt: + description: Creation timestamp + type: string + format: date-time + LastUpdatedAt: + description: Last update timestamp + type: string + format: date-time + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateCodeSecurityIntegrationRequest + type: object + required: [] + CreateCodeSecurityScanConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Code Security Scan Configuration name + type: string + maxLength: 60 + minLength: 1 + pattern: ^[a-zA-Z0-9-_$:.]*$ + Level: + description: Configuration Level + $ref: '#/components/schemas/ConfigurationLevel' + Configuration: + description: Code Security Scan Configuration + $ref: '#/components/schemas/CodeSecurityScanConfiguration' + ScopeSettings: + description: Scope Settings + $ref: '#/components/schemas/ScopeSettings' + Arn: + description: Code Security Scan Configuration ARN + type: string + pattern: ^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/codesecurity-configuration/[a-f0-9-]{36}$ + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateCodeSecurityScanConfigurationRequest + type: object + required: [] + CreateFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Findings filter name. + type: string + maxLength: 128 + minLength: 1 + Description: + description: Findings filter description. + type: string + maxLength: 512 + minLength: 1 + FilterCriteria: + description: Findings filter criteria. + $ref: '#/components/schemas/FilterCriteria' + FilterAction: + description: Findings filter action. + $ref: '#/components/schemas/FilterAction' + Arn: + description: Findings filter ARN. + type: string + maxLength: 128 + minLength: 1 + Tags: + $ref: '#/components/schemas/FilterTagMap' + x-stackQL-stringOnly: true + x-title: CreateFilterRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: cis_scan_configurations: name: cis_scan_configurations id: awscc.inspectorv2.cis_scan_configurations x-cfn-schema-name: CisScanConfiguration - x-type: list + x-cfn-type-name: AWS::InspectorV2::CisScanConfiguration + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CisScanConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CisScanConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CisScanConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CisScanConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ScanName') as scan_name, + JSON_EXTRACT(Properties, '$.SecurityLevel') as security_level, + JSON_EXTRACT(Properties, '$.Schedule') as schedule, + JSON_EXTRACT(Properties, '$.Targets') as targets, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScanName') as scan_name, + json_extract_path_text(Properties, 'SecurityLevel') as security_level, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + cis_scan_configurations_list_only: + name: cis_scan_configurations_list_only + id: awscc.inspectorv2.cis_scan_configurations_list_only + x-cfn-schema-name: CisScanConfiguration + x-cfn-type-name: AWS::InspectorV2::CisScanConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -439,52 +1446,234 @@ components: json_extract_path_text(Properties, 'Arn') as arn FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' AND region = 'us-east-1' - cis_scan_configuration: - name: cis_scan_configuration - id: awscc.inspectorv2.cis_scan_configuration - x-cfn-schema-name: CisScanConfiguration - x-type: get + code_security_integrations: + name: code_security_integrations + id: awscc.inspectorv2.code_security_integrations + x-cfn-schema-name: CodeSecurityIntegration + x-cfn-type-name: AWS::InspectorV2::CodeSecurityIntegration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CodeSecurityIntegration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CodeSecurityIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CodeSecurityIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CodeSecurityIntegration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/code_security_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/code_security_integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/code_security_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ScanName') as scan_name, - JSON_EXTRACT(Properties, '$.SecurityLevel') as security_level, - JSON_EXTRACT(Properties, '$.Schedule') as schedule, - JSON_EXTRACT(Properties, '$.Targets') as targets, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.CreateIntegrationDetails') as create_integration_details, + JSON_EXTRACT(Properties, '$.UpdateIntegrationDetails') as update_integration_details, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusReason') as status_reason, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AuthorizationUrl') as authorization_url, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityIntegration' AND data__Identifier = '' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'CreateIntegrationDetails') as create_integration_details, + json_extract_path_text(Properties, 'UpdateIntegrationDetails') as update_integration_details, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthorizationUrl') as authorization_url, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityIntegration' + AND data__Identifier = '' + AND region = 'us-east-1' + code_security_integrations_list_only: + name: code_security_integrations_list_only + id: awscc.inspectorv2.code_security_integrations_list_only + x-cfn-schema-name: CodeSecurityIntegration + x-cfn-type-name: AWS::InspectorV2::CodeSecurityIntegration + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityIntegration' + AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityIntegration' + AND region = 'us-east-1' + code_security_scan_configurations: + name: code_security_scan_configurations + id: awscc.inspectorv2.code_security_scan_configurations + x-cfn-schema-name: CodeSecurityScanConfiguration + x-cfn-type-name: AWS::InspectorV2::CodeSecurityScanConfiguration + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CodeSecurityScanConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CodeSecurityScanConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CodeSecurityScanConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::CodeSecurityScanConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/code_security_scan_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/code_security_scan_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/code_security_scan_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Level') as level, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.ScopeSettings') as scope_settings, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityScanConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ScanName') as scan_name, - json_extract_path_text(Properties, 'SecurityLevel') as security_level, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Level') as level, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'ScopeSettings') as scope_settings, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityScanConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - filters: - name: filters - id: awscc.inspectorv2.filters - x-cfn-schema-name: Filter - x-type: list + code_security_scan_configurations_list_only: + name: code_security_scan_configurations_list_only + id: awscc.inspectorv2.code_security_scan_configurations_list_only + x-cfn-schema-name: CodeSecurityScanConfiguration + x-cfn-type-name: AWS::InspectorV2::CodeSecurityScanConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -493,7 +1682,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityScanConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -501,19 +1690,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CodeSecurityScanConfiguration' AND region = 'us-east-1' - filter: - name: filter - id: awscc.inspectorv2.filter + filters: + name: filters + id: awscc.inspectorv2.filters x-cfn-schema-name: Filter - x-type: get + x-cfn-type-name: AWS::InspectorV2::Filter x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Filter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::Filter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::Filter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InspectorV2::Filter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/filters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -522,12 +1759,13 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.FilterCriteria') as filter_criteria, JSON_EXTRACT(Properties, '$.FilterAction') as filter_action, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::Filter' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -536,7 +1774,360 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'FilterCriteria') as filter_criteria, json_extract_path_text(Properties, 'FilterAction') as filter_action, - json_extract_path_text(Properties, 'Arn') as arn + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::Filter' AND data__Identifier = '' AND region = 'us-east-1' + filters_list_only: + name: filters_list_only + id: awscc.inspectorv2.filters_list_only + x-cfn-schema-name: Filter + x-cfn-type-name: AWS::InspectorV2::Filter + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CisScanConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCisScanConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCisScanConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CodeSecurityIntegration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCodeSecurityIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCodeSecurityIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CodeSecurityScanConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCodeSecurityScanConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCodeSecurityScanConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Filter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/internetmonitor.yaml b/providers/src/awscc/v00.00.00000/services/internetmonitor.yaml index f57e1c1d..871ef9bb 100644 --- a/providers/src/awscc/v00.00.00000/services/internetmonitor.yaml +++ b/providers/src/awscc/v00.00.00000/services/internetmonitor.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: InternetMonitor - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: MonitorConfigState: type: string @@ -104,6 +484,13 @@ components: maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_.-]+$ + LinkedAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^(\d{12})$ + IncludeLinkedAccounts: + type: boolean ProcessingStatus: $ref: '#/components/schemas/MonitorProcessingStatusCode' ProcessingStatusInfo: @@ -152,16 +539,35 @@ components: required: - MonitorName x-stackql-resource-name: monitor - x-stackql-primaryIdentifier: + description: Represents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application + x-type-name: AWS::InternetMonitor::Monitor + x-stackql-primary-identifier: - MonitorName x-create-only-properties: - MonitorName + x-write-only-properties: + - ResourcesToAdd + - ResourcesToRemove + - LinkedAccountId + - IncludeLinkedAccounts x-read-only-properties: - CreatedAt - ModifiedAt - MonitorArn - ProcessingStatus - ProcessingStatusInfo + x-required-properties: + - MonitorName + x-tagging: + taggable: true + tagOnCreate: false + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - internetmonitor:TagResource + - internetmonitor:UntagResource + - internetmonitor:ListTagsForResource x-required-permissions: create: - internetmonitor:CreateMonitor @@ -201,44 +607,158 @@ components: list: - internetmonitor:ListMonitors - internetmonitor:GetMonitor + - internetmonitor:ListTagsForResource - logs:GetLogDelivery + CreateMonitorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedAt: + $ref: '#/components/schemas/iso8601UTC' + ModifiedAt: + $ref: '#/components/schemas/iso8601UTC' + MonitorArn: + type: string + maxLength: 512 + minLength: 20 + pattern: ^arn:.* + MonitorName: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + LinkedAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^(\d{12})$ + IncludeLinkedAccounts: + type: boolean + ProcessingStatus: + $ref: '#/components/schemas/MonitorProcessingStatusCode' + ProcessingStatusInfo: + type: string + Resources: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:.* + ResourcesToAdd: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 2048 + minLength: 20 + ResourcesToRemove: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 2048 + minLength: 20 + Status: + $ref: '#/components/schemas/MonitorConfigState' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + MaxCityNetworksToMonitor: + type: integer + minimum: 1 + maximum: 500000 + TrafficPercentageToMonitor: + type: integer + minimum: 1 + maximum: 100 + InternetMeasurementsLogDelivery: + $ref: '#/components/schemas/InternetMeasurementsLogDelivery' + HealthEventsConfig: + $ref: '#/components/schemas/HealthEventsConfig' + x-stackQL-stringOnly: true + x-title: CreateMonitorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: monitors: name: monitors id: awscc.internetmonitor.monitors x-cfn-schema-name: Monitor - x-type: list - x-identifiers: - - MonitorName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MonitorName') as monitor_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MonitorName') as monitor_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' - AND region = 'us-east-1' - monitor: - name: monitor - id: awscc.internetmonitor.monitor - x-cfn-schema-name: Monitor - x-type: get + x-cfn-type-name: AWS::InternetMonitor::Monitor x-identifiers: - MonitorName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Monitor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InternetMonitor::Monitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InternetMonitor::Monitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::InternetMonitor::Monitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/monitors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/monitors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -247,6 +767,8 @@ components: JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, JSON_EXTRACT(Properties, '$.MonitorArn') as monitor_arn, JSON_EXTRACT(Properties, '$.MonitorName') as monitor_name, + JSON_EXTRACT(Properties, '$.LinkedAccountId') as linked_account_id, + JSON_EXTRACT(Properties, '$.IncludeLinkedAccounts') as include_linked_accounts, JSON_EXTRACT(Properties, '$.ProcessingStatus') as processing_status, JSON_EXTRACT(Properties, '$.ProcessingStatusInfo') as processing_status_info, JSON_EXTRACT(Properties, '$.Resources') as resources, @@ -262,7 +784,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -271,6 +793,8 @@ components: json_extract_path_text(Properties, 'ModifiedAt') as modified_at, json_extract_path_text(Properties, 'MonitorArn') as monitor_arn, json_extract_path_text(Properties, 'MonitorName') as monitor_name, + json_extract_path_text(Properties, 'LinkedAccountId') as linked_account_id, + json_extract_path_text(Properties, 'IncludeLinkedAccounts') as include_linked_accounts, json_extract_path_text(Properties, 'ProcessingStatus') as processing_status, json_extract_path_text(Properties, 'ProcessingStatusInfo') as processing_status_info, json_extract_path_text(Properties, 'Resources') as resources, @@ -285,3 +809,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' AND data__Identifier = '' AND region = 'us-east-1' + monitors_list_only: + name: monitors_list_only + id: awscc.internetmonitor.monitors_list_only + x-cfn-schema-name: Monitor + x-cfn-type-name: AWS::InternetMonitor::Monitor + x-identifiers: + - MonitorName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.MonitorName') as monitor_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MonitorName') as monitor_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Monitor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMonitor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMonitorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/invoicing.yaml b/providers/src/awscc/v00.00.00000/services/invoicing.yaml new file mode 100644 index 00000000..2d695452 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/invoicing.yaml @@ -0,0 +1,864 @@ +openapi: 3.0.0 +info: + title: Invoicing + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + InvoiceUnitArn: + type: string + pattern: ^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$ + minLength: 1 + maxLength: 256 + InvoiceReceiver: + type: string + pattern: ^\d{12}$ + minLength: 12 + maxLength: 12 + Name: + type: string + pattern: ^(?! )[\p{L}\p{N}\p{Z}-_]*(?' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InvoiceUnitArn') as invoice_unit_arn, + json_extract_path_text(Properties, 'InvoiceReceiver') as invoice_receiver, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TaxInheritanceDisabled') as tax_inheritance_disabled, + json_extract_path_text(Properties, 'Rule') as rule, + json_extract_path_text(Properties, 'LastModified') as last_modified, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Invoicing::InvoiceUnit' + AND data__Identifier = '' + AND region = 'us-east-1' + invoice_units_list_only: + name: invoice_units_list_only + id: awscc.invoicing.invoice_units_list_only + x-cfn-schema-name: InvoiceUnit + x-cfn-type-name: AWS::Invoicing::InvoiceUnit + x-identifiers: + - InvoiceUnitArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.InvoiceUnitArn') as invoice_unit_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Invoicing::InvoiceUnit' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InvoiceUnitArn') as invoice_unit_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Invoicing::InvoiceUnit' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InvoiceUnit&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInvoiceUnit + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInvoiceUnitRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iot.yaml b/providers/src/awscc/v00.00.00000/services/iot.yaml index dd4c72e0..f9ea0890 100644 --- a/providers/src/awscc/v00.00.00000/services/iot.yaml +++ b/providers/src/awscc/v00.00.00000/services/iot.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoT - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AuditCheckConfigurations: description: Specifies which audit checks are enabled and disabled for this account. @@ -18,7 +398,7 @@ components: ConflictingClientIdsCheck: $ref: '#/components/schemas/AuditCheckConfiguration' DeviceCertificateExpiringCheck: - $ref: '#/components/schemas/AuditCheckConfiguration' + $ref: '#/components/schemas/DeviceCertExpirationAuditCheckConfiguration' DeviceCertificateKeyQualityCheck: $ref: '#/components/schemas/AuditCheckConfiguration' DeviceCertificateSharedCheck: @@ -41,6 +421,8 @@ components: $ref: '#/components/schemas/AuditCheckConfiguration' IoTPolicyPotentialMisConfigurationCheck: $ref: '#/components/schemas/AuditCheckConfiguration' + DeviceCertificateAgeCheck: + $ref: '#/components/schemas/DeviceCertAgeAuditCheckConfiguration' additionalProperties: false AuditNotificationTargetConfigurations: description: Information about the targets to which audit notifications are sent. @@ -57,6 +439,26 @@ components: description: True if the check is enabled. type: boolean additionalProperties: false + DeviceCertAgeAuditCheckConfiguration: + description: A structure containing the configName and corresponding configValue for configuring DeviceCertAgeCheck. + type: object + properties: + Enabled: + description: True if the check is enabled. + type: boolean + Configuration: + $ref: '#/components/schemas/CertAgeCheckCustomConfiguration' + additionalProperties: false + DeviceCertExpirationAuditCheckConfiguration: + description: A structure containing the configName and corresponding configValue for configuring DeviceCertExpirationCheck. + type: object + properties: + Enabled: + description: True if the check is enabled. + type: boolean + Configuration: + $ref: '#/components/schemas/CertExpirationCheckCustomConfiguration' + additionalProperties: false AuditNotificationTarget: type: object properties: @@ -73,6 +475,25 @@ components: description: True if notifications to the target are enabled. type: boolean additionalProperties: false + ConfigValue: + type: string + description: The configValue for configuring audit checks. + minLength: 1 + maxLength: 64 + CertAgeCheckCustomConfiguration: + type: object + description: A structure containing the configName and corresponding configValue for configuring audit checks. + properties: + CertAgeThresholdInDays: + $ref: '#/components/schemas/ConfigValue' + additionalProperties: false + CertExpirationCheckCustomConfiguration: + type: object + description: A structure containing the configName and corresponding configValue for configuring audit checks. + properties: + CertExpirationThresholdInDays: + $ref: '#/components/schemas/ConfigValue' + additionalProperties: false AccountAuditConfiguration: type: object properties: @@ -95,10 +516,18 @@ components: - AuditCheckConfigurations - RoleArn x-stackql-resource-name: account_audit_configuration - x-stackql-primaryIdentifier: + description: Configures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. + x-type-name: AWS::IoT::AccountAuditConfiguration + x-stackql-primary-identifier: - AccountId x-create-only-properties: - AccountId + x-required-properties: + - AccountId + - AuditCheckConfigurations + - RoleArn + x-tagging: + taggable: false x-required-permissions: create: - iot:UpdateAccountAuditConfiguration @@ -158,38 +587,57 @@ components: type: boolean Tags: type: array - x-insertionOrder: true + uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - AuthorizerFunctionArn x-stackql-resource-name: authorizer - x-stackql-primaryIdentifier: + description: Creates an authorizer. + x-type-name: AWS::IoT::Authorizer + x-stackql-primary-identifier: - AuthorizerName x-create-only-properties: - SigningDisabled - AuthorizerName x-read-only-properties: - Arn + x-required-properties: + - AuthorizerFunctionArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:CreateAuthorizer - iot:DescribeAuthorizer - iot:TagResource - iot:ListTagsForResource + - kms:Decrypt read: - iot:DescribeAuthorizer - iot:ListTagsForResource + - kms:Decrypt update: - iot:UpdateAuthorizer - iot:DescribeAuthorizer - iot:TagResource - iot:UntagResource - iot:ListTagsForResource + - kms:Decrypt delete: - iot:UpdateAuthorizer - iot:DeleteAuthorizer - iot:DescribeAuthorizer + - kms:Decrypt list: - iot:ListAuthorizers BillingGroup: @@ -221,13 +669,25 @@ components: maxLength: 2028 pattern: '[\p{Graph}\x20]*' x-stackql-resource-name: billing_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::BillingGroup + x-type-name: AWS::IoT::BillingGroup + x-stackql-primary-identifier: - BillingGroupName x-create-only-properties: - BillingGroupName x-read-only-properties: - Arn - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:DescribeBillingGroup @@ -308,6 +768,7 @@ components: Tags: description: An array of key-value pairs to apply to this resource. type: array + uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/Tag' @@ -315,15 +776,33 @@ components: - CACertificatePem - Status x-stackql-resource-name: ca_certificate - x-stackql-primaryIdentifier: + description: Registers a CA Certificate in IoT. + x-type-name: AWS::IoT::CACertificate + x-stackql-primary-identifier: - Id x-create-only-properties: - VerificationCertificatePem - CertificateMode - CACertificatePem + x-write-only-properties: + - VerificationCertificatePem + - RemoveAutoRegistration x-read-only-properties: - Arn - Id + x-required-properties: + - CACertificatePem + - Status + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iam:GetRole @@ -332,9 +811,11 @@ components: - iot:DescribeCACertificate - iot:TagResource - iot:ListTagsForResource + - kms:Decrypt read: - iot:DescribeCACertificate - iot:ListTagsForResource + - kms:Decrypt update: - iam:GetRole - iam:PassRole @@ -343,10 +824,12 @@ components: - iot:TagResource - iot:UntagResource - iot:ListTagsForResource + - kms:Decrypt delete: - iot:UpdateCACertificate - iot:DeleteCACertificate - iot:DescribeCACertificate + - kms:Decrypt list: - iot:ListCACertificates Certificate: @@ -382,31 +865,47 @@ components: required: - Status x-stackql-resource-name: certificate - x-stackql-primaryIdentifier: + description: Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate. + x-type-name: AWS::IoT::Certificate + x-stackql-primary-identifier: - Id x-create-only-properties: - CertificateSigningRequest - CACertificatePem - CertificatePem - CertificateMode + x-write-only-properties: + - CertificateSigningRequest + - CACertificatePem x-read-only-properties: - Arn - Id + x-required-properties: + - Status + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iot:CreateCertificateFromCsr - iot:RegisterCertificate - iot:RegisterCertificateWithoutCA - iot:DescribeCertificate + - kms:Decrypt read: - iot:DescribeCertificate + - kms:Decrypt update: - iot:UpdateCertificate - iot:DescribeCertificate + - kms:Decrypt delete: - iot:DeleteCertificate - iot:UpdateCertificate - iot:DescribeCertificate + - kms:Decrypt list: - iot:ListCertificates CertificateProviderOperation: @@ -437,7 +936,8 @@ components: description: An array of key-value pairs to apply to this resource. type: array maxItems: 50 - x-insertionOrder: true + uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' Arn: @@ -446,32 +946,218 @@ components: - LambdaFunctionArn - AccountDefaultForOperations x-stackql-resource-name: certificate_provider - x-stackql-primaryIdentifier: + description: Use the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider. + x-type-name: AWS::IoT::CertificateProvider + x-stackql-primary-identifier: - CertificateProviderName x-create-only-properties: - CertificateProviderName x-read-only-properties: - Arn + x-required-properties: + - LambdaFunctionArn + - AccountDefaultForOperations + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:CreateCertificateProvider - iot:DescribeCertificateProvider - iot:TagResource - iot:ListTagsForResource + - kms:Decrypt read: - iot:DescribeCertificateProvider - iot:ListTagsForResource + - kms:Decrypt update: - iot:UpdateCertificateProvider - iot:DescribeCertificateProvider - iot:TagResource - iot:UntagResource - iot:ListTagsForResource + - kms:Decrypt delete: - iot:DeleteCertificateProvider - iot:DescribeCertificateProvider + - kms:Decrypt list: - iot:ListCertificateProviders + CommandParameterList: + type: array + items: + $ref: '#/components/schemas/CommandParameter' + minItems: 1 + x-insertionOrder: false + CommandParameter: + type: object + properties: + Name: + $ref: '#/components/schemas/CommandParameterName' + Value: + $ref: '#/components/schemas/CommandParameterValue' + DefaultValue: + $ref: '#/components/schemas/CommandParameterValue' + Description: + $ref: '#/components/schemas/CommandParameterDescription' + required: + - Name + additionalProperties: false + CommandParameterName: + type: string + pattern: ^[.$a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 192 + CommandParameterDescription: + type: string + maxLength: 2028 + CommandParameterValue: + type: object + properties: + S: + type: string + minLength: 1 + B: + type: boolean + I: + type: integer + L: + type: string + pattern: ^-?\d+$ + maxLength: 19 + D: + type: number + BIN: + type: string + minLength: 1 + UL: + type: string + pattern: ^[0-9]*$ + minLength: 1 + maxLength: 20 + additionalProperties: false + MimeType: + type: string + minLength: 1 + CommandPayloadContent: + type: string + CommandPayload: + type: object + properties: + Content: + $ref: '#/components/schemas/CommandPayloadContent' + ContentType: + $ref: '#/components/schemas/MimeType' + additionalProperties: false + Command: + type: object + properties: + CommandArn: + type: string + description: The Amazon Resource Name (ARN) of the command. + CommandId: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + description: The unique identifier for the command. + CreatedAt: + type: string + description: The date and time when the command was created. + Deprecated: + type: boolean + description: A flag indicating whether the command is deprecated. + Description: + type: string + maxLength: 2028 + description: The description of the command. + DisplayName: + type: string + description: The display name for the command. + LastUpdatedAt: + type: string + description: The date and time when the command was last updated. + MandatoryParameters: + $ref: '#/components/schemas/CommandParameterList' + description: The list of mandatory parameters for the command. + Namespace: + type: string + enum: + - AWS-IoT + - AWS-IoT-FleetWise + description: The namespace to which the command belongs. + RoleArn: + type: string + minLength: 20 + maxLength: 2028 + description: The customer role associated with the command. + Payload: + $ref: '#/components/schemas/CommandPayload' + description: The payload associated with the command. + PendingDeletion: + type: boolean + description: A flag indicating whether the command is pending deletion. + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + description: The tags to be associated with the command. + x-insertionOrder: true + required: + - CommandId + x-stackql-resource-name: command + description: Represents the resource definition of AWS IoT Command. + x-type-name: AWS::IoT::Command + x-stackql-primary-identifier: + - CommandId + x-create-only-properties: + - CommandId + x-write-only-properties: + - LastUpdatedAt + x-read-only-properties: + - CommandArn + x-required-properties: + - CommandId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource + x-required-permissions: + create: + - iam:PassRole + - iot:CreateCommand + - iot:TagResource + read: + - iot:GetCommand + - iot:ListTagsForResource + update: + - iam:PassRole + - iot:UpdateCommand + - iot:GetCommand + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource + delete: + - iot:GetCommand + - iot:UpdateCommand + - iot:DeleteCommand + list: + - iot:ListCommands CustomMetric: type: object properties: @@ -509,13 +1195,27 @@ components: required: - MetricType x-stackql-resource-name: custom_metric - x-stackql-primaryIdentifier: + description: A custom metric published by your devices to Device Defender. + x-type-name: AWS::IoT::CustomMetric + x-stackql-primary-identifier: - MetricName x-create-only-properties: - MetricName - MetricType x-read-only-properties: - MetricArn + x-required-properties: + - MetricType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateCustomMetric @@ -573,13 +1273,28 @@ components: - Type - StringValues x-stackql-resource-name: dimension - x-stackql-primaryIdentifier: + description: A dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender. + x-type-name: AWS::IoT::Dimension + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - Type x-read-only-properties: - Arn + x-required-properties: + - Type + - StringValues + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateDimension @@ -613,6 +1328,15 @@ components: properties: EnableOCSPCheck: type: boolean + OcspLambdaArn: + type: string + minLength: 1 + maxLength: 170 + OcspAuthorizedResponderArn: + type: string + pattern: ^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+$ + minLength: 1 + maxLength: 2048 additionalProperties: false ServerCertificateSummary: type: object @@ -637,6 +1361,14 @@ components: type: string maxLength: 128 additionalProperties: false + ClientCertificateConfig: + type: object + properties: + ClientCertificateCallbackArn: + type: string + minLength: 1 + maxLength: 170 + additionalProperties: false DomainConfiguration: type: object properties: @@ -692,14 +1424,34 @@ components: $ref: '#/components/schemas/ServerCertificateSummary' TlsConfig: $ref: '#/components/schemas/TlsConfig' - Tags: - type: array - x-insertionOrder: true + AuthenticationType: + type: string + enum: + - AWS_X509 + - CUSTOM_AUTH + - AWS_SIGV4 + - CUSTOM_AUTH_X509 + - DEFAULT + ApplicationProtocol: + type: string + enum: + - SECURE_MQTT + - MQTT_WSS + - HTTPS + - DEFAULT + ClientCertificateConfig: + $ref: '#/components/schemas/ClientCertificateConfig' + Tags: + type: array + uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: domain_configuration - x-stackql-primaryIdentifier: + description: Create and manage a Domain Configuration + x-type-name: AWS::IoT::DomainConfiguration + x-stackql-primary-identifier: - DomainConfigurationName x-create-only-properties: - DomainConfigurationName @@ -707,10 +1459,24 @@ components: - ServiceType - ValidationCertificateArn - ServerCertificateArns + x-write-only-properties: + - ValidationCertificateArn + - ServerCertificateArns x-read-only-properties: - Arn - DomainType - ServerCertificates + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:CreateDomainConfiguration @@ -719,21 +1485,99 @@ components: - iot:TagResource - iot:ListTagsForResource - acm:GetCertificate + - kms:Decrypt read: - iot:DescribeDomainConfiguration - iot:ListTagsForResource + - kms:Decrypt update: - iot:UpdateDomainConfiguration - iot:DescribeDomainConfiguration - iot:ListTagsForResource - iot:TagResource - iot:UntagResource + - kms:Decrypt delete: - iot:DescribeDomainConfiguration - iot:DeleteDomainConfiguration - iot:UpdateDomainConfiguration + - kms:Decrypt list: - iot:ListDomainConfigurations + EncryptionConfiguration: + type: object + properties: + AccountId: + type: string + EncryptionType: + type: string + enum: + - CUSTOMER_MANAGED_KMS_KEY + - AWS_OWNED_KMS_KEY + KmsAccessRoleArn: + type: string + minLength: 20 + maxLength: 2048 + KmsKeyArn: + type: string + minLength: 20 + maxLength: 2048 + ConfigurationDetails: + type: object + properties: + ConfigurationStatus: + type: string + enum: + - HEALTHY + - UNHEALTHY + ErrorCode: + type: string + ErrorMessage: + type: string + additionalProperties: false + LastModifiedDate: + type: string + required: + - EncryptionType + x-stackql-resource-name: encryption_configuration + description: Resource Type definition for AWS::IoT::EncryptionConfiguration + x-type-name: AWS::IoT::EncryptionConfiguration + x-stackql-primary-identifier: + - AccountId + x-read-only-properties: + - AccountId + - ConfigurationDetails + - LastModifiedDate + x-required-properties: + - EncryptionType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iot:UpdateEncryptionConfiguration + - iot:DescribeEncryptionConfiguration + - kms:Encrypt + - kms:Decrypt + - kms:DescribeKey + - iam:PassRole + read: + - iot:DescribeEncryptionConfiguration + update: + - iot:UpdateEncryptionConfiguration + - iot:DescribeEncryptionConfiguration + - kms:Encrypt + - kms:Decrypt + - kms:DescribeKey + - iam:PassRole + delete: + - iot:UpdateEncryptionConfiguration + - iot:DescribeEncryptionConfiguration + - kms:Decrypt + list: + - iot:DescribeEncryptionConfiguration AggregationType: description: Aggregation types supported by Fleet Indexing type: object @@ -807,7 +1651,9 @@ components: required: - MetricName x-stackql-resource-name: fleet_metric - x-stackql-primaryIdentifier: + description: An aggregated metric of certain devices in your fleet + x-type-name: AWS::IoT::FleetMetric + x-stackql-primary-identifier: - MetricName x-create-only-properties: - MetricName @@ -816,6 +1662,18 @@ components: - CreationDate - LastModifiedDate - Version + x-required-properties: + - MetricName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateFleetMetric @@ -1112,7 +1970,10 @@ components: - JobTemplateId - Description x-stackql-resource-name: job_template - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::JobTemplate. Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices. + x-type-name: AWS::IoT::JobTemplate + x-documentation-url: https://docs.aws.amazon.com/iot/latest/developerguide/job-templates.html + x-stackql-primary-identifier: - JobTemplateId x-create-only-properties: - JobTemplateId @@ -1124,12 +1985,36 @@ components: - JobExecutionsRolloutConfig - AbortConfig - PresignedUrlConfig + - DestinationPackageVersions + - JobExecutionsRetryConfig + - MaintenanceWindows - Tags + x-write-only-properties: + - JobArn + - Document + - DocumentSource + - TimeoutConfig + - JobExecutionsRolloutConfig + - AbortConfig + - PresignedUrlConfig - DestinationPackageVersions - JobExecutionsRetryConfig - MaintenanceWindows x-read-only-properties: - Arn + x-required-properties: + - JobTemplateId + - Description + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateJobTemplate @@ -1138,6 +2023,7 @@ components: - iot:TagResource read: - iot:DescribeJobTemplate + - iot:ListTagsForResource delete: - iot:DeleteJobTemplate list: @@ -1170,10 +2056,17 @@ components: - RoleArn - DefaultLogLevel x-stackql-resource-name: logging - x-stackql-primaryIdentifier: + description: Logging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service. + x-type-name: AWS::IoT::Logging + x-documentation-url: https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html + x-stackql-primary-identifier: - AccountId x-create-only-properties: - AccountId + x-required-properties: + - AccountId + - RoleArn + - DefaultLogLevel x-required-permissions: create: - iot:SetV2LoggingOptions @@ -1244,7 +2137,7 @@ components: RoleArnForLogging: description: ' The ARN of the IAM role used for logging.' type: string - minLength: 20 + minLength: 11 maxLength: 2048 required: - LogLevel @@ -1257,7 +2150,7 @@ components: TopicArn: type: string description: The ARN of the topic to which you want to publish the findings. - minLength: 20 + minLength: 11 maxLength: 2048 required: - TopicArn @@ -1327,13 +2220,28 @@ components: - RoleArn - ActionParams x-stackql-resource-name: mitigation_action - x-stackql-primaryIdentifier: + description: Mitigation actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation. + x-type-name: AWS::IoT::MitigationAction + x-stackql-primary-identifier: - ActionName x-create-only-properties: - ActionName x-read-only-properties: - MitigationActionArn - MitigationActionId + x-required-properties: + - RoleArn + - ActionParams + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateMitigationAction @@ -1369,33 +2277,51 @@ components: type: string Tags: type: array - x-insertionOrder: true + uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - PolicyDocument x-stackql-resource-name: policy - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::Policy + x-type-name: AWS::IoT::Policy + x-stackql-primary-identifier: - Id x-create-only-properties: - PolicyName x-read-only-properties: - Arn - Id + x-required-properties: + - PolicyDocument + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:CreatePolicy - iot:GetPolicy - iot:TagResource - iot:ListTagsForResource + - kms:Decrypt read: - iot:GetPolicy - iot:ListTagsForResource + - kms:Decrypt delete: - iot:DeletePolicy - iot:GetPolicy - iot:ListPolicyVersions - iot:DeletePolicyVersion + - kms:Decrypt update: - iot:GetPolicy - iot:ListPolicyVersions @@ -1405,6 +2331,7 @@ components: - iot:TagResource - iot:UntagResource - iot:ListTagsForResource + - kms:Decrypt list: - iot:ListPolicies ProvisioningHook: @@ -1414,6 +2341,7 @@ components: type: string PayloadVersion: type: string + additionalProperties: false ProvisioningTemplate: type: object properties: @@ -1442,20 +2370,36 @@ components: $ref: '#/components/schemas/ProvisioningHook' Tags: type: array - x-insertionOrder: true + uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - ProvisioningRoleArn - TemplateBody x-stackql-resource-name: provisioning_template - x-stackql-primaryIdentifier: + description: Creates a fleet provisioning template. + x-type-name: AWS::IoT::ProvisioningTemplate + x-stackql-primary-identifier: - TemplateName x-create-only-properties: - TemplateName - TemplateType x-read-only-properties: - TemplateArn + x-required-properties: + - ProvisioningRoleArn + - TemplateBody + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iam:GetRole @@ -1464,9 +2408,11 @@ components: - iot:DescribeProvisioningTemplate - iot:TagResource - iot:ListTagsForResource + - kms:Decrypt read: - iot:DescribeProvisioningTemplate - iot:ListTagsForResource + - kms:Decrypt update: - iam:GetRole - iam:PassRole @@ -1478,9 +2424,11 @@ components: - iot:TagResource - iot:UntagResource - iot:ListTagsForResource + - kms:Decrypt delete: - iot:DeleteProvisioningTemplate - iot:DescribeProvisioningTemplate + - kms:Decrypt list: - iot:ListProvisioningTemplates ResourceSpecificLogging: @@ -1521,13 +2469,20 @@ components: - TargetType - LogLevel x-stackql-resource-name: resource_specific_logging - x-stackql-primaryIdentifier: + description: Resource-specific logging allows you to specify a logging level for a specific thing group. + x-type-name: AWS::IoT::ResourceSpecificLogging + x-documentation-url: https://docs.aws.amazon.com/iot/latest/developerguide/configure-logging.html + x-stackql-primary-identifier: - TargetId x-create-only-properties: - TargetName - TargetType x-read-only-properties: - TargetId + x-required-properties: + - TargetName + - TargetType + - LogLevel x-required-permissions: create: - iot:ListV2LoggingLevels @@ -1567,18 +2522,33 @@ components: default: 3600 Tags: type: array - x-insertionOrder: true + uniqueItems: true + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - RoleArn x-stackql-resource-name: role_alias - x-stackql-primaryIdentifier: + description: Use the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias. + x-type-name: AWS::IoT::RoleAlias + x-stackql-primary-identifier: - RoleAlias x-create-only-properties: - RoleAlias x-read-only-properties: - RoleAliasArn + x-required-properties: + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iam:GetRole @@ -1587,11 +2557,13 @@ components: - iot:DescribeRoleAlias - iot:TagResource - iot:ListTagsForResource + - kms:Decrypt read: - iam:GetRole - iam:PassRole - iot:DescribeRoleAlias - iot:ListTagsForResource + - kms:Decrypt update: - iam:GetRole - iam:PassRole @@ -1600,9 +2572,11 @@ components: - iot:TagResource - iot:UntagResource - iot:ListTagsForResource + - kms:Decrypt delete: - iot:DeleteRoleAlias - iot:DescribeRoleAlias + - kms:Decrypt list: - iot:ListRoleAliases ScheduledAudit: @@ -1662,12 +2636,27 @@ components: - Frequency - TargetCheckNames x-stackql-resource-name: scheduled_audit - x-stackql-primaryIdentifier: + description: Scheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run. + x-type-name: AWS::IoT::ScheduledAudit + x-stackql-primary-identifier: - ScheduledAuditName x-create-only-properties: - ScheduledAuditName x-read-only-properties: - ScheduledAuditArn + x-required-properties: + - Frequency + - TargetCheckNames + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateScheduledAudit @@ -1958,12 +2947,25 @@ components: type: string required: [] x-stackql-resource-name: security_profile - x-stackql-primaryIdentifier: + description: A security profile defines a set of expected behaviors for devices in your account. + x-type-name: AWS::IoT::SecurityProfile + x-stackql-primary-identifier: - SecurityProfileName x-create-only-properties: - SecurityProfileName x-read-only-properties: - SecurityProfileArn + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreateSecurityProfile @@ -2013,12 +3015,24 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: software_package - x-stackql-primaryIdentifier: + description: resource definition + x-type-name: AWS::IoT::SoftwarePackage + x-stackql-primary-identifier: - PackageName x-create-only-properties: - PackageName x-read-only-properties: - PackageArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreatePackage @@ -2053,6 +3067,15 @@ components: - DRAFT - PUBLISHED - DEPRECATED + PackageVersionArtifact: + description: The artifact location of the package version + type: object + properties: + S3Location: + $ref: '#/components/schemas/S3Location' + required: + - S3Location + additionalProperties: false ResourceAttributes: type: object x-patternProperties: @@ -2061,11 +3084,50 @@ components: minLength: 1 pattern: ^[^\p{C}]+$ additionalProperties: false + Sbom: + description: The sbom zip archive location of the package version + type: object + properties: + S3Location: + $ref: '#/components/schemas/S3Location' + required: + - S3Location + additionalProperties: false + S3Location: + description: The Amazon S3 location + type: object + properties: + Bucket: + type: string + description: The S3 bucket + minLength: 1 + Key: + type: string + description: The S3 key + minLength: 1 + Version: + type: string + description: The S3 version + required: + - Bucket + - Key + - Version + additionalProperties: false + SbomValidationStatus: + description: The validation status of the Sbom file + type: string + enum: + - IN_PROGRESS + - FAILED + - SUCCEEDED + - '' SoftwarePackageVersion: type: object properties: Attributes: $ref: '#/components/schemas/ResourceAttributes' + Artifact: + $ref: '#/components/schemas/PackageVersionArtifact' Description: type: string maxLength: 1024 @@ -2080,6 +3142,14 @@ components: pattern: ^[a-zA-Z0-9-_.]+$ PackageVersionArn: type: string + pattern: ^arn:[!-~]+$ + Recipe: + description: The inline json job document associated with a software package version + type: string + Sbom: + $ref: '#/components/schemas/Sbom' + SbomValidationStatus: + $ref: '#/components/schemas/SbomValidationStatus' Status: $ref: '#/components/schemas/PackageVersionStatus' Tags: @@ -2098,7 +3168,9 @@ components: required: - PackageName x-stackql-resource-name: software_package_version - x-stackql-primaryIdentifier: + description: resource definition + x-type-name: AWS::IoT::SoftwarePackageVersion + x-stackql-primary-identifier: - PackageName - VersionName x-create-only-properties: @@ -2108,12 +3180,28 @@ components: - ErrorReason - PackageVersionArn - Status + - SbomValidationStatus + x-required-properties: + - PackageName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iot:TagResource + - iot:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:CreatePackageVersion - iot:GetPackageVersion + - iot:ListTagsForResource - iot:TagResource - iot:GetIndexingConfiguration + - s3:GetObjectVersion + - iot:AssociateSbomWithPackageVersion read: - iot:GetPackageVersion - iot:ListTagsForResource @@ -2124,6 +3212,9 @@ components: - iot:TagResource - iot:UntagResource - iot:GetIndexingConfiguration + - s3:GetObjectVersion + - iot:AssociateSbomWithPackageVersion + - iot:DisassociateSbomFromPackageVersion delete: - iot:DeletePackageVersion - iot:UpdatePackageVersion @@ -2156,13 +3247,20 @@ components: minLength: 1 maxLength: 128 x-stackql-resource-name: thing - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::Thing + x-type-name: AWS::IoT::Thing + x-stackql-primary-identifier: - ThingName x-create-only-properties: - ThingName x-read-only-properties: - Id - Arn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: true x-required-permissions: create: - iot:CreateThing @@ -2217,7 +3315,9 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: thing_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::ThingGroup + x-type-name: AWS::IoT::ThingGroup + x-stackql-primary-identifier: - ThingGroupName x-create-only-properties: - ThingGroupName @@ -2225,6 +3325,16 @@ components: x-read-only-properties: - Arn - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:DescribeThingGroup @@ -2249,6 +3359,25 @@ components: - iot:UpdateDynamicThingGroup - iot:TagResource - iot:UntagResource + PropagatingAttribute: + type: object + additionalProperties: false + properties: + UserPropertyKey: + type: string + pattern: '[a-zA-Z0-9:$.]+' + maxLength: 128 + ThingAttribute: + type: string + pattern: '[a-zA-Z0-9_.,@/:#-]+' + maxLength: 128 + ConnectionAttribute: + type: string + enum: + - iot:ClientId + - iot:Thing.ThingName + required: + - UserPropertyKey ThingType: type: object properties: @@ -2280,6 +3409,15 @@ components: pattern: '[\p{Graph}\x20]*' type: string maxLength: 2028 + Mqtt5Configuration: + type: object + additionalProperties: false + properties: + PropagatingAttributes: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/PropagatingAttribute' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -2289,14 +3427,25 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: thing_type - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::ThingType + x-type-name: AWS::IoT::ThingType + x-stackql-primary-identifier: - ThingTypeName x-create-only-properties: - ThingTypeName - - ThingTypeProperties x-read-only-properties: - Arn - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:ListTagsForResource + - iot:TagResource + - iot:UntagResource x-required-permissions: create: - iot:DescribeThingType @@ -2918,12 +4067,26 @@ components: required: - TopicRulePayload x-stackql-resource-name: topic_rule - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::TopicRule + x-type-name: AWS::IoT::TopicRule + x-stackql-primary-identifier: - RuleName x-create-only-properties: - RuleName x-read-only-properties: - Arn + x-required-properties: + - TopicRulePayload + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iot:UntagResource + - iot:TagResource + - iot:ListTagsForResource x-required-permissions: create: - iam:PassRole @@ -2995,7 +4158,9 @@ components: description: VPC destination properties. $ref: '#/components/schemas/VpcDestinationProperties' x-stackql-resource-name: topic_rule_destination - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoT::TopicRuleDestination + x-type-name: AWS::IoT::TopicRuleDestination + x-stackql-primary-identifier: - Arn x-create-only-properties: - HttpUrlProperties @@ -3003,6 +4168,11 @@ components: x-read-only-properties: - Arn - StatusReason + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: true x-required-permissions: create: - iam:PassRole @@ -3020,106 +4190,1638 @@ components: - iot:DeleteTopicRuleDestination list: - iot:ListTopicRuleDestinations - x-stackQL-resources: - account_audit_configurations: - name: account_audit_configurations - id: awscc.iot.account_audit_configurations - x-cfn-schema-name: AccountAuditConfiguration - x-type: list - x-identifiers: - - AccountId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND region = 'us-east-1' - account_audit_configuration: - name: account_audit_configuration - id: awscc.iot.account_audit_configuration - x-cfn-schema-name: AccountAuditConfiguration - x-type: get - x-identifiers: - - AccountId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AccountId') as account_id, - JSON_EXTRACT(Properties, '$.AuditCheckConfigurations') as audit_check_configurations, - JSON_EXTRACT(Properties, '$.AuditNotificationTargetConfigurations') as audit_notification_target_configurations, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'AuditCheckConfigurations') as audit_check_configurations, - json_extract_path_text(Properties, 'AuditNotificationTargetConfigurations') as audit_notification_target_configurations, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND data__Identifier = '' - AND region = 'us-east-1' - authorizers: - name: authorizers - id: awscc.iot.authorizers - x-cfn-schema-name: Authorizer - x-type: list - x-identifiers: - - AuthorizerName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AuthorizerName') as authorizer_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AuthorizerName') as authorizer_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' - AND region = 'us-east-1' - authorizer: - name: authorizer - id: awscc.iot.authorizer - x-cfn-schema-name: Authorizer - x-type: get - x-identifiers: - - AuthorizerName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, + CreateAccountAuditConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + description: Your 12-digit account ID (used as the primary identifier for the CloudFormation resource). + type: string + minLength: 12 + maxLength: 12 + AuditCheckConfigurations: + $ref: '#/components/schemas/AuditCheckConfigurations' + AuditNotificationTargetConfigurations: + $ref: '#/components/schemas/AuditNotificationTargetConfigurations' + RoleArn: + description: The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit. + type: string + minLength: 20 + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreateAccountAuditConfigurationRequest + type: object + required: [] + CreateAuthorizerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AuthorizerFunctionArn: + type: string + Arn: + type: string + AuthorizerName: + type: string + pattern: '[\w=,@-]+' + minLength: 1 + maxLength: 128 + SigningDisabled: + type: boolean + Status: + type: string + enum: + - ACTIVE + - INACTIVE + TokenKeyName: + type: string + TokenSigningPublicKeys: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9:_-]+': + type: string + maxLength: 5120 + EnableCachingForHttp: + type: boolean + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAuthorizerRequest + type: object + required: [] + CreateBillingGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + BillingGroupName: + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + BillingGroupProperties: + type: object + additionalProperties: false + properties: + BillingGroupDescription: + type: string + maxLength: 2028 + pattern: '[\p{Graph}\x20]*' + x-stackQL-stringOnly: true + x-title: CreateBillingGroupRequest + type: object + required: [] + CreateCACertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CACertificatePem: + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 65536 + VerificationCertificatePem: + type: string + description: The private key verification certificate. + pattern: '[\s\S]*' + minLength: 1 + maxLength: 65536 + Status: + type: string + enum: + - ACTIVE + - INACTIVE + CertificateMode: + type: string + enum: + - DEFAULT + - SNI_ONLY + AutoRegistrationStatus: + type: string + enum: + - ENABLE + - DISABLE + RemoveAutoRegistration: + type: boolean + RegistrationConfig: + $ref: '#/components/schemas/RegistrationConfig' + Id: + type: string + Arn: + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCACertificateRequest + type: object + required: [] + CreateCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CACertificatePem: + type: string + minLength: 1 + maxLength: 65536 + CertificatePem: + type: string + minLength: 1 + maxLength: 65536 + CertificateSigningRequest: + type: string + CertificateMode: + type: string + enum: + - DEFAULT + - SNI_ONLY + Status: + type: string + enum: + - ACTIVE + - INACTIVE + - REVOKED + - PENDING_TRANSFER + - PENDING_ACTIVATION + Id: + type: string + Arn: + type: string + x-stackQL-stringOnly: true + x-title: CreateCertificateRequest + type: object + required: [] + CreateCertificateProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateProviderName: + type: string + pattern: '[\w=,@-]+' + minLength: 1 + maxLength: 128 + LambdaFunctionArn: + type: string + minLength: 1 + maxLength: 170 + AccountDefaultForOperations: + type: array + minItems: 1 + maxItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/CertificateProviderOperation' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + x-stackQL-stringOnly: true + x-title: CreateCertificateProviderRequest + type: object + required: [] + CreateCommandRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CommandArn: + type: string + description: The Amazon Resource Name (ARN) of the command. + CommandId: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 1 + maxLength: 64 + description: The unique identifier for the command. + CreatedAt: + type: string + description: The date and time when the command was created. + Deprecated: + type: boolean + description: A flag indicating whether the command is deprecated. + Description: + type: string + maxLength: 2028 + description: The description of the command. + DisplayName: + type: string + description: The display name for the command. + LastUpdatedAt: + type: string + description: The date and time when the command was last updated. + MandatoryParameters: + $ref: '#/components/schemas/CommandParameterList' + description: The list of mandatory parameters for the command. + Namespace: + type: string + enum: + - AWS-IoT + - AWS-IoT-FleetWise + description: The namespace to which the command belongs. + RoleArn: + type: string + minLength: 20 + maxLength: 2028 + description: The customer role associated with the command. + Payload: + $ref: '#/components/schemas/CommandPayload' + description: The payload associated with the command. + PendingDeletion: + type: boolean + description: A flag indicating whether the command is pending deletion. + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + description: The tags to be associated with the command. + x-insertionOrder: true + x-stackQL-stringOnly: true + x-title: CreateCommandRequest + type: object + required: [] + CreateCustomMetricRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MetricName: + description: 'The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn''t begin with aws: . Cannot be updated once defined.' + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + DisplayName: + description: Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined. + type: string + maxLength: 128 + MetricType: + description: The type of the custom metric. Types include string-list, ip-address-list, number-list, and number. + type: string + enum: + - string-list + - ip-address-list + - number-list + - number + MetricArn: + description: The Amazon Resource Number (ARN) of the custom metric. + type: string + minLength: 20 + maxLength: 2048 + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCustomMetricRequest + type: object + required: [] + CreateDimensionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: A unique identifier for the dimension. + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + Type: + description: Specifies the type of the dimension. + type: string + enum: + - TOPIC_FILTER + StringValues: + description: Specifies the value or list of values for the dimension. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + minLength: 1 + maxLength: 256 + minItems: 1 + maxItems: 5 + Tags: + description: Metadata that can be used to manage the dimension. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The ARN (Amazon resource name) of the created dimension. + type: string + x-stackQL-stringOnly: true + x-title: CreateDimensionRequest + type: object + required: [] + CreateDomainConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainConfigurationName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[\w.-]+$ + AuthorizerConfig: + $ref: '#/components/schemas/AuthorizerConfig' + DomainName: + type: string + minLength: 1 + maxLength: 253 + ServerCertificateArns: + type: array + minItems: 0 + maxItems: 1 + x-insertionOrder: true + items: + type: string + pattern: ^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+$ + minLength: 1 + maxLength: 2048 + ServiceType: + type: string + enum: + - DATA + - CREDENTIAL_PROVIDER + - JOBS + ValidationCertificateArn: + type: string + pattern: ^arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+$ + Arn: + type: string + DomainConfigurationStatus: + type: string + enum: + - ENABLED + - DISABLED + DomainType: + type: string + enum: + - ENDPOINT + - AWS_MANAGED + - CUSTOMER_MANAGED + ServerCertificateConfig: + $ref: '#/components/schemas/ServerCertificateConfig' + ServerCertificates: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/ServerCertificateSummary' + TlsConfig: + $ref: '#/components/schemas/TlsConfig' + AuthenticationType: + type: string + enum: + - AWS_X509 + - CUSTOM_AUTH + - AWS_SIGV4 + - CUSTOM_AUTH_X509 + - DEFAULT + ApplicationProtocol: + type: string + enum: + - SECURE_MQTT + - MQTT_WSS + - HTTPS + - DEFAULT + ClientCertificateConfig: + $ref: '#/components/schemas/ClientCertificateConfig' + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDomainConfigurationRequest + type: object + required: [] + CreateEncryptionConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + type: string + EncryptionType: + type: string + enum: + - CUSTOMER_MANAGED_KMS_KEY + - AWS_OWNED_KMS_KEY + KmsAccessRoleArn: + type: string + minLength: 20 + maxLength: 2048 + KmsKeyArn: + type: string + minLength: 20 + maxLength: 2048 + ConfigurationDetails: + type: object + properties: + ConfigurationStatus: + type: string + enum: + - HEALTHY + - UNHEALTHY + ErrorCode: + type: string + ErrorMessage: + type: string + additionalProperties: false + LastModifiedDate: + type: string + x-stackQL-stringOnly: true + x-title: CreateEncryptionConfigurationRequest + type: object + required: [] + CreateFleetMetricRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MetricName: + description: The name of the fleet metric + type: string + Description: + description: The description of a fleet metric + type: string + QueryString: + description: The Fleet Indexing query used by a fleet metric + type: string + Period: + description: The period of metric emission in seconds + type: integer + AggregationField: + description: The aggregation field to perform aggregation and metric emission + type: string + QueryVersion: + description: The version of a Fleet Indexing query used by a fleet metric + type: string + IndexName: + description: The index name of a fleet metric + type: string + Unit: + description: The unit of data points emitted by a fleet metric + type: string + AggregationType: + $ref: '#/components/schemas/AggregationType' + MetricArn: + description: The Amazon Resource Number (ARN) of a fleet metric metric + type: string + CreationDate: + description: The creation date of a fleet metric + $ref: '#/components/schemas/iso8601UTC' + LastModifiedDate: + description: The last modified date of a fleet metric + $ref: '#/components/schemas/iso8601UTC' + Version: + description: The version of a fleet metric + type: number + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFleetMetricRequest + type: object + required: [] + CreateJobTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + JobArn: + description: Optional for copying a JobTemplate from a pre-existing Job configuration. + type: string + JobTemplateId: + type: string + pattern: '[a-zA-Z0-9_-]+' + minLength: 1 + maxLength: 64 + Description: + description: A description of the Job Template. + type: string + pattern: '[^\p{C}]+' + maxLength: 2028 + Document: + description: The job document. Required if you don't specify a value for documentSource. + type: string + maxLength: 32768 + DocumentSource: + description: An S3 link to the job document to use in the template. Required if you don't specify a value for document. + type: string + minLength: 1 + maxLength: 1350 + TimeoutConfig: + description: Specifies the amount of time each device has to finish its execution of the job. + type: object + properties: + InProgressTimeoutInMinutes: + $ref: '#/components/schemas/InProgressTimeoutInMinutes' + required: + - InProgressTimeoutInMinutes + additionalProperties: false + JobExecutionsRolloutConfig: + description: Allows you to create a staged rollout of a job. + type: object + properties: + ExponentialRolloutRate: + description: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout. + $ref: '#/components/schemas/ExponentialRolloutRate' + MaximumPerMinute: + description: The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout. + $ref: '#/components/schemas/MaximumPerMinute' + additionalProperties: false + AbortConfig: + description: The criteria that determine when and how a job abort takes place. + type: object + properties: + CriteriaList: + type: array + x-insertionOrder: false + minItems: 1 + items: + $ref: '#/components/schemas/AbortCriteria' + required: + - CriteriaList + additionalProperties: false + PresignedUrlConfig: + type: object + description: Configuration for pre-signed S3 URLs. + properties: + RoleArn: + $ref: '#/components/schemas/RoleArn' + ExpiresInSec: + $ref: '#/components/schemas/ExpiresInSec' + required: + - RoleArn + additionalProperties: false + JobExecutionsRetryConfig: + type: object + properties: + RetryCriteriaList: + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/RetryCriteria' + additionalProperties: false + MaintenanceWindows: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/MaintenanceWindow' + DestinationPackageVersions: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DestinationPackageVersion' + Tags: + description: Metadata that can be used to manage the JobTemplate. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateJobTemplateRequest + type: object + required: [] + CreateLoggingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + description: Your 12-digit account ID (used as the primary identifier for the CloudFormation resource). + type: string + minLength: 12 + maxLength: 12 + pattern: ^[0-9]{12}$ + RoleArn: + description: The ARN of the role that allows IoT to write to Cloudwatch logs. + type: string + minLength: 20 + maxLength: 2048 + DefaultLogLevel: + description: 'The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.' + type: string + enum: + - ERROR + - WARN + - INFO + - DEBUG + - DISABLED + x-stackQL-stringOnly: true + x-title: CreateLoggingRequest + type: object + required: [] + CreateMitigationActionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActionName: + description: A unique identifier for the mitigation action. + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + RoleArn: + type: string + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + ActionParams: + $ref: '#/components/schemas/ActionParams' + MitigationActionArn: + type: string + MitigationActionId: + type: string + x-stackQL-stringOnly: true + x-title: CreateMitigationActionRequest + type: object + required: [] + CreatePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + PolicyDocument: + type: object + minLength: 1 + maxLength: 404600 + PolicyName: + type: string + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePolicyRequest + type: object + required: [] + CreateProvisioningTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TemplateArn: + type: string + TemplateName: + type: string + pattern: ^[0-9A-Za-z_-]+$ + minLength: 1 + maxLength: 36 + Description: + type: string + maxLength: 500 + Enabled: + type: boolean + ProvisioningRoleArn: + type: string + TemplateBody: + type: string + TemplateType: + type: string + enum: + - FLEET_PROVISIONING + - JITP + PreProvisioningHook: + $ref: '#/components/schemas/ProvisioningHook' + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateProvisioningTemplateRequest + type: object + required: [] + CreateResourceSpecificLoggingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TargetType: + description: The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE. + type: string + enum: + - THING_GROUP + - CLIENT_ID + - SOURCE_IP + - PRINCIPAL_ID + - EVENT_TYPE + TargetName: + description: The target name. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9.:\s_\-]+' + LogLevel: + description: 'The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.' + type: string + enum: + - ERROR + - WARN + - INFO + - DEBUG + - DISABLED + TargetId: + description: Unique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target. + type: string + minLength: 13 + maxLength: 140 + pattern: '[a-zA-Z0-9.:\s_\-]+' + x-stackQL-stringOnly: true + x-title: CreateResourceSpecificLoggingRequest + type: object + required: [] + CreateRoleAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RoleAlias: + type: string + pattern: '[\w=,@-]+' + minLength: 1 + maxLength: 128 + RoleAliasArn: + type: string + pattern: '[\w=,@-]+' + minLength: 1 + maxLength: 128 + RoleArn: + type: string + pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ + minLength: 20 + maxLength: 2048 + CredentialDurationSeconds: + type: integer + minimum: 900 + maximum: 43200 + default: 3600 + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRoleAliasRequest + type: object + required: [] + CreateScheduledAuditRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScheduledAuditName: + description: The name you want to give to the scheduled audit. + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + Frequency: + description: How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. + type: string + enum: + - DAILY + - WEEKLY + - BIWEEKLY + - MONTHLY + DayOfMonth: + description: The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. + type: string + pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$|^UNSET_VALUE$ + DayOfWeek: + description: The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY. + type: string + enum: + - SUN + - MON + - TUE + - WED + - THU + - FRI + - SAT + - UNSET_VALUE + TargetCheckNames: + description: Which checks are performed during the scheduled audit. Checks must be enabled for your account. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + ScheduledAuditArn: + description: The ARN (Amazon resource name) of the scheduled audit. + type: string + minLength: 20 + maxLength: 2048 + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateScheduledAuditRequest + type: object + required: [] + CreateSecurityProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SecurityProfileName: + description: A unique identifier for the security profile. + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + SecurityProfileDescription: + description: A description of the security profile. + type: string + maxLength: 1000 + Behaviors: + description: Specifies the behaviors that, when violated by a device (thing), cause an alert. + type: array + maxLength: 100 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Behavior' + AlertTargets: + description: Specifies the destinations to which alerts are sent. + type: object + x-patternProperties: + '[a-zA-Z0-9:_-]+': + $ref: '#/components/schemas/AlertTarget' + additionalProperties: false + AdditionalMetricsToRetainV2: + description: A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/MetricToRetain' + MetricsExportConfig: + description: A structure containing the mqtt topic for metrics export. + type: object + properties: + MqttTopic: + description: The topic for metrics export. + type: string + minLength: 1 + maxLength: 512 + RoleArn: + description: The ARN of the role that grants permission to publish to mqtt topic. + type: string + minLength: 20 + maxLength: 2048 + required: + - MqttTopic + - RoleArn + additionalProperties: false + Tags: + description: Metadata that can be used to manage the security profile. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + TargetArns: + description: A set of target ARNs that the security profile is attached to. + type: array + uniqueItems: true + x-insertionOrder: false + items: + description: The ARN of the target to which the security profile is attached. + type: string + maxLength: 2048 + SecurityProfileArn: + description: The ARN (Amazon resource name) of the created security profile. + type: string + x-stackQL-stringOnly: true + x-title: CreateSecurityProfileRequest + type: object + required: [] + CreateSoftwarePackageRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^[^\p{C}]+$ + PackageArn: + type: string + PackageName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-_.]+$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSoftwarePackageRequest + type: object + required: [] + CreateSoftwarePackageVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Attributes: + $ref: '#/components/schemas/ResourceAttributes' + Artifact: + $ref: '#/components/schemas/PackageVersionArtifact' + Description: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^[^\p{C}]+$ + ErrorReason: + type: string + PackageName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-_.]+$ + PackageVersionArn: + type: string + pattern: ^arn:[!-~]+$ + Recipe: + description: The inline json job document associated with a software package version + type: string + Sbom: + $ref: '#/components/schemas/Sbom' + SbomValidationStatus: + $ref: '#/components/schemas/SbomValidationStatus' + Status: + $ref: '#/components/schemas/PackageVersionStatus' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + VersionName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-_.]+$ + x-stackQL-stringOnly: true + x-title: CreateSoftwarePackageVersionRequest + type: object + required: [] + CreateThingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + AttributePayload: + $ref: '#/components/schemas/AttributePayload' + ThingName: + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + x-stackQL-stringOnly: true + x-title: CreateThingRequest + type: object + required: [] + CreateThingGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + ThingGroupName: + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + ParentGroupName: + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + QueryString: + type: string + minLength: 1 + maxLength: 1000 + ThingGroupProperties: + type: object + additionalProperties: false + properties: + AttributePayload: + $ref: '#/components/schemas/AttributePayload' + ThingGroupDescription: + type: string + pattern: '[\p{Graph}\x20]*' + maxLength: 2028 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateThingGroupRequest + type: object + required: [] + CreateThingTypeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Arn: + type: string + ThingTypeName: + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 128 + DeprecateThingType: + type: boolean + ThingTypeProperties: + type: object + additionalProperties: false + properties: + SearchableAttributes: + type: array + maxItems: 3 + uniqueItems: true + x-insertionOrder: true + items: + type: string + pattern: '[a-zA-Z0-9_.,@/:#-]+' + maxLength: 128 + ThingTypeDescription: + pattern: '[\p{Graph}\x20]*' + type: string + maxLength: 2028 + Mqtt5Configuration: + type: object + additionalProperties: false + properties: + PropagatingAttributes: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/PropagatingAttribute' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateThingTypeRequest + type: object + required: [] + CreateTopicRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + RuleName: + type: string + TopicRulePayload: + $ref: '#/components/schemas/TopicRulePayload' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTopicRuleRequest + type: object + required: [] + CreateTopicRuleDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Amazon Resource Name (ARN). + type: string + Status: + description: The status of the TopicRuleDestination. + $ref: '#/components/schemas/TopicRuleDestinationStatus' + HttpUrlProperties: + description: HTTP URL destination properties. + $ref: '#/components/schemas/HttpUrlDestinationSummary' + StatusReason: + description: The reasoning for the current status of the TopicRuleDestination. + type: string + VpcProperties: + description: VPC destination properties. + $ref: '#/components/schemas/VpcDestinationProperties' + x-stackQL-stringOnly: true + x-title: CreateTopicRuleDestinationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + account_audit_configurations: + name: account_audit_configurations + id: awscc.iot.account_audit_configurations + x-cfn-schema-name: AccountAuditConfiguration + x-cfn-type-name: AWS::IoT::AccountAuditConfiguration + x-identifiers: + - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccountAuditConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::AccountAuditConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::AccountAuditConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::AccountAuditConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.AuditCheckConfigurations') as audit_check_configurations, + JSON_EXTRACT(Properties, '$.AuditNotificationTargetConfigurations') as audit_notification_target_configurations, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'AuditCheckConfigurations') as audit_check_configurations, + json_extract_path_text(Properties, 'AuditNotificationTargetConfigurations') as audit_notification_target_configurations, + json_extract_path_text(Properties, 'RoleArn') as role_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + account_audit_configurations_list_only: + name: account_audit_configurations_list_only + id: awscc.iot.account_audit_configurations_list_only + x-cfn-schema-name: AccountAuditConfiguration + x-cfn-type-name: AWS::IoT::AccountAuditConfiguration + x-identifiers: + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' + AND region = 'us-east-1' + authorizers: + name: authorizers + id: awscc.iot.authorizers + x-cfn-schema-name: Authorizer + x-cfn-type-name: AWS::IoT::Authorizer + x-identifiers: + - AuthorizerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Authorizer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Authorizer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, data__Identifier, JSON_EXTRACT(Properties, '$.AuthorizerFunctionArn') as authorizer_function_arn, JSON_EXTRACT(Properties, '$.Arn') as arn, @@ -3134,7 +5836,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3151,13 +5853,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Authorizer' AND data__Identifier = '' AND region = 'us-east-1' - billing_groups: - name: billing_groups - id: awscc.iot.billing_groups - x-cfn-schema-name: BillingGroup - x-type: list + authorizers_list_only: + name: authorizers_list_only + id: awscc.iot.authorizers_list_only + x-cfn-schema-name: Authorizer + x-cfn-type-name: AWS::IoT::Authorizer x-identifiers: - - BillingGroupName + - AuthorizerName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3165,28 +5873,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BillingGroupName') as billing_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' + JSON_EXTRACT(Properties, '$.AuthorizerName') as authorizer_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BillingGroupName') as billing_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' + json_extract_path_text(Properties, 'AuthorizerName') as authorizer_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' AND region = 'us-east-1' - billing_group: - name: billing_group - id: awscc.iot.billing_group + billing_groups: + name: billing_groups + id: awscc.iot.billing_groups x-cfn-schema-name: BillingGroup - x-type: get + x-cfn-type-name: AWS::IoT::BillingGroup x-identifiers: - BillingGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BillingGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::BillingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::BillingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::BillingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3200,7 +5956,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3213,13 +5969,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::BillingGroup' AND data__Identifier = '' AND region = 'us-east-1' - ca_certificates: - name: ca_certificates - id: awscc.iot.ca_certificates - x-cfn-schema-name: CACertificate - x-type: list + billing_groups_list_only: + name: billing_groups_list_only + id: awscc.iot.billing_groups_list_only + x-cfn-schema-name: BillingGroup + x-cfn-type-name: AWS::IoT::BillingGroup x-identifiers: - - Id + - BillingGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3227,28 +5989,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' + JSON_EXTRACT(Properties, '$.BillingGroupName') as billing_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' + json_extract_path_text(Properties, 'BillingGroupName') as billing_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' AND region = 'us-east-1' - ca_certificate: - name: ca_certificate - id: awscc.iot.ca_certificate + ca_certificates: + name: ca_certificates + id: awscc.iot.ca_certificates x-cfn-schema-name: CACertificate - x-type: get + x-cfn-type-name: AWS::IoT::CACertificate x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CACertificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CACertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CACertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CACertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3267,7 +6077,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3285,13 +6095,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CACertificate' AND data__Identifier = '' AND region = 'us-east-1' - certificates: - name: certificates - id: awscc.iot.certificates - x-cfn-schema-name: Certificate - x-type: list + ca_certificates_list_only: + name: ca_certificates_list_only + id: awscc.iot.ca_certificates_list_only + x-cfn-schema-name: CACertificate + x-cfn-type-name: AWS::IoT::CACertificate x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3300,7 +6116,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -3308,19 +6124,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' AND region = 'us-east-1' - certificate: - name: certificate - id: awscc.iot.certificate + certificates: + name: certificates + id: awscc.iot.certificates x-cfn-schema-name: Certificate - x-type: get + x-cfn-type-name: AWS::IoT::Certificate x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3336,7 +6200,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3351,13 +6215,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Certificate' AND data__Identifier = '' AND region = 'us-east-1' - certificate_providers: - name: certificate_providers - id: awscc.iot.certificate_providers - x-cfn-schema-name: CertificateProvider - x-type: list + certificates_list_only: + name: certificates_list_only + id: awscc.iot.certificates_list_only + x-cfn-schema-name: Certificate + x-cfn-type-name: AWS::IoT::Certificate x-identifiers: - - CertificateProviderName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3365,28 +6235,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CertificateProviderName') as certificate_provider_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CertificateProviderName') as certificate_provider_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' AND region = 'us-east-1' - certificate_provider: - name: certificate_provider - id: awscc.iot.certificate_provider + certificate_providers: + name: certificate_providers + id: awscc.iot.certificate_providers x-cfn-schema-name: CertificateProvider - x-type: get + x-cfn-type-name: AWS::IoT::CertificateProvider x-identifiers: - CertificateProviderName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CertificateProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CertificateProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CertificateProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CertificateProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3400,7 +6318,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3413,13 +6331,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CertificateProvider' AND data__Identifier = '' AND region = 'us-east-1' - custom_metrics: - name: custom_metrics - id: awscc.iot.custom_metrics - x-cfn-schema-name: CustomMetric - x-type: list + certificate_providers_list_only: + name: certificate_providers_list_only + id: awscc.iot.certificate_providers_list_only + x-cfn-schema-name: CertificateProvider + x-cfn-type-name: AWS::IoT::CertificateProvider x-identifiers: - - MetricName + - CertificateProviderName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3427,28 +6351,208 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MetricName') as metric_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' + JSON_EXTRACT(Properties, '$.CertificateProviderName') as certificate_provider_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'MetricName') as metric_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' + json_extract_path_text(Properties, 'CertificateProviderName') as certificate_provider_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' + AND region = 'us-east-1' + commands: + name: commands + id: awscc.iot.commands + x-cfn-schema-name: Command + x-cfn-type-name: AWS::IoT::Command + x-identifiers: + - CommandId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Command&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Command" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Command" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Command" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/commands/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/commands/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/commands/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CommandArn') as command_arn, + JSON_EXTRACT(Properties, '$.CommandId') as command_id, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Deprecated') as deprecated, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, + JSON_EXTRACT(Properties, '$.MandatoryParameters') as mandatory_parameters, + JSON_EXTRACT(Properties, '$.Namespace') as namespace, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Payload') as payload, + JSON_EXTRACT(Properties, '$.PendingDeletion') as pending_deletion, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Command' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CommandArn') as command_arn, + json_extract_path_text(Properties, 'CommandId') as command_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Deprecated') as deprecated, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'MandatoryParameters') as mandatory_parameters, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Payload') as payload, + json_extract_path_text(Properties, 'PendingDeletion') as pending_deletion, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Command' + AND data__Identifier = '' + AND region = 'us-east-1' + commands_list_only: + name: commands_list_only + id: awscc.iot.commands_list_only + x-cfn-schema-name: Command + x-cfn-type-name: AWS::IoT::Command + x-identifiers: + - CommandId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CommandId') as command_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Command' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CommandId') as command_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Command' AND region = 'us-east-1' - custom_metric: - name: custom_metric - id: awscc.iot.custom_metric + custom_metrics: + name: custom_metrics + id: awscc.iot.custom_metrics x-cfn-schema-name: CustomMetric - x-type: get + x-cfn-type-name: AWS::IoT::CustomMetric x-identifiers: - MetricName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomMetric&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CustomMetric" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CustomMetric" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::CustomMetric" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3462,7 +6566,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3475,13 +6579,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CustomMetric' AND data__Identifier = '' AND region = 'us-east-1' - dimensions: - name: dimensions - id: awscc.iot.dimensions - x-cfn-schema-name: Dimension - x-type: list + custom_metrics_list_only: + name: custom_metrics_list_only + id: awscc.iot.custom_metrics_list_only + x-cfn-schema-name: CustomMetric + x-cfn-type-name: AWS::IoT::CustomMetric x-identifiers: - - Name + - MetricName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3489,28 +6599,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' + JSON_EXTRACT(Properties, '$.MetricName') as metric_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' + json_extract_path_text(Properties, 'MetricName') as metric_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' AND region = 'us-east-1' - dimension: - name: dimension - id: awscc.iot.dimension + dimensions: + name: dimensions + id: awscc.iot.dimensions x-cfn-schema-name: Dimension - x-type: get + x-cfn-type-name: AWS::IoT::Dimension x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dimension&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Dimension" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Dimension" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Dimension" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dimensions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dimensions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dimensions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3524,7 +6682,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3537,13 +6695,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Dimension' AND data__Identifier = '' AND region = 'us-east-1' - domain_configurations: - name: domain_configurations - id: awscc.iot.domain_configurations - x-cfn-schema-name: DomainConfiguration - x-type: list + dimensions_list_only: + name: dimensions_list_only + id: awscc.iot.dimensions_list_only + x-cfn-schema-name: Dimension + x-cfn-type-name: AWS::IoT::Dimension x-identifiers: - - DomainConfigurationName + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3551,28 +6715,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainConfigurationName') as domain_configuration_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainConfigurationName') as domain_configuration_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' AND region = 'us-east-1' - domain_configuration: - name: domain_configuration - id: awscc.iot.domain_configuration + domain_configurations: + name: domain_configurations + id: awscc.iot.domain_configurations x-cfn-schema-name: DomainConfiguration - x-type: get + x-cfn-type-name: AWS::IoT::DomainConfiguration x-identifiers: - DomainConfigurationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DomainConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::DomainConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::DomainConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::DomainConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3589,12 +6801,15 @@ components: JSON_EXTRACT(Properties, '$.ServerCertificateConfig') as server_certificate_config, JSON_EXTRACT(Properties, '$.ServerCertificates') as server_certificates, JSON_EXTRACT(Properties, '$.TlsConfig') as tls_config, + JSON_EXTRACT(Properties, '$.AuthenticationType') as authentication_type, + JSON_EXTRACT(Properties, '$.ApplicationProtocol') as application_protocol, + JSON_EXTRACT(Properties, '$.ClientCertificateConfig') as client_certificate_config, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3611,17 +6826,26 @@ components: json_extract_path_text(Properties, 'ServerCertificateConfig') as server_certificate_config, json_extract_path_text(Properties, 'ServerCertificates') as server_certificates, json_extract_path_text(Properties, 'TlsConfig') as tls_config, + json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, + json_extract_path_text(Properties, 'ApplicationProtocol') as application_protocol, + json_extract_path_text(Properties, 'ClientCertificateConfig') as client_certificate_config, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - fleet_metrics: - name: fleet_metrics - id: awscc.iot.fleet_metrics - x-cfn-schema-name: FleetMetric - x-type: list + domain_configurations_list_only: + name: domain_configurations_list_only + id: awscc.iot.domain_configurations_list_only + x-cfn-schema-name: DomainConfiguration + x-cfn-type-name: AWS::IoT::DomainConfiguration x-identifiers: - - MetricName + - DomainConfigurationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3629,28 +6853,194 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MetricName') as metric_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' + JSON_EXTRACT(Properties, '$.DomainConfigurationName') as domain_configuration_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'MetricName') as metric_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' + json_extract_path_text(Properties, 'DomainConfigurationName') as domain_configuration_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' + AND region = 'us-east-1' + encryption_configurations: + name: encryption_configurations + id: awscc.iot.encryption_configurations + x-cfn-schema-name: EncryptionConfiguration + x-cfn-type-name: AWS::IoT::EncryptionConfiguration + x-identifiers: + - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EncryptionConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::EncryptionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::EncryptionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::EncryptionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/encryption_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/encryption_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/encryption_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.EncryptionType') as encryption_type, + JSON_EXTRACT(Properties, '$.KmsAccessRoleArn') as kms_access_role_arn, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, + JSON_EXTRACT(Properties, '$.ConfigurationDetails') as configuration_details, + JSON_EXTRACT(Properties, '$.LastModifiedDate') as last_modified_date + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::EncryptionConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'EncryptionType') as encryption_type, + json_extract_path_text(Properties, 'KmsAccessRoleArn') as kms_access_role_arn, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'ConfigurationDetails') as configuration_details, + json_extract_path_text(Properties, 'LastModifiedDate') as last_modified_date + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::EncryptionConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + encryption_configurations_list_only: + name: encryption_configurations_list_only + id: awscc.iot.encryption_configurations_list_only + x-cfn-schema-name: EncryptionConfiguration + x-cfn-type-name: AWS::IoT::EncryptionConfiguration + x-identifiers: + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::EncryptionConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::EncryptionConfiguration' AND region = 'us-east-1' - fleet_metric: - name: fleet_metric - id: awscc.iot.fleet_metric + fleet_metrics: + name: fleet_metrics + id: awscc.iot.fleet_metrics x-cfn-schema-name: FleetMetric - x-type: get + x-cfn-type-name: AWS::IoT::FleetMetric x-identifiers: - MetricName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FleetMetric&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::FleetMetric" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::FleetMetric" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::FleetMetric" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3673,7 +7063,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3695,13 +7085,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::FleetMetric' AND data__Identifier = '' AND region = 'us-east-1' - job_templates: - name: job_templates - id: awscc.iot.job_templates - x-cfn-schema-name: JobTemplate - x-type: list + fleet_metrics_list_only: + name: fleet_metrics_list_only + id: awscc.iot.fleet_metrics_list_only + x-cfn-schema-name: FleetMetric + x-cfn-type-name: AWS::IoT::FleetMetric x-identifiers: - - JobTemplateId + - MetricName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3709,28 +7105,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.JobTemplateId') as job_template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' + JSON_EXTRACT(Properties, '$.MetricName') as metric_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'JobTemplateId') as job_template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' + json_extract_path_text(Properties, 'MetricName') as metric_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' AND region = 'us-east-1' - job_template: - name: job_template - id: awscc.iot.job_template + job_templates: + name: job_templates + id: awscc.iot.job_templates x-cfn-schema-name: JobTemplate - x-type: get + x-cfn-type-name: AWS::IoT::JobTemplate x-identifiers: - JobTemplateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__JobTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::JobTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::JobTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/job_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/job_templates/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3753,7 +7184,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3775,13 +7206,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::JobTemplate' AND data__Identifier = '' AND region = 'us-east-1' - loggings: - name: loggings - id: awscc.iot.loggings - x-cfn-schema-name: Logging - x-type: list + job_templates_list_only: + name: job_templates_list_only + id: awscc.iot.job_templates_list_only + x-cfn-schema-name: JobTemplate + x-cfn-type-name: AWS::IoT::JobTemplate x-identifiers: - - AccountId + - JobTemplateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3789,28 +7226,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' + JSON_EXTRACT(Properties, '$.JobTemplateId') as job_template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' + json_extract_path_text(Properties, 'JobTemplateId') as job_template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' AND region = 'us-east-1' - logging: - name: logging - id: awscc.iot.logging + loggings: + name: loggings + id: awscc.iot.loggings x-cfn-schema-name: Logging - x-type: get + x-cfn-type-name: AWS::IoT::Logging x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Logging&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Logging" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Logging" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Logging" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/loggings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/loggings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/loggings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3822,7 +7307,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3833,13 +7318,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Logging' AND data__Identifier = '' AND region = 'us-east-1' - mitigation_actions: - name: mitigation_actions - id: awscc.iot.mitigation_actions - x-cfn-schema-name: MitigationAction - x-type: list + loggings_list_only: + name: loggings_list_only + id: awscc.iot.loggings_list_only + x-cfn-schema-name: Logging + x-cfn-type-name: AWS::IoT::Logging x-identifiers: - - ActionName + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3847,28 +7338,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ActionName') as action_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ActionName') as action_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' AND region = 'us-east-1' - mitigation_action: - name: mitigation_action - id: awscc.iot.mitigation_action + mitigation_actions: + name: mitigation_actions + id: awscc.iot.mitigation_actions x-cfn-schema-name: MitigationAction - x-type: get + x-cfn-type-name: AWS::IoT::MitigationAction x-identifiers: - ActionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MitigationAction&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::MitigationAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::MitigationAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::MitigationAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3883,7 +7422,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3897,13 +7436,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::MitigationAction' AND data__Identifier = '' AND region = 'us-east-1' - policies: - name: policies - id: awscc.iot.policies - x-cfn-schema-name: Policy - x-type: list + mitigation_actions_list_only: + name: mitigation_actions_list_only + id: awscc.iot.mitigation_actions_list_only + x-cfn-schema-name: MitigationAction + x-cfn-type-name: AWS::IoT::MitigationAction x-identifiers: - - Id + - ActionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3911,28 +7456,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' + JSON_EXTRACT(Properties, '$.ActionName') as action_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' + json_extract_path_text(Properties, 'ActionName') as action_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' AND region = 'us-east-1' - policy: - name: policy - id: awscc.iot.policy + policies: + name: policies + id: awscc.iot.policies x-cfn-schema-name: Policy - x-type: get + x-cfn-type-name: AWS::IoT::Policy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3946,7 +7539,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3959,13 +7552,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Policy' AND data__Identifier = '' AND region = 'us-east-1' - provisioning_templates: - name: provisioning_templates - id: awscc.iot.provisioning_templates - x-cfn-schema-name: ProvisioningTemplate - x-type: list + policies_list_only: + name: policies_list_only + id: awscc.iot.policies_list_only + x-cfn-schema-name: Policy + x-cfn-type-name: AWS::IoT::Policy x-identifiers: - - TemplateName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3973,28 +7572,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TemplateName') as template_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' AND region = 'us-east-1' - provisioning_template: - name: provisioning_template - id: awscc.iot.provisioning_template + provisioning_templates: + name: provisioning_templates + id: awscc.iot.provisioning_templates x-cfn-schema-name: ProvisioningTemplate - x-type: get + x-cfn-type-name: AWS::IoT::ProvisioningTemplate x-identifiers: - TemplateName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProvisioningTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ProvisioningTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ProvisioningTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ProvisioningTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/provisioning_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/provisioning_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/provisioning_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4012,7 +7659,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4029,13 +7676,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' AND data__Identifier = '' AND region = 'us-east-1' - resource_specific_loggings: - name: resource_specific_loggings - id: awscc.iot.resource_specific_loggings - x-cfn-schema-name: ResourceSpecificLogging - x-type: list + provisioning_templates_list_only: + name: provisioning_templates_list_only + id: awscc.iot.provisioning_templates_list_only + x-cfn-schema-name: ProvisioningTemplate + x-cfn-type-name: AWS::IoT::ProvisioningTemplate x-identifiers: - - TargetId + - TemplateName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4043,28 +7696,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TargetId') as target_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' + JSON_EXTRACT(Properties, '$.TemplateName') as template_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TargetId') as target_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' AND region = 'us-east-1' - resource_specific_logging: - name: resource_specific_logging - id: awscc.iot.resource_specific_logging + resource_specific_loggings: + name: resource_specific_loggings + id: awscc.iot.resource_specific_loggings x-cfn-schema-name: ResourceSpecificLogging - x-type: get + x-cfn-type-name: AWS::IoT::ResourceSpecificLogging x-identifiers: - TargetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceSpecificLogging&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ResourceSpecificLogging" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ResourceSpecificLogging" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ResourceSpecificLogging" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4077,7 +7778,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4089,13 +7790,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' AND data__Identifier = '' AND region = 'us-east-1' - role_aliases: - name: role_aliases - id: awscc.iot.role_aliases - x-cfn-schema-name: RoleAlias - x-type: list + resource_specific_loggings_list_only: + name: resource_specific_loggings_list_only + id: awscc.iot.resource_specific_loggings_list_only + x-cfn-schema-name: ResourceSpecificLogging + x-cfn-type-name: AWS::IoT::ResourceSpecificLogging x-identifiers: - - RoleAlias + - TargetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4103,28 +7810,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RoleAlias') as role_alias - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' + JSON_EXTRACT(Properties, '$.TargetId') as target_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RoleAlias') as role_alias - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' + json_extract_path_text(Properties, 'TargetId') as target_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' AND region = 'us-east-1' - role_alias: - name: role_alias - id: awscc.iot.role_alias + role_aliases: + name: role_aliases + id: awscc.iot.role_aliases x-cfn-schema-name: RoleAlias - x-type: get + x-cfn-type-name: AWS::IoT::RoleAlias x-identifiers: - RoleAlias + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RoleAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::RoleAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::RoleAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::RoleAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/role_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/role_aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/role_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4138,7 +7893,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4151,13 +7906,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::RoleAlias' AND data__Identifier = '' AND region = 'us-east-1' - scheduled_audits: - name: scheduled_audits - id: awscc.iot.scheduled_audits - x-cfn-schema-name: ScheduledAudit - x-type: list + role_aliases_list_only: + name: role_aliases_list_only + id: awscc.iot.role_aliases_list_only + x-cfn-schema-name: RoleAlias + x-cfn-type-name: AWS::IoT::RoleAlias x-identifiers: - - ScheduledAuditName + - RoleAlias + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4165,28 +7926,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ScheduledAuditName') as scheduled_audit_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' + JSON_EXTRACT(Properties, '$.RoleAlias') as role_alias + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ScheduledAuditName') as scheduled_audit_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' + json_extract_path_text(Properties, 'RoleAlias') as role_alias + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' AND region = 'us-east-1' - scheduled_audit: - name: scheduled_audit - id: awscc.iot.scheduled_audit + scheduled_audits: + name: scheduled_audits + id: awscc.iot.scheduled_audits x-cfn-schema-name: ScheduledAudit - x-type: get + x-cfn-type-name: AWS::IoT::ScheduledAudit x-identifiers: - ScheduledAuditName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScheduledAudit&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ScheduledAudit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ScheduledAudit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ScheduledAudit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4202,7 +8011,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4217,13 +8026,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' AND data__Identifier = '' AND region = 'us-east-1' - security_profiles: - name: security_profiles - id: awscc.iot.security_profiles - x-cfn-schema-name: SecurityProfile - x-type: list + scheduled_audits_list_only: + name: scheduled_audits_list_only + id: awscc.iot.scheduled_audits_list_only + x-cfn-schema-name: ScheduledAudit + x-cfn-type-name: AWS::IoT::ScheduledAudit x-identifiers: - - SecurityProfileName + - ScheduledAuditName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4231,28 +8046,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SecurityProfileName') as security_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' + JSON_EXTRACT(Properties, '$.ScheduledAuditName') as scheduled_audit_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' + json_extract_path_text(Properties, 'ScheduledAuditName') as scheduled_audit_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' AND region = 'us-east-1' - security_profile: - name: security_profile - id: awscc.iot.security_profile + security_profiles: + name: security_profiles + id: awscc.iot.security_profiles x-cfn-schema-name: SecurityProfile - x-type: get + x-cfn-type-name: AWS::IoT::SecurityProfile x-identifiers: - SecurityProfileName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SecurityProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SecurityProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SecurityProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4270,7 +8133,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4287,13 +8150,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SecurityProfile' AND data__Identifier = '' AND region = 'us-east-1' - software_packages: - name: software_packages - id: awscc.iot.software_packages - x-cfn-schema-name: SoftwarePackage - x-type: list + security_profiles_list_only: + name: security_profiles_list_only + id: awscc.iot.security_profiles_list_only + x-cfn-schema-name: SecurityProfile + x-cfn-type-name: AWS::IoT::SecurityProfile x-identifiers: - - PackageName + - SecurityProfileName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4301,28 +8170,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PackageName') as package_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' + JSON_EXTRACT(Properties, '$.SecurityProfileName') as security_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PackageName') as package_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' + json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' AND region = 'us-east-1' - software_package: - name: software_package - id: awscc.iot.software_package + software_packages: + name: software_packages + id: awscc.iot.software_packages x-cfn-schema-name: SoftwarePackage - x-type: get + x-cfn-type-name: AWS::IoT::SoftwarePackage x-identifiers: - PackageName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SoftwarePackage&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SoftwarePackage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SoftwarePackage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SoftwarePackage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/software_packages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/software_packages/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/software_packages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4335,7 +8252,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4347,14 +8264,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' AND data__Identifier = '' AND region = 'us-east-1' - software_package_versions: - name: software_package_versions - id: awscc.iot.software_package_versions - x-cfn-schema-name: SoftwarePackageVersion - x-type: list + software_packages_list_only: + name: software_packages_list_only + id: awscc.iot.software_packages_list_only + x-cfn-schema-name: SoftwarePackage + x-cfn-type-name: AWS::IoT::SoftwarePackage x-identifiers: - PackageName - - VersionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4362,40 +8284,90 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PackageName') as package_name, - JSON_EXTRACT(Properties, '$.VersionName') as version_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' + JSON_EXTRACT(Properties, '$.PackageName') as package_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PackageName') as package_name, - json_extract_path_text(Properties, 'VersionName') as version_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' + json_extract_path_text(Properties, 'PackageName') as package_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' AND region = 'us-east-1' - software_package_version: - name: software_package_version - id: awscc.iot.software_package_version + software_package_versions: + name: software_package_versions + id: awscc.iot.software_package_versions x-cfn-schema-name: SoftwarePackageVersion - x-type: get + x-cfn-type-name: AWS::IoT::SoftwarePackageVersion x-identifiers: - PackageName - VersionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SoftwarePackageVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SoftwarePackageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SoftwarePackageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::SoftwarePackageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Attributes') as attributes, + JSON_EXTRACT(Properties, '$.Artifact') as artifact, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.ErrorReason') as error_reason, JSON_EXTRACT(Properties, '$.PackageName') as package_name, JSON_EXTRACT(Properties, '$.PackageVersionArn') as package_version_arn, + JSON_EXTRACT(Properties, '$.Recipe') as recipe, + JSON_EXTRACT(Properties, '$.Sbom') as sbom, + JSON_EXTRACT(Properties, '$.SbomValidationStatus') as sbom_validation_status, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.VersionName') as version_name @@ -4403,29 +8375,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Attributes') as attributes, + json_extract_path_text(Properties, 'Artifact') as artifact, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'ErrorReason') as error_reason, json_extract_path_text(Properties, 'PackageName') as package_name, json_extract_path_text(Properties, 'PackageVersionArn') as package_version_arn, + json_extract_path_text(Properties, 'Recipe') as recipe, + json_extract_path_text(Properties, 'Sbom') as sbom, + json_extract_path_text(Properties, 'SbomValidationStatus') as sbom_validation_status, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'VersionName') as version_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' AND data__Identifier = '|' AND region = 'us-east-1' - things: - name: things - id: awscc.iot.things - x-cfn-schema-name: Thing - x-type: list + software_package_versions_list_only: + name: software_package_versions_list_only + id: awscc.iot.software_package_versions_list_only + x-cfn-schema-name: SoftwarePackageVersion + x-cfn-type-name: AWS::IoT::SoftwarePackageVersion x-identifiers: - - ThingName + - PackageName + - VersionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4433,28 +8416,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ThingName') as thing_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' + JSON_EXTRACT(Properties, '$.PackageName') as package_name, + JSON_EXTRACT(Properties, '$.VersionName') as version_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ThingName') as thing_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' + json_extract_path_text(Properties, 'PackageName') as package_name, + json_extract_path_text(Properties, 'VersionName') as version_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' AND region = 'us-east-1' - thing: - name: thing - id: awscc.iot.thing + things: + name: things + id: awscc.iot.things x-cfn-schema-name: Thing - x-type: get + x-cfn-type-name: AWS::IoT::Thing x-identifiers: - ThingName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Thing&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Thing" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Thing" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::Thing" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/things/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/things/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/things/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4467,7 +8500,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4479,13 +8512,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Thing' AND data__Identifier = '' AND region = 'us-east-1' - thing_groups: - name: thing_groups - id: awscc.iot.thing_groups - x-cfn-schema-name: ThingGroup - x-type: list + things_list_only: + name: things_list_only + id: awscc.iot.things_list_only + x-cfn-schema-name: Thing + x-cfn-type-name: AWS::IoT::Thing x-identifiers: - - ThingGroupName + - ThingName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4493,28 +8532,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ThingGroupName') as thing_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' + JSON_EXTRACT(Properties, '$.ThingName') as thing_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ThingGroupName') as thing_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' + json_extract_path_text(Properties, 'ThingName') as thing_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' AND region = 'us-east-1' - thing_group: - name: thing_group - id: awscc.iot.thing_group + thing_groups: + name: thing_groups + id: awscc.iot.thing_groups x-cfn-schema-name: ThingGroup - x-type: get + x-cfn-type-name: AWS::IoT::ThingGroup x-identifiers: - ThingGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ThingGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ThingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ThingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ThingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/thing_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/thing_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/thing_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4530,7 +8617,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4545,13 +8632,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ThingGroup' AND data__Identifier = '' AND region = 'us-east-1' - thing_types: - name: thing_types - id: awscc.iot.thing_types - x-cfn-schema-name: ThingType - x-type: list + thing_groups_list_only: + name: thing_groups_list_only + id: awscc.iot.thing_groups_list_only + x-cfn-schema-name: ThingGroup + x-cfn-type-name: AWS::IoT::ThingGroup x-identifiers: - - ThingTypeName + - ThingGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4559,28 +8652,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ThingTypeName') as thing_type_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' + JSON_EXTRACT(Properties, '$.ThingGroupName') as thing_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ThingTypeName') as thing_type_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' + json_extract_path_text(Properties, 'ThingGroupName') as thing_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' AND region = 'us-east-1' - thing_type: - name: thing_type - id: awscc.iot.thing_type + thing_types: + name: thing_types + id: awscc.iot.thing_types x-cfn-schema-name: ThingType - x-type: get + x-cfn-type-name: AWS::IoT::ThingType x-identifiers: - ThingTypeName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ThingType&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ThingType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ThingType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ThingType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/thing_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/thing_types/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/thing_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4595,7 +8736,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4609,13 +8750,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ThingType' AND data__Identifier = '' AND region = 'us-east-1' - topic_rules: - name: topic_rules - id: awscc.iot.topic_rules - x-cfn-schema-name: TopicRule - x-type: list + thing_types_list_only: + name: thing_types_list_only + id: awscc.iot.thing_types_list_only + x-cfn-schema-name: ThingType + x-cfn-type-name: AWS::IoT::ThingType x-identifiers: - - RuleName + - ThingTypeName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4623,28 +8770,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RuleName') as rule_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' + JSON_EXTRACT(Properties, '$.ThingTypeName') as thing_type_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RuleName') as rule_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' + json_extract_path_text(Properties, 'ThingTypeName') as thing_type_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' AND region = 'us-east-1' - topic_rule: - name: topic_rule - id: awscc.iot.topic_rule + topic_rules: + name: topic_rules + id: awscc.iot.topic_rules x-cfn-schema-name: TopicRule - x-type: get + x-cfn-type-name: AWS::IoT::TopicRule x-identifiers: - RuleName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TopicRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::TopicRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::TopicRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::TopicRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topic_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topic_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/topic_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4657,7 +8852,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4669,13 +8864,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::TopicRule' AND data__Identifier = '' AND region = 'us-east-1' - topic_rule_destinations: - name: topic_rule_destinations - id: awscc.iot.topic_rule_destinations - x-cfn-schema-name: TopicRuleDestination - x-type: list + topic_rules_list_only: + name: topic_rules_list_only + id: awscc.iot.topic_rules_list_only + x-cfn-schema-name: TopicRule + x-cfn-type-name: AWS::IoT::TopicRule x-identifiers: - - Arn + - RuleName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -4683,28 +8884,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' + JSON_EXTRACT(Properties, '$.RuleName') as rule_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' + json_extract_path_text(Properties, 'RuleName') as rule_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' AND region = 'us-east-1' - topic_rule_destination: - name: topic_rule_destination - id: awscc.iot.topic_rule_destination + topic_rule_destinations: + name: topic_rule_destinations + id: awscc.iot.topic_rule_destinations x-cfn-schema-name: TopicRuleDestination - x-type: get + x-cfn-type-name: AWS::IoT::TopicRuleDestination x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TopicRuleDestination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::TopicRuleDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::TopicRuleDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::TopicRuleDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4718,7 +8967,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4731,3 +8980,1363 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' AND data__Identifier = '' AND region = 'us-east-1' + topic_rule_destinations_list_only: + name: topic_rule_destinations_list_only + id: awscc.iot.topic_rule_destinations_list_only + x-cfn-schema-name: TopicRuleDestination + x-cfn-type-name: AWS::IoT::TopicRuleDestination + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccountAuditConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccountAuditConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccountAuditConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Authorizer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAuthorizer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAuthorizerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BillingGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBillingGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBillingGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CACertificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCACertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCACertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CertificateProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificateProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Command&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCommand + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCommandRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomMetric&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomMetric + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomMetricRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dimension&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDimension + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDimensionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DomainConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomainConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EncryptionConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEncryptionConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEncryptionConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FleetMetric&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFleetMetric + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFleetMetricRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__JobTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateJobTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateJobTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Logging&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLogging + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoggingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MitigationAction&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMitigationAction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMitigationActionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProvisioningTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProvisioningTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProvisioningTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceSpecificLogging&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceSpecificLogging + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceSpecificLoggingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RoleAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoleAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoleAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScheduledAudit&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScheduledAudit + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduledAuditRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SoftwarePackage&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSoftwarePackage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSoftwarePackageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SoftwarePackageVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSoftwarePackageVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSoftwarePackageVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Thing&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateThing + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ThingGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateThingGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThingGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ThingType&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateThingType + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThingTypeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TopicRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTopicRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTopicRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TopicRuleDestination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTopicRuleDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTopicRuleDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iotanalytics.yaml b/providers/src/awscc/v00.00.00000/services/iotanalytics.yaml index 80d1c0ca..298b8a69 100644 --- a/providers/src/awscc/v00.00.00000/services/iotanalytics.yaml +++ b/providers/src/awscc/v00.00.00000/services/iotanalytics.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTAnalytics - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: CustomerManagedS3: type: object @@ -420,12 +800,17 @@ components: required: - Actions x-stackql-resource-name: dataset - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoTAnalytics::Dataset + x-type-name: AWS::IoTAnalytics::Dataset + x-stackql-primary-identifier: - DatasetName x-create-only-properties: - DatasetName x-read-only-properties: - Id + x-required-properties: + - Actions + x-taggable: true x-required-permissions: create: - iotanalytics:CreateDataset @@ -804,12 +1189,17 @@ components: required: - PipelineActivities x-stackql-resource-name: pipeline - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IoTAnalytics::Pipeline + x-type-name: AWS::IoTAnalytics::Pipeline + x-stackql-primary-identifier: - PipelineName x-create-only-properties: - PipelineName x-read-only-properties: - Id + x-required-properties: + - PipelineActivities + x-taggable: true x-required-permissions: create: - iotanalytics:CreatePipeline @@ -824,43 +1214,181 @@ components: - iotanalytics:DeletePipeline list: - iotanalytics:ListPipelines + CreateDatasetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Actions: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/Action' + LateDataRules: + type: array + minItems: 1 + maxItems: 1 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/LateDataRule' + DatasetName: + type: string + pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$) + minLength: 1 + maxLength: 128 + ContentDeliveryRules: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 0 + maxItems: 20 + items: + $ref: '#/components/schemas/DatasetContentDeliveryRule' + Triggers: + type: array + minItems: 0 + maxItems: 5 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Trigger' + VersioningConfiguration: + $ref: '#/components/schemas/VersioningConfiguration' + Id: + type: string + RetentionPeriod: + $ref: '#/components/schemas/RetentionPeriod' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDatasetRequest + type: object + required: [] + CreatePipelineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + PipelineName: + type: string + pattern: '[a-zA-Z0-9_]+' + minLength: 1 + maxLength: 128 + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + PipelineActivities: + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 25 + items: + $ref: '#/components/schemas/Activity' + x-stackQL-stringOnly: true + x-title: CreatePipelineRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: datasets: name: datasets id: awscc.iotanalytics.datasets x-cfn-schema-name: Dataset - x-type: list - x-identifiers: - - DatasetName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatasetName') as dataset_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatasetName') as dataset_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: awscc.iotanalytics.dataset - x-cfn-schema-name: Dataset - x-type: get + x-cfn-type-name: AWS::IoTAnalytics::Dataset x-identifiers: - DatasetName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTAnalytics::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTAnalytics::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTAnalytics::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -878,7 +1406,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -895,13 +1423,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' AND data__Identifier = '' AND region = 'us-east-1' - pipelines: - name: pipelines - id: awscc.iotanalytics.pipelines - x-cfn-schema-name: Pipeline - x-type: list + datasets_list_only: + name: datasets_list_only + id: awscc.iotanalytics.datasets_list_only + x-cfn-schema-name: Dataset + x-cfn-type-name: AWS::IoTAnalytics::Dataset x-identifiers: - - PipelineName + - DatasetName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -909,28 +1443,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' + JSON_EXTRACT(Properties, '$.DatasetName') as dataset_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' + json_extract_path_text(Properties, 'DatasetName') as dataset_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' AND region = 'us-east-1' - pipeline: - name: pipeline - id: awscc.iotanalytics.pipeline + pipelines: + name: pipelines + id: awscc.iotanalytics.pipelines x-cfn-schema-name: Pipeline - x-type: get + x-cfn-type-name: AWS::IoTAnalytics::Pipeline x-identifiers: - PipelineName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTAnalytics::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTAnalytics::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTAnalytics::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -943,7 +1525,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -955,3 +1537,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' AND data__Identifier = '' AND region = 'us-east-1' + pipelines_list_only: + name: pipelines_list_only + id: awscc.iotanalytics.pipelines_list_only + x-cfn-schema-name: Pipeline + x-cfn-type-name: AWS::IoTAnalytics::Pipeline + x-identifiers: + - PipelineName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineName') as pipeline_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePipeline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePipelineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iotcoredeviceadvisor.yaml b/providers/src/awscc/v00.00.00000/services/iotcoredeviceadvisor.yaml index 1e37c438..aef249c1 100644 --- a/providers/src/awscc/v00.00.00000/services/iotcoredeviceadvisor.yaml +++ b/providers/src/awscc/v00.00.00000/services/iotcoredeviceadvisor.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTCoreDeviceAdvisor - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DeviceUnderTest: type: object @@ -105,12 +485,26 @@ components: required: - SuiteDefinitionConfiguration x-stackql-resource-name: suite_definition - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::IoTCoreDeviceAdvisor::SuiteDefinition + x-stackql-primary-identifier: - SuiteDefinitionId x-read-only-properties: - SuiteDefinitionId - SuiteDefinitionArn - SuiteDefinitionVersion + x-required-properties: + - SuiteDefinitionConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotdeviceadvisor:TagResource + - iotdeviceadvisor:UntagResource + - iot:ListTagsForResource x-required-permissions: create: - iot:DescribeCertificate @@ -119,7 +513,6 @@ components: - iot:ListAttachedPolicies - iot:ListCertificates - iot:ListPrincipalPolicies - - iot:ListTagsForResource - iot:ListThingPrincipals - iot:ListThings - iotdeviceadvisor:CreateSuiteDefinition @@ -127,7 +520,7 @@ components: - iam:PassRole read: - iotdeviceadvisor:GetSuiteDefinition - - iotdeviceadvisor:TagResource + - iot:ListTagsForResource update: - iot:DescribeCertificate - iot:DescribeThing @@ -135,7 +528,6 @@ components: - iot:ListAttachedPolicies - iot:ListCertificates - iot:ListPrincipalPolicies - - iot:ListTagsForResource - iot:ListThingPrincipals - iot:ListThings - iotdeviceadvisor:UpdateSuiteDefinition @@ -148,39 +540,168 @@ components: - iotdeviceadvisor:DeleteSuiteDefinition list: - iotdeviceadvisor:ListSuiteDefinitions + CreateSuiteDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SuiteDefinitionConfiguration: + type: object + properties: + DevicePermissionRoleArn: + $ref: '#/components/schemas/DevicePermissionRoleArn' + Devices: + $ref: '#/components/schemas/Devices' + IntendedForQualification: + $ref: '#/components/schemas/IntendedForQualification' + RootGroup: + $ref: '#/components/schemas/RootGroup' + SuiteDefinitionName: + $ref: '#/components/schemas/SuiteDefinitionName' + required: + - DevicePermissionRoleArn + - RootGroup + additionalProperties: false + SuiteDefinitionId: + type: string + maxLength: 36 + minLength: 12 + description: The unique identifier for the suite definition. + SuiteDefinitionArn: + type: string + maxLength: 2048 + minLength: 20 + description: The Amazon Resource name for the suite definition. + SuiteDefinitionVersion: + type: string + maxLength: 255 + minLength: 2 + description: The suite definition version of a test suite. + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSuiteDefinitionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: suite_definitions: name: suite_definitions id: awscc.iotcoredeviceadvisor.suite_definitions x-cfn-schema-name: SuiteDefinition - x-type: list + x-cfn-type-name: AWS::IoTCoreDeviceAdvisor::SuiteDefinition x-identifiers: - SuiteDefinitionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SuiteDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTCoreDeviceAdvisor::SuiteDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTCoreDeviceAdvisor::SuiteDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTCoreDeviceAdvisor::SuiteDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SuiteDefinitionId') as suite_definition_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' + data__Identifier, + JSON_EXTRACT(Properties, '$.SuiteDefinitionConfiguration') as suite_definition_configuration, + JSON_EXTRACT(Properties, '$.SuiteDefinitionId') as suite_definition_id, + JSON_EXTRACT(Properties, '$.SuiteDefinitionArn') as suite_definition_arn, + JSON_EXTRACT(Properties, '$.SuiteDefinitionVersion') as suite_definition_version, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' + data__Identifier, + json_extract_path_text(Properties, 'SuiteDefinitionConfiguration') as suite_definition_configuration, + json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id, + json_extract_path_text(Properties, 'SuiteDefinitionArn') as suite_definition_arn, + json_extract_path_text(Properties, 'SuiteDefinitionVersion') as suite_definition_version, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' + AND data__Identifier = '' AND region = 'us-east-1' - suite_definition: - name: suite_definition - id: awscc.iotcoredeviceadvisor.suite_definition + suite_definitions_list_only: + name: suite_definitions_list_only + id: awscc.iotcoredeviceadvisor.suite_definitions_list_only x-cfn-schema-name: SuiteDefinition - x-type: get + x-cfn-type-name: AWS::IoTCoreDeviceAdvisor::SuiteDefinition x-identifiers: - SuiteDefinitionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -188,26 +709,209 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.SuiteDefinitionConfiguration') as suite_definition_configuration, - JSON_EXTRACT(Properties, '$.SuiteDefinitionId') as suite_definition_id, - JSON_EXTRACT(Properties, '$.SuiteDefinitionArn') as suite_definition_arn, - JSON_EXTRACT(Properties, '$.SuiteDefinitionVersion') as suite_definition_version, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SuiteDefinitionId') as suite_definition_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SuiteDefinitionConfiguration') as suite_definition_configuration, - json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id, - json_extract_path_text(Properties, 'SuiteDefinitionArn') as suite_definition_arn, - json_extract_path_text(Properties, 'SuiteDefinitionVersion') as suite_definition_version, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' - AND data__Identifier = '' + json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SuiteDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSuiteDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSuiteDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iotevents.yaml b/providers/src/awscc/v00.00.00000/services/iotevents.yaml index ac4177b8..d996aa08 100644 --- a/providers/src/awscc/v00.00.00000/services/iotevents.yaml +++ b/providers/src/awscc/v00.00.00000/services/iotevents.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTEvents - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AlarmRule: type: object @@ -12,6 +392,7 @@ components: properties: SimpleRule: $ref: '#/components/schemas/SimpleRule' + description: A rule that compares an input property value to a threshold value with a comparison operator. SimpleRule: type: object additionalProperties: false @@ -21,7 +402,7 @@ components: type: string minLength: 1 maxLength: 512 - description: The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property. + description: The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property. ComparisonOperator: type: string enum: @@ -36,7 +417,7 @@ components: type: string minLength: 1 maxLength: 512 - description: The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute. + description: The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute. required: - InputProperty - ComparisonOperator @@ -48,15 +429,18 @@ components: properties: AlarmActions: $ref: '#/components/schemas/AlarmActions' + description: Specifies one or more supported actions to receive notifications when the alarm state changes. AlarmCapabilities: type: object - description: Contains the configuration information of alarm state changes + description: Contains the configuration information of alarm state changes. additionalProperties: false properties: InitializationConfiguration: $ref: '#/components/schemas/InitializationConfiguration' + description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. AcknowledgeFlow: $ref: '#/components/schemas/AcknowledgeFlow' + description: Specifies whether to get notified for alarm state changes. AlarmActions: type: array description: Specifies one or more supported actions to receive notifications when the alarm state changes. @@ -67,88 +451,143 @@ components: AlarmAction: type: object additionalProperties: false - description: The actions to be performed. + description: Specifies one of the following actions to receive notifications when the alarm state changes. properties: DynamoDB: $ref: '#/components/schemas/DynamoDB' + description: |- + Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. + You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``. + + For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template. + ``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`` + + For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``tableName`` parameter uses a string concatenation. + ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. + If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``_raw``. DynamoDBv2: $ref: '#/components/schemas/DynamoDBv2' + description: |- + Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. + You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``. + + For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template. + ``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'`` + + For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``tableName`` parameter uses a string concatenation. + ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. + The value for the ``type`` parameter in ``Payload`` must be ``JSON``. Firehose: $ref: '#/components/schemas/Firehose' + description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. IotEvents: $ref: '#/components/schemas/IotEvents' + description: Sends an ITE input, passing in information about the detector model instance and the event that triggered the action. IotSiteWise: $ref: '#/components/schemas/IotSiteWise' + description: |- + Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW. + You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``. + + For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``propertyAlias`` parameter uses a substitution template. + ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`` + + You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW. + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. IotTopicPublish: $ref: '#/components/schemas/IotTopicPublish' + description: Information required to publish the MQTT message through the IoT message broker. Lambda: $ref: '#/components/schemas/Lambda' + description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. Sns: $ref: '#/components/schemas/Sns' + description: Information required to publish the Amazon SNS message. Sqs: $ref: '#/components/schemas/Sqs' + description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue. DynamoDB: type: object additionalProperties: false - description: >- - Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see - [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide*. + description: |- + Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. + You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``. + + For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template. + ``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`` + + For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``tableName`` parameter uses a string concatenation. + ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. + If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``_raw``. properties: HashKeyField: type: string - description: The name of the hash key (also called the partition key). + description: The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table. HashKeyType: type: string description: |- The data type for the hash key (also called the partition key). You can specify the following values: - - * `STRING` - The hash key is a string. - - * `NUMBER` - The hash key is a number. - - If you don't specify `hashKeyType`, the default value is `STRING`. + + ``'STRING'`` - The hash key is a string. + + ``'NUMBER'`` - The hash key is a number. + + If you don't specify ``hashKeyType``, the default value is ``'STRING'``. HashKeyValue: type: string description: The value of the hash key (also called the partition key). Operation: type: string description: |- - The type of operation to perform. You can specify the following values: - - * `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. - - * `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. - - * `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. - - If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation. + The type of operation to perform. You can specify the following values: + + ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. + + ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. + + ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. + + If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation. Payload: $ref: '#/components/schemas/Payload' + description: |- + Information needed to configure the payload. + By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``. PayloadField: type: string description: |- The name of the DynamoDB column that receives the action payload. - - If you don't specify this parameter, the name of the DynamoDB column is `payload`. + If you don't specify this parameter, the name of the DynamoDB column is ``payload``. RangeKeyField: type: string - description: The name of the range key (also called the sort key). + description: The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table. RangeKeyType: type: string description: |- The data type for the range key (also called the sort key), You can specify the following values: - - * `STRING` - The range key is a string. - - * `NUMBER` - The range key is number. - - If you don't specify `rangeKeyField`, the default value is `STRING`. + + ``'STRING'`` - The range key is a string. + + ``'NUMBER'`` - The range key is number. + + If you don't specify ``rangeKeyField``, the default value is ``'STRING'``. RangeKeyValue: type: string description: The value of the range key (also called the sort key). TableName: type: string - description: The name of the DynamoDB table. + description: The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table. required: - HashKeyField - HashKeyValue @@ -157,12 +596,26 @@ components: type: object additionalProperties: false description: |- - Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. - - You can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*. + Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. + You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``. + + For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template. + ``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'`` + + For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``tableName`` parameter uses a string concatenation. + ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. + The value for the ``type`` parameter in ``Payload`` must be ``JSON``. properties: Payload: $ref: '#/components/schemas/Payload' + description: |- + Information needed to configure the payload. + By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``. TableName: type: string description: The name of the DynamoDB table. @@ -178,6 +631,7 @@ components: description: The name of the Kinesis Data Firehose delivery stream where the data is written. Payload: $ref: '#/components/schemas/Payload' + description: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream. Separator: type: string description: 'A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: ''\n'' (newline), ''\t'' (tab), ''\r\n'' (Windows newline), '','' (comma).' @@ -187,51 +641,65 @@ components: IotEvents: type: object additionalProperties: false - description: Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action. + description: Sends an ITE input, passing in information about the detector model instance and the event that triggered the action. properties: InputName: type: string - description: The name of the AWS IoT Events input where the data is sent. + description: The name of the ITE input where the data is sent. minLength: 1 maxLength: 128 pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ Payload: $ref: '#/components/schemas/Payload' + description: You can configure the action payload when you send a message to an ITE input. required: - InputName IotSiteWise: type: object additionalProperties: false - description: Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise. + description: |- + Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW. + You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``. + + For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``propertyAlias`` parameter uses a substitution template. + ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`` + + You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW. + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. properties: AssetId: type: string - description: The ID of the asset that has the specified property. You can specify an expression. + description: The ID of the asset that has the specified property. EntryId: type: string - description: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression. + description: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. PropertyAlias: type: string - description: The alias of the asset property. You can also specify an expression. + description: The alias of the asset property. PropertyId: type: string - description: The ID of the asset property. You can specify an expression. + description: The ID of the asset property. PropertyValue: $ref: '#/components/schemas/AssetPropertyValue' + description: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. required: - PropertyValue IotTopicPublish: type: object additionalProperties: false - description: Information required to publish the MQTT message through the AWS IoT message broker. + description: Information required to publish the MQTT message through the IoT message broker. properties: MqttTopic: type: string - description: The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string. + description: The MQTT topic of the message. You can use a string expression that includes variables (``$variable.``) and input values (``$input..``) as the topic string. minLength: 1 maxLength: 128 Payload: $ref: '#/components/schemas/Payload' + description: You can configure the action payload when you publish a message to an IoTCore topic. required: - MqttTopic Lambda: @@ -245,8 +713,10 @@ components: maxLength: 2048 Payload: $ref: '#/components/schemas/Payload' + description: You can configure the action payload when you send a message to a Lambda function. required: - FunctionArn + description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. Sns: type: object additionalProperties: false @@ -254,6 +724,7 @@ components: properties: Payload: $ref: '#/components/schemas/Payload' + description: You can configure the action payload when you send a message as an Amazon SNS push notification. TargetArn: type: string description: The ARN of the Amazon SNS target where the message is sent. @@ -267,29 +738,30 @@ components: properties: Payload: $ref: '#/components/schemas/Payload' + description: You can configure the action payload when you send a message to an Amazon SQS queue. QueueUrl: type: string description: The URL of the SQS queue where the data is written. UseBase64: type: boolean - description: Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`. + description: Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE. required: - QueueUrl + description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue. Payload: type: object additionalProperties: false description: |- Information needed to configure the payload. - - By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`. + By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``. properties: ContentExpression: type: string - description: The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. + description: The content of the payload. You can use a string expression that includes quoted strings (``''``), variables (``$variable.``), input values (``$input..``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB. minLength: 1 Type: type: string - description: The value of the payload type can be either `STRING` or `JSON`. + description: The value of the payload type can be either ``STRING`` or ``JSON``. required: - ContentExpression - Type @@ -300,7 +772,7 @@ components: properties: DisabledOnInitialization: type: boolean - description: The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE. + description: The value must be ``TRUE`` or ``FALSE``. If ``FALSE``, all alarm instances created based on the alarm model are activated. The default value is ``TRUE``. default: 'true' required: - DisabledOnInitialization @@ -311,62 +783,92 @@ components: properties: Enabled: type: boolean - description: The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range. + description: The value must be ``TRUE`` or ``FALSE``. If ``TRUE``, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to ``NORMAL``. If ``FALSE``, you won't receive notifications. The alarm automatically changes to the ``NORMAL`` state when the input property value returns to the specified range. default: 'true' AssetPropertyValue: type: object additionalProperties: false - description: A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference*. + description: |- + A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*. + You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``. + + For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``. + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. properties: Quality: type: string - description: The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression. + description: The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``. Timestamp: $ref: '#/components/schemas/AssetPropertyTimestamp' + description: The timestamp associated with the asset property value. The default is the current event time. Value: $ref: '#/components/schemas/AssetPropertyVariant' + description: The value to send to an asset property. required: - Value AssetPropertyTimestamp: type: object additionalProperties: false - description: A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference*. + description: |- + A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*. + You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``. + + For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template. + ``'${$input.TemperatureInput.sensorData.timestamp / 1000}'`` + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. properties: OffsetInNanos: type: string - description: The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression. + description: The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999. TimeInSeconds: type: string - description: The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression. + description: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. required: - TimeInSeconds AssetPropertyVariant: type: object additionalProperties: false - description: A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference*. + description: |- + A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*. + You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates. + **Examples** + + For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``. + + For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``. + + For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. + In the following example, the value for the ``doubleValue`` parameter uses a substitution template. + ``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`` + + For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*. + You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*. properties: BooleanValue: type: string - description: The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value. + description: The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value. DoubleValue: type: string - description: The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double. + description: The asset property value is a double. You must use an expression, and the evaluated result should be a double. IntegerValue: type: string - description: The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer. + description: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer. StringValue: type: string - description: The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string. + description: The asset property value is a string. You must use an expression, and the evaluated result should be a string. Tag: type: object additionalProperties: false - description: Tags to be applied to Input. + description: Metadata that can be used to manage the resource. properties: Key: - description: Key of the Tag. + description: The tag's key. type: string Value: - description: Value of the Tag. + description: The tag's value. type: string required: - Value @@ -382,54 +884,66 @@ components: pattern: ^[a-zA-Z0-9_-]+$ AlarmModelDescription: type: string - description: A brief description of the alarm model. + description: The description of the alarm model. maxLength: 1024 RoleArn: type: string - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. + description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. minLength: 1 maxLength: 2048 Key: type: string - description: |- - The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information. - - This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value. + description: An input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm. minLength: 1 maxLength: 128 pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$ Severity: type: integer - description: |+ - A non-negative integer that reflects the severity level of the alarm. - + description: A non-negative integer that reflects the severity level of the alarm. minimum: 0 maximum: 2147483647 AlarmRule: $ref: '#/components/schemas/AlarmRule' + description: Defines when your alarm is invoked. AlarmEventActions: $ref: '#/components/schemas/AlarmEventActions' + description: Contains information about one or more alarm actions. AlarmCapabilities: $ref: '#/components/schemas/AlarmCapabilities' + description: Contains the configuration information of alarm state changes. Tags: type: array uniqueItems: false x-insertionOrder: false description: |- - An array of key-value pairs to apply to this resource. - - For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*. + You can create up to 50 tags for one alarm model. items: $ref: '#/components/schemas/Tag' required: - RoleArn - AlarmRule x-stackql-resource-name: alarm_model - x-stackql-primaryIdentifier: + description: Represents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*. + x-type-name: AWS::IoTEvents::AlarmModel + x-stackql-primary-identifier: - AlarmModelName x-create-only-properties: - AlarmModelName - Key + x-required-properties: + - RoleArn + - AlarmRule + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iotevents:UntagResource + - iotevents:TagResource + - iotevents:ListTagsForResource x-required-permissions: create: - iotevents:CreateAlarmModel @@ -482,10 +996,13 @@ components: properties: OnEnter: $ref: '#/components/schemas/OnEnter' + description: When entering this state, perform these ``actions`` if the ``condition`` is TRUE. OnExit: $ref: '#/components/schemas/OnExit' + description: When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``. OnInput: $ref: '#/components/schemas/OnInput' + description: When an input is received and the ``condition`` is TRUE, perform the specified ``actions``. StateName: type: string minLength: 1 @@ -496,50 +1013,50 @@ components: OnEnter: type: object additionalProperties: false - description: When entering this state, perform these `actions` if the `condition` is `TRUE`. + description: When entering this state, perform these ``actions`` if the ``condition`` is TRUE. properties: Events: type: array uniqueItems: false x-insertionOrder: false - description: Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`. + description: Specifies the actions that are performed when the state is entered and the ``condition`` is ``TRUE``. items: $ref: '#/components/schemas/Event' OnExit: type: object additionalProperties: false - description: When exiting this state, perform these `actions` if the specified `condition` is `TRUE`. + description: When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``. properties: Events: type: array uniqueItems: false x-insertionOrder: false - description: Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`. + description: Specifies the ``actions`` that are performed when the state is exited and the ``condition`` is ``TRUE``. items: $ref: '#/components/schemas/Event' OnInput: type: object additionalProperties: false - description: When an input is received and the `condition` is `TRUE`, perform the specified `actions`. + description: Specifies the actions performed when the ``condition`` evaluates to TRUE. properties: Events: type: array uniqueItems: false x-insertionOrder: false - description: Specifies the `actions` performed when the `condition` evaluates to `TRUE`. + description: Specifies the actions performed when the ``condition`` evaluates to TRUE. items: $ref: '#/components/schemas/Event' TransitionEvents: type: array uniqueItems: false x-insertionOrder: true - description: Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`. + description: Specifies the actions performed, and the next state entered, when a ``condition`` evaluates to TRUE. items: $ref: '#/components/schemas/TransitionEvent' Event: type: object additionalProperties: false - description: Specifies the `actions` to be performed when the `condition` evaluates to `TRUE`. + description: Specifies the ``actions`` to be performed when the ``condition`` evaluates to TRUE. properties: Actions: type: array @@ -550,7 +1067,7 @@ components: $ref: '#/components/schemas/Action' Condition: type: string - description: The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`). + description: Optional. The Boolean expression that, when TRUE, causes the ``actions`` to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE). maxLength: 512 EventName: type: string @@ -561,7 +1078,7 @@ components: TransitionEvent: type: object additionalProperties: false - description: Specifies the `actions `performed and the next `state` entered when a `condition` evaluates to `TRUE`. + description: Specifies the actions performed and the next state entered when a ``condition`` evaluates to TRUE. properties: Actions: type: array @@ -572,11 +1089,11 @@ components: $ref: '#/components/schemas/Action' Condition: type: string - description: A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered. + description: Required. A Boolean expression that when TRUE causes the actions to be performed and the ``nextState`` to be entered. maxLength: 512 EventName: type: string - description: The name of the event. + description: The name of the transition event. minLength: 1 maxLength: 128 NextState: @@ -591,34 +1108,51 @@ components: Action: type: object additionalProperties: false - description: The actions to be performed. + description: An action to be performed when the ``condition`` is TRUE. properties: ClearTimer: $ref: '#/components/schemas/ClearTimer' + description: Information needed to clear the timer. DynamoDB: $ref: '#/components/schemas/DynamoDB' + description: >- + Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see + [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*. DynamoDBv2: $ref: '#/components/schemas/DynamoDBv2' + description: >- + Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see + [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*. Firehose: $ref: '#/components/schemas/Firehose' + description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. IotEvents: $ref: '#/components/schemas/IotEvents' + description: Sends ITE input, which passes information about the detector model instance and the event that triggered the action. IotSiteWise: $ref: '#/components/schemas/IotSiteWise' + description: Sends information about the detector model instance and the event that triggered the action to an asset property in ITSW . IotTopicPublish: $ref: '#/components/schemas/IotTopicPublish' + description: Publishes an MQTT message with the given topic to the IoT message broker. Lambda: $ref: '#/components/schemas/Lambda' + description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. ResetTimer: $ref: '#/components/schemas/ResetTimer' + description: Information needed to reset the timer. SetTimer: $ref: '#/components/schemas/SetTimer' + description: Information needed to set the timer. SetVariable: $ref: '#/components/schemas/SetVariable' + description: Sets a variable to a specified value. Sns: $ref: '#/components/schemas/Sns' + description: Sends an Amazon SNS message. Sqs: $ref: '#/components/schemas/Sqs' + description: Sends an Amazon SNS message. ClearTimer: type: object additionalProperties: false @@ -628,6 +1162,7 @@ components: type: string minLength: 1 maxLength: 128 + description: The name of the timer to clear. required: - TimerName ResetTimer: @@ -649,12 +1184,12 @@ components: properties: DurationExpression: type: string - description: The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (`$variable.`), and input values (`$input..`) as the duration. The range of the duration is `1-31622400` seconds. To ensure accuracy, the minimum duration is `60` seconds. The evaluated result of the duration is rounded down to the nearest whole number. + description: The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (``$variable.``), and input values (``$input..``) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. minLength: 1 maxLength: 1024 Seconds: type: integer - description: The number of seconds until the timer expires. The minimum value is `60` seconds to ensure accuracy. The maximum value is `31622400` seconds. + description: The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. minimum: 60 maximum: 31622400 TimerName: @@ -688,6 +1223,7 @@ components: properties: DetectorModelDefinition: $ref: '#/components/schemas/DetectorModelDefinition' + description: Information that defines how a detector operates. DetectorModelDescription: type: string description: A brief description of the detector model. @@ -707,15 +1243,14 @@ components: Key: type: string description: |- - The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information. - - This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value. + The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information. + This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value. minLength: 1 maxLength: 128 pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$ RoleArn: type: string - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. + description: The ARN of the role that grants permission to ITE to perform its operations. minLength: 1 maxLength: 2048 Tags: @@ -724,19 +1259,39 @@ components: x-insertionOrder: false description: |- An array of key-value pairs to apply to this resource. - - For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). items: $ref: '#/components/schemas/Tag' required: - DetectorModelDefinition - RoleArn x-stackql-resource-name: detector_model - x-stackql-primaryIdentifier: + description: >- + The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, + optionally, when a condition is met. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*. + When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's ``state``, and the values of any variables and timers are reset.) + When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.) + If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset. + Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated. + x-type-name: AWS::IoTEvents::DetectorModel + x-stackql-primary-identifier: - DetectorModelName x-create-only-properties: - DetectorModelName - Key + x-required-properties: + - DetectorModelDefinition + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iotevents:UntagResource + - iotevents:TagResource + - iotevents:ListTagsForResource x-required-permissions: create: - iotevents:CreateDetectorModel @@ -770,7 +1325,7 @@ components: type: array uniqueItems: true x-insertionOrder: false - description: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input. + description: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using ``BatchPutMessage``. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors that monitor this input. minItems: 1 maxItems: 200 items: @@ -780,13 +1335,12 @@ components: Attribute: type: object additionalProperties: false - description: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input. + description: The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using ``BatchPutMessage``. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors. properties: JsonPath: description: |- - An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors. - - _Syntax_: `....` + An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to ITE (``BatchPutMessage``). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the ``condition`` expressions used by detectors. + Syntax: ``....`` minLength: 1 maxLength: 128 pattern: ^((`[a-zA-Z0-9_\- ]+`)|([a-zA-Z0-9_\-]+))(\.((`[a-zA-Z0-9_\- ]+`)|([a-zA-Z0-9_\-]+)))*$ @@ -798,6 +1352,7 @@ components: properties: InputDefinition: $ref: '#/components/schemas/InputDefinition' + description: The definition of the input. InputDescription: description: A brief description of the input. minLength: 1 @@ -815,17 +1370,30 @@ components: x-insertionOrder: false description: |- An array of key-value pairs to apply to this resource. - - For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). items: $ref: '#/components/schemas/Tag' required: - InputDefinition x-stackql-resource-name: input - x-stackql-primaryIdentifier: + description: The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into ITE. This is done by sending messages as *inputs* to ITE. For more information, see [How to Use](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*. + x-type-name: AWS::IoTEvents::Input + x-stackql-primary-identifier: - InputName x-create-only-properties: - InputName + x-required-properties: + - InputDefinition + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iotevents:UntagResource + - iotevents:TagResource + - iotevents:ListTagsForResource x-required-permissions: create: - iotevents:CreateInput @@ -846,43 +1414,232 @@ components: - iotevents:DescribeInput list: - iotevents:ListInputs + CreateAlarmModelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AlarmModelName: + type: string + description: The name of the alarm model. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_-]+$ + AlarmModelDescription: + type: string + description: The description of the alarm model. + maxLength: 1024 + RoleArn: + type: string + description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + minLength: 1 + maxLength: 2048 + Key: + type: string + description: An input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm. + minLength: 1 + maxLength: 128 + pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$ + Severity: + type: integer + description: A non-negative integer that reflects the severity level of the alarm. + minimum: 0 + maximum: 2147483647 + AlarmRule: + $ref: '#/components/schemas/AlarmRule' + description: Defines when your alarm is invoked. + AlarmEventActions: + $ref: '#/components/schemas/AlarmEventActions' + description: Contains information about one or more alarm actions. + AlarmCapabilities: + $ref: '#/components/schemas/AlarmCapabilities' + description: Contains the configuration information of alarm state changes. + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + description: |- + A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*. + You can create up to 50 tags for one alarm model. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAlarmModelRequest + type: object + required: [] + CreateDetectorModelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DetectorModelDefinition: + $ref: '#/components/schemas/DetectorModelDefinition' + description: Information that defines how a detector operates. + DetectorModelDescription: + type: string + description: A brief description of the detector model. + maxLength: 1024 + DetectorModelName: + type: string + description: The name of the detector model. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_-]+$ + EvaluationMethod: + type: string + description: Information about the order in which events are evaluated and how actions are executed. + enum: + - BATCH + - SERIAL + Key: + type: string + description: |- + The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information. + This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value. + minLength: 1 + maxLength: 128 + pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$ + RoleArn: + type: string + description: The ARN of the role that grants permission to ITE to perform its operations. + minLength: 1 + maxLength: 2048 + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + description: |- + An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDetectorModelRequest + type: object + required: [] + CreateInputRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InputDefinition: + $ref: '#/components/schemas/InputDefinition' + description: The definition of the input. + InputDescription: + description: A brief description of the input. + minLength: 1 + maxLength: 1024 + type: string + InputName: + description: The name of the input. + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + description: |- + An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateInputRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: alarm_models: name: alarm_models id: awscc.iotevents.alarm_models x-cfn-schema-name: AlarmModel - x-type: list - x-identifiers: - - AlarmModelName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmModelName') as alarm_model_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmModelName') as alarm_model_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' - AND region = 'us-east-1' - alarm_model: - name: alarm_model - id: awscc.iotevents.alarm_model - x-cfn-schema-name: AlarmModel - x-type: get + x-cfn-type-name: AWS::IoTEvents::AlarmModel x-identifiers: - AlarmModelName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AlarmModel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::AlarmModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::AlarmModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::AlarmModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/alarm_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/alarm_models/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/alarm_models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -900,7 +1657,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -917,13 +1674,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' AND data__Identifier = '' AND region = 'us-east-1' - detector_models: - name: detector_models - id: awscc.iotevents.detector_models - x-cfn-schema-name: DetectorModel - x-type: list + alarm_models_list_only: + name: alarm_models_list_only + id: awscc.iotevents.alarm_models_list_only + x-cfn-schema-name: AlarmModel + x-cfn-type-name: AWS::IoTEvents::AlarmModel x-identifiers: - - DetectorModelName + - AlarmModelName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -931,28 +1694,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DetectorModelName') as detector_model_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' + JSON_EXTRACT(Properties, '$.AlarmModelName') as alarm_model_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DetectorModelName') as detector_model_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' + json_extract_path_text(Properties, 'AlarmModelName') as alarm_model_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' AND region = 'us-east-1' - detector_model: - name: detector_model - id: awscc.iotevents.detector_model + detector_models: + name: detector_models + id: awscc.iotevents.detector_models x-cfn-schema-name: DetectorModel - x-type: get + x-cfn-type-name: AWS::IoTEvents::DetectorModel x-identifiers: - DetectorModelName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DetectorModel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::DetectorModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::DetectorModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::DetectorModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/detector_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/detector_models/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/detector_models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -968,7 +1779,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -983,13 +1794,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' AND data__Identifier = '' AND region = 'us-east-1' - inputs: - name: inputs - id: awscc.iotevents.inputs - x-cfn-schema-name: Input - x-type: list + detector_models_list_only: + name: detector_models_list_only + id: awscc.iotevents.detector_models_list_only + x-cfn-schema-name: DetectorModel + x-cfn-type-name: AWS::IoTEvents::DetectorModel x-identifiers: - - InputName + - DetectorModelName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -997,28 +1814,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InputName') as input_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' + JSON_EXTRACT(Properties, '$.DetectorModelName') as detector_model_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InputName') as input_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' + json_extract_path_text(Properties, 'DetectorModelName') as detector_model_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' AND region = 'us-east-1' - input: - name: input - id: awscc.iotevents.input + inputs: + name: inputs + id: awscc.iotevents.inputs x-cfn-schema-name: Input - x-type: get + x-cfn-type-name: AWS::IoTEvents::Input x-identifiers: - InputName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Input&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::Input" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::Input" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTEvents::Input" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inputs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inputs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/inputs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1031,7 +1896,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1043,3 +1908,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::Input' AND data__Identifier = '' AND region = 'us-east-1' + inputs_list_only: + name: inputs_list_only + id: awscc.iotevents.inputs_list_only + x-cfn-schema-name: Input + x-cfn-type-name: AWS::IoTEvents::Input + x-identifiers: + - InputName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.InputName') as input_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InputName') as input_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AlarmModel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlarmModel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAlarmModelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DetectorModel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDetectorModel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDetectorModelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Input&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInput + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInputRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iotfleethub.yaml b/providers/src/awscc/v00.00.00000/services/iotfleethub.yaml deleted file mode 100644 index 63e7b354..00000000 --- a/providers/src/awscc/v00.00.00000/services/iotfleethub.yaml +++ /dev/null @@ -1,197 +0,0 @@ -openapi: 3.0.0 -info: - title: IoTFleetHub - version: 1.0.0 -paths: {} -components: - schemas: - Tag: - description: To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted. - type: object - properties: - Key: - type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 1 - maxLength: 128 - Value: - type: string - description: 'The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 1 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false - Application: - type: object - properties: - ApplicationId: - description: The ID of the application. - type: string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - minLength: 36 - maxLength: 36 - ApplicationArn: - description: The ARN of the application. - type: string - pattern: ^arn:[!-~]+$ - minLength: 1 - maxLength: 1600 - ApplicationName: - description: Application Name, should be between 1 and 256 characters. - type: string - pattern: ^[ -~]*$ - minLength: 1 - maxLength: 256 - ApplicationDescription: - description: Application Description, should be between 1 and 2048 characters. - type: string - pattern: ^[ -~]*$ - minLength: 1 - maxLength: 2048 - ApplicationUrl: - description: The URL of the application. - type: string - ApplicationState: - description: The current state of the application. - type: string - ApplicationCreationDate: - description: When the Application was created - type: integer - ApplicationLastUpdateDate: - description: When the Application was last updated - type: integer - RoleArn: - description: The ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax - type: string - pattern: ^arn:[!-~]+$ - minLength: 1 - maxLength: 1600 - SsoClientId: - description: The AWS SSO application generated client ID (used with AWS SSO APIs). - type: string - ErrorMessage: - description: A message indicating why Create or Delete Application failed. - type: string - Tags: - description: A list of key-value pairs that contain metadata for the application. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - minItems: 0 - maxItems: 50 - required: - - ApplicationName - - RoleArn - x-stackql-resource-name: application - x-stackql-primaryIdentifier: - - ApplicationId - x-read-only-properties: - - ApplicationArn - - ApplicationId - - ApplicationUrl - - ApplicationState - - ApplicationCreationDate - - ApplicationLastUpdateDate - - SsoClientId - - ErrorMessage - x-required-permissions: - create: - - iotfleethub:CreateApplication - - iotfleethub:TagResource - - iam:PassRole - - sso:CreateManagedApplicationInstance - - sso:DescribeRegisteredRegions - read: - - iotfleethub:DescribeApplication - update: - - iotfleethub:UpdateApplication - - iotfleethub:DescribeApplication - - iotfleethub:TagResource - - iotfleethub:UntagResource - delete: - - iotfleethub:DeleteApplication - - iotfleethub:DescribeApplication - - sso:DeleteManagedApplicationInstance - list: - - iotfleethub:ListApplications - x-stackQL-resources: - applications: - name: applications - id: awscc.iotfleethub.applications - x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.iotfleethub.application - x-cfn-schema-name: Application - x-type: get - x-identifiers: - - ApplicationId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, - JSON_EXTRACT(Properties, '$.ApplicationDescription') as application_description, - JSON_EXTRACT(Properties, '$.ApplicationUrl') as application_url, - JSON_EXTRACT(Properties, '$.ApplicationState') as application_state, - JSON_EXTRACT(Properties, '$.ApplicationCreationDate') as application_creation_date, - JSON_EXTRACT(Properties, '$.ApplicationLastUpdateDate') as application_last_update_date, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.SsoClientId') as sso_client_id, - JSON_EXTRACT(Properties, '$.ErrorMessage') as error_message, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'ApplicationDescription') as application_description, - json_extract_path_text(Properties, 'ApplicationUrl') as application_url, - json_extract_path_text(Properties, 'ApplicationState') as application_state, - json_extract_path_text(Properties, 'ApplicationCreationDate') as application_creation_date, - json_extract_path_text(Properties, 'ApplicationLastUpdateDate') as application_last_update_date, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, - json_extract_path_text(Properties, 'ErrorMessage') as error_message, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND data__Identifier = '' - AND region = 'us-east-1' diff --git a/providers/src/awscc/v00.00.00000/services/iotfleetwise.yaml b/providers/src/awscc/v00.00.00000/services/iotfleetwise.yaml index 1f092264..39aa4687 100644 --- a/providers/src/awscc/v00.00.00000/services/iotfleetwise.yaml +++ b/providers/src/awscc/v00.00.00000/services/iotfleetwise.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTFleetWise - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Compression: type: string @@ -29,6 +409,14 @@ components: $ref: '#/components/schemas/TimestreamConfig' required: - TimestreamConfig + - type: object + title: MqttTopicConfig + properties: + MqttTopicConfig: + $ref: '#/components/schemas/MqttTopicConfig' + required: + - MqttTopicConfig + additionalProperties: false S3Config: additionalProperties: false type: object @@ -66,6 +454,23 @@ components: required: - TimestreamTableArn - ExecutionRoleArn + MqttTopicConfig: + type: object + properties: + MqttTopicArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:.* + ExecutionRoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$ + required: + - ExecutionRoleArn + - MqttTopicArn + additionalProperties: false UpdateCampaignAction: type: string enum: @@ -80,6 +485,19 @@ components: - WAITING_FOR_APPROVAL - RUNNING - SUSPENDED + ConditionBasedSignalFetchConfig: + type: object + properties: + ConditionExpression: + type: string + maxLength: 2048 + minLength: 1 + TriggerMode: + $ref: '#/components/schemas/TriggerMode' + required: + - ConditionExpression + - TriggerMode + additionalProperties: false DiagnosticsMode: type: string enum: @@ -103,18 +521,74 @@ components: maximum: 4294967295 type: number minimum: 0 + DataPartitionId: + $ref: '#/components/schemas/DataPartitionId' required: - Name + SignalFetchConfig: + oneOf: + - type: object + title: TimeBased + properties: + TimeBased: + $ref: '#/components/schemas/TimeBasedSignalFetchConfig' + required: + - TimeBased + additionalProperties: false + - type: object + title: ConditionBased + properties: + ConditionBased: + $ref: '#/components/schemas/ConditionBasedSignalFetchConfig' + required: + - ConditionBased + additionalProperties: false + SignalFetchInformation: + type: object + properties: + FullyQualifiedName: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + SignalFetchConfig: + $ref: '#/components/schemas/SignalFetchConfig' + ConditionLanguageVersion: + type: number + maximum: 1 + minimum: 1 + Actions: + type: array + items: + type: string + maxLength: 2048 + minLength: 1 + maxItems: 5 + minItems: 1 + required: + - Actions + - FullyQualifiedName + - SignalFetchConfig + additionalProperties: false TimeBasedCollectionScheme: additionalProperties: false type: object properties: PeriodMs: - maximum: 60000 + maximum: 86400000 type: number minimum: 10000 required: - PeriodMs + TimeBasedSignalFetchConfig: + type: object + properties: + ExecutionFrequencyMs: + type: number + minimum: 1 + required: + - ExecutionFrequencyMs + additionalProperties: false SpoolingMode: type: string enum: @@ -163,16 +637,108 @@ components: type: number minimum: 0 Expression: - minLength: 1 - type: string - maxLength: 2048 + $ref: '#/components/schemas/EventExpression' TriggerMode: $ref: '#/components/schemas/TriggerMode' ConditionLanguageVersion: - type: integer - minimum: 1 + $ref: '#/components/schemas/LanguageVersion' + required: + - Expression + EventExpression: + type: string + minLength: 1 + maxLength: 2048 + LanguageVersion: + type: integer + minimum: 1 + DataPartition: + type: object + properties: + Id: + $ref: '#/components/schemas/DataPartitionId' + StorageOptions: + $ref: '#/components/schemas/DataPartitionStorageOptions' + UploadOptions: + $ref: '#/components/schemas/DataPartitionUploadOptions' + required: + - Id + - StorageOptions + additionalProperties: false + DataPartitionStorageOptions: + type: object + properties: + MaximumSize: + $ref: '#/components/schemas/StorageMaximumSize' + MinimumTimeToLive: + $ref: '#/components/schemas/StorageMinimumTimeToLive' + StorageLocation: + $ref: '#/components/schemas/StorageLocation' + required: + - MaximumSize + - MinimumTimeToLive + - StorageLocation + additionalProperties: false + StorageLocation: + type: string + minLength: 1 + maxLength: 4096 + StorageMaximumSize: + type: object + properties: + Unit: + $ref: '#/components/schemas/StorageMaximumSizeUnit' + Value: + $ref: '#/components/schemas/StorageMaximumSizeValue' + required: + - Unit + - Value + additionalProperties: false + StorageMaximumSizeUnit: + type: string + enum: + - MB + - GB + - TB + StorageMaximumSizeValue: + type: integer + minimum: 1 + maximum: 1073741824 + StorageMinimumTimeToLive: + type: object + properties: + Unit: + $ref: '#/components/schemas/StorageMinimumTimeToLiveUnit' + Value: + $ref: '#/components/schemas/StorageMinimumTimeToLiveValue' + required: + - Unit + - Value + additionalProperties: false + StorageMinimumTimeToLiveUnit: + type: string + enum: + - HOURS + - DAYS + - WEEKS + StorageMinimumTimeToLiveValue: + type: integer + minimum: 1 + maximum: 10000 + DataPartitionUploadOptions: + type: object + properties: + Expression: + $ref: '#/components/schemas/EventExpression' + ConditionLanguageVersion: + $ref: '#/components/schemas/LanguageVersion' required: - Expression + additionalProperties: false + DataPartitionId: + type: string + pattern: ^[a-zA-Z0-9]+$ + minLength: 1 + maxLength: 128 Tag: type: object properties: @@ -188,6 +754,25 @@ components: - Key - Value additionalProperties: false + TimePeriod: + type: object + properties: + Unit: + $ref: '#/components/schemas/TimeUnit' + Value: + type: number + minimum: 1 + required: + - Unit + - Value + additionalProperties: false + TimeUnit: + type: string + enum: + - MILLISECOND + - SECOND + - MINUTE + - HOUR Campaign: type: object properties: @@ -216,6 +801,13 @@ components: type: array items: $ref: '#/components/schemas/SignalInformation' + SignalsToFetch: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SignalFetchInformation' + maxItems: 10 + minItems: 0 DataDestinationConfigs: minItems: 1 maxItems: 1 @@ -266,6 +858,14 @@ components: type: string CollectionScheme: $ref: '#/components/schemas/CollectionScheme' + DataPartitions: + type: array + items: + $ref: '#/components/schemas/DataPartition' + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + minItems: 0 Tags: type: array items: @@ -276,12 +876,13 @@ components: minItems: 0 required: - Name - - Action - CollectionScheme - SignalCatalogArn - TargetArn x-stackql-resource-name: campaign - x-stackql-primaryIdentifier: + description: Definition of AWS::IoTFleetWise::Campaign Resource Type + x-type-name: AWS::IoTFleetWise::Campaign + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -295,11 +896,32 @@ components: - Compression - StartTime - ExpiryTime + - DataPartitions + - SignalsToCollect + - SignalsToFetch + - DataDestinationConfigs + x-write-only-properties: + - Action x-read-only-properties: - Arn - Status - CreationTime - LastModificationTime + x-required-properties: + - Name + - CollectionScheme + - SignalCatalogArn + - TargetArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:UntagResource + - iotfleetwise:TagResource + - iotfleetwise:ListTagsForResource x-required-permissions: read: - iotfleetwise:GetCampaign @@ -363,6 +985,8 @@ components: type: string maxLength: 100 minLength: 1 + SignalValueType: + $ref: '#/components/schemas/SignalValueType' required: - Factor - IsBigEndian @@ -460,6 +1084,10 @@ components: type: integer BitMaskLength: type: integer + IsSigned: + type: boolean + SignalValueType: + $ref: '#/components/schemas/SignalValueType' required: - ByteLength - Offset @@ -515,37 +1143,110 @@ components: - Type - ObdSignal additionalProperties: false - DecoderManifest: + SignalValueType: + type: string + enum: + - INTEGER + - FLOATING_POINT + CustomDecodingNetworkInterface: type: object properties: - Arn: - type: string - CreationTime: - type: string - format: date-time - Description: + InterfaceId: type: string - maxLength: 2048 + maxLength: 50 minLength: 1 - pattern: ^[^\u0000-\u001F\u007F]+$ - LastModificationTime: - type: string - format: date-time - ModelManifestArn: + Type: type: string + enum: + - CUSTOM_DECODING_INTERFACE + CustomDecodingInterface: + $ref: '#/components/schemas/CustomDecodingInterface' + required: + - InterfaceId + - Type + - CustomDecodingInterface + additionalProperties: false + CustomDecodingInterface: + type: object + properties: Name: type: string maxLength: 100 minLength: 1 pattern: ^[a-zA-Z\d\-_:]+$ - NetworkInterfaces: - x-insertionOrder: false - type: array - items: - oneOf: - - $ref: '#/components/schemas/CanNetworkInterface' - - $ref: '#/components/schemas/ObdNetworkInterface' - maxItems: 500 + required: + - Name + additionalProperties: false + CustomDecodingSignal: + type: object + properties: + Id: + type: string + maxLength: 150 + minLength: 1 + pattern: ^(?!.*\.\.)[a-zA-Z0-9_\-#:.]+$ + required: + - Id + additionalProperties: false + CustomDecodingSignalDecoder: + type: object + properties: + FullyQualifiedName: + type: string + maxLength: 150 + minLength: 1 + Type: + type: string + enum: + - CUSTOM_DECODING_SIGNAL + InterfaceId: + type: string + maxLength: 50 + minLength: 1 + CustomDecodingSignal: + $ref: '#/components/schemas/CustomDecodingSignal' + required: + - FullyQualifiedName + - InterfaceId + - Type + - CustomDecodingSignal + additionalProperties: false + DefaultForUnmappedSignalsType: + type: string + enum: + - CUSTOM_DECODING + DecoderManifest: + type: object + properties: + Arn: + type: string + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + LastModificationTime: + type: string + format: date-time + ModelManifestArn: + type: string + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + NetworkInterfaces: + x-insertionOrder: false + type: array + items: + oneOf: + - $ref: '#/components/schemas/CanNetworkInterface' + - $ref: '#/components/schemas/ObdNetworkInterface' + - $ref: '#/components/schemas/CustomDecodingNetworkInterface' + maxItems: 5000 minItems: 1 SignalDecoders: x-insertionOrder: false @@ -554,10 +1255,13 @@ components: oneOf: - $ref: '#/components/schemas/CanSignalDecoder' - $ref: '#/components/schemas/ObdSignalDecoder' - maxItems: 500 + - $ref: '#/components/schemas/CustomDecodingSignalDecoder' + maxItems: 5000 minItems: 1 Status: $ref: '#/components/schemas/ManifestStatus' + DefaultForUnmappedSignals: + $ref: '#/components/schemas/DefaultForUnmappedSignalsType' Tags: type: array items: @@ -570,15 +1274,32 @@ components: - Name - ModelManifestArn x-stackql-resource-name: decoder_manifest - x-stackql-primaryIdentifier: + description: Definition of AWS::IoTFleetWise::DecoderManifest Resource Type + x-type-name: AWS::IoTFleetWise::DecoderManifest + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - ModelManifestArn + x-write-only-properties: + - DefaultForUnmappedSignals x-read-only-properties: - Arn - CreationTime - LastModificationTime + x-required-properties: + - Name + - ModelManifestArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:UntagResource + - iotfleetwise:TagResource + - iotfleetwise:ListTagsForResource x-required-permissions: create: - iotfleetwise:CreateDecoderManifest @@ -641,7 +1362,9 @@ components: - Id - SignalCatalogArn x-stackql-resource-name: fleet - x-stackql-primaryIdentifier: + description: Definition of AWS::IoTFleetWise::Fleet Resource Type + x-type-name: AWS::IoTFleetWise::Fleet + x-stackql-primary-identifier: - Id x-create-only-properties: - Id @@ -650,6 +1373,19 @@ components: - Arn - CreationTime - LastModificationTime + x-required-properties: + - Id + - SignalCatalogArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:UntagResource + - iotfleetwise:TagResource + - iotfleetwise:ListTagsForResource x-required-permissions: create: - iotfleetwise:GetFleet @@ -715,7 +1451,9 @@ components: - SignalCatalogArn - Name x-stackql-resource-name: model_manifest - x-stackql-primaryIdentifier: + description: Definition of AWS::IoTFleetWise::ModelManifest Resource Type + x-type-name: AWS::IoTFleetWise::ModelManifest + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -723,6 +1461,19 @@ components: - Arn - CreationTime - LastModificationTime + x-required-properties: + - SignalCatalogArn + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:UntagResource + - iotfleetwise:TagResource + - iotfleetwise:ListTagsForResource x-required-permissions: create: - iotfleetwise:CreateModelManifest @@ -943,7 +1694,7 @@ components: uniqueItems: true items: $ref: '#/components/schemas/Node' - maxItems: 500 + maxItems: 5000 minItems: 1 Tags: type: array @@ -954,7 +1705,9 @@ components: maxItems: 50 minItems: 0 x-stackql-resource-name: signal_catalog - x-stackql-primaryIdentifier: + description: Definition of AWS::IoTFleetWise::SignalCatalog Resource Type + x-type-name: AWS::IoTFleetWise::SignalCatalog + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -967,6 +1720,16 @@ components: - NodeCounts/TotalSensors - NodeCounts/TotalAttributes - NodeCounts/TotalActuators + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:UntagResource + - iotfleetwise:TagResource + - iotfleetwise:ListTagsForResource x-required-permissions: create: - iotfleetwise:GetSignalCatalog @@ -990,6 +1753,126 @@ components: - iotfleetwise:DeleteSignalCatalog list: - iotfleetwise:ListSignalCatalogs + Unit: + type: object + additionalProperties: false + StateTemplate: + type: object + properties: + Arn: + type: string + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + LastModificationTime: + type: string + format: date-time + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + Id: + type: string + maxLength: 26 + minLength: 26 + pattern: ^[A-Z0-9]+$ + SignalCatalogArn: + type: string + StateTemplateProperties: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + maxItems: 500 + minItems: 1 + DataExtraDimensions: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + maxItems: 5 + minItems: 0 + MetadataExtraDimensions: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + maxItems: 5 + minItems: 0 + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 0 + required: + - Name + - SignalCatalogArn + - StateTemplateProperties + x-stackql-resource-name: state_template + description: Definition of AWS::IoTFleetWise::StateTemplate Resource Type + x-type-name: AWS::IoTFleetWise::StateTemplate + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - SignalCatalogArn + x-read-only-properties: + - Arn + - Id + - CreationTime + - LastModificationTime + x-required-properties: + - Name + - SignalCatalogArn + - StateTemplateProperties + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:ListTagsForResource + - iotfleetwise:TagResource + - iotfleetwise:UntagResource + x-required-permissions: + create: + - iotfleetwise:GetStateTemplate + - iotfleetwise:CreateStateTemplate + - iotfleetwise:ListTagsForResource + - iotfleetwise:TagResource + read: + - iotfleetwise:GetStateTemplate + - iotfleetwise:ListTagsForResource + update: + - iotfleetwise:UpdateStateTemplate + - iotfleetwise:GetStateTemplate + - iotfleetwise:ListTagsForResource + - iotfleetwise:TagResource + - iotfleetwise:UntagResource + delete: + - iotfleetwise:DeleteStateTemplate + - iotfleetwise:GetStateTemplate + list: + - iotfleetwise:ListStateTemplates VehicleAssociationBehavior: type: string enum: @@ -1002,6 +1885,47 @@ components: type: string minProperties: 1 additionalProperties: false + OnChangeStateTemplateUpdateStrategy: + additionalProperties: false + type: object + PeriodicStateTemplateUpdateStrategy: + additionalProperties: false + type: object + properties: + StateTemplateUpdateRate: + $ref: '#/components/schemas/TimePeriod' + required: + - StateTemplateUpdateRate + StateTemplateUpdateStrategy: + oneOf: + - additionalProperties: false + type: object + properties: + Periodic: + $ref: '#/components/schemas/PeriodicStateTemplateUpdateStrategy' + required: + - Periodic + - additionalProperties: false + type: object + properties: + OnChange: + $ref: '#/components/schemas/OnChangeStateTemplateUpdateStrategy' + required: + - OnChange + StateTemplateAssociation: + type: object + properties: + Identifier: + type: string + maxLength: 100 + minLength: 1 + StateTemplateUpdateStrategy: + $ref: '#/components/schemas/StateTemplateUpdateStrategy' + required: + - Identifier + - StateTemplateUpdateStrategy + additionalProperties: false + minProperties: 0 Vehicle: type: object properties: @@ -1034,24 +1958,51 @@ components: uniqueItems: true maxItems: 50 minItems: 0 + StateTemplates: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/StateTemplateAssociation' + maxItems: 20 + minItems: 0 required: - Name - DecoderManifestArn - ModelManifestArn x-stackql-resource-name: vehicle - x-stackql-primaryIdentifier: + description: Definition of AWS::IoTFleetWise::Vehicle Resource Type + x-type-name: AWS::IoTFleetWise::Vehicle + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - AssociationBehavior x-read-only-properties: - Arn - CreationTime - LastModificationTime + x-required-properties: + - Name + - DecoderManifestArn + - ModelManifestArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotfleetwise:UntagResource + - iotfleetwise:TagResource + - iotfleetwise:ListTagsForResource x-required-permissions: create: - iotfleetwise:GetVehicle - iotfleetwise:CreateVehicle - iot:CreateThing + - iot:DeleteThing - iot:DescribeThing - iotfleetwise:ListTagsForResource - iotfleetwise:ListVehicles @@ -1070,43 +2021,543 @@ components: - iotfleetwise:DeleteVehicle list: - iotfleetwise:ListVehicles + CreateCampaignRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + $ref: '#/components/schemas/CampaignStatus' + Action: + $ref: '#/components/schemas/UpdateCampaignAction' + CreationTime: + type: string + format: date-time + Compression: + $ref: '#/components/schemas/Compression' + Description: + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + type: string + maxLength: 2048 + Priority: + type: integer + minimum: 0 + default: 0 + SignalsToCollect: + minItems: 0 + maxItems: 1000 + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SignalInformation' + SignalsToFetch: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SignalFetchInformation' + maxItems: 10 + minItems: 0 + DataDestinationConfigs: + minItems: 1 + maxItems: 1 + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/DataDestinationConfig' + StartTime: + format: date-time + type: string + default: '0' + Name: + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + type: string + maxLength: 100 + ExpiryTime: + format: date-time + type: string + default: '253402214400' + LastModificationTime: + type: string + format: date-time + SpoolingMode: + $ref: '#/components/schemas/SpoolingMode' + SignalCatalogArn: + type: string + PostTriggerCollectionDuration: + maximum: 4294967295 + type: number + minimum: 0 + default: 0 + DataExtraDimensions: + minItems: 0 + maxItems: 5 + x-insertionOrder: false + type: array + items: + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + type: string + maxLength: 150 + DiagnosticsMode: + $ref: '#/components/schemas/DiagnosticsMode' + TargetArn: + type: string + Arn: + type: string + CollectionScheme: + $ref: '#/components/schemas/CollectionScheme' + DataPartitions: + type: array + items: + $ref: '#/components/schemas/DataPartition' + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + minItems: 0 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateCampaignRequest + type: object + required: [] + CreateDecoderManifestRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + LastModificationTime: + type: string + format: date-time + ModelManifestArn: + type: string + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + NetworkInterfaces: + x-insertionOrder: false + type: array + items: + oneOf: + - $ref: '#/components/schemas/CanNetworkInterface' + - $ref: '#/components/schemas/ObdNetworkInterface' + - $ref: '#/components/schemas/CustomDecodingNetworkInterface' + maxItems: 5000 + minItems: 1 + SignalDecoders: + x-insertionOrder: false + type: array + items: + oneOf: + - $ref: '#/components/schemas/CanSignalDecoder' + - $ref: '#/components/schemas/ObdSignalDecoder' + - $ref: '#/components/schemas/CustomDecodingSignalDecoder' + maxItems: 5000 + minItems: 1 + Status: + $ref: '#/components/schemas/ManifestStatus' + DefaultForUnmappedSignals: + $ref: '#/components/schemas/DefaultForUnmappedSignalsType' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 0 + x-insertionOrder: false + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateDecoderManifestRequest + type: object + required: [] + CreateFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + Id: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9:_-]+$ + LastModificationTime: + type: string + format: date-time + SignalCatalogArn: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateFleetRequest + type: object + required: [] + CreateModelManifestRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + LastModificationTime: + type: string + format: date-time + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + Nodes: + x-insertionOrder: false + uniqueItems: true + minItems: 1 + type: array + items: + type: string + SignalCatalogArn: + type: string + Status: + $ref: '#/components/schemas/ManifestStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateModelManifestRequest + type: object + required: [] + CreateSignalCatalogRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + CreationTime: + format: date-time + type: string + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + LastModificationTime: + format: date-time + type: string + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + NodeCounts: + $ref: '#/components/schemas/NodeCounts' + Nodes: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Node' + maxItems: 5000 + minItems: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateSignalCatalogRequest + type: object + required: [] + CreateStateTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[^\u0000-\u001F\u007F]+$ + LastModificationTime: + type: string + format: date-time + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + Id: + type: string + maxLength: 26 + minLength: 26 + pattern: ^[A-Z0-9]+$ + SignalCatalogArn: + type: string + StateTemplateProperties: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + maxItems: 500 + minItems: 1 + DataExtraDimensions: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + maxItems: 5 + minItems: 0 + MetadataExtraDimensions: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 150 + minLength: 1 + pattern: ^[a-zA-Z0-9_.]+$ + maxItems: 5 + minItems: 0 + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateStateTemplateRequest + type: object + required: [] + CreateVehicleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + AssociationBehavior: + $ref: '#/components/schemas/VehicleAssociationBehavior' + Attributes: + $ref: '#/components/schemas/attributesMap' + CreationTime: + type: string + format: date-time + DecoderManifestArn: + type: string + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z\d\-_:]+$ + LastModificationTime: + type: string + format: date-time + ModelManifestArn: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: true + maxItems: 50 + minItems: 0 + StateTemplates: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/StateTemplateAssociation' + maxItems: 20 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateVehicleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: campaigns: name: campaigns id: awscc.iotfleetwise.campaigns x-cfn-schema-name: Campaign - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' - AND region = 'us-east-1' - campaign: - name: campaign - id: awscc.iotfleetwise.campaign - x-cfn-schema-name: Campaign - x-type: get + x-cfn-type-name: AWS::IoTFleetWise::Campaign x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Campaign&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Campaign" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1118,6 +2569,7 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Priority') as priority, JSON_EXTRACT(Properties, '$.SignalsToCollect') as signals_to_collect, + JSON_EXTRACT(Properties, '$.SignalsToFetch') as signals_to_fetch, JSON_EXTRACT(Properties, '$.DataDestinationConfigs') as data_destination_configs, JSON_EXTRACT(Properties, '$.StartTime') as start_time, JSON_EXTRACT(Properties, '$.Name') as name, @@ -1131,12 +2583,13 @@ components: JSON_EXTRACT(Properties, '$.TargetArn') as target_arn, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.CollectionScheme') as collection_scheme, + JSON_EXTRACT(Properties, '$.DataPartitions') as data_partitions, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1148,6 +2601,7 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Priority') as priority, json_extract_path_text(Properties, 'SignalsToCollect') as signals_to_collect, + json_extract_path_text(Properties, 'SignalsToFetch') as signals_to_fetch, json_extract_path_text(Properties, 'DataDestinationConfigs') as data_destination_configs, json_extract_path_text(Properties, 'StartTime') as start_time, json_extract_path_text(Properties, 'Name') as name, @@ -1161,17 +2615,24 @@ components: json_extract_path_text(Properties, 'TargetArn') as target_arn, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'CollectionScheme') as collection_scheme, + json_extract_path_text(Properties, 'DataPartitions') as data_partitions, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' AND data__Identifier = '' AND region = 'us-east-1' - decoder_manifests: - name: decoder_manifests - id: awscc.iotfleetwise.decoder_manifests - x-cfn-schema-name: DecoderManifest - x-type: list + campaigns_list_only: + name: campaigns_list_only + id: awscc.iotfleetwise.campaigns_list_only + x-cfn-schema-name: Campaign + x-cfn-type-name: AWS::IoTFleetWise::Campaign x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1180,7 +2641,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1188,19 +2649,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' AND region = 'us-east-1' - decoder_manifest: - name: decoder_manifest - id: awscc.iotfleetwise.decoder_manifest + decoder_manifests: + name: decoder_manifests + id: awscc.iotfleetwise.decoder_manifests x-cfn-schema-name: DecoderManifest - x-type: get + x-cfn-type-name: AWS::IoTFleetWise::DecoderManifest x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DecoderManifest&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::DecoderManifest" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::DecoderManifest" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::DecoderManifest" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1214,12 +2723,13 @@ components: JSON_EXTRACT(Properties, '$.NetworkInterfaces') as network_interfaces, JSON_EXTRACT(Properties, '$.SignalDecoders') as signal_decoders, JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.DefaultForUnmappedSignals') as default_for_unmapped_signals, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1233,17 +2743,24 @@ components: json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, json_extract_path_text(Properties, 'SignalDecoders') as signal_decoders, json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'DefaultForUnmappedSignals') as default_for_unmapped_signals, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' AND data__Identifier = '' AND region = 'us-east-1' - fleets: - name: fleets - id: awscc.iotfleetwise.fleets - x-cfn-schema-name: Fleet - x-type: list + decoder_manifests_list_only: + name: decoder_manifests_list_only + id: awscc.iotfleetwise.decoder_manifests_list_only + x-cfn-schema-name: DecoderManifest + x-cfn-type-name: AWS::IoTFleetWise::DecoderManifest x-identifiers: - - Id + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1251,28 +2768,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' AND region = 'us-east-1' - fleet: - name: fleet - id: awscc.iotfleetwise.fleet + fleets: + name: fleets + id: awscc.iotfleetwise.fleets x-cfn-schema-name: Fleet - x-type: get + x-cfn-type-name: AWS::IoTFleetWise::Fleet x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1288,7 +2853,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1303,13 +2868,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' AND data__Identifier = '' AND region = 'us-east-1' - model_manifests: - name: model_manifests - id: awscc.iotfleetwise.model_manifests - x-cfn-schema-name: ModelManifest - x-type: list + fleets_list_only: + name: fleets_list_only + id: awscc.iotfleetwise.fleets_list_only + x-cfn-schema-name: Fleet + x-cfn-type-name: AWS::IoTFleetWise::Fleet x-identifiers: - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1317,28 +2888,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' AND region = 'us-east-1' - model_manifest: - name: model_manifest - id: awscc.iotfleetwise.model_manifest + model_manifests: + name: model_manifests + id: awscc.iotfleetwise.model_manifests x-cfn-schema-name: ModelManifest - x-type: get + x-cfn-type-name: AWS::IoTFleetWise::ModelManifest x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModelManifest&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::ModelManifest" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::ModelManifest" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::ModelManifest" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_manifests/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_manifests/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/model_manifests/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1356,7 +2975,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1373,13 +2992,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' AND data__Identifier = '' AND region = 'us-east-1' - signal_catalogs: - name: signal_catalogs - id: awscc.iotfleetwise.signal_catalogs - x-cfn-schema-name: SignalCatalog - x-type: list + model_manifests_list_only: + name: model_manifests_list_only + id: awscc.iotfleetwise.model_manifests_list_only + x-cfn-schema-name: ModelManifest + x-cfn-type-name: AWS::IoTFleetWise::ModelManifest x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1388,7 +3013,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1396,19 +3021,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' AND region = 'us-east-1' - signal_catalog: - name: signal_catalog - id: awscc.iotfleetwise.signal_catalog + signal_catalogs: + name: signal_catalogs + id: awscc.iotfleetwise.signal_catalogs x-cfn-schema-name: SignalCatalog - x-type: get + x-cfn-type-name: AWS::IoTFleetWise::SignalCatalog x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SignalCatalog&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::SignalCatalog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::SignalCatalog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::SignalCatalog" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1425,7 +3098,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1441,13 +3114,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' AND data__Identifier = '' AND region = 'us-east-1' - vehicles: - name: vehicles - id: awscc.iotfleetwise.vehicles - x-cfn-schema-name: Vehicle - x-type: list + signal_catalogs_list_only: + name: signal_catalogs_list_only + id: awscc.iotfleetwise.signal_catalogs_list_only + x-cfn-schema-name: SignalCatalog + x-cfn-type-name: AWS::IoTFleetWise::SignalCatalog x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1456,7 +3135,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1464,19 +3143,195 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' AND region = 'us-east-1' - vehicle: - name: vehicle - id: awscc.iotfleetwise.vehicle - x-cfn-schema-name: Vehicle - x-type: get + state_templates: + name: state_templates + id: awscc.iotfleetwise.state_templates + x-cfn-schema-name: StateTemplate + x-cfn-type-name: AWS::IoTFleetWise::StateTemplate + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StateTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::StateTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::StateTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::StateTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/state_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/state_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/state_templates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.LastModificationTime') as last_modification_time, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.SignalCatalogArn') as signal_catalog_arn, + JSON_EXTRACT(Properties, '$.StateTemplateProperties') as state_template_properties, + JSON_EXTRACT(Properties, '$.DataExtraDimensions') as data_extra_dimensions, + JSON_EXTRACT(Properties, '$.MetadataExtraDimensions') as metadata_extra_dimensions, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::StateTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, + json_extract_path_text(Properties, 'StateTemplateProperties') as state_template_properties, + json_extract_path_text(Properties, 'DataExtraDimensions') as data_extra_dimensions, + json_extract_path_text(Properties, 'MetadataExtraDimensions') as metadata_extra_dimensions, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::StateTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + state_templates_list_only: + name: state_templates_list_only + id: awscc.iotfleetwise.state_templates_list_only + x-cfn-schema-name: StateTemplate + x-cfn-type-name: AWS::IoTFleetWise::StateTemplate x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::StateTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::StateTemplate' + AND region = 'us-east-1' + vehicles: + name: vehicles + id: awscc.iotfleetwise.vehicles + x-cfn-schema-name: Vehicle + x-cfn-type-name: AWS::IoTFleetWise::Vehicle + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Vehicle&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Vehicle" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Vehicle" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTFleetWise::Vehicle" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vehicles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vehicles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vehicles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1489,12 +3344,13 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.LastModificationTime') as last_modification_time, JSON_EXTRACT(Properties, '$.ModelManifestArn') as model_manifest_arn, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.StateTemplates') as state_templates FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1507,7 +3363,486 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, json_extract_path_text(Properties, 'ModelManifestArn') as model_manifest_arn, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'StateTemplates') as state_templates FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' AND data__Identifier = '' AND region = 'us-east-1' + vehicles_list_only: + name: vehicles_list_only + id: awscc.iotfleetwise.vehicles_list_only + x-cfn-schema-name: Vehicle + x-cfn-type-name: AWS::IoTFleetWise::Vehicle + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Campaign&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCampaign + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCampaignRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DecoderManifest&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDecoderManifest + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDecoderManifestRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModelManifest&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModelManifest + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelManifestRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SignalCatalog&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSignalCatalog + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSignalCatalogRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StateTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStateTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStateTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Vehicle&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVehicle + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVehicleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iotsitewise.yaml b/providers/src/awscc/v00.00.00000/services/iotsitewise.yaml index 2fc753e6..2b5e4911 100644 --- a/providers/src/awscc/v00.00.00000/services/iotsitewise.yaml +++ b/providers/src/awscc/v00.00.00000/services/iotsitewise.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTSiteWise - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: User: description: Contains information for a user identity in an access policy. @@ -56,6 +436,14 @@ components: PortalStartUrl: description: The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. type: string + PortalType: + description: The type of portal + type: string + enum: + - SITEWISE_PORTAL_V1 + - SITEWISE_PORTAL_V2 + PortalTypeConfiguration: + $ref: '#/components/schemas/PortalTypeConfiguration' RoleArn: description: The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. type: string @@ -85,15 +473,34 @@ components: - PortalName - RoleArn x-stackql-resource-name: portal - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::Portal + x-type-name: AWS::IoTSiteWise::Portal + x-stackql-primary-identifier: - PortalId + x-stackql-additional-identifiers: + - - PortalArn x-create-only-properties: - PortalAuthMode + - PortalType x-read-only-properties: - PortalArn - PortalClientId - PortalId - PortalStartUrl + x-required-properties: + - PortalContactEmail + - PortalName + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource x-required-permissions: create: - iotsitewise:CreatePortal @@ -121,6 +528,7 @@ components: - sso:DeleteManagedApplicationInstance list: - iotsitewise:ListPortals + - iotsitewise:ListTagsForResource Project: type: object properties: @@ -156,13 +564,28 @@ components: - PortalId - ProjectName x-stackql-resource-name: project - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::Project + x-type-name: AWS::IoTSiteWise::Project + x-stackql-primary-identifier: - ProjectId x-create-only-properties: - PortalId x-read-only-properties: - ProjectId - ProjectArn + x-required-properties: + - PortalId + - ProjectName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource x-required-permissions: create: - iotsitewise:CreateProject @@ -188,7 +611,9 @@ components: - iotsitewise:DescribeProject - iotsitewise:DeleteProject list: + - iotsitewise:ListPortals - iotsitewise:ListProjects + - iotsitewise:ListTagsForResource AccessPolicyIdentity: description: The identity for this access policy. Choose either an SSO user or group or an IAM user or role. type: object @@ -232,11 +657,19 @@ components: - AccessPolicyPermission - AccessPolicyResource x-stackql-resource-name: access_policy - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::AccessPolicy + x-type-name: AWS::IoTSiteWise::AccessPolicy + x-stackql-primary-identifier: - AccessPolicyId x-read-only-properties: - AccessPolicyArn - AccessPolicyId + x-required-properties: + - AccessPolicyIdentity + - AccessPolicyPermission + - AccessPolicyResource + x-tagging: + taggable: false x-required-permissions: create: - iotsitewise:CreateAccessPolicy @@ -250,13 +683,25 @@ components: - iotsitewise:DeleteAccessPolicy list: - iotsitewise:ListAccessPolicies + - iotsitewise:ListProjects + - iotsitewise:ListPortals AssetProperty: description: The asset property's definition, alias, unit, and notification state. type: object additionalProperties: false - required: - - LogicalId properties: + Id: + description: Customer provided actual UUID for property + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ExternalId: + description: String-friendly customer provided external ID + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' LogicalId: description: Customer provided ID for property. type: string @@ -280,9 +725,20 @@ components: type: object additionalProperties: false required: - - LogicalId - ChildAssetId properties: + Id: + description: Customer provided actual UUID for property + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ExternalId: + description: String-friendly customer provided external ID + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' LogicalId: description: The LogicalID of a hierarchy in the parent asset's model. type: string @@ -310,6 +766,15 @@ components: AssetId: description: The ID of the asset type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + AssetExternalId: + description: The External ID of the asset + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' AssetModelId: description: The ID of the asset model from which to create the asset. type: string @@ -343,11 +808,28 @@ components: - AssetName - AssetModelId x-stackql-resource-name: asset - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::Asset + x-type-name: AWS::IoTSiteWise::Asset + x-stackql-primary-identifier: - AssetId x-read-only-properties: - AssetArn - AssetId + - AssetProperties/*/Id + - AssetHierarchies/*/Id + x-required-properties: + - AssetName + - AssetModelId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource x-required-permissions: create: - iotsitewise:AssociateAssets @@ -357,11 +839,17 @@ components: - iotsitewise:ListAssociatedAssets - iotsitewise:ListTagsForResource - iotsitewise:TagResource + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetProperties + - iotsitewise:ListAssetModelCompositeModels - iotsitewise:UpdateAssetProperty read: - iotsitewise:DescribeAsset - iotsitewise:DescribeAssetModel - iotsitewise:ListAssociatedAssets + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels + - iotsitewise:ListAssetProperties - iotsitewise:ListTagsForResource update: - iotsitewise:AssociateAssets @@ -373,6 +861,9 @@ components: - iotsitewise:TagResource - iotsitewise:UpdateAsset - iotsitewise:UpdateAssetProperty + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetProperties + - iotsitewise:ListAssetModelCompositeModels - iotsitewise:UntagResource delete: - iotsitewise:DeleteAsset @@ -380,7 +871,11 @@ components: - iotsitewise:DescribeAssetModel - iotsitewise:DisassociateAssets - iotsitewise:ListAssociatedAssets + - iotsitewise:ListAssetProperties - iotsitewise:ListTagsForResource + - iotsitewise:ListAssetModelCompositeModels + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetProperties list: - iotsitewise:ListAssetModels - iotsitewise:ListAssets @@ -392,6 +887,33 @@ components: - Name - Type properties: + Id: + description: The Actual ID of the composite model + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ExternalId: + description: The External ID of the composite model + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' + ComposedAssetModelId: + description: The component model ID for which the composite model is composed of + type: string + ParentAssetModelCompositeModelExternalId: + description: The parent composite model External ID + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' + Path: + description: The path of the composite model. This is only for derived composite models + type: array + x-insertionOrder: true + items: + type: string Description: description: A description for the asset composite model. type: string @@ -407,22 +929,43 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/AssetModelProperty' + PropertyPathDefinition: + description: The definition for property path which is used to reference properties in transforms/metrics + type: object + additionalProperties: false + required: + - Name + properties: + Name: + description: The name of the property + type: string AssetModelProperty: description: Contains information about an asset model property. type: object additionalProperties: false required: - - LogicalId - Name - DataType - Type properties: LogicalId: - description: Customer provided ID for property. + description: Customer provided Logical ID for property. type: string minLength: 1 maxLength: 256 pattern: '[^\u0000-\u001F\u007F]+' + Id: + description: The ID of the Asset Model Property + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ExternalId: + description: The External ID of the Asset Model Property + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' Name: description: The name of the asset model property. type: string @@ -560,24 +1103,63 @@ components: minLength: 1 maxLength: 256 pattern: '[^\u0000-\u001F\u007F]+' + PropertyId: + description: The ID of the property that is trying to be referenced + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + PropertyExternalId: + description: The External ID of the property that is trying to be referenced + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' + PropertyPath: + description: The path of the property that is trying to be referenced + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/PropertyPathDefinition' HierarchyLogicalId: type: string minLength: 1 maxLength: 256 pattern: '[^\u0000-\u001F\u007F]+' - required: - - PropertyLogicalId + HierarchyId: + description: The ID of the hierarchy that is trying to be referenced + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + HierarchyExternalId: + description: The External ID of the hierarchy that is trying to be referenced + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' AssetModelHierarchy: description: Contains information about an asset model hierarchy. type: object additionalProperties: false required: - - LogicalId - Name - ChildAssetModelId properties: + Id: + description: Customer provided actual ID for hierarchy + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ExternalId: + description: Customer provided external ID for hierarchy + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' LogicalId: - description: Customer provided ID for hierarchy. + description: Customer provided logical ID for hierarchy. type: string minLength: 1 maxLength: 256 @@ -588,12 +1170,54 @@ components: ChildAssetModelId: description: The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model. type: string + EnforcedAssetModelInterfacePropertyMapping: + description: Contains information about enforced interface property and asset model property + type: object + additionalProperties: false + required: + - InterfaceAssetModelPropertyExternalId + properties: + AssetModelPropertyExternalId: + description: The external ID of the enforced asset model property + type: string + AssetModelPropertyLogicalId: + description: The logical ID of the enforced asset model property + type: string + InterfaceAssetModelPropertyExternalId: + description: The external ID of the enforced interface property + type: string + EnforcedAssetModelInterfaceRelationship: + description: Contains information about enforced interface hierarchy and asset model hierarchy + type: object + additionalProperties: false + properties: + InterfaceAssetModelId: + description: The ID of the interface that is enforced to the asset model + type: string + PropertyMappings: + description: Contains information about enforced interface property and asset model property + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/EnforcedAssetModelInterfacePropertyMapping' AssetModel: type: object properties: AssetModelId: description: The ID of the asset model. type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + AssetModelType: + description: The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL or INTERFACE) + type: string + AssetModelExternalId: + description: The external ID of the asset model. + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' AssetModelArn: description: The ARN of the asset model, which has the following format. type: string @@ -621,6 +1245,12 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/AssetModelHierarchy' + EnforcedAssetModelInterfaceRelationships: + description: a list of asset model and interface relationships + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EnforcedAssetModelInterfaceRelationship' Tags: description: A list of key-value pairs that contain metadata for the asset model. type: array @@ -630,33 +1260,272 @@ components: required: - AssetModelName x-stackql-resource-name: asset_model - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::AssetModel + x-type-name: AWS::IoTSiteWise::AssetModel + x-stackql-primary-identifier: - AssetModelId + x-create-only-properties: + - AssetModelType + x-write-only-properties: + - AssetModelProperties/*/DataTypeSpec + - AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId + - AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId + - AssetModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId + - AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId + - AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name + - AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name + - AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name + - AssetModelCompositeModels/*/CompositeModelProperties/*/DataTypeSpec x-read-only-properties: - AssetModelArn - AssetModelId + - AssetModelProperties/*/Id + - AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyId + - AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyId + - AssetModelHierarchies/*/Id + - AssetModelCompositeModels/*/Id + - AssetModelCompositeModels/*/CompositeModelProperties/*/Id + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyId + - AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyId + x-required-properties: + - AssetModelName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource x-required-permissions: create: - iotsitewise:CreateAssetModel - iotsitewise:ListTagsForResource - iotsitewise:TagResource - iotsitewise:DescribeAssetModel + - iotsitewise:UpdateAssetModel + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels + - iotsitewise:UpdateAssetModelCompositeModel + - iotsitewise:DescribeAssetModelCompositeModel + - iotsitewise:CreateAssetModelCompositeModel + - iotsitewise:PutAssetModelInterfaceRelationship + - iotsitewise:DescribeAssetModelInterfaceRelationship read: - iotsitewise:DescribeAssetModel + - iotsitewise:ListAssetModelProperties + - iotsitewise:DescribeAssetModelCompositeModel + - iotsitewise:ListAssetModelCompositeModels - iotsitewise:ListTagsForResource + - iotsitewise:DescribeAssetModelInterfaceRelationship update: - iotsitewise:DescribeAssetModel - iotsitewise:ListTagsForResource - iotsitewise:TagResource - iotsitewise:UntagResource + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels + - iotsitewise:CreateAssetModelCompositeModel + - iotsitewise:UpdateAssetModelCompositeModel + - iotsitewise:DeleteAssetModelCompositeModel + - iotsitewise:DescribeAssetModelCompositeModel - iotsitewise:UpdateAssetModel + - iotsitewise:PutAssetModelInterfaceRelationship + - iotsitewise:DeleteAssetModelInterfaceRelationship + - iotsitewise:DescribeAssetModelInterfaceRelationship delete: - iotsitewise:DescribeAssetModel - iotsitewise:DeleteAssetModel + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels list: - iotsitewise:DescribeAssetModel - iotsitewise:ListAssetModels - iotsitewise:ListTagsForResource + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels + ComputationModelConfiguration: + type: object + additionalProperties: false + properties: + AnomalyDetection: + description: Contains configuration for anomaly detection computation model. + $ref: '#/components/schemas/AnomalyDetectionComputationModelConfiguration' + AnomalyDetectionComputationModelConfiguration: + type: object + additionalProperties: false + required: + - InputProperties + - ResultProperty + properties: + InputProperties: + type: string + minLength: 4 + maxLength: 67 + pattern: ^\$\{[a-z][a-z0-9_]*\}$ + description: Input properties for anomaly detection. + ResultProperty: + type: string + minLength: 4 + maxLength: 67 + pattern: ^\$\{[a-z][a-z0-9_]*\}$ + description: Result property for anomaly detection. + ComputationModelDataBinding: + type: object + additionalProperties: false + x-patternProperties: + ^[a-z][a-z0-9_]{0,63}$: + $ref: '#/components/schemas/ComputationModelDataBindingValue' + ComputationModelDataBindingValue: + type: object + additionalProperties: false + properties: + AssetModelProperty: + description: Defines an asset model property binding. + $ref: '#/components/schemas/AssetModelPropertyBindingValue' + AssetProperty: + description: Defines an asset property binding. + $ref: '#/components/schemas/AssetPropertyBindingValue' + List: + description: Defines a list of computation model binding values. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ComputationModelDataBindingValue' + AssetModelPropertyBindingValue: + type: object + additionalProperties: false + required: + - AssetModelId + - PropertyId + properties: + AssetModelId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + description: The ID of the asset model. + PropertyId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + description: The ID of the asset model property. + AssetPropertyBindingValue: + type: object + additionalProperties: false + required: + - AssetId + - PropertyId + properties: + AssetId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + description: The ID of the asset. + PropertyId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + description: The ID of the asset property. + ComputationModel: + type: object + properties: + ComputationModelId: + description: The ID of the computation model. + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ComputationModelArn: + description: The ARN of the computation model. + type: string + pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_\.]+$ + minLength: 1 + maxLength: 1600 + ComputationModelName: + description: The name of the computation model. + type: string + pattern: ^[a-zA-Z0-9 _\-#$*!@]+$ + minLength: 1 + maxLength: 256 + ComputationModelDescription: + description: A description about the computation model. + type: string + pattern: ^[a-zA-Z0-9 _\-#$*!@]+$ + minLength: 1 + maxLength: 2048 + ComputationModelConfiguration: + description: The configuration for the computation model. + $ref: '#/components/schemas/ComputationModelConfiguration' + ComputationModelDataBinding: + description: The data binding for the computation model. + $ref: '#/components/schemas/ComputationModelDataBinding' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - ComputationModelName + - ComputationModelConfiguration + - ComputationModelDataBinding + x-stackql-resource-name: computation_model + description: Resource schema for AWS::IoTSiteWise::ComputationModel. + x-type-name: AWS::IoTSiteWise::ComputationModel + x-stackql-primary-identifier: + - ComputationModelId + x-read-only-properties: + - ComputationModelArn + - ComputationModelId + x-required-properties: + - ComputationModelName + - ComputationModelConfiguration + - ComputationModelDataBinding + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource + x-required-permissions: + create: + - iotsitewise:CreateComputationModel + - iotsitewise:DescribeComputationModel + - iotsitewise:ListTagsForResource + - iotsitewise:TagResource + read: + - iotsitewise:DescribeComputationModel + - iotsitewise:ListTagsForResource + update: + - iotsitewise:UpdateComputationModel + - iotsitewise:DescribeComputationModel + - iotsitewise:ListTagsForResource + - iotsitewise:TagResource + - iotsitewise:UntagResource + delete: + - iotsitewise:DeleteComputationModel + - iotsitewise:DescribeComputationModel + - iotsitewise:ListTagsForResource + list: + - iotsitewise:ListComputationModels + - iotsitewise:ListTagsForResource Dashboard: type: object properties: @@ -690,13 +1559,31 @@ components: - DashboardDescription - DashboardName x-stackql-resource-name: dashboard - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::Dashboard + x-type-name: AWS::IoTSiteWise::Dashboard + x-stackql-primary-identifier: - DashboardId + x-stackql-additional-identifiers: + - - DashboardArn x-create-only-properties: - ProjectId x-read-only-properties: - DashboardArn - DashboardId + x-required-properties: + - DashboardDefinition + - DashboardDescription + - DashboardName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource x-required-permissions: create: - iotsitewise:CreateDashboard @@ -705,6 +1592,8 @@ components: - iotsitewise:TagResource - iotsitewise:DescribeAsset - iotsitewise:DescribeAssetModel + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels read: - iotsitewise:DescribeDashboard - iotsitewise:ListTagsForResource @@ -716,37 +1605,148 @@ components: - iotsitewise:ListTagsForResource - iotsitewise:DescribeAsset - iotsitewise:DescribeAssetModel + - iotsitewise:ListAssetModelProperties + - iotsitewise:ListAssetModelCompositeModels delete: - iotsitewise:DescribeDashboard - iotsitewise:DeleteDashboard list: - iotsitewise:ListDashboards - GatewayPlatform: - description: Contains a gateway's platform information. + - iotsitewise:ListPortals + - iotsitewise:ListProjects + - iotsitewise:ListTagsForResource + DatasetSource: type: object additionalProperties: false + required: + - SourceFormat + - SourceType properties: - Greengrass: - description: A gateway that runs on AWS IoT Greengrass V1. - $ref: '#/components/schemas/Greengrass' - GreengrassV2: - description: A gateway that runs on AWS IoT Greengrass V2. - $ref: '#/components/schemas/GreengrassV2' - oneOf: - - required: - - Greengrass - - required: - - GreengrassV2 - Greengrass: - description: Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on. - type: object + SourceFormat: + type: string + description: The format of the dataset source associated with the dataset. + enum: + - KNOWLEDGE_BASE + SourceType: + type: string + description: The type of data source for the dataset. + enum: + - KENDRA + SourceDetail: + description: The details of the dataset source associated with the dataset. + $ref: '#/components/schemas/SourceDetail' + SourceDetail: + type: object + additionalProperties: false + properties: + Kendra: + description: Contains details about the Kendra dataset source. + $ref: '#/components/schemas/KendraSourceDetail' + KendraSourceDetail: + type: object additionalProperties: false + required: + - KnowledgeBaseArn + - RoleArn + properties: + KnowledgeBaseArn: + type: string + description: The knowledgeBaseArn details for the Kendra dataset source. + RoleArn: + type: string + description: The roleARN details for the Kendra dataset source. + Dataset: + type: object properties: - GroupArn: - description: The ARN of the Greengrass group. + DatasetId: + description: The ID of the dataset. type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + DatasetArn: + description: The ARN of the dataset. + type: string + DatasetName: + description: The name of the dataset. + type: string + DatasetDescription: + description: A description about the dataset, and its functionality. + type: string + DatasetSource: + description: The data source for the dataset. + $ref: '#/components/schemas/DatasetSource' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - - GroupArn + - DatasetName + - DatasetSource + x-stackql-resource-name: dataset + description: Resource schema for AWS::IoTSiteWise::Dataset. + x-type-name: AWS::IoTSiteWise::Dataset + x-stackql-primary-identifier: + - DatasetId + x-read-only-properties: + - DatasetArn + - DatasetId + x-required-properties: + - DatasetName + - DatasetSource + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource + x-required-permissions: + create: + - iotsitewise:CreateDataset + - iotsitewise:DescribeDataset + - iam:PassRole + - iotsitewise:ListTagsForResource + - iotsitewise:TagResource + read: + - iotsitewise:DescribeDataset + - iotsitewise:ListTagsForResource + update: + - iotsitewise:UpdateDataset + - iotsitewise:DescribeDataset + - iam:PassRole + - iotsitewise:ListTagsForResource + - iotsitewise:TagResource + - iotsitewise:UntagResource + delete: + - iotsitewise:DeleteDataset + - iotsitewise:DescribeDataset + - iotsitewise:ListTagsForResource + list: + - iotsitewise:ListDatasets + - iotsitewise:ListTagsForResource + GatewayPlatform: + description: Contains a gateway's platform information. + type: object + additionalProperties: false + properties: + GreengrassV2: + description: A gateway that runs on AWS IoT Greengrass V2. + $ref: '#/components/schemas/GreengrassV2' + SiemensIE: + description: A gateway that runs on Siemens Industrial Edge. + $ref: '#/components/schemas/SiemensIE' + oneOf: + - required: + - GreengrassV2 + - required: + - SiemensIE GreengrassV2: description: Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on. type: object @@ -755,8 +1755,28 @@ components: CoreDeviceThingName: description: The name of the CoreDevice in GreenGrass V2. type: string + CoreDeviceOperatingSystem: + description: The operating system of the core device in AWS IoT Greengrass V2. + type: string + enum: + - LINUX_AARCH64 + - LINUX_AMD64 + - WINDOWS_AMD64 required: - CoreDeviceThingName + SiemensIE: + description: Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on. + type: object + additionalProperties: false + properties: + IotCoreThingName: + description: The name of the IoT Core Thing. + type: string + required: + - IotCoreThingName + GatewayVersion: + description: The version of the gateway you want to create. + type: string CapabilityNamespace: description: The namespace of the capability configuration. type: string @@ -783,6 +1803,9 @@ components: GatewayPlatform: description: The gateway's platform. You can only specify one platform in a gateway. $ref: '#/components/schemas/GatewayPlatform' + GatewayVersion: + description: The version of the gateway you want to create. + type: string Tags: description: A list of key-value pairs that contain metadata for the gateway. type: array @@ -804,12 +1827,28 @@ components: - GatewayName - GatewayPlatform x-stackql-resource-name: gateway - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTSiteWise::Gateway + x-type-name: AWS::IoTSiteWise::Gateway + x-stackql-primary-identifier: - GatewayId x-create-only-properties: - GatewayPlatform + - GatewayVersion x-read-only-properties: - GatewayId + x-required-properties: + - GatewayName + - GatewayPlatform + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotsitewise:TagResource + - iotsitewise:UntagResource + - iotsitewise:ListTagsForResource x-required-permissions: create: - iotsitewise:CreateGateway @@ -818,10 +1857,8 @@ components: - iotsitewise:UpdateGatewayCapabilityConfiguration - iam:PassRole - iam:GetRole - - greengrass:GetCoreDevice - iotsitewise:ListTagsForResource - iotsitewise:TagResource - - iot:DescribeThing read: - iotsitewise:DescribeGateway - iotsitewise:DescribeGatewayCapabilityConfiguration @@ -840,46 +1877,558 @@ components: - iotsitewise:DeleteGateway list: - iotsitewise:ListGateways + - iotsitewise:ListTagsForResource + PortalTypeEntry: + description: Container associated a certain PortalType. + type: object + additionalProperties: false + properties: + PortalTools: + $ref: '#/components/schemas/PortalTools' + required: + - PortalTools + PortalTools: + description: List of enabled Tools for a certain portal. + type: array + items: + type: string + PortalTypeConfiguration: + description: Map to associate detail of configuration related with a PortalType. + type: object + additionalProperties: false + x-patternProperties: + ^[a-z][a-zA-Z0-9_]*$: + $ref: '#/components/schemas/PortalTypeEntry' AssetId: description: The ID of the asset type: string + CreatePortalRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PortalAuthMode: + description: The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal. + type: string + PortalArn: + description: The ARN of the portal, which has the following format. + type: string + PortalClientId: + description: The AWS SSO application generated client ID (used with AWS SSO APIs). + type: string + PortalContactEmail: + description: The AWS administrator's contact email address. + type: string + PortalDescription: + description: A description for the portal. + type: string + PortalId: + description: The ID of the portal. + type: string + PortalName: + description: A friendly name for the portal. + type: string + PortalStartUrl: + description: The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. + type: string + PortalType: + description: The type of portal + type: string + enum: + - SITEWISE_PORTAL_V1 + - SITEWISE_PORTAL_V2 + PortalTypeConfiguration: + $ref: '#/components/schemas/PortalTypeConfiguration' + RoleArn: + description: The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. + type: string + NotificationSenderEmail: + description: The email address that sends alarm notifications. + type: string + Alarms: + type: object + description: Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. + additionalProperties: false + properties: + AlarmRoleArn: + type: string + description: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events. + NotificationLambdaArn: + type: string + description: The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide. + Tags: + description: A list of key-value pairs that contain metadata for the portal. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePortalRequest + type: object + required: [] + CreateProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PortalId: + description: The ID of the portal in which to create the project. + type: string + ProjectId: + description: The ID of the project. + type: string + ProjectName: + description: A friendly name for the project. + type: string + ProjectDescription: + description: A description for the project. + type: string + ProjectArn: + description: The ARN of the project. + type: string + AssetIds: + description: The IDs of the assets to be associated to the project. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/AssetId' + Tags: + description: A list of key-value pairs that contain metadata for the project. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateProjectRequest + type: object + required: [] + CreateAccessPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessPolicyId: + description: The ID of the access policy. + type: string + AccessPolicyArn: + description: The ARN of the access policy. + type: string + AccessPolicyIdentity: + description: The identity for this access policy. Choose either a user or a group but not both. + $ref: '#/components/schemas/AccessPolicyIdentity' + AccessPolicyPermission: + description: The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER. + type: string + AccessPolicyResource: + description: The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both. + $ref: '#/components/schemas/AccessPolicyResource' + x-stackQL-stringOnly: true + x-title: CreateAccessPolicyRequest + type: object + required: [] + CreateAssetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssetId: + description: The ID of the asset + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + AssetExternalId: + description: The External ID of the asset + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' + AssetModelId: + description: The ID of the asset model from which to create the asset. + type: string + AssetArn: + description: The ARN of the asset + type: string + AssetName: + description: A unique, friendly name for the asset. + type: string + AssetDescription: + description: A description for the asset + type: string + AssetProperties: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AssetProperty' + AssetHierarchies: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AssetHierarchy' + Tags: + description: A list of key-value pairs that contain metadata for the asset. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAssetRequest + type: object + required: [] + CreateAssetModelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssetModelId: + description: The ID of the asset model. + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + AssetModelType: + description: The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL or INTERFACE) + type: string + AssetModelExternalId: + description: The external ID of the asset model. + type: string + minLength: 2 + maxLength: 128 + pattern: '[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+' + AssetModelArn: + description: The ARN of the asset model, which has the following format. + type: string + AssetModelName: + description: A unique, friendly name for the asset model. + type: string + AssetModelDescription: + description: A description for the asset model. + type: string + AssetModelProperties: + description: The property definitions of the asset model. You can specify up to 200 properties per asset model. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AssetModelProperty' + AssetModelCompositeModels: + description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AssetModelCompositeModel' + AssetModelHierarchies: + description: The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AssetModelHierarchy' + EnforcedAssetModelInterfaceRelationships: + description: a list of asset model and interface relationships + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EnforcedAssetModelInterfaceRelationship' + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAssetModelRequest + type: object + required: [] + CreateComputationModelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ComputationModelId: + description: The ID of the computation model. + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ComputationModelArn: + description: The ARN of the computation model. + type: string + pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_\.]+$ + minLength: 1 + maxLength: 1600 + ComputationModelName: + description: The name of the computation model. + type: string + pattern: ^[a-zA-Z0-9 _\-#$*!@]+$ + minLength: 1 + maxLength: 256 + ComputationModelDescription: + description: A description about the computation model. + type: string + pattern: ^[a-zA-Z0-9 _\-#$*!@]+$ + minLength: 1 + maxLength: 2048 + ComputationModelConfiguration: + description: The configuration for the computation model. + $ref: '#/components/schemas/ComputationModelConfiguration' + ComputationModelDataBinding: + description: The data binding for the computation model. + $ref: '#/components/schemas/ComputationModelDataBinding' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateComputationModelRequest + type: object + required: [] + CreateDashboardRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProjectId: + description: The ID of the project in which to create the dashboard. + type: string + DashboardId: + description: The ID of the dashboard. + type: string + DashboardName: + description: A friendly name for the dashboard. + type: string + DashboardDescription: + description: A description for the dashboard. + type: string + DashboardDefinition: + description: The dashboard definition specified in a JSON literal. + type: string + DashboardArn: + description: The ARN of the dashboard. + type: string + Tags: + description: A list of key-value pairs that contain metadata for the dashboard. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDashboardRequest + type: object + required: [] + CreateDatasetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatasetId: + description: The ID of the dataset. + type: string + minLength: 36 + maxLength: 36 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + DatasetArn: + description: The ARN of the dataset. + type: string + DatasetName: + description: The name of the dataset. + type: string + DatasetDescription: + description: A description about the dataset, and its functionality. + type: string + DatasetSource: + description: The data source for the dataset. + $ref: '#/components/schemas/DatasetSource' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDatasetRequest + type: object + required: [] + CreateGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GatewayName: + description: A unique, friendly name for the gateway. + type: string + GatewayPlatform: + description: The gateway's platform. You can only specify one platform in a gateway. + $ref: '#/components/schemas/GatewayPlatform' + GatewayVersion: + description: The version of the gateway you want to create. + type: string + Tags: + description: A list of key-value pairs that contain metadata for the gateway. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + GatewayId: + description: The ID of the gateway device. + type: string + GatewayCapabilitySummaries: + description: A list of gateway capability summaries that each contain a namespace and status. + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/GatewayCapabilitySummary' + x-stackQL-stringOnly: true + x-title: CreateGatewayRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: portals: name: portals id: awscc.iotsitewise.portals x-cfn-schema-name: Portal - x-type: list - x-identifiers: - - PortalId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PortalId') as portal_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PortalId') as portal_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' - AND region = 'us-east-1' - portal: - name: portal - id: awscc.iotsitewise.portal - x-cfn-schema-name: Portal - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::Portal x-identifiers: - PortalId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Portal&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Portal" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Portal" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Portal" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/portals/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/portals/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/portals/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -892,6 +2441,8 @@ components: JSON_EXTRACT(Properties, '$.PortalId') as portal_id, JSON_EXTRACT(Properties, '$.PortalName') as portal_name, JSON_EXTRACT(Properties, '$.PortalStartUrl') as portal_start_url, + JSON_EXTRACT(Properties, '$.PortalType') as portal_type, + JSON_EXTRACT(Properties, '$.PortalTypeConfiguration') as portal_type_configuration, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, JSON_EXTRACT(Properties, '$.NotificationSenderEmail') as notification_sender_email, JSON_EXTRACT(Properties, '$.Alarms') as alarms, @@ -900,7 +2451,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -913,6 +2464,8 @@ components: json_extract_path_text(Properties, 'PortalId') as portal_id, json_extract_path_text(Properties, 'PortalName') as portal_name, json_extract_path_text(Properties, 'PortalStartUrl') as portal_start_url, + json_extract_path_text(Properties, 'PortalType') as portal_type, + json_extract_path_text(Properties, 'PortalTypeConfiguration') as portal_type_configuration, json_extract_path_text(Properties, 'RoleArn') as role_arn, json_extract_path_text(Properties, 'NotificationSenderEmail') as notification_sender_email, json_extract_path_text(Properties, 'Alarms') as alarms, @@ -920,13 +2473,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' AND data__Identifier = '' AND region = 'us-east-1' - projects: - name: projects - id: awscc.iotsitewise.projects - x-cfn-schema-name: Project - x-type: list + portals_list_only: + name: portals_list_only + id: awscc.iotsitewise.portals_list_only + x-cfn-schema-name: Portal + x-cfn-type-name: AWS::IoTSiteWise::Portal x-identifiers: - - ProjectId + - PortalId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -934,28 +2493,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProjectId') as project_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' + JSON_EXTRACT(Properties, '$.PortalId') as portal_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProjectId') as project_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' + json_extract_path_text(Properties, 'PortalId') as portal_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' AND region = 'us-east-1' - project: - name: project - id: awscc.iotsitewise.project + projects: + name: projects + id: awscc.iotsitewise.projects x-cfn-schema-name: Project - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::Project x-identifiers: - ProjectId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -971,7 +2578,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -986,13 +2593,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Project' AND data__Identifier = '' AND region = 'us-east-1' - access_policies: - name: access_policies - id: awscc.iotsitewise.access_policies - x-cfn-schema-name: AccessPolicy - x-type: list + projects_list_only: + name: projects_list_only + id: awscc.iotsitewise.projects_list_only + x-cfn-schema-name: Project + x-cfn-type-name: AWS::IoTSiteWise::Project x-identifiers: - - AccessPolicyId + - ProjectId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1000,28 +2613,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AccessPolicyId') as access_policy_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' + JSON_EXTRACT(Properties, '$.ProjectId') as project_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AccessPolicyId') as access_policy_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' + json_extract_path_text(Properties, 'ProjectId') as project_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' AND region = 'us-east-1' - access_policy: - name: access_policy - id: awscc.iotsitewise.access_policy + access_policies: + name: access_policies + id: awscc.iotsitewise.access_policies x-cfn-schema-name: AccessPolicy - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::AccessPolicy x-identifiers: - AccessPolicyId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::AccessPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::AccessPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::AccessPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1035,7 +2696,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1048,13 +2709,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' AND data__Identifier = '' AND region = 'us-east-1' - assets: - name: assets - id: awscc.iotsitewise.assets - x-cfn-schema-name: Asset - x-type: list + access_policies_list_only: + name: access_policies_list_only + id: awscc.iotsitewise.access_policies_list_only + x-cfn-schema-name: AccessPolicy + x-cfn-type-name: AWS::IoTSiteWise::AccessPolicy x-identifiers: - - AssetId + - AccessPolicyId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1062,33 +2729,82 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AssetId') as asset_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' + JSON_EXTRACT(Properties, '$.AccessPolicyId') as access_policy_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AssetId') as asset_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' + json_extract_path_text(Properties, 'AccessPolicyId') as access_policy_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' AND region = 'us-east-1' - asset: - name: asset - id: awscc.iotsitewise.asset + assets: + name: assets + id: awscc.iotsitewise.assets x-cfn-schema-name: Asset - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::Asset x-identifiers: - AssetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Asset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Asset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Asset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Asset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/assets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.AssetId') as asset_id, + JSON_EXTRACT(Properties, '$.AssetExternalId') as asset_external_id, JSON_EXTRACT(Properties, '$.AssetModelId') as asset_model_id, JSON_EXTRACT(Properties, '$.AssetArn') as asset_arn, JSON_EXTRACT(Properties, '$.AssetName') as asset_name, @@ -1100,12 +2816,13 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'AssetId') as asset_id, + json_extract_path_text(Properties, 'AssetExternalId') as asset_external_id, json_extract_path_text(Properties, 'AssetModelId') as asset_model_id, json_extract_path_text(Properties, 'AssetArn') as asset_arn, json_extract_path_text(Properties, 'AssetName') as asset_name, @@ -1116,13 +2833,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' AND data__Identifier = '' AND region = 'us-east-1' - asset_models: - name: asset_models - id: awscc.iotsitewise.asset_models - x-cfn-schema-name: AssetModel - x-type: list + assets_list_only: + name: assets_list_only + id: awscc.iotsitewise.assets_list_only + x-cfn-schema-name: Asset + x-cfn-type-name: AWS::IoTSiteWise::Asset x-identifiers: - - AssetModelId + - AssetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1130,67 +2853,127 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AssetModelId') as asset_model_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' + JSON_EXTRACT(Properties, '$.AssetId') as asset_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AssetModelId') as asset_model_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' + json_extract_path_text(Properties, 'AssetId') as asset_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' AND region = 'us-east-1' - asset_model: - name: asset_model - id: awscc.iotsitewise.asset_model + asset_models: + name: asset_models + id: awscc.iotsitewise.asset_models x-cfn-schema-name: AssetModel - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::AssetModel x-identifiers: - AssetModelId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AssetModel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::AssetModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::AssetModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::AssetModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/asset_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/asset_models/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/asset_models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.AssetModelId') as asset_model_id, + JSON_EXTRACT(Properties, '$.AssetModelType') as asset_model_type, + JSON_EXTRACT(Properties, '$.AssetModelExternalId') as asset_model_external_id, JSON_EXTRACT(Properties, '$.AssetModelArn') as asset_model_arn, JSON_EXTRACT(Properties, '$.AssetModelName') as asset_model_name, JSON_EXTRACT(Properties, '$.AssetModelDescription') as asset_model_description, JSON_EXTRACT(Properties, '$.AssetModelProperties') as asset_model_properties, JSON_EXTRACT(Properties, '$.AssetModelCompositeModels') as asset_model_composite_models, JSON_EXTRACT(Properties, '$.AssetModelHierarchies') as asset_model_hierarchies, + JSON_EXTRACT(Properties, '$.EnforcedAssetModelInterfaceRelationships') as enforced_asset_model_interface_relationships, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'AssetModelId') as asset_model_id, + json_extract_path_text(Properties, 'AssetModelType') as asset_model_type, + json_extract_path_text(Properties, 'AssetModelExternalId') as asset_model_external_id, json_extract_path_text(Properties, 'AssetModelArn') as asset_model_arn, json_extract_path_text(Properties, 'AssetModelName') as asset_model_name, json_extract_path_text(Properties, 'AssetModelDescription') as asset_model_description, json_extract_path_text(Properties, 'AssetModelProperties') as asset_model_properties, json_extract_path_text(Properties, 'AssetModelCompositeModels') as asset_model_composite_models, json_extract_path_text(Properties, 'AssetModelHierarchies') as asset_model_hierarchies, + json_extract_path_text(Properties, 'EnforcedAssetModelInterfaceRelationships') as enforced_asset_model_interface_relationships, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' AND data__Identifier = '' AND region = 'us-east-1' - dashboards: - name: dashboards - id: awscc.iotsitewise.dashboards - x-cfn-schema-name: Dashboard - x-type: list + asset_models_list_only: + name: asset_models_list_only + id: awscc.iotsitewise.asset_models_list_only + x-cfn-schema-name: AssetModel + x-cfn-type-name: AWS::IoTSiteWise::AssetModel x-identifiers: - - DashboardId + - AssetModelId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1198,28 +2981,196 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' + JSON_EXTRACT(Properties, '$.AssetModelId') as asset_model_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DashboardId') as dashboard_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' + json_extract_path_text(Properties, 'AssetModelId') as asset_model_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' + AND region = 'us-east-1' + computation_models: + name: computation_models + id: awscc.iotsitewise.computation_models + x-cfn-schema-name: ComputationModel + x-cfn-type-name: AWS::IoTSiteWise::ComputationModel + x-identifiers: + - ComputationModelId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ComputationModel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::ComputationModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::ComputationModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::ComputationModel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/computation_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/computation_models/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/computation_models/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ComputationModelId') as computation_model_id, + JSON_EXTRACT(Properties, '$.ComputationModelArn') as computation_model_arn, + JSON_EXTRACT(Properties, '$.ComputationModelName') as computation_model_name, + JSON_EXTRACT(Properties, '$.ComputationModelDescription') as computation_model_description, + JSON_EXTRACT(Properties, '$.ComputationModelConfiguration') as computation_model_configuration, + JSON_EXTRACT(Properties, '$.ComputationModelDataBinding') as computation_model_data_binding, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::ComputationModel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ComputationModelId') as computation_model_id, + json_extract_path_text(Properties, 'ComputationModelArn') as computation_model_arn, + json_extract_path_text(Properties, 'ComputationModelName') as computation_model_name, + json_extract_path_text(Properties, 'ComputationModelDescription') as computation_model_description, + json_extract_path_text(Properties, 'ComputationModelConfiguration') as computation_model_configuration, + json_extract_path_text(Properties, 'ComputationModelDataBinding') as computation_model_data_binding, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::ComputationModel' + AND data__Identifier = '' + AND region = 'us-east-1' + computation_models_list_only: + name: computation_models_list_only + id: awscc.iotsitewise.computation_models_list_only + x-cfn-schema-name: ComputationModel + x-cfn-type-name: AWS::IoTSiteWise::ComputationModel + x-identifiers: + - ComputationModelId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ComputationModelId') as computation_model_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::ComputationModel' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ComputationModelId') as computation_model_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::ComputationModel' AND region = 'us-east-1' - dashboard: - name: dashboard - id: awscc.iotsitewise.dashboard + dashboards: + name: dashboards + id: awscc.iotsitewise.dashboards x-cfn-schema-name: Dashboard - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::Dashboard x-identifiers: - DashboardId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1235,7 +3186,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1250,13 +3201,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' AND data__Identifier = '' AND region = 'us-east-1' - gateways: - name: gateways - id: awscc.iotsitewise.gateways - x-cfn-schema-name: Gateway - x-type: list + dashboards_list_only: + name: dashboards_list_only + id: awscc.iotsitewise.dashboards_list_only + x-cfn-schema-name: Dashboard + x-cfn-type-name: AWS::IoTSiteWise::Dashboard x-identifiers: - - GatewayId + - DashboardId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1264,34 +3221,201 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' + JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GatewayId') as gateway_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' + json_extract_path_text(Properties, 'DashboardId') as dashboard_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' AND region = 'us-east-1' - gateway: - name: gateway - id: awscc.iotsitewise.gateway + datasets: + name: datasets + id: awscc.iotsitewise.datasets + x-cfn-schema-name: Dataset + x-cfn-type-name: AWS::IoTSiteWise::Dataset + x-identifiers: + - DatasetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DatasetId') as dataset_id, + JSON_EXTRACT(Properties, '$.DatasetArn') as dataset_arn, + JSON_EXTRACT(Properties, '$.DatasetName') as dataset_name, + JSON_EXTRACT(Properties, '$.DatasetDescription') as dataset_description, + JSON_EXTRACT(Properties, '$.DatasetSource') as dataset_source, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Dataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatasetId') as dataset_id, + json_extract_path_text(Properties, 'DatasetArn') as dataset_arn, + json_extract_path_text(Properties, 'DatasetName') as dataset_name, + json_extract_path_text(Properties, 'DatasetDescription') as dataset_description, + json_extract_path_text(Properties, 'DatasetSource') as dataset_source, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Dataset' + AND data__Identifier = '' + AND region = 'us-east-1' + datasets_list_only: + name: datasets_list_only + id: awscc.iotsitewise.datasets_list_only + x-cfn-schema-name: Dataset + x-cfn-type-name: AWS::IoTSiteWise::Dataset + x-identifiers: + - DatasetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DatasetId') as dataset_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dataset' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatasetId') as dataset_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dataset' + AND region = 'us-east-1' + gateways: + name: gateways + id: awscc.iotsitewise.gateways x-cfn-schema-name: Gateway - x-type: get + x-cfn-type-name: AWS::IoTSiteWise::Gateway x-identifiers: - GatewayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Gateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Gateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Gateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTSiteWise::Gateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.GatewayName') as gateway_name, JSON_EXTRACT(Properties, '$.GatewayPlatform') as gateway_platform, + JSON_EXTRACT(Properties, '$.GatewayVersion') as gateway_version, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id, JSON_EXTRACT(Properties, '$.GatewayCapabilitySummaries') as gateway_capability_summaries @@ -1299,16 +3423,579 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'GatewayName') as gateway_name, json_extract_path_text(Properties, 'GatewayPlatform') as gateway_platform, + json_extract_path_text(Properties, 'GatewayVersion') as gateway_version, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'GatewayId') as gateway_id, json_extract_path_text(Properties, 'GatewayCapabilitySummaries') as gateway_capability_summaries FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' AND data__Identifier = '' AND region = 'us-east-1' + gateways_list_only: + name: gateways_list_only + id: awscc.iotsitewise.gateways_list_only + x-cfn-schema-name: Gateway + x-cfn-type-name: AWS::IoTSiteWise::Gateway + x-identifiers: + - GatewayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GatewayId') as gateway_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Portal&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePortal + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePortalRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Asset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAsset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AssetModel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssetModel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssetModelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ComputationModel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComputationModel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComputationModelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDashboard + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDashboardRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Gateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iottwinmaker.yaml b/providers/src/awscc/v00.00.00000/services/iottwinmaker.yaml index ac8896fb..5c03365f 100644 --- a/providers/src/awscc/v00.00.00000/services/iottwinmaker.yaml +++ b/providers/src/awscc/v00.00.00000/services/iottwinmaker.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTTwinMaker - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DateTimeFormat: type: string @@ -366,7 +746,9 @@ components: - WorkspaceId - ComponentTypeId x-stackql-resource-name: component_type - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTTwinMaker::ComponentType + x-type-name: AWS::IoTTwinMaker::ComponentType + x-stackql-primary-identifier: - WorkspaceId - ComponentTypeId x-create-only-properties: @@ -379,6 +761,19 @@ components: - Status - IsAbstract - IsSchemaInitialized + x-required-properties: + - WorkspaceId + - ComponentTypeId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iottwinmaker:TagResource + - iottwinmaker:UntagResource + - iottwinmaker:ListTagsForResource x-required-permissions: create: - iottwinmaker:CreateComponentType @@ -626,7 +1021,9 @@ components: - WorkspaceId - EntityName x-stackql-resource-name: entity - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTTwinMaker::Entity + x-type-name: AWS::IoTTwinMaker::Entity + x-stackql-primary-identifier: - WorkspaceId - EntityId x-create-only-properties: @@ -638,6 +1035,19 @@ components: - UpdateDateTime - Status - HasChildEntities + x-required-properties: + - WorkspaceId + - EntityName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iottwinmaker:TagResource + - iottwinmaker:UntagResource + - iottwinmaker:ListTagsForResource x-required-permissions: create: - iottwinmaker:GetWorkspace @@ -761,7 +1171,9 @@ components: - SceneId - ContentLocation x-stackql-resource-name: scene - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTTwinMaker::Scene + x-type-name: AWS::IoTTwinMaker::Scene + x-stackql-primary-identifier: - WorkspaceId - SceneId x-create-only-properties: @@ -772,6 +1184,20 @@ components: - CreationDateTime - UpdateDateTime - GeneratedSceneMetadata + x-required-properties: + - WorkspaceId + - SceneId + - ContentLocation + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iottwinmaker:TagResource + - iottwinmaker:UntagResource + - iottwinmaker:ListTagsForResource x-required-permissions: create: - iottwinmaker:CreateScene @@ -850,7 +1276,9 @@ components: - SyncSource - SyncRole x-stackql-resource-name: sync_job - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTTwinMaker::SyncJob + x-type-name: AWS::IoTTwinMaker::SyncJob + x-stackql-primary-identifier: - WorkspaceId - SyncSource x-create-only-properties: @@ -863,6 +1291,21 @@ components: - CreationDateTime - UpdateDateTime - State + x-required-properties: + - WorkspaceId + - SyncSource + - SyncRole + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iottwinmaker:TagResource + - iottwinmaker:UntagResource + - iottwinmaker:ListTagsForResource x-required-permissions: create: - iam:PassRole @@ -933,7 +1376,9 @@ components: - Role - S3Location x-stackql-resource-name: workspace - x-stackql-primaryIdentifier: + description: Resource schema for AWS::IoTTwinMaker::Workspace + x-type-name: AWS::IoTTwinMaker::Workspace + x-stackql-primary-identifier: - WorkspaceId x-create-only-properties: - WorkspaceId @@ -941,6 +1386,20 @@ components: - Arn - CreationDateTime - UpdateDateTime + x-required-properties: + - WorkspaceId + - Role + - S3Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iottwinmaker:TagResource + - iottwinmaker:UntagResource + - iottwinmaker:ListTagsForResource x-required-permissions: create: - iam:PassRole @@ -964,47 +1423,481 @@ components: - iottwinmaker:GetWorkspace - iottwinmaker:ListTagsForResource - iottwinmaker:ListWorkspaces + CreateComponentTypeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkspaceId: + description: The ID of the workspace that contains the component type. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+' + ComponentTypeId: + description: The ID of the component type. + type: string + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z_\.\-0-9:]+' + Description: + description: The description of the component type. + type: string + minLength: 0 + maxLength: 512 + ExtendsFrom: + description: Specifies the parent component type to extend. + type: array + minItems: 1 + maxItems: 256 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ParentComponentType' + Functions: + description: a Map of functions in the component type. Each function's key must be unique to this map. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z_\-0-9]+': + $ref: '#/components/schemas/Function' + IsSingleton: + description: A Boolean value that specifies whether an entity can have more than one component of this type. + type: boolean + PropertyDefinitions: + description: An map of the property definitions in the component type. Each property definition's key must be unique to this map. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9]+': + $ref: '#/components/schemas/PropertyDefinition' + additionalProperties: false + PropertyGroups: + description: An map of the property groups in the component type. Each property group's key must be unique to this map. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9]+': + $ref: '#/components/schemas/PropertyGroup' + additionalProperties: false + CompositeComponentTypes: + description: An map of the composite component types in the component type. Each composite component type's key must be unique to this map. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9]+': + $ref: '#/components/schemas/CompositeComponentType' + additionalProperties: false + Arn: + description: The ARN of the component type. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ + CreationDateTime: + description: The date and time when the component type was created. + $ref: '#/components/schemas/DateTimeFormat' + UpdateDateTime: + description: The last date and time when the component type was updated. + $ref: '#/components/schemas/DateTimeFormat' + Status: + description: The current status of the component type. + $ref: '#/components/schemas/Status' + IsAbstract: + description: A Boolean value that specifies whether the component type is abstract. + type: boolean + IsSchemaInitialized: + description: A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run. + type: boolean + Tags: + type: object + description: A map of key-value pairs to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + minLength: 1 + maxLength: 256 + maxProperties: 50 + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateComponentTypeRequest + type: object + required: [] + CreateEntityRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EntityId: + description: The ID of the entity. + type: string + minLength: 1 + maxLength: 128 + pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+' + EntityName: + description: The name of the entity. + type: string + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+' + Status: + description: The current status of the entity. + $ref: '#/components/schemas/Status' + HasChildEntities: + description: A Boolean value that specifies whether the entity has child entities or not. + type: boolean + ParentEntityId: + description: The ID of the parent entity. + type: string + minLength: 1 + maxLength: 128 + pattern: \$ROOT|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+ + Arn: + description: The ARN of the entity. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ + Description: + description: The description of the entity. + type: string + minLength: 0 + maxLength: 512 + CreationDateTime: + description: The date and time when the entity was created. + $ref: '#/components/schemas/DateTimeFormat' + UpdateDateTime: + description: The last date and time when the entity was updated. + $ref: '#/components/schemas/DateTimeFormat' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + minLength: 1 + maxLength: 256 + additionalProperties: false + WorkspaceId: + description: The ID of the workspace. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+' + Components: + description: A map that sets information about a component type. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9]+': + $ref: '#/components/schemas/Component' + additionalProperties: false + CompositeComponents: + description: A map that sets information about a composite component. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9/]+': + $ref: '#/components/schemas/CompositeComponent' + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateEntityRequest + type: object + required: [] + CreateSceneRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SceneId: + description: The ID of the scene. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+' + Arn: + description: The ARN of the scene. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ + Description: + description: The description of the scene. + type: string + minLength: 0 + maxLength: 512 + ContentLocation: + description: The relative path that specifies the location of the content definition file. + type: string + minLength: 0 + maxLength: 256 + pattern: '[sS]3://[A-Za-z0-9._/-]+' + CreationDateTime: + description: The date and time when the scene was created. + $ref: '#/components/schemas/DateTimeFormat' + UpdateDateTime: + description: The date and time of the current update. + $ref: '#/components/schemas/DateTimeFormat' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + minLength: 1 + maxLength: 256 + additionalProperties: false + WorkspaceId: + description: The ID of the scene. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+' + Capabilities: + description: A list of capabilities that the scene uses to render. + type: array + minItems: 0 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + type: string + minLength: 0 + maxLength: 256 + pattern: .* + SceneMetadata: + description: A key-value pair of scene metadata for the scene. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9]+': + type: string + minLength: 0 + maxLength: 2048 + minLength: 0 + maxLength: 50 + additionalProperties: false + GeneratedSceneMetadata: + description: A key-value pair of generated scene metadata for the scene. + type: object + x-patternProperties: + '[a-zA-Z_\-0-9]+': + type: string + minLength: 0 + maxLength: 2048 + minLength: 0 + maxLength: 50 + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateSceneRequest + type: object + required: [] + CreateSyncJobRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkspaceId: + description: The ID of the workspace. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+' + SyncSource: + description: The source of the SyncJob. + type: string + minLength: 1 + maxLength: 128 + SyncRole: + description: The IAM Role that execute SyncJob. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.* + CreationDateTime: + description: The date and time when the sync job was created. + $ref: '#/components/schemas/DateTimeFormat' + UpdateDateTime: + description: The date and time when the sync job was updated. + $ref: '#/components/schemas/DateTimeFormat' + Arn: + description: The ARN of the SyncJob. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ + State: + description: The state of SyncJob. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_\-0-9]+' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + minLength: 1 + maxLength: 256 + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateSyncJobRequest + type: object + required: [] + CreateWorkspaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkspaceId: + description: The ID of the workspace. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+' + Arn: + description: The ARN of the workspace. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ + Description: + description: The description of the workspace. + type: string + minLength: 0 + maxLength: 512 + Role: + description: The ARN of the execution role associated with the workspace. + type: string + minLength: 20 + maxLength: 2048 + pattern: arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.* + S3Location: + description: The ARN of the S3 bucket where resources associated with the workspace are stored. + type: string + CreationDateTime: + description: The date and time when the workspace was created. + $ref: '#/components/schemas/DateTimeFormat' + UpdateDateTime: + description: The date and time of the current update. + $ref: '#/components/schemas/DateTimeFormat' + Tags: + type: object + description: A map of key-value pairs to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + minLength: 1 + maxLength: 256 + maxProperties: 50 + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateWorkspaceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: component_types: name: component_types id: awscc.iottwinmaker.component_types x-cfn-schema-name: ComponentType - x-type: list - x-identifiers: - - WorkspaceId - - ComponentTypeId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.ComponentTypeId') as component_type_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'ComponentTypeId') as component_type_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' - AND region = 'us-east-1' - component_type: - name: component_type - id: awscc.iottwinmaker.component_type - x-cfn-schema-name: ComponentType - x-type: get + x-cfn-type-name: AWS::IoTTwinMaker::ComponentType x-identifiers: - WorkspaceId - ComponentTypeId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ComponentType&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::ComponentType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::ComponentType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::ComponentType" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/component_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/component_types/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/component_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1029,7 +1922,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1053,14 +1946,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' AND data__Identifier = '|' AND region = 'us-east-1' - entities: - name: entities - id: awscc.iottwinmaker.entities - x-cfn-schema-name: Entity - x-type: list + component_types_list_only: + name: component_types_list_only + id: awscc.iottwinmaker.component_types_list_only + x-cfn-schema-name: ComponentType + x-cfn-type-name: AWS::IoTTwinMaker::ComponentType x-identifiers: - WorkspaceId - - EntityId + - ComponentTypeId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1069,8 +1968,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.EntityId') as entity_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' + JSON_EXTRACT(Properties, '$.ComponentTypeId') as component_type_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1078,21 +1977,69 @@ components: SELECT region, json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'EntityId') as entity_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' + json_extract_path_text(Properties, 'ComponentTypeId') as component_type_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' AND region = 'us-east-1' - entity: - name: entity - id: awscc.iottwinmaker.entity + entities: + name: entities + id: awscc.iottwinmaker.entities x-cfn-schema-name: Entity - x-type: get + x-cfn-type-name: AWS::IoTTwinMaker::Entity x-identifiers: - WorkspaceId - EntityId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Entity&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Entity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Entity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Entity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/entities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/entities/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/entities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1114,7 +2061,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1135,14 +2082,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' AND data__Identifier = '|' AND region = 'us-east-1' - scenes: - name: scenes - id: awscc.iottwinmaker.scenes - x-cfn-schema-name: Scene - x-type: list + entities_list_only: + name: entities_list_only + id: awscc.iottwinmaker.entities_list_only + x-cfn-schema-name: Entity + x-cfn-type-name: AWS::IoTTwinMaker::Entity x-identifiers: - WorkspaceId - - SceneId + - EntityId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1151,8 +2104,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.SceneId') as scene_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' + JSON_EXTRACT(Properties, '$.EntityId') as entity_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1160,21 +2113,69 @@ components: SELECT region, json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'SceneId') as scene_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' + json_extract_path_text(Properties, 'EntityId') as entity_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' AND region = 'us-east-1' - scene: - name: scene - id: awscc.iottwinmaker.scene + scenes: + name: scenes + id: awscc.iottwinmaker.scenes x-cfn-schema-name: Scene - x-type: get + x-cfn-type-name: AWS::IoTTwinMaker::Scene x-identifiers: - WorkspaceId - SceneId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Scene&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Scene" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Scene" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Scene" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scenes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scenes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scenes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1194,7 +2195,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1213,14 +2214,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' AND data__Identifier = '|' AND region = 'us-east-1' - sync_jobs: - name: sync_jobs - id: awscc.iottwinmaker.sync_jobs - x-cfn-schema-name: SyncJob - x-type: list + scenes_list_only: + name: scenes_list_only + id: awscc.iottwinmaker.scenes_list_only + x-cfn-schema-name: Scene + x-cfn-type-name: AWS::IoTTwinMaker::Scene x-identifiers: - WorkspaceId - - SyncSource + - SceneId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1229,8 +2236,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.SyncSource') as sync_source - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' + JSON_EXTRACT(Properties, '$.SceneId') as scene_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1238,21 +2245,56 @@ components: SELECT region, json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'SyncSource') as sync_source - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' + json_extract_path_text(Properties, 'SceneId') as scene_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' AND region = 'us-east-1' - sync_job: - name: sync_job - id: awscc.iottwinmaker.sync_job + sync_jobs: + name: sync_jobs + id: awscc.iottwinmaker.sync_jobs x-cfn-schema-name: SyncJob - x-type: get + x-cfn-type-name: AWS::IoTTwinMaker::SyncJob x-identifiers: - WorkspaceId - SyncSource + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SyncJob&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::SyncJob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::SyncJob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sync_jobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sync_jobs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1269,7 +2311,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1285,13 +2327,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' AND data__Identifier = '|' AND region = 'us-east-1' - workspaces: - name: workspaces - id: awscc.iottwinmaker.workspaces - x-cfn-schema-name: Workspace - x-type: list + sync_jobs_list_only: + name: sync_jobs_list_only + id: awscc.iottwinmaker.sync_jobs_list_only + x-cfn-schema-name: SyncJob + x-cfn-type-name: AWS::IoTTwinMaker::SyncJob x-identifiers: - WorkspaceId + - SyncSource + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1299,28 +2348,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, + JSON_EXTRACT(Properties, '$.SyncSource') as sync_source + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'SyncSource') as sync_source + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' AND region = 'us-east-1' - workspace: - name: workspace - id: awscc.iottwinmaker.workspace + workspaces: + name: workspaces + id: awscc.iottwinmaker.workspaces x-cfn-schema-name: Workspace - x-type: get + x-cfn-type-name: AWS::IoTTwinMaker::Workspace x-identifiers: - WorkspaceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workspace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTTwinMaker::Workspace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1337,7 +2436,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1353,3 +2452,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' AND data__Identifier = '' AND region = 'us-east-1' + workspaces_list_only: + name: workspaces_list_only + id: awscc.iottwinmaker.workspaces_list_only + x-cfn-schema-name: Workspace + x-cfn-type-name: AWS::IoTTwinMaker::Workspace + x-identifiers: + - WorkspaceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ComponentType&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComponentType + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComponentTypeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Entity&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEntity + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEntityRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Scene&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScene + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSceneRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SyncJob&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSyncJob + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSyncJobRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workspace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkspace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkspaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/iotwireless.yaml b/providers/src/awscc/v00.00.00000/services/iotwireless.yaml index 7be8bec0..6a0fc2bb 100644 --- a/providers/src/awscc/v00.00.00000/services/iotwireless.yaml +++ b/providers/src/awscc/v00.00.00000/services/iotwireless.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IoTWireless - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -60,26 +440,42 @@ components: - Expression - ExpressionType x-stackql-resource-name: destination - x-stackql-primaryIdentifier: + description: Destination's resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::IoTWireless::Destination + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + - Expression + - ExpressionType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iam:PassRole - iotwireless:CreateDestination - iotwireless:TagResource - - iotwireless:ListTagsForResource read: - iotwireless:GetDestination - iotwireless:ListTagsForResource update: - iam:PassRole + - iotwireless:GetDestination - iotwireless:UpdateDestination - iotwireless:UntagResource - - iotwireless:ListTagsForResource + - iotwireless:TagResource delete: - iotwireless:DeleteDestination list: @@ -186,16 +582,35 @@ components: maxLength: 256 required: [] x-stackql-resource-name: device_profile - x-stackql-primaryIdentifier: + description: Device Profile's resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::IoTWireless::DeviceProfile + x-stackql-primary-identifier: - Id + x-create-only-properties: + - Name + - LoRaWAN x-read-only-properties: - Arn - Id + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateDeviceProfile - iotwireless:TagResource - - iotwireless:ListTagsForResource + update: + - iotwireless:GetDeviceProfile + - iotwireless:TagResource + - iotwireless:UntagResource read: - iotwireless:GetDeviceProfile - iotwireless:ListTagsForResource @@ -290,18 +705,33 @@ components: - FirmwareUpdateImage - FirmwareUpdateRole x-stackql-resource-name: fuota_task - x-stackql-primaryIdentifier: + description: Create and manage FUOTA tasks. + x-type-name: AWS::IoTWireless::FuotaTask + x-stackql-primary-identifier: - Id x-read-only-properties: - Arn - Id - FuotaTaskStatus - LoRaWAN/StartTime + x-required-properties: + - LoRaWAN + - FirmwareUpdateImage + - FirmwareUpdateRole + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateFuotaTask - iotwireless:TagResource - - iotwireless:ListTagsForResource - iam:GetRole - iam:PassRole read: @@ -310,8 +740,9 @@ components: update: - iam:PassRole - iotwireless:UpdateFuotaTask + - iotwireless:GetFuotaTask + - iotwireless:TagResource - iotwireless:UntagResource - - iotwireless:ListTagsForResource - iotwireless:AssociateMulticastGroupWithFuotaTask - iotwireless:DisassociateMulticastGroupFromFuotaTask - iotwireless:AssociateWirelessDeviceWithFuotaTask @@ -364,7 +795,9 @@ components: required: - LoRaWAN x-stackql-resource-name: multicast_group - x-stackql-primaryIdentifier: + description: Create and manage Multicast groups. + x-type-name: AWS::IoTWireless::MulticastGroup + x-stackql-primary-identifier: - Id x-read-only-properties: - Arn @@ -372,18 +805,30 @@ components: - Status - LoRaWAN/NumberOfDevicesRequested - LoRaWAN/NumberOfDevicesInGroup + x-required-properties: + - LoRaWAN + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateMulticastGroup - iotwireless:TagResource - - iotwireless:ListTagsForResource read: - iotwireless:GetMulticastGroup - iotwireless:ListTagsForResource update: - iotwireless:UpdateMulticastGroup + - iotwireless:GetMulticastGroup + - iotwireless:TagResource - iotwireless:UntagResource - - iotwireless:ListTagsForResource - iotwireless:AssociateWirelessDeviceWithMulticastGroup - iotwireless:DisassociateWirelessDeviceFromMulticastGroup delete: @@ -451,25 +896,38 @@ components: required: - Name x-stackql-resource-name: network_analyzer_configuration - x-stackql-primaryIdentifier: + description: Create and manage NetworkAnalyzerConfiguration resource. + x-type-name: AWS::IoTWireless::NetworkAnalyzerConfiguration + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - - Tags x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateNetworkAnalyzerConfiguration - iotwireless:TagResource - - iotwireless:ListTagsForResource read: - iotwireless:GetNetworkAnalyzerConfiguration - iotwireless:ListTagsForResource update: - iotwireless:UpdateNetworkAnalyzerConfiguration + - iotwireless:GetNetworkAnalyzerConfiguration + - iotwireless:TagResource - iotwireless:UntagResource - - iotwireless:ListTagsForResource delete: - iotwireless:DeleteNetworkAnalyzerConfiguration list: @@ -548,18 +1006,33 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: partner_account - x-stackql-primaryIdentifier: + description: Create and manage partner account + x-type-name: AWS::IoTWireless::PartnerAccount + x-stackql-primary-identifier: - PartnerAccountId x-create-only-properties: - PartnerAccountId + x-write-only-properties: + - SidewalkUpdate + - Sidewalk x-read-only-properties: - Arn - Fingerprint + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:AssociateAwsAccountWithPartnerAccount - iotwireless:TagResource - - iotwireless:ListTagsForResource + - iotwireless:GetPartnerAccount read: - iotwireless:GetPartnerAccount - iotwireless:ListTagsForResource @@ -567,9 +1040,12 @@ components: - iotwireless:ListPartnerAccounts - iotwireless:ListTagsForResource update: + - iotwireless:GetPartnerAccount + - iotwireless:AssociateAwsAccountWithPartnerAccount - iotwireless:UpdatePartnerAccount - - iotwireless:UntagResource - iotwireless:ListTagsForResource + - iotwireless:TagResource + - iotwireless:UntagResource delete: - iotwireless:DisassociateAwsAccountFromPartnerAccount LoRaWANServiceProfile: @@ -641,8 +1117,13 @@ components: maxLength: 256 required: [] x-stackql-resource-name: service_profile - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::IoTWireless::ServiceProfile + x-stackql-primary-identifier: - Id + x-create-only-properties: + - Name + - LoRaWAN x-read-only-properties: - Id - Arn @@ -662,11 +1143,25 @@ components: - LoRaWAN/NwkGeoLoc - LoRaWAN/TargetPer - LoRaWAN/MinGwDiversity + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateServiceProfile - iotwireless:TagResource - - iotwireless:ListTagsForResource + update: + - iotwireless:GetServiceProfile + - iotwireless:TagResource + - iotwireless:UntagResource read: - iotwireless:GetServiceProfile - iotwireless:ListTagsForResource @@ -768,18 +1263,35 @@ components: required: - AutoCreateTasks x-stackql-resource-name: task_definition - x-stackql-primaryIdentifier: + description: Creates a gateway task definition. + x-type-name: AWS::IoTWireless::TaskDefinition + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - Arn + x-required-properties: + - AutoCreateTasks + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateWirelessGatewayTaskDefinition - iotwireless:TagResource - - iotwireless:ListTagsForResource - iam:GetRole - iam:PassRole + update: + - iotwireless:GetWirelessGatewayTaskDefinition + - iotwireless:TagResource + - iotwireless:UntagResource read: - iotwireless:GetWirelessGatewayTaskDefinition - iotwireless:ListTagsForResource @@ -938,6 +1450,9 @@ components: type: string enum: - SemtechGeolocation + - SemtechGNSS + - SemtechGNSSNG + - SemtechWiFi additionalProperties: false WirelessDevice: type: object @@ -997,25 +1512,40 @@ components: - Type - DestinationName x-stackql-resource-name: wireless_device - x-stackql-primaryIdentifier: + description: Create and manage wireless gateways, including LoRa gateways. + x-type-name: AWS::IoTWireless::WirelessDevice + x-stackql-primary-identifier: - Id x-read-only-properties: - ThingName - Id - Arn + x-required-properties: + - Type + - DestinationName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateWirelessDevice - iotwireless:TagResource - - iotwireless:ListTagsForResource read: - iotwireless:GetWirelessDevice - iotwireless:ListTagsForResource update: - iotwireless:UpdateWirelessDevice - - iotwireless:UntagResource - - iotwireless:ListTagsForResource + - iotwireless:GetWirelessDevice - iotwireless:AssociateWirelessDeviceWithThing + - iotwireless:TagResource + - iotwireless:UntagResource delete: - iotwireless:DeleteWirelessDevice - iotwireless:DisassociateWirelessDeviceFromThing @@ -1066,14 +1596,6 @@ components: $ref: '#/components/schemas/DeviceCreationFileList' Role: $ref: '#/components/schemas/Role' - oneOf: - - allOf: - - required: - - DeviceCreationFile - - required: - - Role - - required: - - SidewalkManufacturingSn Status: description: Status for import task type: string @@ -1110,8 +1632,13 @@ components: - DestinationName - Sidewalk x-stackql-resource-name: wireless_device_import_task - x-stackql-primaryIdentifier: + description: Wireless Device Import Tasks + x-type-name: AWS::IoTWireless::WirelessDeviceImportTask + x-stackql-primary-identifier: - Id + x-write-only-properties: + - Sidewalk/DeviceCreationFile + - Sidewalk/SidewalkManufacturingSn x-read-only-properties: - Id - Arn @@ -1123,20 +1650,33 @@ components: - OnboardedImportedDevicesCount - FailedImportedDevicesCount - Sidewalk/DeviceCreationFileList + x-required-properties: + - DestinationName + - Sidewalk + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:StartWirelessDeviceImportTask - iotwireless:StartSingleWirelessDeviceImportTask - iotwireless:TagResource - - iotwireless:ListTagsForResource - iam:PassRole read: - iotwireless:GetWirelessDeviceImportTask - iotwireless:ListTagsForResource update: + - iotwireless:GetWirelessDeviceImportTask - iotwireless:UpdateWirelessDeviceImportTask + - iotwireless:TagResource - iotwireless:UntagResource - - iotwireless:ListTagsForResource - iam:PassRole delete: - iotwireless:DeleteWirelessDeviceImportTask @@ -1197,88 +1737,751 @@ components: required: - LoRaWAN x-stackql-resource-name: wireless_gateway - x-stackql-primaryIdentifier: + description: Create and manage wireless gateways, including LoRa gateways. + x-type-name: AWS::IoTWireless::WirelessGateway + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - Arn + x-required-properties: + - LoRaWAN + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - iotwireless:TagResource + - iotwireless:UntagResource + - iotwireless:ListTagsForResource x-required-permissions: create: - iotwireless:CreateWirelessGateway - iotwireless:TagResource - - iotwireless:ListTagsForResource read: - iotwireless:GetWirelessGateway - iotwireless:ListTagsForResource update: + - iotwireless:GetWirelessGateway - iotwireless:UpdateWirelessGateway - - iotwireless:UntagResource - - iotwireless:ListTagsForResource - iotwireless:AssociateWirelessGatewayWithThing + - iotwireless:TagResource + - iotwireless:UntagResource delete: - iotwireless:DeleteWirelessGateway - iotwireless:DisassociateWirelessGatewayFromThing list: - iotwireless:ListWirelessGateways - iotwireless:ListTagsForResource - x-stackQL-resources: - destinations: - name: destinations - id: awscc.iotwireless.destinations - x-cfn-schema-name: Destination - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' - AND region = 'us-east-1' - destination: - name: destination - id: awscc.iotwireless.destination - x-cfn-schema-name: Destination - x-type: get - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Expression') as expression, - JSON_EXTRACT(Properties, '$.ExpressionType') as expression_type, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::Destination' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, + CreateDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Unique name of destination + type: string + pattern: '[a-zA-Z0-9:_-]+' + maxLength: 128 + Expression: + description: Destination expression + type: string + ExpressionType: + description: Must be RuleName + type: string + enum: + - RuleName + - MqttTopic + - SnsTopic + Description: + description: Destination description + type: string + maxLength: 2048 + Tags: + description: A list of key-value pairs that contain metadata for the destination. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + RoleArn: + description: AWS role ARN that grants access + type: string + minLength: 20 + maxLength: 2048 + Arn: + description: Destination arn. Returned after successful create. + type: string + x-stackQL-stringOnly: true + x-title: CreateDestinationRequest + type: object + required: [] + CreateDeviceProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of service profile + type: string + maxLength: 256 + LoRaWAN: + description: LoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation + $ref: '#/components/schemas/LoRaWANDeviceProfile' + Tags: + description: A list of key-value pairs that contain metadata for the device profile. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: Service profile Arn. Returned after successful create. + type: string + Id: + description: Service profile Id. Returned after successful create. + type: string + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateDeviceProfileRequest + type: object + required: [] + CreateFuotaTaskRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of FUOTA task + type: string + maxLength: 256 + Description: + description: FUOTA task description + type: string + maxLength: 2048 + LoRaWAN: + description: FUOTA task LoRaWAN + $ref: '#/components/schemas/LoRaWAN' + FirmwareUpdateImage: + description: FUOTA task firmware update image binary S3 link + type: string + minLength: 1 + maxLength: 2048 + FirmwareUpdateRole: + description: FUOTA task firmware IAM role for reading S3 + type: string + minLength: 1 + maxLength: 256 + Arn: + description: FUOTA task arn. Returned after successful create. + type: string + Id: + description: FUOTA task id. Returned after successful create. + type: string + maxLength: 256 + Tags: + description: A list of key-value pairs that contain metadata for the FUOTA task. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + FuotaTaskStatus: + description: FUOTA task status. Returned after successful read. + type: string + AssociateWirelessDevice: + description: Wireless device to associate. Only for update request. + type: string + maxLength: 256 + DisassociateWirelessDevice: + description: Wireless device to disassociate. Only for update request. + type: string + maxLength: 256 + AssociateMulticastGroup: + description: Multicast group to associate. Only for update request. + type: string + maxLength: 256 + DisassociateMulticastGroup: + description: Multicast group to disassociate. Only for update request. + type: string + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateFuotaTaskRequest + type: object + required: [] + CreateMulticastGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of Multicast group + type: string + maxLength: 256 + Description: + description: Multicast group description + type: string + maxLength: 2048 + LoRaWAN: + description: Multicast group LoRaWAN + $ref: '#/components/schemas/LoRaWAN' + Arn: + description: Multicast group arn. Returned after successful create. + type: string + Id: + description: Multicast group id. Returned after successful create. + type: string + maxLength: 256 + Tags: + description: A list of key-value pairs that contain metadata for the Multicast group. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Status: + description: Multicast group status. Returned after successful read. + type: string + AssociateWirelessDevice: + description: Wireless device to associate. Only for update request. + type: string + maxLength: 256 + DisassociateWirelessDevice: + description: Wireless device to disassociate. Only for update request. + type: string + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateMulticastGroupRequest + type: object + required: [] + CreateNetworkAnalyzerConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the network analyzer configuration + type: string + pattern: ^[a-zA-Z0-9-_]+$ + maxLength: 1024 + Description: + description: The description of the new resource + type: string + maxLength: 2048 + TraceContent: + description: Trace content for your wireless gateway and wireless device resources + type: object + additionalProperties: false + properties: + WirelessDeviceFrameInfo: + $ref: '#/components/schemas/WirelessDeviceFrameInfo' + LogLevel: + $ref: '#/components/schemas/LogLevel' + WirelessDevices: + description: List of wireless gateway resources that have been added to the network analyzer configuration + type: array + x-insertionOrder: false + items: + type: string + maxItems: 250 + WirelessGateways: + description: List of wireless gateway resources that have been added to the network analyzer configuration + type: array + x-insertionOrder: false + items: + type: string + maxItems: 250 + Arn: + description: Arn for network analyzer configuration, Returned upon successful create. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateNetworkAnalyzerConfigurationRequest + type: object + required: [] + CreatePartnerAccountRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Sidewalk: + description: The Sidewalk account credentials. + $ref: '#/components/schemas/SidewalkAccountInfo' + PartnerAccountId: + description: The partner account ID to disassociate from the AWS account + type: string + maxLength: 256 + PartnerType: + description: The partner type + type: string + enum: + - Sidewalk + SidewalkResponse: + description: The Sidewalk account credentials. + $ref: '#/components/schemas/SidewalkAccountInfoWithFingerprint' + AccountLinked: + description: Whether the partner account is linked to the AWS account. + type: boolean + SidewalkUpdate: + description: The Sidewalk account credentials. + $ref: '#/components/schemas/SidewalkUpdateAccount' + Fingerprint: + description: The fingerprint of the Sidewalk application server private key. + type: string + Arn: + description: PartnerAccount arn. Returned after successful create. + type: string + Tags: + description: A list of key-value pairs that contain metadata for the destination. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePartnerAccountRequest + type: object + required: [] + CreateServiceProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of service profile + type: string + maxLength: 256 + LoRaWAN: + description: LoRaWAN supports all LoRa specific attributes for service profile for CreateServiceProfile operation + $ref: '#/components/schemas/LoRaWANServiceProfile' + Tags: + description: A list of key-value pairs that contain metadata for the service profile. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: Service profile Arn. Returned after successful create. + type: string + Id: + description: Service profile Id. Returned after successful create. + type: string + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateServiceProfileRequest + type: object + required: [] + CreateTaskDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the new resource. + type: string + minLength: 1 + maxLength: 256 + AutoCreateTasks: + description: Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask. + type: boolean + Update: + description: Information about the gateways to update. + $ref: '#/components/schemas/UpdateWirelessGatewayTaskCreate' + LoRaWANUpdateGatewayTaskEntry: + description: The list of task definitions. + $ref: '#/components/schemas/LoRaWANUpdateGatewayTaskEntry' + Id: + description: The ID of the new wireless gateway task definition + type: string + pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' + TaskDefinitionType: + description: A filter to list only the wireless gateway task definitions that use this task definition type + type: string + enum: + - UPDATE + Arn: + description: TaskDefinition arn. Returned after successful create. + type: string + Tags: + description: A list of key-value pairs that contain metadata for the destination. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTaskDefinitionRequest + type: object + required: [] + CreateWirelessDeviceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Type: + description: Wireless device type, currently only Sidewalk and LoRa + type: string + enum: + - Sidewalk + - LoRaWAN + Name: + description: Wireless device name + type: string + maxLength: 256 + Description: + description: Wireless device description + type: string + maxLength: 2048 + DestinationName: + description: Wireless device destination name + type: string + maxLength: 128 + LoRaWAN: + description: The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device. + $ref: '#/components/schemas/LoRaWANDevice' + Tags: + description: A list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: Wireless device arn. Returned after successful create. + type: string + Id: + description: Wireless device Id. Returned after successful create. + type: string + maxLength: 256 + ThingArn: + description: Thing arn. Passed into update to associate Thing with Wireless device. + type: string + ThingName: + description: Thing Arn. If there is a Thing created, this can be returned with a Get call. + type: string + LastUplinkReceivedAt: + description: The date and time when the most recent uplink was received. + type: string + Positioning: + description: FPort values for the GNSS, stream, and ClockSync functions of the positioning information. + type: string + enum: + - Enabled + - Disabled + x-stackQL-stringOnly: true + x-title: CreateWirelessDeviceRequest + type: object + required: [] + CreateWirelessDeviceImportTaskRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Id for Wireless Device Import Task, Returned upon successful start. + type: string + maxLength: 256 + Arn: + description: Arn for Wireless Device Import Task, Returned upon successful start. + type: string + maxLength: 128 + DestinationName: + description: Destination Name for import task + type: string + pattern: '[a-zA-Z0-9-_]+' + maxLength: 128 + CreationDate: + description: CreationDate for import task + type: string + Sidewalk: + description: sidewalk contain file for created device and role + type: object + additionalProperties: false + properties: + SidewalkManufacturingSn: + type: string + maxLength: 64 + DeviceCreationFile: + type: string + maxLength: 1024 + DeviceCreationFileList: + $ref: '#/components/schemas/DeviceCreationFileList' + Role: + $ref: '#/components/schemas/Role' + Status: + description: Status for import task + type: string + enum: + - INITIALIZING + - INITIALIZED + - PENDING + - COMPLETE + - FAILED + - DELETING + StatusReason: + description: StatusReason for import task + type: string + InitializedImportedDevicesCount: + description: Initialized Imported Devices Count + type: integer + PendingImportedDevicesCount: + description: Pending Imported Devices Count + type: integer + OnboardedImportedDevicesCount: + description: Onboarded Imported Devices Count + type: integer + FailedImportedDevicesCount: + description: Failed Imported Devices Count + type: integer + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateWirelessDeviceImportTaskRequest + type: object + required: [] + CreateWirelessGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of Wireless Gateway. + type: string + maxLength: 256 + Description: + description: Description of Wireless Gateway. + type: string + maxLength: 2048 + Tags: + description: A list of key-value pairs that contain metadata for the gateway. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + LoRaWAN: + description: The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway. + $ref: '#/components/schemas/LoRaWANGateway' + Arn: + description: Arn for Wireless Gateway. Returned upon successful create. + type: string + Id: + description: Id for Wireless Gateway. Returned upon successful create. + type: string + maxLength: 256 + ThingArn: + description: Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway. + type: string + ThingName: + description: Thing Name. If there is a Thing created, this can be returned with a Get call. + type: string + LastUplinkReceivedAt: + description: The date and time when the most recent uplink was received. + type: string + x-stackQL-stringOnly: true + x-title: CreateWirelessGatewayRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + destinations: + name: destinations + id: awscc.iotwireless.destinations + x-cfn-schema-name: Destination + x-cfn-type-name: AWS::IoTWireless::Destination + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Destination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::Destination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::Destination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::Destination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/destinations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Expression') as expression, + JSON_EXTRACT(Properties, '$.ExpressionType') as expression_type, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::Destination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Expression') as expression, json_extract_path_text(Properties, 'ExpressionType') as expression_type, json_extract_path_text(Properties, 'Description') as description, @@ -1288,13 +2491,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::Destination' AND data__Identifier = '' AND region = 'us-east-1' - device_profiles: - name: device_profiles - id: awscc.iotwireless.device_profiles - x-cfn-schema-name: DeviceProfile - x-type: list + destinations_list_only: + name: destinations_list_only + id: awscc.iotwireless.destinations_list_only + x-cfn-schema-name: Destination + x-cfn-type-name: AWS::IoTWireless::Destination x-identifiers: - - Id + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1302,28 +2511,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' AND region = 'us-east-1' - device_profile: - name: device_profile - id: awscc.iotwireless.device_profile + device_profiles: + name: device_profiles + id: awscc.iotwireless.device_profiles x-cfn-schema-name: DeviceProfile - x-type: get + x-cfn-type-name: AWS::IoTWireless::DeviceProfile x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeviceProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::DeviceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::DeviceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::DeviceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/device_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/device_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/device_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1337,7 +2594,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1350,13 +2607,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' AND data__Identifier = '' AND region = 'us-east-1' - fuota_tasks: - name: fuota_tasks - id: awscc.iotwireless.fuota_tasks - x-cfn-schema-name: FuotaTask - x-type: list + device_profiles_list_only: + name: device_profiles_list_only + id: awscc.iotwireless.device_profiles_list_only + x-cfn-schema-name: DeviceProfile + x-cfn-type-name: AWS::IoTWireless::DeviceProfile x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1365,7 +2628,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1373,19 +2636,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' AND region = 'us-east-1' - fuota_task: - name: fuota_task - id: awscc.iotwireless.fuota_task + fuota_tasks: + name: fuota_tasks + id: awscc.iotwireless.fuota_tasks x-cfn-schema-name: FuotaTask - x-type: get + x-cfn-type-name: AWS::IoTWireless::FuotaTask x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FuotaTask&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::FuotaTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::FuotaTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::FuotaTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1407,7 +2718,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1428,13 +2739,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' AND data__Identifier = '' AND region = 'us-east-1' - multicast_groups: - name: multicast_groups - id: awscc.iotwireless.multicast_groups - x-cfn-schema-name: MulticastGroup - x-type: list + fuota_tasks_list_only: + name: fuota_tasks_list_only + id: awscc.iotwireless.fuota_tasks_list_only + x-cfn-schema-name: FuotaTask + x-cfn-type-name: AWS::IoTWireless::FuotaTask x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1443,7 +2760,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1451,19 +2768,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' AND region = 'us-east-1' - multicast_group: - name: multicast_group - id: awscc.iotwireless.multicast_group + multicast_groups: + name: multicast_groups + id: awscc.iotwireless.multicast_groups x-cfn-schema-name: MulticastGroup - x-type: get + x-cfn-type-name: AWS::IoTWireless::MulticastGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MulticastGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::MulticastGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::MulticastGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::MulticastGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1481,7 +2846,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1498,13 +2863,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' AND data__Identifier = '' AND region = 'us-east-1' - network_analyzer_configurations: - name: network_analyzer_configurations - id: awscc.iotwireless.network_analyzer_configurations - x-cfn-schema-name: NetworkAnalyzerConfiguration - x-type: list + multicast_groups_list_only: + name: multicast_groups_list_only + id: awscc.iotwireless.multicast_groups_list_only + x-cfn-schema-name: MulticastGroup + x-cfn-type-name: AWS::IoTWireless::MulticastGroup x-identifiers: - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1512,28 +2883,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' AND region = 'us-east-1' - network_analyzer_configuration: - name: network_analyzer_configuration - id: awscc.iotwireless.network_analyzer_configuration + network_analyzer_configurations: + name: network_analyzer_configurations + id: awscc.iotwireless.network_analyzer_configurations x-cfn-schema-name: NetworkAnalyzerConfiguration - x-type: get + x-cfn-type-name: AWS::IoTWireless::NetworkAnalyzerConfiguration x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkAnalyzerConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::NetworkAnalyzerConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::NetworkAnalyzerConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::NetworkAnalyzerConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1549,7 +2968,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1564,13 +2983,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - partner_accounts: - name: partner_accounts - id: awscc.iotwireless.partner_accounts - x-cfn-schema-name: PartnerAccount - x-type: list + network_analyzer_configurations_list_only: + name: network_analyzer_configurations_list_only + id: awscc.iotwireless.network_analyzer_configurations_list_only + x-cfn-schema-name: NetworkAnalyzerConfiguration + x-cfn-type-name: AWS::IoTWireless::NetworkAnalyzerConfiguration x-identifiers: - - PartnerAccountId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1578,28 +3003,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PartnerAccountId') as partner_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PartnerAccountId') as partner_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' AND region = 'us-east-1' - partner_account: - name: partner_account - id: awscc.iotwireless.partner_account + partner_accounts: + name: partner_accounts + id: awscc.iotwireless.partner_accounts x-cfn-schema-name: PartnerAccount - x-type: get + x-cfn-type-name: AWS::IoTWireless::PartnerAccount x-identifiers: - PartnerAccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PartnerAccount&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::PartnerAccount" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::PartnerAccount" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::PartnerAccount" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1617,7 +3090,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1634,13 +3107,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' AND data__Identifier = '' AND region = 'us-east-1' - service_profiles: - name: service_profiles - id: awscc.iotwireless.service_profiles - x-cfn-schema-name: ServiceProfile - x-type: list + partner_accounts_list_only: + name: partner_accounts_list_only + id: awscc.iotwireless.partner_accounts_list_only + x-cfn-schema-name: PartnerAccount + x-cfn-type-name: AWS::IoTWireless::PartnerAccount x-identifiers: - - Id + - PartnerAccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1648,28 +3127,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' + JSON_EXTRACT(Properties, '$.PartnerAccountId') as partner_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' + json_extract_path_text(Properties, 'PartnerAccountId') as partner_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' AND region = 'us-east-1' - service_profile: - name: service_profile - id: awscc.iotwireless.service_profile + service_profiles: + name: service_profiles + id: awscc.iotwireless.service_profiles x-cfn-schema-name: ServiceProfile - x-type: get + x-cfn-type-name: AWS::IoTWireless::ServiceProfile x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::ServiceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::ServiceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::ServiceProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1683,7 +3210,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1696,13 +3223,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' AND data__Identifier = '' AND region = 'us-east-1' - task_definitions: - name: task_definitions - id: awscc.iotwireless.task_definitions - x-cfn-schema-name: TaskDefinition - x-type: list + service_profiles_list_only: + name: service_profiles_list_only + id: awscc.iotwireless.service_profiles_list_only + x-cfn-schema-name: ServiceProfile + x-cfn-type-name: AWS::IoTWireless::ServiceProfile x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1711,7 +3244,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1719,19 +3252,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' AND region = 'us-east-1' - task_definition: - name: task_definition - id: awscc.iotwireless.task_definition + task_definitions: + name: task_definitions + id: awscc.iotwireless.task_definitions x-cfn-schema-name: TaskDefinition - x-type: get + x-cfn-type-name: AWS::IoTWireless::TaskDefinition x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TaskDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::TaskDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::TaskDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::TaskDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1748,7 +3329,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1764,13 +3345,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' AND data__Identifier = '' AND region = 'us-east-1' - wireless_devices: - name: wireless_devices - id: awscc.iotwireless.wireless_devices - x-cfn-schema-name: WirelessDevice - x-type: list + task_definitions_list_only: + name: task_definitions_list_only + id: awscc.iotwireless.task_definitions_list_only + x-cfn-schema-name: TaskDefinition + x-cfn-type-name: AWS::IoTWireless::TaskDefinition x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1779,7 +3366,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1787,19 +3374,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' AND region = 'us-east-1' - wireless_device: - name: wireless_device - id: awscc.iotwireless.wireless_device + wireless_devices: + name: wireless_devices + id: awscc.iotwireless.wireless_devices x-cfn-schema-name: WirelessDevice - x-type: get + x-cfn-type-name: AWS::IoTWireless::WirelessDevice x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WirelessDevice&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessDevice" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessDevice" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessDevice" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1820,7 +3455,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1840,13 +3475,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' AND data__Identifier = '' AND region = 'us-east-1' - wireless_device_import_tasks: - name: wireless_device_import_tasks - id: awscc.iotwireless.wireless_device_import_tasks - x-cfn-schema-name: WirelessDeviceImportTask - x-type: list + wireless_devices_list_only: + name: wireless_devices_list_only + id: awscc.iotwireless.wireless_devices_list_only + x-cfn-schema-name: WirelessDevice + x-cfn-type-name: AWS::IoTWireless::WirelessDevice x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1855,7 +3496,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1863,19 +3504,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' AND region = 'us-east-1' - wireless_device_import_task: - name: wireless_device_import_task - id: awscc.iotwireless.wireless_device_import_task + wireless_device_import_tasks: + name: wireless_device_import_tasks + id: awscc.iotwireless.wireless_device_import_tasks x-cfn-schema-name: WirelessDeviceImportTask - x-type: get + x-cfn-type-name: AWS::IoTWireless::WirelessDeviceImportTask x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WirelessDeviceImportTask&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessDeviceImportTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessDeviceImportTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessDeviceImportTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1896,7 +3585,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1916,13 +3605,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' AND data__Identifier = '' AND region = 'us-east-1' - wireless_gateways: - name: wireless_gateways - id: awscc.iotwireless.wireless_gateways - x-cfn-schema-name: WirelessGateway - x-type: list + wireless_device_import_tasks_list_only: + name: wireless_device_import_tasks_list_only + id: awscc.iotwireless.wireless_device_import_tasks_list_only + x-cfn-schema-name: WirelessDeviceImportTask + x-cfn-type-name: AWS::IoTWireless::WirelessDeviceImportTask x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1931,7 +3626,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1939,19 +3634,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' AND region = 'us-east-1' - wireless_gateway: - name: wireless_gateway - id: awscc.iotwireless.wireless_gateway + wireless_gateways: + name: wireless_gateways + id: awscc.iotwireless.wireless_gateways x-cfn-schema-name: WirelessGateway - x-type: get + x-cfn-type-name: AWS::IoTWireless::WirelessGateway x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WirelessGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoTWireless::WirelessGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1969,7 +3712,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1986,3 +3729,649 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' AND data__Identifier = '' AND region = 'us-east-1' + wireless_gateways_list_only: + name: wireless_gateways_list_only + id: awscc.iotwireless.wireless_gateways_list_only + x-cfn-schema-name: WirelessGateway + x-cfn-type-name: AWS::IoTWireless::WirelessGateway + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Destination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeviceProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeviceProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeviceProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FuotaTask&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFuotaTask + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFuotaTaskRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MulticastGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMulticastGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMulticastGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkAnalyzerConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkAnalyzerConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkAnalyzerConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PartnerAccount&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePartnerAccount + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePartnerAccountRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TaskDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTaskDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTaskDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WirelessDevice&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWirelessDevice + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWirelessDeviceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WirelessDeviceImportTask&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWirelessDeviceImportTask + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWirelessDeviceImportTaskRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WirelessGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWirelessGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWirelessGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ivs.yaml b/providers/src/awscc/v00.00.00000/services/ivs.yaml index 1beb137d..af44916c 100644 --- a/providers/src/awscc/v00.00.00000/services/ivs.yaml +++ b/providers/src/awscc/v00.00.00000/services/ivs.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IVS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -11,15 +391,38 @@ components: properties: Key: type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' minLength: 1 maxLength: 128 Value: type: string - minLength: 1 + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 maxLength: 256 required: - Value - Key + MultitrackInputConfiguration: + type: object + additionalProperties: false + properties: + Enabled: + description: 'Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.' + default: false + type: boolean + MaximumResolution: + description: Maximum resolution for multitrack input. Required if enabled is true. + type: string + enum: + - SD + - HD + - FULL_HD + Policy: + description: Indicates whether multitrack input is allowed or required. Required if enabled is true. + type: string + enum: + - ALLOW + - REQUIRE Channel: type: object properties: @@ -85,16 +488,39 @@ components: description: Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (""). type: string enum: + - '' - HIGHER_BANDWIDTH_DELIVERY - CONSTRAINED_BANDWIDTH_DELIVERY + MultitrackInputConfiguration: + $ref: '#/components/schemas/MultitrackInputConfiguration' + ContainerFormat: + description: 'Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.' + type: string + default: TS + enum: + - TS + - FRAGMENTED_MP4 required: [] x-stackql-resource-name: channel - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IVS::Channel + x-type-name: AWS::IVS::Channel + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn - PlaybackUrl - IngestEndpoint + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource x-required-permissions: create: - ivs:CreateChannel @@ -106,186 +532,163 @@ components: - ivs:GetChannel - ivs:UpdateChannel - ivs:TagResource - - ivs:UnTagResource + - ivs:UntagResource - ivs:ListTagsForResource delete: - ivs:DeleteChannel - - ivs:UnTagResource + - ivs:UntagResource list: - ivs:ListChannels - ivs:ListTagsForResource - PlaybackKeyPair: + EncoderConfiguration: type: object properties: - Name: - description: An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique. - type: string - pattern: ^[a-zA-Z0-9-_]*$ - minLength: 0 - maxLength: 128 - PublicKeyMaterial: - description: The public portion of a customer-generated key pair. - type: string - Fingerprint: - description: Key-pair identifier. - type: string Arn: - description: Key-pair identifier. + description: Encoder configuration identifier. type: string - pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$ + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$ minLength: 1 maxLength: 128 + Video: + description: 'Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps' + type: object + additionalProperties: false + properties: + Bitrate: + description: 'Bitrate for generated output, in bps. Default: 2500000.' + type: integer + minimum: 1 + maximum: 8500000 + default: 2500000 + Framerate: + description: 'Video frame rate, in fps. Default: 30.' + type: number + minimum: 1 + maximum: 60 + default: 30 + Height: + description: 'Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.' + type: integer + minimum: 2 + maximum: 1920 + default: 720 + Width: + description: 'Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.' + type: integer + minimum: 2 + maximum: 1920 + default: 1280 + Name: + description: Encoder configuration name. + type: string + maxLength: 128 + minLength: 0 + pattern: ^[a-zA-Z0-9-_]*$ Tags: - description: A list of key-value pairs that contain metadata for the asset model. + description: An array of key-value pairs to apply to this resource. type: array uniqueItems: true x-insertionOrder: false maxItems: 50 items: $ref: '#/components/schemas/Tag' - x-stackql-resource-name: playback_key_pair - x-stackql-primaryIdentifier: + required: [] + x-stackql-resource-name: encoder_configuration + description: Resource Type definition for AWS::IVS::EncoderConfiguration. + x-type-name: AWS::IVS::EncoderConfiguration + x-stackql-primary-identifier: - Arn x-create-only-properties: - - PublicKeyMaterial - Name + - Video + - Video/Bitrate + - Video/Framerate + - Video/Height + - Video/Width x-read-only-properties: - Arn - - Fingerprint + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource x-required-permissions: create: - - ivs:ImportPlaybackKeyPair + - ivs:CreateEncoderConfiguration - ivs:TagResource read: - - ivs:GetPlaybackKeyPair + - ivs:GetEncoderConfiguration + - ivs:ListTagsForResource update: - - ivs:GetPlaybackKeyPair + - ivs:GetEncoderConfiguration - ivs:ListTagsForResource - ivs:UntagResource - ivs:TagResource delete: - - ivs:DeletePlaybackKeyPair + - ivs:DeleteEncoderConfiguration - ivs:UntagResource list: - - ivs:ListPlaybackKeyPairs + - ivs:ListEncoderConfigurations - ivs:ListTagsForResource - DestinationConfiguration: - description: Recording Destination Configuration. - type: object - additionalProperties: false - properties: - S3: - $ref: '#/components/schemas/S3DestinationConfiguration' - required: [] - S3DestinationConfiguration: - description: Recording S3 Destination Configuration. - type: object - additionalProperties: false - properties: - BucketName: - type: string - minLength: 3 - maxLength: 63 - pattern: ^[a-z0-9-.]+$ - required: - - BucketName - ThumbnailConfiguration: - description: Recording Thumbnail Configuration. - type: object - additionalProperties: false - properties: - RecordingMode: - description: Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled. - type: string - enum: - - INTERVAL - - DISABLED - default: INTERVAL - TargetIntervalSeconds: - description: Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL. - type: integer - minimum: 1 - maximum: 60 - default: 60 - Resolution: - description: Resolution indicates the desired resolution of recorded thumbnails. - type: string - enum: - - FULL_HD - - HD - - SD - - LOWEST_RESOLUTION - Storage: - description: Storage indicates the format in which thumbnails are recorded. - type: array - uniqueItems: true - x-insertionOrder: false - minItems: 0 - maxItems: 2 - items: - type: string - enum: - - SEQUENTIAL - - LATEST - required: [] - RenditionConfiguration: - description: Rendition Configuration describes which renditions should be recorded for a stream. - type: object - additionalProperties: false - properties: - RenditionSelection: - description: Resolution Selection indicates which set of renditions are recorded for a stream. - type: string - enum: - - ALL - - NONE - - CUSTOM - default: ALL - Renditions: - description: Renditions indicates which renditions are recorded for a stream. - type: array - uniqueItems: true - x-insertionOrder: false - minItems: 0 - maxItems: 4 - items: - type: string - enum: - - FULL_HD - - HD - - SD - - LOWEST_RESOLUTION - required: [] - RecordingConfiguration: + IngestConfiguration: type: object properties: Arn: - description: Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier. + description: IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier. type: string - pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$ - minLength: 0 + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+$ + minLength: 1 maxLength: 128 Name: - description: Recording Configuration Name. + description: IngestConfiguration type: string minLength: 0 maxLength: 128 pattern: ^[a-zA-Z0-9-_]*$ + default: '-' + StageArn: + description: 'Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).' + type: string + default: '' + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + ParticipantId: + description: Participant Id is automatically generated on creation and assigned. + type: string + minLength: 0 + maxLength: 64 + pattern: ^[a-zA-Z0-9-_]*$ + IngestProtocol: + description: Ingest Protocol. + type: string + enum: + - RTMP + - RTMPS + default: RTMPS + InsecureIngest: + description: Whether ingest configuration allows insecure ingest. + type: boolean + default: false State: - description: Recording Configuration State. + description: State of IngestConfiguration which determines whether IngestConfiguration is in use or not. type: string enum: - - CREATING - - CREATE_FAILED - ACTIVE - RecordingReconnectWindowSeconds: - description: Recording Reconnect Window Seconds. (0 means disabled) - type: integer - default: 0 - minimum: 0 - maximum: 300 - DestinationConfiguration: - $ref: '#/components/schemas/DestinationConfiguration' + - INACTIVE + default: INACTIVE + StreamKey: + description: Stream-key value. + type: string + UserId: + description: User defined indentifier for participant associated with IngestConfiguration. + type: string Tags: description: A list of key-value pairs that contain metadata for the asset model. type: array @@ -294,119 +697,680 @@ components: maxItems: 50 items: $ref: '#/components/schemas/Tag' - ThumbnailConfiguration: - $ref: '#/components/schemas/ThumbnailConfiguration' - RenditionConfiguration: - $ref: '#/components/schemas/RenditionConfiguration' - required: - - DestinationConfiguration - x-stackql-resource-name: recording_configuration - x-stackql-primaryIdentifier: + required: [] + x-stackql-resource-name: ingest_configuration + description: Resource Type definition for AWS::IVS::IngestConfiguration + x-type-name: AWS::IVS::IngestConfiguration + x-stackql-primary-identifier: - Arn x-create-only-properties: + - InsecureIngest + - UserId - Name - - DestinationConfiguration - - DestinationConfiguration/S3 - - DestinationConfiguration/S3/BucketName - - RecordingReconnectWindowSeconds - - ThumbnailConfiguration - - ThumbnailConfiguration/RecordingMode - - ThumbnailConfiguration/TargetIntervalSeconds - - ThumbnailConfiguration/Storage - - ThumbnailConfiguration/Resolution - - RenditionConfiguration - - RenditionConfiguration/RenditionSelection - - RenditionConfiguration/Renditions + - IngestProtocol + x-write-only-properties: + - InsecureIngest x-read-only-properties: - Arn + - ParticipantId + - StreamKey - State + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource x-required-permissions: create: - - ivs:CreateRecordingConfiguration - - ivs:GetRecordingConfiguration + - ivs:CreateIngestConfiguration - ivs:TagResource - - iam:CreateServiceLinkedRole - - iam:PutRolePolicy - - iam:AttachRolePolicy - - s3:ListBucket - - s3:GetBucketLocation - - cloudformation:ListExports read: - - ivs:GetRecordingConfiguration - - s3:GetBucketLocation + - ivs:GetIngestConfiguration - ivs:ListTagsForResource update: - - ivs:GetRecordingConfiguration - - sts:AssumeRole - - iam:CreateServiceLinkedRole - - iam:PutRolePolicy - - iam:AttachRolePolicy - - s3:ListBucket + - ivs:GetIngestConfiguration + - ivs:UpdateIngestConfiguration - ivs:TagResource - ivs:UntagResource - ivs:ListTagsForResource delete: - - ivs:DeleteRecordingConfiguration + - ivs:DeleteIngestConfiguration - ivs:UntagResource - - iam:CreateServiceLinkedRole list: - - ivs:ListRecordingConfigurations - - s3:GetBucketLocation + - ivs:ListIngestConfigurations - ivs:ListTagsForResource - Stage: + PlaybackKeyPair: + type: object + properties: + Name: + description: An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique. + type: string + pattern: ^[a-zA-Z0-9-_]*$ + minLength: 0 + maxLength: 128 + PublicKeyMaterial: + description: The public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PlaybackKeyPair resource. + type: string + Fingerprint: + description: Key-pair identifier. + type: string + Arn: + description: Key-pair identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: playback_key_pair + description: Resource Type definition for AWS::IVS::PlaybackKeyPair + x-type-name: AWS::IVS::PlaybackKeyPair + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - PublicKeyMaterial + - Name + x-write-only-properties: + - PublicKeyMaterial + x-read-only-properties: + - Arn + - Fingerprint + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + x-required-permissions: + create: + - ivs:ImportPlaybackKeyPair + - ivs:TagResource + read: + - ivs:GetPlaybackKeyPair + update: + - ivs:GetPlaybackKeyPair + - ivs:ListTagsForResource + - ivs:UntagResource + - ivs:TagResource + delete: + - ivs:DeletePlaybackKeyPair + - ivs:UntagResource + list: + - ivs:ListPlaybackKeyPairs + - ivs:ListTagsForResource + PlaybackRestrictionPolicy: + type: object + properties: + Arn: + description: Playback-restriction-policy identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + AllowedCountries: + description: 'A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).' + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + default: [] + AllowedOrigins: + description: A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin + type: array + x-insertionOrder: false + items: + type: string + default: [] + EnableStrictOriginEnforcement: + description: Whether channel playback is constrained by origin site. + default: false + type: boolean + Name: + description: Playback-restriction-policy name. + type: string + maxLength: 128 + minLength: 0 + pattern: ^[a-zA-Z0-9-_]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: playback_restriction_policy + description: Resource Type definition for AWS::IVS::PlaybackRestrictionPolicy. + x-type-name: AWS::IVS::PlaybackRestrictionPolicy + x-stackql-primary-identifier: + - Arn + x-read-only-properties: + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + x-required-permissions: + create: + - ivs:CreatePlaybackRestrictionPolicy + - ivs:TagResource + read: + - ivs:GetPlaybackRestrictionPolicy + - ivs:ListTagsForResource + update: + - ivs:GetPlaybackRestrictionPolicy + - ivs:UpdatePlaybackRestrictionPolicy + - ivs:ListTagsForResource + - ivs:UntagResource + - ivs:TagResource + delete: + - ivs:DeletePlaybackRestrictionPolicy + - ivs:UntagResource + list: + - ivs:ListPlaybackRestrictionPolicies + - ivs:ListTagsForResource + PublicKey: + type: object + properties: + Name: + description: Name of the public key to be imported. The value does not need to be unique. + type: string + pattern: ^[a-zA-Z0-9-_]*$ + minLength: 0 + maxLength: 128 + PublicKeyMaterial: + description: The public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PublicKey resource. + type: string + pattern: '-----BEGIN PUBLIC KEY-----\r?\n([a-zA-Z0-9+/=\r\n]+)\r?\n-----END PUBLIC KEY-----(\r?\n)?' + Fingerprint: + description: Key-pair identifier. + type: string + Arn: + description: Key-pair identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: public_key + description: Resource Type definition for AWS::IVS::PublicKey + x-type-name: AWS::IVS::PublicKey + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - PublicKeyMaterial + - Name + x-read-only-properties: + - Arn + - Fingerprint + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + x-required-permissions: + create: + - ivs:ImportPublicKey + - ivs:TagResource + read: + - ivs:GetPublicKey + update: + - ivs:GetPublicKey + - ivs:ListTagsForResource + - ivs:UntagResource + - ivs:TagResource + delete: + - ivs:DeletePublicKey + - ivs:UntagResource + list: + - ivs:ListPublicKeys + - ivs:ListTagsForResource + DestinationConfiguration: + description: Recording Destination Configuration. + type: object + additionalProperties: false + properties: + S3: + $ref: '#/components/schemas/S3DestinationConfiguration' + required: [] + S3DestinationConfiguration: + description: Recording S3 Destination Configuration. + type: object + additionalProperties: false + properties: + BucketName: + type: string + minLength: 3 + maxLength: 63 + pattern: ^[a-z0-9-.]+$ + required: + - BucketName + ThumbnailConfiguration: + description: A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session. + type: object + additionalProperties: false + properties: + ParticipantThumbnailConfiguration: + description: An object representing a configuration of thumbnails for recorded video from an individual participant. + type: object + additionalProperties: false + properties: + RecordingMode: + description: 'Thumbnail recording mode. Default: DISABLED.' + type: string + enum: + - INTERVAL + - DISABLED + default: DISABLED + Storage: + description: 'Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.' + type: array + minItems: 0 + maxItems: 2 + uniqueItems: true + x-insertionOrder: false + items: + type: string + enum: + - SEQUENTIAL + - LATEST + default: + - SEQUENTIAL + TargetIntervalSeconds: + description: 'The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.' + type: integer + minimum: 1 + maximum: 86400 + default: 60 + required: [] + RenditionConfiguration: + description: Rendition Configuration describes which renditions should be recorded for a stream. + type: object + additionalProperties: false + properties: + RenditionSelection: + description: Resolution Selection indicates which set of renditions are recorded for a stream. + type: string + enum: + - ALL + - NONE + - CUSTOM + default: ALL + Renditions: + description: Renditions indicates which renditions are recorded for a stream. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 4 + items: + type: string + enum: + - FULL_HD + - HD + - SD + - LOWEST_RESOLUTION + required: [] + RecordingConfiguration: + type: object + properties: + Arn: + description: Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + Name: + description: Recording Configuration Name. + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + State: + description: Recording Configuration State. + type: string + enum: + - CREATING + - CREATE_FAILED + - ACTIVE + RecordingReconnectWindowSeconds: + description: Recording Reconnect Window Seconds. (0 means disabled) + type: integer + default: 0 + minimum: 0 + maximum: 300 + DestinationConfiguration: + $ref: '#/components/schemas/DestinationConfiguration' + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + ThumbnailConfiguration: + $ref: '#/components/schemas/ThumbnailConfiguration' + RenditionConfiguration: + $ref: '#/components/schemas/RenditionConfiguration' + required: + - DestinationConfiguration + x-stackql-resource-name: recording_configuration + description: Resource Type definition for AWS::IVS::RecordingConfiguration + x-type-name: AWS::IVS::RecordingConfiguration + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - DestinationConfiguration + - DestinationConfiguration/S3 + - DestinationConfiguration/S3/BucketName + - RecordingReconnectWindowSeconds + - ThumbnailConfiguration + - ThumbnailConfiguration/RecordingMode + - ThumbnailConfiguration/TargetIntervalSeconds + - ThumbnailConfiguration/Storage + - ThumbnailConfiguration/Resolution + - RenditionConfiguration + - RenditionConfiguration/RenditionSelection + - RenditionConfiguration/Renditions + x-read-only-properties: + - Arn + - State + x-required-properties: + - DestinationConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + x-required-permissions: + create: + - ivs:CreateRecordingConfiguration + - ivs:GetRecordingConfiguration + - ivs:TagResource + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + - iam:AttachRolePolicy + - s3:ListBucket + - s3:GetBucketLocation + - cloudformation:ListExports + read: + - ivs:GetRecordingConfiguration + - s3:GetBucketLocation + - ivs:ListTagsForResource + update: + - ivs:GetRecordingConfiguration + - sts:AssumeRole + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + - iam:AttachRolePolicy + - s3:ListBucket + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + delete: + - ivs:DeleteRecordingConfiguration + - ivs:UntagResource + - iam:CreateServiceLinkedRole + list: + - ivs:ListRecordingConfigurations + - s3:GetBucketLocation + - ivs:ListTagsForResource + ParticipantRecordingHlsConfiguration: + description: An object representing a configuration of participant HLS recordings for individual participant recording. + type: object + additionalProperties: false + properties: + TargetSegmentDurationSeconds: + description: 'Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.' + type: integer + minimum: 2 + maximum: 10 + default: 6 + HlsConfiguration: + description: HLS configuration object for individual participant recording. + type: object + additionalProperties: false + properties: + ParticipantRecordingHlsConfiguration: + $ref: '#/components/schemas/ParticipantRecordingHlsConfiguration' + required: [] + AutoParticipantRecordingConfiguration: + description: Configuration object for individual participant recording, to attach to the new stage. + type: object + additionalProperties: false + properties: + StorageConfigurationArn: + description: ARN of the StorageConfiguration resource to use for individual participant recording. + type: string + pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + MediaTypes: + description: 'Types of media to be recorded. Default: AUDIO_VIDEO.' + type: array + minItems: 0 + maxItems: 1 + uniqueItems: true + x-insertionOrder: false + items: + type: string + enum: + - AUDIO_VIDEO + - AUDIO_ONLY + default: + - AUDIO_VIDEO + HlsConfiguration: + $ref: '#/components/schemas/HlsConfiguration' + RecordingReconnectWindowSeconds: + description: If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging. + type: integer + minimum: 0 + maximum: 300 + default: 0 + ThumbnailConfiguration: + $ref: '#/components/schemas/ThumbnailConfiguration' + required: + - StorageConfigurationArn + Stage: + type: object + properties: + Arn: + description: Stage ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + Name: + description: Stage name + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + AutoParticipantRecordingConfiguration: + $ref: '#/components/schemas/AutoParticipantRecordingConfiguration' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + ActiveSessionId: + description: ID of the active session within the stage. + type: string + minLength: 0 + maxLength: 128 + x-stackql-resource-name: stage + description: Resource Type definition for AWS::IVS::Stage. + x-type-name: AWS::IVS::Stage + x-stackql-primary-identifier: + - Arn + x-read-only-properties: + - Arn + - ActiveSessionId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + x-required-permissions: + create: + - ivs:CreateStage + - ivs:GetStage + - ivs:TagResource + - ivs:ListTagsForResource + read: + - ivs:GetStage + - ivs:ListTagsForResource + update: + - ivs:GetStage + - ivs:UpdateStage + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource + delete: + - ivs:DeleteStage + - ivs:UntagResource + list: + - ivs:ListStages + - ivs:ListTagsForResource + S3StorageConfiguration: + description: A complex type that describes an S3 location where recorded videos will be stored. + type: object + additionalProperties: false + properties: + BucketName: + description: Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition. + type: string + minLength: 3 + maxLength: 63 + pattern: ^[a-z0-9-.]+$ + required: + - BucketName + StorageConfiguration: type: object properties: Arn: - description: Stage ARN is automatically generated on creation and assigned as the unique identifier. + description: Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier. type: string - pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$ + pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$ minLength: 0 maxLength: 128 Name: - description: Stage name + description: Storage Configuration Name. type: string minLength: 0 maxLength: 128 pattern: ^[a-zA-Z0-9-_]*$ + S3: + $ref: '#/components/schemas/S3StorageConfiguration' Tags: - description: An array of key-value pairs to apply to this resource. + description: A list of key-value pairs that contain metadata for the asset model. type: array uniqueItems: true x-insertionOrder: false + maxItems: 50 items: $ref: '#/components/schemas/Tag' - ActiveSessionId: - description: ID of the active session within the stage. - type: string - default: '' - minLength: 0 - maxLength: 128 - x-stackql-resource-name: stage - x-stackql-primaryIdentifier: + required: + - S3 + x-stackql-resource-name: storage_configuration + description: Resource Type definition for AWS::IVS::StorageConfiguration + x-type-name: AWS::IVS::StorageConfiguration + x-stackql-primary-identifier: - Arn + x-create-only-properties: + - Name + - S3 + - S3/BucketName x-read-only-properties: - Arn - - ActiveSessionId + x-required-properties: + - S3 + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource x-required-permissions: create: - - ivs:CreateStage - - ivs:GetStage + - ivs:CreateStorageConfiguration + - ivs:GetStorageConfiguration - ivs:TagResource - - ivs:ListTagsForResource + - s3:GetBucketLocation + - s3:GetBucketPolicy + - s3:PutBucketPolicy read: - - ivs:GetStage + - ivs:GetStorageConfiguration - ivs:ListTagsForResource + - s3:GetBucketLocation update: - - ivs:GetStage - - ivs:UpdateStage + - ivs:GetStorageConfiguration - ivs:TagResource - - ivs:UnTagResource + - ivs:UntagResource - ivs:ListTagsForResource delete: - - ivs:DeleteStage - - ivs:UnTagResource + - ivs:DeleteStorageConfiguration + - ivs:UntagResource + - s3:GetBucketPolicy + - s3:DeleteBucketPolicy + - s3:PutBucketPolicy list: - - ivs:ListStages + - ivs:ListStorageConfigurations + - s3:GetBucketLocation - ivs:ListTagsForResource StreamKey: type: object @@ -435,13 +1399,28 @@ components: required: - ChannelArn x-stackql-resource-name: stream_key - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::IVS::StreamKey + x-type-name: AWS::IVS::StreamKey + x-stackql-primary-identifier: - Arn x-create-only-properties: - ChannelArn x-read-only-properties: - Arn - Value + x-required-properties: + - ChannelArn + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivs:TagResource + - ivs:UntagResource + - ivs:ListTagsForResource x-required-permissions: create: - ivs:TagResource @@ -461,14 +1440,920 @@ components: list: - ivs:ListStreamKeys - ivs:ListTagsForResource + CreateChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Channel ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Name: + description: Channel + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + default: '-' + Authorized: + description: Whether the channel is authorized. + type: boolean + default: false + InsecureIngest: + description: Whether the channel allows insecure ingest. + type: boolean + default: false + LatencyMode: + description: Channel latency mode. + type: string + enum: + - NORMAL + - LOW + default: LOW + Type: + description: Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. + type: string + enum: + - STANDARD + - BASIC + - ADVANCED_SD + - ADVANCED_HD + default: STANDARD + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + PlaybackUrl: + description: Channel Playback URL. + type: string + IngestEndpoint: + description: Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software. + type: string + RecordingConfigurationArn: + description: 'Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).' + type: string + default: '' + pattern: ^$|arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + Preset: + description: Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (""). + type: string + enum: + - '' + - HIGHER_BANDWIDTH_DELIVERY + - CONSTRAINED_BANDWIDTH_DELIVERY + MultitrackInputConfiguration: + $ref: '#/components/schemas/MultitrackInputConfiguration' + ContainerFormat: + description: 'Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.' + type: string + default: TS + enum: + - TS + - FRAGMENTED_MP4 + x-stackQL-stringOnly: true + x-title: CreateChannelRequest + type: object + required: [] + CreateEncoderConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Encoder configuration identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Video: + description: 'Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps' + type: object + additionalProperties: false + properties: + Bitrate: + description: 'Bitrate for generated output, in bps. Default: 2500000.' + type: integer + minimum: 1 + maximum: 8500000 + default: 2500000 + Framerate: + description: 'Video frame rate, in fps. Default: 30.' + type: number + minimum: 1 + maximum: 60 + default: 30 + Height: + description: 'Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.' + type: integer + minimum: 2 + maximum: 1920 + default: 720 + Width: + description: 'Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.' + type: integer + minimum: 2 + maximum: 1920 + default: 1280 + Name: + description: Encoder configuration name. + type: string + maxLength: 128 + minLength: 0 + pattern: ^[a-zA-Z0-9-_]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEncoderConfigurationRequest + type: object + required: [] + CreateIngestConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Name: + description: IngestConfiguration + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + default: '-' + StageArn: + description: 'Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).' + type: string + default: '' + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + ParticipantId: + description: Participant Id is automatically generated on creation and assigned. + type: string + minLength: 0 + maxLength: 64 + pattern: ^[a-zA-Z0-9-_]*$ + IngestProtocol: + description: Ingest Protocol. + type: string + enum: + - RTMP + - RTMPS + default: RTMPS + InsecureIngest: + description: Whether ingest configuration allows insecure ingest. + type: boolean + default: false + State: + description: State of IngestConfiguration which determines whether IngestConfiguration is in use or not. + type: string + enum: + - ACTIVE + - INACTIVE + default: INACTIVE + StreamKey: + description: Stream-key value. + type: string + UserId: + description: User defined indentifier for participant associated with IngestConfiguration. + type: string + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateIngestConfigurationRequest + type: object + required: [] + CreatePlaybackKeyPairRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique. + type: string + pattern: ^[a-zA-Z0-9-_]*$ + minLength: 0 + maxLength: 128 + PublicKeyMaterial: + description: The public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PlaybackKeyPair resource. + type: string + Fingerprint: + description: Key-pair identifier. + type: string + Arn: + description: Key-pair identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePlaybackKeyPairRequest + type: object + required: [] + CreatePlaybackRestrictionPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Playback-restriction-policy identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + AllowedCountries: + description: 'A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).' + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + default: [] + AllowedOrigins: + description: A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin + type: array + x-insertionOrder: false + items: + type: string + default: [] + EnableStrictOriginEnforcement: + description: Whether channel playback is constrained by origin site. + default: false + type: boolean + Name: + description: Playback-restriction-policy name. + type: string + maxLength: 128 + minLength: 0 + pattern: ^[a-zA-Z0-9-_]*$ + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePlaybackRestrictionPolicyRequest + type: object + required: [] + CreatePublicKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the public key to be imported. The value does not need to be unique. + type: string + pattern: ^[a-zA-Z0-9-_]*$ + minLength: 0 + maxLength: 128 + PublicKeyMaterial: + description: The public portion of a customer-generated key pair. This field is required to create the AWS::IVS::PublicKey resource. + type: string + pattern: '-----BEGIN PUBLIC KEY-----\r?\n([a-zA-Z0-9+/=\r\n]+)\r?\n-----END PUBLIC KEY-----(\r?\n)?' + Fingerprint: + description: Key-pair identifier. + type: string + Arn: + description: Key-pair identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePublicKeyRequest + type: object + required: [] + CreateRecordingConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + Name: + description: Recording Configuration Name. + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + State: + description: Recording Configuration State. + type: string + enum: + - CREATING + - CREATE_FAILED + - ACTIVE + RecordingReconnectWindowSeconds: + description: Recording Reconnect Window Seconds. (0 means disabled) + type: integer + default: 0 + minimum: 0 + maximum: 300 + DestinationConfiguration: + $ref: '#/components/schemas/DestinationConfiguration' + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + ThumbnailConfiguration: + $ref: '#/components/schemas/ThumbnailConfiguration' + RenditionConfiguration: + $ref: '#/components/schemas/RenditionConfiguration' + x-stackQL-stringOnly: true + x-title: CreateRecordingConfigurationRequest + type: object + required: [] + CreateStageRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Stage ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + Name: + description: Stage name + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + AutoParticipantRecordingConfiguration: + $ref: '#/components/schemas/AutoParticipantRecordingConfiguration' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + ActiveSessionId: + description: ID of the active session within the stage. + type: string + minLength: 0 + maxLength: 128 + x-stackQL-stringOnly: true + x-title: CreateStageRequest + type: object + required: [] + CreateStorageConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$ + minLength: 0 + maxLength: 128 + Name: + description: Storage Configuration Name. + type: string + minLength: 0 + maxLength: 128 + pattern: ^[a-zA-Z0-9-_]*$ + S3: + $ref: '#/components/schemas/S3StorageConfiguration' + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStorageConfigurationRequest + type: object + required: [] + CreateStreamKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Stream Key ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + ChannelArn: + description: Channel ARN for the stream. + type: string + pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$ + Tags: + description: A list of key-value pairs that contain metadata for the asset model. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + Value: + description: Stream-key value. + type: string + x-stackQL-stringOnly: true + x-title: CreateStreamKeyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: channels: name: channels id: awscc.ivs.channels x-cfn-schema-name: Channel - x-type: list + x-cfn-type-name: AWS::IVS::Channel + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Authorized') as authorized, + JSON_EXTRACT(Properties, '$.InsecureIngest') as insecure_ingest, + JSON_EXTRACT(Properties, '$.LatencyMode') as latency_mode, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.PlaybackUrl') as playback_url, + JSON_EXTRACT(Properties, '$.IngestEndpoint') as ingest_endpoint, + JSON_EXTRACT(Properties, '$.RecordingConfigurationArn') as recording_configuration_arn, + JSON_EXTRACT(Properties, '$.Preset') as preset, + JSON_EXTRACT(Properties, '$.MultitrackInputConfiguration') as multitrack_input_configuration, + JSON_EXTRACT(Properties, '$.ContainerFormat') as container_format + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Authorized') as authorized, + json_extract_path_text(Properties, 'InsecureIngest') as insecure_ingest, + json_extract_path_text(Properties, 'LatencyMode') as latency_mode, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'PlaybackUrl') as playback_url, + json_extract_path_text(Properties, 'IngestEndpoint') as ingest_endpoint, + json_extract_path_text(Properties, 'RecordingConfigurationArn') as recording_configuration_arn, + json_extract_path_text(Properties, 'Preset') as preset, + json_extract_path_text(Properties, 'MultitrackInputConfiguration') as multitrack_input_configuration, + json_extract_path_text(Properties, 'ContainerFormat') as container_format + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + channels_list_only: + name: channels_list_only + id: awscc.ivs.channels_list_only + x-cfn-schema-name: Channel + x-cfn-type-name: AWS::IVS::Channel + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' + AND region = 'us-east-1' + encoder_configurations: + name: encoder_configurations + id: awscc.ivs.encoder_configurations + x-cfn-schema-name: EncoderConfiguration + x-cfn-type-name: AWS::IVS::EncoderConfiguration + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EncoderConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::EncoderConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::EncoderConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::EncoderConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Video') as video, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Video') as video, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + encoder_configurations_list_only: + name: encoder_configurations_list_only + id: awscc.ivs.encoder_configurations_list_only + x-cfn-schema-name: EncoderConfiguration + x-cfn-type-name: AWS::IVS::EncoderConfiguration + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' + AND region = 'us-east-1' + ingest_configurations: + name: ingest_configurations + id: awscc.ivs.ingest_configurations + x-cfn-schema-name: IngestConfiguration + x-cfn-type-name: AWS::IVS::IngestConfiguration + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IngestConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::IngestConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::IngestConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::IngestConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ingest_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ingest_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ingest_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.StageArn') as stage_arn, + JSON_EXTRACT(Properties, '$.ParticipantId') as participant_id, + JSON_EXTRACT(Properties, '$.IngestProtocol') as ingest_protocol, + JSON_EXTRACT(Properties, '$.InsecureIngest') as insecure_ingest, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.StreamKey') as stream_key, + JSON_EXTRACT(Properties, '$.UserId') as user_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::IngestConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'StageArn') as stage_arn, + json_extract_path_text(Properties, 'ParticipantId') as participant_id, + json_extract_path_text(Properties, 'IngestProtocol') as ingest_protocol, + json_extract_path_text(Properties, 'InsecureIngest') as insecure_ingest, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'StreamKey') as stream_key, + json_extract_path_text(Properties, 'UserId') as user_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::IngestConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + ingest_configurations_list_only: + name: ingest_configurations_list_only + id: awscc.ivs.ingest_configurations_list_only + x-cfn-schema-name: IngestConfiguration + x-cfn-type-name: AWS::IVS::IngestConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -477,7 +2362,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::IngestConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -485,64 +2370,106 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::IngestConfiguration' AND region = 'us-east-1' - channel: - name: channel - id: awscc.ivs.channel - x-cfn-schema-name: Channel - x-type: get + playback_key_pairs: + name: playback_key_pairs + id: awscc.ivs.playback_key_pairs + x-cfn-schema-name: PlaybackKeyPair + x-cfn-type-name: AWS::IVS::PlaybackKeyPair x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PlaybackKeyPair&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PlaybackKeyPair" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PlaybackKeyPair" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PlaybackKeyPair" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Authorized') as authorized, - JSON_EXTRACT(Properties, '$.InsecureIngest') as insecure_ingest, - JSON_EXTRACT(Properties, '$.LatencyMode') as latency_mode, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.PlaybackUrl') as playback_url, - JSON_EXTRACT(Properties, '$.IngestEndpoint') as ingest_endpoint, - JSON_EXTRACT(Properties, '$.RecordingConfigurationArn') as recording_configuration_arn, - JSON_EXTRACT(Properties, '$.Preset') as preset - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Channel' + JSON_EXTRACT(Properties, '$.PublicKeyMaterial') as public_key_material, + JSON_EXTRACT(Properties, '$.Fingerprint') as fingerprint, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Authorized') as authorized, - json_extract_path_text(Properties, 'InsecureIngest') as insecure_ingest, - json_extract_path_text(Properties, 'LatencyMode') as latency_mode, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'PlaybackUrl') as playback_url, - json_extract_path_text(Properties, 'IngestEndpoint') as ingest_endpoint, - json_extract_path_text(Properties, 'RecordingConfigurationArn') as recording_configuration_arn, - json_extract_path_text(Properties, 'Preset') as preset - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Channel' + json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, + json_extract_path_text(Properties, 'Fingerprint') as fingerprint, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' AND data__Identifier = '' AND region = 'us-east-1' - playback_key_pairs: - name: playback_key_pairs - id: awscc.ivs.playback_key_pairs + playback_key_pairs_list_only: + name: playback_key_pairs_list_only + id: awscc.ivs.playback_key_pairs_list_only x-cfn-schema-name: PlaybackKeyPair - x-type: list + x-cfn-type-name: AWS::IVS::PlaybackKeyPair x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -561,17 +2488,183 @@ components: json_extract_path_text(Properties, 'Arn') as arn FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' AND region = 'us-east-1' - playback_key_pair: - name: playback_key_pair - id: awscc.ivs.playback_key_pair - x-cfn-schema-name: PlaybackKeyPair - x-type: get + playback_restriction_policies: + name: playback_restriction_policies + id: awscc.ivs.playback_restriction_policies + x-cfn-schema-name: PlaybackRestrictionPolicy + x-cfn-type-name: AWS::IVS::PlaybackRestrictionPolicy + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PlaybackRestrictionPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PlaybackRestrictionPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PlaybackRestrictionPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PlaybackRestrictionPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AllowedCountries') as allowed_countries, + JSON_EXTRACT(Properties, '$.AllowedOrigins') as allowed_origins, + JSON_EXTRACT(Properties, '$.EnableStrictOriginEnforcement') as enable_strict_origin_enforcement, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AllowedCountries') as allowed_countries, + json_extract_path_text(Properties, 'AllowedOrigins') as allowed_origins, + json_extract_path_text(Properties, 'EnableStrictOriginEnforcement') as enable_strict_origin_enforcement, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + playback_restriction_policies_list_only: + name: playback_restriction_policies_list_only + id: awscc.ivs.playback_restriction_policies_list_only + x-cfn-schema-name: PlaybackRestrictionPolicy + x-cfn-type-name: AWS::IVS::PlaybackRestrictionPolicy x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' + AND region = 'us-east-1' + public_keys: + name: public_keys + id: awscc.ivs.public_keys + x-cfn-schema-name: PublicKey + x-cfn-type-name: AWS::IVS::PublicKey + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PublicKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PublicKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PublicKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::PublicKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -581,11 +2674,11 @@ components: JSON_EXTRACT(Properties, '$.Fingerprint') as fingerprint, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PublicKey' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -595,16 +2688,22 @@ components: json_extract_path_text(Properties, 'Fingerprint') as fingerprint, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PublicKey' AND data__Identifier = '' AND region = 'us-east-1' - recording_configurations: - name: recording_configurations - id: awscc.ivs.recording_configurations - x-cfn-schema-name: RecordingConfiguration - x-type: list + public_keys_list_only: + name: public_keys_list_only + id: awscc.ivs.public_keys_list_only + x-cfn-schema-name: PublicKey + x-cfn-type-name: AWS::IVS::PublicKey x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -613,7 +2712,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PublicKey' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -621,19 +2720,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PublicKey' AND region = 'us-east-1' - recording_configuration: - name: recording_configuration - id: awscc.ivs.recording_configuration + recording_configurations: + name: recording_configurations + id: awscc.ivs.recording_configurations x-cfn-schema-name: RecordingConfiguration - x-type: get + x-cfn-type-name: AWS::IVS::RecordingConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RecordingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::RecordingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::RecordingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::RecordingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -650,7 +2797,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -666,13 +2813,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - stages: - name: stages - id: awscc.ivs.stages - x-cfn-schema-name: Stage - x-type: list + recording_configurations_list_only: + name: recording_configurations_list_only + id: awscc.ivs.recording_configurations_list_only + x-cfn-schema-name: RecordingConfiguration + x-cfn-type-name: AWS::IVS::RecordingConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -681,7 +2834,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -689,50 +2842,106 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' AND region = 'us-east-1' - stage: - name: stage - id: awscc.ivs.stage + stages: + name: stages + id: awscc.ivs.stages x-cfn-schema-name: Stage - x-type: get + x-cfn-type-name: AWS::IVS::Stage x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Stage&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::Stage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::Stage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::Stage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stages/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.AutoParticipantRecordingConfiguration') as auto_participant_recording_configuration, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.ActiveSessionId') as active_session_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Stage' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AutoParticipantRecordingConfiguration') as auto_participant_recording_configuration, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'ActiveSessionId') as active_session_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Stage' AND data__Identifier = '' AND region = 'us-east-1' - stream_keys: - name: stream_keys - id: awscc.ivs.stream_keys - x-cfn-schema-name: StreamKey - x-type: list + stages_list_only: + name: stages_list_only + id: awscc.ivs.stages_list_only + x-cfn-schema-name: Stage + x-cfn-type-name: AWS::IVS::Stage x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -741,7 +2950,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -749,19 +2958,181 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' AND region = 'us-east-1' - stream_key: - name: stream_key - id: awscc.ivs.stream_key - x-cfn-schema-name: StreamKey - x-type: get + storage_configurations: + name: storage_configurations + id: awscc.ivs.storage_configurations + x-cfn-schema-name: StorageConfiguration + x-cfn-type-name: AWS::IVS::StorageConfiguration + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StorageConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::StorageConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::StorageConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::StorageConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.S3') as s3, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'S3') as s3, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + storage_configurations_list_only: + name: storage_configurations_list_only + id: awscc.ivs.storage_configurations_list_only + x-cfn-schema-name: StorageConfiguration + x-cfn-type-name: AWS::IVS::StorageConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' + AND region = 'us-east-1' + stream_keys: + name: stream_keys + id: awscc.ivs.stream_keys + x-cfn-schema-name: StreamKey + x-cfn-type-name: AWS::IVS::StreamKey + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StreamKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::StreamKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::StreamKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVS::StreamKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stream_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stream_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stream_keys/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -774,7 +3145,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -786,3 +3157,607 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StreamKey' AND data__Identifier = '' AND region = 'us-east-1' + stream_keys_list_only: + name: stream_keys_list_only + id: awscc.ivs.stream_keys_list_only + x-cfn-schema-name: StreamKey + x-cfn-type-name: AWS::IVS::StreamKey + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EncoderConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEncoderConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEncoderConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IngestConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIngestConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIngestConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PlaybackKeyPair&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlaybackKeyPair + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlaybackKeyPairRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PlaybackRestrictionPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlaybackRestrictionPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlaybackRestrictionPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PublicKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePublicKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePublicKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RecordingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRecordingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRecordingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Stage&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StorageConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStorageConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStorageConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StreamKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStreamKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStreamKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ivschat.yaml b/providers/src/awscc/v00.00.00000/services/ivschat.yaml index c920f473..5e3682fb 100644 --- a/providers/src/awscc/v00.00.00000/services/ivschat.yaml +++ b/providers/src/awscc/v00.00.00000/services/ivschat.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: IVSChat - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DestinationConfiguration: description: Destination configuration for IVS Chat logging. @@ -118,12 +498,26 @@ components: required: - DestinationConfiguration x-stackql-resource-name: logging_configuration - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::IVSChat::LoggingConfiguration. + x-type-name: AWS::IVSChat::LoggingConfiguration + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn - Id - State + x-required-properties: + - DestinationConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivschat:TagResource + - ivschat:UntagResource + - ivschat:ListTagsForResource x-required-permissions: create: - ivschat:CreateLoggingConfiguration @@ -144,7 +538,7 @@ components: - ivschat:UpdateLoggingConfiguration - ivschat:GetLoggingConfiguration - ivschat:TagResource - - ivschat:UnTagResource + - ivschat:UntagResource - ivschat:ListTagsForResource - logs:CreateLogDelivery - logs:GetLogDelivery @@ -243,11 +637,24 @@ components: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: room - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::IVSChat::Room. + x-type-name: AWS::IVSChat::Room + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn - Id + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ivschat:TagResource + - ivschat:ListTagsForResource + - ivschat:UntagResource x-required-permissions: create: - ivschat:CreateRoom @@ -258,7 +665,7 @@ components: update: - ivschat:UpdateRoom - ivschat:TagResource - - ivschat:UnTagResource + - ivschat:UntagResource - ivschat:ListTagsForResource delete: - ivschat:DeleteRoom @@ -266,43 +673,196 @@ components: list: - ivschat:ListRooms - ivschat:ListTagsForResource + CreateLoggingConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Id: + description: The system-generated ID of the logging configuration. + type: string + pattern: ^[a-zA-Z0-9]+$ + minLength: 12 + maxLength: 12 + DestinationConfiguration: + $ref: '#/components/schemas/DestinationConfiguration' + Name: + description: The name of the logging configuration. The value does not need to be unique. + type: string + pattern: ^[a-zA-Z0-9-_]*$ + minLength: 0 + maxLength: 128 + State: + description: The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content. + type: string + enum: + - CREATING + - CREATE_FAILED + - DELETING + - DELETE_FAILED + - UPDATING + - UPDATING_FAILED + - ACTIVE + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateLoggingConfigurationRequest + type: object + required: [] + CreateRoomRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Room ARN is automatically generated on creation and assigned as the unique identifier. + type: string + pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + Id: + description: The system-generated ID of the room. + type: string + pattern: ^[a-zA-Z0-9]+$ + minLength: 12 + maxLength: 12 + Name: + description: The name of the room. The value does not need to be unique. + type: string + pattern: ^[a-zA-Z0-9-_]*$ + minLength: 0 + maxLength: 128 + LoggingConfigurationIdentifiers: + description: Array of logging configuration identifiers attached to the room. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 50 + items: + type: string + pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$ + minLength: 1 + maxLength: 128 + MaximumMessageLength: + description: The maximum number of characters in a single message. + type: integer + minimum: 1 + maximum: 500 + default: 500 + MaximumMessageRatePerSecond: + description: The maximum number of messages per second that can be sent to the room. + type: integer + minimum: 1 + maximum: 10 + default: 10 + MessageReviewHandler: + $ref: '#/components/schemas/MessageReviewHandler' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRoomRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: logging_configurations: name: logging_configurations id: awscc.ivschat.logging_configurations x-cfn-schema-name: LoggingConfiguration - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' - AND region = 'us-east-1' - logging_configuration: - name: logging_configuration - id: awscc.ivschat.logging_configuration - x-cfn-schema-name: LoggingConfiguration - x-type: get + x-cfn-type-name: AWS::IVSChat::LoggingConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LoggingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVSChat::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVSChat::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVSChat::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -317,7 +877,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -331,13 +891,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - rooms: - name: rooms - id: awscc.ivschat.rooms - x-cfn-schema-name: Room - x-type: list + logging_configurations_list_only: + name: logging_configurations_list_only + id: awscc.ivschat.logging_configurations_list_only + x-cfn-schema-name: LoggingConfiguration + x-cfn-type-name: AWS::IVSChat::LoggingConfiguration x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -346,7 +912,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -354,19 +920,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' AND region = 'us-east-1' - room: - name: room - id: awscc.ivschat.room + rooms: + name: rooms + id: awscc.ivschat.rooms x-cfn-schema-name: Room - x-type: get + x-cfn-type-name: AWS::IVSChat::Room x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Room&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVSChat::Room" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVSChat::Room" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IVSChat::Room" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rooms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rooms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rooms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -383,7 +997,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -399,3 +1013,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::IVSChat::Room' AND data__Identifier = '' AND region = 'us-east-1' + rooms_list_only: + name: rooms_list_only + id: awscc.ivschat.rooms_list_only + x-cfn-schema-name: Room + x-cfn-type-name: AWS::IVSChat::Room + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LoggingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLoggingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoggingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Room&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoom + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoomRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kafkaconnect.yaml b/providers/src/awscc/v00.00.00000/services/kafkaconnect.yaml index 96f4d3ee..2dd77da8 100644 --- a/providers/src/awscc/v00.00.00000/services/kafkaconnect.yaml +++ b/providers/src/awscc/v00.00.00000/services/kafkaconnect.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: KafkaConnect - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ApacheKafkaCluster: description: Details of how to connect to an Apache Kafka cluster. @@ -75,22 +455,99 @@ components: required: - Enabled CustomPlugin: - description: Details about a custom plugin. type: object - additionalProperties: false properties: + Name: + description: The name of the custom plugin. + type: string + minLength: 1 + maxLength: 128 + Description: + description: A summary description of the custom plugin. + type: string + maxLength: 1024 CustomPluginArn: description: The Amazon Resource Name (ARN) of the custom plugin to use. type: string pattern: arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.* + ContentType: + description: The type of the plugin file. + type: string + enum: + - JAR + - ZIP + FileDescription: + $ref: '#/components/schemas/CustomPluginFileDescription' + Location: + $ref: '#/components/schemas/CustomPluginLocation' Revision: - description: The revision of the custom plugin to use. + description: The revision of the custom plugin. type: integer format: int64 - minimum: 1 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: + - Name + - ContentType + - Location + x-stackql-resource-name: custom_plugin + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::KafkaConnect::CustomPlugin + x-stackql-primary-identifier: + - CustomPluginArn + x-stackql-additional-identifiers: + - - Name + x-create-only-properties: + - Name + - Description + - ContentType + - Location + x-read-only-properties: - CustomPluginArn - Revision + - FileDescription + x-required-properties: + - Name + - ContentType + - Location + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafkaconnect:ListTagsForResource + - kafkaconnect:UntagResource + - kafkaconnect:TagResource + x-required-permissions: + create: + - kafkaconnect:DescribeCustomPlugin + - kafkaconnect:ListTagsForResource + - kafkaconnect:CreateCustomPlugin + - kafkaconnect:TagResource + - s3:GetObject + - s3:GetObjectVersion + - s3:GetObjectAttributes + - s3:GetObjectVersionAttributes + read: + - kafkaconnect:DescribeCustomPlugin + - kafkaconnect:ListTagsForResource + update: + - kafkaconnect:DescribeCustomPlugin + - kafkaconnect:ListTagsForResource + - kafkaconnect:TagResource + - kafkaconnect:UntagResource + delete: + - kafkaconnect:DeleteCustomPlugin + - kafkaconnect:DescribeCustomPlugin + list: + - kafkaconnect:ListCustomPlugins FirehoseLogDelivery: description: Details about delivering logs to Amazon Kinesis Data Firehose. type: object @@ -219,6 +676,20 @@ components: maximum: 100 required: - CpuUtilizationPercentage + Tag: + type: object + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + Value: + type: string + maxLength: 256 + required: + - Value + - Key + additionalProperties: false Vpc: description: Information about a VPC used with the connector. type: object @@ -243,22 +714,84 @@ components: - SecurityGroups - Subnets WorkerConfiguration: - description: Specifies the worker configuration to use with the connector. type: object - additionalProperties: false properties: - Revision: - description: The revision of the worker configuration to use. - type: integer - minimum: 1 - format: int64 + Name: + description: The name of the worker configuration. + type: string + minLength: 1 + maxLength: 128 + Description: + description: A summary description of the worker configuration. + type: string + maxLength: 1024 WorkerConfigurationArn: - description: The Amazon Resource Name (ARN) of the worker configuration to use. + description: The Amazon Resource Name (ARN) of the custom configuration. type: string pattern: arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.* + PropertiesFileContent: + description: Base64 encoded contents of connect-distributed.properties file. + type: string + Revision: + description: The description of a revision of the worker configuration. + type: integer + format: int64 + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - - Revision + - Name + - PropertiesFileContent + x-stackql-resource-name: worker_configuration + description: The configuration of the workers, which are the processes that run the connector logic. + x-type-name: AWS::KafkaConnect::WorkerConfiguration + x-stackql-primary-identifier: - WorkerConfigurationArn + x-stackql-additional-identifiers: + - - Name + x-create-only-properties: + - Name + - Description + - PropertiesFileContent + x-read-only-properties: + - WorkerConfigurationArn + - Revision + x-required-properties: + - Name + - PropertiesFileContent + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafkaconnect:ListTagsForResource + - kafkaconnect:UntagResource + - kafkaconnect:TagResource + x-required-permissions: + create: + - kafkaconnect:DescribeWorkerConfiguration + - kafkaconnect:CreateWorkerConfiguration + - kafkaconnect:TagResource + - kafkaconnect:ListTagsForResource + read: + - kafkaconnect:DescribeWorkerConfiguration + - kafkaconnect:ListTagsForResource + update: + - kafkaconnect:DescribeWorkerConfiguration + - kafkaconnect:ListTagsForResource + - kafkaconnect:TagResource + - kafkaconnect:UntagResource + delete: + - kafkaconnect:DescribeWorkerConfiguration + - kafkaconnect:DeleteWorkerConfiguration + list: + - kafkaconnect:ListWorkerConfigurations WorkerLogDelivery: description: Specifies where worker logs are delivered. type: object @@ -318,6 +851,13 @@ components: description: The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources. type: string pattern: arn:(aws|aws-us-gov|aws-cn):iam:.* + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' WorkerConfiguration: $ref: '#/components/schemas/WorkerConfiguration' required: @@ -331,10 +871,13 @@ components: - Plugins - ServiceExecutionRoleArn x-stackql-resource-name: connector - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::KafkaConnect::Connector + x-type-name: AWS::KafkaConnect::Connector + x-stackql-primary-identifier: - ConnectorArn + x-stackql-additional-identifiers: + - - ConnectorName x-create-only-properties: - - ConnectorConfiguration - ConnectorDescription - ConnectorName - KafkaCluster @@ -347,10 +890,34 @@ components: - WorkerConfiguration x-read-only-properties: - ConnectorArn + x-required-properties: + - Capacity + - ConnectorConfiguration + - ConnectorName + - KafkaConnectVersion + - KafkaCluster + - KafkaClusterClientAuthentication + - KafkaClusterEncryptionInTransit + - Plugins + - ServiceExecutionRoleArn + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafkaconnect:ListTagsForResource + - kafkaconnect:UntagResource + - kafkaconnect:TagResource + - firehose:TagDeliveryStream x-required-permissions: create: - kafkaconnect:CreateConnector - kafkaconnect:DescribeConnector + - kafkaconnect:TagResource + - kafkaconnect:ListTagsForResource - iam:CreateServiceLinkedRole - iam:PassRole - ec2:CreateNetworkInterface @@ -368,6 +935,7 @@ components: - firehose:TagDeliveryStream read: - kafkaconnect:DescribeConnector + - kafkaconnect:ListTagsForResource delete: - kafkaconnect:DeleteConnector - kafkaconnect:DescribeConnector @@ -377,6 +945,10 @@ components: update: - kafkaconnect:UpdateConnector - kafkaconnect:DescribeConnector + - kafkaconnect:DescribeConnectorOperation + - kafkaconnect:TagResource + - kafkaconnect:ListTagsForResource + - kafkaconnect:UntagResource - iam:CreateServiceLinkedRole - logs:UpdateLogDelivery - logs:GetLogDelivery @@ -389,14 +961,322 @@ components: - firehose:TagDeliveryStream list: - kafkaconnect:ListConnectors + CustomPluginFileDescription: + description: Details about the custom plugin file. + type: object + additionalProperties: false + properties: + FileMd5: + description: The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file. + type: string + FileSize: + description: The size in bytes of the custom plugin file. You can use it to validate the file. + type: integer + format: int64 + CustomPluginLocation: + description: Information about the location of a custom plugin. + type: object + additionalProperties: false + properties: + S3Location: + $ref: '#/components/schemas/S3Location' + required: + - S3Location + S3Location: + description: The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3. + type: object + additionalProperties: false + properties: + BucketArn: + type: string + description: The Amazon Resource Name (ARN) of an S3 bucket. + FileKey: + type: string + description: The file key for an object in an S3 bucket. + ObjectVersion: + type: string + description: The version of an object in an S3 bucket. + required: + - BucketArn + - FileKey + CreateCustomPluginRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the custom plugin. + type: string + minLength: 1 + maxLength: 128 + Description: + description: A summary description of the custom plugin. + type: string + maxLength: 1024 + CustomPluginArn: + description: The Amazon Resource Name (ARN) of the custom plugin to use. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.* + ContentType: + description: The type of the plugin file. + type: string + enum: + - JAR + - ZIP + FileDescription: + $ref: '#/components/schemas/CustomPluginFileDescription' + Location: + $ref: '#/components/schemas/CustomPluginLocation' + Revision: + description: The revision of the custom plugin. + type: integer + format: int64 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCustomPluginRequest + type: object + required: [] + CreateWorkerConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the worker configuration. + type: string + minLength: 1 + maxLength: 128 + Description: + description: A summary description of the worker configuration. + type: string + maxLength: 1024 + WorkerConfigurationArn: + description: The Amazon Resource Name (ARN) of the custom configuration. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.* + PropertiesFileContent: + description: Base64 encoded contents of connect-distributed.properties file. + type: string + Revision: + description: The description of a revision of the worker configuration. + type: integer + format: int64 + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateWorkerConfigurationRequest + type: object + required: [] + CreateConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Capacity: + $ref: '#/components/schemas/Capacity' + ConnectorArn: + description: Amazon Resource Name for the created Connector. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.* + ConnectorConfiguration: + description: The configuration for the connector. + type: object + additionalProperties: false + x-patternProperties: + .*: + type: string + ConnectorDescription: + description: A summary description of the connector. + type: string + maxLength: 1024 + ConnectorName: + description: The name of the connector. + type: string + minLength: 1 + maxLength: 128 + KafkaCluster: + $ref: '#/components/schemas/KafkaCluster' + KafkaClusterClientAuthentication: + $ref: '#/components/schemas/KafkaClusterClientAuthentication' + KafkaClusterEncryptionInTransit: + $ref: '#/components/schemas/KafkaClusterEncryptionInTransit' + KafkaConnectVersion: + description: The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins. + type: string + LogDelivery: + $ref: '#/components/schemas/LogDelivery' + Plugins: + description: List of plugins to use with the connector. + type: array + uniqueItems: true + minItems: 1 + items: + $ref: '#/components/schemas/Plugin' + x-insertionOrder: false + ServiceExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):iam:.* + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + WorkerConfiguration: + $ref: '#/components/schemas/WorkerConfiguration' + x-stackQL-stringOnly: true + x-title: CreateConnectorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - connectors: - name: connectors - id: awscc.kafkaconnect.connectors - x-cfn-schema-name: Connector - x-type: list + custom_plugins: + name: custom_plugins + id: awscc.kafkaconnect.custom_plugins + x-cfn-schema-name: CustomPlugin + x-cfn-type-name: AWS::KafkaConnect::CustomPlugin x-identifiers: - - ConnectorArn + - CustomPluginArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomPlugin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::CustomPlugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::CustomPlugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::CustomPlugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.CustomPluginArn') as custom_plugin_arn, + JSON_EXTRACT(Properties, '$.ContentType') as content_type, + JSON_EXTRACT(Properties, '$.FileDescription') as file_description, + JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.Revision') as revision, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CustomPluginArn') as custom_plugin_arn, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'FileDescription') as file_description, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Revision') as revision, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' + AND data__Identifier = '' + AND region = 'us-east-1' + custom_plugins_list_only: + name: custom_plugins_list_only + id: awscc.kafkaconnect.custom_plugins_list_only + x-cfn-schema-name: CustomPlugin + x-cfn-type-name: AWS::KafkaConnect::CustomPlugin + x-identifiers: + - CustomPluginArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -404,28 +1284,194 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' + JSON_EXTRACT(Properties, '$.CustomPluginArn') as custom_plugin_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' + json_extract_path_text(Properties, 'CustomPluginArn') as custom_plugin_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' AND region = 'us-east-1' - connector: - name: connector - id: awscc.kafkaconnect.connector + worker_configurations: + name: worker_configurations + id: awscc.kafkaconnect.worker_configurations + x-cfn-schema-name: WorkerConfiguration + x-cfn-type-name: AWS::KafkaConnect::WorkerConfiguration + x-identifiers: + - WorkerConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WorkerConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::WorkerConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::WorkerConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::WorkerConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.WorkerConfigurationArn') as worker_configuration_arn, + JSON_EXTRACT(Properties, '$.PropertiesFileContent') as properties_file_content, + JSON_EXTRACT(Properties, '$.Revision') as revision, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'WorkerConfigurationArn') as worker_configuration_arn, + json_extract_path_text(Properties, 'PropertiesFileContent') as properties_file_content, + json_extract_path_text(Properties, 'Revision') as revision, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + worker_configurations_list_only: + name: worker_configurations_list_only + id: awscc.kafkaconnect.worker_configurations_list_only + x-cfn-schema-name: WorkerConfiguration + x-cfn-type-name: AWS::KafkaConnect::WorkerConfiguration + x-identifiers: + - WorkerConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkerConfigurationArn') as worker_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkerConfigurationArn') as worker_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' + AND region = 'us-east-1' + connectors: + name: connectors + id: awscc.kafkaconnect.connectors x-cfn-schema-name: Connector - x-type: get + x-cfn-type-name: AWS::KafkaConnect::Connector x-identifiers: - ConnectorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KafkaConnect::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -442,12 +1488,13 @@ components: JSON_EXTRACT(Properties, '$.LogDelivery') as log_delivery, JSON_EXTRACT(Properties, '$.Plugins') as plugins, JSON_EXTRACT(Properties, '$.ServiceExecutionRoleArn') as service_execution_role_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.WorkerConfiguration') as worker_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::Connector' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -464,7 +1511,318 @@ components: json_extract_path_text(Properties, 'LogDelivery') as log_delivery, json_extract_path_text(Properties, 'Plugins') as plugins, json_extract_path_text(Properties, 'ServiceExecutionRoleArn') as service_execution_role_arn, + json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'WorkerConfiguration') as worker_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::Connector' AND data__Identifier = '' AND region = 'us-east-1' + connectors_list_only: + name: connectors_list_only + id: awscc.kafkaconnect.connectors_list_only + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::KafkaConnect::Connector + x-identifiers: + - ConnectorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomPlugin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomPlugin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomPluginRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WorkerConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkerConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkerConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kendra.yaml b/providers/src/awscc/v00.00.00000/services/kendra.yaml index c17a2622..c74eabbb 100644 --- a/providers/src/awscc/v00.00.00000/services/kendra.yaml +++ b/providers/src/awscc/v00.00.00000/services/kendra.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Kendra - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: IndexId: description: Unique ID of Index @@ -31,6 +411,7 @@ components: TagList: description: List of tags type: array + x-insertionOrder: false maxItems: 200 items: $ref: '#/components/schemas/Tag' @@ -998,6 +1379,14 @@ components: additionalProperties: false required: - OrganizationId + TemplateConfiguration: + type: object + properties: + Template: + type: object + additionalProperties: false + required: + - Template DataSourceConfiguration: type: object properties: @@ -1021,6 +1410,8 @@ components: $ref: '#/components/schemas/WebCrawlerConfiguration' WorkDocsConfiguration: $ref: '#/components/schemas/WorkDocsConfiguration' + TemplateConfiguration: + $ref: '#/components/schemas/TemplateConfiguration' additionalProperties: false oneOf: - required: @@ -1043,6 +1434,8 @@ components: - WebCrawlerConfiguration - required: - WorkDocsConfiguration + - required: + - TemplateConfiguration Name: description: Name of index type: string @@ -1063,6 +1456,7 @@ components: - GOOGLEDRIVE - WEBCRAWLER - WORKDOCS + - TEMPLATE Description: type: string maxLength: 1000 @@ -1233,14 +1627,31 @@ components: - IndexId - Type x-stackql-resource-name: data_source - x-stackql-primaryIdentifier: + description: Kendra DataSource + x-type-name: AWS::Kendra::DataSource + x-stackql-primary-identifier: - Id - IndexId x-create-only-properties: - Type + - IndexId x-read-only-properties: - Id - Arn + x-required-properties: + - Name + - IndexId + - Type + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kendra:UntagResource + - kendra:TagResource + - kendra:ListTagsForResource x-required-permissions: create: - kendra:CreateDataSource @@ -1303,13 +1714,17 @@ components: Arn: type: string maxLength: 1000 + LanguageCode: + $ref: '#/components/schemas/LanguageCode' required: - IndexId - Name - S3Path - RoleArn x-stackql-resource-name: faq - x-stackql-primaryIdentifier: + description: A Kendra FAQ resource + x-type-name: AWS::Kendra::Faq + x-stackql-primary-identifier: - Id - IndexId x-create-only-properties: @@ -1322,6 +1737,21 @@ components: x-read-only-properties: - Id - Arn + x-required-properties: + - IndexId + - Name + - S3Path + - RoleArn + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kendra:UntagResource + - kendra:TagResource + - kendra:ListTagsForResource x-required-permissions: create: - kendra:CreateFaq @@ -1383,6 +1813,7 @@ components: additionalProperties: false ValueImportanceItems: type: array + x-insertionOrder: false items: $ref: '#/components/schemas/ValueImportanceItem' ValueImportanceItem: @@ -1437,6 +1868,7 @@ components: - Type DocumentMetadataConfigurationList: type: array + x-insertionOrder: false maxItems: 500 items: $ref: '#/components/schemas/DocumentMetadataConfiguration' @@ -1463,6 +1895,7 @@ components: enum: - DEVELOPER_EDITION - ENTERPRISE_EDITION + - GEN_AI_ENTERPRISE_EDITION UserContextPolicy: type: string enum: @@ -1530,6 +1963,7 @@ components: additionalProperties: false UserTokenConfigurationList: type: array + x-insertionOrder: false maxItems: 1 items: $ref: '#/components/schemas/UserTokenConfiguration' @@ -1570,7 +2004,9 @@ components: - RoleArn - Edition x-stackql-resource-name: index - x-stackql-primaryIdentifier: + description: A Kendra index + x-type-name: AWS::Kendra::Index + x-stackql-primary-identifier: - Id x-create-only-properties: - Edition @@ -1578,6 +2014,20 @@ components: x-read-only-properties: - Id - Arn + x-required-properties: + - Name + - RoleArn + - Edition + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kendra:UntagResource + - kendra:TagResource + - kendra:ListTagsForResource x-required-permissions: create: - kendra:CreateIndex @@ -1586,6 +2036,8 @@ components: - kendra:ListTagsForResource - iam:PassRole - kendra:TagResource + - kms:DescribeKey + - kms:CreateGrant read: - kendra:DescribeIndex - kendra:ListTagsForResource @@ -1599,49 +2051,210 @@ components: delete: - kendra:DescribeIndex - kendra:DeleteIndex + - kms:RetireGrant list: - kendra:ListIndices + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/Id' + Arn: + $ref: '#/components/schemas/Arn' + Name: + $ref: '#/components/schemas/Name' + IndexId: + $ref: '#/components/schemas/IndexId' + Type: + $ref: '#/components/schemas/Type' + DataSourceConfiguration: + $ref: '#/components/schemas/DataSourceConfiguration' + Description: + $ref: '#/components/schemas/Description' + Schedule: + $ref: '#/components/schemas/Schedule' + RoleArn: + $ref: '#/components/schemas/RoleArn' + Tags: + description: Tags for labeling the data source + $ref: '#/components/schemas/TagList' + CustomDocumentEnrichmentConfiguration: + $ref: '#/components/schemas/CustomDocumentEnrichmentConfiguration' + LanguageCode: + $ref: '#/components/schemas/LanguageCode' + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateFaqRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/Id' + IndexId: + description: Index ID + $ref: '#/components/schemas/IndexId' + Name: + description: FAQ name + $ref: '#/components/schemas/FaqName' + Description: + description: FAQ description + $ref: '#/components/schemas/Description' + FileFormat: + description: FAQ file format + $ref: '#/components/schemas/FileFormat' + S3Path: + description: FAQ S3 path + $ref: '#/components/schemas/S3Path' + RoleArn: + description: FAQ role ARN + $ref: '#/components/schemas/RoleArn' + Tags: + description: Tags for labeling the FAQ + $ref: '#/components/schemas/TagList' + Arn: + type: string + maxLength: 1000 + LanguageCode: + $ref: '#/components/schemas/LanguageCode' + x-stackQL-stringOnly: true + x-title: CreateFaqRequest + type: object + required: [] + CreateIndexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/Id' + Arn: + $ref: '#/components/schemas/Arn' + Description: + description: A description for the index + $ref: '#/components/schemas/Description' + ServerSideEncryptionConfiguration: + description: Server side encryption configuration + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + Tags: + description: Tags for labeling the index + $ref: '#/components/schemas/TagList' + Name: + $ref: '#/components/schemas/Name' + RoleArn: + $ref: '#/components/schemas/RoleArn' + Edition: + $ref: '#/components/schemas/Edition' + DocumentMetadataConfigurations: + description: Document metadata configurations + $ref: '#/components/schemas/DocumentMetadataConfigurationList' + CapacityUnits: + description: Capacity units + $ref: '#/components/schemas/CapacityUnitsConfiguration' + UserContextPolicy: + $ref: '#/components/schemas/UserContextPolicy' + UserTokenConfigurations: + $ref: '#/components/schemas/UserTokenConfigurationList' + x-stackQL-stringOnly: true + x-title: CreateIndexRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: data_sources: name: data_sources id: awscc.kendra.data_sources x-cfn-schema-name: DataSource - x-type: list - x-identifiers: - - Id - - IndexId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.IndexId') as index_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'IndexId') as index_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' - AND region = 'us-east-1' - data_source: - name: data_source - id: awscc.kendra.data_source - x-cfn-schema-name: DataSource - x-type: get + x-cfn-type-name: AWS::Kendra::DataSource x-identifiers: - Id - IndexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1662,7 +2275,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1682,14 +2295,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::DataSource' AND data__Identifier = '|' AND region = 'us-east-1' - faqs: - name: faqs - id: awscc.kendra.faqs - x-cfn-schema-name: Faq - x-type: list + data_sources_list_only: + name: data_sources_list_only + id: awscc.kendra.data_sources_list_only + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::Kendra::DataSource x-identifiers: - Id - IndexId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1699,7 +2318,7 @@ components: region, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.IndexId') as index_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1708,20 +2327,68 @@ components: region, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'IndexId') as index_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' AND region = 'us-east-1' - faq: - name: faq - id: awscc.kendra.faq + faqs: + name: faqs + id: awscc.kendra.faqs x-cfn-schema-name: Faq - x-type: get + x-cfn-type-name: AWS::Kendra::Faq x-identifiers: - Id - IndexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Faq&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::Faq" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::Faq" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::Faq" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/faqs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/faqs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/faqs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1734,12 +2401,13 @@ components: JSON_EXTRACT(Properties, '$.S3Path') as s3_path, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.LanguageCode') as language_code FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Faq' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1752,17 +2420,25 @@ components: json_extract_path_text(Properties, 'S3Path') as s3_path, json_extract_path_text(Properties, 'RoleArn') as role_arn, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'LanguageCode') as language_code FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Faq' AND data__Identifier = '|' AND region = 'us-east-1' - indices: - name: indices - id: awscc.kendra.indices - x-cfn-schema-name: Index - x-type: list + faqs_list_only: + name: faqs_list_only + id: awscc.kendra.faqs_list_only + x-cfn-schema-name: Faq + x-cfn-type-name: AWS::Kendra::Faq x-identifiers: - Id + - IndexId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1770,28 +2446,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' AND region = 'us-east-1' - index: - name: index - id: awscc.kendra.index + indices: + name: indices + id: awscc.kendra.indices x-cfn-schema-name: Index - x-type: get + x-cfn-type-name: AWS::Kendra::Index x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kendra::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1812,7 +2538,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1832,3 +2558,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Index' AND data__Identifier = '' AND region = 'us-east-1' + indices_list_only: + name: indices_list_only + id: awscc.kendra.indices_list_only + x-cfn-schema-name: Index + x-cfn-type-name: AWS::Kendra::Index + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Faq&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFaq + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFaqRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIndex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIndexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kendraranking.yaml b/providers/src/awscc/v00.00.00000/services/kendraranking.yaml index e891cb7a..7bd14e28 100644 --- a/providers/src/awscc/v00.00.00000/services/kendraranking.yaml +++ b/providers/src/awscc/v00.00.00000/services/kendraranking.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: KendraRanking - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Description: type: string @@ -78,11 +458,21 @@ components: required: - Name x-stackql-resource-name: execution_plan - x-stackql-primaryIdentifier: + description: A KendraRanking Rescore execution plan + x-type-name: AWS::KendraRanking::ExecutionPlan + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - kendra-ranking:CreateRescoreExecutionPlan @@ -104,43 +494,105 @@ components: - kendra-ranking:DeleteRescoreExecutionPlan list: - kendra-ranking:ListRescoreExecutionPlans + CreateExecutionPlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/Id' + Arn: + $ref: '#/components/schemas/Arn' + Description: + description: A description for the execution plan + $ref: '#/components/schemas/Description' + Tags: + description: Tags for labeling the execution plan + $ref: '#/components/schemas/Tags' + Name: + $ref: '#/components/schemas/Name' + CapacityUnits: + description: Capacity units + $ref: '#/components/schemas/CapacityUnitsConfiguration' + x-stackQL-stringOnly: true + x-title: CreateExecutionPlanRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: execution_plans: name: execution_plans id: awscc.kendraranking.execution_plans x-cfn-schema-name: ExecutionPlan - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' - AND region = 'us-east-1' - execution_plan: - name: execution_plan - id: awscc.kendraranking.execution_plan - x-cfn-schema-name: ExecutionPlan - x-type: get + x-cfn-type-name: AWS::KendraRanking::ExecutionPlan x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ExecutionPlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KendraRanking::ExecutionPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KendraRanking::ExecutionPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KendraRanking::ExecutionPlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/execution_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/execution_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/execution_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -155,7 +607,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -169,3 +621,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' AND data__Identifier = '' AND region = 'us-east-1' + execution_plans_list_only: + name: execution_plans_list_only + id: awscc.kendraranking.execution_plans_list_only + x-cfn-schema-name: ExecutionPlan + x-cfn-type-name: AWS::KendraRanking::ExecutionPlan + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ExecutionPlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateExecutionPlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateExecutionPlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kinesis.yaml b/providers/src/awscc/v00.00.00000/services/kinesis.yaml index d083fd39..edd5012b 100644 --- a/providers/src/awscc/v00.00.00000/services/kinesis.yaml +++ b/providers/src/awscc/v00.00.00000/services/kinesis.yaml @@ -1,14 +1,453 @@ openapi: 3.0.0 info: title: Kinesis - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + ResourcePolicy: + type: object + properties: + ResourceArn: + description: The ARN of the AWS Kinesis resource to which the policy applies. + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+ + anyOf: + - relationshipRef: + typeName: AWS::Kinesis::Stream + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::Kinesis::StreamConsumer + propertyPath: /properties/ConsumerARN + ResourcePolicy: + description: A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + type: object + required: + - ResourceArn + - ResourcePolicy + x-stackql-resource-name: resource_policy + description: Resource Type definition for AWS::Kinesis::ResourcePolicy + x-type-name: AWS::Kinesis::ResourcePolicy + x-stackql-primary-identifier: + - ResourceArn + x-create-only-properties: + - ResourceArn + x-required-properties: + - ResourceArn + - ResourcePolicy + x-tagging: + taggable: false + x-required-permissions: + create: + - kinesis:GetResourcePolicy + - kinesis:PutResourcePolicy + read: + - kinesis:GetResourcePolicy + update: + - kinesis:PutResourcePolicy + - kinesis:GetResourcePolicy + delete: + - kinesis:DeleteResourcePolicy + - kinesis:GetResourcePolicy + EnhancedMetric: + description: Value of an enhanced metric + type: string + additionalProperties: false + enum: + - IncomingBytes + - IncomingRecords + - OutgoingBytes + - OutgoingRecords + - WriteProvisionedThroughputExceeded + - ReadProvisionedThroughputExceeded + - IteratorAgeMilliseconds + - ALL StreamModeDetails: description: When specified, enables or updates the mode of stream. Default is PROVISIONED. - additionalProperties: false type: object + additionalProperties: false properties: StreamMode: description: The mode of the stream @@ -20,8 +459,8 @@ components: - StreamMode StreamEncryption: description: When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption. - additionalProperties: false type: object + additionalProperties: false properties: EncryptionType: description: 'The encryption type to use. The only valid value is KMS. ' @@ -29,8 +468,10 @@ components: enum: - KMS KeyId: - minLength: 1 description: The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis. + type: string + minLength: 1 + maxLength: 2048 anyOf: - relationshipRef: typeName: AWS::KMS::Key @@ -38,13 +479,11 @@ components: - relationshipRef: typeName: AWS::KMS::Key propertyPath: /properties/KeyId - type: string - maxLength: 2048 required: - EncryptionType - KeyId Tag: - description: An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream. + description: An arbitrary set of tags (key-value pairs) to associate with the Kinesis consumer. additionalProperties: false type: object properties: @@ -64,50 +503,70 @@ components: Stream: type: object properties: - StreamModeDetails: - default: - StreamMode: PROVISIONED - description: The mode in which the stream is running. - $ref: '#/components/schemas/StreamModeDetails' - StreamEncryption: - description: When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. - $ref: '#/components/schemas/StreamEncryption' Arn: description: The Amazon resource name (ARN) of the Kinesis stream type: string + Name: + description: The name of the Kinesis stream. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_.-]+$ + DesiredShardLevelMetrics: + description: The final list of shard-level metrics + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 7 + items: + $ref: '#/components/schemas/EnhancedMetric' RetentionPeriodHours: description: The number of hours for the data records that are stored in shards to remain accessible. type: integer minimum: 24 + ShardCount: + description: The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed. + type: integer + minimum: 1 + StreamModeDetails: + description: The mode in which the stream is running. + $ref: '#/components/schemas/StreamModeDetails' + default: + StreamMode: PROVISIONED + StreamEncryption: + description: When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. + $ref: '#/components/schemas/StreamEncryption' Tags: - maxItems: 50 - uniqueItems: false description: An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream. - x-insertionOrder: false type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 50 items: $ref: '#/components/schemas/Tag' - Name: - minLength: 1 - pattern: ^[a-zA-Z0-9_.-]+$ - description: The name of the Kinesis stream. - type: string - maxLength: 128 - ShardCount: - description: The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed. - type: integer - minimum: 1 x-stackql-resource-name: stream - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Kinesis::Stream + x-type-name: AWS::Kinesis::Stream + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn - x-required-permissions: - read: - - kinesis:DescribeStreamSummary + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - kinesis:AddTagsToStream + - kinesis:TagResource + - kinesis:RemoveTagsFromStream + - kinesis:UntagResource - kinesis:ListTagsForStream + - kinesis:ListTagsForResource + x-required-permissions: create: - kinesis:EnableEnhancedMonitoring - kinesis:DescribeStreamSummary @@ -116,6 +575,11 @@ components: - kinesis:StartStreamEncryption - kinesis:AddTagsToStream - kinesis:ListTagsForStream + - kinesis:ListTagsForResource + read: + - kinesis:DescribeStreamSummary + - kinesis:ListTagsForStream + - kinesis:ListTagsForResource update: - kinesis:EnableEnhancedMonitoring - kinesis:DisableEnhancedMonitoring @@ -127,22 +591,421 @@ components: - kinesis:StartStreamEncryption - kinesis:StopStreamEncryption - kinesis:AddTagsToStream + - kinesis:TagResource - kinesis:RemoveTagsFromStream + - kinesis:UntagResource - kinesis:ListTagsForStream - list: - - kinesis:ListStreams + - kinesis:ListTagsForResource delete: - kinesis:DescribeStreamSummary - kinesis:DeleteStream - kinesis:RemoveTagsFromStream + - kinesis:UntagResource + list: + - kinesis:ListStreams + StreamConsumer: + type: object + properties: + ConsumerCreationTimestamp: + description: Timestamp when the consumer was created. + type: string + ConsumerName: + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + description: The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams. + type: string + maxLength: 128 + ConsumerARN: + description: The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN. + type: string + ConsumerStatus: + description: 'A consumer can''t read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE' + type: string + StreamARN: + minLength: 1 + pattern: ^arn:aws.*:kinesis:.*:\d{12}:stream/\S+ + description: The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with. + type: string + maxLength: 2048 + Tags: + maxItems: 50 + uniqueItems: false + description: An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - ConsumerName + - StreamARN + x-stackql-resource-name: stream_consumer + description: Resource Type definition for AWS::Kinesis::StreamConsumer + x-type-name: AWS::Kinesis::StreamConsumer + x-stackql-primary-identifier: + - ConsumerARN + x-create-only-properties: + - ConsumerName + - StreamARN + - Tags + x-read-only-properties: + - ConsumerARN + - ConsumerStatus + - ConsumerCreationTimestamp + x-required-properties: + - ConsumerName + - StreamARN + x-tagging: + permissions: + - kinesis:TagResource + - kinesis:UntagResource + - kinesis:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: false + tagProperty: /properties/Tags + cloudFormationSystemTags: false + x-required-permissions: + read: + - kinesis:DescribeStreamConsumer + - kinesis:ListTagsForResource + create: + - kinesis:RegisterStreamConsumer + - kinesis:DescribeStreamConsumer + - kinesis:TagResource + list: + - kinesis:ListStreamConsumers + delete: + - kinesis:DeregisterStreamConsumer + - kinesis:DescribeStreamConsumer + - kinesis:UntagResource + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + description: The ARN of the AWS Kinesis resource to which the policy applies. + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:aws.*:kinesis:.*:\d{12}:stream/\S+ + anyOf: + - relationshipRef: + typeName: AWS::Kinesis::Stream + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::Kinesis::StreamConsumer + propertyPath: /properties/ConsumerARN + ResourcePolicy: + description: A policy document containing permissions to add to the specified resource. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + type: object + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon resource name (ARN) of the Kinesis stream + type: string + Name: + description: The name of the Kinesis stream. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_.-]+$ + DesiredShardLevelMetrics: + description: The final list of shard-level metrics + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 7 + items: + $ref: '#/components/schemas/EnhancedMetric' + RetentionPeriodHours: + description: The number of hours for the data records that are stored in shards to remain accessible. + type: integer + minimum: 24 + ShardCount: + description: The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed. + type: integer + minimum: 1 + StreamModeDetails: + description: The mode in which the stream is running. + $ref: '#/components/schemas/StreamModeDetails' + default: + StreamMode: PROVISIONED + StreamEncryption: + description: When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. + $ref: '#/components/schemas/StreamEncryption' + Tags: + description: An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream. + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStreamRequest + type: object + required: [] + CreateStreamConsumerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConsumerCreationTimestamp: + description: Timestamp when the consumer was created. + type: string + ConsumerName: + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + description: The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams. + type: string + maxLength: 128 + ConsumerARN: + description: The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN. + type: string + ConsumerStatus: + description: 'A consumer can''t read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE' + type: string + StreamARN: + minLength: 1 + pattern: ^arn:aws.*:kinesis:.*:\d{12}:stream/\S+ + description: The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with. + type: string + maxLength: 2048 + Tags: + maxItems: 50 + uniqueItems: false + description: An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStreamConsumerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: + resource_policies: + name: resource_policies + id: awscc.kinesis.resource_policies + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::Kinesis::ResourcePolicy + x-identifiers: + - ResourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.ResourcePolicy') as resource_policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' streams: name: streams id: awscc.kinesis.streams x-cfn-schema-name: Stream - x-type: list + x-cfn-type-name: AWS::Kinesis::Stream x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Stream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/streams/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.DesiredShardLevelMetrics') as desired_shard_level_metrics, + JSON_EXTRACT(Properties, '$.RetentionPeriodHours') as retention_period_hours, + JSON_EXTRACT(Properties, '$.ShardCount') as shard_count, + JSON_EXTRACT(Properties, '$.StreamModeDetails') as stream_mode_details, + JSON_EXTRACT(Properties, '$.StreamEncryption') as stream_encryption, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::Stream' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DesiredShardLevelMetrics') as desired_shard_level_metrics, + json_extract_path_text(Properties, 'RetentionPeriodHours') as retention_period_hours, + json_extract_path_text(Properties, 'ShardCount') as shard_count, + json_extract_path_text(Properties, 'StreamModeDetails') as stream_mode_details, + json_extract_path_text(Properties, 'StreamEncryption') as stream_encryption, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::Stream' + AND data__Identifier = '' + AND region = 'us-east-1' + streams_list_only: + name: streams_list_only + id: awscc.kinesis.streams_list_only + x-cfn-schema-name: Stream + x-cfn-type-name: AWS::Kinesis::Stream + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -161,44 +1024,387 @@ components: json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::Stream' AND region = 'us-east-1' - kinesis_stream: - name: kinesis_stream - id: awscc.kinesis.kinesis_stream - x-cfn-schema-name: Stream - x-type: get + stream_consumers: + name: stream_consumers + id: awscc.kinesis.stream_consumers + x-cfn-schema-name: StreamConsumer + x-cfn-type-name: AWS::Kinesis::StreamConsumer x-identifiers: - - Name + - ConsumerARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StreamConsumer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::StreamConsumer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Kinesis::StreamConsumer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stream_consumers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stream_consumers/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.StreamModeDetails') as stream_mode_details, - JSON_EXTRACT(Properties, '$.StreamEncryption') as stream_encryption, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.RetentionPeriodHours') as retention_period_hours, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ShardCount') as shard_count - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::Stream' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConsumerCreationTimestamp') as consumer_creation_timestamp, + JSON_EXTRACT(Properties, '$.ConsumerName') as consumer_name, + JSON_EXTRACT(Properties, '$.ConsumerARN') as consumer_arn, + JSON_EXTRACT(Properties, '$.ConsumerStatus') as consumer_status, + JSON_EXTRACT(Properties, '$.StreamARN') as stream_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::StreamConsumer' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'StreamModeDetails') as stream_mode_details, - json_extract_path_text(Properties, 'StreamEncryption') as stream_encryption, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RetentionPeriodHours') as retention_period_hours, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ShardCount') as shard_count - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::Stream' - AND data__Identifier = '' + json_extract_path_text(Properties, 'ConsumerCreationTimestamp') as consumer_creation_timestamp, + json_extract_path_text(Properties, 'ConsumerName') as consumer_name, + json_extract_path_text(Properties, 'ConsumerARN') as consumer_arn, + json_extract_path_text(Properties, 'ConsumerStatus') as consumer_status, + json_extract_path_text(Properties, 'StreamARN') as stream_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::StreamConsumer' + AND data__Identifier = '' + AND region = 'us-east-1' + stream_consumers_list_only: + name: stream_consumers_list_only + id: awscc.kinesis.stream_consumers_list_only + x-cfn-schema-name: StreamConsumer + x-cfn-type-name: AWS::Kinesis::StreamConsumer + x-identifiers: + - ConsumerARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConsumerARN') as consumer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::StreamConsumer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConsumerARN') as consumer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::StreamConsumer' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Stream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StreamConsumer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStreamConsumer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStreamConsumerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kinesisanalyticsv2.yaml b/providers/src/awscc/v00.00.00000/services/kinesisanalyticsv2.yaml index 61b8e10a..81447b15 100644 --- a/providers/src/awscc/v00.00.00000/services/kinesisanalyticsv2.yaml +++ b/providers/src/awscc/v00.00.00000/services/kinesisanalyticsv2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: KinesisAnalyticsV2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: description: The Amazon Resource Name @@ -19,9 +399,15 @@ components: ApplicationCodeConfiguration: description: The code location and type parameters for a Flink-based Kinesis Data Analytics application. $ref: '#/components/schemas/ApplicationCodeConfiguration' + ApplicationEncryptionConfiguration: + description: Describes whether customer managed key is enabled and key details for customer data encryption + $ref: '#/components/schemas/ApplicationEncryptionConfiguration' ApplicationSnapshotConfiguration: description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. $ref: '#/components/schemas/ApplicationSnapshotConfiguration' + ApplicationSystemRollbackConfiguration: + description: Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application. + $ref: '#/components/schemas/ApplicationSystemRollbackConfiguration' EnvironmentProperties: description: Describes execution properties for a Flink-based Kinesis Data Analytics application. $ref: '#/components/schemas/EnvironmentProperties' @@ -130,6 +516,25 @@ components: required: - BucketARN - FileKey + ApplicationEncryptionConfiguration: + description: Describes whether customer managed key is enabled and key details for customer data encryption + type: object + additionalProperties: false + properties: + KeyId: + description: KMS KeyId. Can be either key uuid or full key arn or key alias arn or short key alias + type: string + minLength: 1 + maxLength: 2048 + pattern: ^(?:arn:.*:kms:.*:.*:(?:key\/.*|alias\/.*)|alias\/.*|(?i)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ + KeyType: + description: 'Specifies whether application data is encrypted using service key: AWS_OWNED_KEY or customer key: CUSTOMER_MANAGED_KEY' + type: string + enum: + - AWS_OWNED_KEY + - CUSTOMER_MANAGED_KEY + required: + - KeyType ApplicationSnapshotConfiguration: description: Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. type: object @@ -140,6 +545,16 @@ components: type: boolean required: - SnapshotsEnabled + ApplicationSystemRollbackConfiguration: + description: Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application. + type: object + additionalProperties: false + properties: + RollbackEnabled: + description: Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application. + type: boolean + required: + - RollbackEnabled EnvironmentProperties: description: Describes execution properties for a Flink-based Kinesis Data Analytics application. type: object @@ -710,12 +1125,26 @@ components: - RuntimeEnvironment - ServiceExecutionRole x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html). + x-type-name: AWS::KinesisAnalyticsV2::Application + x-stackql-primary-identifier: - ApplicationName x-create-only-properties: - ApplicationName - ApplicationMode + x-write-only-properties: + - RunConfiguration + - ApplicationConfiguration/EnvironmentProperties + - ApplicationConfiguration/ApplicationCodeConfiguration/CodeContent/ZipFileContent + x-required-properties: - RuntimeEnvironment + - ServiceExecutionRole + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - iam:PassRole @@ -723,9 +1152,14 @@ components: - kinesisanalytics:DescribeApplication - kinesisanalytics:ListTagsForResource - kinesisanalytics:UpdateApplicationMaintenanceConfiguration + - kms:Decrypt + - kms:DescribeKey + - kms:GenerateDataKey + - kms:GenerateDataKeyWithoutPlaintext read: - kinesisanalytics:DescribeApplication - kinesisanalytics:ListTagsForResource + - kms:DescribeKey update: - kinesisanalytics:UpdateApplication - kinesisanalytics:DescribeApplication @@ -735,48 +1169,142 @@ components: - kinesisanalytics:DeleteApplicationVpcConfiguration - kinesisanalytics:UpdateApplicationMaintenanceConfiguration - kinesisanalytics:ListTagsForResource + - kms:CreateGrant + - kms:Decrypt + - kms:DescribeKey + - kms:GenerateDataKey + - kms:GenerateDataKeyWithoutPlaintext delete: - kinesisanalytics:DescribeApplication - kinesisanalytics:DeleteApplication list: - kinesisanalytics:ListApplications + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationConfiguration: + description: Use this parameter to configure the application. + $ref: '#/components/schemas/ApplicationConfiguration' + ApplicationDescription: + description: The description of the application. + type: string + default: '' + minLength: 0 + maxLength: 1024 + ApplicationMode: + description: To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional. + type: string + enum: + - INTERACTIVE + - STREAMING + ApplicationName: + description: The name of the application. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9_.-]+$ + RuntimeEnvironment: + description: The runtime environment for the application. + type: string + ServiceExecutionRole: + description: Specifies the IAM role that the application uses to access external resources. + $ref: '#/components/schemas/Arn' + RunConfiguration: + description: Specifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only. + $ref: '#/components/schemas/RunConfiguration' + ApplicationMaintenanceConfiguration: + description: Used to configure start of maintenance window. + $ref: '#/components/schemas/ApplicationMaintenanceConfiguration' + Tags: + description: A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. + type: array + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.kinesisanalyticsv2.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.kinesisanalyticsv2.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::KinesisAnalyticsV2::Application x-identifiers: - ApplicationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisAnalyticsV2::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisAnalyticsV2::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisAnalyticsV2::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -794,7 +1322,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -811,3 +1339,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' AND data__Identifier = '' AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.kinesisanalyticsv2.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::KinesisAnalyticsV2::Application + x-identifiers: + - ApplicationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kinesisfirehose.yaml b/providers/src/awscc/v00.00.00000/services/kinesisfirehose.yaml index 9649970b..62c9976d 100644 --- a/providers/src/awscc/v00.00.00000/services/kinesisfirehose.yaml +++ b/providers/src/awscc/v00.00.00000/services/kinesisfirehose.yaml @@ -1,408 +1,773 @@ openapi: 3.0.0 info: title: KinesisFirehose - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - DeliveryStreamEncryptionConfigurationInput: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object - additionalProperties: false + CancelResourceRequestOutput: properties: - KeyARN: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - KeyType: + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: type: string - enum: - - AWS_OWNED_CMK - - CUSTOMER_MANAGED_CMK required: - - KeyType - SplunkDestinationConfiguration: + - DesiredState + title: CreateResourceInput type: object - additionalProperties: false + CreateResourceOutput: properties: - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - HECAcknowledgmentTimeoutInSeconds: - type: integer - minimum: 180 - maximum: 600 - HECEndpoint: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: type: string - minLength: 0 - maxLength: 2048 - HECEndpointType: + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: type: string - enum: - - Raw - - Event - HECToken: + TypeName: type: string - minLength: 0 - maxLength: 2048 - ProcessingConfiguration: - $ref: '#/components/schemas/ProcessingConfiguration' - RetryOptions: - $ref: '#/components/schemas/SplunkRetryOptions' - S3BackupMode: + TypeVersionId: type: string - S3Configuration: - $ref: '#/components/schemas/S3DestinationConfiguration' - BufferingHints: - $ref: '#/components/schemas/SplunkBufferingHints' required: - - HECEndpoint - - S3Configuration - - HECToken - - HECEndpointType - HttpEndpointDestinationConfiguration: + - Identifier + title: DeleteResourceInput type: object - additionalProperties: false + DeleteResourceOutput: properties: - RoleARN: - type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - EndpointConfiguration: - $ref: '#/components/schemas/HttpEndpointConfiguration' - RequestConfiguration: - $ref: '#/components/schemas/HttpEndpointRequestConfiguration' - BufferingHints: - $ref: '#/components/schemas/BufferingHints' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - ProcessingConfiguration: - $ref: '#/components/schemas/ProcessingConfiguration' - RetryOptions: - $ref: '#/components/schemas/RetryOptions' - S3BackupMode: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: type: string - S3Configuration: - $ref: '#/components/schemas/S3DestinationConfiguration' + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' required: - - EndpointConfiguration - - S3Configuration - KinesisStreamSourceConfiguration: + - RequestToken + title: GetResourceRequestStatusInput type: object - additionalProperties: false + GetResourceRequestStatusOutput: properties: - KinesisStreamARN: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - RoleARN: + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - required: - - RoleARN - - KinesisStreamARN - MSKSourceConfiguration: type: object - additionalProperties: false + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. properties: - MSKClusterARN: + Identifier: type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - TopicName: + Properties: type: string - minLength: 1 - maxLength: 255 - pattern: '[a-zA-Z0-9\._\-]+' - AuthenticationConfiguration: - $ref: '#/components/schemas/AuthenticationConfiguration' + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' required: - - MSKClusterARN - - TopicName - - AuthenticationConfiguration - AuthenticationConfiguration: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object + schemas: + SnowflakeVpcConfiguration: additionalProperties: false + type: object properties: - RoleARN: + PrivateLinkVpceId: + minLength: 47 + pattern: ([a-zA-Z0-9\-\_]+\.){2,3}vpce\.[a-zA-Z0-9\-]*\.vpce-svc\-[a-zA-Z0-9\-]{17}$ type: string + maxLength: 255 + required: + - PrivateLinkVpceId + CopyCommand: + additionalProperties: false + type: object + properties: + DataTableName: minLength: 1 + type: string maxLength: 512 - pattern: arn:.* - Connectivity: + CopyOptions: + minLength: 0 type: string - enum: - - PUBLIC - - PRIVATE + maxLength: 204800 + DataTableColumns: + minLength: 0 + type: string + maxLength: 204800 required: - - RoleARN - - Connectivity - VpcConfiguration: + - DataTableName + SnowflakeRetryOptions: + additionalProperties: false type: object + properties: + DurationInSeconds: + type: integer + ParquetSerDe: additionalProperties: false + type: object properties: - RoleARN: + Compression: type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - SubnetIds: + BlockSizeBytes: + type: integer + EnableDictionaryCompression: + type: boolean + PageSizeBytes: + type: integer + MaxPaddingBytes: + type: integer + WriterVersion: + type: string + DatabaseColumns: + additionalProperties: false + type: object + properties: + Exclude: type: array - uniqueItems: true items: - type: string - minLength: 1 - maxLength: 1024 - minItems: 1 - maxItems: 16 - SecurityGroupIds: + $ref: '#/components/schemas/DatabaseColumnName' + Include: type: array - uniqueItems: true items: - type: string - minLength: 1 - maxLength: 1024 - minItems: 1 - maxItems: 5 + $ref: '#/components/schemas/DatabaseColumnName' + MSKSourceConfiguration: + additionalProperties: false + type: object + properties: + AuthenticationConfiguration: + $ref: '#/components/schemas/AuthenticationConfiguration' + ReadFromTimestamp: + type: string + MSKClusterARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + TopicName: + minLength: 1 + pattern: '[a-zA-Z0-9\._\-]+' + type: string + maxLength: 255 required: - - RoleARN - - SubnetIds - - SecurityGroupIds - DocumentIdOptions: + - MSKClusterARN + - TopicName + - AuthenticationConfiguration + DirectPutSourceConfiguration: + additionalProperties: false type: object + properties: + ThroughputHintInMBs: + maximum: 100 + type: integer + minimum: 1 + PartitionField: additionalProperties: false + type: object properties: - DefaultDocumentIdFormat: + SourceName: + minLength: 1 type: string - enum: - - FIREHOSE_DEFAULT - - NO_DOCUMENT_ID + maxLength: 255 required: - - DefaultDocumentIdFormat - ExtendedS3DestinationConfiguration: + - SourceName + AmazonOpenSearchServerlessBufferingHints: + additionalProperties: false type: object + properties: + IntervalInSeconds: + type: integer + SizeInMBs: + type: integer + VpcEndpointServiceName: + minLength: 47 + pattern: ([a-zA-Z0-9\-\_]+\.){2,3}vpce\.[a-zA-Z0-9\-]*\.vpce-svc\-[a-zA-Z0-9\-]{17}$ + type: string + maxLength: 255 + SnowflakeDestinationConfiguration: additionalProperties: false + type: object properties: - BucketARN: + PrivateKey: + minLength: 256 + pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$ type: string + maxLength: 4096 + User: minLength: 1 - maxLength: 2048 - pattern: arn:.* - BufferingHints: - $ref: '#/components/schemas/BufferingHints' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - CompressionFormat: type: string - enum: - - UNCOMPRESSED - - GZIP - - ZIP - - Snappy - - HADOOP_SNAPPY - CustomTimeZone: + maxLength: 255 + Table: + minLength: 1 type: string - minLength: 0 - maxLength: 50 - DataFormatConversionConfiguration: - $ref: '#/components/schemas/DataFormatConversionConfiguration' - DynamicPartitioningConfiguration: - $ref: '#/components/schemas/DynamicPartitioningConfiguration' - EncryptionConfiguration: - $ref: '#/components/schemas/EncryptionConfiguration' - ErrorOutputPrefix: + maxLength: 255 + SnowflakeVpcConfiguration: + $ref: '#/components/schemas/SnowflakeVpcConfiguration' + DataLoadingOption: type: string - minLength: 0 - maxLength: 1024 - FileExtension: + enum: + - JSON_MAPPING + - VARIANT_CONTENT_MAPPING + - VARIANT_CONTENT_AND_METADATA_MAPPING + Schema: + minLength: 1 type: string - minLength: 0 - maxLength: 128 - pattern: ^$|\.[0-9a-z!\-_.*'()]+ - Prefix: + maxLength: 255 + ContentColumnName: + minLength: 1 type: string - minLength: 0 - maxLength: 1024 + maxLength: 255 + SecretsManagerConfiguration: + $ref: '#/components/schemas/SecretsManagerConfiguration' + SnowflakeRoleConfiguration: + $ref: '#/components/schemas/SnowflakeRoleConfiguration' ProcessingConfiguration: $ref: '#/components/schemas/ProcessingConfiguration' - RoleARN: + AccountUrl: + minLength: 24 + pattern: .+?\.snowflakecomputing\.com type: string + maxLength: 2048 + RoleARN: minLength: 1 - maxLength: 512 pattern: arn:.* - S3BackupConfiguration: - $ref: '#/components/schemas/S3DestinationConfiguration' + type: string + maxLength: 512 S3BackupMode: type: string enum: - - Disabled - - Enabled + - FailedDataOnly + - AllData + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + BufferingHints: + $ref: '#/components/schemas/SnowflakeBufferingHints' + MetaDataColumnName: + minLength: 1 + type: string + maxLength: 255 + Database: + minLength: 1 + type: string + maxLength: 255 + RetryOptions: + $ref: '#/components/schemas/SnowflakeRetryOptions' + KeyPassphrase: + minLength: 7 + type: string + maxLength: 255 + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' required: - - BucketARN + - AccountUrl + - Database + - Schema + - Table - RoleARN - S3DestinationConfiguration: + - S3Configuration + AmazonOpenSearchServerlessRetryOptions: + additionalProperties: false type: object + properties: + DurationInSeconds: + type: integer + OrcSerDe: additionalProperties: false + type: object properties: - BucketARN: - type: string - minLength: 1 - maxLength: 2048 - pattern: arn:.* - BufferingHints: - $ref: '#/components/schemas/BufferingHints' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - CompressionFormat: + PaddingTolerance: + type: number + Compression: type: string - enum: - - UNCOMPRESSED - - GZIP - - ZIP - - Snappy - - HADOOP_SNAPPY - EncryptionConfiguration: - $ref: '#/components/schemas/EncryptionConfiguration' - ErrorOutputPrefix: + StripeSizeBytes: + type: integer + BloomFilterColumns: + uniqueItems: true + type: array + items: + type: string + BloomFilterFalsePositiveProbability: + type: number + EnablePadding: + type: boolean + FormatVersion: type: string - minLength: 0 - maxLength: 1024 - Prefix: + RowIndexStride: + type: integer + BlockSizeBytes: + type: integer + DictionaryKeyThreshold: + type: number + SnowflakeBufferingHints: + additionalProperties: false + type: object + properties: + IntervalInSeconds: + type: integer + SizeInMBs: + type: integer + ProcessorParameter: + additionalProperties: false + type: object + properties: + ParameterValue: + anyOf: + - relationshipRef: + typeName: AWS::Lambda::Function + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::IAM::Role + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::Lambda::Alias + propertyPath: /properties/Id type: string - minLength: 0 - maxLength: 1024 - RoleARN: + ParameterName: type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* required: - - BucketARN - - RoleARN - RedshiftDestinationConfiguration: + - ParameterValue + - ParameterName + HiveJsonSerDe: + additionalProperties: false type: object + properties: + TimestampFormats: + uniqueItems: true + type: array + items: + type: string + SchemaEvolutionConfiguration: additionalProperties: false + type: object properties: - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - ClusterJDBCURL: - type: string - minLength: 1 - maxLength: 512 - CopyCommand: - $ref: '#/components/schemas/CopyCommand' - Password: - type: string - minLength: 6 - maxLength: 512 + Enabled: + type: boolean + SplunkBufferingHints: + additionalProperties: false + type: object + properties: + IntervalInSeconds: + type: integer + SizeInMBs: + type: integer + Serializer: + additionalProperties: false + type: object + properties: + OrcSerDe: + $ref: '#/components/schemas/OrcSerDe' + ParquetSerDe: + $ref: '#/components/schemas/ParquetSerDe' + HttpEndpointDestinationConfiguration: + additionalProperties: false + type: object + properties: + RequestConfiguration: + $ref: '#/components/schemas/HttpEndpointRequestConfiguration' + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + BufferingHints: + $ref: '#/components/schemas/BufferingHints' + RetryOptions: + $ref: '#/components/schemas/RetryOptions' + SecretsManagerConfiguration: + $ref: '#/components/schemas/SecretsManagerConfiguration' + EndpointConfiguration: + $ref: '#/components/schemas/HttpEndpointConfiguration' ProcessingConfiguration: $ref: '#/components/schemas/ProcessingConfiguration' - RetryOptions: - $ref: '#/components/schemas/RedshiftRetryOptions' RoleARN: - type: string minLength: 1 - maxLength: 512 pattern: arn:.* - S3BackupConfiguration: - $ref: '#/components/schemas/S3DestinationConfiguration' - S3BackupMode: - type: string - enum: - - Disabled - - Enabled - S3Configuration: - $ref: '#/components/schemas/S3DestinationConfiguration' - Username: type: string - minLength: 1 maxLength: 512 + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' + S3BackupMode: + type: string required: + - EndpointConfiguration - S3Configuration - - Username - - ClusterJDBCURL - - CopyCommand - - RoleARN - - Password - ElasticsearchDestinationConfiguration: - type: object + KinesisStreamSourceConfiguration: additionalProperties: false + type: object properties: - BufferingHints: - $ref: '#/components/schemas/ElasticsearchBufferingHints' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - DomainARN: - type: string + KinesisStreamARN: minLength: 1 - maxLength: 512 pattern: arn:.* - IndexName: type: string + maxLength: 512 + RoleARN: minLength: 1 - maxLength: 80 - IndexRotationPeriod: - type: string - enum: - - NoRotation - - OneHour - - OneDay - - OneWeek - - OneMonth - ProcessingConfiguration: - $ref: '#/components/schemas/ProcessingConfiguration' - RetryOptions: - $ref: '#/components/schemas/ElasticsearchRetryOptions' - RoleARN: - type: string - minLength: 1 - maxLength: 512 pattern: arn:.* - S3BackupMode: type: string - enum: - - FailedDocumentsOnly - - AllDocuments - S3Configuration: - $ref: '#/components/schemas/S3DestinationConfiguration' - ClusterEndpoint: - type: string - minLength: 1 maxLength: 512 - pattern: https:.* - TypeName: - type: string - minLength: 0 - maxLength: 100 - VpcConfiguration: - $ref: '#/components/schemas/VpcConfiguration' - DocumentIdOptions: - $ref: '#/components/schemas/DocumentIdOptions' required: - - IndexName - - S3Configuration - RoleARN - AmazonopensearchserviceDestinationConfiguration: + - KinesisStreamARN + DataFormatConversionConfiguration: + additionalProperties: false + type: object + properties: + InputFormatConfiguration: + $ref: '#/components/schemas/InputFormatConfiguration' + Enabled: + type: boolean + SchemaConfiguration: + $ref: '#/components/schemas/SchemaConfiguration' + OutputFormatConfiguration: + $ref: '#/components/schemas/OutputFormatConfiguration' + ElasticsearchRetryOptions: + additionalProperties: false type: object + properties: + DurationInSeconds: + type: integer + DatabaseName: + minLength: 1 + pattern: '[\u0001-\uFFFF]*' + type: string + maxLength: 64 + HttpEndpointCommonAttribute: additionalProperties: false + type: object properties: - BufferingHints: - $ref: '#/components/schemas/AmazonopensearchserviceBufferingHints' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - DomainARN: + AttributeValue: + minLength: 0 type: string + maxLength: 1024 + AttributeName: minLength: 1 - maxLength: 512 - pattern: arn:.* - IndexName: type: string - minLength: 1 - maxLength: 80 + maxLength: 256 + required: + - AttributeName + - AttributeValue + AmazonopensearchserviceDestinationConfiguration: + additionalProperties: false + type: object + properties: + TypeName: + minLength: 0 + type: string + maxLength: 100 IndexRotationPeriod: type: string enum: @@ -413,592 +778,928 @@ components: - OneMonth ProcessingConfiguration: $ref: '#/components/schemas/ProcessingConfiguration' - RetryOptions: - $ref: '#/components/schemas/AmazonopensearchserviceRetryOptions' - RoleARN: - type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - S3BackupMode: - type: string - enum: - - FailedDocumentsOnly - - AllDocuments - S3Configuration: - $ref: '#/components/schemas/S3DestinationConfiguration' ClusterEndpoint: - type: string minLength: 1 - maxLength: 512 pattern: https:.* - TypeName: - type: string - minLength: 0 - maxLength: 100 - VpcConfiguration: - $ref: '#/components/schemas/VpcConfiguration' - DocumentIdOptions: - $ref: '#/components/schemas/DocumentIdOptions' - required: - - IndexName - - S3Configuration - - RoleARN - AmazonOpenSearchServerlessDestinationConfiguration: - type: object - additionalProperties: false - properties: - BufferingHints: - $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingHints' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' - IndexName: type: string + maxLength: 512 + DomainARN: minLength: 1 - maxLength: 80 - ProcessingConfiguration: - $ref: '#/components/schemas/ProcessingConfiguration' - RetryOptions: - $ref: '#/components/schemas/AmazonOpenSearchServerlessRetryOptions' - RoleARN: + pattern: arn:.* type: string - minLength: 1 maxLength: 512 + RoleARN: + minLength: 1 pattern: arn:.* + type: string + maxLength: 512 S3BackupMode: type: string enum: - FailedDocumentsOnly - AllDocuments + IndexName: + minLength: 1 + type: string + maxLength: 80 + DocumentIdOptions: + $ref: '#/components/schemas/DocumentIdOptions' S3Configuration: $ref: '#/components/schemas/S3DestinationConfiguration' - CollectionEndpoint: - type: string - minLength: 1 - maxLength: 512 - pattern: https:.* + BufferingHints: + $ref: '#/components/schemas/AmazonopensearchserviceBufferingHints' + RetryOptions: + $ref: '#/components/schemas/AmazonopensearchserviceRetryOptions' VpcConfiguration: $ref: '#/components/schemas/VpcConfiguration' + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' required: - IndexName - S3Configuration - RoleARN - SnowflakeDestinationConfiguration: - type: object + SplunkDestinationConfiguration: additionalProperties: false + type: object properties: - AccountUrl: + HECEndpoint: + minLength: 0 type: string - minLength: 24 maxLength: 2048 - pattern: .+?\.snowflakecomputing\.com - PrivateKey: - type: string - minLength: 256 - maxLength: 4096 - pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$ - KeyPassphrase: - type: string - minLength: 7 - maxLength: 255 - User: - type: string - minLength: 1 - maxLength: 255 - Database: - type: string - minLength: 1 - maxLength: 255 - Schema: - type: string - minLength: 1 - maxLength: 255 - Table: + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + BufferingHints: + $ref: '#/components/schemas/SplunkBufferingHints' + HECToken: + minLength: 0 type: string - minLength: 1 - maxLength: 255 - SnowflakeRoleConfiguration: - $ref: '#/components/schemas/SnowflakeRoleConfiguration' - DataLoadingOption: + maxLength: 2048 + RetryOptions: + $ref: '#/components/schemas/SplunkRetryOptions' + HECEndpointType: type: string enum: - - JSON_MAPPING - - VARIANT_CONTENT_MAPPING - - VARIANT_CONTENT_AND_METADATA_MAPPING - MetaDataColumnName: - type: string - minLength: 1 - maxLength: 255 - ContentColumnName: - type: string - minLength: 1 - maxLength: 255 - SnowflakeVpcConfiguration: - $ref: '#/components/schemas/SnowflakeVpcConfiguration' - CloudWatchLoggingOptions: - $ref: '#/components/schemas/CloudWatchLoggingOptions' + - Raw + - Event + SecretsManagerConfiguration: + $ref: '#/components/schemas/SecretsManagerConfiguration' + HECAcknowledgmentTimeoutInSeconds: + maximum: 600 + type: integer + minimum: 180 ProcessingConfiguration: $ref: '#/components/schemas/ProcessingConfiguration' - RoleARN: - type: string - minLength: 1 - maxLength: 512 - pattern: arn:.* - RetryOptions: - $ref: '#/components/schemas/SnowflakeRetryOptions' + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' S3BackupMode: type: string - enum: - - FailedDataOnly - - AllData - S3Configuration: - $ref: '#/components/schemas/S3DestinationConfiguration' required: - - AccountUrl - - PrivateKey - - User - - Database - - Schema - - Table - - RoleARN + - HECEndpoint - S3Configuration - BufferingHints: - type: object - additionalProperties: false - properties: - IntervalInSeconds: - type: integer - SizeInMBs: - type: integer + - HECEndpointType ProcessingConfiguration: - type: object additionalProperties: false + type: object properties: Enabled: type: boolean Processors: - type: array uniqueItems: true + type: array items: $ref: '#/components/schemas/Processor' - SplunkRetryOptions: - type: object + DocumentIdOptions: additionalProperties: false + type: object properties: - DurationInSeconds: - type: integer - ElasticsearchRetryOptions: + DefaultDocumentIdFormat: + type: string + enum: + - FIREHOSE_DEFAULT + - NO_DOCUMENT_ID + required: + - DefaultDocumentIdFormat + Deserializer: + additionalProperties: false type: object + properties: + HiveJsonSerDe: + $ref: '#/components/schemas/HiveJsonSerDe' + OpenXJsonSerDe: + $ref: '#/components/schemas/OpenXJsonSerDe' + S3DestinationConfiguration: additionalProperties: false + type: object properties: - DurationInSeconds: - type: integer + ErrorOutputPrefix: + minLength: 0 + type: string + maxLength: 1024 + BucketARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 2048 + BufferingHints: + $ref: '#/components/schemas/BufferingHints' + CompressionFormat: + type: string + enum: + - UNCOMPRESSED + - GZIP + - ZIP + - Snappy + - HADOOP_SNAPPY + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + Prefix: + minLength: 0 + type: string + maxLength: 1024 + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' + RoleARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + required: + - BucketARN + - RoleARN AmazonopensearchserviceRetryOptions: - type: object additionalProperties: false + type: object properties: DurationInSeconds: type: integer - AmazonOpenSearchServerlessRetryOptions: + InputFormatConfiguration: + additionalProperties: false type: object + properties: + Deserializer: + $ref: '#/components/schemas/Deserializer' + VpcConfiguration: additionalProperties: false + type: object properties: - DurationInSeconds: - type: integer - SnowflakeRetryOptions: + SubnetIds: + minItems: 1 + maxItems: 16 + uniqueItems: true + type: array + items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + minLength: 1 + type: string + maxLength: 1024 + SecurityGroupIds: + minItems: 1 + maxItems: 5 + uniqueItems: true + type: array + items: + relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + minLength: 1 + type: string + maxLength: 1024 + RoleARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + required: + - RoleARN + - SubnetIds + - SecurityGroupIds + OutputFormatConfiguration: + additionalProperties: false type: object + properties: + Serializer: + $ref: '#/components/schemas/Serializer' + CloudWatchLoggingOptions: additionalProperties: false + type: object properties: - DurationInSeconds: - type: integer + LogStreamName: + type: string + Enabled: + type: boolean + LogGroupName: + type: string RedshiftRetryOptions: - type: object additionalProperties: false + type: object properties: DurationInSeconds: type: integer - RetryOptions: - type: object + DatabaseColumnName: + minLength: 1 + pattern: '[\u0001-\uFFFF]*' + type: string + maxLength: 194 + ElasticsearchBufferingHints: additionalProperties: false + type: object properties: - DurationInSeconds: + IntervalInSeconds: type: integer - DataFormatConversionConfiguration: + SizeInMBs: + type: integer + Processor: + additionalProperties: false type: object + properties: + Type: + type: string + enum: + - RecordDeAggregation + - Decompression + - CloudWatchLogProcessing + - Lambda + - MetadataExtraction + - AppendDelimiterToRecord + Parameters: + uniqueItems: true + type: array + items: + $ref: '#/components/schemas/ProcessorParameter' + required: + - Type + TableCreationConfiguration: additionalProperties: false + type: object properties: Enabled: type: boolean - InputFormatConfiguration: - $ref: '#/components/schemas/InputFormatConfiguration' - OutputFormatConfiguration: - $ref: '#/components/schemas/OutputFormatConfiguration' - SchemaConfiguration: - $ref: '#/components/schemas/SchemaConfiguration' - DynamicPartitioningConfiguration: - type: object + RedshiftDestinationConfiguration: additionalProperties: false + type: object properties: - Enabled: - type: boolean + S3BackupConfiguration: + $ref: '#/components/schemas/S3DestinationConfiguration' + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + Username: + minLength: 1 + type: string + maxLength: 512 + CopyCommand: + $ref: '#/components/schemas/CopyCommand' RetryOptions: - $ref: '#/components/schemas/RetryOptions' - CopyCommand: + $ref: '#/components/schemas/RedshiftRetryOptions' + SecretsManagerConfiguration: + $ref: '#/components/schemas/SecretsManagerConfiguration' + ProcessingConfiguration: + $ref: '#/components/schemas/ProcessingConfiguration' + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' + ClusterJDBCURL: + minLength: 1 + type: string + maxLength: 512 + RoleARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + Password: + minLength: 6 + type: string + maxLength: 512 + S3BackupMode: + type: string + enum: + - Disabled + - Enabled + required: + - S3Configuration + - ClusterJDBCURL + - CopyCommand + - RoleARN + SchemaConfiguration: + additionalProperties: false type: object + properties: + VersionId: + type: string + TableName: + type: string + DatabaseName: + type: string + Region: + type: string + CatalogId: + type: string + RoleARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + ExtendedS3DestinationConfiguration: additionalProperties: false + type: object properties: - CopyOptions: + ErrorOutputPrefix: + minLength: 0 + type: string + maxLength: 1024 + S3BackupConfiguration: + $ref: '#/components/schemas/S3DestinationConfiguration' + BucketARN: + minLength: 1 + pattern: arn:.* type: string + maxLength: 2048 + CompressionFormat: + type: string + enum: + - UNCOMPRESSED + - GZIP + - ZIP + - Snappy + - HADOOP_SNAPPY + DataFormatConversionConfiguration: + $ref: '#/components/schemas/DataFormatConversionConfiguration' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + CustomTimeZone: minLength: 0 - maxLength: 204800 - DataTableColumns: type: string + maxLength: 50 + DynamicPartitioningConfiguration: + $ref: '#/components/schemas/DynamicPartitioningConfiguration' + Prefix: minLength: 0 - maxLength: 204800 - DataTableName: type: string + maxLength: 1024 + ProcessingConfiguration: + $ref: '#/components/schemas/ProcessingConfiguration' + RoleARN: minLength: 1 + pattern: arn:.* + type: string maxLength: 512 + S3BackupMode: + type: string + enum: + - Disabled + - Enabled + BufferingHints: + $ref: '#/components/schemas/BufferingHints' + FileExtension: + minLength: 0 + pattern: ^$|\.[0-9a-z!\-_.*'()]+ + type: string + maxLength: 128 + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' required: - - DataTableName - EncryptionConfiguration: - type: object + - BucketARN + - RoleARN + AmazonOpenSearchServerlessDestinationConfiguration: additionalProperties: false + type: object properties: - KMSEncryptionConfig: - $ref: '#/components/schemas/KMSEncryptionConfig' - NoEncryptionConfig: + IndexName: + minLength: 1 + type: string + maxLength: 80 + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + BufferingHints: + $ref: '#/components/schemas/AmazonOpenSearchServerlessBufferingHints' + RetryOptions: + $ref: '#/components/schemas/AmazonOpenSearchServerlessRetryOptions' + CollectionEndpoint: + minLength: 1 + pattern: https:.* + type: string + maxLength: 512 + VpcConfiguration: + $ref: '#/components/schemas/VpcConfiguration' + ProcessingConfiguration: + $ref: '#/components/schemas/ProcessingConfiguration' + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' + RoleARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + S3BackupMode: type: string enum: - - NoEncryption - ElasticsearchBufferingHints: - type: object + - FailedDocumentsOnly + - AllDocuments + required: + - IndexName + - S3Configuration + - RoleARN + KMSEncryptionConfig: additionalProperties: false - properties: - IntervalInSeconds: - type: integer - SizeInMBs: - type: integer - AmazonopensearchserviceBufferingHints: type: object - additionalProperties: false properties: - IntervalInSeconds: - type: integer - SizeInMBs: - type: integer - AmazonOpenSearchServerlessBufferingHints: - type: object + AWSKMSKeyARN: + type: string + required: + - AWSKMSKeyARN + Databases: additionalProperties: false - properties: - IntervalInSeconds: - type: integer - SizeInMBs: - type: integer - SplunkBufferingHints: type: object - additionalProperties: false properties: - IntervalInSeconds: - type: integer - SizeInMBs: - type: integer - CloudWatchLoggingOptions: - type: object + Exclude: + type: array + items: + $ref: '#/components/schemas/DatabaseName' + Include: + type: array + items: + $ref: '#/components/schemas/DatabaseName' + DestinationTableConfigurationList: + type: array + items: + $ref: '#/components/schemas/DestinationTableConfiguration' + DatabaseSourceConfiguration: additionalProperties: false + type: object properties: - Enabled: - type: boolean - LogGroupName: + Digest: + minLength: 1 + pattern: .* type: string - LogStreamName: + maxLength: 512 + Port: + maximum: 65535 + type: integer + minimum: 0 + PublicCertificate: + minLength: 1 + pattern: .* type: string - OutputFormatConfiguration: - type: object - additionalProperties: false - properties: - Serializer: - $ref: '#/components/schemas/Serializer' - Processor: - type: object - additionalProperties: false - properties: - Parameters: + maxLength: 4096 + Columns: + $ref: '#/components/schemas/DatabaseColumns' + Type: + type: string + enum: + - MySQL + - PostgreSQL + SurrogateKeys: type: array - uniqueItems: true items: - $ref: '#/components/schemas/ProcessorParameter' - Type: + minLength: 1 + pattern: ^\S+$ + type: string + maxLength: 1024 + Databases: + $ref: '#/components/schemas/Databases' + Endpoint: + minLength: 1 + pattern: ^(?!\s*$).+ + type: string + maxLength: 255 + SSLMode: type: string enum: - - RecordDeAggregation - - Decompression - - CloudWatchLogProcessing - - Lambda - - MetadataExtraction - - AppendDelimiterToRecord + - Disabled + - Enabled + SnapshotWatermarkTable: + $ref: '#/components/schemas/DatabaseTableName' + DatabaseSourceAuthenticationConfiguration: + $ref: '#/components/schemas/DatabaseSourceAuthenticationConfiguration' + Tables: + $ref: '#/components/schemas/DatabaseTables' + DatabaseSourceVPCConfiguration: + $ref: '#/components/schemas/DatabaseSourceVPCConfiguration' required: - Type - KMSEncryptionConfig: - type: object + - Endpoint + - Port + - Databases + - Tables + - SnapshotWatermarkTable + - DatabaseSourceAuthenticationConfiguration + - DatabaseSourceVPCConfiguration + DestinationTableConfiguration: additionalProperties: false + type: object properties: - AWSKMSKeyARN: + DestinationDatabaseName: + minLength: 1 + type: string + maxLength: 512 + S3ErrorOutputPrefix: + minLength: 1 type: string + maxLength: 1024 + DestinationTableName: + minLength: 1 + type: string + maxLength: 512 + UniqueKeys: + uniqueItems: true + type: array + items: + $ref: '#/components/schemas/UniqueKey' + PartitionSpec: + additionalProperties: false + type: object + properties: + Identity: + uniqueItems: true + type: array + items: + $ref: '#/components/schemas/PartitionField' required: - - AWSKMSKeyARN - InputFormatConfiguration: - type: object - additionalProperties: false - properties: - Deserializer: - $ref: '#/components/schemas/Deserializer' - SchemaConfiguration: - type: object + - DestinationDatabaseName + - DestinationTableName + AuthenticationConfiguration: additionalProperties: false + type: object properties: - CatalogId: - type: string - DatabaseName: - type: string - Region: + Connectivity: type: string + enum: + - PUBLIC + - PRIVATE RoleARN: - type: string minLength: 1 + pattern: arn:.* + type: string maxLength: 512 + required: + - RoleARN + - Connectivity + CatalogConfiguration: + additionalProperties: false + type: object + properties: + CatalogArn: + minLength: 1 pattern: arn:.* - TableName: type: string - VersionId: + maxLength: 512 + WarehouseLocation: + minLength: 1 + pattern: s3:\/\/.* type: string - Serializer: - type: object + maxLength: 2048 + DeliveryStreamEncryptionConfigurationInput: additionalProperties: false - properties: - OrcSerDe: - $ref: '#/components/schemas/OrcSerDe' - ParquetSerDe: - $ref: '#/components/schemas/ParquetSerDe' - ProcessorParameter: type: object - additionalProperties: false properties: - ParameterName: + KeyType: type: string - ParameterValue: + enum: + - AWS_OWNED_CMK + - CUSTOMER_MANAGED_CMK + KeyARN: + minLength: 1 + pattern: arn:.* type: string + maxLength: 512 required: - - ParameterValue - - ParameterName - Deserializer: - type: object + - KeyType + HttpEndpointRequestConfiguration: additionalProperties: false - properties: - HiveJsonSerDe: - $ref: '#/components/schemas/HiveJsonSerDe' - OpenXJsonSerDe: - $ref: '#/components/schemas/OpenXJsonSerDe' - HiveJsonSerDe: type: object - additionalProperties: false properties: - TimestampFormats: - type: array + CommonAttributes: + minItems: 0 + maxItems: 50 uniqueItems: true + type: array items: - type: string - OrcSerDe: + $ref: '#/components/schemas/HttpEndpointCommonAttribute' + ContentEncoding: + type: string + enum: + - NONE + - GZIP + EncryptionConfiguration: + additionalProperties: false type: object + properties: + KMSEncryptionConfig: + $ref: '#/components/schemas/KMSEncryptionConfig' + NoEncryptionConfig: + type: string + enum: + - NoEncryption + IcebergDestinationConfiguration: additionalProperties: false + type: object properties: - BlockSizeBytes: - type: integer - BloomFilterColumns: - type: array - uniqueItems: true - items: - type: string - BloomFilterFalsePositiveProbability: - type: number - Compression: + CatalogConfiguration: + $ref: '#/components/schemas/CatalogConfiguration' + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + DestinationTableConfigurationList: + $ref: '#/components/schemas/DestinationTableConfigurationList' + BufferingHints: + $ref: '#/components/schemas/BufferingHints' + TableCreationConfiguration: + $ref: '#/components/schemas/TableCreationConfiguration' + RetryOptions: + $ref: '#/components/schemas/RetryOptions' + s3BackupMode: type: string - DictionaryKeyThreshold: - type: number - EnablePadding: + enum: + - AllData + - FailedDataOnly + ProcessingConfiguration: + $ref: '#/components/schemas/ProcessingConfiguration' + SchemaEvolutionConfiguration: + $ref: '#/components/schemas/SchemaEvolutionConfiguration' + AppendOnly: type: boolean - FormatVersion: + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' + RoleARN: + minLength: 1 + pattern: arn:.* type: string - PaddingTolerance: - type: number - RowIndexStride: - type: integer - StripeSizeBytes: - type: integer - ParquetSerDe: + maxLength: 512 + required: + - RoleARN + - CatalogConfiguration + - S3Configuration + HttpEndpointConfiguration: + additionalProperties: false type: object + properties: + AccessKey: + minLength: 0 + type: string + maxLength: 4096 + Url: + minLength: 1 + type: string + maxLength: 1000 + Name: + minLength: 1 + type: string + maxLength: 256 + required: + - Url + SecretsManagerConfiguration: additionalProperties: false + type: object properties: - BlockSizeBytes: - type: integer - Compression: + SecretARN: + minLength: 1 + pattern: arn:.*:secretsmanager:[a-zA-Z0-9\-]+:\d{12}:secret:[a-zA-Z0-9\-/_+=.@]+ type: string - EnableDictionaryCompression: + maxLength: 2048 + Enabled: type: boolean - MaxPaddingBytes: - type: integer - PageSizeBytes: - type: integer - WriterVersion: + RoleARN: + minLength: 1 + pattern: arn:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+ type: string - OpenXJsonSerDe: - type: object + maxLength: 512 + required: + - Enabled + DynamicPartitioningConfiguration: additionalProperties: false + type: object properties: - CaseInsensitive: - type: boolean - ColumnToJsonKeyMappings: - type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - ConvertDotsInJsonKeysToUnderscores: + Enabled: type: boolean - HttpEndpointRequestConfiguration: - type: object + RetryOptions: + $ref: '#/components/schemas/RetryOptions' + SnowflakeRoleConfiguration: additionalProperties: false + type: object properties: - ContentEncoding: + SnowflakeRole: + minLength: 1 type: string - enum: - - NONE - - GZIP - CommonAttributes: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/HttpEndpointCommonAttribute' - minItems: 0 - maxItems: 50 - HttpEndpointCommonAttribute: - type: object + maxLength: 255 + Enabled: + type: boolean + DatabaseTableName: + minLength: 1 + pattern: '[\u0001-\uFFFF]*' + type: string + maxLength: 129 + ElasticsearchDestinationConfiguration: additionalProperties: false + type: object properties: - AttributeName: + TypeName: + minLength: 0 + type: string + maxLength: 100 + IndexRotationPeriod: + type: string + enum: + - NoRotation + - OneHour + - OneDay + - OneWeek + - OneMonth + ProcessingConfiguration: + $ref: '#/components/schemas/ProcessingConfiguration' + ClusterEndpoint: + minLength: 1 + pattern: https:.* type: string + maxLength: 512 + DomainARN: minLength: 1 - maxLength: 256 - AttributeValue: + pattern: arn:.* + anyOf: + - relationshipRef: + typeName: AWS::Elasticsearch::Domain + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::OpenSearchService::Domain + propertyPath: /properties/Arn type: string - minLength: 0 - maxLength: 1024 + maxLength: 512 + RoleARN: + minLength: 1 + pattern: arn:.* + type: string + maxLength: 512 + S3BackupMode: + type: string + enum: + - FailedDocumentsOnly + - AllDocuments + IndexName: + minLength: 1 + type: string + maxLength: 80 + DocumentIdOptions: + $ref: '#/components/schemas/DocumentIdOptions' + S3Configuration: + $ref: '#/components/schemas/S3DestinationConfiguration' + BufferingHints: + $ref: '#/components/schemas/ElasticsearchBufferingHints' + RetryOptions: + $ref: '#/components/schemas/ElasticsearchRetryOptions' + VpcConfiguration: + $ref: '#/components/schemas/VpcConfiguration' + CloudWatchLoggingOptions: + $ref: '#/components/schemas/CloudWatchLoggingOptions' + required: + - IndexName + - S3Configuration + - RoleARN + DatabaseSourceAuthenticationConfiguration: + additionalProperties: false + type: object + properties: + SecretsManagerConfiguration: + $ref: '#/components/schemas/SecretsManagerConfiguration' required: - - AttributeName - - AttributeValue - HttpEndpointConfiguration: + - SecretsManagerConfiguration + BufferingHints: + additionalProperties: false type: object + properties: + IntervalInSeconds: + type: integer + SizeInMBs: + type: integer + UniqueKey: + minLength: 1 + type: string + maxLength: 512 + AmazonopensearchserviceBufferingHints: additionalProperties: false + type: object properties: - Url: - type: string - minLength: 1 - maxLength: 1000 - AccessKey: - type: string - minLength: 0 - maxLength: 4096 - Name: - type: string - minLength: 1 - maxLength: 256 - required: - - Url - SnowflakeRoleConfiguration: + IntervalInSeconds: + type: integer + SizeInMBs: + type: integer + SplunkRetryOptions: + additionalProperties: false type: object + properties: + DurationInSeconds: + type: integer + DatabaseTables: additionalProperties: false + type: object properties: - Enabled: - type: boolean - SnowflakeRole: - type: string - minLength: 1 - maxLength: 255 - SnowflakeVpcConfiguration: + Exclude: + type: array + items: + $ref: '#/components/schemas/DatabaseTableName' + Include: + type: array + items: + $ref: '#/components/schemas/DatabaseTableName' + RetryOptions: + additionalProperties: false type: object + properties: + DurationInSeconds: + type: integer + DatabaseSourceVPCConfiguration: additionalProperties: false + type: object properties: - PrivateLinkVpceId: - type: string - minLength: 47 - maxLength: 255 - pattern: ([a-zA-Z0-9\-\_]+\.){2,3}vpce\.[a-zA-Z0-9\-]*\.vpce-svc\-[a-zA-Z0-9\-]{17}$ + VpcEndpointServiceName: + $ref: '#/components/schemas/VpcEndpointServiceName' required: - - PrivateLinkVpceId + - VpcEndpointServiceName Tag: - type: object additionalProperties: false + type: object properties: - Key: - type: string - pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$ - minLength: 1 - maxLength: 128 Value: - type: string - pattern: ^[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$ minLength: 0 + pattern: ^[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$ + type: string maxLength: 256 + Key: + minLength: 1 + pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$ + type: string + maxLength: 128 required: - Key + OpenXJsonSerDe: + additionalProperties: false + type: object + properties: + ConvertDotsInJsonKeysToUnderscores: + type: boolean + ColumnToJsonKeyMappings: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + additionalProperties: false + type: object + CaseInsensitive: + type: boolean DeliveryStream: type: object properties: - Arn: - type: string DeliveryStreamEncryptionConfigurationInput: $ref: '#/components/schemas/DeliveryStreamEncryptionConfigurationInput' - DeliveryStreamName: - type: string - minLength: 1 - maxLength: 64 - pattern: '[a-zA-Z0-9._-]+' + HttpEndpointDestinationConfiguration: + $ref: '#/components/schemas/HttpEndpointDestinationConfiguration' + KinesisStreamSourceConfiguration: + $ref: '#/components/schemas/KinesisStreamSourceConfiguration' DeliveryStreamType: type: string enum: + - DatabaseAsSource - DirectPut - KinesisStreamAsSource - MSKAsSource - ElasticsearchDestinationConfiguration: - $ref: '#/components/schemas/ElasticsearchDestinationConfiguration' + IcebergDestinationConfiguration: + $ref: '#/components/schemas/IcebergDestinationConfiguration' + RedshiftDestinationConfiguration: + $ref: '#/components/schemas/RedshiftDestinationConfiguration' AmazonopensearchserviceDestinationConfiguration: $ref: '#/components/schemas/AmazonopensearchserviceDestinationConfiguration' - AmazonOpenSearchServerlessDestinationConfiguration: - $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationConfiguration' - ExtendedS3DestinationConfiguration: - $ref: '#/components/schemas/ExtendedS3DestinationConfiguration' - KinesisStreamSourceConfiguration: - $ref: '#/components/schemas/KinesisStreamSourceConfiguration' MSKSourceConfiguration: $ref: '#/components/schemas/MSKSourceConfiguration' - RedshiftDestinationConfiguration: - $ref: '#/components/schemas/RedshiftDestinationConfiguration' - S3DestinationConfiguration: - $ref: '#/components/schemas/S3DestinationConfiguration' + DirectPutSourceConfiguration: + $ref: '#/components/schemas/DirectPutSourceConfiguration' SplunkDestinationConfiguration: $ref: '#/components/schemas/SplunkDestinationConfiguration' - HttpEndpointDestinationConfiguration: - $ref: '#/components/schemas/HttpEndpointDestinationConfiguration' + ExtendedS3DestinationConfiguration: + $ref: '#/components/schemas/ExtendedS3DestinationConfiguration' + AmazonOpenSearchServerlessDestinationConfiguration: + $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationConfiguration' + ElasticsearchDestinationConfiguration: + $ref: '#/components/schemas/ElasticsearchDestinationConfiguration' SnowflakeDestinationConfiguration: $ref: '#/components/schemas/SnowflakeDestinationConfiguration' + DatabaseSourceConfiguration: + $ref: '#/components/schemas/DatabaseSourceConfiguration' + S3DestinationConfiguration: + $ref: '#/components/schemas/S3DestinationConfiguration' + DeliveryStreamName: + minLength: 1 + pattern: '[a-zA-Z0-9._-]+' + type: string + maxLength: 64 + Arn: + type: string Tags: + minItems: 1 + maxItems: 50 type: array items: $ref: '#/components/schemas/Tag' - minItems: 1 - maxItems: 50 x-stackql-resource-name: delivery_stream - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::KinesisFirehose::DeliveryStream + x-type-name: AWS::KinesisFirehose::DeliveryStream + x-stackql-primary-identifier: - DeliveryStreamName x-create-only-properties: - DeliveryStreamName @@ -1006,12 +1707,61 @@ components: - ElasticsearchDestinationConfiguration/VpcConfiguration - AmazonopensearchserviceDestinationConfiguration/VpcConfiguration - AmazonOpenSearchServerlessDestinationConfiguration/VpcConfiguration + - DatabaseSourceConfiguration - KinesisStreamSourceConfiguration + - DirectPutSourceConfiguration + - MSKSourceConfiguration + - IcebergDestinationConfiguration/CatalogConfiguration + - SnowflakeDestinationConfiguration/SnowflakeVpcConfiguration + x-write-only-properties: + - HttpEndpointDestinationConfiguration/EndpointConfiguration/AccessKey + - RedshiftDestinationConfiguration/Password + - ElasticsearchDestinationConfiguration/CloudWatchLoggingOptions/Enabled + - AmazonopensearchserviceDestinationConfiguration + - ElasticsearchDestinationConfiguration + - SnowflakeDestinationConfiguration + - AmazonOpenSearchServerlessDestinationConfiguration + - DatabaseSourceConfiguration + - IcebergDestinationConfiguration + - HttpEndpointDestinationConfiguration/SecretsManagerConfiguration + - RedshiftDestinationConfiguration/ProcessingConfiguration + - S3DestinationConfiguration - MSKSourceConfiguration + - KinesisStreamSourceConfiguration - SnowflakeDestinationConfiguration/SnowflakeVpcConfiguration + - HttpEndpointDestinationConfiguration/ProcessingConfiguration + - RedshiftDestinationConfiguration/S3Configuration/EncryptionConfiguration/KMSEncryptionConfig/AWSKMSKeyARN + - SplunkDestinationConfiguration/BufferingHints + - SplunkDestinationConfiguration/SecretsManagerConfiguration + - SplunkDestinationConfiguration/ProcessingConfiguration + - SplunkDestinationConfiguration/CloudWatchLoggingOptions + - SplunkDestinationConfiguration/S3Configuration/EncryptionConfiguration/NoEncryptionConfig + - RedshiftDestinationConfiguration/S3BackupConfiguration/ErrorOutputPrefix + - RedshiftDestinationConfiguration/S3BackupConfiguration/EncryptionConfiguration/KMSEncryptionConfig/AWSKMSKeyARN + - ExtendedS3DestinationConfiguration/FileExtension + - RedshiftDestinationConfiguration/S3Configuration/ErrorOutputPrefix + - RedshiftDestinationConfiguration/SecretsManagerConfiguration/Enabled + - RedshiftDestinationConfiguration/SecretsManagerConfiguration/SecretARN + - HttpEndpointDestinationConfiguration/S3Configuration/EncryptionConfiguration/KMSEncryptionConfig/AWSKMSKeyARN + - ExtendedS3DestinationConfiguration/CustomTimeZone + - RedshiftDestinationConfiguration/SecretsManagerConfiguration/RoleARN + - DirectPutSourceConfiguration/ThroughputHintInMBs x-read-only-properties: - Arn + x-tagging: + permissions: + - firehose:TagDeliveryStream + - firehose:ListTagsForDeliveryStream + - firehose:UntagDeliveryStream + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - firehose:DescribeDeliveryStream + - firehose:ListTagsForDeliveryStream create: - firehose:CreateDeliveryStream - firehose:DescribeDeliveryStream @@ -1019,9 +1769,7 @@ components: - iam:PassRole - kms:CreateGrant - kms:DescribeKey - read: - - firehose:DescribeDeliveryStream - - firehose:ListTagsForDeliveryStream + - firehose:TagDeliveryStream update: - firehose:UpdateDestination - firehose:DescribeDeliveryStream @@ -1033,95 +1781,425 @@ components: - kms:CreateGrant - kms:RevokeGrant - kms:DescribeKey + - iam:PassRole + list: + - firehose:ListDeliveryStreams delete: - firehose:DeleteDeliveryStream - firehose:DescribeDeliveryStream - kms:RevokeGrant - kms:DescribeKey - list: - - firehose:ListDeliveryStreams + CreateDeliveryStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeliveryStreamEncryptionConfigurationInput: + $ref: '#/components/schemas/DeliveryStreamEncryptionConfigurationInput' + HttpEndpointDestinationConfiguration: + $ref: '#/components/schemas/HttpEndpointDestinationConfiguration' + KinesisStreamSourceConfiguration: + $ref: '#/components/schemas/KinesisStreamSourceConfiguration' + DeliveryStreamType: + type: string + enum: + - DatabaseAsSource + - DirectPut + - KinesisStreamAsSource + - MSKAsSource + IcebergDestinationConfiguration: + $ref: '#/components/schemas/IcebergDestinationConfiguration' + RedshiftDestinationConfiguration: + $ref: '#/components/schemas/RedshiftDestinationConfiguration' + AmazonopensearchserviceDestinationConfiguration: + $ref: '#/components/schemas/AmazonopensearchserviceDestinationConfiguration' + MSKSourceConfiguration: + $ref: '#/components/schemas/MSKSourceConfiguration' + DirectPutSourceConfiguration: + $ref: '#/components/schemas/DirectPutSourceConfiguration' + SplunkDestinationConfiguration: + $ref: '#/components/schemas/SplunkDestinationConfiguration' + ExtendedS3DestinationConfiguration: + $ref: '#/components/schemas/ExtendedS3DestinationConfiguration' + AmazonOpenSearchServerlessDestinationConfiguration: + $ref: '#/components/schemas/AmazonOpenSearchServerlessDestinationConfiguration' + ElasticsearchDestinationConfiguration: + $ref: '#/components/schemas/ElasticsearchDestinationConfiguration' + SnowflakeDestinationConfiguration: + $ref: '#/components/schemas/SnowflakeDestinationConfiguration' + DatabaseSourceConfiguration: + $ref: '#/components/schemas/DatabaseSourceConfiguration' + S3DestinationConfiguration: + $ref: '#/components/schemas/S3DestinationConfiguration' + DeliveryStreamName: + minLength: 1 + pattern: '[a-zA-Z0-9._-]+' + type: string + maxLength: 64 + Arn: + type: string + Tags: + minItems: 1 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDeliveryStreamRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: delivery_streams: name: delivery_streams id: awscc.kinesisfirehose.delivery_streams x-cfn-schema-name: DeliveryStream - x-type: list - x-identifiers: - - DeliveryStreamName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DeliveryStreamName') as delivery_stream_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' - AND region = 'us-east-1' - delivery_stream: - name: delivery_stream - id: awscc.kinesisfirehose.delivery_stream - x-cfn-schema-name: DeliveryStream - x-type: get + x-cfn-type-name: AWS::KinesisFirehose::DeliveryStream x-identifiers: - DeliveryStreamName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeliveryStream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisFirehose::DeliveryStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisFirehose::DeliveryStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisFirehose::DeliveryStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.DeliveryStreamEncryptionConfigurationInput') as delivery_stream_encryption_configuration_input, - JSON_EXTRACT(Properties, '$.DeliveryStreamName') as delivery_stream_name, + JSON_EXTRACT(Properties, '$.HttpEndpointDestinationConfiguration') as http_endpoint_destination_configuration, + JSON_EXTRACT(Properties, '$.KinesisStreamSourceConfiguration') as kinesis_stream_source_configuration, JSON_EXTRACT(Properties, '$.DeliveryStreamType') as delivery_stream_type, - JSON_EXTRACT(Properties, '$.ElasticsearchDestinationConfiguration') as elasticsearch_destination_configuration, + JSON_EXTRACT(Properties, '$.IcebergDestinationConfiguration') as iceberg_destination_configuration, + JSON_EXTRACT(Properties, '$.RedshiftDestinationConfiguration') as redshift_destination_configuration, JSON_EXTRACT(Properties, '$.AmazonopensearchserviceDestinationConfiguration') as amazonopensearchservice_destination_configuration, - JSON_EXTRACT(Properties, '$.AmazonOpenSearchServerlessDestinationConfiguration') as amazon_open_search_serverless_destination_configuration, - JSON_EXTRACT(Properties, '$.ExtendedS3DestinationConfiguration') as extended_s3_destination_configuration, - JSON_EXTRACT(Properties, '$.KinesisStreamSourceConfiguration') as kinesis_stream_source_configuration, JSON_EXTRACT(Properties, '$.MSKSourceConfiguration') as msk_source_configuration, - JSON_EXTRACT(Properties, '$.RedshiftDestinationConfiguration') as redshift_destination_configuration, - JSON_EXTRACT(Properties, '$.S3DestinationConfiguration') as s3_destination_configuration, + JSON_EXTRACT(Properties, '$.DirectPutSourceConfiguration') as direct_put_source_configuration, JSON_EXTRACT(Properties, '$.SplunkDestinationConfiguration') as splunk_destination_configuration, - JSON_EXTRACT(Properties, '$.HttpEndpointDestinationConfiguration') as http_endpoint_destination_configuration, + JSON_EXTRACT(Properties, '$.ExtendedS3DestinationConfiguration') as extended_s3_destination_configuration, + JSON_EXTRACT(Properties, '$.AmazonOpenSearchServerlessDestinationConfiguration') as amazon_open_search_serverless_destination_configuration, + JSON_EXTRACT(Properties, '$.ElasticsearchDestinationConfiguration') as elasticsearch_destination_configuration, JSON_EXTRACT(Properties, '$.SnowflakeDestinationConfiguration') as snowflake_destination_configuration, + JSON_EXTRACT(Properties, '$.DatabaseSourceConfiguration') as database_source_configuration, + JSON_EXTRACT(Properties, '$.S3DestinationConfiguration') as s3_destination_configuration, + JSON_EXTRACT(Properties, '$.DeliveryStreamName') as delivery_stream_name, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'DeliveryStreamEncryptionConfigurationInput') as delivery_stream_encryption_configuration_input, - json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name, + json_extract_path_text(Properties, 'HttpEndpointDestinationConfiguration') as http_endpoint_destination_configuration, + json_extract_path_text(Properties, 'KinesisStreamSourceConfiguration') as kinesis_stream_source_configuration, json_extract_path_text(Properties, 'DeliveryStreamType') as delivery_stream_type, - json_extract_path_text(Properties, 'ElasticsearchDestinationConfiguration') as elasticsearch_destination_configuration, + json_extract_path_text(Properties, 'IcebergDestinationConfiguration') as iceberg_destination_configuration, + json_extract_path_text(Properties, 'RedshiftDestinationConfiguration') as redshift_destination_configuration, json_extract_path_text(Properties, 'AmazonopensearchserviceDestinationConfiguration') as amazonopensearchservice_destination_configuration, - json_extract_path_text(Properties, 'AmazonOpenSearchServerlessDestinationConfiguration') as amazon_open_search_serverless_destination_configuration, - json_extract_path_text(Properties, 'ExtendedS3DestinationConfiguration') as extended_s3_destination_configuration, - json_extract_path_text(Properties, 'KinesisStreamSourceConfiguration') as kinesis_stream_source_configuration, json_extract_path_text(Properties, 'MSKSourceConfiguration') as msk_source_configuration, - json_extract_path_text(Properties, 'RedshiftDestinationConfiguration') as redshift_destination_configuration, - json_extract_path_text(Properties, 'S3DestinationConfiguration') as s3_destination_configuration, + json_extract_path_text(Properties, 'DirectPutSourceConfiguration') as direct_put_source_configuration, json_extract_path_text(Properties, 'SplunkDestinationConfiguration') as splunk_destination_configuration, - json_extract_path_text(Properties, 'HttpEndpointDestinationConfiguration') as http_endpoint_destination_configuration, + json_extract_path_text(Properties, 'ExtendedS3DestinationConfiguration') as extended_s3_destination_configuration, + json_extract_path_text(Properties, 'AmazonOpenSearchServerlessDestinationConfiguration') as amazon_open_search_serverless_destination_configuration, + json_extract_path_text(Properties, 'ElasticsearchDestinationConfiguration') as elasticsearch_destination_configuration, json_extract_path_text(Properties, 'SnowflakeDestinationConfiguration') as snowflake_destination_configuration, + json_extract_path_text(Properties, 'DatabaseSourceConfiguration') as database_source_configuration, + json_extract_path_text(Properties, 'S3DestinationConfiguration') as s3_destination_configuration, + json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name, + json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' AND data__Identifier = '' AND region = 'us-east-1' + delivery_streams_list_only: + name: delivery_streams_list_only + id: awscc.kinesisfirehose.delivery_streams_list_only + x-cfn-schema-name: DeliveryStream + x-cfn-type-name: AWS::KinesisFirehose::DeliveryStream + x-identifiers: + - DeliveryStreamName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DeliveryStreamName') as delivery_stream_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeliveryStream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeliveryStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeliveryStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kinesisvideo.yaml b/providers/src/awscc/v00.00.00000/services/kinesisvideo.yaml index abab38c5..ecc6c567 100644 --- a/providers/src/awscc/v00.00.00000/services/kinesisvideo.yaml +++ b/providers/src/awscc/v00.00.00000/services/kinesisvideo.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: KinesisVideo - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associated with the Kinesis Video Stream. @@ -56,24 +436,43 @@ components: maxItems: 50 required: [] x-stackql-resource-name: signaling_channel - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::KinesisVideo::SignalingChannel + x-type-name: AWS::KinesisVideo::SignalingChannel + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - kinesisvideo:TagResource + - kinesisvideo:UntagResource x-required-permissions: create: - kinesisvideo:CreateSignalingChannel - kinesisvideo:DescribeSignalingChannel + - kinesisvideo:TagResource read: - kinesisvideo:DescribeSignalingChannel + - kinesisvideo:ListTagsForResource update: - kinesisvideo:UpdateSignalingChannel - kinesisvideo:DescribeSignalingChannel + - kinesisvideo:TagResource + - kinesisvideo:UntagResource + - kinesisvideo:ListTagsForResource delete: - kinesisvideo:DeleteSignalingChannel - kinesisvideo:DescribeSignalingChannel + list: + - kinesisvideo:ListSignalingChannels Stream: type: object properties: @@ -120,37 +519,214 @@ components: maxItems: 50 required: [] x-stackql-resource-name: stream - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::KinesisVideo::Stream + x-type-name: AWS::KinesisVideo::Stream + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - kinesisvideo:TagStream + - kinesisvideo:UntagStream x-required-permissions: create: - kinesisvideo:DescribeStream - kinesisvideo:CreateStream + - kinesisvideo:TagStream read: - kinesisvideo:DescribeStream + - kinesisvideo:ListTagsForStream update: - kinesisvideo:DescribeStream - kinesisvideo:UpdateStream - kinesisvideo:UpdateDataRetention + - kinesisvideo:TagStream + - kinesisvideo:UntagStream + - kinesisvideo:ListTagsForStream delete: - kinesisvideo:DescribeStream - kinesisvideo:DeleteStream + list: + - kinesisvideo:ListStreams + CreateSignalingChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel. + type: string + Name: + description: The name of the Kinesis Video Signaling Channel. + type: string + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z0-9_.-]+' + Type: + description: The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type. + type: string + enum: + - SINGLE_MASTER + MessageTtlSeconds: + description: The period of time a signaling channel retains undelivered messages before they are discarded. + type: integer + minimum: 5 + maximum: 120 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateSignalingChannelRequest + type: object + required: [] + CreateStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the Kinesis Video stream. + type: string + Name: + description: The name of the Kinesis Video stream. + type: string + minLength: 1 + maxLength: 256 + pattern: '[a-zA-Z0-9_.-]+' + DataRetentionInHours: + description: The number of hours till which Kinesis Video will retain the data in the stream + type: integer + minimum: 0 + maximum: 87600 + DeviceName: + description: The name of the device that is writing to the stream. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_.-]+' + KmsKeyId: + description: AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data. + type: string + minLength: 1 + maxLength: 2048 + pattern: .+ + MediaType: + description: The media type of the stream. Consumers of the stream can use this information when processing the stream. + type: string + minLength: 1 + maxLength: 128 + pattern: '[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*' + Tags: + description: An array of key-value pairs associated with the Kinesis Video Stream. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateStreamRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - signaling_channel: - name: signaling_channel - id: awscc.kinesisvideo.signaling_channel + signaling_channels: + name: signaling_channels + id: awscc.kinesisvideo.signaling_channels x-cfn-schema-name: SignalingChannel - x-type: get + x-cfn-type-name: AWS::KinesisVideo::SignalingChannel x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SignalingChannel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisVideo::SignalingChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisVideo::SignalingChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisVideo::SignalingChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -164,7 +740,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -177,17 +753,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisVideo::SignalingChannel' AND data__Identifier = '' AND region = 'us-east-1' - kinesisvideo_stream: - name: kinesisvideo_stream - id: awscc.kinesisvideo.kinesisvideo_stream - x-cfn-schema-name: Stream - x-type: get + signaling_channels_list_only: + name: signaling_channels_list_only + id: awscc.kinesisvideo.signaling_channels_list_only + x-cfn-schema-name: SignalingChannel + x-cfn-type-name: AWS::KinesisVideo::SignalingChannel x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisVideo::SignalingChannel' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisVideo::SignalingChannel' + AND region = 'us-east-1' + streams: + name: streams + id: awscc.kinesisvideo.streams + x-cfn-schema-name: Stream + x-cfn-type-name: AWS::KinesisVideo::Stream + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Stream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisVideo::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisVideo::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KinesisVideo::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/streams/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -203,7 +858,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -218,3 +873,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisVideo::Stream' AND data__Identifier = '' AND region = 'us-east-1' + streams_list_only: + name: streams_list_only + id: awscc.kinesisvideo.streams_list_only + x-cfn-schema-name: Stream + x-cfn-type-name: AWS::KinesisVideo::Stream + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisVideo::Stream' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisVideo::Stream' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SignalingChannel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSignalingChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSignalingChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Stream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/kms.yaml b/providers/src/awscc/v00.00.00000/services/kms.yaml index 83d8ea8a..de84eff1 100644 --- a/providers/src/awscc/v00.00.00000/services/kms.yaml +++ b/providers/src/awscc/v00.00.00000/services/kms.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: KMS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Alias: type: object @@ -16,8 +396,8 @@ components: For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. Specify the key ID or the key ARN of the KMS key. For example: - + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` - + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html). type: string @@ -35,10 +415,29 @@ components: - AliasName - TargetKeyId x-stackql-resource-name: alias - x-stackql-primaryIdentifier: + description: >- + The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as + [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html). + Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. + Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*. + When specifying an alias, observe the following rules. + + Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key. + + The alias and its associated KMS key must be in the same AWS-account and Region. + + The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an ``alias/projectKey`` in multiple Regions, each of which is associated with a KMS key in its Region. + + Each alias name must begin with ``alias/`` followed by a name, such as ``alias/exampleKey``. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with ``alias/aws/``. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). + + *Regions* + KMS CloudFormation resources are available in all AWS-Regions in which KMS and CFN are supported. + x-type-name: AWS::KMS::Alias + x-stackql-primary-identifier: - AliasName x-create-only-properties: - AliasName + x-required-properties: + - AliasName + - TargetKeyId + x-tagging: + taggable: false x-required-permissions: read: - kms:ListAliases @@ -88,14 +487,23 @@ components: Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. - When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. Fo + When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. type: boolean KeyPolicy: description: |- The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) - + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [ + + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. + + If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. + A key policy document can include only the following characters: + + Printable ASCII characters + + Printable characters in the Basic Latin and Latin-1 Supplement character set + + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters + + *Minimum*: ``1`` + *Maximum*: ``32768`` type: object default: |- { @@ -118,21 +526,27 @@ components: Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. - + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. - + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. - + For asymmetric KMS keys with ECC key material, specify + + For symmetric encryption KMS keys, omit the parameter or specify ``ENCRYPT_DECRYPT``. + + For HMAC KMS keys (symmetric), specify ``GENERATE_VERIFY_MAC``. + + For asymmetric KMS keys with RSA key pairs, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + + For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify ``SIGN_VERIFY`` or ``KEY_AGREEMENT``. + + For asymmetric KMS keys with ``ECC_SECG_P256K1`` key pairs, specify ``SIGN_VERIFY``. + + For asymmetric KMS keys with ML-DSA key pairs, specify ``SIGN_VERIFY``. + + For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ``ENCRYPT_DECRYPT``, ``SIGN_VERIFY``, or ``KEY_AGREEMENT``. type: string default: ENCRYPT_DECRYPT enum: - ENCRYPT_DECRYPT - SIGN_VERIFY - GENERATE_VERIFY_MAC + - KEY_AGREEMENT Origin: description: |- The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. - CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. + + CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. + + ``EXTERNAL`` is not supported for ML-DSA keys. type: string default: AWS_KMS enum: @@ -143,7 +557,38 @@ components: Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. - If you change the value of the ``KeySpec`` property on an existing KMS key, the u + If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. + KMS supports the following key specs for KMS keys: + + Symmetric encryption key (default) + + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + + + HMAC keys (symmetric) + + ``HMAC_224`` + + ``HMAC_256`` + + ``HMAC_384`` + + ``HMAC_512`` + + + Asymmetric RSA key pairs (encryption and decryption *or* signing and verification) + + ``RSA_2048`` + + ``RSA_3072`` + + ``RSA_4096`` + + + Asymmetric NIST-recommended elliptic curve key pairs (signing and verification *or* deriving shared secrets) + + ``ECC_NIST_P256`` (secp256r1) + + ``ECC_NIST_P384`` (secp384r1) + + ``ECC_NIST_P521`` (secp521r1) + + + Other asymmetric elliptic curve key pairs (signing and verification) + + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + + + Asymmetric ML-DSA key pairs (signing and verification) + + ``ML_DSA_44`` + + ``ML_DSA_65`` + + ``ML_DSA_87`` + + + SM2 key pairs (encryption and decryption *or* signing and verification *or* deriving shared secrets) + + ``SM2`` (China Regions only) type: string default: SYMMETRIC_DEFAULT enum: @@ -160,20 +605,27 @@ components: - HMAC_384 - HMAC_512 - SM2 + - ML_DSA_44 + - ML_DSA_65 + - ML_DSA_87 MultiRegion: description: |- Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. - *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Bec + *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. + You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. + To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. type: boolean default: false PendingWindowInDays: description: |- Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. - KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic ope + KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. + You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. + For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*. type: integer minimum: 7 maximum: 30 @@ -201,12 +653,49 @@ components: Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. type: boolean default: false + RotationPeriodInDays: + description: |- + Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days. + The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter. + You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter. + For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. + type: integer + minimum: 90 + maximum: 2560 + default: 365 x-stackql-resource-name: key - x-stackql-primaryIdentifier: + description: >- + The ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To + replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource. + If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values. + KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. + You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*. + You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*. + You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*. + You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. + You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). + *Regions* + KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region. + x-type-name: AWS::KMS::Key + x-stackql-primary-identifier: - KeyId + x-write-only-properties: + - PendingWindowInDays + - BypassPolicyLockoutSafetyCheck + - RotationPeriodInDays x-read-only-properties: - Arn - KeyId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - kms:TagResource + - kms:UntagResource + - kms:ListResourceTags x-required-permissions: create: - kms:CreateKey @@ -275,13 +764,30 @@ components: - PrimaryKeyArn - KeyPolicy x-stackql-resource-name: replica_key - x-stackql-primaryIdentifier: + description: The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS). + x-type-name: AWS::KMS::ReplicaKey + x-stackql-primary-identifier: - KeyId x-create-only-properties: - PrimaryKeyArn + x-write-only-properties: + - PendingWindowInDays x-read-only-properties: - Arn - KeyId + x-required-properties: + - PrimaryKeyArn + - KeyPolicy + x-tagging: + permissions: + - kms:TagResource + - kms:UntagResource + - kms:ListResourceTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: read: - kms:DescribeKey @@ -307,43 +813,372 @@ components: delete: - kms:DescribeKey - kms:ScheduleKeyDeletion + CreateAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TargetKeyId: + minLength: 1 + description: |- + Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. + A valid key ID is required. If you supply a null or empty string value, this operation returns an error. + For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. + Specify the key ID or the key ARN of the KMS key. + For example: + + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + + To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html). + type: string + maxLength: 256 + AliasName: + minLength: 1 + pattern: ^(alias/)[a-zA-Z0-9:/_-]+$ + description: |- + Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. + If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). + The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). + type: string + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateAliasRequest + type: object + required: [] + CreateKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use. + type: string + minLength: 0 + maxLength: 8192 + Enabled: + description: |- + Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. + When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. + The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. + For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. + type: boolean + EnableKeyRotation: + description: |- + Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. + KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. + To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. + When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. + type: boolean + KeyPolicy: + description: |- + The key policy to attach to the KMS key. + If you provide a key policy, it must meet the following criteria: + + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. + + If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. + A key policy document can include only the following characters: + + Printable ASCII characters + + Printable characters in the Basic Latin and Latin-1 Supplement character set + + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters + + *Minimum*: ``1`` + *Maximum*: ``32768`` + type: object + default: |- + { + "Version": "2012-10-17", + "Id": "key-default", + "Statement": [ + { + "Sid": "Enable IAM User Permissions", + "Effect": "Allow", + "Principal": { + "AWS": "arn::iam:::root" + }, + "Action": "kms:*", + "Resource": "*" + } + ] + } + KeyUsage: + description: |- + Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. + If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + Select only one valid value. + + For symmetric encryption KMS keys, omit the parameter or specify ``ENCRYPT_DECRYPT``. + + For HMAC KMS keys (symmetric), specify ``GENERATE_VERIFY_MAC``. + + For asymmetric KMS keys with RSA key pairs, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + + For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify ``SIGN_VERIFY`` or ``KEY_AGREEMENT``. + + For asymmetric KMS keys with ``ECC_SECG_P256K1`` key pairs, specify ``SIGN_VERIFY``. + + For asymmetric KMS keys with ML-DSA key pairs, specify ``SIGN_VERIFY``. + + For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ``ENCRYPT_DECRYPT``, ``SIGN_VERIFY``, or ``KEY_AGREEMENT``. + type: string + default: ENCRYPT_DECRYPT + enum: + - ENCRYPT_DECRYPT + - SIGN_VERIFY + - GENERATE_VERIFY_MAC + - KEY_AGREEMENT + Origin: + description: |- + The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. + To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. + You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. + + CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. + + ``EXTERNAL`` is not supported for ML-DSA keys. + type: string + default: AWS_KMS + enum: + - AWS_KMS + - EXTERNAL + KeySpec: + description: >- + Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) + in the *Developer Guide*. + The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. + If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. + KMS supports the following key specs for KMS keys: + + Symmetric encryption key (default) + + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + + + HMAC keys (symmetric) + + ``HMAC_224`` + + ``HMAC_256`` + + ``HMAC_384`` + + ``HMAC_512`` + + + Asymmetric RSA key pairs (encryption and decryption *or* signing and verification) + + ``RSA_2048`` + + ``RSA_3072`` + + ``RSA_4096`` + + + Asymmetric NIST-recommended elliptic curve key pairs (signing and verification *or* deriving shared secrets) + + ``ECC_NIST_P256`` (secp256r1) + + ``ECC_NIST_P384`` (secp384r1) + + ``ECC_NIST_P521`` (secp521r1) + + + Other asymmetric elliptic curve key pairs (signing and verification) + + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + + + Asymmetric ML-DSA key pairs (signing and verification) + + ``ML_DSA_44`` + + ``ML_DSA_65`` + + ``ML_DSA_87`` + + + SM2 key pairs (encryption and decryption *or* signing and verification *or* deriving shared secrets) + + ``SM2`` (China Regions only) + type: string + default: SYMMETRIC_DEFAULT + enum: + - SYMMETRIC_DEFAULT + - RSA_2048 + - RSA_3072 + - RSA_4096 + - ECC_NIST_P256 + - ECC_NIST_P384 + - ECC_NIST_P521 + - ECC_SECG_P256K1 + - HMAC_224 + - HMAC_256 + - HMAC_384 + - HMAC_512 + - SM2 + - ML_DSA_44 + - ML_DSA_65 + - ML_DSA_87 + MultiRegion: + description: |- + Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. + For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. + If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. + *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. + You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. + To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. + type: boolean + default: false + PendingWindowInDays: + description: |- + Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. + When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. + KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. + You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. + For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*. + type: integer + minimum: 7 + maximum: 30 + Tags: + description: |- + Assigns one or more tags to the replica key. + Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. + For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: '' + KeyId: + type: string + description: '' + BypassPolicyLockoutSafetyCheck: + description: |- + Skips ("bypasses") the key policy lockout safety check. The default value is false. + Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. + For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. + Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. + type: boolean + default: false + RotationPeriodInDays: + description: |- + Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days. + The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter. + You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter. + For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. + type: integer + minimum: 90 + maximum: 2560 + default: 365 + x-stackQL-stringOnly: true + x-title: CreateKeyRequest + type: object + required: [] + CreateReplicaKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + minLength: 0 + description: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use. + type: string + maxLength: 8192 + PendingWindowInDays: + description: Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. + maximum: 30 + type: integer + minimum: 7 + KeyPolicy: + description: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules. + type: object + PrimaryKeyArn: + minLength: 1 + description: Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide. + type: string + maxLength: 256 + Enabled: + description: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations. + type: boolean + KeyId: + type: string + Arn: + type: string + Tags: + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateReplicaKeyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: aliases: name: aliases id: awscc.kms.aliases x-cfn-schema-name: Alias - x-type: list - x-identifiers: - - AliasName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AliasName') as alias_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AliasName') as alias_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' - AND region = 'us-east-1' - alias: - name: alias - id: awscc.kms.alias - x-cfn-schema-name: Alias - x-type: get + x-cfn-type-name: AWS::KMS::Alias x-identifiers: - AliasName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -354,7 +1189,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -364,13 +1199,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Alias' AND data__Identifier = '' AND region = 'us-east-1' - keys: - name: keys - id: awscc.kms.keys - x-cfn-schema-name: Key - x-type: list + aliases_list_only: + name: aliases_list_only + id: awscc.kms.aliases_list_only + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::KMS::Alias x-identifiers: - - KeyId + - AliasName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -378,28 +1219,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.KeyId') as key_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' + JSON_EXTRACT(Properties, '$.AliasName') as alias_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'KeyId') as key_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' + json_extract_path_text(Properties, 'AliasName') as alias_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' AND region = 'us-east-1' - key: - name: key - id: awscc.kms.key + keys: + name: keys + id: awscc.kms.keys x-cfn-schema-name: Key - x-type: get + x-cfn-type-name: AWS::KMS::Key x-identifiers: - KeyId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Key&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -416,12 +1305,13 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.KeyId') as key_id, - JSON_EXTRACT(Properties, '$.BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check + JSON_EXTRACT(Properties, '$.BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check, + JSON_EXTRACT(Properties, '$.RotationPeriodInDays') as rotation_period_in_days FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Key' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -438,17 +1328,24 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'KeyId') as key_id, - json_extract_path_text(Properties, 'BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check + json_extract_path_text(Properties, 'BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check, + json_extract_path_text(Properties, 'RotationPeriodInDays') as rotation_period_in_days FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Key' AND data__Identifier = '' AND region = 'us-east-1' - replica_keys: - name: replica_keys - id: awscc.kms.replica_keys - x-cfn-schema-name: ReplicaKey - x-type: list + keys_list_only: + name: keys_list_only + id: awscc.kms.keys_list_only + x-cfn-schema-name: Key + x-cfn-type-name: AWS::KMS::Key x-identifiers: - KeyId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -457,7 +1354,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.KeyId') as key_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -465,19 +1362,67 @@ components: SELECT region, json_extract_path_text(Properties, 'KeyId') as key_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' AND region = 'us-east-1' - replica_key: - name: replica_key - id: awscc.kms.replica_key + replica_keys: + name: replica_keys + id: awscc.kms.replica_keys x-cfn-schema-name: ReplicaKey - x-type: get + x-cfn-type-name: AWS::KMS::ReplicaKey x-identifiers: - KeyId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReplicaKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::ReplicaKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::ReplicaKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::KMS::ReplicaKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replica_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replica_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/replica_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -494,7 +1439,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -510,3 +1455,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::ReplicaKey' AND data__Identifier = '' AND region = 'us-east-1' + replica_keys_list_only: + name: replica_keys_list_only + id: awscc.kms.replica_keys_list_only + x-cfn-schema-name: ReplicaKey + x-cfn-type-name: AWS::KMS::ReplicaKey + x-identifiers: + - KeyId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KeyId') as key_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyId') as key_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Key&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReplicaKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReplicaKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReplicaKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/lakeformation.yaml b/providers/src/awscc/v00.00.00000/services/lakeformation.yaml index ab98d6f9..f8cac874 100644 --- a/providers/src/awscc/v00.00.00000/services/lakeformation.yaml +++ b/providers/src/awscc/v00.00.00000/services/lakeformation.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: LakeFormation - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: CatalogIdString: type: string @@ -35,7 +415,9 @@ components: properties: ExcludedColumnNames: $ref: '#/components/schemas/ColumnNames' + description: Excludes column names. Any column with this name will be excluded. additionalProperties: false + description: A wildcard object, consisting of an optional list of excluded column names or indexes. DataCellsFilter: type: object properties: @@ -66,7 +448,9 @@ components: - TableName - Name x-stackql-resource-name: data_cells_filter - x-stackql-primaryIdentifier: + description: A resource schema representing a Lake Formation Data Cells Filter. + x-type-name: AWS::LakeFormation::DataCellsFilter + x-stackql-primary-identifier: - TableCatalogId - DatabaseName - TableName @@ -79,6 +463,14 @@ components: - RowFilter - ColumnNames - ColumnWildcard + x-required-properties: + - TableCatalogId + - DatabaseName + - TableName + - Name + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false x-required-permissions: create: - lakeformation:CreateDataCellsFilter @@ -101,9 +493,12 @@ components: properties: TagKey: $ref: '#/components/schemas/LFTagKey' + description: The key-name for the LF-tag. TagValues: $ref: '#/components/schemas/TagValueList' + description: A list of possible values of the corresponding ``TagKey`` of an LF-tag key-value pair. additionalProperties: false + description: The LF-tag key and values attached to a resource. LFTagPair: type: object properties: @@ -199,57 +594,75 @@ components: properties: CatalogId: $ref: '#/components/schemas/CatalogIdString' + description: The identifier for the GLUDC where the location is registered with LFlong. ResourceArn: $ref: '#/components/schemas/ResourceArnString' + description: The Amazon Resource Name (ARN) that uniquely identifies the data location resource. additionalProperties: false required: - CatalogId - ResourceArn + description: A structure for a data location object where permissions are granted or revoked. DataCellsFilterResource: type: object properties: TableCatalogId: $ref: '#/components/schemas/CatalogIdString' + description: The ID of the catalog to which the table belongs. DatabaseName: $ref: '#/components/schemas/NameString' + description: A database in the GLUDC. TableName: $ref: '#/components/schemas/NameString' + description: The name of the table. Name: $ref: '#/components/schemas/NameString' + description: The name given by the user to the data filter cell. additionalProperties: false required: - TableCatalogId - DatabaseName - TableName - Name + description: A structure that describes certain columns on certain rows. LFTagKeyResource: type: object properties: CatalogId: $ref: '#/components/schemas/CatalogIdString' + description: The identifier for the GLUDC where the location is registered with GLUDC. TagKey: $ref: '#/components/schemas/NameString' + description: The key-name for the LF-tag. TagValues: $ref: '#/components/schemas/TagValueList' + description: A list of possible values for the corresponding ``TagKey`` of an LF-tag key-value pair. additionalProperties: false required: - CatalogId - TagKey - TagValues + description: A structure containing an LF-tag key and values for a resource. LFTagPolicyResource: type: object properties: CatalogId: $ref: '#/components/schemas/CatalogIdString' + description: The identifier for the GLUDC. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment. ResourceType: $ref: '#/components/schemas/ResourceType' + description: The resource type for which the LF-tag policy applies. Expression: $ref: '#/components/schemas/Expression' + description: A list of LF-tag conditions that apply to the resource's LF-tag policy. additionalProperties: false required: - CatalogId - ResourceType - Expression + description: |- + A list of LF-tag conditions that define a resource's LF-tag policy. + A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'. Resource: type: object properties: @@ -277,8 +690,9 @@ components: - CREATE_DATABASE - CREATE_TABLE - DATA_LOCATION_ACCESS - - CREATE_TAG + - CREATE_LF_TAG - ASSOCIATE + - GRANT_WITH_LF_TAG_EXPRESSION LFTagKey: type: string minLength: 1 @@ -315,30 +729,40 @@ components: required: - Principal - Resource + description: '' PrincipalPermissions: type: object properties: Catalog: $ref: '#/components/schemas/CatalogIdString' + description: The identifier for the GLUDC. By default, the account ID. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. Principal: $ref: '#/components/schemas/DataLakePrincipal' + description: The principal to be granted a permission. Resource: $ref: '#/components/schemas/Resource' + description: The resource to be granted or revoked permissions. Permissions: $ref: '#/components/schemas/PermissionList' + description: The permissions granted or revoked. PermissionsWithGrantOption: $ref: '#/components/schemas/PermissionList' + description: Indicates the ability to grant permissions (as a subset of permissions granted). PrincipalIdentifier: type: string + description: '' ResourceIdentifier: type: string + description: '' required: - Principal - Resource - Permissions - PermissionsWithGrantOption x-stackql-resource-name: principal_permissions - x-stackql-primaryIdentifier: + description: The ``AWS::LakeFormation::PrincipalPermissions`` resource represents the permissions that a principal has on a GLUDC resource (such as GLUlong databases or GLUlong tables). When you create a ``PrincipalPermissions`` resource, the permissions are granted via the LFlong``GrantPermissions`` API operation. When you delete a ``PrincipalPermissions`` resource, the permissions on principal-resource pair are revoked via the LFlong``RevokePermissions`` API operation. + x-type-name: AWS::LakeFormation::PrincipalPermissions + x-stackql-primary-identifier: - PrincipalIdentifier - ResourceIdentifier x-create-only-properties: @@ -350,6 +774,14 @@ components: x-read-only-properties: - PrincipalIdentifier - ResourceIdentifier + x-required-properties: + - Principal + - Resource + - Permissions + - PermissionsWithGrantOption + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false x-required-permissions: create: - lakeformation:GrantPermissions @@ -386,18 +818,28 @@ components: - TagKey - TagValues x-stackql-resource-name: tag - x-stackql-primaryIdentifier: + description: A resource schema representing a Lake Formation Tag. + x-type-name: AWS::LakeFormation::Tag + x-stackql-primary-identifier: - TagKey x-create-only-properties: - CatalogId - TagKey + x-required-properties: + - TagKey + - TagValues + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false x-required-permissions: create: - lakeformation:CreateLFTag + - lakeformation:GetLFTag read: - lakeformation:GetLFTag update: - lakeformation:UpdateLFTag + - lakeformation:GetLFTag delete: - lakeformation:DeleteLFTag list: @@ -421,7 +863,9 @@ components: - Resource - LFTags x-stackql-resource-name: tag_association - x-stackql-primaryIdentifier: + description: A resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities. + x-type-name: AWS::LakeFormation::TagAssociation + x-stackql-primary-identifier: - ResourceIdentifier - TagsIdentifier x-create-only-properties: @@ -430,6 +874,12 @@ components: x-read-only-properties: - ResourceIdentifier - TagsIdentifier + x-required-properties: + - Resource + - LFTags + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false x-required-permissions: create: - lakeformation:AddLFTagsToResource @@ -443,51 +893,240 @@ components: - lakeformation:RemoveLFTagsFromResource - glue:GetDatabase - glue:GetTable + CreateDataCellsFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TableCatalogId: + description: The Catalog Id of the Table on which to create a Data Cells Filter. + $ref: '#/components/schemas/CatalogIdString' + DatabaseName: + description: The name of the Database that the Table resides in. + $ref: '#/components/schemas/NameString' + TableName: + description: The name of the Table to create a Data Cells Filter for. + $ref: '#/components/schemas/NameString' + Name: + description: The desired name of the Data Cells Filter. + $ref: '#/components/schemas/NameString' + RowFilter: + description: An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required + $ref: '#/components/schemas/RowFilter' + ColumnNames: + description: A list of columns to be included in this Data Cells Filter. + $ref: '#/components/schemas/ColumnNames' + ColumnWildcard: + description: An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required + $ref: '#/components/schemas/ColumnWildcard' + x-stackQL-stringOnly: true + x-title: CreateDataCellsFilterRequest + type: object + required: [] + CreatePrincipalPermissionsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Catalog: + $ref: '#/components/schemas/CatalogIdString' + description: The identifier for the GLUDC. By default, the account ID. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. + Principal: + $ref: '#/components/schemas/DataLakePrincipal' + description: The principal to be granted a permission. + Resource: + $ref: '#/components/schemas/Resource' + description: The resource to be granted or revoked permissions. + Permissions: + $ref: '#/components/schemas/PermissionList' + description: The permissions granted or revoked. + PermissionsWithGrantOption: + $ref: '#/components/schemas/PermissionList' + description: Indicates the ability to grant permissions (as a subset of permissions granted). + PrincipalIdentifier: + type: string + description: '' + ResourceIdentifier: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreatePrincipalPermissionsRequest + type: object + required: [] + CreateTagRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CatalogId: + description: The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. + $ref: '#/components/schemas/CatalogIdString' + TagKey: + description: The key-name for the LF-tag. + $ref: '#/components/schemas/LFTagKey' + TagValues: + description: A list of possible values an attribute can take. + $ref: '#/components/schemas/TagValueList' + x-stackQL-stringOnly: true + x-title: CreateTagRequest + type: object + required: [] + CreateTagAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Resource: + description: Resource to tag with the Lake Formation Tags + $ref: '#/components/schemas/Resource' + LFTags: + description: List of Lake Formation Tags to associate with the Lake Formation Resource + $ref: '#/components/schemas/LFTagsList' + ResourceIdentifier: + description: Unique string identifying the resource. Used as primary identifier, which ideally should be a string + type: string + TagsIdentifier: + description: Unique string identifying the resource's tags. Used as primary identifier, which ideally should be a string + type: string + x-stackQL-stringOnly: true + x-title: CreateTagAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: data_cells_filters: name: data_cells_filters id: awscc.lakeformation.data_cells_filters x-cfn-schema-name: DataCellsFilter - x-type: list + x-cfn-type-name: AWS::LakeFormation::DataCellsFilter x-identifiers: - TableCatalogId - DatabaseName - TableName - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataCellsFilter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::DataCellsFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::DataCellsFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_cells_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_cells_filters/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.TableCatalogId') as table_catalog_id, JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, JSON_EXTRACT(Properties, '$.TableName') as table_name, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.RowFilter') as row_filter, + JSON_EXTRACT(Properties, '$.ColumnNames') as column_names, + JSON_EXTRACT(Properties, '$.ColumnWildcard') as column_wildcard + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' + AND data__Identifier = '|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, json_extract_path_text(Properties, 'TableCatalogId') as table_catalog_id, json_extract_path_text(Properties, 'DatabaseName') as database_name, json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RowFilter') as row_filter, + json_extract_path_text(Properties, 'ColumnNames') as column_names, + json_extract_path_text(Properties, 'ColumnWildcard') as column_wildcard + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' + AND data__Identifier = '|||' AND region = 'us-east-1' - data_cells_filter: - name: data_cells_filter - id: awscc.lakeformation.data_cells_filter + data_cells_filters_list_only: + name: data_cells_filters_list_only + id: awscc.lakeformation.data_cells_filters_list_only x-cfn-schema-name: DataCellsFilter - x-type: get + x-cfn-type-name: AWS::LakeFormation::DataCellsFilter x-identifiers: - TableCatalogId - DatabaseName - TableName - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -495,45 +1134,70 @@ components: ddl: |- SELECT region, - data__Identifier, JSON_EXTRACT(Properties, '$.TableCatalogId') as table_catalog_id, JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, JSON_EXTRACT(Properties, '$.TableName') as table_name, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.RowFilter') as row_filter, - JSON_EXTRACT(Properties, '$.ColumnNames') as column_names, - JSON_EXTRACT(Properties, '$.ColumnWildcard') as column_wildcard - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' - AND data__Identifier = '|||' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, json_extract_path_text(Properties, 'TableCatalogId') as table_catalog_id, json_extract_path_text(Properties, 'DatabaseName') as database_name, json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RowFilter') as row_filter, - json_extract_path_text(Properties, 'ColumnNames') as column_names, - json_extract_path_text(Properties, 'ColumnWildcard') as column_wildcard - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' - AND data__Identifier = '|||' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' AND region = 'us-east-1' principal_permissions: name: principal_permissions id: awscc.lakeformation.principal_permissions x-cfn-schema-name: PrincipalPermissions - x-type: get + x-cfn-type-name: AWS::LakeFormation::PrincipalPermissions x-identifiers: - PrincipalIdentifier - ResourceIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PrincipalPermissions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::PrincipalPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::PrincipalPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/principal_permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/principal_permissions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -549,7 +1213,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -568,34 +1232,96 @@ components: name: tags id: awscc.lakeformation.tags x-cfn-schema-name: Tag - x-type: list + x-cfn-type-name: AWS::LakeFormation::Tag x-identifiers: - TagKey + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Tag&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::Tag" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::Tag" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::Tag" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tags/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TagKey') as tag_key - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' + data__Identifier, + JSON_EXTRACT(Properties, '$.CatalogId') as catalog_id, + JSON_EXTRACT(Properties, '$.TagKey') as tag_key, + JSON_EXTRACT(Properties, '$.TagValues') as tag_values + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::Tag' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'TagKey') as tag_key - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' + data__Identifier, + json_extract_path_text(Properties, 'CatalogId') as catalog_id, + json_extract_path_text(Properties, 'TagKey') as tag_key, + json_extract_path_text(Properties, 'TagValues') as tag_values + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::Tag' + AND data__Identifier = '' AND region = 'us-east-1' - tag: - name: tag - id: awscc.lakeformation.tag + tags_list_only: + name: tags_list_only + id: awscc.lakeformation.tags_list_only x-cfn-schema-name: Tag - x-type: get + x-cfn-type-name: AWS::LakeFormation::Tag x-identifiers: - TagKey + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -603,37 +1329,64 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.CatalogId') as catalog_id, - JSON_EXTRACT(Properties, '$.TagKey') as tag_key, - JSON_EXTRACT(Properties, '$.TagValues') as tag_values - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::Tag' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TagKey') as tag_key + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CatalogId') as catalog_id, - json_extract_path_text(Properties, 'TagKey') as tag_key, - json_extract_path_text(Properties, 'TagValues') as tag_values - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::Tag' - AND data__Identifier = '' + json_extract_path_text(Properties, 'TagKey') as tag_key + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' AND region = 'us-east-1' - tag_association: - name: tag_association - id: awscc.lakeformation.tag_association + tag_associations: + name: tag_associations + id: awscc.lakeformation.tag_associations x-cfn-schema-name: TagAssociation - x-type: get + x-cfn-type-name: AWS::LakeFormation::TagAssociation x-identifiers: - ResourceIdentifier - TagsIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TagAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::TagAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::TagAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tag_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tag_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -646,7 +1399,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -658,3 +1411,324 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::TagAssociation' AND data__Identifier = '|' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataCellsFilter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataCellsFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataCellsFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PrincipalPermissions&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrincipalPermissions + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePrincipalPermissionsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Tag&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTag + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTagRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TagAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTagAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTagAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/lambda.yaml b/providers/src/awscc/v00.00.00000/services/lambda.yaml index ad8d17c4..8a8db185 100644 --- a/providers/src/awscc/v00.00.00000/services/lambda.yaml +++ b/providers/src/awscc/v00.00.00000/services/lambda.yaml @@ -1,10 +1,494 @@ openapi: 3.0.0 info: title: Lambda - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + ProvisionedConcurrencyConfiguration: + type: object + description: A provisioned concurrency configuration for a function's version. + additionalProperties: false + properties: + ProvisionedConcurrentExecutions: + type: integer + description: The amount of provisioned concurrency to allocate for the version. + required: + - ProvisionedConcurrentExecutions + VersionWeight: + type: object + description: The traffic-shifting configuration of a Lambda function alias. + additionalProperties: false + properties: + FunctionWeight: + type: number + description: The percentage of traffic that the alias routes to the second version. + FunctionVersion: + type: string + description: The qualifier of the second version. + required: + - FunctionVersion + - FunctionWeight + AliasRoutingConfiguration: + type: object + description: The traffic-shifting configuration of a Lambda function alias. + additionalProperties: false + properties: + AdditionalVersionWeights: + type: array + description: The second version, and the percentage of traffic that's routed to it. + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/VersionWeight' + Alias: + type: object + properties: + FunctionName: + description: The name of the Lambda function. + type: string + AliasArn: + description: Lambda Alias ARN generated by the service. + type: string + ProvisionedConcurrencyConfig: + description: Specifies a provisioned concurrency configuration for a function's alias. + $ref: '#/components/schemas/ProvisionedConcurrencyConfiguration' + Description: + description: A description of the alias. + type: string + FunctionVersion: + description: The function version that the alias invokes. + type: string + RoutingConfig: + description: The routing configuration of the alias. + $ref: '#/components/schemas/AliasRoutingConfiguration' + Name: + description: The name of the alias. + type: string + required: + - FunctionName + - FunctionVersion + - Name + x-stackql-resource-name: alias + description: Resource Type definition for AWS::Lambda::Alias + x-type-name: AWS::Lambda::Alias + x-stackql-primary-identifier: + - AliasArn + x-create-only-properties: + - Name + - FunctionName + x-read-only-properties: + - AliasArn + x-required-properties: + - FunctionName + - FunctionVersion + - Name + x-tagging: + taggable: false + x-required-permissions: + create: + - lambda:CreateAlias + - lambda:PutProvisionedConcurrencyConfig + - lambda:GetProvisionedConcurrencyConfig + read: + - lambda:GetAlias + - lambda:GetProvisionedConcurrencyConfig + delete: + - lambda:DeleteAlias + - lambda:GetAlias + list: + - lambda:ListAliases + update: + - lambda:UpdateAlias + - lambda:GetAlias + - lambda:PutProvisionedConcurrencyConfig + - lambda:DeleteProvisionedConcurrencyConfig + - lambda:GetProvisionedConcurrencyConfig + - codedeploy:CreateDeployment + - codedeploy:GetDeployment + - codedeploy:GetDeploymentGroup + - codedeploy:GetDeploymentConfig + - codedeploy:StopDeployment AllowedPublishers: type: object description: When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list @@ -36,6 +520,23 @@ components: - Enforce required: - UntrustedArtifactOnDeployment + Tag: + description: A [tag](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. + additionalProperties: false + type: object + properties: + Value: + minLength: 0 + description: The value for this tag. + type: string + maxLength: 256 + Key: + minLength: 1 + description: The key for this tag. + type: string + maxLength: 128 + required: + - Key CodeSigningConfig: type: object properties: @@ -58,21 +559,46 @@ components: description: A unique Arn for CodeSigningConfig resource type: string pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} + Tags: + description: A list of tags to apply to CodeSigningConfig resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - AllowedPublishers x-stackql-resource-name: code_signing_config - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lambda::CodeSigningConfig. + x-type-name: AWS::Lambda::CodeSigningConfig + x-stackql-primary-identifier: - CodeSigningConfigArn x-read-only-properties: - CodeSigningConfigId - CodeSigningConfigArn + x-required-properties: + - AllowedPublishers + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - lambda:ListTags + - lambda:TagResource + - lambda:UntagResource x-required-permissions: create: - lambda:CreateCodeSigningConfig + - lambda:TagResource read: - lambda:GetCodeSigningConfig + - lambda:ListTags update: - lambda:UpdateCodeSigningConfig + - lambda:TagResource + - lambda:UntagResource delete: - lambda:DeleteCodeSigningConfig list: @@ -80,20 +606,23 @@ components: DestinationConfig: type: object additionalProperties: false - description: (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records. + description: A configuration object that specifies the destination of an event after Lambda processes it. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations). properties: OnFailure: description: The destination configuration for failed invocations. $ref: '#/components/schemas/OnFailure' OnFailure: type: object - description: A destination for events that failed processing. + description: A destination for events that failed processing. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations). additionalProperties: false properties: Destination: - description: The Amazon Resource Name (ARN) of the destination resource. + description: |- + The Amazon Resource Name (ARN) of the destination resource. + To retain records of unsuccessful [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. + To retain records of failed invocations from [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html), [DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html), [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination. type: string - pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) minLength: 12 maxLength: 1024 OnSuccess: @@ -103,7 +632,7 @@ components: Destination: description: The Amazon Resource Name (ARN) of the destination resource. type: string - pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) + pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]+(-[a-z]+)+-\d{1})?:(\d{12})?:(.*) minLength: 0 maxLength: 350 required: @@ -117,7 +646,7 @@ components: FunctionName: description: The name of the Lambda function. type: string - pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]+(-[a-z]+)+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ MaximumEventAgeInSeconds: description: The maximum age of a request that Lambda sends to a function for processing. type: integer @@ -136,12 +665,22 @@ components: - FunctionName - Qualifier x-stackql-resource-name: event_invoke_config - x-stackql-primaryIdentifier: + description: The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias. + x-type-name: AWS::Lambda::EventInvokeConfig + x-stackql-primary-identifier: - FunctionName - Qualifier x-create-only-properties: - FunctionName - Qualifier + x-required-properties: + - FunctionName + - Qualifier + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - lambda:PutFunctionEventInvokeConfig @@ -155,11 +694,11 @@ components: - lambda:ListFunctionEventInvokeConfigs FilterCriteria: type: object - description: The filter criteria to control event filtering. + description: An object that contains the filters for an event source. additionalProperties: false properties: Filters: - description: List of filters of this FilterCriteria + description: A list of filters. type: array uniqueItems: true items: @@ -168,22 +707,32 @@ components: maxItems: 20 Filter: type: object - description: The filter object that defines parameters for ESM filtering. + description: A structure within a ``FilterCriteria`` object that defines an event filtering pattern. additionalProperties: false properties: Pattern: type: string - description: The filter pattern that defines which events should be passed for invocations. + description: A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). pattern: .* minLength: 0 maxLength: 4096 SourceAccessConfiguration: type: object additionalProperties: false - description: The configuration used by AWS Lambda to access event source + description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. properties: Type: - description: The type of source access configuration. + description: |- + The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``"Type":"SASL_SCRAM_512_AUTH"``. + + ``BASIC_AUTH`` – (Amazon MQ) The ASMlong secret that stores your broker credentials. + + ``BASIC_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers. + + ``VPC_SUBNET`` – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster. + + ``VPC_SECURITY_GROUP`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers. + + ``SASL_SCRAM_256_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers. + + ``SASL_SCRAM_512_AUTH`` – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers. + + ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call. + + ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers. + + ``SERVER_ROOT_CA_CERTIFICATE`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers. enum: - BASIC_AUTH - VPC_SUBNET @@ -195,7 +744,7 @@ components: - SERVER_ROOT_CA_CERTIFICATE type: string URI: - description: The URI for the source access configuration resource. + description: 'The value for your chosen configuration in ``Type``. For example: ``"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"``.' type: string pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' minLength: 1 @@ -203,19 +752,19 @@ components: SelfManagedEventSource: type: object additionalProperties: false - description: The configuration used by AWS Lambda to access a self-managed event source. + description: The self-managed Apache Kafka cluster for your event source. properties: Endpoints: - description: The endpoints for a self-managed event source. + description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' $ref: '#/components/schemas/Endpoints' Endpoints: type: object additionalProperties: false - description: The endpoints used by AWS Lambda to access a self-managed event source. + description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' properties: KafkaBootstrapServers: type: array - description: A list of Kafka server endpoints. + description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' uniqueItems: true items: type: string @@ -232,124 +781,288 @@ components: minLength: 1 maxLength: 200 AmazonManagedKafkaEventSourceConfig: - description: Specific configuration settings for an MSK event source. + description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. type: object additionalProperties: false properties: ConsumerGroupId: - description: The identifier for the Kafka Consumer Group to join. + description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). $ref: '#/components/schemas/ConsumerGroupId' + SchemaRegistryConfig: + description: Specific configuration settings for a Kafka schema registry. + $ref: '#/components/schemas/SchemaRegistryConfig' SelfManagedKafkaEventSourceConfig: - description: Specific configuration settings for a Self-Managed Apache Kafka event source. + description: Specific configuration settings for a self-managed Apache Kafka event source. type: object additionalProperties: false properties: ConsumerGroupId: - description: The identifier for the Kafka Consumer Group to join. + description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka-process.html#services-smaa-topic-add). $ref: '#/components/schemas/ConsumerGroupId' + SchemaRegistryConfig: + description: Specific configuration settings for a Kafka schema registry. + $ref: '#/components/schemas/SchemaRegistryConfig' MaximumConcurrency: description: The maximum number of concurrent functions that an event source can invoke. type: integer minimum: 2 maximum: 1000 ScalingConfig: - description: The scaling configuration for the event source. + description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. type: object additionalProperties: false properties: MaximumConcurrency: - description: The maximum number of concurrent functions that the event source can invoke. + description: Limits the number of concurrent instances that the SQS event source can invoke. $ref: '#/components/schemas/MaximumConcurrency' DocumentDBEventSourceConfig: - description: Document db event source config. + description: Specific configuration settings for a DocumentDB event source. type: object additionalProperties: false properties: DatabaseName: - description: The database name to connect to. + description: The name of the database to consume within the DocumentDB cluster. type: string minLength: 1 maxLength: 63 CollectionName: - description: The collection name to connect to. + description: The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. type: string minLength: 1 maxLength: 57 FullDocument: - description: Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup. + description: Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. type: string enum: - UpdateLookup - Default + ProvisionedPollerConfig: + description: The [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode) configuration for the event source. Use provisioned mode to customize the minimum and maximum number of event pollers for your event source. + type: object + additionalProperties: false + properties: + MinimumPollers: + description: The minimum number of event pollers this event source can scale down to. + type: integer + minimum: 1 + maximum: 200 + MaximumPollers: + description: The maximum number of event pollers this event source can scale up to. + type: integer + minimum: 1 + maximum: 2000 + SchemaRegistryConfig: + description: Specific configuration settings for a Kafka schema registry. + type: object + additionalProperties: false + properties: + SchemaRegistryURI: + description: |- + The URI for your schema registry. The correct URI format depends on the type of schema registry you're using. + + For GLU schema registries, use the ARN of the registry. + + For Confluent schema registries, use the URL of the registry. + type: string + pattern: '[a-zA-Z0-9-/*:_+=.@-]*' + minLength: 1 + maxLength: 10000 + EventRecordFormat: + description: |- + The record format that Lambda delivers to your function after schema validation. + + Choose ``JSON`` to have Lambda deliver the record to your function as a standard JSON object. + + Choose ``SOURCE`` to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function. + enum: + - JSON + - SOURCE + type: string + AccessConfigs: + description: An array of access configuration objects that tell Lambda how to authenticate with your schema registry. + type: array + uniqueItems: true + maxItems: 2 + items: + $ref: '#/components/schemas/SchemaRegistryAccessConfig' + SchemaValidationConfigs: + description: An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry. + type: array + uniqueItems: true + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/SchemaValidationConfig' + SchemaRegistryAccessConfig: + description: |- + Specific access configuration settings that tell Lambda how to authenticate with your schema registry. + If you're working with an GLU schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster. + If you're working with a Confluent schema registry, choose the authentication method in the ``Type`` field, and provide the ASMlong secret ARN in the ``URI`` field. + type: object + additionalProperties: false + properties: + Type: + description: The type of authentication Lambda uses to access your schema registry. + type: string + enum: + - BASIC_AUTH + - CLIENT_CERTIFICATE_TLS_AUTH + - SERVER_ROOT_CA_CERTIFICATE + URI: + description: The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry. + type: string + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) + minLength: 1 + maxLength: 10000 + SchemaValidationConfig: + description: Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry. + type: object + additionalProperties: false + properties: + Attribute: + description: The attributes you want your schema registry to validate and filter for. If you selected ``JSON`` as the ``EventRecordFormat``, Lambda also deserializes the selected message attributes. + type: string + enum: + - KEY + - VALUE + MetricsConfig: + description: The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce. + type: object + additionalProperties: false + properties: + Metrics: + description: The metrics you want your event source mapping to produce. Include ``EventCount`` to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics). + type: array + uniqueItems: true + items: + type: string + enum: + - EventCount + minItems: 0 + maxItems: 1 EventSourceMapping: type: object properties: Id: - description: Event Source Mapping Identifier UUID. + description: '' type: string pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' minLength: 36 maxLength: 36 BatchSize: - description: The maximum number of items to retrieve in a single batch. + description: |- + The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). + + *Amazon Kinesis* – Default 100. Max 10,000. + + *Amazon DynamoDB Streams* – Default 100. Max 10,000. + + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. + + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. + + *Self-managed Apache Kafka* – Default 100. Max 10,000. + + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. + + *DocumentDB* – Default 100. Max 10,000. type: integer minimum: 1 maximum: 10000 BisectBatchOnFunctionError: - description: (Streams) If the function returns an error, split the batch in two and retry. + description: |- + (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. + When using ``BisectBatchOnFunctionError``, check the ``BatchSize`` parameter in the ``OnFailure`` destination message's metadata. The ``BatchSize`` could be greater than 1 since LAM consolidates failed messages metadata when writing to the ``OnFailure`` destination. type: boolean DestinationConfig: - description: (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records. + description: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it. $ref: '#/components/schemas/DestinationConfig' Enabled: - description: Disables the event source mapping to pause polling and invocation. + description: |- + When true, the event source mapping is active. When false, Lambda pauses polling and invocation. + Default: True type: boolean EventSourceArn: - description: The Amazon Resource Name (ARN) of the event source. + description: |- + The Amazon Resource Name (ARN) of the event source. + + *Amazon Kinesis* – The ARN of the data stream or a stream consumer. + + *Amazon DynamoDB Streams* – The ARN of the stream. + + *Amazon Simple Queue Service* – The ARN of the queue. + + *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)). + + *Amazon MQ* – The ARN of the broker. + + *Amazon DocumentDB* – The ARN of the DocumentDB change stream. type: string - pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) minLength: 12 maxLength: 1024 + EventSourceMappingArn: + description: '' + type: string + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} + minLength: 85 + maxLength: 120 FilterCriteria: - description: The filter criteria to control event filtering. + description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). $ref: '#/components/schemas/FilterCriteria' + KmsKeyArn: + description: The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics). + type: string + pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() + minLength: 12 + maxLength: 2048 FunctionName: - description: The name of the Lambda function. + description: |- + The name or ARN of the Lambda function. + **Name formats** + + *Function name* – ``MyFunction``. + + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``. + + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``. + + *Partial ARN* – ``123456789012:function:MyFunction``. + + The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. type: string - pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 MaximumBatchingWindowInSeconds: - description: (Streams) The maximum amount of time to gather records before invoking the function, in seconds. + description: |- + The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. + *Default (, , event sources)*: 0 + *Default (, Kafka, , event sources)*: 500 ms + *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1. type: integer minimum: 0 maximum: 300 MaximumRecordAgeInSeconds: - description: (Streams) The maximum age of a record that Lambda sends to a function for processing. + description: |- + (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. + The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed type: integer minimum: -1 maximum: 604800 MaximumRetryAttempts: - description: (Streams) The maximum number of times to retry when the function returns an error. + description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. type: integer minimum: -1 maximum: 10000 ParallelizationFactor: - description: (Streams) The number of batches to process from each shard concurrently. + description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. type: integer minimum: 1 maximum: 10 StartingPosition: - description: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. + description: |- + The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. + + *LATEST* - Read only new records. + + *TRIM_HORIZON* - Process all available records. + + *AT_TIMESTAMP* - Specify a time from which to start reading records. type: string pattern: (LATEST|TRIM_HORIZON|AT_TIMESTAMP)+ minLength: 6 maxLength: 12 StartingPositionTimestamp: - description: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds. + description: With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future. type: number - Topics: - description: (Kafka) A list of Kafka topics. + Tags: + description: |- + A list of tags to add to the event source mapping. + You must have the ``lambda:TagResource``, ``lambda:UntagResource``, and ``lambda:ListTags`` permissions for your [principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Topics: + description: The name of the Kafka topic. type: array uniqueItems: true items: @@ -360,7 +1073,7 @@ components: minItems: 1 maxItems: 1 Queues: - description: (ActiveMQ) A list of ActiveMQ queues. + description: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. type: array uniqueItems: true items: @@ -371,7 +1084,7 @@ components: minItems: 1 maxItems: 1 SourceAccessConfigurations: - description: A list of SourceAccessConfiguration. + description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. type: array uniqueItems: true items: @@ -379,12 +1092,14 @@ components: minItems: 1 maxItems: 22 TumblingWindowInSeconds: - description: (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations. + description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. type: integer minimum: 0 maximum: 900 FunctionResponseTypes: - description: (Streams) A list of response types supported by the function. + description: |- + (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping. + Valid Values: ``ReportBatchItemFailures`` type: array uniqueItems: true items: @@ -394,48 +1109,88 @@ components: minLength: 0 maxLength: 1 SelfManagedEventSource: - description: Self-managed event source endpoints. + description: The self-managed Apache Kafka cluster for your event source. $ref: '#/components/schemas/SelfManagedEventSource' AmazonManagedKafkaEventSourceConfig: - description: Specific configuration settings for an MSK event source. + description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. $ref: '#/components/schemas/AmazonManagedKafkaEventSourceConfig' SelfManagedKafkaEventSourceConfig: - description: Specific configuration settings for a Self-Managed Apache Kafka event source. + description: Specific configuration settings for a self-managed Apache Kafka event source. $ref: '#/components/schemas/SelfManagedKafkaEventSourceConfig' ScalingConfig: - description: The scaling configuration for the event source. + description: (Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). $ref: '#/components/schemas/ScalingConfig' DocumentDBEventSourceConfig: - description: Document db event source config. + description: Specific configuration settings for a DocumentDB event source. $ref: '#/components/schemas/DocumentDBEventSourceConfig' + ProvisionedPollerConfig: + description: (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode). + $ref: '#/components/schemas/ProvisionedPollerConfig' + MetricsConfig: + description: The metrics configuration for your event source. For more information, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics). + $ref: '#/components/schemas/MetricsConfig' required: - FunctionName x-stackql-resource-name: event_source_mapping - x-stackql-primaryIdentifier: + description: |- + The ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function. + For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. + + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) + + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) + + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) + + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) + + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) + + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) + + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) + x-type-name: AWS::Lambda::EventSourceMapping + x-stackql-primary-identifier: - Id x-create-only-properties: - EventSourceArn - StartingPosition - StartingPositionTimestamp - SelfManagedEventSource - - AmazonManagedKafkaEventSourceConfig - - SelfManagedKafkaEventSourceConfig x-read-only-properties: - Id + - EventSourceMappingArn + x-required-properties: + - FunctionName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - lambda:ListTags + - lambda:TagResource + - lambda:UntagResource x-required-permissions: create: - lambda:CreateEventSourceMapping - lambda:GetEventSourceMapping + - lambda:TagResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt delete: - lambda:DeleteEventSourceMapping - lambda:GetEventSourceMapping + - kms:Decrypt list: - lambda:ListEventSourceMappings read: - lambda:GetEventSourceMapping + - lambda:ListTags + - kms:Decrypt update: - lambda:UpdateEventSourceMapping - lambda:GetEventSourceMapping + - lambda:TagResource + - lambda:UntagResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt ImageConfig: description: Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). additionalProperties: false @@ -495,7 +1250,7 @@ components: items: type: string DeadLetterConfig: - description: The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations. + description: The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) for failed asynchronous invocations. additionalProperties: false type: object properties: @@ -511,9 +1266,11 @@ components: UpdateRuntimeOn: description: |- Specify the runtime update mode. - + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. - + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. - + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incomp + + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). + + *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual`` type: string enum: - Auto @@ -559,10 +1316,15 @@ components: Code: description: |- The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. - Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template. + When you specify source code inline for a Node.js function, the ``index`` file that CFN creates uses the extension ``.js``. This means that LAM treats the file as a CommonJS module. ES modules aren't supported for inline functions. + Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template. additionalProperties: false type: object properties: + SourceKMSKeyArn: + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + description: The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an [owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk). + type: string S3ObjectVersion: minLength: 1 description: For versioned objects, the version of the deployment package object to use. @@ -577,8 +1339,9 @@ components: ZipFile: description: |- (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. - For JSON, you must escape quotes and special characters such as newline (``\n``) with a backslash. - If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs + When you specify source code inline for a Node.js function, the ``index`` file that CFN creates uses the extension ``.js``. This means that LAM treats the file as a CommonJS module. ES modules aren't supported for inline functions. + For JSON, you must escape quotes and special characters such as newline (``\n``) with a backslash. + If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details. type: string S3Key: minLength: 1 @@ -622,6 +1385,12 @@ components: - DEBUG - INFO - WARN + RecursiveLoop: + description: The function recursion configuration. + type: string + enum: + - Allow + - Terminate Environment: description: A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration. additionalProperties: false @@ -631,7 +1400,9 @@ components: x-patternProperties: '[a-zA-Z][a-zA-Z0-9_]+': type: string - description: Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). + description: |- + Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). + If the value of the environment variable is a time or a duration, enclose the value in quotes. additionalProperties: false type: object FileSystemConfig: @@ -640,7 +1411,7 @@ components: type: object properties: Arn: - pattern: ^arn:aws[a-zA-Z-]*:elasticfilesystem:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:access-point/fsap-[a-f0-9]{17}$ + pattern: ^arn:aws[a-zA-Z-]*:elasticfilesystem:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:access-point/fsap-[a-f0-9]{17}$ description: The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. type: string maxLength: 200 @@ -652,23 +1423,6 @@ components: required: - Arn - LocalMountPath - Tag: - description: '' - additionalProperties: false - type: object - properties: - Value: - minLength: 0 - description: '' - type: string - maxLength: 256 - Key: - minLength: 1 - description: '' - type: string - maxLength: 128 - required: - - Key EphemeralStorage: description: The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. additionalProperties: false @@ -720,14 +1474,20 @@ components: type: string Runtime: description: |- - The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. - The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy). + The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. + The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels). + For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported). type: string KmsKeyArn: pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ - description: >- - The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your - function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key. + description: |- + The ARN of the KMSlong (KMS) customer managed key that's used to encrypt the following resources: + + The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). + + The function's [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) snapshots. + + When used with ``SourceKMSKeyArn``, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see [Specifying a customer managed key for Lambda](https://docs.aws.amazon.com/lambda/latest/dg/encrypt-zip-package.html#enable-zip-custom-encryption). + + The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see [Function lifecycle](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-lifecycle). + + If you don't provide a customer managed key, Lambda uses an [owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) or an [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). type: string PackageType: description: The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive. @@ -736,7 +1496,7 @@ components: - Image - Zip CodeSigningConfigArn: - pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} + pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} description: To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. type: string Layers: @@ -747,7 +1507,9 @@ components: type: string Tags: uniqueItems: true - description: A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. + description: |- + A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. + You must have the ``lambda:TagResource``, ``lambda:UntagResource``, and ``lambda:ListTags`` permissions for your [principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. x-insertionOrder: false type: array items: @@ -774,7 +1536,11 @@ components: description: '' $ref: '#/components/schemas/SnapStartResponse' Code: - description: The code for the function. + description: |- + The code for the function. You can define your function code in multiple ways: + + For .zip deployment packages, you can specify the S3 location of the .zip file in the ``S3Bucket``, ``S3Key``, and ``S3ObjectVersion`` properties. + + For .zip deployment packages, you can alternatively define the function code inline in the ``ZipFile`` property. This method works only for Node.js and Python functions. + + For container images, specify the URI of your container image in the ECR registry in the ``ImageUri`` property. $ref: '#/components/schemas/Code' Role: pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ @@ -783,6 +1549,12 @@ components: LoggingConfig: description: The function's Amazon CloudWatch Logs configuration settings. $ref: '#/components/schemas/LoggingConfig' + RecursiveLoop: + description: |- + The status of your function's recursive loop detection configuration. + When this value is set to ``Allow``and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action. + When this value is set to ``Terminate`` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you. + $ref: '#/components/schemas/RecursiveLoop' Environment: description: Environment variables that are accessible from function code during execution. $ref: '#/components/schemas/Environment' @@ -807,19 +1579,52 @@ components: - Code - Role x-stackql-resource-name: function - x-stackql-primaryIdentifier: + description: >- + The ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon + CloudWatch Logs for log streaming and AWS X-Ray for request tracing. + You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For these functions, include the URI of the container image in the ECR registry in the [ImageUri property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri). You do not need to specify the handler and runtime properties. + You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For these functions, specify the S3 location of your .zip file in the ``Code`` property. Alternatively, for Node.js and Python functions, you can define your function inline in the [ZipFile property of the Code property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile). In both cases, you must also specify the handler and runtime properties. + You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. + When you update a ``AWS::Lambda::Function`` resource, CFNshort calls the [UpdateFunctionConfiguration](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionConfiguration.html) and [UpdateFunctionCode](https://docs.aws.amazon.com/lambda/latest/api/API_UpdateFunctionCode.html)LAM APIs under the hood. Because these calls happen sequentially, and invocations can happen between these calls, your function may encounter errors in the time between the calls. For example, if you remove an environment variable, and the code that references that environment variable in the same CFNshort update, you may see invocation errors related to a missing environment variable. To work around this, you can invoke your function against a version or alias by default, rather than the ``$LATEST`` version. + Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``. + For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.* + x-type-name: AWS::Lambda::Function + x-stackql-primary-identifier: - FunctionName x-create-only-properties: - FunctionName + - PackageType + x-write-only-properties: + - SnapStart + - SnapStart/ApplyOn + - Code/ImageUri + - Code/S3Bucket + - Code/S3Key + - Code/S3ObjectVersion + - Code/ZipFile x-read-only-properties: - SnapStartResponse - SnapStartResponse/ApplyOn - SnapStartResponse/OptimizationStatus - Arn + x-required-properties: + - Code + - Role + x-tagging: + permissions: + - lambda:ListTags + - lambda:TagResource + - lambda:UntagResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: read: - lambda:GetFunction - lambda:GetFunctionCodeSigningConfig + - lambda:GetFunctionRecursionConfig create: - lambda:CreateFunction - lambda:GetFunction @@ -841,16 +1646,12 @@ components: - lambda:GetRuntimeManagementConfig - lambda:PutRuntimeManagementConfig - lambda:TagResource - - lambda:GetPolicy - - lambda:AddPermission - - lambda:RemovePermission - - lambda:GetResourcePolicy - - lambda:PutResourcePolicy + - lambda:PutFunctionRecursionConfig + - lambda:GetFunctionRecursionConfig update: - lambda:DeleteFunctionConcurrency - lambda:GetFunction - lambda:PutFunctionConcurrency - - lambda:ListTags - lambda:TagResource - lambda:UntagResource - lambda:UpdateFunctionConfiguration @@ -871,12 +1672,8 @@ components: - lambda:DeleteFunctionCodeSigningConfig - lambda:GetCodeSigningConfig - lambda:GetFunctionCodeSigningConfig - - lambda:GetPolicy - - lambda:AddPermission - - lambda:RemovePermission - - lambda:GetResourcePolicy - - lambda:PutResourcePolicy - - lambda:DeleteResourcePolicy + - lambda:PutFunctionRecursionConfig + - lambda:GetFunctionRecursionConfig list: - lambda:ListFunctions delete: @@ -933,7 +1730,9 @@ components: required: - Content x-stackql-resource-name: layer_version - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lambda::LayerVersion + x-type-name: AWS::Lambda::LayerVersion + x-stackql-primary-identifier: - LayerVersionArn x-create-only-properties: - CompatibleRuntimes @@ -942,8 +1741,17 @@ components: - LayerName - Description - Content + x-write-only-properties: + - Content x-read-only-properties: - LayerVersionArn + x-required-properties: + - Content + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - lambda:PublishLayerVersion @@ -979,7 +1787,9 @@ components: - Action - Principal x-stackql-resource-name: layer_version_permission - x-stackql-primaryIdentifier: + description: Schema for Lambda LayerVersionPermission + x-type-name: AWS::Lambda::LayerVersionPermission + x-stackql-primary-identifier: - Id x-create-only-properties: - OrganizationId @@ -988,6 +1798,15 @@ components: - LayerVersionArn x-read-only-properties: - Id + x-required-properties: + - LayerVersionArn + - Action + - Principal + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - lambda:AddLayerVersionPermission @@ -1001,75 +1820,81 @@ components: Permission: type: object properties: - Id: - description: '' - type: string - pattern: ^.*$ + FunctionName: minLength: 1 - maxLength: 256 + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: |- + The name or ARN of the Lambda function, version, or alias. + **Name formats** + + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias). + + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``. + + *Partial ARN* – ``123456789012:function:my-function``. + + You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + type: string + maxLength: 140 Action: + minLength: 1 + pattern: ^(lambda:[*]|lambda:[a-zA-Z]+|[*])$ description: The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``. type: string - pattern: ^(lambda:[*]|lambda:[a-zA-Z]+|[*])$ - minLength: 1 maxLength: 256 EventSourceToken: + minLength: 1 + pattern: ^[a-zA-Z0-9._\-]+$ description: For Alexa Smart Home functions, a token that the invoker must supply. type: string - pattern: ^[a-zA-Z0-9._\-]+$ - minLength: 1 maxLength: 256 - FunctionName: - description: |- - The name of the Lambda function, version, or alias. - **Name formats** - + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias). - + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``. - + *Partial ARN* – ``123456789012:function:my-function``. - - You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. - type: string - pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ - minLength: 1 - maxLength: 140 FunctionUrlAuthType: description: The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). type: string enum: - AWS_IAM - NONE - Principal: - description: The AWS-service or AWS-account that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service. + SourceArn: + minLength: 12 + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*)$ + description: |- + For AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. + Note that Lambda configures the comparison using the ``StringLike`` operator. type: string - pattern: ^.*$ - minLength: 1 - maxLength: 256 + maxLength: 1024 + SourceAccount: + minLength: 12 + pattern: ^\d{12}$ + description: For AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account. + type: string + maxLength: 12 PrincipalOrgID: + minLength: 12 + pattern: ^o-[a-z0-9]{10,32}$ description: The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization. type: string - pattern: ^o-[a-z0-9]{10,32}$ - minLength: 12 maxLength: 34 - SourceAccount: - description: For AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account. + Id: + minLength: 1 + pattern: ^.*$ + description: '' type: string - pattern: ^\d{12}$ - minLength: 12 - maxLength: 12 - SourceArn: - description: |- - For AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. - Note that Lambda configures the comparison using the ``StringLike`` operator. + maxLength: 256 + Principal: + minLength: 1 + pattern: ^.*$ + description: The AWS-service, AWS-account, IAM user, or IAM role that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service. type: string - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*)$ - minLength: 12 - maxLength: 1024 + maxLength: 256 required: - FunctionName - Action - Principal x-stackql-resource-name: permission - x-stackql-primaryIdentifier: + description: |- + The ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. + To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. + If your function has a function URL, you can specify the ``FunctionUrlAuthType`` parameter. This adds a condition to your permission that only applies when your function URL's ``AuthType`` matches the specified ``FunctionUrlAuthType``. For more information about the ``AuthType`` parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html). + x-type-name: AWS::Lambda::Permission + x-stackql-primary-identifier: - FunctionName - Id x-create-only-properties: @@ -1083,15 +1908,24 @@ components: - EventSourceToken x-read-only-properties: - Id + x-required-properties: + - FunctionName + - Action + - Principal + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: + read: + - lambda:GetPolicy create: - lambda:AddPermission - read: + list: - lambda:GetPolicy delete: - lambda:RemovePermission - list: - - lambda:GetPolicy AllowHeaders: items: type: string @@ -1177,7 +2011,7 @@ components: - AWS_IAM - NONE InvokeMode: - description: The invocation mode for the function’s URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED. + description: The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED. type: string enum: - BUFFERED @@ -1195,7 +2029,9 @@ components: - TargetFunctionArn - AuthType x-stackql-resource-name: url - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lambda::Url + x-type-name: AWS::Lambda::Url + x-stackql-primary-identifier: - FunctionArn x-create-only-properties: - TargetFunctionArn @@ -1203,6 +2039,11 @@ components: x-read-only-properties: - FunctionUrl - FunctionArn + x-required-properties: + - TargetFunctionArn + - AuthType + x-tagging: + taggable: false x-required-permissions: create: - lambda:CreateFunctionUrlConfig @@ -1214,16 +2055,6 @@ components: - lambda:ListFunctionUrlConfigs delete: - lambda:DeleteFunctionUrlConfig - ProvisionedConcurrencyConfiguration: - type: object - description: A provisioned concurrency configuration for a function's version. - additionalProperties: false - properties: - ProvisionedConcurrentExecutions: - type: integer - description: The amount of provisioned concurrency to allocate for the version. - required: - - ProvisionedConcurrentExecutions RuntimePolicy: type: object description: Runtime Management Config of a function. @@ -1234,7 +2065,7 @@ components: description: The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned. minLength: 26 maxLength: 2048 - pattern: ^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$ + pattern: ^arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}::runtime:.+$ UpdateRuntimeOn: type: string description: The runtime update mode. @@ -1246,6 +2077,7 @@ components: FunctionArn: type: string description: The ARN of the version. + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ Version: type: string description: The version number. @@ -1262,7 +2094,7 @@ components: description: The name of the Lambda function. minLength: 1 maxLength: 140 - pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ ProvisionedConcurrencyConfig: description: Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property. $ref: '#/components/schemas/ProvisionedConcurrencyConfiguration' @@ -1272,7 +2104,9 @@ components: required: - FunctionName x-stackql-resource-name: version - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lambda::Version + x-type-name: AWS::Lambda::Version + x-stackql-primary-identifier: - FunctionArn x-create-only-properties: - FunctionName @@ -1283,6 +2117,13 @@ components: x-read-only-properties: - Version - FunctionArn + x-required-properties: + - FunctionName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - lambda:PublishVersion @@ -1300,15 +2141,844 @@ components: - lambda:DeleteFunction list: - lambda:ListVersionsByFunction - update: [] + CreateAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FunctionName: + description: The name of the Lambda function. + type: string + AliasArn: + description: Lambda Alias ARN generated by the service. + type: string + ProvisionedConcurrencyConfig: + description: Specifies a provisioned concurrency configuration for a function's alias. + $ref: '#/components/schemas/ProvisionedConcurrencyConfiguration' + Description: + description: A description of the alias. + type: string + FunctionVersion: + description: The function version that the alias invokes. + type: string + RoutingConfig: + description: The routing configuration of the alias. + $ref: '#/components/schemas/AliasRoutingConfiguration' + Name: + description: The name of the alias. + type: string + x-stackQL-stringOnly: true + x-title: CreateAliasRequest + type: object + required: [] + CreateCodeSigningConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A description of the CodeSigningConfig + type: string + minLength: 0 + maxLength: 256 + AllowedPublishers: + description: When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list + $ref: '#/components/schemas/AllowedPublishers' + CodeSigningPolicies: + description: Policies to control how to act if a signature is invalid + $ref: '#/components/schemas/CodeSigningPolicies' + CodeSigningConfigId: + description: A unique identifier for CodeSigningConfig resource + type: string + pattern: csc-[a-zA-Z0-9-_\.]{17} + CodeSigningConfigArn: + description: A unique Arn for CodeSigningConfig resource + type: string + pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} + Tags: + description: A list of tags to apply to CodeSigningConfig resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCodeSigningConfigRequest + type: object + required: [] + CreateEventInvokeConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DestinationConfig: + $ref: '#/components/schemas/DestinationConfig' + FunctionName: + description: The name of the Lambda function. + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]+(-[a-z]+)+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + MaximumEventAgeInSeconds: + description: The maximum age of a request that Lambda sends to a function for processing. + type: integer + minimum: 60 + maximum: 21600 + MaximumRetryAttempts: + description: The maximum number of times to retry when the function returns an error. + type: integer + minimum: 0 + maximum: 2 + Qualifier: + description: The identifier of a version or alias. + type: string + pattern: ^(|[a-zA-Z0-9$_-]{1,129})$ + x-stackQL-stringOnly: true + x-title: CreateEventInvokeConfigRequest + type: object + required: [] + CreateEventSourceMappingRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: '' + type: string + pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' + minLength: 36 + maxLength: 36 + BatchSize: + description: |- + The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). + + *Amazon Kinesis* – Default 100. Max 10,000. + + *Amazon DynamoDB Streams* – Default 100. Max 10,000. + + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. + + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. + + *Self-managed Apache Kafka* – Default 100. Max 10,000. + + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. + + *DocumentDB* – Default 100. Max 10,000. + type: integer + minimum: 1 + maximum: 10000 + BisectBatchOnFunctionError: + description: |- + (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. + When using ``BisectBatchOnFunctionError``, check the ``BatchSize`` parameter in the ``OnFailure`` destination message's metadata. The ``BatchSize`` could be greater than 1 since LAM consolidates failed messages metadata when writing to the ``OnFailure`` destination. + type: boolean + DestinationConfig: + description: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it. + $ref: '#/components/schemas/DestinationConfig' + Enabled: + description: |- + When true, the event source mapping is active. When false, Lambda pauses polling and invocation. + Default: True + type: boolean + EventSourceArn: + description: |- + The Amazon Resource Name (ARN) of the event source. + + *Amazon Kinesis* – The ARN of the data stream or a stream consumer. + + *Amazon DynamoDB Streams* – The ARN of the stream. + + *Amazon Simple Queue Service* – The ARN of the queue. + + *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)). + + *Amazon MQ* – The ARN of the broker. + + *Amazon DocumentDB* – The ARN of the DocumentDB change stream. + type: string + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*) + minLength: 12 + maxLength: 1024 + EventSourceMappingArn: + description: '' + type: string + pattern: arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} + minLength: 85 + maxLength: 120 + FilterCriteria: + description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + $ref: '#/components/schemas/FilterCriteria' + KmsKeyArn: + description: The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics). + type: string + pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() + minLength: 12 + maxLength: 2048 + FunctionName: + description: |- + The name or ARN of the Lambda function. + **Name formats** + + *Function name* – ``MyFunction``. + + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``. + + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``. + + *Partial ARN* – ``123456789012:function:MyFunction``. + + The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. + type: string + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? + minLength: 1 + maxLength: 140 + MaximumBatchingWindowInSeconds: + description: |- + The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. + *Default (, , event sources)*: 0 + *Default (, Kafka, , event sources)*: 500 ms + *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1. + type: integer + minimum: 0 + maximum: 300 + MaximumRecordAgeInSeconds: + description: |- + (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. + The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed + type: integer + minimum: -1 + maximum: 604800 + MaximumRetryAttempts: + description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. + type: integer + minimum: -1 + maximum: 10000 + ParallelizationFactor: + description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. + type: integer + minimum: 1 + maximum: 10 + StartingPosition: + description: |- + The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. + + *LATEST* - Read only new records. + + *TRIM_HORIZON* - Process all available records. + + *AT_TIMESTAMP* - Specify a time from which to start reading records. + type: string + pattern: (LATEST|TRIM_HORIZON|AT_TIMESTAMP)+ + minLength: 6 + maxLength: 12 + StartingPositionTimestamp: + description: With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future. + type: number + Tags: + description: |- + A list of tags to add to the event source mapping. + You must have the ``lambda:TagResource``, ``lambda:UntagResource``, and ``lambda:ListTags`` permissions for your [principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Topics: + description: The name of the Kafka topic. + type: array + uniqueItems: true + items: + type: string + pattern: ^[^.]([a-zA-Z0-9\-_.]+) + minLength: 1 + maxLength: 249 + minItems: 1 + maxItems: 1 + Queues: + description: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. + type: array + uniqueItems: true + items: + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 1000 + minItems: 1 + maxItems: 1 + SourceAccessConfigurations: + description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/SourceAccessConfiguration' + minItems: 1 + maxItems: 22 + TumblingWindowInSeconds: + description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. + type: integer + minimum: 0 + maximum: 900 + FunctionResponseTypes: + description: |- + (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping. + Valid Values: ``ReportBatchItemFailures`` + type: array + uniqueItems: true + items: + type: string + enum: + - ReportBatchItemFailures + minLength: 0 + maxLength: 1 + SelfManagedEventSource: + description: The self-managed Apache Kafka cluster for your event source. + $ref: '#/components/schemas/SelfManagedEventSource' + AmazonManagedKafkaEventSourceConfig: + description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. + $ref: '#/components/schemas/AmazonManagedKafkaEventSourceConfig' + SelfManagedKafkaEventSourceConfig: + description: Specific configuration settings for a self-managed Apache Kafka event source. + $ref: '#/components/schemas/SelfManagedKafkaEventSourceConfig' + ScalingConfig: + description: (Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + $ref: '#/components/schemas/ScalingConfig' + DocumentDBEventSourceConfig: + description: Specific configuration settings for a DocumentDB event source. + $ref: '#/components/schemas/DocumentDBEventSourceConfig' + ProvisionedPollerConfig: + description: (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode). + $ref: '#/components/schemas/ProvisionedPollerConfig' + MetricsConfig: + description: The metrics configuration for your event source. For more information, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics). + $ref: '#/components/schemas/MetricsConfig' + x-stackQL-stringOnly: true + x-title: CreateEventSourceMappingRequest + type: object + required: [] + CreateFunctionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A description of the function. + type: string + maxLength: 256 + TracingConfig: + description: Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). + $ref: '#/components/schemas/TracingConfig' + VpcConfig: + description: For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + $ref: '#/components/schemas/VpcConfig' + RuntimeManagementConfig: + description: Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). + $ref: '#/components/schemas/RuntimeManagementConfig' + ReservedConcurrentExecutions: + description: The number of simultaneous executions to reserve for the function. + type: integer + minimum: 0 + SnapStart: + description: The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. + $ref: '#/components/schemas/SnapStart' + FileSystemConfigs: + maxItems: 1 + description: |- + Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. + For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html). + type: array + items: + $ref: '#/components/schemas/FileSystemConfig' + FunctionName: + minLength: 1 + description: |- + The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + type: string + Runtime: + description: |- + The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. + The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels). + For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported). + type: string + KmsKeyArn: + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ + description: |- + The ARN of the KMSlong (KMS) customer managed key that's used to encrypt the following resources: + + The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). + + The function's [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) snapshots. + + When used with ``SourceKMSKeyArn``, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see [Specifying a customer managed key for Lambda](https://docs.aws.amazon.com/lambda/latest/dg/encrypt-zip-package.html#enable-zip-custom-encryption). + + The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see [Function lifecycle](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-lifecycle). + + If you don't provide a customer managed key, Lambda uses an [owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) or an [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). + type: string + PackageType: + description: The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive. + type: string + enum: + - Image + - Zip + CodeSigningConfigArn: + pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} + description: To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. + type: string + Layers: + uniqueItems: false + description: A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version. + type: array + items: + type: string + Tags: + uniqueItems: true + description: |- + A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. + You must have the ``lambda:TagResource``, ``lambda:UntagResource``, and ``lambda:ListTags`` permissions for your [principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + ImageConfig: + description: Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). + $ref: '#/components/schemas/ImageConfig' + MemorySize: + description: The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. + type: integer + DeadLetterConfig: + description: A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). + $ref: '#/components/schemas/DeadLetterConfig' + Timeout: + description: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). + type: integer + minimum: 1 + Handler: + pattern: ^[^\s]+$ + description: The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html). + type: string + maxLength: 128 + SnapStartResponse: + description: '' + $ref: '#/components/schemas/SnapStartResponse' + Code: + description: |- + The code for the function. You can define your function code in multiple ways: + + For .zip deployment packages, you can specify the S3 location of the .zip file in the ``S3Bucket``, ``S3Key``, and ``S3ObjectVersion`` properties. + + For .zip deployment packages, you can alternatively define the function code inline in the ``ZipFile`` property. This method works only for Node.js and Python functions. + + For container images, specify the URI of your container image in the ECR registry in the ``ImageUri`` property. + $ref: '#/components/schemas/Code' + Role: + pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + description: The Amazon Resource Name (ARN) of the function's execution role. + type: string + LoggingConfig: + description: The function's Amazon CloudWatch Logs configuration settings. + $ref: '#/components/schemas/LoggingConfig' + RecursiveLoop: + description: |- + The status of your function's recursive loop detection configuration. + When this value is set to ``Allow``and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action. + When this value is set to ``Terminate`` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you. + $ref: '#/components/schemas/RecursiveLoop' + Environment: + description: Environment variables that are accessible from function code during execution. + $ref: '#/components/schemas/Environment' + Arn: + description: '' + type: string + EphemeralStorage: + description: The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. + $ref: '#/components/schemas/EphemeralStorage' + Architectures: + minItems: 1 + maxItems: 1 + uniqueItems: true + description: The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``. + type: array + items: + type: string + enum: + - x86_64 + - arm64 + x-stackQL-stringOnly: true + x-title: CreateFunctionRequest + type: object + required: [] + CreateLayerVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CompatibleRuntimes: + description: A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions. + type: array + x-insertionOrder: false + uniqueItems: false + items: + type: string + LicenseInfo: + description: The layer's software license. + type: string + Description: + description: The description of the version. + type: string + LayerName: + description: The name or Amazon Resource Name (ARN) of the layer. + type: string + Content: + description: The function layer archive. + $ref: '#/components/schemas/Content' + LayerVersionArn: + type: string + CompatibleArchitectures: + description: A list of compatible instruction set architectures. + type: array + x-insertionOrder: false + uniqueItems: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateLayerVersionRequest + type: object + required: [] + CreateLayerVersionPermissionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: ID generated by service + type: string + Action: + description: The API action that grants access to the layer. + type: string + LayerVersionArn: + description: The name or Amazon Resource Name (ARN) of the layer. + type: string + OrganizationId: + description: With the principal set to *, grant permission to all accounts in the specified organization. + type: string + Principal: + description: An account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified). + type: string + x-stackQL-stringOnly: true + x-title: CreateLayerVersionPermissionRequest + type: object + required: [] + CreatePermissionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FunctionName: + minLength: 1 + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: |- + The name or ARN of the Lambda function, version, or alias. + **Name formats** + + *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias). + + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``. + + *Partial ARN* – ``123456789012:function:my-function``. + + You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. + type: string + maxLength: 140 + Action: + minLength: 1 + pattern: ^(lambda:[*]|lambda:[a-zA-Z]+|[*])$ + description: The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``. + type: string + maxLength: 256 + EventSourceToken: + minLength: 1 + pattern: ^[a-zA-Z0-9._\-]+$ + description: For Alexa Smart Home functions, a token that the invoker must supply. + type: string + maxLength: 256 + FunctionUrlAuthType: + description: The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + type: string + enum: + - AWS_IAM + - NONE + SourceArn: + minLength: 12 + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*)$ + description: |- + For AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. + Note that Lambda configures the comparison using the ``StringLike`` operator. + type: string + maxLength: 1024 + SourceAccount: + minLength: 12 + pattern: ^\d{12}$ + description: For AWS-service, the ID of the AWS-account that owns the resource. Use this together with ``SourceArn`` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account. + type: string + maxLength: 12 + PrincipalOrgID: + minLength: 12 + pattern: ^o-[a-z0-9]{10,32}$ + description: The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization. + type: string + maxLength: 34 + Id: + minLength: 1 + pattern: ^.*$ + description: '' + type: string + maxLength: 256 + Principal: + minLength: 1 + pattern: ^.*$ + description: The AWS-service, AWS-account, IAM user, or IAM role that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service. + type: string + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreatePermissionRequest + type: object + required: [] + CreateUrlRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TargetFunctionArn: + description: The Amazon Resource Name (ARN) of the function associated with the Function URL. + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\d+)[0-9a-zA-Z-_]+))?$ + Qualifier: + description: The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed. + type: string + minLength: 1 + maxLength: 128 + pattern: ((?!^[0-9]+$)([a-zA-Z0-9-_]+)) + AuthType: + description: Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL. + type: string + enum: + - AWS_IAM + - NONE + InvokeMode: + description: The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED. + type: string + enum: + - BUFFERED + - RESPONSE_STREAM + FunctionArn: + description: The full Amazon Resource Name (ARN) of the function associated with the Function URL. + type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:((?!\d+)[0-9a-zA-Z-_]+))?$ + FunctionUrl: + description: The generated url for this resource. + type: string + Cors: + $ref: '#/components/schemas/Cors' + x-stackQL-stringOnly: true + x-title: CreateUrlRequest + type: object + required: [] + CreateVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FunctionArn: + type: string + description: The ARN of the version. + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + Version: + type: string + description: The version number. + CodeSha256: + type: string + description: Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property. + Description: + type: string + description: A description for the version to override the description in the function configuration. Updates are not supported for this property. + minLength: 0 + maxLength: 256 + FunctionName: + type: string + description: The name of the Lambda function. + minLength: 1 + maxLength: 140 + pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + ProvisionedConcurrencyConfig: + description: Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property. + $ref: '#/components/schemas/ProvisionedConcurrencyConfiguration' + RuntimePolicy: + description: Specifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual. + $ref: '#/components/schemas/RuntimePolicy' + x-stackQL-stringOnly: true + x-title: CreateVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - code_signing_configs: - name: code_signing_configs - id: awscc.lambda.code_signing_configs - x-cfn-schema-name: CodeSigningConfig - x-type: list + aliases: + name: aliases + id: awscc.lambda.aliases + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::Lambda::Alias x-identifiers: - - CodeSigningConfigArn + - AliasArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.AliasArn') as alias_arn, + JSON_EXTRACT(Properties, '$.ProvisionedConcurrencyConfig') as provisioned_concurrency_config, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FunctionVersion') as function_version, + JSON_EXTRACT(Properties, '$.RoutingConfig') as routing_config, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'AliasArn') as alias_arn, + json_extract_path_text(Properties, 'ProvisionedConcurrencyConfig') as provisioned_concurrency_config, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FunctionVersion') as function_version, + json_extract_path_text(Properties, 'RoutingConfig') as routing_config, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + aliases_list_only: + name: aliases_list_only + id: awscc.lambda.aliases_list_only + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::Lambda::Alias + x-identifiers: + - AliasArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1316,28 +2986,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CodeSigningConfigArn') as code_signing_config_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' + JSON_EXTRACT(Properties, '$.AliasArn') as alias_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Alias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' + json_extract_path_text(Properties, 'AliasArn') as alias_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Alias' AND region = 'us-east-1' - code_signing_config: - name: code_signing_config - id: awscc.lambda.code_signing_config + code_signing_configs: + name: code_signing_configs + id: awscc.lambda.code_signing_configs x-cfn-schema-name: CodeSigningConfig - x-type: get + x-cfn-type-name: AWS::Lambda::CodeSigningConfig x-identifiers: - CodeSigningConfigArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CodeSigningConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::CodeSigningConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::CodeSigningConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::CodeSigningConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/code_signing_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/code_signing_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/code_signing_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1346,12 +3064,13 @@ components: JSON_EXTRACT(Properties, '$.AllowedPublishers') as allowed_publishers, JSON_EXTRACT(Properties, '$.CodeSigningPolicies') as code_signing_policies, JSON_EXTRACT(Properties, '$.CodeSigningConfigId') as code_signing_config_id, - JSON_EXTRACT(Properties, '$.CodeSigningConfigArn') as code_signing_config_arn + JSON_EXTRACT(Properties, '$.CodeSigningConfigArn') as code_signing_config_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1360,18 +3079,24 @@ components: json_extract_path_text(Properties, 'AllowedPublishers') as allowed_publishers, json_extract_path_text(Properties, 'CodeSigningPolicies') as code_signing_policies, json_extract_path_text(Properties, 'CodeSigningConfigId') as code_signing_config_id, - json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn + json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' AND data__Identifier = '' AND region = 'us-east-1' - event_invoke_configs: - name: event_invoke_configs - id: awscc.lambda.event_invoke_configs - x-cfn-schema-name: EventInvokeConfig - x-type: list + code_signing_configs_list_only: + name: code_signing_configs_list_only + id: awscc.lambda.code_signing_configs_list_only + x-cfn-schema-name: CodeSigningConfig + x-cfn-type-name: AWS::Lambda::CodeSigningConfig x-identifiers: - - FunctionName - - Qualifier + - CodeSigningConfigArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1379,31 +3104,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name, - JSON_EXTRACT(Properties, '$.Qualifier') as qualifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' + JSON_EXTRACT(Properties, '$.CodeSigningConfigArn') as code_signing_config_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'Qualifier') as qualifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' + json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' AND region = 'us-east-1' - event_invoke_config: - name: event_invoke_config - id: awscc.lambda.event_invoke_config + event_invoke_configs: + name: event_invoke_configs + id: awscc.lambda.event_invoke_configs x-cfn-schema-name: EventInvokeConfig - x-type: get + x-cfn-type-name: AWS::Lambda::EventInvokeConfig x-identifiers: - FunctionName - Qualifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventInvokeConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventInvokeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventInvokeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventInvokeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_invoke_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_invoke_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_invoke_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1417,7 +3188,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1430,13 +3201,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' AND data__Identifier = '|' AND region = 'us-east-1' - event_source_mappings: - name: event_source_mappings - id: awscc.lambda.event_source_mappings - x-cfn-schema-name: EventSourceMapping - x-type: list + event_invoke_configs_list_only: + name: event_invoke_configs_list_only + id: awscc.lambda.event_invoke_configs_list_only + x-cfn-schema-name: EventInvokeConfig + x-cfn-type-name: AWS::Lambda::EventInvokeConfig x-identifiers: - - Id + - FunctionName + - Qualifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1444,28 +3222,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' + JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.Qualifier') as qualifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'Qualifier') as qualifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' AND region = 'us-east-1' - event_source_mapping: - name: event_source_mapping - id: awscc.lambda.event_source_mapping + event_source_mappings: + name: event_source_mappings + id: awscc.lambda.event_source_mappings x-cfn-schema-name: EventSourceMapping - x-type: get + x-cfn-type-name: AWS::Lambda::EventSourceMapping x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventSourceMapping&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventSourceMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventSourceMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventSourceMapping" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1476,7 +3304,9 @@ components: JSON_EXTRACT(Properties, '$.DestinationConfig') as destination_config, JSON_EXTRACT(Properties, '$.Enabled') as enabled, JSON_EXTRACT(Properties, '$.EventSourceArn') as event_source_arn, + JSON_EXTRACT(Properties, '$.EventSourceMappingArn') as event_source_mapping_arn, JSON_EXTRACT(Properties, '$.FilterCriteria') as filter_criteria, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, JSON_EXTRACT(Properties, '$.FunctionName') as function_name, JSON_EXTRACT(Properties, '$.MaximumBatchingWindowInSeconds') as maximum_batching_window_in_seconds, JSON_EXTRACT(Properties, '$.MaximumRecordAgeInSeconds') as maximum_record_age_in_seconds, @@ -1484,6 +3314,7 @@ components: JSON_EXTRACT(Properties, '$.ParallelizationFactor') as parallelization_factor, JSON_EXTRACT(Properties, '$.StartingPosition') as starting_position, JSON_EXTRACT(Properties, '$.StartingPositionTimestamp') as starting_position_timestamp, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Topics') as topics, JSON_EXTRACT(Properties, '$.Queues') as queues, JSON_EXTRACT(Properties, '$.SourceAccessConfigurations') as source_access_configurations, @@ -1493,12 +3324,14 @@ components: JSON_EXTRACT(Properties, '$.AmazonManagedKafkaEventSourceConfig') as amazon_managed_kafka_event_source_config, JSON_EXTRACT(Properties, '$.SelfManagedKafkaEventSourceConfig') as self_managed_kafka_event_source_config, JSON_EXTRACT(Properties, '$.ScalingConfig') as scaling_config, - JSON_EXTRACT(Properties, '$.DocumentDBEventSourceConfig') as document_db_event_source_config + JSON_EXTRACT(Properties, '$.DocumentDBEventSourceConfig') as document_db_event_source_config, + JSON_EXTRACT(Properties, '$.ProvisionedPollerConfig') as provisioned_poller_config, + JSON_EXTRACT(Properties, '$.MetricsConfig') as metrics_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1509,7 +3342,9 @@ components: json_extract_path_text(Properties, 'DestinationConfig') as destination_config, json_extract_path_text(Properties, 'Enabled') as enabled, json_extract_path_text(Properties, 'EventSourceArn') as event_source_arn, + json_extract_path_text(Properties, 'EventSourceMappingArn') as event_source_mapping_arn, json_extract_path_text(Properties, 'FilterCriteria') as filter_criteria, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, json_extract_path_text(Properties, 'FunctionName') as function_name, json_extract_path_text(Properties, 'MaximumBatchingWindowInSeconds') as maximum_batching_window_in_seconds, json_extract_path_text(Properties, 'MaximumRecordAgeInSeconds') as maximum_record_age_in_seconds, @@ -1517,6 +3352,7 @@ components: json_extract_path_text(Properties, 'ParallelizationFactor') as parallelization_factor, json_extract_path_text(Properties, 'StartingPosition') as starting_position, json_extract_path_text(Properties, 'StartingPositionTimestamp') as starting_position_timestamp, + json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Topics') as topics, json_extract_path_text(Properties, 'Queues') as queues, json_extract_path_text(Properties, 'SourceAccessConfigurations') as source_access_configurations, @@ -1526,17 +3362,25 @@ components: json_extract_path_text(Properties, 'AmazonManagedKafkaEventSourceConfig') as amazon_managed_kafka_event_source_config, json_extract_path_text(Properties, 'SelfManagedKafkaEventSourceConfig') as self_managed_kafka_event_source_config, json_extract_path_text(Properties, 'ScalingConfig') as scaling_config, - json_extract_path_text(Properties, 'DocumentDBEventSourceConfig') as document_db_event_source_config + json_extract_path_text(Properties, 'DocumentDBEventSourceConfig') as document_db_event_source_config, + json_extract_path_text(Properties, 'ProvisionedPollerConfig') as provisioned_poller_config, + json_extract_path_text(Properties, 'MetricsConfig') as metrics_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' AND data__Identifier = '' AND region = 'us-east-1' - functions: - name: functions - id: awscc.lambda.functions - x-cfn-schema-name: Function - x-type: list + event_source_mappings_list_only: + name: event_source_mappings_list_only + id: awscc.lambda.event_source_mappings_list_only + x-cfn-schema-name: EventSourceMapping + x-cfn-type-name: AWS::Lambda::EventSourceMapping x-identifiers: - - FunctionName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1544,28 +3388,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FunctionName') as function_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' AND region = 'us-east-1' - function: - name: function - id: awscc.lambda.function + functions: + name: functions + id: awscc.lambda.functions x-cfn-schema-name: Function - x-type: get + x-cfn-type-name: AWS::Lambda::Function x-identifiers: - FunctionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Function&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Function" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Function" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Function" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/functions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1593,6 +3485,7 @@ components: JSON_EXTRACT(Properties, '$.Code') as code, JSON_EXTRACT(Properties, '$.Role') as role, JSON_EXTRACT(Properties, '$.LoggingConfig') as logging_config, + JSON_EXTRACT(Properties, '$.RecursiveLoop') as recursive_loop, JSON_EXTRACT(Properties, '$.Environment') as environment, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.EphemeralStorage') as ephemeral_storage, @@ -1601,7 +3494,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1629,6 +3522,7 @@ components: json_extract_path_text(Properties, 'Code') as code, json_extract_path_text(Properties, 'Role') as role, json_extract_path_text(Properties, 'LoggingConfig') as logging_config, + json_extract_path_text(Properties, 'RecursiveLoop') as recursive_loop, json_extract_path_text(Properties, 'Environment') as environment, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, @@ -1636,13 +3530,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Function' AND data__Identifier = '' AND region = 'us-east-1' - layer_versions: - name: layer_versions - id: awscc.lambda.layer_versions - x-cfn-schema-name: LayerVersion - x-type: list + functions_list_only: + name: functions_list_only + id: awscc.lambda.functions_list_only + x-cfn-schema-name: Function + x-cfn-type-name: AWS::Lambda::Function x-identifiers: - - LayerVersionArn + - FunctionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1650,28 +3550,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LayerVersionArn') as layer_version_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' + JSON_EXTRACT(Properties, '$.FunctionName') as function_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' + json_extract_path_text(Properties, 'FunctionName') as function_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' AND region = 'us-east-1' - layer_version: - name: layer_version - id: awscc.lambda.layer_version + layer_versions: + name: layer_versions + id: awscc.lambda.layer_versions x-cfn-schema-name: LayerVersion - x-type: get + x-cfn-type-name: AWS::Lambda::LayerVersion x-identifiers: - LayerVersionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LayerVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::LayerVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::LayerVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/layer_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/layer_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1687,7 +3622,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1702,13 +3637,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::LayerVersion' AND data__Identifier = '' AND region = 'us-east-1' - layer_version_permissions: - name: layer_version_permissions - id: awscc.lambda.layer_version_permissions - x-cfn-schema-name: LayerVersionPermission - x-type: list + layer_versions_list_only: + name: layer_versions_list_only + id: awscc.lambda.layer_versions_list_only + x-cfn-schema-name: LayerVersion + x-cfn-type-name: AWS::Lambda::LayerVersion x-identifiers: - - Id + - LayerVersionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1716,28 +3657,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' + JSON_EXTRACT(Properties, '$.LayerVersionArn') as layer_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' + json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' AND region = 'us-east-1' - layer_version_permission: - name: layer_version_permission - id: awscc.lambda.layer_version_permission + layer_version_permissions: + name: layer_version_permissions + id: awscc.lambda.layer_version_permissions x-cfn-schema-name: LayerVersionPermission - x-type: get + x-cfn-type-name: AWS::Lambda::LayerVersionPermission x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LayerVersionPermission&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::LayerVersionPermission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::LayerVersionPermission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/layer_version_permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/layer_version_permissions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1751,7 +3727,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1764,14 +3740,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' AND data__Identifier = '' AND region = 'us-east-1' - permissions: - name: permissions - id: awscc.lambda.permissions - x-cfn-schema-name: Permission - x-type: list + layer_version_permissions_list_only: + name: layer_version_permissions_list_only + id: awscc.lambda.layer_version_permissions_list_only + x-cfn-schema-name: LayerVersionPermission + x-cfn-type-name: AWS::Lambda::LayerVersionPermission x-identifiers: - - FunctionName - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1779,72 +3760,112 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FunctionName') as function_name, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' AND region = 'us-east-1' - permission: - name: permission - id: awscc.lambda.permission + permissions: + name: permissions + id: awscc.lambda.permissions x-cfn-schema-name: Permission - x-type: get + x-cfn-type-name: AWS::Lambda::Permission x-identifiers: - FunctionName - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.FunctionName') as function_name, JSON_EXTRACT(Properties, '$.Action') as action, JSON_EXTRACT(Properties, '$.EventSourceToken') as event_source_token, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name, JSON_EXTRACT(Properties, '$.FunctionUrlAuthType') as function_url_auth_type, - JSON_EXTRACT(Properties, '$.Principal') as principal, - JSON_EXTRACT(Properties, '$.PrincipalOrgID') as principal_org_id, + JSON_EXTRACT(Properties, '$.SourceArn') as source_arn, JSON_EXTRACT(Properties, '$.SourceAccount') as source_account, - JSON_EXTRACT(Properties, '$.SourceArn') as source_arn + JSON_EXTRACT(Properties, '$.PrincipalOrgID') as principal_org_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Principal') as principal FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Permission' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'FunctionName') as function_name, json_extract_path_text(Properties, 'Action') as action, json_extract_path_text(Properties, 'EventSourceToken') as event_source_token, - json_extract_path_text(Properties, 'FunctionName') as function_name, json_extract_path_text(Properties, 'FunctionUrlAuthType') as function_url_auth_type, - json_extract_path_text(Properties, 'Principal') as principal, - json_extract_path_text(Properties, 'PrincipalOrgID') as principal_org_id, + json_extract_path_text(Properties, 'SourceArn') as source_arn, json_extract_path_text(Properties, 'SourceAccount') as source_account, - json_extract_path_text(Properties, 'SourceArn') as source_arn + json_extract_path_text(Properties, 'PrincipalOrgID') as principal_org_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Principal') as principal FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Permission' AND data__Identifier = '|' AND region = 'us-east-1' - urls: - name: urls - id: awscc.lambda.urls - x-cfn-schema-name: Url - x-type: list + permissions_list_only: + name: permissions_list_only + id: awscc.lambda.permissions_list_only + x-cfn-schema-name: Permission + x-cfn-type-name: AWS::Lambda::Permission x-identifiers: - - FunctionArn + - FunctionName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1852,28 +3873,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' + JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FunctionArn') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' AND region = 'us-east-1' - url: - name: url - id: awscc.lambda.url + urls: + name: urls + id: awscc.lambda.urls x-cfn-schema-name: Url - x-type: get + x-cfn-type-name: AWS::Lambda::Url x-identifiers: - FunctionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Url&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Url" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Url" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Url" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/urls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/urls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/urls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1889,7 +3960,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1904,13 +3975,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Url' AND data__Identifier = '' AND region = 'us-east-1' - versions: - name: versions - id: awscc.lambda.versions - x-cfn-schema-name: Version - x-type: list + urls_list_only: + name: urls_list_only + id: awscc.lambda.urls_list_only + x-cfn-schema-name: Url + x-cfn-type-name: AWS::Lambda::Url x-identifiers: - FunctionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1919,7 +3996,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1927,19 +4004,54 @@ components: SELECT region, json_extract_path_text(Properties, 'FunctionArn') as function_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' AND region = 'us-east-1' - version: - name: version - id: awscc.lambda.version + versions: + name: versions + id: awscc.lambda.versions x-cfn-schema-name: Version - x-type: get + x-cfn-type-name: AWS::Lambda::Version x-identifiers: - FunctionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Version&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Version" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::Version" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1955,7 +4067,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1970,3 +4082,607 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Version' AND data__Identifier = '' AND region = 'us-east-1' + versions_list_only: + name: versions_list_only + id: awscc.lambda.versions_list_only + x-cfn-schema-name: Version + x-cfn-type-name: AWS::Lambda::Version + x-identifiers: + - FunctionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionArn') as function_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CodeSigningConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCodeSigningConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCodeSigningConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventInvokeConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventInvokeConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventInvokeConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventSourceMapping&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventSourceMapping + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventSourceMappingRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Function&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFunction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFunctionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LayerVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLayerVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLayerVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LayerVersionPermission&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLayerVersionPermission + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLayerVersionPermissionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePermission + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePermissionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Url&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUrl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUrlRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Version&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/launchwizard.yaml b/providers/src/awscc/v00.00.00000/services/launchwizard.yaml new file mode 100644 index 00000000..a91015ef --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/launchwizard.yaml @@ -0,0 +1,994 @@ +openapi: 3.0.0 +info: + title: LaunchWizard + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + DeploymentSpecifications: + type: object + maxProperties: 100 + minProperties: 1 + x-patternProperties: + ^[a-zA-Z0-9-:]{3,256}$: + type: string + maxLength: 1500 + minLength: 1 + additionalProperties: false + DeploymentStatus: + type: string + enum: + - COMPLETED + - CREATING + - DELETE_IN_PROGRESS + - DELETE_INITIATING + - DELETE_FAILED + - DELETED + - FAILED + - IN_PROGRESS + - VALIDATING + Tags: + type: object + properties: + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z+-=._:/]+$ + Value: + description: 'The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + type: string + minLength: 0 + maxLength: 256 + required: + - Key + additionalProperties: false + Deployment: + type: object + properties: + Arn: + description: ARN of the LaunchWizard deployment + type: string + pattern: ^arn:aws(-cn|-us-gov)?:launchwizard:[a-z0-9-]+:[0-9]{12}:deployment/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ + CreatedAt: + description: Timestamp of LaunchWizard deployment creation + type: string + format: date-time + DeletedAt: + description: Timestamp of LaunchWizard deployment deletion + type: string + format: date-time + DeploymentId: + description: Deployment ID of the LaunchWizard deployment + type: string + maxLength: 128 + minLength: 2 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + DeploymentPatternName: + description: Workload deployment pattern name + type: string + maxLength: 256 + minLength: 1 + pattern: ^[A-Za-z0-9][a-zA-Z0-9-]*$ + Name: + description: Name of LaunchWizard deployment + type: string + maxLength: 50 + minLength: 1 + pattern: ^[A-Za-z0-9_\s\.-]+$ + ResourceGroup: + description: Resource Group Name created for LaunchWizard deployment + type: string + Specifications: + description: LaunchWizard deployment specifications + $ref: '#/components/schemas/DeploymentSpecifications' + Status: + description: Status of LaunchWizard deployment + $ref: '#/components/schemas/DeploymentStatus' + Tags: + description: Tags for LaunchWizard deployment + type: array + items: + $ref: '#/components/schemas/Tags' + x-insertionOrder: false + WorkloadName: + description: Workload Name for LaunchWizard deployment + type: string + maxLength: 100 + minLength: 1 + pattern: ^[A-Za-z][a-zA-Z0-9-_]*$ + required: + - DeploymentPatternName + - Name + - WorkloadName + x-stackql-resource-name: deployment + description: Definition of AWS::LaunchWizard::Deployment Resource Type + x-type-name: AWS::LaunchWizard::Deployment + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - DeploymentPatternName + - Name + - WorkloadName + x-write-only-properties: + - Specifications + x-read-only-properties: + - Arn + - CreatedAt + - DeletedAt + - DeploymentId + - ResourceGroup + - Status + x-required-properties: + - DeploymentPatternName + - Name + - WorkloadName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - launchwizard:ListTagsForResource + - launchwizard:TagResource + - launchwizard:UntagResource + x-required-permissions: + create: + - launchwizard:CreateDeployment + - launchwizard:GetDeployment + - launchwizard:ListDeploymentEvents + - launchwizard:ListTagsForResource + - launchwizard:TagResource + - ssm:GetParameter + - ssm:PutParameter + - ssm:DescribeParameters + - ssm:AddTagsToResource + - ssm:DeleteParameter + - secretsmanager:DescribeSecret + - secretsmanager:PutSecretValue + - secretsmanager:CreateSecret + - secretsmanager:TagResource + - secretsmanager:UpdateSecret + - resource-groups:CreateGroup + - resource-groups:DeleteGroup + - cloudformation:DeleteStack + - cloudformation:DescribeStackResources + - cloudformation:DescribeStackResource + - cloudformation:DescribeStacks + - cloudformation:DescribeStackEvents + - cloudformation:CreateStack + - cloudformation:TagResource + - s3:PutObject + - s3:GetObject + - s3:CreateBucket + - sns:ListSubscriptionsByTopic + - sns:Publish + - sns:ListSubscriptions + - sns:ListTopics + - sns:CreateTopic + - sns:Subscribe + - sns:Unsubscribe + - sqs:TagQueue + - sqs:GetQueueUrl + - sqs:AddPermission + - sqs:ListQueues + - sqs:GetQueueAttributes + - sqs:ListQueueTags + - sqs:CreateQueue + - sqs:SetQueueAttributes + read: + - launchwizard:GetDeployment + - launchwizard:ListDeploymentEvents + - launchwizard:ListTagsForResource + delete: + - launchwizard:GetDeployment + - launchwizard:DeleteDeployment + - launchwizard:UntagResource + - ssm:DeleteParameter + - secretsmanager:DeleteSecret + - resource-groups:DeleteGroup + - cloudformation:DeleteStack + - cloudformation:DescribeStacks + - ssm:GetParameter + - sns:ListSubscriptionsByTopic + - sns:Publish + - sns:ListSubscriptions + - sns:ListTopics + - sns:CreateTopic + - sns:DeleteTopic + - sns:Subscribe + - sns:Unsubscribe + - sqs:GetQueueUrl + - sqs:ListQueues + - sqs:DeleteQueue + - sqs:GetQueueAttributes + - sqs:ListQueueTags + update: + - launchwizard:GetDeployment + - launchwizard:ListTagsForResource + - launchwizard:TagResource + - launchwizard:UntagResource + list: + - launchwizard:ListDeployments + - launchwizard:ListTagsForResource + CreateDeploymentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: ARN of the LaunchWizard deployment + type: string + pattern: ^arn:aws(-cn|-us-gov)?:launchwizard:[a-z0-9-]+:[0-9]{12}:deployment/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ + CreatedAt: + description: Timestamp of LaunchWizard deployment creation + type: string + format: date-time + DeletedAt: + description: Timestamp of LaunchWizard deployment deletion + type: string + format: date-time + DeploymentId: + description: Deployment ID of the LaunchWizard deployment + type: string + maxLength: 128 + minLength: 2 + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + DeploymentPatternName: + description: Workload deployment pattern name + type: string + maxLength: 256 + minLength: 1 + pattern: ^[A-Za-z0-9][a-zA-Z0-9-]*$ + Name: + description: Name of LaunchWizard deployment + type: string + maxLength: 50 + minLength: 1 + pattern: ^[A-Za-z0-9_\s\.-]+$ + ResourceGroup: + description: Resource Group Name created for LaunchWizard deployment + type: string + Specifications: + description: LaunchWizard deployment specifications + $ref: '#/components/schemas/DeploymentSpecifications' + Status: + description: Status of LaunchWizard deployment + $ref: '#/components/schemas/DeploymentStatus' + Tags: + description: Tags for LaunchWizard deployment + type: array + items: + $ref: '#/components/schemas/Tags' + x-insertionOrder: false + WorkloadName: + description: Workload Name for LaunchWizard deployment + type: string + maxLength: 100 + minLength: 1 + pattern: ^[A-Za-z][a-zA-Z0-9-_]*$ + x-stackQL-stringOnly: true + x-title: CreateDeploymentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + deployments: + name: deployments + id: awscc.launchwizard.deployments + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::LaunchWizard::Deployment + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LaunchWizard::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LaunchWizard::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LaunchWizard::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DeletedAt') as deleted_at, + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, + JSON_EXTRACT(Properties, '$.DeploymentPatternName') as deployment_pattern_name, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ResourceGroup') as resource_group, + JSON_EXTRACT(Properties, '$.Specifications') as specifications, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.WorkloadName') as workload_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LaunchWizard::Deployment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DeletedAt') as deleted_at, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'DeploymentPatternName') as deployment_pattern_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ResourceGroup') as resource_group, + json_extract_path_text(Properties, 'Specifications') as specifications, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkloadName') as workload_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LaunchWizard::Deployment' + AND data__Identifier = '' + AND region = 'us-east-1' + deployments_list_only: + name: deployments_list_only + id: awscc.launchwizard.deployments_list_only + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::LaunchWizard::Deployment + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LaunchWizard::Deployment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LaunchWizard::Deployment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeployment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/lex.yaml b/providers/src/awscc/v00.00.00000/services/lex.yaml index 55eb7ef5..881f5cd5 100644 --- a/providers/src/awscc/v00.00.00000/services/lex.yaml +++ b/providers/src/awscc/v00.00.00000/services/lex.yaml @@ -1,10 +1,409 @@ openapi: 3.0.0 info: title: Lex - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + ReplicaRegion: + description: The secondary region that will be used in the replication of the source bot. + type: string + minLength: 2 + maxLength: 25 + Replication: + type: object + properties: + ReplicaRegions: + type: array + uniqueItems: true + maxItems: 1 + minItems: 1 + x-insertionOrder: false + items: + $ref: '#/components/schemas/ReplicaRegion' + required: + - ReplicaRegions + additionalProperties: false BotAliasLocaleSettingsList: description: A list of bot alias locale settings to add to the bot alias. type: array @@ -179,7 +578,6 @@ components: - S3BucketArn additionalProperties: false TestBotAliasSettings: - description: Configuring the test bot alias settings for a given bot type: object properties: BotAliasLocaleSettings: @@ -189,18 +587,15 @@ components: Description: $ref: '#/components/schemas/Description' SentimentAnalysisSettings: - description: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. type: object properties: DetectSentiment: type: boolean - description: Enable to call Amazon Comprehend for Sentiment natively within Lex required: - DetectSentiment additionalProperties: false additionalProperties: false RoleArn: - description: The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. type: string minLength: 32 maxLength: 2048 @@ -215,7 +610,7 @@ components: type: string minLength: 1 maxLength: 1011 - pattern: ^arn:aws[a-zA-Z-]*:lex:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:bot/[0-9a-zA-Z]+$ + pattern: ^arn:aws[a-zA-Z-]*:lex:[a-z]+-(?:[a-z]+-)*[0-9]:[0-9]{12}:bot/[0-9a-zA-Z]+$ Name: description: A unique identifier for a resource. type: string @@ -227,25 +622,30 @@ components: type: string maxLength: 200 DataPrivacy: - description: Provides information on additional privacy protections Amazon Lex should use with the bot's data. type: object properties: ChildDirected: type: boolean - description: Specify whether your use of Amazon Lex is related to application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA). required: - ChildDirected additionalProperties: false + ErrorLogSettings: + description: Error logs configuration for this bot. This is used by Amazon Lex to emit any errors that occur during Lex Runtime API invocations. + type: object + properties: + Enabled: + type: boolean + description: Specify whether error log feature has been enabled + required: + - Enabled + additionalProperties: false IdleSessionTTLInSeconds: - description: The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. type: integer minimum: 60 maximum: 86400 Utterance: - description: The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents/slots. type: string SampleUtterance: - description: A sample utterance that invokes an intent or respond to a slot elicitation prompt. type: object properties: Utterance: @@ -254,7 +654,6 @@ components: - Utterance additionalProperties: false SampleUtterancesList: - description: An array of sample utterances type: array x-insertionOrder: false items: @@ -281,31 +680,77 @@ components: description: The identifier of the language and locale that the bot will be used in. type: string VoiceSettings: - description: Settings for using an Amazon Polly voice to communicate with a user. type: object properties: VoiceId: type: string - description: The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. Engine: type: string - description: Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide. enum: - standard - neural + - long-form + - generative required: - VoiceId additionalProperties: false + GenerativeAISettings: + type: object + properties: + BuildtimeSettings: + type: object + properties: + DescriptiveBotBuilderSpecification: + type: object + properties: + Enabled: + type: boolean + BedrockModelSpecification: + $ref: '#/components/schemas/BedrockModelSpecification' + required: + - Enabled + additionalProperties: false + SampleUtteranceGenerationSpecification: + type: object + properties: + Enabled: + type: boolean + BedrockModelSpecification: + $ref: '#/components/schemas/BedrockModelSpecification' + required: + - Enabled + additionalProperties: false + additionalProperties: false + RuntimeSettings: + type: object + properties: + NluImprovementSpecification: + type: object + properties: + Enabled: + type: boolean + required: + - Enabled + additionalProperties: false + SlotResolutionImprovementSpecification: + type: object + properties: + Enabled: + type: boolean + BedrockModelSpecification: + $ref: '#/components/schemas/BedrockModelSpecification' + required: + - Enabled + additionalProperties: false + additionalProperties: false + additionalProperties: false ConfidenceThreshold: - description: The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents. type: number minimum: 0 maximum: 1 ParentIntentSignature: - description: A unique identifier for the built-in intent to base this intent on. type: string DialogCodeHookSetting: - description: Settings that determine the Lambda function that Amazon Lex uses for processing user responses. type: object properties: Enabled: @@ -314,43 +759,36 @@ components: - Enabled additionalProperties: false FulfillmentStartResponseSpecification: - description: Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running. type: object properties: MessageGroups: $ref: '#/components/schemas/MessageGroupsList' DelayInSeconds: - description: The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played. type: integer minimum: 1 maximum: 900 AllowInterrupt: - description: Determines whether the user can interrupt the start message while it is playing. type: boolean required: - DelayInSeconds - MessageGroups additionalProperties: false FulfillmentUpdateResponseSpecification: - description: Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running. type: object properties: MessageGroups: $ref: '#/components/schemas/MessageGroupsList' FrequencyInSeconds: - description: The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user. type: integer minimum: 1 maximum: 900 AllowInterrupt: - description: Determines whether the user can interrupt an update message while it is playing. type: boolean required: - FrequencyInSeconds - MessageGroups additionalProperties: false FulfillmentUpdatesSpecification: - description: Provides information for updating the user on the progress of fulfilling an intent. type: object properties: StartResponse: @@ -358,51 +796,38 @@ components: UpdateResponse: $ref: '#/components/schemas/FulfillmentUpdateResponseSpecification' TimeoutInSeconds: - description: The length of time that the fulfillment Lambda function should run before it times out. type: integer minimum: 1 maximum: 900 Active: - description: Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent. type: boolean required: - Active additionalProperties: false PostFulfillmentStatusSpecification: - description: Provides a setting that determines whether the post-fulfillment response is sent to the user. type: object properties: SuccessResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' SuccessNextStep: - description: Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully. $ref: '#/components/schemas/DialogState' SuccessConditional: - description: A list of conditional branches to evaluate after the fulfillment code hook finishes successfully. $ref: '#/components/schemas/ConditionalSpecification' FailureResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' FailureNextStep: - description: Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed. $ref: '#/components/schemas/DialogState' FailureConditional: - description: A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed. $ref: '#/components/schemas/ConditionalSpecification' TimeoutResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' TimeoutNextStep: - description: Specifies the next step that the bot runs when the fulfillment code hook times out. $ref: '#/components/schemas/DialogState' TimeoutConditional: - description: A list of conditional branches to evaluate if the fulfillment code hook times out. $ref: '#/components/schemas/ConditionalSpecification' required: [] additionalProperties: false FulfillmentCodeHookSetting: - description: Settings that determine if a Lambda function should be invoked to fulfill a specific intent. type: object properties: FulfillmentUpdatesSpecification: @@ -412,22 +837,18 @@ components: Enabled: type: boolean IsActive: - description: Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run. type: boolean required: - Enabled additionalProperties: false Button: - description: A button to use on a response card used to gather slot values from a user. type: object properties: Text: - description: The text that appears on the button. type: string minLength: 1 maxLength: 50 Value: - description: The value returned to Amazon Lex when the user chooses this button. type: string minLength: 1 maxLength: 50 @@ -444,20 +865,15 @@ components: minLength: 1 maxLength: 250 ImageResponseCard: - description: A message that defines a response card that the client application can show to the user. type: object properties: Title: - description: The title to display on the response card. $ref: '#/components/schemas/AttachmentTitle' Subtitle: - description: The subtitle to display on the response card. $ref: '#/components/schemas/AttachmentTitle' ImageUrl: - description: The URL of an image to display on the response card. $ref: '#/components/schemas/AttachmentUrl' Buttons: - description: A list of buttons that should be displayed on the response card. type: array maxItems: 5 x-insertionOrder: false @@ -467,11 +883,9 @@ components: - Title additionalProperties: false PlainTextMessage: - description: A message in plain text format. type: object properties: Value: - description: The message to send to the user. type: string minLength: 1 maxLength: 1000 @@ -479,11 +893,9 @@ components: - Value additionalProperties: false CustomPayload: - description: A message in a custom format defined by the client application. type: object properties: Value: - description: The string that is sent to your application. type: string minLength: 1 maxLength: 1000 @@ -491,11 +903,9 @@ components: - Value additionalProperties: false SSMLMessage: - description: A message in Speech Synthesis Markup Language (SSML). type: object properties: Value: - description: The SSML text that defines the prompt. type: string minLength: 1 maxLength: 1000 @@ -503,7 +913,6 @@ components: - Value additionalProperties: false Message: - description: The primary message that Amazon Lex should send to the user. type: object properties: PlainTextMessage: @@ -517,13 +926,11 @@ components: required: [] additionalProperties: false MessageGroup: - description: One or more messages that Amazon Lex can send to the user. type: object properties: Message: $ref: '#/components/schemas/Message' Variations: - description: Message variations to send to the user. type: array maxItems: 2 x-insertionOrder: false @@ -533,7 +940,6 @@ components: - Message additionalProperties: false MessageGroupsList: - description: One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user. type: array minItems: 1 maxItems: 5 @@ -541,48 +947,38 @@ components: items: $ref: '#/components/schemas/MessageGroup' PromptMaxRetries: - description: The maximum number of times the bot tries to elicit a response from the user using this prompt. type: integer minimum: 0 maximum: 5 MessageSelectionStrategy: - description: Indicates how a message is selected from a message group among retries. type: string enum: - Random - Ordered AllowedInputTypes: - description: Specifies the allowed input types. type: object properties: AllowAudioInput: - description: Indicates whether audio input is allowed. type: boolean AllowDTMFInput: - description: Indicates whether DTMF input is allowed. type: boolean required: - AllowAudioInput - AllowDTMFInput additionalProperties: false DTMFSpecification: - description: Specifies the settings on DTMF input. type: object properties: DeletionCharacter: - description: The DTMF character that clears the accumulated DTMF digits and immediately ends the input. type: string pattern: ^[A-D0-9#*]{1}$ EndCharacter: - description: The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout. type: string pattern: ^[A-D0-9#*]{1}$ EndTimeoutMs: - description: How long the bot should wait after the last DTMF character input before assuming that the input has concluded. type: integer minimum: 1 MaxLength: - description: The maximum number of DTMF digits allowed in an utterance. type: integer minimum: 1 maximum: 1024 @@ -593,15 +989,12 @@ components: - MaxLength additionalProperties: false AudioSpecification: - description: Specifies the audio input specifications. type: object properties: EndTimeoutMs: - description: Time for which a bot waits after the customer stops speaking to assume the utterance is finished. type: integer minimum: 1 MaxLengthMs: - description: Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application. type: integer minimum: 1 required: @@ -609,11 +1002,9 @@ components: - MaxLengthMs additionalProperties: false AudioAndDTMFInputSpecification: - description: Specifies the audio and DTMF input specification. type: object properties: StartTimeoutMs: - description: Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs. type: integer minimum: 1 DTMFSpecification: @@ -624,24 +1015,20 @@ components: - StartTimeoutMs additionalProperties: false TextInputSpecification: - description: Specifies the text input specifications. type: object properties: StartTimeoutMs: - description: Time for which a bot waits before re-prompting a customer for text input. type: integer minimum: 1 required: - StartTimeoutMs additionalProperties: false PromptAttemptSpecification: - description: Specifies the settings on a prompt attempt. type: object properties: AllowedInputTypes: $ref: '#/components/schemas/AllowedInputTypes' AllowInterrupt: - description: Indicates whether the user can interrupt a speech prompt attempt from the bot. type: boolean AudioAndDTMFInputSpecification: $ref: '#/components/schemas/AudioAndDTMFInputSpecification' @@ -651,7 +1038,6 @@ components: - AllowedInputTypes additionalProperties: false PromptSpecification: - description: Prompts the user to confirm the intent. type: object properties: MessageGroupsList: @@ -659,12 +1045,10 @@ components: MaxRetries: $ref: '#/components/schemas/PromptMaxRetries' AllowInterrupt: - description: Indicates whether the user can interrupt a speech prompt from the bot. type: boolean MessageSelectionStrategy: $ref: '#/components/schemas/MessageSelectionStrategy' PromptAttemptsSpecification: - description: Specifies the advanced settings on each attempt of the prompt. type: object x-patternProperties: ^(Initial|Retry1|Retry2|Retry3|Retry4|Retry5)$: @@ -675,29 +1059,24 @@ components: - MaxRetries additionalProperties: false ResponseSpecification: - description: A list of message groups that Amazon Lex uses to respond the user input. type: object properties: MessageGroupsList: $ref: '#/components/schemas/MessageGroupsList' AllowInterrupt: - description: Indicates whether the user can interrupt a speech prompt from the bot. type: boolean required: - MessageGroupsList additionalProperties: false StillWaitingResponseFrequency: - description: How often a message should be sent to the user in seconds. type: integer minimum: 1 maximum: 300 StillWaitingResponseTimeout: - description: If Amazon Lex waits longer than this length of time in seconds for a response, it will stop sending messages. type: integer minimum: 1 maximum: 900 StillWaitingResponseSpecification: - description: StillWaitingResponseSpecification. type: object properties: MessageGroupsList: @@ -707,7 +1086,6 @@ components: TimeoutInSeconds: $ref: '#/components/schemas/StillWaitingResponseTimeout' AllowInterrupt: - description: Indicates whether the user can interrupt a speech prompt from the bot. type: boolean required: - MessageGroupsList @@ -715,97 +1093,72 @@ components: - TimeoutInSeconds additionalProperties: false IntentConfirmationSetting: - description: Provides a prompt for making sure that the user is ready for the intent to be fulfilled. type: object properties: PromptSpecification: - description: Prompts the user to confirm the intent. This question should have a yes or no answer. $ref: '#/components/schemas/PromptSpecification' IsActive: - description: Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true. type: boolean ConfirmationResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' ConfirmationNextStep: - description: Specifies the next step that the bot executes when the customer confirms the intent. $ref: '#/components/schemas/DialogState' ConfirmationConditional: - description: A list of conditional branches to evaluate after the intent is closed. $ref: '#/components/schemas/ConditionalSpecification' DeclinationResponse: - description: When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled. $ref: '#/components/schemas/ResponseSpecification' DeclinationNextStep: - description: Specifies the next step that the bot executes when the customer declines the intent. $ref: '#/components/schemas/DialogState' DeclinationConditional: - description: A list of conditional branches to evaluate after the intent is declined. $ref: '#/components/schemas/ConditionalSpecification' FailureResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' FailureNextStep: - description: The next step to take in the conversation if the confirmation step fails. $ref: '#/components/schemas/DialogState' FailureConditional: - description: Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition. $ref: '#/components/schemas/ConditionalSpecification' CodeHook: - description: The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook. $ref: '#/components/schemas/DialogCodeHookInvocationSetting' ElicitationCodeHook: - description: The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries. $ref: '#/components/schemas/ElicitationCodeHookInvocationSetting' required: - PromptSpecification additionalProperties: false IntentClosingSetting: - description: Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled. type: object properties: ClosingResponse: - description: The response that Amazon Lex sends to the user when the intent is complete. $ref: '#/components/schemas/ResponseSpecification' IsActive: - description: Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true. type: boolean Conditional: - description: A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional. $ref: '#/components/schemas/ConditionalSpecification' NextStep: - description: Specifies the next step that the bot executes after playing the intent's closing response. $ref: '#/components/schemas/DialogState' additionalProperties: false InputContext: - description: InputContext specified for the intent. type: object properties: Name: - description: The name of the context. $ref: '#/components/schemas/Name' required: - Name additionalProperties: false InputContextsList: - description: The list of input contexts specified for the intent. type: array maxItems: 5 x-insertionOrder: false items: $ref: '#/components/schemas/InputContext' ContextTimeToLiveInSeconds: - description: The amount of time, in seconds, that the output context should remain active. type: integer minimum: 5 maximum: 86400 ContextTurnsToLive: - description: The number of conversation turns that the output context should remain active. type: integer minimum: 1 maximum: 20 OutputContext: - description: A session context that is activated when an intent is fulfilled. type: object properties: Name: @@ -820,67 +1173,217 @@ components: - TurnsToLive additionalProperties: false OutputContextsList: - description: A list of contexts that the intent activates when it is fulfilled. type: array maxItems: 10 x-insertionOrder: false items: $ref: '#/components/schemas/OutputContext' KendraIndexArn: - description: The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. type: string minLength: 32 maxLength: 2048 - pattern: ^arn:aws[a-zA-Z-]*:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index/[a-zA-Z0-9][a-zA-Z0-9_-]*$ + pattern: ^arn:aws[a-zA-Z-]*:kendra:[a-z]+-(?:[a-z]+-)*[0-9]:[0-9]{12}:index/[a-zA-Z0-9][a-zA-Z0-9_-]*$ QueryFilterString: - description: A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. type: string minLength: 1 maxLength: 5000 + BedrockModelSpecification: + type: object + properties: + ModelArn: + type: string + minLength: 1 + maxLength: 5000 + BedrockGuardrailConfiguration: + type: object + properties: + BedrockGuardrailIdentifier: + type: string + minLength: 1 + maxLength: 5000 + BedrockGuardrailVersion: + type: string + minLength: 1 + maxLength: 5000 + additionalProperties: false + BedrockTraceStatus: + type: string + enum: + - ENABLED + - DISABLED + BedrockModelCustomPrompt: + type: string + minLength: 1 + maxLength: 5000 + required: + - ModelArn + additionalProperties: false KendraConfiguration: - description: Configuration for searching a Amazon Kendra index specified for the intent. type: object properties: KendraIndex: $ref: '#/components/schemas/KendraIndexArn' QueryFilterStringEnabled: - description: Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index. type: boolean QueryFilterString: $ref: '#/components/schemas/QueryFilterString' required: - KendraIndex additionalProperties: false + QnAIntentConfiguration: + type: object + properties: + DataSourceConfiguration: + type: object + properties: + OpensearchConfiguration: + type: object + properties: + DomainEndpoint: + type: string + minLength: 1 + maxLength: 5000 + IndexName: + type: string + minLength: 1 + maxLength: 5000 + IncludeFields: + type: array + x-insertionOrder: false + items: + type: string + minLength: 1 + maxLength: 5000 + ExactResponse: + type: boolean + ExactResponseFields: + type: object + properties: + QuestionField: + type: string + minLength: 1 + maxLength: 5000 + AnswerField: + type: string + minLength: 1 + maxLength: 5000 + additionalProperties: false + additionalProperties: false + BedrockKnowledgeStoreConfiguration: + type: object + properties: + BedrockKnowledgeBaseArn: + type: string + minLength: 1 + maxLength: 5000 + ExactResponse: + type: boolean + BKBExactResponseFields: + type: object + properties: + AnswerField: + type: string + minLength: 1 + maxLength: 5000 + additionalProperties: false + additionalProperties: false + KendraConfiguration: + $ref: '#/components/schemas/QnAKendraConfiguration' + additionalProperties: false + BedrockModelConfiguration: + $ref: '#/components/schemas/BedrockModelSpecification' + required: + - DataSourceConfiguration + - BedrockModelConfiguration + additionalProperties: false + QInConnectIntentConfiguration: + type: object + properties: + QInConnectAssistantConfiguration: + type: object + properties: + AssistantArn: + type: string + minLength: 1 + maxLength: 200 + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + required: + - AssistantArn + additionalProperties: false + additionalProperties: false + QnAKendraConfiguration: + type: object + properties: + KendraIndex: + type: string + minLength: 1 + maxLength: 5000 + QueryFilterString: + type: string + minLength: 1 + maxLength: 5000 + QueryFilterStringEnabled: + type: boolean + ExactResponse: + type: boolean + required: + - KendraIndex + - QueryFilterStringEnabled + - ExactResponse + additionalProperties: false + BedrockAgentIntentConfiguration: + type: object + properties: + BedrockAgentConfiguration: + type: object + properties: + BedrockAgentId: + type: string + minLength: 1 + maxLength: 5000 + BedrockAgentAliasId: + type: string + minLength: 1 + maxLength: 5000 + additionalProperties: false + BedrockAgentIntentKnowledgeBaseConfiguration: + type: object + properties: + BedrockKnowledgeBaseArn: + type: string + minLength: 1 + maxLength: 5000 + BedrockModelConfiguration: + $ref: '#/components/schemas/BedrockModelSpecification' + required: + - BedrockKnowledgeBaseArn + - BedrockModelConfiguration + additionalProperties: false + additionalProperties: false PriorityValue: - description: The priority that a slot should be elicited. type: integer minimum: 0 maximum: 100 SlotPriority: - description: The priority that Amazon Lex should use when eliciting slot values from a user. type: object properties: Priority: $ref: '#/components/schemas/PriorityValue' SlotName: - description: The name of the slot. $ref: '#/components/schemas/Name' required: - SlotName - Priority additionalProperties: false SlotPrioritiesList: - description: List for slot priorities type: array x-insertionOrder: false items: $ref: '#/components/schemas/SlotPriority' Intent: - description: Represents an action that the user wants to perform. type: object properties: Name: - description: The name of the intent. $ref: '#/components/schemas/Name' Description: description: Description of thr intent. @@ -888,7 +1391,6 @@ components: ParentIntentSignature: $ref: '#/components/schemas/ParentIntentSignature' SampleUtterances: - description: A sample utterance that invokes an intent or respond to a slot elicitation prompt. $ref: '#/components/schemas/SampleUtterancesList' DialogCodeHook: $ref: '#/components/schemas/DialogCodeHookSetting' @@ -899,7 +1401,6 @@ components: IntentClosingSetting: $ref: '#/components/schemas/IntentClosingSetting' InitialResponseSetting: - description: Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. $ref: '#/components/schemas/InitialResponseSetting' InputContexts: $ref: '#/components/schemas/InputContextsList' @@ -907,10 +1408,15 @@ components: $ref: '#/components/schemas/OutputContextsList' KendraConfiguration: $ref: '#/components/schemas/KendraConfiguration' + QnAIntentConfiguration: + $ref: '#/components/schemas/QnAIntentConfiguration' + QInConnectIntentConfiguration: + $ref: '#/components/schemas/QInConnectIntentConfiguration' + BedrockAgentIntentConfiguration: + $ref: '#/components/schemas/BedrockAgentIntentConfiguration' SlotPriorities: $ref: '#/components/schemas/SlotPrioritiesList' Slots: - description: List of slots type: array maxItems: 100 uniqueItems: true @@ -921,17 +1427,13 @@ components: - Name additionalProperties: false ParentSlotTypeSignature: - description: The built-in slot type used as a parent of this slot type. type: string SlotTypeName: - description: The slot type name that is used in the slot. Allows for custom and built-in slot type names type: string SampleValue: - description: Defines one of the values for a slot type. type: object properties: Value: - description: The value that can be used for a slot type. type: string minLength: 1 maxLength: 140 @@ -939,14 +1441,12 @@ components: - Value additionalProperties: false SynonymList: - description: Additional values related to the slot type entry. type: array maxItems: 10000 x-insertionOrder: false items: $ref: '#/components/schemas/SampleValue' SlotTypeValue: - description: Value that the slot type can take. type: object properties: SampleValue: @@ -957,7 +1457,6 @@ components: - SampleValue additionalProperties: false SlotTypeValues: - description: A List of slot type values type: array maxItems: 10000 x-insertionOrder: false @@ -968,12 +1467,11 @@ components: enum: - ORIGINAL_VALUE - TOP_RESOLUTION + - CONCATENATION SlotValueRegexFilter: - description: A regular expression used to validate the value of a slot. type: object properties: Pattern: - description: Regex pattern type: string minLength: 1 maxLength: 300 @@ -981,19 +1479,16 @@ components: - Pattern additionalProperties: false AudioRecognitionStrategy: - description: Enables using slot values as a custom vocabulary when recognizing user utterances. type: string enum: - UseSlotValuesAsCustomVocabulary AdvancedRecognitionSetting: - description: Provides settings that enable advanced recognition settings for slot values. type: object properties: AudioRecognitionStrategy: $ref: '#/components/schemas/AudioRecognitionStrategy' additionalProperties: false SlotValueSelectionSetting: - description: Contains settings used by Amazon Lex to select a slot value. type: object properties: ResolutionStrategy: @@ -1016,17 +1511,13 @@ components: maxLength: 1024 pattern: '[\.\-\!\*\_\''\(\)a-zA-Z0-9][\.\-\!\*\_\''\(\)\/a-zA-Z0-9]*$' GrammarSlotTypeSource: - description: Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type. type: object properties: S3BucketName: - description: The name of the S3 bucket that contains the grammar source. $ref: '#/components/schemas/S3BucketName' S3ObjectKey: - description: The path to the grammar in the S3 bucket. $ref: '#/components/schemas/S3ObjectKey' KmsKeyArn: - description: The Amazon KMS key required to decrypt the contents of the grammar, if any. type: string minLength: 20 maxLength: 2048 @@ -1036,21 +1527,89 @@ components: - S3ObjectKey additionalProperties: false GrammarSlotTypeSetting: - description: Settings required for a slot type based on a grammar that you provide. type: object properties: Source: $ref: '#/components/schemas/GrammarSlotTypeSource' additionalProperties: false ExternalSourceSetting: - description: Provides information about the external source of the slot type's definition. type: object properties: GrammarSlotTypeSetting: $ref: '#/components/schemas/GrammarSlotTypeSetting' additionalProperties: false + CompositeSlotTypeSetting: + type: object + properties: + SubSlots: + type: array + minItems: 1 + maxItems: 6 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/SubSlotTypeComposition' + additionalProperties: false + SubSlotTypeComposition: + type: object + properties: + Name: + type: string + minLength: 1 + maxLength: 100 + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + SlotTypeId: + $ref: '#/components/schemas/SlotTypeId' + required: + - Name + - SlotTypeId + additionalProperties: false + SubSlotSetting: + type: object + properties: + Expression: + type: string + minLength: 1 + maxLength: 1000 + pattern: '[0-9A-Za-z_\-\s\(\)]+' + SlotSpecifications: + type: object + minProperties: 0 + maxProperties: 6 + x-patternProperties: + ^([0-9a-zA-Z][_-]?){1,100}$: + $ref: '#/components/schemas/Specifications' + additionalProperties: false + additionalProperties: false + Specifications: + type: object + properties: + SlotTypeId: + $ref: '#/components/schemas/SlotTypeId' + ValueElicitationSetting: + $ref: '#/components/schemas/SubSlotValueElicitationSetting' + required: + - SlotTypeId + - ValueElicitationSetting + additionalProperties: false + SlotTypeId: + type: string + minLength: 1 + maxLength: 25 + pattern: ^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$ + SubSlotValueElicitationSetting: + type: object + properties: + PromptSpecification: + $ref: '#/components/schemas/PromptSpecification' + DefaultValueSpecification: + $ref: '#/components/schemas/SlotDefaultValueSpecification' + SampleUtterances: + $ref: '#/components/schemas/SampleUtterancesList' + WaitAndContinueSpecification: + $ref: '#/components/schemas/WaitAndContinueSpecification' + additionalProperties: false SlotType: - description: A custom, extended built-in or a grammar slot type. type: object properties: Name: @@ -1065,25 +1624,23 @@ components: $ref: '#/components/schemas/SlotValueSelectionSetting' ExternalSourceSetting: $ref: '#/components/schemas/ExternalSourceSetting' + CompositeSlotTypeSetting: + $ref: '#/components/schemas/CompositeSlotTypeSetting' required: - Name additionalProperties: false CustomVocabularyItem: - description: A custom vocabulary item that contains the phrase to recognize and a weight to give the boost. type: object properties: Phrase: - description: Phrase that should be recognized. type: string minLength: 1 maxLength: 100 Weight: - description: The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field. type: integer minimum: 0 maximum: 3 DisplayAs: - description: Defines how you want your phrase to look in your transcription output. type: string minLength: 1 maxLength: 100 @@ -1098,7 +1655,6 @@ components: items: $ref: '#/components/schemas/CustomVocabularyItem' CustomVocabulary: - description: A custom vocabulary is a list of specific phrases that you want Amazon Lex V2 to recognize in the audio input. type: object properties: CustomVocabularyItems: @@ -1107,11 +1663,9 @@ components: - CustomVocabularyItems additionalProperties: false SlotDefaultValue: - description: The default value to use when a user doesn't provide a value for a slot. type: object properties: DefaultValue: - description: The default value to use when a user doesn't provide a value for a slot. type: string minLength: 1 maxLength: 202 @@ -1119,11 +1673,9 @@ components: - DefaultValue additionalProperties: false SlotDefaultValueSpecification: - description: A list of values that Amazon Lex should use as the default value for a slot. type: object properties: DefaultValueList: - description: A list of slot default values type: array maxItems: 10 x-insertionOrder: false @@ -1138,56 +1690,42 @@ components: - Required - Optional WaitAndContinueSpecification: - description: The prompts that Amazon Lex uses while a bot is waiting for customer input. type: object properties: WaitingResponse: - description: The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue. $ref: '#/components/schemas/ResponseSpecification' ContinueResponse: - description: The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation. $ref: '#/components/schemas/ResponseSpecification' StillWaitingResponse: - description: The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user. $ref: '#/components/schemas/StillWaitingResponseSpecification' IsActive: - description: Specifies whether the bot will wait for a user to respond. type: boolean required: - WaitingResponse - ContinueResponse additionalProperties: false SlotValueElicitationSetting: - description: Settings that you can use for eliciting a slot value. type: object properties: DefaultValueSpecification: - description: A list of default values for a slot. $ref: '#/components/schemas/SlotDefaultValueSpecification' SlotConstraint: - description: Specifies whether the slot is required or optional. $ref: '#/components/schemas/SlotConstraint' PromptSpecification: - description: The prompt that Amazon Lex uses to elicit the slot value from the user. $ref: '#/components/schemas/PromptSpecification' SampleUtterances: - description: If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. $ref: '#/components/schemas/SampleUtterancesList' WaitAndContinueSpecification: - description: Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. $ref: '#/components/schemas/WaitAndContinueSpecification' SlotCaptureSetting: - description: Specifies the next stage in the conversation after capturing the slot. $ref: '#/components/schemas/SlotCaptureSetting' required: - SlotConstraint additionalProperties: false ObfuscationSetting: - description: Determines whether Amazon Lex obscures slot values in conversation logs. type: object properties: ObfuscationSettingType: - description: Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values. type: string enum: - None @@ -1196,7 +1734,6 @@ components: - ObfuscationSettingType additionalProperties: false MultipleValuesSetting: - description: Indicates whether a slot can return multiple values. type: object properties: AllowMultipleValues: @@ -1204,7 +1741,6 @@ components: required: [] additionalProperties: false Slot: - description: A slot is a variable needed to fulfill an intent, where an intent can require zero or more slots. type: object properties: Name: @@ -1219,13 +1755,14 @@ components: $ref: '#/components/schemas/ObfuscationSetting' MultipleValuesSetting: $ref: '#/components/schemas/MultipleValuesSetting' + SubSlotSetting: + $ref: '#/components/schemas/SubSlotSetting' required: - Name - SlotTypeName - ValueElicitationSetting additionalProperties: false BotLocale: - description: A locale in the bot, which contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. type: object properties: LocaleId: @@ -1234,10 +1771,11 @@ components: $ref: '#/components/schemas/Description' VoiceSettings: $ref: '#/components/schemas/VoiceSettings' + GenerativeAISettings: + $ref: '#/components/schemas/GenerativeAISettings' NluConfidenceThreshold: $ref: '#/components/schemas/ConfidenceThreshold' Intents: - description: List of intents type: array maxItems: 1000 uniqueItems: true @@ -1245,7 +1783,6 @@ components: items: $ref: '#/components/schemas/Intent' SlotTypes: - description: List of SlotTypes type: array maxItems: 250 uniqueItems: true @@ -1259,18 +1796,14 @@ components: - NluConfidenceThreshold additionalProperties: false S3Location: - description: S3 location of bot definitions zip file, if it's not defined inline in CloudFormation. type: object properties: S3Bucket: - description: An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. $ref: '#/components/schemas/S3BucketName' S3ObjectKey: - description: The Amazon S3 key of the deployment package. $ref: '#/components/schemas/S3ObjectKey' S3ObjectVersion: type: string - description: For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used. minLength: 1 maxLength: 1024 required: @@ -1278,17 +1811,14 @@ components: - S3ObjectKey additionalProperties: false Condition: - description: Provides an expression that evaluates to true or false. type: object properties: ExpressionString: - description: The expression string that is evaluated. $ref: '#/components/schemas/ConditionExpression' required: - ExpressionString additionalProperties: false Conditional: - description: Contains conditional branches to fork the conversation flow. type: object properties: IsActive: @@ -1300,17 +1830,13 @@ components: - ConditionalBranches additionalProperties: false ConditionalSpecification: - description: Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition. type: object properties: IsActive: - description: Determines whether a conditional branch is active. When active is false, the conditions are not evaluated. type: boolean ConditionalBranches: - description: A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true. $ref: '#/components/schemas/ConditionalBranches' DefaultBranch: - description: The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step. $ref: '#/components/schemas/DefaultConditionalBranch' required: - IsActive @@ -1318,31 +1844,23 @@ components: - DefaultBranch additionalProperties: false DefaultConditionalBranch: - description: A set of actions that Amazon Lex should run if none of the other conditions are met. type: object properties: NextStep: - description: The next step in the conversation. $ref: '#/components/schemas/DialogState' Response: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' additionalProperties: false ConditionalBranch: - description: A set of actions that Amazon Lex should run if the condition is matched. type: object properties: Name: - description: The name of the branch. $ref: '#/components/schemas/Name' Condition: - description: Contains the expression to evaluate. If the condition is true, the branch's actions are taken. $ref: '#/components/schemas/Condition' NextStep: - description: The next step in the conversation. $ref: '#/components/schemas/DialogState' Response: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' required: - Name @@ -1350,7 +1868,6 @@ components: - NextStep additionalProperties: false ConditionalBranches: - description: A list of 1 to 4 conditional branches to fork the conversation flow. type: array minItems: 1 maxItems: 4 @@ -1358,42 +1875,31 @@ components: items: $ref: '#/components/schemas/ConditionalBranch' InitialResponseSetting: - description: Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. type: object properties: InitialResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' NextStep: - description: The next step in the conversation. $ref: '#/components/schemas/DialogState' Conditional: - description: Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition. $ref: '#/components/schemas/ConditionalSpecification' CodeHook: - description: Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation. $ref: '#/components/schemas/DialogCodeHookInvocationSetting' additionalProperties: false ConditionExpression: - description: Expression that is evaluated to true or false at runtime. type: string minLength: 1 maxLength: 1024 DialogCodeHookInvocationSetting: - description: Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation. type: object properties: EnableCodeHookInvocation: - description: Indicates whether a Lambda function should be invoked for the dialog. type: boolean IsActive: - description: Determines whether a dialog code hook is used when the intent is activated. type: boolean InvocationLabel: - description: A label that indicates the dialog step from which the dialog code hook is happening. $ref: '#/components/schemas/Name' PostCodeHookSpecification: - description: Contains the responses and actions that Amazon Lex takes after the Lambda function is complete. $ref: '#/components/schemas/PostDialogCodeHookInvocationSpecification' required: - IsActive @@ -1401,85 +1907,63 @@ components: - PostCodeHookSpecification additionalProperties: false ElicitationCodeHookInvocationSetting: - description: Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values. type: object properties: EnableCodeHookInvocation: - description: Indicates whether a Lambda function should be invoked for the dialog. type: boolean InvocationLabel: - description: A label that indicates the dialog step from which the dialog code hook is happening. $ref: '#/components/schemas/Name' required: - EnableCodeHookInvocation additionalProperties: false PostDialogCodeHookInvocationSpecification: - description: Specifies next steps to run after the dialog code hook finishes. type: object properties: SuccessResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' SuccessNextStep: - description: Specifics the next step the bot runs after the dialog code hook finishes successfully. $ref: '#/components/schemas/DialogState' SuccessConditional: - description: A list of conditional branches to evaluate after the dialog code hook finishes successfully. $ref: '#/components/schemas/ConditionalSpecification' FailureResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' FailureNextStep: - description: Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed. $ref: '#/components/schemas/DialogState' FailureConditional: - description: A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed. $ref: '#/components/schemas/ConditionalSpecification' TimeoutResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' TimeoutNextStep: - description: Specifies the next step that the bot runs when the code hook times out. $ref: '#/components/schemas/DialogState' TimeoutConditional: - description: A list of conditional branches to evaluate if the code hook times out. $ref: '#/components/schemas/ConditionalSpecification' additionalProperties: false DialogState: - description: The current state of the conversation with the user. type: object properties: DialogAction: - description: Defines the action that the bot executes at runtime when the conversation reaches this step. $ref: '#/components/schemas/DialogAction' Intent: - description: Override settings to configure the intent state. $ref: '#/components/schemas/IntentOverride' SessionAttributes: - description: List of session attributes to be applied when the conversation reaches this step. type: array x-insertionOrder: false items: $ref: '#/components/schemas/SessionAttribute' additionalProperties: false DialogAction: - description: Defines the action that the bot executes at runtime when the conversation reaches this step. type: object properties: Type: - description: The action that the bot should execute. $ref: '#/components/schemas/DialogActionType' SlotToElicit: - description: If the dialog action is ElicitSlot, defines the slot to elicit from the user. $ref: '#/components/schemas/Name' SuppressNextMessage: - description: When true the next message for the intent is not used. type: boolean required: - Type additionalProperties: false DialogActionType: - description: The possible values of actions that the conversation can take. type: string enum: - CloseIntent @@ -1492,7 +1976,6 @@ components: - EvaluateConditional - InvokeDialogCodeHook SessionAttribute: - description: Key/value pair representing session-specific context information. It contains application information passed between Amazon Lex and a client application. type: object properties: Key: @@ -1507,21 +1990,17 @@ components: - Key additionalProperties: false IntentOverride: - description: Override settings to configure the intent state. type: object properties: Name: - description: The name of the intent. Only required when you're switching intents. $ref: '#/components/schemas/Name' Slots: - description: A map of all of the slot value overrides for the intent. type: array x-insertionOrder: false items: $ref: '#/components/schemas/SlotValueOverrideMap' additionalProperties: false SlotValueOverrideMap: - description: A map of slot names and their overridden values. type: object properties: SlotName: @@ -1530,67 +2009,51 @@ components: $ref: '#/components/schemas/SlotValueOverride' additionalProperties: false SlotValueOverride: - description: The slot values that Amazon Lex uses when it sets slot values in a dialog step. type: object properties: Shape: - description: When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value. $ref: '#/components/schemas/SlotShape' Value: - description: The current value of the slot. $ref: '#/components/schemas/SlotValue' Values: - description: A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple." $ref: '#/components/schemas/SlotValues' additionalProperties: false SlotValue: - description: The value to set in a slot. type: object properties: InterpretedValue: - description: The value that Amazon Lex determines for the slot. type: string minLength: 1 maxLength: 202 additionalProperties: false SlotValues: - description: An array of values that slots should be set to type: array + x-insertionOrder: false items: $ref: '#/components/schemas/SlotValueOverride' SlotShape: - description: The different shapes that a slot can be in during a conversation. type: string enum: - Scalar - List SlotCaptureSetting: - description: Settings used when Amazon Lex successfully captures a slot value from a user. type: object properties: CaptureResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' CaptureNextStep: - description: Specifies the next step that the bot runs when the slot value is captured before the code hook times out. $ref: '#/components/schemas/DialogState' CaptureConditional: - description: A list of conditional branches to evaluate after the slot value is captured. $ref: '#/components/schemas/ConditionalSpecification' FailureResponse: - description: Specifies a list of message groups that Amazon Lex uses to respond the user input. $ref: '#/components/schemas/ResponseSpecification' FailureNextStep: - description: Specifies the next step that the bot runs when the slot value code is not recognized. $ref: '#/components/schemas/DialogState' FailureConditional: - description: A list of conditional branches to evaluate when the slot value isn't captured. $ref: '#/components/schemas/ConditionalSpecification' CodeHook: - description: Code hook called after Amazon Lex successfully captures a slot value. $ref: '#/components/schemas/DialogCodeHookInvocationSetting' ElicitationCodeHook: - description: Code hook called when Amazon Lex doesn't capture a slot value. $ref: '#/components/schemas/ElicitationCodeHookInvocationSetting' additionalProperties: false Bot: @@ -1607,22 +2070,26 @@ components: RoleArn: $ref: '#/components/schemas/RoleArn' DataPrivacy: - description: Data privacy setting of the Bot. type: object properties: ChildDirected: type: boolean - description: '' required: - ChildDirected additionalProperties: false + ErrorLogSettings: + type: object + properties: + Enabled: + type: boolean + required: + - Enabled + additionalProperties: false IdleSessionTTLInSeconds: - description: IdleSessionTTLInSeconds of the resource type: integer minimum: 60 maximum: 86400 BotLocales: - description: List of bot locales type: array uniqueItems: true x-insertionOrder: false @@ -1631,7 +2098,6 @@ components: BotFileS3Location: $ref: '#/components/schemas/S3Location' BotTags: - description: A list of tags to add to the bot, which can only be added at bot creation. type: array uniqueItems: true maxItems: 200 @@ -1639,7 +2105,6 @@ components: items: $ref: '#/components/schemas/Tag' TestBotAliasTags: - description: A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation. type: array uniqueItems: true maxItems: 200 @@ -1647,21 +2112,37 @@ components: items: $ref: '#/components/schemas/Tag' AutoBuildBotLocales: - description: Specifies whether to build the bot locales after bot creation completes. type: boolean TestBotAliasSettings: $ref: '#/components/schemas/TestBotAliasSettings' + Replication: + $ref: '#/components/schemas/Replication' required: - Name - RoleArn - DataPrivacy - IdleSessionTTLInSeconds x-stackql-resource-name: bot - x-stackql-primaryIdentifier: + description: Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on. + x-type-name: AWS::Lex::Bot + x-stackql-primary-identifier: - Id + x-write-only-properties: + - BotLocales + - BotFileS3Location + - AutoBuildBotLocales + - BotTags + - TestBotAliasTags + - Replication x-read-only-properties: - Id - Arn + x-required-properties: + - Name + - RoleArn + - DataPrivacy + - IdleSessionTTLInSeconds + x-taggable: true x-required-permissions: create: - iam:PassRole @@ -1694,9 +2175,15 @@ components: - lex:DeleteCustomVocabulary - s3:GetObject - lex:UpdateBotAlias + - iam:CreateServiceLinkedRole + - iam:GetRole + - lex:CreateBotReplica + - lex:DescribeBotReplica + - lex:DeleteBotReplica read: - lex:DescribeBot - lex:ListTagsForResource + - lex:DescribeBotReplica update: - iam:PassRole - lex:DescribeBot @@ -1729,6 +2216,9 @@ components: - lex:DeleteCustomVocabulary - s3:GetObject - lex:UpdateBotAlias + - lex:CreateBotReplica + - lex:DescribeBotReplica + - lex:DeleteBotReplica delete: - lex:DeleteBot - lex:DescribeBot @@ -1740,8 +2230,10 @@ components: - lex:DeleteBotChannel - lex:DeleteBotAlias - lex:DeleteCustomVocabulary + - lex:DeleteBotReplica list: - lex:ListBots + - lex:ListBotReplicas BotAliasStatus: type: string enum: @@ -1764,13 +2256,20 @@ components: - BotId - BotVersionLocaleSpecification x-stackql-resource-name: bot_version - x-stackql-primaryIdentifier: + description: A version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production. + x-type-name: AWS::Lex::BotVersion + x-stackql-primary-identifier: - BotId - BotVersion x-create-only-properties: - BotId + x-write-only-properties: + - BotVersionLocaleSpecification x-read-only-properties: - BotVersion + x-required-properties: + - BotId + - BotVersionLocaleSpecification x-required-permissions: create: - lex:CreateBotVersion @@ -1831,15 +2330,22 @@ components: - BotId - BotAliasName x-stackql-resource-name: bot_alias - x-stackql-primaryIdentifier: + description: A Bot Alias enables you to change the version of a bot without updating applications that use the bot + x-type-name: AWS::Lex::BotAlias + x-stackql-primary-identifier: - BotAliasId - BotId x-create-only-properties: - BotId + x-write-only-properties: + - BotAliasTags x-read-only-properties: - BotAliasId - Arn - BotAliasStatus + x-required-properties: + - BotId + - BotAliasName x-required-permissions: create: - lex:CreateBotAlias @@ -1915,11 +2421,18 @@ components: - ResourceArn - Policy x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: + description: A resource policy with specified policy statements that attaches to a Lex bot or bot alias. + x-type-name: AWS::Lex::ResourcePolicy + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - ResourceArn x-read-only-properties: - Id - RevisionId + x-required-properties: + - ResourceArn + - Policy x-required-permissions: create: - lex:CreateResourcePolicy @@ -1934,43 +2447,251 @@ components: - lex:DescribeResourcePolicy list: - lex:DescribeResourcePolicy + CreateBotRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + $ref: '#/components/schemas/Id' + Arn: + $ref: '#/components/schemas/BotArn' + Name: + $ref: '#/components/schemas/Name' + Description: + $ref: '#/components/schemas/Description' + RoleArn: + $ref: '#/components/schemas/RoleArn' + DataPrivacy: + type: object + properties: + ChildDirected: + type: boolean + required: + - ChildDirected + additionalProperties: false + ErrorLogSettings: + type: object + properties: + Enabled: + type: boolean + required: + - Enabled + additionalProperties: false + IdleSessionTTLInSeconds: + type: integer + minimum: 60 + maximum: 86400 + BotLocales: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/BotLocale' + BotFileS3Location: + $ref: '#/components/schemas/S3Location' + BotTags: + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + TestBotAliasTags: + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AutoBuildBotLocales: + type: boolean + TestBotAliasSettings: + $ref: '#/components/schemas/TestBotAliasSettings' + Replication: + $ref: '#/components/schemas/Replication' + x-stackQL-stringOnly: true + x-title: CreateBotRequest + type: object + required: [] + CreateBotVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BotId: + $ref: '#/components/schemas/Id' + BotVersion: + $ref: '#/components/schemas/BotVersion' + Description: + $ref: '#/components/schemas/Description' + BotVersionLocaleSpecification: + $ref: '#/components/schemas/BotVersionLocaleSpecificationList' + x-stackQL-stringOnly: true + x-title: CreateBotVersionRequest + type: object + required: [] + CreateBotAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BotAliasId: + $ref: '#/components/schemas/Id' + BotId: + $ref: '#/components/schemas/Id' + Arn: + $ref: '#/components/schemas/Arn' + BotAliasStatus: + $ref: '#/components/schemas/BotAliasStatus' + BotAliasLocaleSettings: + $ref: '#/components/schemas/BotAliasLocaleSettingsList' + BotAliasName: + $ref: '#/components/schemas/Name' + BotVersion: + $ref: '#/components/schemas/BotVersion' + ConversationLogSettings: + $ref: '#/components/schemas/ConversationLogSettings' + Description: + $ref: '#/components/schemas/Description' + SentimentAnalysisSettings: + description: Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. + type: object + properties: + DetectSentiment: + type: boolean + description: Enable to call Amazon Comprehend for Sentiment natively within Lex + required: + - DetectSentiment + additionalProperties: false + BotAliasTags: + description: A list of tags to add to the bot alias. + type: array + uniqueItems: true + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateBotAliasRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + $ref: '#/components/schemas/ResourceArn' + RevisionId: + $ref: '#/components/schemas/RevisionId' + Policy: + $ref: '#/components/schemas/Policy' + Id: + $ref: '#/components/schemas/PhysicalId' + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: bots: name: bots id: awscc.lex.bots x-cfn-schema-name: Bot - x-type: list + x-cfn-type-name: AWS::Lex::Bot x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Bot&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::Bot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::Bot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::Bot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bots/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bots/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bots/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' - AND region = 'us-east-1' - bot: - name: bot - id: awscc.lex.bot - x-cfn-schema-name: Bot - x-type: get - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1981,18 +2702,20 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, JSON_EXTRACT(Properties, '$.DataPrivacy') as data_privacy, + JSON_EXTRACT(Properties, '$.ErrorLogSettings') as error_log_settings, JSON_EXTRACT(Properties, '$.IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, JSON_EXTRACT(Properties, '$.BotLocales') as bot_locales, JSON_EXTRACT(Properties, '$.BotFileS3Location') as bot_file_s3_location, JSON_EXTRACT(Properties, '$.BotTags') as bot_tags, JSON_EXTRACT(Properties, '$.TestBotAliasTags') as test_bot_alias_tags, JSON_EXTRACT(Properties, '$.AutoBuildBotLocales') as auto_build_bot_locales, - JSON_EXTRACT(Properties, '$.TestBotAliasSettings') as test_bot_alias_settings + JSON_EXTRACT(Properties, '$.TestBotAliasSettings') as test_bot_alias_settings, + JSON_EXTRACT(Properties, '$.Replication') as replication FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::Bot' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2003,24 +2726,31 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'RoleArn') as role_arn, json_extract_path_text(Properties, 'DataPrivacy') as data_privacy, + json_extract_path_text(Properties, 'ErrorLogSettings') as error_log_settings, json_extract_path_text(Properties, 'IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, json_extract_path_text(Properties, 'BotLocales') as bot_locales, json_extract_path_text(Properties, 'BotFileS3Location') as bot_file_s3_location, json_extract_path_text(Properties, 'BotTags') as bot_tags, json_extract_path_text(Properties, 'TestBotAliasTags') as test_bot_alias_tags, json_extract_path_text(Properties, 'AutoBuildBotLocales') as auto_build_bot_locales, - json_extract_path_text(Properties, 'TestBotAliasSettings') as test_bot_alias_settings + json_extract_path_text(Properties, 'TestBotAliasSettings') as test_bot_alias_settings, + json_extract_path_text(Properties, 'Replication') as replication FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::Bot' AND data__Identifier = '' AND region = 'us-east-1' - bot_versions: - name: bot_versions - id: awscc.lex.bot_versions - x-cfn-schema-name: BotVersion - x-type: list + bots_list_only: + name: bots_list_only + id: awscc.lex.bots_list_only + x-cfn-schema-name: Bot + x-cfn-type-name: AWS::Lex::Bot x-identifiers: - - BotId - - BotVersion + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2028,31 +2758,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BotId') as bot_id, - JSON_EXTRACT(Properties, '$.BotVersion') as bot_version - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BotId') as bot_id, - json_extract_path_text(Properties, 'BotVersion') as bot_version - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' AND region = 'us-east-1' - bot_version: - name: bot_version - id: awscc.lex.bot_version + bot_versions: + name: bot_versions + id: awscc.lex.bot_versions x-cfn-schema-name: BotVersion - x-type: get + x-cfn-type-name: AWS::Lex::BotVersion x-identifiers: - BotId - BotVersion + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BotVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::BotVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::BotVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bot_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bot_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2065,7 +2828,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2077,14 +2840,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::BotVersion' AND data__Identifier = '|' AND region = 'us-east-1' - bot_aliases: - name: bot_aliases - id: awscc.lex.bot_aliases - x-cfn-schema-name: BotAlias - x-type: list + bot_versions_list_only: + name: bot_versions_list_only + id: awscc.lex.bot_versions_list_only + x-cfn-schema-name: BotVersion + x-cfn-type-name: AWS::Lex::BotVersion x-identifiers: - - BotAliasId - BotId + - BotVersion + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2092,31 +2861,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BotAliasId') as bot_alias_id, - JSON_EXTRACT(Properties, '$.BotId') as bot_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' + JSON_EXTRACT(Properties, '$.BotId') as bot_id, + JSON_EXTRACT(Properties, '$.BotVersion') as bot_version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BotAliasId') as bot_alias_id, - json_extract_path_text(Properties, 'BotId') as bot_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' + json_extract_path_text(Properties, 'BotId') as bot_id, + json_extract_path_text(Properties, 'BotVersion') as bot_version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' AND region = 'us-east-1' - bot_alias: - name: bot_alias - id: awscc.lex.bot_alias + bot_aliases: + name: bot_aliases + id: awscc.lex.bot_aliases x-cfn-schema-name: BotAlias - x-type: get + x-cfn-type-name: AWS::Lex::BotAlias x-identifiers: - BotAliasId - BotId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BotAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::BotAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::BotAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::BotAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2136,7 +2953,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2155,13 +2972,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::BotAlias' AND data__Identifier = '|' AND region = 'us-east-1' - resource_policies: - name: resource_policies - id: awscc.lex.resource_policies - x-cfn-schema-name: ResourcePolicy - x-type: list + bot_aliases_list_only: + name: bot_aliases_list_only + id: awscc.lex.bot_aliases_list_only + x-cfn-schema-name: BotAlias + x-cfn-type-name: AWS::Lex::BotAlias x-identifiers: - - Id + - BotAliasId + - BotId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2169,28 +2993,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' + JSON_EXTRACT(Properties, '$.BotAliasId') as bot_alias_id, + JSON_EXTRACT(Properties, '$.BotId') as bot_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' + json_extract_path_text(Properties, 'BotAliasId') as bot_alias_id, + json_extract_path_text(Properties, 'BotId') as bot_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.lex.resource_policy + resource_policies: + name: resource_policies + id: awscc.lex.resource_policies x-cfn-schema-name: ResourcePolicy - x-type: get + x-cfn-type-name: AWS::Lex::ResourcePolicy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lex::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2203,7 +3077,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2215,3 +3089,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' AND data__Identifier = '' AND region = 'us-east-1' + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.lex.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::Lex::ResourcePolicy + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Bot&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBot + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBotRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BotVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBotVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBotVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BotAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBotAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBotAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/licensemanager.yaml b/providers/src/awscc/v00.00.00000/services/licensemanager.yaml index a3806518..98758384 100644 --- a/providers/src/awscc/v00.00.00000/services/licensemanager.yaml +++ b/providers/src/awscc/v00.00.00000/services/licensemanager.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: LicenseManager - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: type: string @@ -40,11 +420,18 @@ components: type: string required: [] x-stackql-resource-name: grant - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::LicenseManager::Grant + x-stackql-primary-identifier: - GrantArn + x-write-only-properties: + - Principals + - AllowedOperations + - Status x-read-only-properties: - GrantArn - Version + x-required-properties: [] x-required-permissions: create: - license-manager:CreateGrant @@ -195,11 +582,23 @@ components: - ConsumptionConfiguration - Entitlements x-stackql-resource-name: license - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::LicenseManager::License + x-type-name: AWS::LicenseManager::License + x-stackql-primary-identifier: - LicenseArn + x-write-only-properties: + - Status x-read-only-properties: - LicenseArn - Version + x-required-properties: + - LicenseName + - ProductName + - Issuer + - HomeRegion + - Validity + - ConsumptionConfiguration + - Entitlements x-required-permissions: create: - license-manager:CreateLicense @@ -211,43 +610,175 @@ components: - license-manager:DeleteLicense list: - license-manager:ListLicenses + CreateGrantRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GrantArn: + description: Arn of the grant. + $ref: '#/components/schemas/Arn' + GrantName: + description: Name for the created Grant. + type: string + LicenseArn: + description: License Arn for the grant. + $ref: '#/components/schemas/Arn' + HomeRegion: + description: Home region for the created grant. + type: string + Version: + description: The version of the grant. + type: string + AllowedOperations: + type: array + uniqueItems: true + items: + type: string + Principals: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Arn' + Status: + type: string + x-stackQL-stringOnly: true + x-title: CreateGrantRequest + type: object + required: [] + CreateLicenseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProductSKU: + description: ProductSKU of the license. + type: string + minLength: 1 + maxLength: 1024 + Issuer: + $ref: '#/components/schemas/IssuerData' + LicenseName: + description: Name for the created license. + type: string + ProductName: + description: Product name for the created license. + type: string + HomeRegion: + description: Home region for the created license. + type: string + Validity: + $ref: '#/components/schemas/ValidityDateFormat' + Entitlements: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Entitlement' + Beneficiary: + description: Beneficiary of the license. + type: string + ConsumptionConfiguration: + $ref: '#/components/schemas/ConsumptionConfiguration' + LicenseMetadata: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Metadata' + LicenseArn: + description: Amazon Resource Name is a unique name for each resource. + $ref: '#/components/schemas/Arn' + Status: + $ref: '#/components/schemas/LicenseStatus' + Version: + description: The version of the license. + type: string + x-stackQL-stringOnly: true + x-title: CreateLicenseRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: grants: name: grants id: awscc.licensemanager.grants x-cfn-schema-name: Grant - x-type: list - x-identifiers: - - GrantArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GrantArn') as grant_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GrantArn') as grant_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' - AND region = 'us-east-1' - grant: - name: grant - id: awscc.licensemanager.grant - x-cfn-schema-name: Grant - x-type: get + x-cfn-type-name: AWS::LicenseManager::Grant x-identifiers: - GrantArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Grant&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LicenseManager::Grant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LicenseManager::Grant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LicenseManager::Grant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/grants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/grants/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/grants/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -264,7 +795,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -280,13 +811,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LicenseManager::Grant' AND data__Identifier = '' AND region = 'us-east-1' - licenses: - name: licenses - id: awscc.licensemanager.licenses - x-cfn-schema-name: License - x-type: list + grants_list_only: + name: grants_list_only + id: awscc.licensemanager.grants_list_only + x-cfn-schema-name: Grant + x-cfn-type-name: AWS::LicenseManager::Grant x-identifiers: - - LicenseArn + - GrantArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -294,28 +831,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LicenseArn') as license_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' + JSON_EXTRACT(Properties, '$.GrantArn') as grant_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LicenseArn') as license_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' + json_extract_path_text(Properties, 'GrantArn') as grant_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' AND region = 'us-east-1' - license: - name: license - id: awscc.licensemanager.license + licenses: + name: licenses + id: awscc.licensemanager.licenses x-cfn-schema-name: License - x-type: get + x-cfn-type-name: AWS::LicenseManager::License x-identifiers: - LicenseArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__License&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LicenseManager::License" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LicenseManager::License" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LicenseManager::License" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/licenses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/licenses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/licenses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -337,7 +922,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -358,3 +943,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LicenseManager::License' AND data__Identifier = '' AND region = 'us-east-1' + licenses_list_only: + name: licenses_list_only + id: awscc.licensemanager.licenses_list_only + x-cfn-schema-name: License + x-cfn-type-name: AWS::LicenseManager::License + x-identifiers: + - LicenseArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LicenseArn') as license_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LicenseArn') as license_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Grant&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGrant + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGrantRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__License&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLicense + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLicenseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/lightsail.yaml b/providers/src/awscc/v00.00.00000/services/lightsail.yaml index b3a93f8a..546a7272 100644 --- a/providers/src/awscc/v00.00.00000/services/lightsail.yaml +++ b/providers/src/awscc/v00.00.00000/services/lightsail.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Lightsail - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Alarm: type: object @@ -13,7 +393,7 @@ components: type: string pattern: \w[\w\-]*\w MonitoredResourceName: - description: The validation status of the SSL/TLS certificate. + description: The name of the Lightsail resource that the alarm monitors. type: string MetricName: description: The name of the metric to associate with the alarm. @@ -63,7 +443,9 @@ components: - EvaluationPeriods - Threshold x-stackql-resource-name: alarm - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Alarm + x-type-name: AWS::Lightsail::Alarm + x-stackql-primary-identifier: - AlarmName x-create-only-properties: - AlarmName @@ -72,6 +454,14 @@ components: x-read-only-properties: - AlarmArn - State + x-required-properties: + - AlarmName + - MonitoredResourceName + - MetricName + - ComparisonOperator + - EvaluationPeriods + - Threshold + x-taggable: true x-required-permissions: create: - lightsail:PutAlarm @@ -164,7 +554,9 @@ components: - BucketName - BundleId x-stackql-resource-name: bucket - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Bucket + x-type-name: AWS::Lightsail::Bucket + x-stackql-primary-identifier: - BucketName x-create-only-properties: - BucketName @@ -172,6 +564,18 @@ components: - BucketArn - Url - AbleToUpdateBundle + x-required-properties: + - BucketName + - BundleId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:CreateBucket @@ -229,7 +633,9 @@ components: - CertificateName - DomainName x-stackql-resource-name: certificate - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Certificate. + x-type-name: AWS::Lightsail::Certificate + x-stackql-primary-identifier: - CertificateName x-create-only-properties: - CertificateName @@ -238,6 +644,18 @@ components: x-read-only-properties: - CertificateArn - Status + x-required-properties: + - CertificateName + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:CreateCertificate @@ -361,7 +779,9 @@ components: - Power - Scale x-stackql-resource-name: container - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Container + x-type-name: AWS::Lightsail::Container + x-stackql-primary-identifier: - ServiceName x-create-only-properties: - ServiceName @@ -370,6 +790,19 @@ components: - Url - PrincipalArn - PrivateRegistryAccess/EcrImagePullerRole/PrincipalArn + x-required-properties: + - ServiceName + - Power + - Scale + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:CreateContainerService @@ -545,7 +978,9 @@ components: - MasterDatabaseName - MasterUsername x-stackql-resource-name: database - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Database + x-type-name: AWS::Lightsail::Database + x-stackql-primary-identifier: - RelationalDatabaseName x-create-only-properties: - RelationalDatabaseName @@ -554,8 +989,27 @@ components: - RelationalDatabaseBundleId - MasterDatabaseName - MasterUsername + x-write-only-properties: + - MasterUserPassword + - RelationalDatabaseParameters + - RotateMasterUserPassword x-read-only-properties: - DatabaseArn + x-required-properties: + - RelationalDatabaseName + - RelationalDatabaseBlueprintId + - RelationalDatabaseBundleId + - MasterDatabaseName + - MasterUsername + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:CreateRelationalDatabase @@ -617,15 +1071,15 @@ components: - AddOnType additionalProperties: false Location: - description: Location of a resource. + description: The region name and Availability Zone where you created the snapshot. type: object properties: AvailabilityZone: type: string - description: 'The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.' + description: The Availability Zone. Follows the format us-east-2a (case-sensitive). RegionName: type: string - description: The Region Name in which to create your instance. + description: The AWS Region name. additionalProperties: false Disk: description: Disk associated with the Instance. @@ -825,7 +1279,9 @@ components: - DefaultCacheBehavior - Origin x-stackql-resource-name: distribution - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Distribution + x-type-name: AWS::Lightsail::Distribution + x-stackql-primary-identifier: - DistributionName x-create-only-properties: - DistributionName @@ -834,6 +1290,20 @@ components: - DistributionArn - Status - AbleToUpdateBundle + x-required-properties: + - DistributionName + - BundleId + - DefaultCacheBehavior + - Origin + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:AttachCertificateToDistribution @@ -863,6 +1333,131 @@ components: - lightsail:GetDistributions list: - lightsail:GetDistributions + DomainEntry: + type: object + description: Describes the domain recordset entry (e.g., A record, CNAME record, TXT record, etc.) + properties: + Id: + type: string + description: The ID of the domain recordset entry. + Name: + type: string + description: The name of the domain entry. + Target: + type: string + description: The target AWS name server (e.g., ns-111.awsdns-11.com). + IsAlias: + type: boolean + description: When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource. + Type: + type: string + description: The type of domain entry (e.g., A, CNAME, MX, NS, SOA, SRV, TXT). + enum: + - A + - AAAA + - CNAME + - MX + - NS + - SOA + - SRV + - TXT + required: + - Name + - Type + - Target + additionalProperties: false + Domain: + type: object + properties: + DomainName: + description: The name of the domain to manage in Lightsail. + type: string + DomainEntries: + description: An array of key-value pairs containing information about the domain entries. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/DomainEntry' + Arn: + description: The Amazon Resource Name (ARN) of the domain (read-only). + type: string + pattern: ^arn:.+:lightsail:[a-z0-9-]+:[0-9]{12}:Domain/[a-zA-Z0-9][a-zA-Z0-9-_.]{0,253}[a-zA-Z0-9]$ + SupportCode: + description: The support code. Include this code in your email to support when you have questions (read-only). + type: string + CreatedAt: + description: The timestamp when the domain was created (read-only). + type: string + Location: + type: object + description: The AWS Region and Availability Zone where the domain was created (read-only). + properties: + AvailabilityZone: + type: string + description: The Availability Zone. + RegionName: + type: string + description: The AWS Region name. + additionalProperties: false + ResourceType: + description: The Lightsail resource type (read-only). + type: string + enum: + - Domain + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - DomainName + x-stackql-resource-name: domain + description: Resource Type definition for AWS::Lightsail::Domain + x-type-name: AWS::Lightsail::Domain + x-stackql-primary-identifier: + - DomainName + x-create-only-properties: + - DomainName + x-read-only-properties: + - Arn + - SupportCode + - CreatedAt + - Location + - ResourceType + - DomainEntries/*/Id + x-required-properties: + - DomainName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource + x-required-permissions: + create: + - lightsail:CreateDomain + - lightsail:GetDomain + - lightsail:CreateDomainEntry + - lightsail:TagResource + read: + - lightsail:GetDomain + update: + - lightsail:GetDomain + - lightsail:CreateDomainEntry + - lightsail:DeleteDomainEntry + - lightsail:TagResource + - lightsail:UntagResource + delete: + - lightsail:DeleteDomain + - lightsail:GetDomain + list: + - lightsail:GetDomains ipv6Cidrs: description: IPv6 Cidrs type: array @@ -984,6 +1579,12 @@ components: PublicIpAddress: description: Public IP Address of the Instance type: string + Ipv6Addresses: + description: IPv6 addresses of the instance + type: array + x-insertionOrder: false + items: + type: string Location: $ref: '#/components/schemas/Location' Hardware: @@ -1045,13 +1646,17 @@ components: - BlueprintId - BundleId x-stackql-resource-name: instance - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::Instance + x-type-name: AWS::Lightsail::Instance + x-stackql-primary-identifier: - InstanceName x-create-only-properties: - InstanceName - BlueprintId - BundleId - AvailabilityZone + x-write-only-properties: + - UserData x-read-only-properties: - InstanceArn - SshKeyName @@ -1060,6 +1665,7 @@ components: - IsStaticIp - PrivateIpAddress - PublicIpAddress + - Ipv6Addresses - Location/AvailabilityZone - Location/RegionName - Hardware/CpuCount @@ -1068,6 +1674,19 @@ components: - State/Name - UserName - Networking/MonthlyTransfer/GbPerMonthAllocated + x-required-properties: + - InstanceName + - BlueprintId + - BundleId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:CreateInstances @@ -1107,6 +1726,97 @@ components: - lightsail:GetDisk - lightsail:TagResource - lightsail:UntagResource + InstanceSnapshot: + type: object + properties: + InstanceSnapshotName: + description: The name of the snapshot. + type: string + Arn: + description: The Amazon Resource Name (ARN) of the snapshot. + type: string + InstanceName: + description: The instance from which the snapshot was created. + type: string + ResourceType: + description: The type of resource (usually InstanceSnapshot). + type: string + State: + description: The state the snapshot is in. + type: string + FromInstanceName: + description: The instance from which the snapshot was created. + type: string + FromInstanceArn: + description: The Amazon Resource Name (ARN) of the instance from which the snapshot was created. + type: string + SizeInGb: + description: The size in GB of the SSD + type: integer + IsFromAutoSnapshot: + description: A Boolean value indicating whether the snapshot was created from an automatic snapshot. + type: boolean + SupportCode: + description: Support code to help identify any issues + type: string + Location: + $ref: '#/components/schemas/Location' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - InstanceSnapshotName + - InstanceName + x-stackql-resource-name: instance_snapshot + description: Resource Type definition for AWS::Lightsail::InstanceSnapshot + x-type-name: AWS::Lightsail::InstanceSnapshot + x-stackql-primary-identifier: + - InstanceSnapshotName + x-create-only-properties: + - InstanceSnapshotName + - InstanceName + x-read-only-properties: + - Arn + - IsFromAutoSnapshot + - Location + - FromInstanceName + - FromInstanceArn + - ResourceType + - SizeInGb + - State + - SupportCode + x-required-properties: + - InstanceSnapshotName + - InstanceName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource + x-required-permissions: + create: + - lightsail:CreateInstanceSnapshot + - lightsail:GetInstanceSnapshot + - lightsail:TagResource + read: + - lightsail:GetInstanceSnapshot + update: + - lightsail:GetInstanceSnapshot + - lightsail:TagResource + - lightsail:UntagResource + delete: + - lightsail:GetInstanceSnapshot + - lightsail:DeleteInstanceSnapshot + list: + - lightsail:GetInstanceSnapshots LoadBalancer: type: object properties: @@ -1152,7 +1862,9 @@ components: - LoadBalancerName - InstancePort x-stackql-resource-name: load_balancer - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::LoadBalancer + x-type-name: AWS::Lightsail::LoadBalancer + x-stackql-primary-identifier: - LoadBalancerName x-create-only-properties: - LoadBalancerName @@ -1160,6 +1872,18 @@ components: - IpAddressType x-read-only-properties: - LoadBalancerArn + x-required-properties: + - LoadBalancerName + - InstancePort + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - lightsail:TagResource + - lightsail:UntagResource x-required-permissions: create: - lightsail:CreateLoadBalancer @@ -1225,7 +1949,9 @@ components: - CertificateName - CertificateDomainName x-stackql-resource-name: load_balancer_tls_certificate - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate + x-type-name: AWS::Lightsail::LoadBalancerTlsCertificate + x-stackql-primary-identifier: - CertificateName - LoadBalancerName x-create-only-properties: @@ -1236,6 +1962,11 @@ components: x-read-only-properties: - LoadBalancerTlsCertificateArn - Status + x-required-properties: + - LoadBalancerName + - CertificateName + - CertificateDomainName + x-taggable: true x-required-permissions: create: - lightsail:CreateLoadBalancerTlsCertificate @@ -1278,7 +2009,9 @@ components: required: - StaticIpName x-stackql-resource-name: static_ip - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Lightsail::StaticIp + x-type-name: AWS::Lightsail::StaticIp + x-stackql-primary-identifier: - StaticIpName x-create-only-properties: - StaticIpName @@ -1286,6 +2019,9 @@ components: - StaticIpArn - IsAttached - IpAddress + x-required-properties: + - StaticIpName + x-taggable: true x-required-permissions: create: - lightsail:AllocateStaticIp @@ -1309,43 +2045,793 @@ components: - lightsail:ReleaseStaticIp list: - lightsail:GetStaticIps - x-stackQL-resources: - alarms: - name: alarms - id: awscc.lightsail.alarms - x-cfn-schema-name: Alarm - x-type: list - x-identifiers: - - AlarmName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmName') as alarm_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' - AND region = 'us-east-1' - alarm: - name: alarm - id: awscc.lightsail.alarm - x-cfn-schema-name: Alarm - x-type: get - x-identifiers: + CreateAlarmRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AlarmName: + description: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm. + type: string + pattern: \w[\w\-]*\w + MonitoredResourceName: + description: The name of the Lightsail resource that the alarm monitors. + type: string + MetricName: + description: The name of the metric to associate with the alarm. + type: string + ComparisonOperator: + description: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand. + type: string + ContactProtocols: + description: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + AlarmArn: + type: string + DatapointsToAlarm: + description: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M. + type: integer + EvaluationPeriods: + description: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N. + type: integer + NotificationEnabled: + description: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter. + type: boolean + NotificationTriggers: + description: The alarm states that trigger a notification. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Threshold: + description: The value against which the specified statistic is compared. + type: number + TreatMissingData: + description: Sets how this alarm will handle missing data points. + type: string + State: + description: The current state of the alarm. + type: string + x-stackQL-stringOnly: true + x-title: CreateAlarmRequest + type: object + required: [] + CreateBucketRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BucketName: + description: The name for the bucket. + type: string + pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ + minLength: 3 + maxLength: 54 + BundleId: + description: The ID of the bundle to use for the bucket. + type: string + BucketArn: + type: string + ObjectVersioning: + description: Specifies whether to enable or disable versioning of objects in the bucket. + type: boolean + AccessRules: + $ref: '#/components/schemas/AccessRules' + ResourcesReceivingAccess: + description: The names of the Lightsail resources for which to set bucket access. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + ReadOnlyAccessAccounts: + description: An array of strings to specify the AWS account IDs that can access the bucket. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Url: + description: The URL of the bucket. + type: string + AbleToUpdateBundle: + description: Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateBucketRequest + type: object + required: [] + CreateCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateName: + description: The name for the certificate. + type: string + DomainName: + description: The domain name (e.g., example.com ) for the certificate. + type: string + SubjectAlternativeNames: + description: An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + CertificateArn: + type: string + Status: + description: The validation status of the certificate. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCertificateRequest + type: object + required: [] + CreateContainerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ServiceName: + description: The name for the container service. + type: string + pattern: ^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$ + minLength: 1 + maxLength: 63 + Power: + description: The power specification for the container service. + type: string + ContainerArn: + type: string + Scale: + description: The scale specification for the container service. + type: integer + minimum: 1 + maximum: 20 + PublicDomainNames: + description: The public domain names to use with the container service, such as example.com and www.example.com. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PublicDomainName' + ContainerServiceDeployment: + $ref: '#/components/schemas/ContainerServiceDeployment' + description: Describes a container deployment configuration of an Amazon Lightsail container service. + IsDisabled: + description: A Boolean value to indicate whether the container service is disabled. + type: boolean + PrivateRegistryAccess: + $ref: '#/components/schemas/PrivateRegistryAccess' + description: A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. + Url: + description: The publicly accessible URL of the container service. + type: string + PrincipalArn: + description: The principal ARN of the container service. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateContainerRequest + type: object + required: [] + CreateDatabaseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RelationalDatabaseName: + description: The name to use for your new Lightsail database resource. + type: string + pattern: \w[\w\-]*\w + minLength: 2 + maxLength: 255 + DatabaseArn: + type: string + AvailabilityZone: + description: The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. + type: string + minLength: 1 + maxLength: 255 + RelationalDatabaseBlueprintId: + description: The blueprint ID for your new database. A blueprint describes the major engine version of a database. + type: string + minLength: 1 + maxLength: 255 + RelationalDatabaseBundleId: + description: The bundle ID for your new database. A bundle describes the performance specifications for your database. + type: string + minLength: 1 + maxLength: 255 + MasterDatabaseName: + description: The name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource. + type: string + minLength: 1 + maxLength: 255 + MasterUsername: + description: The name for the master user. + type: string + minLength: 1 + maxLength: 63 + MasterUserPassword: + description: The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces. + type: string + minLength: 1 + maxLength: 63 + PreferredBackupWindow: + description: The daily time range during which automated backups are created for your new database if automated backups are enabled. + type: string + PreferredMaintenanceWindow: + description: The weekly time range during which system maintenance can occur on your new database. + type: string + PubliclyAccessible: + description: Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. + type: boolean + CaCertificateIdentifier: + description: Indicates the certificate that needs to be associated with the database. + type: string + BackupRetention: + description: When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage. + type: boolean + RotateMasterUserPassword: + description: When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password. + type: boolean + RelationalDatabaseParameters: + description: Update one or more parameters of the relational database. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/RelationalDatabaseParameter' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDatabaseRequest + type: object + required: [] + CreateDistributionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DistributionName: + description: The name for the distribution. + type: string + pattern: \w[\w\-]*\w + DistributionArn: + type: string + BundleId: + description: The bundle ID to use for the distribution. + type: string + IpAddressType: + description: The IP address type for the distribution. + type: string + CacheBehaviors: + description: An array of objects that describe the per-path cache behavior for the distribution. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/CacheBehaviorPerPath' + CacheBehaviorSettings: + description: An object that describes the cache behavior settings for the distribution. + $ref: '#/components/schemas/CacheSettings' + DefaultCacheBehavior: + description: An object that describes the default cache behavior for the distribution. + $ref: '#/components/schemas/CacheBehavior' + Origin: + description: An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer. + $ref: '#/components/schemas/InputOrigin' + Status: + description: The status of the distribution. + type: string + AbleToUpdateBundle: + description: Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle. + type: boolean + IsEnabled: + description: Indicates whether the distribution is enabled. + type: boolean + CertificateName: + description: The certificate attached to the Distribution. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDistributionRequest + type: object + required: [] + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainName: + description: The name of the domain to manage in Lightsail. + type: string + DomainEntries: + description: An array of key-value pairs containing information about the domain entries. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/DomainEntry' + Arn: + description: The Amazon Resource Name (ARN) of the domain (read-only). + type: string + pattern: ^arn:.+:lightsail:[a-z0-9-]+:[0-9]{12}:Domain/[a-zA-Z0-9][a-zA-Z0-9-_.]{0,253}[a-zA-Z0-9]$ + SupportCode: + description: The support code. Include this code in your email to support when you have questions (read-only). + type: string + CreatedAt: + description: The timestamp when the domain was created (read-only). + type: string + Location: + type: object + description: The AWS Region and Availability Zone where the domain was created (read-only). + properties: + AvailabilityZone: + type: string + description: The Availability Zone. + RegionName: + type: string + description: The AWS Region name. + additionalProperties: false + ResourceType: + description: The Lightsail resource type (read-only). + type: string + enum: + - Domain + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + CreateInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SupportCode: + description: Support code to help identify any issues + type: string + ResourceType: + description: Resource type of Lightsail instance. + type: string + IsStaticIp: + description: Is the IP Address of the Instance is the static IP + type: boolean + PrivateIpAddress: + description: Private IP Address of the Instance + type: string + PublicIpAddress: + description: Public IP Address of the Instance + type: string + Ipv6Addresses: + description: IPv6 addresses of the instance + type: array + x-insertionOrder: false + items: + type: string + Location: + $ref: '#/components/schemas/Location' + Hardware: + $ref: '#/components/schemas/Hardware' + State: + $ref: '#/components/schemas/State' + Networking: + $ref: '#/components/schemas/Networking' + UserName: + description: Username of the Lightsail instance. + type: string + SshKeyName: + description: SSH Key Name of the Lightsail instance. + type: string + InstanceName: + description: The names to use for your new Lightsail instance. + type: string + pattern: ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$ + minLength: 1 + maxLength: 254 + AvailabilityZone: + description: 'The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.' + type: string + minLength: 1 + maxLength: 255 + BundleId: + description: The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ). + type: string + minLength: 1 + maxLength: 255 + BlueprintId: + description: The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ). + type: string + minLength: 1 + maxLength: 255 + AddOns: + description: An array of objects representing the add-ons to enable for the new instance. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/AddOn' + UserData: + description: A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. + type: string + KeyPairName: + description: The name of your key pair. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + InstanceArn: + type: string + x-stackQL-stringOnly: true + x-title: CreateInstanceRequest + type: object + required: [] + CreateInstanceSnapshotRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceSnapshotName: + description: The name of the snapshot. + type: string + Arn: + description: The Amazon Resource Name (ARN) of the snapshot. + type: string + InstanceName: + description: The instance from which the snapshot was created. + type: string + ResourceType: + description: The type of resource (usually InstanceSnapshot). + type: string + State: + description: The state the snapshot is in. + type: string + FromInstanceName: + description: The instance from which the snapshot was created. + type: string + FromInstanceArn: + description: The Amazon Resource Name (ARN) of the instance from which the snapshot was created. + type: string + SizeInGb: + description: The size in GB of the SSD + type: integer + IsFromAutoSnapshot: + description: A Boolean value indicating whether the snapshot was created from an automatic snapshot. + type: boolean + SupportCode: + description: Support code to help identify any issues + type: string + Location: + $ref: '#/components/schemas/Location' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateInstanceSnapshotRequest + type: object + required: [] + CreateLoadBalancerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LoadBalancerName: + description: The name of your load balancer. + type: string + pattern: \w[\w\-]*\w + LoadBalancerArn: + type: string + InstancePort: + description: The instance port where you're creating your load balancer. + type: integer + IpAddressType: + description: The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack. + type: string + AttachedInstances: + description: The names of the instances attached to the load balancer. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + HealthCheckPath: + description: The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/"). + type: string + SessionStickinessEnabled: + description: Configuration option to enable session stickiness. + type: boolean + SessionStickinessLBCookieDurationSeconds: + description: Configuration option to adjust session stickiness cookie duration parameter. + type: string + TlsPolicyName: + description: The name of the TLS policy to apply to the load balancer. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateLoadBalancerRequest + type: object + required: [] + CreateLoadBalancerTlsCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LoadBalancerName: + description: The name of your load balancer. + type: string + pattern: \w[\w\-]*\w + CertificateName: + description: The SSL/TLS certificate name. + type: string + CertificateDomainName: + description: The domain name (e.g., example.com ) for your SSL/TLS certificate. + type: string + CertificateAlternativeNames: + description: An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + LoadBalancerTlsCertificateArn: + type: string + IsAttached: + description: When true, the SSL/TLS certificate is attached to the Lightsail load balancer. + type: boolean + HttpsRedirectionEnabled: + description: A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer. + type: boolean + Status: + description: The validation status of the SSL/TLS certificate. + type: string + x-stackQL-stringOnly: true + x-title: CreateLoadBalancerTlsCertificateRequest + type: object + required: [] + CreateStaticIpRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StaticIpName: + description: The name of the static IP address. + type: string + AttachedTo: + description: The instance where the static IP is attached. + type: string + IsAttached: + description: A Boolean value indicating whether the static IP is attached. + type: boolean + IpAddress: + description: The static IP address. + type: string + StaticIpArn: + type: string + x-stackQL-stringOnly: true + x-title: CreateStaticIpRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + alarms: + name: alarms + id: awscc.lightsail.alarms + x-cfn-schema-name: Alarm + x-cfn-type-name: AWS::Lightsail::Alarm + x-identifiers: - AlarmName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alarm&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Alarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Alarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Alarm" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/alarms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/alarms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/alarms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1367,7 +2853,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1388,13 +2874,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Alarm' AND data__Identifier = '' AND region = 'us-east-1' - buckets: - name: buckets - id: awscc.lightsail.buckets - x-cfn-schema-name: Bucket - x-type: list + alarms_list_only: + name: alarms_list_only + id: awscc.lightsail.alarms_list_only + x-cfn-schema-name: Alarm + x-cfn-type-name: AWS::Lightsail::Alarm x-identifiers: - - BucketName + - AlarmName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1402,28 +2894,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BucketName') as bucket_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' + JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BucketName') as bucket_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' + json_extract_path_text(Properties, 'AlarmName') as alarm_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' AND region = 'us-east-1' - bucket: - name: bucket - id: awscc.lightsail.bucket + buckets: + name: buckets + id: awscc.lightsail.buckets x-cfn-schema-name: Bucket - x-type: get + x-cfn-type-name: AWS::Lightsail::Bucket x-identifiers: - BucketName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Bucket&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1442,7 +2982,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1460,13 +3000,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Bucket' AND data__Identifier = '' AND region = 'us-east-1' - certificates: - name: certificates - id: awscc.lightsail.certificates - x-cfn-schema-name: Certificate - x-type: list + buckets_list_only: + name: buckets_list_only + id: awscc.lightsail.buckets_list_only + x-cfn-schema-name: Bucket + x-cfn-type-name: AWS::Lightsail::Bucket x-identifiers: - - CertificateName + - BucketName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1474,28 +3020,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' + JSON_EXTRACT(Properties, '$.BucketName') as bucket_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CertificateName') as certificate_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' + json_extract_path_text(Properties, 'BucketName') as bucket_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' AND region = 'us-east-1' - certificate: - name: certificate - id: awscc.lightsail.certificate + certificates: + name: certificates + id: awscc.lightsail.certificates x-cfn-schema-name: Certificate - x-type: get + x-cfn-type-name: AWS::Lightsail::Certificate x-identifiers: - CertificateName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1510,7 +3104,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1524,13 +3118,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Certificate' AND data__Identifier = '' AND region = 'us-east-1' - containers: - name: containers - id: awscc.lightsail.containers - x-cfn-schema-name: Container - x-type: list + certificates_list_only: + name: certificates_list_only + id: awscc.lightsail.certificates_list_only + x-cfn-schema-name: Certificate + x-cfn-type-name: AWS::Lightsail::Certificate x-identifiers: - - ServiceName + - CertificateName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1538,28 +3138,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ServiceName') as service_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' + JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ServiceName') as service_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' + json_extract_path_text(Properties, 'CertificateName') as certificate_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' AND region = 'us-east-1' - container: - name: container - id: awscc.lightsail.container + containers: + name: containers + id: awscc.lightsail.containers x-cfn-schema-name: Container - x-type: get + x-cfn-type-name: AWS::Lightsail::Container x-identifiers: - ServiceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Container&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Container" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Container" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Container" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/containers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/containers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/containers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1579,7 +3227,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1598,13 +3246,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Container' AND data__Identifier = '' AND region = 'us-east-1' - databases: - name: databases - id: awscc.lightsail.databases - x-cfn-schema-name: Database - x-type: list + containers_list_only: + name: containers_list_only + id: awscc.lightsail.containers_list_only + x-cfn-schema-name: Container + x-cfn-type-name: AWS::Lightsail::Container x-identifiers: - - RelationalDatabaseName + - ServiceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1612,28 +3266,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RelationalDatabaseName') as relational_database_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' + JSON_EXTRACT(Properties, '$.ServiceName') as service_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RelationalDatabaseName') as relational_database_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' + json_extract_path_text(Properties, 'ServiceName') as service_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' AND region = 'us-east-1' - database: - name: database - id: awscc.lightsail.database + databases: + name: databases + id: awscc.lightsail.databases x-cfn-schema-name: Database - x-type: get + x-cfn-type-name: AWS::Lightsail::Database x-identifiers: - RelationalDatabaseName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Database&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1658,7 +3360,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1682,13 +3384,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Database' AND data__Identifier = '' AND region = 'us-east-1' - distributions: - name: distributions - id: awscc.lightsail.distributions - x-cfn-schema-name: Distribution - x-type: list + databases_list_only: + name: databases_list_only + id: awscc.lightsail.databases_list_only + x-cfn-schema-name: Database + x-cfn-type-name: AWS::Lightsail::Database x-identifiers: - - DistributionName + - RelationalDatabaseName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1696,28 +3404,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DistributionName') as distribution_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' + JSON_EXTRACT(Properties, '$.RelationalDatabaseName') as relational_database_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DistributionName') as distribution_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' + json_extract_path_text(Properties, 'RelationalDatabaseName') as relational_database_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' AND region = 'us-east-1' - distribution: - name: distribution - id: awscc.lightsail.distribution + distributions: + name: distributions + id: awscc.lightsail.distributions x-cfn-schema-name: Distribution - x-type: get + x-cfn-type-name: AWS::Lightsail::Distribution x-identifiers: - DistributionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Distribution&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Distribution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Distribution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Distribution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distributions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distributions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/distributions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1739,7 +3495,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1760,13 +3516,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Distribution' AND data__Identifier = '' AND region = 'us-east-1' - instances: - name: instances - id: awscc.lightsail.instances - x-cfn-schema-name: Instance - x-type: list + distributions_list_only: + name: distributions_list_only + id: awscc.lightsail.distributions_list_only + x-cfn-schema-name: Distribution + x-cfn-type-name: AWS::Lightsail::Distribution x-identifiers: - - InstanceName + - DistributionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1774,28 +3536,198 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceName') as instance_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' + JSON_EXTRACT(Properties, '$.DistributionName') as distribution_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceName') as instance_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' + json_extract_path_text(Properties, 'DistributionName') as distribution_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' + AND region = 'us-east-1' + domains: + name: domains + id: awscc.lightsail.domains + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::Lightsail::Domain + x-identifiers: + - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.DomainEntries') as domain_entries, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.SupportCode') as support_code, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainEntries') as domain_entries, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'SupportCode') as support_code, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + domains_list_only: + name: domains_list_only + id: awscc.lightsail.domains_list_only + x-cfn-schema-name: Domain + x-cfn-type-name: AWS::Lightsail::Domain + x-identifiers: + - DomainName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Domain' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Domain' AND region = 'us-east-1' - instance: - name: instance - id: awscc.lightsail.instance + instances: + name: instances + id: awscc.lightsail.instances x-cfn-schema-name: Instance - x-type: get + x-cfn-type-name: AWS::Lightsail::Instance x-identifiers: - InstanceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1805,6 +3737,7 @@ components: JSON_EXTRACT(Properties, '$.IsStaticIp') as is_static_ip, JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, JSON_EXTRACT(Properties, '$.PublicIpAddress') as public_ip_address, + JSON_EXTRACT(Properties, '$.Ipv6Addresses') as ipv6_addresses, JSON_EXTRACT(Properties, '$.Location') as location, JSON_EXTRACT(Properties, '$.Hardware') as hardware, JSON_EXTRACT(Properties, '$.State') as state, @@ -1824,7 +3757,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1834,6 +3767,7 @@ components: json_extract_path_text(Properties, 'IsStaticIp') as is_static_ip, json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, json_extract_path_text(Properties, 'PublicIpAddress') as public_ip_address, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, json_extract_path_text(Properties, 'Location') as location, json_extract_path_text(Properties, 'Hardware') as hardware, json_extract_path_text(Properties, 'State') as state, @@ -1852,13 +3786,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Instance' AND data__Identifier = '' AND region = 'us-east-1' - load_balancers: - name: load_balancers - id: awscc.lightsail.load_balancers - x-cfn-schema-name: LoadBalancer - x-type: list + instances_list_only: + name: instances_list_only + id: awscc.lightsail.instances_list_only + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::Lightsail::Instance x-identifiers: - - LoadBalancerName + - InstanceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1866,28 +3806,206 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' + JSON_EXTRACT(Properties, '$.InstanceName') as instance_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' + json_extract_path_text(Properties, 'InstanceName') as instance_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' + AND region = 'us-east-1' + instance_snapshots: + name: instance_snapshots + id: awscc.lightsail.instance_snapshots + x-cfn-schema-name: InstanceSnapshot + x-cfn-type-name: AWS::Lightsail::InstanceSnapshot + x-identifiers: + - InstanceSnapshotName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceSnapshot&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::InstanceSnapshot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::InstanceSnapshot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::InstanceSnapshot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_snapshots/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_snapshots/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_snapshots/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.InstanceSnapshotName') as instance_snapshot_name, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.InstanceName') as instance_name, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.FromInstanceName') as from_instance_name, + JSON_EXTRACT(Properties, '$.FromInstanceArn') as from_instance_arn, + JSON_EXTRACT(Properties, '$.SizeInGb') as size_in_gb, + JSON_EXTRACT(Properties, '$.IsFromAutoSnapshot') as is_from_auto_snapshot, + JSON_EXTRACT(Properties, '$.SupportCode') as support_code, + JSON_EXTRACT(Properties, '$.Location') as location, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::InstanceSnapshot' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceSnapshotName') as instance_snapshot_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'InstanceName') as instance_name, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'FromInstanceName') as from_instance_name, + json_extract_path_text(Properties, 'FromInstanceArn') as from_instance_arn, + json_extract_path_text(Properties, 'SizeInGb') as size_in_gb, + json_extract_path_text(Properties, 'IsFromAutoSnapshot') as is_from_auto_snapshot, + json_extract_path_text(Properties, 'SupportCode') as support_code, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::InstanceSnapshot' + AND data__Identifier = '' + AND region = 'us-east-1' + instance_snapshots_list_only: + name: instance_snapshots_list_only + id: awscc.lightsail.instance_snapshots_list_only + x-cfn-schema-name: InstanceSnapshot + x-cfn-type-name: AWS::Lightsail::InstanceSnapshot + x-identifiers: + - InstanceSnapshotName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.InstanceSnapshotName') as instance_snapshot_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::InstanceSnapshot' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceSnapshotName') as instance_snapshot_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::InstanceSnapshot' AND region = 'us-east-1' - load_balancer: - name: load_balancer - id: awscc.lightsail.load_balancer + load_balancers: + name: load_balancers + id: awscc.lightsail.load_balancers x-cfn-schema-name: LoadBalancer - x-type: get + x-cfn-type-name: AWS::Lightsail::LoadBalancer x-identifiers: - LoadBalancerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LoadBalancer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::LoadBalancer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::LoadBalancer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::LoadBalancer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1906,7 +4024,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1924,14 +4042,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' AND data__Identifier = '' AND region = 'us-east-1' - load_balancer_tls_certificates: - name: load_balancer_tls_certificates - id: awscc.lightsail.load_balancer_tls_certificates - x-cfn-schema-name: LoadBalancerTlsCertificate - x-type: list + load_balancers_list_only: + name: load_balancers_list_only + id: awscc.lightsail.load_balancers_list_only + x-cfn-schema-name: LoadBalancer + x-cfn-type-name: AWS::Lightsail::LoadBalancer x-identifiers: - - CertificateName - LoadBalancerName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1939,31 +4062,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name, JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CertificateName') as certificate_name, json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' AND region = 'us-east-1' - load_balancer_tls_certificate: - name: load_balancer_tls_certificate - id: awscc.lightsail.load_balancer_tls_certificate + load_balancer_tls_certificates: + name: load_balancer_tls_certificates + id: awscc.lightsail.load_balancer_tls_certificates x-cfn-schema-name: LoadBalancerTlsCertificate - x-type: get + x-cfn-type-name: AWS::Lightsail::LoadBalancerTlsCertificate x-identifiers: - CertificateName - LoadBalancerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LoadBalancerTlsCertificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::LoadBalancerTlsCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::LoadBalancerTlsCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::LoadBalancerTlsCertificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1980,7 +4149,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1996,13 +4165,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' AND data__Identifier = '|' AND region = 'us-east-1' - static_ips: - name: static_ips - id: awscc.lightsail.static_ips - x-cfn-schema-name: StaticIp - x-type: list + load_balancer_tls_certificates_list_only: + name: load_balancer_tls_certificates_list_only + id: awscc.lightsail.load_balancer_tls_certificates_list_only + x-cfn-schema-name: LoadBalancerTlsCertificate + x-cfn-type-name: AWS::Lightsail::LoadBalancerTlsCertificate x-identifiers: - - StaticIpName + - CertificateName + - LoadBalancerName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2010,28 +4186,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StaticIpName') as static_ip_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' + JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name, + JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StaticIpName') as static_ip_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' + json_extract_path_text(Properties, 'CertificateName') as certificate_name, + json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' AND region = 'us-east-1' - static_ip: - name: static_ip - id: awscc.lightsail.static_ip + static_ips: + name: static_ips + id: awscc.lightsail.static_ips x-cfn-schema-name: StaticIp - x-type: get + x-cfn-type-name: AWS::Lightsail::StaticIp x-identifiers: - StaticIpName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StaticIp&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::StaticIp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::StaticIp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lightsail::StaticIp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/static_ips/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/static_ips/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/static_ips/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2045,7 +4271,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2058,3 +4284,691 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::StaticIp' AND data__Identifier = '' AND region = 'us-east-1' + static_ips_list_only: + name: static_ips_list_only + id: awscc.lightsail.static_ips_list_only + x-cfn-schema-name: StaticIp + x-cfn-type-name: AWS::Lightsail::StaticIp + x-identifiers: + - StaticIpName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.StaticIpName') as static_ip_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StaticIpName') as static_ip_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alarm&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlarm + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAlarmRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Bucket&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBucket + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBucketRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Container&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContainer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContainerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Database&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDatabase + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatabaseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Distribution&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDistribution + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDistributionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceSnapshot&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceSnapshot + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceSnapshotRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LoadBalancer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLoadBalancer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoadBalancerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LoadBalancerTlsCertificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLoadBalancerTlsCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoadBalancerTlsCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StaticIp&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStaticIp + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStaticIpRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/location.yaml b/providers/src/awscc/v00.00.00000/services/location.yaml index a7ed566a..d8b8ac90 100644 --- a/providers/src/awscc/v00.00.00000/services/location.yaml +++ b/providers/src/awscc/v00.00.00000/services/location.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Location - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ApiKeyRestrictions: type: object @@ -14,8 +394,8 @@ components: type: string maxLength: 200 minLength: 5 - pattern: ^geo:\w*\*?$ - maxItems: 7 + pattern: ^(geo|geo-routes|geo-places|geo-maps):\w*\*?$ + maxItems: 24 minItems: 1 x-insertionOrder: false AllowResources: @@ -23,8 +403,8 @@ components: items: type: string maxLength: 1600 - pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$ - maxItems: 5 + pattern: (^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\/][*-._\w]+))$) + maxItems: 8 minItems: 1 x-insertionOrder: false AllowReferers: @@ -44,11 +424,14 @@ components: type: object maxProperties: 50 x-patternProperties: - ^[a-zA-Z+-=._:/]+$: + ^([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)$: type: string maxLength: 256 minLength: 0 - pattern: ^[A-Za-z0-9 _=@:.+-/]*$ + pattern: ^([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)$ + additionalProperties: false + Unit: + type: object additionalProperties: false Tag: description: A key-value pair to associate with a resource. @@ -121,15 +504,33 @@ components: - KeyName - Restrictions x-stackql-resource-name: api_key - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::APIKey Resource Type + x-type-name: AWS::Location::APIKey + x-stackql-primary-identifier: - KeyName x-create-only-properties: - KeyName + x-write-only-properties: + - ForceUpdate + - ForceDelete + - NoExpiry x-read-only-properties: - CreateTime - Arn - KeyArn - UpdateTime + x-required-properties: + - KeyName + - Restrictions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - geo:TagResource + - geo:UntagResource x-required-permissions: create: - geo:CreateKey @@ -146,6 +547,20 @@ components: - geo:GetPlace - geo:CalculateRoute - geo:CalculateRouteMatrix + - geo-maps:GetTile + - geo-maps:GetStaticMap + - geo-places:Autocomplete + - geo-places:Geocode + - geo-places:GetPlace + - geo-places:ReverseGeocode + - geo-places:SearchNearby + - geo-places:SearchText + - geo-places:Suggest + - geo-routes:CalculateIsolines + - geo-routes:CalculateRouteMatrix + - geo-routes:CalculateRoutes + - geo-routes:OptimizeWaypoints + - geo-routes:SnapToRoads read: - geo:DescribeKey update: @@ -163,6 +578,20 @@ components: - geo:GetPlace - geo:CalculateRoute - geo:CalculateRouteMatrix + - geo-maps:GetTile + - geo-maps:GetStaticMap + - geo-places:Autocomplete + - geo-places:Geocode + - geo-places:GetPlace + - geo-places:ReverseGeocode + - geo-places:SearchNearby + - geo-places:SearchText + - geo-places:Suggest + - geo-routes:CalculateIsolines + - geo-routes:CalculateRouteMatrix + - geo-routes:CalculateRoutes + - geo-routes:OptimizeWaypoints + - geo-routes:SnapToRoads - geo:UpdateKey delete: - geo:DeleteKey @@ -199,6 +628,7 @@ components: $ref: '#/components/schemas/PricingPlan' PricingPlanDataSource: type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -217,7 +647,9 @@ components: required: - CollectionName x-stackql-resource-name: geofence_collection - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::GeofenceCollection Resource Type + x-type-name: AWS::Location::GeofenceCollection + x-stackql-primary-identifier: - CollectionName x-create-only-properties: - CollectionName @@ -227,6 +659,17 @@ components: - Arn - CreateTime - UpdateTime + x-required-properties: + - CollectionName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - geo:TagResource + - geo:UntagResource x-required-permissions: create: - geo:CreateGeofenceCollection @@ -316,7 +759,9 @@ components: - Configuration - MapName x-stackql-resource-name: map - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::Map Resource Type + x-type-name: AWS::Location::Map + x-stackql-primary-identifier: - MapName x-create-only-properties: - Configuration @@ -326,6 +771,18 @@ components: - Arn - MapArn - UpdateTime + x-required-properties: + - Configuration + - MapName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - geo:TagResource + - geo:UntagResource x-required-permissions: create: - geo:CreateMap @@ -399,7 +856,9 @@ components: - DataSource - IndexName x-stackql-resource-name: place_index - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::PlaceIndex Resource Type + x-type-name: AWS::Location::PlaceIndex + x-stackql-primary-identifier: - IndexName x-create-only-properties: - DataSource @@ -409,6 +868,18 @@ components: - Arn - IndexArn - UpdateTime + x-required-properties: + - DataSource + - IndexName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - geo:TagResource + - geo:UntagResource x-required-permissions: create: - geo:CreatePlaceIndex @@ -469,7 +940,9 @@ components: - DataSource - CalculatorName x-stackql-resource-name: route_calculator - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::RouteCalculator Resource Type + x-type-name: AWS::Location::RouteCalculator + x-stackql-primary-identifier: - CalculatorName x-create-only-properties: - CalculatorName @@ -479,6 +952,18 @@ components: - Arn - CreateTime - UpdateTime + x-required-properties: + - DataSource + - CalculatorName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - geo:TagResource + - geo:UntagResource x-required-permissions: create: - geo:CreateRouteCalculator @@ -527,6 +1012,7 @@ components: $ref: '#/components/schemas/PricingPlan' PricingPlanDataSource: type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -554,7 +1040,9 @@ components: required: - TrackerName x-stackql-resource-name: tracker - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::Tracker Resource Type + x-type-name: AWS::Location::Tracker + x-stackql-primary-identifier: - TrackerName x-create-only-properties: - KmsKeyId @@ -564,6 +1052,17 @@ components: - Arn - TrackerArn - UpdateTime + x-required-properties: + - TrackerName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - geo:TagResource + - geo:UntagResource x-required-permissions: create: - geo:CreateTracker @@ -604,12 +1103,22 @@ components: - ConsumerArn - TrackerName x-stackql-resource-name: tracker_consumer - x-stackql-primaryIdentifier: + description: Definition of AWS::Location::TrackerConsumer Resource Type + x-type-name: AWS::Location::TrackerConsumer + x-stackql-primary-identifier: - TrackerName - ConsumerArn x-create-only-properties: - TrackerName - ConsumerArn + x-required-properties: + - ConsumerArn + - TrackerName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - geo:AssociateTrackerConsumer @@ -621,43 +1130,429 @@ components: - geo:ListTrackerConsumers read: - geo:ListTrackerConsumers + CreateAPIKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreateTime: + $ref: '#/components/schemas/iso8601UTC' + Description: + type: string + maxLength: 1000 + minLength: 0 + ExpireTime: + $ref: '#/components/schemas/iso8601UTC' + ForceUpdate: + type: boolean + KeyArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + KeyName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + NoExpiry: + type: boolean + Restrictions: + $ref: '#/components/schemas/ApiKeyRestrictions' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + UpdateTime: + $ref: '#/components/schemas/iso8601UTC' + ForceDelete: + type: boolean + Arn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + x-stackQL-stringOnly: true + x-title: CreateAPIKeyRequest + type: object + required: [] + CreateGeofenceCollectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CollectionArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + CollectionName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + CreateTime: + $ref: '#/components/schemas/iso8601UTC' + Description: + type: string + maxLength: 1000 + minLength: 0 + KmsKeyId: + type: string + maxLength: 2048 + minLength: 1 + PricingPlan: + $ref: '#/components/schemas/PricingPlan' + PricingPlanDataSource: + type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + UpdateTime: + $ref: '#/components/schemas/iso8601UTC' + Arn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + x-stackQL-stringOnly: true + x-title: CreateGeofenceCollectionRequest + type: object + required: [] + CreateMapRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Configuration: + $ref: '#/components/schemas/MapConfiguration' + CreateTime: + $ref: '#/components/schemas/iso8601UTC' + Description: + type: string + maxLength: 1000 + minLength: 0 + MapArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$ + MapName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + PricingPlan: + $ref: '#/components/schemas/PricingPlan' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + UpdateTime: + $ref: '#/components/schemas/iso8601UTC' + Arn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + x-stackQL-stringOnly: true + x-title: CreateMapRequest + type: object + required: [] + CreatePlaceIndexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreateTime: + $ref: '#/components/schemas/iso8601UTC' + DataSource: + type: string + DataSourceConfiguration: + $ref: '#/components/schemas/DataSourceConfiguration' + Description: + type: string + maxLength: 1000 + minLength: 0 + IndexArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$ + IndexName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + PricingPlan: + $ref: '#/components/schemas/PricingPlan' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + UpdateTime: + $ref: '#/components/schemas/iso8601UTC' + Arn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + x-stackQL-stringOnly: true + x-title: CreatePlaceIndexRequest + type: object + required: [] + CreateRouteCalculatorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CalculatorArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$ + CalculatorName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + CreateTime: + $ref: '#/components/schemas/iso8601UTC' + DataSource: + type: string + Description: + type: string + maxLength: 1000 + minLength: 0 + PricingPlan: + $ref: '#/components/schemas/PricingPlan' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + UpdateTime: + $ref: '#/components/schemas/iso8601UTC' + Arn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + x-stackQL-stringOnly: true + x-title: CreateRouteCalculatorRequest + type: object + required: [] + CreateTrackerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreateTime: + $ref: '#/components/schemas/iso8601UTC' + Description: + type: string + maxLength: 1000 + minLength: 0 + EventBridgeEnabled: + type: boolean + KmsKeyEnableGeospatialQueries: + type: boolean + KmsKeyId: + type: string + maxLength: 2048 + minLength: 1 + PositionFiltering: + $ref: '#/components/schemas/PositionFiltering' + PricingPlan: + $ref: '#/components/schemas/PricingPlan' + PricingPlanDataSource: + type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + TrackerArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + TrackerName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + UpdateTime: + $ref: '#/components/schemas/iso8601UTC' + Arn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + x-stackQL-stringOnly: true + x-title: CreateTrackerRequest + type: object + required: [] + CreateTrackerConsumerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConsumerArn: + type: string + maxLength: 1600 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + TrackerName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[-._\w]+$ + x-stackQL-stringOnly: true + x-title: CreateTrackerConsumerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: api_keys: name: api_keys id: awscc.location.api_keys x-cfn-schema-name: APIKey - x-type: list - x-identifiers: - - KeyName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyName') as key_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyName') as key_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' - AND region = 'us-east-1' - api_key: - name: api_key - id: awscc.location.api_key - x-cfn-schema-name: APIKey - x-type: get + x-cfn-type-name: AWS::Location::APIKey x-identifiers: - KeyName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__APIKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::APIKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::APIKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::APIKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -678,7 +1573,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -698,13 +1593,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::APIKey' AND data__Identifier = '' AND region = 'us-east-1' - geofence_collections: - name: geofence_collections - id: awscc.location.geofence_collections - x-cfn-schema-name: GeofenceCollection - x-type: list + api_keys_list_only: + name: api_keys_list_only + id: awscc.location.api_keys_list_only + x-cfn-schema-name: APIKey + x-cfn-type-name: AWS::Location::APIKey x-identifiers: - - CollectionName + - KeyName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -712,28 +1613,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CollectionName') as collection_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' + JSON_EXTRACT(Properties, '$.KeyName') as key_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CollectionName') as collection_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' + json_extract_path_text(Properties, 'KeyName') as key_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' AND region = 'us-east-1' - geofence_collection: - name: geofence_collection - id: awscc.location.geofence_collection + geofence_collections: + name: geofence_collections + id: awscc.location.geofence_collections x-cfn-schema-name: GeofenceCollection - x-type: get + x-cfn-type-name: AWS::Location::GeofenceCollection x-identifiers: - CollectionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GeofenceCollection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::GeofenceCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::GeofenceCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::GeofenceCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -752,7 +1701,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -770,13 +1719,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::GeofenceCollection' AND data__Identifier = '' AND region = 'us-east-1' - maps: - name: maps - id: awscc.location.maps - x-cfn-schema-name: Map - x-type: list + geofence_collections_list_only: + name: geofence_collections_list_only + id: awscc.location.geofence_collections_list_only + x-cfn-schema-name: GeofenceCollection + x-cfn-type-name: AWS::Location::GeofenceCollection x-identifiers: - - MapName + - CollectionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -784,28 +1739,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MapName') as map_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' + JSON_EXTRACT(Properties, '$.CollectionName') as collection_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'MapName') as map_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' + json_extract_path_text(Properties, 'CollectionName') as collection_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' AND region = 'us-east-1' - map: - name: map - id: awscc.location.map + maps: + name: maps + id: awscc.location.maps x-cfn-schema-name: Map - x-type: get + x-cfn-type-name: AWS::Location::Map x-identifiers: - MapName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Map&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::Map" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::Map" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::Map" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/maps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/maps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/maps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -823,7 +1826,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -840,13 +1843,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::Map' AND data__Identifier = '' AND region = 'us-east-1' - place_indices: - name: place_indices - id: awscc.location.place_indices - x-cfn-schema-name: PlaceIndex - x-type: list + maps_list_only: + name: maps_list_only + id: awscc.location.maps_list_only + x-cfn-schema-name: Map + x-cfn-type-name: AWS::Location::Map x-identifiers: - - IndexName + - MapName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -854,28 +1863,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IndexName') as index_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' + JSON_EXTRACT(Properties, '$.MapName') as map_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IndexName') as index_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' + json_extract_path_text(Properties, 'MapName') as map_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' AND region = 'us-east-1' - place_index: - name: place_index - id: awscc.location.place_index + place_indices: + name: place_indices + id: awscc.location.place_indices x-cfn-schema-name: PlaceIndex - x-type: get + x-cfn-type-name: AWS::Location::PlaceIndex x-identifiers: - IndexName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PlaceIndex&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::PlaceIndex" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::PlaceIndex" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::PlaceIndex" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/place_indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/place_indices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/place_indices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -894,7 +1951,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -912,13 +1969,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::PlaceIndex' AND data__Identifier = '' AND region = 'us-east-1' - route_calculators: - name: route_calculators - id: awscc.location.route_calculators - x-cfn-schema-name: RouteCalculator - x-type: list + place_indices_list_only: + name: place_indices_list_only + id: awscc.location.place_indices_list_only + x-cfn-schema-name: PlaceIndex + x-cfn-type-name: AWS::Location::PlaceIndex x-identifiers: - - CalculatorName + - IndexName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -926,28 +1989,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CalculatorName') as calculator_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' + JSON_EXTRACT(Properties, '$.IndexName') as index_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CalculatorName') as calculator_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' + json_extract_path_text(Properties, 'IndexName') as index_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' AND region = 'us-east-1' - route_calculator: - name: route_calculator - id: awscc.location.route_calculator + route_calculators: + name: route_calculators + id: awscc.location.route_calculators x-cfn-schema-name: RouteCalculator - x-type: get + x-cfn-type-name: AWS::Location::RouteCalculator x-identifiers: - CalculatorName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RouteCalculator&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::RouteCalculator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::RouteCalculator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::RouteCalculator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_calculators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_calculators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/route_calculators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -965,7 +2076,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -982,13 +2093,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::RouteCalculator' AND data__Identifier = '' AND region = 'us-east-1' - trackers: - name: trackers - id: awscc.location.trackers - x-cfn-schema-name: Tracker - x-type: list + route_calculators_list_only: + name: route_calculators_list_only + id: awscc.location.route_calculators_list_only + x-cfn-schema-name: RouteCalculator + x-cfn-type-name: AWS::Location::RouteCalculator x-identifiers: - - TrackerName + - CalculatorName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -996,28 +2113,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' + JSON_EXTRACT(Properties, '$.CalculatorName') as calculator_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrackerName') as tracker_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' + json_extract_path_text(Properties, 'CalculatorName') as calculator_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' AND region = 'us-east-1' - tracker: - name: tracker - id: awscc.location.tracker + trackers: + name: trackers + id: awscc.location.trackers x-cfn-schema-name: Tracker - x-type: get + x-cfn-type-name: AWS::Location::Tracker x-identifiers: - TrackerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Tracker&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::Tracker" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::Tracker" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::Tracker" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trackers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trackers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/trackers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1039,7 +2204,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1060,14 +2225,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::Tracker' AND data__Identifier = '' AND region = 'us-east-1' - tracker_consumers: - name: tracker_consumers - id: awscc.location.tracker_consumers - x-cfn-schema-name: TrackerConsumer - x-type: list + trackers_list_only: + name: trackers_list_only + id: awscc.location.trackers_list_only + x-cfn-schema-name: Tracker + x-cfn-type-name: AWS::Location::Tracker x-identifiers: - TrackerName - - ConsumerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1075,31 +2245,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name, - JSON_EXTRACT(Properties, '$.ConsumerArn') as consumer_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' + JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrackerName') as tracker_name, - json_extract_path_text(Properties, 'ConsumerArn') as consumer_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' + json_extract_path_text(Properties, 'TrackerName') as tracker_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' AND region = 'us-east-1' - tracker_consumer: - name: tracker_consumer - id: awscc.location.tracker_consumer + tracker_consumers: + name: tracker_consumers + id: awscc.location.tracker_consumers x-cfn-schema-name: TrackerConsumer - x-type: get + x-cfn-type-name: AWS::Location::TrackerConsumer x-identifiers: - TrackerName - ConsumerArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrackerConsumer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::TrackerConsumer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Location::TrackerConsumer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tracker_consumers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tracker_consumers/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1110,7 +2313,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1120,3 +2323,484 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Location::TrackerConsumer' AND data__Identifier = '|' AND region = 'us-east-1' + tracker_consumers_list_only: + name: tracker_consumers_list_only + id: awscc.location.tracker_consumers_list_only + x-cfn-schema-name: TrackerConsumer + x-cfn-type-name: AWS::Location::TrackerConsumer + x-identifiers: + - TrackerName + - ConsumerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name, + JSON_EXTRACT(Properties, '$.ConsumerArn') as consumer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrackerName') as tracker_name, + json_extract_path_text(Properties, 'ConsumerArn') as consumer_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__APIKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAPIKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAPIKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GeofenceCollection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGeofenceCollection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGeofenceCollectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Map&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMap + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMapRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PlaceIndex&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlaceIndex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlaceIndexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RouteCalculator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRouteCalculator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteCalculatorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Tracker&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTracker + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrackerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrackerConsumer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrackerConsumer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrackerConsumerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/logs.yaml b/providers/src/awscc/v00.00.00000/services/logs.yaml index 089672e1..9cc44fad 100644 --- a/providers/src/awscc/v00.00.00000/services/logs.yaml +++ b/providers/src/awscc/v00.00.00000/services/logs.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Logs - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AccountPolicy: type: object @@ -36,6 +416,9 @@ components: enum: - DATA_PROTECTION_POLICY - SUBSCRIPTION_FILTER_POLICY + - FIELD_INDEX_POLICY + - TRANSFORMER_POLICY + - METRIC_EXTRACTION_POLICY Scope: description: Scope for policy application type: string @@ -49,7 +432,9 @@ components: - PolicyType - PolicyDocument x-stackql-resource-name: account_policy - x-stackql-primaryIdentifier: + description: The AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy. + x-type-name: AWS::Logs::AccountPolicy + x-stackql-primary-identifier: - AccountId - PolicyType - PolicyName @@ -58,9 +443,20 @@ components: - PolicyType x-read-only-properties: - AccountId + x-required-properties: + - PolicyName + - PolicyType + - PolicyDocument + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - logs:PutAccountPolicy + - logs:PutIndexPolicy - logs:PutDataProtectionPolicy - logs:DescribeAccountPolicies - logs:CreateLogDelivery @@ -68,53 +464,72 @@ components: - firehose:TagDeliveryStream - logs:PutSubscriptionFilter - logs:DeleteSubscriptionFilter + - logs:PutTransformer + - logs:PutMetricExtractionPolicy - iam:PassRole read: - logs:DescribeAccountPolicies + - logs:GetTransformer + - logs:GetMetricExtractionPolicy update: - logs:PutAccountPolicy + - logs:PutIndexPolicy - logs:PutDataProtectionPolicy - logs:DescribeAccountPolicies - logs:DeleteAccountPolicy + - logs:DeleteIndexPolicy - logs:DeleteDataProtectionPolicy - logs:CreateLogDelivery - logs:PutSubscriptionFilter - logs:DeleteSubscriptionFilter + - logs:PutTransformer + - logs:DeleteTransformer + - logs:PutMetricExtractionPolicy + - logs:DeleteMetricExtractionPolicy - s3:REST.PUT.OBJECT - firehose:TagDeliveryStream - iam:PassRole delete: - logs:DeleteAccountPolicy + - logs:DeleteIndexPolicy - logs:DeleteDataProtectionPolicy - logs:DescribeAccountPolicies - logs:DeleteSubscriptionFilter + - logs:DeleteTransformer + - logs:DeleteMetricExtractionPolicy - iam:PassRole list: - logs:DescribeAccountPolicies + - logs:GetTransformer + - logs:GetMetricExtractionPolicy Tag: - description: A key-value pair to associate with a resource. + description: The value of this key-value pair. type: object additionalProperties: false properties: Key: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @.' + description: '' minLength: 1 maxLength: 128 Value: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @.' + description: The value of this key-value pair. minLength: 0 maxLength: 256 required: - Key - Value Arn: - description: The Amazon Resource Name (ARN) that uniquely identifies this delivery source. type: string - minLength: 16 + minLength: 20 maxLength: 2048 - pattern: ^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + pattern: '[\w#+=/:,.@-]*\*?' + FieldHeader: + description: A single record field to be delivered to the destination. + type: string + minLength: 1 + maxLength: 50 Delivery: type: object properties: @@ -149,11 +564,36 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/Tag' + RecordFields: + description: The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list. + type: array + items: + $ref: '#/components/schemas/FieldHeader' + FieldDelimiter: + description: The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format. + type: string + minLength: 1 + maxLength: 5 + S3SuffixPath: + description: This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source. + type: string + minLength: 0 + maxLength: 256 + S3EnableHiveCompatiblePath: + description: This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive. + type: boolean required: - DeliverySourceName - DeliveryDestinationArn x-stackql-resource-name: delivery - x-stackql-primaryIdentifier: + description: |- + This structure contains information about one delivery in your account. + + A delivery is a connection between a logical delivery source and a logical delivery destination. + + For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html). + x-type-name: AWS::Logs::Delivery + x-stackql-primary-identifier: - DeliveryId x-create-only-properties: - DeliverySourceName @@ -162,6 +602,19 @@ components: - DeliveryId - Arn - DeliveryDestinationType + x-required-properties: + - DeliverySourceName + - DeliveryDestinationArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - logs:TagResource + - logs:UntagResource + - logs:ListTagsForResource x-required-permissions: create: - logs:CreateDelivery @@ -179,6 +632,7 @@ components: - logs:ListTagsForResource - logs:TagResource - logs:UntagResource + - logs:UpdateDeliveryConfiguration delete: - logs:DeleteDelivery - logs:ListTagsForResource @@ -195,13 +649,8 @@ components: minLength: 1 maxLength: 60 DeliveryDestinationPolicy: - type: string + type: object description: The contents of the policy attached to the delivery destination - minLength: 1 - maxLength: 51200 - required: - - DeliveryDestinationName - - DeliveryDestinationPolicy additionalProperties: false DeliveryDestination: type: object @@ -216,7 +665,7 @@ components: description: The Amazon Resource Name (ARN) that uniquely identifies this delivery destination. $ref: '#/components/schemas/Arn' DestinationResourceArn: - description: The ARN of the AWS resource that will receive the logs. + description: The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose. $ref: '#/components/schemas/Arn' Tags: description: The tags that have been assigned to this delivery destination. @@ -239,19 +688,42 @@ components: Length Constraints: Maximum length of 51200 type: object - items: - $ref: '#/components/schemas/DestinationPolicy' + $ref: '#/components/schemas/DestinationPolicy' + OutputFormat: + description: The format of the logs that are sent to this delivery destination. + type: string + minLength: 1 + maxLength: 12 + pattern: ^[0-9A-Za-z]+$ required: - Name x-stackql-resource-name: delivery_destination - x-stackql-primaryIdentifier: + description: |- + This structure contains information about one delivery destination in your account. + + A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations. + x-type-name: AWS::Logs::DeliveryDestination + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + - OutputFormat - DestinationResourceArn x-read-only-properties: - Arn - DeliveryDestinationType + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - logs:TagResource + - logs:UntagResource + - logs:ListTagsForResource x-required-permissions: create: - logs:PutDeliveryDestination @@ -324,14 +796,33 @@ components: required: - Name x-stackql-resource-name: delivery_source - x-stackql-primaryIdentifier: + description: |2- + A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. + + Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html). + x-type-name: AWS::Logs::DeliverySource + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - ResourceArn x-read-only-properties: - Service - ResourceArns - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - logs:TagResource + - logs:UntagResource + - logs:ListTagsForResource x-required-permissions: create: - logs:PutDeliverySource @@ -360,6 +851,13 @@ components: properties: Arn: type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' DestinationName: description: The name of the destination resource type: string @@ -383,29 +881,175 @@ components: - TargetArn - RoleArn x-stackql-resource-name: destination - x-stackql-primaryIdentifier: + description: The AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events. + x-type-name: AWS::Logs::Destination + x-stackql-primary-identifier: - DestinationName x-create-only-properties: - DestinationName x-read-only-properties: - Arn + x-required-properties: + - DestinationName + - TargetArn + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - logs:TagResource + - logs:UntagResource + - logs:ListTagsForResource x-required-permissions: create: - logs:PutDestination - logs:PutDestinationPolicy - logs:DescribeDestinations + - logs:TagResource - iam:PassRole read: - logs:DescribeDestinations + - logs:ListTagsForResource update: - logs:PutDestination - logs:PutDestinationPolicy - logs:DescribeDestinations + - logs:TagResource + - logs:UntagResource + - logs:ListTagsForResource - iam:PassRole delete: - logs:DeleteDestination list: - logs:DescribeDestinations + - logs:ListTagsForResource + OpenSearchResourceConfig: + type: object + properties: + KmsKeyArn: + $ref: '#/components/schemas/Arn' + DataSourceRoleArn: + $ref: '#/components/schemas/Arn' + DashboardViewerPrincipals: + type: array + items: + $ref: '#/components/schemas/Arn' + ApplicationARN: + $ref: '#/components/schemas/Arn' + RetentionDays: + type: integer + minimum: 1 + maximum: 3650 + required: + - DataSourceRoleArn + - DashboardViewerPrincipals + additionalProperties: false + Integration: + type: object + properties: + IntegrationName: + description: User provided identifier for integration, unique to the user account. + type: string + pattern: '[\.\-_/#A-Za-z0-9]+' + minLength: 1 + maxLength: 50 + IntegrationType: + description: The type of the Integration. + type: string + enum: + - OPENSEARCH + ResourceConfig: + description: OpenSearchResourceConfig for the given Integration + type: object + properties: + OpenSearchResourceConfig: + $ref: '#/components/schemas/OpenSearchResourceConfig' + additionalProperties: false + IntegrationStatus: + description: Status of creation for the Integration and its resources + type: string + enum: + - PROVISIONING + - ACTIVE + - FAILED + required: + - IntegrationName + - IntegrationType + - ResourceConfig + x-stackql-resource-name: integration + description: Resource Schema for Logs Integration Resource + x-type-name: AWS::Logs::Integration + x-stackql-primary-identifier: + - IntegrationName + x-create-only-properties: + - IntegrationName + - IntegrationType + - ResourceConfig + x-write-only-properties: + - ResourceConfig + x-read-only-properties: + - IntegrationStatus + x-required-properties: + - IntegrationName + - IntegrationType + - ResourceConfig + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - logs:PutIntegration + - logs:GetIntegration + - aoss:CreateCollection + - aoss:CreateSecurityPolicy + - aoss:CreateAccessPolicy + - aoss:CreateLifeCyclePolicy + - aoss:BatchGetCollection + - aoss:DeleteCollection + - aoss:DeleteSecurityPolicy + - aoss:DeleteAccessPolicy + - aoss:DeleteLifeCyclePolicy + - aoss:GetAccessPolicy + - aoss:GetSecurityPolicy + - aoss:BatchGetLifecyclePolicy + - aoss:TagResource + - aoss:APIAccessAll + - opensearch:AddDirectQueryDataSource + - opensearch:DeleteDirectQueryDataSource + - opensearch:GetDirectQueryDataSource + - opensearch:CreateApplication + - opensearch:GetApplication + - opensearch:UpdateApplication + - opensearch:DeleteApplication + - opensearch:ApplicationAccessAll + - opensearch:DashboardsAccessAll + - opensearch:StartDirectQuery + - opensearch:GetDirectQuery + - iam:PassRole + - iam:CreateServiceLinkedRole + - iam:AttachRolePolicy + - iam:AttachUserPolicy + - es:AddDirectQueryDataSource + - es:CreateApplication + - es:UpdateApplication + - es:GetApplication + - es:DeleteApplication + - es:DeleteDirectQueryDataSource + - es:GetDirectQueryDataSource + - es:AddTags + - es:ListApplications + read: + - logs:GetIntegration + delete: + - logs:DeleteIntegration + list: + - logs:ListIntegrations LogAnomalyDetector: type: object properties: @@ -458,13 +1102,20 @@ components: type: string required: [] x-stackql-resource-name: log_anomaly_detector - x-stackql-primaryIdentifier: + description: The AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector. + x-type-name: AWS::Logs::LogAnomalyDetector + x-stackql-primary-identifier: - AnomalyDetectorArn + x-write-only-properties: + - AccountId x-read-only-properties: - AnomalyDetectorArn - CreationTimeStamp - LastModifiedTimeStamp - AnomalyDetectorStatus + x-required-properties: [] + x-tagging: + taggable: false x-required-permissions: create: - logs:CreateLogAnomalyDetector @@ -484,75 +1135,79 @@ components: LogStream: type: object properties: - LogGroupName: + LogStreamName: + description: The name of the log stream. The name must be unique wihtin the log group. type: string + LogGroupName: description: The name of the log group where the log stream is created. - LogStreamName: type: string - description: The name of the log stream. The name must be unique wihtin the log group. required: - LogGroupName x-stackql-resource-name: log_stream - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Logs::LogStream + x-type-name: AWS::Logs::LogStream + x-stackql-primary-identifier: - LogGroupName - LogStreamName x-create-only-properties: - LogGroupName - LogStreamName + x-required-properties: + - LogGroupName + x-tagging: + taggable: false x-required-permissions: + read: + - logs:DescribeLogStreams create: - logs:CreateLogStream - read: - logs:DescribeLogStreams - delete: - - logs:DeleteLogStream list: - logs:DescribeLogStreams - Dimension: - description: the key-value pairs that further define a metric. - type: object - additionalProperties: false - properties: - Key: - type: string - description: The key of the dimension. Maximum length of 255. - minLength: 1 - maxLength: 255 - Value: - type: string - description: The value of the dimension. Maximum length of 255. - minLength: 1 - maxLength: 255 - required: - - Key - - Value + delete: + - logs:DeleteLogStream MetricTransformation: + description: '``MetricTransformation`` is a property of the ``AWS::Logs::MetricFilter`` resource that describes how to transform log streams into a CloudWatch metric.' + additionalProperties: false type: object properties: DefaultValue: - description: The value to emit when a filter pattern does not match a log event. This value can be null. + description: (Optional) The value to emit when a filter pattern does not match a log event. This value can be null. type: number MetricName: - description: The name of the CloudWatch metric. Metric name must be in ASCII format. - type: string minLength: 1 - maxLength: 255 pattern: ^((?![:*$])[\x00-\x7F]){1,255} - MetricNamespace: - x-$comment: Namespaces can be up to 256 characters long; valid characters include 0-9A-Za-z.-_/# - description: The namespace of the CloudWatch metric. + description: The name of the CloudWatch metric. type: string - minLength: 1 - maxLength: 256 - pattern: ^[0-9a-zA-Z\.\-_\/#]{1,256} + maxLength: 255 MetricValue: - description: The value to publish to the CloudWatch metric when a filter pattern matches a log event. - type: string - pattern: .{1,100} minLength: 1 + pattern: .{1,100} + description: The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``. + type: string maxLength: 100 + MetricNamespace: + minLength: 1 + pattern: ^[0-9a-zA-Z\.\-_\/#]{1,256} + description: A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). + x-$comment: Namespaces can be up to 256 characters long; valid characters include 0-9A-Za-z.-_/# + type: string + maxLength: 256 + Dimensions: + minItems: 1 + maxItems: 3 + uniqueItems: true + description: |- + The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. + Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. + CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. + You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Dimension' Unit: - description: The unit to assign to the metric. If you omit this, the unit is set as None. + description: The unit to assign to the metric. If you omit this, the unit is set as ``None``. type: string enum: - Seconds @@ -582,71 +1237,103 @@ components: - Terabits/Second - Count/Second - None - Dimensions: - description: Dimensions are the key-value pairs that further define a metric - type: array - uniqueItems: true - x-insertionOrder: false - minItems: 1 - maxItems: 3 - items: - $ref: '#/components/schemas/Dimension' required: - MetricName - MetricNamespace - MetricValue + Dimension: + description: |- + Specifies the CW metric dimensions to publish with this metric. + Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric. + For more information about publishing dimensions with metrics created by metric filters, see [Publishing dimensions with metrics from values in JSON or space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#logs-metric-filters-dimensions). + Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. + To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time. + You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). additionalProperties: false - MetricFilter: type: object properties: - FilterName: - description: A name for the metric filter. - type: string + Value: minLength: 1 - maxLength: 512 - pattern: ^[^:*]{1,512} - FilterPattern: - description: Pattern that Logs follows to interpret each entry in a log. - type: string - maxLength: 1024 - LogGroupName: - description: Existing log group that you want to associate with this filter. + description: The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events. type: string + maxLength: 255 + Key: minLength: 1 - maxLength: 512 - pattern: ^[.\-_/#A-Za-z0-9]{1,512} - MetricTransformations: - description: A collection of information that defines how metric data gets emitted. - type: array - minItems: 1 - maxItems: 1 + description: |- + The name for the CW metric dimension that the metric filter creates. + Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). + type: string + maxLength: 255 + required: + - Key + - Value + MetricFilter: + type: object + properties: + MetricTransformations: + minItems: 1 + maxItems: 1 + description: The metric transformations. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/MetricTransformation' + FilterPattern: + description: A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). + type: string + maxLength: 1024 + LogGroupName: + minLength: 1 + pattern: ^[.\-_/#A-Za-z0-9]{1,512} + description: The name of an existing log group that you want to associate with this metric filter. + type: string + maxLength: 512 + ApplyOnTransformedLogs: + description: |- + This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html). + If this value is ``true``, the metric filter is applied on the transformed version of the log events instead of the original ingested log events. + type: boolean + FilterName: + minLength: 1 + pattern: ^[^:*]{1,512} + description: The name of the metric filter. + type: string + maxLength: 512 required: - FilterPattern - LogGroupName - MetricTransformations x-stackql-resource-name: metric_filter - x-stackql-primaryIdentifier: + description: |- + The ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group. + The maximum number of metric filters that can be associated with a log group is 100. + x-type-name: AWS::Logs::MetricFilter + x-stackql-primary-identifier: - LogGroupName - FilterName x-create-only-properties: - FilterName - LogGroupName + x-required-properties: + - FilterPattern + - LogGroupName + - MetricTransformations + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false x-required-permissions: + read: + - logs:DescribeMetricFilters create: - logs:PutMetricFilter - logs:DescribeMetricFilters - read: - - logs:DescribeMetricFilters update: - logs:PutMetricFilter - logs:DescribeMetricFilters - delete: - - logs:DeleteMetricFilter list: - logs:DescribeMetricFilters + delete: + - logs:DeleteMetricFilter QueryDefinition: type: object properties: @@ -672,14 +1359,29 @@ components: type: string minLength: 0 maxLength: 256 + QueryLanguage: + description: Query language of the query string. Possible values are CWLI, SQL, PPL, with CWLI being the default. + type: string + enum: + - CWLI + - SQL + - PPL + default: CWLI required: - Name - QueryString x-stackql-resource-name: query_definition - x-stackql-primaryIdentifier: + description: The resource schema for AWSLogs QueryDefinition + x-type-name: AWS::Logs::QueryDefinition + x-stackql-primary-identifier: - QueryDefinitionId x-read-only-properties: - QueryDefinitionId + x-required-properties: + - Name + - QueryString + x-tagging: + taggable: false x-required-permissions: create: - logs:PutQueryDefinition @@ -710,10 +1412,17 @@ components: - PolicyName - PolicyDocument x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: + description: The resource schema for AWSLogs ResourcePolicy + x-type-name: AWS::Logs::ResourcePolicy + x-stackql-primary-identifier: - PolicyName x-create-only-properties: - PolicyName + x-required-properties: + - PolicyName + - PolicyDocument + x-tagging: + taggable: false x-required-permissions: create: - logs:PutResourcePolicy @@ -732,37 +1441,61 @@ components: type: object properties: FilterName: - description: The name of the filter generated by resource. + description: The name of the subscription filter. type: string DestinationArn: description: The Amazon Resource Name (ARN) of the destination. type: string FilterPattern: - description: The filtering expressions that restrict what gets delivered to the destination AWS resource. + description: The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). type: string LogGroupName: - description: Existing log group that you want to associate with this filter. + description: The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events. type: string RoleArn: - description: The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. + description: The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. type: string Distribution: - description: The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream. + description: The method used to distribute log data to the destination, which can be either random or grouped by log stream. type: string enum: - Random - ByLogStream + ApplyOnTransformedLogs: + description: |- + This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html). + If this value is ``true``, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events. + type: boolean required: - DestinationArn - FilterPattern - LogGroupName x-stackql-resource-name: subscription_filter - x-stackql-primaryIdentifier: + description: |- + The ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are: + + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery. + + A logical destination that belongs to a different account, for cross-account delivery. + + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. + + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery. + + There can be as many as two subscription filters associated with a log group. + x-type-name: AWS::Logs::SubscriptionFilter + x-stackql-primary-identifier: - FilterName - LogGroupName x-create-only-properties: - FilterName - LogGroupName + x-required-properties: + - DestinationArn + - FilterPattern + - LogGroupName + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - iam:PassRole @@ -778,51 +1511,1169 @@ components: - logs:DeleteSubscriptionFilter list: - logs:DescribeSubscriptionFilters + Processor: + description: Individual processor configuration + type: object + properties: + ParseCloudfront: + $ref: '#/components/schemas/ParseCloudfront' + ParseVPC: + $ref: '#/components/schemas/ParseVPC' + ParseWAF: + $ref: '#/components/schemas/ParseWAF' + ParseJSON: + type: object + properties: + Source: + type: string + Destination: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + additionalProperties: false + ParseRoute53: + $ref: '#/components/schemas/ParseRoute53' + ParsePostgres: + $ref: '#/components/schemas/ParsePostgres' + ParseToOCSF: + $ref: '#/components/schemas/ParseToOCSF' + ParseKeyValue: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Destination: + $ref: '#/components/schemas/NonEmptyString' + FieldDelimiter: + type: string + KeyValueDelimiter: + type: string + KeyPrefix: + $ref: '#/components/schemas/NonEmptyString' + NonMatchValue: + $ref: '#/components/schemas/NonEmptyString' + OverwriteIfExists: + type: boolean + additionalProperties: false + CopyValue: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/CopyValueEntry' + minItems: 1 + maxItems: 5 + x-insertionOrder: false + required: + - Entries + additionalProperties: false + Csv: + type: object + properties: + QuoteCharacter: + type: string + maxLength: 1 + Delimiter: + type: string + maxLength: 2 + Source: + type: string + Columns: + type: array + items: + $ref: '#/components/schemas/Column' + minItems: 1 + maxItems: 100 + x-insertionOrder: false + additionalProperties: false + DateTimeConverter: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Target: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + TargetFormat: + type: string + MatchPatterns: + type: array + items: + $ref: '#/components/schemas/MatchPattern' + minItems: 1 + maxItems: 5 + uniqueItems: true + x-insertionOrder: false + SourceTimezone: + type: string + TargetTimezone: + type: string + Locale: + type: string + required: + - Source + - Target + - MatchPatterns + additionalProperties: false + DeleteKeys: + type: object + properties: + WithKeys: + type: array + items: + $ref: '#/components/schemas/WithKey' + minItems: 1 + maxItems: 5 + uniqueItems: true + x-insertionOrder: false + required: + - WithKeys + additionalProperties: false + Grok: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Match: + type: string + maxLength: 512 + required: + - Match + additionalProperties: false + ListToMap: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Key: + $ref: '#/components/schemas/NonEmptyString' + ValueKey: + $ref: '#/components/schemas/NonEmptyString' + Target: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + Flatten: + type: boolean + FlattenedElement: + type: string + enum: + - first + - last + required: + - Source + - Key + additionalProperties: false + AddKeys: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/AddKeyEntry' + minItems: 1 + maxItems: 5 + uniqueItems: true + x-insertionOrder: false + required: + - Entries + additionalProperties: false + MoveKeys: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/MoveKeyEntry' + minItems: 1 + maxItems: 5 + x-insertionOrder: false + required: + - Entries + additionalProperties: false + RenameKeys: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/RenameKeyEntry' + minItems: 1 + maxItems: 5 + x-insertionOrder: false + required: + - Entries + additionalProperties: false + LowerCaseString: + type: object + properties: + WithKeys: + type: array + items: + $ref: '#/components/schemas/WithKey' + minItems: 1 + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + required: + - WithKeys + additionalProperties: false + SplitString: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/SplitStringEntry' + minItems: 1 + maxItems: 10 + x-insertionOrder: false + required: + - Entries + additionalProperties: false + SubstituteString: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/SubstituteStringEntry' + minItems: 1 + maxItems: 10 + x-insertionOrder: false + required: + - Entries + additionalProperties: false + TrimString: + type: object + properties: + WithKeys: + type: array + items: + $ref: '#/components/schemas/WithKey' + minItems: 1 + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + required: + - WithKeys + additionalProperties: false + UpperCaseString: + type: object + properties: + WithKeys: + type: array + items: + $ref: '#/components/schemas/WithKey' + minItems: 1 + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + required: + - WithKeys + additionalProperties: false + TypeConverter: + type: object + properties: + Entries: + type: array + items: + $ref: '#/components/schemas/TypeConverterEntry' + minItems: 1 + maxItems: 5 + x-insertionOrder: false + required: + - Entries + additionalProperties: false + additionalProperties: false + minProperties: 1 + maxProperties: 1 + ParseCloudfront: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + additionalProperties: false + ParseVPC: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + additionalProperties: false + ParseWAF: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + additionalProperties: false + ParseRoute53: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + additionalProperties: false + ParsePostgres: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + additionalProperties: false + ParseToOCSF: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + EventSource: + $ref: '#/components/schemas/EventSource' + OcsfVersion: + $ref: '#/components/schemas/OcsfVersion' + additionalProperties: false + required: + - EventSource + - OcsfVersion + AddKeyEntry: + type: object + properties: + Key: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + Value: + type: string + minLength: 1 + maxLength: 256 + OverwriteIfExists: + type: boolean + additionalProperties: false + required: + - Key + - Value + CopyValueEntry: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Target: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + OverwriteIfExists: + type: boolean + required: + - Source + - Target + additionalProperties: false + Column: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + WithKey: + type: string + minLength: 1 + maxLength: 128 + MatchPattern: + $ref: '#/components/schemas/NonEmptyString' + MoveKeyEntry: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Target: + $ref: '#/components/schemas/NonEmptyString' + OverwriteIfExists: + type: boolean + required: + - Source + - Target + additionalProperties: false + RenameKeyEntry: + type: object + properties: + Key: + $ref: '#/components/schemas/NonEmptyString' + RenameTo: + $ref: '#/components/schemas/NonEmptyString' + OverwriteIfExists: + type: boolean + required: + - Key + - RenameTo + additionalProperties: false + SplitStringEntry: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + Delimiter: + type: string + maxLength: 128 + required: + - Source + - Delimiter + additionalProperties: false + SubstituteStringEntry: + type: object + properties: + Source: + $ref: '#/components/schemas/NonEmptyString' + From: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + To: + $ref: '#/components/schemas/NonEmptyAndMaxLengthString' + required: + - Source + - From + - To + additionalProperties: false + TypeConverterEntry: + type: object + properties: + Key: + $ref: '#/components/schemas/NonEmptyString' + Type: + type: string + enum: + - boolean + - integer + - double + - string + required: + - Key + - Type + additionalProperties: false + NonEmptyAndMaxLengthString: + type: string + maxLength: 128 + pattern: ^.*[a-zA-Z0-9]+.*$ + NonEmptyString: + type: string + pattern: ^.*[a-zA-Z0-9]+.*$ + MaxLengthString: + type: string + maxLength: 128 + EventSource: + type: string + enum: + - CloudTrail + - Route53Resolver + - VPCFlow + - EKSAudit + - AWSWAF + OcsfVersion: + type: string + enum: + - V1.1 + Transformer: + type: object + properties: + LogGroupIdentifier: + description: Existing log group that you want to associate with this transformer. + type: string + minLength: 1 + maxLength: 2048 + pattern: '[\w#+=/:,.@-]*' + TransformerConfig: + description: List of processors in a transformer + type: array + items: + $ref: '#/components/schemas/Processor' + minItems: 1 + maxItems: 20 + x-insertionOrder: false + required: + - LogGroupIdentifier + - TransformerConfig + x-stackql-resource-name: transformer + description: Specifies a transformer on the log group to transform logs into consistent structured and information rich format. + x-type-name: AWS::Logs::Transformer + x-stackql-primary-identifier: + - LogGroupIdentifier + x-create-only-properties: + - LogGroupIdentifier + x-required-properties: + - LogGroupIdentifier + - TransformerConfig + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - logs:PutTransformer + - logs:GetTransformer + read: + - logs:GetTransformer + update: + - logs:GetTransformer + - logs:PutTransformer + delete: + - logs:DeleteTransformer + list: + - logs:DescribeLogGroups + - logs:GetTransformer + CreateAccountPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + description: User account id + type: string + pattern: ^\d{12}$ + PolicyName: + description: The name of the account policy + type: string + minLength: 1 + maxLength: 256 + pattern: ^[^:*]{1,256}$ + PolicyDocument: + description: |- + The body of the policy document you want to use for this topic. + + You can only add one policy per PolicyType. + + The policy must be in JSON string format. + + Length Constraints: Maximum length of 30720 + type: string + minLength: 1 + maxLength: 30720 + PolicyType: + description: Type of the policy. + type: string + enum: + - DATA_PROTECTION_POLICY + - SUBSCRIPTION_FILTER_POLICY + - FIELD_INDEX_POLICY + - TRANSFORMER_POLICY + - METRIC_EXTRACTION_POLICY + Scope: + description: Scope for policy application + type: string + enum: + - ALL + SelectionCriteria: + description: Log group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes + type: string + x-stackQL-stringOnly: true + x-title: CreateAccountPolicyRequest + type: object + required: [] + CreateDeliveryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeliveryId: + description: The unique ID that identifies this delivery in your account. + type: string + minLength: 1 + maxLength: 64 + pattern: ^[0-9A-Za-z]+$ + Arn: + description: The Amazon Resource Name (ARN) that uniquely identifies this delivery. + $ref: '#/components/schemas/Arn' + DeliverySourceName: + description: The name of the delivery source that is associated with this delivery. + type: string + pattern: '[\w-]*$' + minLength: 1 + maxLength: 60 + DeliveryDestinationArn: + description: The ARN of the delivery destination that is associated with this delivery. + $ref: '#/components/schemas/Arn' + DeliveryDestinationType: + description: Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. + type: string + minLength: 1 + maxLength: 12 + pattern: ^[0-9A-Za-z]+$ + Tags: + description: The tags that have been assigned to this delivery. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + RecordFields: + description: The list of record fields to be delivered to the destination, in order. If the delivery's log source has mandatory fields, they must be included in this list. + type: array + items: + $ref: '#/components/schemas/FieldHeader' + FieldDelimiter: + description: The field delimiter to use between record fields when the final output format of a delivery is in Plain , W3C , or Raw format. + type: string + minLength: 1 + maxLength: 5 + S3SuffixPath: + description: This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source. + type: string + minLength: 0 + maxLength: 256 + S3EnableHiveCompatiblePath: + description: This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateDeliveryRequest + type: object + required: [] + CreateDeliveryDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of this delivery destination. + type: string + pattern: '[\w-]*$' + minLength: 1 + maxLength: 60 + Arn: + description: The Amazon Resource Name (ARN) that uniquely identifies this delivery destination. + $ref: '#/components/schemas/Arn' + DestinationResourceArn: + description: The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose. + $ref: '#/components/schemas/Arn' + Tags: + description: The tags that have been assigned to this delivery destination. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + DeliveryDestinationType: + description: Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. + type: string + minLength: 1 + maxLength: 12 + pattern: ^[0-9A-Za-z]+$ + DeliveryDestinationPolicy: + description: |- + IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. + + The policy must be in JSON string format. + + Length Constraints: Maximum length of 51200 + type: object + $ref: '#/components/schemas/DestinationPolicy' + OutputFormat: + description: The format of the logs that are sent to this delivery destination. + type: string + minLength: 1 + maxLength: 12 + pattern: ^[0-9A-Za-z]+$ + x-stackQL-stringOnly: true + x-title: CreateDeliveryDestinationRequest + type: object + required: [] + CreateDeliverySourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The unique name of the Log source. + type: string + pattern: '[\w-]*$' + minLength: 1 + maxLength: 60 + Arn: + description: The Amazon Resource Name (ARN) that uniquely identifies this delivery source. + $ref: '#/components/schemas/Arn' + ResourceArns: + description: This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Arn' + ResourceArn: + description: The ARN of the resource that will be sending the logs. + $ref: '#/components/schemas/Arn' + Service: + description: The AWS service that is sending logs. + type: string + pattern: '[\w-]*$' + minLength: 1 + maxLength: 255 + LogType: + description: The type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options. + type: string + pattern: '[\w-]*$' + minLength: 1 + maxLength: 255 + Tags: + description: The tags that have been assigned to this delivery source. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDeliverySourceRequest + type: object + required: [] + CreateDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + DestinationName: + description: The name of the destination resource + type: string + minLength: 1 + maxLength: 512 + pattern: ^[^:*]{1,512}$ + DestinationPolicy: + description: An IAM policy document that governs which AWS accounts can create subscription filters against this destination. + type: string + minLength: 1 + RoleArn: + description: The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource + type: string + minLength: 1 + TargetArn: + description: The ARN of the physical target where the log events are delivered (for example, a Kinesis stream) + type: string + minLength: 1 + x-stackQL-stringOnly: true + x-title: CreateDestinationRequest + type: object + required: [] + CreateIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IntegrationName: + description: User provided identifier for integration, unique to the user account. + type: string + pattern: '[\.\-_/#A-Za-z0-9]+' + minLength: 1 + maxLength: 50 + IntegrationType: + description: The type of the Integration. + type: string + enum: + - OPENSEARCH + ResourceConfig: + description: OpenSearchResourceConfig for the given Integration + type: object + properties: + OpenSearchResourceConfig: + $ref: '#/components/schemas/OpenSearchResourceConfig' + additionalProperties: false + IntegrationStatus: + description: Status of creation for the Integration and its resources + type: string + enum: + - PROVISIONING + - ACTIVE + - FAILED + x-stackQL-stringOnly: true + x-title: CreateIntegrationRequest + type: object + required: [] + CreateLogAnomalyDetectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + description: Account ID for owner of detector + type: string + KmsKeyId: + description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. + type: string + maxLength: 256 + DetectorName: + description: Name of detector + type: string + LogGroupArnList: + description: List of Arns for the given log group + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + minLength: 20 + maxLength: 2048 + EvaluationFrequency: + description: How often log group is evaluated + type: string + enum: + - FIVE_MIN + - TEN_MIN + - FIFTEEN_MIN + - THIRTY_MIN + - ONE_HOUR + FilterPattern: + description: '' + type: string + pattern: '' + AnomalyDetectorStatus: + description: Current status of detector. + type: string + AnomalyVisibilityTime: + description: '' + type: number + CreationTimeStamp: + description: When detector was created. + type: number + LastModifiedTimeStamp: + description: When detector was lsat modified. + type: number + AnomalyDetectorArn: + description: ARN of LogAnomalyDetector + type: string + x-stackQL-stringOnly: true + x-title: CreateLogAnomalyDetectorRequest + type: object + required: [] + CreateLogStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LogStreamName: + description: The name of the log stream. The name must be unique wihtin the log group. + type: string + LogGroupName: + description: The name of the log group where the log stream is created. + type: string + x-stackQL-stringOnly: true + x-title: CreateLogStreamRequest + type: object + required: [] + CreateMetricFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MetricTransformations: + minItems: 1 + maxItems: 1 + description: The metric transformations. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/MetricTransformation' + FilterPattern: + description: A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). + type: string + maxLength: 1024 + LogGroupName: + minLength: 1 + pattern: ^[.\-_/#A-Za-z0-9]{1,512} + description: The name of an existing log group that you want to associate with this metric filter. + type: string + maxLength: 512 + ApplyOnTransformedLogs: + description: |- + This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html). + If this value is ``true``, the metric filter is applied on the transformed version of the log events instead of the original ingested log events. + type: boolean + FilterName: + minLength: 1 + pattern: ^[^:*]{1,512} + description: The name of the metric filter. + type: string + maxLength: 512 + x-stackQL-stringOnly: true + x-title: CreateMetricFilterRequest + type: object + required: [] + CreateQueryDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: A name for the saved query definition + type: string + minLength: 1 + maxLength: 255 + QueryString: + description: The query string to use for this definition + type: string + minLength: 1 + maxLength: 10000 + LogGroupNames: + description: Optionally define specific log groups as part of your query definition + type: array + x-insertionOrder: false + items: + description: LogGroup name + $ref: '#/components/schemas/LogGroup' + QueryDefinitionId: + description: Unique identifier of a query definition + type: string + minLength: 0 + maxLength: 256 + QueryLanguage: + description: Query language of the query string. Possible values are CWLI, SQL, PPL, with CWLI being the default. + type: string + enum: + - CWLI + - SQL + - PPL + default: CWLI + x-stackQL-stringOnly: true + x-title: CreateQueryDefinitionRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyName: + description: A name for resource policy + type: string + pattern: ^([^:*\/]+\/?)*[^:*\/]+$ + minLength: 1 + maxLength: 255 + PolicyDocument: + description: The policy document + type: string + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + minLength: 1 + maxLength: 5120 + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateSubscriptionFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FilterName: + description: The name of the subscription filter. + type: string + DestinationArn: + description: The Amazon Resource Name (ARN) of the destination. + type: string + FilterPattern: + description: The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). + type: string + LogGroupName: + description: The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events. + type: string + RoleArn: + description: The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. + type: string + Distribution: + description: The method used to distribute log data to the destination, which can be either random or grouped by log stream. + type: string + enum: + - Random + - ByLogStream + ApplyOnTransformedLogs: + description: |- + This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see [PutTransformer](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html). + If this value is ``true``, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events. + type: boolean + x-stackQL-stringOnly: true + x-title: CreateSubscriptionFilterRequest + type: object + required: [] + CreateTransformerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LogGroupIdentifier: + description: Existing log group that you want to associate with this transformer. + type: string + minLength: 1 + maxLength: 2048 + pattern: '[\w#+=/:,.@-]*' + TransformerConfig: + description: List of processors in a transformer + type: array + items: + $ref: '#/components/schemas/Processor' + minItems: 1 + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateTransformerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: account_policies: name: account_policies id: awscc.logs.account_policies x-cfn-schema-name: AccountPolicy - x-type: list - x-identifiers: - - AccountId - - PolicyType - - PolicyName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id, - JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'PolicyType') as policy_type, - json_extract_path_text(Properties, 'PolicyName') as policy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' - AND region = 'us-east-1' - account_policy: - name: account_policy - id: awscc.logs.account_policy - x-cfn-schema-name: AccountPolicy - x-type: get + x-cfn-type-name: AWS::Logs::AccountPolicy x-identifiers: - AccountId - PolicyType - PolicyName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccountPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::AccountPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::AccountPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::AccountPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/account_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/account_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/account_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -837,7 +2688,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -851,13 +2702,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::AccountPolicy' AND data__Identifier = '||' AND region = 'us-east-1' - deliveries: - name: deliveries - id: awscc.logs.deliveries - x-cfn-schema-name: Delivery - x-type: list + account_policies_list_only: + name: account_policies_list_only + id: awscc.logs.account_policies_list_only + x-cfn-schema-name: AccountPolicy + x-cfn-type-name: AWS::Logs::AccountPolicy x-identifiers: - - DeliveryId + - AccountId + - PolicyType + - PolicyName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -865,28 +2724,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DeliveryId') as delivery_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DeliveryId') as delivery_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'PolicyName') as policy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' AND region = 'us-east-1' - delivery: - name: delivery - id: awscc.logs.delivery + deliveries: + name: deliveries + id: awscc.logs.deliveries x-cfn-schema-name: Delivery - x-type: get + x-cfn-type-name: AWS::Logs::Delivery x-identifiers: - DeliveryId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Delivery&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Delivery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Delivery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Delivery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deliveries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deliveries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deliveries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -896,12 +2807,16 @@ components: JSON_EXTRACT(Properties, '$.DeliverySourceName') as delivery_source_name, JSON_EXTRACT(Properties, '$.DeliveryDestinationArn') as delivery_destination_arn, JSON_EXTRACT(Properties, '$.DeliveryDestinationType') as delivery_destination_type, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.RecordFields') as record_fields, + JSON_EXTRACT(Properties, '$.FieldDelimiter') as field_delimiter, + JSON_EXTRACT(Properties, '$.S3SuffixPath') as s3_suffix_path, + JSON_EXTRACT(Properties, '$.S3EnableHiveCompatiblePath') as s3_enable_hive_compatible_path FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Delivery' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -911,17 +2826,27 @@ components: json_extract_path_text(Properties, 'DeliverySourceName') as delivery_source_name, json_extract_path_text(Properties, 'DeliveryDestinationArn') as delivery_destination_arn, json_extract_path_text(Properties, 'DeliveryDestinationType') as delivery_destination_type, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'RecordFields') as record_fields, + json_extract_path_text(Properties, 'FieldDelimiter') as field_delimiter, + json_extract_path_text(Properties, 'S3SuffixPath') as s3_suffix_path, + json_extract_path_text(Properties, 'S3EnableHiveCompatiblePath') as s3_enable_hive_compatible_path FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Delivery' AND data__Identifier = '' AND region = 'us-east-1' - delivery_destinations: - name: delivery_destinations - id: awscc.logs.delivery_destinations - x-cfn-schema-name: DeliveryDestination - x-type: list + deliveries_list_only: + name: deliveries_list_only + id: awscc.logs.deliveries_list_only + x-cfn-schema-name: Delivery + x-cfn-type-name: AWS::Logs::Delivery x-identifiers: - - Name + - DeliveryId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -929,28 +2854,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' + JSON_EXTRACT(Properties, '$.DeliveryId') as delivery_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' + json_extract_path_text(Properties, 'DeliveryId') as delivery_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' AND region = 'us-east-1' - delivery_destination: - name: delivery_destination - id: awscc.logs.delivery_destination + delivery_destinations: + name: delivery_destinations + id: awscc.logs.delivery_destinations x-cfn-schema-name: DeliveryDestination - x-type: get + x-cfn-type-name: AWS::Logs::DeliveryDestination x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeliveryDestination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::DeliveryDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::DeliveryDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::DeliveryDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -960,12 +2933,13 @@ components: JSON_EXTRACT(Properties, '$.DestinationResourceArn') as destination_resource_arn, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.DeliveryDestinationType') as delivery_destination_type, - JSON_EXTRACT(Properties, '$.DeliveryDestinationPolicy') as delivery_destination_policy + JSON_EXTRACT(Properties, '$.DeliveryDestinationPolicy') as delivery_destination_policy, + JSON_EXTRACT(Properties, '$.OutputFormat') as output_format FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -975,17 +2949,24 @@ components: json_extract_path_text(Properties, 'DestinationResourceArn') as destination_resource_arn, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'DeliveryDestinationType') as delivery_destination_type, - json_extract_path_text(Properties, 'DeliveryDestinationPolicy') as delivery_destination_policy + json_extract_path_text(Properties, 'DeliveryDestinationPolicy') as delivery_destination_policy, + json_extract_path_text(Properties, 'OutputFormat') as output_format FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' AND data__Identifier = '' AND region = 'us-east-1' - delivery_sources: - name: delivery_sources - id: awscc.logs.delivery_sources - x-cfn-schema-name: DeliverySource - x-type: list + delivery_destinations_list_only: + name: delivery_destinations_list_only + id: awscc.logs.delivery_destinations_list_only + x-cfn-schema-name: DeliveryDestination + x-cfn-type-name: AWS::Logs::DeliveryDestination x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -994,7 +2975,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1002,19 +2983,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' AND region = 'us-east-1' - delivery_source: - name: delivery_source - id: awscc.logs.delivery_source + delivery_sources: + name: delivery_sources + id: awscc.logs.delivery_sources x-cfn-schema-name: DeliverySource - x-type: get + x-cfn-type-name: AWS::Logs::DeliverySource x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeliverySource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::DeliverySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::DeliverySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::DeliverySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1030,7 +3059,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1045,13 +3074,137 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliverySource' AND data__Identifier = '' AND region = 'us-east-1' - destinations: - name: destinations - id: awscc.logs.destinations + delivery_sources_list_only: + name: delivery_sources_list_only + id: awscc.logs.delivery_sources_list_only + x-cfn-schema-name: DeliverySource + x-cfn-type-name: AWS::Logs::DeliverySource + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' + AND region = 'us-east-1' + destinations: + name: destinations + id: awscc.logs.destinations + x-cfn-schema-name: Destination + x-cfn-type-name: AWS::Logs::Destination + x-identifiers: + - DestinationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Destination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Destination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Destination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Destination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/destinations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.DestinationName') as destination_name, + JSON_EXTRACT(Properties, '$.DestinationPolicy') as destination_policy, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.TargetArn') as target_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Destination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DestinationName') as destination_name, + json_extract_path_text(Properties, 'DestinationPolicy') as destination_policy, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'TargetArn') as target_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Destination' + AND data__Identifier = '' + AND region = 'us-east-1' + destinations_list_only: + name: destinations_list_only + id: awscc.logs.destinations_list_only x-cfn-schema-name: Destination - x-type: list + x-cfn-type-name: AWS::Logs::Destination x-identifiers: - DestinationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1070,50 +3223,89 @@ components: json_extract_path_text(Properties, 'DestinationName') as destination_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Destination' AND region = 'us-east-1' - destination: - name: destination - id: awscc.logs.destination - x-cfn-schema-name: Destination - x-type: get + integrations: + name: integrations + id: awscc.logs.integrations + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::Logs::Integration x-identifiers: - - DestinationName + - IntegrationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.DestinationName') as destination_name, - JSON_EXTRACT(Properties, '$.DestinationPolicy') as destination_policy, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.TargetArn') as target_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Destination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IntegrationName') as integration_name, + JSON_EXTRACT(Properties, '$.IntegrationType') as integration_type, + JSON_EXTRACT(Properties, '$.ResourceConfig') as resource_config, + JSON_EXTRACT(Properties, '$.IntegrationStatus') as integration_status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Integration' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DestinationName') as destination_name, - json_extract_path_text(Properties, 'DestinationPolicy') as destination_policy, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'TargetArn') as target_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Destination' - AND data__Identifier = '' + json_extract_path_text(Properties, 'IntegrationName') as integration_name, + json_extract_path_text(Properties, 'IntegrationType') as integration_type, + json_extract_path_text(Properties, 'ResourceConfig') as resource_config, + json_extract_path_text(Properties, 'IntegrationStatus') as integration_status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Integration' + AND data__Identifier = '' AND region = 'us-east-1' - log_anomaly_detectors: - name: log_anomaly_detectors - id: awscc.logs.log_anomaly_detectors - x-cfn-schema-name: LogAnomalyDetector - x-type: list + integrations_list_only: + name: integrations_list_only + id: awscc.logs.integrations_list_only + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::Logs::Integration x-identifiers: - - AnomalyDetectorArn + - IntegrationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1121,28 +3313,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AnomalyDetectorArn') as anomaly_detector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' + JSON_EXTRACT(Properties, '$.IntegrationName') as integration_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Integration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' + json_extract_path_text(Properties, 'IntegrationName') as integration_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Integration' AND region = 'us-east-1' - log_anomaly_detector: - name: log_anomaly_detector - id: awscc.logs.log_anomaly_detector + log_anomaly_detectors: + name: log_anomaly_detectors + id: awscc.logs.log_anomaly_detectors x-cfn-schema-name: LogAnomalyDetector - x-type: get + x-cfn-type-name: AWS::Logs::LogAnomalyDetector x-identifiers: - AnomalyDetectorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LogAnomalyDetector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::LogAnomalyDetector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::LogAnomalyDetector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::LogAnomalyDetector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1162,7 +3402,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1181,14 +3421,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' AND data__Identifier = '' AND region = 'us-east-1' - log_streams: - name: log_streams - id: awscc.logs.log_streams - x-cfn-schema-name: LogStream - x-type: list + log_anomaly_detectors_list_only: + name: log_anomaly_detectors_list_only + id: awscc.logs.log_anomaly_detectors_list_only + x-cfn-schema-name: LogAnomalyDetector + x-cfn-type-name: AWS::Logs::LogAnomalyDetector x-identifiers: - - LogGroupName - - LogStreamName + - AnomalyDetectorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1196,59 +3441,98 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.LogStreamName') as log_stream_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' + JSON_EXTRACT(Properties, '$.AnomalyDetectorArn') as anomaly_detector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'LogStreamName') as log_stream_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' + json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' AND region = 'us-east-1' - log_stream: - name: log_stream - id: awscc.logs.log_stream + log_streams: + name: log_streams + id: awscc.logs.log_streams x-cfn-schema-name: LogStream - x-type: get + x-cfn-type-name: AWS::Logs::LogStream x-identifiers: - LogGroupName - LogStreamName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LogStream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::LogStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::LogStream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.LogStreamName') as log_stream_name + JSON_EXTRACT(Properties, '$.LogStreamName') as log_stream_name, + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogStream' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'LogStreamName') as log_stream_name + json_extract_path_text(Properties, 'LogStreamName') as log_stream_name, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogStream' AND data__Identifier = '|' AND region = 'us-east-1' - metric_filters: - name: metric_filters - id: awscc.logs.metric_filters - x-cfn-schema-name: MetricFilter - x-type: list + log_streams_list_only: + name: log_streams_list_only + id: awscc.logs.log_streams_list_only + x-cfn-schema-name: LogStream + x-cfn-type-name: AWS::Logs::LogStream x-identifiers: - LogGroupName - - FilterName + - LogStreamName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1257,8 +3541,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.FilterName') as filter_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' + JSON_EXTRACT(Properties, '$.LogStreamName') as log_stream_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1266,52 +3550,109 @@ components: SELECT region, json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'FilterName') as filter_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' + json_extract_path_text(Properties, 'LogStreamName') as log_stream_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' AND region = 'us-east-1' - metric_filter: - name: metric_filter - id: awscc.logs.metric_filter + metric_filters: + name: metric_filters + id: awscc.logs.metric_filters x-cfn-schema-name: MetricFilter - x-type: get + x-cfn-type-name: AWS::Logs::MetricFilter x-identifiers: - LogGroupName - FilterName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MetricFilter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::MetricFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::MetricFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::MetricFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/metric_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/metric_filters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/metric_filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.FilterName') as filter_name, + JSON_EXTRACT(Properties, '$.MetricTransformations') as metric_transformations, JSON_EXTRACT(Properties, '$.FilterPattern') as filter_pattern, JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.MetricTransformations') as metric_transformations + JSON_EXTRACT(Properties, '$.ApplyOnTransformedLogs') as apply_on_transformed_logs, + JSON_EXTRACT(Properties, '$.FilterName') as filter_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::MetricFilter' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'FilterName') as filter_name, + json_extract_path_text(Properties, 'MetricTransformations') as metric_transformations, json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'MetricTransformations') as metric_transformations + json_extract_path_text(Properties, 'ApplyOnTransformedLogs') as apply_on_transformed_logs, + json_extract_path_text(Properties, 'FilterName') as filter_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::MetricFilter' AND data__Identifier = '|' AND region = 'us-east-1' - query_definitions: - name: query_definitions - id: awscc.logs.query_definitions - x-cfn-schema-name: QueryDefinition - x-type: list + metric_filters_list_only: + name: metric_filters_list_only + id: awscc.logs.metric_filters_list_only + x-cfn-schema-name: MetricFilter + x-cfn-type-name: AWS::Logs::MetricFilter x-identifiers: - - QueryDefinitionId + - LogGroupName + - FilterName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1319,28 +3660,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.QueryDefinitionId') as query_definition_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, + JSON_EXTRACT(Properties, '$.FilterName') as filter_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'FilterName') as filter_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' AND region = 'us-east-1' - query_definition: - name: query_definition - id: awscc.logs.query_definition + query_definitions: + name: query_definitions + id: awscc.logs.query_definitions x-cfn-schema-name: QueryDefinition - x-type: get + x-cfn-type-name: AWS::Logs::QueryDefinition x-identifiers: - QueryDefinitionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QueryDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::QueryDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::QueryDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::QueryDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/query_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/query_definitions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/query_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1348,12 +3739,13 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.QueryString') as query_string, JSON_EXTRACT(Properties, '$.LogGroupNames') as log_group_names, - JSON_EXTRACT(Properties, '$.QueryDefinitionId') as query_definition_id + JSON_EXTRACT(Properties, '$.QueryDefinitionId') as query_definition_id, + JSON_EXTRACT(Properties, '$.QueryLanguage') as query_language FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::QueryDefinition' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1361,17 +3753,24 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'QueryString') as query_string, json_extract_path_text(Properties, 'LogGroupNames') as log_group_names, - json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id + json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id, + json_extract_path_text(Properties, 'QueryLanguage') as query_language FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::QueryDefinition' AND data__Identifier = '' AND region = 'us-east-1' - resource_policies: - name: resource_policies - id: awscc.logs.resource_policies - x-cfn-schema-name: ResourcePolicy - x-type: list + query_definitions_list_only: + name: query_definitions_list_only + id: awscc.logs.query_definitions_list_only + x-cfn-schema-name: QueryDefinition + x-cfn-type-name: AWS::Logs::QueryDefinition x-identifiers: - - PolicyName + - QueryDefinitionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1379,28 +3778,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' + JSON_EXTRACT(Properties, '$.QueryDefinitionId') as query_definition_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyName') as policy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' + json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.logs.resource_policy + resource_policies: + name: resource_policies + id: awscc.logs.resource_policies x-cfn-schema-name: ResourcePolicy - x-type: get + x-cfn-type-name: AWS::Logs::ResourcePolicy x-identifiers: - PolicyName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1411,7 +3858,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1421,14 +3868,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' AND data__Identifier = '' AND region = 'us-east-1' - subscription_filters: - name: subscription_filters - id: awscc.logs.subscription_filters - x-cfn-schema-name: SubscriptionFilter - x-type: list + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.logs.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::Logs::ResourcePolicy x-identifiers: - - FilterName - - LogGroupName + - PolicyName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1436,31 +3888,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FilterName') as filter_name, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FilterName') as filter_name, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' + json_extract_path_text(Properties, 'PolicyName') as policy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' AND region = 'us-east-1' - subscription_filter: - name: subscription_filter - id: awscc.logs.subscription_filter + subscription_filters: + name: subscription_filters + id: awscc.logs.subscription_filters x-cfn-schema-name: SubscriptionFilter - x-type: get + x-cfn-type-name: AWS::Logs::SubscriptionFilter x-identifiers: - FilterName - LogGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubscriptionFilter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::SubscriptionFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::SubscriptionFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::SubscriptionFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1470,12 +3968,13 @@ components: JSON_EXTRACT(Properties, '$.FilterPattern') as filter_pattern, JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.Distribution') as distribution + JSON_EXTRACT(Properties, '$.Distribution') as distribution, + JSON_EXTRACT(Properties, '$.ApplyOnTransformedLogs') as apply_on_transformed_logs FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1485,7 +3984,851 @@ components: json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, json_extract_path_text(Properties, 'LogGroupName') as log_group_name, json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Distribution') as distribution + json_extract_path_text(Properties, 'Distribution') as distribution, + json_extract_path_text(Properties, 'ApplyOnTransformedLogs') as apply_on_transformed_logs FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' AND data__Identifier = '|' AND region = 'us-east-1' + subscription_filters_list_only: + name: subscription_filters_list_only + id: awscc.logs.subscription_filters_list_only + x-cfn-schema-name: SubscriptionFilter + x-cfn-type-name: AWS::Logs::SubscriptionFilter + x-identifiers: + - FilterName + - LogGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FilterName') as filter_name, + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FilterName') as filter_name, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' + AND region = 'us-east-1' + transformers: + name: transformers + id: awscc.logs.transformers + x-cfn-schema-name: Transformer + x-cfn-type-name: AWS::Logs::Transformer + x-identifiers: + - LogGroupIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Transformer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Transformer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Transformer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Logs::Transformer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transformers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transformers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transformers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.LogGroupIdentifier') as log_group_identifier, + JSON_EXTRACT(Properties, '$.TransformerConfig') as transformer_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Transformer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LogGroupIdentifier') as log_group_identifier, + json_extract_path_text(Properties, 'TransformerConfig') as transformer_config + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Transformer' + AND data__Identifier = '' + AND region = 'us-east-1' + transformers_list_only: + name: transformers_list_only + id: awscc.logs.transformers_list_only + x-cfn-schema-name: Transformer + x-cfn-type-name: AWS::Logs::Transformer + x-identifiers: + - LogGroupIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.LogGroupIdentifier') as log_group_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Transformer' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LogGroupIdentifier') as log_group_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Transformer' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccountPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccountPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccountPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Delivery&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDelivery + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeliveryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeliveryDestination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeliveryDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeliveryDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeliverySource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeliverySource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeliverySourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Destination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LogAnomalyDetector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLogAnomalyDetector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLogAnomalyDetectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LogStream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLogStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLogStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MetricFilter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMetricFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMetricFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QueryDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueryDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueryDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubscriptionFilter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubscriptionFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubscriptionFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Transformer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransformer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransformerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/lookoutequipment.yaml b/providers/src/awscc/v00.00.00000/services/lookoutequipment.yaml index f560d40d..0ebd778b 100644 --- a/providers/src/awscc/v00.00.00000/services/lookoutequipment.yaml +++ b/providers/src/awscc/v00.00.00000/services/lookoutequipment.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: LookoutEquipment - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Bucket: type: string @@ -163,7 +543,9 @@ components: - ModelName - RoleArn x-stackql-resource-name: inference_scheduler - x-stackql-primaryIdentifier: + description: Resource schema for LookoutEquipment InferenceScheduler. + x-type-name: AWS::LookoutEquipment::InferenceScheduler + x-stackql-primary-identifier: - InferenceSchedulerName x-create-only-properties: - InferenceSchedulerName @@ -171,6 +553,13 @@ components: - ServerSideKmsKeyId x-read-only-properties: - InferenceSchedulerArn + x-required-properties: + - DataInputConfiguration + - DataOutputConfiguration + - DataUploadFrequency + - ModelName + - RoleArn + x-taggable: true x-required-permissions: create: - iam:PassRole @@ -189,43 +578,172 @@ components: - lookoutequipment:StartInferenceScheduler list: - lookoutequipment:ListInferenceSchedulers + CreateInferenceSchedulerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DataDelayOffsetInMinutes: + description: A period of time (in minutes) by which inference on the data is delayed after the data starts. + type: integer + minimum: 0 + maximum: 60 + DataInputConfiguration: + description: Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location. + type: object + properties: + InputTimeZoneOffset: + description: Indicates the difference between your time zone and Greenwich Mean Time (GMT). + type: string + pattern: ^(\+|\-)[0-9]{2}\:[0-9]{2}$ + InferenceInputNameConfiguration: + $ref: '#/components/schemas/InputNameConfiguration' + S3InputConfiguration: + $ref: '#/components/schemas/S3InputConfiguration' + required: + - S3InputConfiguration + additionalProperties: false + DataOutputConfiguration: + description: Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output. + type: object + properties: + KmsKeyId: + description: The ID number for the AWS KMS key used to encrypt the inference output. + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ + minLength: 1 + maxLength: 2048 + S3OutputConfiguration: + $ref: '#/components/schemas/S3OutputConfiguration' + required: + - S3OutputConfiguration + additionalProperties: false + DataUploadFrequency: + description: How often data is uploaded to the source S3 bucket for the input data. + type: string + enum: + - PT5M + - PT10M + - PT15M + - PT30M + - PT1H + InferenceSchedulerName: + description: The name of the inference scheduler being created. + type: string + pattern: ^[0-9a-zA-Z_-]{1,200}$ + minLength: 1 + maxLength: 200 + ModelName: + description: The name of the previously trained ML model being used to create the inference scheduler. + type: string + pattern: ^[0-9a-zA-Z_-]{1,200}$ + minLength: 1 + maxLength: 200 + RoleArn: + description: The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference. + type: string + pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+ + minLength: 20 + maxLength: 2048 + ServerSideKmsKeyId: + description: Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment. + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$ + minLength: 1 + maxLength: 2048 + Tags: + description: Any tags associated with the inference scheduler. + type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + InferenceSchedulerArn: + description: The Amazon Resource Name (ARN) of the inference scheduler being created. + type: string + pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:inference-scheduler\/.+ + minLength: 1 + maxLength: 200 + x-stackQL-stringOnly: true + x-title: CreateInferenceSchedulerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: inference_schedulers: name: inference_schedulers id: awscc.lookoutequipment.inference_schedulers x-cfn-schema-name: InferenceScheduler - x-type: list - x-identifiers: - - InferenceSchedulerName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InferenceSchedulerName') as inference_scheduler_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InferenceSchedulerName') as inference_scheduler_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' - AND region = 'us-east-1' - inference_scheduler: - name: inference_scheduler - id: awscc.lookoutequipment.inference_scheduler - x-cfn-schema-name: InferenceScheduler - x-type: get + x-cfn-type-name: AWS::LookoutEquipment::InferenceScheduler x-identifiers: - InferenceSchedulerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InferenceScheduler&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LookoutEquipment::InferenceScheduler" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LookoutEquipment::InferenceScheduler" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LookoutEquipment::InferenceScheduler" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -244,7 +762,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -262,3 +780,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' AND data__Identifier = '' AND region = 'us-east-1' + inference_schedulers_list_only: + name: inference_schedulers_list_only + id: awscc.lookoutequipment.inference_schedulers_list_only + x-cfn-schema-name: InferenceScheduler + x-cfn-type-name: AWS::LookoutEquipment::InferenceScheduler + x-identifiers: + - InferenceSchedulerName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.InferenceSchedulerName') as inference_scheduler_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InferenceSchedulerName') as inference_scheduler_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InferenceScheduler&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInferenceScheduler + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInferenceSchedulerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/lookoutmetrics.yaml b/providers/src/awscc/v00.00.00000/services/lookoutmetrics.yaml deleted file mode 100644 index 4cdb9b43..00000000 --- a/providers/src/awscc/v00.00.00000/services/lookoutmetrics.yaml +++ /dev/null @@ -1,622 +0,0 @@ -openapi: 3.0.0 -info: - title: LookoutMetrics - version: 1.0.0 -paths: {} -components: - schemas: - Arn: - type: string - maxLength: 256 - pattern: arn:([a-z\d-]+):.*:.*:.*:.+ - Action: - type: object - additionalProperties: false - properties: - SNSConfiguration: - $ref: '#/components/schemas/SNSConfiguration' - LambdaConfiguration: - $ref: '#/components/schemas/LambdaConfiguration' - SNSConfiguration: - description: Configuration options for an SNS alert action. - type: object - additionalProperties: false - properties: - RoleArn: - description: ARN of an IAM role that LookoutMetrics should assume to access the SNS topic. - $ref: '#/components/schemas/Arn' - SnsTopicArn: - description: ARN of an SNS topic to send alert notifications to. - $ref: '#/components/schemas/Arn' - required: - - RoleArn - - SnsTopicArn - LambdaConfiguration: - description: Configuration options for a Lambda alert action. - type: object - additionalProperties: false - properties: - RoleArn: - description: ARN of an IAM role that LookoutMetrics should assume to access the Lambda function. - $ref: '#/components/schemas/Arn' - LambdaArn: - description: ARN of a Lambda to send alert notifications to. - $ref: '#/components/schemas/Arn' - required: - - RoleArn - - LambdaArn - Alert: - type: object - properties: - AlertName: - description: The name of the alert. If not provided, a name is generated automatically. - type: string - minLength: 1 - maxLength: 63 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* - Arn: - description: ARN assigned to the alert. - $ref: '#/components/schemas/Arn' - AlertDescription: - description: A description for the alert. - type: string - maxLength: 256 - pattern: .*\S.* - AnomalyDetectorArn: - description: The Amazon resource name (ARN) of the Anomaly Detector to alert. - type: string - maxLength: 256 - pattern: arn:([a-z\d-]+):.*:.*:.*:.+ - AlertSensitivityThreshold: - description: A number between 0 and 100 (inclusive) that tunes the sensitivity of the alert. - type: integer - minimum: 0 - maximum: 100 - Action: - description: The action to be taken by the alert when an anomaly is detected. - $ref: '#/components/schemas/Action' - required: - - AnomalyDetectorArn - - AlertSensitivityThreshold - - Action - x-stackql-resource-name: alert - x-stackql-primaryIdentifier: - - Arn - x-create-only-properties: - - AlertName - - AlertDescription - - AnomalyDetectorArn - - AlertSensitivityThreshold - - Action - x-read-only-properties: - - Arn - x-required-permissions: - create: - - lookoutmetrics:CreateAlert - - iam:PassRole - read: - - lookoutmetrics:DescribeAlert - delete: - - lookoutmetrics:DeleteAlert - list: - - lookoutmetrics:ListAlerts - ColumnName: - description: Name of a column in the data. - type: string - minLength: 1 - maxLength: 63 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* - Charset: - type: string - maxLength: 63 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* - CsvFormatDescriptor: - type: object - properties: - FileCompression: - type: string - enum: - - NONE - - GZIP - Charset: - $ref: '#/components/schemas/Charset' - Delimiter: - type: string - maxLength: 1 - pattern: '[^\r\n]' - HeaderList: - type: array - items: - $ref: '#/components/schemas/ColumnName' - QuoteSymbol: - type: string - maxLength: 1 - pattern: '[^\r\n]|^$' - ContainsHeader: - type: boolean - additionalProperties: false - JsonFormatDescriptor: - type: object - properties: - FileCompression: - type: string - enum: - - NONE - - GZIP - Charset: - $ref: '#/components/schemas/Charset' - additionalProperties: false - FileFormatDescriptor: - type: object - properties: - CsvFormatDescriptor: - $ref: '#/components/schemas/CsvFormatDescriptor' - JsonFormatDescriptor: - $ref: '#/components/schemas/JsonFormatDescriptor' - additionalProperties: false - S3SourceConfig: - type: object - properties: - RoleArn: - $ref: '#/components/schemas/Arn' - TemplatedPathList: - type: array - minItems: 1 - maxItems: 1 - items: - type: string - maxLength: 1024 - pattern: ^s3://[a-zA-Z0-9_\-\/ {}=]+$ - HistoricalDataPathList: - type: array - minItems: 1 - maxItems: 1 - items: - type: string - maxLength: 1024 - pattern: ^s3://[a-z0-9].+$ - FileFormatDescriptor: - $ref: '#/components/schemas/FileFormatDescriptor' - additionalProperties: false - required: - - RoleArn - - FileFormatDescriptor - AppFlowConfig: - type: object - properties: - RoleArn: - $ref: '#/components/schemas/Arn' - FlowName: - type: string - maxLength: 256 - pattern: '[a-zA-Z0-9][\w!@#.-]+' - required: - - RoleArn - - FlowName - additionalProperties: false - CloudwatchConfig: - type: object - properties: - RoleArn: - $ref: '#/components/schemas/Arn' - required: - - RoleArn - additionalProperties: false - DatabaseHost: - type: string - minLength: 1 - maxLength: 253 - pattern: .*\S.* - DatabasePort: - type: integer - minimum: 1 - maximum: 65535 - TableName: - type: string - minLength: 1 - maxLength: 100 - pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ - SubnetIdList: - type: array - items: - type: string - maxLength: 255 - pattern: '[\-0-9a-zA-Z]+' - SecurityGroupIdList: - type: array - items: - type: string - minLength: 1 - maxLength: 255 - pattern: '[-0-9a-zA-Z]+' - VpcConfiguration: - type: object - properties: - SubnetIdList: - $ref: '#/components/schemas/SubnetIdList' - SecurityGroupIdList: - $ref: '#/components/schemas/SecurityGroupIdList' - required: - - SubnetIdList - - SecurityGroupIdList - additionalProperties: false - SecretManagerArn: - type: string - maxLength: 256 - pattern: arn:([a-z\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+ - RDSSourceConfig: - type: object - properties: - DBInstanceIdentifier: - type: string - minLength: 1 - maxLength: 63 - pattern: ^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\-]*$ - DatabaseHost: - $ref: '#/components/schemas/DatabaseHost' - DatabasePort: - $ref: '#/components/schemas/DatabasePort' - SecretManagerArn: - $ref: '#/components/schemas/SecretManagerArn' - DatabaseName: - type: string - minLength: 1 - maxLength: 64 - pattern: '[a-zA-Z0-9_]+' - TableName: - $ref: '#/components/schemas/TableName' - RoleArn: - $ref: '#/components/schemas/Arn' - VpcConfiguration: - $ref: '#/components/schemas/VpcConfiguration' - required: - - DBInstanceIdentifier - - DatabaseHost - - DatabasePort - - SecretManagerArn - - DatabaseName - - TableName - - RoleArn - - VpcConfiguration - additionalProperties: false - RedshiftSourceConfig: - type: object - properties: - ClusterIdentifier: - type: string - minLength: 1 - maxLength: 63 - pattern: ^[a-z](?!.*--)(?!.*-$)[0-9a-z\-]*$ - DatabaseHost: - $ref: '#/components/schemas/DatabaseHost' - DatabasePort: - $ref: '#/components/schemas/DatabasePort' - SecretManagerArn: - $ref: '#/components/schemas/SecretManagerArn' - DatabaseName: - type: string - minLength: 1 - maxLength: 100 - pattern: '[a-z0-9]+' - TableName: - $ref: '#/components/schemas/TableName' - RoleArn: - $ref: '#/components/schemas/Arn' - VpcConfiguration: - $ref: '#/components/schemas/VpcConfiguration' - required: - - ClusterIdentifier - - DatabaseHost - - DatabasePort - - SecretManagerArn - - DatabaseName - - TableName - - RoleArn - - VpcConfiguration - additionalProperties: false - MetricSource: - type: object - properties: - S3SourceConfig: - $ref: '#/components/schemas/S3SourceConfig' - RDSSourceConfig: - $ref: '#/components/schemas/RDSSourceConfig' - RedshiftSourceConfig: - $ref: '#/components/schemas/RedshiftSourceConfig' - CloudwatchConfig: - $ref: '#/components/schemas/CloudwatchConfig' - AppFlowConfig: - $ref: '#/components/schemas/AppFlowConfig' - additionalProperties: false - TimestampColumn: - type: object - additionalProperties: false - properties: - ColumnName: - $ref: '#/components/schemas/ColumnName' - ColumnFormat: - description: A timestamp format for the timestamps in the dataset - type: string - maxLength: 63 - pattern: .*\S.* - Metric: - type: object - additionalProperties: false - properties: - MetricName: - $ref: '#/components/schemas/ColumnName' - AggregationFunction: - description: Operator used to aggregate metric values - type: string - enum: - - AVG - - SUM - Namespace: - type: string - minLength: 1 - maxLength: 255 - pattern: '[^:].*' - required: - - MetricName - - AggregationFunction - MetricSet: - type: object - properties: - MetricSetName: - description: The name of the MetricSet. - type: string - minLength: 1 - maxLength: 63 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* - MetricSetDescription: - description: A description for the MetricSet. - type: string - maxLength: 256 - pattern: .*\S.* - MetricSource: - $ref: '#/components/schemas/MetricSource' - MetricList: - description: Metrics captured by this MetricSet. - type: array - x-insertionOrder: false - minItems: 1 - items: - $ref: '#/components/schemas/Metric' - Offset: - description: Offset, in seconds, between the frequency interval and the time at which the metrics are available. - type: integer - minimum: 0 - maximum: 432000 - TimestampColumn: - $ref: '#/components/schemas/TimestampColumn' - DimensionList: - description: Dimensions for this MetricSet. - type: array - x-insertionOrder: false - minItems: 0 - items: - $ref: '#/components/schemas/ColumnName' - MetricSetFrequency: - description: A frequency period to aggregate the data - type: string - enum: - - PT5M - - PT10M - - PT1H - - P1D - Timezone: - type: string - maxLength: 60 - pattern: .*\S.* - required: - - MetricSetName - - MetricList - - MetricSource - additionalProperties: false - AnomalyDetectorFrequency: - description: Frequency of anomaly detection - type: string - enum: - - PT5M - - PT10M - - PT1H - - P1D - AnomalyDetectorConfig: - type: object - properties: - AnomalyDetectorFrequency: - description: Frequency of anomaly detection - $ref: '#/components/schemas/AnomalyDetectorFrequency' - required: - - AnomalyDetectorFrequency - additionalProperties: false - AnomalyDetector: - type: object - properties: - Arn: - $ref: '#/components/schemas/Arn' - AnomalyDetectorName: - description: Name for the Amazon Lookout for Metrics Anomaly Detector - type: string - minLength: 1 - maxLength: 63 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* - AnomalyDetectorDescription: - description: A description for the AnomalyDetector. - type: string - maxLength: 256 - pattern: .*\S.* - AnomalyDetectorConfig: - description: Configuration options for the AnomalyDetector - $ref: '#/components/schemas/AnomalyDetectorConfig' - MetricSetList: - description: List of metric sets for anomaly detection - type: array - minItems: 1 - maxItems: 1 - items: - $ref: '#/components/schemas/MetricSet' - KmsKeyArn: - description: KMS key used to encrypt the AnomalyDetector data - type: string - minLength: 20 - maxLength: 2048 - pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.* - required: - - AnomalyDetectorConfig - - MetricSetList - x-stackql-resource-name: anomaly_detector - x-stackql-primaryIdentifier: - - Arn - x-create-only-properties: - - AnomalyDetectorName - - MetricSource - x-read-only-properties: - - Arn - x-required-permissions: - create: - - lookoutmetrics:CreateAnomalyDetector - - lookoutmetrics:DeleteAnomalyDetector - - lookoutmetrics:CreateMetricSet - - iam:PassRole - read: - - lookoutmetrics:DescribeAnomalyDetector - - lookoutmetrics:DescribeMetricSet - - lookoutmetrics:ListMetricSets - update: - - lookoutmetrics:UpdateAnomalyDetector - - lookoutmetrics:UpdateMetricSet - delete: - - lookoutmetrics:DescribeAnomalyDetector - - lookoutmetrics:DeleteAnomalyDetector - list: - - lookoutmetrics:ListAnomalyDetectors - x-stackQL-resources: - alerts: - name: alerts - id: awscc.lookoutmetrics.alerts - x-cfn-schema-name: Alert - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND region = 'us-east-1' - alert: - name: alert - id: awscc.lookoutmetrics.alert - x-cfn-schema-name: Alert - x-type: get - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AlertName') as alert_name, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AlertDescription') as alert_description, - JSON_EXTRACT(Properties, '$.AnomalyDetectorArn') as anomaly_detector_arn, - JSON_EXTRACT(Properties, '$.AlertSensitivityThreshold') as alert_sensitivity_threshold, - JSON_EXTRACT(Properties, '$.Action') as action - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'AlertName') as alert_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AlertDescription') as alert_description, - json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn, - json_extract_path_text(Properties, 'AlertSensitivityThreshold') as alert_sensitivity_threshold, - json_extract_path_text(Properties, 'Action') as action - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND data__Identifier = '' - AND region = 'us-east-1' - anomaly_detectors: - name: anomaly_detectors - id: awscc.lookoutmetrics.anomaly_detectors - x-cfn-schema-name: AnomalyDetector - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND region = 'us-east-1' - anomaly_detector: - name: anomaly_detector - id: awscc.lookoutmetrics.anomaly_detector - x-cfn-schema-name: AnomalyDetector - x-type: get - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AnomalyDetectorName') as anomaly_detector_name, - JSON_EXTRACT(Properties, '$.AnomalyDetectorDescription') as anomaly_detector_description, - JSON_EXTRACT(Properties, '$.AnomalyDetectorConfig') as anomaly_detector_config, - JSON_EXTRACT(Properties, '$.MetricSetList') as metric_set_list, - JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AnomalyDetectorName') as anomaly_detector_name, - json_extract_path_text(Properties, 'AnomalyDetectorDescription') as anomaly_detector_description, - json_extract_path_text(Properties, 'AnomalyDetectorConfig') as anomaly_detector_config, - json_extract_path_text(Properties, 'MetricSetList') as metric_set_list, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND data__Identifier = '' - AND region = 'us-east-1' diff --git a/providers/src/awscc/v00.00.00000/services/lookoutvision.yaml b/providers/src/awscc/v00.00.00000/services/lookoutvision.yaml index 96e427b6..e5611cd4 100644 --- a/providers/src/awscc/v00.00.00000/services/lookoutvision.yaml +++ b/providers/src/awscc/v00.00.00000/services/lookoutvision.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: LookoutVision - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: type: string @@ -24,12 +404,18 @@ components: required: - ProjectName x-stackql-resource-name: project - x-stackql-primaryIdentifier: + description: The AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model. + x-type-name: AWS::LookoutVision::Project + x-stackql-primary-identifier: - ProjectName x-create-only-properties: - ProjectName x-read-only-properties: - Arn + x-required-properties: + - ProjectName + x-tagging: + taggable: false x-required-permissions: create: - lookoutvision:CreateProject @@ -40,39 +426,114 @@ components: - lookoutvision:DeleteProject list: - lookoutvision:ListProjects + CreateProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + ProjectName: + $ref: '#/components/schemas/ProjectName' + x-stackQL-stringOnly: true + x-title: CreateProjectRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: projects: name: projects id: awscc.lookoutvision.projects x-cfn-schema-name: Project - x-type: list + x-cfn-type-name: AWS::LookoutVision::Project x-identifiers: - ProjectName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LookoutVision::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LookoutVision::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.ProjectName') as project_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutVision::Project' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'ProjectName') as project_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutVision::Project' + AND data__Identifier = '' AND region = 'us-east-1' - project: - name: project - id: awscc.lookoutvision.project + projects_list_only: + name: projects_list_only + id: awscc.lookoutvision.projects_list_only x-cfn-schema-name: Project - x-type: get + x-cfn-type-name: AWS::LookoutVision::Project x-identifiers: - ProjectName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -80,20 +541,209 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.ProjectName') as project_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutVision::Project' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'ProjectName') as project_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutVision::Project' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/m2.yaml b/providers/src/awscc/v00.00.00000/services/m2.yaml index 3fde769f..c991a4a6 100644 --- a/providers/src/awscc/v00.00.00000/services/m2.yaml +++ b/providers/src/awscc/v00.00.00000/services/m2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: M2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Definition: oneOf: @@ -73,20 +453,36 @@ components: Tags: $ref: '#/components/schemas/TagMap' required: - - Definition - EngineType - Name x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Represents an application that runs on an AWS Mainframe Modernization Environment + x-type-name: AWS::M2::Application + x-stackql-primary-identifier: - ApplicationArn x-create-only-properties: - EngineType - Name - KmsKeyId - RoleArn + x-write-only-properties: + - Definition x-read-only-properties: - ApplicationArn - ApplicationId + x-required-properties: + - EngineType + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - m2:TagResource + - m2:UntagResource + - m2:ListTagsForResource x-required-permissions: create: - m2:CreateApplication @@ -117,6 +513,100 @@ components: - m2:DeleteApplication list: - m2:ListApplications + Deployment: + type: object + properties: + EnvironmentId: + type: string + description: The environment ID. + pattern: ^\S{1,80}$ + ApplicationId: + type: string + description: The application ID. + pattern: ^\S{1,80}$ + ApplicationVersion: + type: integer + description: The version number of the application to deploy + DeploymentId: + type: string + description: The deployment ID. + pattern: ^\S{1,80}$ + Status: + type: string + description: The status of the deployment. + required: + - EnvironmentId + - ApplicationId + - ApplicationVersion + x-stackql-resource-name: deployment + description: Represents a deployment resource of an AWS Mainframe Modernization (M2) application to a specified environment + x-type-name: AWS::M2::Deployment + x-stackql-primary-identifier: + - ApplicationId + x-create-only-properties: + - EnvironmentId + - ApplicationId + x-read-only-properties: + - DeploymentId + - Status + x-required-properties: + - EnvironmentId + - ApplicationId + - ApplicationVersion + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - m2:CreateDeployment + - m2:ListDeployments + - m2:GetDeployment + - iam:PassRole + - ec2:DescribeNetworkInterfaces + - elasticloadbalancing:CreateListener + - elasticloadbalancing:CreateLoadBalancer + - elasticloadbalancing:CreateTargetGroup + - elasticloadbalancing:AddTags + - elasticloadbalancing:RegisterTargets + - logs:DescribeResourcePolicies + - logs:DescribeLogGroups + - logs:CreateLogDelivery + - logs:GetLogDelivery + - logs:UpdateLogDelivery + - logs:DeleteLogDelivery + - logs:ListLogDeliveries + - logs:CreateLogGroup + - logs:PutResourcePolicy + read: + - m2:ListDeployments + - m2:GetDeployment + update: + - m2:CreateDeployment + - m2:ListDeployments + - m2:GetDeployment + - elasticloadbalancing:CreateListener + - elasticloadbalancing:CreateLoadBalancer + - elasticloadbalancing:CreateTargetGroup + - elasticloadbalancing:DeleteListener + - elasticloadbalancing:DeleteTargetGroup + - elasticloadbalancing:DeregisterTargets + - elasticloadbalancing:DeleteLoadBalancer + - elasticloadbalancing:AddTags + - elasticloadbalancing:RegisterTargets + - ec2:DescribeNetworkInterfaces + delete: + - elasticloadbalancing:DeleteListener + - elasticloadbalancing:DeleteTargetGroup + - elasticloadbalancing:DeregisterTargets + - elasticloadbalancing:DeleteLoadBalancer + - logs:DeleteLogDelivery + - m2:ListDeployments + - m2:GetDeployment + - m2:DeleteApplicationFromEnvironment + list: + - m2:ListDeployments EfsStorageConfiguration: type: object description: Defines the storage configuration for an Amazon EFS file system. @@ -160,6 +650,11 @@ components: required: - DesiredCapacity additionalProperties: false + NetworkType: + type: string + enum: + - ipv4 + - dual StorageConfiguration: type: object description: Defines the storage configuration for an environment. @@ -212,6 +707,8 @@ components: type: string description: The name of the environment. pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$ + NetworkType: + $ref: '#/components/schemas/NetworkType' PreferredMaintenanceWindow: type: string description: Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned. @@ -247,13 +744,16 @@ components: - InstanceType - Name x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: Represents a runtime environment that can run migrated mainframe applications. + x-type-name: AWS::M2::Environment + x-stackql-primary-identifier: - EnvironmentArn x-create-only-properties: - Description - EngineType - KmsKeyId - Name + - NetworkType - PubliclyAccessible - SecurityGroupIds - StorageConfigurations @@ -261,6 +761,20 @@ components: x-read-only-properties: - EnvironmentArn - EnvironmentId + x-required-properties: + - EngineType + - InstanceType + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - m2:TagResource + - m2:UntagResource + - m2:ListTagsForResource x-required-permissions: create: - ec2:CreateNetworkInterface @@ -273,6 +787,7 @@ components: - ec2:ModifyNetworkInterfaceAttribute - elasticfilesystem:DescribeMountTargets - elasticloadbalancing:CreateLoadBalancer + - elasticloadbalancing:DeleteLoadBalancer - elasticloadbalancing:AddTags - fsx:DescribeFileSystems - iam:CreateServiceLinkedRole @@ -291,49 +806,240 @@ components: - m2:ListTagsForResource - m2:GetEnvironment - m2:UpdateEnvironment + - kms:DescribeKey delete: - elasticloadbalancing:DeleteLoadBalancer - m2:DeleteEnvironment - m2:GetEnvironment list: - m2:ListEnvironments + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationArn: + type: string + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$ + ApplicationId: + type: string + pattern: ^\S{1,80}$ + Definition: + $ref: '#/components/schemas/Definition' + Description: + type: string + maxLength: 500 + minLength: 0 + EngineType: + $ref: '#/components/schemas/EngineType' + KmsKeyId: + type: string + maxLength: 2048 + description: The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources. + Name: + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$ + RoleArn: + type: string + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$ + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateDeploymentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EnvironmentId: + type: string + description: The environment ID. + pattern: ^\S{1,80}$ + ApplicationId: + type: string + description: The application ID. + pattern: ^\S{1,80}$ + ApplicationVersion: + type: integer + description: The version number of the application to deploy + DeploymentId: + type: string + description: The deployment ID. + pattern: ^\S{1,80}$ + Status: + type: string + description: The status of the deployment. + x-stackQL-stringOnly: true + x-title: CreateDeploymentRequest + type: object + required: [] + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: The description of the environment. + maxLength: 500 + minLength: 0 + EngineType: + $ref: '#/components/schemas/EngineType' + EngineVersion: + type: string + description: The version of the runtime engine for the environment. + pattern: ^\S{1,10}$ + EnvironmentArn: + type: string + description: The Amazon Resource Name (ARN) of the runtime environment. + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$ + EnvironmentId: + type: string + description: The unique identifier of the environment. + pattern: ^\S{1,80}$ + HighAvailabilityConfig: + $ref: '#/components/schemas/HighAvailabilityConfig' + InstanceType: + type: string + description: The type of instance underlying the environment. + pattern: ^\S{1,20}$ + KmsKeyId: + type: string + maxLength: 2048 + description: The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources. + Name: + type: string + description: The name of the environment. + pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$ + NetworkType: + $ref: '#/components/schemas/NetworkType' + PreferredMaintenanceWindow: + type: string + description: Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned. + pattern: ^\S{1,50}$ + PubliclyAccessible: + type: boolean + description: Specifies whether the environment is publicly accessible. + SecurityGroupIds: + type: array + description: The list of security groups for the VPC associated with this environment. + x-insertionOrder: false + items: + type: string + pattern: ^\S{1,50}$ + StorageConfigurations: + type: array + description: The storage configurations defined for the runtime environment. + x-insertionOrder: false + items: + $ref: '#/components/schemas/StorageConfiguration' + SubnetIds: + type: array + description: The unique identifiers of the subnets assigned to this runtime environment. + x-insertionOrder: false + items: + type: string + pattern: ^\S{1,50}$ + Tags: + description: Tags associated to this environment. + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.m2.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - ApplicationArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.m2.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::M2::Application x-identifiers: - ApplicationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -351,7 +1057,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -368,13 +1074,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Application' AND data__Identifier = '' AND region = 'us-east-1' - environments: - name: environments - id: awscc.m2.environments - x-cfn-schema-name: Environment - x-type: list + applications_list_only: + name: applications_list_only + id: awscc.m2.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::M2::Application x-identifiers: - - EnvironmentArn + - ApplicationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -382,28 +1094,192 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EnvironmentArn') as environment_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' + json_extract_path_text(Properties, 'ApplicationArn') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' + AND region = 'us-east-1' + deployments: + name: deployments + id: awscc.m2.deployments + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::M2::Deployment + x-identifiers: + - ApplicationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Deployment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.ApplicationVersion') as application_version, + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, + JSON_EXTRACT(Properties, '$.Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Deployment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'ApplicationVersion') as application_version, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Deployment' + AND data__Identifier = '' AND region = 'us-east-1' - environment: - name: environment - id: awscc.m2.environment + deployments_list_only: + name: deployments_list_only + id: awscc.m2.deployments_list_only + x-cfn-schema-name: Deployment + x-cfn-type-name: AWS::M2::Deployment + x-identifiers: + - ApplicationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Deployment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Deployment' + AND region = 'us-east-1' + environments: + name: environments + id: awscc.m2.environments x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::M2::Environment x-identifiers: - EnvironmentArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::M2::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -417,6 +1293,7 @@ components: JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.NetworkType') as network_type, JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, @@ -427,7 +1304,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -441,6 +1318,7 @@ components: json_extract_path_text(Properties, 'InstanceType') as instance_type, json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NetworkType') as network_type, json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, @@ -450,3 +1328,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Environment' AND data__Identifier = '' AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.m2.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::M2::Environment + x-identifiers: + - EnvironmentArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EnvironmentArn') as environment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Deployment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeployment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/macie.yaml b/providers/src/awscc/v00.00.00000/services/macie.yaml index 28fed6af..7fee8ca2 100644 --- a/providers/src/awscc/v00.00.00000/services/macie.yaml +++ b/providers/src/awscc/v00.00.00000/services/macie.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Macie - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Regex: type: string @@ -93,12 +473,28 @@ components: - Name - Criteria x-stackql-resource-name: allow_list - x-stackql-primaryIdentifier: + description: Macie AllowList resource schema + x-type-name: AWS::Macie::AllowList + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Arn x-read-only-properties: - Id - Arn - Status + x-required-properties: + - Name + - Criteria + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - macie2:TagResource + - macie2:UntagResource x-required-permissions: create: - macie2:CreateAllowList @@ -156,8 +552,12 @@ components: - Name - Regex x-stackql-resource-name: custom_data_identifier - x-stackql-primaryIdentifier: + description: Macie CustomDataIdentifier resource schema + x-type-name: AWS::Macie::CustomDataIdentifier + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Arn x-create-only-properties: - Name - Description @@ -168,6 +568,18 @@ components: x-read-only-properties: - Id - Arn + x-required-properties: + - Name + - Regex + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - macie2:TagResource + - macie2:UntagResource x-required-permissions: create: - macie2:CreateCustomDataIdentifier @@ -182,6 +594,7 @@ components: update: - macie2:TagResource - macie2:UntagResource + - macie2:GetCustomDataIdentifier CriterionAdditionalProperties: type: object properties: @@ -266,11 +679,28 @@ components: - Name - FindingCriteria x-stackql-resource-name: findings_filter - x-stackql-primaryIdentifier: + description: Macie FindingsFilter resource schema. + x-type-name: AWS::Macie::FindingsFilter + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Arn + - - Name x-read-only-properties: - Id - Arn + x-required-properties: + - Name + - FindingCriteria + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - macie2:TagResource + - macie2:UntagResource x-required-permissions: create: - macie2:GetFindingsFilter @@ -311,62 +741,290 @@ components: ServiceRole: description: Service role used by Macie type: string + AutomatedDiscoveryStatus: + description: The status of automated sensitive data discovery for the Macie session. + type: string + enum: + - ENABLED + - DISABLED x-stackql-resource-name: session - x-stackql-primaryIdentifier: + description: The AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational. + x-type-name: AWS::Macie::Session + x-stackql-primary-identifier: - AwsAccountId x-read-only-properties: - AwsAccountId - ServiceRole + - AutomatedDiscoveryStatus + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - macie2:GetMacieSession - macie2:EnableMacie + - macie2:ListAutomatedDiscoveryAccounts read: - macie2:GetMacieSession + - macie2:ListAutomatedDiscoveryAccounts list: - macie2:GetMacieSession + - macie2:ListAutomatedDiscoveryAccounts update: - macie2:GetMacieSession - macie2:UpdateMacieSession + - macie2:ListAutomatedDiscoveryAccounts delete: - macie2:DisableMacie + CreateAllowListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of AllowList. + type: string + Description: + description: Description of AllowList. + type: string + Criteria: + description: AllowList criteria. + $ref: '#/components/schemas/Criteria' + Id: + description: AllowList ID. + type: string + Arn: + description: AllowList ARN. + type: string + Status: + description: AllowList status. + $ref: '#/components/schemas/Status' + Tags: + description: A collection of tags associated with a resource + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAllowListRequest + type: object + required: [] + CreateCustomDataIdentifierRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of custom data identifier. + type: string + Description: + description: Description of custom data identifier. + type: string + Regex: + description: Regular expression for custom data identifier. + type: string + MaximumMatchDistance: + description: Maximum match distance. + type: integer + Keywords: + description: Keywords to be matched against. + type: array + items: + type: string + IgnoreWords: + description: Words to be ignored. + type: array + items: + type: string + Id: + description: Custom data identifier ID. + type: string + Arn: + description: Custom data identifier ARN. + type: string + Tags: + description: A collection of tags associated with a resource + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCustomDataIdentifierRequest + type: object + required: [] + CreateFindingsFilterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Findings filter name + type: string + Description: + description: Findings filter description + type: string + FindingCriteria: + description: Findings filter criteria. + $ref: '#/components/schemas/FindingCriteria' + Action: + description: Findings filter action. + $ref: '#/components/schemas/FindingFilterAction' + Position: + description: Findings filter position. + type: integer + Id: + description: Findings filter ID. + type: string + Arn: + description: Findings filter ARN. + type: string + Tags: + description: A collection of tags associated with a resource + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFindingsFilterRequest + type: object + required: [] + CreateSessionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AwsAccountId: + description: AWS account ID of customer + type: string + Status: + description: A enumeration value that specifies the status of the Macie Session. + type: string + enum: + - ENABLED + - PAUSED + default: ENABLED + FindingPublishingFrequency: + description: A enumeration value that specifies how frequently finding updates are published. + type: string + enum: + - FIFTEEN_MINUTES + - ONE_HOUR + - SIX_HOURS + default: SIX_HOURS + ServiceRole: + description: Service role used by Macie + type: string + AutomatedDiscoveryStatus: + description: The status of automated sensitive data discovery for the Macie session. + type: string + enum: + - ENABLED + - DISABLED + x-stackQL-stringOnly: true + x-title: CreateSessionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: allow_lists: name: allow_lists id: awscc.macie.allow_lists x-cfn-schema-name: AllowList - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' - AND region = 'us-east-1' - allow_list: - name: allow_list - id: awscc.macie.allow_list - x-cfn-schema-name: AllowList - x-type: get + x-cfn-type-name: AWS::Macie::AllowList x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AllowList&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::AllowList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::AllowList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::AllowList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/allow_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/allow_lists/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/allow_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -382,7 +1040,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -397,13 +1055,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::AllowList' AND data__Identifier = '' AND region = 'us-east-1' - custom_data_identifiers: - name: custom_data_identifiers - id: awscc.macie.custom_data_identifiers - x-cfn-schema-name: CustomDataIdentifier - x-type: list + allow_lists_list_only: + name: allow_lists_list_only + id: awscc.macie.allow_lists_list_only + x-cfn-schema-name: AllowList + x-cfn-type-name: AWS::Macie::AllowList x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -412,7 +1076,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -420,19 +1084,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' AND region = 'us-east-1' - custom_data_identifier: - name: custom_data_identifier - id: awscc.macie.custom_data_identifier + custom_data_identifiers: + name: custom_data_identifiers + id: awscc.macie.custom_data_identifiers x-cfn-schema-name: CustomDataIdentifier - x-type: get + x-cfn-type-name: AWS::Macie::CustomDataIdentifier x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomDataIdentifier&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::CustomDataIdentifier" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::CustomDataIdentifier" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::CustomDataIdentifier" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -450,7 +1162,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -467,13 +1179,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' AND data__Identifier = '' AND region = 'us-east-1' - findings_filters: - name: findings_filters - id: awscc.macie.findings_filters - x-cfn-schema-name: FindingsFilter - x-type: list + custom_data_identifiers_list_only: + name: custom_data_identifiers_list_only + id: awscc.macie.custom_data_identifiers_list_only + x-cfn-schema-name: CustomDataIdentifier + x-cfn-type-name: AWS::Macie::CustomDataIdentifier x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -482,7 +1200,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -490,19 +1208,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' AND region = 'us-east-1' - findings_filter: - name: findings_filter - id: awscc.macie.findings_filter + findings_filters: + name: findings_filters + id: awscc.macie.findings_filters x-cfn-schema-name: FindingsFilter - x-type: get + x-cfn-type-name: AWS::Macie::FindingsFilter x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FindingsFilter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::FindingsFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::FindingsFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::FindingsFilter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/findings_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/findings_filters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/findings_filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -519,7 +1285,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -535,13 +1301,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::FindingsFilter' AND data__Identifier = '' AND region = 'us-east-1' - sessions: - name: sessions - id: awscc.macie.sessions - x-cfn-schema-name: Session - x-type: list + findings_filters_list_only: + name: findings_filters_list_only + id: awscc.macie.findings_filters_list_only + x-cfn-schema-name: FindingsFilter + x-cfn-type-name: AWS::Macie::FindingsFilter x-identifiers: - - AwsAccountId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -549,28 +1321,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' AND region = 'us-east-1' - session: - name: session - id: awscc.macie.session + sessions: + name: sessions + id: awscc.macie.sessions x-cfn-schema-name: Session - x-type: get + x-cfn-type-name: AWS::Macie::Session x-identifiers: - AwsAccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Session&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::Session" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::Session" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Macie::Session" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sessions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sessions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sessions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -578,12 +1398,13 @@ components: JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.FindingPublishingFrequency') as finding_publishing_frequency, - JSON_EXTRACT(Properties, '$.ServiceRole') as service_role + JSON_EXTRACT(Properties, '$.ServiceRole') as service_role, + JSON_EXTRACT(Properties, '$.AutomatedDiscoveryStatus') as automated_discovery_status FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::Session' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -591,7 +1412,360 @@ components: json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'FindingPublishingFrequency') as finding_publishing_frequency, - json_extract_path_text(Properties, 'ServiceRole') as service_role + json_extract_path_text(Properties, 'ServiceRole') as service_role, + json_extract_path_text(Properties, 'AutomatedDiscoveryStatus') as automated_discovery_status FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::Session' AND data__Identifier = '' AND region = 'us-east-1' + sessions_list_only: + name: sessions_list_only + id: awscc.macie.sessions_list_only + x-cfn-schema-name: Session + x-cfn-type-name: AWS::Macie::Session + x-identifiers: + - AwsAccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AllowList&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAllowList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAllowListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomDataIdentifier&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomDataIdentifier + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomDataIdentifierRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FindingsFilter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFindingsFilter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFindingsFilterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Session&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSession + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSessionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/managedblockchain.yaml b/providers/src/awscc/v00.00.00000/services/managedblockchain.yaml index 4ed03c2b..55426258 100644 --- a/providers/src/awscc/v00.00.00000/services/managedblockchain.yaml +++ b/providers/src/awscc/v00.00.00000/services/managedblockchain.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ManagedBlockchain - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AccessorStatus: type: string @@ -76,17 +456,30 @@ components: required: - AccessorType x-stackql-resource-name: accessor - x-stackql-primaryIdentifier: + description: Definition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type + x-type-name: AWS::ManagedBlockchain::Accessor + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Arn x-create-only-properties: - AccessorType - NetworkType + x-write-only-properties: + - Tags x-read-only-properties: - Arn - Id - BillingToken - CreationDate - Status + x-required-properties: + - AccessorType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true x-required-permissions: create: - managedblockchain:CreateAccessor @@ -103,43 +496,119 @@ components: - managedblockchain:DeleteAccessor list: - managedblockchain:ListAccessors + CreateAccessorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 1011 + minLength: 1 + pattern: ^arn:.+:.+:.+:.+:.+$ + BillingToken: + type: string + maxLength: 42 + minLength: 42 + CreationDate: + type: string + Id: + type: string + maxLength: 32 + minLength: 1 + Status: + $ref: '#/components/schemas/AccessorStatus' + AccessorType: + $ref: '#/components/schemas/AccessorType' + NetworkType: + $ref: '#/components/schemas/NetworkAccessorType' + Tags: + type: array + maxItems: 50 + x-insertionOrder: false + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAccessorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: accessors: name: accessors id: awscc.managedblockchain.accessors x-cfn-schema-name: Accessor - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' - AND region = 'us-east-1' - accessor: - name: accessor - id: awscc.managedblockchain.accessor - x-cfn-schema-name: Accessor - x-type: get + x-cfn-type-name: AWS::ManagedBlockchain::Accessor x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Accessor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ManagedBlockchain::Accessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ManagedBlockchain::Accessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ManagedBlockchain::Accessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accessors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accessors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/accessors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -156,7 +625,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -172,3 +641,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' AND data__Identifier = '' AND region = 'us-east-1' + accessors_list_only: + name: accessors_list_only + id: awscc.managedblockchain.accessors_list_only + x-cfn-schema-name: Accessor + x-cfn-type-name: AWS::ManagedBlockchain::Accessor + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Accessor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/mediaconnect.yaml b/providers/src/awscc/v00.00.00000/services/mediaconnect.yaml index 2212d882..3b1a9b5b 100644 --- a/providers/src/awscc/v00.00.00000/services/mediaconnect.yaml +++ b/providers/src/awscc/v00.00.00000/services/mediaconnect.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MediaConnect - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: FailoverConfig: type: object @@ -82,12 +462,20 @@ components: - Name - NetworkOutput x-stackql-resource-name: bridge_output - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::BridgeOutput + x-type-name: AWS::MediaConnect::BridgeOutput + x-stackql-primary-identifier: - BridgeArn - Name x-create-only-properties: - BridgeArn - Name + x-required-properties: + - BridgeArn + - Name + - NetworkOutput + x-tagging: + taggable: false x-required-permissions: create: - mediaconnect:AddBridgeOutputs @@ -146,12 +534,19 @@ components: - Name - BridgeArn x-stackql-resource-name: bridge_source - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::BridgeSource + x-type-name: AWS::MediaConnect::BridgeSource + x-stackql-primary-identifier: - BridgeArn - Name x-create-only-properties: - BridgeArn - Name + x-required-properties: + - Name + - BridgeArn + x-tagging: + taggable: false x-required-permissions: create: - mediaconnect:AddBridgeSources @@ -194,6 +589,9 @@ components: MulticastIp: description: The network source multicast IP. type: string + MulticastSourceSettings: + description: The settings related to the multicast source. + $ref: '#/components/schemas/MulticastSourceSettings' Port: description: The network source port. type: integer @@ -206,6 +604,14 @@ components: - Port - NetworkName additionalProperties: false + MulticastSourceSettings: + type: object + description: The settings related to the multicast source. + properties: + MulticastSourceIp: + description: The IP address of the source for source-specific multicast (SSM). + type: string + additionalProperties: false ProtocolEnum: type: string enum: @@ -277,15 +683,25 @@ components: - PlacementArn - Sources x-stackql-resource-name: bridge - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::Bridge + x-type-name: AWS::MediaConnect::Bridge + x-stackql-primary-identifier: - BridgeArn x-read-only-properties: - BridgeArn - BridgeState + x-required-properties: + - Name + - PlacementArn + - Sources + x-tagging: + taggable: false x-required-permissions: create: - mediaconnect:CreateBridge - mediaconnect:DescribeBridge + - mediaconnect:AddBridgeOutputs + - mediaconnect:AddBridgeSources read: - mediaconnect:DescribeBridge update: @@ -294,6 +710,8 @@ components: delete: - mediaconnect:DescribeBridge - mediaconnect:DeleteBridge + - mediaconnect:RemoveBridgeOutput + - mediaconnect:RemoveBridgeSource list: - mediaconnect:ListBridges Source: @@ -327,11 +745,9 @@ components: MaxLatency: type: integer description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. - default: 2000 MinLatency: type: integer description: The minimum latency in milliseconds. - default: 2000 Name: type: string description: The name of the source. @@ -345,6 +761,8 @@ components: - fujitsu-qos - srt-listener - srt-caller + - st2110-jpegxs + - cdi description: The protocol that is used by the source. SenderIpAddress: type: string @@ -370,6 +788,14 @@ components: WhitelistCidr: type: string description: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + MaxSyncBuffer: + type: integer + description: The size of the buffer (in milliseconds) to use to sync incoming source data. + MediaStreamSourceConfigurations: + type: array + description: The media stream that is associated with the source, and the parameters for that association. + items: + $ref: '#/components/schemas/MediaStreamSourceConfiguration' additionalProperties: false Encryption: type: object @@ -427,12 +853,348 @@ components: additionalProperties: false required: - BridgeArn + VpcInterface: + type: object + description: The details of a VPC interface. + properties: + Name: + type: string + description: Immutable and has to be a unique against other VpcInterfaces in this Flow. + NetworkInterfaceType: + type: string + description: The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA. + enum: + - ena + - efa + RoleArn: + type: string + description: Role Arn MediaConnect can assume to create ENIs in customer's account. + SecurityGroupIds: + type: array + description: Security Group IDs to be used on ENI. + items: + type: string + SubnetId: + type: string + description: Subnet must be in the AZ of the Flow + NetworkInterfaceIds: + type: array + description: IDs of the network interfaces created in customer's account by MediaConnect. + items: + type: string + additionalProperties: false + required: + - Name + - RoleArn + - SecurityGroupIds + - SubnetId + Maintenance: + type: object + description: The maintenance setting of a flow. + properties: + MaintenanceDay: + type: string + description: A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday. + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + MaintenanceStartHour: + type: string + description: 'UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.' + additionalProperties: false + required: + - MaintenanceDay + - MaintenanceStartHour + MediaStream: + type: object + description: A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams. + properties: + MediaStreamId: + type: integer + description: A unique identifier for the media stream. + MediaStreamType: + type: string + description: The type of media stream. + enum: + - video + - audio + - ancillary-data + VideoFormat: + type: string + description: The resolution of the video. + enum: + - 2160p + - 1080p + - 1080i + - 720p + - 480p + MediaStreamName: + type: string + description: A name that helps you distinguish one media stream from another. + Description: + type: string + description: A description that can help you quickly identify what your media stream is used for. + Attributes: + $ref: '#/components/schemas/MediaStreamAttributes' + description: Attributes that are related to the media stream. + ClockRate: + type: integer + description: The sample rate for the stream. This value in measured in kHz. + Fmt: + type: integer + description: The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver. + additionalProperties: false + required: + - MediaStreamId + - MediaStreamType + - MediaStreamName + MediaStreamAttributes: + type: object + description: Attributes that are related to the media stream. + properties: + Fmtp: + $ref: '#/components/schemas/Fmtp' + description: A set of parameters that define the media stream. + Lang: + type: string + description: The audio language, in a format that is recognized by the receiver. + additionalProperties: false + Fmtp: + type: object + description: A set of parameters that define the media stream. + properties: + ExactFramerate: + type: string + description: 'The frame rate for the video stream, in frames/second. For example: 60000/1001.' + Colorimetry: + type: string + description: The format used for the representation of color. + enum: + - BT601 + - BT709 + - BT2020 + - BT2100 + - ST2065-1 + - ST2065-3 + - XYZ + ScanMode: + type: string + description: The type of compression that was used to smooth the video's appearance. + enum: + - progressive + - interlace + - progressive-segmented-frame + Tcs: + type: string + description: The transfer characteristic system (TCS) that is used in the video. + enum: + - SDR + - PQ + - HLG + - LINEAR + - BT2100LINPQ + - BT2100LINHLG + - ST2065-1 + - ST428-1 + - DENSITY + Range: + type: string + description: The encoding range of the video. + enum: + - NARROW + - FULL + - FULLPROTECT + Par: + type: string + description: The pixel aspect ratio (PAR) of the video. + ChannelOrder: + type: string + description: The format of the audio channel. + additionalProperties: false + MediaStreamSourceConfiguration: + type: object + description: The media stream that is associated with the source, and the parameters for that association. + properties: + EncodingName: + type: string + description: The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. + enum: + - jxsv + - raw + - smpte291 + - pcm + InputConfigurations: + type: array + description: The media streams that you want to associate with the source. + items: + $ref: '#/components/schemas/InputConfiguration' + MediaStreamName: + type: string + description: A name that helps you distinguish one media stream from another. + additionalProperties: false + required: + - EncodingName + - MediaStreamName + InputConfiguration: + type: object + description: The transport parameters associated with an incoming media stream. + properties: + InputPort: + type: integer + description: The port that the flow listens on for an incoming media stream. + Interface: + $ref: '#/components/schemas/Interface' + description: The VPC interface where the media stream comes in from. + additionalProperties: false + required: + - InputPort + - Interface + Interface: + type: object + description: The VPC interface that you want to use for the media stream associated with the output. + properties: + Name: + type: string + description: The name of the VPC interface that you want to use for the media stream associated with the output. + additionalProperties: false + required: + - Name + SourceMonitoringConfig: + type: object + description: The settings for source monitoring. + properties: + ThumbnailState: + type: string + description: The state of thumbnail monitoring. + enum: + - ENABLED + - DISABLED + ContentQualityAnalysisState: + type: string + description: Indicates whether content quality analysis is enabled or disabled. + enum: + - ENABLED + - DISABLED + AudioMonitoringSettings: + type: array + description: Contains the settings for audio stream metrics monitoring. + items: + $ref: '#/components/schemas/AudioMonitoringSetting' + VideoMonitoringSettings: + type: array + description: Contains the settings for video stream metrics monitoring. + items: + $ref: '#/components/schemas/VideoMonitoringSetting' + additionalProperties: false + AudioMonitoringSetting: + type: object + description: Specifies the configuration for audio stream metrics monitoring. + properties: + SilentAudio: + $ref: '#/components/schemas/SilentAudio' + additionalProperties: false + SilentAudio: + type: object + description: Configures settings for the SilentAudio metric. + properties: + State: + type: string + description: Indicates whether the SilentAudio metric is enabled or disabled. + enum: + - ENABLED + - DISABLED + ThresholdSeconds: + type: integer + description: Specifies the number of consecutive seconds of silence that triggers an event or alert. + additionalProperties: false + VideoMonitoringSetting: + type: object + description: Specifies the configuration for video stream metrics monitoring. + properties: + BlackFrames: + $ref: '#/components/schemas/BlackFrames' + FrozenFrames: + $ref: '#/components/schemas/FrozenFrames' + additionalProperties: false + BlackFrames: + type: object + description: Configures settings for the BlackFrames metric. + properties: + State: + type: string + description: Indicates whether the BlackFrames metric is enabled or disabled. + enum: + - ENABLED + - DISABLED + ThresholdSeconds: + type: integer + description: Specifies the number of consecutive seconds of black frames that triggers an event or alert. + additionalProperties: false + FrozenFrames: + type: object + description: Configures settings for the FrozenFrames metric. + properties: + State: + type: string + description: Indicates whether the FrozenFrames metric is enabled or disabled. + enum: + - ENABLED + - DISABLED + ThresholdSeconds: + type: integer + description: Specifies the number of consecutive seconds of a static image that triggers an event or alert. + additionalProperties: false + NdiConfig: + type: object + description: Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. + properties: + NdiDiscoveryServers: + type: array + description: A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. + items: + $ref: '#/components/schemas/NdiDiscoveryServerConfig' + NdiState: + type: string + description: A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. + enum: + - ENABLED + - DISABLED + MachineName: + type: string + description: A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix. + additionalProperties: false + NdiDiscoveryServerConfig: + type: object + description: Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. + properties: + VpcInterfaceAdapter: + type: string + description: The identifier for the Virtual Private Cloud (VPC) network interface used by the flow. + DiscoveryServerAddress: + type: string + description: The unique network address of the NDI discovery server. + DiscoveryServerPort: + type: integer + description: The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified. + format: int32 + additionalProperties: false + required: + - DiscoveryServerAddress + - VpcInterfaceAdapter Flow: type: object properties: FlowArn: description: The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. type: string + EgressIp: + description: The IP address from which video will be sent to output destinations. + type: string Name: description: The name of the flow. type: string @@ -448,11 +1210,41 @@ components: SourceFailoverConfig: description: The source failover config of the flow. $ref: '#/components/schemas/FailoverConfig' + VpcInterfaces: + type: array + description: The VPC interfaces that you added to this flow. + items: + $ref: '#/components/schemas/VpcInterface' + MediaStreams: + type: array + description: The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow. + items: + $ref: '#/components/schemas/MediaStream' + Maintenance: + description: The maintenance settings you want to use for the flow. + $ref: '#/components/schemas/Maintenance' + SourceMonitoringConfig: + description: The source monitoring config of the flow. + $ref: '#/components/schemas/SourceMonitoringConfig' + FlowSize: + type: string + description: Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow. + enum: + - MEDIUM + - LARGE + NdiConfig: + description: Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. + $ref: '#/components/schemas/NdiConfig' + FlowNdiMachineName: + type: string + description: A prefix for the names of the NDI sources that the flow creates.(ReadOnly) required: - Name - Source x-stackql-resource-name: flow - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::Flow + x-type-name: AWS::MediaConnect::Flow + x-stackql-primary-identifier: - FlowArn x-create-only-properties: - Name @@ -464,9 +1256,19 @@ components: - Source/SourceArn - Source/IngestIp - Source/SourceIngestPort + - VpcInterfaces/*/NetworkInterfaceIds + - MediaStreams/*/Fmt + - EgressIp + - FlowNdiMachineName + x-required-properties: + - Name + - Source x-required-permissions: create: - mediaconnect:CreateFlow + - mediaconnect:AddFlowMediaStreams + - mediaconnect:AddFlowSources + - mediaconnect:AddFlowVpcInterfaces - iam:PassRole read: - mediaconnect:DescribeFlow @@ -474,10 +1276,20 @@ components: - mediaconnect:DescribeFlow - mediaconnect:UpdateFlow - mediaconnect:UpdateFlowSource + - mediaconnect:UpdateFlowMediaStream + - mediaconnect:AddFlowMediaStreams + - mediaconnect:RemoveFlowMediaStream + - mediaconnect:AddFlowVpcInterfaces + - mediaconnect:RemoveFlowVpcInterface delete: - mediaconnect:DescribeFlow - mediaconnect:DeleteFlow - list: + - mediaconnect:RemoveFlowMediaStream + - mediaconnect:RemoveFlowOutput + - mediaconnect:RemoveFlowSource + - mediaconnect:RemoveFlowVpcInterface + - mediaconnect:RevokeFlowEntitlement + list: - mediaconnect:ListFlows FlowEntitlement: type: object @@ -518,13 +1330,20 @@ components: - Subscribers - Description x-stackql-resource-name: flow_entitlement - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::FlowEntitlement + x-type-name: AWS::MediaConnect::FlowEntitlement + x-stackql-primary-identifier: - EntitlementArn x-create-only-properties: - DataTransferSubscriberFeePercent - Name x-read-only-properties: - EntitlementArn + x-required-properties: + - FlowArn + - Name + - Subscribers + - Description x-required-permissions: create: - iam:PassRole @@ -539,6 +1358,68 @@ components: - mediaconnect:RevokeFlowEntitlement list: - mediaconnect:DescribeFlow + - mediaconnect:ListFlows + MediaStreamOutputConfiguration: + type: object + description: The media stream that is associated with the output, and the parameters for that association. + properties: + EncodingName: + type: string + description: The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv. + enum: + - jxsv + - raw + - smpte291 + - pcm + DestinationConfigurations: + type: array + description: The media streams that you want to associate with the output. + items: + $ref: '#/components/schemas/DestinationConfiguration' + MediaStreamName: + type: string + description: A name that helps you distinguish one media stream from another. + EncodingParameters: + $ref: '#/components/schemas/EncodingParameters' + description: A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source. + additionalProperties: false + required: + - EncodingName + - MediaStreamName + DestinationConfiguration: + type: object + description: The definition of a media stream that is associated with the output. + properties: + DestinationIp: + type: string + description: The IP address where contents of the media stream will be sent. + DestinationPort: + type: integer + description: The port to use when the content of the media stream is distributed to the output. + Interface: + $ref: '#/components/schemas/Interface' + description: The VPC interface that is used for the media stream associated with the output. + additionalProperties: false + required: + - DestinationIp + - DestinationPort + - Interface + EncodingParameters: + type: object + description: A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source. + properties: + CompressionFactor: + type: number + description: 'A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.' + EncoderProfile: + type: string + description: A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. + enum: + - main + - high + additionalProperties: false + required: + - CompressionFactor FlowOutput: type: object properties: @@ -585,6 +1466,9 @@ components: - fujitsu-qos - srt-listener - srt-caller + - st2110-jpegxs + - cdi + - ndi-speed-hq description: The protocol that is used by the source or output. RemoteId: type: string @@ -598,16 +1482,38 @@ components: VpcInterfaceAttachment: $ref: '#/components/schemas/VpcInterfaceAttachment' description: The name of the VPC interface attachment to use for this output. + MediaStreamOutputConfigurations: + type: array + description: The definition for each media stream that is associated with the output. + items: + $ref: '#/components/schemas/MediaStreamOutputConfiguration' + OutputStatus: + type: string + enum: + - ENABLED + - DISABLED + description: An indication of whether the output should transmit data or not. + NdiProgramName: + type: string + description: A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. + NdiSpeedHqQuality: + type: integer + description: A quality setting for the NDI Speed HQ encoder. required: - FlowArn - Protocol x-stackql-resource-name: flow_output - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::FlowOutput + x-type-name: AWS::MediaConnect::FlowOutput + x-stackql-primary-identifier: - OutputArn x-create-only-properties: - Name x-read-only-properties: - OutputArn + x-required-properties: + - FlowArn + - Protocol x-required-permissions: create: - iam:PassRole @@ -622,6 +1528,7 @@ components: - mediaconnect:RemoveFlowOutput list: - mediaconnect:DescribeFlow + - mediaconnect:ListFlows FlowSource: type: object properties: @@ -655,11 +1562,9 @@ components: MaxLatency: type: integer description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. - default: 2000 MinLatency: type: integer description: The minimum latency in milliseconds. - default: 2000 Name: type: string description: The name of the source. @@ -701,7 +1606,9 @@ components: - Name - Description x-stackql-resource-name: flow_source - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::FlowSource + x-type-name: AWS::MediaConnect::FlowSource + x-stackql-primary-identifier: - SourceArn x-create-only-properties: - Name @@ -709,6 +1616,9 @@ components: - IngestIp - SourceArn - SourceIngestPort + x-required-properties: + - Name + - Description x-required-permissions: create: - mediaconnect:CreateFlow @@ -725,6 +1635,7 @@ components: - mediaconnect:RemoveFlowSource list: - mediaconnect:DescribeFlow + - mediaconnect:ListFlows FlowVpcInterface: type: object properties: @@ -736,7 +1647,7 @@ components: description: Immutable and has to be a unique against other VpcInterfaces in this Flow. RoleArn: type: string - description: Role Arn MediaConnect can assumes to create ENIs in customer's account. + description: Role Arn MediaConnect can assume to create ENIs in customer's account. SecurityGroupIds: type: array description: Security Group IDs to be used on ENI. @@ -757,7 +1668,9 @@ components: - SubnetId - SecurityGroupIds x-stackql-resource-name: flow_vpc_interface - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::FlowVpcInterface + x-type-name: AWS::MediaConnect::FlowVpcInterface + x-stackql-primary-identifier: - FlowArn - Name x-create-only-properties: @@ -765,6 +1678,12 @@ components: - Name x-read-only-properties: - NetworkInterfaceIds + x-required-properties: + - FlowArn + - Name + - RoleArn + - SubnetId + - SecurityGroupIds x-required-permissions: create: - iam:PassRole @@ -833,17 +1752,23 @@ components: - EgressCidrBlocks - Networks x-stackql-resource-name: gateway - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaConnect::Gateway + x-type-name: AWS::MediaConnect::Gateway + x-stackql-primary-identifier: - GatewayArn x-create-only-properties: - Name - EgressCidrBlocks - Networks - - Networks/Name - - Networks/CidrBlock x-read-only-properties: - GatewayArn - GatewayState + x-required-properties: + - Name + - EgressCidrBlocks + - Networks + x-tagging: + taggable: false x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -857,19 +1782,558 @@ components: - mediaconnect:DeleteGateway list: - mediaconnect:ListGateways + CreateBridgeOutputRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BridgeArn: + description: The Amazon Resource Number (ARN) of the bridge. + type: string + NetworkOutput: + description: The output of the bridge. + $ref: '#/components/schemas/BridgeNetworkOutput' + Name: + type: string + description: The network output name. + x-stackQL-stringOnly: true + x-title: CreateBridgeOutputRequest + type: object + required: [] + CreateBridgeSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + description: The name of the source. + BridgeArn: + description: The Amazon Resource Number (ARN) of the bridge. + type: string + FlowSource: + $ref: '#/components/schemas/BridgeFlowSource' + NetworkSource: + $ref: '#/components/schemas/BridgeNetworkSource' + x-stackQL-stringOnly: true + x-title: CreateBridgeSourceRequest + type: object + required: [] + CreateBridgeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the bridge. + type: string + BridgeArn: + description: The Amazon Resource Number (ARN) of the bridge. + type: string + PlacementArn: + description: The placement Amazon Resource Number (ARN) of the bridge. + type: string + BridgeState: + $ref: '#/components/schemas/BridgeStateEnum' + SourceFailoverConfig: + $ref: '#/components/schemas/FailoverConfig' + Outputs: + description: The outputs on this bridge. + type: array + minItems: 0 + maxItems: 2 + items: + $ref: '#/components/schemas/BridgeOutput' + x-insertionOrder: true + Sources: + description: The sources on this bridge. + type: array + minItems: 0 + maxItems: 2 + items: + $ref: '#/components/schemas/BridgeSource' + x-insertionOrder: true + IngressGatewayBridge: + type: object + $ref: '#/components/schemas/IngressGatewayBridge' + EgressGatewayBridge: + type: object + $ref: '#/components/schemas/EgressGatewayBridge' + x-stackQL-stringOnly: true + x-title: CreateBridgeRequest + type: object + required: [] + CreateFlowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + description: The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. + type: string + EgressIp: + description: The IP address from which video will be sent to output destinations. + type: string + Name: + description: The name of the flow. + type: string + AvailabilityZone: + description: The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS. + type: string + FlowAvailabilityZone: + description: The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly) + type: string + Source: + description: The source of the flow. + $ref: '#/components/schemas/Source' + SourceFailoverConfig: + description: The source failover config of the flow. + $ref: '#/components/schemas/FailoverConfig' + VpcInterfaces: + type: array + description: The VPC interfaces that you added to this flow. + items: + $ref: '#/components/schemas/VpcInterface' + MediaStreams: + type: array + description: The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow. + items: + $ref: '#/components/schemas/MediaStream' + Maintenance: + description: The maintenance settings you want to use for the flow. + $ref: '#/components/schemas/Maintenance' + SourceMonitoringConfig: + description: The source monitoring config of the flow. + $ref: '#/components/schemas/SourceMonitoringConfig' + FlowSize: + type: string + description: Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow. + enum: + - MEDIUM + - LARGE + NdiConfig: + description: Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. + $ref: '#/components/schemas/NdiConfig' + FlowNdiMachineName: + type: string + description: A prefix for the names of the NDI sources that the flow creates.(ReadOnly) + x-stackQL-stringOnly: true + x-title: CreateFlowRequest + type: object + required: [] + CreateFlowEntitlementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + type: string + description: The ARN of the flow. + EntitlementArn: + type: string + description: The ARN of the entitlement. + DataTransferSubscriberFeePercent: + type: integer + default: 0 + description: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. + Description: + type: string + description: A description of the entitlement. + Encryption: + $ref: '#/components/schemas/Encryption' + description: The type of encryption that will be used on the output that is associated with this entitlement. + EntitlementStatus: + type: string + description: ' An indication of whether the entitlement is enabled.' + enum: + - ENABLED + - DISABLED + Name: + type: string + description: The name of the entitlement. + Subscribers: + type: array + description: The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateFlowEntitlementRequest + type: object + required: [] + CreateFlowOutputRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + description: The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. + type: string + OutputArn: + description: The ARN of the output. + type: string + CidrAllowList: + type: array + description: The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + items: + type: string + Encryption: + $ref: '#/components/schemas/Encryption' + description: The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). + Description: + type: string + description: A description of the output. + Destination: + type: string + description: The address where you want to send the output. + MaxLatency: + type: integer + description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. + MinLatency: + type: integer + description: The minimum latency in milliseconds. + Name: + type: string + description: The name of the output. This value must be unique within the current flow. + Port: + type: integer + description: The port to use when content is distributed to this output. + Protocol: + type: string + enum: + - zixi-push + - rtp-fec + - rtp + - zixi-pull + - rist + - fujitsu-qos + - srt-listener + - srt-caller + - st2110-jpegxs + - cdi + - ndi-speed-hq + description: The protocol that is used by the source or output. + RemoteId: + type: string + description: The remote ID for the Zixi-pull stream. + SmoothingLatency: + type: integer + description: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. + StreamId: + type: string + description: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + VpcInterfaceAttachment: + $ref: '#/components/schemas/VpcInterfaceAttachment' + description: The name of the VPC interface attachment to use for this output. + MediaStreamOutputConfigurations: + type: array + description: The definition for each media stream that is associated with the output. + items: + $ref: '#/components/schemas/MediaStreamOutputConfiguration' + OutputStatus: + type: string + enum: + - ENABLED + - DISABLED + description: An indication of whether the output should transmit data or not. + NdiProgramName: + type: string + description: A suffix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect uses the output name. + NdiSpeedHqQuality: + type: integer + description: A quality setting for the NDI Speed HQ encoder. + x-stackQL-stringOnly: true + x-title: CreateFlowOutputRequest + type: object + required: [] + CreateFlowSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + type: string + description: The ARN of the flow. + SourceArn: + type: string + description: The ARN of the source. + Decryption: + $ref: '#/components/schemas/Encryption' + description: The type of encryption that is used on the content ingested from this source. + Description: + type: string + description: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. + EntitlementArn: + type: string + description: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. + GatewayBridgeSource: + $ref: '#/components/schemas/GatewayBridgeSource' + description: The source configuration for cloud flows receiving a stream from a bridge. + IngestIp: + type: string + description: The IP address that the flow will be listening on for incoming content. + IngestPort: + type: integer + description: The port that the flow will be listening on for incoming content. + MaxBitrate: + type: integer + description: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. + MaxLatency: + type: integer + description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. + MinLatency: + type: integer + description: The minimum latency in milliseconds. + Name: + type: string + description: The name of the source. + Protocol: + type: string + enum: + - zixi-push + - rtp-fec + - rtp + - rist + - srt-listener + - srt-caller + description: The protocol that is used by the source. + SenderIpAddress: + type: string + description: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol. + SenderControlPort: + type: integer + description: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol. + StreamId: + type: string + description: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. + SourceIngestPort: + type: string + description: The port that the flow will be listening on for incoming content.(ReadOnly) + SourceListenerAddress: + type: string + description: Source IP or domain name for SRT-caller protocol. + SourceListenerPort: + type: integer + description: Source port for SRT-caller protocol. + VpcInterfaceName: + type: string + description: The name of the VPC Interface this Source is configured with. + WhitelistCidr: + type: string + description: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + x-stackQL-stringOnly: true + x-title: CreateFlowSourceRequest + type: object + required: [] + CreateFlowVpcInterfaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FlowArn: + type: string + description: The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. + Name: + type: string + description: Immutable and has to be a unique against other VpcInterfaces in this Flow. + RoleArn: + type: string + description: Role Arn MediaConnect can assume to create ENIs in customer's account. + SecurityGroupIds: + type: array + description: Security Group IDs to be used on ENI. + items: + type: string + SubnetId: + type: string + description: Subnet must be in the AZ of the Flow + NetworkInterfaceIds: + type: array + description: IDs of the network interfaces created in customer's account by MediaConnect. + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateFlowVpcInterfaceRequest + type: object + required: [] + CreateGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the gateway. This name can not be modified after the gateway is created. + type: string + GatewayArn: + description: The Amazon Resource Name (ARN) of the gateway. + type: string + GatewayState: + description: The current status of the gateway. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - ERROR + - DELETING + - DELETED + EgressCidrBlocks: + description: The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + type: array + items: + type: string + x-insertionOrder: true + Networks: + type: array + description: The list of networks in the gateway. + minItems: 1 + maxItems: 4 + items: + $ref: '#/components/schemas/GatewayNetwork' + x-insertionOrder: true + x-stackQL-stringOnly: true + x-title: CreateGatewayRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - bridge_output: - name: bridge_output - id: awscc.mediaconnect.bridge_output + bridge_outputs: + name: bridge_outputs + id: awscc.mediaconnect.bridge_outputs x-cfn-schema-name: BridgeOutput - x-type: get + x-cfn-type-name: AWS::MediaConnect::BridgeOutput x-identifiers: - BridgeArn - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BridgeOutput&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::BridgeOutput" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::BridgeOutput" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::BridgeOutput" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -881,7 +2345,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -892,18 +2356,66 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::BridgeOutput' AND data__Identifier = '|' AND region = 'us-east-1' - bridge_source: - name: bridge_source - id: awscc.mediaconnect.bridge_source + bridge_sources: + name: bridge_sources + id: awscc.mediaconnect.bridge_sources x-cfn-schema-name: BridgeSource - x-type: get + x-cfn-type-name: AWS::MediaConnect::BridgeSource x-identifiers: - BridgeArn - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BridgeSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::BridgeSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::BridgeSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::BridgeSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -916,7 +2428,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -932,38 +2444,61 @@ components: name: bridges id: awscc.mediaconnect.bridges x-cfn-schema-name: Bridge - x-type: list - x-identifiers: - - BridgeArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BridgeArn') as bridge_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BridgeArn') as bridge_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' - AND region = 'us-east-1' - bridge: - name: bridge - id: awscc.mediaconnect.bridge - x-cfn-schema-name: Bridge - x-type: get + x-cfn-type-name: AWS::MediaConnect::Bridge x-identifiers: - BridgeArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Bridge&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Bridge" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Bridge" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Bridge" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bridges/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bridges/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bridges/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -981,7 +2516,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -998,13 +2533,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Bridge' AND data__Identifier = '' AND region = 'us-east-1' - flows: - name: flows - id: awscc.mediaconnect.flows - x-cfn-schema-name: Flow - x-type: list + bridges_list_only: + name: bridges_list_only + id: awscc.mediaconnect.bridges_list_only + x-cfn-schema-name: Bridge + x-cfn-type-name: AWS::MediaConnect::Bridge x-identifiers: - - FlowArn + - BridgeArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1012,63 +2553,133 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' + JSON_EXTRACT(Properties, '$.BridgeArn') as bridge_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FlowArn') as flow_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' + json_extract_path_text(Properties, 'BridgeArn') as bridge_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' AND region = 'us-east-1' - flow: - name: flow - id: awscc.mediaconnect.flow + flows: + name: flows + id: awscc.mediaconnect.flows x-cfn-schema-name: Flow - x-type: get + x-cfn-type-name: AWS::MediaConnect::Flow x-identifiers: - FlowArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Flow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Flow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.EgressIp') as egress_ip, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, JSON_EXTRACT(Properties, '$.FlowAvailabilityZone') as flow_availability_zone, JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.SourceFailoverConfig') as source_failover_config + JSON_EXTRACT(Properties, '$.SourceFailoverConfig') as source_failover_config, + JSON_EXTRACT(Properties, '$.VpcInterfaces') as vpc_interfaces, + JSON_EXTRACT(Properties, '$.MediaStreams') as media_streams, + JSON_EXTRACT(Properties, '$.Maintenance') as maintenance, + JSON_EXTRACT(Properties, '$.SourceMonitoringConfig') as source_monitoring_config, + JSON_EXTRACT(Properties, '$.FlowSize') as flow_size, + JSON_EXTRACT(Properties, '$.NdiConfig') as ndi_config, + JSON_EXTRACT(Properties, '$.FlowNdiMachineName') as flow_ndi_machine_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Flow' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'EgressIp') as egress_ip, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, json_extract_path_text(Properties, 'FlowAvailabilityZone') as flow_availability_zone, json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'SourceFailoverConfig') as source_failover_config + json_extract_path_text(Properties, 'SourceFailoverConfig') as source_failover_config, + json_extract_path_text(Properties, 'VpcInterfaces') as vpc_interfaces, + json_extract_path_text(Properties, 'MediaStreams') as media_streams, + json_extract_path_text(Properties, 'Maintenance') as maintenance, + json_extract_path_text(Properties, 'SourceMonitoringConfig') as source_monitoring_config, + json_extract_path_text(Properties, 'FlowSize') as flow_size, + json_extract_path_text(Properties, 'NdiConfig') as ndi_config, + json_extract_path_text(Properties, 'FlowNdiMachineName') as flow_ndi_machine_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Flow' AND data__Identifier = '' AND region = 'us-east-1' - flow_entitlements: - name: flow_entitlements - id: awscc.mediaconnect.flow_entitlements - x-cfn-schema-name: FlowEntitlement - x-type: list + flows_list_only: + name: flows_list_only + id: awscc.mediaconnect.flows_list_only + x-cfn-schema-name: Flow + x-cfn-type-name: AWS::MediaConnect::Flow x-identifiers: - - EntitlementArn + - FlowArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1076,28 +2687,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EntitlementArn') as entitlement_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' + json_extract_path_text(Properties, 'FlowArn') as flow_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' AND region = 'us-east-1' - flow_entitlement: - name: flow_entitlement - id: awscc.mediaconnect.flow_entitlement + flow_entitlements: + name: flow_entitlements + id: awscc.mediaconnect.flow_entitlements x-cfn-schema-name: FlowEntitlement - x-type: get + x-cfn-type-name: AWS::MediaConnect::FlowEntitlement x-identifiers: - EntitlementArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowEntitlement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowEntitlement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowEntitlement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowEntitlement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1114,7 +2773,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1130,13 +2789,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' AND data__Identifier = '' AND region = 'us-east-1' - flow_outputs: - name: flow_outputs - id: awscc.mediaconnect.flow_outputs - x-cfn-schema-name: FlowOutput - x-type: list + flow_entitlements_list_only: + name: flow_entitlements_list_only + id: awscc.mediaconnect.flow_entitlements_list_only + x-cfn-schema-name: FlowEntitlement + x-cfn-type-name: AWS::MediaConnect::FlowEntitlement x-identifiers: - - OutputArn + - EntitlementArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1144,28 +2809,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.OutputArn') as output_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' + JSON_EXTRACT(Properties, '$.EntitlementArn') as entitlement_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'OutputArn') as output_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' + json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' AND region = 'us-east-1' - flow_output: - name: flow_output - id: awscc.mediaconnect.flow_output + flow_outputs: + name: flow_outputs + id: awscc.mediaconnect.flow_outputs x-cfn-schema-name: FlowOutput - x-type: get + x-cfn-type-name: AWS::MediaConnect::FlowOutput x-identifiers: - OutputArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowOutput&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowOutput" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowOutput" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowOutput" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1184,12 +2897,16 @@ components: JSON_EXTRACT(Properties, '$.RemoteId') as remote_id, JSON_EXTRACT(Properties, '$.SmoothingLatency') as smoothing_latency, JSON_EXTRACT(Properties, '$.StreamId') as stream_id, - JSON_EXTRACT(Properties, '$.VpcInterfaceAttachment') as vpc_interface_attachment + JSON_EXTRACT(Properties, '$.VpcInterfaceAttachment') as vpc_interface_attachment, + JSON_EXTRACT(Properties, '$.MediaStreamOutputConfigurations') as media_stream_output_configurations, + JSON_EXTRACT(Properties, '$.OutputStatus') as output_status, + JSON_EXTRACT(Properties, '$.NdiProgramName') as ndi_program_name, + JSON_EXTRACT(Properties, '$.NdiSpeedHqQuality') as ndi_speed_hq_quality FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1208,17 +2925,27 @@ components: json_extract_path_text(Properties, 'RemoteId') as remote_id, json_extract_path_text(Properties, 'SmoothingLatency') as smoothing_latency, json_extract_path_text(Properties, 'StreamId') as stream_id, - json_extract_path_text(Properties, 'VpcInterfaceAttachment') as vpc_interface_attachment + json_extract_path_text(Properties, 'VpcInterfaceAttachment') as vpc_interface_attachment, + json_extract_path_text(Properties, 'MediaStreamOutputConfigurations') as media_stream_output_configurations, + json_extract_path_text(Properties, 'OutputStatus') as output_status, + json_extract_path_text(Properties, 'NdiProgramName') as ndi_program_name, + json_extract_path_text(Properties, 'NdiSpeedHqQuality') as ndi_speed_hq_quality FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' AND data__Identifier = '' AND region = 'us-east-1' - flow_sources: - name: flow_sources - id: awscc.mediaconnect.flow_sources - x-cfn-schema-name: FlowSource - x-type: list + flow_outputs_list_only: + name: flow_outputs_list_only + id: awscc.mediaconnect.flow_outputs_list_only + x-cfn-schema-name: FlowOutput + x-cfn-type-name: AWS::MediaConnect::FlowOutput x-identifiers: - - SourceArn + - OutputArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1226,28 +2953,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SourceArn') as source_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' + JSON_EXTRACT(Properties, '$.OutputArn') as output_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SourceArn') as source_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' + json_extract_path_text(Properties, 'OutputArn') as output_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' AND region = 'us-east-1' - flow_source: - name: flow_source - id: awscc.mediaconnect.flow_source + flow_sources: + name: flow_sources + id: awscc.mediaconnect.flow_sources x-cfn-schema-name: FlowSource - x-type: get + x-cfn-type-name: AWS::MediaConnect::FlowSource x-identifiers: - SourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1277,7 +3052,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1306,14 +3081,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' AND data__Identifier = '' AND region = 'us-east-1' - flow_vpc_interfaces: - name: flow_vpc_interfaces - id: awscc.mediaconnect.flow_vpc_interfaces - x-cfn-schema-name: FlowVpcInterface - x-type: list + flow_sources_list_only: + name: flow_sources_list_only + id: awscc.mediaconnect.flow_sources_list_only + x-cfn-schema-name: FlowSource + x-cfn-type-name: AWS::MediaConnect::FlowSource x-identifiers: - - FlowArn - - Name + - SourceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1321,31 +3101,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' + JSON_EXTRACT(Properties, '$.SourceArn') as source_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' + json_extract_path_text(Properties, 'SourceArn') as source_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' AND region = 'us-east-1' - flow_vpc_interface: - name: flow_vpc_interface - id: awscc.mediaconnect.flow_vpc_interface + flow_vpc_interfaces: + name: flow_vpc_interfaces + id: awscc.mediaconnect.flow_vpc_interfaces x-cfn-schema-name: FlowVpcInterface - x-type: get + x-cfn-type-name: AWS::MediaConnect::FlowVpcInterface x-identifiers: - FlowArn - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FlowVpcInterface&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowVpcInterface" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowVpcInterface" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::FlowVpcInterface" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1360,7 +3186,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1374,13 +3200,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' AND data__Identifier = '|' AND region = 'us-east-1' - gateways: - name: gateways - id: awscc.mediaconnect.gateways - x-cfn-schema-name: Gateway - x-type: list + flow_vpc_interfaces_list_only: + name: flow_vpc_interfaces_list_only + id: awscc.mediaconnect.flow_vpc_interfaces_list_only + x-cfn-schema-name: FlowVpcInterface + x-cfn-type-name: AWS::MediaConnect::FlowVpcInterface x-identifiers: - - GatewayArn + - FlowArn + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1388,28 +3221,65 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GatewayArn') as gateway_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GatewayArn') as gateway_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' AND region = 'us-east-1' - gateway: - name: gateway - id: awscc.mediaconnect.gateway + gateways: + name: gateways + id: awscc.mediaconnect.gateways x-cfn-schema-name: Gateway - x-type: get + x-cfn-type-name: AWS::MediaConnect::Gateway x-identifiers: - GatewayArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Gateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Gateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaConnect::Gateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateways/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1423,7 +3293,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1436,3 +3306,565 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Gateway' AND data__Identifier = '' AND region = 'us-east-1' + gateways_list_only: + name: gateways_list_only + id: awscc.mediaconnect.gateways_list_only + x-cfn-schema-name: Gateway + x-cfn-type-name: AWS::MediaConnect::Gateway + x-identifiers: + - GatewayArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.GatewayArn') as gateway_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GatewayArn') as gateway_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BridgeOutput&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBridgeOutput + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBridgeOutputRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BridgeSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBridgeSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBridgeSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Bridge&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBridge + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBridgeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Flow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowEntitlement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowEntitlement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowEntitlementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowOutput&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowOutput + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowOutputRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FlowVpcInterface&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFlowVpcInterface + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFlowVpcInterfaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Gateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/medialive.yaml b/providers/src/awscc/v00.00.00000/services/medialive.yaml index 4264fce4..0bea6c17 100644 --- a/providers/src/awscc/v00.00.00000/services/medialive.yaml +++ b/providers/src/awscc/v00.00.00000/services/medialive.yaml @@ -1,51 +1,400 @@ openapi: 3.0.0 info: title: MediaLive - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - MultiplexOutputDestination: - description: Multiplex MediaConnect output destination settings. + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object + CancelResourceRequestOutput: properties: - MultiplexMediaConnectOutputDestinationSettings: - description: Multiplex MediaConnect output destination settings. - properties: - EntitlementArn: - type: string - description: The MediaConnect entitlement ARN available as a Flow source. - minLength: 1 - additionalProperties: false - additionalProperties: false - MultiplexSettings: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object - description: A key-value pair to associate with a resource. + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: properties: - MaximumVideoBufferDelayMilliseconds: - type: integer - description: Maximum video buffer delay in milliseconds. - minimum: 800 - maximum: 3000 - TransportStreamBitrate: - type: integer - description: Transport stream bit rate. - minimum: 1000000 - maximum: 100000000 - TransportStreamId: - type: integer - description: Transport stream ID. - minimum: 0 - maximum: 65535 - TransportStreamReservedBitrate: - type: integer - description: Transport stream reserved bit rate. - minimum: 0 - maximum: 100000000 + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string required: - - TransportStreamBitrate - - TransportStreamId - additionalProperties: false + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ChannelPlacementGroupState: + type: string + description: The current state of the ChannelPlacementGroupState + enum: + - UNASSIGNED + - ASSIGNING + - ASSIGNED + - DELETING + - DELETED + - UNASSIGNING Tags: description: A key-value pair to associate with a resource. type: object @@ -55,296 +404,2991 @@ components: Value: type: string additionalProperties: false - Multiplex: + ChannelPlacementGroup: type: object properties: Arn: type: string - description: The unique arn of the multiplex. - AvailabilityZones: - description: A list of availability zones for the multiplex. + description: The ARN of the channel placement group. + Channels: type: array x-insertionOrder: false + description: List of channel IDs added to the channel placement group. items: type: string - Destinations: - description: A list of the multiplex output destinations. - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/MultiplexOutputDestination' + ClusterId: + type: string + description: The ID of the cluster the node is on. Id: type: string - description: The unique id of the multiplex. - MultiplexSettings: - $ref: '#/components/schemas/MultiplexSettings' - description: Configuration for a multiplex event. + description: Unique internal identifier. Name: type: string - description: Name of multiplex. - PipelinesRunningCount: - type: integer - description: The number of currently healthy pipelines. - ProgramCount: - type: integer - description: The number of programs in the multiplex. + description: The name of the channel placement group. + Nodes: + type: array + x-insertionOrder: false + description: List of nodes added to the channel placement group + items: + type: string State: - type: string - enum: - - CREATING - - CREATE_FAILED - - IDLE - - STARTING - - RUNNING - - RECOVERING - - STOPPING - - DELETING - - DELETED + $ref: '#/components/schemas/ChannelPlacementGroupState' Tags: description: A collection of key-value pairs. type: array x-insertionOrder: false items: $ref: '#/components/schemas/Tags' - required: - - AvailabilityZones - - MultiplexSettings - - Name - x-stackql-resource-name: multiplex - x-stackql-primaryIdentifier: + x-stackql-resource-name: channel_placement_group + description: Definition of AWS::MediaLive::ChannelPlacementGroup Resource Type + x-type-name: AWS::MediaLive::ChannelPlacementGroup + x-stackql-primary-identifier: - Id + - ClusterId x-create-only-properties: - - AvailabilityZones + - ClusterId x-read-only-properties: - Arn + - Channels - Id - - PipelinesRunningCount - - ProgramCount - State + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags x-required-permissions: create: - - medialive:CreateMultiplex - - medialive:DescribeMultiplex + - medialive:CreateChannelPlacementGroup + - medialive:DescribeChannelPlacementGroup - medialive:CreateTags + - medialive:ListTagsForResource read: - - medialive:DescribeMultiplex + - medialive:DescribeChannelPlacementGroup + - medialive:ListTagsForResource update: - - medialive:UpdateMultiplex - - medialive:DescribeMultiplex + - medialive:UpdateChannelPlacementGroup + - medialive:DescribeChannelPlacementGroup - medialive:CreateTags - medialive:DeleteTags + - medialive:ListTagsForResource delete: - - medialive:DeleteMultiplex - - medialive:DescribeMultiplex + - medialive:DeleteChannelPlacementGroup + - medialive:DescribeChannelPlacementGroup list: - - medialive:ListMultiplexes - MultiplexProgramSettings: - description: Multiplex Program settings configuration. + - medialive:ListChannelPlacementGroups + CloudWatchAlarmTemplateComparisonOperator: + type: string + description: The comparison operator used to compare the specified statistic and the threshold. + enum: + - GreaterThanOrEqualToThreshold + - GreaterThanThreshold + - LessThanThreshold + - LessThanOrEqualToThreshold + CloudWatchAlarmTemplateStatistic: + type: string + description: The statistic to apply to the alarm's metric data. + enum: + - SampleCount + - Average + - Sum + - Minimum + - Maximum + CloudWatchAlarmTemplateTargetResourceType: + type: string + description: The resource type this template should dynamically generate cloudwatch metric alarms for. + enum: + - CLOUDFRONT_DISTRIBUTION + - MEDIALIVE_MULTIPLEX + - MEDIALIVE_CHANNEL + - MEDIALIVE_INPUT_DEVICE + - MEDIAPACKAGE_CHANNEL + - MEDIAPACKAGE_ORIGIN_ENDPOINT + - MEDIACONNECT_FLOW + - MEDIATAILOR_PLAYBACK_CONFIGURATION + - S3_BUCKET + CloudWatchAlarmTemplateTreatMissingData: + type: string + description: Specifies how missing data points are treated when evaluating the alarm's condition. + enum: + - notBreaching + - breaching + - ignore + - missing + TagMap: type: object - properties: - PreferredChannelPipeline: + description: Represents the tags associated with a resource. + x-patternProperties: + .+: type: string - $ref: '#/components/schemas/PreferredChannelPipeline' - ProgramNumber: - type: integer - description: Unique program number. - minimum: 0 - maximum: 65535 - ServiceDescriptor: - $ref: '#/components/schemas/MultiplexProgramServiceDescriptor' - description: Transport stream service descriptor configuration for the Multiplex program. - VideoSettings: - $ref: '#/components/schemas/MultiplexVideoSettings' - description: Program video settings configuration. - required: - - ProgramNumber additionalProperties: false - PreferredChannelPipeline: - type: string - description: | - Indicates which pipeline is preferred by the multiplex for program ingest. - If set to \"PIPELINE_0\" or \"PIPELINE_1\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline, - it will switch back once that ingest is healthy again. If set to \"CURRENTLY_ACTIVE\", - it will not switch back to the other pipeline based on it recovering to a healthy state, - it will only switch if the active pipeline becomes unhealthy. - enum: - - CURRENTLY_ACTIVE - - PIPELINE_0 - - PIPELINE_1 - MultiplexProgramServiceDescriptor: - description: Transport stream service descriptor configuration for the Multiplex program. + CloudWatchAlarmTemplate: type: object properties: - ProviderName: + Arn: type: string - description: Name of the provider. - minLength: 1 - maxLength: 256 - ServiceName: + pattern: ^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$ + description: A cloudwatch alarm template's ARN (Amazon Resource Name) + ComparisonOperator: + $ref: '#/components/schemas/CloudWatchAlarmTemplateComparisonOperator' + CreatedAt: type: string - description: Name of the service. + format: date-time + DatapointsToAlarm: + type: number + default: 0 + minimum: 1 + description: The number of datapoints within the evaluation period that must be breaching to trigger the alarm. + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + EvaluationPeriods: + type: number + default: 0 + minimum: 1 + description: The number of periods over which data is compared to the specified threshold. + GroupId: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` + GroupIdentifier: + type: string + pattern: ^[^\s]+$ + description: A cloudwatch alarm template group's identifier. Can be either be its id or current name. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-` + Identifier: + type: string + MetricName: + type: string + maxLength: 64 + minLength: 0 + description: The name of the metric associated with the alarm. Must be compatible with targetResourceType. + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 minLength: 1 - maxLength: 256 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Period: + type: number + default: 0 + maximum: 86400 + minimum: 10 + description: The period, in seconds, over which the specified statistic is applied. + Statistic: + $ref: '#/components/schemas/CloudWatchAlarmTemplateStatistic' + Tags: + $ref: '#/components/schemas/TagMap' + TargetResourceType: + $ref: '#/components/schemas/CloudWatchAlarmTemplateTargetResourceType' + Threshold: + type: number + default: 0 + description: The threshold value to compare with the specified statistic. + TreatMissingData: + $ref: '#/components/schemas/CloudWatchAlarmTemplateTreatMissingData' required: - - ProviderName - - ServiceName - additionalProperties: false - MultiplexVideoSettings: - description: The video configuration for each program in a multiplex. - type: object - oneOf: - - type: object - properties: - ConstantBitrate: - type: integer - description: |- - The constant bitrate configuration for the video encode. - When this field is defined, StatmuxSettings must be undefined. - minimum: 100000 - maximum: 100000000 - required: - - ConstantBitrate - additionalProperties: false - - type: object - properties: - StatmuxSettings: - description: |- - Statmux rate control settings. - When this field is defined, ConstantBitrate must be undefined. - $ref: '#/components/schemas/MultiplexStatmuxVideoSettings' - required: - - StatmuxSettings - additionalProperties: false - MultiplexStatmuxVideoSettings: - description: Statmux rate control settings + - ComparisonOperator + - EvaluationPeriods + - MetricName + - Name + - Period + - Statistic + - TargetResourceType + - Threshold + - TreatMissingData + x-stackql-resource-name: cloud_watch_alarm_template + description: Definition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type + x-type-name: AWS::MediaLive::CloudWatchAlarmTemplate + x-stackql-primary-identifier: + - Identifier + x-create-only-properties: + - Tags + x-write-only-properties: + - GroupIdentifier + x-read-only-properties: + - Arn + - CreatedAt + - Id + - GroupId + - Identifier + - ModifiedAt + x-required-properties: + - ComparisonOperator + - EvaluationPeriods + - MetricName + - Name + - Period + - Statistic + - TargetResourceType + - Threshold + - TreatMissingData + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateCloudWatchAlarmTemplate + - medialive:GetCloudWatchAlarmTemplate + - medialive:CreateTags + read: + - medialive:GetCloudWatchAlarmTemplate + update: + - medialive:UpdateCloudWatchAlarmTemplate + - medialive:GetCloudWatchAlarmTemplate + - medialive:CreateTags + - medialive:DeleteTags + delete: + - medialive:DeleteCloudWatchAlarmTemplate + list: + - medialive:ListCloudWatchAlarmTemplates + CloudWatchAlarmTemplateGroup: type: object properties: - MaximumBitrate: - type: integer - description: Maximum statmux bitrate. - minimum: 100000 - maximum: 100000000 - MinimumBitrate: - type: integer - description: Minimum statmux bitrate. - minimum: 100000 - maximum: 100000000 - Priority: - type: integer - description: The purpose of the priority is to use a combination of the\nmultiplex rate control algorithm and the QVBR capability of the\nencoder to prioritize the video quality of some channels in a\nmultiplex over others. Channels that have a higher priority will\nget higher video quality at the expense of the video quality of\nother channels in the multiplex with lower priority. - minimum: -5 - maximum: 5 - additionalProperties: false - MultiplexProgramPacketIdentifiersMap: - description: Packet identifiers map for a given Multiplex program. + Arn: + type: string + pattern: ^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$ + description: A cloudwatch alarm template group's ARN (Amazon Resource Name) + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` + Identifier: + type: string + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Tags: + $ref: '#/components/schemas/TagMap' + required: + - Name + x-stackql-resource-name: cloud_watch_alarm_template_group + description: Definition of AWS::MediaLive::CloudWatchAlarmTemplateGroup Resource Type + x-type-name: AWS::MediaLive::CloudWatchAlarmTemplateGroup + x-stackql-primary-identifier: + - Identifier + x-create-only-properties: + - Name + - Tags + x-read-only-properties: + - Arn + - CreatedAt + - Id + - Identifier + - ModifiedAt + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateCloudWatchAlarmTemplateGroup + - medialive:GetCloudWatchAlarmTemplateGroup + - medialive:CreateTags + read: + - medialive:GetCloudWatchAlarmTemplateGroup + update: + - medialive:UpdateCloudWatchAlarmTemplateGroup + - medialive:GetCloudWatchAlarmTemplateGroup + - medialive:CreateTags + - medialive:DeleteTags + delete: + - medialive:DeleteCloudWatchAlarmTemplateGroup + list: + - medialive:ListCloudWatchAlarmTemplateGroups + ClusterNetworkSettings: type: object + description: On premises settings which will have the interface network mappings and default Output logical interface properties: - AudioPids: - type: array - items: - type: integer - x-insertionOrder: true - DvbSubPids: + DefaultRoute: + type: string + description: Default value if the customer does not define it in channel Output API + InterfaceMappings: type: array + x-insertionOrder: false items: - type: integer - x-insertionOrder: true - DvbTeletextPid: - type: integer - EtvPlatformPid: - type: integer - EtvSignalPid: - type: integer - KlvDataPids: + $ref: '#/components/schemas/InterfaceMapping' + description: Network mappings for the cluster + additionalProperties: false + ClusterState: + type: string + description: The current state of the Cluster. + enum: + - CREATING + - CREATE_FAILED + - ACTIVE + - DELETING + - DELETED + ClusterType: + type: string + description: The hardware type for the cluster. + enum: + - ON_PREMISES + - OUTPOSTS_RACK + - OUTPOSTS_SERVER + - EC2 + InterfaceMapping: + type: object + description: Network mappings for the cluster + properties: + LogicalInterfaceName: + type: string + description: logical interface name, unique in the list + NetworkId: + type: string + description: Network Id to be associated with the logical interface name, can be duplicated in list + additionalProperties: false + InterfaceNetworkMapping: + type: object + description: Network mappings for the cluster + properties: + LogicalInterfaceName: + type: string + description: logical interface name, unique in the list + NetworkId: + type: string + description: Network Id to be associated with the logical interface name, can be duplicated in list + additionalProperties: false + Cluster: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:cluster:.+$ + description: The ARN of the Cluster. + ChannelIds: type: array + x-insertionOrder: false items: - type: integer - x-insertionOrder: true - PcrPid: - type: integer - PmtPid: - type: integer - PrivateMetadataPid: - type: integer - Scte27Pids: + type: string + description: MediaLive Channel Ids + description: The MediaLive Channels that are currently running on Nodes in this Cluster. + ClusterType: + $ref: '#/components/schemas/ClusterType' + Id: + type: string + description: The unique ID of the Cluster. + InstanceRoleArn: + type: string + pattern: ^arn:.+:iam:.+:role/.+$ + description: The IAM role your nodes will use. + Name: + type: string + description: The user-specified name of the Cluster to be created. + NetworkSettings: + $ref: '#/components/schemas/ClusterNetworkSettings' + State: + $ref: '#/components/schemas/ClusterState' + Tags: + description: A collection of key-value pairs. type: array + x-insertionOrder: false items: - type: integer - x-insertionOrder: true - Scte35Pid: - type: integer - TimedMetadataPid: - type: integer - VideoPid: - type: integer - additionalProperties: false - MultiplexProgramPipelineDetail: - description: The current source for one of the pipelines in the multiplex. + $ref: '#/components/schemas/Tags' + x-stackql-resource-name: cluster + description: Definition of AWS::MediaLive::Cluster Resource Type + x-type-name: AWS::MediaLive::Cluster + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - ClusterType + - InstanceRoleArn + x-read-only-properties: + - Arn + - ChannelIds + - Id + - State + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateCluster + - medialive:DescribeCluster + - medialive:CreateTags + - ecs:CreateCluster + - ecs:RegisterTaskDefinition + - ecs:TagResource + - ecs:CreateService + - iam:PassRole + - medialive:ListTagsForResource + read: + - medialive:DescribeCluster + - medialive:ListTagsForResource + update: + - medialive:UpdateCluster + - medialive:DescribeCluster + - medialive:CreateTags + - medialive:DeleteTags + - medialive:ListTagsForResource + delete: + - medialive:DeleteCluster + - medialive:DescribeCluster + - ecs:DeleteService + list: + - medialive:ListClusters + EventBridgeRuleTemplateEventType: + type: string + description: The type of event to match with the rule. + enum: + - MEDIALIVE_MULTIPLEX_ALERT + - MEDIALIVE_MULTIPLEX_STATE_CHANGE + - MEDIALIVE_CHANNEL_ALERT + - MEDIALIVE_CHANNEL_INPUT_CHANGE + - MEDIALIVE_CHANNEL_STATE_CHANGE + - MEDIAPACKAGE_INPUT_NOTIFICATION + - MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION + - MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION + - SIGNAL_MAP_ACTIVE_ALARM + - MEDIACONNECT_ALERT + - MEDIACONNECT_SOURCE_HEALTH + - MEDIACONNECT_OUTPUT_HEALTH + - MEDIACONNECT_FLOW_STATUS_CHANGE + EventBridgeRuleTemplateTarget: type: object + description: The target to which to send matching events. properties: - ActiveChannelPipeline: - type: string - description: Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex. - PipelineId: + Arn: type: string - description: Identifies a specific pipeline in the multiplex. + maxLength: 2048 + minLength: 1 + pattern: ^arn.+$ + description: Target ARNs must be either an SNS topic or CloudWatch log group. + required: + - Arn additionalProperties: false - Multiplexprogram: + EventBridgeRuleTemplate: type: object properties: - ChannelId: + Arn: type: string - description: The MediaLive channel associated with the program. - MultiplexId: + pattern: ^arn:.+:medialive:.+:eventbridge-rule-template:.+$ + description: An eventbridge rule template's ARN (Amazon Resource Name) + CreatedAt: type: string - description: The ID of the multiplex that the program belongs to. - MultiplexProgramSettings: - description: The settings for this multiplex program. - $ref: '#/components/schemas/MultiplexProgramSettings' - PreferredChannelPipeline: - description: The settings for this multiplex program. - $ref: '#/components/schemas/PreferredChannelPipeline' - PacketIdentifiersMap: - $ref: '#/components/schemas/MultiplexProgramPacketIdentifiersMap' - description: The packet identifier map for this multiplex program. - PipelineDetails: - description: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time. + description: Placeholder documentation for __timestampIso8601 + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + EventTargets: type: array items: - $ref: '#/components/schemas/MultiplexProgramPipelineDetail' - x-insertionOrder: true - ProgramName: + $ref: '#/components/schemas/EventBridgeRuleTemplateTarget' + description: Placeholder documentation for __listOfEventBridgeRuleTemplateTarget + EventType: + $ref: '#/components/schemas/EventBridgeRuleTemplateEventType' + GroupId: type: string - description: The name of the multiplex program. - x-stackql-resource-name: multiplexprogram - x-stackql-primaryIdentifier: - - ProgramName - - MultiplexId + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` + GroupIdentifier: + type: string + pattern: ^[^\s]+$ + description: An eventbridge rule template group's identifier. Can be either be its id or current name. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: An eventbridge rule template's id. AWS provided templates have ids that start with `aws-` + Identifier: + type: string + description: Placeholder documentation for __string + ModifiedAt: + type: string + description: Placeholder documentation for __timestampIso8601 + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Tags: + $ref: '#/components/schemas/TagMap' + required: + - EventType + - Name + x-stackql-resource-name: event_bridge_rule_template + description: Definition of AWS::MediaLive::EventBridgeRuleTemplate Resource Type + x-type-name: AWS::MediaLive::EventBridgeRuleTemplate + x-stackql-primary-identifier: + - Identifier x-create-only-properties: - - ProgramName - - MultiplexId + - Tags + x-write-only-properties: + - GroupIdentifier + x-read-only-properties: + - Arn + - CreatedAt + - GroupId + - Id + - Identifier + - ModifiedAt + x-required-properties: + - EventType + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags x-required-permissions: create: - - medialive:CreateMultiplexProgram - - medialive:DescribeMultiplexProgram + - medialive:CreateEventBridgeRuleTemplate + - medialive:GetEventBridgeRuleTemplate + - medialive:CreateTags read: - - medialive:DescribeMultiplexProgram + - medialive:GetEventBridgeRuleTemplate update: - - medialive:UpdateMultiplexProgram - - medialive:DescribeMultiplexProgram + - medialive:UpdateEventBridgeRuleTemplate + - medialive:GetEventBridgeRuleTemplate + - medialive:CreateTags + - medialive:DeleteTags delete: - - medialive:DeleteMultiplexProgram - - medialive:DescribeMultiplexProgram + - medialive:DeleteEventBridgeRuleTemplate list: - - medialive:ListMultiplexPrograms - x-stackQL-resources: - multiplexes: - name: multiplexes - id: awscc.medialive.multiplexes - x-cfn-schema-name: Multiplex - x-type: list + - medialive:ListEventBridgeRuleTemplates + EventBridgeRuleTemplateGroup: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$ + description: An eventbridge rule template group's ARN (Amazon Resource Name) + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` + Identifier: + type: string + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Tags: + $ref: '#/components/schemas/TagMap' + required: + - Name + x-stackql-resource-name: event_bridge_rule_template_group + description: Definition of AWS::MediaLive::EventBridgeRuleTemplateGroup Resource Type + x-type-name: AWS::MediaLive::EventBridgeRuleTemplateGroup + x-stackql-primary-identifier: + - Identifier + x-create-only-properties: + - Name + - Tags + x-read-only-properties: + - Arn + - CreatedAt + - Id + - Identifier + - ModifiedAt + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateEventBridgeRuleTemplateGroup + - medialive:GetEventBridgeRuleTemplateGroup + - medialive:CreateTags + read: + - medialive:GetEventBridgeRuleTemplateGroup + update: + - medialive:UpdateEventBridgeRuleTemplateGroup + - medialive:GetEventBridgeRuleTemplateGroup + - medialive:CreateTags + - medialive:DeleteTags + delete: + - medialive:DeleteEventBridgeRuleTemplateGroup + list: + - medialive:ListEventBridgeRuleTemplateGroups + MultiplexOutputDestination: + description: Multiplex MediaConnect output destination settings. + type: object + properties: + MultiplexMediaConnectOutputDestinationSettings: + description: Multiplex MediaConnect output destination settings. + properties: + EntitlementArn: + type: string + description: The MediaConnect entitlement ARN available as a Flow source. + minLength: 1 + additionalProperties: false + additionalProperties: false + MultiplexSettings: + type: object + description: A key-value pair to associate with a resource. + properties: + MaximumVideoBufferDelayMilliseconds: + type: integer + description: Maximum video buffer delay in milliseconds. + minimum: 800 + maximum: 3000 + TransportStreamBitrate: + type: integer + description: Transport stream bit rate. + minimum: 1000000 + maximum: 100000000 + TransportStreamId: + type: integer + description: Transport stream ID. + minimum: 0 + maximum: 65535 + TransportStreamReservedBitrate: + type: integer + description: Transport stream reserved bit rate. + minimum: 0 + maximum: 100000000 + required: + - TransportStreamBitrate + - TransportStreamId + additionalProperties: false + Multiplex: + type: object + properties: + Arn: + type: string + description: The unique arn of the multiplex. + AvailabilityZones: + description: A list of availability zones for the multiplex. + type: array + x-insertionOrder: false + items: + type: string + Destinations: + description: A list of the multiplex output destinations. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/MultiplexOutputDestination' + Id: + type: string + description: The unique id of the multiplex. + MultiplexSettings: + $ref: '#/components/schemas/MultiplexSettings' + description: Configuration for a multiplex event. + Name: + type: string + description: Name of multiplex. + PipelinesRunningCount: + type: integer + description: The number of currently healthy pipelines. + ProgramCount: + type: integer + description: The number of programs in the multiplex. + State: + type: string + enum: + - CREATING + - CREATE_FAILED + - IDLE + - STARTING + - RUNNING + - RECOVERING + - STOPPING + - DELETING + - DELETED + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + required: + - AvailabilityZones + - MultiplexSettings + - Name + x-stackql-resource-name: multiplex + description: Resource schema for AWS::MediaLive::Multiplex + x-type-name: AWS::MediaLive::Multiplex + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - AvailabilityZones + x-read-only-properties: + - Arn + - Id + - PipelinesRunningCount + - ProgramCount + - State + x-required-properties: + - AvailabilityZones + - MultiplexSettings + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateMultiplex + - medialive:DescribeMultiplex + - medialive:CreateTags + read: + - medialive:DescribeMultiplex + update: + - medialive:UpdateMultiplex + - medialive:DescribeMultiplex + - medialive:CreateTags + - medialive:DeleteTags + delete: + - medialive:DeleteMultiplex + - medialive:DescribeMultiplex + list: + - medialive:ListMultiplexes + MultiplexProgramSettings: + description: Multiplex Program settings configuration. + type: object + properties: + PreferredChannelPipeline: + type: string + $ref: '#/components/schemas/PreferredChannelPipeline' + ProgramNumber: + type: integer + description: Unique program number. + minimum: 0 + maximum: 65535 + ServiceDescriptor: + $ref: '#/components/schemas/MultiplexProgramServiceDescriptor' + description: Transport stream service descriptor configuration for the Multiplex program. + VideoSettings: + $ref: '#/components/schemas/MultiplexVideoSettings' + description: Program video settings configuration. + required: + - ProgramNumber + additionalProperties: false + PreferredChannelPipeline: + type: string + description: | + Indicates which pipeline is preferred by the multiplex for program ingest. + If set to \"PIPELINE_0\" or \"PIPELINE_1\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline, + it will switch back once that ingest is healthy again. If set to \"CURRENTLY_ACTIVE\", + it will not switch back to the other pipeline based on it recovering to a healthy state, + it will only switch if the active pipeline becomes unhealthy. + enum: + - CURRENTLY_ACTIVE + - PIPELINE_0 + - PIPELINE_1 + MultiplexProgramServiceDescriptor: + description: Transport stream service descriptor configuration for the Multiplex program. + type: object + properties: + ProviderName: + type: string + description: Name of the provider. + minLength: 1 + maxLength: 256 + ServiceName: + type: string + description: Name of the service. + minLength: 1 + maxLength: 256 + required: + - ProviderName + - ServiceName + additionalProperties: false + MultiplexVideoSettings: + description: The video configuration for each program in a multiplex. + type: object + oneOf: + - type: object + properties: + ConstantBitrate: + type: integer + description: |- + The constant bitrate configuration for the video encode. + When this field is defined, StatmuxSettings must be undefined. + minimum: 100000 + maximum: 100000000 + required: + - ConstantBitrate + additionalProperties: false + - type: object + properties: + StatmuxSettings: + description: |- + Statmux rate control settings. + When this field is defined, ConstantBitrate must be undefined. + $ref: '#/components/schemas/MultiplexStatmuxVideoSettings' + required: + - StatmuxSettings + additionalProperties: false + MultiplexStatmuxVideoSettings: + description: Statmux rate control settings + type: object + properties: + MaximumBitrate: + type: integer + description: Maximum statmux bitrate. + minimum: 100000 + maximum: 100000000 + MinimumBitrate: + type: integer + description: Minimum statmux bitrate. + minimum: 100000 + maximum: 100000000 + Priority: + type: integer + description: The purpose of the priority is to use a combination of the\nmultiplex rate control algorithm and the QVBR capability of the\nencoder to prioritize the video quality of some channels in a\nmultiplex over others. Channels that have a higher priority will\nget higher video quality at the expense of the video quality of\nother channels in the multiplex with lower priority. + minimum: -5 + maximum: 5 + additionalProperties: false + MultiplexProgramPacketIdentifiersMap: + description: Packet identifiers map for a given Multiplex program. + type: object + properties: + AudioPids: + type: array + items: + type: integer + x-insertionOrder: true + DvbSubPids: + type: array + items: + type: integer + x-insertionOrder: true + DvbTeletextPid: + type: integer + EtvPlatformPid: + type: integer + EtvSignalPid: + type: integer + KlvDataPids: + type: array + items: + type: integer + x-insertionOrder: true + PcrPid: + type: integer + PmtPid: + type: integer + PrivateMetadataPid: + type: integer + Scte27Pids: + type: array + items: + type: integer + x-insertionOrder: true + Scte35Pid: + type: integer + TimedMetadataPid: + type: integer + VideoPid: + type: integer + additionalProperties: false + MultiplexProgramPipelineDetail: + description: The current source for one of the pipelines in the multiplex. + type: object + properties: + ActiveChannelPipeline: + type: string + description: Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex. + PipelineId: + type: string + description: Identifies a specific pipeline in the multiplex. + additionalProperties: false + Multiplexprogram: + type: object + properties: + ChannelId: + type: string + description: The MediaLive channel associated with the program. + MultiplexId: + type: string + description: The ID of the multiplex that the program belongs to. + MultiplexProgramSettings: + description: The settings for this multiplex program. + $ref: '#/components/schemas/MultiplexProgramSettings' + PreferredChannelPipeline: + description: The settings for this multiplex program. + $ref: '#/components/schemas/PreferredChannelPipeline' + PacketIdentifiersMap: + $ref: '#/components/schemas/MultiplexProgramPacketIdentifiersMap' + description: The packet identifier map for this multiplex program. + PipelineDetails: + description: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time. + type: array + items: + $ref: '#/components/schemas/MultiplexProgramPipelineDetail' + x-insertionOrder: true + ProgramName: + type: string + description: The name of the multiplex program. + x-stackql-resource-name: multiplexprogram + description: Resource schema for AWS::MediaLive::Multiplexprogram + x-type-name: AWS::MediaLive::Multiplexprogram + x-stackql-primary-identifier: + - ProgramName + - MultiplexId + x-create-only-properties: + - ProgramName + - MultiplexId + x-write-only-properties: + - PreferredChannelPipeline + x-read-only-properties: + - ChannelId + x-tagging: + taggable: false + x-required-permissions: + create: + - medialive:CreateMultiplexProgram + - medialive:DescribeMultiplexProgram + read: + - medialive:DescribeMultiplexProgram + update: + - medialive:UpdateMultiplexProgram + - medialive:DescribeMultiplexProgram + delete: + - medialive:DeleteMultiplexProgram + - medialive:DescribeMultiplexProgram + list: + - medialive:ListMultiplexPrograms + IpPool: + type: object + description: IP address cidr pool + properties: + Cidr: + type: string + description: IP address cidr pool + additionalProperties: false + NetworkState: + type: string + enum: + - CREATING + - CREATE_FAILED + - ACTIVE + - DELETING + - IDLE + - IN_USE + - UPDATING + - DELETED + - DELETE_FAILED + Route: + type: object + properties: + Cidr: + type: string + description: Ip address cidr + Gateway: + type: string + description: IP address for the route packet paths + additionalProperties: false + Network: + type: object + properties: + Arn: + type: string + description: The ARN of the Network. + AssociatedClusterIds: + type: array + x-insertionOrder: false + items: + type: string + description: Cluster Ids which have this network ID in their Interface Network Mappings + Id: + type: string + description: The unique ID of the Network. + IpPools: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpPool' + description: The list of IP address cidr pools for the network + Name: + type: string + description: The user-specified name of the Network to be created. + Routes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Route' + description: The routes for the network + State: + $ref: '#/components/schemas/NetworkState' + description: The current state of the Network. + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + required: + - Name + - IpPools + x-stackql-resource-name: network + description: Resource schema for AWS::MediaLive::Network. + x-type-name: AWS::MediaLive::Network + x-stackql-primary-identifier: + - Id + x-read-only-properties: + - Arn + - Id + - State + - AssociatedClusterIds + x-required-properties: + - Name + - IpPools + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateNetwork + - medialive:CreateTags + - medialive:DescribeNetwork + - medialive:ListTagsForResource + read: + - medialive:DescribeNetwork + - medialive:ListTagsForResource + update: + - medialive:UpdateNetwork + - medialive:CreateTags + - medialive:DeleteTags + - medialive:DescribeNetwork + - medialive:ListTagsForResource + delete: + - medialive:DeleteNetwork + - medialive:DescribeNetwork + list: + - medialive:ListNetworks + SdiSourceMode: + type: string + description: The current state of the SdiSource. + enum: + - QUADRANT + - INTERLEAVE + SdiSourceState: + type: string + description: The current state of the SdiSource. + enum: + - IDLE + - IN_USE + - DELETED + SdiSourceType: + type: string + description: The interface mode of the SdiSource. + enum: + - SINGLE + - QUAD + SdiSource: + type: object + properties: + Arn: + type: string + description: The unique arn of the SdiSource. + Id: + type: string + description: The unique identifier of the SdiSource. + Mode: + $ref: '#/components/schemas/SdiSourceMode' + Name: + type: string + description: The name of the SdiSource. + State: + $ref: '#/components/schemas/SdiSourceState' + Type: + $ref: '#/components/schemas/SdiSourceType' + Inputs: + description: The list of inputs currently using this SDI source. + type: array + x-insertionOrder: false + items: + type: string + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + required: + - Name + - Type + x-stackql-resource-name: sdi_source + description: Definition of AWS::MediaLive::SdiSource Resource Type + x-type-name: AWS::MediaLive::SdiSource + x-stackql-primary-identifier: + - Id + x-read-only-properties: + - Id + - State + - Arn + - Inputs + x-required-properties: + - Name + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateSdiSource + - medialive:CreateTags + - medialive:DescribeSdiSource + - medialive:ListTagsForResource + read: + - medialive:DescribeSdiSource + - medialive:ListTagsForResource + update: + - medialive:UpdateSdiSource + - medialive:DescribeSdiSource + - medialive:CreateTags + - medialive:DeleteTags + - medialive:ListTagsForResource + delete: + - medialive:DeleteSdiSource + - medialive:DescribeSdiSource + list: + - medialive:ListSdiSources + FailedMediaResourceMap: + type: object + description: A map representing an incomplete AWS media workflow as a graph. + x-patternProperties: + .+: + $ref: '#/components/schemas/MediaResource' + additionalProperties: false + MediaResource: + type: object + description: An AWS resource used in media workflows. + properties: + Destinations: + type: array + items: + $ref: '#/components/schemas/MediaResourceNeighbor' + Name: + type: string + maxLength: 256 + minLength: 0 + description: The logical name of an AWS media resource. + Sources: + type: array + items: + $ref: '#/components/schemas/MediaResourceNeighbor' + additionalProperties: false + MediaResourceMap: + type: object + description: A map representing an AWS media workflow as a graph. + x-patternProperties: + .+: + $ref: '#/components/schemas/MediaResource' + additionalProperties: false + MediaResourceNeighbor: + type: object + description: A direct source or destination neighbor to an AWS media resource. + properties: + Arn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn.+$ + description: The ARN of a resource used in AWS media workflows. + Name: + type: string + maxLength: 256 + minLength: 0 + description: The logical name of an AWS media resource. + required: + - Arn + additionalProperties: false + MonitorDeployment: + type: object + description: Represents the latest monitor deployment of a signal map. + properties: + DetailsUri: + type: string + maxLength: 2048 + minLength: 0 + description: URI associated with a signal map's monitor deployment. + ErrorMessage: + type: string + maxLength: 2048 + minLength: 0 + description: Error message associated with a failed monitor deployment of a signal map. + Status: + $ref: '#/components/schemas/SignalMapMonitorDeploymentStatus' + required: + - Status + additionalProperties: false + SignalMapMonitorDeploymentStatus: + type: string + description: A signal map's monitor deployment status. + enum: + - NOT_DEPLOYED + - DRY_RUN_DEPLOYMENT_COMPLETE + - DRY_RUN_DEPLOYMENT_FAILED + - DRY_RUN_DEPLOYMENT_IN_PROGRESS + - DEPLOYMENT_COMPLETE + - DEPLOYMENT_FAILED + - DEPLOYMENT_IN_PROGRESS + - DELETE_COMPLETE + - DELETE_FAILED + - DELETE_IN_PROGRESS + SignalMapStatus: + type: string + description: A signal map's current status which is dependent on its lifecycle actions or associated jobs. + enum: + - CREATE_IN_PROGRESS + - CREATE_COMPLETE + - CREATE_FAILED + - UPDATE_IN_PROGRESS + - UPDATE_COMPLETE + - UPDATE_REVERTED + - UPDATE_FAILED + - READY + - NOT_READY + SuccessfulMonitorDeployment: + type: object + description: Represents the latest successful monitor deployment of a signal map. + properties: + DetailsUri: + type: string + maxLength: 2048 + minLength: 0 + description: URI associated with a signal map's monitor deployment. + Status: + $ref: '#/components/schemas/SignalMapMonitorDeploymentStatus' + required: + - DetailsUri + - Status + additionalProperties: false + Unit: + type: object + additionalProperties: false + SignalMap: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:signal-map:.+$ + description: A signal map's ARN (Amazon Resource Name) + CloudWatchAlarmTemplateGroupIdentifiers: + type: array + items: + type: string + pattern: ^[^\s]+$ + CloudWatchAlarmTemplateGroupIds: + type: array + items: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + DiscoveryEntryPointArn: + type: string + maxLength: 2048 + minLength: 1 + description: A top-level supported AWS resource ARN to discovery a signal map from. + ErrorMessage: + type: string + maxLength: 2048 + minLength: 0 + description: Error message associated with a failed creation or failed update attempt of a signal map. + EventBridgeRuleTemplateGroupIdentifiers: + type: array + items: + type: string + pattern: ^[^\s]+$ + EventBridgeRuleTemplateGroupIds: + type: array + items: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + FailedMediaResourceMap: + $ref: '#/components/schemas/FailedMediaResourceMap' + ForceRediscovery: + type: boolean + default: false + description: If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A signal map's id. + Identifier: + type: string + LastDiscoveredAt: + type: string + format: date-time + LastSuccessfulMonitorDeployment: + $ref: '#/components/schemas/SuccessfulMonitorDeployment' + MediaResourceMap: + $ref: '#/components/schemas/MediaResourceMap' + ModifiedAt: + type: string + format: date-time + MonitorChangesPendingDeployment: + type: boolean + default: false + description: If true, there are pending monitor changes for this signal map that can be deployed. + MonitorDeployment: + $ref: '#/components/schemas/MonitorDeployment' + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Status: + $ref: '#/components/schemas/SignalMapStatus' + Tags: + $ref: '#/components/schemas/TagMap' + required: + - DiscoveryEntryPointArn + - Name + x-stackql-resource-name: signal_map + description: Definition of AWS::MediaLive::SignalMap Resource Type + x-type-name: AWS::MediaLive::SignalMap + x-stackql-primary-identifier: + - Identifier + x-create-only-properties: + - Tags + x-write-only-properties: + - CloudWatchAlarmTemplateGroupIdentifiers + - EventBridgeRuleTemplateGroupIdentifiers + - ForceRediscovery + x-read-only-properties: + - Arn + - CloudWatchAlarmTemplateGroupIds + - CreatedAt + - ErrorMessage + - EventBridgeRuleTemplateGroupIds + - FailedMediaResourceMap + - Id + - Identifier + - LastDiscoveredAt + - LastSuccessfulMonitorDeployment + - MediaResourceMap + - ModifiedAt + - MonitorChangesPendingDeployment + - MonitorDeployment + - Status + x-required-properties: + - DiscoveryEntryPointArn + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - medialive:CreateTags + - medialive:DeleteTags + x-required-permissions: + create: + - medialive:CreateSignalMap + - medialive:GetSignalMap + - medialive:CreateTags + - medialive:DescribeChannel + - medialive:DescribeInput + - medialive:DescribeInputDevice + - medialive:DescribeInputSecurityGroup + - medialive:DescribeMultiplex + - medialive:DescribeMultiplexProgram + - medialive:ListChannels + - medialive:ListInputDevices + - medialive:ListInputSecurityGroups + - medialive:ListInputs + - medialive:ListMultiplexPrograms + - medialive:ListMultiplexes + - medialive:ListOfferings + - medialive:ListReservations + - medialive:ListTagsForResource + - cloudfront:ListDistributions + - cloudfront:GetDistribution + - ec2:DescribeNetworkInterfaces + - mediaconnect:ListEntitlements + - mediaconnect:ListFlows + - mediaconnect:ListOfferings + - mediaconnect:ListReservations + - mediaconnect:DescribeFlow + - mediapackage:ListChannels + - mediapackage:ListOriginEndpoints + - mediapackage:DescribeChannel + - mediapackage:DescribeOriginEndpoint + - mediapackagev2:ListChannelGroups + - mediapackagev2:ListChannels + - mediapackagev2:ListOriginEndpoints + - mediapackagev2:GetChannelGroup + - mediapackagev2:GetChannel + - mediapackagev2:GetOriginEndpoint + - tag:GetResources + read: + - medialive:GetSignalMap + - tag:GetResources + update: + - medialive:StartUpdateSignalMap + - medialive:GetSignalMap + - medialive:CreateTags + - medialive:DeleteTags + - medialive:DescribeChannel + - medialive:DescribeInput + - medialive:DescribeInputDevice + - medialive:DescribeInputSecurityGroup + - medialive:DescribeMultiplex + - medialive:DescribeMultiplexProgram + - medialive:ListChannels + - medialive:ListInputDevices + - medialive:ListInputSecurityGroups + - medialive:ListInputs + - medialive:ListMultiplexPrograms + - medialive:ListMultiplexes + - medialive:ListOfferings + - medialive:ListReservations + - medialive:ListTagsForResource + - cloudfront:ListDistributions + - cloudfront:GetDistribution + - ec2:DescribeNetworkInterfaces + - mediaconnect:ListEntitlements + - mediaconnect:ListFlows + - mediaconnect:ListOfferings + - mediaconnect:ListReservations + - mediaconnect:DescribeFlow + - mediapackage:ListChannels + - mediapackage:ListOriginEndpoints + - mediapackage:DescribeChannel + - mediapackage:DescribeOriginEndpoint + - mediapackagev2:ListChannelGroups + - mediapackagev2:ListChannels + - mediapackagev2:ListOriginEndpoints + - mediapackagev2:GetChannelGroup + - mediapackagev2:GetChannel + - mediapackagev2:GetOriginEndpoint + - tag:GetResources + delete: + - medialive:GetSignalMap + - medialive:DeleteSignalMap + list: + - medialive:ListSignalMaps + CreateChannelPlacementGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The ARN of the channel placement group. + Channels: + type: array + x-insertionOrder: false + description: List of channel IDs added to the channel placement group. + items: + type: string + ClusterId: + type: string + description: The ID of the cluster the node is on. + Id: + type: string + description: Unique internal identifier. + Name: + type: string + description: The name of the channel placement group. + Nodes: + type: array + x-insertionOrder: false + description: List of nodes added to the channel placement group + items: + type: string + State: + $ref: '#/components/schemas/ChannelPlacementGroupState' + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateChannelPlacementGroupRequest + type: object + required: [] + CreateCloudWatchAlarmTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$ + description: A cloudwatch alarm template's ARN (Amazon Resource Name) + ComparisonOperator: + $ref: '#/components/schemas/CloudWatchAlarmTemplateComparisonOperator' + CreatedAt: + type: string + format: date-time + DatapointsToAlarm: + type: number + default: 0 + minimum: 1 + description: The number of datapoints within the evaluation period that must be breaching to trigger the alarm. + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + EvaluationPeriods: + type: number + default: 0 + minimum: 1 + description: The number of periods over which data is compared to the specified threshold. + GroupId: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` + GroupIdentifier: + type: string + pattern: ^[^\s]+$ + description: A cloudwatch alarm template group's identifier. Can be either be its id or current name. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-` + Identifier: + type: string + MetricName: + type: string + maxLength: 64 + minLength: 0 + description: The name of the metric associated with the alarm. Must be compatible with targetResourceType. + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Period: + type: number + default: 0 + maximum: 86400 + minimum: 10 + description: The period, in seconds, over which the specified statistic is applied. + Statistic: + $ref: '#/components/schemas/CloudWatchAlarmTemplateStatistic' + Tags: + $ref: '#/components/schemas/TagMap' + TargetResourceType: + $ref: '#/components/schemas/CloudWatchAlarmTemplateTargetResourceType' + Threshold: + type: number + default: 0 + description: The threshold value to compare with the specified statistic. + TreatMissingData: + $ref: '#/components/schemas/CloudWatchAlarmTemplateTreatMissingData' + x-stackQL-stringOnly: true + x-title: CreateCloudWatchAlarmTemplateRequest + type: object + required: [] + CreateCloudWatchAlarmTemplateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$ + description: A cloudwatch alarm template group's ARN (Amazon Resource Name) + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-` + Identifier: + type: string + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateCloudWatchAlarmTemplateGroupRequest + type: object + required: [] + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:cluster:.+$ + description: The ARN of the Cluster. + ChannelIds: + type: array + x-insertionOrder: false + items: + type: string + description: MediaLive Channel Ids + description: The MediaLive Channels that are currently running on Nodes in this Cluster. + ClusterType: + $ref: '#/components/schemas/ClusterType' + Id: + type: string + description: The unique ID of the Cluster. + InstanceRoleArn: + type: string + pattern: ^arn:.+:iam:.+:role/.+$ + description: The IAM role your nodes will use. + Name: + type: string + description: The user-specified name of the Cluster to be created. + NetworkSettings: + $ref: '#/components/schemas/ClusterNetworkSettings' + State: + $ref: '#/components/schemas/ClusterState' + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateEventBridgeRuleTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:eventbridge-rule-template:.+$ + description: An eventbridge rule template's ARN (Amazon Resource Name) + CreatedAt: + type: string + description: Placeholder documentation for __timestampIso8601 + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + EventTargets: + type: array + items: + $ref: '#/components/schemas/EventBridgeRuleTemplateTarget' + description: Placeholder documentation for __listOfEventBridgeRuleTemplateTarget + EventType: + $ref: '#/components/schemas/EventBridgeRuleTemplateEventType' + GroupId: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` + GroupIdentifier: + type: string + pattern: ^[^\s]+$ + description: An eventbridge rule template group's identifier. Can be either be its id or current name. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: An eventbridge rule template's id. AWS provided templates have ids that start with `aws-` + Identifier: + type: string + description: Placeholder documentation for __string + ModifiedAt: + type: string + description: Placeholder documentation for __timestampIso8601 + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateEventBridgeRuleTemplateRequest + type: object + required: [] + CreateEventBridgeRuleTemplateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$ + description: An eventbridge rule template group's ARN (Amazon Resource Name) + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: An eventbridge rule template group's id. AWS provided template groups have ids that start with `aws-` + Identifier: + type: string + ModifiedAt: + type: string + format: date-time + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateEventBridgeRuleTemplateGroupRequest + type: object + required: [] + CreateMultiplexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The unique arn of the multiplex. + AvailabilityZones: + description: A list of availability zones for the multiplex. + type: array + x-insertionOrder: false + items: + type: string + Destinations: + description: A list of the multiplex output destinations. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/MultiplexOutputDestination' + Id: + type: string + description: The unique id of the multiplex. + MultiplexSettings: + $ref: '#/components/schemas/MultiplexSettings' + description: Configuration for a multiplex event. + Name: + type: string + description: Name of multiplex. + PipelinesRunningCount: + type: integer + description: The number of currently healthy pipelines. + ProgramCount: + type: integer + description: The number of programs in the multiplex. + State: + type: string + enum: + - CREATING + - CREATE_FAILED + - IDLE + - STARTING + - RUNNING + - RECOVERING + - STOPPING + - DELETING + - DELETED + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateMultiplexRequest + type: object + required: [] + CreateMultiplexprogramRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ChannelId: + type: string + description: The MediaLive channel associated with the program. + MultiplexId: + type: string + description: The ID of the multiplex that the program belongs to. + MultiplexProgramSettings: + description: The settings for this multiplex program. + $ref: '#/components/schemas/MultiplexProgramSettings' + PreferredChannelPipeline: + description: The settings for this multiplex program. + $ref: '#/components/schemas/PreferredChannelPipeline' + PacketIdentifiersMap: + $ref: '#/components/schemas/MultiplexProgramPacketIdentifiersMap' + description: The packet identifier map for this multiplex program. + PipelineDetails: + description: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time. + type: array + items: + $ref: '#/components/schemas/MultiplexProgramPipelineDetail' + x-insertionOrder: true + ProgramName: + type: string + description: The name of the multiplex program. + x-stackQL-stringOnly: true + x-title: CreateMultiplexprogramRequest + type: object + required: [] + CreateNetworkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The ARN of the Network. + AssociatedClusterIds: + type: array + x-insertionOrder: false + items: + type: string + description: Cluster Ids which have this network ID in their Interface Network Mappings + Id: + type: string + description: The unique ID of the Network. + IpPools: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpPool' + description: The list of IP address cidr pools for the network + Name: + type: string + description: The user-specified name of the Network to be created. + Routes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Route' + description: The routes for the network + State: + $ref: '#/components/schemas/NetworkState' + description: The current state of the Network. + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateNetworkRequest + type: object + required: [] + CreateSdiSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The unique arn of the SdiSource. + Id: + type: string + description: The unique identifier of the SdiSource. + Mode: + $ref: '#/components/schemas/SdiSourceMode' + Name: + type: string + description: The name of the SdiSource. + State: + $ref: '#/components/schemas/SdiSourceState' + Type: + $ref: '#/components/schemas/SdiSourceType' + Inputs: + description: The list of inputs currently using this SDI source. + type: array + x-insertionOrder: false + items: + type: string + Tags: + description: A collection of key-value pairs. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateSdiSourceRequest + type: object + required: [] + CreateSignalMapRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:.+:medialive:.+:signal-map:.+$ + description: A signal map's ARN (Amazon Resource Name) + CloudWatchAlarmTemplateGroupIdentifiers: + type: array + items: + type: string + pattern: ^[^\s]+$ + CloudWatchAlarmTemplateGroupIds: + type: array + items: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description: A resource's optional description. + DiscoveryEntryPointArn: + type: string + maxLength: 2048 + minLength: 1 + description: A top-level supported AWS resource ARN to discovery a signal map from. + ErrorMessage: + type: string + maxLength: 2048 + minLength: 0 + description: Error message associated with a failed creation or failed update attempt of a signal map. + EventBridgeRuleTemplateGroupIdentifiers: + type: array + items: + type: string + pattern: ^[^\s]+$ + EventBridgeRuleTemplateGroupIds: + type: array + items: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + FailedMediaResourceMap: + $ref: '#/components/schemas/FailedMediaResourceMap' + ForceRediscovery: + type: boolean + default: false + description: If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided. + Id: + type: string + maxLength: 11 + minLength: 7 + pattern: ^(aws-)?[0-9]{7}$ + description: A signal map's id. + Identifier: + type: string + LastDiscoveredAt: + type: string + format: date-time + LastSuccessfulMonitorDeployment: + $ref: '#/components/schemas/SuccessfulMonitorDeployment' + MediaResourceMap: + $ref: '#/components/schemas/MediaResourceMap' + ModifiedAt: + type: string + format: date-time + MonitorChangesPendingDeployment: + type: boolean + default: false + description: If true, there are pending monitor changes for this signal map that can be deployed. + MonitorDeployment: + $ref: '#/components/schemas/MonitorDeployment' + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[^\s]+$ + description: A resource's name. Names must be unique within the scope of a resource type in a specific region. + Status: + $ref: '#/components/schemas/SignalMapStatus' + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateSignalMapRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + channel_placement_groups: + name: channel_placement_groups + id: awscc.medialive.channel_placement_groups + x-cfn-schema-name: ChannelPlacementGroup + x-cfn-type-name: AWS::MediaLive::ChannelPlacementGroup + x-identifiers: + - Id + - ClusterId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ChannelPlacementGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::ChannelPlacementGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::ChannelPlacementGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::ChannelPlacementGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_placement_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_placement_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channel_placement_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Channels') as channels, + JSON_EXTRACT(Properties, '$.ClusterId') as cluster_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Nodes') as nodes, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::ChannelPlacementGroup' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Channels') as channels, + json_extract_path_text(Properties, 'ClusterId') as cluster_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Nodes') as nodes, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::ChannelPlacementGroup' + AND data__Identifier = '|' + AND region = 'us-east-1' + channel_placement_groups_list_only: + name: channel_placement_groups_list_only + id: awscc.medialive.channel_placement_groups_list_only + x-cfn-schema-name: ChannelPlacementGroup + x-cfn-type-name: AWS::MediaLive::ChannelPlacementGroup + x-identifiers: + - Id + - ClusterId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.ClusterId') as cluster_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::ChannelPlacementGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ClusterId') as cluster_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::ChannelPlacementGroup' + AND region = 'us-east-1' + cloud_watch_alarm_templates: + name: cloud_watch_alarm_templates + id: awscc.medialive.cloud_watch_alarm_templates + x-cfn-schema-name: CloudWatchAlarmTemplate + x-cfn-type-name: AWS::MediaLive::CloudWatchAlarmTemplate + x-identifiers: + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudWatchAlarmTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::CloudWatchAlarmTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::CloudWatchAlarmTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::CloudWatchAlarmTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_watch_alarm_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_watch_alarm_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_watch_alarm_templates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ComparisonOperator') as comparison_operator, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DatapointsToAlarm') as datapoints_to_alarm, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.EvaluationPeriods') as evaluation_periods, + JSON_EXTRACT(Properties, '$.GroupId') as group_id, + JSON_EXTRACT(Properties, '$.GroupIdentifier') as group_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.MetricName') as metric_name, + JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Period') as period, + JSON_EXTRACT(Properties, '$.Statistic') as statistic, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TargetResourceType') as target_resource_type, + JSON_EXTRACT(Properties, '$.Threshold') as threshold, + JSON_EXTRACT(Properties, '$.TreatMissingData') as treat_missing_data + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ComparisonOperator') as comparison_operator, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DatapointsToAlarm') as datapoints_to_alarm, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EvaluationPeriods') as evaluation_periods, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'GroupIdentifier') as group_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'MetricName') as metric_name, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Period') as period, + json_extract_path_text(Properties, 'Statistic') as statistic, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TargetResourceType') as target_resource_type, + json_extract_path_text(Properties, 'Threshold') as threshold, + json_extract_path_text(Properties, 'TreatMissingData') as treat_missing_data + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + cloud_watch_alarm_templates_list_only: + name: cloud_watch_alarm_templates_list_only + id: awscc.medialive.cloud_watch_alarm_templates_list_only + x-cfn-schema-name: CloudWatchAlarmTemplate + x-cfn-type-name: AWS::MediaLive::CloudWatchAlarmTemplate + x-identifiers: + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplate' + AND region = 'us-east-1' + cloud_watch_alarm_template_groups: + name: cloud_watch_alarm_template_groups + id: awscc.medialive.cloud_watch_alarm_template_groups + x-cfn-schema-name: CloudWatchAlarmTemplateGroup + x-cfn-type-name: AWS::MediaLive::CloudWatchAlarmTemplateGroup + x-identifiers: + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudWatchAlarmTemplateGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::CloudWatchAlarmTemplateGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::CloudWatchAlarmTemplateGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::CloudWatchAlarmTemplateGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_watch_alarm_template_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_watch_alarm_template_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_watch_alarm_template_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplateGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplateGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + cloud_watch_alarm_template_groups_list_only: + name: cloud_watch_alarm_template_groups_list_only + id: awscc.medialive.cloud_watch_alarm_template_groups_list_only + x-cfn-schema-name: CloudWatchAlarmTemplateGroup + x-cfn-type-name: AWS::MediaLive::CloudWatchAlarmTemplateGroup + x-identifiers: + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplateGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::CloudWatchAlarmTemplateGroup' + AND region = 'us-east-1' + clusters: + name: clusters + id: awscc.medialive.clusters + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::MediaLive::Cluster + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ChannelIds') as channel_ids, + JSON_EXTRACT(Properties, '$.ClusterType') as cluster_type, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.InstanceRoleArn') as instance_role_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.NetworkSettings') as network_settings, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ChannelIds') as channel_ids, + json_extract_path_text(Properties, 'ClusterType') as cluster_type, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'InstanceRoleArn') as instance_role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NetworkSettings') as network_settings, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + clusters_list_only: + name: clusters_list_only + id: awscc.medialive.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::MediaLive::Cluster + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Cluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Cluster' + AND region = 'us-east-1' + event_bridge_rule_templates: + name: event_bridge_rule_templates + id: awscc.medialive.event_bridge_rule_templates + x-cfn-schema-name: EventBridgeRuleTemplate + x-cfn-type-name: AWS::MediaLive::EventBridgeRuleTemplate + x-identifiers: + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventBridgeRuleTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::EventBridgeRuleTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::EventBridgeRuleTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::EventBridgeRuleTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_bridge_rule_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_bridge_rule_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_bridge_rule_templates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.EventTargets') as event_targets, + JSON_EXTRACT(Properties, '$.EventType') as event_type, + JSON_EXTRACT(Properties, '$.GroupId') as group_id, + JSON_EXTRACT(Properties, '$.GroupIdentifier') as group_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EventTargets') as event_targets, + json_extract_path_text(Properties, 'EventType') as event_type, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'GroupIdentifier') as group_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + event_bridge_rule_templates_list_only: + name: event_bridge_rule_templates_list_only + id: awscc.medialive.event_bridge_rule_templates_list_only + x-cfn-schema-name: EventBridgeRuleTemplate + x-cfn-type-name: AWS::MediaLive::EventBridgeRuleTemplate + x-identifiers: + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplate' + AND region = 'us-east-1' + event_bridge_rule_template_groups: + name: event_bridge_rule_template_groups + id: awscc.medialive.event_bridge_rule_template_groups + x-cfn-schema-name: EventBridgeRuleTemplateGroup + x-cfn-type-name: AWS::MediaLive::EventBridgeRuleTemplateGroup x-identifiers: - - Id + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventBridgeRuleTemplateGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::EventBridgeRuleTemplateGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::EventBridgeRuleTemplateGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::EventBridgeRuleTemplateGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_bridge_rule_template_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_bridge_rule_template_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_bridge_rule_template_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplateGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplateGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + event_bridge_rule_template_groups_list_only: + name: event_bridge_rule_template_groups_list_only + id: awscc.medialive.event_bridge_rule_template_groups_list_only + x-cfn-schema-name: EventBridgeRuleTemplateGroup + x-cfn-type-name: AWS::MediaLive::EventBridgeRuleTemplateGroup + x-identifiers: + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -352,28 +3396,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplateGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::EventBridgeRuleTemplateGroup' AND region = 'us-east-1' - multiplex: - name: multiplex - id: awscc.medialive.multiplex + multiplexes: + name: multiplexes + id: awscc.medialive.multiplexes x-cfn-schema-name: Multiplex - x-type: get + x-cfn-type-name: AWS::MediaLive::Multiplex x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Multiplex&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Multiplex" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Multiplex" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Multiplex" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multiplexes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multiplexes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/multiplexes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -392,7 +3484,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -410,14 +3502,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Multiplex' AND data__Identifier = '' AND region = 'us-east-1' - multiplexprograms: - name: multiplexprograms - id: awscc.medialive.multiplexprograms - x-cfn-schema-name: Multiplexprogram - x-type: list + multiplexes_list_only: + name: multiplexes_list_only + id: awscc.medialive.multiplexes_list_only + x-cfn-schema-name: Multiplex + x-cfn-type-name: AWS::MediaLive::Multiplex x-identifiers: - - ProgramName - - MultiplexId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -425,31 +3522,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProgramName') as program_name, - JSON_EXTRACT(Properties, '$.MultiplexId') as multiplex_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProgramName') as program_name, - json_extract_path_text(Properties, 'MultiplexId') as multiplex_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' AND region = 'us-east-1' - multiplexprogram: - name: multiplexprogram - id: awscc.medialive.multiplexprogram + multiplexprograms: + name: multiplexprograms + id: awscc.medialive.multiplexprograms x-cfn-schema-name: Multiplexprogram - x-type: get + x-cfn-type-name: AWS::MediaLive::Multiplexprogram x-identifiers: - ProgramName - MultiplexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Multiplexprogram&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Multiplexprogram" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Multiplexprogram" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Multiplexprogram" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -465,7 +3608,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -480,3 +3623,1046 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' AND data__Identifier = '|' AND region = 'us-east-1' + multiplexprograms_list_only: + name: multiplexprograms_list_only + id: awscc.medialive.multiplexprograms_list_only + x-cfn-schema-name: Multiplexprogram + x-cfn-type-name: AWS::MediaLive::Multiplexprogram + x-identifiers: + - ProgramName + - MultiplexId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ProgramName') as program_name, + JSON_EXTRACT(Properties, '$.MultiplexId') as multiplex_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProgramName') as program_name, + json_extract_path_text(Properties, 'MultiplexId') as multiplex_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' + AND region = 'us-east-1' + networks: + name: networks + id: awscc.medialive.networks + x-cfn-schema-name: Network + x-cfn-type-name: AWS::MediaLive::Network + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Network&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Network" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Network" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::Network" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/networks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/networks/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AssociatedClusterIds') as associated_cluster_ids, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.IpPools') as ip_pools, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Routes') as routes, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Network' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AssociatedClusterIds') as associated_cluster_ids, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IpPools') as ip_pools, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Routes') as routes, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Network' + AND data__Identifier = '' + AND region = 'us-east-1' + networks_list_only: + name: networks_list_only + id: awscc.medialive.networks_list_only + x-cfn-schema-name: Network + x-cfn-type-name: AWS::MediaLive::Network + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Network' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Network' + AND region = 'us-east-1' + sdi_sources: + name: sdi_sources + id: awscc.medialive.sdi_sources + x-cfn-schema-name: SdiSource + x-cfn-type-name: AWS::MediaLive::SdiSource + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SdiSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::SdiSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::SdiSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::SdiSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sdi_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sdi_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sdi_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Mode') as mode, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Inputs') as inputs, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::SdiSource' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Mode') as mode, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Inputs') as inputs, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::SdiSource' + AND data__Identifier = '' + AND region = 'us-east-1' + sdi_sources_list_only: + name: sdi_sources_list_only + id: awscc.medialive.sdi_sources_list_only + x-cfn-schema-name: SdiSource + x-cfn-type-name: AWS::MediaLive::SdiSource + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::SdiSource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::SdiSource' + AND region = 'us-east-1' + signal_maps: + name: signal_maps + id: awscc.medialive.signal_maps + x-cfn-schema-name: SignalMap + x-cfn-type-name: AWS::MediaLive::SignalMap + x-identifiers: + - Identifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SignalMap&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::SignalMap" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::SignalMap" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaLive::SignalMap" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signal_maps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signal_maps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/signal_maps/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CloudWatchAlarmTemplateGroupIdentifiers') as cloud_watch_alarm_template_group_identifiers, + JSON_EXTRACT(Properties, '$.CloudWatchAlarmTemplateGroupIds') as cloud_watch_alarm_template_group_ids, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DiscoveryEntryPointArn') as discovery_entry_point_arn, + JSON_EXTRACT(Properties, '$.ErrorMessage') as error_message, + JSON_EXTRACT(Properties, '$.EventBridgeRuleTemplateGroupIdentifiers') as event_bridge_rule_template_group_identifiers, + JSON_EXTRACT(Properties, '$.EventBridgeRuleTemplateGroupIds') as event_bridge_rule_template_group_ids, + JSON_EXTRACT(Properties, '$.FailedMediaResourceMap') as failed_media_resource_map, + JSON_EXTRACT(Properties, '$.ForceRediscovery') as force_rediscovery, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.LastDiscoveredAt') as last_discovered_at, + JSON_EXTRACT(Properties, '$.LastSuccessfulMonitorDeployment') as last_successful_monitor_deployment, + JSON_EXTRACT(Properties, '$.MediaResourceMap') as media_resource_map, + JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, + JSON_EXTRACT(Properties, '$.MonitorChangesPendingDeployment') as monitor_changes_pending_deployment, + JSON_EXTRACT(Properties, '$.MonitorDeployment') as monitor_deployment, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::SignalMap' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CloudWatchAlarmTemplateGroupIdentifiers') as cloud_watch_alarm_template_group_identifiers, + json_extract_path_text(Properties, 'CloudWatchAlarmTemplateGroupIds') as cloud_watch_alarm_template_group_ids, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DiscoveryEntryPointArn') as discovery_entry_point_arn, + json_extract_path_text(Properties, 'ErrorMessage') as error_message, + json_extract_path_text(Properties, 'EventBridgeRuleTemplateGroupIdentifiers') as event_bridge_rule_template_group_identifiers, + json_extract_path_text(Properties, 'EventBridgeRuleTemplateGroupIds') as event_bridge_rule_template_group_ids, + json_extract_path_text(Properties, 'FailedMediaResourceMap') as failed_media_resource_map, + json_extract_path_text(Properties, 'ForceRediscovery') as force_rediscovery, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'LastDiscoveredAt') as last_discovered_at, + json_extract_path_text(Properties, 'LastSuccessfulMonitorDeployment') as last_successful_monitor_deployment, + json_extract_path_text(Properties, 'MediaResourceMap') as media_resource_map, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'MonitorChangesPendingDeployment') as monitor_changes_pending_deployment, + json_extract_path_text(Properties, 'MonitorDeployment') as monitor_deployment, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::SignalMap' + AND data__Identifier = '' + AND region = 'us-east-1' + signal_maps_list_only: + name: signal_maps_list_only + id: awscc.medialive.signal_maps_list_only + x-cfn-schema-name: SignalMap + x-cfn-type-name: AWS::MediaLive::SignalMap + x-identifiers: + - Identifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::SignalMap' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Identifier') as identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::SignalMap' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ChannelPlacementGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannelPlacementGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelPlacementGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudWatchAlarmTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudWatchAlarmTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudWatchAlarmTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudWatchAlarmTemplateGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudWatchAlarmTemplateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudWatchAlarmTemplateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventBridgeRuleTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventBridgeRuleTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventBridgeRuleTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventBridgeRuleTemplateGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventBridgeRuleTemplateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventBridgeRuleTemplateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Multiplex&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMultiplex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMultiplexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Multiplexprogram&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMultiplexprogram + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMultiplexprogramRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Network&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetwork + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SdiSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSdiSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSdiSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SignalMap&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSignalMap + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSignalMapRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/mediapackage.yaml b/providers/src/awscc/v00.00.00000/services/mediapackage.yaml index bdffb6e6..906d5fd2 100644 --- a/providers/src/awscc/v00.00.00000/services/mediapackage.yaml +++ b/providers/src/awscc/v00.00.00000/services/mediapackage.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MediaPackage - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: EgressEndpoint: description: The endpoint URL used to access an Asset using one PackagingConfiguration. @@ -71,13 +451,33 @@ components: - SourceArn - SourceRoleArn x-stackql-resource-name: asset - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaPackage::Asset + x-type-name: AWS::MediaPackage::Asset + x-stackql-primary-identifier: - Id + x-create-only-properties: + - Id + - Tags x-read-only-properties: - Arn - CreatedAt - EgressEndpoints/*/PackagingConfigurationId - EgressEndpoints/*/Url + x-required-properties: + - Id + - PackagingGroupId + - SourceArn + - SourceRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackage-vod:TagResource + - mediapackage-vod:UntagResource + - mediapackage-vod:ListTagsForResource x-required-permissions: create: - mediapackage-vod:CreateAsset @@ -167,7 +567,9 @@ components: required: - Id x-stackql-resource-name: channel - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaPackage::Channel + x-type-name: AWS::MediaPackage::Channel + x-stackql-primary-identifier: - Id x-create-only-properties: - Id @@ -178,6 +580,18 @@ components: - HlsIngest/ingestEndpoints/*/Username - HlsIngest/ingestEndpoints/*/Password - HlsIngest/ingestEndpoints/*/Url + x-required-properties: + - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackage:TagResource + - mediapackage:UntagResource + - mediapackage:ListTagsForResource x-required-permissions: create: - mediapackage:CreateChannel @@ -515,13 +929,27 @@ components: - Id - ChannelId x-stackql-resource-name: origin_endpoint - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaPackage::OriginEndpoint + x-type-name: AWS::MediaPackage::OriginEndpoint + x-stackql-primary-identifier: - Id x-create-only-properties: - Id x-read-only-properties: - Arn - Url + x-required-properties: + - Id + - ChannelId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackage:TagResource + - mediapackage:UntagResource x-required-permissions: create: - mediapackage:CreateOriginEndpoint @@ -534,6 +962,10 @@ components: - mediapackage:DescribeOriginEndpoint update: - mediapackage:UpdateOriginEndpoint + - mediapackage:TagResource + - mediapackage:ListTagsForResource + - mediapackage:UntagResource + - mediapackage:DescribeOriginEndpoint - iam:PassRole delete: - mediapackage:DeleteOriginEndpoint @@ -621,12 +1053,27 @@ components: - PackagingGroupId - Id x-stackql-resource-name: packaging_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaPackage::PackagingConfiguration + x-type-name: AWS::MediaPackage::PackagingConfiguration + x-stackql-primary-identifier: - Id x-create-only-properties: - Id x-read-only-properties: - Arn + x-required-properties: + - PackagingGroupId + - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackage-vod:TagResource + - mediapackage-vod:UntagResource + - mediapackage-vod:ListTagsForResource x-required-permissions: create: - mediapackage-vod:CreatePackagingConfiguration @@ -671,7 +1118,9 @@ components: required: - Id x-stackql-resource-name: packaging_group - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaPackage::PackagingGroup + x-type-name: AWS::MediaPackage::PackagingGroup + x-stackql-primary-identifier: - Id x-create-only-properties: - Id @@ -679,6 +1128,18 @@ components: x-read-only-properties: - Arn - DomainName + x-required-properties: + - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackage-vod:TagResource + - mediapackage-vod:UntagResource + - mediapackage-vod:ListTagsForResource x-required-permissions: create: - mediapackage-vod:CreatePackagingGroup @@ -701,43 +1162,309 @@ components: delete: - mediapackage-vod:DescribePackagingGroup - mediapackage-vod:DeletePackagingGroup + CreateAssetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The ARN of the Asset. + type: string + CreatedAt: + description: The time the Asset was initially submitted for Ingest. + type: string + EgressEndpoints: + description: The list of egress endpoints available for the Asset. + type: array + items: + $ref: '#/components/schemas/EgressEndpoint' + Id: + description: The unique identifier for the Asset. + type: string + PackagingGroupId: + description: The ID of the PackagingGroup for the Asset. + type: string + ResourceId: + description: The resource ID to include in SPEKE key requests. + type: string + SourceArn: + description: ARN of the source object in S3. + type: string + SourceRoleArn: + description: The IAM role_arn used to access the source S3 bucket. + type: string + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAssetRequest + type: object + required: [] + CreateChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) assigned to the Channel. + type: string + Id: + description: The ID of the Channel. + type: string + pattern: \A[0-9a-zA-Z-_]+\Z + minLength: 1 + maxLength: 256 + Description: + description: A short text description of the Channel. + type: string + HlsIngest: + description: An HTTP Live Streaming (HLS) ingest resource configuration. + $ref: '#/components/schemas/HlsIngest' + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + EgressAccessLogs: + description: The configuration parameters for egress access logging. + $ref: '#/components/schemas/LogConfiguration' + IngressAccessLogs: + description: The configuration parameters for egress access logging. + $ref: '#/components/schemas/LogConfiguration' + x-stackQL-stringOnly: true + x-title: CreateChannelRequest + type: object + required: [] + CreateOriginEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) assigned to the OriginEndpoint. + type: string + Url: + description: The URL of the packaged OriginEndpoint for consumption. + type: string + Id: + description: The ID of the OriginEndpoint. + type: string + pattern: \A[0-9a-zA-Z-_]+\Z + minLength: 1 + maxLength: 256 + ChannelId: + description: The ID of the Channel the OriginEndpoint is associated with. + type: string + Description: + description: A short text description of the OriginEndpoint. + type: string + Whitelist: + description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. + type: array + items: + type: string + StartoverWindowSeconds: + description: Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. + type: integer + TimeDelaySeconds: + description: Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. + type: integer + ManifestName: + description: A short string appended to the end of the OriginEndpoint URL. + type: string + Origination: + description: Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination + type: string + enum: + - ALLOW + - DENY + Authorization: + $ref: '#/components/schemas/Authorization' + HlsPackage: + $ref: '#/components/schemas/HlsPackage' + DashPackage: + $ref: '#/components/schemas/DashPackage' + MssPackage: + $ref: '#/components/schemas/MssPackage' + CmafPackage: + $ref: '#/components/schemas/CmafPackage' + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOriginEndpointRequest + type: object + required: [] + CreatePackagingConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The ID of the PackagingConfiguration. + type: string + PackagingGroupId: + description: The ID of a PackagingGroup. + type: string + Arn: + description: The ARN of the PackagingConfiguration. + type: string + CmafPackage: + description: A CMAF packaging configuration. + $ref: '#/components/schemas/CmafPackage' + DashPackage: + description: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. + $ref: '#/components/schemas/DashPackage' + HlsPackage: + description: An HTTP Live Streaming (HLS) packaging configuration. + $ref: '#/components/schemas/HlsPackage' + MssPackage: + description: A Microsoft Smooth Streaming (MSS) PackagingConfiguration. + $ref: '#/components/schemas/MssPackage' + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePackagingConfigurationRequest + type: object + required: [] + CreatePackagingGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The ID of the PackagingGroup. + type: string + pattern: \A[0-9a-zA-Z-_]+\Z + minLength: 1 + maxLength: 256 + Arn: + description: The ARN of the PackagingGroup. + type: string + DomainName: + description: The fully qualified domain name for Assets in the PackagingGroup. + type: string + Authorization: + description: CDN Authorization + $ref: '#/components/schemas/Authorization' + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + EgressAccessLogs: + description: The configuration parameters for egress access logging. + $ref: '#/components/schemas/LogConfiguration' + x-stackQL-stringOnly: true + x-title: CreatePackagingGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: assets: name: assets id: awscc.mediapackage.assets x-cfn-schema-name: Asset - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' - AND region = 'us-east-1' - asset: - name: asset - id: awscc.mediapackage.asset - x-cfn-schema-name: Asset - x-type: get + x-cfn-type-name: AWS::MediaPackage::Asset x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Asset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::Asset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::Asset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -755,7 +1482,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -772,13 +1499,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::Asset' AND data__Identifier = '' AND region = 'us-east-1' - channels: - name: channels - id: awscc.mediapackage.channels - x-cfn-schema-name: Channel - x-type: list + assets_list_only: + name: assets_list_only + id: awscc.mediapackage.assets_list_only + x-cfn-schema-name: Asset + x-cfn-type-name: AWS::MediaPackage::Asset x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -787,7 +1520,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -795,19 +1528,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' AND region = 'us-east-1' - channel: - name: channel - id: awscc.mediapackage.channel + channels: + name: channels + id: awscc.mediapackage.channels x-cfn-schema-name: Channel - x-type: get + x-cfn-type-name: AWS::MediaPackage::Channel x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -823,7 +1604,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -838,13 +1619,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::Channel' AND data__Identifier = '' AND region = 'us-east-1' - origin_endpoints: - name: origin_endpoints - id: awscc.mediapackage.origin_endpoints - x-cfn-schema-name: OriginEndpoint - x-type: list + channels_list_only: + name: channels_list_only + id: awscc.mediapackage.channels_list_only + x-cfn-schema-name: Channel + x-cfn-type-name: AWS::MediaPackage::Channel x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -853,7 +1640,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -861,19 +1648,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' AND region = 'us-east-1' - origin_endpoint: - name: origin_endpoint - id: awscc.mediapackage.origin_endpoint + origin_endpoints: + name: origin_endpoints + id: awscc.mediapackage.origin_endpoints x-cfn-schema-name: OriginEndpoint - x-type: get + x-cfn-type-name: AWS::MediaPackage::OriginEndpoint x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OriginEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::OriginEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::OriginEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::OriginEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -898,7 +1733,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -922,13 +1757,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' AND data__Identifier = '' AND region = 'us-east-1' - packaging_configurations: - name: packaging_configurations - id: awscc.mediapackage.packaging_configurations - x-cfn-schema-name: PackagingConfiguration - x-type: list + origin_endpoints_list_only: + name: origin_endpoints_list_only + id: awscc.mediapackage.origin_endpoints_list_only + x-cfn-schema-name: OriginEndpoint + x-cfn-type-name: AWS::MediaPackage::OriginEndpoint x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -937,7 +1778,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -945,19 +1786,54 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' AND region = 'us-east-1' - packaging_configuration: - name: packaging_configuration - id: awscc.mediapackage.packaging_configuration + packaging_configurations: + name: packaging_configurations + id: awscc.mediapackage.packaging_configurations x-cfn-schema-name: PackagingConfiguration - x-type: get + x-cfn-type-name: AWS::MediaPackage::PackagingConfiguration x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PackagingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::PackagingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::PackagingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/packaging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/packaging_configurations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -974,7 +1850,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -990,13 +1866,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - packaging_groups: - name: packaging_groups - id: awscc.mediapackage.packaging_groups - x-cfn-schema-name: PackagingGroup - x-type: list + packaging_configurations_list_only: + name: packaging_configurations_list_only + id: awscc.mediapackage.packaging_configurations_list_only + x-cfn-schema-name: PackagingConfiguration + x-cfn-type-name: AWS::MediaPackage::PackagingConfiguration x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1005,7 +1887,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1013,19 +1895,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' AND region = 'us-east-1' - packaging_group: - name: packaging_group - id: awscc.mediapackage.packaging_group + packaging_groups: + name: packaging_groups + id: awscc.mediapackage.packaging_groups x-cfn-schema-name: PackagingGroup - x-type: get + x-cfn-type-name: AWS::MediaPackage::PackagingGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PackagingGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::PackagingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::PackagingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackage::PackagingGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1040,7 +1970,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1054,3 +1984,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' AND data__Identifier = '' AND region = 'us-east-1' + packaging_groups_list_only: + name: packaging_groups_list_only + id: awscc.mediapackage.packaging_groups_list_only + x-cfn-schema-name: PackagingGroup + x-cfn-type-name: AWS::MediaPackage::PackagingGroup + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Asset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAsset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OriginEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOriginEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOriginEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PackagingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePackagingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePackagingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PackagingGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePackagingGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePackagingGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/mediapackagev2.yaml b/providers/src/awscc/v00.00.00000/services/mediapackagev2.yaml index ac5dc5ae..89b9689f 100644 --- a/providers/src/awscc/v00.00.00000/services/mediapackagev2.yaml +++ b/providers/src/awscc/v00.00.00000/services/mediapackagev2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MediaPackageV2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: IngestEndpoint: type: object @@ -16,6 +396,31 @@ components: type: string description:

The ingest domain URL where the source stream should be sent.

additionalProperties: false + InputSwitchConfiguration: + type: object + description:

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.

+ properties: + MQCSInputSwitching: + type: boolean + description:

When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when InputType is CMAF.

+ PreferredInput: + type: integer + maximum: 2 + minimum: 1 + additionalProperties: false + InputType: + type: string + enum: + - HLS + - CMAF + OutputHeaderConfiguration: + type: object + description:

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.

+ properties: + PublishMQCS: + type: boolean + description:

When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when InputType is CMAF.

+ additionalProperties: false Tag: type: object properties: @@ -54,10 +459,20 @@ components: items: $ref: '#/components/schemas/IngestEndpoint' description:

The list of ingest endpoints.

+ InputSwitchConfiguration: + $ref: '#/components/schemas/InputSwitchConfiguration' + InputType: + $ref: '#/components/schemas/InputType' ModifiedAt: type: string description:

The date and time the channel was modified.

format: date-time + OutputHeaderConfiguration: + $ref: '#/components/schemas/OutputHeaderConfiguration' + IngestEndpointUrls: + type: array + items: + type: string Tags: type: array x-insertionOrder: false @@ -67,16 +482,36 @@ components: - ChannelGroupName - ChannelName x-stackql-resource-name: channel - x-stackql-primaryIdentifier: + description:

Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

+ x-type-name: AWS::MediaPackageV2::Channel + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ChannelGroupName + - ChannelName x-create-only-properties: - ChannelGroupName - ChannelName + - InputType x-read-only-properties: - Arn - CreatedAt - IngestEndpoints + - IngestEndpointUrls - ModifiedAt + x-required-properties: + - ChannelGroupName + - ChannelName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackagev2:TagResource + - mediapackagev2:UntagResource + - mediapackagev2:ListTagsForResource x-required-permissions: create: - mediapackagev2:TagResource @@ -128,8 +563,12 @@ components: required: - ChannelGroupName x-stackql-resource-name: channel_group - x-stackql-primaryIdentifier: + description:

Represents a channel group that facilitates the grouping of multiple channels.

+ x-type-name: AWS::MediaPackageV2::ChannelGroup + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ChannelGroupName x-create-only-properties: - ChannelGroupName x-read-only-properties: @@ -137,6 +576,18 @@ components: - CreatedAt - EgressDomain - ModifiedAt + x-required-properties: + - ChannelGroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackagev2:TagResource + - mediapackagev2:UntagResource + - mediapackagev2:ListTagsForResource x-required-permissions: create: - mediapackagev2:TagResource @@ -173,12 +624,23 @@ components: - ChannelName - Policy x-stackql-resource-name: channel_policy - x-stackql-primaryIdentifier: + description:

Represents a resource-based policy that allows or denies access to a channel.

+ x-type-name: AWS::MediaPackageV2::ChannelPolicy + x-stackql-primary-identifier: - ChannelGroupName - ChannelName x-create-only-properties: - ChannelGroupName - ChannelName + x-required-properties: + - ChannelGroupName + - ChannelName + - Policy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - mediapackagev2:GetChannelPolicy @@ -191,6 +653,11 @@ components: delete: - mediapackagev2:GetChannelPolicy - mediapackagev2:DeleteChannelPolicy + AdMarkerDash: + type: string + enum: + - BINARY + - XML AdMarkerHls: type: string enum: @@ -205,6 +672,182 @@ components: enum: - TS - CMAF + DashBaseUrl: + type: object + description:

The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.

+ properties: + Url: + type: string + maxLength: 2048 + minLength: 1 + description:

A source location for segments.

+ ServiceLocation: + type: string + maxLength: 2048 + minLength: 1 + description:

The name of the source location.

+ DvbPriority: + type: integer + maximum: 15000 + minimum: 1 + description:

For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.

+ DvbWeight: + type: integer + maximum: 15000 + minimum: 1 + description:

For use with DVB-DASH profiles only. The weighting for source locations that have the same priority.

+ required: + - Url + additionalProperties: false + DashCompactness: + type: string + enum: + - STANDARD + - NONE + DashDrmSignaling: + type: string + enum: + - INDIVIDUAL + - REFERENCED + DashDvbFontDownload: + type: object + description:

For use with DVB-DASH profiles only. The settings for font downloads that you want Elemental MediaPackage to pass through to the manifest.

+ properties: + Url: + type: string + maxLength: 2048 + minLength: 1 + description:

The URL for downloading fonts for subtitles.

+ MimeType: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_/-]*[a-zA-Z0-9]$ + description:

The mimeType of the resource that's at the font download URL.

For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.

+ FontFamily: + type: string + maxLength: 256 + minLength: 1 + description:

The fontFamily name for subtitles, as described in EBU-TT-D Subtitling Distribution Format.

+ additionalProperties: false + DashDvbMetricsReporting: + type: object + description:

For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest.

+ properties: + ReportingUrl: + type: string + maxLength: 2048 + minLength: 1 + description:

The URL where playback devices send error reports.

+ Probability: + type: integer + maximum: 1000 + minimum: 1 + description:

The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.

+ required: + - ReportingUrl + additionalProperties: false + DashDvbSettings: + type: object + description:

For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.

+ properties: + FontDownload: + $ref: '#/components/schemas/DashDvbFontDownload' + ErrorMetrics: + type: array + items: + $ref: '#/components/schemas/DashDvbMetricsReporting' + maxItems: 20 + minItems: 0 + description:

Playback device error reporting settings.

+ additionalProperties: false + DashPeriodTrigger: + type: string + enum: + - AVAILS + - DRM_KEY_ROTATION + - SOURCE_CHANGES + - SOURCE_DISRUPTIONS + - NONE + DashProfile: + type: string + enum: + - DVB_DASH + DashProgramInformation: + type: object + description:

Details about the content that you want MediaPackage to pass through in the manifest to the playback device.

+ properties: + Title: + type: string + maxLength: 2048 + minLength: 1 + description:

The title for the manifest.

+ Source: + type: string + maxLength: 2048 + minLength: 1 + description:

Information about the content provider.

+ Copyright: + type: string + maxLength: 2048 + minLength: 1 + description:

A copyright statement about the content.

+ LanguageCode: + type: string + maxLength: 5 + minLength: 2 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$ + description:

The language code for this manifest.

+ MoreInformationUrl: + type: string + maxLength: 2048 + minLength: 1 + description:

An absolute URL that contains more information about this content.

+ additionalProperties: false + DashSegmentTemplateFormat: + type: string + enum: + - NUMBER_WITH_TIMELINE + DashSubtitleConfiguration: + type: object + description:

The configuration for DASH subtitles.

+ properties: + TtmlConfiguration: + $ref: '#/components/schemas/DashTtmlConfiguration' + additionalProperties: false + DashTtmlConfiguration: + type: object + description:

The settings for TTML subtitles.

+ properties: + TtmlProfile: + $ref: '#/components/schemas/DashTtmlProfile' + required: + - TtmlProfile + additionalProperties: false + DashTtmlProfile: + type: string + enum: + - IMSC_1 + - EBU_TT_D_101 + DashUtcTiming: + type: object + description:

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

+ properties: + TimingMode: + $ref: '#/components/schemas/DashUtcTimingMode' + TimingSource: + type: string + maxLength: 1024 + minLength: 1 + description:

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

+ additionalProperties: false + DashUtcTimingMode: + type: string + enum: + - HTTP_HEAD + - HTTP_ISO + - HTTP_XSDATE + - UTC_DIRECT DrmSystem: type: string enum: @@ -212,6 +855,7 @@ components: - FAIRPLAY - PLAYREADY - WIDEVINE + - IRDETO Encryption: type: object description:

The parameters for encrypting content.

@@ -228,10 +872,14 @@ components: type: integer maximum: 31536000 minimum: 300 - description: |- -

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

-

The following example setting causes the service to rotate keys every thirty minutes: 1800 -

+ description: >- +

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

The following example setting causes + the service to rotate keys every thirty minutes: 1800

+ CmafExcludeSegmentDrmMetadata: + type: boolean + description: >- +

Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

Important considerations:

  • This setting only affects CMAF container formats

  • Key rotation can still be handled through media playlist signaling

  • PSSH and TENC + boxes remain unaffected

  • Default behavior is preserved when this setting is disabled

Valid values: true | false

Default: false

SpekeKeyProvider: $ref: '#/components/schemas/SpekeKeyProvider' required: @@ -259,6 +907,13 @@ components: CmafEncryptionMethod: $ref: '#/components/schemas/CmafEncryptionMethod' additionalProperties: false + EndpointErrorCondition: + type: string + enum: + - STALE_MANIFEST + - INCOMPLETE_MANIFEST + - MISSING_DRM_KEY + - SLATE_INPUT FilterConfiguration: type: object description:

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

@@ -281,6 +936,86 @@ components: maximum: 1209600 minimum: 0 description:

Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

+ ClipStartTime: + type: string + description:

Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.

+ format: date-time + additionalProperties: false + ForceEndpointErrorConfiguration: + type: object + description:

The failover settings for the endpoint.

+ properties: + EndpointErrorConditions: + type: array + items: + $ref: '#/components/schemas/EndpointErrorCondition' + description: >- +

The failover conditions for the endpoint. The options are:

  • STALE_MANIFEST - The manifest stalled and there are no new segments or parts.

  • INCOMPLETE_MANIFEST - There is a gap in the manifest.

  • MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.

  • SLATE_INPUT - The segments which contain slate content are + considered to be missing content.

+ additionalProperties: false + DashManifestConfiguration: + type: object + description:

Retrieve the DASH manifest configuration.

+ properties: + ManifestName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + description:

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

+ ManifestWindowSeconds: + type: integer + description:

The total duration (in seconds) of the manifest's content.

+ FilterConfiguration: + $ref: '#/components/schemas/FilterConfiguration' + MinUpdatePeriodSeconds: + type: integer + description:

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

+ MinBufferTimeSeconds: + type: integer + description:

Minimum amount of content (in seconds) that a player must keep available in the buffer.

+ SuggestedPresentationDelaySeconds: + type: integer + description:

The amount of time (in seconds) that the player should be from the end of the manifest.

+ SegmentTemplateFormat: + $ref: '#/components/schemas/DashSegmentTemplateFormat' + PeriodTriggers: + type: array + items: + $ref: '#/components/schemas/DashPeriodTrigger' + maxItems: 100 + minItems: 0 + description:

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

+ ScteDash: + $ref: '#/components/schemas/ScteDash' + DrmSignaling: + $ref: '#/components/schemas/DashDrmSignaling' + UtcTiming: + $ref: '#/components/schemas/DashUtcTiming' + Profiles: + type: array + items: + $ref: '#/components/schemas/DashProfile' + maxItems: 5 + minItems: 0 + description:

The profile that the output is compliant with.

+ BaseUrls: + type: array + items: + $ref: '#/components/schemas/DashBaseUrl' + maxItems: 20 + minItems: 0 + description:

The base URL to use for retrieving segments.

+ ProgramInformation: + $ref: '#/components/schemas/DashProgramInformation' + DvbSettings: + $ref: '#/components/schemas/DashDvbSettings' + Compactness: + $ref: '#/components/schemas/DashCompactness' + SubtitleConfiguration: + $ref: '#/components/schemas/DashSubtitleConfiguration' + required: + - ManifestName additionalProperties: false HlsManifestConfiguration: type: object @@ -306,16 +1041,16 @@ components: description:

The total duration (in seconds) of the manifest's content.

ProgramDateTimeIntervalSeconds: type: integer - description: |- -

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, - EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. - The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. - ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

-

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

+ description:

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

ScteHls: $ref: '#/components/schemas/ScteHls' FilterConfiguration: $ref: '#/components/schemas/FilterConfiguration' + StartTag: + $ref: '#/components/schemas/StartTag' + UrlEncodeChildManifest: + type: boolean + description:

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

required: - ManifestName additionalProperties: false @@ -343,16 +1078,16 @@ components: description:

The total duration (in seconds) of the manifest's content.

ProgramDateTimeIntervalSeconds: type: integer - description: |- -

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, - EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. - The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. - ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

-

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

+ description:

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

ScteHls: $ref: '#/components/schemas/ScteHls' FilterConfiguration: $ref: '#/components/schemas/FilterConfiguration' + StartTag: + $ref: '#/components/schemas/StartTag' + UrlEncodeChildManifest: + type: boolean + description:

When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

required: - ManifestName additionalProperties: false @@ -389,6 +1124,13 @@ components: minItems: 0 description:

The SCTE-35 message types that you want to be treated as ad markers in the output.

additionalProperties: false + ScteDash: + type: object + description:

The SCTE configuration.

+ properties: + AdMarkerDash: + $ref: '#/components/schemas/AdMarkerDash' + additionalProperties: false ScteFilter: type: string enum: @@ -448,10 +1190,7 @@ components: maxLength: 256 minLength: 1 pattern: ^[0-9a-zA-Z_-]+$ - description: |- -

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

-

The following example shows a resource ID: MovieNight20171126093045 -

+ description: '

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

The following example shows a resource ID: MovieNight20171126093045

' DrmSystems: type: array items: @@ -463,18 +1202,14 @@ components: type: string maxLength: 2048 minLength: 1 - description: |- -

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

-

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess -

+ description: >- +

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: + arn:aws:iam::444455556666:role/SpekeAccess

Url: type: string maxLength: 1024 minLength: 1 - description: |- -

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

-

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection -

+ description: '

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

' required: - DrmSystems - EncryptionContractConfiguration @@ -482,6 +1217,19 @@ components: - RoleArn - Url additionalProperties: false + StartTag: + type: object + description:

To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.

+ properties: + TimeOffset: + type: number + description:

Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.

+ Precise: + type: boolean + description:

Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.

+ required: + - TimeOffset + additionalProperties: false TsEncryptionMethod: type: string enum: @@ -509,11 +1257,18 @@ components: type: string description:

The date and time the origin endpoint was created.

format: date-time + DashManifests: + type: array + items: + $ref: '#/components/schemas/DashManifestConfiguration' + description:

A DASH manifest configuration.

Description: type: string maxLength: 1024 minLength: 0 description:

Enter any descriptive text that helps you to identify the origin endpoint.

+ ForceEndpointErrorConfiguration: + $ref: '#/components/schemas/ForceEndpointErrorConfiguration' HlsManifests: type: array items: @@ -540,6 +1295,18 @@ components: maximum: 1209600 minimum: 60 description:

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

+ DashManifestUrls: + type: array + items: + type: string + HlsManifestUrls: + type: array + items: + type: string + LowLatencyHlsManifestUrls: + type: array + items: + type: string Tags: type: array x-insertionOrder: false @@ -549,9 +1316,16 @@ components: - ChannelGroupName - ChannelName - OriginEndpointName + - ContainerType x-stackql-resource-name: origin_endpoint - x-stackql-primaryIdentifier: + description:

Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.

+ x-type-name: AWS::MediaPackageV2::OriginEndpoint + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ChannelGroupName + - ChannelName + - OriginEndpointName x-create-only-properties: - ChannelGroupName - ChannelName @@ -559,9 +1333,27 @@ components: x-read-only-properties: - Arn - CreatedAt + - DashManifestUrls + - HlsManifestUrls + - LowLatencyHlsManifestUrls - ModifiedAt - LowLatencyHlsManifests/*/Url - HlsManifests/*/Url + x-required-properties: + - ChannelGroupName + - ChannelName + - OriginEndpointName + - ContainerType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediapackagev2:TagResource + - mediapackagev2:UntagResource + - mediapackagev2:ListTagsForResource x-required-permissions: create: - mediapackagev2:TagResource @@ -580,9 +1372,30 @@ components: - mediapackagev2:DeleteOriginEndpoint list: - mediapackagev2:ListOriginEndpoints + CdnAuthConfiguration: + type: object + properties: + CdnIdentifierSecretArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + maxItems: 100 + minItems: 1 + SecretsRoleArn: + type: string + maxLength: 2048 + minLength: 20 + required: + - CdnIdentifierSecretArns + - SecretsRoleArn + additionalProperties: false OriginEndpointPolicy: type: object properties: + CdnAuthConfiguration: + $ref: '#/components/schemas/CdnAuthConfiguration' ChannelGroupName: type: string maxLength: 256 @@ -606,7 +1419,9 @@ components: - OriginEndpointName - Policy x-stackql-resource-name: origin_endpoint_policy - x-stackql-primaryIdentifier: + description:

Represents a resource policy that allows or denies access to an origin endpoint.

+ x-type-name: AWS::MediaPackageV2::OriginEndpointPolicy + x-stackql-primary-identifier: - ChannelGroupName - ChannelName - OriginEndpointName @@ -614,55 +1429,362 @@ components: - ChannelGroupName - ChannelName - OriginEndpointName + x-required-properties: + - ChannelGroupName + - ChannelName + - OriginEndpointName + - Policy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - mediapackagev2:GetOriginEndpointPolicy - mediapackagev2:PutOriginEndpointPolicy + - iam:PassRole read: - mediapackagev2:GetOriginEndpointPolicy update: - mediapackagev2:GetOriginEndpointPolicy - mediapackagev2:PutOriginEndpointPolicy + - iam:PassRole delete: - mediapackagev2:GetOriginEndpointPolicy - mediapackagev2:DeleteOriginEndpointPolicy + CreateChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) associated with the resource.

+ ChannelGroupName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + ChannelName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + CreatedAt: + type: string + description:

The date and time the channel was created.

+ format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description:

Enter any descriptive text that helps you to identify the channel.

+ IngestEndpoints: + type: array + items: + $ref: '#/components/schemas/IngestEndpoint' + description:

The list of ingest endpoints.

+ InputSwitchConfiguration: + $ref: '#/components/schemas/InputSwitchConfiguration' + InputType: + $ref: '#/components/schemas/InputType' + ModifiedAt: + type: string + description:

The date and time the channel was modified.

+ format: date-time + OutputHeaderConfiguration: + $ref: '#/components/schemas/OutputHeaderConfiguration' + IngestEndpointUrls: + type: array + items: + type: string + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateChannelRequest + type: object + required: [] + CreateChannelGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) associated with the resource.

+ ChannelGroupName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + CreatedAt: + type: string + description:

The date and time the channel group was created.

+ format: date-time + Description: + type: string + maxLength: 1024 + minLength: 0 + description:

Enter any descriptive text that helps you to identify the channel group.

+ EgressDomain: + type: string + description:

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

+ ModifiedAt: + type: string + description:

The date and time the channel group was modified.

+ format: date-time + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateChannelGroupRequest + type: object + required: [] + CreateChannelPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ChannelGroupName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + ChannelName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Policy: + type: object + x-stackQL-stringOnly: true + x-title: CreateChannelPolicyRequest + type: object + required: [] + CreateOriginEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) associated with the resource.

+ ChannelGroupName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + ChannelName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + ContainerType: + $ref: '#/components/schemas/ContainerType' + CreatedAt: + type: string + description:

The date and time the origin endpoint was created.

+ format: date-time + DashManifests: + type: array + items: + $ref: '#/components/schemas/DashManifestConfiguration' + description:

A DASH manifest configuration.

+ Description: + type: string + maxLength: 1024 + minLength: 0 + description:

Enter any descriptive text that helps you to identify the origin endpoint.

+ ForceEndpointErrorConfiguration: + $ref: '#/components/schemas/ForceEndpointErrorConfiguration' + HlsManifests: + type: array + items: + $ref: '#/components/schemas/HlsManifestConfiguration' + description:

An HTTP live streaming (HLS) manifest configuration.

+ LowLatencyHlsManifests: + type: array + items: + $ref: '#/components/schemas/LowLatencyHlsManifestConfiguration' + description:

A low-latency HLS manifest configuration.

+ ModifiedAt: + type: string + description:

The date and time the origin endpoint was modified.

+ format: date-time + OriginEndpointName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Segment: + $ref: '#/components/schemas/Segment' + StartoverWindowSeconds: + type: integer + maximum: 1209600 + minimum: 60 + description:

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

+ DashManifestUrls: + type: array + items: + type: string + HlsManifestUrls: + type: array + items: + type: string + LowLatencyHlsManifestUrls: + type: array + items: + type: string + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOriginEndpointRequest + type: object + required: [] + CreateOriginEndpointPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CdnAuthConfiguration: + $ref: '#/components/schemas/CdnAuthConfiguration' + ChannelGroupName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + ChannelName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + OriginEndpointName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Policy: + type: object + x-stackQL-stringOnly: true + x-title: CreateOriginEndpointPolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: channels: name: channels id: awscc.mediapackagev2.channels x-cfn-schema-name: Channel - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: awscc.mediapackagev2.channel - x-cfn-schema-name: Channel - x-type: get + x-cfn-type-name: AWS::MediaPackageV2::Channel x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -673,13 +1795,17 @@ components: JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.IngestEndpoints') as ingest_endpoints, + JSON_EXTRACT(Properties, '$.InputSwitchConfiguration') as input_switch_configuration, + JSON_EXTRACT(Properties, '$.InputType') as input_type, JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, + JSON_EXTRACT(Properties, '$.OutputHeaderConfiguration') as output_header_configuration, + JSON_EXTRACT(Properties, '$.IngestEndpointUrls') as ingest_endpoint_urls, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -690,18 +1816,28 @@ components: json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'IngestEndpoints') as ingest_endpoints, + json_extract_path_text(Properties, 'InputSwitchConfiguration') as input_switch_configuration, + json_extract_path_text(Properties, 'InputType') as input_type, json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'OutputHeaderConfiguration') as output_header_configuration, + json_extract_path_text(Properties, 'IngestEndpointUrls') as ingest_endpoint_urls, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' AND data__Identifier = '' AND region = 'us-east-1' - channel_groups: - name: channel_groups - id: awscc.mediapackagev2.channel_groups - x-cfn-schema-name: ChannelGroup - x-type: list + channels_list_only: + name: channels_list_only + id: awscc.mediapackagev2.channels_list_only + x-cfn-schema-name: Channel + x-cfn-type-name: AWS::MediaPackageV2::Channel x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -710,7 +1846,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -718,19 +1854,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' AND region = 'us-east-1' - channel_group: - name: channel_group - id: awscc.mediapackagev2.channel_group + channel_groups: + name: channel_groups + id: awscc.mediapackagev2.channel_groups x-cfn-schema-name: ChannelGroup - x-type: get + x-cfn-type-name: AWS::MediaPackageV2::ChannelGroup x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ChannelGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::ChannelGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::ChannelGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::ChannelGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channel_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -746,7 +1930,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -761,18 +1945,97 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' AND data__Identifier = '' AND region = 'us-east-1' - channel_policy: - name: channel_policy - id: awscc.mediapackagev2.channel_policy + channel_groups_list_only: + name: channel_groups_list_only + id: awscc.mediapackagev2.channel_groups_list_only + x-cfn-schema-name: ChannelGroup + x-cfn-type-name: AWS::MediaPackageV2::ChannelGroup + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' + AND region = 'us-east-1' + channel_policies: + name: channel_policies + id: awscc.mediapackagev2.channel_policies x-cfn-schema-name: ChannelPolicy - x-type: get + x-cfn-type-name: AWS::MediaPackageV2::ChannelPolicy x-identifiers: - ChannelGroupName - ChannelName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ChannelPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::ChannelPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::ChannelPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::ChannelPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -784,7 +2047,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -799,38 +2062,61 @@ components: name: origin_endpoints id: awscc.mediapackagev2.origin_endpoints x-cfn-schema-name: OriginEndpoint - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' - AND region = 'us-east-1' - origin_endpoint: - name: origin_endpoint - id: awscc.mediapackagev2.origin_endpoint - x-cfn-schema-name: OriginEndpoint - x-type: get + x-cfn-type-name: AWS::MediaPackageV2::OriginEndpoint x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OriginEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::OriginEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::OriginEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::OriginEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -840,19 +2126,24 @@ components: JSON_EXTRACT(Properties, '$.ChannelName') as channel_name, JSON_EXTRACT(Properties, '$.ContainerType') as container_type, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DashManifests') as dash_manifests, JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ForceEndpointErrorConfiguration') as force_endpoint_error_configuration, JSON_EXTRACT(Properties, '$.HlsManifests') as hls_manifests, JSON_EXTRACT(Properties, '$.LowLatencyHlsManifests') as low_latency_hls_manifests, JSON_EXTRACT(Properties, '$.ModifiedAt') as modified_at, JSON_EXTRACT(Properties, '$.OriginEndpointName') as origin_endpoint_name, JSON_EXTRACT(Properties, '$.Segment') as segment, JSON_EXTRACT(Properties, '$.StartoverWindowSeconds') as startover_window_seconds, + JSON_EXTRACT(Properties, '$.DashManifestUrls') as dash_manifest_urls, + JSON_EXTRACT(Properties, '$.HlsManifestUrls') as hls_manifest_urls, + JSON_EXTRACT(Properties, '$.LowLatencyHlsManifestUrls') as low_latency_hls_manifest_urls, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -862,34 +2153,119 @@ components: json_extract_path_text(Properties, 'ChannelName') as channel_name, json_extract_path_text(Properties, 'ContainerType') as container_type, json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DashManifests') as dash_manifests, json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ForceEndpointErrorConfiguration') as force_endpoint_error_configuration, json_extract_path_text(Properties, 'HlsManifests') as hls_manifests, json_extract_path_text(Properties, 'LowLatencyHlsManifests') as low_latency_hls_manifests, json_extract_path_text(Properties, 'ModifiedAt') as modified_at, json_extract_path_text(Properties, 'OriginEndpointName') as origin_endpoint_name, json_extract_path_text(Properties, 'Segment') as segment, json_extract_path_text(Properties, 'StartoverWindowSeconds') as startover_window_seconds, + json_extract_path_text(Properties, 'DashManifestUrls') as dash_manifest_urls, + json_extract_path_text(Properties, 'HlsManifestUrls') as hls_manifest_urls, + json_extract_path_text(Properties, 'LowLatencyHlsManifestUrls') as low_latency_hls_manifest_urls, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' AND data__Identifier = '' AND region = 'us-east-1' - origin_endpoint_policy: - name: origin_endpoint_policy - id: awscc.mediapackagev2.origin_endpoint_policy + origin_endpoints_list_only: + name: origin_endpoints_list_only + id: awscc.mediapackagev2.origin_endpoints_list_only + x-cfn-schema-name: OriginEndpoint + x-cfn-type-name: AWS::MediaPackageV2::OriginEndpoint + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' + AND region = 'us-east-1' + origin_endpoint_policies: + name: origin_endpoint_policies + id: awscc.mediapackagev2.origin_endpoint_policies x-cfn-schema-name: OriginEndpointPolicy - x-type: get + x-cfn-type-name: AWS::MediaPackageV2::OriginEndpointPolicy x-identifiers: - ChannelGroupName - ChannelName - OriginEndpointName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OriginEndpointPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::OriginEndpointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::OriginEndpointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaPackageV2::OriginEndpointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.CdnAuthConfiguration') as cdn_auth_configuration, JSON_EXTRACT(Properties, '$.ChannelGroupName') as channel_group_name, JSON_EXTRACT(Properties, '$.ChannelName') as channel_name, JSON_EXTRACT(Properties, '$.OriginEndpointName') as origin_endpoint_name, @@ -898,11 +2274,12 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'CdnAuthConfiguration') as cdn_auth_configuration, json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, json_extract_path_text(Properties, 'ChannelName') as channel_name, json_extract_path_text(Properties, 'OriginEndpointName') as origin_endpoint_name, @@ -910,3 +2287,366 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpointPolicy' AND data__Identifier = '||' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ChannelGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannelGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ChannelPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannelPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OriginEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOriginEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOriginEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OriginEndpointPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOriginEndpointPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOriginEndpointPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/mediatailor.yaml b/providers/src/awscc/v00.00.00000/services/mediatailor.yaml index 3b2e1df5..c5954e14 100644 --- a/providers/src/awscc/v00.00.00000/services/mediatailor.yaml +++ b/providers/src/awscc/v00.00.00000/services/mediatailor.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MediaTailor - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DashPlaylistSettings: type: object @@ -121,6 +501,11 @@ components: Arn: type: string description:

The ARN of the channel.

+ Audiences: + type: array + items: + type: string + description:

The list of audiences defined in channel.

ChannelName: type: string FillerSlate: @@ -151,13 +536,28 @@ components: - Outputs - PlaybackMode x-stackql-resource-name: channel - x-stackql-primaryIdentifier: + description: Definition of AWS::MediaTailor::Channel Resource Type + x-type-name: AWS::MediaTailor::Channel + x-stackql-primary-identifier: - ChannelName x-create-only-properties: - ChannelName - Tier x-read-only-properties: - Arn + x-required-properties: + - ChannelName + - Outputs + - PlaybackMode + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediatailor:TagResource + - mediatailor:UntagResource x-required-permissions: create: - mediatailor:CreateChannel @@ -191,10 +591,20 @@ components: - ChannelName - Policy x-stackql-resource-name: channel_policy - x-stackql-primaryIdentifier: + description: Definition of AWS::MediaTailor::ChannelPolicy Resource Type + x-type-name: AWS::MediaTailor::ChannelPolicy + x-stackql-primary-identifier: - ChannelName x-create-only-properties: - ChannelName + x-required-properties: + - ChannelName + - Policy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - mediatailor:PutChannelPolicy @@ -256,7 +666,9 @@ components: - LiveSourceName - SourceLocationName x-stackql-resource-name: live_source - x-stackql-primaryIdentifier: + description: Definition of AWS::MediaTailor::LiveSource Resource Type + x-type-name: AWS::MediaTailor::LiveSource + x-stackql-primary-identifier: - LiveSourceName - SourceLocationName x-create-only-properties: @@ -264,6 +676,19 @@ components: - SourceLocationName x-read-only-properties: - Arn + x-required-properties: + - HttpPackageConfigurations + - LiveSourceName + - SourceLocationName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediatailor:TagResource + - mediatailor:UntagResource x-required-permissions: create: - mediatailor:CreateLiveSource @@ -281,22 +706,38 @@ components: - mediatailor:DescribeLiveSource list: - mediatailor:ListLiveSources + AdConditioningConfiguration: + type: object + description:

The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.

+ properties: + StreamingMediaFileConditioning: + $ref: '#/components/schemas/StreamingMediaFileConditioning' + required: + - StreamingMediaFileConditioning + additionalProperties: false AvailSuppression: description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). type: object additionalProperties: false properties: Mode: - description: Sets the ad suppression mode. By default, ad suppression is set to OFF and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. + description: Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value. type: string enum: - 'OFF' - BEHIND_LIVE_EDGE + - AFTER_LIVE_EDGE Value: description: >- A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge. type: string + FillPolicy: + description: Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL + type: string + enum: + - PARTIAL_AVAIL + - FULL_AVAIL_ONLY Bumper: description: The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). type: object @@ -344,6 +785,16 @@ components: ManifestEndpointPrefix: description: The URL generated by MediaTailor to initiate a DASH playback session. The session uses server-side reporting. type: string + StreamingMediaFileConditioning: + type: string + enum: + - TRANSCODE + - NONE + InsertionMode: + type: string + enum: + - STITCHED_ONLY + - PLAYER_SELECT LivePreRollConfiguration: description: The configuration for pre-roll ad insertion. type: object @@ -378,9 +829,56 @@ components: ManifestEndpointPrefix: description: The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. type: string + LogConfiguration: + type: object + additionalProperties: false + properties: + AdsInteractionLog: + description: The event types that MediaTailor emits in logs for interactions with the ADS. + $ref: '#/components/schemas/AdsInteractionLog' + EnabledLoggingStrategies: + description: The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose LEGACY_CLOUDWATCH. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose VENDED_LOGS. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream. To use vended logs, you must configure the delivery destination in Amazon CloudWatch + type: array + items: + type: string + ManifestServiceInteractionLog: + description: The event types that MediaTailor emits in logs for interactions with the origin server. + $ref: '#/components/schemas/ManifestServiceInteractionLog' + PercentEnabled: + description: The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode. + type: integer + minimum: 0 + maximum: 100 + required: + - PercentEnabled + AdsInteractionLog: + type: object + additionalProperties: false + properties: + ExcludeEventTypes: + type: array + description: Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration. + items: + type: string + PublishOptInEventTypes: + type: array + description: Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration. + items: + type: string + ManifestServiceInteractionLog: + type: object + additionalProperties: false + properties: + ExcludeEventTypes: + type: array + description: Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration. + items: + type: string PlaybackConfiguration: type: object properties: + AdConditioningConfiguration: + $ref: '#/components/schemas/AdConditioningConfiguration' AdDecisionServerUrl: description: The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters. type: string @@ -399,6 +897,9 @@ components: DashConfiguration: description: The configuration for DASH content. $ref: '#/components/schemas/DashConfiguration' + InsertionMode: + description: The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched. + $ref: '#/components/schemas/InsertionMode' LivePreRollConfiguration: description: The configuration for pre-roll ad insertion. $ref: '#/components/schemas/LivePreRollConfiguration' @@ -422,6 +923,9 @@ components: HlsConfiguration: description: The configuration for HLS content. $ref: '#/components/schemas/HlsConfiguration' + LogConfiguration: + description: The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration. + $ref: '#/components/schemas/LogConfiguration' PlaybackConfigurationArn: description: The Amazon Resource Name (ARN) for the playback configuration. type: string @@ -449,7 +953,9 @@ components: - VideoContentSourceUrl - AdDecisionServerUrl x-stackql-resource-name: playback_configuration - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MediaTailor::PlaybackConfiguration + x-type-name: AWS::MediaTailor::PlaybackConfiguration + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -459,6 +965,13 @@ components: - DashConfiguration/ManifestEndpointPrefix - PlaybackConfigurationArn - PlaybackEndpointPrefix + x-required-properties: + - Name + - VideoContentSourceUrl + - AdDecisionServerUrl + x-tagging: + taggable: true + cloudFormationSystemTags: false x-required-permissions: create: - mediatailor:PutPlaybackConfiguration @@ -567,12 +1080,26 @@ components: - HttpConfiguration - SourceLocationName x-stackql-resource-name: source_location - x-stackql-primaryIdentifier: + description: Definition of AWS::MediaTailor::SourceLocation Resource Type + x-type-name: AWS::MediaTailor::SourceLocation + x-stackql-primary-identifier: - SourceLocationName x-create-only-properties: - SourceLocationName x-read-only-properties: - Arn + x-required-properties: + - HttpConfiguration + - SourceLocationName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediatailor:TagResource + - mediatailor:UntagResource x-required-permissions: create: - mediatailor:CreateSourceLocation @@ -623,7 +1150,9 @@ components: - SourceLocationName - VodSourceName x-stackql-resource-name: vod_source - x-stackql-primaryIdentifier: + description: Definition of AWS::MediaTailor::VodSource Resource Type + x-type-name: AWS::MediaTailor::VodSource + x-stackql-primary-identifier: - SourceLocationName - VodSourceName x-create-only-properties: @@ -631,6 +1160,19 @@ components: - VodSourceName x-read-only-properties: - Arn + x-required-properties: + - HttpPackageConfigurations + - SourceLocationName + - VodSourceName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mediatailor:TagResource + - mediatailor:UntagResource x-required-permissions: create: - mediatailor:CreateVodSource @@ -648,48 +1190,352 @@ components: - mediatailor:DescribeVodSource list: - mediatailor:ListVodSources + CreateChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The ARN of the channel.

+ Audiences: + type: array + items: + type: string + description:

The list of audiences defined in channel.

+ ChannelName: + type: string + FillerSlate: + $ref: '#/components/schemas/SlateSource' + LogConfiguration: + $ref: '#/components/schemas/LogConfigurationForChannel' + Outputs: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/RequestOutputItem' + description:

The channel's output properties.

+ PlaybackMode: + $ref: '#/components/schemas/PlaybackMode' + Tags: + description: The tags to assign to the channel. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Tier: + $ref: '#/components/schemas/Tier' + TimeShiftConfiguration: + $ref: '#/components/schemas/TimeShiftConfiguration' + x-stackQL-stringOnly: true + x-title: CreateChannelRequest + type: object + required: [] + CreateChannelPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ChannelName: + type: string + Policy: + type: object + description:

The IAM policy for the channel. IAM policies are used to control access to your channel.

+ x-stackQL-stringOnly: true + x-title: CreateChannelPolicyRequest + type: object + required: [] + CreateLiveSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The ARN of the live source.

+ HttpPackageConfigurations: + type: array + items: + $ref: '#/components/schemas/HttpPackageConfiguration' + description:

A list of HTTP package configuration parameters for this live source.

+ LiveSourceName: + type: string + SourceLocationName: + type: string + Tags: + description: The tags to assign to the live source. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateLiveSourceRequest + type: object + required: [] + CreatePlaybackConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdConditioningConfiguration: + $ref: '#/components/schemas/AdConditioningConfiguration' + AdDecisionServerUrl: + description: The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters. + type: string + AvailSuppression: + description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + $ref: '#/components/schemas/AvailSuppression' + Bumper: + description: The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). + $ref: '#/components/schemas/Bumper' + CdnConfiguration: + description: The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. + $ref: '#/components/schemas/CdnConfiguration' + ConfigurationAliases: + description: 'The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables. ' + $ref: '#/components/schemas/ConfigurationAliases' + DashConfiguration: + description: The configuration for DASH content. + $ref: '#/components/schemas/DashConfiguration' + InsertionMode: + description: The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched. + $ref: '#/components/schemas/InsertionMode' + LivePreRollConfiguration: + description: The configuration for pre-roll ad insertion. + $ref: '#/components/schemas/LivePreRollConfiguration' + ManifestProcessingRules: + description: The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor. + $ref: '#/components/schemas/ManifestProcessingRules' + Name: + description: The identifier for the playback configuration. + type: string + pattern: ^[a-zA-Z0-9_-]+$ + maxLength: 64 + minLength: 1 + PersonalizationThresholdSeconds: + description: >- + Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, + see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + type: integer + SessionInitializationEndpointPrefix: + description: The URL that the player uses to initialize a session that uses client-side reporting. + type: string + HlsConfiguration: + description: The configuration for HLS content. + $ref: '#/components/schemas/HlsConfiguration' + LogConfiguration: + description: The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration. + $ref: '#/components/schemas/LogConfiguration' + PlaybackConfigurationArn: + description: The Amazon Resource Name (ARN) for the playback configuration. + type: string + PlaybackEndpointPrefix: + description: The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting. + type: string + SlateAdUrl: + description: The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. + type: string + Tags: + description: The tags to assign to the playback configuration. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + TranscodeProfileName: + description: The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support. + type: string + VideoContentSourceUrl: + description: The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters. + type: string + x-stackQL-stringOnly: true + x-title: CreatePlaybackConfigurationRequest + type: object + required: [] + CreateSourceLocationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessConfiguration: + $ref: '#/components/schemas/AccessConfiguration' + Arn: + type: string + description:

The ARN of the source location.

+ DefaultSegmentDeliveryConfiguration: + $ref: '#/components/schemas/DefaultSegmentDeliveryConfiguration' + HttpConfiguration: + $ref: '#/components/schemas/HttpConfiguration' + SegmentDeliveryConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SegmentDeliveryConfiguration' + description:

A list of the segment delivery configurations associated with this resource.

+ SourceLocationName: + type: string + Tags: + description: The tags to assign to the source location. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSourceLocationRequest + type: object + required: [] + CreateVodSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The ARN of the VOD source.

+ HttpPackageConfigurations: + type: array + items: + $ref: '#/components/schemas/HttpPackageConfiguration' + description:

A list of HTTP package configuration parameters for this VOD source.

+ SourceLocationName: + type: string + Tags: + description: The tags to assign to the VOD source. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + VodSourceName: + type: string + x-stackQL-stringOnly: true + x-title: CreateVodSourceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: channels: name: channels id: awscc.mediatailor.channels x-cfn-schema-name: Channel - x-type: list - x-identifiers: - - ChannelName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ChannelName') as channel_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ChannelName') as channel_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: awscc.mediatailor.channel - x-cfn-schema-name: Channel - x-type: get + x-cfn-type-name: AWS::MediaTailor::Channel x-identifiers: - ChannelName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::Channel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Audiences') as audiences, JSON_EXTRACT(Properties, '$.ChannelName') as channel_name, JSON_EXTRACT(Properties, '$.FillerSlate') as filler_slate, JSON_EXTRACT(Properties, '$.LogConfiguration') as log_configuration, @@ -702,12 +1548,13 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Audiences') as audiences, json_extract_path_text(Properties, 'ChannelName') as channel_name, json_extract_path_text(Properties, 'FillerSlate') as filler_slate, json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, @@ -719,13 +1566,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::Channel' AND data__Identifier = '' AND region = 'us-east-1' - channel_policy: - name: channel_policy - id: awscc.mediatailor.channel_policy - x-cfn-schema-name: ChannelPolicy - x-type: get + channels_list_only: + name: channels_list_only + id: awscc.mediatailor.channels_list_only + x-cfn-schema-name: Channel + x-cfn-type-name: AWS::MediaTailor::Channel x-identifiers: - ChannelName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -733,63 +1586,156 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ChannelName') as channel_name, - JSON_EXTRACT(Properties, '$.Policy') as policy - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::ChannelPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ChannelName') as channel_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ChannelName') as channel_name, - json_extract_path_text(Properties, 'Policy') as policy - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::ChannelPolicy' - AND data__Identifier = '' + json_extract_path_text(Properties, 'ChannelName') as channel_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' AND region = 'us-east-1' - live_sources: - name: live_sources - id: awscc.mediatailor.live_sources - x-cfn-schema-name: LiveSource - x-type: list + channel_policies: + name: channel_policies + id: awscc.mediatailor.channel_policies + x-cfn-schema-name: ChannelPolicy + x-cfn-type-name: AWS::MediaTailor::ChannelPolicy x-identifiers: - - LiveSourceName - - SourceLocationName + - ChannelName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ChannelPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::ChannelPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::ChannelPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::ChannelPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.LiveSourceName') as live_source_name, - JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' + data__Identifier, + JSON_EXTRACT(Properties, '$.ChannelName') as channel_name, + JSON_EXTRACT(Properties, '$.Policy') as policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::ChannelPolicy' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'LiveSourceName') as live_source_name, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' + data__Identifier, + json_extract_path_text(Properties, 'ChannelName') as channel_name, + json_extract_path_text(Properties, 'Policy') as policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::ChannelPolicy' + AND data__Identifier = '' AND region = 'us-east-1' - live_source: - name: live_source - id: awscc.mediatailor.live_source + live_sources: + name: live_sources + id: awscc.mediatailor.live_sources x-cfn-schema-name: LiveSource - x-type: get + x-cfn-type-name: AWS::MediaTailor::LiveSource x-identifiers: - LiveSourceName - SourceLocationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LiveSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::LiveSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::LiveSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::LiveSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/live_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/live_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/live_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -803,7 +1749,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -816,13 +1762,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' AND data__Identifier = '|' AND region = 'us-east-1' - playback_configurations: - name: playback_configurations - id: awscc.mediatailor.playback_configurations - x-cfn-schema-name: PlaybackConfiguration - x-type: list + live_sources_list_only: + name: live_sources_list_only + id: awscc.mediatailor.live_sources_list_only + x-cfn-schema-name: LiveSource + x-cfn-type-name: AWS::MediaTailor::LiveSource x-identifiers: - - Name + - LiveSourceName + - SourceLocationName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -830,44 +1783,97 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' + JSON_EXTRACT(Properties, '$.LiveSourceName') as live_source_name, + JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' + json_extract_path_text(Properties, 'LiveSourceName') as live_source_name, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' AND region = 'us-east-1' - playback_configuration: - name: playback_configuration - id: awscc.mediatailor.playback_configuration + playback_configurations: + name: playback_configurations + id: awscc.mediatailor.playback_configurations x-cfn-schema-name: PlaybackConfiguration - x-type: get + x-cfn-type-name: AWS::MediaTailor::PlaybackConfiguration x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PlaybackConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::PlaybackConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::PlaybackConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::PlaybackConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.AdConditioningConfiguration') as ad_conditioning_configuration, JSON_EXTRACT(Properties, '$.AdDecisionServerUrl') as ad_decision_server_url, JSON_EXTRACT(Properties, '$.AvailSuppression') as avail_suppression, JSON_EXTRACT(Properties, '$.Bumper') as bumper, JSON_EXTRACT(Properties, '$.CdnConfiguration') as cdn_configuration, JSON_EXTRACT(Properties, '$.ConfigurationAliases') as configuration_aliases, JSON_EXTRACT(Properties, '$.DashConfiguration') as dash_configuration, + JSON_EXTRACT(Properties, '$.InsertionMode') as insertion_mode, JSON_EXTRACT(Properties, '$.LivePreRollConfiguration') as live_pre_roll_configuration, JSON_EXTRACT(Properties, '$.ManifestProcessingRules') as manifest_processing_rules, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.PersonalizationThresholdSeconds') as personalization_threshold_seconds, JSON_EXTRACT(Properties, '$.SessionInitializationEndpointPrefix') as session_initialization_endpoint_prefix, JSON_EXTRACT(Properties, '$.HlsConfiguration') as hls_configuration, + JSON_EXTRACT(Properties, '$.LogConfiguration') as log_configuration, JSON_EXTRACT(Properties, '$.PlaybackConfigurationArn') as playback_configuration_arn, JSON_EXTRACT(Properties, '$.PlaybackEndpointPrefix') as playback_endpoint_prefix, JSON_EXTRACT(Properties, '$.SlateAdUrl') as slate_ad_url, @@ -878,23 +1884,26 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'AdConditioningConfiguration') as ad_conditioning_configuration, json_extract_path_text(Properties, 'AdDecisionServerUrl') as ad_decision_server_url, json_extract_path_text(Properties, 'AvailSuppression') as avail_suppression, json_extract_path_text(Properties, 'Bumper') as bumper, json_extract_path_text(Properties, 'CdnConfiguration') as cdn_configuration, json_extract_path_text(Properties, 'ConfigurationAliases') as configuration_aliases, json_extract_path_text(Properties, 'DashConfiguration') as dash_configuration, + json_extract_path_text(Properties, 'InsertionMode') as insertion_mode, json_extract_path_text(Properties, 'LivePreRollConfiguration') as live_pre_roll_configuration, json_extract_path_text(Properties, 'ManifestProcessingRules') as manifest_processing_rules, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'PersonalizationThresholdSeconds') as personalization_threshold_seconds, json_extract_path_text(Properties, 'SessionInitializationEndpointPrefix') as session_initialization_endpoint_prefix, json_extract_path_text(Properties, 'HlsConfiguration') as hls_configuration, + json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, json_extract_path_text(Properties, 'PlaybackConfigurationArn') as playback_configuration_arn, json_extract_path_text(Properties, 'PlaybackEndpointPrefix') as playback_endpoint_prefix, json_extract_path_text(Properties, 'SlateAdUrl') as slate_ad_url, @@ -904,13 +1913,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - source_locations: - name: source_locations - id: awscc.mediatailor.source_locations - x-cfn-schema-name: SourceLocation - x-type: list + playback_configurations_list_only: + name: playback_configurations_list_only + id: awscc.mediatailor.playback_configurations_list_only + x-cfn-schema-name: PlaybackConfiguration + x-cfn-type-name: AWS::MediaTailor::PlaybackConfiguration x-identifiers: - - SourceLocationName + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -918,28 +1933,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' AND region = 'us-east-1' - source_location: - name: source_location - id: awscc.mediatailor.source_location + source_locations: + name: source_locations + id: awscc.mediatailor.source_locations x-cfn-schema-name: SourceLocation - x-type: get + x-cfn-type-name: AWS::MediaTailor::SourceLocation x-identifiers: - SourceLocationName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SourceLocation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::SourceLocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::SourceLocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::SourceLocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/source_locations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/source_locations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/source_locations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -955,7 +2018,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -970,14 +2033,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' AND data__Identifier = '' AND region = 'us-east-1' - vod_sources: - name: vod_sources - id: awscc.mediatailor.vod_sources - x-cfn-schema-name: VodSource - x-type: list + source_locations_list_only: + name: source_locations_list_only + id: awscc.mediatailor.source_locations_list_only + x-cfn-schema-name: SourceLocation + x-cfn-type-name: AWS::MediaTailor::SourceLocation x-identifiers: - SourceLocationName - - VodSourceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -985,31 +2053,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name, - JSON_EXTRACT(Properties, '$.VodSourceName') as vod_source_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' + JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, - json_extract_path_text(Properties, 'VodSourceName') as vod_source_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' AND region = 'us-east-1' - vod_source: - name: vod_source - id: awscc.mediatailor.vod_source + vod_sources: + name: vod_sources + id: awscc.mediatailor.vod_sources x-cfn-schema-name: VodSource - x-type: get + x-cfn-type-name: AWS::MediaTailor::VodSource x-identifiers: - SourceLocationName - VodSourceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VodSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::VodSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::VodSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MediaTailor::VodSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vod_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vod_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vod_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1023,7 +2137,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1036,3 +2150,442 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::VodSource' AND data__Identifier = '|' AND region = 'us-east-1' + vod_sources_list_only: + name: vod_sources_list_only + id: awscc.mediatailor.vod_sources_list_only + x-cfn-schema-name: VodSource + x-cfn-type-name: AWS::MediaTailor::VodSource + x-identifiers: + - SourceLocationName + - VodSourceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name, + JSON_EXTRACT(Properties, '$.VodSourceName') as vod_source_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, + json_extract_path_text(Properties, 'VodSourceName') as vod_source_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Channel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ChannelPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannelPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LiveSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLiveSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLiveSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PlaybackConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlaybackConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlaybackConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SourceLocation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSourceLocation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSourceLocationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VodSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVodSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVodSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/memorydb.yaml b/providers/src/awscc/v00.00.00000/services/memorydb.yaml index 52a6d133..1a602ff0 100644 --- a/providers/src/awscc/v00.00.00000/services/memorydb.yaml +++ b/providers/src/awscc/v00.00.00000/services/memorydb.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MemoryDB - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -56,19 +436,34 @@ components: required: - ACLName x-stackql-resource-name: acl - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MemoryDB::ACL + x-type-name: AWS::MemoryDB::ACL + x-stackql-primary-identifier: - ACLName x-create-only-properties: - ACLName x-read-only-properties: - Status - Arn + x-required-properties: + - ACLName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - memorydb:TagResource + - memorydb:ListTags + - memorydb:UntagResource x-required-permissions: create: - memorydb:CreateACL - memorydb:DescribeACLs - memorydb:TagResource - memorydb:ListTags + - iam:CreateServiceLinkedRole read: - memorydb:DescribeACLs - memorydb:ListTags @@ -100,6 +495,17 @@ components: enum: - 'true' - 'false' + SupportedNetworkTypes: + type: string + enum: + - ipv4 + - ipv6 + - dual_stack + SupportedIpDiscoveryTypes: + type: string + enum: + - ipv4 + - ipv6 Cluster: type: object properties: @@ -110,6 +516,9 @@ components: Description: description: An optional description of the cluster. type: string + MultiRegionClusterName: + description: The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix. + type: string Status: description: The status of the cluster. For example, Available, Updating, Creating. type: string @@ -170,6 +579,14 @@ components: type: object description: Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. $ref: '#/components/schemas/DataTieringStatus' + NetworkType: + type: object + description: Must be either ipv4 | ipv6 | dual_stack. + $ref: '#/components/schemas/SupportedNetworkTypes' + IpDiscovery: + type: object + description: For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as `cluster info` and `cluster nodes` which are used by clients to connect to the nodes in the cluster. + $ref: '#/components/schemas/SupportedIpDiscoveryTypes' KmsKeyId: description: The ID of the KMS key used to encrypt the cluster. type: string @@ -189,6 +606,9 @@ components: ARN: description: The Amazon Resource Name (ARN) of the cluster. type: string + Engine: + description: The engine type used by the cluster. + type: string EngineVersion: description: The Redis engine version used by the cluster. type: string @@ -214,7 +634,9 @@ components: - NodeType - ACLName x-stackql-resource-name: cluster - x-stackql-primaryIdentifier: + description: The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster. + x-type-name: AWS::MemoryDB::Cluster + x-stackql-primary-identifier: - ClusterName x-create-only-properties: - ClusterName @@ -223,19 +645,44 @@ components: - KmsKeyId - Port - SubnetGroupName + - SnapshotArns + - MultiRegionClusterName + - SnapshotName + - NetworkType + x-write-only-properties: - SnapshotArns - SnapshotName + - MultiRegionClusterName + - FinalSnapshotName x-read-only-properties: - Status - ClusterEndpoint/Address - ClusterEndpoint/Port - ARN - ParameterGroupStatus + x-required-properties: + - ClusterName + - NodeType + - ACLName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - memorydb:TagResource + - memorydb:ListTags + - memorydb:UntagResource x-required-permissions: create: + - kms:DescribeKey + - kms:CreateGrant - memorydb:CreateCluster - memorydb:DescribeClusters + - memorydb:TagResource - memorydb:ListTags + - iam:CreateServiceLinkedRole read: - memorydb:DescribeClusters - memorydb:ListTags @@ -250,6 +697,112 @@ components: - memorydb:DescribeClusters list: - memorydb:DescribeClusters + MultiRegionCluster: + type: object + properties: + MultiRegionClusterNameSuffix: + description: The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier. + pattern: '[a-z][a-z0-9\-]*' + type: string + Description: + description: Description of the multi region cluster. + type: string + MultiRegionClusterName: + description: The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix. + type: string + Status: + description: The status of the multi region cluster. For example, Available, Updating, Creating. + type: string + NodeType: + description: The compute and memory capacity of the nodes in the multi region cluster. + type: string + NumShards: + description: The number of shards the multi region cluster will contain. + type: integer + MultiRegionParameterGroupName: + description: The name of the parameter group associated with the multi region cluster. + type: string + TLSEnabled: + description: |- + A flag that enables in-transit encryption when set to true. + + You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. + type: boolean + ARN: + description: The Amazon Resource Name (ARN) of the multi region cluster. + type: string + Engine: + description: The engine type used by the multi region cluster. + type: string + EngineVersion: + description: The Redis engine version used by the multi region cluster. + type: string + Tags: + description: An array of key-value pairs to apply to this multi region cluster. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + UpdateStrategy: + description: An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'. + type: string + enum: + - COORDINATED + - UNCOORDINATED + required: + - NodeType + x-stackql-resource-name: multi_region_cluster + description: The AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster. + x-type-name: AWS::MemoryDB::MultiRegionCluster + x-stackql-primary-identifier: + - MultiRegionClusterName + x-create-only-properties: + - MultiRegionClusterNameSuffix + - EngineVersion + - MultiRegionParameterGroupName + - TLSEnabled + x-write-only-properties: + - MultiRegionClusterNameSuffix + - UpdateStrategy + x-read-only-properties: + - MultiRegionClusterName + - Status + - ARN + x-required-properties: + - NodeType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - memorydb:TagResource + - memorydb:ListTags + - memorydb:UntagResource + x-required-permissions: + create: + - memorydb:CreateMultiRegionCluster + - memorydb:DescribeMultiRegionClusters + - memorydb:TagResource + - memorydb:ListTags + - iam:CreateServiceLinkedRole + read: + - memorydb:DescribeMultiRegionClusters + - memorydb:ListTags + update: + - memorydb:UpdateMultiRegionCluster + - memorydb:DescribeMultiRegionClusters + - memorydb:ListTags + - memorydb:TagResource + - memorydb:UntagResource + delete: + - memorydb:DeleteMultiRegionCluster + - memorydb:DescribeMultiRegionClusters + list: + - memorydb:DescribeMultiRegionClusters ParameterGroup: type: object properties: @@ -280,20 +833,38 @@ components: - ParameterGroupName - Family x-stackql-resource-name: parameter_group - x-stackql-primaryIdentifier: + description: The AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup. + x-type-name: AWS::MemoryDB::ParameterGroup + x-stackql-primary-identifier: - ParameterGroupName x-create-only-properties: - ParameterGroupName - Family - Description + x-write-only-properties: + - Parameters x-read-only-properties: - ARN + x-required-properties: + - ParameterGroupName + - Family + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - memorydb:TagResource + - memorydb:ListTags + - memorydb:UntagResource x-required-permissions: create: - memorydb:CreateParameterGroup - memorydb:DescribeParameterGroups - memorydb:TagResource - memorydb:ListTags + - iam:CreateServiceLinkedRole read: - memorydb:DescribeParameterGroups - memorydb:ListTags @@ -337,22 +908,46 @@ components: ARN: description: The Amazon Resource Name (ARN) of the subnet group. type: string + SupportedNetworkTypes: + description: Supported network types would be a list of network types supported by subnet group and can be either [ipv4] or [ipv4, dual_stack] or [ipv6]. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string required: - SubnetGroupName - SubnetIds x-stackql-resource-name: subnet_group - x-stackql-primaryIdentifier: + description: The AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group. + x-type-name: AWS::MemoryDB::SubnetGroup + x-stackql-primary-identifier: - SubnetGroupName x-create-only-properties: - SubnetGroupName x-read-only-properties: - ARN + - SupportedNetworkTypes + x-required-properties: + - SubnetGroupName + - SubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - memorydb:TagResource + - memorydb:ListTags + - memorydb:UntagResource x-required-permissions: create: - memorydb:CreateSubnetGroup - memorydb:DescribeSubnetGroups - memorydb:TagResource - memorydb:ListTags + - iam:CreateServiceLinkedRole read: - memorydb:DescribeSubnetGroups - memorydb:ListTags @@ -414,19 +1009,37 @@ components: required: - UserName x-stackql-resource-name: user - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MemoryDB::User + x-type-name: AWS::MemoryDB::User + x-stackql-primary-identifier: - UserName x-create-only-properties: - UserName + x-write-only-properties: + - AuthenticationMode + - AccessString x-read-only-properties: - Status - Arn + x-required-properties: + - UserName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - memorydb:TagResource + - memorydb:ListTags + - memorydb:UntagResource x-required-permissions: create: - memorydb:CreateUser - memorydb:DescribeUsers - memorydb:TagResource - memorydb:ListTags + - iam:CreateServiceLinkedRole read: - memorydb:DescribeUsers - memorydb:ListTags @@ -442,43 +1055,468 @@ components: list: - memorydb:DescribeUsers - memorydb:ListTags + CreateACLRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: Indicates acl status. Can be "creating", "active", "modifying", "deleting". + type: string + ACLName: + description: The name of the acl. + pattern: '[a-z][a-z0-9\\-]*' + type: string + UserNames: + type: array + x-$comment: List of users. + uniqueItems: true + x-insertionOrder: true + items: + type: string + description: List of users associated to this acl. + Arn: + description: The Amazon Resource Name (ARN) of the acl. + type: string + Tags: + description: An array of key-value pairs to apply to this cluster. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateACLRequest + type: object + required: [] + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + description: The name of the cluster. This value must be unique as it also serves as the cluster identifier. + pattern: '[a-z][a-z0-9\-]*' + type: string + Description: + description: An optional description of the cluster. + type: string + MultiRegionClusterName: + description: The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix. + type: string + Status: + description: The status of the cluster. For example, Available, Updating, Creating. + type: string + NodeType: + description: The compute and memory capacity of the nodes in the cluster. + type: string + NumShards: + description: The number of shards the cluster will contain. + type: integer + NumReplicasPerShard: + description: The number of replicas to apply to each shard. The limit is 5. + type: integer + SubnetGroupName: + description: The name of the subnet group to be used for the cluster. + type: string + SecurityGroupIds: + description: One or more Amazon VPC security groups associated with this cluster. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + MaintenanceWindow: + description: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. + type: string + ParameterGroupName: + description: The name of the parameter group associated with the cluster. + type: string + ParameterGroupStatus: + description: The status of the parameter group used by the cluster. + type: string + Port: + description: The port number on which each member of the cluster accepts connections. + type: integer + SnapshotRetentionLimit: + description: The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. + type: integer + SnapshotWindow: + description: The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster. + type: string + ACLName: + description: The name of the Access Control List to associate with the cluster. + type: string + pattern: '[a-zA-Z][a-zA-Z0-9\-]*' + SnsTopicArn: + description: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. + type: string + SnsTopicStatus: + description: The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled. + type: string + TLSEnabled: + description: |- + A flag that enables in-transit encryption when set to true. + + You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. + type: boolean + DataTiering: + type: object + description: Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. + $ref: '#/components/schemas/DataTieringStatus' + NetworkType: + type: object + description: Must be either ipv4 | ipv6 | dual_stack. + $ref: '#/components/schemas/SupportedNetworkTypes' + IpDiscovery: + type: object + description: For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as `cluster info` and `cluster nodes` which are used by clients to connect to the nodes in the cluster. + $ref: '#/components/schemas/SupportedIpDiscoveryTypes' + KmsKeyId: + description: The ID of the KMS key used to encrypt the cluster. + type: string + SnapshotArns: + description: A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + SnapshotName: + description: The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created. + type: string + FinalSnapshotName: + description: The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward. + type: string + ARN: + description: The Amazon Resource Name (ARN) of the cluster. + type: string + Engine: + description: The engine type used by the cluster. + type: string + EngineVersion: + description: The Redis engine version used by the cluster. + type: string + ClusterEndpoint: + description: The cluster endpoint. + $ref: '#/components/schemas/Endpoint' + AutoMinorVersionUpgrade: + description: |- + A flag that enables automatic minor version upgrade when set to true. + + You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster. + type: boolean + Tags: + description: An array of key-value pairs to apply to this cluster. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateMultiRegionClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MultiRegionClusterNameSuffix: + description: The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier. + pattern: '[a-z][a-z0-9\-]*' + type: string + Description: + description: Description of the multi region cluster. + type: string + MultiRegionClusterName: + description: The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix. + type: string + Status: + description: The status of the multi region cluster. For example, Available, Updating, Creating. + type: string + NodeType: + description: The compute and memory capacity of the nodes in the multi region cluster. + type: string + NumShards: + description: The number of shards the multi region cluster will contain. + type: integer + MultiRegionParameterGroupName: + description: The name of the parameter group associated with the multi region cluster. + type: string + TLSEnabled: + description: |- + A flag that enables in-transit encryption when set to true. + + You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. + type: boolean + ARN: + description: The Amazon Resource Name (ARN) of the multi region cluster. + type: string + Engine: + description: The engine type used by the multi region cluster. + type: string + EngineVersion: + description: The Redis engine version used by the multi region cluster. + type: string + Tags: + description: An array of key-value pairs to apply to this multi region cluster. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + UpdateStrategy: + description: An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'. + type: string + enum: + - COORDINATED + - UNCOORDINATED + x-stackQL-stringOnly: true + x-title: CreateMultiRegionClusterRequest + type: object + required: [] + CreateParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ParameterGroupName: + description: The name of the parameter group. + type: string + Family: + description: The name of the parameter group family that this parameter group is compatible with. + type: string + Description: + description: A description of the parameter group. + type: string + Tags: + description: An array of key-value pairs to apply to this parameter group. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Parameters: + description: An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. + type: object + ARN: + description: The Amazon Resource Name (ARN) of the parameter group. + type: string + x-stackQL-stringOnly: true + x-title: CreateParameterGroupRequest + type: object + required: [] + CreateSubnetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SubnetGroupName: + description: The name of the subnet group. This value must be unique as it also serves as the subnet group identifier. + pattern: '[a-z][a-z0-9\-]*' + type: string + Description: + description: An optional description of the subnet group. + type: string + SubnetIds: + description: A list of VPC subnet IDs for the subnet group. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Tags: + description: An array of key-value pairs to apply to this subnet group. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + ARN: + description: The Amazon Resource Name (ARN) of the subnet group. + type: string + SupportedNetworkTypes: + description: Supported network types would be a list of network types supported by subnet group and can be either [ipv4] or [ipv4, dual_stack] or [ipv6]. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateSubnetGroupRequest + type: object + required: [] + CreateUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: Indicates the user status. Can be "active", "modifying" or "deleting". + type: string + UserName: + description: The name of the user. + pattern: '[a-z][a-z0-9\\-]*' + type: string + AccessString: + description: Access permissions string used for this user account. + type: string + AuthenticationMode: + type: object + properties: + Type: + type: string + description: Type of authentication strategy for this user. + enum: + - password + - iam + Passwords: + type: array + x-$comment: List of passwords. + uniqueItems: true + x-insertionOrder: true + maxItems: 2 + minItems: 1 + items: + type: string + description: Passwords used for this user account. You can create up to two passwords for each user. + additionalProperties: false + Arn: + description: The Amazon Resource Name (ARN) of the user account. + type: string + Tags: + description: An array of key-value pairs to apply to this user. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateUserRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: acls: name: acls id: awscc.memorydb.acls x-cfn-schema-name: ACL - x-type: list - x-identifiers: - - ACLName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ACLName') as acl_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ACLName') as acl_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' - AND region = 'us-east-1' - acl: - name: acl - id: awscc.memorydb.acl - x-cfn-schema-name: ACL - x-type: get + x-cfn-type-name: AWS::MemoryDB::ACL x-identifiers: - ACLName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ACL&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::ACL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::ACL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::ACL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/acls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/acls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -492,7 +1530,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -505,13 +1543,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::ACL' AND data__Identifier = '' AND region = 'us-east-1' - clusters: - name: clusters - id: awscc.memorydb.clusters - x-cfn-schema-name: Cluster - x-type: list + acls_list_only: + name: acls_list_only + id: awscc.memorydb.acls_list_only + x-cfn-schema-name: ACL + x-cfn-type-name: AWS::MemoryDB::ACL x-identifiers: - - ClusterName + - ACLName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -519,34 +1563,83 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' + JSON_EXTRACT(Properties, '$.ACLName') as acl_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClusterName') as cluster_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' + json_extract_path_text(Properties, 'ACLName') as acl_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' AND region = 'us-east-1' - cluster: - name: cluster - id: awscc.memorydb.cluster + clusters: + name: clusters + id: awscc.memorydb.clusters x-cfn-schema-name: Cluster - x-type: get + x-cfn-type-name: AWS::MemoryDB::Cluster x-identifiers: - ClusterName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.MultiRegionClusterName') as multi_region_cluster_name, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.NodeType') as node_type, JSON_EXTRACT(Properties, '$.NumShards') as num_shards, @@ -564,11 +1657,14 @@ components: JSON_EXTRACT(Properties, '$.SnsTopicStatus') as sns_topic_status, JSON_EXTRACT(Properties, '$.TLSEnabled') as tls_enabled, JSON_EXTRACT(Properties, '$.DataTiering') as data_tiering, + JSON_EXTRACT(Properties, '$.NetworkType') as network_type, + JSON_EXTRACT(Properties, '$.IpDiscovery') as ip_discovery, JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, JSON_EXTRACT(Properties, '$.SnapshotArns') as snapshot_arns, JSON_EXTRACT(Properties, '$.SnapshotName') as snapshot_name, JSON_EXTRACT(Properties, '$.FinalSnapshotName') as final_snapshot_name, JSON_EXTRACT(Properties, '$.ARN') as arn, + JSON_EXTRACT(Properties, '$.Engine') as engine, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, JSON_EXTRACT(Properties, '$.ClusterEndpoint') as cluster_endpoint, JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, @@ -577,13 +1673,14 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'ClusterName') as cluster_name, json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MultiRegionClusterName') as multi_region_cluster_name, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'NodeType') as node_type, json_extract_path_text(Properties, 'NumShards') as num_shards, @@ -601,11 +1698,14 @@ components: json_extract_path_text(Properties, 'SnsTopicStatus') as sns_topic_status, json_extract_path_text(Properties, 'TLSEnabled') as tls_enabled, json_extract_path_text(Properties, 'DataTiering') as data_tiering, + json_extract_path_text(Properties, 'NetworkType') as network_type, + json_extract_path_text(Properties, 'IpDiscovery') as ip_discovery, json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, json_extract_path_text(Properties, 'SnapshotArns') as snapshot_arns, json_extract_path_text(Properties, 'SnapshotName') as snapshot_name, json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name, json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'Engine') as engine, json_extract_path_text(Properties, 'EngineVersion') as engine_version, json_extract_path_text(Properties, 'ClusterEndpoint') as cluster_endpoint, json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, @@ -613,13 +1713,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::Cluster' AND data__Identifier = '' AND region = 'us-east-1' - parameter_groups: - name: parameter_groups - id: awscc.memorydb.parameter_groups - x-cfn-schema-name: ParameterGroup - x-type: list + clusters_list_only: + name: clusters_list_only + id: awscc.memorydb.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::MemoryDB::Cluster x-identifiers: - - ParameterGroupName + - ClusterName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -627,28 +1733,208 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' + json_extract_path_text(Properties, 'ClusterName') as cluster_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' + AND region = 'us-east-1' + multi_region_clusters: + name: multi_region_clusters + id: awscc.memorydb.multi_region_clusters + x-cfn-schema-name: MultiRegionCluster + x-cfn-type-name: AWS::MemoryDB::MultiRegionCluster + x-identifiers: + - MultiRegionClusterName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MultiRegionCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::MultiRegionCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::MultiRegionCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::MultiRegionCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multi_region_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multi_region_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/multi_region_clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.MultiRegionClusterNameSuffix') as multi_region_cluster_name_suffix, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.MultiRegionClusterName') as multi_region_cluster_name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.NodeType') as node_type, + JSON_EXTRACT(Properties, '$.NumShards') as num_shards, + JSON_EXTRACT(Properties, '$.MultiRegionParameterGroupName') as multi_region_parameter_group_name, + JSON_EXTRACT(Properties, '$.TLSEnabled') as tls_enabled, + JSON_EXTRACT(Properties, '$.ARN') as arn, + JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdateStrategy') as update_strategy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::MultiRegionCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MultiRegionClusterNameSuffix') as multi_region_cluster_name_suffix, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MultiRegionClusterName') as multi_region_cluster_name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'NodeType') as node_type, + json_extract_path_text(Properties, 'NumShards') as num_shards, + json_extract_path_text(Properties, 'MultiRegionParameterGroupName') as multi_region_parameter_group_name, + json_extract_path_text(Properties, 'TLSEnabled') as tls_enabled, + json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateStrategy') as update_strategy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::MultiRegionCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + multi_region_clusters_list_only: + name: multi_region_clusters_list_only + id: awscc.memorydb.multi_region_clusters_list_only + x-cfn-schema-name: MultiRegionCluster + x-cfn-type-name: AWS::MemoryDB::MultiRegionCluster + x-identifiers: + - MultiRegionClusterName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.MultiRegionClusterName') as multi_region_cluster_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::MultiRegionCluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MultiRegionClusterName') as multi_region_cluster_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::MultiRegionCluster' AND region = 'us-east-1' - parameter_group: - name: parameter_group - id: awscc.memorydb.parameter_group + parameter_groups: + name: parameter_groups + id: awscc.memorydb.parameter_groups x-cfn-schema-name: ParameterGroup - x-type: get + x-cfn-type-name: AWS::MemoryDB::ParameterGroup x-identifiers: - ParameterGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -663,7 +1949,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -677,13 +1963,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' AND data__Identifier = '' AND region = 'us-east-1' - subnet_groups: - name: subnet_groups - id: awscc.memorydb.subnet_groups - x-cfn-schema-name: SubnetGroup - x-type: list + parameter_groups_list_only: + name: parameter_groups_list_only + id: awscc.memorydb.parameter_groups_list_only + x-cfn-schema-name: ParameterGroup + x-cfn-type-name: AWS::MemoryDB::ParameterGroup x-identifiers: - - SubnetGroupName + - ParameterGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -691,28 +1983,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' + JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' AND region = 'us-east-1' - subnet_group: - name: subnet_group - id: awscc.memorydb.subnet_group + subnet_groups: + name: subnet_groups + id: awscc.memorydb.subnet_groups x-cfn-schema-name: SubnetGroup - x-type: get + x-cfn-type-name: AWS::MemoryDB::SubnetGroup x-identifiers: - SubnetGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubnetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::SubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::SubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::SubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -721,12 +2061,13 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ARN') as arn + JSON_EXTRACT(Properties, '$.ARN') as arn, + JSON_EXTRACT(Properties, '$.SupportedNetworkTypes') as supported_network_types FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -735,17 +2076,24 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ARN') as arn + json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'SupportedNetworkTypes') as supported_network_types FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' AND data__Identifier = '' AND region = 'us-east-1' - users: - name: users - id: awscc.memorydb.users - x-cfn-schema-name: User - x-type: list + subnet_groups_list_only: + name: subnet_groups_list_only + id: awscc.memorydb.subnet_groups_list_only + x-cfn-schema-name: SubnetGroup + x-cfn-type-name: AWS::MemoryDB::SubnetGroup x-identifiers: - - UserName + - SubnetGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -753,28 +2101,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserName') as user_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' + JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserName') as user_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' + json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' AND region = 'us-east-1' - user: - name: user - id: awscc.memorydb.user + users: + name: users + id: awscc.memorydb.users x-cfn-schema-name: User - x-type: get + x-cfn-type-name: AWS::MemoryDB::User x-identifiers: - UserName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MemoryDB::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -789,7 +2185,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -803,3 +2199,439 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::User' AND data__Identifier = '' AND region = 'us-east-1' + users_list_only: + name: users_list_only + id: awscc.memorydb.users_list_only + x-cfn-schema-name: User + x-cfn-type-name: AWS::MemoryDB::User + x-identifiers: + - UserName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserName') as user_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserName') as user_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ACL&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateACL + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateACLRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MultiRegionCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMultiRegionCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMultiRegionClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubnetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubnetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubnetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/mpa.yaml b/providers/src/awscc/v00.00.00000/services/mpa.yaml new file mode 100644 index 00000000..3cec5872 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/mpa.yaml @@ -0,0 +1,1261 @@ +openapi: 3.0.0 +info: + title: MPA + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Timestamp: + type: string + format: date-time + MofNApprovalStrategy: + type: object + properties: + MinApprovalsRequired: + type: integer + additionalProperties: false + required: + - MinApprovalsRequired + ApprovalStrategy: + type: object + properties: + MofN: + $ref: '#/components/schemas/MofNApprovalStrategy' + additionalProperties: false + required: + - MofN + Approver: + type: object + properties: + PrimaryIdentityId: + type: string + PrimaryIdentitySourceArn: + type: string + ApproverId: + type: string + ResponseTime: + $ref: '#/components/schemas/Timestamp' + PrimaryIdentityStatus: + type: string + additionalProperties: false + required: + - PrimaryIdentityId + - PrimaryIdentitySourceArn + Policy: + properties: + PolicyArn: + type: string + additionalProperties: false + required: + - PolicyArn + Tag: + type: object + additionalProperties: false + properties: + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + Value: + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + required: + - Value + - Key + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + ApprovalTeam: + type: object + properties: + ApprovalStrategy: + $ref: '#/components/schemas/ApprovalStrategy' + Approvers: + type: array + items: + $ref: '#/components/schemas/Approver' + minItems: 1 + x-insertionOrder: false + uniqueItems: true + Tags: + $ref: '#/components/schemas/Tags' + Policies: + type: array + items: + $ref: '#/components/schemas/Policy' + minItems: 1 + x-insertionOrder: false + uniqueItems: true + Name: + type: string + Description: + type: string + Arn: + type: string + VersionId: + type: string + UpdateSessionArn: + type: string + CreationTime: + $ref: '#/components/schemas/Timestamp' + LastUpdateTime: + $ref: '#/components/schemas/Timestamp' + NumberOfApprovers: + type: integer + Status: + type: string + StatusCode: + type: string + StatusMessage: + type: string + required: + - ApprovalStrategy + - Approvers + - Policies + - Name + - Description + x-stackql-resource-name: approval_team + description: Resource Type definition for AWS::MPA::ApprovalTeam. + x-type-name: AWS::MPA::ApprovalTeam + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - Policies + - Policies/*/PolicyArn + x-read-only-properties: + - Arn + - VersionId + - NumberOfApprovers + - Approvers/*/ApproverId + - Approvers/*/ResponseTime + - Approvers/*/PrimaryIdentityStatus + - UpdateSessionArn + - CreationTime + - LastUpdateTime + - Status + - StatusCode + - StatusMessage + x-required-properties: + - ApprovalStrategy + - Approvers + - Policies + - Name + - Description + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mpa:TagResource + - mpa:ListTagsForResource + - mpa:UntagResource + x-required-permissions: + create: + - mpa:CreateApprovalTeam + - mpa:TagResource + - mpa:GetApprovalTeam + - mpa:ListTagsForResource + read: + - mpa:GetApprovalTeam + - mpa:ListTagsForResource + update: + - mpa:GetApprovalTeam + - mpa:UpdateApprovalTeam + - mpa:TagResource + - mpa:ListTagsForResource + - mpa:UntagResource + delete: + - mpa:StartActiveApprovalTeamDeletion + - mpa:DeleteInactiveApprovalTeamVersion + - mpa:GetApprovalTeam + - mpa:UntagResource + list: + - mpa:ListApprovalTeams + - mpa:ListTagsForResource + IdentitySourceArn: + type: string + IamIdentityCenter: + type: object + properties: + InstanceArn: + type: string + pattern: ^arn:.+:sso:::instance/(?:sso)?ins-[a-zA-Z0-9-.]{16}$ + Region: + type: string + ApprovalPortalUrl: + type: string + additionalProperties: false + required: + - InstanceArn + - Region + IdentitySourceParameters: + type: object + properties: + IamIdentityCenter: + $ref: '#/components/schemas/IamIdentityCenter' + additionalProperties: false + required: + - IamIdentityCenter + IdentitySource: + type: object + properties: + IdentitySourceArn: + $ref: '#/components/schemas/IdentitySourceArn' + IdentitySourceParameters: + $ref: '#/components/schemas/IdentitySourceParameters' + Tags: + $ref: '#/components/schemas/Tags' + IdentitySourceType: + type: string + CreationTime: + type: string + format: date-time + Status: + type: string + StatusCode: + type: string + StatusMessage: + type: string + required: + - IdentitySourceParameters + x-stackql-resource-name: identity_source + description: Resource Type definition for AWS::MPA::IdentitySource. + x-type-name: AWS::MPA::IdentitySource + x-stackql-primary-identifier: + - IdentitySourceArn + x-create-only-properties: + - IdentitySourceParameters + - IdentitySourceParameters/IamIdentityCenter + - IdentitySourceParameters/IamIdentityCenter/InstanceArn + - IdentitySourceParameters/IamIdentityCenter/Region + x-read-only-properties: + - IdentitySourceArn + - IdentitySourceType + - IdentitySourceParameters/IamIdentityCenter/ApprovalPortalUrl + - CreationTime + - Status + - StatusCode + - StatusMessage + x-required-properties: + - IdentitySourceParameters + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mpa:TagResource + - mpa:ListTagsForResource + - mpa:UntagResource + x-required-permissions: + create: + - mpa:CreateIdentitySource + - mpa:TagResource + - mpa:ListTagsForResource + - mpa:GetIdentitySource + - sso:DescribeApplication + - sso:DescribeInstance + - sso:CreateApplication + - sso:PutApplicationAssignmentConfiguration + - sso:PutApplicationGrant + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationAccessScope + - kms:Decrypt + read: + - mpa:GetIdentitySource + - mpa:ListTagsForResource + update: + - mpa:GetIdentitySource + - mpa:TagResource + - mpa:ListTagsForResource + - mpa:UntagResource + delete: + - mpa:DeleteIdentitySource + - mpa:GetIdentitySource + - mpa:UntagResource + - sso:DeleteApplication + - sso:ListInstances + - kms:Decrypt + list: + - mpa:ListIdentitySources + - mpa:ListTagsForResource + CreateApprovalTeamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApprovalStrategy: + $ref: '#/components/schemas/ApprovalStrategy' + Approvers: + type: array + items: + $ref: '#/components/schemas/Approver' + minItems: 1 + x-insertionOrder: false + uniqueItems: true + Tags: + $ref: '#/components/schemas/Tags' + Policies: + type: array + items: + $ref: '#/components/schemas/Policy' + minItems: 1 + x-insertionOrder: false + uniqueItems: true + Name: + type: string + Description: + type: string + Arn: + type: string + VersionId: + type: string + UpdateSessionArn: + type: string + CreationTime: + $ref: '#/components/schemas/Timestamp' + LastUpdateTime: + $ref: '#/components/schemas/Timestamp' + NumberOfApprovers: + type: integer + Status: + type: string + StatusCode: + type: string + StatusMessage: + type: string + x-stackQL-stringOnly: true + x-title: CreateApprovalTeamRequest + type: object + required: [] + CreateIdentitySourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdentitySourceArn: + $ref: '#/components/schemas/IdentitySourceArn' + IdentitySourceParameters: + $ref: '#/components/schemas/IdentitySourceParameters' + Tags: + $ref: '#/components/schemas/Tags' + IdentitySourceType: + type: string + CreationTime: + type: string + format: date-time + Status: + type: string + StatusCode: + type: string + StatusMessage: + type: string + x-stackQL-stringOnly: true + x-title: CreateIdentitySourceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + approval_teams: + name: approval_teams + id: awscc.mpa.approval_teams + x-cfn-schema-name: ApprovalTeam + x-cfn-type-name: AWS::MPA::ApprovalTeam + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApprovalTeam&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MPA::ApprovalTeam" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MPA::ApprovalTeam" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MPA::ApprovalTeam" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/approval_teams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/approval_teams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/approval_teams/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApprovalStrategy') as approval_strategy, + JSON_EXTRACT(Properties, '$.Approvers') as approvers, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Policies') as policies, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.VersionId') as version_id, + JSON_EXTRACT(Properties, '$.UpdateSessionArn') as update_session_arn, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.LastUpdateTime') as last_update_time, + JSON_EXTRACT(Properties, '$.NumberOfApprovers') as number_of_approvers, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusCode') as status_code, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MPA::ApprovalTeam' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApprovalStrategy') as approval_strategy, + json_extract_path_text(Properties, 'Approvers') as approvers, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Policies') as policies, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'VersionId') as version_id, + json_extract_path_text(Properties, 'UpdateSessionArn') as update_session_arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastUpdateTime') as last_update_time, + json_extract_path_text(Properties, 'NumberOfApprovers') as number_of_approvers, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusCode') as status_code, + json_extract_path_text(Properties, 'StatusMessage') as status_message + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MPA::ApprovalTeam' + AND data__Identifier = '' + AND region = 'us-east-1' + approval_teams_list_only: + name: approval_teams_list_only + id: awscc.mpa.approval_teams_list_only + x-cfn-schema-name: ApprovalTeam + x-cfn-type-name: AWS::MPA::ApprovalTeam + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MPA::ApprovalTeam' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MPA::ApprovalTeam' + AND region = 'us-east-1' + identity_sources: + name: identity_sources + id: awscc.mpa.identity_sources + x-cfn-schema-name: IdentitySource + x-cfn-type-name: AWS::MPA::IdentitySource + x-identifiers: + - IdentitySourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentitySource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MPA::IdentitySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MPA::IdentitySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MPA::IdentitySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.IdentitySourceArn') as identity_source_arn, + JSON_EXTRACT(Properties, '$.IdentitySourceParameters') as identity_source_parameters, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.IdentitySourceType') as identity_source_type, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusCode') as status_code, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MPA::IdentitySource' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdentitySourceArn') as identity_source_arn, + json_extract_path_text(Properties, 'IdentitySourceParameters') as identity_source_parameters, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IdentitySourceType') as identity_source_type, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusCode') as status_code, + json_extract_path_text(Properties, 'StatusMessage') as status_message + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MPA::IdentitySource' + AND data__Identifier = '' + AND region = 'us-east-1' + identity_sources_list_only: + name: identity_sources_list_only + id: awscc.mpa.identity_sources_list_only + x-cfn-schema-name: IdentitySource + x-cfn-type-name: AWS::MPA::IdentitySource + x-identifiers: + - IdentitySourceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.IdentitySourceArn') as identity_source_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MPA::IdentitySource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdentitySourceArn') as identity_source_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MPA::IdentitySource' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApprovalTeam&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApprovalTeam + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApprovalTeamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentitySource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentitySource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentitySourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/msk.yaml b/providers/src/awscc/v00.00.00000/services/msk.yaml index 177f1401..90d0048c 100644 --- a/providers/src/awscc/v00.00.00000/services/msk.yaml +++ b/providers/src/awscc/v00.00.00000/services/msk.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MSK - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: SecretArnList: type: array @@ -20,10 +400,19 @@ components: required: - ClusterArn x-stackql-resource-name: batch_scram_secret - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::BatchScramSecret + x-type-name: AWS::MSK::BatchScramSecret + x-stackql-primary-identifier: - ClusterArn x-create-only-properties: - ClusterArn + x-required-properties: + - ClusterArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - kafka:BatchAssociateScramSecret @@ -402,7 +791,9 @@ components: - NumberOfBrokerNodes - ClusterName x-stackql-resource-name: cluster - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::Cluster + x-type-name: AWS::MSK::Cluster + x-stackql-primary-identifier: - Arn x-create-only-properties: - BrokerNodeGroupInfo/BrokerAZDistribution @@ -413,6 +804,21 @@ components: - ClusterName x-read-only-properties: - Arn + x-required-properties: + - BrokerNodeGroupInfo + - KafkaVersion + - NumberOfBrokerNodes + - ClusterName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafka:TagResource + - kafka:UntagResource + - kafka:ListTagsForResource x-required-permissions: create: - ec2:DescribeSecurityGroups @@ -496,12 +902,19 @@ components: - Policy - ClusterArn x-stackql-resource-name: cluster_policy - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::ClusterPolicy + x-type-name: AWS::MSK::ClusterPolicy + x-stackql-primary-identifier: - ClusterArn x-create-only-properties: - ClusterArn x-read-only-properties: - CurrentVersion + x-required-properties: + - Policy + - ClusterArn + x-tagging: + taggable: false x-required-permissions: create: - kafka:PutClusterPolicy @@ -550,16 +963,28 @@ components: - ServerProperties - Name x-stackql-resource-name: configuration - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::Configuration + x-type-name: AWS::MSK::Configuration + x-stackql-primary-identifier: - Arn x-create-only-properties: - KafkaVersionsList - Name + x-write-only-properties: + - ServerProperties x-read-only-properties: - Arn - LatestRevision/CreationTime - LatestRevision/Revision - LatestRevision/Description + x-required-properties: + - ServerProperties + - Name + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - kafka:CreateConfiguration @@ -621,8 +1046,42 @@ components: DetectAndCopyNewTopics: description: Whether to periodically check for new topics and partitions. type: boolean + StartingPosition: + description: Configuration for specifying the position in the topics to start replicating from. + $ref: '#/components/schemas/ReplicationStartingPosition' + TopicNameConfiguration: + description: Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias. + $ref: '#/components/schemas/ReplicationTopicNameConfiguration' required: - TopicsToReplicate + ReplicationStartingPosition: + description: Configuration for specifying the position in the topics to start replicating from. + type: object + additionalProperties: false + properties: + Type: + $ref: '#/components/schemas/ReplicationStartingPositionType' + required: [] + ReplicationStartingPositionType: + description: The type of replication starting position. + type: string + enum: + - LATEST + - EARLIEST + ReplicationTopicNameConfiguration: + description: Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias. + type: object + additionalProperties: false + properties: + Type: + $ref: '#/components/schemas/ReplicationTopicNameConfigurationType' + required: [] + ReplicationTopicNameConfigurationType: + description: The type of replicated topic name. + type: string + enum: + - PREFIXED_WITH_SOURCE_CLUSTER_ALIAS + - IDENTICAL ConsumerGroupReplication: description: Configuration relating to consumer group replication. type: object @@ -795,15 +1254,40 @@ components: - KafkaClusters - ServiceExecutionRoleArn x-stackql-resource-name: replicator - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::Replicator + x-type-name: AWS::MSK::Replicator + x-stackql-primary-identifier: - ReplicatorArn + x-stackql-additional-identifiers: + - - ReplicatorName x-create-only-properties: - ReplicatorName - Description - KafkaClusters - ServiceExecutionRoleArn + - ReplicationInfoList/*/SourceKafkaClusterArn + - ReplicationInfoList/*/TargetKafkaClusterArn + - ReplicationInfoList/*/TargetCompressionType + - ReplicationInfoList/*/TopicReplication/StartingPosition + - ReplicationInfoList/*/TopicReplication/TopicNameConfiguration x-read-only-properties: - ReplicatorArn + - CurrentVersion + x-required-properties: + - ReplicatorName + - ReplicationInfoList + - KafkaClusters + - ServiceExecutionRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafka:UntagResource + - kafka:ListTagsForResource + - kafka:TagResource x-required-permissions: create: - ec2:CreateNetworkInterface @@ -882,7 +1366,9 @@ components: - VpcConfigs - ClientAuthentication x-stackql-resource-name: serverless_cluster - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::ServerlessCluster + x-type-name: AWS::MSK::ServerlessCluster + x-stackql-primary-identifier: - Arn x-create-only-properties: - ClusterName @@ -891,6 +1377,20 @@ components: - Tags x-read-only-properties: - Arn + x-required-properties: + - ClusterName + - VpcConfigs + - ClientAuthentication + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafka:TagResource + - kafka:UntagResource + - kafka:ListTagsForResource x-required-permissions: create: - kafka:CreateClusterV2 @@ -970,7 +1470,9 @@ components: - TargetClusterArn - VpcId x-stackql-resource-name: vpc_connection - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::MSK::VpcConnection + x-type-name: AWS::MSK::VpcConnection + x-stackql-primary-identifier: - Arn x-create-only-properties: - ClientSubnets @@ -980,6 +1482,22 @@ components: - VpcId x-read-only-properties: - Arn + x-required-properties: + - Authentication + - ClientSubnets + - SecurityGroups + - TargetClusterArn + - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - kafka:TagResource + - kafka:UntagResource + - kafka:ListTagsForResource x-required-permissions: create: - ec2:CreateVpcEndpoint @@ -1023,43 +1541,352 @@ components: - kafka:ListVpcConnections - kms:CreateGrant - kms:DescribeKey + CreateBatchScramSecretRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterArn: + type: string + SecretArnList: + $ref: '#/components/schemas/SecretArnList' + x-stackQL-stringOnly: true + x-title: CreateBatchScramSecretRequest + type: object + required: [] + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BrokerNodeGroupInfo: + $ref: '#/components/schemas/BrokerNodeGroupInfo' + EnhancedMonitoring: + type: string + minLength: 7 + maxLength: 23 + enum: + - DEFAULT + - PER_BROKER + - PER_TOPIC_PER_BROKER + - PER_TOPIC_PER_PARTITION + KafkaVersion: + type: string + minLength: 1 + maxLength: 128 + NumberOfBrokerNodes: + type: integer + EncryptionInfo: + $ref: '#/components/schemas/EncryptionInfo' + OpenMonitoring: + $ref: '#/components/schemas/OpenMonitoring' + ClusterName: + type: string + minLength: 1 + maxLength: 64 + Arn: + type: string + CurrentVersion: + description: The current version of the MSK cluster + type: string + ClientAuthentication: + $ref: '#/components/schemas/ClientAuthentication' + LoggingInfo: + $ref: '#/components/schemas/LoggingInfo' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + ConfigurationInfo: + $ref: '#/components/schemas/ConfigurationInfo' + StorageMode: + type: string + minLength: 5 + maxLength: 6 + enum: + - LOCAL + - TIERED + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateClusterPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Policy: + description: A policy document containing permissions to add to the specified cluster. + type: object + ClusterArn: + description: The arn of the cluster for the resource policy. + type: string + pattern: ^arn:[\w-]+:kafka:[\w-]+:\d+:cluster.*\Z + CurrentVersion: + description: The current version of the policy attached to the specified cluster + type: string + pattern: ^(K)([a-zA-Z0-9]+)\Z + x-stackQL-stringOnly: true + x-title: CreateClusterPolicyRequest + type: object + required: [] + CreateConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + Description: + type: string + ServerProperties: + type: string + KafkaVersionsList: + $ref: '#/components/schemas/KafkaVersionsList' + Arn: + type: string + LatestRevision: + $ref: '#/components/schemas/LatestRevision' + x-stackQL-stringOnly: true + x-title: CreateConfigurationRequest + type: object + required: [] + CreateReplicatorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ReplicatorArn: + description: Amazon Resource Name for the created replicator. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):kafka:.* + ReplicatorName: + description: The name of the replicator. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[0-9A-Za-z][0-9A-Za-z-]{0,}$ + CurrentVersion: + description: The current version of the MSK replicator. + type: string + Description: + description: A summary description of the replicator. + type: string + maxLength: 1024 + KafkaClusters: + description: Specifies a list of Kafka clusters which are targets of the replicator. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 2 + maxItems: 2 + items: + $ref: '#/components/schemas/KafkaCluster' + ReplicationInfoList: + description: A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/ReplicationInfo' + ServiceExecutionRoleArn: + description: The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn):iam:.* + Tags: + description: A collection of tags associated with a resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateReplicatorRequest + type: object + required: [] + CreateServerlessClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + ClusterName: + type: string + minLength: 1 + maxLength: 64 + VpcConfigs: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/VpcConfig' + ClientAuthentication: + $ref: '#/components/schemas/ClientAuthentication' + Tags: + type: object + description: A key-value pair to associate with a resource. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateServerlessClusterRequest + type: object + required: [] + CreateVpcConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + Authentication: + $ref: '#/components/schemas/Authentication' + ClientSubnets: + $ref: '#/components/schemas/ClientSubnets' + TargetClusterArn: + description: The Amazon Resource Name (ARN) of the target cluster + type: string + pattern: ^arn:[\w-]+:kafka:[\w-]+:\d+:cluster.*\Z + SecurityGroups: + $ref: '#/components/schemas/SecurityGroups' + Tags: + $ref: '#/components/schemas/Tags' + VpcId: + $ref: '#/components/schemas/VpcId' + x-stackQL-stringOnly: true + x-title: CreateVpcConnectionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: batch_scram_secrets: name: batch_scram_secrets id: awscc.msk.batch_scram_secrets x-cfn-schema-name: BatchScramSecret - x-type: list - x-identifiers: - - ClusterArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' - AND region = 'us-east-1' - batch_scram_secret: - name: batch_scram_secret - id: awscc.msk.batch_scram_secret - x-cfn-schema-name: BatchScramSecret - x-type: get + x-cfn-type-name: AWS::MSK::BatchScramSecret x-identifiers: - ClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BatchScramSecret&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::BatchScramSecret" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::BatchScramSecret" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::BatchScramSecret" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1070,7 +1897,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1080,13 +1907,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' AND data__Identifier = '' AND region = 'us-east-1' - clusters: - name: clusters - id: awscc.msk.clusters - x-cfn-schema-name: Cluster - x-type: list + batch_scram_secrets_list_only: + name: batch_scram_secrets_list_only + id: awscc.msk.batch_scram_secrets_list_only + x-cfn-schema-name: BatchScramSecret + x-cfn-type-name: AWS::MSK::BatchScramSecret x-identifiers: - - Arn + - ClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1094,28 +1927,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' AND region = 'us-east-1' - cluster: - name: cluster - id: awscc.msk.cluster + clusters: + name: clusters + id: awscc.msk.clusters x-cfn-schema-name: Cluster - x-type: get + x-cfn-type-name: AWS::MSK::Cluster x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1138,7 +2019,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1160,13 +2041,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Cluster' AND data__Identifier = '' AND region = 'us-east-1' - cluster_policies: - name: cluster_policies - id: awscc.msk.cluster_policies - x-cfn-schema-name: ClusterPolicy - x-type: list + clusters_list_only: + name: clusters_list_only + id: awscc.msk.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::MSK::Cluster x-identifiers: - - ClusterArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1174,28 +2061,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' AND region = 'us-east-1' - cluster_policy: - name: cluster_policy - id: awscc.msk.cluster_policy + cluster_policies: + name: cluster_policies + id: awscc.msk.cluster_policies x-cfn-schema-name: ClusterPolicy - x-type: get + x-cfn-type-name: AWS::MSK::ClusterPolicy x-identifiers: - ClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::ClusterPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::ClusterPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::ClusterPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1207,7 +2142,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1218,13 +2153,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' AND data__Identifier = '' AND region = 'us-east-1' - configurations: - name: configurations - id: awscc.msk.configurations - x-cfn-schema-name: Configuration - x-type: list + cluster_policies_list_only: + name: cluster_policies_list_only + id: awscc.msk.cluster_policies_list_only + x-cfn-schema-name: ClusterPolicy + x-cfn-type-name: AWS::MSK::ClusterPolicy x-identifiers: - - Arn + - ClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1232,28 +2173,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' AND region = 'us-east-1' - configuration: - name: configuration - id: awscc.msk.configuration + configurations: + name: configurations + id: awscc.msk.configurations x-cfn-schema-name: Configuration - x-type: get + x-cfn-type-name: AWS::MSK::Configuration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Configuration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Configuration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Configuration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Configuration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1268,7 +2257,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1282,13 +2271,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Configuration' AND data__Identifier = '' AND region = 'us-east-1' - replicators: - name: replicators - id: awscc.msk.replicators - x-cfn-schema-name: Replicator - x-type: list + configurations_list_only: + name: configurations_list_only + id: awscc.msk.configurations_list_only + x-cfn-schema-name: Configuration + x-cfn-type-name: AWS::MSK::Configuration x-identifiers: - - ReplicatorArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1296,28 +2291,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ReplicatorArn') as replicator_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ReplicatorArn') as replicator_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' AND region = 'us-east-1' - replicator: - name: replicator - id: awscc.msk.replicator + replicators: + name: replicators + id: awscc.msk.replicators x-cfn-schema-name: Replicator - x-type: get + x-cfn-type-name: AWS::MSK::Replicator x-identifiers: - ReplicatorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Replicator&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Replicator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Replicator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::Replicator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replicators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replicators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/replicators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1334,7 +2377,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1350,13 +2393,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Replicator' AND data__Identifier = '' AND region = 'us-east-1' - serverless_clusters: - name: serverless_clusters - id: awscc.msk.serverless_clusters - x-cfn-schema-name: ServerlessCluster - x-type: list + replicators_list_only: + name: replicators_list_only + id: awscc.msk.replicators_list_only + x-cfn-schema-name: Replicator + x-cfn-type-name: AWS::MSK::Replicator x-identifiers: - - Arn + - ReplicatorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1364,28 +2413,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' + JSON_EXTRACT(Properties, '$.ReplicatorArn') as replicator_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' + json_extract_path_text(Properties, 'ReplicatorArn') as replicator_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' AND region = 'us-east-1' - serverless_cluster: - name: serverless_cluster - id: awscc.msk.serverless_cluster + serverless_clusters: + name: serverless_clusters + id: awscc.msk.serverless_clusters x-cfn-schema-name: ServerlessCluster - x-type: get + x-cfn-type-name: AWS::MSK::ServerlessCluster x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServerlessCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::ServerlessCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::ServerlessCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/serverless_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/serverless_clusters/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1399,7 +2483,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1412,13 +2496,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' AND data__Identifier = '' AND region = 'us-east-1' - vpc_connections: - name: vpc_connections - id: awscc.msk.vpc_connections - x-cfn-schema-name: VpcConnection - x-type: list + serverless_clusters_list_only: + name: serverless_clusters_list_only + id: awscc.msk.serverless_clusters_list_only + x-cfn-schema-name: ServerlessCluster + x-cfn-type-name: AWS::MSK::ServerlessCluster x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1427,7 +2517,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1435,19 +2525,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' AND region = 'us-east-1' - vpc_connection: - name: vpc_connection - id: awscc.msk.vpc_connection + vpc_connections: + name: vpc_connections + id: awscc.msk.vpc_connections x-cfn-schema-name: VpcConnection - x-type: get + x-cfn-type-name: AWS::MSK::VpcConnection x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcConnection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::VpcConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::VpcConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MSK::VpcConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1463,7 +2601,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1478,3 +2616,481 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::VpcConnection' AND data__Identifier = '' AND region = 'us-east-1' + vpc_connections_list_only: + name: vpc_connections_list_only + id: awscc.msk.vpc_connections_list_only + x-cfn-schema-name: VpcConnection + x-cfn-type-name: AWS::MSK::VpcConnection + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BatchScramSecret&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBatchScramSecret + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBatchScramSecretRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ClusterPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateClusterPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Configuration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Replicator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReplicator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReplicatorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServerlessCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServerlessCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServerlessClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcConnection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/mwaa.yaml b/providers/src/awscc/v00.00.00000/services/mwaa.yaml index b1e29a3e..1a15e353 100644 --- a/providers/src/awscc/v00.00.00000/services/mwaa.yaml +++ b/providers/src/awscc/v00.00.00000/services/mwaa.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: MWAA - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: EnvironmentName: type: string @@ -159,6 +539,14 @@ components: type: integer description: Minimum worker compute units. minimum: 1 + MaxWebservers: + type: integer + description: Maximum webserver compute units. + minimum: 1 + MinWebservers: + type: integer + description: Minimum webserver compute units. + minimum: 1 Schedulers: type: integer description: Scheduler compute units. @@ -245,6 +633,8 @@ components: $ref: '#/components/schemas/UpdateCreatedAt' Error: $ref: '#/components/schemas/UpdateError' + WorkerReplacementStrategy: + $ref: '#/components/schemas/WorkerReplacementStrategy' ErrorCode: type: string description: The error code associated with an error. @@ -287,6 +677,12 @@ components: type: string description: The webserver VPC endpoint service name, applicable if private webserver access mode selected. maxLength: 1224 + WorkerReplacementStrategy: + type: string + description: 'The worker replacement strategy to use when updating the environment. Valid values: `FORCED`, `GRACEFUL`. FORCED means Apache Airflow workers will be stopped and replaced without waiting for tasks to complete before an update. GRACEFUL means Apache Airflow workers will be able to complete running tasks for up to 12 hours during an update before being stopped and replaced.' + enum: + - FORCED + - GRACEFUL Environment: type: object properties: @@ -336,6 +732,10 @@ components: $ref: '#/components/schemas/MaxWorkers' MinWorkers: $ref: '#/components/schemas/MinWorkers' + MaxWebservers: + $ref: '#/components/schemas/MaxWebservers' + MinWebservers: + $ref: '#/components/schemas/MinWebservers' Schedulers: $ref: '#/components/schemas/Schedulers' NetworkConfiguration: @@ -357,16 +757,22 @@ components: $ref: '#/components/schemas/DatabaseVpcEndpointService' WebserverVpcEndpointService: $ref: '#/components/schemas/WebserverVpcEndpointService' + WorkerReplacementStrategy: + $ref: '#/components/schemas/WorkerReplacementStrategy' required: - Name x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: Resource schema for AWS::MWAA::Environment + x-type-name: AWS::MWAA::Environment + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - KmsKey - NetworkConfiguration/SubnetIds - EndpointManagement + x-write-only-properties: + - WorkerReplacementStrategy x-read-only-properties: - Arn - CeleryExecutorQueue @@ -378,56 +784,229 @@ components: - LoggingConfiguration/WebserverLogs/CloudWatchLogGroupArn - LoggingConfiguration/WorkerLogs/CloudWatchLogGroupArn - LoggingConfiguration/TaskLogs/CloudWatchLogGroupArn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - airflow:UntagResource + - airflow:TagResource x-required-permissions: create: + - airflow:GetEnvironment - airflow:CreateEnvironment + - airflow:TagResource + - airflow:UntagResource + - iam:PassRole + - iam:ListRoles + - iam:CreatePolicy + - iam:AttachRolePolicy + - iam:CreateRole + - iam:CreateServiceLinkedRole + - s3:GetBucketLocation + - s3:ListAllMyBuckets + - s3:ListBucket + - s3:ListBucketVersions + - s3:CreateBucket + - s3:PutObject + - s3:GetEncryptionConfiguration + - ec2:DescribeSecurityGroups + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - ec2:DescribeRouteTables + - ec2:AuthorizeSecurityGroupIngress + - ec2:CreateSecurityGroup + - ec2:CreateVpcEndpoint + - ec2:CreateNetworkInterface + - kms:CreateGrant + - kms:DescribeKey + - kms:ListAliases read: - airflow:GetEnvironment update: + - airflow:GetEnvironment - airflow:UpdateEnvironment - airflow:TagResource - airflow:UntagResource + - iam:PassRole + - iam:ListRoles + - iam:AttachRolePolicy + - s3:GetBucketLocation + - s3:ListBucket + - s3:ListBucketVersions + - s3:GetEncryptionConfiguration + - ec2:DescribeSecurityGroups + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - ec2:DescribeRouteTables + - kms:DescribeKey + - kms:ListAliases delete: + - airflow:GetEnvironment - airflow:DeleteEnvironment list: - airflow:ListEnvironments + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + $ref: '#/components/schemas/EnvironmentName' + Arn: + $ref: '#/components/schemas/EnvironmentArn' + WebserverUrl: + $ref: '#/components/schemas/WebserverUrl' + ExecutionRoleArn: + $ref: '#/components/schemas/ExecutionRoleArn' + KmsKey: + $ref: '#/components/schemas/KmsKey' + AirflowVersion: + $ref: '#/components/schemas/AirflowVersion' + SourceBucketArn: + $ref: '#/components/schemas/S3BucketArn' + DagS3Path: + $ref: '#/components/schemas/RelativePath' + PluginsS3Path: + $ref: '#/components/schemas/RelativePath' + PluginsS3ObjectVersion: + $ref: '#/components/schemas/S3ObjectVersion' + RequirementsS3Path: + $ref: '#/components/schemas/RelativePath' + RequirementsS3ObjectVersion: + $ref: '#/components/schemas/S3ObjectVersion' + StartupScriptS3Path: + $ref: '#/components/schemas/RelativePath' + StartupScriptS3ObjectVersion: + $ref: '#/components/schemas/S3ObjectVersion' + AirflowConfigurationOptions: + type: object + description: |- + Key/value pairs representing Airflow configuration variables. + Keys are prefixed by their section: + + [core] + dags_folder={AIRFLOW_HOME}/dags + + Would be represented as + + "core.dags_folder": "{AIRFLOW_HOME}/dags" + EnvironmentClass: + $ref: '#/components/schemas/EnvironmentClass' + MaxWorkers: + $ref: '#/components/schemas/MaxWorkers' + MinWorkers: + $ref: '#/components/schemas/MinWorkers' + MaxWebservers: + $ref: '#/components/schemas/MaxWebservers' + MinWebservers: + $ref: '#/components/schemas/MinWebservers' + Schedulers: + $ref: '#/components/schemas/Schedulers' + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + LoggingConfiguration: + $ref: '#/components/schemas/LoggingConfiguration' + WeeklyMaintenanceWindowStart: + $ref: '#/components/schemas/WeeklyMaintenanceWindowStart' + Tags: + type: object + description: A map of tags for the environment. + WebserverAccessMode: + $ref: '#/components/schemas/WebserverAccessMode' + EndpointManagement: + $ref: '#/components/schemas/EndpointManagement' + CeleryExecutorQueue: + $ref: '#/components/schemas/CeleryExecutorQueue' + DatabaseVpcEndpointService: + $ref: '#/components/schemas/DatabaseVpcEndpointService' + WebserverVpcEndpointService: + $ref: '#/components/schemas/WebserverVpcEndpointService' + WorkerReplacementStrategy: + $ref: '#/components/schemas/WorkerReplacementStrategy' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: environments: name: environments id: awscc.mwaa.environments x-cfn-schema-name: Environment - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: awscc.mwaa.environment - x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::MWAA::Environment x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MWAA::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MWAA::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::MWAA::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -450,6 +1029,8 @@ components: JSON_EXTRACT(Properties, '$.EnvironmentClass') as environment_class, JSON_EXTRACT(Properties, '$.MaxWorkers') as max_workers, JSON_EXTRACT(Properties, '$.MinWorkers') as min_workers, + JSON_EXTRACT(Properties, '$.MaxWebservers') as max_webservers, + JSON_EXTRACT(Properties, '$.MinWebservers') as min_webservers, JSON_EXTRACT(Properties, '$.Schedulers') as schedulers, JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration, @@ -459,12 +1040,13 @@ components: JSON_EXTRACT(Properties, '$.EndpointManagement') as endpoint_management, JSON_EXTRACT(Properties, '$.CeleryExecutorQueue') as celery_executor_queue, JSON_EXTRACT(Properties, '$.DatabaseVpcEndpointService') as database_vpc_endpoint_service, - JSON_EXTRACT(Properties, '$.WebserverVpcEndpointService') as webserver_vpc_endpoint_service + JSON_EXTRACT(Properties, '$.WebserverVpcEndpointService') as webserver_vpc_endpoint_service, + JSON_EXTRACT(Properties, '$.WorkerReplacementStrategy') as worker_replacement_strategy FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MWAA::Environment' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -487,6 +1069,8 @@ components: json_extract_path_text(Properties, 'EnvironmentClass') as environment_class, json_extract_path_text(Properties, 'MaxWorkers') as max_workers, json_extract_path_text(Properties, 'MinWorkers') as min_workers, + json_extract_path_text(Properties, 'MaxWebservers') as max_webservers, + json_extract_path_text(Properties, 'MinWebservers') as min_webservers, json_extract_path_text(Properties, 'Schedulers') as schedulers, json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, @@ -496,7 +1080,234 @@ components: json_extract_path_text(Properties, 'EndpointManagement') as endpoint_management, json_extract_path_text(Properties, 'CeleryExecutorQueue') as celery_executor_queue, json_extract_path_text(Properties, 'DatabaseVpcEndpointService') as database_vpc_endpoint_service, - json_extract_path_text(Properties, 'WebserverVpcEndpointService') as webserver_vpc_endpoint_service + json_extract_path_text(Properties, 'WebserverVpcEndpointService') as webserver_vpc_endpoint_service, + json_extract_path_text(Properties, 'WorkerReplacementStrategy') as worker_replacement_strategy FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::MWAA::Environment' AND data__Identifier = '' AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.mwaa.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::MWAA::Environment + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/neptune.yaml b/providers/src/awscc/v00.00.00000/services/neptune.yaml index 755adebf..f1db0bab 100644 --- a/providers/src/awscc/v00.00.00000/services/neptune.yaml +++ b/providers/src/awscc/v00.00.00000/services/neptune.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Neptune - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DBClusterRole: description: Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster. @@ -37,22 +417,19 @@ components: - MinCapacity - MaxCapacity Tag: - description: A key-value pair to associate with a resource. + description: An optional array of key-value pairs to apply to this DB subnet group. type: object additionalProperties: false properties: Key: type: string description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' - minLength: 1 - maxLength: 128 Value: type: string description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' - minLength: 0 - maxLength: 256 required: - Key + - Value DBCluster: type: object properties: @@ -127,7 +504,7 @@ components: description: True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. type: boolean KmsKeyId: - description: If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster. + description: The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true. type: string Port: description: 'The port number on which the DB cluster accepts connections. For example: `8182`.' @@ -178,9 +555,13 @@ components: description: |- Indicates whether the DB cluster is encrypted. - If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption. + If you specify the KmsKeyId property, then you must enable encryption and set this property to true. + + If you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster. - If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true. + If you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the KmsKeyId property from the source cluster is used. + + If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used. type: boolean Tags: type: array @@ -206,7 +587,9 @@ components: type: string type: array x-stackql-resource-name: db_cluster - x-stackql-primaryIdentifier: + description: The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. + x-type-name: AWS::Neptune::DBCluster + x-stackql-primary-identifier: - DBClusterIdentifier x-create-only-properties: - AvailabilityZones @@ -219,14 +602,32 @@ components: - SourceDBClusterIdentifier - StorageEncrypted - UseLatestRestorableTime + x-write-only-properties: + - DBInstanceParameterGroupName + - RestoreToTime + - RestoreType + - SnapshotIdentifier + - SourceDBClusterIdentifier + - UseLatestRestorableTime x-read-only-properties: - Endpoint - ClusterResourceId - Port - ReadEndpoint + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:ListTagsForResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:PassRole + - iam:CreateServiceLinkedRole - rds:AddRoleToDBCluster - rds:AddTagsToResource - rds:CreateDBCluster @@ -236,11 +637,13 @@ components: - rds:ModifyDBCluster - rds:RestoreDBClusterFromSnapshot - rds:RestoreDBClusterToPointInTime - - kms:* + - kms:CreateGrant + - kms:DescribeKey read: - rds:DescribeDBClusters - rds:ListTagsForResource - - kms:* + - kms:CreateGrant + - kms:DescribeKey update: - ec2:DescribeSecurityGroups - iam:PassRole @@ -256,7 +659,8 @@ components: - rds:RemoveFromGlobalCluster - rds:RemoveRoleFromDBCluster - rds:RemoveTagsFromResource - - kms:* + - kms:CreateGrant + - kms:DescribeKey delete: - rds:DeleteDBCluster - rds:DeleteDBInstance @@ -265,119 +669,1798 @@ components: - rds:ListTagsForResource - rds:RemoveFromGlobalCluster - rds:CreateDBClusterSnapshot - - kms:* + - kms:CreateGrant + - kms:DescribeKey list: - rds:DescribeDBClusters - rds:ListTagsForResource - - kms:* - x-stackQL-resources: - db_clusters: - name: db_clusters - id: awscc.neptune.db_clusters - x-cfn-schema-name: DBCluster - x-type: list - x-identifiers: - - DBClusterIdentifier - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND region = 'us-east-1' - db_cluster: - name: db_cluster - id: awscc.neptune.db_cluster - x-cfn-schema-name: DBCluster - x-type: get - x-identifiers: + - kms:CreateGrant + - kms:DescribeKey + DBClusterParameterGroup: + type: object + properties: + Description: + description: Provides the customer-specified description for this DB cluster parameter group. + type: string + Family: + description: Must be neptune1 for engine versions prior to 1.2.0.0, or neptune1.2 for engine version 1.2.0.0 and higher. + type: string + Parameters: + description: An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. + type: object + Name: + description: Provides the name of the DB cluster parameter group. + type: string + Tags: + description: The list of tags for the cluster parameter group. + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - Description + - Family + - Parameters + x-stackql-resource-name: db_cluster_parameter_group + description: The AWS::Neptune::DBClusterParameterGroup resource creates a new Amazon Neptune DB cluster parameter group + x-type-name: AWS::Neptune::DBClusterParameterGroup + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - Description + - Family + x-required-properties: + - Description + - Family + - Parameters + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:ListTagsForResource + - rds:RemoveTagsFromResource + x-required-permissions: + create: + - rds:AddTagsToResource + - rds:CreateDBClusterParameterGroup + - rds:DescribeDBClusterParameterGroups + - rds:DescribeDBClusterParameters + - rds:DescribeEngineDefaultClusterParameters + - rds:ListTagsForResource + - rds:ModifyDBClusterParameterGroup + - iam:CreateServiceLinkedRole + read: + - rds:DescribeDBClusterParameterGroups + - rds:ListTagsForResource + - rds:DescribeDBClusterParameters + update: + - rds:AddTagsToResource + - rds:DescribeDBClusterParameterGroups + - rds:DescribeDBClusterParameters + - rds:DescribeDBClusters + - rds:DescribeEngineDefaultClusterParameters + - rds:ListTagsForResource + - rds:ModifyDBClusterParameterGroup + - rds:RemoveTagsFromResource + - rds:ResetDBClusterParameterGroup + delete: + - rds:DeleteDBClusterParameterGroup + - rds:ListTagsForResource + - rds:RemoveTagsFromResource + list: + - rds:DescribeDBClusterParameterGroups + - rds:ListTagsForResource + DBInstance: + type: object + properties: + AllowMajorVersionUpgrade: + type: boolean + description: Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. + AutoMinorVersionUpgrade: + type: boolean + description: |- + Indicates that minor version patches are applied automatically. + + When updating this property, some interruptions may occur. + AvailabilityZone: + type: string + description: Specifies the name of the Availability Zone the DB instance is located in. + DBClusterIdentifier: + type: string + description: If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. + DBInstanceClass: + type: string + description: |- + Contains the name of the compute and memory capacity class of the DB instance. + + If you update this property, some interruptions may occur. + DBInstanceIdentifier: + type: string + description: Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. + DBParameterGroupName: + type: string + description: The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + DBSnapshotIdentifier: + type: string + description: |+ + This parameter is not supported. + + `AWS::Neptune::DBInstance` does not support restoring from snapshots. + + `AWS::Neptune::DBCluster` does support restoring from snapshots. + + DBSubnetGroupName: + type: string + description: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC). + Endpoint: + type: string + description: 'The connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`.' + PreferredMaintenanceWindow: + type: string + description: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Port: + type: string + description: 'The port number on which the database accepts connections. For example: `8182`.' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + description: An arbitrary set of tags (key-value pairs) for this DB instance. + required: + - DBInstanceClass + x-stackql-resource-name: db_instance + description: The AWS::Neptune::DBInstance resource creates an Amazon Neptune DB instance. + x-type-name: AWS::Neptune::DBInstance + x-stackql-primary-identifier: + - DBInstanceIdentifier + x-create-only-properties: + - AvailabilityZone - DBClusterIdentifier - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, - JSON_EXTRACT(Properties, '$.ReadEndpoint') as read_endpoint, - JSON_EXTRACT(Properties, '$.ClusterResourceId') as cluster_resource_id, - JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, - JSON_EXTRACT(Properties, '$.AvailabilityZones') as availability_zones, - JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, - JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, - JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, - JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name, - JSON_EXTRACT(Properties, '$.DBInstanceParameterGroupName') as db_instance_parameter_group_name, - JSON_EXTRACT(Properties, '$.DBPort') as db_port, - JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, - JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, - JSON_EXTRACT(Properties, '$.EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, - JSON_EXTRACT(Properties, '$.IamAuthEnabled') as iam_auth_enabled, - JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, - JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, - JSON_EXTRACT(Properties, '$.RestoreToTime') as restore_to_time, - JSON_EXTRACT(Properties, '$.RestoreType') as restore_type, - JSON_EXTRACT(Properties, '$.ServerlessScalingConfiguration') as serverless_scaling_configuration, - JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, - JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, - JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.UseLatestRestorableTime') as use_latest_restorable_time, - JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'ReadEndpoint') as read_endpoint, - json_extract_path_text(Properties, 'ClusterResourceId') as cluster_resource_id, - json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, - json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, - json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, - json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, - json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, - json_extract_path_text(Properties, 'DBInstanceParameterGroupName') as db_instance_parameter_group_name, - json_extract_path_text(Properties, 'DBPort') as db_port, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'IamAuthEnabled') as iam_auth_enabled, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'RestoreToTime') as restore_to_time, - json_extract_path_text(Properties, 'RestoreType') as restore_type, - json_extract_path_text(Properties, 'ServerlessScalingConfiguration') as serverless_scaling_configuration, - json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, - json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, - json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND data__Identifier = '' - AND region = 'us-east-1' + - DBInstanceIdentifier + - DBSnapshotIdentifier + - DBSubnetGroupName + x-conditional-create-only-properties: + - AutoMinorVersionUpgrade + - DBParameterGroupName + - PreferredMaintenanceWindow + x-write-only-properties: + - DBSnapshotIdentifier + - AllowMajorVersionUpgrade + x-read-only-properties: + - Endpoint + - Port + x-required-properties: + - DBInstanceClass + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:ListTagsForResource + - rds:RemoveTagsFromResource + x-required-permissions: + create: + - ec2:DescribeAccountAttributes + - ec2:DescribeAvailabilityZones + - ec2:DescribeInternetGateways + - iam:GetRole + - iam:ListRoles + - iam:PassRole + - rds:AddTagsToResource + - rds:CreateDBInstance + - rds:DescribeDBInstances + - rds:DescribeEvents + - rds:ListTagsForResource + - rds:ModifyDBInstance + - rds:RebootDBInstance + - iam:CreateServiceLinkedRole + read: + - ec2:DescribeAccountAttributes + - ec2:DescribeAvailabilityZones + - ec2:DescribeInternetGateways + - rds:DescribeDBInstances + - rds:ListTagsForResource + update: + - ec2:DescribeAccountAttributes + - ec2:DescribeAvailabilityZones + - ec2:DescribeInternetGateways + - iam:GetRole + - iam:ListRoles + - iam:PassRole + - rds:AddTagsToResource + - rds:DescribeDBClusters + - rds:DescribeDBInstances + - rds:DescribeDBParameterGroups + - rds:DescribeEvents + - rds:ListTagsForResource + - rds:ModifyDBInstance + - rds:RebootDBInstance + - rds:RemoveTagsFromResource + delete: + - rds:AddTagsToResource + - rds:CreateDBSnapshot + - rds:DeleteDBInstance + - rds:DescribeDBInstances + list: + - rds:DescribeDBInstances + - rds:ListTagsForResource + DBParameterGroup: + type: object + properties: + Name: + description: Provides the name of the DB parameter group. + type: string + Description: + description: Provides the customer-specified description for this DB parameter group. + type: string + Family: + description: Must be `neptune1` for engine versions prior to 1.2.0.0, or `neptune1.2` for engine version `1.2.0.0` and higher. + type: string + Parameters: + description: |- + The parameters to set for this DB parameter group. + + The parameters are expressed as a JSON object consisting of key-value pairs. + + Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover. + type: object + Tags: + description: An optional array of key-value pairs to apply to this DB parameter group. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + required: + - Family + - Description + - Parameters + x-stackql-resource-name: db_parameter_group + description: AWS::Neptune::DBParameterGroup creates a new DB parameter group. This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance + x-type-name: AWS::Neptune::DBParameterGroup + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - Description + - Family + x-required-properties: + - Family + - Description + - Parameters + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:ListTagsForResource + - rds:RemoveTagsFromResource + x-required-permissions: + create: + - rds:AddTagsToResource + - rds:CreateDBParameterGroup + - rds:DescribeDBParameterGroups + - rds:DescribeDBParameters + - rds:DescribeEngineDefaultParameters + - rds:ModifyDBParameterGroup + - rds:ListTagsForResource + - iam:CreateServiceLinkedRole + read: + - rds:DescribeDBParameterGroups + - rds:ListTagsForResource + - rds:DescribeDBParameters + - rds:DescribeEngineDefaultParameters + update: + - rds:AddTagsToResource + - rds:DescribeDBParameterGroups + - rds:DescribeDBParameters + - rds:DescribeEngineDefaultParameters + - rds:ListTagsForResource + - rds:ModifyDBParameterGroup + - rds:ResetDBParameterGroup + - rds:RemoveTagsFromResource + - rds:DescribeDBInstances + delete: + - rds:DeleteDBParameterGroup + - rds:RemoveTagsFromResource + list: + - rds:DescribeDBParameterGroups + - rds:ListTagsForResource + DBSubnetGroup: + type: object + properties: + DBSubnetGroupName: + description: |+ + The name for the DB subnet group. This value is stored as a lowercase string. + + Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default". + + Example: mysubnetgroup + + type: string + DBSubnetGroupDescription: + description: The description for the DB subnet group. + type: string + SubnetIds: + description: The Amazon EC2 subnet IDs for the DB subnet group. + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + uniqueItems: false + description: An optional array of key-value pairs to apply to this DB subnet group. + items: + $ref: '#/components/schemas/Tag' + required: + - DBSubnetGroupDescription + - SubnetIds + x-stackql-resource-name: db_subnet_group + description: The AWS::Neptune::DBSubnetGroup type creates an Amazon Neptune DB subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS Region. + x-type-name: AWS::Neptune::DBSubnetGroup + x-stackql-primary-identifier: + - DBSubnetGroupName + x-create-only-properties: + - DBSubnetGroupName + x-required-properties: + - DBSubnetGroupDescription + - SubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:ListTagsForResource + - rds:RemoveTagsFromResource + x-required-permissions: + create: + - rds:CreateDBSubnetGroup + - rds:DescribeDBSubnetGroups + - rds:ListTagsForResource + - rds:AddTagsToResource + - iam:CreateServiceLinkedRole + read: + - rds:DescribeDBSubnetGroups + - rds:ListTagsForResource + update: + - rds:ModifyDBSubnetGroup + - rds:DescribeDBSubnetGroups + - rds:AddTagsToResource + - rds:RemoveTagsFromResource + - rds:ListTagsForResource + delete: + - rds:DeleteDBSubnetGroup + - rds:DescribeDBSubnetGroups + - rds:ListTagsForResource + - rds:RemoveTagsFromResource + list: + - rds:DescribeDBSubnetGroups + - rds:ListTagsForResource + EventSubscription: + type: object + properties: + Enabled: + type: boolean + EventCategories: + type: array + uniqueItems: false + items: + type: string + SnsTopicArn: + type: string + SourceIds: + type: array + uniqueItems: false + items: + type: string + Id: + type: string + SourceType: + type: string + x-stackql-resource-name: event_subscription + description: Resource Type definition for AWS::Neptune::EventSubscription + x-type-name: AWS::Neptune::EventSubscription + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SnsTopicArn + x-read-only-properties: + - Id + CreateDBClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Endpoint: + description: 'The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`' + type: string + ReadEndpoint: + description: 'The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`' + type: string + ClusterResourceId: + description: 'The resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.' + type: string + AssociatedRoles: + description: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/DBClusterRole' + AvailabilityZones: + description: Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. + type: array + uniqueItems: true + x-insertionOrder: true + items: + type: string + BackupRetentionPeriod: + description: Specifies the number of days for which automatic DB snapshots are retained. + default: 1 + minimum: 1 + type: integer + CopyTagsToSnapshot: + description: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them. + type: boolean + DBClusterIdentifier: + description: The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string. + type: string + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + minLength: 1 + maxLength: 63 + DBClusterParameterGroupName: + description: Provides the name of the DB cluster parameter group. + type: string + DBInstanceParameterGroupName: + description: The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request. + type: string + DBPort: + description: |- + The port number on which the DB instances in the DB cluster accept connections. + + If not specified, the default port used is `8182`. + + Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities. + type: integer + DBSubnetGroupName: + description: Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. + type: string + DeletionProtection: + description: Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. + type: boolean + EnableCloudwatchLogsExports: + description: Specifies a list of log types that are enabled for export to CloudWatch Logs. + type: array + uniqueItems: true + x-insertionOrder: true + items: + type: string + EngineVersion: + description: Indicates the database engine version. + type: string + IamAuthEnabled: + description: True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. + type: boolean + KmsKeyId: + description: The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true. + type: string + Port: + description: 'The port number on which the DB cluster accepts connections. For example: `8182`.' + type: string + PreferredBackupWindow: + description: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. + type: string + PreferredMaintenanceWindow: + description: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + type: string + RestoreToTime: + description: |- + Creates a new DB cluster from a DB snapshot or DB cluster snapshot. + + If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. + + If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + type: string + RestoreType: + description: |- + Creates a new DB cluster from a DB snapshot or DB cluster snapshot. + + If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. + + If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + type: string + default: full-copy + ServerlessScalingConfiguration: + description: Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster. + $ref: '#/components/schemas/ServerlessScalingConfiguration' + SnapshotIdentifier: + description: |- + Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. + + After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. + + However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted. + type: string + SourceDBClusterIdentifier: + description: |- + Creates a new DB cluster from a DB snapshot or DB cluster snapshot. + + If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. + + If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + type: string + StorageEncrypted: + description: |- + Indicates whether the DB cluster is encrypted. + + If you specify the KmsKeyId property, then you must enable encryption and set this property to true. + + If you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster. + + If you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the KmsKeyId property from the source cluster is used. + + If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used. + type: boolean + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: The tags assigned to this cluster. + items: + $ref: '#/components/schemas/Tag' + UseLatestRestorableTime: + description: |- + Creates a new DB cluster from a DB snapshot or DB cluster snapshot. + + If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. + + If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. + type: boolean + VpcSecurityGroupIds: + description: Provides a list of VPC security groups that the DB cluster belongs to. + uniqueItems: true + x-insertionOrder: true + items: + type: string + type: array + x-stackQL-stringOnly: true + x-title: CreateDBClusterRequest + type: object + required: [] + CreateDBClusterParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: Provides the customer-specified description for this DB cluster parameter group. + type: string + Family: + description: Must be neptune1 for engine versions prior to 1.2.0.0, or neptune1.2 for engine version 1.2.0.0 and higher. + type: string + Parameters: + description: An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. + type: object + Name: + description: Provides the name of the DB cluster parameter group. + type: string + Tags: + description: The list of tags for the cluster parameter group. + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBClusterParameterGroupRequest + type: object + required: [] + CreateDBInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllowMajorVersionUpgrade: + type: boolean + description: Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. + AutoMinorVersionUpgrade: + type: boolean + description: |- + Indicates that minor version patches are applied automatically. + + When updating this property, some interruptions may occur. + AvailabilityZone: + type: string + description: Specifies the name of the Availability Zone the DB instance is located in. + DBClusterIdentifier: + type: string + description: If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. + DBInstanceClass: + type: string + description: |- + Contains the name of the compute and memory capacity class of the DB instance. + + If you update this property, some interruptions may occur. + DBInstanceIdentifier: + type: string + description: Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. + DBParameterGroupName: + type: string + description: The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + DBSnapshotIdentifier: + type: string + description: |+ + This parameter is not supported. + + `AWS::Neptune::DBInstance` does not support restoring from snapshots. + + `AWS::Neptune::DBCluster` does support restoring from snapshots. + + DBSubnetGroupName: + type: string + description: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC). + Endpoint: + type: string + description: 'The connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`.' + PreferredMaintenanceWindow: + type: string + description: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Port: + type: string + description: 'The port number on which the database accepts connections. For example: `8182`.' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + description: An arbitrary set of tags (key-value pairs) for this DB instance. + x-stackQL-stringOnly: true + x-title: CreateDBInstanceRequest + type: object + required: [] + CreateDBParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Provides the name of the DB parameter group. + type: string + Description: + description: Provides the customer-specified description for this DB parameter group. + type: string + Family: + description: Must be `neptune1` for engine versions prior to 1.2.0.0, or `neptune1.2` for engine version `1.2.0.0` and higher. + type: string + Parameters: + description: |- + The parameters to set for this DB parameter group. + + The parameters are expressed as a JSON object consisting of key-value pairs. + + Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover. + type: object + Tags: + description: An optional array of key-value pairs to apply to this DB parameter group. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBParameterGroupRequest + type: object + required: [] + CreateDBSubnetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DBSubnetGroupName: + description: |+ + The name for the DB subnet group. This value is stored as a lowercase string. + + Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default". + + Example: mysubnetgroup + + type: string + DBSubnetGroupDescription: + description: The description for the DB subnet group. + type: string + SubnetIds: + description: The Amazon EC2 subnet IDs for the DB subnet group. + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + uniqueItems: false + description: An optional array of key-value pairs to apply to this DB subnet group. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBSubnetGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + db_clusters: + name: db_clusters + id: awscc.neptune.db_clusters + x-cfn-schema-name: DBCluster + x-cfn-type-name: AWS::Neptune::DBCluster + x-identifiers: + - DBClusterIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.ReadEndpoint') as read_endpoint, + JSON_EXTRACT(Properties, '$.ClusterResourceId') as cluster_resource_id, + JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, + JSON_EXTRACT(Properties, '$.AvailabilityZones') as availability_zones, + JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, + JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, + JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name, + JSON_EXTRACT(Properties, '$.DBInstanceParameterGroupName') as db_instance_parameter_group_name, + JSON_EXTRACT(Properties, '$.DBPort') as db_port, + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, + JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, + JSON_EXTRACT(Properties, '$.EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, + JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, + JSON_EXTRACT(Properties, '$.IamAuthEnabled') as iam_auth_enabled, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.Port') as port, + JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, + JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.RestoreToTime') as restore_to_time, + JSON_EXTRACT(Properties, '$.RestoreType') as restore_type, + JSON_EXTRACT(Properties, '$.ServerlessScalingConfiguration') as serverless_scaling_configuration, + JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, + JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, + JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UseLatestRestorableTime') as use_latest_restorable_time, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'ReadEndpoint') as read_endpoint, + json_extract_path_text(Properties, 'ClusterResourceId') as cluster_resource_id, + json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, + json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, + json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, + json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, + json_extract_path_text(Properties, 'DBInstanceParameterGroupName') as db_instance_parameter_group_name, + json_extract_path_text(Properties, 'DBPort') as db_port, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'IamAuthEnabled') as iam_auth_enabled, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'RestoreToTime') as restore_to_time, + json_extract_path_text(Properties, 'RestoreType') as restore_type, + json_extract_path_text(Properties, 'ServerlessScalingConfiguration') as serverless_scaling_configuration, + json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, + json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, + json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + db_clusters_list_only: + name: db_clusters_list_only + id: awscc.neptune.db_clusters_list_only + x-cfn-schema-name: DBCluster + x-cfn-type-name: AWS::Neptune::DBCluster + x-identifiers: + - DBClusterIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' + AND region = 'us-east-1' + db_cluster_parameter_groups: + name: db_cluster_parameter_groups + id: awscc.neptune.db_cluster_parameter_groups + x-cfn-schema-name: DBClusterParameterGroup + x-cfn-type-name: AWS::Neptune::DBClusterParameterGroup + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBClusterParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Family') as family, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBClusterParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBClusterParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + db_cluster_parameter_groups_list_only: + name: db_cluster_parameter_groups_list_only + id: awscc.neptune.db_cluster_parameter_groups_list_only + x-cfn-schema-name: DBClusterParameterGroup + x-cfn-type-name: AWS::Neptune::DBClusterParameterGroup + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBClusterParameterGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBClusterParameterGroup' + AND region = 'us-east-1' + db_instances: + name: db_instances + id: awscc.neptune.db_instances + x-cfn-schema-name: DBInstance + x-cfn-type-name: AWS::Neptune::DBInstance + x-identifiers: + - DBInstanceIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AllowMajorVersionUpgrade') as allow_major_version_upgrade, + JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, + JSON_EXTRACT(Properties, '$.DBInstanceClass') as db_instance_class, + JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier, + JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name, + JSON_EXTRACT(Properties, '$.DBSnapshotIdentifier') as db_snapshot_identifier, + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.Port') as port, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllowMajorVersionUpgrade') as allow_major_version_upgrade, + json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, + json_extract_path_text(Properties, 'DBInstanceClass') as db_instance_class, + json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier, + json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name, + json_extract_path_text(Properties, 'DBSnapshotIdentifier') as db_snapshot_identifier, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + db_instances_list_only: + name: db_instances_list_only + id: awscc.neptune.db_instances_list_only + x-cfn-schema-name: DBInstance + x-cfn-type-name: AWS::Neptune::DBInstance + x-identifiers: + - DBInstanceIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBInstance' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBInstance' + AND region = 'us-east-1' + db_parameter_groups: + name: db_parameter_groups + id: awscc.neptune.db_parameter_groups + x-cfn-schema-name: DBParameterGroup + x-cfn-type-name: AWS::Neptune::DBParameterGroup + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Family') as family, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + db_parameter_groups_list_only: + name: db_parameter_groups_list_only + id: awscc.neptune.db_parameter_groups_list_only + x-cfn-schema-name: DBParameterGroup + x-cfn-type-name: AWS::Neptune::DBParameterGroup + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBParameterGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBParameterGroup' + AND region = 'us-east-1' + db_subnet_groups: + name: db_subnet_groups + id: awscc.neptune.db_subnet_groups + x-cfn-schema-name: DBSubnetGroup + x-cfn-type-name: AWS::Neptune::DBSubnetGroup + x-identifiers: + - DBSubnetGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBSubnetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Neptune::DBSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, + JSON_EXTRACT(Properties, '$.DBSubnetGroupDescription') as db_subnet_group_description, + JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBSubnetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'DBSubnetGroupDescription') as db_subnet_group_description, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBSubnetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + db_subnet_groups_list_only: + name: db_subnet_groups_list_only + id: awscc.neptune.db_subnet_groups_list_only + x-cfn-schema-name: DBSubnetGroup + x-cfn-type-name: AWS::Neptune::DBSubnetGroup + x-identifiers: + - DBSubnetGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBSubnetGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBSubnetGroup' + AND region = 'us-east-1' + event_subscriptions: + name: event_subscriptions + id: awscc.neptune.event_subscriptions + x-cfn-schema-name: EventSubscription + x-cfn-type-name: AWS::Neptune::EventSubscription + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBClusterParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBClusterParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBClusterParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBSubnetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBSubnetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBSubnetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/neptunegraph.yaml b/providers/src/awscc/v00.00.00000/services/neptunegraph.yaml index d153e5ba..720d0b2d 100644 --- a/providers/src/awscc/v00.00.00000/services/neptunegraph.yaml +++ b/providers/src/awscc/v00.00.00000/services/neptunegraph.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: NeptuneGraph - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -96,16 +476,30 @@ components: required: - ProvisionedMemory x-stackql-resource-name: graph - x-stackql-primaryIdentifier: + description: The AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph. + x-type-name: AWS::NeptuneGraph::Graph + x-stackql-primary-identifier: - GraphId + x-stackql-additional-identifiers: + - - GraphName x-create-only-properties: - GraphName - ReplicaCount - VectorSearchConfiguration + x-conditional-create-only-properties: + - ProvisionedMemory x-read-only-properties: - GraphArn - GraphId - Endpoint + x-required-properties: + - ProvisionedMemory + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - iam:PassRole @@ -179,16 +573,32 @@ components: - GraphIdentifier - VpcId x-stackql-resource-name: private_graph_endpoint - x-stackql-primaryIdentifier: + description: The AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint. + x-type-name: AWS::NeptuneGraph::PrivateGraphEndpoint + x-stackql-primary-identifier: - PrivateGraphEndpointIdentifier + x-stackql-additional-identifiers: + - - GraphIdentifier + - VpcId x-create-only-properties: - GraphIdentifier - SecurityGroupIds - SubnetIds - VpcId + x-write-only-properties: + - GraphIdentifier + - SecurityGroupIds x-read-only-properties: - PrivateGraphEndpointIdentifier - VpcEndpointId + x-required-properties: + - GraphIdentifier + - VpcId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - ec2:CreateVpcEndpoint @@ -224,43 +634,193 @@ components: list: - neptune-graph:GetPrivateGraphEndpoint - neptune-graph:ListPrivateGraphEndpoints + - neptune-graph:ListGraphs + CreateGraphRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeletionProtection: + description: |- + Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled. + + _Default_: If not specified, the default value is true. + type: boolean + GraphName: + description: |- + Contains a user-supplied name for the Graph. + + If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters. + + _Important_: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + type: string + pattern: ^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ + minLength: 1 + maxLength: 63 + ProvisionedMemory: + description: Memory for the Graph. + type: integer + PublicConnectivity: + description: |- + Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. + + When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet. + + When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC. + + _Default_: If not specified, the default value is false. + type: boolean + ReplicaCount: + description: |- + Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones. + + Replica Count should always be less than or equal to 2. + + _Default_: If not specified, the default value is 1. + type: integer + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: The tags associated with this graph. + items: + $ref: '#/components/schemas/Tag' + VectorSearchConfiguration: + description: Vector Search Configuration + $ref: '#/components/schemas/VectorSearchConfiguration' + Endpoint: + description: 'The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`' + type: string + GraphArn: + description: Graph resource ARN + type: string + GraphId: + description: The auto-generated id assigned by the service. + type: string + x-stackQL-stringOnly: true + x-title: CreateGraphRequest + type: object + required: [] + CreatePrivateGraphEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GraphIdentifier: + description: The auto-generated Graph Id assigned by the service. + type: string + SecurityGroupIds: + description: The security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC. + type: array + x-insertionOrder: false + items: + type: string + SubnetIds: + description: The subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC. + type: array + x-insertionOrder: false + items: + type: string + VpcId: + description: The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC. + type: string + PrivateGraphEndpointIdentifier: + description: |- + PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator. + + For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90` + type: string + VpcEndpointId: + description: VPC endpoint that provides a private connection between the Graph and specified VPC. + type: string + x-stackQL-stringOnly: true + x-title: CreatePrivateGraphEndpointRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: graphs: name: graphs id: awscc.neptunegraph.graphs x-cfn-schema-name: Graph - x-type: list - x-identifiers: - - GraphId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GraphId') as graph_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GraphId') as graph_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' - AND region = 'us-east-1' - graph: - name: graph - id: awscc.neptunegraph.graph - x-cfn-schema-name: Graph - x-type: get + x-cfn-type-name: AWS::NeptuneGraph::Graph x-identifiers: - GraphId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Graph&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NeptuneGraph::Graph" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NeptuneGraph::Graph" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NeptuneGraph::Graph" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/graphs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/graphs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/graphs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -279,7 +839,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -297,13 +857,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' AND data__Identifier = '' AND region = 'us-east-1' - private_graph_endpoints: - name: private_graph_endpoints - id: awscc.neptunegraph.private_graph_endpoints - x-cfn-schema-name: PrivateGraphEndpoint - x-type: list + graphs_list_only: + name: graphs_list_only + id: awscc.neptunegraph.graphs_list_only + x-cfn-schema-name: Graph + x-cfn-type-name: AWS::NeptuneGraph::Graph x-identifiers: - - PrivateGraphEndpointIdentifier + - GraphId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -311,28 +877,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' + JSON_EXTRACT(Properties, '$.GraphId') as graph_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' + json_extract_path_text(Properties, 'GraphId') as graph_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' AND region = 'us-east-1' - private_graph_endpoint: - name: private_graph_endpoint - id: awscc.neptunegraph.private_graph_endpoint + private_graph_endpoints: + name: private_graph_endpoints + id: awscc.neptunegraph.private_graph_endpoints x-cfn-schema-name: PrivateGraphEndpoint - x-type: get + x-cfn-type-name: AWS::NeptuneGraph::PrivateGraphEndpoint x-identifiers: - PrivateGraphEndpointIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PrivateGraphEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NeptuneGraph::PrivateGraphEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NeptuneGraph::PrivateGraphEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NeptuneGraph::PrivateGraphEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -347,7 +961,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -361,3 +975,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' AND data__Identifier = '' AND region = 'us-east-1' + private_graph_endpoints_list_only: + name: private_graph_endpoints_list_only + id: awscc.neptunegraph.private_graph_endpoints_list_only + x-cfn-schema-name: PrivateGraphEndpoint + x-cfn-type-name: AWS::NeptuneGraph::PrivateGraphEndpoint + x-identifiers: + - PrivateGraphEndpointIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Graph&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGraph + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGraphRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PrivateGraphEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePrivateGraphEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePrivateGraphEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/networkfirewall.yaml b/providers/src/awscc/v00.00.00000/services/networkfirewall.yaml index 1e6bec09..0ba210f3 100644 --- a/providers/src/awscc/v00.00.00000/services/networkfirewall.yaml +++ b/providers/src/awscc/v00.00.00000/services/networkfirewall.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: NetworkFirewall - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ResourceArn: description: A resource ARN. @@ -14,6 +394,15 @@ components: EndpointId: description: An endpoint Id. type: string + AvailabilityZoneMapping: + type: object + properties: + AvailabilityZone: + description: A AvailabilityZone + type: string + required: + - AvailabilityZone + additionalProperties: false SubnetMapping: type: object properties: @@ -26,6 +415,12 @@ components: required: - SubnetId additionalProperties: false + EnabledAnalysisType: + description: An analysis type. + enum: + - TLS_SNI + - HTTP_HOST + type: string Tag: type: object properties: @@ -67,17 +462,28 @@ components: pattern: ^vpc-[0-9a-f]+$ SubnetMappings: type: array - minItems: 1 x-insertionOrder: false uniqueItems: true items: $ref: '#/components/schemas/SubnetMapping' + AvailabilityZoneMappings: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/AvailabilityZoneMapping' DeleteProtection: type: boolean SubnetChangeProtection: type: boolean + AvailabilityZoneChangeProtection: + type: boolean FirewallPolicyChangeProtection: type: boolean + TransitGatewayId: + type: string + maxLength: 128 + pattern: ^tgw-[0-9a-z]+$ Description: type: string maxLength: 512 @@ -87,6 +493,12 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/EndpointId' + EnabledAnalysisTypes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EnabledAnalysisType' + description: The types of analysis to enable for the firewall. Can be TLS_SNI, HTTP_HOST, or both. Tags: type: array x-insertionOrder: false @@ -96,10 +508,10 @@ components: required: - FirewallName - FirewallPolicyArn - - VpcId - - SubnetMappings x-stackql-resource-name: firewall - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::NetworkFirewall::Firewall + x-type-name: AWS::NetworkFirewall::Firewall + x-stackql-primary-identifier: - FirewallArn x-create-only-properties: - VpcId @@ -108,6 +520,19 @@ components: - FirewallArn - FirewallId - EndpointIds + x-required-properties: + - FirewallName + - FirewallPolicyArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - network-firewall:TagResource + - network-firewall:UntagResource + - network-firewall:ListTagsForResource x-required-permissions: create: - ec2:CreateVpcEndpoint @@ -120,11 +545,12 @@ components: - network-firewall:DescribeRuleGroup - network-firewall:TagResource - network-firewall:AssociateSubnets + - network-firewall:AssociateAvailabilityZones - network-firewall:AssociateFirewallPolicy - network-firewall:DescribeFirewall read: - network-firewall:DescribeFirewall - - network-firewall:ListTagsForResources + - network-firewall:ListTagsForResource update: - network-firewall:AssociateSubnets - network-firewall:DisassociateSubnets @@ -136,6 +562,10 @@ components: - network-firewall:TagResource - network-firewall:UntagResource - network-firewall:DescribeFirewall + - network-firewall:UpdateFirewallAnalysisSettings + - network-firewall:DisassociateAvailabilityZones + - network-firewall:AssociateAvailabilityZones + - network-firewall:UpdateAvailabilityZoneChangeProtection delete: - ec2:DeleteVpcEndpoints - ec2:DescribeRouteTables @@ -180,13 +610,28 @@ components: - FirewallPolicyName - FirewallPolicy x-stackql-resource-name: firewall_policy - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::NetworkFirewall::FirewallPolicy + x-type-name: AWS::NetworkFirewall::FirewallPolicy + x-stackql-primary-identifier: - FirewallPolicyArn x-create-only-properties: - FirewallPolicyName x-read-only-properties: - FirewallPolicyArn - FirewallPolicyId + x-required-properties: + - FirewallPolicyName + - FirewallPolicy + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - network-firewall:TagResource + - network-firewall:UntagResource + - network-firewall:ListTagsForResource x-required-permissions: create: - network-firewall:CreateFirewallPolicy @@ -278,6 +723,8 @@ components: $ref: '#/components/schemas/Priority' Override: $ref: '#/components/schemas/StatefulRuleGroupOverride' + DeepThreatInspection: + type: boolean required: - ResourceArn additionalProperties: false @@ -327,6 +774,14 @@ components: $ref: '#/components/schemas/RuleOrder' StreamExceptionPolicy: $ref: '#/components/schemas/StreamExceptionPolicy' + FlowTimeouts: + type: object + properties: + TcpIdleTimeoutSeconds: + type: integer + minimum: 60 + maximum: 6000 + additionalProperties: false additionalProperties: false RuleOrder: type: string @@ -351,15 +806,24 @@ components: $ref: '#/components/schemas/ResourceArn' LoggingConfiguration: $ref: '#/components/schemas/LoggingConfiguration' + EnableMonitoringDashboard: + type: boolean required: - FirewallArn - LoggingConfiguration x-stackql-resource-name: logging_configuration - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::NetworkFirewall::LoggingConfiguration + x-type-name: AWS::NetworkFirewall::LoggingConfiguration + x-stackql-primary-identifier: - FirewallArn x-create-only-properties: - FirewallName - FirewallArn + x-required-properties: + - FirewallArn + - LoggingConfiguration + x-tagging: + taggable: false x-required-permissions: create: - logs:CreateLogDelivery @@ -399,10 +863,6 @@ components: - logs:GetLogDelivery - network-firewall:UpdateLoggingConfiguration - network-firewall:DescribeLoggingConfiguration - list: - - logs:GetLogDelivery - - logs:ListLogDeliveries - - network-firewall:DescribeLoggingConfiguration LogDestinationConfig: type: object properties: @@ -411,6 +871,7 @@ components: enum: - ALERT - FLOW + - TLS LogDestinationType: type: string enum: @@ -460,6 +921,16 @@ components: - STATEFUL Capacity: type: integer + SummaryConfiguration: + type: object + properties: + RuleOptions: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/SummaryRuleOption' + additionalProperties: false Description: type: string minLength: 1 @@ -476,7 +947,9 @@ components: - Capacity - RuleGroupName x-stackql-resource-name: rule_group - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::NetworkFirewall::RuleGroup + x-type-name: AWS::NetworkFirewall::RuleGroup + x-stackql-primary-identifier: - RuleGroupArn x-create-only-properties: - RuleGroupName @@ -485,6 +958,20 @@ components: x-read-only-properties: - RuleGroupArn - RuleGroupId + x-required-properties: + - Type + - Capacity + - RuleGroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - network-firewall:TagResource + - network-firewall:UntagResource + - network-firewall:ListTagsForResource x-required-permissions: create: - network-firewall:CreateRuleGroup @@ -493,6 +980,7 @@ components: - network-firewall:ListRuleGroups - iam:CreateServiceLinkedRole - ec2:GetManagedPrefixListEntries + - ec2:DescribeManagedPrefixLists read: - network-firewall:DescribeRuleGroup - network-firewall:ListTagsForResources @@ -503,6 +991,7 @@ components: - network-firewall:UntagResource - iam:CreateServiceLinkedRole - ec2:GetManagedPrefixListEntries + - ec2:DescribeManagedPrefixLists delete: - network-firewall:DeleteRuleGroup - network-firewall:DescribeRuleGroup @@ -578,6 +1067,12 @@ components: enum: - TLS_SNI - HTTP_HOST + SummaryRuleOption: + type: string + enum: + - SID + - MSG + - METADATA GeneratedRulesType: type: string enum: @@ -868,15 +1363,31 @@ components: - TLSInspectionConfigurationName - TLSInspectionConfiguration x-stackql-resource-name: tls_inspection_configuration - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration + x-type-name: AWS::NetworkFirewall::TLSInspectionConfiguration + x-stackql-primary-identifier: - TLSInspectionConfigurationArn x-create-only-properties: - TLSInspectionConfigurationName x-read-only-properties: - TLSInspectionConfigurationArn - TLSInspectionConfigurationId + x-required-properties: + - TLSInspectionConfigurationName + - TLSInspectionConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - network-firewall:TagResource + - network-firewall:UntagResource + - network-firewall:ListTagsForResource x-required-permissions: create: + - iam:CreateServiceLinkedRole - network-firewall:CreateTLSInspectionConfiguration - network-firewall:DescribeTLSInspectionConfiguration - network-firewall:TagResource @@ -972,43 +1483,457 @@ components: items: $ref: '#/components/schemas/ProtocolNumber' additionalProperties: false + ResourceId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ + Description: + type: string + maxLength: 512 + pattern: ^.*$ + VpcId: + type: string + minLength: 1 + maxLength: 128 + pattern: ^vpc-[0-9a-f]+$ + VpcEndpointAssociation: + type: object + properties: + VpcEndpointAssociationArn: + $ref: '#/components/schemas/ResourceArn' + VpcEndpointAssociationId: + $ref: '#/components/schemas/ResourceId' + Description: + $ref: '#/components/schemas/Description' + FirewallArn: + $ref: '#/components/schemas/ResourceArn' + VpcId: + $ref: '#/components/schemas/VpcId' + EndpointId: + $ref: '#/components/schemas/EndpointId' + SubnetMapping: + $ref: '#/components/schemas/SubnetMapping' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + required: + - FirewallArn + - VpcId + - SubnetMapping + x-stackql-resource-name: vpc_endpoint_association + description: Resource type definition for AWS::NetworkFirewall::VpcEndpointAssociation + x-type-name: AWS::NetworkFirewall::VpcEndpointAssociation + x-stackql-primary-identifier: + - VpcEndpointAssociationArn + x-create-only-properties: + - FirewallArn + - Description + - VpcId + - SubnetMapping + x-read-only-properties: + - VpcEndpointAssociationArn + - VpcEndpointAssociationId + - EndpointId + x-required-properties: + - FirewallArn + - VpcId + - SubnetMapping + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - network-firewall:TagResource + - network-firewall:UntagResource + - network-firewall:ListTagsForResource + x-required-permissions: + create: + - network-firewall:CreateVpcEndpointAssociation + - network-firewall:DescribeVpcEndpointAssociation + - network-firewall:ListFirewalls + - network-firewall:TagResource + - ec2:CreateVpcEndpoint + - ec2:DescribeVpcEndpoints + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - iam:CreateServiceLinkedRole + read: + - network-firewall:DescribeVpcEndpointAssociation + - network-firewall:ListTagsForResource + update: + - network-firewall:DescribeVpcEndpointAssociation + - network-firewall:TagResource + - network-firewall:UntagResource + delete: + - network-firewall:DeleteVpcEndpointAssociation + - network-firewall:DescribeVpcEndpointAssociation + - network-firewall:UntagResource + - ec2:DeleteVpcEndpoints + - ec2:DescribeRouteTables + list: + - network-firewall:ListVpcEndpointAssociations + CreateFirewallRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FirewallName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + FirewallArn: + $ref: '#/components/schemas/ResourceArn' + FirewallId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ + FirewallPolicyArn: + $ref: '#/components/schemas/ResourceArn' + VpcId: + type: string + minLength: 1 + maxLength: 128 + pattern: ^vpc-[0-9a-f]+$ + SubnetMappings: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/SubnetMapping' + AvailabilityZoneMappings: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/AvailabilityZoneMapping' + DeleteProtection: + type: boolean + SubnetChangeProtection: + type: boolean + AvailabilityZoneChangeProtection: + type: boolean + FirewallPolicyChangeProtection: + type: boolean + TransitGatewayId: + type: string + maxLength: 128 + pattern: ^tgw-[0-9a-z]+$ + Description: + type: string + maxLength: 512 + pattern: ^.*$ + EndpointIds: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EndpointId' + EnabledAnalysisTypes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/EnabledAnalysisType' + description: The types of analysis to enable for the firewall. Can be TLS_SNI, HTTP_HOST, or both. + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFirewallRequest + type: object + required: [] + CreateFirewallPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FirewallPolicyName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + FirewallPolicyArn: + $ref: '#/components/schemas/ResourceArn' + FirewallPolicy: + $ref: '#/components/schemas/FirewallPolicy' + FirewallPolicyId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ + Description: + type: string + minLength: 1 + maxLength: 512 + pattern: ^.*$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFirewallPolicyRequest + type: object + required: [] + CreateLoggingConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FirewallName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + FirewallArn: + $ref: '#/components/schemas/ResourceArn' + LoggingConfiguration: + $ref: '#/components/schemas/LoggingConfiguration' + EnableMonitoringDashboard: + type: boolean + x-stackQL-stringOnly: true + x-title: CreateLoggingConfigurationRequest + type: object + required: [] + CreateRuleGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleGroupName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + RuleGroupArn: + $ref: '#/components/schemas/ResourceArn' + RuleGroupId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ + RuleGroup: + $ref: '#/components/schemas/RuleGroup' + Type: + type: string + enum: + - STATELESS + - STATEFUL + Capacity: + type: integer + SummaryConfiguration: + type: object + properties: + RuleOptions: + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/SummaryRuleOption' + additionalProperties: false + Description: + type: string + minLength: 1 + maxLength: 512 + pattern: ^.*$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRuleGroupRequest + type: object + required: [] + CreateTLSInspectionConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TLSInspectionConfigurationName: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + TLSInspectionConfigurationArn: + $ref: '#/components/schemas/ResourceArn' + TLSInspectionConfiguration: + $ref: '#/components/schemas/TLSInspectionConfiguration' + TLSInspectionConfigurationId: + type: string + minLength: 36 + maxLength: 36 + pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ + Description: + type: string + minLength: 1 + maxLength: 512 + pattern: ^.*$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTLSInspectionConfigurationRequest + type: object + required: [] + CreateVpcEndpointAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VpcEndpointAssociationArn: + $ref: '#/components/schemas/ResourceArn' + VpcEndpointAssociationId: + $ref: '#/components/schemas/ResourceId' + Description: + $ref: '#/components/schemas/Description' + FirewallArn: + $ref: '#/components/schemas/ResourceArn' + VpcId: + $ref: '#/components/schemas/VpcId' + EndpointId: + $ref: '#/components/schemas/EndpointId' + SubnetMapping: + $ref: '#/components/schemas/SubnetMapping' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateVpcEndpointAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: firewalls: name: firewalls id: awscc.networkfirewall.firewalls x-cfn-schema-name: Firewall - x-type: list - x-identifiers: - - FirewallArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FirewallArn') as firewall_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' - AND region = 'us-east-1' - firewall: - name: firewall - id: awscc.networkfirewall.firewall - x-cfn-schema-name: Firewall - x-type: get + x-cfn-type-name: AWS::NetworkFirewall::Firewall x-identifiers: - FirewallArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Firewall&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::Firewall" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::Firewall" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::Firewall" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1019,17 +1944,21 @@ components: JSON_EXTRACT(Properties, '$.FirewallPolicyArn') as firewall_policy_arn, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, JSON_EXTRACT(Properties, '$.SubnetMappings') as subnet_mappings, + JSON_EXTRACT(Properties, '$.AvailabilityZoneMappings') as availability_zone_mappings, JSON_EXTRACT(Properties, '$.DeleteProtection') as delete_protection, JSON_EXTRACT(Properties, '$.SubnetChangeProtection') as subnet_change_protection, + JSON_EXTRACT(Properties, '$.AvailabilityZoneChangeProtection') as availability_zone_change_protection, JSON_EXTRACT(Properties, '$.FirewallPolicyChangeProtection') as firewall_policy_change_protection, + JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.EndpointIds') as endpoint_ids, + JSON_EXTRACT(Properties, '$.EnabledAnalysisTypes') as enabled_analysis_types, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1040,22 +1969,32 @@ components: json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn, json_extract_path_text(Properties, 'VpcId') as vpc_id, json_extract_path_text(Properties, 'SubnetMappings') as subnet_mappings, + json_extract_path_text(Properties, 'AvailabilityZoneMappings') as availability_zone_mappings, json_extract_path_text(Properties, 'DeleteProtection') as delete_protection, json_extract_path_text(Properties, 'SubnetChangeProtection') as subnet_change_protection, + json_extract_path_text(Properties, 'AvailabilityZoneChangeProtection') as availability_zone_change_protection, json_extract_path_text(Properties, 'FirewallPolicyChangeProtection') as firewall_policy_change_protection, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'EndpointIds') as endpoint_ids, + json_extract_path_text(Properties, 'EnabledAnalysisTypes') as enabled_analysis_types, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' AND data__Identifier = '' AND region = 'us-east-1' - firewall_policies: - name: firewall_policies - id: awscc.networkfirewall.firewall_policies - x-cfn-schema-name: FirewallPolicy - x-type: list + firewalls_list_only: + name: firewalls_list_only + id: awscc.networkfirewall.firewalls_list_only + x-cfn-schema-name: Firewall + x-cfn-type-name: AWS::NetworkFirewall::Firewall x-identifiers: - - FirewallPolicyArn + - FirewallArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1063,28 +2002,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FirewallPolicyArn') as firewall_policy_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' + JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' + json_extract_path_text(Properties, 'FirewallArn') as firewall_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' AND region = 'us-east-1' - firewall_policy: - name: firewall_policy - id: awscc.networkfirewall.firewall_policy + firewall_policies: + name: firewall_policies + id: awscc.networkfirewall.firewall_policies x-cfn-schema-name: FirewallPolicy - x-type: get + x-cfn-type-name: AWS::NetworkFirewall::FirewallPolicy x-identifiers: - FirewallPolicyArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FirewallPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::FirewallPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::FirewallPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::FirewallPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1099,7 +2086,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1113,13 +2100,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' AND data__Identifier = '' AND region = 'us-east-1' - logging_configurations: - name: logging_configurations - id: awscc.networkfirewall.logging_configurations - x-cfn-schema-name: LoggingConfiguration - x-type: list + firewall_policies_list_only: + name: firewall_policies_list_only + id: awscc.networkfirewall.firewall_policies_list_only + x-cfn-schema-name: FirewallPolicy + x-cfn-type-name: AWS::NetworkFirewall::FirewallPolicy x-identifiers: - - FirewallArn + - FirewallPolicyArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1127,47 +2120,97 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' + JSON_EXTRACT(Properties, '$.FirewallPolicyArn') as firewall_policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FirewallArn') as firewall_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' + json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' AND region = 'us-east-1' - logging_configuration: - name: logging_configuration - id: awscc.networkfirewall.logging_configuration + logging_configurations: + name: logging_configurations + id: awscc.networkfirewall.logging_configurations x-cfn-schema-name: LoggingConfiguration - x-type: get + x-cfn-type-name: AWS::NetworkFirewall::LoggingConfiguration x-identifiers: - FirewallArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LoggingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.FirewallName') as firewall_name, JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn, - JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration + JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration, + JSON_EXTRACT(Properties, '$.EnableMonitoringDashboard') as enable_monitoring_dashboard FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'FirewallName') as firewall_name, json_extract_path_text(Properties, 'FirewallArn') as firewall_arn, - json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration + json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, + json_extract_path_text(Properties, 'EnableMonitoringDashboard') as enable_monitoring_dashboard FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' @@ -1175,38 +2218,61 @@ components: name: rule_groups id: awscc.networkfirewall.rule_groups x-cfn-schema-name: RuleGroup - x-type: list - x-identifiers: - - RuleGroupArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RuleGroupArn') as rule_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RuleGroupArn') as rule_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' - AND region = 'us-east-1' - rule_group: - name: rule_group - id: awscc.networkfirewall.rule_group - x-cfn-schema-name: RuleGroup - x-type: get + x-cfn-type-name: AWS::NetworkFirewall::RuleGroup x-identifiers: - RuleGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RuleGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::RuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::RuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::RuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1217,13 +2283,14 @@ components: JSON_EXTRACT(Properties, '$.RuleGroup') as rule_group, JSON_EXTRACT(Properties, '$.Type') as type, JSON_EXTRACT(Properties, '$.Capacity') as capacity, + JSON_EXTRACT(Properties, '$.SummaryConfiguration') as summary_configuration, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1234,18 +2301,25 @@ components: json_extract_path_text(Properties, 'RuleGroup') as rule_group, json_extract_path_text(Properties, 'Type') as type, json_extract_path_text(Properties, 'Capacity') as capacity, + json_extract_path_text(Properties, 'SummaryConfiguration') as summary_configuration, json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' AND data__Identifier = '' AND region = 'us-east-1' - tls_inspection_configurations: - name: tls_inspection_configurations - id: awscc.networkfirewall.tls_inspection_configurations - x-cfn-schema-name: TLSInspectionConfiguration - x-type: list + rule_groups_list_only: + name: rule_groups_list_only + id: awscc.networkfirewall.rule_groups_list_only + x-cfn-schema-name: RuleGroup + x-cfn-type-name: AWS::NetworkFirewall::RuleGroup x-identifiers: - - TLSInspectionConfigurationArn + - RuleGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1253,28 +2327,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TLSInspectionConfigurationArn') as tls_inspection_configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' + JSON_EXTRACT(Properties, '$.RuleGroupArn') as rule_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TLSInspectionConfigurationArn') as tls_inspection_configuration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' + json_extract_path_text(Properties, 'RuleGroupArn') as rule_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' AND region = 'us-east-1' - tls_inspection_configuration: - name: tls_inspection_configuration - id: awscc.networkfirewall.tls_inspection_configuration + tls_inspection_configurations: + name: tls_inspection_configurations + id: awscc.networkfirewall.tls_inspection_configurations x-cfn-schema-name: TLSInspectionConfiguration - x-type: get + x-cfn-type-name: AWS::NetworkFirewall::TLSInspectionConfiguration x-identifiers: - TLSInspectionConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TLSInspectionConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::TLSInspectionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::TLSInspectionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::TLSInspectionConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1289,7 +2411,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1303,3 +2425,561 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' AND data__Identifier = '' AND region = 'us-east-1' + tls_inspection_configurations_list_only: + name: tls_inspection_configurations_list_only + id: awscc.networkfirewall.tls_inspection_configurations_list_only + x-cfn-schema-name: TLSInspectionConfiguration + x-cfn-type-name: AWS::NetworkFirewall::TLSInspectionConfiguration + x-identifiers: + - TLSInspectionConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TLSInspectionConfigurationArn') as tls_inspection_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TLSInspectionConfigurationArn') as tls_inspection_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' + AND region = 'us-east-1' + vpc_endpoint_associations: + name: vpc_endpoint_associations + id: awscc.networkfirewall.vpc_endpoint_associations + x-cfn-schema-name: VpcEndpointAssociation + x-cfn-type-name: AWS::NetworkFirewall::VpcEndpointAssociation + x-identifiers: + - VpcEndpointAssociationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcEndpointAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::VpcEndpointAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::VpcEndpointAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkFirewall::VpcEndpointAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.VpcEndpointAssociationArn') as vpc_endpoint_association_arn, + JSON_EXTRACT(Properties, '$.VpcEndpointAssociationId') as vpc_endpoint_association_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.EndpointId') as endpoint_id, + JSON_EXTRACT(Properties, '$.SubnetMapping') as subnet_mapping, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::VpcEndpointAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpcEndpointAssociationArn') as vpc_endpoint_association_arn, + json_extract_path_text(Properties, 'VpcEndpointAssociationId') as vpc_endpoint_association_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FirewallArn') as firewall_arn, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'EndpointId') as endpoint_id, + json_extract_path_text(Properties, 'SubnetMapping') as subnet_mapping, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::VpcEndpointAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + vpc_endpoint_associations_list_only: + name: vpc_endpoint_associations_list_only + id: awscc.networkfirewall.vpc_endpoint_associations_list_only + x-cfn-schema-name: VpcEndpointAssociation + x-cfn-type-name: AWS::NetworkFirewall::VpcEndpointAssociation + x-identifiers: + - VpcEndpointAssociationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VpcEndpointAssociationArn') as vpc_endpoint_association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::VpcEndpointAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcEndpointAssociationArn') as vpc_endpoint_association_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::VpcEndpointAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Firewall&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFirewall + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFirewallRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FirewallPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFirewallPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFirewallPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LoggingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLoggingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoggingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RuleGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRuleGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TLSInspectionConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTLSInspectionConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTLSInspectionConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcEndpointAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcEndpointAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcEndpointAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/networkmanager.yaml b/providers/src/awscc/v00.00.00000/services/networkmanager.yaml index a87f2ec8..9c08fb80 100644 --- a/providers/src/awscc/v00.00.00000/services/networkmanager.yaml +++ b/providers/src/awscc/v00.00.00000/services/networkmanager.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: NetworkManager - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ProposedSegmentChange: description: The attachment to move from one segment to another. @@ -23,6 +403,24 @@ components: description: The name of the segment to change. type: string additionalProperties: false + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + type: object + properties: + Tags: + description: The key-value tags that changed for the network function group. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AttachmentPolicyRuleNumber: + description: The rule number in the policy document that applies to this change. + type: integer + NetworkFunctionGroupName: + description: The name of the network function group to change. + type: string + additionalProperties: false Tag: description: A key-value pair to associate with a resource. type: object @@ -81,6 +479,12 @@ components: ProposedSegmentChange: description: The attachment to move from one segment to another. $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' Tags: description: Tags for the attachment. type: array @@ -106,7 +510,9 @@ components: - TransportAttachmentId - Options x-stackql-resource-name: connect_attachment - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::ConnectAttachment Resource Type Definition + x-type-name: AWS::NetworkManager::ConnectAttachment + x-stackql-primary-identifier: - AttachmentId x-create-only-properties: - CoreNetworkId @@ -124,6 +530,21 @@ components: - OwnerAccountId - AttachmentPolicyRuleNumber - SegmentName + x-required-properties: + - CoreNetworkId + - EdgeLocation + - TransportAttachmentId + - Options + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:GetConnectAttachment @@ -247,8 +668,14 @@ components: - ConnectAttachmentId - PeerAddress x-stackql-resource-name: connect_peer - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::ConnectPeer Resource Type Definition. + x-type-name: AWS::NetworkManager::ConnectPeer + x-stackql-primary-identifier: - ConnectPeerId + x-stackql-additional-identifiers: + - - ConnectAttachmentId + - CoreNetworkAddress + - InsideCidrBlocks x-create-only-properties: - PeerAddress - CoreNetworkAddress @@ -256,6 +683,10 @@ components: - InsideCidrBlocks - ConnectAttachmentId - SubnetArn + x-write-only-properties: + - CoreNetworkAddress + - BgpOptions + - SubnetArn x-read-only-properties: - ConnectPeerId - State @@ -263,6 +694,19 @@ components: - Configuration - CoreNetworkId - EdgeLocation + x-required-properties: + - ConnectAttachmentId + - PeerAddress + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:GetConnectPeer @@ -302,6 +746,35 @@ components: type: string description: The shared segments of a core network. additionalProperties: false + CoreNetworkNetworkFunctionGroup: + type: object + properties: + Name: + type: string + description: Name of network function group + EdgeLocations: + type: array + x-insertionOrder: false + items: + type: string + description: The Regions where the edges are located. + Segments: + type: object + properties: + SendTo: + type: array + x-insertionOrder: false + items: + type: string + description: The send-to segments. + SendVia: + type: array + x-insertionOrder: false + items: + type: string + description: The send-via segments. + additionalProperties: false + additionalProperties: false CoreNetworkEdge: type: object properties: @@ -348,6 +821,12 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/CoreNetworkSegment' + NetworkFunctionGroups: + description: The network function groups within a core network. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CoreNetworkNetworkFunctionGroup' Edges: description: The edges within a core network. type: array @@ -367,8 +846,13 @@ components: required: - GlobalNetworkId x-stackql-resource-name: core_network - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::CoreNetwork Resource Type Definition. + x-type-name: AWS::NetworkManager::CoreNetwork + x-stackql-primary-identifier: - CoreNetworkId + x-stackql-additional-identifiers: + - - CoreNetworkArn + - - GlobalNetworkId x-create-only-properties: - GlobalNetworkId x-read-only-properties: @@ -378,7 +862,20 @@ components: - CreatedAt - State - Segments + - NetworkFunctionGroups - Edges + x-required-properties: + - GlobalNetworkId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateCoreNetwork @@ -427,7 +924,9 @@ components: - CustomerGatewayArn - DeviceId x-stackql-resource-name: customer_gateway_association - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link. + x-type-name: AWS::NetworkManager::CustomerGatewayAssociation + x-stackql-primary-identifier: - GlobalNetworkId - CustomerGatewayArn x-create-only-properties: @@ -435,6 +934,15 @@ components: - CustomerGatewayArn - DeviceId - LinkId + x-required-properties: + - GlobalNetworkId + - CustomerGatewayArn + - DeviceId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - networkmanager:GetCustomerGatewayAssociations @@ -522,9 +1030,13 @@ components: required: - GlobalNetworkId x-stackql-resource-name: device - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::Device type describes a device. + x-type-name: AWS::NetworkManager::Device + x-stackql-primary-identifier: - GlobalNetworkId - DeviceId + x-stackql-additional-identifiers: + - - DeviceArn x-create-only-properties: - GlobalNetworkId x-read-only-properties: @@ -532,6 +1044,18 @@ components: - DeviceArn - State - CreatedAt + x-required-properties: + - GlobalNetworkId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateDevice @@ -550,6 +1074,131 @@ components: - networkmanager:DeleteDevice list: - networkmanager:GetDevices + DirectConnectGatewayAttachment: + type: object + properties: + CoreNetworkId: + description: The ID of a core network for the Direct Connect Gateway attachment. + type: string + CoreNetworkArn: + description: The ARN of a core network for the Direct Connect Gateway attachment. + type: string + AttachmentId: + description: Id of the attachment. + type: string + OwnerAccountId: + description: Owner account of the attachment. + type: string + AttachmentType: + description: Attachment type. + type: string + State: + description: State of the attachment. + type: string + EdgeLocations: + description: The Regions where the edges are located. + type: array + x-insertionOrder: false + items: + type: string + DirectConnectGatewayArn: + description: The ARN of the Direct Connect Gateway. + type: string + ResourceArn: + description: The ARN of the Resource. + type: string + AttachmentPolicyRuleNumber: + description: The policy rule number associated with the attachment. + type: integer + SegmentName: + description: The name of the segment attachment.. + type: string + ProposedSegmentChange: + description: The attachment to move from one segment to another. + $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' + Tags: + description: Tags for the attachment. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + description: Creation time of the attachment. + type: string + UpdatedAt: + description: Last update time of the attachment. + type: string + required: + - CoreNetworkId + - DirectConnectGatewayArn + - EdgeLocations + x-stackql-resource-name: direct_connect_gateway_attachment + description: AWS::NetworkManager::DirectConnectGatewayAttachment Resource Type + x-type-name: AWS::NetworkManager::DirectConnectGatewayAttachment + x-stackql-primary-identifier: + - AttachmentId + x-stackql-additional-identifiers: + - - CoreNetworkId + - DirectConnectGatewayArn + x-create-only-properties: + - CoreNetworkId + - DirectConnectGatewayArn + x-read-only-properties: + - CoreNetworkArn + - CreatedAt + - UpdatedAt + - AttachmentType + - State + - AttachmentId + - OwnerAccountId + - AttachmentPolicyRuleNumber + - SegmentName + - NetworkFunctionGroupName + - ResourceArn + x-required-properties: + - CoreNetworkId + - DirectConnectGatewayArn + - EdgeLocations + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource + x-required-permissions: + create: + - networkmanager:CreateDirectConnectGatewayAttachment + - networkmanager:GetDirectConnectGatewayAttachment + - networkmanager:TagResource + - ec2:DescribeRegions + - iam:CreateServiceLinkedRole + read: + - networkmanager:GetDirectConnectGatewayAttachment + update: + - networkmanager:UpdateDirectConnectGatewayAttachment + - networkmanager:GetDirectConnectGatewayAttachment + - networkmanager:ListTagsForResource + - networkmanager:TagResource + - networkmanager:UntagResource + - ec2:DescribeRegions + delete: + - networkmanager:DeleteAttachment + - networkmanager:GetDirectConnectGatewayAttachment + - networkmanager:UntagResource + - ec2:DescribeRegions + list: + - networkmanager:ListAttachments GlobalNetwork: type: object properties: @@ -576,11 +1225,25 @@ components: description: The state of the global network. type: string x-stackql-resource-name: global_network - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account + x-type-name: AWS::NetworkManager::GlobalNetwork + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Arn x-read-only-properties: - Id - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateGlobalNetwork @@ -656,9 +1319,13 @@ components: - SiteId - Bandwidth x-stackql-resource-name: link - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::Link type describes a link. + x-type-name: AWS::NetworkManager::Link + x-stackql-primary-identifier: - GlobalNetworkId - LinkId + x-stackql-additional-identifiers: + - - LinkArn x-create-only-properties: - GlobalNetworkId - SiteId @@ -667,6 +1334,20 @@ components: - LinkArn - CreatedAt - State + x-required-properties: + - GlobalNetworkId + - SiteId + - Bandwidth + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateLink @@ -702,7 +1383,9 @@ components: - DeviceId - LinkId x-stackql-resource-name: link_association - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site. + x-type-name: AWS::NetworkManager::LinkAssociation + x-stackql-primary-identifier: - GlobalNetworkId - DeviceId - LinkId @@ -710,6 +1393,15 @@ components: - GlobalNetworkId - DeviceId - LinkId + x-required-properties: + - GlobalNetworkId + - DeviceId + - LinkId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - networkmanager:GetLinkAssociations @@ -754,9 +1446,13 @@ components: required: - GlobalNetworkId x-stackql-resource-name: site - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::Site type describes a site. + x-type-name: AWS::NetworkManager::Site + x-stackql-primary-identifier: - GlobalNetworkId - SiteId + x-stackql-additional-identifiers: + - - SiteArn x-create-only-properties: - GlobalNetworkId x-read-only-properties: @@ -764,6 +1460,18 @@ components: - SiteArn - State - CreatedAt + x-required-properties: + - GlobalNetworkId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateSite @@ -818,6 +1526,12 @@ components: ProposedSegmentChange: description: The attachment to move from one segment to another. $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' Tags: description: Tags for the attachment. type: array @@ -838,8 +1552,13 @@ components: - CoreNetworkId - VpnConnectionArn x-stackql-resource-name: site_to_site_vpn_attachment - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition. + x-type-name: AWS::NetworkManager::SiteToSiteVpnAttachment + x-stackql-primary-identifier: - AttachmentId + x-stackql-additional-identifiers: + - - CoreNetworkId + - VpnConnectionArn x-create-only-properties: - CoreNetworkId - VpnConnectionArn @@ -855,6 +1574,19 @@ components: - EdgeLocation - AttachmentPolicyRuleNumber - SegmentName + x-required-properties: + - CoreNetworkId + - VpnConnectionArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:GetSiteToSiteVpnAttachment @@ -922,7 +1654,9 @@ components: - CoreNetworkId - TransitGatewayArn x-stackql-resource-name: transit_gateway_peering - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::TransitGatewayPeering Resoruce Type. + x-type-name: AWS::NetworkManager::TransitGatewayPeering + x-stackql-primary-identifier: - PeeringId x-create-only-properties: - CoreNetworkId @@ -937,6 +1671,19 @@ components: - ResourceArn - CreatedAt - TransitGatewayPeeringAttachmentId + x-required-properties: + - CoreNetworkId + - TransitGatewayArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateTransitGatewayPeering @@ -948,7 +1695,6 @@ components: - ec2:DescribeRegions read: - networkmanager:GetTransitGatewayPeering - - networkmanager:TagResource update: - networkmanager:TagResource - networkmanager:UntagResource @@ -974,12 +1720,22 @@ components: - GlobalNetworkId - TransitGatewayArn x-stackql-resource-name: transit_gateway_registration - x-stackql-primaryIdentifier: + description: The AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network. + x-type-name: AWS::NetworkManager::TransitGatewayRegistration + x-stackql-primary-identifier: - GlobalNetworkId - TransitGatewayArn x-create-only-properties: - GlobalNetworkId - TransitGatewayArn + x-required-properties: + - GlobalNetworkId + - TransitGatewayArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - networkmanager:RegisterTransitGateway @@ -1033,6 +1789,12 @@ components: ProposedSegmentChange: description: The attachment to move from one segment to another. $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' CreatedAt: description: Creation time of the attachment. type: string @@ -1050,7 +1812,9 @@ components: - PeeringId - TransitGatewayRouteTableArn x-stackql-resource-name: transit_gateway_route_table_attachment - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition. + x-type-name: AWS::NetworkManager::TransitGatewayRouteTableAttachment + x-stackql-primary-identifier: - AttachmentId x-create-only-properties: - PeeringId @@ -1068,6 +1832,19 @@ components: - EdgeLocation - AttachmentPolicyRuleNumber - SegmentName + x-required-properties: + - PeeringId + - TransitGatewayRouteTableArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource x-required-permissions: create: - networkmanager:CreateTransitGatewayRouteTableAttachment @@ -1101,6 +1878,14 @@ components: description: 'Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false' type: boolean default: false + DnsSupport: + description: 'Indicates whether to enable private DNS Support for Vpc Attachment. Valid Values: true | false' + type: boolean + default: true + SecurityGroupReferencingSupport: + description: 'Indicates whether to enable Security Group Referencing Support for Vpc Attachment. Valid Values: true | false' + type: boolean + default: true additionalProperties: false VpcAttachment: type: object @@ -1141,6 +1926,12 @@ components: ProposedSegmentChange: description: The attachment to move from one segment to another. $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' Tags: description: Tags for the attachment. type: array @@ -1168,8 +1959,13 @@ components: - VpcArn - SubnetArns x-stackql-resource-name: vpc_attachment - x-stackql-primaryIdentifier: + description: AWS::NetworkManager::VpcAttachment Resoruce Type + x-type-name: AWS::NetworkManager::VpcAttachment + x-stackql-primary-identifier: - AttachmentId + x-stackql-additional-identifiers: + - - CoreNetworkId + - VpcArn x-create-only-properties: - CoreNetworkId - VpcArn @@ -1184,9 +1980,24 @@ components: - EdgeLocation - AttachmentPolicyRuleNumber - SegmentName + - NetworkFunctionGroupName - ResourceArn - x-required-permissions: - create: + x-required-properties: + - CoreNetworkId + - VpcArn + - SubnetArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - networkmanager:TagResource + - networkmanager:UntagResource + - networkmanager:ListTagsForResource + x-required-permissions: + create: - networkmanager:CreateVpcAttachment - networkmanager:GetVpcAttachment - networkmanager:TagResource @@ -1208,43 +2019,916 @@ components: - ec2:DescribeRegions list: - networkmanager:ListAttachments + CreateConnectAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CoreNetworkId: + description: ID of the CoreNetwork that the attachment will be attached to. + type: string + CoreNetworkArn: + description: The ARN of a core network. + type: string + AttachmentId: + description: The ID of the attachment. + type: string + OwnerAccountId: + description: The ID of the attachment account owner. + type: string + AttachmentType: + description: The type of attachment. + type: string + State: + description: State of the attachment. + type: string + EdgeLocation: + description: Edge location of the attachment. + type: string + ResourceArn: + description: The attachment resource ARN. + type: string + AttachmentPolicyRuleNumber: + description: The policy rule number associated with the attachment. + type: integer + SegmentName: + description: The name of the segment attachment. + type: string + ProposedSegmentChange: + description: The attachment to move from one segment to another. + $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' + Tags: + description: Tags for the attachment. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + description: Creation time of the attachment. + type: string + UpdatedAt: + description: Last update time of the attachment. + type: string + TransportAttachmentId: + description: Id of transport attachment + type: string + Options: + description: Protocol options for connect attachment + $ref: '#/components/schemas/ConnectAttachmentOptions' + x-stackQL-stringOnly: true + x-title: CreateConnectAttachmentRequest + type: object + required: [] + CreateConnectPeerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PeerAddress: + description: The IP address of the Connect peer. + type: string + CoreNetworkAddress: + description: The IP address of a core network. + type: string + BgpOptions: + description: Bgp options for connect peer. + $ref: '#/components/schemas/BgpOptions' + InsideCidrBlocks: + description: The inside IP addresses used for a Connect peer configuration. + type: array + x-insertionOrder: false + items: + type: string + CoreNetworkId: + description: The ID of the core network. + type: string + ConnectAttachmentId: + description: The ID of the attachment to connect. + type: string + ConnectPeerId: + description: The ID of the Connect peer. + type: string + EdgeLocation: + description: The Connect peer Regions where edges are located. + type: string + State: + description: State of the connect peer. + type: string + CreatedAt: + description: Connect peer creation time. + type: string + Configuration: + description: Configuration of the connect peer. + $ref: '#/components/schemas/ConnectPeerConfiguration' + SubnetArn: + description: The subnet ARN for the connect peer. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateConnectPeerRequest + type: object + required: [] + CreateCoreNetworkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GlobalNetworkId: + description: The ID of the global network that your core network is a part of. + type: string + CoreNetworkId: + description: The Id of core network + type: string + CoreNetworkArn: + description: The ARN (Amazon resource name) of core network + type: string + PolicyDocument: + description: Live policy document for the core network, you must provide PolicyDocument in Json Format + type: object + Description: + description: The description of core network + type: string + CreatedAt: + description: The creation time of core network + type: string + State: + description: The state of core network + type: string + Segments: + description: The segments within a core network. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CoreNetworkSegment' + NetworkFunctionGroups: + description: The network function groups within a core network. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CoreNetworkNetworkFunctionGroup' + Edges: + description: The edges within a core network. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CoreNetworkEdge' + OwnerAccount: + description: Owner of the core network + type: string + Tags: + description: The tags for the global network. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCoreNetworkRequest + type: object + required: [] + CreateCustomerGatewayAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GlobalNetworkId: + description: The ID of the global network. + type: string + CustomerGatewayArn: + description: The Amazon Resource Name (ARN) of the customer gateway. + type: string + DeviceId: + description: The ID of the device + type: string + LinkId: + description: The ID of the link + type: string + x-stackQL-stringOnly: true + x-title: CreateCustomerGatewayAssociationRequest + type: object + required: [] + CreateDeviceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeviceArn: + description: The Amazon Resource Name (ARN) of the device. + type: string + DeviceId: + description: The ID of the device. + type: string + Description: + description: The description of the device. + type: string + Tags: + description: The tags for the device. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + GlobalNetworkId: + description: The ID of the global network. + type: string + AWSLocation: + description: The Amazon Web Services location of the device, if applicable. + $ref: '#/components/schemas/AWSLocation' + Location: + description: The site location. + $ref: '#/components/schemas/Location' + Model: + description: The device model + type: string + SerialNumber: + description: The device serial number. + type: string + SiteId: + description: The site ID. + type: string + Type: + description: The device type. + type: string + Vendor: + description: The device vendor. + type: string + CreatedAt: + description: The date and time that the device was created. + type: string + State: + description: The state of the device. + type: string + x-stackQL-stringOnly: true + x-title: CreateDeviceRequest + type: object + required: [] + CreateDirectConnectGatewayAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CoreNetworkId: + description: The ID of a core network for the Direct Connect Gateway attachment. + type: string + CoreNetworkArn: + description: The ARN of a core network for the Direct Connect Gateway attachment. + type: string + AttachmentId: + description: Id of the attachment. + type: string + OwnerAccountId: + description: Owner account of the attachment. + type: string + AttachmentType: + description: Attachment type. + type: string + State: + description: State of the attachment. + type: string + EdgeLocations: + description: The Regions where the edges are located. + type: array + x-insertionOrder: false + items: + type: string + DirectConnectGatewayArn: + description: The ARN of the Direct Connect Gateway. + type: string + ResourceArn: + description: The ARN of the Resource. + type: string + AttachmentPolicyRuleNumber: + description: The policy rule number associated with the attachment. + type: integer + SegmentName: + description: The name of the segment attachment.. + type: string + ProposedSegmentChange: + description: The attachment to move from one segment to another. + $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' + Tags: + description: Tags for the attachment. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + description: Creation time of the attachment. + type: string + UpdatedAt: + description: Last update time of the attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateDirectConnectGatewayAttachmentRequest + type: object + required: [] + CreateGlobalNetworkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the global network. + type: string + Id: + description: The ID of the global network. + type: string + Description: + description: The description of the global network. + type: string + Tags: + description: The tags for the global network. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + description: The date and time that the global network was created. + type: string + State: + description: The state of the global network. + type: string + x-stackQL-stringOnly: true + x-title: CreateGlobalNetworkRequest + type: object + required: [] + CreateLinkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LinkArn: + description: The Amazon Resource Name (ARN) of the link. + type: string + LinkId: + description: The ID of the link. + type: string + GlobalNetworkId: + description: The ID of the global network. + type: string + SiteId: + description: The ID of the site + type: string + Bandwidth: + description: The Bandwidth for the link. + $ref: '#/components/schemas/Bandwidth' + Provider: + description: The provider of the link. + type: string + Description: + description: The description of the link. + type: string + Tags: + description: The tags for the link. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Type: + description: The type of the link. + type: string + CreatedAt: + description: The date and time that the device was created. + type: string + State: + description: The state of the link. + type: string + x-stackQL-stringOnly: true + x-title: CreateLinkRequest + type: object + required: [] + CreateLinkAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GlobalNetworkId: + description: The ID of the global network. + type: string + DeviceId: + description: The ID of the device + type: string + LinkId: + description: The ID of the link + type: string + x-stackQL-stringOnly: true + x-title: CreateLinkAssociationRequest + type: object + required: [] + CreateSiteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SiteArn: + description: The Amazon Resource Name (ARN) of the site. + type: string + SiteId: + description: The ID of the site. + type: string + Description: + description: The description of the site. + type: string + Tags: + description: The tags for the site. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + GlobalNetworkId: + description: The ID of the global network. + type: string + Location: + description: The location of the site. + $ref: '#/components/schemas/Location' + CreatedAt: + description: The date and time that the device was created. + type: string + State: + description: The state of the site. + type: string + x-stackQL-stringOnly: true + x-title: CreateSiteRequest + type: object + required: [] + CreateSiteToSiteVpnAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CoreNetworkId: + description: The ID of a core network where you're creating a site-to-site VPN attachment. + type: string + CoreNetworkArn: + description: The ARN of a core network for the VPC attachment. + type: string + AttachmentId: + description: The ID of the attachment. + type: string + OwnerAccountId: + description: Owner account of the attachment. + type: string + AttachmentType: + description: The type of attachment. + type: string + State: + description: The state of the attachment. + type: string + EdgeLocation: + description: The Region where the edge is located. + type: string + ResourceArn: + description: The ARN of the Resource. + type: string + AttachmentPolicyRuleNumber: + description: The policy rule number associated with the attachment. + type: integer + SegmentName: + description: The name of the segment that attachment is in. + type: string + ProposedSegmentChange: + description: The attachment to move from one segment to another. + $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' + Tags: + description: Tags for the attachment. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + description: Creation time of the attachment. + type: string + UpdatedAt: + description: Last update time of the attachment. + type: string + VpnConnectionArn: + description: The ARN of the site-to-site VPN attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateSiteToSiteVpnAttachmentRequest + type: object + required: [] + CreateTransitGatewayPeeringRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CoreNetworkId: + description: The Id of the core network that you want to peer a transit gateway to. + type: string + CoreNetworkArn: + description: The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to. + type: string + TransitGatewayArn: + description: The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network + type: string + TransitGatewayPeeringAttachmentId: + description: The ID of the TransitGatewayPeeringAttachment + type: string + PeeringId: + description: The Id of the transit gateway peering + type: string + State: + description: The state of the transit gateway peering + type: string + EdgeLocation: + description: The location of the transit gateway peering + type: string + ResourceArn: + description: The ARN (Amazon Resource Name) of the resource that you will peer to a core network + type: string + OwnerAccountId: + description: Peering owner account Id + type: string + PeeringType: + description: Peering type (TransitGatewayPeering) + type: string + CreatedAt: + description: The creation time of the transit gateway peering + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayPeeringRequest + type: object + required: [] + CreateTransitGatewayRegistrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + GlobalNetworkId: + description: The ID of the global network. + type: string + TransitGatewayArn: + description: The Amazon Resource Name (ARN) of the transit gateway. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRegistrationRequest + type: object + required: [] + CreateTransitGatewayRouteTableAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PeeringId: + description: The Id of peering between transit gateway and core network. + type: string + TransitGatewayRouteTableArn: + description: The Arn of transit gateway route table. + type: string + CoreNetworkId: + description: The ID of a core network where you're creating a site-to-site VPN attachment. + type: string + CoreNetworkArn: + description: The ARN of a core network for the VPC attachment. + type: string + AttachmentId: + description: The ID of the attachment. + type: string + OwnerAccountId: + description: Owner account of the attachment. + type: string + AttachmentType: + description: The type of attachment. + type: string + State: + description: The state of the attachment. + type: string + EdgeLocation: + description: The Region where the edge is located. + type: string + ResourceArn: + description: The ARN of the Resource. + type: string + AttachmentPolicyRuleNumber: + description: The policy rule number associated with the attachment. + type: integer + SegmentName: + description: The name of the segment that attachment is in. + type: string + ProposedSegmentChange: + description: The attachment to move from one segment to another. + $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' + CreatedAt: + description: Creation time of the attachment. + type: string + UpdatedAt: + description: Last update time of the attachment. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteTableAttachmentRequest + type: object + required: [] + CreateVpcAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CoreNetworkId: + description: The ID of a core network for the VPC attachment. + type: string + CoreNetworkArn: + description: The ARN of a core network for the VPC attachment. + type: string + AttachmentId: + description: Id of the attachment. + type: string + OwnerAccountId: + description: Owner account of the attachment. + type: string + AttachmentType: + description: Attachment type. + type: string + State: + description: State of the attachment. + type: string + EdgeLocation: + description: The Region where the edge is located. + type: string + VpcArn: + description: The ARN of the VPC. + type: string + ResourceArn: + description: The ARN of the Resource. + type: string + AttachmentPolicyRuleNumber: + description: The policy rule number associated with the attachment. + type: integer + SegmentName: + description: The name of the segment attachment.. + type: string + ProposedSegmentChange: + description: The attachment to move from one segment to another. + $ref: '#/components/schemas/ProposedSegmentChange' + NetworkFunctionGroupName: + description: The name of the network function group attachment. + type: string + ProposedNetworkFunctionGroupChange: + description: The attachment to move from one network function group to another. + $ref: '#/components/schemas/ProposedNetworkFunctionGroupChange' + Tags: + description: Tags for the attachment. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CreatedAt: + description: Creation time of the attachment. + type: string + UpdatedAt: + description: Last update time of the attachment. + type: string + SubnetArns: + description: Subnet Arn list + type: array + x-insertionOrder: false + items: + type: string + Options: + description: Vpc options of the attachment. + $ref: '#/components/schemas/VpcOptions' + x-stackQL-stringOnly: true + x-title: CreateVpcAttachmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: connect_attachments: name: connect_attachments id: awscc.networkmanager.connect_attachments x-cfn-schema-name: ConnectAttachment - x-type: list - x-identifiers: - - AttachmentId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' - AND region = 'us-east-1' - connect_attachment: - name: connect_attachment - id: awscc.networkmanager.connect_attachment - x-cfn-schema-name: ConnectAttachment - x-type: get + x-cfn-type-name: AWS::NetworkManager::ConnectAttachment x-identifiers: - AttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConnectAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::ConnectAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::ConnectAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::ConnectAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1260,6 +2944,8 @@ components: JSON_EXTRACT(Properties, '$.AttachmentPolicyRuleNumber') as attachment_policy_rule_number, JSON_EXTRACT(Properties, '$.SegmentName') as segment_name, JSON_EXTRACT(Properties, '$.ProposedSegmentChange') as proposed_segment_change, + JSON_EXTRACT(Properties, '$.NetworkFunctionGroupName') as network_function_group_name, + JSON_EXTRACT(Properties, '$.ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, @@ -1269,7 +2955,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1285,6 +2971,8 @@ components: json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, json_extract_path_text(Properties, 'SegmentName') as segment_name, json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'NetworkFunctionGroupName') as network_function_group_name, + json_extract_path_text(Properties, 'ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'UpdatedAt') as updated_at, @@ -1293,13 +2981,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' AND data__Identifier = '' AND region = 'us-east-1' - connect_peers: - name: connect_peers - id: awscc.networkmanager.connect_peers - x-cfn-schema-name: ConnectPeer - x-type: list + connect_attachments_list_only: + name: connect_attachments_list_only + id: awscc.networkmanager.connect_attachments_list_only + x-cfn-schema-name: ConnectAttachment + x-cfn-type-name: AWS::NetworkManager::ConnectAttachment x-identifiers: - - ConnectPeerId + - AttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1307,28 +3001,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConnectPeerId') as connect_peer_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConnectPeerId') as connect_peer_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' AND region = 'us-east-1' - connect_peer: - name: connect_peer - id: awscc.networkmanager.connect_peer + connect_peers: + name: connect_peers + id: awscc.networkmanager.connect_peers x-cfn-schema-name: ConnectPeer - x-type: get + x-cfn-type-name: AWS::NetworkManager::ConnectPeer x-identifiers: - ConnectPeerId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConnectPeer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::ConnectPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::ConnectPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::ConnectPeer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connect_peers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connect_peers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connect_peers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1350,7 +3092,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1371,13 +3113,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' AND data__Identifier = '' AND region = 'us-east-1' - core_networks: - name: core_networks - id: awscc.networkmanager.core_networks - x-cfn-schema-name: CoreNetwork - x-type: list + connect_peers_list_only: + name: connect_peers_list_only + id: awscc.networkmanager.connect_peers_list_only + x-cfn-schema-name: ConnectPeer + x-cfn-type-name: AWS::NetworkManager::ConnectPeer x-identifiers: - - CoreNetworkId + - ConnectPeerId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1385,28 +3133,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CoreNetworkId') as core_network_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' + JSON_EXTRACT(Properties, '$.ConnectPeerId') as connect_peer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' + json_extract_path_text(Properties, 'ConnectPeerId') as connect_peer_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' AND region = 'us-east-1' - core_network: - name: core_network - id: awscc.networkmanager.core_network + core_networks: + name: core_networks + id: awscc.networkmanager.core_networks x-cfn-schema-name: CoreNetwork - x-type: get + x-cfn-type-name: AWS::NetworkManager::CoreNetwork x-identifiers: - CoreNetworkId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CoreNetwork&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::CoreNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::CoreNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::CoreNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/core_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/core_networks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/core_networks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1419,6 +3215,7 @@ components: JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.State') as state, JSON_EXTRACT(Properties, '$.Segments') as segments, + JSON_EXTRACT(Properties, '$.NetworkFunctionGroups') as network_function_groups, JSON_EXTRACT(Properties, '$.Edges') as edges, JSON_EXTRACT(Properties, '$.OwnerAccount') as owner_account, JSON_EXTRACT(Properties, '$.Tags') as tags @@ -1426,7 +3223,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1439,20 +3236,26 @@ components: json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'State') as state, json_extract_path_text(Properties, 'Segments') as segments, + json_extract_path_text(Properties, 'NetworkFunctionGroups') as network_function_groups, json_extract_path_text(Properties, 'Edges') as edges, json_extract_path_text(Properties, 'OwnerAccount') as owner_account, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' AND data__Identifier = '' AND region = 'us-east-1' - customer_gateway_associations: - name: customer_gateway_associations - id: awscc.networkmanager.customer_gateway_associations - x-cfn-schema-name: CustomerGatewayAssociation - x-type: list + core_networks_list_only: + name: core_networks_list_only + id: awscc.networkmanager.core_networks_list_only + x-cfn-schema-name: CoreNetwork + x-cfn-type-name: AWS::NetworkManager::CoreNetwork x-identifiers: - - GlobalNetworkId - - CustomerGatewayArn + - CoreNetworkId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1460,31 +3263,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.CustomerGatewayArn') as customer_gateway_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' + JSON_EXTRACT(Properties, '$.CoreNetworkId') as core_network_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'CustomerGatewayArn') as customer_gateway_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' AND region = 'us-east-1' - customer_gateway_association: - name: customer_gateway_association - id: awscc.networkmanager.customer_gateway_association + customer_gateway_associations: + name: customer_gateway_associations + id: awscc.networkmanager.customer_gateway_associations x-cfn-schema-name: CustomerGatewayAssociation - x-type: get + x-cfn-type-name: AWS::NetworkManager::CustomerGatewayAssociation x-identifiers: - GlobalNetworkId - CustomerGatewayArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomerGatewayAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::CustomerGatewayAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::CustomerGatewayAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/customer_gateway_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/customer_gateway_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1497,7 +3333,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1509,14 +3345,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' AND data__Identifier = '|' AND region = 'us-east-1' - devices: - name: devices - id: awscc.networkmanager.devices - x-cfn-schema-name: Device - x-type: list + customer_gateway_associations_list_only: + name: customer_gateway_associations_list_only + id: awscc.networkmanager.customer_gateway_associations_list_only + x-cfn-schema-name: CustomerGatewayAssociation + x-cfn-type-name: AWS::NetworkManager::CustomerGatewayAssociation x-identifiers: - GlobalNetworkId - - DeviceId + - CustomerGatewayArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1525,8 +3367,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.DeviceId') as device_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' + JSON_EXTRACT(Properties, '$.CustomerGatewayArn') as customer_gateway_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1534,21 +3376,69 @@ components: SELECT region, json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'DeviceId') as device_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' + json_extract_path_text(Properties, 'CustomerGatewayArn') as customer_gateway_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' AND region = 'us-east-1' - device: - name: device - id: awscc.networkmanager.device + devices: + name: devices + id: awscc.networkmanager.devices x-cfn-schema-name: Device - x-type: get + x-cfn-type-name: AWS::NetworkManager::Device x-identifiers: - GlobalNetworkId - DeviceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Device&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Device" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Device" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Device" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/devices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1571,7 +3461,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1593,13 +3483,162 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Device' AND data__Identifier = '|' AND region = 'us-east-1' - global_networks: - name: global_networks - id: awscc.networkmanager.global_networks - x-cfn-schema-name: GlobalNetwork - x-type: list + devices_list_only: + name: devices_list_only + id: awscc.networkmanager.devices_list_only + x-cfn-schema-name: Device + x-cfn-type-name: AWS::NetworkManager::Device + x-identifiers: + - GlobalNetworkId + - DeviceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.DeviceId') as device_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'DeviceId') as device_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' + AND region = 'us-east-1' + direct_connect_gateway_attachments: + name: direct_connect_gateway_attachments + id: awscc.networkmanager.direct_connect_gateway_attachments + x-cfn-schema-name: DirectConnectGatewayAttachment + x-cfn-type-name: AWS::NetworkManager::DirectConnectGatewayAttachment + x-identifiers: + - AttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DirectConnectGatewayAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::DirectConnectGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::DirectConnectGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::DirectConnectGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/direct_connect_gateway_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/direct_connect_gateway_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/direct_connect_gateway_attachments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CoreNetworkId') as core_network_id, + JSON_EXTRACT(Properties, '$.CoreNetworkArn') as core_network_arn, + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id, + JSON_EXTRACT(Properties, '$.OwnerAccountId') as owner_account_id, + JSON_EXTRACT(Properties, '$.AttachmentType') as attachment_type, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.EdgeLocations') as edge_locations, + JSON_EXTRACT(Properties, '$.DirectConnectGatewayArn') as direct_connect_gateway_arn, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.AttachmentPolicyRuleNumber') as attachment_policy_rule_number, + JSON_EXTRACT(Properties, '$.SegmentName') as segment_name, + JSON_EXTRACT(Properties, '$.ProposedSegmentChange') as proposed_segment_change, + JSON_EXTRACT(Properties, '$.NetworkFunctionGroupName') as network_function_group_name, + JSON_EXTRACT(Properties, '$.ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::DirectConnectGatewayAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'EdgeLocations') as edge_locations, + json_extract_path_text(Properties, 'DirectConnectGatewayArn') as direct_connect_gateway_arn, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, + json_extract_path_text(Properties, 'SegmentName') as segment_name, + json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'NetworkFunctionGroupName') as network_function_group_name, + json_extract_path_text(Properties, 'ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::DirectConnectGatewayAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + direct_connect_gateway_attachments_list_only: + name: direct_connect_gateway_attachments_list_only + id: awscc.networkmanager.direct_connect_gateway_attachments_list_only + x-cfn-schema-name: DirectConnectGatewayAttachment + x-cfn-type-name: AWS::NetworkManager::DirectConnectGatewayAttachment x-identifiers: - - Id + - AttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1607,28 +3646,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::DirectConnectGatewayAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::DirectConnectGatewayAttachment' AND region = 'us-east-1' - global_network: - name: global_network - id: awscc.networkmanager.global_network + global_networks: + name: global_networks + id: awscc.networkmanager.global_networks x-cfn-schema-name: GlobalNetwork - x-type: get + x-cfn-type-name: AWS::NetworkManager::GlobalNetwork x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GlobalNetwork&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::GlobalNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::GlobalNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::GlobalNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_networks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/global_networks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1643,7 +3730,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1657,14 +3744,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' AND data__Identifier = '' AND region = 'us-east-1' - links: - name: links - id: awscc.networkmanager.links - x-cfn-schema-name: Link - x-type: list + global_networks_list_only: + name: global_networks_list_only + id: awscc.networkmanager.global_networks_list_only + x-cfn-schema-name: GlobalNetwork + x-cfn-type-name: AWS::NetworkManager::GlobalNetwork x-identifiers: - - GlobalNetworkId - - LinkId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1672,31 +3764,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.LinkId') as link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'LinkId') as link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' AND region = 'us-east-1' - link: - name: link - id: awscc.networkmanager.link + links: + name: links + id: awscc.networkmanager.links x-cfn-schema-name: Link - x-type: get + x-cfn-type-name: AWS::NetworkManager::Link x-identifiers: - GlobalNetworkId - LinkId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Link&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Link" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Link" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Link" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/links/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1716,7 +3854,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1735,15 +3873,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Link' AND data__Identifier = '|' AND region = 'us-east-1' - link_associations: - name: link_associations - id: awscc.networkmanager.link_associations - x-cfn-schema-name: LinkAssociation - x-type: list + links_list_only: + name: links_list_only + id: awscc.networkmanager.links_list_only + x-cfn-schema-name: Link + x-cfn-type-name: AWS::NetworkManager::Link x-identifiers: - GlobalNetworkId - - DeviceId - LinkId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1752,9 +3895,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.DeviceId') as device_id, JSON_EXTRACT(Properties, '$.LinkId') as link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1762,23 +3904,57 @@ components: SELECT region, json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'DeviceId') as device_id, json_extract_path_text(Properties, 'LinkId') as link_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' AND region = 'us-east-1' - link_association: - name: link_association - id: awscc.networkmanager.link_association + link_associations: + name: link_associations + id: awscc.networkmanager.link_associations x-cfn-schema-name: LinkAssociation - x-type: get + x-cfn-type-name: AWS::NetworkManager::LinkAssociation x-identifiers: - GlobalNetworkId - DeviceId - LinkId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LinkAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::LinkAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::LinkAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/link_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/link_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1790,7 +3966,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1801,14 +3977,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' AND data__Identifier = '||' AND region = 'us-east-1' - sites: - name: sites - id: awscc.networkmanager.sites - x-cfn-schema-name: Site - x-type: list + link_associations_list_only: + name: link_associations_list_only + id: awscc.networkmanager.link_associations_list_only + x-cfn-schema-name: LinkAssociation + x-cfn-type-name: AWS::NetworkManager::LinkAssociation x-identifiers: - GlobalNetworkId - - SiteId + - DeviceId + - LinkId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1817,8 +4000,9 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.SiteId') as site_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' + JSON_EXTRACT(Properties, '$.DeviceId') as device_id, + JSON_EXTRACT(Properties, '$.LinkId') as link_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1826,21 +4010,70 @@ components: SELECT region, json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'SiteId') as site_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' + json_extract_path_text(Properties, 'DeviceId') as device_id, + json_extract_path_text(Properties, 'LinkId') as link_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' AND region = 'us-east-1' - site: - name: site - id: awscc.networkmanager.site + sites: + name: sites + id: awscc.networkmanager.sites x-cfn-schema-name: Site - x-type: get + x-cfn-type-name: AWS::NetworkManager::Site x-identifiers: - GlobalNetworkId - SiteId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Site&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Site" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Site" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::Site" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sites/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sites/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sites/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1857,7 +4090,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1873,13 +4106,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Site' AND data__Identifier = '|' AND region = 'us-east-1' - site_to_site_vpn_attachments: - name: site_to_site_vpn_attachments - id: awscc.networkmanager.site_to_site_vpn_attachments - x-cfn-schema-name: SiteToSiteVpnAttachment - x-type: list + sites_list_only: + name: sites_list_only + id: awscc.networkmanager.sites_list_only + x-cfn-schema-name: Site + x-cfn-type-name: AWS::NetworkManager::Site x-identifiers: - - AttachmentId + - GlobalNetworkId + - SiteId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1887,28 +4127,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.SiteId') as site_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'SiteId') as site_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' AND region = 'us-east-1' - site_to_site_vpn_attachment: - name: site_to_site_vpn_attachment - id: awscc.networkmanager.site_to_site_vpn_attachment + site_to_site_vpn_attachments: + name: site_to_site_vpn_attachments + id: awscc.networkmanager.site_to_site_vpn_attachments x-cfn-schema-name: SiteToSiteVpnAttachment - x-type: get + x-cfn-type-name: AWS::NetworkManager::SiteToSiteVpnAttachment x-identifiers: - AttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SiteToSiteVpnAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::SiteToSiteVpnAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::SiteToSiteVpnAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::SiteToSiteVpnAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1924,6 +4214,8 @@ components: JSON_EXTRACT(Properties, '$.AttachmentPolicyRuleNumber') as attachment_policy_rule_number, JSON_EXTRACT(Properties, '$.SegmentName') as segment_name, JSON_EXTRACT(Properties, '$.ProposedSegmentChange') as proposed_segment_change, + JSON_EXTRACT(Properties, '$.NetworkFunctionGroupName') as network_function_group_name, + JSON_EXTRACT(Properties, '$.ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, @@ -1932,7 +4224,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1948,6 +4240,8 @@ components: json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, json_extract_path_text(Properties, 'SegmentName') as segment_name, json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'NetworkFunctionGroupName') as network_function_group_name, + json_extract_path_text(Properties, 'ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'UpdatedAt') as updated_at, @@ -1955,13 +4249,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_peerings: - name: transit_gateway_peerings - id: awscc.networkmanager.transit_gateway_peerings - x-cfn-schema-name: TransitGatewayPeering - x-type: list + site_to_site_vpn_attachments_list_only: + name: site_to_site_vpn_attachments_list_only + id: awscc.networkmanager.site_to_site_vpn_attachments_list_only + x-cfn-schema-name: SiteToSiteVpnAttachment + x-cfn-type-name: AWS::NetworkManager::SiteToSiteVpnAttachment x-identifiers: - - PeeringId + - AttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1969,28 +4269,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PeeringId') as peering_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PeeringId') as peering_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' AND region = 'us-east-1' - transit_gateway_peering: - name: transit_gateway_peering - id: awscc.networkmanager.transit_gateway_peering + transit_gateway_peerings: + name: transit_gateway_peerings + id: awscc.networkmanager.transit_gateway_peerings x-cfn-schema-name: TransitGatewayPeering - x-type: get + x-cfn-type-name: AWS::NetworkManager::TransitGatewayPeering x-identifiers: - PeeringId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayPeering&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayPeering" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayPeering" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayPeering" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2011,7 +4359,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2031,14 +4379,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' AND data__Identifier = '' AND region = 'us-east-1' - transit_gateway_registrations: - name: transit_gateway_registrations - id: awscc.networkmanager.transit_gateway_registrations - x-cfn-schema-name: TransitGatewayRegistration - x-type: list + transit_gateway_peerings_list_only: + name: transit_gateway_peerings_list_only + id: awscc.networkmanager.transit_gateway_peerings_list_only + x-cfn-schema-name: TransitGatewayPeering + x-cfn-type-name: AWS::NetworkManager::TransitGatewayPeering x-identifiers: - - GlobalNetworkId - - TransitGatewayArn + - PeeringId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2046,31 +4399,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.TransitGatewayArn') as transit_gateway_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' + JSON_EXTRACT(Properties, '$.PeeringId') as peering_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' + json_extract_path_text(Properties, 'PeeringId') as peering_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' AND region = 'us-east-1' - transit_gateway_registration: - name: transit_gateway_registration - id: awscc.networkmanager.transit_gateway_registration + transit_gateway_registrations: + name: transit_gateway_registrations + id: awscc.networkmanager.transit_gateway_registrations x-cfn-schema-name: TransitGatewayRegistration - x-type: get + x-cfn-type-name: AWS::NetworkManager::TransitGatewayRegistration x-identifiers: - GlobalNetworkId - TransitGatewayArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRegistration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayRegistration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayRegistration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_registrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_registrations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2081,7 +4467,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2091,13 +4477,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' AND data__Identifier = '|' AND region = 'us-east-1' - transit_gateway_route_table_attachments: - name: transit_gateway_route_table_attachments - id: awscc.networkmanager.transit_gateway_route_table_attachments - x-cfn-schema-name: TransitGatewayRouteTableAttachment - x-type: list + transit_gateway_registrations_list_only: + name: transit_gateway_registrations_list_only + id: awscc.networkmanager.transit_gateway_registrations_list_only + x-cfn-schema-name: TransitGatewayRegistration + x-cfn-type-name: AWS::NetworkManager::TransitGatewayRegistration x-identifiers: - - AttachmentId + - GlobalNetworkId + - TransitGatewayArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2105,28 +4498,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.TransitGatewayArn') as transit_gateway_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' AND region = 'us-east-1' - transit_gateway_route_table_attachment: - name: transit_gateway_route_table_attachment - id: awscc.networkmanager.transit_gateway_route_table_attachment + transit_gateway_route_table_attachments: + name: transit_gateway_route_table_attachments + id: awscc.networkmanager.transit_gateway_route_table_attachments x-cfn-schema-name: TransitGatewayRouteTableAttachment - x-type: get + x-cfn-type-name: AWS::NetworkManager::TransitGatewayRouteTableAttachment x-identifiers: - AttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTableAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayRouteTableAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayRouteTableAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::TransitGatewayRouteTableAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2144,6 +4587,8 @@ components: JSON_EXTRACT(Properties, '$.AttachmentPolicyRuleNumber') as attachment_policy_rule_number, JSON_EXTRACT(Properties, '$.SegmentName') as segment_name, JSON_EXTRACT(Properties, '$.ProposedSegmentChange') as proposed_segment_change, + JSON_EXTRACT(Properties, '$.NetworkFunctionGroupName') as network_function_group_name, + JSON_EXTRACT(Properties, '$.ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, JSON_EXTRACT(Properties, '$.Tags') as tags @@ -2151,7 +4596,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2169,19 +4614,27 @@ components: json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, json_extract_path_text(Properties, 'SegmentName') as segment_name, json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'NetworkFunctionGroupName') as network_function_group_name, + json_extract_path_text(Properties, 'ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'UpdatedAt') as updated_at, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' AND data__Identifier = '' AND region = 'us-east-1' - vpc_attachments: - name: vpc_attachments - id: awscc.networkmanager.vpc_attachments - x-cfn-schema-name: VpcAttachment - x-type: list + transit_gateway_route_table_attachments_list_only: + name: transit_gateway_route_table_attachments_list_only + id: awscc.networkmanager.transit_gateway_route_table_attachments_list_only + x-cfn-schema-name: TransitGatewayRouteTableAttachment + x-cfn-type-name: AWS::NetworkManager::TransitGatewayRouteTableAttachment x-identifiers: - AttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2190,7 +4643,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2198,19 +4651,67 @@ components: SELECT region, json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' AND region = 'us-east-1' - vpc_attachment: - name: vpc_attachment - id: awscc.networkmanager.vpc_attachment + vpc_attachments: + name: vpc_attachments + id: awscc.networkmanager.vpc_attachments x-cfn-schema-name: VpcAttachment - x-type: get + x-cfn-type-name: AWS::NetworkManager::VpcAttachment x-identifiers: - AttachmentId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::VpcAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::VpcAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NetworkManager::VpcAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2227,6 +4728,8 @@ components: JSON_EXTRACT(Properties, '$.AttachmentPolicyRuleNumber') as attachment_policy_rule_number, JSON_EXTRACT(Properties, '$.SegmentName') as segment_name, JSON_EXTRACT(Properties, '$.ProposedSegmentChange') as proposed_segment_change, + JSON_EXTRACT(Properties, '$.NetworkFunctionGroupName') as network_function_group_name, + JSON_EXTRACT(Properties, '$.ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, @@ -2236,7 +4739,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2253,6 +4756,8 @@ components: json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, json_extract_path_text(Properties, 'SegmentName') as segment_name, json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'NetworkFunctionGroupName') as network_function_group_name, + json_extract_path_text(Properties, 'ProposedNetworkFunctionGroupChange') as proposed_network_function_group_change, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'CreatedAt') as created_at, json_extract_path_text(Properties, 'UpdatedAt') as updated_at, @@ -2261,3 +4766,817 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' AND data__Identifier = '' AND region = 'us-east-1' + vpc_attachments_list_only: + name: vpc_attachments_list_only + id: awscc.networkmanager.vpc_attachments_list_only + x-cfn-schema-name: VpcAttachment + x-cfn-type-name: AWS::NetworkManager::VpcAttachment + x-identifiers: + - AttachmentId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConnectAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnectAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConnectPeer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnectPeer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectPeerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CoreNetwork&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCoreNetwork + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCoreNetworkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomerGatewayAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomerGatewayAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomerGatewayAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Device&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDevice + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeviceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DirectConnectGatewayAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDirectConnectGatewayAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDirectConnectGatewayAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GlobalNetwork&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGlobalNetwork + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGlobalNetworkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Link&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLink + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LinkAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLinkAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLinkAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Site&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSite + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSiteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SiteToSiteVpnAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSiteToSiteVpnAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSiteToSiteVpnAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayPeering&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayPeering + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayPeeringRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRegistration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRegistration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRegistrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTableAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRouteTableAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteTableAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/nimblestudio.yaml b/providers/src/awscc/v00.00.00000/services/nimblestudio.yaml deleted file mode 100644 index 1799e913..00000000 --- a/providers/src/awscc/v00.00.00000/services/nimblestudio.yaml +++ /dev/null @@ -1,1129 +0,0 @@ -openapi: 3.0.0 -info: - title: NimbleStudio - version: 1.0.0 -paths: {} -components: - schemas: - AutomaticTerminationMode: - type: string - enum: - - DEACTIVATED - - ACTIVATED - SessionBackupMode: - type: string - enum: - - AUTOMATIC - - DEACTIVATED - SessionPersistenceMode: - type: string - enum: - - DEACTIVATED - - ACTIVATED - StreamConfiguration: - type: object - description:

A configuration for a streaming session.

- properties: - ClipboardMode: - $ref: '#/components/schemas/StreamingClipboardMode' - Ec2InstanceTypes: - type: array - items: - $ref: '#/components/schemas/StreamingInstanceType' - maxItems: 30 - minItems: 1 - description: |- -

The EC2 instance types that users can select from when launching a streaming session - with this launch profile.

- MaxSessionLengthInMinutes: - type: number - default: 690 - maximum: 43200 - minimum: 1 - description: |- -

The length of time, in minutes, that a streaming session can be active before it is - stopped or terminated. After this point, Nimble Studio automatically terminates or - stops the session. The default length of time is 690 minutes, and the maximum length of - time is 30 days.

- StreamingImageIds: - type: array - items: - type: string - maxLength: 22 - minLength: 0 - pattern: ^[a-zA-Z0-9-_]*$ - maxItems: 20 - minItems: 1 - description: |- -

The streaming images that users can select from when launching a streaming session - with this launch profile.

- MaxStoppedSessionLengthInMinutes: - type: number - default: 0 - maximum: 5760 - minimum: 0 - description: |- -

Integer that determines if you can start and stop your sessions and how long a session - can stay in the STOPPED state. The default value is 0. The maximum value is - 5760.

-

This field is allowed only when sessionPersistenceMode is - ACTIVATED and automaticTerminationMode is - ACTIVATED.

-

If the value is set to 0, your sessions can’t be STOPPED. If you then - call StopStreamingSession, the session fails. If the time that a session - stays in the READY state exceeds the maxSessionLengthInMinutes - value, the session will automatically be terminated (instead of - STOPPED).

-

If the value is set to a positive number, the session can be stopped. You can call - StopStreamingSession to stop sessions in the READY state. - If the time that a session stays in the READY state exceeds the - maxSessionLengthInMinutes value, the session will automatically be - stopped (instead of terminated).

- SessionStorage: - $ref: '#/components/schemas/StreamConfigurationSessionStorage' - SessionBackup: - $ref: '#/components/schemas/StreamConfigurationSessionBackup' - SessionPersistenceMode: - $ref: '#/components/schemas/SessionPersistenceMode' - VolumeConfiguration: - $ref: '#/components/schemas/VolumeConfiguration' - AutomaticTerminationMode: - $ref: '#/components/schemas/AutomaticTerminationMode' - required: - - ClipboardMode - - Ec2InstanceTypes - - StreamingImageIds - additionalProperties: false - StreamConfigurationSessionBackup: - type: object - description: |- -

Configures how streaming sessions are backed up when launched from this launch - profile.

- properties: - Mode: - $ref: '#/components/schemas/SessionBackupMode' - MaxBackupsToRetain: - type: number - default: 0 - maximum: 10 - minimum: 0 - description: |- -

The maximum number of backups that each streaming session created from this launch - profile can have.

- additionalProperties: false - StreamConfigurationSessionStorage: - type: object - description:

The configuration for a streaming session’s upload storage.

- properties: - Root: - $ref: '#/components/schemas/StreamingSessionStorageRoot' - Mode: - type: array - items: - $ref: '#/components/schemas/StreamingSessionStorageMode' - minItems: 1 - description: |- -

Allows artists to upload files to their workstations. The only valid option is - UPLOAD.

- required: - - Mode - additionalProperties: false - StreamingClipboardMode: - type: string - enum: - - ENABLED - - DISABLED - StreamingInstanceType: - type: string - enum: - - g4dn.xlarge - - g4dn.2xlarge - - g4dn.4xlarge - - g4dn.8xlarge - - g4dn.12xlarge - - g4dn.16xlarge - - g3.4xlarge - - g3s.xlarge - - g5.xlarge - - g5.2xlarge - - g5.4xlarge - - g5.8xlarge - - g5.16xlarge - StreamingSessionStorageMode: - type: string - enum: - - UPLOAD - StreamingSessionStorageRoot: - type: object - description: |- -

The upload storage root location (folder) on streaming workstations where files are - uploaded.

- properties: - Linux: - type: string - maxLength: 128 - minLength: 1 - pattern: ^(\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$ - description:

The folder path in Linux workstations where files are uploaded.

- Windows: - type: string - maxLength: 128 - minLength: 1 - pattern: ^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$ - description:

The folder path in Windows workstations where files are uploaded.

- additionalProperties: false - Tags: - type: object - x-patternProperties: - .+: - type: string - additionalProperties: false - VolumeConfiguration: - type: object - description: |- -

Custom volume configuration for the root volumes that are attached to streaming - sessions.

-

This parameter is only allowed when sessionPersistenceMode is - ACTIVATED.

- properties: - Size: - type: number - default: 500 - maximum: 16000 - minimum: 100 - description: |- -

The size of the root volume that is attached to the streaming session. The root volume - size is measured in GiBs.

- Throughput: - type: number - default: 125 - maximum: 1000 - minimum: 125 - description: |- -

The throughput to provision for the root volume that is attached to the streaming - session. The throughput is measured in MiB/s.

- Iops: - type: number - default: 3000 - maximum: 16000 - minimum: 3000 - description: |- -

The number of I/O operations per second for the root volume that is attached to - streaming session.

- additionalProperties: false - LaunchProfile: - type: object - properties: - Description: - type: string - maxLength: 256 - minLength: 0 - description:

The description.

- Ec2SubnetIds: - type: array - items: - type: string - maxItems: 6 - minItems: 0 - description: |- -

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. - These subnets must support the specified instance types.

- LaunchProfileId: - type: string - LaunchProfileProtocolVersions: - type: array - items: - type: string - maxLength: 10 - minLength: 0 - pattern: ^2021\-03\-31$ - description: |- -

The version number of the protocol that is used by the launch profile. The only valid - version is "2021-03-31".

- description: |- -

The version number of the protocol that is used by the launch profile. The only valid - version is "2021-03-31".

- Name: - type: string - maxLength: 64 - minLength: 1 - description:

The name for the launch profile.

- StreamConfiguration: - $ref: '#/components/schemas/StreamConfiguration' - StudioComponentIds: - type: array - items: - type: string - maxItems: 100 - minItems: 1 - description: |- -

Unique identifiers for a collection of studio components that can be used with this - launch profile.

- StudioId: - type: string - description:

The studio ID.

- Tags: - $ref: '#/components/schemas/Tags' - required: - - StudioId - - Name - - StudioComponentIds - - Ec2SubnetIds - - StreamConfiguration - - LaunchProfileProtocolVersions - x-stackql-resource-name: launch_profile - x-stackql-primaryIdentifier: - - LaunchProfileId - - StudioId - x-create-only-properties: - - Ec2SubnetIds - - StudioId - - Tags - x-read-only-properties: - - LaunchProfileId - x-required-permissions: - create: - - nimble:CreateLaunchProfile - - nimble:GetLaunchProfile - - nimble:TagResource - - ec2:CreateNetworkInterface - - ec2:CreateNetworkInterfacePermission - - ec2:RunInstances - - ec2:DescribeSubnets - read: - - nimble:GetLaunchProfile - update: - - nimble:UpdateLaunchProfile - - nimble:GetLaunchProfile - - ec2:CreateNetworkInterface - - ec2:CreateNetworkInterfacePermission - - ec2:DescribeSubnets - - ec2:RunInstances - delete: - - nimble:DeleteLaunchProfile - - nimble:GetLaunchProfile - - nimble:UntagResource - list: - - nimble:ListLaunchProfiles - StreamingImageEncryptionConfiguration: - type: object - description:

TODO

- properties: - KeyType: - $ref: '#/components/schemas/StreamingImageEncryptionConfigurationKeyType' - KeyArn: - type: string - minLength: 4 - pattern: ^arn:.* - description:

The ARN for a KMS key that is used to encrypt studio data.

- required: - - KeyType - additionalProperties: false - StreamingImageEncryptionConfigurationKeyType: - type: string - description:

- enum: - - CUSTOMER_MANAGED_KEY - StreamingImage: - type: object - properties: - Description: - type: string - maxLength: 256 - minLength: 0 - description:

A human-readable description of the streaming image.

- Ec2ImageId: - type: string - pattern: ^ami-[0-9A-z]+$ - description:

The ID of an EC2 machine image with which to create this streaming image.

- EncryptionConfiguration: - $ref: '#/components/schemas/StreamingImageEncryptionConfiguration' - EulaIds: - type: array - items: - type: string - description:

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

- Name: - type: string - maxLength: 64 - minLength: 0 - description:

A friendly name for a streaming image resource.

- Owner: - type: string - description:

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

- Platform: - type: string - pattern: ^[a-zA-Z]*$ - description:

The platform of the streaming image, either WINDOWS or LINUX.

- StreamingImageId: - type: string - StudioId: - type: string - description:

The studioId.

- Tags: - $ref: '#/components/schemas/Tags' - required: - - StudioId - - Ec2ImageId - - Name - x-stackql-resource-name: streaming_image - x-stackql-primaryIdentifier: - - StudioId - - StreamingImageId - x-create-only-properties: - - Ec2ImageId - - StudioId - - Tags - x-read-only-properties: - - EncryptionConfiguration - - EulaIds - - Owner - - Platform - - StreamingImageId - x-required-permissions: - create: - - nimble:CreateStreamingImage - - nimble:GetStreamingImage - - nimble:TagResource - - ec2:DescribeImages - - ec2:DescribeSnapshots - - ec2:ModifyInstanceAttribute - - ec2:ModifySnapshotAttribute - - ec2:ModifyImageAttribute - - ec2:RegisterImage - - kms:Encrypt - - kms:Decrypt - - kms:CreateGrant - - kms:ListGrants - - kms:GenerateDataKey - read: - - nimble:GetStreamingImage - update: - - nimble:UpdateStreamingImage - - nimble:GetStreamingImage - - kms:Encrypt - - kms:Decrypt - - kms:CreateGrant - - kms:ListGrants - - kms:GenerateDataKey - delete: - - nimble:DeleteStreamingImage - - nimble:GetStreamingImage - - nimble:UntagResource - - ec2:ModifyInstanceAttribute - - ec2:ModifySnapshotAttribute - - ec2:DeregisterImage - - ec2:DeleteSnapshot - - kms:ListGrants - - kms:RetireGrant - list: - - nimble:ListStreamingImages - StudioEncryptionConfiguration: - type: object - description:

Configuration of the encryption method that is used for the studio.

- properties: - KeyType: - $ref: '#/components/schemas/StudioEncryptionConfigurationKeyType' - KeyArn: - type: string - minLength: 4 - pattern: ^arn:.* - description:

The ARN for a KMS key that is used to encrypt studio data.

- required: - - KeyType - additionalProperties: false - StudioEncryptionConfigurationKeyType: - type: string - description:

The type of KMS key that is used to encrypt studio data.

- enum: - - AWS_OWNED_KEY - - CUSTOMER_MANAGED_KEY - Studio: - type: object - properties: - AdminRoleArn: - type: string - description:

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

- DisplayName: - type: string - maxLength: 64 - minLength: 0 - description:

A friendly name for the studio.

- HomeRegion: - type: string - maxLength: 50 - minLength: 0 - pattern: '[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]' - description:

The Amazon Web Services Region where the studio resource is located.

- SsoClientId: - type: string - description:

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

- StudioEncryptionConfiguration: - $ref: '#/components/schemas/StudioEncryptionConfiguration' - StudioId: - type: string - StudioName: - type: string - maxLength: 64 - minLength: 3 - pattern: ^[a-z0-9]*$ - description:

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

- StudioUrl: - type: string - description:

The address of the web page for the studio.

- Tags: - $ref: '#/components/schemas/Tags' - UserRoleArn: - type: string - description:

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

- required: - - DisplayName - - UserRoleArn - - AdminRoleArn - - StudioName - x-stackql-resource-name: studio - x-stackql-primaryIdentifier: - - StudioId - x-create-only-properties: - - StudioName - - Tags - x-read-only-properties: - - HomeRegion - - SsoClientId - - StudioId - - StudioUrl - x-required-permissions: - create: - - iam:PassRole - - nimble:CreateStudio - - nimble:GetStudio - - nimble:TagResource - - sso:CreateManagedApplicationInstance - - kms:Encrypt - - kms:Decrypt - - kms:CreateGrant - - kms:ListGrants - - kms:GenerateDataKey - read: - - nimble:GetStudio - - kms:Encrypt - - kms:Decrypt - - kms:ListGrants - - kms:GenerateDataKey - update: - - iam:PassRole - - nimble:UpdateStudio - - nimble:GetStudio - - kms:Encrypt - - kms:Decrypt - - kms:CreateGrant - - kms:ListGrants - - kms:GenerateDataKey - delete: - - nimble:DeleteStudio - - nimble:GetStudio - - nimble:UntagResource - - kms:Encrypt - - kms:Decrypt - - kms:ListGrants - - kms:RetireGrant - - kms:GenerateDataKey - - sso:DeleteManagedApplicationInstance - - sso:GetManagedApplicationInstance - list: - - nimble:ListStudios - ActiveDirectoryComputerAttribute: - type: object - description: |- -

An LDAP attribute of an Active Directory computer account, in the form of a name:value - pair.

- properties: - Name: - type: string - maxLength: 40 - minLength: 1 - description:

The name for the LDAP attribute.

- Value: - type: string - maxLength: 64 - minLength: 1 - description:

The value for the LDAP attribute.

- additionalProperties: false - ActiveDirectoryConfiguration: - type: object - description: |- -

The configuration for a Microsoft Active Directory (Microsoft AD) studio - resource.

- properties: - ComputerAttributes: - type: array - items: - $ref: '#/components/schemas/ActiveDirectoryComputerAttribute' - maxItems: 50 - minItems: 0 - description:

A collection of custom attributes for an Active Directory computer.

- DirectoryId: - type: string - description: |- -

The directory ID of the Directory Service for Microsoft Active Directory to access - using this studio component.

- OrganizationalUnitDistinguishedName: - type: string - maxLength: 2000 - minLength: 1 - description: |- -

The distinguished name (DN) and organizational unit (OU) of an Active Directory - computer.

- additionalProperties: false - ComputeFarmConfiguration: - type: object - description:

The configuration for a render farm that is associated with a studio resource.

- properties: - ActiveDirectoryUser: - type: string - description: |- -

The name of an Active Directory user that is used on ComputeFarm worker - instances.

- Endpoint: - type: string - description: |- -

The endpoint of the ComputeFarm that is accessed by the studio component - resource.

- additionalProperties: false - LaunchProfilePlatform: - type: string - enum: - - LINUX - - WINDOWS - LicenseServiceConfiguration: - type: object - description: |- -

The configuration for a license service that is associated with a studio - resource.

- properties: - Endpoint: - type: string - description: |- -

The endpoint of the license service that is accessed by the studio component - resource.

- additionalProperties: false - ScriptParameterKeyValue: - type: object - description:

A parameter for a studio component script, in the form of a key:value pair.

- properties: - Key: - type: string - maxLength: 64 - minLength: 1 - pattern: ^[a-zA-Z_][a-zA-Z0-9_]+$ - description:

A script parameter key.

- Value: - type: string - maxLength: 256 - minLength: 1 - description:

A script parameter value.

- additionalProperties: false - SharedFileSystemConfiguration: - type: object - description: |- -

The configuration for a shared file storage system that is associated with a studio - resource.

- properties: - Endpoint: - type: string - description: |- -

The endpoint of the shared file system that is accessed by the studio component - resource.

- FileSystemId: - type: string - description:

The unique identifier for a file system.

- LinuxMountPoint: - type: string - maxLength: 128 - minLength: 0 - pattern: ^(/?|(\$HOME)?(/[^/\n\s\\]+)*)$ - description:

The mount location for a shared file system on a Linux virtual workstation.

- ShareName: - type: string - description:

The name of the file share.

- WindowsMountDrive: - type: string - pattern: ^[A-Z]$ - description:

The mount location for a shared file system on a Windows virtual workstation.

- additionalProperties: false - StudioComponentConfiguration: - description:

The configuration of the studio component, based on component type.

- oneOf: - - type: object - title: ActiveDirectoryConfiguration - properties: - ActiveDirectoryConfiguration: - $ref: '#/components/schemas/ActiveDirectoryConfiguration' - required: - - ActiveDirectoryConfiguration - additionalProperties: false - - type: object - title: ComputeFarmConfiguration - properties: - ComputeFarmConfiguration: - $ref: '#/components/schemas/ComputeFarmConfiguration' - required: - - ComputeFarmConfiguration - additionalProperties: false - - type: object - title: LicenseServiceConfiguration - properties: - LicenseServiceConfiguration: - $ref: '#/components/schemas/LicenseServiceConfiguration' - required: - - LicenseServiceConfiguration - additionalProperties: false - - type: object - title: SharedFileSystemConfiguration - properties: - SharedFileSystemConfiguration: - $ref: '#/components/schemas/SharedFileSystemConfiguration' - required: - - SharedFileSystemConfiguration - additionalProperties: false - StudioComponentInitializationScript: - type: object - description:

Initialization scripts for studio components.

- properties: - LaunchProfileProtocolVersion: - type: string - maxLength: 10 - minLength: 0 - pattern: ^2021\-03\-31$ - description: |- -

The version number of the protocol that is used by the launch profile. The only valid - version is "2021-03-31".

- Platform: - $ref: '#/components/schemas/LaunchProfilePlatform' - RunContext: - $ref: '#/components/schemas/StudioComponentInitializationScriptRunContext' - Script: - type: string - maxLength: 5120 - minLength: 1 - description:

The initialization script.

- additionalProperties: false - StudioComponentInitializationScriptRunContext: - type: string - enum: - - SYSTEM_INITIALIZATION - - USER_INITIALIZATION - StudioComponentSubtype: - type: string - enum: - - AWS_MANAGED_MICROSOFT_AD - - AMAZON_FSX_FOR_WINDOWS - - AMAZON_FSX_FOR_LUSTRE - - CUSTOM - StudioComponentType: - type: string - enum: - - ACTIVE_DIRECTORY - - SHARED_FILE_SYSTEM - - COMPUTE_FARM - - LICENSE_SERVICE - - CUSTOM - StudioComponent: - type: object - properties: - Configuration: - $ref: '#/components/schemas/StudioComponentConfiguration' - Description: - type: string - maxLength: 256 - minLength: 0 - description:

The description.

- Ec2SecurityGroupIds: - type: array - items: - type: string - maxItems: 30 - minItems: 0 - description:

The EC2 security groups that control access to the studio component.

- InitializationScripts: - type: array - items: - $ref: '#/components/schemas/StudioComponentInitializationScript' - description:

Initialization scripts for studio components.

- Name: - type: string - maxLength: 64 - minLength: 0 - description:

The name for the studio component.

- RuntimeRoleArn: - type: string - maxLength: 2048 - minLength: 0 - ScriptParameters: - type: array - items: - $ref: '#/components/schemas/ScriptParameterKeyValue' - maxItems: 30 - minItems: 0 - description:

Parameters for the studio component scripts.

- SecureInitializationRoleArn: - type: string - maxLength: 2048 - minLength: 0 - StudioComponentId: - type: string - StudioId: - type: string - description:

The studio ID.

- Subtype: - $ref: '#/components/schemas/StudioComponentSubtype' - Tags: - $ref: '#/components/schemas/Tags' - Type: - $ref: '#/components/schemas/StudioComponentType' - required: - - StudioId - - Name - - Type - x-stackql-resource-name: studio_component - x-stackql-primaryIdentifier: - - StudioComponentId - - StudioId - x-create-only-properties: - - StudioId - - Subtype - - Tags - x-read-only-properties: - - StudioComponentId - x-required-permissions: - create: - - iam:PassRole - - nimble:CreateStudioComponent - - nimble:GetStudioComponent - - nimble:TagResource - - ds:AuthorizeApplication - - ec2:DescribeSecurityGroups - - fsx:DescribeFilesystems - - ds:DescribeDirectories - read: - - nimble:GetStudioComponent - update: - - iam:PassRole - - nimble:UpdateStudioComponent - - nimble:GetStudioComponent - - ds:AuthorizeApplication - - ec2:DescribeSecurityGroups - - fsx:DescribeFilesystems - - ds:DescribeDirectories - delete: - - nimble:DeleteStudioComponent - - nimble:GetStudioComponent - - nimble:UntagResource - - ds:UnauthorizeApplication - list: - - nimble:ListStudioComponents - x-stackQL-resources: - launch_profiles: - name: launch_profiles - id: awscc.nimblestudio.launch_profiles - x-cfn-schema-name: LaunchProfile - x-type: list - x-identifiers: - - LaunchProfileId - - StudioId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LaunchProfileId') as launch_profile_id, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LaunchProfileId') as launch_profile_id, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND region = 'us-east-1' - launch_profile: - name: launch_profile - id: awscc.nimblestudio.launch_profile - x-cfn-schema-name: LaunchProfile - x-type: get - x-identifiers: - - LaunchProfileId - - StudioId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Ec2SubnetIds') as ec2_subnet_ids, - JSON_EXTRACT(Properties, '$.LaunchProfileId') as launch_profile_id, - JSON_EXTRACT(Properties, '$.LaunchProfileProtocolVersions') as launch_profile_protocol_versions, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.StreamConfiguration') as stream_configuration, - JSON_EXTRACT(Properties, '$.StudioComponentIds') as studio_component_ids, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Ec2SubnetIds') as ec2_subnet_ids, - json_extract_path_text(Properties, 'LaunchProfileId') as launch_profile_id, - json_extract_path_text(Properties, 'LaunchProfileProtocolVersions') as launch_profile_protocol_versions, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'StreamConfiguration') as stream_configuration, - json_extract_path_text(Properties, 'StudioComponentIds') as studio_component_ids, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND data__Identifier = '|' - AND region = 'us-east-1' - streaming_images: - name: streaming_images - id: awscc.nimblestudio.streaming_images - x-cfn-schema-name: StreamingImage - x-type: list - x-identifiers: - - StudioId - - StreamingImageId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.StreamingImageId') as streaming_image_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'StreamingImageId') as streaming_image_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND region = 'us-east-1' - streaming_image: - name: streaming_image - id: awscc.nimblestudio.streaming_image - x-cfn-schema-name: StreamingImage - x-type: get - x-identifiers: - - StudioId - - StreamingImageId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Ec2ImageId') as ec2_image_id, - JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration, - JSON_EXTRACT(Properties, '$.EulaIds') as eula_ids, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Owner') as owner, - JSON_EXTRACT(Properties, '$.Platform') as platform, - JSON_EXTRACT(Properties, '$.StreamingImageId') as streaming_image_id, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Ec2ImageId') as ec2_image_id, - json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, - json_extract_path_text(Properties, 'EulaIds') as eula_ids, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Owner') as owner, - json_extract_path_text(Properties, 'Platform') as platform, - json_extract_path_text(Properties, 'StreamingImageId') as streaming_image_id, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND data__Identifier = '|' - AND region = 'us-east-1' - studios: - name: studios - id: awscc.nimblestudio.studios - x-cfn-schema-name: Studio - x-type: list - x-identifiers: - - StudioId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND region = 'us-east-1' - studio: - name: studio - id: awscc.nimblestudio.studio - x-cfn-schema-name: Studio - x-type: get - x-identifiers: - - StudioId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AdminRoleArn') as admin_role_arn, - JSON_EXTRACT(Properties, '$.DisplayName') as display_name, - JSON_EXTRACT(Properties, '$.HomeRegion') as home_region, - JSON_EXTRACT(Properties, '$.SsoClientId') as sso_client_id, - JSON_EXTRACT(Properties, '$.StudioEncryptionConfiguration') as studio_encryption_configuration, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.StudioName') as studio_name, - JSON_EXTRACT(Properties, '$.StudioUrl') as studio_url, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.UserRoleArn') as user_role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'AdminRoleArn') as admin_role_arn, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'HomeRegion') as home_region, - json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, - json_extract_path_text(Properties, 'StudioEncryptionConfiguration') as studio_encryption_configuration, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'StudioName') as studio_name, - json_extract_path_text(Properties, 'StudioUrl') as studio_url, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UserRoleArn') as user_role_arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND data__Identifier = '' - AND region = 'us-east-1' - studio_components: - name: studio_components - id: awscc.nimblestudio.studio_components - x-cfn-schema-name: StudioComponent - x-type: list - x-identifiers: - - StudioComponentId - - StudioId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioComponentId') as studio_component_id, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioComponentId') as studio_component_id, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND region = 'us-east-1' - studio_component: - name: studio_component - id: awscc.nimblestudio.studio_component - x-cfn-schema-name: StudioComponent - x-type: get - x-identifiers: - - StudioComponentId - - StudioId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Configuration') as configuration, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Ec2SecurityGroupIds') as ec2_security_group_ids, - JSON_EXTRACT(Properties, '$.InitializationScripts') as initialization_scripts, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.RuntimeRoleArn') as runtime_role_arn, - JSON_EXTRACT(Properties, '$.ScriptParameters') as script_parameters, - JSON_EXTRACT(Properties, '$.SecureInitializationRoleArn') as secure_initialization_role_arn, - JSON_EXTRACT(Properties, '$.StudioComponentId') as studio_component_id, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.Subtype') as subtype, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Type') as type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Ec2SecurityGroupIds') as ec2_security_group_ids, - json_extract_path_text(Properties, 'InitializationScripts') as initialization_scripts, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RuntimeRoleArn') as runtime_role_arn, - json_extract_path_text(Properties, 'ScriptParameters') as script_parameters, - json_extract_path_text(Properties, 'SecureInitializationRoleArn') as secure_initialization_role_arn, - json_extract_path_text(Properties, 'StudioComponentId') as studio_component_id, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'Subtype') as subtype, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND data__Identifier = '|' - AND region = 'us-east-1' diff --git a/providers/src/awscc/v00.00.00000/services/notifications.yaml b/providers/src/awscc/v00.00.00000/services/notifications.yaml new file mode 100644 index 00000000..4eeedf3a --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/notifications.yaml @@ -0,0 +1,2288 @@ +openapi: 3.0.0 +info: + title: Notifications + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ChannelAssociation: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+$ + description: |- + ARN identifier of the channel. + Example: arn:aws:chatbot::123456789012:chat-configuration/slack-channel/security-ops + NotificationConfigurationArn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration\/[a-z0-9]{27}$ + description: |- + ARN identifier of the NotificationConfiguration. + Example: arn:aws:notifications::123456789012:configuration/a01jes88qxwkbj05xv9c967pgm1 + required: + - Arn + - NotificationConfigurationArn + x-stackql-resource-name: channel_association + description: Resource Type definition for AWS::Notifications::ChannelAssociation + x-type-name: AWS::Notifications::ChannelAssociation + x-stackql-primary-identifier: + - Arn + - NotificationConfigurationArn + x-create-only-properties: + - Arn + - NotificationConfigurationArn + x-required-properties: + - Arn + - NotificationConfigurationArn + x-tagging: + taggable: false + x-required-permissions: + create: + - notifications:AssociateChannel + - notifications:ListChannels + delete: + - notifications:DisassociateChannel + list: + - notifications:ListChannels + read: + - notifications:ListChannels + EventRuleStatus: + type: string + enum: + - ACTIVE + - INACTIVE + - CREATING + - UPDATING + - DELETING + EventRuleStatusSummary: + type: object + properties: + Status: + $ref: '#/components/schemas/EventRuleStatus' + Reason: + type: string + required: + - Reason + - Status + additionalProperties: false + StatusSummaryByRegion: + type: object + x-patternProperties: + ^([a-z]{1,2})-([a-z]{1,15}-)+([0-9])$: + $ref: '#/components/schemas/EventRuleStatusSummary' + additionalProperties: false + Unit: + type: object + additionalProperties: false + EventRule: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}/rule/[a-z0-9]{27}$ + CreationTime: + type: string + format: date-time + EventPattern: + type: string + maxLength: 4096 + minLength: 0 + EventType: + type: string + maxLength: 128 + minLength: 1 + pattern: ^([a-zA-Z0-9 \-\(\)])+$ + ManagedRules: + type: array + items: + type: string + pattern: ^arn:aws:events:[a-z-\d]{2,25}:\d{12}:rule\/[a-zA-Z-\d]{1,1024}$ + NotificationConfigurationArn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}$ + Regions: + type: array + items: + type: string + maxLength: 25 + minLength: 2 + pattern: ^([a-z]{1,2})-([a-z]{1,15}-)+([0-9])$ + minItems: 1 + Source: + type: string + maxLength: 36 + minLength: 1 + pattern: ^aws.([a-z0-9\-])+$ + StatusSummaryByRegion: + $ref: '#/components/schemas/StatusSummaryByRegion' + required: + - EventType + - NotificationConfigurationArn + - Regions + - Source + x-stackql-resource-name: event_rule + description: Resource Type definition for AWS::Notifications::EventRule + x-type-name: AWS::Notifications::EventRule + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - EventType + - NotificationConfigurationArn + - Source + x-read-only-properties: + - Arn + - CreationTime + - ManagedRules + - StatusSummaryByRegion + x-required-properties: + - EventType + - NotificationConfigurationArn + - Regions + - Source + x-tagging: + taggable: false + x-required-permissions: + create: + - notifications:CreateEventRule + - notifications:UpdateEventRule + - notifications:GetEventRule + read: + - notifications:GetEventRule + update: + - notifications:UpdateEventRule + - notifications:GetEventRule + delete: + - notifications:DeleteEventRule + - notifications:GetEventRule + list: + - notifications:ListEventRules + - notifications:GetEventRule + ManagedNotificationConfigurationArn: + description: The managed notification configuration ARN, against which the account contact association will be created + type: string + pattern: ^arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}$ + ContactIdentifier: + description: This unique identifier for Contact + type: string + enum: + - ACCOUNT_PRIMARY + - ACCOUNT_ALTERNATE_SECURITY + - ACCOUNT_ALTERNATE_OPERATIONS + - ACCOUNT_ALTERNATE_BILLING + ManagedNotificationAccountContactAssociation: + type: object + properties: + ManagedNotificationConfigurationArn: + $ref: '#/components/schemas/ManagedNotificationConfigurationArn' + ContactIdentifier: + $ref: '#/components/schemas/ContactIdentifier' + required: + - ContactIdentifier + - ManagedNotificationConfigurationArn + x-stackql-resource-name: managed_notification_account_contact_association + description: Resource Type definition for ManagedNotificationAccountContactAssociation + x-type-name: AWS::Notifications::ManagedNotificationAccountContactAssociation + x-stackql-primary-identifier: + - ManagedNotificationConfigurationArn + - ContactIdentifier + x-create-only-properties: + - ManagedNotificationConfigurationArn + - ContactIdentifier + x-required-properties: + - ContactIdentifier + - ManagedNotificationConfigurationArn + x-tagging: + taggable: false + x-required-permissions: + create: + - notifications:AssociateManagedNotificationAccountContact + - notifications:ListManagedNotificationChannelAssociations + read: + - notifications:ListManagedNotificationChannelAssociations + update: + - notifications:ListManagedNotificationChannelAssociations + delete: + - notifications:DisassociateManagedNotificationAccountContact + - notifications:ListManagedNotificationChannelAssociations + list: + - notifications:ListManagedNotificationChannelAssociations + ManagedNotificationAdditionalChannelAssociation: + type: object + properties: + ChannelArn: + type: string + pattern: ^arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+$ + description: |- + ARN identifier of the channel. + Example: arn:aws:chatbot::123456789012:chat-configuration/slack-channel/security-ops + ManagedNotificationConfigurationArn: + type: string + pattern: ^arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}$ + description: |- + ARN identifier of the Managed Notification. + Example: arn:aws:notifications::381491923782:managed-notification-configuration/category/AWS-Health/sub-category/Billing + required: + - ChannelArn + - ManagedNotificationConfigurationArn + x-stackql-resource-name: managed_notification_additional_channel_association + description: Resource Type definition for AWS::Notifications::ManagedNotificationAdditionalChannelAssociation + x-type-name: AWS::Notifications::ManagedNotificationAdditionalChannelAssociation + x-stackql-primary-identifier: + - ChannelArn + - ManagedNotificationConfigurationArn + x-create-only-properties: + - ChannelArn + - ManagedNotificationConfigurationArn + x-required-properties: + - ChannelArn + - ManagedNotificationConfigurationArn + x-tagging: + taggable: false + x-required-permissions: + create: + - notifications:AssociateManagedNotificationAdditionalChannel + - notifications:ListManagedNotificationChannelAssociations + delete: + - notifications:DisassociateManagedNotificationAdditionalChannel + - notifications:ListManagedNotificationChannelAssociations + list: + - notifications:ListManagedNotificationChannelAssociations + read: + - notifications:ListManagedNotificationChannelAssociations + AggregationDuration: + type: string + enum: + - LONG + - SHORT + - NONE + NotificationConfigurationStatus: + type: string + enum: + - ACTIVE + - PARTIALLY_ACTIVE + - INACTIVE + - DELETING + TagMap: + description: A list of tags that are attached to the role. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + Value: + type: string + minLength: 0 + maxLength: 256 + required: + - Key + - Value + NotificationConfiguration: + type: object + properties: + AggregationDuration: + $ref: '#/components/schemas/AggregationDuration' + Arn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}$ + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[^\u0001-\u001F\u007F-\u009F]*$ + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9_\-]+$ + Status: + $ref: '#/components/schemas/NotificationConfigurationStatus' + Tags: + $ref: '#/components/schemas/TagMap' + required: + - Description + - Name + x-stackql-resource-name: notification_configuration + description: Resource Type definition for AWS::Notifications::NotificationConfiguration + x-type-name: AWS::Notifications::NotificationConfiguration + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Tags + x-read-only-properties: + - CreationTime + - Status + - Arn + x-required-properties: + - Description + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - notifications:TagResource + - notifications:UntagResource + - notifications:ListTagsForResource + x-required-permissions: + create: + - notifications:CreateNotificationConfiguration + - notifications:GetNotificationConfiguration + - notifications:UpdateNotificationConfiguration + - notifications:TagResource + - notifications:UntagResource + - notifications:ListTagsForResource + - iam:CreateServiceLinkedRole + read: + - notifications:GetNotificationConfiguration + - notifications:ListTagsForResource + - notifications:TagResource + - notifications:UntagResource + update: + - notifications:CreateNotificationConfiguration + - notifications:GetNotificationConfiguration + - notifications:UpdateNotificationConfiguration + - notifications:TagResource + - notifications:UntagResource + - notifications:ListTagsForResource + delete: + - notifications:DeleteNotificationConfiguration + list: + - notifications:ListNotificationConfigurations + - notifications:ListTagsForResource + NotificationHubStatus: + type: string + enum: + - ACTIVE + - REGISTERING + - DEREGISTERING + - INACTIVE + NotificationHubStatusSummary: + type: object + properties: + NotificationHubStatus: + $ref: '#/components/schemas/NotificationHubStatus' + NotificationHubStatusReason: + type: string + required: + - NotificationHubStatus + - NotificationHubStatusReason + additionalProperties: false + Region: + type: string + maxLength: 25 + minLength: 2 + pattern: ^([a-z]{1,2})-([a-z]{1,15}-)+([0-9])$ + description: Region that NotificationHub is present in. + NotificationHub: + type: object + properties: + Region: + $ref: '#/components/schemas/Region' + NotificationHubStatusSummary: + $ref: '#/components/schemas/NotificationHubStatusSummary' + CreationTime: + type: string + format: date-time + required: + - Region + x-stackql-resource-name: notification_hub + description: Resource Type definition for AWS::Notifications::NotificationHub + x-type-name: AWS::Notifications::NotificationHub + x-stackql-primary-identifier: + - Region + x-create-only-properties: + - Region + x-read-only-properties: + - CreationTime + - NotificationHubStatusSummary + x-required-properties: + - Region + x-tagging: + taggable: false + x-required-permissions: + read: + - notifications:ListNotificationHubs + create: + - notifications:RegisterNotificationHub + - notifications:ListNotificationHubs + - iam:CreateServiceLinkedRole + delete: + - notifications:DeregisterNotificationHub + - notifications:ListNotificationHubs + list: + - notifications:ListNotificationHubs + OrganizationalUnitAssociation: + type: object + properties: + NotificationConfigurationArn: + description: |- + ARN identifier of the NotificationConfiguration. + Example: arn:aws:notifications::123456789012:configuration/a01jes88qxwkbj05xv9c967pgm1 + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration\/[a-z0-9]{27}$ + OrganizationalUnitId: + description: The ID of the organizational unit. + type: string + pattern: ^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$ + required: + - NotificationConfigurationArn + - OrganizationalUnitId + x-stackql-resource-name: organizational_unit_association + description: Resource Type definition for AWS::Notifications::OrganizationalUnitAssociation + x-type-name: AWS::Notifications::OrganizationalUnitAssociation + x-stackql-primary-identifier: + - NotificationConfigurationArn + - OrganizationalUnitId + x-create-only-properties: + - NotificationConfigurationArn + - OrganizationalUnitId + x-required-properties: + - NotificationConfigurationArn + - OrganizationalUnitId + x-tagging: + taggable: false + x-required-permissions: + create: + - notifications:AssociateOrganizationalUnit + - notifications:GetNotificationConfiguration + - notifications:ListOrganizationalUnits + read: + - notifications:ListOrganizationalUnits + delete: + - notifications:DisassociateOrganizationalUnit + - notifications:ListOrganizationalUnits + list: + - notifications:ListOrganizationalUnits + CreateChannelAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+$ + description: |- + ARN identifier of the channel. + Example: arn:aws:chatbot::123456789012:chat-configuration/slack-channel/security-ops + NotificationConfigurationArn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration\/[a-z0-9]{27}$ + description: |- + ARN identifier of the NotificationConfiguration. + Example: arn:aws:notifications::123456789012:configuration/a01jes88qxwkbj05xv9c967pgm1 + x-stackQL-stringOnly: true + x-title: CreateChannelAssociationRequest + type: object + required: [] + CreateEventRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}/rule/[a-z0-9]{27}$ + CreationTime: + type: string + format: date-time + EventPattern: + type: string + maxLength: 4096 + minLength: 0 + EventType: + type: string + maxLength: 128 + minLength: 1 + pattern: ^([a-zA-Z0-9 \-\(\)])+$ + ManagedRules: + type: array + items: + type: string + pattern: ^arn:aws:events:[a-z-\d]{2,25}:\d{12}:rule\/[a-zA-Z-\d]{1,1024}$ + NotificationConfigurationArn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}$ + Regions: + type: array + items: + type: string + maxLength: 25 + minLength: 2 + pattern: ^([a-z]{1,2})-([a-z]{1,15}-)+([0-9])$ + minItems: 1 + Source: + type: string + maxLength: 36 + minLength: 1 + pattern: ^aws.([a-z0-9\-])+$ + StatusSummaryByRegion: + $ref: '#/components/schemas/StatusSummaryByRegion' + x-stackQL-stringOnly: true + x-title: CreateEventRuleRequest + type: object + required: [] + CreateManagedNotificationAccountContactAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ManagedNotificationConfigurationArn: + $ref: '#/components/schemas/ManagedNotificationConfigurationArn' + ContactIdentifier: + $ref: '#/components/schemas/ContactIdentifier' + x-stackQL-stringOnly: true + x-title: CreateManagedNotificationAccountContactAssociationRequest + type: object + required: [] + CreateManagedNotificationAdditionalChannelAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ChannelArn: + type: string + pattern: ^arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+$ + description: |- + ARN identifier of the channel. + Example: arn:aws:chatbot::123456789012:chat-configuration/slack-channel/security-ops + ManagedNotificationConfigurationArn: + type: string + pattern: ^arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}$ + description: |- + ARN identifier of the Managed Notification. + Example: arn:aws:notifications::381491923782:managed-notification-configuration/category/AWS-Health/sub-category/Billing + x-stackQL-stringOnly: true + x-title: CreateManagedNotificationAdditionalChannelAssociationRequest + type: object + required: [] + CreateNotificationConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AggregationDuration: + $ref: '#/components/schemas/AggregationDuration' + Arn: + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}$ + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[^\u0001-\u001F\u007F-\u009F]*$ + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9_\-]+$ + Status: + $ref: '#/components/schemas/NotificationConfigurationStatus' + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateNotificationConfigurationRequest + type: object + required: [] + CreateNotificationHubRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Region: + $ref: '#/components/schemas/Region' + NotificationHubStatusSummary: + $ref: '#/components/schemas/NotificationHubStatusSummary' + CreationTime: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateNotificationHubRequest + type: object + required: [] + CreateOrganizationalUnitAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NotificationConfigurationArn: + description: |- + ARN identifier of the NotificationConfiguration. + Example: arn:aws:notifications::123456789012:configuration/a01jes88qxwkbj05xv9c967pgm1 + type: string + pattern: ^arn:aws:notifications::[0-9]{12}:configuration\/[a-z0-9]{27}$ + OrganizationalUnitId: + description: The ID of the organizational unit. + type: string + pattern: ^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$ + x-stackQL-stringOnly: true + x-title: CreateOrganizationalUnitAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + channel_associations: + name: channel_associations + id: awscc.notifications.channel_associations + x-cfn-schema-name: ChannelAssociation + x-cfn-type-name: AWS::Notifications::ChannelAssociation + x-identifiers: + - Arn + - NotificationConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ChannelAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ChannelAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ChannelAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.NotificationConfigurationArn') as notification_configuration_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::ChannelAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'NotificationConfigurationArn') as notification_configuration_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::ChannelAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + channel_associations_list_only: + name: channel_associations_list_only + id: awscc.notifications.channel_associations_list_only + x-cfn-schema-name: ChannelAssociation + x-cfn-type-name: AWS::Notifications::ChannelAssociation + x-identifiers: + - Arn + - NotificationConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.NotificationConfigurationArn') as notification_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::ChannelAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'NotificationConfigurationArn') as notification_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::ChannelAssociation' + AND region = 'us-east-1' + event_rules: + name: event_rules + id: awscc.notifications.event_rules + x-cfn-schema-name: EventRule + x-cfn-type-name: AWS::Notifications::EventRule + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::EventRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::EventRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::EventRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.EventPattern') as event_pattern, + JSON_EXTRACT(Properties, '$.EventType') as event_type, + JSON_EXTRACT(Properties, '$.ManagedRules') as managed_rules, + JSON_EXTRACT(Properties, '$.NotificationConfigurationArn') as notification_configuration_arn, + JSON_EXTRACT(Properties, '$.Regions') as regions, + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.StatusSummaryByRegion') as status_summary_by_region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::EventRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'EventPattern') as event_pattern, + json_extract_path_text(Properties, 'EventType') as event_type, + json_extract_path_text(Properties, 'ManagedRules') as managed_rules, + json_extract_path_text(Properties, 'NotificationConfigurationArn') as notification_configuration_arn, + json_extract_path_text(Properties, 'Regions') as regions, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'StatusSummaryByRegion') as status_summary_by_region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::EventRule' + AND data__Identifier = '' + AND region = 'us-east-1' + event_rules_list_only: + name: event_rules_list_only + id: awscc.notifications.event_rules_list_only + x-cfn-schema-name: EventRule + x-cfn-type-name: AWS::Notifications::EventRule + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::EventRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::EventRule' + AND region = 'us-east-1' + managed_notification_account_contact_associations: + name: managed_notification_account_contact_associations + id: awscc.notifications.managed_notification_account_contact_associations + x-cfn-schema-name: ManagedNotificationAccountContactAssociation + x-cfn-type-name: AWS::Notifications::ManagedNotificationAccountContactAssociation + x-identifiers: + - ManagedNotificationConfigurationArn + - ContactIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ManagedNotificationAccountContactAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ManagedNotificationAccountContactAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ManagedNotificationAccountContactAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ManagedNotificationAccountContactAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/managed_notification_account_contact_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/managed_notification_account_contact_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/managed_notification_account_contact_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ManagedNotificationConfigurationArn') as managed_notification_configuration_arn, + JSON_EXTRACT(Properties, '$.ContactIdentifier') as contact_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAccountContactAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ManagedNotificationConfigurationArn') as managed_notification_configuration_arn, + json_extract_path_text(Properties, 'ContactIdentifier') as contact_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAccountContactAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + managed_notification_account_contact_associations_list_only: + name: managed_notification_account_contact_associations_list_only + id: awscc.notifications.managed_notification_account_contact_associations_list_only + x-cfn-schema-name: ManagedNotificationAccountContactAssociation + x-cfn-type-name: AWS::Notifications::ManagedNotificationAccountContactAssociation + x-identifiers: + - ManagedNotificationConfigurationArn + - ContactIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ManagedNotificationConfigurationArn') as managed_notification_configuration_arn, + JSON_EXTRACT(Properties, '$.ContactIdentifier') as contact_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAccountContactAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ManagedNotificationConfigurationArn') as managed_notification_configuration_arn, + json_extract_path_text(Properties, 'ContactIdentifier') as contact_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAccountContactAssociation' + AND region = 'us-east-1' + managed_notification_additional_channel_associations: + name: managed_notification_additional_channel_associations + id: awscc.notifications.managed_notification_additional_channel_associations + x-cfn-schema-name: ManagedNotificationAdditionalChannelAssociation + x-cfn-type-name: AWS::Notifications::ManagedNotificationAdditionalChannelAssociation + x-identifiers: + - ChannelArn + - ManagedNotificationConfigurationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ManagedNotificationAdditionalChannelAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ManagedNotificationAdditionalChannelAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::ManagedNotificationAdditionalChannelAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/managed_notification_additional_channel_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/managed_notification_additional_channel_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ChannelArn') as channel_arn, + JSON_EXTRACT(Properties, '$.ManagedNotificationConfigurationArn') as managed_notification_configuration_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAdditionalChannelAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ChannelArn') as channel_arn, + json_extract_path_text(Properties, 'ManagedNotificationConfigurationArn') as managed_notification_configuration_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAdditionalChannelAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + managed_notification_additional_channel_associations_list_only: + name: managed_notification_additional_channel_associations_list_only + id: awscc.notifications.managed_notification_additional_channel_associations_list_only + x-cfn-schema-name: ManagedNotificationAdditionalChannelAssociation + x-cfn-type-name: AWS::Notifications::ManagedNotificationAdditionalChannelAssociation + x-identifiers: + - ChannelArn + - ManagedNotificationConfigurationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ChannelArn') as channel_arn, + JSON_EXTRACT(Properties, '$.ManagedNotificationConfigurationArn') as managed_notification_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAdditionalChannelAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ChannelArn') as channel_arn, + json_extract_path_text(Properties, 'ManagedNotificationConfigurationArn') as managed_notification_configuration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::ManagedNotificationAdditionalChannelAssociation' + AND region = 'us-east-1' + notification_configurations: + name: notification_configurations + id: awscc.notifications.notification_configurations + x-cfn-schema-name: NotificationConfiguration + x-cfn-type-name: AWS::Notifications::NotificationConfiguration + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NotificationConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::NotificationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::NotificationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::NotificationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/notification_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AggregationDuration') as aggregation_duration, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::NotificationConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AggregationDuration') as aggregation_duration, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::NotificationConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + notification_configurations_list_only: + name: notification_configurations_list_only + id: awscc.notifications.notification_configurations_list_only + x-cfn-schema-name: NotificationConfiguration + x-cfn-type-name: AWS::Notifications::NotificationConfiguration + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::NotificationConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::NotificationConfiguration' + AND region = 'us-east-1' + notification_hubs: + name: notification_hubs + id: awscc.notifications.notification_hubs + x-cfn-schema-name: NotificationHub + x-cfn-type-name: AWS::Notifications::NotificationHub + x-identifiers: + - Region + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NotificationHub&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::NotificationHub" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::NotificationHub" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_hubs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_hubs/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Region') as region, + JSON_EXTRACT(Properties, '$.NotificationHubStatusSummary') as notification_hub_status_summary, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::NotificationHub' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Region') as region, + json_extract_path_text(Properties, 'NotificationHubStatusSummary') as notification_hub_status_summary, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::NotificationHub' + AND data__Identifier = '' + AND region = 'us-east-1' + notification_hubs_list_only: + name: notification_hubs_list_only + id: awscc.notifications.notification_hubs_list_only + x-cfn-schema-name: NotificationHub + x-cfn-type-name: AWS::Notifications::NotificationHub + x-identifiers: + - Region + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Region') as region + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::NotificationHub' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Region') as region + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::NotificationHub' + AND region = 'us-east-1' + organizational_unit_associations: + name: organizational_unit_associations + id: awscc.notifications.organizational_unit_associations + x-cfn-schema-name: OrganizationalUnitAssociation + x-cfn-type-name: AWS::Notifications::OrganizationalUnitAssociation + x-identifiers: + - NotificationConfigurationArn + - OrganizationalUnitId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationalUnitAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::OrganizationalUnitAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Notifications::OrganizationalUnitAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organizational_unit_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organizational_unit_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.NotificationConfigurationArn') as notification_configuration_arn, + JSON_EXTRACT(Properties, '$.OrganizationalUnitId') as organizational_unit_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::OrganizationalUnitAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NotificationConfigurationArn') as notification_configuration_arn, + json_extract_path_text(Properties, 'OrganizationalUnitId') as organizational_unit_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Notifications::OrganizationalUnitAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + organizational_unit_associations_list_only: + name: organizational_unit_associations_list_only + id: awscc.notifications.organizational_unit_associations_list_only + x-cfn-schema-name: OrganizationalUnitAssociation + x-cfn-type-name: AWS::Notifications::OrganizationalUnitAssociation + x-identifiers: + - NotificationConfigurationArn + - OrganizationalUnitId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.NotificationConfigurationArn') as notification_configuration_arn, + JSON_EXTRACT(Properties, '$.OrganizationalUnitId') as organizational_unit_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::OrganizationalUnitAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NotificationConfigurationArn') as notification_configuration_arn, + json_extract_path_text(Properties, 'OrganizationalUnitId') as organizational_unit_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Notifications::OrganizationalUnitAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ChannelAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChannelAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChannelAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ManagedNotificationAccountContactAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateManagedNotificationAccountContactAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateManagedNotificationAccountContactAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ManagedNotificationAdditionalChannelAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateManagedNotificationAdditionalChannelAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateManagedNotificationAdditionalChannelAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NotificationConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNotificationConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNotificationConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NotificationHub&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNotificationHub + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNotificationHubRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationalUnitAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationalUnitAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationalUnitAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/notificationscontacts.yaml b/providers/src/awscc/v00.00.00000/services/notificationscontacts.yaml new file mode 100644 index 00000000..64ae3425 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/notificationscontacts.yaml @@ -0,0 +1,829 @@ +openapi: 3.0.0 +info: + title: NotificationsContacts + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + EmailContact: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws:notifications-contacts::[0-9]{12}:emailcontact/[a-z0-9]{27}$ + EmailAddress: + type: string + maxLength: 254 + minLength: 6 + pattern: ^(.+)@(.+)$ + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: '[\w-.~]+' + EmailContact: + $ref: '#/components/schemas/EmailContact' + Tags: + $ref: '#/components/schemas/TagMap' + required: + - EmailAddress + - Name + x-stackql-resource-name: email_contact + description: Definition of AWS::NotificationsContacts::EmailContact Resource Type + x-type-name: AWS::NotificationsContacts::EmailContact + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - EmailAddress + - Name + - Tags + x-write-only-properties: + - EmailAddress + - Name + x-read-only-properties: + - Arn + - EmailContact + - EmailContact/Arn + - EmailContact/Address + - EmailContact/Name + - EmailContact/Status + - EmailContact/CreationTime + - EmailContact/UpdateTime + x-required-properties: + - EmailAddress + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - notifications-contacts:TagResource + - notifications-contacts:UntagResource + - notifications-contacts:ListTagsForResource + x-required-permissions: + create: + - notifications-contacts:CreateEmailContact + - notifications-contacts:GetEmailContact + - notifications-contacts:SendActivationCode + - notifications-contacts:ListEmailContacts + - notifications-contacts:TagResource + - notifications-contacts:UntagResource + - notifications-contacts:ListTagsForResource + read: + - notifications-contacts:GetEmailContact + - notifications-contacts:ListTagsForResource + - notifications-contacts:TagResource + delete: + - notifications-contacts:DeleteEmailContact + - notifications-contacts:GetEmailContact + list: + - notifications-contacts:ListEmailContacts + EmailContactStatus: + type: string + enum: + - inactive + - active + TagMap: + description: A list of tags that are attached to the role. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + Value: + type: string + minLength: 0 + maxLength: 256 + required: + - Key + - Value + CreateEmailContactRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + pattern: ^arn:aws:notifications-contacts::[0-9]{12}:emailcontact/[a-z0-9]{27}$ + EmailAddress: + type: string + maxLength: 254 + minLength: 6 + pattern: ^(.+)@(.+)$ + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: '[\w-.~]+' + EmailContact: + $ref: '#/components/schemas/EmailContact' + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateEmailContactRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + email_contacts: + name: email_contacts + id: awscc.notificationscontacts.email_contacts + x-cfn-schema-name: EmailContact + x-cfn-type-name: AWS::NotificationsContacts::EmailContact + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EmailContact&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NotificationsContacts::EmailContact" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::NotificationsContacts::EmailContact" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/email_contacts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/email_contacts/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.EmailAddress') as email_address, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.EmailContact') as email_contact, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NotificationsContacts::EmailContact' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'EmailAddress') as email_address, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'EmailContact') as email_contact, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::NotificationsContacts::EmailContact' + AND data__Identifier = '' + AND region = 'us-east-1' + email_contacts_list_only: + name: email_contacts_list_only + id: awscc.notificationscontacts.email_contacts_list_only + x-cfn-schema-name: EmailContact + x-cfn-type-name: AWS::NotificationsContacts::EmailContact + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NotificationsContacts::EmailContact' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::NotificationsContacts::EmailContact' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EmailContact&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEmailContact + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEmailContactRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/oam.yaml b/providers/src/awscc/v00.00.00000/services/oam.yaml index 81b3e851..f1b43b70 100644 --- a/providers/src/awscc/v00.00.00000/services/oam.yaml +++ b/providers/src/awscc/v00.00.00000/services/oam.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Oam - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ResourceType: type: string @@ -12,6 +392,27 @@ components: - AWS::Logs::LogGroup - AWS::XRay::Trace - AWS::ApplicationInsights::Application + - AWS::InternetMonitor::Monitor + - AWS::ApplicationSignals::Service + - AWS::ApplicationSignals::ServiceLevelObjective + LinkConfiguration: + type: object + additionalProperties: false + properties: + MetricConfiguration: + $ref: '#/components/schemas/LinkFilter' + LogGroupConfiguration: + $ref: '#/components/schemas/LinkFilter' + LinkFilter: + type: object + additionalProperties: false + properties: + Filter: + type: string + maxLength: 2000 + minLength: 1 + required: + - Filter Link: type: object properties: @@ -36,39 +437,64 @@ components: type: string maxLength: 2048 minLength: 1 + LinkConfiguration: + $ref: '#/components/schemas/LinkConfiguration' Tags: description: Tags to apply to the link type: object additionalProperties: false x-patternProperties: - ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{1,128}$: + ^(?!aws:.*).{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - pattern: ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{0,256}$ + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ minLength: 0 maxLength: 256 required: - ResourceTypes - SinkIdentifier x-stackql-resource-name: link - x-stackql-primaryIdentifier: + description: Definition of AWS::Oam::Link Resource Type + x-type-name: AWS::Oam::Link + x-stackql-primary-identifier: - Arn x-create-only-properties: - SinkIdentifier - LabelTemplate + x-write-only-properties: + - LabelTemplate x-read-only-properties: - Arn - Label + x-required-properties: + - ResourceTypes + - SinkIdentifier + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - oam:ListTagsForResource + - oam:UntagResource + - oam:TagResource x-required-permissions: create: - oam:CreateLink - oam:GetLink + - oam:TagResource + - oam:ListTagsForResource - cloudwatch:Link - logs:Link - xray:Link - applicationinsights:Link + - internetmonitor:Link + - application-signals:Link read: - oam:GetLink + - oam:ListTagsForResource update: - oam:GetLink - oam:UpdateLink @@ -76,8 +502,11 @@ components: - logs:Link - xray:Link - applicationinsights:Link + - internetmonitor:Link + - application-signals:Link - oam:TagResource - oam:UntagResource + - oam:ListTagsForResource delete: - oam:DeleteLink - oam:GetLink @@ -104,27 +533,43 @@ components: type: object additionalProperties: false x-patternProperties: - ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{1,128}$: + ^(?!aws:.*).{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - pattern: ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{0,256}$ + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ minLength: 0 maxLength: 256 required: - Name x-stackql-resource-name: sink - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Oam::Sink + x-type-name: AWS::Oam::Sink + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - oam:ListTagsForResource + - oam:UntagResource + - oam:TagResource x-required-permissions: create: - oam:CreateSink - oam:PutSinkPolicy - oam:GetSinkPolicy - oam:GetSink + - oam:TagResource + - oam:ListTagsForResource delete: - oam:DeleteSink - oam:GetSinkPolicy @@ -134,49 +579,173 @@ components: read: - oam:GetSinkPolicy - oam:GetSink + - oam:ListTagsForResource update: - oam:PutSinkPolicy - oam:GetSinkPolicy - oam:GetSink - oam:TagResource - oam:UntagResource + - oam:ListTagsForResource + CreateLinkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + Label: + type: string + LabelTemplate: + type: string + maxLength: 64 + minLength: 1 + ResourceTypes: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ResourceType' + maxItems: 50 + minItems: 1 + uniqueItems: true + SinkIdentifier: + type: string + maxLength: 2048 + minLength: 1 + LinkConfiguration: + $ref: '#/components/schemas/LinkConfiguration' + Tags: + description: Tags to apply to the link + type: object + additionalProperties: false + x-patternProperties: + ^(?!aws:.*).{1,128}$: + type: string + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ + minLength: 0 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateLinkRequest + type: object + required: [] + CreateSinkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon resource name (ARN) of the ObservabilityAccessManager Sink + type: string + maxLength: 2048 + Name: + description: The name of the ObservabilityAccessManager Sink. + type: string + minLength: 1 + maxLength: 255 + pattern: ^[a-zA-Z0-9_.-]+$ + Policy: + description: The policy of this ObservabilityAccessManager Sink. + type: object + Tags: + description: Tags to apply to the sink + type: object + additionalProperties: false + x-patternProperties: + ^(?!aws:.*).{1,128}$: + type: string + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ + minLength: 0 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateSinkRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: links: name: links id: awscc.oam.links x-cfn-schema-name: Link - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' - AND region = 'us-east-1' - link: - name: link - id: awscc.oam.link - x-cfn-schema-name: Link - x-type: get + x-cfn-type-name: AWS::Oam::Link x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Link&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Oam::Link" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Oam::Link" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Oam::Link" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/links/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -186,12 +755,13 @@ components: JSON_EXTRACT(Properties, '$.LabelTemplate') as label_template, JSON_EXTRACT(Properties, '$.ResourceTypes') as resource_types, JSON_EXTRACT(Properties, '$.SinkIdentifier') as sink_identifier, + JSON_EXTRACT(Properties, '$.LinkConfiguration') as link_configuration, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Link' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -201,17 +771,24 @@ components: json_extract_path_text(Properties, 'LabelTemplate') as label_template, json_extract_path_text(Properties, 'ResourceTypes') as resource_types, json_extract_path_text(Properties, 'SinkIdentifier') as sink_identifier, + json_extract_path_text(Properties, 'LinkConfiguration') as link_configuration, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Link' AND data__Identifier = '' AND region = 'us-east-1' - sinks: - name: sinks - id: awscc.oam.sinks - x-cfn-schema-name: Sink - x-type: list + links_list_only: + name: links_list_only + id: awscc.oam.links_list_only + x-cfn-schema-name: Link + x-cfn-type-name: AWS::Oam::Link x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -220,7 +797,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -228,19 +805,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' AND region = 'us-east-1' - sink: - name: sink - id: awscc.oam.sink + sinks: + name: sinks + id: awscc.oam.sinks x-cfn-schema-name: Sink - x-type: get + x-cfn-type-name: AWS::Oam::Sink x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Sink&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Oam::Sink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Oam::Sink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Oam::Sink" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sinks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sinks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sinks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -253,7 +878,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -265,3 +890,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Sink' AND data__Identifier = '' AND region = 'us-east-1' + sinks_list_only: + name: sinks_list_only + id: awscc.oam.sinks_list_only + x-cfn-schema-name: Sink + x-cfn-type-name: AWS::Oam::Sink + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Link&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLink + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Sink&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSink + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSinkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/observabilityadmin.yaml b/providers/src/awscc/v00.00.00000/services/observabilityadmin.yaml new file mode 100644 index 00000000..2d71d568 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/observabilityadmin.yaml @@ -0,0 +1,1163 @@ +openapi: 3.0.0 +info: + title: ObservabilityAdmin + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ResourceType: + description: Resource Type associated with the Telemetry Rule + type: string + enum: + - AWS::EC2::VPC + TelemetryType: + description: Telemetry Type associated with the Telemetry Rule + type: string + enum: + - Logs + Scope: + description: Selection Criteria on scope level for rule application + type: string + SelectionCriteria: + description: Selection Criteria on resource level for rule application + type: string + DestinationType: + description: Type of telemetry destination + type: string + enum: + - cloud-watch-logs + DestinationPattern: + description: Pattern for telemetry data destination + type: string + RetentionInDays: + description: Number of days to retain the telemetry data in the specified destination + type: integer + VPCFlowLogParameters: + description: Telemetry parameters for VPC Flow logs + type: object + properties: + LogFormat: + description: The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format. + type: string + TrafficType: + description: The type of traffic captured for the flow log. Default is ALL + type: string + MaxAggregationInterval: + description: The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s. + type: integer + required: [] + additionalProperties: false + TelemetryDestinationConfiguration: + description: The destination configuration for telemetry data + type: object + properties: + DestinationType: + $ref: '#/components/schemas/DestinationType' + DestinationPattern: + $ref: '#/components/schemas/DestinationPattern' + RetentionInDays: + $ref: '#/components/schemas/RetentionInDays' + VPCFlowLogParameters: + $ref: '#/components/schemas/VPCFlowLogParameters' + required: [] + additionalProperties: false + TelemetryRule: + type: object + properties: + RuleName: + description: The name of the telemetry rule + type: string + minLength: 1 + maxLength: 100 + pattern: ^[0-9A-Za-z-]+$ + Rule: + $ref: '#/components/schemas/TelemetryRule' + RuleArn: + description: The arn of the telemetry rule + type: string + minLength: 1 + maxLength: 1011 + pattern: ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$ + Tags: + description: An array of key-value pairs to apply to this resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - RuleName + - Rule + x-stackql-resource-name: telemetry_rule + description: The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule. + x-type-name: AWS::ObservabilityAdmin::TelemetryRule + x-stackql-primary-identifier: + - RuleArn + x-create-only-properties: + - RuleName + x-read-only-properties: + - RuleArn + x-required-properties: + - RuleName + - Rule + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - observabilityadmin:TagResource + - observabilityadmin:UntagResource + - observabilityadmin:ListTagsForResource + x-required-permissions: + create: + - observabilityadmin:CreateTelemetryRule + - observabilityadmin:GetTelemetryRule + - observabilityadmin:TagResource + - observabilityadmin:ListTagsForResource + - observabilityadmin:GetTelemetryEvaluationStatus + - iam:CreateServiceLinkedRole + read: + - observabilityadmin:GetTelemetryRule + - observabilityadmin:ListTagsForResource + - observabilityadmin:GetTelemetryEvaluationStatus + update: + - observabilityadmin:UpdateTelemetryRule + - observabilityadmin:GetTelemetryRule + - observabilityadmin:TagResource + - observabilityadmin:UntagResource + - observabilityadmin:ListTagsForResource + - observabilityadmin:GetTelemetryEvaluationStatus + delete: + - observabilityadmin:DeleteTelemetryRule + - observabilityadmin:GetTelemetryEvaluationStatus + list: + - observabilityadmin:ListTelemetryRules + - observabilityadmin:GetTelemetryEvaluationStatus + Tag: + description: A key-value pair to associate with a resource + type: object + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + OrganizationTelemetryRule: + type: object + properties: + RuleName: + description: The name of the organization telemetry rule + type: string + minLength: 1 + maxLength: 100 + pattern: ^[0-9A-Za-z-]+$ + Rule: + $ref: '#/components/schemas/TelemetryRule' + RuleArn: + description: The arn of the organization telemetry rule + type: string + minLength: 1 + maxLength: 1011 + pattern: ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$ + Tags: + description: An array of key-value pairs to apply to this resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - RuleName + - Rule + x-stackql-resource-name: organization_telemetry_rule + description: The AWS::ObservabilityAdmin::OrganizationTelemetryRule resource defines a CloudWatch Observability Admin Organization Telemetry Rule. + x-type-name: AWS::ObservabilityAdmin::OrganizationTelemetryRule + x-stackql-primary-identifier: + - RuleArn + x-create-only-properties: + - RuleName + x-read-only-properties: + - RuleArn + x-required-properties: + - RuleName + - Rule + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - observabilityadmin:TagResource + - observabilityadmin:UntagResource + - observabilityadmin:ListTagsForResource + x-required-permissions: + create: + - observabilityadmin:CreateTelemetryRuleForOrganization + - observabilityadmin:GetTelemetryRuleForOrganization + - observabilityadmin:TagResource + - observabilityadmin:ListTagsForResource + - observabilityadmin:GetTelemetryEvaluationStatusForOrganization + - organizations:ListDelegatedAdministrators + - iam:CreateServiceLinkedRole + read: + - observabilityadmin:GetTelemetryRuleForOrganization + - observabilityadmin:ListTagsForResource + - observabilityadmin:GetTelemetryEvaluationStatusForOrganization + - organizations:ListDelegatedAdministrators + update: + - observabilityadmin:UpdateTelemetryRuleForOrganization + - observabilityadmin:GetTelemetryRuleForOrganization + - observabilityadmin:TagResource + - observabilityadmin:UntagResource + - observabilityadmin:ListTagsForResource + - observabilityadmin:GetTelemetryEvaluationStatusForOrganization + - organizations:ListDelegatedAdministrators + delete: + - observabilityadmin:DeleteTelemetryRuleForOrganization + - observabilityadmin:GetTelemetryEvaluationStatusForOrganization + - organizations:ListDelegatedAdministrators + list: + - observabilityadmin:ListTelemetryRulesForOrganization + - observabilityadmin:GetTelemetryEvaluationStatusForOrganization + - organizations:ListDelegatedAdministrators + CreateTelemetryRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleName: + description: The name of the telemetry rule + type: string + minLength: 1 + maxLength: 100 + pattern: ^[0-9A-Za-z-]+$ + Rule: + $ref: '#/components/schemas/TelemetryRule' + RuleArn: + description: The arn of the telemetry rule + type: string + minLength: 1 + maxLength: 1011 + pattern: ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$ + Tags: + description: An array of key-value pairs to apply to this resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTelemetryRuleRequest + type: object + required: [] + CreateOrganizationTelemetryRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleName: + description: The name of the organization telemetry rule + type: string + minLength: 1 + maxLength: 100 + pattern: ^[0-9A-Za-z-]+$ + Rule: + $ref: '#/components/schemas/TelemetryRule' + RuleArn: + description: The arn of the organization telemetry rule + type: string + minLength: 1 + maxLength: 1011 + pattern: ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$ + Tags: + description: An array of key-value pairs to apply to this resource + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOrganizationTelemetryRuleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + telemetry_rules: + name: telemetry_rules + id: awscc.observabilityadmin.telemetry_rules + x-cfn-schema-name: TelemetryRule + x-cfn-type-name: AWS::ObservabilityAdmin::TelemetryRule + x-identifiers: + - RuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TelemetryRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ObservabilityAdmin::TelemetryRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ObservabilityAdmin::TelemetryRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ObservabilityAdmin::TelemetryRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/telemetry_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/telemetry_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/telemetry_rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RuleName') as rule_name, + JSON_EXTRACT(Properties, '$.Rule') as rule, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ObservabilityAdmin::TelemetryRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'Rule') as rule, + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ObservabilityAdmin::TelemetryRule' + AND data__Identifier = '' + AND region = 'us-east-1' + telemetry_rules_list_only: + name: telemetry_rules_list_only + id: awscc.observabilityadmin.telemetry_rules_list_only + x-cfn-schema-name: TelemetryRule + x-cfn-type-name: AWS::ObservabilityAdmin::TelemetryRule + x-identifiers: + - RuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ObservabilityAdmin::TelemetryRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ObservabilityAdmin::TelemetryRule' + AND region = 'us-east-1' + organization_telemetry_rules: + name: organization_telemetry_rules + id: awscc.observabilityadmin.organization_telemetry_rules + x-cfn-schema-name: OrganizationTelemetryRule + x-cfn-type-name: AWS::ObservabilityAdmin::OrganizationTelemetryRule + x-identifiers: + - RuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationTelemetryRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ObservabilityAdmin::OrganizationTelemetryRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ObservabilityAdmin::OrganizationTelemetryRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ObservabilityAdmin::OrganizationTelemetryRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organization_telemetry_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organization_telemetry_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/organization_telemetry_rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RuleName') as rule_name, + JSON_EXTRACT(Properties, '$.Rule') as rule, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ObservabilityAdmin::OrganizationTelemetryRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'Rule') as rule, + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ObservabilityAdmin::OrganizationTelemetryRule' + AND data__Identifier = '' + AND region = 'us-east-1' + organization_telemetry_rules_list_only: + name: organization_telemetry_rules_list_only + id: awscc.observabilityadmin.organization_telemetry_rules_list_only + x-cfn-schema-name: OrganizationTelemetryRule + x-cfn-type-name: AWS::ObservabilityAdmin::OrganizationTelemetryRule + x-identifiers: + - RuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ObservabilityAdmin::OrganizationTelemetryRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ObservabilityAdmin::OrganizationTelemetryRule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TelemetryRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTelemetryRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTelemetryRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationTelemetryRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationTelemetryRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationTelemetryRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/odb.yaml b/providers/src/awscc/v00.00.00000/services/odb.yaml new file mode 100644 index 00000000..97ebf2a6 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/odb.yaml @@ -0,0 +1,2888 @@ +openapi: 3.0.0 +info: + title: ODB + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + MaintenanceWindow: + description: The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. + type: object + additionalProperties: false + properties: + DaysOfWeek: + type: array + description: The days of the week when maintenance can be performed. + uniqueItems: false + items: + type: string + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + HoursOfDay: + type: array + description: The hours of the day when maintenance can be performed. + uniqueItems: false + items: + type: integer + LeadTimeInWeeks: + type: integer + description: The lead time in weeks before the maintenance window. + minLength: 1 + maxLength: 4 + Months: + type: array + description: The months when maintenance can be performed. + uniqueItems: false + items: + type: string + enum: + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + Preference: + type: string + description: The preference for the maintenance window scheduling. + enum: + - NO_PREFERENCE + - CUSTOM_PREFERENCE + WeeksOfMonth: + type: array + description: The weeks of the month when maintenance can be performed. + uniqueItems: false + items: + type: integer + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that''s 1 to 128 Unicode characters in length and can''t be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, @, -, and ".' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that''s 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Key + CloudAutonomousVmCluster: + type: object + properties: + CloudAutonomousVmClusterId: + type: string + description: The unique identifier of the Autonomous VM cluster. + CloudAutonomousVmClusterArn: + type: string + description: The Amazon Resource Name (ARN) for the Autonomous VM cluster. + OdbNetworkId: + type: string + description: The unique identifier of the ODB network associated with this Autonomous VM cluster. + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor associated with this Autonomous VM cluster. + DisplayName: + type: string + description: The display name of the Autonomous VM cluster. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + CloudExadataInfrastructureId: + type: string + description: The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster. + AutonomousDataStoragePercentage: + type: number + description: The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster. + AutonomousDataStorageSizeInTBs: + type: number + description: The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB. + AvailableAutonomousDataStorageSizeInTBs: + type: number + description: The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB. + AvailableContainerDatabases: + type: integer + description: The number of Autonomous CDBs that you can create with the currently available storage. + AvailableCpus: + type: number + description: The number of CPU cores available for allocation to Autonomous Databases. + ComputeModel: + type: string + description: 'The compute model of the Autonomous VM cluster: ECPU or OCPU.' + enum: + - ECPU + - OCPU + CpuCoreCount: + type: integer + description: The total number of CPU cores in the Autonomous VM cluster. + CpuCoreCountPerNode: + type: integer + description: The number of CPU cores enabled per node in the Autonomous VM cluster. + CpuPercentage: + type: number + description: The percentage of total CPU cores currently in use in the Autonomous VM cluster. + DataStorageSizeInGBs: + type: number + description: The total data storage allocated to the Autonomous VM cluster, in GB. + DataStorageSizeInTBs: + type: number + description: The total data storage allocated to the Autonomous VM cluster, in TB. + DbNodeStorageSizeInGBs: + type: integer + description: The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB). + DbServers: + type: array + description: The list of database servers associated with the Autonomous VM cluster. + uniqueItems: false + items: + type: string + Description: + type: string + description: The user-provided description of the Autonomous VM cluster. + Domain: + type: string + description: The domain name for the Autonomous VM cluster. + ExadataStorageInTBsLowestScaledValue: + type: number + description: The minimum value to which you can scale down the Exadata storage, in TB. + Hostname: + type: string + description: The hostname for the Autonomous VM cluster. + Ocid: + type: string + description: The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster. + OciUrl: + type: string + description: The URL for accessing the OCI console page for this Autonomous VM cluster. + IsMtlsEnabledVmCluster: + type: boolean + description: Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster. + LicenseModel: + type: string + description: The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE. + enum: + - BRING_YOUR_OWN_LICENSE + - LICENSE_INCLUDED + MaintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + description: The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. + MaxAcdsLowestScaledValue: + type: integer + description: The minimum value to which you can scale down the maximum number of Autonomous CDBs. + MemoryPerOracleComputeUnitInGBs: + type: integer + description: The amount of memory allocated per Oracle Compute Unit, in GB. + MemorySizeInGBs: + type: integer + description: The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB). + NodeCount: + type: integer + description: The number of database server nodes in the Autonomous VM cluster. + NonProvisionableAutonomousContainerDatabases: + type: integer + description: The number of Autonomous CDBs that can't be provisioned because of resource constraints. + ProvisionableAutonomousContainerDatabases: + type: integer + description: The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster. + ProvisionedAutonomousContainerDatabases: + type: integer + description: The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster. + ProvisionedCpus: + type: number + description: The number of CPU cores currently provisioned in the Autonomous VM cluster. + ReclaimableCpus: + type: number + description: The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases. + ReservedCpus: + type: number + description: The number of CPU cores reserved for system operations and redundancy. + ScanListenerPortNonTls: + type: integer + description: The SCAN listener port for non-TLS (TCP) protocol. The default is 1521. + minimum: 1024 + maximum: 8999 + ScanListenerPortTls: + type: integer + description: The SCAN listener port for TLS (TCP) protocol. The default is 2484. + minimum: 1024 + maximum: 8999 + Shape: + type: string + description: The shape of the Exadata infrastructure for the Autonomous VM cluster. + Tags: + type: array + description: The tags associated with the Autonomous VM cluster. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TimeZone: + type: string + description: The time zone of the Autonomous VM cluster. + minLength: 1 + maxLength: 255 + TotalContainerDatabases: + type: integer + description: The total number of Autonomous Container Databases that can be created with the allocated local storage. + x-stackql-resource-name: cloud_autonomous_vm_cluster + description: The AWS::ODB::CloudAutonomousVmCluster resource creates a Cloud Autonomous VM Cluster + x-type-name: AWS::ODB::CloudAutonomousVmCluster + x-stackql-primary-identifier: + - CloudAutonomousVmClusterArn + x-create-only-properties: + - OdbNetworkId + - CloudExadataInfrastructureId + - DbServers + - IsMtlsEnabledVmCluster + - MemoryPerOracleComputeUnitInGBs + - ScanListenerPortNonTls + - ScanListenerPortTls + - TimeZone + - AutonomousDataStorageSizeInTBs + - DisplayName + - CpuCoreCountPerNode + - Description + - LicenseModel + - MaintenanceWindow + - TotalContainerDatabases + x-read-only-properties: + - CloudAutonomousVmClusterId + - CloudAutonomousVmClusterArn + - OciResourceAnchorName + - AutonomousDataStoragePercentage + - AvailableAutonomousDataStorageSizeInTBs + - AvailableContainerDatabases + - AvailableCpus + - ComputeModel + - CpuCoreCount + - CpuPercentage + - DataStorageSizeInGBs + - DataStorageSizeInTBs + - DbNodeStorageSizeInGBs + - Domain + - ExadataStorageInTBsLowestScaledValue + - Hostname + - Ocid + - OciUrl + - MaxAcdsLowestScaledValue + - MemorySizeInGBs + - NodeCount + - NonProvisionableAutonomousContainerDatabases + - ProvisionableAutonomousContainerDatabases + - ProvisionedAutonomousContainerDatabases + - ProvisionedCpus + - ReclaimableCpus + - ReservedCpus + - Shape + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - odb:TagResource + - odb:UntagResource + - odb:ListTagsForResource + x-required-permissions: + create: + - ec2:DescribeAvailabilityZones + - iam:CreateServiceLinkedRole + - odb:CreateCloudAutonomousVmCluster + - odb:GetCloudAutonomousVmCluster + - odb:ListCloudAutonomousVmClusters + - odb:ListTagsForResource + - odb:TagResource + - sts:GetCallerIdentity + read: + - odb:GetCloudAutonomousVmCluster + - odb:ListTagsForResource + - sts:GetCallerIdentity + update: + - odb:TagResource + - odb:UntagResource + - odb:GetCloudAutonomousVmCluster + - odb:ListCloudAutonomousVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + delete: + - odb:DeleteCloudAutonomousVmCluster + - odb:GetCloudAutonomousVmCluster + - odb:ListCloudAutonomousVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + list: + - odb:ListCloudAutonomousVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + CustomerContact: + type: object + description: A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure. + additionalProperties: false + properties: + Email: + type: string + description: The email address of the contact. + CloudExadataInfrastructure: + type: object + properties: + ActivatedStorageCount: + type: integer + description: The number of storage servers requested for the Exadata infrastructure. + AdditionalStorageCount: + type: integer + description: The number of storage servers requested for the Exadata infrastructure. + AvailabilityZone: + type: string + description: The name of the Availability Zone (AZ) where the Exadata infrastructure is located. + minLength: 1 + maxLength: 255 + AvailabilityZoneId: + type: string + description: The AZ ID of the AZ where the Exadata infrastructure is located. + minLength: 1 + maxLength: 255 + AvailableStorageSizeInGBs: + type: integer + description: The amount of available storage, in gigabytes (GB), for the Exadata infrastructure. + CloudExadataInfrastructureArn: + type: string + description: The Amazon Resource Name (ARN) for the Exadata infrastructure. + CloudExadataInfrastructureId: + type: string + description: The unique identifier for the Exadata infrastructure. + ComputeCount: + type: integer + description: The number of database servers for the Exadata infrastructure. + ComputeModel: + type: string + description: 'The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.' + CpuCount: + type: integer + description: The total number of CPU cores that are allocated to the Exadata infrastructure. + CustomerContactsToSendToOCI: + type: array + description: The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/CustomerContact' + DataStorageSizeInTBs: + type: number + description: The size of the Exadata infrastructure's data disk group, in terabytes (TB). + DatabaseServerType: + type: string + description: The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. + pattern: ^[a-zA-Z0-9_\/.=-]+$ + minLength: 1 + maxLength: 255 + DbNodeStorageSizeInGBs: + type: integer + description: The size of the Exadata infrastructure's local node storage, in gigabytes (GB). + DbServerVersion: + type: string + description: The software version of the database servers (dom0) in the Exadata infrastructure. + DisplayName: + type: string + description: The user-friendly name for the Exadata infrastructure. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + MaxCpuCount: + type: integer + description: The total number of CPU cores available on the Exadata infrastructure. + MaxDataStorageInTBs: + type: number + description: The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure. + MaxDbNodeStorageSizeInGBs: + type: integer + description: The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure. + MaxMemoryInGBs: + type: integer + description: The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure. + MemorySizeInGBs: + type: integer + description: The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure. + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor for the Exadata infrastructure. + OciUrl: + type: string + description: The HTTPS link to the Exadata infrastructure in OCI. + Ocid: + type: string + description: The OCID of the Exadata infrastructure. + Shape: + type: string + description: The model name of the Exadata infrastructure. + pattern: ^[a-zA-Z0-9_\/.=-]+$ + minLength: 1 + maxLength: 255 + StorageCount: + type: integer + description: The number of storage servers that are activated for the Exadata infrastructure. + StorageServerType: + type: string + description: The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. + pattern: ^[a-zA-Z0-9_\/.=-]+$ + minLength: 1 + maxLength: 255 + StorageServerVersion: + type: string + description: The software version of the storage servers on the Exadata infrastructure. + Tags: + type: array + description: Tags to assign to the Exadata Infrastructure. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TotalStorageSizeInGBs: + type: integer + description: The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure. + DbServerIds: + type: array + description: The list of database server identifiers for the Exadata infrastructure. + x-insertionOrder: false + uniqueItems: false + items: + type: string + x-stackql-resource-name: cloud_exadata_infrastructure + description: The AWS::ODB::CloudExadataInfrastructure resource creates an Exadata Infrastructure + x-type-name: AWS::ODB::CloudExadataInfrastructure + x-stackql-primary-identifier: + - CloudExadataInfrastructureArn + x-create-only-properties: + - AvailabilityZone + - AvailabilityZoneId + - Shape + - DatabaseServerType + - StorageServerType + - DisplayName + - ComputeCount + - CustomerContactsToSendToOCI + - StorageCount + x-read-only-properties: + - ActivatedStorageCount + - AdditionalStorageCount + - AvailableStorageSizeInGBs + - CloudExadataInfrastructureArn + - CloudExadataInfrastructureId + - ComputeModel + - CpuCount + - DataStorageSizeInTBs + - DbNodeStorageSizeInGBs + - DbServerVersion + - MaxCpuCount + - MaxDataStorageInTBs + - MaxDbNodeStorageSizeInGBs + - MaxMemoryInGBs + - MemorySizeInGBs + - OciResourceAnchorName + - OciUrl + - Ocid + - StorageServerVersion + - TotalStorageSizeInGBs + - DbServerIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - odb:TagResource + - odb:UntagResource + - odb:ListTagsForResource + x-required-permissions: + create: + - odb:CreateCloudExadataInfrastructure + - ec2:DescribeAvailabilityZones + - iam:CreateServiceLinkedRole + - odb:ListCloudExadataInfrastructures + - odb:GetCloudExadataInfrastructure + - odb:ListDbServers + - odb:TagResource + - sts:GetCallerIdentity + - odb:ListTagsForResource + read: + - odb:GetCloudExadataInfrastructure + - odb:ListDbServers + - sts:GetCallerIdentity + - odb:ListTagsForResource + update: + - odb:UpdateCloudExadataInfrastructure + - odb:TagResource + - odb:UntagResource + - odb:ListCloudExadataInfrastructures + - odb:GetCloudExadataInfrastructure + - odb:ListDbServers + - sts:GetCallerIdentity + - odb:ListTagsForResource + delete: + - odb:DeleteCloudExadataInfrastructure + - odb:ListCloudExadataInfrastructures + - odb:GetCloudExadataInfrastructure + - odb:ListDbServers + - sts:GetCallerIdentity + - odb:ListTagsForResource + list: + - odb:ListCloudExadataInfrastructures + - sts:GetCallerIdentity + - odb:ListTagsForResource + - odb:ListDbServers + DataCollectionOptions: + description: Information about the data collection options enabled for a VM cluster. + type: object + additionalProperties: false + properties: + IsDiagnosticsEventsEnabled: + type: boolean + description: Indicates whether diagnostic collection is enabled for the VM cluster. + IsHealthMonitoringEnabled: + type: boolean + description: Indicates whether health monitoring is enabled for the VM cluster. + IsIncidentLogsEnabled: + type: boolean + description: Indicates whether incident logs are enabled for the cloud VM cluster. + CloudVmCluster: + type: object + properties: + CloudExadataInfrastructureId: + type: string + description: The unique identifier of the Exadata infrastructure that this VM cluster belongs to. + CloudVmClusterArn: + type: string + description: The Amazon Resource Name (ARN) of the VM cluster. + CloudVmClusterId: + type: string + description: The unique identifier of the VM cluster. + ClusterName: + type: string + description: The name of the Grid Infrastructure (GI) cluster. + pattern: ^[a-zA-Z][a-zA-Z0-9-]*$ + minLength: 1 + maxLength: 11 + ComputeModel: + type: string + description: 'The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.' + CpuCoreCount: + type: integer + description: The number of CPU cores enabled on the VM cluster. + minimum: 0 + maximum: 368 + DataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + description: The set of diagnostic collection options enabled for the VM cluster. + DataStorageSizeInTBs: + type: number + description: The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster. + DbNodeStorageSizeInGBs: + type: integer + description: The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster. + DbServers: + type: array + description: The list of database servers for the VM cluster. + uniqueItems: false + items: + type: string + DisplayName: + type: string + description: The user-friendly name for the VM cluster. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + DiskRedundancy: + type: string + description: The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. + Domain: + type: string + description: The domain of the VM cluster. + GiVersion: + type: string + description: The software version of the Oracle Grid Infrastructure (GI) for the VM cluster. + minLength: 1 + maxLength: 255 + Hostname: + type: string + description: The host name for the VM cluster. + pattern: ^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$ + minLength: 1 + maxLength: 12 + IsLocalBackupEnabled: + type: boolean + description: Indicates whether database backups to local Exadata storage is enabled for the VM cluster. + IsSparseDiskgroupEnabled: + type: boolean + description: Indicates whether the VM cluster is configured with a sparse disk group. + LicenseModel: + type: string + description: The Oracle license model applied to the VM cluster. + enum: + - BRING_YOUR_OWN_LICENSE + - LICENSE_INCLUDED + ListenerPort: + type: integer + description: The port number configured for the listener on the VM cluster. + MemorySizeInGBs: + type: integer + description: The amount of memory, in gigabytes (GB), that's allocated for the VM cluster. + NodeCount: + type: integer + description: The number of nodes in the VM cluster. + OdbNetworkId: + type: string + description: The unique identifier of the ODB network for the VM cluster. + Ocid: + type: string + description: The OCID of the VM cluster. + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor for the VM cluster. + OciUrl: + type: string + description: The HTTPS link to the VM cluster in OCI. + ScanDnsName: + type: string + description: The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster. + ScanIpIds: + type: array + description: The OCID of the SCAN IP addresses that are associated with the VM cluster. + uniqueItems: false + items: + type: string + ScanListenerPortTcp: + type: integer + description: Property description not available. + minimum: 1024 + maximum: 8999 + Shape: + type: string + description: The hardware model name of the Exadata infrastructure that's running the VM cluster. + SshPublicKeys: + type: array + description: The public key portion of one or more key pairs used for SSH access to the VM cluster. + uniqueItems: false + items: + type: string + StorageSizeInGBs: + type: integer + description: The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster. + SystemVersion: + type: string + description: The operating system version of the image chosen for the VM cluster. + minLength: 1 + maxLength: 255 + Tags: + type: array + description: Tags to assign to the Vm Cluster. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TimeZone: + type: string + description: The time zone of the VM cluster. + minLength: 1 + maxLength: 255 + VipIds: + type: array + description: The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + uniqueItems: false + items: + type: string + x-stackql-resource-name: cloud_vm_cluster + description: The AWS::ODB::CloudVmCluster resource creates a Cloud VM Cluster + x-type-name: AWS::ODB::CloudVmCluster + x-stackql-primary-identifier: + - CloudVmClusterArn + x-create-only-properties: + - CloudExadataInfrastructureId + - DataCollectionOptions + - DataStorageSizeInTBs + - DbNodeStorageSizeInGBs + - OdbNetworkId + - GiVersion + - ClusterName + - DbServers + - LicenseModel + - Hostname + - IsLocalBackupEnabled + - IsSparseDiskgroupEnabled + - SystemVersion + - TimeZone + - ScanListenerPortTcp + - SshPublicKeys + - CpuCoreCount + - DisplayName + - MemorySizeInGBs + x-write-only-properties: + - ScanListenerPortTcp + x-read-only-properties: + - CloudVmClusterArn + - CloudVmClusterId + - ComputeModel + - DiskRedundancy + - Domain + - ListenerPort + - NodeCount + - Ocid + - OciResourceAnchorName + - OciUrl + - ScanDnsName + - ScanIpIds + - Shape + - StorageSizeInGBs + - VipIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - odb:TagResource + - odb:UntagResource + - odb:ListTagsForResource + x-required-permissions: + create: + - odb:CreateCloudVmCluster + - odb:TagResource + - odb:GetCloudVmCluster + - odb:ListCloudVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + - ec2:DescribeAvailabilityZones + - odb:CreateDbNode + read: + - odb:GetCloudVmCluster + - odb:ListTagsForResource + - sts:GetCallerIdentity + update: + - odb:TagResource + - odb:UntagResource + - odb:GetCloudVmCluster + - odb:ListCloudVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + delete: + - odb:DeleteCloudVmCluster + - odb:GetCloudVmCluster + - odb:ListCloudVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + - odb:DeleteDbNode + list: + - odb:ListCloudVmClusters + - odb:ListTagsForResource + - sts:GetCallerIdentity + OdbNetwork: + type: object + properties: + AvailabilityZone: + type: string + description: The AWS Availability Zone (AZ) where the ODB network is located. + minLength: 1 + maxLength: 255 + AvailabilityZoneId: + type: string + description: The AZ ID of the AZ where the ODB network is located. + minLength: 1 + maxLength: 255 + BackupSubnetCidr: + type: string + description: The CIDR range of the backup subnet in the ODB network. + minLength: 1 + maxLength: 255 + ClientSubnetCidr: + type: string + description: The CIDR range of the client subnet in the ODB network. + minLength: 1 + maxLength: 255 + DefaultDnsPrefix: + type: string + description: The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com. + minLength: 1 + maxLength: 255 + DeleteAssociatedResources: + type: boolean + description: Specifies whether to delete associated OCI networking resources along with the ODB network. + DisplayName: + type: string + description: The user-friendly name of the ODB network. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + OciNetworkAnchorId: + type: string + description: The unique identifier of the OCI network anchor for the ODB network. + minLength: 1 + maxLength: 255 + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor that's associated with the ODB network. + OciVcnUrl: + type: string + description: The URL for the VCN that's associated with the ODB network. + OdbNetworkArn: + type: string + description: The Amazon Resource Name (ARN) of the ODB network. + OdbNetworkId: + type: string + description: The unique identifier of the ODB network. + Tags: + type: array + description: Tags to assign to the Odb Network. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: odb_network + description: The AWS::ODB::OdbNetwork resource creates an ODB Network + x-type-name: AWS::ODB::OdbNetwork + x-stackql-primary-identifier: + - OdbNetworkArn + x-create-only-properties: + - AvailabilityZone + - AvailabilityZoneId + - BackupSubnetCidr + - ClientSubnetCidr + - DefaultDnsPrefix + - DisplayName + x-write-only-properties: + - DeleteAssociatedResources + - DefaultDnsPrefix + x-read-only-properties: + - OciNetworkAnchorId + - OciResourceAnchorName + - OciVcnUrl + - OdbNetworkArn + - OdbNetworkId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - odb:TagResource + - odb:UntagResource + - odb:ListTagsForResource + x-required-permissions: + create: + - odb:CreateOdbNetwork + - odb:TagResource + - ec2:DescribeAvailabilityZones + - iam:CreateServiceLinkedRole + - ec2:DescribeVpcs + - ec2:CreateOdbNetworkPeering + - odb:ListTagsForResource + - sts:GetCallerIdentity + - odb:GetOdbNetwork + - odb:ListOdbNetworks + - odb:UpdateOdbNetwork + - vpc-lattice:CreateServiceNetwork + - vpc-lattice:GetServiceNetwork + - vpc-lattice:CreateServiceNetworkResourceAssociation + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:CreateResourceGateway + - vpc-lattice:GetResourceGateway + - vpc-lattice:CreateServiceNetworkVpcEndpointAssociation + - redshiftchannelmanagement:CreateChannel + - ec2:ModifyOdbNetworkPeering + - ec2:DescribeVpcEndpointAssociations + - ec2:CreateVpcEndpoint + - ec2:DescribeVpcEndpoints + - ec2:CreateTags + read: + - odb:GetOdbNetwork + - odb:ListOdbNetworks + - odb:ListTagsForResource + - sts:GetCallerIdentity + - vpc-lattice:GetServiceNetwork + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:GetResourceGateway + - ec2:DescribeVpcEndpointAssociations + - ec2:DescribeVpcEndpoints + update: + - odb:UpdateOdbNetwork + - odb:TagResource + - odb:UntagResource + - ec2:DescribeVpcs + - ec2:CreateOdbNetworkPeering + - ec2:DeleteOdbNetworkPeering + - odb:ListTagsForResource + - sts:GetCallerIdentity + - odb:GetOdbNetwork + - odb:ListOdbNetworks + - vpc-lattice:GetServiceNetwork + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:GetResourceGateway + - ec2:DescribeVpcEndpointAssociations + - ec2:DescribeVpcEndpoints + delete: + - odb:DeleteOdbNetwork + - ec2:DeleteOdbNetworkPeering + - ec2:DescribeVpcs + - odb:ListTagsForResource + - sts:GetCallerIdentity + - odb:GetOdbNetwork + - odb:ListOdbNetworks + - vpc-lattice:DeleteServiceNetwork + - vpc-lattice:GetServiceNetwork + - vpc-lattice:DeleteServiceNetworkResourceAssociation + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:DeleteResourceGateway + - vpc-lattice:GetResourceGateway + - ec2:ModifyOdbNetworkPeering + - ec2:DescribeVpcEndpointAssociations + - ec2:DeleteVpcEndpoints + - ec2:DescribeVpcEndpoints + list: + - odb:ListOdbNetworks + - odb:ListTagsForResource + - sts:GetCallerIdentity + - vpc-lattice:GetServiceNetwork + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:GetResourceGateway + - ec2:DescribeVpcEndpointAssociations + - ec2:DescribeVpcEndpoints + CreateCloudAutonomousVmClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CloudAutonomousVmClusterId: + type: string + description: The unique identifier of the Autonomous VM cluster. + CloudAutonomousVmClusterArn: + type: string + description: The Amazon Resource Name (ARN) for the Autonomous VM cluster. + OdbNetworkId: + type: string + description: The unique identifier of the ODB network associated with this Autonomous VM cluster. + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor associated with this Autonomous VM cluster. + DisplayName: + type: string + description: The display name of the Autonomous VM cluster. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + CloudExadataInfrastructureId: + type: string + description: The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster. + AutonomousDataStoragePercentage: + type: number + description: The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster. + AutonomousDataStorageSizeInTBs: + type: number + description: The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB. + AvailableAutonomousDataStorageSizeInTBs: + type: number + description: The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB. + AvailableContainerDatabases: + type: integer + description: The number of Autonomous CDBs that you can create with the currently available storage. + AvailableCpus: + type: number + description: The number of CPU cores available for allocation to Autonomous Databases. + ComputeModel: + type: string + description: 'The compute model of the Autonomous VM cluster: ECPU or OCPU.' + enum: + - ECPU + - OCPU + CpuCoreCount: + type: integer + description: The total number of CPU cores in the Autonomous VM cluster. + CpuCoreCountPerNode: + type: integer + description: The number of CPU cores enabled per node in the Autonomous VM cluster. + CpuPercentage: + type: number + description: The percentage of total CPU cores currently in use in the Autonomous VM cluster. + DataStorageSizeInGBs: + type: number + description: The total data storage allocated to the Autonomous VM cluster, in GB. + DataStorageSizeInTBs: + type: number + description: The total data storage allocated to the Autonomous VM cluster, in TB. + DbNodeStorageSizeInGBs: + type: integer + description: The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB). + DbServers: + type: array + description: The list of database servers associated with the Autonomous VM cluster. + uniqueItems: false + items: + type: string + Description: + type: string + description: The user-provided description of the Autonomous VM cluster. + Domain: + type: string + description: The domain name for the Autonomous VM cluster. + ExadataStorageInTBsLowestScaledValue: + type: number + description: The minimum value to which you can scale down the Exadata storage, in TB. + Hostname: + type: string + description: The hostname for the Autonomous VM cluster. + Ocid: + type: string + description: The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster. + OciUrl: + type: string + description: The URL for accessing the OCI console page for this Autonomous VM cluster. + IsMtlsEnabledVmCluster: + type: boolean + description: Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster. + LicenseModel: + type: string + description: The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE. + enum: + - BRING_YOUR_OWN_LICENSE + - LICENSE_INCLUDED + MaintenanceWindow: + $ref: '#/components/schemas/MaintenanceWindow' + description: The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. + MaxAcdsLowestScaledValue: + type: integer + description: The minimum value to which you can scale down the maximum number of Autonomous CDBs. + MemoryPerOracleComputeUnitInGBs: + type: integer + description: The amount of memory allocated per Oracle Compute Unit, in GB. + MemorySizeInGBs: + type: integer + description: The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB). + NodeCount: + type: integer + description: The number of database server nodes in the Autonomous VM cluster. + NonProvisionableAutonomousContainerDatabases: + type: integer + description: The number of Autonomous CDBs that can't be provisioned because of resource constraints. + ProvisionableAutonomousContainerDatabases: + type: integer + description: The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster. + ProvisionedAutonomousContainerDatabases: + type: integer + description: The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster. + ProvisionedCpus: + type: number + description: The number of CPU cores currently provisioned in the Autonomous VM cluster. + ReclaimableCpus: + type: number + description: The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases. + ReservedCpus: + type: number + description: The number of CPU cores reserved for system operations and redundancy. + ScanListenerPortNonTls: + type: integer + description: The SCAN listener port for non-TLS (TCP) protocol. The default is 1521. + minimum: 1024 + maximum: 8999 + ScanListenerPortTls: + type: integer + description: The SCAN listener port for TLS (TCP) protocol. The default is 2484. + minimum: 1024 + maximum: 8999 + Shape: + type: string + description: The shape of the Exadata infrastructure for the Autonomous VM cluster. + Tags: + type: array + description: The tags associated with the Autonomous VM cluster. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TimeZone: + type: string + description: The time zone of the Autonomous VM cluster. + minLength: 1 + maxLength: 255 + TotalContainerDatabases: + type: integer + description: The total number of Autonomous Container Databases that can be created with the allocated local storage. + x-stackQL-stringOnly: true + x-title: CreateCloudAutonomousVmClusterRequest + type: object + required: [] + CreateCloudExadataInfrastructureRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActivatedStorageCount: + type: integer + description: The number of storage servers requested for the Exadata infrastructure. + AdditionalStorageCount: + type: integer + description: The number of storage servers requested for the Exadata infrastructure. + AvailabilityZone: + type: string + description: The name of the Availability Zone (AZ) where the Exadata infrastructure is located. + minLength: 1 + maxLength: 255 + AvailabilityZoneId: + type: string + description: The AZ ID of the AZ where the Exadata infrastructure is located. + minLength: 1 + maxLength: 255 + AvailableStorageSizeInGBs: + type: integer + description: The amount of available storage, in gigabytes (GB), for the Exadata infrastructure. + CloudExadataInfrastructureArn: + type: string + description: The Amazon Resource Name (ARN) for the Exadata infrastructure. + CloudExadataInfrastructureId: + type: string + description: The unique identifier for the Exadata infrastructure. + ComputeCount: + type: integer + description: The number of database servers for the Exadata infrastructure. + ComputeModel: + type: string + description: 'The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.' + CpuCount: + type: integer + description: The total number of CPU cores that are allocated to the Exadata infrastructure. + CustomerContactsToSendToOCI: + type: array + description: The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/CustomerContact' + DataStorageSizeInTBs: + type: number + description: The size of the Exadata infrastructure's data disk group, in terabytes (TB). + DatabaseServerType: + type: string + description: The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. + pattern: ^[a-zA-Z0-9_\/.=-]+$ + minLength: 1 + maxLength: 255 + DbNodeStorageSizeInGBs: + type: integer + description: The size of the Exadata infrastructure's local node storage, in gigabytes (GB). + DbServerVersion: + type: string + description: The software version of the database servers (dom0) in the Exadata infrastructure. + DisplayName: + type: string + description: The user-friendly name for the Exadata infrastructure. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + MaxCpuCount: + type: integer + description: The total number of CPU cores available on the Exadata infrastructure. + MaxDataStorageInTBs: + type: number + description: The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure. + MaxDbNodeStorageSizeInGBs: + type: integer + description: The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure. + MaxMemoryInGBs: + type: integer + description: The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure. + MemorySizeInGBs: + type: integer + description: The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure. + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor for the Exadata infrastructure. + OciUrl: + type: string + description: The HTTPS link to the Exadata infrastructure in OCI. + Ocid: + type: string + description: The OCID of the Exadata infrastructure. + Shape: + type: string + description: The model name of the Exadata infrastructure. + pattern: ^[a-zA-Z0-9_\/.=-]+$ + minLength: 1 + maxLength: 255 + StorageCount: + type: integer + description: The number of storage servers that are activated for the Exadata infrastructure. + StorageServerType: + type: string + description: The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. + pattern: ^[a-zA-Z0-9_\/.=-]+$ + minLength: 1 + maxLength: 255 + StorageServerVersion: + type: string + description: The software version of the storage servers on the Exadata infrastructure. + Tags: + type: array + description: Tags to assign to the Exadata Infrastructure. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TotalStorageSizeInGBs: + type: integer + description: The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure. + DbServerIds: + type: array + description: The list of database server identifiers for the Exadata infrastructure. + x-insertionOrder: false + uniqueItems: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateCloudExadataInfrastructureRequest + type: object + required: [] + CreateCloudVmClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CloudExadataInfrastructureId: + type: string + description: The unique identifier of the Exadata infrastructure that this VM cluster belongs to. + CloudVmClusterArn: + type: string + description: The Amazon Resource Name (ARN) of the VM cluster. + CloudVmClusterId: + type: string + description: The unique identifier of the VM cluster. + ClusterName: + type: string + description: The name of the Grid Infrastructure (GI) cluster. + pattern: ^[a-zA-Z][a-zA-Z0-9-]*$ + minLength: 1 + maxLength: 11 + ComputeModel: + type: string + description: 'The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.' + CpuCoreCount: + type: integer + description: The number of CPU cores enabled on the VM cluster. + minimum: 0 + maximum: 368 + DataCollectionOptions: + $ref: '#/components/schemas/DataCollectionOptions' + description: The set of diagnostic collection options enabled for the VM cluster. + DataStorageSizeInTBs: + type: number + description: The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster. + DbNodeStorageSizeInGBs: + type: integer + description: The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster. + DbServers: + type: array + description: The list of database servers for the VM cluster. + uniqueItems: false + items: + type: string + DisplayName: + type: string + description: The user-friendly name for the VM cluster. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + DiskRedundancy: + type: string + description: The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. + Domain: + type: string + description: The domain of the VM cluster. + GiVersion: + type: string + description: The software version of the Oracle Grid Infrastructure (GI) for the VM cluster. + minLength: 1 + maxLength: 255 + Hostname: + type: string + description: The host name for the VM cluster. + pattern: ^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$ + minLength: 1 + maxLength: 12 + IsLocalBackupEnabled: + type: boolean + description: Indicates whether database backups to local Exadata storage is enabled for the VM cluster. + IsSparseDiskgroupEnabled: + type: boolean + description: Indicates whether the VM cluster is configured with a sparse disk group. + LicenseModel: + type: string + description: The Oracle license model applied to the VM cluster. + enum: + - BRING_YOUR_OWN_LICENSE + - LICENSE_INCLUDED + ListenerPort: + type: integer + description: The port number configured for the listener on the VM cluster. + MemorySizeInGBs: + type: integer + description: The amount of memory, in gigabytes (GB), that's allocated for the VM cluster. + NodeCount: + type: integer + description: The number of nodes in the VM cluster. + OdbNetworkId: + type: string + description: The unique identifier of the ODB network for the VM cluster. + Ocid: + type: string + description: The OCID of the VM cluster. + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor for the VM cluster. + OciUrl: + type: string + description: The HTTPS link to the VM cluster in OCI. + ScanDnsName: + type: string + description: The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster. + ScanIpIds: + type: array + description: The OCID of the SCAN IP addresses that are associated with the VM cluster. + uniqueItems: false + items: + type: string + ScanListenerPortTcp: + type: integer + description: Property description not available. + minimum: 1024 + maximum: 8999 + Shape: + type: string + description: The hardware model name of the Exadata infrastructure that's running the VM cluster. + SshPublicKeys: + type: array + description: The public key portion of one or more key pairs used for SSH access to the VM cluster. + uniqueItems: false + items: + type: string + StorageSizeInGBs: + type: integer + description: The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster. + SystemVersion: + type: string + description: The operating system version of the image chosen for the VM cluster. + minLength: 1 + maxLength: 255 + Tags: + type: array + description: Tags to assign to the Vm Cluster. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + TimeZone: + type: string + description: The time zone of the VM cluster. + minLength: 1 + maxLength: 255 + VipIds: + type: array + description: The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. + uniqueItems: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateCloudVmClusterRequest + type: object + required: [] + CreateOdbNetworkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AvailabilityZone: + type: string + description: The AWS Availability Zone (AZ) where the ODB network is located. + minLength: 1 + maxLength: 255 + AvailabilityZoneId: + type: string + description: The AZ ID of the AZ where the ODB network is located. + minLength: 1 + maxLength: 255 + BackupSubnetCidr: + type: string + description: The CIDR range of the backup subnet in the ODB network. + minLength: 1 + maxLength: 255 + ClientSubnetCidr: + type: string + description: The CIDR range of the client subnet in the ODB network. + minLength: 1 + maxLength: 255 + DefaultDnsPrefix: + type: string + description: The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com. + minLength: 1 + maxLength: 255 + DeleteAssociatedResources: + type: boolean + description: Specifies whether to delete associated OCI networking resources along with the ODB network. + DisplayName: + type: string + description: The user-friendly name of the ODB network. + pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$ + minLength: 1 + maxLength: 255 + OciNetworkAnchorId: + type: string + description: The unique identifier of the OCI network anchor for the ODB network. + minLength: 1 + maxLength: 255 + OciResourceAnchorName: + type: string + description: The name of the OCI resource anchor that's associated with the ODB network. + OciVcnUrl: + type: string + description: The URL for the VCN that's associated with the ODB network. + OdbNetworkArn: + type: string + description: The Amazon Resource Name (ARN) of the ODB network. + OdbNetworkId: + type: string + description: The unique identifier of the ODB network. + Tags: + type: array + description: Tags to assign to the Odb Network. + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOdbNetworkRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + cloud_autonomous_vm_clusters: + name: cloud_autonomous_vm_clusters + id: awscc.odb.cloud_autonomous_vm_clusters + x-cfn-schema-name: CloudAutonomousVmCluster + x-cfn-type-name: AWS::ODB::CloudAutonomousVmCluster + x-identifiers: + - CloudAutonomousVmClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudAutonomousVmCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudAutonomousVmCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudAutonomousVmCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudAutonomousVmCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_autonomous_vm_clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CloudAutonomousVmClusterId') as cloud_autonomous_vm_cluster_id, + JSON_EXTRACT(Properties, '$.CloudAutonomousVmClusterArn') as cloud_autonomous_vm_cluster_arn, + JSON_EXTRACT(Properties, '$.OdbNetworkId') as odb_network_id, + JSON_EXTRACT(Properties, '$.OciResourceAnchorName') as oci_resource_anchor_name, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.CloudExadataInfrastructureId') as cloud_exadata_infrastructure_id, + JSON_EXTRACT(Properties, '$.AutonomousDataStoragePercentage') as autonomous_data_storage_percentage, + JSON_EXTRACT(Properties, '$.AutonomousDataStorageSizeInTBs') as autonomous_data_storage_size_in_tbs, + JSON_EXTRACT(Properties, '$.AvailableAutonomousDataStorageSizeInTBs') as available_autonomous_data_storage_size_in_tbs, + JSON_EXTRACT(Properties, '$.AvailableContainerDatabases') as available_container_databases, + JSON_EXTRACT(Properties, '$.AvailableCpus') as available_cpus, + JSON_EXTRACT(Properties, '$.ComputeModel') as compute_model, + JSON_EXTRACT(Properties, '$.CpuCoreCount') as cpu_core_count, + JSON_EXTRACT(Properties, '$.CpuCoreCountPerNode') as cpu_core_count_per_node, + JSON_EXTRACT(Properties, '$.CpuPercentage') as cpu_percentage, + JSON_EXTRACT(Properties, '$.DataStorageSizeInGBs') as data_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.DataStorageSizeInTBs') as data_storage_size_in_tbs, + JSON_EXTRACT(Properties, '$.DbNodeStorageSizeInGBs') as db_node_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.DbServers') as db_servers, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.ExadataStorageInTBsLowestScaledValue') as exadata_storage_in_tbs_lowest_scaled_value, + JSON_EXTRACT(Properties, '$.Hostname') as hostname, + JSON_EXTRACT(Properties, '$.Ocid') as ocid, + JSON_EXTRACT(Properties, '$.OciUrl') as oci_url, + JSON_EXTRACT(Properties, '$.IsMtlsEnabledVmCluster') as is_mtls_enabled_vm_cluster, + JSON_EXTRACT(Properties, '$.LicenseModel') as license_model, + JSON_EXTRACT(Properties, '$.MaintenanceWindow') as maintenance_window, + JSON_EXTRACT(Properties, '$.MaxAcdsLowestScaledValue') as max_acds_lowest_scaled_value, + JSON_EXTRACT(Properties, '$.MemoryPerOracleComputeUnitInGBs') as memory_per_oracle_compute_unit_in_gbs, + JSON_EXTRACT(Properties, '$.MemorySizeInGBs') as memory_size_in_gbs, + JSON_EXTRACT(Properties, '$.NodeCount') as node_count, + JSON_EXTRACT(Properties, '$.NonProvisionableAutonomousContainerDatabases') as non_provisionable_autonomous_container_databases, + JSON_EXTRACT(Properties, '$.ProvisionableAutonomousContainerDatabases') as provisionable_autonomous_container_databases, + JSON_EXTRACT(Properties, '$.ProvisionedAutonomousContainerDatabases') as provisioned_autonomous_container_databases, + JSON_EXTRACT(Properties, '$.ProvisionedCpus') as provisioned_cpus, + JSON_EXTRACT(Properties, '$.ReclaimableCpus') as reclaimable_cpus, + JSON_EXTRACT(Properties, '$.ReservedCpus') as reserved_cpus, + JSON_EXTRACT(Properties, '$.ScanListenerPortNonTls') as scan_listener_port_non_tls, + JSON_EXTRACT(Properties, '$.ScanListenerPortTls') as scan_listener_port_tls, + JSON_EXTRACT(Properties, '$.Shape') as shape, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TimeZone') as time_zone, + JSON_EXTRACT(Properties, '$.TotalContainerDatabases') as total_container_databases + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::CloudAutonomousVmCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CloudAutonomousVmClusterId') as cloud_autonomous_vm_cluster_id, + json_extract_path_text(Properties, 'CloudAutonomousVmClusterArn') as cloud_autonomous_vm_cluster_arn, + json_extract_path_text(Properties, 'OdbNetworkId') as odb_network_id, + json_extract_path_text(Properties, 'OciResourceAnchorName') as oci_resource_anchor_name, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'CloudExadataInfrastructureId') as cloud_exadata_infrastructure_id, + json_extract_path_text(Properties, 'AutonomousDataStoragePercentage') as autonomous_data_storage_percentage, + json_extract_path_text(Properties, 'AutonomousDataStorageSizeInTBs') as autonomous_data_storage_size_in_tbs, + json_extract_path_text(Properties, 'AvailableAutonomousDataStorageSizeInTBs') as available_autonomous_data_storage_size_in_tbs, + json_extract_path_text(Properties, 'AvailableContainerDatabases') as available_container_databases, + json_extract_path_text(Properties, 'AvailableCpus') as available_cpus, + json_extract_path_text(Properties, 'ComputeModel') as compute_model, + json_extract_path_text(Properties, 'CpuCoreCount') as cpu_core_count, + json_extract_path_text(Properties, 'CpuCoreCountPerNode') as cpu_core_count_per_node, + json_extract_path_text(Properties, 'CpuPercentage') as cpu_percentage, + json_extract_path_text(Properties, 'DataStorageSizeInGBs') as data_storage_size_in_gbs, + json_extract_path_text(Properties, 'DataStorageSizeInTBs') as data_storage_size_in_tbs, + json_extract_path_text(Properties, 'DbNodeStorageSizeInGBs') as db_node_storage_size_in_gbs, + json_extract_path_text(Properties, 'DbServers') as db_servers, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'ExadataStorageInTBsLowestScaledValue') as exadata_storage_in_tbs_lowest_scaled_value, + json_extract_path_text(Properties, 'Hostname') as hostname, + json_extract_path_text(Properties, 'Ocid') as ocid, + json_extract_path_text(Properties, 'OciUrl') as oci_url, + json_extract_path_text(Properties, 'IsMtlsEnabledVmCluster') as is_mtls_enabled_vm_cluster, + json_extract_path_text(Properties, 'LicenseModel') as license_model, + json_extract_path_text(Properties, 'MaintenanceWindow') as maintenance_window, + json_extract_path_text(Properties, 'MaxAcdsLowestScaledValue') as max_acds_lowest_scaled_value, + json_extract_path_text(Properties, 'MemoryPerOracleComputeUnitInGBs') as memory_per_oracle_compute_unit_in_gbs, + json_extract_path_text(Properties, 'MemorySizeInGBs') as memory_size_in_gbs, + json_extract_path_text(Properties, 'NodeCount') as node_count, + json_extract_path_text(Properties, 'NonProvisionableAutonomousContainerDatabases') as non_provisionable_autonomous_container_databases, + json_extract_path_text(Properties, 'ProvisionableAutonomousContainerDatabases') as provisionable_autonomous_container_databases, + json_extract_path_text(Properties, 'ProvisionedAutonomousContainerDatabases') as provisioned_autonomous_container_databases, + json_extract_path_text(Properties, 'ProvisionedCpus') as provisioned_cpus, + json_extract_path_text(Properties, 'ReclaimableCpus') as reclaimable_cpus, + json_extract_path_text(Properties, 'ReservedCpus') as reserved_cpus, + json_extract_path_text(Properties, 'ScanListenerPortNonTls') as scan_listener_port_non_tls, + json_extract_path_text(Properties, 'ScanListenerPortTls') as scan_listener_port_tls, + json_extract_path_text(Properties, 'Shape') as shape, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TimeZone') as time_zone, + json_extract_path_text(Properties, 'TotalContainerDatabases') as total_container_databases + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::CloudAutonomousVmCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + cloud_autonomous_vm_clusters_list_only: + name: cloud_autonomous_vm_clusters_list_only + id: awscc.odb.cloud_autonomous_vm_clusters_list_only + x-cfn-schema-name: CloudAutonomousVmCluster + x-cfn-type-name: AWS::ODB::CloudAutonomousVmCluster + x-identifiers: + - CloudAutonomousVmClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CloudAutonomousVmClusterArn') as cloud_autonomous_vm_cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::CloudAutonomousVmCluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CloudAutonomousVmClusterArn') as cloud_autonomous_vm_cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::CloudAutonomousVmCluster' + AND region = 'us-east-1' + cloud_exadata_infrastructures: + name: cloud_exadata_infrastructures + id: awscc.odb.cloud_exadata_infrastructures + x-cfn-schema-name: CloudExadataInfrastructure + x-cfn-type-name: AWS::ODB::CloudExadataInfrastructure + x-identifiers: + - CloudExadataInfrastructureArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudExadataInfrastructure&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudExadataInfrastructure" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudExadataInfrastructure" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudExadataInfrastructure" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_exadata_infrastructures/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ActivatedStorageCount') as activated_storage_count, + JSON_EXTRACT(Properties, '$.AdditionalStorageCount') as additional_storage_count, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.AvailabilityZoneId') as availability_zone_id, + JSON_EXTRACT(Properties, '$.AvailableStorageSizeInGBs') as available_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.CloudExadataInfrastructureArn') as cloud_exadata_infrastructure_arn, + JSON_EXTRACT(Properties, '$.CloudExadataInfrastructureId') as cloud_exadata_infrastructure_id, + JSON_EXTRACT(Properties, '$.ComputeCount') as compute_count, + JSON_EXTRACT(Properties, '$.ComputeModel') as compute_model, + JSON_EXTRACT(Properties, '$.CpuCount') as cpu_count, + JSON_EXTRACT(Properties, '$.CustomerContactsToSendToOCI') as customer_contacts_to_send_to_oc_i, + JSON_EXTRACT(Properties, '$.DataStorageSizeInTBs') as data_storage_size_in_tbs, + JSON_EXTRACT(Properties, '$.DatabaseServerType') as database_server_type, + JSON_EXTRACT(Properties, '$.DbNodeStorageSizeInGBs') as db_node_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.DbServerVersion') as db_server_version, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.MaxCpuCount') as max_cpu_count, + JSON_EXTRACT(Properties, '$.MaxDataStorageInTBs') as max_data_storage_in_tbs, + JSON_EXTRACT(Properties, '$.MaxDbNodeStorageSizeInGBs') as max_db_node_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.MaxMemoryInGBs') as max_memory_in_gbs, + JSON_EXTRACT(Properties, '$.MemorySizeInGBs') as memory_size_in_gbs, + JSON_EXTRACT(Properties, '$.OciResourceAnchorName') as oci_resource_anchor_name, + JSON_EXTRACT(Properties, '$.OciUrl') as oci_url, + JSON_EXTRACT(Properties, '$.Ocid') as ocid, + JSON_EXTRACT(Properties, '$.Shape') as shape, + JSON_EXTRACT(Properties, '$.StorageCount') as storage_count, + JSON_EXTRACT(Properties, '$.StorageServerType') as storage_server_type, + JSON_EXTRACT(Properties, '$.StorageServerVersion') as storage_server_version, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TotalStorageSizeInGBs') as total_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.DbServerIds') as db_server_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::CloudExadataInfrastructure' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActivatedStorageCount') as activated_storage_count, + json_extract_path_text(Properties, 'AdditionalStorageCount') as additional_storage_count, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'AvailabilityZoneId') as availability_zone_id, + json_extract_path_text(Properties, 'AvailableStorageSizeInGBs') as available_storage_size_in_gbs, + json_extract_path_text(Properties, 'CloudExadataInfrastructureArn') as cloud_exadata_infrastructure_arn, + json_extract_path_text(Properties, 'CloudExadataInfrastructureId') as cloud_exadata_infrastructure_id, + json_extract_path_text(Properties, 'ComputeCount') as compute_count, + json_extract_path_text(Properties, 'ComputeModel') as compute_model, + json_extract_path_text(Properties, 'CpuCount') as cpu_count, + json_extract_path_text(Properties, 'CustomerContactsToSendToOCI') as customer_contacts_to_send_to_oc_i, + json_extract_path_text(Properties, 'DataStorageSizeInTBs') as data_storage_size_in_tbs, + json_extract_path_text(Properties, 'DatabaseServerType') as database_server_type, + json_extract_path_text(Properties, 'DbNodeStorageSizeInGBs') as db_node_storage_size_in_gbs, + json_extract_path_text(Properties, 'DbServerVersion') as db_server_version, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'MaxCpuCount') as max_cpu_count, + json_extract_path_text(Properties, 'MaxDataStorageInTBs') as max_data_storage_in_tbs, + json_extract_path_text(Properties, 'MaxDbNodeStorageSizeInGBs') as max_db_node_storage_size_in_gbs, + json_extract_path_text(Properties, 'MaxMemoryInGBs') as max_memory_in_gbs, + json_extract_path_text(Properties, 'MemorySizeInGBs') as memory_size_in_gbs, + json_extract_path_text(Properties, 'OciResourceAnchorName') as oci_resource_anchor_name, + json_extract_path_text(Properties, 'OciUrl') as oci_url, + json_extract_path_text(Properties, 'Ocid') as ocid, + json_extract_path_text(Properties, 'Shape') as shape, + json_extract_path_text(Properties, 'StorageCount') as storage_count, + json_extract_path_text(Properties, 'StorageServerType') as storage_server_type, + json_extract_path_text(Properties, 'StorageServerVersion') as storage_server_version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TotalStorageSizeInGBs') as total_storage_size_in_gbs, + json_extract_path_text(Properties, 'DbServerIds') as db_server_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::CloudExadataInfrastructure' + AND data__Identifier = '' + AND region = 'us-east-1' + cloud_exadata_infrastructures_list_only: + name: cloud_exadata_infrastructures_list_only + id: awscc.odb.cloud_exadata_infrastructures_list_only + x-cfn-schema-name: CloudExadataInfrastructure + x-cfn-type-name: AWS::ODB::CloudExadataInfrastructure + x-identifiers: + - CloudExadataInfrastructureArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CloudExadataInfrastructureArn') as cloud_exadata_infrastructure_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::CloudExadataInfrastructure' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CloudExadataInfrastructureArn') as cloud_exadata_infrastructure_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::CloudExadataInfrastructure' + AND region = 'us-east-1' + cloud_vm_clusters: + name: cloud_vm_clusters + id: awscc.odb.cloud_vm_clusters + x-cfn-schema-name: CloudVmCluster + x-cfn-type-name: AWS::ODB::CloudVmCluster + x-identifiers: + - CloudVmClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudVmCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudVmCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudVmCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::CloudVmCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_vm_clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CloudExadataInfrastructureId') as cloud_exadata_infrastructure_id, + JSON_EXTRACT(Properties, '$.CloudVmClusterArn') as cloud_vm_cluster_arn, + JSON_EXTRACT(Properties, '$.CloudVmClusterId') as cloud_vm_cluster_id, + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.ComputeModel') as compute_model, + JSON_EXTRACT(Properties, '$.CpuCoreCount') as cpu_core_count, + JSON_EXTRACT(Properties, '$.DataCollectionOptions') as data_collection_options, + JSON_EXTRACT(Properties, '$.DataStorageSizeInTBs') as data_storage_size_in_tbs, + JSON_EXTRACT(Properties, '$.DbNodeStorageSizeInGBs') as db_node_storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.DbServers') as db_servers, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.DiskRedundancy') as disk_redundancy, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.GiVersion') as gi_version, + JSON_EXTRACT(Properties, '$.Hostname') as hostname, + JSON_EXTRACT(Properties, '$.IsLocalBackupEnabled') as is_local_backup_enabled, + JSON_EXTRACT(Properties, '$.IsSparseDiskgroupEnabled') as is_sparse_diskgroup_enabled, + JSON_EXTRACT(Properties, '$.LicenseModel') as license_model, + JSON_EXTRACT(Properties, '$.ListenerPort') as listener_port, + JSON_EXTRACT(Properties, '$.MemorySizeInGBs') as memory_size_in_gbs, + JSON_EXTRACT(Properties, '$.NodeCount') as node_count, + JSON_EXTRACT(Properties, '$.OdbNetworkId') as odb_network_id, + JSON_EXTRACT(Properties, '$.Ocid') as ocid, + JSON_EXTRACT(Properties, '$.OciResourceAnchorName') as oci_resource_anchor_name, + JSON_EXTRACT(Properties, '$.OciUrl') as oci_url, + JSON_EXTRACT(Properties, '$.ScanDnsName') as scan_dns_name, + JSON_EXTRACT(Properties, '$.ScanIpIds') as scan_ip_ids, + JSON_EXTRACT(Properties, '$.ScanListenerPortTcp') as scan_listener_port_tcp, + JSON_EXTRACT(Properties, '$.Shape') as shape, + JSON_EXTRACT(Properties, '$.SshPublicKeys') as ssh_public_keys, + JSON_EXTRACT(Properties, '$.StorageSizeInGBs') as storage_size_in_gbs, + JSON_EXTRACT(Properties, '$.SystemVersion') as system_version, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TimeZone') as time_zone, + JSON_EXTRACT(Properties, '$.VipIds') as vip_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::CloudVmCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CloudExadataInfrastructureId') as cloud_exadata_infrastructure_id, + json_extract_path_text(Properties, 'CloudVmClusterArn') as cloud_vm_cluster_arn, + json_extract_path_text(Properties, 'CloudVmClusterId') as cloud_vm_cluster_id, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'ComputeModel') as compute_model, + json_extract_path_text(Properties, 'CpuCoreCount') as cpu_core_count, + json_extract_path_text(Properties, 'DataCollectionOptions') as data_collection_options, + json_extract_path_text(Properties, 'DataStorageSizeInTBs') as data_storage_size_in_tbs, + json_extract_path_text(Properties, 'DbNodeStorageSizeInGBs') as db_node_storage_size_in_gbs, + json_extract_path_text(Properties, 'DbServers') as db_servers, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'DiskRedundancy') as disk_redundancy, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'GiVersion') as gi_version, + json_extract_path_text(Properties, 'Hostname') as hostname, + json_extract_path_text(Properties, 'IsLocalBackupEnabled') as is_local_backup_enabled, + json_extract_path_text(Properties, 'IsSparseDiskgroupEnabled') as is_sparse_diskgroup_enabled, + json_extract_path_text(Properties, 'LicenseModel') as license_model, + json_extract_path_text(Properties, 'ListenerPort') as listener_port, + json_extract_path_text(Properties, 'MemorySizeInGBs') as memory_size_in_gbs, + json_extract_path_text(Properties, 'NodeCount') as node_count, + json_extract_path_text(Properties, 'OdbNetworkId') as odb_network_id, + json_extract_path_text(Properties, 'Ocid') as ocid, + json_extract_path_text(Properties, 'OciResourceAnchorName') as oci_resource_anchor_name, + json_extract_path_text(Properties, 'OciUrl') as oci_url, + json_extract_path_text(Properties, 'ScanDnsName') as scan_dns_name, + json_extract_path_text(Properties, 'ScanIpIds') as scan_ip_ids, + json_extract_path_text(Properties, 'ScanListenerPortTcp') as scan_listener_port_tcp, + json_extract_path_text(Properties, 'Shape') as shape, + json_extract_path_text(Properties, 'SshPublicKeys') as ssh_public_keys, + json_extract_path_text(Properties, 'StorageSizeInGBs') as storage_size_in_gbs, + json_extract_path_text(Properties, 'SystemVersion') as system_version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TimeZone') as time_zone, + json_extract_path_text(Properties, 'VipIds') as vip_ids + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::CloudVmCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + cloud_vm_clusters_list_only: + name: cloud_vm_clusters_list_only + id: awscc.odb.cloud_vm_clusters_list_only + x-cfn-schema-name: CloudVmCluster + x-cfn-type-name: AWS::ODB::CloudVmCluster + x-identifiers: + - CloudVmClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CloudVmClusterArn') as cloud_vm_cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::CloudVmCluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CloudVmClusterArn') as cloud_vm_cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::CloudVmCluster' + AND region = 'us-east-1' + odb_networks: + name: odb_networks + id: awscc.odb.odb_networks + x-cfn-schema-name: OdbNetwork + x-cfn-type-name: AWS::ODB::OdbNetwork + x-identifiers: + - OdbNetworkArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OdbNetwork&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::OdbNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::OdbNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ODB::OdbNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.AvailabilityZoneId') as availability_zone_id, + JSON_EXTRACT(Properties, '$.BackupSubnetCidr') as backup_subnet_cidr, + JSON_EXTRACT(Properties, '$.ClientSubnetCidr') as client_subnet_cidr, + JSON_EXTRACT(Properties, '$.DefaultDnsPrefix') as default_dns_prefix, + JSON_EXTRACT(Properties, '$.DeleteAssociatedResources') as delete_associated_resources, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.OciNetworkAnchorId') as oci_network_anchor_id, + JSON_EXTRACT(Properties, '$.OciResourceAnchorName') as oci_resource_anchor_name, + JSON_EXTRACT(Properties, '$.OciVcnUrl') as oci_vcn_url, + JSON_EXTRACT(Properties, '$.OdbNetworkArn') as odb_network_arn, + JSON_EXTRACT(Properties, '$.OdbNetworkId') as odb_network_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::OdbNetwork' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'AvailabilityZoneId') as availability_zone_id, + json_extract_path_text(Properties, 'BackupSubnetCidr') as backup_subnet_cidr, + json_extract_path_text(Properties, 'ClientSubnetCidr') as client_subnet_cidr, + json_extract_path_text(Properties, 'DefaultDnsPrefix') as default_dns_prefix, + json_extract_path_text(Properties, 'DeleteAssociatedResources') as delete_associated_resources, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'OciNetworkAnchorId') as oci_network_anchor_id, + json_extract_path_text(Properties, 'OciResourceAnchorName') as oci_resource_anchor_name, + json_extract_path_text(Properties, 'OciVcnUrl') as oci_vcn_url, + json_extract_path_text(Properties, 'OdbNetworkArn') as odb_network_arn, + json_extract_path_text(Properties, 'OdbNetworkId') as odb_network_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ODB::OdbNetwork' + AND data__Identifier = '' + AND region = 'us-east-1' + odb_networks_list_only: + name: odb_networks_list_only + id: awscc.odb.odb_networks_list_only + x-cfn-schema-name: OdbNetwork + x-cfn-type-name: AWS::ODB::OdbNetwork + x-identifiers: + - OdbNetworkArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.OdbNetworkArn') as odb_network_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::OdbNetwork' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OdbNetworkArn') as odb_network_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ODB::OdbNetwork' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudAutonomousVmCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudAutonomousVmCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudAutonomousVmClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudExadataInfrastructure&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudExadataInfrastructure + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudExadataInfrastructureRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudVmCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudVmCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudVmClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OdbNetwork&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOdbNetwork + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOdbNetworkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/omics.yaml b/providers/src/awscc/v00.00.00000/services/omics.yaml index 0569eabe..cd0f82f7 100644 --- a/providers/src/awscc/v00.00.00000/services/omics.yaml +++ b/providers/src/awscc/v00.00.00000/services/omics.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Omics - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AnnotationType: type: string @@ -182,7 +562,9 @@ components: - Name - StoreFormat x-stackql-resource-name: annotation_store - x-stackql-primaryIdentifier: + description: Definition of AWS::Omics::AnnotationStore Resource Type + x-type-name: AWS::Omics::AnnotationStore + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -199,6 +581,19 @@ components: - StoreArn - StoreSizeBytes - UpdateTime + x-required-properties: + - Name + - StoreFormat + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:UntagResource + - omics:ListTagsForResource x-required-permissions: create: - omics:CreateAnnotationStore @@ -259,7 +654,9 @@ components: required: - Name x-stackql-resource-name: reference_store - x-stackql-primaryIdentifier: + description: Definition of AWS::Omics::ReferenceStore Resource Type + x-type-name: AWS::Omics::ReferenceStore + x-stackql-primary-identifier: - ReferenceStoreId x-create-only-properties: - Description @@ -270,10 +667,22 @@ components: - Arn - CreationTime - ReferenceStoreId + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:ListTagsForResource x-required-permissions: create: - omics:CreateReferenceStore - omics:TagResource + - kms:DescribeKey read: - omics:GetReferenceStore - omics:ListTagsForResource @@ -321,12 +730,24 @@ components: Tags: $ref: '#/components/schemas/TagMap' x-stackql-resource-name: run_group - x-stackql-primaryIdentifier: + description: Definition of AWS::Omics::RunGroup Resource Type + x-type-name: AWS::Omics::RunGroup + x-stackql-primary-identifier: - Id x-read-only-properties: - Arn - CreationTime - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:UntagResource + - omics:ListTagsForResource x-required-permissions: create: - omics:CreateRunGroup @@ -344,9 +765,27 @@ components: - omics:GetRunGroup list: - omics:ListRunGroups + ETagAlgorithmFamily: + type: string + enum: + - MD5up + - SHA256up + - SHA512up + SequenceStoreStatus: + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED SequenceStore: type: object properties: + AccessLogLocation: + type: string + pattern: ^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,800})/)?$ + description: Location of the access logs. Arn: type: string maxLength: 127 @@ -363,17 +802,41 @@ components: minLength: 1 pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ description: A description for the store. + ETagAlgorithmFamily: + $ref: '#/components/schemas/ETagAlgorithmFamily' + FallbackLocation: + type: string + minLength: 0 + pattern: ^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?$ + description: An S3 location that is used to store files that have failed a direct upload. Name: type: string maxLength: 127 minLength: 1 pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ description: A name for the store. - FallbackLocation: + PropagatedSetLevelTags: + type: array + items: + type: string + maxLength: 128 + minLength: 1 + maxItems: 50 + minItems: 0 + description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store. + S3AccessPointArn: type: string + maxLength: 1024 minLength: 1 - pattern: ^s3:\/\/([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])\/?((.{1,1024})\/)?$ - description: An S3 URI representing the bucket and folder to store failed read set uploads. + pattern: ^arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*$ + description: This is ARN of the access point associated with the S3 bucket storing read sets. + S3AccessPolicy: + description: The resource policy that controls S3 access on the store + type: object + S3Uri: + type: string + pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})$ + description: The S3 URI of the sequence store. SequenceStoreId: type: string maxLength: 36 @@ -381,30 +844,73 @@ components: pattern: ^[0-9]+$ SseConfig: $ref: '#/components/schemas/SseConfig' + Status: + $ref: '#/components/schemas/SequenceStoreStatus' + StatusMessage: + type: string + maxLength: 127 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + description: The status message of the sequence store. Tags: $ref: '#/components/schemas/TagMap' + UpdateTime: + type: string + description: The last-updated time of the sequence store. + format: date-time required: - Name x-stackql-resource-name: sequence_store - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Omics::SequenceStore + x-type-name: AWS::Omics::SequenceStore + x-stackql-primary-identifier: - SequenceStoreId x-create-only-properties: - - Description - - Name - - FallbackLocation + - ETagAlgorithmFamily - SseConfig - - Tags x-read-only-properties: - Arn - CreationTime + - S3AccessPointArn + - S3Uri - SequenceStoreId + - Status + - StatusMessage + - UpdateTime + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:ListTagsForResource + - omics:UntagResource x-required-permissions: create: - omics:CreateSequenceStore + - omics:GetSequenceStore + - omics:GetS3AccessPolicy + - omics:PutS3AccessPolicy + - omics:ListTagsForResource - omics:TagResource + - kms:DescribeKey read: + - omics:GetS3AccessPolicy - omics:GetSequenceStore - omics:ListTagsForResource + update: + - omics:UpdateSequenceStore + - omics:GetSequenceStore + - omics:TagResource + - omics:UntagResource + - omics:ListTagsForResource + - omics:GetS3AccessPolicy + - omics:DeleteS3AccessPolicy + - omics:PutS3AccessPolicy delete: - omics:DeleteSequenceStore list: @@ -456,7 +962,9 @@ components: - Name - Reference x-stackql-resource-name: variant_store - x-stackql-primaryIdentifier: + description: Definition of AWS::Omics::VariantStore Resource Type + x-type-name: AWS::Omics::VariantStore + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -471,6 +979,19 @@ components: - StoreArn - StoreSizeBytes - UpdateTime + x-required-properties: + - Name + - Reference + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:UntagResource + - omics:ListTagsForResource x-required-permissions: create: - omics:CreateVariantStore @@ -537,12 +1058,54 @@ components: - UPDATING - DELETED - FAILED + - INACTIVE WorkflowType: type: string maxLength: 64 minLength: 1 enum: - PRIVATE + - READY2RUN + StorageType: + type: string + maxLength: 64 + minLength: 1 + enum: + - STATIC + - DYNAMIC + Uuid: + type: string + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + SourceReference: + type: object + properties: + type: + type: string + enum: + - BRANCH + - TAG + - COMMIT + value: + type: string + DefinitionRepository: + type: object + properties: + connectionArn: + type: string + minLength: 1 + maxLength: 256 + pattern: ^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$ + fullRepositoryId: + type: string + pattern: .+/.+ + sourceReference: + $ref: '#/components/schemas/SourceReference' + excludeFilePatterns: + type: array + items: + type: string + minItems: 1 + maxItems: 50 Workflow: type: object properties: @@ -595,8 +1158,37 @@ components: $ref: '#/components/schemas/TagMap' Type: $ref: '#/components/schemas/WorkflowType' + StorageType: + $ref: '#/components/schemas/StorageType' + Uuid: + $ref: '#/components/schemas/Uuid' + WorkflowBucketOwnerId: + type: string + description: Optional workflow bucket owner ID to verify the workflow bucket + pattern: ^[0-9]{12}$ + DefinitionRepository: + $ref: '#/components/schemas/DefinitionRepository' + ParameterTemplatePath: + type: string + description: Path to the primary workflow parameter template JSON file inside the repository + pattern: ^[\S]+$ + readmePath: + type: string + description: The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used. + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + readmeUri: + type: string + description: The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB. + pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$ + readmeMarkdown: + type: string + description: The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow. x-stackql-resource-name: workflow - x-stackql-primaryIdentifier: + description: Definition of AWS::Omics::Workflow Resource Type + x-type-name: AWS::Omics::Workflow + x-stackql-primary-identifier: - Id x-create-only-properties: - DefinitionUri @@ -605,12 +1197,35 @@ components: - ParameterTemplate - StorageCapacity - Accelerators + - DefinitionRepository + - ParameterTemplatePath + - readmePath + - readmeUri + - WorkflowBucketOwnerId + x-write-only-properties: + - DefinitionUri + - WorkflowBucketOwnerId + - ParameterTemplatePath + - DefinitionRepository + - readmeUri + - readmeMarkdown x-read-only-properties: - Arn - CreationTime - Id - Status - Type + - Uuid + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:UntagResource + - omics:ListTagsForResource x-required-permissions: create: - omics:CreateWorkflow @@ -626,6 +1241,9 @@ components: - kms:GenerateDataKeyPair - kms:GenerateDataKeyPairWithoutPlaintext - kms:GenerateDataKeyWithoutPlaintext + - codeconnections:UseConnection + - codeconnections:GetConnection + - codeconnections:GetHost read: - omics:GetWorkflow update: @@ -639,94 +1257,796 @@ components: - omics:GetWorkflow list: - omics:ListWorkflows - x-stackQL-resources: - annotation_stores: - name: annotation_stores - id: awscc.omics.annotation_stores - x-cfn-schema-name: AnnotationStore - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND region = 'us-east-1' - annotation_store: - name: annotation_store - id: awscc.omics.annotation_store - x-cfn-schema-name: AnnotationStore - x-type: get - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Reference') as reference, - JSON_EXTRACT(Properties, '$.SseConfig') as sse_config, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, - JSON_EXTRACT(Properties, '$.StoreArn') as store_arn, - JSON_EXTRACT(Properties, '$.StoreFormat') as store_format, - JSON_EXTRACT(Properties, '$.StoreOptions') as store_options, - JSON_EXTRACT(Properties, '$.StoreSizeBytes') as store_size_bytes, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.UpdateTime') as update_time - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Reference') as reference, - json_extract_path_text(Properties, 'SseConfig') as sse_config, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StoreArn') as store_arn, - json_extract_path_text(Properties, 'StoreFormat') as store_format, - json_extract_path_text(Properties, 'StoreOptions') as store_options, - json_extract_path_text(Properties, 'StoreSizeBytes') as store_size_bytes, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND data__Identifier = '' - AND region = 'us-east-1' - reference_stores: - name: reference_stores - id: awscc.omics.reference_stores - x-cfn-schema-name: ReferenceStore - x-type: list + WorkflowVersion: + type: object + properties: + Arn: + type: string + maxLength: 128 + minLength: 1 + pattern: ^arn:.+$ + WorkflowId: + type: string + maxLength: 18 + minLength: 1 + pattern: ^[0-9]+$ + VersionName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9][A-Za-z0-9\-\._]*$ + CreationTime: + type: string + format: date-time + DefinitionUri: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Engine: + $ref: '#/components/schemas/WorkflowEngine' + Main: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + ParameterTemplate: + $ref: '#/components/schemas/WorkflowParameterTemplate' + Status: + $ref: '#/components/schemas/WorkflowStatus' + Accelerators: + $ref: '#/components/schemas/Accelerators' + StorageType: + $ref: '#/components/schemas/StorageType' + StorageCapacity: + type: number + maximum: 100000 + minimum: 0 + Tags: + $ref: '#/components/schemas/TagMap' + Type: + $ref: '#/components/schemas/WorkflowType' + Uuid: + type: string + maxLength: 36 + minLength: 1 + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + WorkflowBucketOwnerId: + type: string + maxLength: 12 + minLength: 1 + pattern: ^[0-9]{12}$ + ParameterTemplatePath: + type: string + description: Path to the primary workflow parameter template JSON file inside the repository + pattern: ^[\S]+$ + DefinitionRepository: + $ref: '#/components/schemas/DefinitionRepository' + readmePath: + type: string + description: The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used. + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + readmeUri: + type: string + description: The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB. + pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$ + readmeMarkdown: + type: string + description: The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow. + required: + - WorkflowId + - VersionName + x-stackql-resource-name: workflow_version + description: Definition of AWS::Omics::WorkflowVersion Resource Type. + x-type-name: AWS::Omics::WorkflowVersion + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - WorkflowId + - VersionName + - DefinitionUri + - Engine + - Main + - ParameterTemplate + - Accelerators + - WorkflowBucketOwnerId + - Accelerators + - DefinitionRepository + - ParameterTemplatePath + - readmePath + - readmeUri + x-write-only-properties: + - DefinitionUri + - ParameterTemplatePath + - DefinitionRepository + - readmeUri + - readmeMarkdown + x-read-only-properties: + - Arn + - CreationTime + - Status + - Type + - Uuid + x-required-properties: + - WorkflowId + - VersionName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - omics:TagResource + - omics:UntagResource + - omics:ListTagsForResource + x-required-permissions: + create: + - omics:CreateWorkflow + - omics:GetWorkflow + - omics:CreateWorkflowVersion + - omics:GetWorkflowVersion + - omics:TagResource + - s3:PutObject + - s3:GetObject + - s3:GetObjectAttributes + - s3:HeadObject + - s3:GetEncryptionConfiguration + - kms:Decrypt + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext + - codeconnections:UseConnection + - codeconnections:GetConnection + - codeconnections:GetHost + read: + - omics:GetWorkflowVersion + - omics:ListTagsForResource + update: + - omics:UpdateWorkflowVersion + - omics:GetWorkflowVersion + - omics:TagResource + - omics:ListTagsForResource + - omics:UntagResource + delete: + - omics:DeleteWorkflowVersion + - omics:GetWorkflowVersion + list: + - omics:ListWorkflowVersions + CreateAnnotationStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 500 + minLength: 0 + Id: + type: string + pattern: ^[a-f0-9]{12}$ + Name: + type: string + pattern: ^([a-z]){1}([a-z0-9_]){2,254} + Reference: + $ref: '#/components/schemas/ReferenceItem' + SseConfig: + $ref: '#/components/schemas/SseConfig' + Status: + $ref: '#/components/schemas/StoreStatus' + StatusMessage: + type: string + maxLength: 1000 + minLength: 0 + StoreArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: |- + ^arn:([^: + ]*):([^: + ]*):([^: + ]*):([0-9]{12}):([^: + ]*)$ + StoreFormat: + $ref: '#/components/schemas/StoreFormat' + StoreOptions: + $ref: '#/components/schemas/StoreOptions' + StoreSizeBytes: + type: number + Tags: + $ref: '#/components/schemas/TagMap' + UpdateTime: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateAnnotationStoreRequest + type: object + required: [] + CreateReferenceStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 127 + minLength: 1 + pattern: ^arn:.+$ + description: The store's ARN. + CreationTime: + type: string + description: When the store was created. + format: date-time + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + description: A description for the store. + Name: + type: string + maxLength: 127 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + description: A name for the store. + ReferenceStoreId: + type: string + maxLength: 36 + minLength: 10 + pattern: ^[0-9]+$ + SseConfig: + $ref: '#/components/schemas/SseConfig' + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateReferenceStoreRequest + type: object + required: [] + CreateRunGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 128 + minLength: 1 + pattern: ^arn:.+$ + CreationTime: + type: string + format: date-time + Id: + type: string + maxLength: 18 + minLength: 1 + pattern: ^[0-9]+$ + MaxCpus: + type: number + maximum: 100000 + minimum: 1 + MaxGpus: + type: number + maximum: 100000 + minimum: 1 + MaxDuration: + type: number + maximum: 100000 + minimum: 1 + MaxRuns: + type: number + maximum: 100000 + minimum: 1 + Name: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateRunGroupRequest + type: object + required: [] + CreateSequenceStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessLogLocation: + type: string + pattern: ^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,800})/)?$ + description: Location of the access logs. + Arn: + type: string + maxLength: 127 + minLength: 1 + pattern: ^arn:.+$ + description: The store's ARN. + CreationTime: + type: string + description: When the store was created. + format: date-time + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + description: A description for the store. + ETagAlgorithmFamily: + $ref: '#/components/schemas/ETagAlgorithmFamily' + FallbackLocation: + type: string + minLength: 0 + pattern: ^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?$ + description: An S3 location that is used to store files that have failed a direct upload. + Name: + type: string + maxLength: 127 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + description: A name for the store. + PropagatedSetLevelTags: + type: array + items: + type: string + maxLength: 128 + minLength: 1 + maxItems: 50 + minItems: 0 + description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store. + S3AccessPointArn: + type: string + maxLength: 1024 + minLength: 1 + pattern: ^arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*$ + description: This is ARN of the access point associated with the S3 bucket storing read sets. + S3AccessPolicy: + description: The resource policy that controls S3 access on the store + type: object + S3Uri: + type: string + pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})$ + description: The S3 URI of the sequence store. + SequenceStoreId: + type: string + maxLength: 36 + minLength: 10 + pattern: ^[0-9]+$ + SseConfig: + $ref: '#/components/schemas/SseConfig' + Status: + $ref: '#/components/schemas/SequenceStoreStatus' + StatusMessage: + type: string + maxLength: 127 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + description: The status message of the sequence store. + Tags: + $ref: '#/components/schemas/TagMap' + UpdateTime: + type: string + description: The last-updated time of the sequence store. + format: date-time + x-stackQL-stringOnly: true + x-title: CreateSequenceStoreRequest + type: object + required: [] + CreateVariantStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreationTime: + type: string + format: date-time + Description: + type: string + maxLength: 500 + minLength: 0 + Id: + type: string + pattern: ^[a-f0-9]{12}$ + Name: + type: string + pattern: ^([a-z]){1}([a-z0-9_]){2,254} + Reference: + $ref: '#/components/schemas/ReferenceItem' + SseConfig: + $ref: '#/components/schemas/SseConfig' + Status: + $ref: '#/components/schemas/StoreStatus' + StatusMessage: + type: string + maxLength: 1000 + minLength: 0 + StoreArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: |- + ^arn:([^: + ]*):([^: + ]*):([^: + ]*):([0-9]{12}):([^: + ]*)$ + StoreSizeBytes: + type: number + Tags: + $ref: '#/components/schemas/TagMap' + UpdateTime: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateVariantStoreRequest + type: object + required: [] + CreateWorkflowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 128 + minLength: 1 + pattern: ^arn:.+$ + CreationTime: + type: string + format: date-time + DefinitionUri: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Engine: + $ref: '#/components/schemas/WorkflowEngine' + Id: + type: string + maxLength: 18 + minLength: 1 + pattern: ^[0-9]+$ + Main: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Name: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + ParameterTemplate: + $ref: '#/components/schemas/WorkflowParameterTemplate' + Status: + $ref: '#/components/schemas/WorkflowStatus' + Accelerators: + $ref: '#/components/schemas/Accelerators' + StorageCapacity: + type: number + maximum: 100000 + minimum: 0 + Tags: + $ref: '#/components/schemas/TagMap' + Type: + $ref: '#/components/schemas/WorkflowType' + StorageType: + $ref: '#/components/schemas/StorageType' + Uuid: + $ref: '#/components/schemas/Uuid' + WorkflowBucketOwnerId: + type: string + description: Optional workflow bucket owner ID to verify the workflow bucket + pattern: ^[0-9]{12}$ + DefinitionRepository: + $ref: '#/components/schemas/DefinitionRepository' + ParameterTemplatePath: + type: string + description: Path to the primary workflow parameter template JSON file inside the repository + pattern: ^[\S]+$ + readmePath: + type: string + description: The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used. + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + readmeUri: + type: string + description: The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB. + pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$ + readmeMarkdown: + type: string + description: The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow. + x-stackQL-stringOnly: true + x-title: CreateWorkflowRequest + type: object + required: [] + CreateWorkflowVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 128 + minLength: 1 + pattern: ^arn:.+$ + WorkflowId: + type: string + maxLength: 18 + minLength: 1 + pattern: ^[0-9]+$ + VersionName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9][A-Za-z0-9\-\._]*$ + CreationTime: + type: string + format: date-time + DefinitionUri: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + Engine: + $ref: '#/components/schemas/WorkflowEngine' + Main: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + ParameterTemplate: + $ref: '#/components/schemas/WorkflowParameterTemplate' + Status: + $ref: '#/components/schemas/WorkflowStatus' + Accelerators: + $ref: '#/components/schemas/Accelerators' + StorageType: + $ref: '#/components/schemas/StorageType' + StorageCapacity: + type: number + maximum: 100000 + minimum: 0 + Tags: + $ref: '#/components/schemas/TagMap' + Type: + $ref: '#/components/schemas/WorkflowType' + Uuid: + type: string + maxLength: 36 + minLength: 1 + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + WorkflowBucketOwnerId: + type: string + maxLength: 12 + minLength: 1 + pattern: ^[0-9]{12}$ + ParameterTemplatePath: + type: string + description: Path to the primary workflow parameter template JSON file inside the repository + pattern: ^[\S]+$ + DefinitionRepository: + $ref: '#/components/schemas/DefinitionRepository' + readmePath: + type: string + description: The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used. + maxLength: 128 + minLength: 1 + pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$ + readmeUri: + type: string + description: The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB. + pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$ + readmeMarkdown: + type: string + description: The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow. + x-stackQL-stringOnly: true + x-title: CreateWorkflowVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + annotation_stores: + name: annotation_stores + id: awscc.omics.annotation_stores + x-cfn-schema-name: AnnotationStore + x-cfn-type-name: AWS::Omics::AnnotationStore x-identifiers: - - ReferenceStoreId + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AnnotationStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::AnnotationStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::AnnotationStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::AnnotationStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Reference') as reference, + JSON_EXTRACT(Properties, '$.SseConfig') as sse_config, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.StoreArn') as store_arn, + JSON_EXTRACT(Properties, '$.StoreFormat') as store_format, + JSON_EXTRACT(Properties, '$.StoreOptions') as store_options, + JSON_EXTRACT(Properties, '$.StoreSizeBytes') as store_size_bytes, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdateTime') as update_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::AnnotationStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Reference') as reference, + json_extract_path_text(Properties, 'SseConfig') as sse_config, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StoreArn') as store_arn, + json_extract_path_text(Properties, 'StoreFormat') as store_format, + json_extract_path_text(Properties, 'StoreOptions') as store_options, + json_extract_path_text(Properties, 'StoreSizeBytes') as store_size_bytes, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::AnnotationStore' + AND data__Identifier = '' + AND region = 'us-east-1' + annotation_stores_list_only: + name: annotation_stores_list_only + id: awscc.omics.annotation_stores_list_only + x-cfn-schema-name: AnnotationStore + x-cfn-type-name: AWS::Omics::AnnotationStore + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -734,28 +2054,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ReferenceStoreId') as reference_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ReferenceStoreId') as reference_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' AND region = 'us-east-1' - reference_store: - name: reference_store - id: awscc.omics.reference_store + reference_stores: + name: reference_stores + id: awscc.omics.reference_stores x-cfn-schema-name: ReferenceStore - x-type: get + x-cfn-type-name: AWS::Omics::ReferenceStore x-identifiers: - ReferenceStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReferenceStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::ReferenceStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::ReferenceStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/reference_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/reference_stores/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -771,7 +2126,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -786,13 +2141,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::ReferenceStore' AND data__Identifier = '' AND region = 'us-east-1' - run_groups: - name: run_groups - id: awscc.omics.run_groups - x-cfn-schema-name: RunGroup - x-type: list + reference_stores_list_only: + name: reference_stores_list_only + id: awscc.omics.reference_stores_list_only + x-cfn-schema-name: ReferenceStore + x-cfn-type-name: AWS::Omics::ReferenceStore x-identifiers: - - Id + - ReferenceStoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -800,28 +2161,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' + JSON_EXTRACT(Properties, '$.ReferenceStoreId') as reference_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' + json_extract_path_text(Properties, 'ReferenceStoreId') as reference_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' AND region = 'us-east-1' - run_group: - name: run_group - id: awscc.omics.run_group + run_groups: + name: run_groups + id: awscc.omics.run_groups x-cfn-schema-name: RunGroup - x-type: get + x-cfn-type-name: AWS::Omics::RunGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RunGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::RunGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::RunGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::RunGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/run_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/run_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/run_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -839,7 +2248,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -856,13 +2265,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::RunGroup' AND data__Identifier = '' AND region = 'us-east-1' - sequence_stores: - name: sequence_stores - id: awscc.omics.sequence_stores - x-cfn-schema-name: SequenceStore - x-type: list + run_groups_list_only: + name: run_groups_list_only + id: awscc.omics.run_groups_list_only + x-cfn-schema-name: RunGroup + x-cfn-type-name: AWS::Omics::RunGroup x-identifiers: - - SequenceStoreId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -870,67 +2285,139 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SequenceStoreId') as sequence_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' AND region = 'us-east-1' - sequence_store: - name: sequence_store - id: awscc.omics.sequence_store + sequence_stores: + name: sequence_stores + id: awscc.omics.sequence_stores x-cfn-schema-name: SequenceStore - x-type: get + x-cfn-type-name: AWS::Omics::SequenceStore x-identifiers: - SequenceStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SequenceStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::SequenceStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::SequenceStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::SequenceStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sequence_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sequence_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sequence_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.AccessLogLocation') as access_log_location, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ETagAlgorithmFamily') as e_tag_algorithm_family, JSON_EXTRACT(Properties, '$.FallbackLocation') as fallback_location, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.PropagatedSetLevelTags') as propagated_set_level_tags, + JSON_EXTRACT(Properties, '$.S3AccessPointArn') as s3_access_point_arn, + JSON_EXTRACT(Properties, '$.S3AccessPolicy') as s3_access_policy, + JSON_EXTRACT(Properties, '$.S3Uri') as s3_uri, JSON_EXTRACT(Properties, '$.SequenceStoreId') as sequence_store_id, JSON_EXTRACT(Properties, '$.SseConfig') as sse_config, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdateTime') as update_time FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::SequenceStore' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'AccessLogLocation') as access_log_location, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'CreationTime') as creation_time, json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ETagAlgorithmFamily') as e_tag_algorithm_family, json_extract_path_text(Properties, 'FallbackLocation') as fallback_location, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PropagatedSetLevelTags') as propagated_set_level_tags, + json_extract_path_text(Properties, 'S3AccessPointArn') as s3_access_point_arn, + json_extract_path_text(Properties, 'S3AccessPolicy') as s3_access_policy, + json_extract_path_text(Properties, 'S3Uri') as s3_uri, json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id, json_extract_path_text(Properties, 'SseConfig') as sse_config, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::SequenceStore' AND data__Identifier = '' AND region = 'us-east-1' - variant_stores: - name: variant_stores - id: awscc.omics.variant_stores - x-cfn-schema-name: VariantStore - x-type: list + sequence_stores_list_only: + name: sequence_stores_list_only + id: awscc.omics.sequence_stores_list_only + x-cfn-schema-name: SequenceStore + x-cfn-type-name: AWS::Omics::SequenceStore x-identifiers: - - Name + - SequenceStoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -938,28 +2425,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' + JSON_EXTRACT(Properties, '$.SequenceStoreId') as sequence_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' + json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' AND region = 'us-east-1' - variant_store: - name: variant_store - id: awscc.omics.variant_store + variant_stores: + name: variant_stores + id: awscc.omics.variant_stores x-cfn-schema-name: VariantStore - x-type: get + x-cfn-type-name: AWS::Omics::VariantStore x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VariantStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::VariantStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::VariantStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::VariantStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/variant_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/variant_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/variant_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -980,7 +2515,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1000,13 +2535,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::VariantStore' AND data__Identifier = '' AND region = 'us-east-1' - workflows: - name: workflows - id: awscc.omics.workflows - x-cfn-schema-name: Workflow - x-type: list + variant_stores_list_only: + name: variant_stores_list_only + id: awscc.omics.variant_stores_list_only + x-cfn-schema-name: VariantStore + x-cfn-type-name: AWS::Omics::VariantStore x-identifiers: - - Id + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1014,28 +2555,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' AND region = 'us-east-1' - workflow: - name: workflow - id: awscc.omics.workflow + workflows: + name: workflows + id: awscc.omics.workflows x-cfn-schema-name: Workflow - x-type: get + x-cfn-type-name: AWS::Omics::Workflow x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1053,12 +2642,20 @@ components: JSON_EXTRACT(Properties, '$.Accelerators') as accelerators, JSON_EXTRACT(Properties, '$.StorageCapacity') as storage_capacity, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Type') as type + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.StorageType') as storage_type, + JSON_EXTRACT(Properties, '$.Uuid') as uuid, + JSON_EXTRACT(Properties, '$.WorkflowBucketOwnerId') as workflow_bucket_owner_id, + JSON_EXTRACT(Properties, '$.DefinitionRepository') as definition_repository, + JSON_EXTRACT(Properties, '$.ParameterTemplatePath') as parameter_template_path, + JSON_EXTRACT(Properties, '$.readmePath') as readme_path, + JSON_EXTRACT(Properties, '$.readmeUri') as readme_uri, + JSON_EXTRACT(Properties, '$.readmeMarkdown') as readme_markdown FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::Workflow' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1076,7 +2673,643 @@ components: json_extract_path_text(Properties, 'Accelerators') as accelerators, json_extract_path_text(Properties, 'StorageCapacity') as storage_capacity, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'StorageType') as storage_type, + json_extract_path_text(Properties, 'Uuid') as uuid, + json_extract_path_text(Properties, 'WorkflowBucketOwnerId') as workflow_bucket_owner_id, + json_extract_path_text(Properties, 'DefinitionRepository') as definition_repository, + json_extract_path_text(Properties, 'ParameterTemplatePath') as parameter_template_path, + json_extract_path_text(Properties, 'readmePath') as readme_path, + json_extract_path_text(Properties, 'readmeUri') as readme_uri, + json_extract_path_text(Properties, 'readmeMarkdown') as readme_markdown FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::Workflow' AND data__Identifier = '' AND region = 'us-east-1' + workflows_list_only: + name: workflows_list_only + id: awscc.omics.workflows_list_only + x-cfn-schema-name: Workflow + x-cfn-type-name: AWS::Omics::Workflow + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' + AND region = 'us-east-1' + workflow_versions: + name: workflow_versions + id: awscc.omics.workflow_versions + x-cfn-schema-name: WorkflowVersion + x-cfn-type-name: AWS::Omics::WorkflowVersion + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WorkflowVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::WorkflowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::WorkflowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Omics::WorkflowVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workflow_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workflow_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workflow_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id, + JSON_EXTRACT(Properties, '$.VersionName') as version_name, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.DefinitionUri') as definition_uri, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.Main') as main, + JSON_EXTRACT(Properties, '$.ParameterTemplate') as parameter_template, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Accelerators') as accelerators, + JSON_EXTRACT(Properties, '$.StorageType') as storage_type, + JSON_EXTRACT(Properties, '$.StorageCapacity') as storage_capacity, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Uuid') as uuid, + JSON_EXTRACT(Properties, '$.WorkflowBucketOwnerId') as workflow_bucket_owner_id, + JSON_EXTRACT(Properties, '$.ParameterTemplatePath') as parameter_template_path, + JSON_EXTRACT(Properties, '$.DefinitionRepository') as definition_repository, + JSON_EXTRACT(Properties, '$.readmePath') as readme_path, + JSON_EXTRACT(Properties, '$.readmeUri') as readme_uri, + JSON_EXTRACT(Properties, '$.readmeMarkdown') as readme_markdown + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::WorkflowVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'WorkflowId') as workflow_id, + json_extract_path_text(Properties, 'VersionName') as version_name, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'DefinitionUri') as definition_uri, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'Main') as main, + json_extract_path_text(Properties, 'ParameterTemplate') as parameter_template, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Accelerators') as accelerators, + json_extract_path_text(Properties, 'StorageType') as storage_type, + json_extract_path_text(Properties, 'StorageCapacity') as storage_capacity, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Uuid') as uuid, + json_extract_path_text(Properties, 'WorkflowBucketOwnerId') as workflow_bucket_owner_id, + json_extract_path_text(Properties, 'ParameterTemplatePath') as parameter_template_path, + json_extract_path_text(Properties, 'DefinitionRepository') as definition_repository, + json_extract_path_text(Properties, 'readmePath') as readme_path, + json_extract_path_text(Properties, 'readmeUri') as readme_uri, + json_extract_path_text(Properties, 'readmeMarkdown') as readme_markdown + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::WorkflowVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + workflow_versions_list_only: + name: workflow_versions_list_only + id: awscc.omics.workflow_versions_list_only + x-cfn-schema-name: WorkflowVersion + x-cfn-type-name: AWS::Omics::WorkflowVersion + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::WorkflowVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::WorkflowVersion' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AnnotationStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnnotationStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnnotationStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReferenceStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReferenceStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReferenceStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RunGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRunGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRunGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SequenceStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSequenceStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSequenceStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VariantStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVariantStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVariantStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkflow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkflowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WorkflowVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkflowVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkflowVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/opensearchserverless.yaml b/providers/src/awscc/v00.00.00000/services/opensearchserverless.yaml index 53e067c2..c2ce4a25 100644 --- a/providers/src/awscc/v00.00.00000/services/opensearchserverless.yaml +++ b/providers/src/awscc/v00.00.00000/services/opensearchserverless.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: OpenSearchServerless - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AccessPolicyType: type: string @@ -37,12 +417,23 @@ components: - Name - Policy x-stackql-resource-name: access_policy - x-stackql-primaryIdentifier: + description: Amazon OpenSearchServerless access policy resource + x-type-name: AWS::OpenSearchServerless::AccessPolicy + x-stackql-primary-identifier: - Type - Name x-create-only-properties: - Type - Name + x-required-properties: + - Type + - Name + - Policy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - aoss:CreateAccessPolicy @@ -137,17 +528,32 @@ components: required: - Name x-stackql-resource-name: collection - x-stackql-primaryIdentifier: + description: Amazon OpenSearchServerless collection resource + x-type-name: AWS::OpenSearchServerless::Collection + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Name + - - Arn x-create-only-properties: - Name - Tags - Type + x-write-only-properties: + - Tags x-read-only-properties: - Id - Arn - CollectionEndpoint - DashboardEndpoint + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - aoss:CreateCollection @@ -163,6 +569,159 @@ components: update: - aoss:UpdateCollection - aoss:BatchGetCollection + IndexSettings: + type: object + additionalProperties: false + properties: + Index: + type: object + additionalProperties: false + properties: + RefreshInterval: + type: string + description: How often to perform refresh operation (e.g. '1s', '5s') + Knn: + type: boolean + description: Enable/disable k-nearest neighbor search capability + KnnAlgoParamEfSearch: + type: integer + description: Size of the dynamic list for the nearest neighbors + PropertyMapping: + type: object + additionalProperties: false + properties: + Dimension: + type: integer + description: Dimension size for vector fields, defines the number of dimensions in the vector + Index: + type: boolean + description: Whether a field should be indexed + Method: + type: object + description: Configuration for k-NN search method + additionalProperties: false + properties: + Engine: + type: string + enum: + - nmslib + - faiss + - lucene + description: The k-NN search engine to use + Name: + type: string + description: The algorithm name for k-NN search + enum: + - hnsw + - ivf + SpaceType: + type: string + description: The distance function used for k-NN search + enum: + - l2 + - l1 + - linf + - cosinesimil + - innerproduct + - hamming + Parameters: + type: object + description: Additional parameters for the k-NN algorithm + additionalProperties: false + properties: + EfConstruction: + type: integer + minimum: 1 + description: The size of the dynamic list used during k-NN graph creation + M: + type: integer + description: Number of neighbors to consider during k-NN search + minimum: 2 + maximum: 100 + required: + - Name + - Engine + Properties: + type: object + description: Nested fields within an object or nested field type + additionalProperties: false + x-patternProperties: + ^[A-Za-z0-9_.-]{1,64}$: + $ref: '#/components/schemas/PropertyMapping' + description: Nested field name and its mapping configuration + Type: + type: string + description: The field data type. Must be a valid OpenSearch field type. + enum: + - text + - knn_vector + Value: + type: string + description: Default value for the field when not specified in a document + required: + - Type + Index: + type: object + properties: + CollectionEndpoint: + description: The endpoint for the collection. + type: string + IndexName: + type: string + pattern: ^(?![_-])[a-z][a-z0-9_-]*$ + description: The name of the OpenSearch Serverless index. + Settings: + $ref: '#/components/schemas/IndexSettings' + description: Index settings + Mappings: + type: object + description: Index Mappings + additionalProperties: false + properties: + Properties: + type: object + description: Defines the fields within the mapping, including their types and configurations + additionalProperties: false + x-patternProperties: + ^[A-Za-z0-9_.-]{1,64}$: + $ref: '#/components/schemas/PropertyMapping' + description: Field name and its mapping configuration + Uuid: + description: The unique identifier for the index. + type: string + required: + - CollectionEndpoint + - IndexName + x-stackql-resource-name: index + description: An OpenSearch Serverless index resource + x-type-name: AWS::OpenSearchServerless::Index + x-stackql-primary-identifier: + - IndexName + - CollectionEndpoint + x-create-only-properties: + - IndexName + - CollectionEndpoint + x-write-only-properties: + - Settings/Index/RefreshInterval + - Settings/Index/KnnAlgoParamEfSearch + x-read-only-properties: + - Uuid + x-required-properties: + - CollectionEndpoint + - IndexName + x-tagging: + taggable: false + x-required-permissions: + create: + - aoss:APIAccessAll + read: + - aoss:APIAccessAll + update: + - aoss:APIAccessAll + delete: + - aoss:APIAccessAll + list: + - aoss:APIAccessAll LifecyclePolicyType: type: string description: The type of lifecycle policy @@ -195,12 +754,23 @@ components: - Name - Policy x-stackql-resource-name: lifecycle_policy - x-stackql-primaryIdentifier: + description: Amazon OpenSearchServerless lifecycle policy resource + x-type-name: AWS::OpenSearchServerless::LifecyclePolicy + x-stackql-primary-identifier: - Type - Name x-create-only-properties: - Type - Name + x-required-properties: + - Type + - Name + - Policy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - aoss:CreateLifecyclePolicy @@ -235,6 +805,12 @@ components: maxLength: 2048 minLength: 1 pattern: '[\w+=,.@-]+' + OpenSearchServerlessEntityId: + type: string + description: Custom entity id attribute to override default entity id for this saml integration + maxLength: 1024 + minLength: 1 + pattern: ^aws:opensearch:[0-9]{12}:* SessionTimeout: type: integer description: Defines the session timeout in minutes @@ -246,6 +822,40 @@ components: description: Config type for security config enum: - saml + - iamidentitycenter + IamIdentityCenterInstanceArn: + type: string + description: The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless + IamIdentityCenterApplicationArn: + type: string + description: The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless + IamIdentityCenterUserAttribute: + type: string + description: User attribute for this IAM Identity Center integration + IamIdentityCenterGroupAttribute: + type: string + description: Group attribute for this IAM Identity Center integration + IamIdentityCenterConfigOptions: + type: object + description: Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map + properties: + InstanceArn: + $ref: '#/components/schemas/IamIdentityCenterInstanceArn' + ApplicationArn: + $ref: '#/components/schemas/IamIdentityCenterApplicationArn' + ApplicationName: + type: string + description: The name of the IAM Identity Center application used to integrate with OpenSearch Serverless + ApplicationDescription: + type: string + description: The description of the IAM Identity Center application used to integrate with OpenSearch Serverless + UserAttribute: + $ref: '#/components/schemas/IamIdentityCenterUserAttribute' + GroupAttribute: + $ref: '#/components/schemas/IamIdentityCenterGroupAttribute' + required: + - InstanceArn + additionalProperties: false SecurityConfig: type: object properties: @@ -267,19 +877,42 @@ components: description: The friendly name of the security config SamlOptions: $ref: '#/components/schemas/SamlConfigOptions' + IamIdentityCenterOptions: + $ref: '#/components/schemas/IamIdentityCenterConfigOptions' Type: $ref: '#/components/schemas/SecurityConfigType' x-stackql-resource-name: security_config - x-stackql-primaryIdentifier: + description: Amazon OpenSearchServerless security config resource + x-type-name: AWS::OpenSearchServerless::SecurityConfig + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Name x-create-only-properties: - Type - Name + - IamIdentityCenterOptions/InstanceArn + x-write-only-properties: + - Name x-read-only-properties: - Id + - IamIdentityCenterOptions/ApplicationArn + - IamIdentityCenterOptions/ApplicationName + - IamIdentityCenterOptions/ApplicationDescription + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - aoss:CreateSecurityConfig + - sso:CreateApplication + - sso:ListApplications + - sso:DeleteApplication + - sso:PutApplicationAssignmentConfiguration + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant read: - aoss:GetSecurityConfig update: @@ -287,6 +920,9 @@ components: - aoss:UpdateSecurityConfig delete: - aoss:DeleteSecurityConfig + - sso:ListApplicationAssignments + - sso:DeleteApplicationAssignment + - sso:DeleteApplication list: - aoss:ListSecurityConfigs SecurityPolicyType: @@ -322,12 +958,23 @@ components: - Name - Policy x-stackql-resource-name: security_policy - x-stackql-primaryIdentifier: + description: Amazon OpenSearchServerless security policy resource + x-type-name: AWS::OpenSearchServerless::SecurityPolicy + x-stackql-primary-identifier: - Type - Name x-create-only-properties: - Type - Name + x-required-properties: + - Type + - Name + - Policy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - aoss:GetSecurityPolicy @@ -395,13 +1042,26 @@ components: - VpcId - SubnetIds x-stackql-resource-name: vpc_endpoint - x-stackql-primaryIdentifier: + description: Amazon OpenSearchServerless vpc endpoint resource + x-type-name: AWS::OpenSearchServerless::VpcEndpoint + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Name x-create-only-properties: - Name - VpcId x-read-only-properties: - Id + x-required-properties: + - Name + - VpcId + - SubnetIds + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - aoss:BatchGetVpcEndpoint @@ -465,47 +1125,381 @@ components: list: - aoss:ListVpcEndpoints - ec2:DescribeVpcEndpoints + CreateAccessPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + maxLength: 32 + minLength: 3 + pattern: ^[a-z][a-z0-9-]{2,31}$ + description: The name of the policy + Type: + $ref: '#/components/schemas/AccessPolicyType' + Description: + type: string + maxLength: 1000 + minLength: 1 + description: The description of the policy + Policy: + type: string + minLength: 1 + maxLength: 20480 + pattern: '[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+' + description: The JSON policy document that is the content for the policy + x-stackQL-stringOnly: true + x-title: CreateAccessPolicyRequest + type: object + required: [] + CreateCollectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 1000 + description: The description of the collection + Id: + type: string + maxLength: 40 + minLength: 3 + description: The identifier of the collection + Name: + type: string + maxLength: 32 + minLength: 3 + pattern: ^[a-z][a-z0-9-]{2,31}$ + description: | + The name of the collection. + + The name must meet the following criteria: + Unique to your account and AWS Region + Starts with a lowercase letter + Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) + Contains between 3 and 32 characters + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 0 + x-insertionOrder: false + description: List of tags to be added to the resource + Arn: + description: The Amazon Resource Name (ARN) of the collection. + type: string + CollectionEndpoint: + description: The endpoint for the collection. + type: string + DashboardEndpoint: + description: The OpenSearch Dashboards endpoint for the collection. + type: string + Type: + $ref: '#/components/schemas/CollectionType' + StandbyReplicas: + $ref: '#/components/schemas/StandbyReplicas' + x-stackQL-stringOnly: true + x-title: CreateCollectionRequest + type: object + required: [] + CreateIndexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CollectionEndpoint: + description: The endpoint for the collection. + type: string + IndexName: + type: string + pattern: ^(?![_-])[a-z][a-z0-9_-]*$ + description: The name of the OpenSearch Serverless index. + Settings: + $ref: '#/components/schemas/IndexSettings' + description: Index settings + Mappings: + type: object + description: Index Mappings + additionalProperties: false + properties: + Properties: + type: object + description: Defines the fields within the mapping, including their types and configurations + additionalProperties: false + x-patternProperties: + ^[A-Za-z0-9_.-]{1,64}$: + $ref: '#/components/schemas/PropertyMapping' + description: Field name and its mapping configuration + Uuid: + description: The unique identifier for the index. + type: string + x-stackQL-stringOnly: true + x-title: CreateIndexRequest + type: object + required: [] + CreateLifecyclePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + maxLength: 32 + minLength: 3 + pattern: ^[a-z][a-z0-9-]+$ + description: The name of the policy + Type: + $ref: '#/components/schemas/LifecyclePolicyType' + Description: + type: string + maxLength: 1000 + minLength: 0 + description: The description of the policy + Policy: + type: string + minLength: 1 + maxLength: 20480 + pattern: '[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+' + description: The JSON policy document that is the content for the policy + x-stackQL-stringOnly: true + x-title: CreateLifecyclePolicyRequest + type: object + required: [] + CreateSecurityConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 1000 + minLength: 1 + description: Security config description + Id: + type: string + maxLength: 100 + minLength: 1 + description: The identifier of the security config + Name: + type: string + maxLength: 32 + minLength: 3 + pattern: ^[a-z][a-z0-9-]{2,31}$ + description: The friendly name of the security config + SamlOptions: + $ref: '#/components/schemas/SamlConfigOptions' + IamIdentityCenterOptions: + $ref: '#/components/schemas/IamIdentityCenterConfigOptions' + Type: + $ref: '#/components/schemas/SecurityConfigType' + x-stackQL-stringOnly: true + x-title: CreateSecurityConfigRequest + type: object + required: [] + CreateSecurityPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 1000 + minLength: 1 + description: The description of the policy + Policy: + type: string + maxLength: 20480 + minLength: 1 + pattern: '[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+' + description: The JSON policy document that is the content for the policy + Name: + type: string + maxLength: 32 + minLength: 3 + pattern: ^[a-z][a-z0-9-]{2,31}$ + description: The name of the policy + Type: + $ref: '#/components/schemas/SecurityPolicyType' + x-stackQL-stringOnly: true + x-title: CreateSecurityPolicyRequest + type: object + required: [] + CreateVpcEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + maxLength: 255 + minLength: 1 + pattern: ^vpce-[0-9a-z]*$ + description: The identifier of the VPC Endpoint + Name: + type: string + maxLength: 32 + minLength: 3 + pattern: ^[a-z][a-z0-9-]{2,31}$ + description: The name of the VPC Endpoint + SecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\w+\-]+$ + maxItems: 5 + minItems: 1 + description: The ID of one or more security groups to associate with the endpoint network interface + SubnetIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 32 + minLength: 1 + pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$ + maxItems: 6 + minItems: 1 + description: The ID of one or more subnets in which to create an endpoint network interface + VpcId: + type: string + maxLength: 255 + minLength: 1 + pattern: ^vpc-[0-9a-z]*$ + description: The ID of the VPC in which the endpoint will be used. + x-stackQL-stringOnly: true + x-title: CreateVpcEndpointRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_policies: name: access_policies id: awscc.opensearchserverless.access_policies x-cfn-schema-name: AccessPolicy - x-type: list - x-identifiers: - - Type - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' - AND region = 'us-east-1' - access_policy: - name: access_policy - id: awscc.opensearchserverless.access_policy - x-cfn-schema-name: AccessPolicy - x-type: get + x-cfn-type-name: AWS::OpenSearchServerless::AccessPolicy x-identifiers: - Type - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::AccessPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::AccessPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::AccessPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -518,7 +1512,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -530,13 +1524,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' AND data__Identifier = '|' AND region = 'us-east-1' - collections: - name: collections - id: awscc.opensearchserverless.collections - x-cfn-schema-name: Collection - x-type: list + access_policies_list_only: + name: access_policies_list_only + id: awscc.opensearchserverless.access_policies_list_only + x-cfn-schema-name: AccessPolicy + x-cfn-type-name: AWS::OpenSearchServerless::AccessPolicy x-identifiers: - - Id + - Type + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -544,28 +1545,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' AND region = 'us-east-1' - collection: - name: collection - id: awscc.opensearchserverless.collection + collections: + name: collections + id: awscc.opensearchserverless.collections x-cfn-schema-name: Collection - x-type: get + x-cfn-type-name: AWS::OpenSearchServerless::Collection x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Collection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::Collection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::Collection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::Collection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/collections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -583,7 +1634,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -600,14 +1651,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' AND data__Identifier = '' AND region = 'us-east-1' - lifecycle_policies: - name: lifecycle_policies - id: awscc.opensearchserverless.lifecycle_policies - x-cfn-schema-name: LifecyclePolicy - x-type: list + collections_list_only: + name: collections_list_only + id: awscc.opensearchserverless.collections_list_only + x-cfn-schema-name: Collection + x-cfn-type-name: AWS::OpenSearchServerless::Collection x-identifiers: - - Type - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -615,31 +1671,197 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' + AND region = 'us-east-1' + indices: + name: indices + id: awscc.opensearchserverless.indices + x-cfn-schema-name: Index + x-cfn-type-name: AWS::OpenSearchServerless::Index + x-identifiers: + - IndexName + - CollectionEndpoint + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CollectionEndpoint') as collection_endpoint, + JSON_EXTRACT(Properties, '$.IndexName') as index_name, + JSON_EXTRACT(Properties, '$.Settings') as settings, + JSON_EXTRACT(Properties, '$.Mappings') as mappings, + JSON_EXTRACT(Properties, '$.Uuid') as uuid + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::Index' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CollectionEndpoint') as collection_endpoint, + json_extract_path_text(Properties, 'IndexName') as index_name, + json_extract_path_text(Properties, 'Settings') as settings, + json_extract_path_text(Properties, 'Mappings') as mappings, + json_extract_path_text(Properties, 'Uuid') as uuid + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::Index' + AND data__Identifier = '|' AND region = 'us-east-1' - lifecycle_policy: - name: lifecycle_policy - id: awscc.opensearchserverless.lifecycle_policy + indices_list_only: + name: indices_list_only + id: awscc.opensearchserverless.indices_list_only + x-cfn-schema-name: Index + x-cfn-type-name: AWS::OpenSearchServerless::Index + x-identifiers: + - IndexName + - CollectionEndpoint + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.IndexName') as index_name, + JSON_EXTRACT(Properties, '$.CollectionEndpoint') as collection_endpoint + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Index' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IndexName') as index_name, + json_extract_path_text(Properties, 'CollectionEndpoint') as collection_endpoint + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Index' + AND region = 'us-east-1' + lifecycle_policies: + name: lifecycle_policies + id: awscc.opensearchserverless.lifecycle_policies x-cfn-schema-name: LifecyclePolicy - x-type: get + x-cfn-type-name: AWS::OpenSearchServerless::LifecyclePolicy x-identifiers: - Type - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LifecyclePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::LifecyclePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::LifecyclePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::LifecyclePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -652,7 +1874,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -664,13 +1886,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' AND data__Identifier = '|' AND region = 'us-east-1' - security_configs: - name: security_configs - id: awscc.opensearchserverless.security_configs - x-cfn-schema-name: SecurityConfig - x-type: list + lifecycle_policies_list_only: + name: lifecycle_policies_list_only + id: awscc.opensearchserverless.lifecycle_policies_list_only + x-cfn-schema-name: LifecyclePolicy + x-cfn-type-name: AWS::OpenSearchServerless::LifecyclePolicy x-identifiers: - - Id + - Type + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -678,28 +1907,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' AND region = 'us-east-1' - security_config: - name: security_config - id: awscc.opensearchserverless.security_config + security_configs: + name: security_configs + id: awscc.opensearchserverless.security_configs x-cfn-schema-name: SecurityConfig - x-type: get + x-cfn-type-name: AWS::OpenSearchServerless::SecurityConfig x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::SecurityConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::SecurityConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::SecurityConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -708,12 +1987,13 @@ components: JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.SamlOptions') as saml_options, + JSON_EXTRACT(Properties, '$.IamIdentityCenterOptions') as iam_identity_center_options, JSON_EXTRACT(Properties, '$.Type') as type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -722,18 +2002,24 @@ components: json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'SamlOptions') as saml_options, + json_extract_path_text(Properties, 'IamIdentityCenterOptions') as iam_identity_center_options, json_extract_path_text(Properties, 'Type') as type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' AND data__Identifier = '' AND region = 'us-east-1' - security_policies: - name: security_policies - id: awscc.opensearchserverless.security_policies - x-cfn-schema-name: SecurityPolicy - x-type: list + security_configs_list_only: + name: security_configs_list_only + id: awscc.opensearchserverless.security_configs_list_only + x-cfn-schema-name: SecurityConfig + x-cfn-type-name: AWS::OpenSearchServerless::SecurityConfig x-identifiers: - - Type - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -741,31 +2027,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' AND region = 'us-east-1' - security_policy: - name: security_policy - id: awscc.opensearchserverless.security_policy + security_policies: + name: security_policies + id: awscc.opensearchserverless.security_policies x-cfn-schema-name: SecurityPolicy - x-type: get + x-cfn-type-name: AWS::OpenSearchServerless::SecurityPolicy x-identifiers: - Type - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::SecurityPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::SecurityPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::SecurityPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -778,7 +2110,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -790,13 +2122,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' AND data__Identifier = '|' AND region = 'us-east-1' - vpc_endpoints: - name: vpc_endpoints - id: awscc.opensearchserverless.vpc_endpoints - x-cfn-schema-name: VpcEndpoint - x-type: list + security_policies_list_only: + name: security_policies_list_only + id: awscc.opensearchserverless.security_policies_list_only + x-cfn-schema-name: SecurityPolicy + x-cfn-type-name: AWS::OpenSearchServerless::SecurityPolicy x-identifiers: - - Id + - Type + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -804,28 +2143,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' AND region = 'us-east-1' - vpc_endpoint: - name: vpc_endpoint - id: awscc.opensearchserverless.vpc_endpoint + vpc_endpoints: + name: vpc_endpoints + id: awscc.opensearchserverless.vpc_endpoints x-cfn-schema-name: VpcEndpoint - x-type: get + x-cfn-type-name: AWS::OpenSearchServerless::VpcEndpoint x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VpcEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::VpcEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::VpcEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchServerless::VpcEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -839,7 +2228,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -852,3 +2241,481 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' AND data__Identifier = '' AND region = 'us-east-1' + vpc_endpoints_list_only: + name: vpc_endpoints_list_only + id: awscc.opensearchserverless.vpc_endpoints_list_only + x-cfn-schema-name: VpcEndpoint + x-cfn-type-name: AWS::OpenSearchServerless::VpcEndpoint + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Collection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCollection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCollectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIndex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIndexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LifecyclePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLifecyclePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLifecyclePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VpcEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVpcEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVpcEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/opensearchservice.yaml b/providers/src/awscc/v00.00.00000/services/opensearchservice.yaml index 226e4dda..d6769c7d 100644 --- a/providers/src/awscc/v00.00.00000/services/opensearchservice.yaml +++ b/providers/src/awscc/v00.00.00000/services/opensearchservice.yaml @@ -1,16 +1,567 @@ openapi: 3.0.0 info: title: OpenSearchService - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + AppConfigType: + type: string + enum: + - opensearchDashboards.dashboardAdmin.users + - opensearchDashboards.dashboardAdmin.groups + description: AppConfig type values. + Tag: + type: object + additionalProperties: false + properties: + Value: + description: The key of the tag. + type: string + minLength: 0 + maxLength: 256 + Key: + description: The value of the tag. + type: string + minLength: 0 + maxLength: 128 + required: + - Value + - Key + AppConfig: + type: object + description: A key-value pair of AppConfig + properties: + Key: + $ref: '#/components/schemas/AppConfigType' + description: The configuration key + Value: + type: string + maxLength: 256 + minLength: 0 + description: The configuration value. + required: + - Key + - Value + additionalProperties: false + DataSource: + type: object + description: Datasource arn and description + properties: + DataSourceArn: + type: string + description: The ARN of the data source. + DataSourceDescription: + type: string + description: Description of the data source. + required: + - DataSourceArn + additionalProperties: false + Application: + type: object + properties: + IamIdentityCenterOptions: + type: object + description: Options for configuring IAM Identity Center + properties: + Enabled: + type: boolean + description: Whether IAM Identity Center is enabled. + IamIdentityCenterInstanceArn: + type: string + description: The ARN of the IAM Identity Center instance. + IamRoleForIdentityCenterApplicationArn: + type: string + description: The ARN of the IAM role for Identity Center application. + additionalProperties: false + Arn: + type: string + description: Amazon Resource Name (ARN) format. + Id: + type: string + maxLength: 40 + minLength: 3 + description: The identifier of the application. + Name: + type: string + pattern: '[a-z][a-z0-9\-]+' + minLength: 3 + maxLength: 40 + description: The name of the application. + Endpoint: + type: string + description: The endpoint for the application. + AppConfigs: + type: array + items: + $ref: '#/components/schemas/AppConfig' + description: List of application configurations. + x-insertionOrder: false + DataSources: + type: array + items: + $ref: '#/components/schemas/DataSource' + description: List of data sources. + x-insertionOrder: false + Tags: + description: An arbitrary set of tags (key-value pairs) for this application. + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: true + required: + - Name + x-stackql-resource-name: application + description: Amazon OpenSearchService application resource + x-type-name: AWS::OpenSearchService::Application + x-stackql-primary-identifier: + - Name + x-stackql-additional-identifiers: + - - Arn + x-create-only-properties: + - Name + x-read-only-properties: + - Id + - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - es:AddTags + - es:RemoveTags + - es:ListTags + x-required-permissions: + create: + - es:CreateApplication + - es:GetApplication + - es:AddTags + - es:ListTags + - iam:CreateServiceLinkedRole + read: + - es:GetApplication + - es:ListTags + update: + - es:UpdateApplication + - es:GetApplication + - es:AddTags + - es:RemoveTags + - es:ListTags + delete: + - es:GetApplication + - es:DeleteApplication + list: + - es:ListApplications ZoneAwarenessConfig: type: object additionalProperties: false properties: AvailabilityZoneCount: type: integer + NodeConfig: + type: object + properties: + Enabled: + type: boolean + Type: + type: string + Count: + type: integer + additionalProperties: false + NodeOption: + type: object + properties: + NodeType: + type: string + enum: + - coordinator + NodeConfig: + $ref: '#/components/schemas/NodeConfig' + additionalProperties: false ClusterConfig: type: object additionalProperties: false @@ -39,6 +590,10 @@ components: type: boolean ColdStorageOptions: $ref: '#/components/schemas/ColdStorageOptions' + NodeOptions: + type: array + items: + $ref: '#/components/schemas/NodeOption' LogPublishingOption: type: object additionalProperties: false @@ -140,6 +695,28 @@ components: type: string SessionTimeoutMinutes: type: integer + JWTOptions: + type: object + additionalProperties: false + properties: + Enabled: + type: boolean + PublicKey: + type: string + SubjectKey: + type: string + RolesKey: + type: string + IAMFederationOptions: + type: object + additionalProperties: false + properties: + Enabled: + type: boolean + RolesKey: + type: string + SubjectKey: + type: string AdvancedSecurityOptionsInput: type: object additionalProperties: false @@ -154,6 +731,10 @@ components: type: boolean SAMLOptions: $ref: '#/components/schemas/SAMLOptions' + JWTOptions: + $ref: '#/components/schemas/JWTOptions' + IAMFederationOptions: + $ref: '#/components/schemas/IAMFederationOptions' AnonymousAuthDisableDate: type: string EBSOptions: @@ -178,23 +759,6 @@ components: type: string Enabled: type: boolean - Tag: - type: object - additionalProperties: false - properties: - Value: - description: The key of the tag. - type: string - minLength: 0 - maxLength: 256 - Key: - description: The value of the tag. - type: string - minLength: 0 - maxLength: 128 - required: - - Value - - Key ServiceSoftwareOptions: type: object additionalProperties: false @@ -256,6 +820,42 @@ components: properties: Enabled: type: boolean + SubjectKeyIdcType: + type: string + enum: + - UserName + - UserId + - Email + description: Subject Key Idc type values. + RolesKeyIdcType: + type: string + enum: + - GroupName + - GroupId + description: Roles Key Idc type values. + IdentityCenterOptions: + type: object + description: Options for configuring Identity Center + properties: + EnabledAPIAccess: + type: boolean + description: Whether Identity Center is enabled. + IdentityCenterInstanceARN: + type: string + description: The ARN of the Identity Center instance. + SubjectKey: + $ref: '#/components/schemas/SubjectKeyIdcType' + description: The subject key for Identity Center options. + RolesKey: + $ref: '#/components/schemas/RolesKeyIdcType' + description: The roles key for Identity Center options. + IdentityCenterApplicationARN: + type: string + description: The ARN of the Identity Center application. + IdentityStoreId: + type: string + description: The IdentityStoreId for Identity Center options. + additionalProperties: false Domain: type: object properties: @@ -325,11 +925,25 @@ components: $ref: '#/components/schemas/OffPeakWindowOptions' SoftwareUpdateOptions: $ref: '#/components/schemas/SoftwareUpdateOptions' + SkipShardMigrationWait: + type: boolean + IdentityCenterOptions: + $ref: '#/components/schemas/IdentityCenterOptions' x-stackql-resource-name: domain - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::OpenSearchService::Domain + x-stackql-primary-identifier: - DomainName x-create-only-properties: - DomainName + x-conditional-create-only-properties: + - EncryptionAtRestOptions/properties + - AdvancedSecurityOptions/properties/Enabled + x-write-only-properties: + - AdvancedSecurityOptions/MasterUserOptions + - AdvancedSecurityOptions/SAMLOptions/MasterUserName + - AdvancedSecurityOptions/SAMLOptions/MasterBackendRole + - AdvancedSecurityOptions/JWTOptions/PublicKey x-read-only-properties: - Id - Arn @@ -339,12 +953,25 @@ components: - DomainEndpoints - ServiceSoftwareOptions - AdvancedSecurityOptions/AnonymousAuthDisableDate + - IdentityCenterOptions/IdentityCenterApplicationARN + - IdentityCenterOptions/IdentityStoreId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - es:AddTags + - es:RemoveTags + - es:ListTags x-required-permissions: create: - es:CreateDomain - es:DescribeDomain - es:AddTags - es:ListTags + - es:DescribeDomainChangeProgress read: - es:DescribeDomain - es:ListTags @@ -359,18 +986,348 @@ components: delete: - es:DeleteDomain - es:DescribeDomain + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IamIdentityCenterOptions: + type: object + description: Options for configuring IAM Identity Center + properties: + Enabled: + type: boolean + description: Whether IAM Identity Center is enabled. + IamIdentityCenterInstanceArn: + type: string + description: The ARN of the IAM Identity Center instance. + IamRoleForIdentityCenterApplicationArn: + type: string + description: The ARN of the IAM role for Identity Center application. + additionalProperties: false + Arn: + type: string + description: Amazon Resource Name (ARN) format. + Id: + type: string + maxLength: 40 + minLength: 3 + description: The identifier of the application. + Name: + type: string + pattern: '[a-z][a-z0-9\-]+' + minLength: 3 + maxLength: 40 + description: The name of the application. + Endpoint: + type: string + description: The endpoint for the application. + AppConfigs: + type: array + items: + $ref: '#/components/schemas/AppConfig' + description: List of application configurations. + x-insertionOrder: false + DataSources: + type: array + items: + $ref: '#/components/schemas/DataSource' + description: List of data sources. + x-insertionOrder: false + Tags: + description: An arbitrary set of tags (key-value pairs) for this application. + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterConfig: + $ref: '#/components/schemas/ClusterConfig' + DomainName: + type: string + AccessPolicies: + type: object + IPAddressType: + type: string + EngineVersion: + type: string + AdvancedOptions: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + LogPublishingOptions: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + $ref: '#/components/schemas/LogPublishingOption' + SnapshotOptions: + $ref: '#/components/schemas/SnapshotOptions' + VPCOptions: + $ref: '#/components/schemas/VPCOptions' + NodeToNodeEncryptionOptions: + $ref: '#/components/schemas/NodeToNodeEncryptionOptions' + DomainEndpointOptions: + $ref: '#/components/schemas/DomainEndpointOptions' + CognitoOptions: + $ref: '#/components/schemas/CognitoOptions' + AdvancedSecurityOptions: + $ref: '#/components/schemas/AdvancedSecurityOptionsInput' + DomainEndpoint: + type: string + DomainEndpointV2: + type: string + DomainEndpoints: + type: object + additionalProperties: false + x-patternProperties: + ^.*$: + type: string + EBSOptions: + $ref: '#/components/schemas/EBSOptions' + Id: + type: string + Arn: + type: string + DomainArn: + type: string + EncryptionAtRestOptions: + $ref: '#/components/schemas/EncryptionAtRestOptions' + Tags: + description: An arbitrary set of tags (key-value pairs) for this Domain. + items: + $ref: '#/components/schemas/Tag' + type: array + uniqueItems: true + ServiceSoftwareOptions: + $ref: '#/components/schemas/ServiceSoftwareOptions' + OffPeakWindowOptions: + $ref: '#/components/schemas/OffPeakWindowOptions' + SoftwareUpdateOptions: + $ref: '#/components/schemas/SoftwareUpdateOptions' + SkipShardMigrationWait: + type: boolean + IdentityCenterOptions: + $ref: '#/components/schemas/IdentityCenterOptions' + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - domain: - name: domain - id: awscc.opensearchservice.domain + applications: + name: applications + id: awscc.opensearchservice.applications + x-cfn-schema-name: Application + x-cfn-type-name: AWS::OpenSearchService::Application + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchService::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchService::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchService::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.IamIdentityCenterOptions') as iam_identity_center_options, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.AppConfigs') as app_configs, + JSON_EXTRACT(Properties, '$.DataSources') as data_sources, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchService::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IamIdentityCenterOptions') as iam_identity_center_options, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'AppConfigs') as app_configs, + json_extract_path_text(Properties, 'DataSources') as data_sources, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchService::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.opensearchservice.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::OpenSearchService::Application + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchService::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchService::Application' + AND region = 'us-east-1' + domains: + name: domains + id: awscc.opensearchservice.domains x-cfn-schema-name: Domain - x-type: get + x-cfn-type-name: AWS::OpenSearchService::Domain x-identifiers: - DomainName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchService::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchService::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OpenSearchService::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -399,12 +1356,14 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.ServiceSoftwareOptions') as service_software_options, JSON_EXTRACT(Properties, '$.OffPeakWindowOptions') as off_peak_window_options, - JSON_EXTRACT(Properties, '$.SoftwareUpdateOptions') as software_update_options + JSON_EXTRACT(Properties, '$.SoftwareUpdateOptions') as software_update_options, + JSON_EXTRACT(Properties, '$.SkipShardMigrationWait') as skip_shard_migration_wait, + JSON_EXTRACT(Properties, '$.IdentityCenterOptions') as identity_center_options FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchService::Domain' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -433,7 +1392,246 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'ServiceSoftwareOptions') as service_software_options, json_extract_path_text(Properties, 'OffPeakWindowOptions') as off_peak_window_options, - json_extract_path_text(Properties, 'SoftwareUpdateOptions') as software_update_options + json_extract_path_text(Properties, 'SoftwareUpdateOptions') as software_update_options, + json_extract_path_text(Properties, 'SkipShardMigrationWait') as skip_shard_migration_wait, + json_extract_path_text(Properties, 'IdentityCenterOptions') as identity_center_options FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchService::Domain' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/opsworkscm.yaml b/providers/src/awscc/v00.00.00000/services/opsworkscm.yaml deleted file mode 100644 index 88d224c2..00000000 --- a/providers/src/awscc/v00.00.00000/services/opsworkscm.yaml +++ /dev/null @@ -1,271 +0,0 @@ -openapi: 3.0.0 -info: - title: OpsWorksCM - version: 1.0.0 -paths: {} -components: - schemas: - EngineAttribute: - type: object - additionalProperties: false - properties: - Value: - type: string - pattern: (?s).* - maxLength: 10000 - Name: - type: string - pattern: (?s).* - maxLength: 10000 - Tag: - type: object - additionalProperties: false - properties: - Value: - type: string - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ - minLength: 0 - maxLength: 256 - Key: - type: string - pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ - minLength: 1 - maxLength: 128 - required: - - Value - - Key - Server: - type: object - properties: - KeyPair: - type: string - pattern: .* - maxLength: 10000 - EngineVersion: - type: string - maxLength: 10000 - ServiceRoleArn: - type: string - pattern: arn:aws:iam::[0-9]{12}:role/.* - maxLength: 10000 - DisableAutomatedBackup: - type: boolean - BackupId: - type: string - pattern: '[a-zA-Z][a-zA-Z0-9\-\.\:]*' - maxLength: 79 - EngineModel: - type: string - maxLength: 10000 - PreferredMaintenanceWindow: - type: string - pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$ - maxLength: 10000 - AssociatePublicIpAddress: - type: boolean - InstanceProfileArn: - type: string - pattern: arn:aws:iam::[0-9]{12}:instance-profile/.* - maxLength: 10000 - CustomCertificate: - type: string - pattern: (?s)\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\s* - maxLength: 2097152 - PreferredBackupWindow: - type: string - pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$ - maxLength: 10000 - SecurityGroupIds: - type: array - uniqueItems: false - items: - type: string - maxLength: 10000 - SubnetIds: - type: array - uniqueItems: false - items: - type: string - maxLength: 10000 - CustomDomain: - type: string - pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$ - maxLength: 253 - Endpoint: - type: string - maxLength: 10000 - CustomPrivateKey: - type: string - pattern: (?ms)\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\s* - maxLength: 4096 - ServerName: - type: string - minLength: 1 - maxLength: 40 - pattern: '[a-zA-Z][a-zA-Z0-9\-]*' - EngineAttributes: - type: array - uniqueItems: false - items: - $ref: '#/components/schemas/EngineAttribute' - BackupRetentionCount: - type: integer - minLength: 1 - Arn: - type: string - maxLength: 10000 - InstanceType: - type: string - maxLength: 10000 - Tags: - type: array - uniqueItems: false - items: - $ref: '#/components/schemas/Tag' - Engine: - type: string - maxLength: 10000 - required: - - ServiceRoleArn - - InstanceProfileArn - - InstanceType - x-stackql-resource-name: server - x-stackql-primaryIdentifier: - - ServerName - x-create-only-properties: - - KeyPair - - CustomPrivateKey - - ServiceRoleArn - - InstanceType - - CustomCertificate - - CustomDomain - - InstanceProfileArn - - SecurityGroupIds - - ServerName - - SubnetIds - - BackupId - - EngineModel - - AssociatePublicIpAddress - - EngineVersion - - Engine - x-read-only-properties: - - ServerName - - Endpoint - - Arn - x-required-permissions: - create: - - opsworks-cm:CreateServer - - opsworks-cm:DescribeServers - - iam:PassRole - delete: - - opsworks-cm:DeleteServer - - opsworks-cm:DescribeServers - update: - - opsworks-cm:UpdateServer - - opsworks-cm:TagResource - - opsworks-cm:UntagResource - - opsworks-cm:DescribeServers - list: - - opsworks-cm:DescribeServers - - opsworks-cm:ListTagsForResource - read: - - opsworks-cm:DescribeServers - x-stackQL-resources: - servers: - name: servers - id: awscc.opsworkscm.servers - x-cfn-schema-name: Server - x-type: list - x-identifiers: - - ServerName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServerName') as server_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServerName') as server_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND region = 'us-east-1' - server: - name: server - id: awscc.opsworkscm.server - x-cfn-schema-name: Server - x-type: get - x-identifiers: - - ServerName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.KeyPair') as key_pair, - JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, - JSON_EXTRACT(Properties, '$.ServiceRoleArn') as service_role_arn, - JSON_EXTRACT(Properties, '$.DisableAutomatedBackup') as disable_automated_backup, - JSON_EXTRACT(Properties, '$.BackupId') as backup_id, - JSON_EXTRACT(Properties, '$.EngineModel') as engine_model, - JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, - JSON_EXTRACT(Properties, '$.AssociatePublicIpAddress') as associate_public_ip_address, - JSON_EXTRACT(Properties, '$.InstanceProfileArn') as instance_profile_arn, - JSON_EXTRACT(Properties, '$.CustomCertificate') as custom_certificate, - JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, - JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, - JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, - JSON_EXTRACT(Properties, '$.CustomDomain') as custom_domain, - JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, - JSON_EXTRACT(Properties, '$.CustomPrivateKey') as custom_private_key, - JSON_EXTRACT(Properties, '$.ServerName') as server_name, - JSON_EXTRACT(Properties, '$.EngineAttributes') as engine_attributes, - JSON_EXTRACT(Properties, '$.BackupRetentionCount') as backup_retention_count, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Engine') as engine - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'KeyPair') as key_pair, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'ServiceRoleArn') as service_role_arn, - json_extract_path_text(Properties, 'DisableAutomatedBackup') as disable_automated_backup, - json_extract_path_text(Properties, 'BackupId') as backup_id, - json_extract_path_text(Properties, 'EngineModel') as engine_model, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, - json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, - json_extract_path_text(Properties, 'CustomCertificate') as custom_certificate, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'CustomDomain') as custom_domain, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'CustomPrivateKey') as custom_private_key, - json_extract_path_text(Properties, 'ServerName') as server_name, - json_extract_path_text(Properties, 'EngineAttributes') as engine_attributes, - json_extract_path_text(Properties, 'BackupRetentionCount') as backup_retention_count, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Engine') as engine - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND data__Identifier = '' - AND region = 'us-east-1' diff --git a/providers/src/awscc/v00.00.00000/services/organizations.yaml b/providers/src/awscc/v00.00.00000/services/organizations.yaml index a632248c..f4da4a6d 100644 --- a/providers/src/awscc/v00.00.00000/services/organizations.yaml +++ b/providers/src/awscc/v00.00.00000/services/organizations.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Organizations - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A custom key-value pair associated with a resource within your organization. @@ -89,19 +469,37 @@ components: - AccountName - Email x-stackql-resource-name: account - x-stackql-primaryIdentifier: + description: You can use AWS::Organizations::Account to manage accounts in organization. + x-type-name: AWS::Organizations::Account + x-stackql-primary-identifier: - AccountId + x-write-only-properties: + - RoleName x-read-only-properties: - AccountId - Status - JoinedTimestamp - JoinedMethod - Arn + x-required-properties: + - AccountName + - Email + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - organizations:TagResource + - organizations:UntagResource + - organizations:ListTagsForResource x-required-permissions: create: - organizations:CreateAccount - organizations:DescribeCreateAccountStatus - organizations:MoveAccount + - organizations:ListAccounts - organizations:ListParents - organizations:TagResource - organizations:DescribeAccount @@ -160,7 +558,9 @@ components: pattern: ^r-[0-9a-z]{4,32}$ maxLength: 64 x-stackql-resource-name: organization - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Organizations::Organization + x-type-name: AWS::Organizations::Organization + x-stackql-primary-identifier: - Id x-read-only-properties: - Id @@ -169,6 +569,8 @@ components: - ManagementAccountId - ManagementAccountEmail - RootId + x-tagging: + taggable: false x-required-permissions: create: - organizations:CreateOrganization @@ -183,7 +585,8 @@ components: - organizations:DescribeOrganization list: - organizations:DescribeOrganization - update: [] + update: + - organizations:DescribeOrganization OrganizationalUnit: type: object properties: @@ -218,18 +621,36 @@ components: - Name - ParentId x-stackql-resource-name: organizational_unit - x-stackql-primaryIdentifier: + description: >- + You can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must + be unique within a parent OU or root. + x-type-name: AWS::Organizations::OrganizationalUnit + x-stackql-primary-identifier: - Id x-create-only-properties: - ParentId x-read-only-properties: - Arn - Id + x-required-properties: + - Name + - ParentId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - organizations:TagResource + - organizations:UntagResource + - organizations:ListTagsForResource x-required-permissions: create: - organizations:CreateOrganizationalUnit - organizations:DescribeOrganizationalUnit - organizations:ListParents + - organizations:ListOrganizationalUnitsForParent - organizations:ListTagsForResource - organizations:TagResource read: @@ -257,13 +678,17 @@ components: minLength: 1 maxLength: 128 Type: - description: 'The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY' + description: 'The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY' type: string enum: - SERVICE_CONTROL_POLICY - AISERVICES_OPT_OUT_POLICY - BACKUP_POLICY - TAG_POLICY + - CHATBOT_POLICY + - RESOURCE_CONTROL_POLICY + - DECLARATIVE_POLICY_EC2 + - SECURITYHUB_POLICY Content: description: The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it. type: object @@ -307,7 +732,9 @@ components: - Type - Content x-stackql-resource-name: policy - x-stackql-primaryIdentifier: + description: Policies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization. + x-type-name: AWS::Organizations::Policy + x-stackql-primary-identifier: - Id x-create-only-properties: - Type @@ -315,11 +742,26 @@ components: - Id - Arn - AwsManaged + x-required-properties: + - Name + - Type + - Content + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - organizations:TagResource + - organizations:UntagResource + - organizations:ListTagsForResource x-required-permissions: create: - organizations:CreatePolicy - organizations:DescribePolicy - organizations:AttachPolicy + - organizations:ListPolicies - organizations:ListTagsForResource - organizations:ListTargetsForPolicy - organizations:TagResource @@ -369,11 +811,25 @@ components: required: - Content x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: + description: You can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account. + x-type-name: AWS::Organizations::ResourcePolicy + x-stackql-primary-identifier: - Id x-read-only-properties: - Id - Arn + x-required-properties: + - Content + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - organizations:TagResource + - organizations:UntagResource + - organizations:ListTagsForResource x-required-permissions: create: - organizations:PutResourcePolicy @@ -393,43 +849,356 @@ components: - organizations:DeleteResourcePolicy list: - organizations:DescribeResourcePolicy + CreateAccountRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountName: + description: The friendly name of the member account. + type: string + pattern: '[\u0020-\u007E]+' + minLength: 1 + maxLength: 50 + Email: + description: The email address of the owner to assign to the new member account. + type: string + pattern: '[^\s@]+@[^\s@]+\.[^\s@]+' + minLength: 6 + maxLength: 64 + RoleName: + description: The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified. + type: string + default: OrganizationAccountAccessRole + pattern: '[\w+=,.@-]{1,64}' + minLength: 1 + maxLength: 64 + ParentIds: + description: List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root. + type: array + x-insertionOrder: false + uniqueItems: true + items: + type: string + pattern: ^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$ + Tags: + description: A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AccountId: + description: If the account was created successfully, the unique identifier (ID) of the new account. + type: string + pattern: ^\d{12}$ + maxLength: 12 + Arn: + description: The Amazon Resource Name (ARN) of the account. + type: string + pattern: ^arn:aws.*:organizations::\d{12}:account\/o-[a-z0-9]{10,32}\/\d{12} + JoinedMethod: + description: The method by which the account joined the organization. + type: string + enum: + - INVITED + - CREATED + JoinedTimestamp: + description: The date the account became a part of the organization. + type: string + Status: + description: The status of the account in the organization. + type: string + enum: + - ACTIVE + - SUSPENDED + - PENDING_CLOSURE + x-stackQL-stringOnly: true + x-title: CreateAccountRequest + type: object + required: [] + CreateOrganizationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The unique identifier (ID) of an organization. + type: string + pattern: ^o-[a-z0-9]{10,32}$ + Arn: + description: The Amazon Resource Name (ARN) of an organization. + type: string + pattern: ^arn:aws.*:organizations::\d{12}:organization\/o-[a-z0-9]{10,32} + FeatureSet: + description: Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality. + type: string + enum: + - ALL + - CONSOLIDATED_BILLING + default: ALL + ManagementAccountArn: + description: The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. + type: string + pattern: ^arn:aws.*:organizations::\d{12}:account\/o-[a-z0-9]{10,32}\/\d{12} + ManagementAccountId: + description: The unique identifier (ID) of the management account of an organization. + type: string + pattern: ^\d{12}$ + ManagementAccountEmail: + description: The email address that is associated with the AWS account that is designated as the management account for the organization. + type: string + pattern: '[^\s@]+@[^\s@]+\.[^\s@]+' + minLength: 6 + maxLength: 64 + RootId: + description: The unique identifier (ID) for the root. + type: string + pattern: ^r-[0-9a-z]{4,32}$ + maxLength: 64 + x-stackQL-stringOnly: true + x-title: CreateOrganizationRequest + type: object + required: [] + CreateOrganizationalUnitRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of this OU. + type: string + pattern: ^arn:aws.*:organizations::\d{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32} + Id: + description: The unique identifier (ID) associated with this OU. + type: string + pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$ + maxLength: 68 + Name: + description: The friendly name of this OU. + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 128 + ParentId: + description: The unique identifier (ID) of the parent root or OU that you want to create the new OU in. + type: string + pattern: ^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$ + maxLength: 100 + Tags: + description: A list of tags that you want to attach to the newly created OU. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOrganizationalUnitRequest + type: object + required: [] + CreatePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the Policy + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 128 + Type: + description: 'The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2, SECURITYHUB_POLICY' + type: string + enum: + - SERVICE_CONTROL_POLICY + - AISERVICES_OPT_OUT_POLICY + - BACKUP_POLICY + - TAG_POLICY + - CHATBOT_POLICY + - RESOURCE_CONTROL_POLICY + - DECLARATIVE_POLICY_EC2 + - SECURITYHUB_POLICY + Content: + description: The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it. + type: object + pattern: '[\s\S]*' + minLength: 1 + maxLength: 1000000 + Description: + description: Human readable description of the policy + pattern: '[\s\S]*' + type: string + maxLength: 512 + TargetIds: + description: List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to + type: array + x-insertionOrder: false + uniqueItems: true + items: + type: string + pattern: ^(r-[0-9a-z]{4,32})|(\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$ + Tags: + description: A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Id: + description: Id of the Policy + type: string + pattern: ^p-[0-9a-zA-Z_]{8,128}$ + maxLength: 130 + Arn: + description: ARN of the Policy + type: string + pattern: ^arn:aws.*:organizations::[0-9]{12}:policy/o-[a-z0-9]{10}/(service_control|tag|backup|aiservices_opt_out)_policy/p-[a-z0-9]{8} + AwsManaged: + description: A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it. + type: boolean + x-stackQL-stringOnly: true + x-title: CreatePolicyRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The unique identifier (ID) associated with this resource policy. + type: string + pattern: ^rp-[0-9a-zA-Z_]{4,128}$ + maxLength: 131 + Arn: + description: The Amazon Resource Name (ARN) of the resource policy. + type: string + pattern: ^arn:aws.*:organizations::\d{12}:resourcepolicy\/o-[a-z0-9]{10,32}\/rp-[0-9a-zA-Z_]{4,128} + Content: + description: The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it. + type: object + pattern: '[\s\S]*' + minLength: 1 + maxLength: 40000 + Tags: + description: A list of tags that you want to attach to the resource policy + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: accounts: name: accounts id: awscc.organizations.accounts x-cfn-schema-name: Account - x-type: list - x-identifiers: - - AccountId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' - AND region = 'us-east-1' - account: - name: account - id: awscc.organizations.account - x-cfn-schema-name: Account - x-type: get + x-cfn-type-name: AWS::Organizations::Account x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Account&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -448,7 +1217,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -466,13 +1235,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Account' AND data__Identifier = '' AND region = 'us-east-1' - organizations: - name: organizations - id: awscc.organizations.organizations - x-cfn-schema-name: Organization - x-type: list + accounts_list_only: + name: accounts_list_only + id: awscc.organizations.accounts_list_only + x-cfn-schema-name: Account + x-cfn-type-name: AWS::Organizations::Account x-identifiers: - - Id + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -480,28 +1255,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' AND region = 'us-east-1' - organization: - name: organization - id: awscc.organizations.organization + organizations: + name: organizations + id: awscc.organizations.organizations x-cfn-schema-name: Organization - x-type: get + x-cfn-type-name: AWS::Organizations::Organization x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Organization&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Organization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Organization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Organization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organizations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organizations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/organizations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -517,7 +1340,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -532,13 +1355,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Organization' AND data__Identifier = '' AND region = 'us-east-1' - organizational_units: - name: organizational_units - id: awscc.organizations.organizational_units - x-cfn-schema-name: OrganizationalUnit - x-type: list + organizations_list_only: + name: organizations_list_only + id: awscc.organizations.organizations_list_only + x-cfn-schema-name: Organization + x-cfn-type-name: AWS::Organizations::Organization x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -547,7 +1376,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -555,19 +1384,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' AND region = 'us-east-1' - organizational_unit: - name: organizational_unit - id: awscc.organizations.organizational_unit + organizational_units: + name: organizational_units + id: awscc.organizations.organizational_units x-cfn-schema-name: OrganizationalUnit - x-type: get + x-cfn-type-name: AWS::Organizations::OrganizationalUnit x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationalUnit&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::OrganizationalUnit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::OrganizationalUnit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::OrganizationalUnit" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organizational_units/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organizational_units/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/organizational_units/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -581,7 +1458,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -594,13 +1471,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' AND data__Identifier = '' AND region = 'us-east-1' - policies: - name: policies - id: awscc.organizations.policies - x-cfn-schema-name: Policy - x-type: list + organizational_units_list_only: + name: organizational_units_list_only + id: awscc.organizations.organizational_units_list_only + x-cfn-schema-name: OrganizationalUnit + x-cfn-type-name: AWS::Organizations::OrganizationalUnit x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -609,7 +1492,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -617,19 +1500,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' AND region = 'us-east-1' - policy: - name: policy - id: awscc.organizations.policy + policies: + name: policies + id: awscc.organizations.policies x-cfn-schema-name: Policy - x-type: get + x-cfn-type-name: AWS::Organizations::Policy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -647,7 +1578,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -664,13 +1595,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Policy' AND data__Identifier = '' AND region = 'us-east-1' - resource_policies: - name: resource_policies - id: awscc.organizations.resource_policies - x-cfn-schema-name: ResourcePolicy - x-type: list + policies_list_only: + name: policies_list_only + id: awscc.organizations.policies_list_only + x-cfn-schema-name: Policy + x-cfn-type-name: AWS::Organizations::Policy x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -679,7 +1616,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -687,19 +1624,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.organizations.resource_policy + resource_policies: + name: resource_policies + id: awscc.organizations.resource_policies x-cfn-schema-name: ResourcePolicy - x-type: get + x-cfn-type-name: AWS::Organizations::ResourcePolicy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Organizations::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -712,7 +1697,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -724,3 +1709,397 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' AND data__Identifier = '' AND region = 'us-east-1' + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.organizations.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::Organizations::ResourcePolicy + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Account&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccount + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccountRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Organization&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganization + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationalUnit&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationalUnit + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationalUnitRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/osis.yaml b/providers/src/awscc/v00.00.00000/services/osis.yaml index e5e6a03a..1c91e149 100644 --- a/providers/src/awscc/v00.00.00000/services/osis.yaml +++ b/providers/src/awscc/v00.00.00000/services/osis.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: OSIS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: BufferOptions: description: Key-value pairs to configure buffering. @@ -85,6 +465,27 @@ components: minLength: 15 maxLength: 24 pattern: subnet-\w{8}(\w{9})? + VpcEndpointManagement: + description: Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. + type: string + enum: + - CUSTOMER + - SERVICE + VpcAttachmentOptions: + type: object + description: Options for attaching a VPC to the pipeline. + properties: + AttachToVpc: + type: boolean + description: Whether the pipeline should be attached to the provided VPC + CidrBlock: + type: string + description: The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). + pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$ + required: + - AttachToVpc + - CidrBlock + additionalProperties: false required: - SubnetIds additionalProperties: false @@ -111,20 +512,20 @@ components: LogPublishingOptions: $ref: '#/components/schemas/LogPublishingOptions' MaxUnits: - description: The maximum pipeline capacity, in Ingestion Compute Units (ICUs). + description: The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). type: integer minimum: 1 - maximum: 24 + maximum: 384 MinUnits: - description: The minimum pipeline capacity, in Ingestion Compute Units (ICUs). + description: The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). type: integer minimum: 1 - maximum: 24 + maximum: 384 PipelineConfigurationBody: - description: The Data Prepper pipeline configuration in YAML format. + description: The Data Prepper pipeline configuration. type: string minLength: 1 - maxLength: 12000 + maxLength: 100000 PipelineName: description: Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region. type: string @@ -146,6 +547,11 @@ components: description: The VPC interface endpoints that have access to the pipeline. items: $ref: '#/components/schemas/VpcEndpoint' + VpcEndpointService: + description: The VPC endpoint service name for the pipeline. + type: string + minLength: 1 + maxLength: 128 PipelineArn: description: The Amazon Resource Name (ARN) of the pipeline. type: string @@ -164,14 +570,34 @@ components: - PipelineConfigurationBody - PipelineName x-stackql-resource-name: pipeline - x-stackql-primaryIdentifier: + description: An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper. + x-type-name: AWS::OSIS::Pipeline + x-stackql-primary-identifier: - PipelineArn x-create-only-properties: - PipelineName + x-write-only-properties: + - VpcOptions x-read-only-properties: - PipelineArn - IngestEndpointUrls - VpcEndpoints + - VpcEndpointService + x-required-properties: + - MaxUnits + - MinUnits + - PipelineConfigurationBody + - PipelineName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - osis:TagResource + - osis:UntagResource + - osis:ListTagsForResource x-required-permissions: create: - osis:CreatePipeline @@ -204,43 +630,149 @@ components: - logs:ListLogDeliveries list: - osis:ListPipelines + CreatePipelineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BufferOptions: + $ref: '#/components/schemas/BufferOptions' + EncryptionAtRestOptions: + $ref: '#/components/schemas/EncryptionAtRestOptions' + LogPublishingOptions: + $ref: '#/components/schemas/LogPublishingOptions' + MaxUnits: + description: The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). + type: integer + minimum: 1 + maximum: 384 + MinUnits: + description: The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). + type: integer + minimum: 1 + maximum: 384 + PipelineConfigurationBody: + description: The Data Prepper pipeline configuration. + type: string + minLength: 1 + maxLength: 100000 + PipelineName: + description: Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region. + type: string + minLength: 3 + maxLength: 28 + pattern: '[a-z][a-z0-9\-]+' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + VpcOptions: + $ref: '#/components/schemas/VpcOptions' + VpcEndpoints: + type: array + x-insertionOrder: false + description: The VPC interface endpoints that have access to the pipeline. + items: + $ref: '#/components/schemas/VpcEndpoint' + VpcEndpointService: + description: The VPC endpoint service name for the pipeline. + type: string + minLength: 1 + maxLength: 128 + PipelineArn: + description: The Amazon Resource Name (ARN) of the pipeline. + type: string + minLength: 46 + maxLength: 76 + pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$ + IngestEndpointUrls: + type: array + x-insertionOrder: false + description: A list of endpoints that can be used for ingesting data into a pipeline + items: + type: string + x-stackQL-stringOnly: true + x-title: CreatePipelineRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: pipelines: name: pipelines id: awscc.osis.pipelines x-cfn-schema-name: Pipeline - x-type: list - x-identifiers: - - PipelineArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PipelineArn') as pipeline_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' - AND region = 'us-east-1' - pipeline: - name: pipeline - id: awscc.osis.pipeline - x-cfn-schema-name: Pipeline - x-type: get + x-cfn-type-name: AWS::OSIS::Pipeline x-identifiers: - PipelineArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OSIS::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OSIS::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::OSIS::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -255,13 +787,14 @@ components: JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.VpcOptions') as vpc_options, JSON_EXTRACT(Properties, '$.VpcEndpoints') as vpc_endpoints, + JSON_EXTRACT(Properties, '$.VpcEndpointService') as vpc_endpoint_service, JSON_EXTRACT(Properties, '$.PipelineArn') as pipeline_arn, JSON_EXTRACT(Properties, '$.IngestEndpointUrls') as ingest_endpoint_urls FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OSIS::Pipeline' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -276,8 +809,235 @@ components: json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'VpcOptions') as vpc_options, json_extract_path_text(Properties, 'VpcEndpoints') as vpc_endpoints, + json_extract_path_text(Properties, 'VpcEndpointService') as vpc_endpoint_service, json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn, json_extract_path_text(Properties, 'IngestEndpointUrls') as ingest_endpoint_urls FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::OSIS::Pipeline' AND data__Identifier = '' AND region = 'us-east-1' + pipelines_list_only: + name: pipelines_list_only + id: awscc.osis.pipelines_list_only + x-cfn-schema-name: Pipeline + x-cfn-type-name: AWS::OSIS::Pipeline + x-identifiers: + - PipelineArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PipelineArn') as pipeline_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePipeline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePipelineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/panorama.yaml b/providers/src/awscc/v00.00.00000/services/panorama.yaml index e2fb9ba2..521a26a7 100644 --- a/providers/src/awscc/v00.00.00000/services/panorama.yaml +++ b/providers/src/awscc/v00.00.00000/services/panorama.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Panorama - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DefaultRuntimeContextDevice: minLength: 1 @@ -34,10 +414,12 @@ components: - REMOVAL_FAILED - REMOVAL_SUCCEEDED ManifestOverridesPayload: + description: Parameter overrides for an application instance. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the overrides document. additionalProperties: false type: object properties: PayloadData: + description: The overrides document. $ref: '#/components/schemas/ManifestOverridesPayloadData' RuntimeRoleArn: minLength: 1 @@ -83,10 +465,12 @@ components: items: $ref: '#/components/schemas/Tag' ManifestPayload: + description: A application verion's manifest file. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the application manifest (``graph.json``). This file is located in the ``graphs`` folder in your application source. additionalProperties: false type: object properties: PayloadData: + description: The application manifest. $ref: '#/components/schemas/ManifestPayloadData' ApplicationInstanceArn: minLength: 1 @@ -109,15 +493,18 @@ components: minLength: 1 maxLength: 128 pattern: ^.+$ + description: '' Value: type: string minLength: 0 maxLength: 256 pattern: ^.+$ + description: '' required: - Key - Value additionalProperties: false + description: '' DeviceName: minLength: 1 pattern: ^[a-zA-Z0-9\-\_]+$ @@ -127,42 +514,60 @@ components: type: object properties: DefaultRuntimeContextDeviceName: + description: '' $ref: '#/components/schemas/DeviceName' Status: + description: '' $ref: '#/components/schemas/ApplicationInstanceStatus' DefaultRuntimeContextDevice: + description: The device's ID. $ref: '#/components/schemas/DefaultRuntimeContextDevice' Description: + description: A description for the application instance. $ref: '#/components/schemas/Description' ApplicationInstanceIdToReplace: + description: The ID of an application instance to replace with the new instance. $ref: '#/components/schemas/ApplicationInstanceId' CreatedTime: + description: '' $ref: '#/components/schemas/Timestamp' HealthStatus: + description: '' $ref: '#/components/schemas/ApplicationInstanceHealthStatus' ManifestOverridesPayload: + description: Setting overrides for the application manifest. $ref: '#/components/schemas/ManifestOverridesPayload' LastUpdatedTime: + description: '' $ref: '#/components/schemas/Timestamp' RuntimeRoleArn: + description: The ARN of a runtime role for the application instance. $ref: '#/components/schemas/RuntimeRoleArn' Name: + description: A name for the application instance. $ref: '#/components/schemas/Name' ApplicationInstanceId: + description: '' $ref: '#/components/schemas/ApplicationInstanceId' StatusDescription: + description: '' $ref: '#/components/schemas/ApplicationInstanceStatusDescription' ManifestPayload: + description: The application's manifest document. $ref: '#/components/schemas/ManifestPayload' Arn: + description: '' $ref: '#/components/schemas/ApplicationInstanceArn' Tags: + description: Tags for the application instance. $ref: '#/components/schemas/TagList' required: - ManifestPayload - DefaultRuntimeContextDevice x-stackql-resource-name: application_instance - x-stackql-primaryIdentifier: + description: Creates an application instance and deploys it to a device. + x-type-name: AWS::Panorama::ApplicationInstance + x-stackql-primary-identifier: - ApplicationInstanceId x-create-only-properties: - Name @@ -172,6 +577,8 @@ components: - RuntimeRoleArn - DefaultRuntimeContextDevice - ApplicationInstanceIdToReplace + x-write-only-properties: + - ApplicationInstanceIdToReplace x-read-only-properties: - ApplicationInstanceId - Arn @@ -181,6 +588,19 @@ components: - DefaultRuntimeContextDeviceName - CreatedTime - LastUpdatedTime + x-required-properties: + - ManifestPayload + - DefaultRuntimeContextDevice + x-tagging: + permissions: + - panorama:ListTagsForResource + - panorama:TagResource + - panorama:UntagResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: read: - panorama:DescribeApplicationInstance @@ -243,34 +663,48 @@ components: properties: Bucket: type: string + description: The location's bucket. RepoPrefixLocation: type: string + description: The location's repo prefix. GeneratedPrefixLocation: type: string + description: The location's generated prefix. BinaryPrefixLocation: type: string + description: The location's binary prefix. ManifestPrefixLocation: type: string + description: The location's manifest prefix. additionalProperties: false + description: A storage location. Package: type: object properties: PackageName: $ref: '#/components/schemas/NodePackageName' + description: A name for the package. PackageId: $ref: '#/components/schemas/NodePackageId' + description: '' Arn: $ref: '#/components/schemas/NodePackageArn' + description: '' StorageLocation: $ref: '#/components/schemas/StorageLocation' + description: A storage location. CreatedTime: $ref: '#/components/schemas/Timestamp' + description: '' Tags: $ref: '#/components/schemas/TagList' + description: Tags for the package. required: - PackageName x-stackql-resource-name: package - x-stackql-primaryIdentifier: + description: Creates a package and storage location in an Amazon S3 access point. + x-type-name: AWS::Panorama::Package + x-stackql-primary-identifier: - PackageId x-create-only-properties: - PackageName @@ -283,6 +717,18 @@ components: - StorageLocation/GeneratedPrefixLocation - StorageLocation/BinaryPrefixLocation - StorageLocation/ManifestPrefixLocation + x-required-properties: + - PackageName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - panorama:ListTagsForResource + - panorama:TagResource + - panorama:UntagResource x-required-permissions: create: - panorama:CreatePackage @@ -357,34 +803,48 @@ components: properties: OwnerAccount: $ref: '#/components/schemas/PackageOwnerAccount' + description: An owner account. PackageId: $ref: '#/components/schemas/NodePackageId' + description: A package ID. PackageArn: $ref: '#/components/schemas/NodePackageArn' + description: '' PackageVersion: $ref: '#/components/schemas/NodePackageVersion' + description: A package version. PatchVersion: $ref: '#/components/schemas/NodePackagePatchVersion' + description: A patch version. MarkLatest: type: boolean + description: Whether to mark the new version as the latest version. IsLatestPatch: type: boolean + description: '' PackageName: $ref: '#/components/schemas/NodePackageName' + description: '' Status: $ref: '#/components/schemas/PackageVersionStatus' + description: '' StatusDescription: $ref: '#/components/schemas/PackageVersionStatusDescription' + description: '' RegisteredTime: $ref: '#/components/schemas/TimeStamp' + description: '' UpdatedLatestPatchVersion: $ref: '#/components/schemas/NodePackagePatchVersion' + description: If the version was marked latest, the new version to maker as latest. required: - PackageId - PackageVersion - PatchVersion x-stackql-resource-name: package_version - x-stackql-primaryIdentifier: + description: Registers a package version. + x-type-name: AWS::Panorama::PackageVersion + x-stackql-primary-identifier: - PackageId - PackageVersion - PatchVersion @@ -393,6 +853,8 @@ components: - PackageId - PackageVersion - PatchVersion + x-write-only-properties: + - UpdatedLatestPatchVersion x-read-only-properties: - PackageName - PackageArn @@ -400,6 +862,10 @@ components: - StatusDescription - IsLatestPatch - RegisteredTime + x-required-properties: + - PackageId + - PackageVersion + - PatchVersion x-required-permissions: create: - panorama:RegisterPackageVersion @@ -429,43 +895,226 @@ components: - s3:ListBucket - s3:GetObject - s3:GetObjectVersion + CreateApplicationInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DefaultRuntimeContextDeviceName: + description: '' + $ref: '#/components/schemas/DeviceName' + Status: + description: '' + $ref: '#/components/schemas/ApplicationInstanceStatus' + DefaultRuntimeContextDevice: + description: The device's ID. + $ref: '#/components/schemas/DefaultRuntimeContextDevice' + Description: + description: A description for the application instance. + $ref: '#/components/schemas/Description' + ApplicationInstanceIdToReplace: + description: The ID of an application instance to replace with the new instance. + $ref: '#/components/schemas/ApplicationInstanceId' + CreatedTime: + description: '' + $ref: '#/components/schemas/Timestamp' + HealthStatus: + description: '' + $ref: '#/components/schemas/ApplicationInstanceHealthStatus' + ManifestOverridesPayload: + description: Setting overrides for the application manifest. + $ref: '#/components/schemas/ManifestOverridesPayload' + LastUpdatedTime: + description: '' + $ref: '#/components/schemas/Timestamp' + RuntimeRoleArn: + description: The ARN of a runtime role for the application instance. + $ref: '#/components/schemas/RuntimeRoleArn' + Name: + description: A name for the application instance. + $ref: '#/components/schemas/Name' + ApplicationInstanceId: + description: '' + $ref: '#/components/schemas/ApplicationInstanceId' + StatusDescription: + description: '' + $ref: '#/components/schemas/ApplicationInstanceStatusDescription' + ManifestPayload: + description: The application's manifest document. + $ref: '#/components/schemas/ManifestPayload' + Arn: + description: '' + $ref: '#/components/schemas/ApplicationInstanceArn' + Tags: + description: Tags for the application instance. + $ref: '#/components/schemas/TagList' + x-stackQL-stringOnly: true + x-title: CreateApplicationInstanceRequest + type: object + required: [] + CreatePackageRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PackageName: + $ref: '#/components/schemas/NodePackageName' + description: A name for the package. + PackageId: + $ref: '#/components/schemas/NodePackageId' + description: '' + Arn: + $ref: '#/components/schemas/NodePackageArn' + description: '' + StorageLocation: + $ref: '#/components/schemas/StorageLocation' + description: A storage location. + CreatedTime: + $ref: '#/components/schemas/Timestamp' + description: '' + Tags: + $ref: '#/components/schemas/TagList' + description: Tags for the package. + x-stackQL-stringOnly: true + x-title: CreatePackageRequest + type: object + required: [] + CreatePackageVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OwnerAccount: + $ref: '#/components/schemas/PackageOwnerAccount' + description: An owner account. + PackageId: + $ref: '#/components/schemas/NodePackageId' + description: A package ID. + PackageArn: + $ref: '#/components/schemas/NodePackageArn' + description: '' + PackageVersion: + $ref: '#/components/schemas/NodePackageVersion' + description: A package version. + PatchVersion: + $ref: '#/components/schemas/NodePackagePatchVersion' + description: A patch version. + MarkLatest: + type: boolean + description: Whether to mark the new version as the latest version. + IsLatestPatch: + type: boolean + description: '' + PackageName: + $ref: '#/components/schemas/NodePackageName' + description: '' + Status: + $ref: '#/components/schemas/PackageVersionStatus' + description: '' + StatusDescription: + $ref: '#/components/schemas/PackageVersionStatusDescription' + description: '' + RegisteredTime: + $ref: '#/components/schemas/TimeStamp' + description: '' + UpdatedLatestPatchVersion: + $ref: '#/components/schemas/NodePackagePatchVersion' + description: If the version was marked latest, the new version to maker as latest. + x-stackQL-stringOnly: true + x-title: CreatePackageVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: application_instances: name: application_instances id: awscc.panorama.application_instances x-cfn-schema-name: ApplicationInstance - x-type: list + x-cfn-type-name: AWS::Panorama::ApplicationInstance x-identifiers: - ApplicationInstanceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::ApplicationInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::ApplicationInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::ApplicationInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/application_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationInstanceId') as application_instance_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationInstanceId') as application_instance_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' - AND region = 'us-east-1' - application_instance: - name: application_instance - id: awscc.panorama.application_instance - x-cfn-schema-name: ApplicationInstance - x-type: get - x-identifiers: - - ApplicationInstanceId - config: - views: - select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -490,7 +1139,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -514,13 +1163,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' AND data__Identifier = '' AND region = 'us-east-1' - packages: - name: packages - id: awscc.panorama.packages - x-cfn-schema-name: Package - x-type: list + application_instances_list_only: + name: application_instances_list_only + id: awscc.panorama.application_instances_list_only + x-cfn-schema-name: ApplicationInstance + x-cfn-type-name: AWS::Panorama::ApplicationInstance x-identifiers: - - PackageId + - ApplicationInstanceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -528,28 +1183,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PackageId') as package_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' + JSON_EXTRACT(Properties, '$.ApplicationInstanceId') as application_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PackageId') as package_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' + json_extract_path_text(Properties, 'ApplicationInstanceId') as application_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' AND region = 'us-east-1' - package: - name: package - id: awscc.panorama.package + packages: + name: packages + id: awscc.panorama.packages x-cfn-schema-name: Package - x-type: get + x-cfn-type-name: AWS::Panorama::Package x-identifiers: - PackageId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Package&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::Package" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::Package" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::Package" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/packages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/packages/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/packages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -564,7 +1267,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -578,19 +1281,98 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::Package' AND data__Identifier = '' AND region = 'us-east-1' - package_version: - name: package_version - id: awscc.panorama.package_version + packages_list_only: + name: packages_list_only + id: awscc.panorama.packages_list_only + x-cfn-schema-name: Package + x-cfn-type-name: AWS::Panorama::Package + x-identifiers: + - PackageId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PackageId') as package_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PackageId') as package_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' + AND region = 'us-east-1' + package_versions: + name: package_versions + id: awscc.panorama.package_versions x-cfn-schema-name: PackageVersion - x-type: get + x-cfn-type-name: AWS::Panorama::PackageVersion x-identifiers: - PackageId - PackageVersion - PatchVersion + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PackageVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::PackageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::PackageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Panorama::PackageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/package_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/package_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/package_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -611,7 +1393,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -631,3 +1413,282 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::PackageVersion' AND data__Identifier = '||' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Package&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePackage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePackageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PackageVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePackageVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePackageVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/paymentcryptography.yaml b/providers/src/awscc/v00.00.00000/services/paymentcryptography.yaml new file mode 100644 index 00000000..14269c2b --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/paymentcryptography.yaml @@ -0,0 +1,1204 @@ +openapi: 3.0.0 +info: + title: PaymentCryptography + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Alias: + type: object + properties: + AliasName: + type: string + maxLength: 256 + minLength: 7 + pattern: ^alias/[a-zA-Z0-9/_-]+$ + KeyArn: + type: string + maxLength: 150 + minLength: 70 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$ + required: + - AliasName + x-stackql-resource-name: alias + description: Definition of AWS::PaymentCryptography::Alias Resource Type + x-type-name: AWS::PaymentCryptography::Alias + x-stackql-primary-identifier: + - AliasName + x-create-only-properties: + - AliasName + x-required-properties: + - AliasName + x-tagging: + taggable: false + x-required-permissions: + create: + - payment-cryptography:CreateAlias + read: + - payment-cryptography:GetAlias + update: + - payment-cryptography:UpdateAlias + delete: + - payment-cryptography:DeleteAlias + list: + - payment-cryptography:ListAliases + DeriveKeyUsage: + type: string + enum: + - TR31_B0_BASE_DERIVATION_KEY + - TR31_C0_CARD_VERIFICATION_KEY + - TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY + - TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS + - TR31_E1_EMV_MKEY_CONFIDENTIALITY + - TR31_E2_EMV_MKEY_INTEGRITY + - TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS + - TR31_E5_EMV_MKEY_CARD_PERSONALIZATION + - TR31_E6_EMV_MKEY_OTHER + - TR31_K0_KEY_ENCRYPTION_KEY + - TR31_K1_KEY_BLOCK_PROTECTION_KEY + - TR31_M3_ISO_9797_3_MAC_KEY + - TR31_M1_ISO_9797_1_MAC_KEY + - TR31_M6_ISO_9797_5_CMAC_KEY + - TR31_M7_HMAC_KEY + - TR31_P0_PIN_ENCRYPTION_KEY + - TR31_P1_PIN_GENERATION_KEY + - TR31_V1_IBM3624_PIN_VERIFICATION_KEY + - TR31_V2_VISA_PIN_VERIFICATION_KEY + KeyAlgorithm: + type: string + enum: + - TDES_2KEY + - TDES_3KEY + - AES_128 + - AES_192 + - AES_256 + - HMAC_SHA256 + - HMAC_SHA384 + - HMAC_SHA512 + - HMAC_SHA224 + - RSA_2048 + - RSA_3072 + - RSA_4096 + - ECC_NIST_P256 + - ECC_NIST_P384 + - ECC_NIST_P521 + KeyAttributes: + type: object + properties: + KeyUsage: + $ref: '#/components/schemas/KeyUsage' + KeyClass: + $ref: '#/components/schemas/KeyClass' + KeyAlgorithm: + $ref: '#/components/schemas/KeyAlgorithm' + KeyModesOfUse: + $ref: '#/components/schemas/KeyModesOfUse' + required: + - KeyAlgorithm + - KeyClass + - KeyModesOfUse + - KeyUsage + additionalProperties: false + KeyCheckValueAlgorithm: + type: string + enum: + - CMAC + - ANSI_X9_24 + - HMAC + - SHA_1 + KeyClass: + type: string + enum: + - SYMMETRIC_KEY + - ASYMMETRIC_KEY_PAIR + - PRIVATE_KEY + - PUBLIC_KEY + KeyModesOfUse: + type: object + properties: + Encrypt: + type: boolean + default: false + Decrypt: + type: boolean + default: false + Wrap: + type: boolean + default: false + Unwrap: + type: boolean + default: false + Generate: + type: boolean + default: false + Sign: + type: boolean + default: false + Verify: + type: boolean + default: false + DeriveKey: + type: boolean + default: false + NoRestrictions: + type: boolean + default: false + additionalProperties: false + KeyOrigin: + type: string + description: Defines the source of a key + enum: + - EXTERNAL + - AWS_PAYMENT_CRYPTOGRAPHY + KeyState: + type: string + description: Defines the state of a key + enum: + - CREATE_IN_PROGRESS + - CREATE_COMPLETE + - DELETE_PENDING + - DELETE_COMPLETE + KeyUsage: + type: string + enum: + - TR31_B0_BASE_DERIVATION_KEY + - TR31_C0_CARD_VERIFICATION_KEY + - TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY + - TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION + - TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS + - TR31_E1_EMV_MKEY_CONFIDENTIALITY + - TR31_E2_EMV_MKEY_INTEGRITY + - TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS + - TR31_E5_EMV_MKEY_CARD_PERSONALIZATION + - TR31_E6_EMV_MKEY_OTHER + - TR31_K0_KEY_ENCRYPTION_KEY + - TR31_K1_KEY_BLOCK_PROTECTION_KEY + - TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT + - TR31_M3_ISO_9797_3_MAC_KEY + - TR31_M1_ISO_9797_1_MAC_KEY + - TR31_M6_ISO_9797_5_CMAC_KEY + - TR31_M7_HMAC_KEY + - TR31_P0_PIN_ENCRYPTION_KEY + - TR31_P1_PIN_GENERATION_KEY + - TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE + - TR31_V1_IBM3624_PIN_VERIFICATION_KEY + - TR31_V2_VISA_PIN_VERIFICATION_KEY + - TR31_K2_TR34_ASYMMETRIC_KEY + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 1 + required: + - Key + - Value + additionalProperties: false + Key: + type: object + properties: + DeriveKeyUsage: + $ref: '#/components/schemas/DeriveKeyUsage' + Enabled: + type: boolean + Exportable: + type: boolean + KeyAttributes: + $ref: '#/components/schemas/KeyAttributes' + KeyCheckValueAlgorithm: + $ref: '#/components/schemas/KeyCheckValueAlgorithm' + KeyIdentifier: + type: string + maxLength: 322 + minLength: 7 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$ + KeyOrigin: + $ref: '#/components/schemas/KeyOrigin' + KeyState: + $ref: '#/components/schemas/KeyState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + required: + - Exportable + - KeyAttributes + x-stackql-resource-name: key + description: Definition of AWS::PaymentCryptography::Key Resource Type + x-type-name: AWS::PaymentCryptography::Key + x-stackql-primary-identifier: + - KeyIdentifier + x-read-only-properties: + - KeyIdentifier + - KeyOrigin + - KeyState + x-required-properties: + - Exportable + - KeyAttributes + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - payment-cryptography:ListTagsForResource + - payment-cryptography:TagResource + - payment-cryptography:UntagResource + x-required-permissions: + create: + - payment-cryptography:GetKey + - payment-cryptography:CreateKey + - payment-cryptography:TagResource + read: + - payment-cryptography:GetKey + - payment-cryptography:ListTagsForResource + update: + - payment-cryptography:GetKey + - payment-cryptography:ListTagsForResource + - payment-cryptography:TagResource + - payment-cryptography:UntagResource + - payment-cryptography:StartKeyUsage + - payment-cryptography:StopKeyUsage + delete: + - payment-cryptography:GetKey + - payment-cryptography:DeleteKey + list: + - payment-cryptography:ListKeys + CreateAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AliasName: + type: string + maxLength: 256 + minLength: 7 + pattern: ^alias/[a-zA-Z0-9/_-]+$ + KeyArn: + type: string + maxLength: 150 + minLength: 70 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$ + x-stackQL-stringOnly: true + x-title: CreateAliasRequest + type: object + required: [] + CreateKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DeriveKeyUsage: + $ref: '#/components/schemas/DeriveKeyUsage' + Enabled: + type: boolean + Exportable: + type: boolean + KeyAttributes: + $ref: '#/components/schemas/KeyAttributes' + KeyCheckValueAlgorithm: + $ref: '#/components/schemas/KeyCheckValueAlgorithm' + KeyIdentifier: + type: string + maxLength: 322 + minLength: 7 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$ + KeyOrigin: + $ref: '#/components/schemas/KeyOrigin' + KeyState: + $ref: '#/components/schemas/KeyState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateKeyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + aliases: + name: aliases + id: awscc.paymentcryptography.aliases + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::PaymentCryptography::Alias + x-identifiers: + - AliasName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AliasName') as alias_name, + JSON_EXTRACT(Properties, '$.KeyArn') as key_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AliasName') as alias_name, + json_extract_path_text(Properties, 'KeyArn') as key_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + aliases_list_only: + name: aliases_list_only + id: awscc.paymentcryptography.aliases_list_only + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::PaymentCryptography::Alias + x-identifiers: + - AliasName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AliasName') as alias_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AliasName') as alias_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND region = 'us-east-1' + keys: + name: keys + id: awscc.paymentcryptography.keys + x-cfn-schema-name: Key + x-cfn-type-name: AWS::PaymentCryptography::Key + x-identifiers: + - KeyIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Key&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/keys/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DeriveKeyUsage') as derive_key_usage, + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.Exportable') as exportable, + JSON_EXTRACT(Properties, '$.KeyAttributes') as key_attributes, + JSON_EXTRACT(Properties, '$.KeyCheckValueAlgorithm') as key_check_value_algorithm, + JSON_EXTRACT(Properties, '$.KeyIdentifier') as key_identifier, + JSON_EXTRACT(Properties, '$.KeyOrigin') as key_origin, + JSON_EXTRACT(Properties, '$.KeyState') as key_state, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeriveKeyUsage') as derive_key_usage, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Exportable') as exportable, + json_extract_path_text(Properties, 'KeyAttributes') as key_attributes, + json_extract_path_text(Properties, 'KeyCheckValueAlgorithm') as key_check_value_algorithm, + json_extract_path_text(Properties, 'KeyIdentifier') as key_identifier, + json_extract_path_text(Properties, 'KeyOrigin') as key_origin, + json_extract_path_text(Properties, 'KeyState') as key_state, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND data__Identifier = '' + AND region = 'us-east-1' + keys_list_only: + name: keys_list_only + id: awscc.paymentcryptography.keys_list_only + x-cfn-schema-name: Key + x-cfn-type-name: AWS::PaymentCryptography::Key + x-identifiers: + - KeyIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KeyIdentifier') as key_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyIdentifier') as key_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Key&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/pcaconnectorad.yaml b/providers/src/awscc/v00.00.00000/services/pcaconnectorad.yaml index 1bf12a5d..85a4bb22 100644 --- a/providers/src/awscc/v00.00.00000/services/pcaconnectorad.yaml +++ b/providers/src/awscc/v00.00.00000/services/pcaconnectorad.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: PCAConnectorAD - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tags: type: object @@ -11,6 +391,9 @@ components: .+: type: string additionalProperties: false + Unit: + type: object + additionalProperties: false VpcInformation: type: object properties: @@ -24,6 +407,11 @@ components: maxItems: 5 minItems: 1 uniqueItems: true + IpAddressType: + type: string + enum: + - IPV4 + - DUALSTACK required: - SecurityGroupIds additionalProperties: false @@ -34,12 +422,12 @@ components: type: string maxLength: 200 minLength: 5 - pattern: ^arn:[\w-]+:acm-pca:[\w-]+:[0-9]+:certificate-authority(\/[\w-]+)$ + pattern: ^arn:[\w-]+:acm-pca:[\w-]+:[0-9]+:certificate-authority\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ ConnectorArn: type: string maxLength: 200 minLength: 5 - pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector(\/[\w-]+)$ + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ DirectoryId: type: string pattern: ^d-[0-9a-f]{10}$ @@ -52,7 +440,9 @@ components: - DirectoryId - VpcInformation x-stackql-resource-name: connector - x-stackql-primaryIdentifier: + description: Represents a Connector that connects AWS PrivateCA and your directory + x-type-name: AWS::PCAConnectorAD::Connector + x-stackql-primary-identifier: - ConnectorArn x-create-only-properties: - CertificateAuthorityArn @@ -60,6 +450,20 @@ components: - VpcInformation x-read-only-properties: - ConnectorArn + x-required-properties: + - CertificateAuthorityArn + - DirectoryId + - VpcInformation + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pca-connector-ad:ListTagsForResource + - pca-connector-ad:TagResource + - pca-connector-ad:UntagResource x-required-permissions: create: - acm-pca:DescribeCertificateAuthority @@ -72,14 +476,16 @@ components: - ec2:DescribeVpcEndpoints - pca-connector-ad:CreateConnector - pca-connector-ad:GetConnector + - pca-connector-ad:TagResource read: - pca-connector-ad:ListTagsForResource - pca-connector-ad:GetConnector delete: - - pca-connector-ad:GetConnector - - pca-connector-ad:DeleteConnector - ec2:DeleteVpcEndpoints - ec2:DescribeVpcEndpoints + - pca-connector-ad:GetConnector + - pca-connector-ad:DeleteConnector + - pca-connector-ad:UntagResource list: - pca-connector-ad:ListConnectors update: @@ -102,27 +508,43 @@ components: required: - DirectoryId x-stackql-resource-name: directory_registration - x-stackql-primaryIdentifier: + description: Definition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type + x-type-name: AWS::PCAConnectorAD::DirectoryRegistration + x-stackql-primary-identifier: - DirectoryRegistrationArn x-create-only-properties: - DirectoryId x-read-only-properties: - DirectoryRegistrationArn + x-required-properties: + - DirectoryId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pca-connector-ad:ListTagsForResource + - pca-connector-ad:TagResource + - pca-connector-ad:UntagResource x-required-permissions: create: - - pca-connector-ad:GetDirectoryRegistration - - pca-connector-ad:CreateDirectoryRegistration - ds:AuthorizeApplication - ds:DescribeDirectories + - pca-connector-ad:GetDirectoryRegistration + - pca-connector-ad:CreateDirectoryRegistration + - pca-connector-ad:TagResource read: - - pca-connector-ad:ListTagsForResource - pca-connector-ad:GetDirectoryRegistration + - pca-connector-ad:ListTagsForResource delete: - - pca-connector-ad:GetDirectoryRegistration - - pca-connector-ad:DeleteDirectoryRegistration - ds:DescribeDirectories - ds:UnauthorizeApplication - ds:UpdateAuthorizedApplication + - pca-connector-ad:GetDirectoryRegistration + - pca-connector-ad:DeleteDirectoryRegistration + - pca-connector-ad:UntagResource list: - pca-connector-ad:ListDirectoryRegistrations update: @@ -143,12 +565,19 @@ components: minLength: 5 pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:directory-registration(\/[\w-]+)$ x-stackql-resource-name: service_principal_name - x-stackql-primaryIdentifier: + description: Definition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type + x-type-name: AWS::PCAConnectorAD::ServicePrincipalName + x-stackql-primary-identifier: - ConnectorArn - DirectoryRegistrationArn x-create-only-properties: - ConnectorArn - DirectoryRegistrationArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - ds:UpdateAuthorizedApplication @@ -850,16 +1279,35 @@ components: - Definition - Name x-stackql-resource-name: template - x-stackql-primaryIdentifier: + description: Represents a template that defines certificate configurations, both for issuance and client handling + x-type-name: AWS::PCAConnectorAD::Template + x-stackql-primary-identifier: - TemplateArn x-create-only-properties: - ConnectorArn - Name + x-write-only-properties: + - ReenrollAllCertificateHolders x-read-only-properties: - TemplateArn + x-required-properties: + - ConnectorArn + - Definition + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pca-connector-ad:ListTagsForResource + - pca-connector-ad:TagResource + - pca-connector-ad:UntagResource x-required-permissions: create: - pca-connector-ad:CreateTemplate + - pca-connector-ad:TagResource read: - pca-connector-ad:GetTemplate - pca-connector-ad:ListTagsForResource @@ -871,6 +1319,7 @@ components: delete: - pca-connector-ad:GetTemplate - pca-connector-ad:DeleteTemplate + - pca-connector-ad:UntagResource list: - pca-connector-ad:ListTemplates AccessRight: @@ -910,12 +1359,25 @@ components: - AccessRights - GroupDisplayName x-stackql-resource-name: template_group_access_control_entry - x-stackql-primaryIdentifier: + description: Definition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type + x-type-name: AWS::PCAConnectorAD::TemplateGroupAccessControlEntry + x-stackql-primary-identifier: - GroupSecurityIdentifier - TemplateArn x-create-only-properties: - GroupSecurityIdentifier - TemplateArn + x-write-only-properties: + - AccessRights + - GroupDisplayName + x-required-properties: + - AccessRights + - GroupDisplayName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - pca-connector-ad:CreateTemplateGroupAccessControlEntry @@ -928,43 +1390,233 @@ components: - pca-connector-ad:GetTemplateGroupAccessControlEntry list: - pca-connector-ad:ListTemplateGroupAccessControlEntries + CreateConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateAuthorityArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:acm-pca:[\w-]+:[0-9]+:certificate-authority\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + DirectoryId: + type: string + pattern: ^d-[0-9a-f]{10}$ + Tags: + $ref: '#/components/schemas/Tags' + VpcInformation: + $ref: '#/components/schemas/VpcInformation' + x-stackQL-stringOnly: true + x-title: CreateConnectorRequest + type: object + required: [] + CreateDirectoryRegistrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DirectoryId: + type: string + pattern: ^d-[0-9a-f]{10}$ + DirectoryRegistrationArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:directory-registration(\/[\w-]+)$ + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateDirectoryRegistrationRequest + type: object + required: [] + CreateServicePrincipalNameRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector(\/[\w-]+)$ + DirectoryRegistrationArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:directory-registration(\/[\w-]+)$ + x-stackQL-stringOnly: true + x-title: CreateServicePrincipalNameRequest + type: object + required: [] + CreateTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + Definition: + $ref: '#/components/schemas/TemplateDefinition' + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^(?!^\s+$)((?![\x5c'\x2b,;<=>#\x22])([\x20-\x7E]))+$ + ReenrollAllCertificateHolders: + type: boolean + Tags: + $ref: '#/components/schemas/Tags' + TemplateArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\/template\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + x-stackQL-stringOnly: true + x-title: CreateTemplateRequest + type: object + required: [] + CreateTemplateGroupAccessControlEntryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessRights: + $ref: '#/components/schemas/AccessRights' + GroupDisplayName: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[\x20-\x7E]+$ + GroupSecurityIdentifier: + type: string + maxLength: 256 + minLength: 7 + pattern: ^S-[0-9]-([0-9]+-){1,14}[0-9]+$ + TemplateArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector(\/[\w-]+)\/template(\/[\w-]+)$ + x-stackQL-stringOnly: true + x-title: CreateTemplateGroupAccessControlEntryRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: connectors: name: connectors id: awscc.pcaconnectorad.connectors x-cfn-schema-name: Connector - x-type: list - x-identifiers: - - ConnectorArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' - AND region = 'us-east-1' - connector: - name: connector - id: awscc.pcaconnectorad.connector - x-cfn-schema-name: Connector - x-type: get + x-cfn-type-name: AWS::PCAConnectorAD::Connector x-identifiers: - ConnectorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -978,7 +1630,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -991,13 +1643,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' AND data__Identifier = '' AND region = 'us-east-1' - directory_registrations: - name: directory_registrations - id: awscc.pcaconnectorad.directory_registrations - x-cfn-schema-name: DirectoryRegistration - x-type: list + connectors_list_only: + name: connectors_list_only + id: awscc.pcaconnectorad.connectors_list_only + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::PCAConnectorAD::Connector x-identifiers: - - DirectoryRegistrationArn + - ConnectorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1005,28 +1663,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' AND region = 'us-east-1' - directory_registration: - name: directory_registration - id: awscc.pcaconnectorad.directory_registration + directory_registrations: + name: directory_registrations + id: awscc.pcaconnectorad.directory_registrations x-cfn-schema-name: DirectoryRegistration - x-type: get + x-cfn-type-name: AWS::PCAConnectorAD::DirectoryRegistration x-identifiers: - DirectoryRegistrationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DirectoryRegistration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::DirectoryRegistration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::DirectoryRegistration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::DirectoryRegistration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1038,7 +1744,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1049,14 +1755,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' AND data__Identifier = '' AND region = 'us-east-1' - service_principal_names: - name: service_principal_names - id: awscc.pcaconnectorad.service_principal_names - x-cfn-schema-name: ServicePrincipalName - x-type: list + directory_registrations_list_only: + name: directory_registrations_list_only + id: awscc.pcaconnectorad.directory_registrations_list_only + x-cfn-schema-name: DirectoryRegistration + x-cfn-type-name: AWS::PCAConnectorAD::DirectoryRegistration x-identifiers: - - ConnectorArn - DirectoryRegistrationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1064,31 +1775,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn, JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' AND region = 'us-east-1' - service_principal_name: - name: service_principal_name - id: awscc.pcaconnectorad.service_principal_name + service_principal_names: + name: service_principal_names + id: awscc.pcaconnectorad.service_principal_names x-cfn-schema-name: ServicePrincipalName - x-type: get + x-cfn-type-name: AWS::PCAConnectorAD::ServicePrincipalName x-identifiers: - ConnectorArn - DirectoryRegistrationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServicePrincipalName&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::ServicePrincipalName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::ServicePrincipalName" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_principal_names/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_principal_names/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1099,7 +1843,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1109,13 +1853,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' AND data__Identifier = '|' AND region = 'us-east-1' - templates: - name: templates - id: awscc.pcaconnectorad.templates - x-cfn-schema-name: Template - x-type: list + service_principal_names_list_only: + name: service_principal_names_list_only + id: awscc.pcaconnectorad.service_principal_names_list_only + x-cfn-schema-name: ServicePrincipalName + x-cfn-type-name: AWS::PCAConnectorAD::ServicePrincipalName x-identifiers: - - TemplateArn + - ConnectorArn + - DirectoryRegistrationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1123,28 +1874,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn, + JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TemplateArn') as template_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' AND region = 'us-east-1' - template: - name: template - id: awscc.pcaconnectorad.template + templates: + name: templates + id: awscc.pcaconnectorad.templates x-cfn-schema-name: Template - x-type: get + x-cfn-type-name: AWS::PCAConnectorAD::Template x-identifiers: - TemplateArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Template&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1159,7 +1960,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1173,14 +1974,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' AND data__Identifier = '' AND region = 'us-east-1' - template_group_access_control_entries: - name: template_group_access_control_entries - id: awscc.pcaconnectorad.template_group_access_control_entries - x-cfn-schema-name: TemplateGroupAccessControlEntry - x-type: list + templates_list_only: + name: templates_list_only + id: awscc.pcaconnectorad.templates_list_only + x-cfn-schema-name: Template + x-cfn-type-name: AWS::PCAConnectorAD::Template x-identifiers: - - GroupSecurityIdentifier - TemplateArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1188,31 +1994,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GroupSecurityIdentifier') as group_security_identifier, JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GroupSecurityIdentifier') as group_security_identifier, json_extract_path_text(Properties, 'TemplateArn') as template_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' AND region = 'us-east-1' - template_group_access_control_entry: - name: template_group_access_control_entry - id: awscc.pcaconnectorad.template_group_access_control_entry + template_group_access_control_entries: + name: template_group_access_control_entries + id: awscc.pcaconnectorad.template_group_access_control_entries x-cfn-schema-name: TemplateGroupAccessControlEntry - x-type: get + x-cfn-type-name: AWS::PCAConnectorAD::TemplateGroupAccessControlEntry x-identifiers: - GroupSecurityIdentifier - TemplateArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TemplateGroupAccessControlEntry&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1225,7 +2077,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1237,3 +2089,400 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' AND data__Identifier = '|' AND region = 'us-east-1' + template_group_access_control_entries_list_only: + name: template_group_access_control_entries_list_only + id: awscc.pcaconnectorad.template_group_access_control_entries_list_only + x-cfn-schema-name: TemplateGroupAccessControlEntry + x-cfn-type-name: AWS::PCAConnectorAD::TemplateGroupAccessControlEntry + x-identifiers: + - GroupSecurityIdentifier + - TemplateArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.GroupSecurityIdentifier') as group_security_identifier, + JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupSecurityIdentifier') as group_security_identifier, + json_extract_path_text(Properties, 'TemplateArn') as template_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DirectoryRegistration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDirectoryRegistration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDirectoryRegistrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServicePrincipalName&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServicePrincipalName + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServicePrincipalNameRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Template&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TemplateGroupAccessControlEntry&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTemplateGroupAccessControlEntry + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTemplateGroupAccessControlEntryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/pcaconnectorscep.yaml b/providers/src/awscc/v00.00.00000/services/pcaconnectorscep.yaml new file mode 100644 index 00000000..a2569396 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/pcaconnectorscep.yaml @@ -0,0 +1,1116 @@ +openapi: 3.0.0 +info: + title: PCAConnectorSCEP + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tags: + type: object + x-patternProperties: + .+: + type: string + additionalProperties: false + Unit: + type: object + additionalProperties: false + Challenge: + type: object + properties: + ChallengeArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\/challenge\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + Tags: + $ref: '#/components/schemas/Tags' + required: + - ConnectorArn + x-stackql-resource-name: challenge + description: Represents a SCEP Challenge that is used for certificate enrollment + x-type-name: AWS::PCAConnectorSCEP::Challenge + x-stackql-primary-identifier: + - ChallengeArn + x-create-only-properties: + - ConnectorArn + x-read-only-properties: + - ChallengeArn + x-required-properties: + - ConnectorArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pca-connector-scep:ListTagsForResource + - pca-connector-scep:TagResource + - pca-connector-scep:UntagResource + x-required-permissions: + create: + - pca-connector-scep:CreateChallenge + - pca-connector-scep:TagResource + read: + - pca-connector-scep:ListTagsForResource + - pca-connector-scep:GetChallengeMetadata + delete: + - pca-connector-scep:GetChallengeMetadata + - pca-connector-scep:DeleteChallenge + - pca-connector-scep:UntagResource + list: + - pca-connector-scep:ListChallengeMetadata + update: + - pca-connector-scep:ListTagsForResource + - pca-connector-scep:TagResource + - pca-connector-scep:UntagResource + ConnectorType: + type: string + enum: + - GENERAL_PURPOSE + - INTUNE + IntuneConfiguration: + type: object + properties: + AzureApplicationId: + type: string + maxLength: 100 + minLength: 15 + pattern: ^[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}-[a-zA-Z0-9]{2,15}$ + Domain: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9._-]+$ + required: + - AzureApplicationId + - Domain + additionalProperties: false + MobileDeviceManagement: + type: object + oneOf: + - title: Intune + properties: + Intune: + $ref: '#/components/schemas/IntuneConfiguration' + required: + - Intune + additionalProperties: false + OpenIdConfiguration: + type: object + properties: + Issuer: + type: string + Subject: + type: string + Audience: + type: string + additionalProperties: false + Connector: + type: object + properties: + CertificateAuthorityArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:acm-pca:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:certificate-authority\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + Type: + $ref: '#/components/schemas/ConnectorType' + Endpoint: + type: string + maxLength: 200 + minLength: 5 + MobileDeviceManagement: + $ref: '#/components/schemas/MobileDeviceManagement' + OpenIdConfiguration: + $ref: '#/components/schemas/OpenIdConfiguration' + Tags: + $ref: '#/components/schemas/Tags' + required: + - CertificateAuthorityArn + x-stackql-resource-name: connector + description: Represents a Connector that allows certificate issuance through Simple Certificate Enrollment Protocol (SCEP) + x-type-name: AWS::PCAConnectorSCEP::Connector + x-stackql-primary-identifier: + - ConnectorArn + x-create-only-properties: + - CertificateAuthorityArn + - MobileDeviceManagement + x-read-only-properties: + - ConnectorArn + - Endpoint + - OpenIdConfiguration + - Type + x-required-properties: + - CertificateAuthorityArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pca-connector-scep:ListTagsForResource + - pca-connector-scep:TagResource + - pca-connector-scep:UntagResource + x-required-permissions: + create: + - acm-pca:DescribeCertificateAuthority + - acm-pca:GetCertificate + - acm-pca:GetCertificateAuthorityCertificate + - acm-pca:IssueCertificate + - pca-connector-scep:GetConnector + - pca-connector-scep:CreateConnector + - pca-connector-scep:TagResource + read: + - pca-connector-scep:ListTagsForResource + - pca-connector-scep:GetConnector + delete: + - acm-pca:DescribeCertificateAuthority + - acm-pca:GetCertificate + - acm-pca:GetCertificateAuthorityCertificate + - acm-pca:IssueCertificate + - pca-connector-scep:GetConnector + - pca-connector-scep:DeleteConnector + - pca-connector-scep:UntagResource + list: + - pca-connector-scep:ListConnectors + update: + - pca-connector-scep:ListTagsForResource + - pca-connector-scep:TagResource + - pca-connector-scep:UntagResource + CreateChallengeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ChallengeArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\/challenge\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateChallengeRequest + type: object + required: [] + CreateConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateAuthorityArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:acm-pca:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:certificate-authority\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + ConnectorArn: + type: string + maxLength: 200 + minLength: 5 + pattern: ^arn:aws(-[a-z]+)*:pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d*:\d{12}:connector\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$ + Type: + $ref: '#/components/schemas/ConnectorType' + Endpoint: + type: string + maxLength: 200 + minLength: 5 + MobileDeviceManagement: + $ref: '#/components/schemas/MobileDeviceManagement' + OpenIdConfiguration: + $ref: '#/components/schemas/OpenIdConfiguration' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateConnectorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + challenges: + name: challenges + id: awscc.pcaconnectorscep.challenges + x-cfn-schema-name: Challenge + x-cfn-type-name: AWS::PCAConnectorSCEP::Challenge + x-identifiers: + - ChallengeArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Challenge&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorSCEP::Challenge" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorSCEP::Challenge" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorSCEP::Challenge" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/challenges/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/challenges/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/challenges/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ChallengeArn') as challenge_arn, + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Challenge' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ChallengeArn') as challenge_arn, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Challenge' + AND data__Identifier = '' + AND region = 'us-east-1' + challenges_list_only: + name: challenges_list_only + id: awscc.pcaconnectorscep.challenges_list_only + x-cfn-schema-name: Challenge + x-cfn-type-name: AWS::PCAConnectorSCEP::Challenge + x-identifiers: + - ChallengeArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ChallengeArn') as challenge_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Challenge' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ChallengeArn') as challenge_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Challenge' + AND region = 'us-east-1' + connectors: + name: connectors + id: awscc.pcaconnectorscep.connectors + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::PCAConnectorSCEP::Connector + x-identifiers: + - ConnectorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorSCEP::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorSCEP::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCAConnectorSCEP::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CertificateAuthorityArn') as certificate_authority_arn, + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.MobileDeviceManagement') as mobile_device_management, + JSON_EXTRACT(Properties, '$.OpenIdConfiguration') as open_id_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateAuthorityArn') as certificate_authority_arn, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'MobileDeviceManagement') as mobile_device_management, + json_extract_path_text(Properties, 'OpenIdConfiguration') as open_id_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + connectors_list_only: + name: connectors_list_only + id: awscc.pcaconnectorscep.connectors_list_only + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::PCAConnectorSCEP::Connector + x-identifiers: + - ConnectorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Connector' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorSCEP::Connector' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Challenge&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateChallenge + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateChallengeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/pcs.yaml b/providers/src/awscc/v00.00.00000/services/pcs.yaml new file mode 100644 index 00000000..c29b1f4b --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/pcs.yaml @@ -0,0 +1,1987 @@ +openapi: 3.0.0 +info: + title: PCS + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Accounting: + type: object + description: The accounting configuration includes configurable settings for Slurm accounting. + properties: + DefaultPurgeTimeInDays: + type: integer + description: The default value for all purge settings for `slurmdbd.conf`. For more information, see the [slurmdbd.conf documentation at SchedMD](https://slurm.schedmd.com/slurmdbd.conf.html). The default value is `-1`. A value of `-1` means there is no purge time and records persist as long as the cluster exists. + default: -1 + minimum: -1 + maximum: 10000 + Mode: + type: string + description: The default value is `STANDARD`. A value of `STANDARD` means that Slurm accounting is enabled. + default: NONE + enum: + - STANDARD + - NONE + required: + - Mode + AuthKey: + type: object + description: The shared Slurm key for authentication, also known as the cluster secret. + properties: + SecretArn: + type: string + description: The Amazon Resource Name (ARN) of the the shared Slurm key. + SecretVersion: + type: string + description: The version of the shared Slurm key. + required: + - SecretArn + - SecretVersion + additionalProperties: false + Endpoint: + type: object + description: An endpoint available for interaction with the scheduler. + properties: + Port: + type: string + description: The endpoint's connection port number. + PrivateIpAddress: + type: string + description: The endpoint's private IP address. + Ipv6Address: + type: string + description: The endpoint's IPv6 address. + Type: + type: string + description: Indicates the type of endpoint running at the specific IP address. + enum: + - SLURMCTLD + - SLURMDBD + PublicIpAddress: + type: string + description: The endpoint's public IP address. + required: + - Port + - PrivateIpAddress + - Type + additionalProperties: false + ErrorInfo: + type: object + description: An error that occurred during resource provisioning. + properties: + Code: + type: string + description: The short-form error code. + Message: + type: string + description: The detailed error information. + additionalProperties: false + SecurityGroupId: + type: string + description: A VPC security group ID. + SlurmCustomSetting: + description: Additional settings that directly map to Slurm settings. + additionalProperties: false + type: object + properties: + ParameterValue: + description: The value for the configured Slurm setting. + type: string + ParameterName: + description: 'AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.' + type: string + required: + - ParameterName + - ParameterValue + SubnetId: + description: A VPC subnet ID. + type: string + Tag: + type: object + description: A key-value pair to associate with a resource. + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 0 + maxLength: 256 + additionalProperties: false + required: + - Key + Cluster: + type: object + properties: + Arn: + type: string + description: The unique Amazon Resource Name (ARN) of the cluster. + Endpoints: + type: array + description: The list of endpoints available for interaction with the scheduler. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Endpoint' + ErrorInfo: + type: array + description: The list of errors that occurred during cluster provisioning. + x-insertionOrder: false + items: + $ref: '#/components/schemas/ErrorInfo' + Id: + type: string + description: The generated unique ID of the cluster. + pattern: ^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,40})$ + Name: + type: string + description: The name that identifies the cluster. + Networking: + type: object + description: The networking configuration for the cluster's control plane. + properties: + SecurityGroupIds: + type: array + description: The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' + SubnetIds: + type: array + description: The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetId' + NetworkType: + type: string + description: The IP of the cluster (IPV4 or IPV6) + enum: + - IPV4 + - IPV6 + x-insertionOrder: false + additionalProperties: false + Scheduler: + type: object + description: The cluster management and job scheduling software associated with the cluster. + properties: + Type: + type: string + description: The software AWS PCS uses to manage cluster scaling and job scheduling. + enum: + - SLURM + Version: + type: string + description: The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling. + required: + - Type + - Version + additionalProperties: false + Size: + type: string + description: The size of the cluster. + enum: + - SMALL + - MEDIUM + - LARGE + SlurmConfiguration: + type: object + description: Additional options related to the Slurm scheduler. + properties: + Accounting: + $ref: '#/components/schemas/Accounting' + AuthKey: + $ref: '#/components/schemas/AuthKey' + ScaleDownIdleTimeInSeconds: + type: integer + description: The time before an idle node is scaled down. + minimum: 1 + SlurmCustomSettings: + type: array + description: Additional Slurm-specific configuration that directly maps to Slurm settings. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SlurmCustomSetting' + additionalProperties: false + Status: + type: string + description: The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - CREATE_FAILED + - DELETE_FAILED + - UPDATE_FAILED + Tags: + description: 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + required: + - Networking + - Scheduler + - Size + x-stackql-resource-name: cluster + description: AWS::PCS::Cluster resource creates an AWS PCS cluster. + x-type-name: AWS::PCS::Cluster + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - Networking + - Scheduler + - Size + - SlurmConfiguration + x-read-only-properties: + - Arn + - Endpoints + - ErrorInfo + - Id + - Status + x-required-properties: + - Networking + - Scheduler + - Size + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pcs:TagResource + - pcs:ListTagsForResource + - pcs:UntagResource + x-required-permissions: + create: + - ec2:CreateNetworkInterface + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:GetSecurityGroupsForVpc + - iam:CreateServiceLinkedRole + - secretsmanager:CreateSecret + - secretsmanager:TagResource + - pcs:CreateCluster + - pcs:GetCluster + - pcs:ListTagsForResource + - pcs:TagResource + read: + - pcs:GetCluster + - pcs:ListTagsForResource + update: + - pcs:GetCluster + - pcs:ListTagsForResource + - pcs:TagResource + - pcs:UntagResource + delete: + - pcs:DeleteCluster + - pcs:GetCluster + list: + - pcs:ListClusters + InstanceConfig: + description: An EC2 instance configuration AWS PCS uses to launch compute nodes. + additionalProperties: false + type: object + properties: + InstanceType: + description: The EC2 instance type that AWS PCS can provision in the compute node group. + type: string + ComputeNodeGroup: + type: object + properties: + Status: + description: The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - CREATE_FAILED + - DELETE_FAILED + - UPDATE_FAILED + ClusterId: + description: The ID of the cluster of the compute node group. + type: string + ErrorInfo: + description: The list of errors that occurred during compute node group provisioning. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ErrorInfo' + SpotOptions: + description: Additional configuration when you specify SPOT as the purchase option. + additionalProperties: false + type: object + properties: + AllocationStrategy: + description: The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized. + type: string + enum: + - lowest-price + - capacity-optimized + - price-capacity-optimized + SlurmConfiguration: + description: Additional options related to the Slurm scheduler. + additionalProperties: false + type: object + properties: + SlurmCustomSettings: + description: Additional Slurm-specific configuration that directly maps to Slurm settings. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SlurmCustomSetting' + SubnetIds: + description: The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SubnetId' + Name: + description: The name that identifies the compute node group. + type: string + ScalingConfiguration: + description: Specifies the boundaries of the compute node group auto scaling. + additionalProperties: false + type: object + properties: + MaxInstanceCount: + description: The upper bound of the number of instances allowed in the compute fleet. + type: integer + minimum: 0 + MinInstanceCount: + description: The lower bound of the number of instances allowed in the compute fleet. + type: integer + minimum: 0 + required: + - MaxInstanceCount + - MinInstanceCount + InstanceConfigs: + description: A list of EC2 instance configurations that AWS PCS can provision in the compute node group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InstanceConfig' + Id: + description: The generated unique ID of the compute node group. + type: string + PurchaseOption: + description: Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand. + type: string + enum: + - ONDEMAND + - SPOT + Arn: + description: The unique Amazon Resource Name (ARN) of the compute node group. + type: string + CustomLaunchTemplate: + description: An Amazon EC2 launch template AWS PCS uses to launch compute nodes. + additionalProperties: false + type: object + properties: + Version: + description: The version of the EC2 launch template to use to provision instances. + type: string + TemplateId: + description: The ID of the EC2 launch template to use to provision instances. + type: string + required: + - Version + Tags: + x-patternProperties: + ^.+$: + type: string + description: 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. + additionalProperties: false + AmiId: + pattern: ^ami-[a-z0-9]+$ + description: The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances. If not provided, AWS PCS uses the AMI ID specified in the custom launch template. + type: string + IamInstanceProfileArn: + pattern: ^arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{1,128}$ + description: The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly. + type: string + required: + - ClusterId + - CustomLaunchTemplate + - IamInstanceProfileArn + - InstanceConfigs + - ScalingConfiguration + - SubnetIds + x-stackql-resource-name: compute_node_group + description: AWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group. + x-type-name: AWS::PCS::ComputeNodeGroup + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - ClusterId + - InstanceConfigs + x-read-only-properties: + - Arn + - ErrorInfo + - Id + - Status + x-required-properties: + - ClusterId + - CustomLaunchTemplate + - IamInstanceProfileArn + - InstanceConfigs + - ScalingConfiguration + - SubnetIds + x-tagging: + permissions: + - pcs:TagResource + - pcs:ListTagsForResource + - pcs:UntagResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - pcs:GetComputeNodeGroup + - pcs:ListTagsForResource + create: + - ec2:DescribeImages + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeLaunchTemplates + - ec2:DescribeLaunchTemplateVersions + - ec2:DescribeInstanceTypes + - ec2:DescribeInstanceTypeOfferings + - ec2:RunInstances + - ec2:CreateFleet + - ec2:CreateTags + - iam:PassRole + - iam:GetInstanceProfile + - pcs:CreateComputeNodeGroup + - pcs:GetComputeNodeGroup + - pcs:ListTagsForResource + - pcs:TagResource + update: + - ec2:DescribeImages + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeLaunchTemplates + - ec2:DescribeLaunchTemplateVersions + - ec2:DescribeInstanceTypes + - ec2:DescribeInstanceTypeOfferings + - ec2:RunInstances + - ec2:CreateFleet + - ec2:CreateTags + - iam:PassRole + - iam:GetInstanceProfile + - pcs:GetComputeNodeGroup + - pcs:UpdateComputeNodeGroup + - pcs:ListTagsForResource + - pcs:TagResource + - pcs:UntagResource + list: + - pcs:ListClusters + - pcs:ListComputeNodeGroups + delete: + - ec2:DescribeImages + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeLaunchTemplates + - ec2:DescribeLaunchTemplateVersions + - ec2:DescribeInstanceTypes + - ec2:DescribeInstanceTypeOfferings + - ec2:TerminateInstances + - ec2:CreateFleet + - ec2:CreateTags + - iam:PassRole + - iam:GetInstanceProfile + - pcs:GetComputeNodeGroup + - pcs:DeleteComputeNodeGroup + - pcs:ListTagsForResource + - pcs:TagResource + - pcs:UntagResource + ComputeNodeGroupConfiguration: + type: object + description: The compute node group configuration for a queue. + properties: + ComputeNodeGroupId: + type: string + description: The compute node group ID for the compute node group configuration. + additionalProperties: false + Queue: + type: object + properties: + Arn: + type: string + description: The unique Amazon Resource Name (ARN) of the queue. + pattern: ^(.*?) + ClusterId: + type: string + description: The ID of the cluster of the queue. + ComputeNodeGroupConfigurations: + type: array + description: The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups. + x-insertionOrder: false + items: + $ref: '#/components/schemas/ComputeNodeGroupConfiguration' + ErrorInfo: + type: array + description: The list of errors that occurred during queue provisioning. + x-insertionOrder: false + items: + $ref: '#/components/schemas/ErrorInfo' + Id: + type: string + description: The generated unique ID of the queue. + Name: + type: string + description: The name that identifies the queue. + Status: + type: string + description: The provisioning status of the queue. The provisioning status doesn't indicate the overall health of the queue. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - CREATE_FAILED + - DELETE_FAILED + - UPDATE_FAILED + Tags: + type: object + description: 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + required: + - ClusterId + x-stackql-resource-name: queue + description: AWS::PCS::Queue resource creates an AWS PCS queue. + x-type-name: AWS::PCS::Queue + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Name + - ClusterId + x-read-only-properties: + - Arn + - ErrorInfo + - Id + - Status + x-required-properties: + - ClusterId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - pcs:TagResource + - pcs:ListTagsForResource + - pcs:UntagResource + x-required-permissions: + create: + - ec2:CreateNetworkInterface + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:GetSecurityGroupsForVpc + - iam:CreateServiceLinkedRole + - secretsmanager:CreateSecret + - secretsmanager:TagResource + - pcs:CreateQueue + - pcs:GetQueue + - pcs:ListTagsForResource + - pcs:TagResource + read: + - pcs:GetQueue + - pcs:ListTagsForResource + update: + - pcs:GetQueue + - pcs:UpdateQueue + - pcs:ListTagsForResource + - pcs:TagResource + - pcs:UntagResource + delete: + - pcs:DeleteQueue + - pcs:GetQueue + list: + - pcs:ListClusters + - pcs:ListQueues + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The unique Amazon Resource Name (ARN) of the cluster. + Endpoints: + type: array + description: The list of endpoints available for interaction with the scheduler. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Endpoint' + ErrorInfo: + type: array + description: The list of errors that occurred during cluster provisioning. + x-insertionOrder: false + items: + $ref: '#/components/schemas/ErrorInfo' + Id: + type: string + description: The generated unique ID of the cluster. + pattern: ^(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,40})$ + Name: + type: string + description: The name that identifies the cluster. + Networking: + type: object + description: The networking configuration for the cluster's control plane. + properties: + SecurityGroupIds: + type: array + description: The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SecurityGroupId' + SubnetIds: + type: array + description: The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SubnetId' + NetworkType: + type: string + description: The IP of the cluster (IPV4 or IPV6) + enum: + - IPV4 + - IPV6 + x-insertionOrder: false + additionalProperties: false + Scheduler: + type: object + description: The cluster management and job scheduling software associated with the cluster. + properties: + Type: + type: string + description: The software AWS PCS uses to manage cluster scaling and job scheduling. + enum: + - SLURM + Version: + type: string + description: The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling. + required: + - Type + - Version + additionalProperties: false + Size: + type: string + description: The size of the cluster. + enum: + - SMALL + - MEDIUM + - LARGE + SlurmConfiguration: + type: object + description: Additional options related to the Slurm scheduler. + properties: + Accounting: + $ref: '#/components/schemas/Accounting' + AuthKey: + $ref: '#/components/schemas/AuthKey' + ScaleDownIdleTimeInSeconds: + type: integer + description: The time before an idle node is scaled down. + minimum: 1 + SlurmCustomSettings: + type: array + description: Additional Slurm-specific configuration that directly maps to Slurm settings. + x-insertionOrder: false + items: + $ref: '#/components/schemas/SlurmCustomSetting' + additionalProperties: false + Status: + type: string + description: The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - CREATE_FAILED + - DELETE_FAILED + - UPDATE_FAILED + Tags: + description: 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateComputeNodeGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group. + type: string + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - CREATE_FAILED + - DELETE_FAILED + - UPDATE_FAILED + ClusterId: + description: The ID of the cluster of the compute node group. + type: string + ErrorInfo: + description: The list of errors that occurred during compute node group provisioning. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ErrorInfo' + SpotOptions: + description: Additional configuration when you specify SPOT as the purchase option. + additionalProperties: false + type: object + properties: + AllocationStrategy: + description: The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized. + type: string + enum: + - lowest-price + - capacity-optimized + - price-capacity-optimized + SlurmConfiguration: + description: Additional options related to the Slurm scheduler. + additionalProperties: false + type: object + properties: + SlurmCustomSettings: + description: Additional Slurm-specific configuration that directly maps to Slurm settings. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SlurmCustomSetting' + SubnetIds: + description: The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SubnetId' + Name: + description: The name that identifies the compute node group. + type: string + ScalingConfiguration: + description: Specifies the boundaries of the compute node group auto scaling. + additionalProperties: false + type: object + properties: + MaxInstanceCount: + description: The upper bound of the number of instances allowed in the compute fleet. + type: integer + minimum: 0 + MinInstanceCount: + description: The lower bound of the number of instances allowed in the compute fleet. + type: integer + minimum: 0 + required: + - MaxInstanceCount + - MinInstanceCount + InstanceConfigs: + description: A list of EC2 instance configurations that AWS PCS can provision in the compute node group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/InstanceConfig' + Id: + description: The generated unique ID of the compute node group. + type: string + PurchaseOption: + description: Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand. + type: string + enum: + - ONDEMAND + - SPOT + Arn: + description: The unique Amazon Resource Name (ARN) of the compute node group. + type: string + CustomLaunchTemplate: + description: An Amazon EC2 launch template AWS PCS uses to launch compute nodes. + additionalProperties: false + type: object + properties: + Version: + description: The version of the EC2 launch template to use to provision instances. + type: string + TemplateId: + description: The ID of the EC2 launch template to use to provision instances. + type: string + required: + - Version + Tags: + x-patternProperties: + ^.+$: + type: string + description: 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. + additionalProperties: false + AmiId: + pattern: ^ami-[a-z0-9]+$ + description: The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances. If not provided, AWS PCS uses the AMI ID specified in the custom launch template. + type: string + IamInstanceProfileArn: + pattern: ^arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{1,128}$ + description: The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly. + type: string + x-stackQL-stringOnly: true + x-title: CreateComputeNodeGroupRequest + type: object + required: [] + CreateQueueRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The unique Amazon Resource Name (ARN) of the queue. + pattern: ^(.*?) + ClusterId: + type: string + description: The ID of the cluster of the queue. + ComputeNodeGroupConfigurations: + type: array + description: The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups. + x-insertionOrder: false + items: + $ref: '#/components/schemas/ComputeNodeGroupConfiguration' + ErrorInfo: + type: array + description: The list of errors that occurred during queue provisioning. + x-insertionOrder: false + items: + $ref: '#/components/schemas/ErrorInfo' + Id: + type: string + description: The generated unique ID of the queue. + Name: + type: string + description: The name that identifies the queue. + Status: + type: string + description: The provisioning status of the queue. The provisioning status doesn't indicate the overall health of the queue. + enum: + - CREATING + - ACTIVE + - UPDATING + - DELETING + - CREATE_FAILED + - DELETE_FAILED + - UPDATE_FAILED + Tags: + type: object + description: 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string. + x-patternProperties: + ^.+$: + type: string + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateQueueRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + clusters: + name: clusters + id: awscc.pcs.clusters + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::PCS::Cluster + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Endpoints') as endpoints, + JSON_EXTRACT(Properties, '$.ErrorInfo') as error_info, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Networking') as networking, + JSON_EXTRACT(Properties, '$.Scheduler') as scheduler, + JSON_EXTRACT(Properties, '$.Size') as size, + JSON_EXTRACT(Properties, '$.SlurmConfiguration') as slurm_configuration, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCS::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Endpoints') as endpoints, + json_extract_path_text(Properties, 'ErrorInfo') as error_info, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Networking') as networking, + json_extract_path_text(Properties, 'Scheduler') as scheduler, + json_extract_path_text(Properties, 'Size') as size, + json_extract_path_text(Properties, 'SlurmConfiguration') as slurm_configuration, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCS::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + clusters_list_only: + name: clusters_list_only + id: awscc.pcs.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::PCS::Cluster + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCS::Cluster' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCS::Cluster' + AND region = 'us-east-1' + compute_node_groups: + name: compute_node_groups + id: awscc.pcs.compute_node_groups + x-cfn-schema-name: ComputeNodeGroup + x-cfn-type-name: AWS::PCS::ComputeNodeGroup + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ComputeNodeGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::ComputeNodeGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::ComputeNodeGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::ComputeNodeGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/compute_node_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/compute_node_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/compute_node_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.ClusterId') as cluster_id, + JSON_EXTRACT(Properties, '$.ErrorInfo') as error_info, + JSON_EXTRACT(Properties, '$.SpotOptions') as spot_options, + JSON_EXTRACT(Properties, '$.SlurmConfiguration') as slurm_configuration, + JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ScalingConfiguration') as scaling_configuration, + JSON_EXTRACT(Properties, '$.InstanceConfigs') as instance_configs, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.PurchaseOption') as purchase_option, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CustomLaunchTemplate') as custom_launch_template, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AmiId') as ami_id, + JSON_EXTRACT(Properties, '$.IamInstanceProfileArn') as iam_instance_profile_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCS::ComputeNodeGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ClusterId') as cluster_id, + json_extract_path_text(Properties, 'ErrorInfo') as error_info, + json_extract_path_text(Properties, 'SpotOptions') as spot_options, + json_extract_path_text(Properties, 'SlurmConfiguration') as slurm_configuration, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ScalingConfiguration') as scaling_configuration, + json_extract_path_text(Properties, 'InstanceConfigs') as instance_configs, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PurchaseOption') as purchase_option, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CustomLaunchTemplate') as custom_launch_template, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AmiId') as ami_id, + json_extract_path_text(Properties, 'IamInstanceProfileArn') as iam_instance_profile_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCS::ComputeNodeGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + compute_node_groups_list_only: + name: compute_node_groups_list_only + id: awscc.pcs.compute_node_groups_list_only + x-cfn-schema-name: ComputeNodeGroup + x-cfn-type-name: AWS::PCS::ComputeNodeGroup + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCS::ComputeNodeGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCS::ComputeNodeGroup' + AND region = 'us-east-1' + queues: + name: queues + id: awscc.pcs.queues + x-cfn-schema-name: Queue + x-cfn-type-name: AWS::PCS::Queue + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PCS::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ClusterId') as cluster_id, + JSON_EXTRACT(Properties, '$.ComputeNodeGroupConfigurations') as compute_node_group_configurations, + JSON_EXTRACT(Properties, '$.ErrorInfo') as error_info, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCS::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ClusterId') as cluster_id, + json_extract_path_text(Properties, 'ComputeNodeGroupConfigurations') as compute_node_group_configurations, + json_extract_path_text(Properties, 'ErrorInfo') as error_info, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::PCS::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + queues_list_only: + name: queues_list_only + id: awscc.pcs.queues_list_only + x-cfn-schema-name: Queue + x-cfn-type-name: AWS::PCS::Queue + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCS::Queue' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::PCS::Queue' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ComputeNodeGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateComputeNodeGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateComputeNodeGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueue + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/personalize.yaml b/providers/src/awscc/v00.00.00000/services/personalize.yaml index 1cc98047..78cc6fd1 100644 --- a/providers/src/awscc/v00.00.00000/services/personalize.yaml +++ b/providers/src/awscc/v00.00.00000/services/personalize.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Personalize - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DatasetImportJob: description: Initial DatasetImportJob for the created dataset @@ -81,7 +461,9 @@ components: - DatasetGroupArn - SchemaArn x-stackql-resource-name: dataset - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Personalize::Dataset. + x-type-name: AWS::Personalize::Dataset + x-stackql-primary-identifier: - DatasetArn x-create-only-properties: - Name @@ -90,6 +472,12 @@ components: - SchemaArn x-read-only-properties: - DatasetArn + x-required-properties: + - Name + - DatasetType + - DatasetGroupArn + - SchemaArn + x-replacement-strategy: delete_then_create x-required-permissions: create: - personalize:CreateDataset @@ -143,7 +531,9 @@ components: required: - Name x-stackql-resource-name: dataset_group - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::Personalize::DatasetGroup. + x-type-name: AWS::Personalize::DatasetGroup + x-stackql-primary-identifier: - DatasetGroupArn x-create-only-properties: - Name @@ -152,6 +542,8 @@ components: - Domain x-read-only-properties: - DatasetGroupArn + x-required-properties: + - Name x-required-permissions: create: - personalize:CreateDatasetGroup @@ -192,7 +584,9 @@ components: - Name - Schema x-stackql-resource-name: schema - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Personalize::Schema. + x-type-name: AWS::Personalize::Schema + x-stackql-primary-identifier: - SchemaArn x-create-only-properties: - Name @@ -200,6 +594,9 @@ components: - Domain x-read-only-properties: - SchemaArn + x-required-properties: + - Name + - Schema x-required-permissions: create: - personalize:CreateSchema @@ -410,7 +807,9 @@ components: - Name - DatasetGroupArn x-stackql-resource-name: solution - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Personalize::Solution. + x-type-name: AWS::Personalize::Solution + x-stackql-primary-identifier: - SolutionArn x-create-only-properties: - Name @@ -422,6 +821,9 @@ components: - SolutionConfig x-read-only-properties: - SolutionArn + x-required-properties: + - Name + - DatasetGroupArn x-required-permissions: create: - personalize:CreateSolution @@ -433,43 +835,251 @@ components: - personalize:DescribeSolution list: - personalize:ListSolutions + CreateDatasetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name for the dataset + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* + minLength: 1 + maxLength: 63 + DatasetArn: + description: The ARN of the dataset + type: string + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + maxLength: 256 + DatasetType: + description: The type of dataset + type: string + enum: + - Interactions + - Items + - Users + maxLength: 256 + DatasetGroupArn: + description: The Amazon Resource Name (ARN) of the dataset group to add the dataset to + type: string + maxLength: 256 + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + SchemaArn: + description: The ARN of the schema to associate with the dataset. The schema defines the dataset fields. + type: string + maxLength: 256 + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + DatasetImportJob: + $ref: '#/components/schemas/DatasetImportJob' + x-stackQL-stringOnly: true + x-title: CreateDatasetRequest + type: object + required: [] + CreateDatasetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatasetGroupArn: + description: The Amazon Resource Name (ARN) of the dataset group. + type: string + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + maxLength: 256 + Name: + description: The name for the new dataset group. + type: string + minLength: 1 + maxLength: 63 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* + KmsKeyArn: + description: The Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets. + type: string + maxLength: 2048 + pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.* + RoleArn: + description: The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key. + type: string + pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ + minLength: 0 + maxLength: 256 + Domain: + description: The domain of a Domain dataset group. + type: string + enum: + - ECOMMERCE + - VIDEO_ON_DEMAND + x-stackQL-stringOnly: true + x-title: CreateDatasetGroupRequest + type: object + required: [] + CreateSchemaRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name for the schema. + type: string + minLength: 1 + maxLength: 63 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* + SchemaArn: + description: Arn for the schema. + type: string + maxLength: 256 + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + Schema: + description: A schema in Avro JSON format. + type: string + maxLength: 10000 + Domain: + description: The domain of a Domain dataset group. + type: string + enum: + - ECOMMERCE + - VIDEO_ON_DEMAND + x-stackQL-stringOnly: true + x-title: CreateSchemaRequest + type: object + required: [] + CreateSolutionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name for the solution + type: string + minLength: 1 + maxLength: 63 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* + SolutionArn: + $ref: '#/components/schemas/SolutionArn' + EventType: + description: When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type. + type: string + maxLength: 256 + DatasetGroupArn: + description: The ARN of the dataset group that provides the training data. + type: string + maxLength: 256 + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + PerformAutoML: + description: Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn. + type: boolean + PerformHPO: + description: Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false. + type: boolean + RecipeArn: + description: The ARN of the recipe to use for model training. Only specified when performAutoML is false. + type: string + maxLength: 256 + pattern: arn:([a-z\d-]+):personalize:.*:.*:.+ + SolutionConfig: + $ref: '#/components/schemas/SolutionConfig' + x-stackQL-stringOnly: true + x-title: CreateSolutionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: datasets: name: datasets id: awscc.personalize.datasets x-cfn-schema-name: Dataset - x-type: list - x-identifiers: - - DatasetArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatasetArn') as dataset_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatasetArn') as dataset_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: awscc.personalize.dataset - x-cfn-schema-name: Dataset - x-type: get + x-cfn-type-name: AWS::Personalize::Dataset x-identifiers: - DatasetArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Dataset" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -484,7 +1094,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -498,13 +1108,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Dataset' AND data__Identifier = '' AND region = 'us-east-1' - dataset_groups: - name: dataset_groups - id: awscc.personalize.dataset_groups - x-cfn-schema-name: DatasetGroup - x-type: list + datasets_list_only: + name: datasets_list_only + id: awscc.personalize.datasets_list_only + x-cfn-schema-name: Dataset + x-cfn-type-name: AWS::Personalize::Dataset x-identifiers: - - DatasetGroupArn + - DatasetArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -512,28 +1128,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' + JSON_EXTRACT(Properties, '$.DatasetArn') as dataset_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' + json_extract_path_text(Properties, 'DatasetArn') as dataset_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' AND region = 'us-east-1' - dataset_group: - name: dataset_group - id: awscc.personalize.dataset_group + dataset_groups: + name: dataset_groups + id: awscc.personalize.dataset_groups x-cfn-schema-name: DatasetGroup - x-type: get + x-cfn-type-name: AWS::Personalize::DatasetGroup x-identifiers: - DatasetGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DatasetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::DatasetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::DatasetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -547,7 +1198,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -560,13 +1211,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' AND data__Identifier = '' AND region = 'us-east-1' - schemata: - name: schemata - id: awscc.personalize.schemata - x-cfn-schema-name: Schema - x-type: list + dataset_groups_list_only: + name: dataset_groups_list_only + id: awscc.personalize.dataset_groups_list_only + x-cfn-schema-name: DatasetGroup + x-cfn-type-name: AWS::Personalize::DatasetGroup x-identifiers: - - SchemaArn + - DatasetGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -574,28 +1231,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' + JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' AND region = 'us-east-1' - schema: - name: schema - id: awscc.personalize.schema + schemata: + name: schemata + id: awscc.personalize.schemata x-cfn-schema-name: Schema - x-type: get + x-cfn-type-name: AWS::Personalize::Schema x-identifiers: - SchemaArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Schema&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Schema" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Schema" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schemata/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schemata/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -608,7 +1300,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -620,13 +1312,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Schema' AND data__Identifier = '' AND region = 'us-east-1' - solutions: - name: solutions - id: awscc.personalize.solutions - x-cfn-schema-name: Solution - x-type: list + schemata_list_only: + name: schemata_list_only + id: awscc.personalize.schemata_list_only + x-cfn-schema-name: Schema + x-cfn-type-name: AWS::Personalize::Schema x-identifiers: - - SolutionArn + - SchemaArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -634,28 +1332,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SolutionArn') as solution_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' + JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SolutionArn') as solution_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' + json_extract_path_text(Properties, 'SchemaArn') as schema_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' AND region = 'us-east-1' - solution: - name: solution - id: awscc.personalize.solution + solutions: + name: solutions + id: awscc.personalize.solutions x-cfn-schema-name: Solution - x-type: get + x-cfn-type-name: AWS::Personalize::Solution x-identifiers: - SolutionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Solution&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Solution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Personalize::Solution" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/solutions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/solutions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -672,7 +1405,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -688,3 +1421,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Solution' AND data__Identifier = '' AND region = 'us-east-1' + solutions_list_only: + name: solutions_list_only + id: awscc.personalize.solutions_list_only + x-cfn-schema-name: Solution + x-cfn-type-name: AWS::Personalize::Solution + x-identifiers: + - SolutionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SolutionArn') as solution_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SolutionArn') as solution_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dataset&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataset + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DatasetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDatasetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatasetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Schema&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchema + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSchemaRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Solution&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSolution + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSolutionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/pinpoint.yaml b/providers/src/awscc/v00.00.00000/services/pinpoint.yaml index 63883a78..c5644648 100644 --- a/providers/src/awscc/v00.00.00000/services/pinpoint.yaml +++ b/providers/src/awscc/v00.00.00000/services/pinpoint.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Pinpoint - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Alignment: enum: @@ -119,12 +499,25 @@ components: required: - TemplateName x-stackql-resource-name: in_app_template - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Pinpoint::InAppTemplate + x-type-name: AWS::Pinpoint::InAppTemplate + x-stackql-primary-identifier: - TemplateName x-create-only-properties: - TemplateName x-read-only-properties: - Arn + x-required-properties: + - TemplateName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - mobiletargeting:TagResource + - mobiletargeting:UntagResource x-required-permissions: create: - mobiletargeting:CreateInAppTemplate @@ -142,39 +535,159 @@ components: update: - mobiletargeting:UpdateInAppTemplate - mobiletargeting:GetInAppTemplate + - mobiletargeting:TagResource + - mobiletargeting:UntagResource + CreateInAppTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + Content: + x-insertionOrder: true + items: + $ref: '#/components/schemas/InAppMessageContent' + type: array + CustomConfig: + type: object + Layout: + enum: + - BOTTOM_BANNER + - TOP_BANNER + - OVERLAYS + - MOBILE_FEED + - MIDDLE_BANNER + - CAROUSEL + type: string + Tags: + type: object + TemplateDescription: + type: string + TemplateName: + type: string + x-stackQL-stringOnly: true + x-title: CreateInAppTemplateRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: in_app_templates: name: in_app_templates id: awscc.pinpoint.in_app_templates x-cfn-schema-name: InAppTemplate - x-type: list + x-cfn-type-name: AWS::Pinpoint::InAppTemplate x-identifiers: - TemplateName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InAppTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Pinpoint::InAppTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Pinpoint::InAppTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Pinpoint::InAppTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Content') as content, + JSON_EXTRACT(Properties, '$.CustomConfig') as custom_config, + JSON_EXTRACT(Properties, '$.Layout') as layout, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TemplateDescription') as template_description, JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'CustomConfig') as custom_config, + json_extract_path_text(Properties, 'Layout') as layout, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateDescription') as template_description, json_extract_path_text(Properties, 'TemplateName') as template_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' + AND data__Identifier = '' AND region = 'us-east-1' - in_app_template: - name: in_app_template - id: awscc.pinpoint.in_app_template + in_app_templates_list_only: + name: in_app_templates_list_only + id: awscc.pinpoint.in_app_templates_list_only x-cfn-schema-name: InAppTemplate - x-type: get + x-cfn-type-name: AWS::Pinpoint::InAppTemplate x-identifiers: - TemplateName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -182,30 +695,209 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Content') as content, - JSON_EXTRACT(Properties, '$.CustomConfig') as custom_config, - JSON_EXTRACT(Properties, '$.Layout') as layout, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TemplateDescription') as template_description, JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'CustomConfig') as custom_config, - json_extract_path_text(Properties, 'Layout') as layout, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateDescription') as template_description, json_extract_path_text(Properties, 'TemplateName') as template_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InAppTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInAppTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInAppTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/pipes.yaml b/providers/src/awscc/v00.00.00000/services/pipes.yaml index d926789e..e62fabe1 100644 --- a/providers/src/awscc/v00.00.00000/services/pipes.yaml +++ b/providers/src/awscc/v00.00.00000/services/pipes.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Pipes - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AssignPublicIp: type: string @@ -143,7 +523,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):log-group:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:logs:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):log-group:.+)$ additionalProperties: false DeadLetterConfig: type: object @@ -152,8 +532,30 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ additionalProperties: false + DimensionMapping: + type: object + properties: + DimensionValue: + type: string + maxLength: 2048 + minLength: 1 + DimensionValueType: + $ref: '#/components/schemas/DimensionValueType' + DimensionName: + type: string + maxLength: 256 + minLength: 1 + required: + - DimensionName + - DimensionValue + - DimensionValueType + additionalProperties: false + DimensionValueType: + type: string + enum: + - VARCHAR DynamoDBStreamStartPosition: type: string enum: @@ -260,7 +662,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ InferenceAcceleratorOverrides: type: array items: @@ -271,8 +673,15 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ additionalProperties: false + EpochTimeUnit: + type: string + enum: + - MILLISECONDS + - SECONDS + - MICROSECONDS + - NANOSECONDS Filter: type: object properties: @@ -298,7 +707,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):deliverystream/.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:firehose:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):deliverystream/.+)$ additionalProperties: false HeaderParametersMap: type: object @@ -341,7 +750,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - BasicAuth @@ -355,7 +764,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - SaslScram512Auth @@ -367,7 +776,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - ClientCertificateTlsAuth @@ -377,6 +786,49 @@ components: enum: - TRIM_HORIZON - LATEST + MeasureValueType: + type: string + enum: + - DOUBLE + - BIGINT + - VARCHAR + - BOOLEAN + - TIMESTAMP + MultiMeasureAttributeMapping: + type: object + properties: + MeasureValue: + type: string + maxLength: 2048 + minLength: 1 + MeasureValueType: + $ref: '#/components/schemas/MeasureValueType' + MultiMeasureAttributeName: + type: string + maxLength: 256 + minLength: 1 + required: + - MeasureValue + - MeasureValueType + - MultiMeasureAttributeName + additionalProperties: false + MultiMeasureMapping: + type: object + properties: + MultiMeasureName: + type: string + maxLength: 256 + minLength: 1 + MultiMeasureAttributeMappings: + type: array + items: + $ref: '#/components/schemas/MultiMeasureAttributeMapping' + maxItems: 256 + minItems: 1 + required: + - MultiMeasureAttributeMappings + - MultiMeasureName + additionalProperties: false NetworkConfiguration: type: object properties: @@ -629,7 +1081,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials Vpc: $ref: '#/components/schemas/SelfManagedKafkaAccessConfigurationVpc' @@ -711,7 +1163,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ TaskCount: type: integer minimum: 1 @@ -785,7 +1237,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ maxItems: 10 minItems: 0 Time: @@ -857,6 +1309,8 @@ components: $ref: '#/components/schemas/PipeTargetEventBridgeEventBusParameters' CloudWatchLogsParameters: $ref: '#/components/schemas/PipeTargetCloudWatchLogsParameters' + TimestreamParameters: + $ref: '#/components/schemas/PipeTargetTimestreamParameters' additionalProperties: false PipeTargetRedshiftDataParameters: type: object @@ -865,7 +1319,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ description: Optional SecretManager ARN which stores the database credentials Database: type: string @@ -927,6 +1381,48 @@ components: InvocationType: $ref: '#/components/schemas/PipeTargetInvocationType' additionalProperties: false + PipeTargetTimestreamParameters: + type: object + properties: + TimeValue: + type: string + maxLength: 256 + minLength: 1 + EpochTimeUnit: + $ref: '#/components/schemas/EpochTimeUnit' + TimeFieldType: + $ref: '#/components/schemas/TimeFieldType' + TimestampFormat: + type: string + maxLength: 256 + minLength: 1 + VersionValue: + type: string + maxLength: 256 + minLength: 1 + DimensionMappings: + type: array + items: + $ref: '#/components/schemas/DimensionMapping' + maxItems: 128 + minItems: 1 + SingleMeasureMappings: + type: array + items: + $ref: '#/components/schemas/SingleMeasureMapping' + maxItems: 8192 + minItems: 0 + MultiMeasureMappings: + type: array + items: + $ref: '#/components/schemas/MultiMeasureMapping' + maxItems: 1024 + minItems: 0 + required: + - DimensionMappings + - TimeValue + - VersionValue + additionalProperties: false PlacementConstraint: type: object properties: @@ -1019,7 +1515,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - BasicAuth @@ -1031,7 +1527,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - SaslScram512Auth @@ -1043,7 +1539,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - SaslScram256Auth @@ -1055,7 +1551,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ + pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$ description: Optional SecretManager ARN which stores the database credentials required: - ClientCertificateTlsAuth @@ -1089,6 +1585,24 @@ components: enum: - TRIM_HORIZON - LATEST + SingleMeasureMapping: + type: object + properties: + MeasureValue: + type: string + maxLength: 2048 + minLength: 1 + MeasureValueType: + $ref: '#/components/schemas/MeasureValueType' + MeasureName: + type: string + maxLength: 1024 + minLength: 1 + required: + - MeasureName + - MeasureValue + - MeasureValueType + additionalProperties: false Tag: type: object properties: @@ -1114,6 +1628,11 @@ components: maxLength: 256 minLength: 0 additionalProperties: false + TimeFieldType: + type: string + enum: + - EPOCH + - TIMESTAMP_FORMAT Pipe: type: object properties: @@ -1138,9 +1657,13 @@ components: type: string maxLength: 1600 minLength: 0 - pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ EnrichmentParameters: $ref: '#/components/schemas/PipeEnrichmentParameters' + KmsKeyIdentifier: + type: string + maxLength: 2048 + minLength: 0 LastModifiedTime: type: string format: date-time @@ -1160,7 +1683,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + pattern: ^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ SourceParameters: $ref: '#/components/schemas/PipeSourceParameters' StateReason: @@ -1174,7 +1697,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ TargetParameters: $ref: '#/components/schemas/PipeTargetParameters' required: @@ -1182,8 +1705,12 @@ components: - Source - Target x-stackql-resource-name: pipe - x-stackql-primaryIdentifier: + description: Definition of AWS::Pipes::Pipe Resource Type + x-type-name: AWS::Pipes::Pipe + x-stackql-primary-identifier: - Name + x-stackql-additional-identifiers: + - - Arn x-create-only-properties: - Name - Source @@ -1196,16 +1723,33 @@ components: - SourceParameters/ManagedStreamingKafkaParameters/TopicName - SourceParameters/ManagedStreamingKafkaParameters/StartingPosition - SourceParameters/ManagedStreamingKafkaParameters/ConsumerGroupID - - SourceParameters/SelfManagedApacheKafkaParameters/TopicName - - SourceParameters/SelfManagedApacheKafkaParameters/StartingPosition - - SourceParameters/SelfManagedApacheKafkaParameters/AdditionalBootstrapServers - - SourceParameters/SelfManagedApacheKafkaParameters/ConsumerGroupID + - SourceParameters/SelfManagedKafkaParameters/TopicName + - SourceParameters/SelfManagedKafkaParameters/StartingPosition + - SourceParameters/SelfManagedKafkaParameters/AdditionalBootstrapServers + - SourceParameters/SelfManagedKafkaParameters/ConsumerGroupID + x-write-only-properties: + - TargetParameters + - SourceParameters x-read-only-properties: - Arn - CreationTime - CurrentState - LastModifiedTime - StateReason + x-required-properties: + - RoleArn + - Source + - Target + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - pipes:TagResource + - pipes:UntagResource + - pipes:ListTagsForResource x-required-permissions: create: - pipes:CreatePipe @@ -1222,8 +1766,12 @@ components: - s3:PutBucketPolicy - s3:GetBucketPolicy - firehose:TagDeliveryStream + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey read: - pipes:DescribePipe + - kms:Decrypt update: - pipes:UpdatePipe - pipes:TagResource @@ -1242,53 +1790,171 @@ components: - s3:PutBucketPolicy - s3:GetBucketPolicy - firehose:TagDeliveryStream + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey delete: - pipes:DeletePipe - pipes:DescribePipe + - pipes:UntagResource - logs:CreateLogDelivery - logs:UpdateLogDelivery - logs:DeleteLogDelivery - logs:GetLogDelivery - logs:ListLogDeliveries + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey list: - pipes:ListPipes + CreatePipeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 1600 + minLength: 1 + pattern: ^arn:aws([a-z]|\-)*:([a-zA-Z0-9\-]+):([a-z]|\d|\-)*:([0-9]{12})?:(.+)$ + CreationTime: + type: string + format: date-time + CurrentState: + $ref: '#/components/schemas/PipeState' + Description: + type: string + maxLength: 512 + minLength: 0 + pattern: ^.*$ + DesiredState: + $ref: '#/components/schemas/RequestedPipeState' + Enrichment: + type: string + maxLength: 1600 + minLength: 0 + pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + EnrichmentParameters: + $ref: '#/components/schemas/PipeEnrichmentParameters' + KmsKeyIdentifier: + type: string + maxLength: 2048 + minLength: 0 + LastModifiedTime: + type: string + format: date-time + LogConfiguration: + $ref: '#/components/schemas/PipeLogConfiguration' + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[\.\-_A-Za-z0-9]+$ + RoleArn: + type: string + maxLength: 1600 + minLength: 1 + pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z0-9+=,.@\-_/]+$ + Source: + type: string + maxLength: 1600 + minLength: 1 + pattern: ^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + SourceParameters: + $ref: '#/components/schemas/PipeSourceParameters' + StateReason: + type: string + maxLength: 512 + minLength: 0 + pattern: ^.*$ + Tags: + $ref: '#/components/schemas/TagMap' + Target: + type: string + maxLength: 1600 + minLength: 1 + pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ + TargetParameters: + $ref: '#/components/schemas/PipeTargetParameters' + x-stackQL-stringOnly: true + x-title: CreatePipeRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: pipes: name: pipes id: awscc.pipes.pipes x-cfn-schema-name: Pipe - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' - AND region = 'us-east-1' - pipe: - name: pipe - id: awscc.pipes.pipe - x-cfn-schema-name: Pipe - x-type: get + x-cfn-type-name: AWS::Pipes::Pipe x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Pipe&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Pipes::Pipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Pipes::Pipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Pipes::Pipe" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pipes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1300,6 +1966,7 @@ components: JSON_EXTRACT(Properties, '$.DesiredState') as desired_state, JSON_EXTRACT(Properties, '$.Enrichment') as enrichment, JSON_EXTRACT(Properties, '$.EnrichmentParameters') as enrichment_parameters, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, JSON_EXTRACT(Properties, '$.LogConfiguration') as log_configuration, JSON_EXTRACT(Properties, '$.Name') as name, @@ -1314,7 +1981,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1326,6 +1993,7 @@ components: json_extract_path_text(Properties, 'DesiredState') as desired_state, json_extract_path_text(Properties, 'Enrichment') as enrichment, json_extract_path_text(Properties, 'EnrichmentParameters') as enrichment_parameters, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, json_extract_path_text(Properties, 'Name') as name, @@ -1339,3 +2007,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Pipes::Pipe' AND data__Identifier = '' AND region = 'us-east-1' + pipes_list_only: + name: pipes_list_only + id: awscc.pipes.pipes_list_only + x-cfn-schema-name: Pipe + x-cfn-type-name: AWS::Pipes::Pipe + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Pipe&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePipe + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePipeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/proton.yaml b/providers/src/awscc/v00.00.00000/services/proton.yaml index eade7074..20e841bf 100644 --- a/providers/src/awscc/v00.00.00000/services/proton.yaml +++ b/providers/src/awscc/v00.00.00000/services/proton.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Proton - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Status: type: string @@ -85,12 +465,26 @@ components:

For more information, see Proton resources and tagging in the Proton User Guide.

x-stackql-resource-name: environment_account_connection - x-stackql-primaryIdentifier: + description: Resource Schema describing various properties for AWS Proton Environment Account Connections resources. + x-type-name: AWS::Proton::EnvironmentAccountConnection + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id x-read-only-properties: - Arn - Id - Status + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - proton:ListTagsForResource + - proton:UntagResource + - proton:TagResource x-required-permissions: create: - proton:CreateEnvironmentAccountConnection @@ -164,36 +558,195 @@ components:

For more information, see Proton resources and tagging in the Proton User Guide.

x-stackql-resource-name: environment_template - x-stackql-primaryIdentifier: + description: Definition of AWS::Proton::EnvironmentTemplate Resource Type + x-type-name: AWS::Proton::EnvironmentTemplate + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Name x-create-only-properties: - EncryptionKey - Name - Provisioning x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - proton:ListTagsForResource + - proton:UntagResource + - proton:TagResource x-required-permissions: create: - proton:CreateEnvironmentTemplate + - proton:DeleteEnvironmentTemplate + - proton:ListTagsForResource - proton:TagResource - proton:GetEnvironmentTemplate - - kms:* + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion read: - - proton:GetEnvironmentTemplate + - proton:CreateEnvironmentTemplate + - proton:DeleteEnvironmentTemplate - proton:ListTagsForResource - - kms:* + - proton:GetEnvironmentTemplate + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion update: - proton:CreateEnvironmentTemplate + - proton:DeleteEnvironmentTemplate + - proton:GetEnvironmentTemplate - proton:ListTagsForResource - proton:TagResource - - proton:UntagResource - proton:UpdateEnvironmentTemplate - - proton:GetEnvironmentTemplate - - kms:* + - proton:UntagResource + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion delete: + - proton:CreateEnvironmentTemplate - proton:DeleteEnvironmentTemplate - proton:GetEnvironmentTemplate - - kms:* + - proton:ListTagsForResource + - proton:TagResource + - proton:UntagResource + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion list: - proton:ListEnvironmentTemplates ServiceTemplate: @@ -240,24 +793,106 @@ components:

For more information, see Proton resources and tagging in the Proton User Guide.

x-stackql-resource-name: service_template - x-stackql-primaryIdentifier: + description: Definition of AWS::Proton::ServiceTemplate Resource Type + x-type-name: AWS::Proton::ServiceTemplate + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Name x-create-only-properties: - EncryptionKey - Name - PipelineProvisioning x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - proton:ListTagsForResource + - proton:UntagResource + - proton:TagResource x-required-permissions: create: - proton:CreateServiceTemplate - proton:TagResource - - kms:* - proton:GetServiceTemplate + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion read: - proton:GetServiceTemplate - proton:ListTagsForResource - - kms:* + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion update: - proton:GetServiceTemplate - proton:CreateServiceTemplate @@ -265,51 +900,330 @@ components: - proton:TagResource - proton:UntagResource - proton:UpdateServiceTemplate - - kms:* + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion delete: - proton:DeleteServiceTemplate - proton:UntagResource - - kms:* - proton:GetServiceTemplate + - kms:CancelKeyDeletion + - kms:CreateAlias + - kms:CreateCustomKeyStore + - kms:CreateGrant + - kms:CreateKey + - kms:DeleteAlias + - kms:DeleteCustomKeyStore + - kms:DeleteImportedKeyMaterial + - kms:DescribeCustomKeyStores + - kms:DescribeKey + - kms:DisableKey + - kms:DisableKeyRotation + - kms:EnableKey + - kms:EnableKeyRotation + - kms:GenerateDataKey + - kms:GetKeyPolicy + - kms:GetKeyRotationStatus + - kms:GetParametersForImport + - kms:GetPublicKey + - kms:ListAliases + - kms:ListGrants + - kms:ListKeyPolicies + - kms:ListKeyRotations + - kms:ListKeys + - kms:ListResourceTags + - kms:ListRetirableGrants + - kms:PutKeyPolicy + - kms:RevokeGrant + - kms:ScheduleKeyDeletion + - kms:TagResource + - kms:UntagResource + - kms:UpdateAlias + - kms:UpdateCustomKeyStore + - kms:UpdateKeyDescription + - kms:UpdatePrimaryRegion list: - proton:ListServiceTemplates + - proton:ListTagsForResource + CreateEnvironmentAccountConnectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the environment account connection. + type: string + CodebuildRoleArn: + description: The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account. + type: string + minLength: 1 + maxLength: 200 + pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$ + ComponentRoleArn: + description: The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account. + type: string + minLength: 1 + maxLength: 200 + pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$ + EnvironmentAccountId: + description: The environment account that's connected to the environment account connection. + type: string + pattern: ^\d{12}$ + EnvironmentName: + description: The name of the AWS Proton environment that's created in the associated management account. + type: string + pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$ + minLength: 1 + maxLength: 100 + Id: + description: The ID of the environment account connection. + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + ManagementAccountId: + description: The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account. + type: string + pattern: ^\d{12}$ + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account. + type: string + minLength: 1 + maxLength: 200 + pattern: ^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$ + Status: + description: The status of the environment account connection. + $ref: '#/components/schemas/Status' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + uniqueItems: true + x-insertionOrder: false + description: |- +

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

+

For more information, see Proton resources and tagging in the + Proton User Guide.

+ x-stackQL-stringOnly: true + x-title: CreateEnvironmentAccountConnectionRequest + type: object + required: [] + CreateEnvironmentTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) of the environment template.

+ Description: + type: string + maxLength: 500 + minLength: 0 + description:

A description of the environment template.

+ DisplayName: + type: string + maxLength: 100 + minLength: 1 + description:

The environment template name as displayed in the developer interface.

+ EncryptionKey: + type: string + maxLength: 200 + minLength: 1 + pattern: ^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$ + description:

A customer provided encryption key that Proton uses to encrypt data.

+ Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$ + Provisioning: + $ref: '#/components/schemas/Provisioning' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 0 + uniqueItems: true + description: |- +

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

+

For more information, see Proton resources and tagging in the + Proton User Guide.

+ x-stackQL-stringOnly: true + x-title: CreateEnvironmentTemplateRequest + type: object + required: [] + CreateServiceTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 200 + minLength: 1 + pattern: ^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$ + description:

The Amazon Resource Name (ARN) of the service template.

+ Description: + type: string + maxLength: 500 + minLength: 0 + description:

A description of the service template.

+ DisplayName: + type: string + maxLength: 100 + minLength: 1 + description:

The name of the service template as displayed in the developer interface.

+ EncryptionKey: + type: string + maxLength: 200 + minLength: 1 + pattern: ^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$ + description:

A customer provided encryption key that's used to encrypt data.

+ Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$ + PipelineProvisioning: + $ref: '#/components/schemas/Provisioning' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 0 + uniqueItems: true + description: |- +

An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

+

For more information, see Proton resources and tagging in the + Proton User Guide.

+ x-stackQL-stringOnly: true + x-title: CreateServiceTemplateRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: environment_account_connections: name: environment_account_connections id: awscc.proton.environment_account_connections x-cfn-schema-name: EnvironmentAccountConnection - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' - AND region = 'us-east-1' - environment_account_connection: - name: environment_account_connection - id: awscc.proton.environment_account_connection - x-cfn-schema-name: EnvironmentAccountConnection - x-type: get + x-cfn-type-name: AWS::Proton::EnvironmentAccountConnection x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnvironmentAccountConnection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::EnvironmentAccountConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::EnvironmentAccountConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::EnvironmentAccountConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -328,7 +1242,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -346,13 +1260,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' AND data__Identifier = '' AND region = 'us-east-1' - environment_templates: - name: environment_templates - id: awscc.proton.environment_templates - x-cfn-schema-name: EnvironmentTemplate - x-type: list + environment_account_connections_list_only: + name: environment_account_connections_list_only + id: awscc.proton.environment_account_connections_list_only + x-cfn-schema-name: EnvironmentAccountConnection + x-cfn-type-name: AWS::Proton::EnvironmentAccountConnection x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -361,7 +1281,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -369,19 +1289,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' AND region = 'us-east-1' - environment_template: - name: environment_template - id: awscc.proton.environment_template + environment_templates: + name: environment_templates + id: awscc.proton.environment_templates x-cfn-schema-name: EnvironmentTemplate - x-type: get + x-cfn-type-name: AWS::Proton::EnvironmentTemplate x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EnvironmentTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::EnvironmentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::EnvironmentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::EnvironmentTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environment_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -397,7 +1365,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -412,13 +1380,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' AND data__Identifier = '' AND region = 'us-east-1' - service_templates: - name: service_templates - id: awscc.proton.service_templates - x-cfn-schema-name: ServiceTemplate - x-type: list + environment_templates_list_only: + name: environment_templates_list_only + id: awscc.proton.environment_templates_list_only + x-cfn-schema-name: EnvironmentTemplate + x-cfn-type-name: AWS::Proton::EnvironmentTemplate x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -427,7 +1401,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -435,19 +1409,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' AND region = 'us-east-1' - service_template: - name: service_template - id: awscc.proton.service_template + service_templates: + name: service_templates + id: awscc.proton.service_templates x-cfn-schema-name: ServiceTemplate - x-type: get + x-cfn-type-name: AWS::Proton::ServiceTemplate x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::ServiceTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::ServiceTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Proton::ServiceTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -463,7 +1485,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -478,3 +1500,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' AND data__Identifier = '' AND region = 'us-east-1' + service_templates_list_only: + name: service_templates_list_only + id: awscc.proton.service_templates_list_only + x-cfn-schema-name: ServiceTemplate + x-cfn-type-name: AWS::Proton::ServiceTemplate + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnvironmentAccountConnection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironmentAccountConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentAccountConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EnvironmentTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironmentTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/qbusiness.yaml b/providers/src/awscc/v00.00.00000/services/qbusiness.yaml new file mode 100644 index 00000000..d671286c --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/qbusiness.yaml @@ -0,0 +1,4291 @@ +openapi: 3.0.0 +info: + title: QBusiness + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ApplicationStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPDATING + AttachmentsConfiguration: + type: object + properties: + AttachmentsControlMode: + $ref: '#/components/schemas/AttachmentsControlMode' + required: + - AttachmentsControlMode + additionalProperties: false + AttachmentsControlMode: + type: string + enum: + - ENABLED + - DISABLED + AutoSubscriptionConfiguration: + type: object + properties: + AutoSubscribe: + $ref: '#/components/schemas/AutoSubscriptionStatus' + DefaultSubscriptionType: + $ref: '#/components/schemas/SubscriptionType' + required: + - AutoSubscribe + additionalProperties: false + AutoSubscriptionStatus: + type: string + enum: + - ENABLED + - DISABLED + EncryptionConfiguration: + type: object + properties: + KmsKeyId: + type: string + maxLength: 2048 + minLength: 1 + additionalProperties: false + IdentityType: + type: string + enum: + - AWS_IAM_IDP_SAML + - AWS_IAM_IDP_OIDC + - AWS_IAM_IDC + - AWS_QUICKSIGHT_IDP + - ANONYMOUS + PersonalizationConfiguration: + type: object + properties: + PersonalizationControlMode: + $ref: '#/components/schemas/PersonalizationControlMode' + required: + - PersonalizationControlMode + additionalProperties: false + PersonalizationControlMode: + type: string + enum: + - ENABLED + - DISABLED + QAppsConfiguration: + type: object + properties: + QAppsControlMode: + $ref: '#/components/schemas/QAppsControlMode' + required: + - QAppsControlMode + additionalProperties: false + QAppsControlMode: + type: string + enum: + - ENABLED + - DISABLED + QuickSightConfiguration: + type: object + properties: + ClientNamespace: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9._-]*$ + required: + - ClientNamespace + additionalProperties: false + SubscriptionType: + type: string + enum: + - Q_LITE + - Q_BUSINESS + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 0 + required: + - Key + - Value + additionalProperties: false + Application: + type: object + properties: + ApplicationArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AttachmentsConfiguration: + $ref: '#/components/schemas/AttachmentsConfiguration' + AutoSubscriptionConfiguration: + $ref: '#/components/schemas/AutoSubscriptionConfiguration' + ClientIdsForOIDC: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.:/()*?=-]*$ + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + IamIdentityProviderArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+$ + IdentityCenterApplicationArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + IdentityCenterInstanceArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + IdentityType: + $ref: '#/components/schemas/IdentityType' + PersonalizationConfiguration: + $ref: '#/components/schemas/PersonalizationConfiguration' + QAppsConfiguration: + $ref: '#/components/schemas/QAppsConfiguration' + QuickSightConfiguration: + $ref: '#/components/schemas/QuickSightConfiguration' + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/ApplicationStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + required: + - DisplayName + x-stackql-resource-name: application + description: Definition of AWS::QBusiness::Application Resource Type + x-type-name: AWS::QBusiness::Application + x-stackql-primary-identifier: + - ApplicationId + x-create-only-properties: + - ClientIdsForOIDC + - EncryptionConfiguration + - IamIdentityProviderArn + - IdentityType + - QuickSightConfiguration + x-write-only-properties: + - IdentityCenterInstanceArn + x-read-only-properties: + - ApplicationArn + - ApplicationId + - CreatedAt + - IdentityCenterApplicationArn + - Status + - UpdatedAt + x-required-properties: + - DisplayName + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - iam:GetSAMLProvider + - iam:PassRole + - kms:CreateGrant + - kms:DescribeKey + - qbusiness:CreateApplication + - qbusiness:GetApplication + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UpdateApplication + - quicksight:DescribeAccountSubscription + - quicksight:ListNamespaces + - sso:CreateApplication + - sso:DeleteApplication + - sso:DescribeInstance + - sso:PutApplicationAccessScope + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + read: + - qbusiness:GetApplication + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetApplication + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateApplication + - sso:CreateApplication + - sso:DeleteApplication + - sso:DescribeInstance + - sso:PutApplicationAccessScope + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + delete: + - kms:RetireGrant + - qbusiness:DeleteApplication + - qbusiness:GetApplication + - sso:DeleteApplication + list: + - qbusiness:ListApplications + ActionConfiguration: + type: object + properties: + Action: + type: string + pattern: ^qbusiness:[a-zA-Z]+$ + FilterConfiguration: + $ref: '#/components/schemas/ActionFilterConfiguration' + required: + - Action + additionalProperties: false + ActionFilterConfiguration: + type: object + properties: + DocumentAttributeFilter: + $ref: '#/components/schemas/AttributeFilter' + required: + - DocumentAttributeFilter + additionalProperties: false + AttributeFilter: + type: object + properties: + AndAllFilters: + type: array + items: + $ref: '#/components/schemas/AttributeFilter' + OrAllFilters: + type: array + items: + $ref: '#/components/schemas/AttributeFilter' + NotFilter: + $ref: '#/components/schemas/AttributeFilter' + EqualsTo: + $ref: '#/components/schemas/DocumentAttribute' + ContainsAll: + $ref: '#/components/schemas/DocumentAttribute' + ContainsAny: + $ref: '#/components/schemas/DocumentAttribute' + GreaterThan: + $ref: '#/components/schemas/DocumentAttribute' + GreaterThanOrEquals: + $ref: '#/components/schemas/DocumentAttribute' + LessThan: + $ref: '#/components/schemas/DocumentAttribute' + LessThanOrEquals: + $ref: '#/components/schemas/DocumentAttribute' + additionalProperties: false + DataAccessorAuthenticationConfiguration: + oneOf: + - type: object + title: IdcTrustedTokenIssuerConfiguration + properties: + IdcTrustedTokenIssuerConfiguration: + $ref: '#/components/schemas/DataAccessorIdcTrustedTokenIssuerConfiguration' + required: + - IdcTrustedTokenIssuerConfiguration + additionalProperties: false + DataAccessorAuthenticationDetail: + type: object + properties: + AuthenticationType: + $ref: '#/components/schemas/DataAccessorAuthenticationType' + AuthenticationConfiguration: + $ref: '#/components/schemas/DataAccessorAuthenticationConfiguration' + ExternalIds: + type: array + items: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + maxItems: 1 + minItems: 1 + required: + - AuthenticationType + additionalProperties: false + DataAccessorAuthenticationType: + type: string + enum: + - AWS_IAM_IDC_TTI + - AWS_IAM_IDC_AUTH_CODE + DataAccessorIdcTrustedTokenIssuerConfiguration: + type: object + properties: + IdcTrustedTokenIssuerArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:aws:sso::[0-9]{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + required: + - IdcTrustedTokenIssuerArn + additionalProperties: false + DocumentAttribute: + type: object + properties: + Name: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Value: + $ref: '#/components/schemas/DocumentAttributeValue' + required: + - Name + - Value + additionalProperties: false + DocumentAttributeValue: + oneOf: + - type: object + title: StringValue + properties: + StringValue: + type: string + maxLength: 2048 + required: + - StringValue + additionalProperties: false + - type: object + title: StringListValue + properties: + StringListValue: + type: array + x-insertionOrder: true + items: + type: string + maxLength: 2048 + minLength: 1 + required: + - StringListValue + additionalProperties: false + - type: object + title: LongValue + properties: + LongValue: + type: number + required: + - LongValue + additionalProperties: false + - type: object + title: DateValue + properties: + DateValue: + type: string + format: date-time + required: + - DateValue + additionalProperties: false + Unit: + type: object + additionalProperties: false + DataAccessor: + type: object + properties: + ActionConfigurations: + type: array + items: + $ref: '#/components/schemas/ActionConfiguration' + maxItems: 10 + minItems: 1 + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AuthenticationDetail: + $ref: '#/components/schemas/DataAccessorAuthenticationDetail' + CreatedAt: + type: string + format: date-time + DataAccessorArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + DataAccessorId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + DisplayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + IdcApplicationArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + Principal: + type: string + maxLength: 1284 + minLength: 1 + pattern: ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + required: + - ApplicationId + - ActionConfigurations + - DisplayName + - Principal + x-stackql-resource-name: data_accessor + description: Definition of AWS::QBusiness::DataAccessor Resource Type + x-type-name: AWS::QBusiness::DataAccessor + x-stackql-primary-identifier: + - ApplicationId + - DataAccessorId + x-create-only-properties: + - ApplicationId + - Principal + x-read-only-properties: + - CreatedAt + - DataAccessorArn + - DataAccessorId + - IdcApplicationArn + - UpdatedAt + x-required-properties: + - ApplicationId + - ActionConfigurations + - DisplayName + - Principal + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - qbusiness:CreateDataAccessor + - qbusiness:GetDataAccessor + - qbusiness:ListTagsForResource + - qbusiness:CreateDataAccessorWithTti + - qbusiness:TagResource + - sso:CreateApplication + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + - sso:PutApplicationAccessScope + - sso:DescribeTrustedTokenIssuer + read: + - qbusiness:GetDataAccessor + - qbusiness:ListTagsForResource + update: + - qbusiness:GetDataAccessor + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateDataAccessor + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + - sso:PutApplicationAccessScope + - sso:DescribeTrustedTokenIssuer + - sso:UpdateApplication + delete: + - qbusiness:DeleteDataAccessor + - qbusiness:GetDataAccessor + - sso:DeleteApplication + list: + - qbusiness:ListDataAccessors + AttributeValueOperator: + type: string + enum: + - DELETE + DataSourceStatus: + type: string + enum: + - PENDING_CREATION + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPDATING + DataSourceVpcConfiguration: + type: object + properties: + SubnetIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[-0-9a-zA-Z]+$ + SecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[-0-9a-zA-Z]+$ + maxItems: 10 + minItems: 1 + required: + - SecurityGroupIds + - SubnetIds + additionalProperties: false + DocumentAttributeCondition: + type: object + properties: + Key: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Operator: + $ref: '#/components/schemas/DocumentEnrichmentConditionOperator' + Value: + $ref: '#/components/schemas/DocumentAttributeValue' + required: + - Key + - Operator + additionalProperties: false + DocumentAttributeTarget: + type: object + properties: + Key: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Value: + $ref: '#/components/schemas/DocumentAttributeValue' + AttributeValueOperator: + $ref: '#/components/schemas/AttributeValueOperator' + required: + - Key + additionalProperties: false + DocumentContentOperator: + type: string + enum: + - DELETE + DocumentEnrichmentConditionOperator: + type: string + enum: + - GREATER_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN + - LESS_THAN_OR_EQUALS + - EQUALS + - NOT_EQUALS + - CONTAINS + - NOT_CONTAINS + - EXISTS + - NOT_EXISTS + - BEGINS_WITH + ImageExtractionStatus: + type: string + enum: + - ENABLED + - DISABLED + ImageExtractionConfiguration: + type: object + properties: + ImageExtractionStatus: + $ref: '#/components/schemas/ImageExtractionStatus' + required: + - ImageExtractionStatus + additionalProperties: false + AudioExtractionStatus: + type: string + enum: + - ENABLED + - DISABLED + AudioExtractionConfiguration: + type: object + properties: + AudioExtractionStatus: + $ref: '#/components/schemas/AudioExtractionStatus' + required: + - AudioExtractionStatus + additionalProperties: false + VideoExtractionStatus: + type: string + enum: + - ENABLED + - DISABLED + VideoExtractionConfiguration: + type: object + properties: + VideoExtractionStatus: + $ref: '#/components/schemas/VideoExtractionStatus' + required: + - VideoExtractionStatus + additionalProperties: false + MediaExtractionConfiguration: + type: object + properties: + ImageExtractionConfiguration: + $ref: '#/components/schemas/ImageExtractionConfiguration' + AudioExtractionConfiguration: + $ref: '#/components/schemas/AudioExtractionConfiguration' + VideoExtractionConfiguration: + $ref: '#/components/schemas/VideoExtractionConfiguration' + additionalProperties: false + DocumentEnrichmentConfiguration: + type: object + properties: + InlineConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/InlineDocumentEnrichmentConfiguration' + maxItems: 100 + minItems: 1 + PreExtractionHookConfiguration: + $ref: '#/components/schemas/HookConfiguration' + PostExtractionHookConfiguration: + $ref: '#/components/schemas/HookConfiguration' + additionalProperties: false + HookConfiguration: + type: object + properties: + InvocationCondition: + $ref: '#/components/schemas/DocumentAttributeCondition' + LambdaArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$ + S3BucketName: + type: string + maxLength: 63 + minLength: 1 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + additionalProperties: false + InlineDocumentEnrichmentConfiguration: + type: object + properties: + Condition: + $ref: '#/components/schemas/DocumentAttributeCondition' + Target: + $ref: '#/components/schemas/DocumentAttributeTarget' + DocumentContentOperator: + $ref: '#/components/schemas/DocumentContentOperator' + additionalProperties: false + DataSource: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: {} + CreatedAt: + type: string + format: date-time + DataSourceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + DataSourceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentEnrichmentConfiguration: + $ref: '#/components/schemas/DocumentEnrichmentConfiguration' + MediaExtractionConfiguration: + $ref: '#/components/schemas/MediaExtractionConfiguration' + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/DataSourceStatus' + SyncSchedule: + type: string + maxLength: 998 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + type: string + maxLength: 2048 + minLength: 1 + UpdatedAt: + type: string + format: date-time + VpcConfiguration: + $ref: '#/components/schemas/DataSourceVpcConfiguration' + required: + - ApplicationId + - IndexId + - Configuration + - DisplayName + x-stackql-resource-name: data_source + description: Definition of AWS::QBusiness::DataSource Resource Type + x-type-name: AWS::QBusiness::DataSource + x-stackql-primary-identifier: + - ApplicationId + - DataSourceId + - IndexId + x-create-only-properties: + - ApplicationId + - IndexId + x-read-only-properties: + - CreatedAt + - DataSourceArn + - DataSourceId + - Status + - Type + - UpdatedAt + x-required-properties: + - ApplicationId + - IndexId + - Configuration + - DisplayName + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreateDataSource + - qbusiness:GetDataSource + - qbusiness:ListTagsForResource + - qbusiness:TagResource + read: + - qbusiness:GetDataSource + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetDataSource + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateDataSource + delete: + - qbusiness:DeleteDataSource + - qbusiness:GetDataSource + list: + - qbusiness:ListDataSources + AttributeType: + type: string + enum: + - STRING + - STRING_LIST + - NUMBER + - DATE + DocumentAttributeConfiguration: + type: object + properties: + Name: + type: string + maxLength: 30 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Type: + $ref: '#/components/schemas/AttributeType' + Search: + $ref: '#/components/schemas/Status' + additionalProperties: false + IndexCapacityConfiguration: + type: object + properties: + Units: + type: number + minimum: 1 + additionalProperties: false + IndexStatistics: + type: object + properties: + TextDocumentStatistics: + $ref: '#/components/schemas/TextDocumentStatistics' + additionalProperties: false + IndexStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPDATING + IndexType: + type: string + enum: + - ENTERPRISE + - STARTER + Status: + type: string + enum: + - ENABLED + - DISABLED + TextDocumentStatistics: + type: object + properties: + IndexedTextBytes: + type: number + minimum: 0 + IndexedTextDocumentCount: + type: number + minimum: 0 + additionalProperties: false + Index: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CapacityConfiguration: + $ref: '#/components/schemas/IndexCapacityConfiguration' + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentAttributeConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DocumentAttributeConfiguration' + maxItems: 500 + minItems: 1 + IndexArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + IndexStatistics: + $ref: '#/components/schemas/IndexStatistics' + Type: + $ref: '#/components/schemas/IndexType' + Status: + $ref: '#/components/schemas/IndexStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + required: + - ApplicationId + - DisplayName + x-stackql-resource-name: index + description: Definition of AWS::QBusiness::Index Resource Type + x-type-name: AWS::QBusiness::Index + x-stackql-primary-identifier: + - ApplicationId + - IndexId + x-create-only-properties: + - ApplicationId + - Type + x-read-only-properties: + - CreatedAt + - IndexArn + - IndexId + - IndexStatistics + - Status + - UpdatedAt + x-required-properties: + - ApplicationId + - DisplayName + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - qbusiness:CreateIndex + - qbusiness:GetIndex + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UpdateIndex + read: + - qbusiness:GetIndex + - qbusiness:ListTagsForResource + update: + - qbusiness:GetIndex + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateIndex + delete: + - qbusiness:DeleteIndex + - qbusiness:GetIndex + list: + - qbusiness:ListIndices + Condition: + type: object + properties: + ConditionOperator: + type: string + enum: + - StringEquals + ConditionKey: + type: string + pattern: ^aws:PrincipalTag/qbusiness-dataaccessor:[a-zA-Z]+ + ConditionValues: + type: array + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + items: + type: string + minItems: 1 + maxItems: 1 + required: + - ConditionOperator + - ConditionKey + - ConditionValues + additionalProperties: false + Permission: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + StatementId: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Actions: + type: array + items: + type: string + pattern: ^qbusiness:[a-zA-Z]+$ + maxItems: 10 + minItems: 1 + Conditions: + type: array + items: + $ref: '#/components/schemas/Condition' + minItems: 1 + maxItems: 10 + Principal: + type: string + maxLength: 1284 + minLength: 1 + pattern: ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$ + required: + - ApplicationId + - StatementId + - Actions + - Principal + x-stackql-resource-name: permission + description: Definition of AWS::QBusiness::Permission Resource Type + x-type-name: AWS::QBusiness::Permission + x-stackql-primary-identifier: + - ApplicationId + - StatementId + x-create-only-properties: + - ApplicationId + - StatementId + - Actions + - Principal + - Conditions + x-required-properties: + - ApplicationId + - StatementId + - Actions + - Principal + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - qbusiness:AssociatePermission + - qbusiness:PutResourcePolicy + read: + - qbusiness:GetPolicy + delete: + - qbusiness:DisassociatePermission + - qbusiness:PutResourcePolicy + list: + - qbusiness:GetPolicy + APISchema: + oneOf: + - type: object + title: Payload + properties: + Payload: + type: string + required: + - Payload + additionalProperties: false + - type: object + title: S3 + properties: + S3: + $ref: '#/components/schemas/S3' + required: + - S3 + additionalProperties: false + APISchemaType: + type: string + enum: + - OPEN_API_V3 + BasicAuthConfiguration: + type: object + properties: + SecretArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + required: + - RoleArn + - SecretArn + additionalProperties: false + CustomPluginConfiguration: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + ApiSchemaType: + $ref: '#/components/schemas/APISchemaType' + ApiSchema: + $ref: '#/components/schemas/APISchema' + required: + - ApiSchema + - ApiSchemaType + - Description + additionalProperties: false + NoAuthConfiguration: + type: object + additionalProperties: false + OAuth2ClientCredentialConfiguration: + type: object + properties: + SecretArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + AuthorizationUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + TokenUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + required: + - RoleArn + - SecretArn + additionalProperties: false + PluginAuthConfiguration: + oneOf: + - type: object + title: BasicAuthConfiguration + properties: + BasicAuthConfiguration: + $ref: '#/components/schemas/BasicAuthConfiguration' + required: + - BasicAuthConfiguration + additionalProperties: false + - type: object + title: OAuth2ClientCredentialConfiguration + properties: + OAuth2ClientCredentialConfiguration: + $ref: '#/components/schemas/OAuth2ClientCredentialConfiguration' + required: + - OAuth2ClientCredentialConfiguration + additionalProperties: false + - type: object + title: NoAuthConfiguration + properties: + NoAuthConfiguration: + $ref: '#/components/schemas/NoAuthConfiguration' + required: + - NoAuthConfiguration + additionalProperties: false + PluginBuildStatus: + type: string + enum: + - READY + - CREATE_IN_PROGRESS + - CREATE_FAILED + - UPDATE_IN_PROGRESS + - UPDATE_FAILED + - DELETE_IN_PROGRESS + - DELETE_FAILED + PluginState: + type: string + enum: + - ENABLED + - DISABLED + PluginType: + type: string + enum: + - SERVICE_NOW + - SALESFORCE + - JIRA + - ZENDESK + - CUSTOM + - QUICKSIGHT + - SERVICENOW_NOW_PLATFORM + - JIRA_CLOUD + - SALESFORCE_CRM + - ZENDESK_SUITE + - ATLASSIAN_CONFLUENCE + - GOOGLE_CALENDAR + - MICROSOFT_TEAMS + - MICROSOFT_EXCHANGE + - PAGERDUTY_ADVANCE + - SMARTSHEET + - ASANA + S3: + type: object + properties: + Bucket: + type: string + maxLength: 63 + minLength: 1 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + Key: + type: string + maxLength: 1024 + minLength: 1 + required: + - Bucket + - Key + additionalProperties: false + Plugin: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AuthConfiguration: + $ref: '#/components/schemas/PluginAuthConfiguration' + BuildStatus: + $ref: '#/components/schemas/PluginBuildStatus' + CreatedAt: + type: string + format: date-time + CustomPluginConfiguration: + $ref: '#/components/schemas/CustomPluginConfiguration' + DisplayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + PluginArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + PluginId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + ServerUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + State: + $ref: '#/components/schemas/PluginState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/PluginType' + UpdatedAt: + type: string + format: date-time + required: + - AuthConfiguration + - DisplayName + - Type + x-stackql-resource-name: plugin + description: Definition of AWS::QBusiness::Plugin Resource Type + x-type-name: AWS::QBusiness::Plugin + x-stackql-primary-identifier: + - ApplicationId + - PluginId + x-create-only-properties: + - ApplicationId + - Type + x-read-only-properties: + - BuildStatus + - CreatedAt + - PluginArn + - PluginId + - UpdatedAt + x-required-properties: + - AuthConfiguration + - DisplayName + - Type + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreatePlugin + - qbusiness:GetPlugin + - qbusiness:ListTagsForResource + - qbusiness:TagResource + read: + - qbusiness:GetPlugin + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetPlugin + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdatePlugin + delete: + - qbusiness:DeletePlugin + - qbusiness:GetPlugin + list: + - qbusiness:ListPlugins + KendraIndexConfiguration: + type: object + properties: + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + required: + - IndexId + additionalProperties: false + NativeIndexConfiguration: + type: object + properties: + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + required: + - IndexId + additionalProperties: false + RetrieverConfiguration: + oneOf: + - type: object + title: NativeIndexConfiguration + properties: + NativeIndexConfiguration: + $ref: '#/components/schemas/NativeIndexConfiguration' + required: + - NativeIndexConfiguration + additionalProperties: false + - type: object + title: KendraIndexConfiguration + properties: + KendraIndexConfiguration: + $ref: '#/components/schemas/KendraIndexConfiguration' + required: + - KendraIndexConfiguration + additionalProperties: false + RetrieverStatus: + type: string + enum: + - CREATING + - ACTIVE + - FAILED + RetrieverType: + type: string + enum: + - NATIVE_INDEX + - KENDRA_INDEX + Retriever: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: + $ref: '#/components/schemas/RetrieverConfiguration' + CreatedAt: + type: string + format: date-time + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + RetrieverArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RetrieverId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/RetrieverStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/RetrieverType' + UpdatedAt: + type: string + format: date-time + required: + - ApplicationId + - Configuration + - DisplayName + - Type + x-stackql-resource-name: retriever + description: Definition of AWS::QBusiness::Retriever Resource Type + x-type-name: AWS::QBusiness::Retriever + x-stackql-primary-identifier: + - ApplicationId + - RetrieverId + x-create-only-properties: + - ApplicationId + - Type + x-read-only-properties: + - CreatedAt + - RetrieverArn + - RetrieverId + - Status + - UpdatedAt + x-required-properties: + - ApplicationId + - Configuration + - DisplayName + - Type + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreateRetriever + - qbusiness:GetRetriever + - qbusiness:ListTagsForResource + - qbusiness:TagResource + read: + - qbusiness:GetRetriever + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetRetriever + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateRetriever + delete: + - qbusiness:DeleteRetriever + - qbusiness:GetRetriever + list: + - qbusiness:ListRetrievers + IdentityProviderConfiguration: + oneOf: + - type: object + title: SamlConfiguration + properties: + SamlConfiguration: + $ref: '#/components/schemas/SamlProviderConfiguration' + required: + - SamlConfiguration + additionalProperties: false + - type: object + title: OpenIDConnectConfiguration + properties: + OpenIDConnectConfiguration: + $ref: '#/components/schemas/OpenIDConnectProviderConfiguration' + required: + - OpenIDConnectConfiguration + additionalProperties: false + OpenIDConnectProviderConfiguration: + type: object + properties: + SecretsArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + SecretsRole: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + required: + - SecretsArn + - SecretsRole + additionalProperties: false + SamlProviderConfiguration: + type: object + properties: + AuthenticationUrl: + type: string + maxLength: 1284 + minLength: 1 + pattern: ^https://.*$ + required: + - AuthenticationUrl + additionalProperties: false + WebExperienceSamplePromptsControlMode: + type: string + enum: + - ENABLED + - DISABLED + WebExperienceStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + - PENDING_AUTH_CONFIG + Origin: + type: string + maxLength: 64 + minLength: 1 + pattern: ^(http:\/\/|https:\/\/)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?$ + CustomizationConfiguration: + type: object + properties: + CustomCSSUrl: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^(https?://[a-zA-Z0-9-_.+%/]+\.css)?$ + LogoUrl: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^(https?://[a-zA-Z0-9-_.+%/]+\.(svg|png))?$ + FontUrl: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^(https?://[a-zA-Z0-9-_.+%/]+\.(ttf|woff|woff2|otf))?$ + FaviconUrl: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^(https?://[a-zA-Z0-9-_.+%/]+\.(svg|ico))?$ + additionalProperties: false + BrowserExtension: + type: string + enum: + - FIREFOX + - CHROME + BrowserExtensionConfiguration: + type: object + properties: + EnabledBrowserExtensions: + type: array + items: + $ref: '#/components/schemas/BrowserExtension' + maxItems: 2 + minItems: 0 + uniqueItems: true + x-insertionOrder: false + required: + - EnabledBrowserExtensions + additionalProperties: false + WebExperience: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CreatedAt: + type: string + format: date-time + DefaultEndpoint: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + IdentityProviderConfiguration: + $ref: '#/components/schemas/IdentityProviderConfiguration' + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + SamplePromptsControlMode: + $ref: '#/components/schemas/WebExperienceSamplePromptsControlMode' + Status: + $ref: '#/components/schemas/WebExperienceStatus' + Subtitle: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Title: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + UpdatedAt: + type: string + format: date-time + WebExperienceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + WebExperienceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + WelcomeMessage: + type: string + maxLength: 300 + minLength: 0 + Origins: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Origin' + maxItems: 10 + minItems: 0 + CustomizationConfiguration: + $ref: '#/components/schemas/CustomizationConfiguration' + BrowserExtensionConfiguration: + $ref: '#/components/schemas/BrowserExtensionConfiguration' + required: + - ApplicationId + x-stackql-resource-name: web_experience + description: Definition of AWS::QBusiness::WebExperience Resource Type + x-type-name: AWS::QBusiness::WebExperience + x-stackql-primary-identifier: + - ApplicationId + - WebExperienceId + x-create-only-properties: + - ApplicationId + x-read-only-properties: + - CreatedAt + - DefaultEndpoint + - Status + - UpdatedAt + - WebExperienceArn + - WebExperienceId + x-required-properties: + - ApplicationId + x-tagging: + taggable: true + tagUpdatable: true + tagOnCreate: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - qbusiness:UntagResource + - qbusiness:TagResource + - qbusiness:ListTagsForResource + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreateWebExperience + - qbusiness:GetWebExperience + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - sso:PutApplicationGrant + - sso:UpdateApplication + read: + - qbusiness:GetWebExperience + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetWebExperience + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateWebExperience + - sso:PutApplicationGrant + - sso:UpdateApplication + delete: + - qbusiness:DeleteWebExperience + - qbusiness:GetWebExperience + list: + - qbusiness:ListWebExperiences + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AttachmentsConfiguration: + $ref: '#/components/schemas/AttachmentsConfiguration' + AutoSubscriptionConfiguration: + $ref: '#/components/schemas/AutoSubscriptionConfiguration' + ClientIdsForOIDC: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.:/()*?=-]*$ + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + IamIdentityProviderArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+$ + IdentityCenterApplicationArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + IdentityCenterInstanceArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + IdentityType: + $ref: '#/components/schemas/IdentityType' + PersonalizationConfiguration: + $ref: '#/components/schemas/PersonalizationConfiguration' + QAppsConfiguration: + $ref: '#/components/schemas/QAppsConfiguration' + QuickSightConfiguration: + $ref: '#/components/schemas/QuickSightConfiguration' + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/ApplicationStatus' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateDataAccessorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ActionConfigurations: + type: array + items: + $ref: '#/components/schemas/ActionConfiguration' + maxItems: 10 + minItems: 1 + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AuthenticationDetail: + $ref: '#/components/schemas/DataAccessorAuthenticationDetail' + CreatedAt: + type: string + format: date-time + DataAccessorArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + DataAccessorId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + DisplayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + IdcApplicationArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + Principal: + type: string + maxLength: 1284 + minLength: 1 + pattern: ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateDataAccessorRequest + type: object + required: [] + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: {} + CreatedAt: + type: string + format: date-time + DataSourceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + DataSourceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentEnrichmentConfiguration: + $ref: '#/components/schemas/DocumentEnrichmentConfiguration' + MediaExtractionConfiguration: + $ref: '#/components/schemas/MediaExtractionConfiguration' + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/DataSourceStatus' + SyncSchedule: + type: string + maxLength: 998 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + type: string + maxLength: 2048 + minLength: 1 + UpdatedAt: + type: string + format: date-time + VpcConfiguration: + $ref: '#/components/schemas/DataSourceVpcConfiguration' + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateIndexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CapacityConfiguration: + $ref: '#/components/schemas/IndexCapacityConfiguration' + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentAttributeConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DocumentAttributeConfiguration' + maxItems: 500 + minItems: 1 + IndexArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + IndexStatistics: + $ref: '#/components/schemas/IndexStatistics' + Type: + $ref: '#/components/schemas/IndexType' + Status: + $ref: '#/components/schemas/IndexStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateIndexRequest + type: object + required: [] + CreatePermissionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + StatementId: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + Actions: + type: array + items: + type: string + pattern: ^qbusiness:[a-zA-Z]+$ + maxItems: 10 + minItems: 1 + Conditions: + type: array + items: + $ref: '#/components/schemas/Condition' + minItems: 1 + maxItems: 10 + Principal: + type: string + maxLength: 1284 + minLength: 1 + pattern: ^arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+$ + x-stackQL-stringOnly: true + x-title: CreatePermissionRequest + type: object + required: [] + CreatePluginRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AuthConfiguration: + $ref: '#/components/schemas/PluginAuthConfiguration' + BuildStatus: + $ref: '#/components/schemas/PluginBuildStatus' + CreatedAt: + type: string + format: date-time + CustomPluginConfiguration: + $ref: '#/components/schemas/CustomPluginConfiguration' + DisplayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + PluginArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + PluginId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + ServerUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + State: + $ref: '#/components/schemas/PluginState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/PluginType' + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreatePluginRequest + type: object + required: [] + CreateRetrieverRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: + $ref: '#/components/schemas/RetrieverConfiguration' + CreatedAt: + type: string + format: date-time + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + RetrieverArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RetrieverId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/RetrieverStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/RetrieverType' + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateRetrieverRequest + type: object + required: [] + CreateWebExperienceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CreatedAt: + type: string + format: date-time + DefaultEndpoint: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + IdentityProviderConfiguration: + $ref: '#/components/schemas/IdentityProviderConfiguration' + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + SamplePromptsControlMode: + $ref: '#/components/schemas/WebExperienceSamplePromptsControlMode' + Status: + $ref: '#/components/schemas/WebExperienceStatus' + Subtitle: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Title: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + UpdatedAt: + type: string + format: date-time + WebExperienceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + WebExperienceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + WelcomeMessage: + type: string + maxLength: 300 + minLength: 0 + Origins: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Origin' + maxItems: 10 + minItems: 0 + CustomizationConfiguration: + $ref: '#/components/schemas/CustomizationConfiguration' + BrowserExtensionConfiguration: + $ref: '#/components/schemas/BrowserExtensionConfiguration' + x-stackQL-stringOnly: true + x-title: CreateWebExperienceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + applications: + name: applications + id: awscc.qbusiness.applications + x-cfn-schema-name: Application + x-cfn-type-name: AWS::QBusiness::Application + x-identifiers: + - ApplicationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.AttachmentsConfiguration') as attachments_configuration, + JSON_EXTRACT(Properties, '$.AutoSubscriptionConfiguration') as auto_subscription_configuration, + JSON_EXTRACT(Properties, '$.ClientIdsForOIDC') as client_ids_for_oid_c, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration, + JSON_EXTRACT(Properties, '$.IamIdentityProviderArn') as iam_identity_provider_arn, + JSON_EXTRACT(Properties, '$.IdentityCenterApplicationArn') as identity_center_application_arn, + JSON_EXTRACT(Properties, '$.IdentityCenterInstanceArn') as identity_center_instance_arn, + JSON_EXTRACT(Properties, '$.IdentityType') as identity_type, + JSON_EXTRACT(Properties, '$.PersonalizationConfiguration') as personalization_configuration, + JSON_EXTRACT(Properties, '$.QAppsConfiguration') as q_apps_configuration, + JSON_EXTRACT(Properties, '$.QuickSightConfiguration') as quick_sight_configuration, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'AttachmentsConfiguration') as attachments_configuration, + json_extract_path_text(Properties, 'AutoSubscriptionConfiguration') as auto_subscription_configuration, + json_extract_path_text(Properties, 'ClientIdsForOIDC') as client_ids_for_oid_c, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'IamIdentityProviderArn') as iam_identity_provider_arn, + json_extract_path_text(Properties, 'IdentityCenterApplicationArn') as identity_center_application_arn, + json_extract_path_text(Properties, 'IdentityCenterInstanceArn') as identity_center_instance_arn, + json_extract_path_text(Properties, 'IdentityType') as identity_type, + json_extract_path_text(Properties, 'PersonalizationConfiguration') as personalization_configuration, + json_extract_path_text(Properties, 'QAppsConfiguration') as q_apps_configuration, + json_extract_path_text(Properties, 'QuickSightConfiguration') as quick_sight_configuration, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.qbusiness.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::QBusiness::Application + x-identifiers: + - ApplicationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Application' + AND region = 'us-east-1' + data_accessors: + name: data_accessors + id: awscc.qbusiness.data_accessors + x-cfn-schema-name: DataAccessor + x-cfn-type-name: AWS::QBusiness::DataAccessor + x-identifiers: + - ApplicationId + - DataAccessorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataAccessor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataAccessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataAccessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataAccessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_accessors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_accessors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_accessors/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ActionConfigurations') as action_configurations, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.AuthenticationDetail') as authentication_detail, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DataAccessorArn') as data_accessor_arn, + JSON_EXTRACT(Properties, '$.DataAccessorId') as data_accessor_id, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.IdcApplicationArn') as idc_application_arn, + JSON_EXTRACT(Properties, '$.Principal') as principal, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::DataAccessor' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActionConfigurations') as action_configurations, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'AuthenticationDetail') as authentication_detail, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DataAccessorArn') as data_accessor_arn, + json_extract_path_text(Properties, 'DataAccessorId') as data_accessor_id, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'IdcApplicationArn') as idc_application_arn, + json_extract_path_text(Properties, 'Principal') as principal, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::DataAccessor' + AND data__Identifier = '|' + AND region = 'us-east-1' + data_accessors_list_only: + name: data_accessors_list_only + id: awscc.qbusiness.data_accessors_list_only + x-cfn-schema-name: DataAccessor + x-cfn-type-name: AWS::QBusiness::DataAccessor + x-identifiers: + - ApplicationId + - DataAccessorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.DataAccessorId') as data_accessor_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::DataAccessor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'DataAccessorId') as data_accessor_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::DataAccessor' + AND region = 'us-east-1' + data_sources: + name: data_sources + id: awscc.qbusiness.data_sources + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::QBusiness::DataSource + x-identifiers: + - ApplicationId + - DataSourceId + - IndexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DataSourceArn') as data_source_arn, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.DocumentEnrichmentConfiguration') as document_enrichment_configuration, + JSON_EXTRACT(Properties, '$.MediaExtractionConfiguration') as media_extraction_configuration, + JSON_EXTRACT(Properties, '$.IndexId') as index_id, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.SyncSchedule') as sync_schedule, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.VpcConfiguration') as vpc_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DataSourceArn') as data_source_arn, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'DocumentEnrichmentConfiguration') as document_enrichment_configuration, + json_extract_path_text(Properties, 'MediaExtractionConfiguration') as media_extraction_configuration, + json_extract_path_text(Properties, 'IndexId') as index_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SyncSchedule') as sync_schedule, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND data__Identifier = '||' + AND region = 'us-east-1' + data_sources_list_only: + name: data_sources_list_only + id: awscc.qbusiness.data_sources_list_only + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::QBusiness::DataSource + x-identifiers: + - ApplicationId + - DataSourceId + - IndexId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND region = 'us-east-1' + indices: + name: indices + id: awscc.qbusiness.indices + x-cfn-schema-name: Index + x-cfn-type-name: AWS::QBusiness::Index + x-identifiers: + - ApplicationId + - IndexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.CapacityConfiguration') as capacity_configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.DocumentAttributeConfigurations') as document_attribute_configurations, + JSON_EXTRACT(Properties, '$.IndexArn') as index_arn, + JSON_EXTRACT(Properties, '$.IndexId') as index_id, + JSON_EXTRACT(Properties, '$.IndexStatistics') as index_statistics, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Index' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'CapacityConfiguration') as capacity_configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'DocumentAttributeConfigurations') as document_attribute_configurations, + json_extract_path_text(Properties, 'IndexArn') as index_arn, + json_extract_path_text(Properties, 'IndexId') as index_id, + json_extract_path_text(Properties, 'IndexStatistics') as index_statistics, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Index' + AND data__Identifier = '|' + AND region = 'us-east-1' + indices_list_only: + name: indices_list_only + id: awscc.qbusiness.indices_list_only + x-cfn-schema-name: Index + x-cfn-type-name: AWS::QBusiness::Index + x-identifiers: + - ApplicationId + - IndexId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Index' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Index' + AND region = 'us-east-1' + permissions: + name: permissions + id: awscc.qbusiness.permissions + x-cfn-schema-name: Permission + x-cfn-type-name: AWS::QBusiness::Permission + x-identifiers: + - ApplicationId + - StatementId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.StatementId') as statement_id, + JSON_EXTRACT(Properties, '$.Actions') as actions, + JSON_EXTRACT(Properties, '$.Conditions') as conditions, + JSON_EXTRACT(Properties, '$.Principal') as principal + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Permission' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'StatementId') as statement_id, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Conditions') as conditions, + json_extract_path_text(Properties, 'Principal') as principal + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Permission' + AND data__Identifier = '|' + AND region = 'us-east-1' + permissions_list_only: + name: permissions_list_only + id: awscc.qbusiness.permissions_list_only + x-cfn-schema-name: Permission + x-cfn-type-name: AWS::QBusiness::Permission + x-identifiers: + - ApplicationId + - StatementId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.StatementId') as statement_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Permission' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'StatementId') as statement_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Permission' + AND region = 'us-east-1' + plugins: + name: plugins + id: awscc.qbusiness.plugins + x-cfn-schema-name: Plugin + x-cfn-type-name: AWS::QBusiness::Plugin + x-identifiers: + - ApplicationId + - PluginId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Plugin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Plugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Plugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Plugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/plugins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/plugins/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/plugins/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.AuthConfiguration') as auth_configuration, + JSON_EXTRACT(Properties, '$.BuildStatus') as build_status, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CustomPluginConfiguration') as custom_plugin_configuration, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.PluginArn') as plugin_arn, + JSON_EXTRACT(Properties, '$.PluginId') as plugin_id, + JSON_EXTRACT(Properties, '$.ServerUrl') as server_url, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'AuthConfiguration') as auth_configuration, + json_extract_path_text(Properties, 'BuildStatus') as build_status, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CustomPluginConfiguration') as custom_plugin_configuration, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'PluginArn') as plugin_arn, + json_extract_path_text(Properties, 'PluginId') as plugin_id, + json_extract_path_text(Properties, 'ServerUrl') as server_url, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND data__Identifier = '|' + AND region = 'us-east-1' + plugins_list_only: + name: plugins_list_only + id: awscc.qbusiness.plugins_list_only + x-cfn-schema-name: Plugin + x-cfn-type-name: AWS::QBusiness::Plugin + x-identifiers: + - ApplicationId + - PluginId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.PluginId') as plugin_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'PluginId') as plugin_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND region = 'us-east-1' + retrievers: + name: retrievers + id: awscc.qbusiness.retrievers + x-cfn-schema-name: Retriever + x-cfn-type-name: AWS::QBusiness::Retriever + x-identifiers: + - ApplicationId + - RetrieverId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Retriever&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Retriever" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Retriever" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Retriever" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/retrievers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/retrievers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/retrievers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.RetrieverArn') as retriever_arn, + JSON_EXTRACT(Properties, '$.RetrieverId') as retriever_id, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'RetrieverArn') as retriever_arn, + json_extract_path_text(Properties, 'RetrieverId') as retriever_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND data__Identifier = '|' + AND region = 'us-east-1' + retrievers_list_only: + name: retrievers_list_only + id: awscc.qbusiness.retrievers_list_only + x-cfn-schema-name: Retriever + x-cfn-type-name: AWS::QBusiness::Retriever + x-identifiers: + - ApplicationId + - RetrieverId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.RetrieverId') as retriever_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'RetrieverId') as retriever_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND region = 'us-east-1' + web_experiences: + name: web_experiences + id: awscc.qbusiness.web_experiences + x-cfn-schema-name: WebExperience + x-cfn-type-name: AWS::QBusiness::WebExperience + x-identifiers: + - ApplicationId + - WebExperienceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WebExperience&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::WebExperience" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::WebExperience" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::WebExperience" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/web_experiences/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/web_experiences/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/web_experiences/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DefaultEndpoint') as default_endpoint, + JSON_EXTRACT(Properties, '$.IdentityProviderConfiguration') as identity_provider_configuration, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.SamplePromptsControlMode') as sample_prompts_control_mode, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Subtitle') as subtitle, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Title') as title, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.WebExperienceArn') as web_experience_arn, + JSON_EXTRACT(Properties, '$.WebExperienceId') as web_experience_id, + JSON_EXTRACT(Properties, '$.WelcomeMessage') as welcome_message, + JSON_EXTRACT(Properties, '$.Origins') as origins, + JSON_EXTRACT(Properties, '$.CustomizationConfiguration') as customization_configuration, + JSON_EXTRACT(Properties, '$.BrowserExtensionConfiguration') as browser_extension_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DefaultEndpoint') as default_endpoint, + json_extract_path_text(Properties, 'IdentityProviderConfiguration') as identity_provider_configuration, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'SamplePromptsControlMode') as sample_prompts_control_mode, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Subtitle') as subtitle, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Title') as title, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'WebExperienceArn') as web_experience_arn, + json_extract_path_text(Properties, 'WebExperienceId') as web_experience_id, + json_extract_path_text(Properties, 'WelcomeMessage') as welcome_message, + json_extract_path_text(Properties, 'Origins') as origins, + json_extract_path_text(Properties, 'CustomizationConfiguration') as customization_configuration, + json_extract_path_text(Properties, 'BrowserExtensionConfiguration') as browser_extension_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND data__Identifier = '|' + AND region = 'us-east-1' + web_experiences_list_only: + name: web_experiences_list_only + id: awscc.qbusiness.web_experiences_list_only + x-cfn-schema-name: WebExperience + x-cfn-type-name: AWS::QBusiness::WebExperience + x-identifiers: + - ApplicationId + - WebExperienceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.WebExperienceId') as web_experience_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'WebExperienceId') as web_experience_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataAccessor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataAccessor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataAccessorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIndex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIndexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePermission + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePermissionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Plugin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlugin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePluginRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Retriever&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRetriever + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRetrieverRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WebExperience&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWebExperience + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWebExperienceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/qldb.yaml b/providers/src/awscc/v00.00.00000/services/qldb.yaml index a58504d3..e41c5964 100644 --- a/providers/src/awscc/v00.00.00000/services/qldb.yaml +++ b/providers/src/awscc/v00.00.00000/services/qldb.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: QLDB - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: type: string @@ -69,7 +449,9 @@ components: - KinesisConfiguration - InclusiveStartTime x-stackql-resource-name: stream - x-stackql-primaryIdentifier: + description: Resource schema for AWS::QLDB::Stream. + x-type-name: AWS::QLDB::Stream + x-stackql-primary-identifier: - LedgerName - Id x-create-only-properties: @@ -82,6 +464,22 @@ components: x-read-only-properties: - Id - Arn + x-required-properties: + - LedgerName + - StreamName + - RoleArn + - KinesisConfiguration + - InclusiveStartTime + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - qldb:TagResource + - qldb:UntagResource + - qldb:ListTagsForResource x-required-permissions: create: - iam:PassRole @@ -99,43 +497,163 @@ components: - qldb:TagResource list: - qldb:listJournalKinesisStreamsForLedger + CreateStreamRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + LedgerName: + type: string + StreamName: + type: string + RoleArn: + $ref: '#/components/schemas/Arn' + InclusiveStartTime: + type: string + ExclusiveEndTime: + type: string + KinesisConfiguration: + $ref: '#/components/schemas/KinesisConfiguration' + Tags: + type: array + maxItems: 50 + x-insertionOrder: false + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + Arn: + $ref: '#/components/schemas/Arn' + Id: + type: string + x-stackQL-stringOnly: true + x-title: CreateStreamRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: streams: name: streams id: awscc.qldb.streams x-cfn-schema-name: Stream - x-type: list + x-cfn-type-name: AWS::QLDB::Stream x-identifiers: - LedgerName - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Stream&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QLDB::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QLDB::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QLDB::Stream" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.LedgerName') as ledger_name, + JSON_EXTRACT(Properties, '$.StreamName') as stream_name, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.InclusiveStartTime') as inclusive_start_time, + JSON_EXTRACT(Properties, '$.ExclusiveEndTime') as exclusive_end_time, + JSON_EXTRACT(Properties, '$.KinesisConfiguration') as kinesis_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QLDB::Stream' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, json_extract_path_text(Properties, 'LedgerName') as ledger_name, + json_extract_path_text(Properties, 'StreamName') as stream_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'InclusiveStartTime') as inclusive_start_time, + json_extract_path_text(Properties, 'ExclusiveEndTime') as exclusive_end_time, + json_extract_path_text(Properties, 'KinesisConfiguration') as kinesis_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QLDB::Stream' + AND data__Identifier = '|' AND region = 'us-east-1' - qldb_stream: - name: qldb_stream - id: awscc.qldb.qldb_stream + streams_list_only: + name: streams_list_only + id: awscc.qldb.streams_list_only x-cfn-schema-name: Stream - x-type: get + x-cfn-type-name: AWS::QLDB::Stream x-identifiers: - LedgerName - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -143,34 +661,211 @@ components: ddl: |- SELECT region, - data__Identifier, JSON_EXTRACT(Properties, '$.LedgerName') as ledger_name, - JSON_EXTRACT(Properties, '$.StreamName') as stream_name, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.InclusiveStartTime') as inclusive_start_time, - JSON_EXTRACT(Properties, '$.ExclusiveEndTime') as exclusive_end_time, - JSON_EXTRACT(Properties, '$.KinesisConfiguration') as kinesis_configuration, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QLDB::Stream' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, json_extract_path_text(Properties, 'LedgerName') as ledger_name, - json_extract_path_text(Properties, 'StreamName') as stream_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'InclusiveStartTime') as inclusive_start_time, - json_extract_path_text(Properties, 'ExclusiveEndTime') as exclusive_end_time, - json_extract_path_text(Properties, 'KinesisConfiguration') as kinesis_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QLDB::Stream' - AND data__Identifier = '|' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Stream&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStream + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStreamRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/quicksight.yaml b/providers/src/awscc/v00.00.00000/services/quicksight.yaml index 487151cb..c2d3ae2c 100644 --- a/providers/src/awscc/v00.00.00000/services/quicksight.yaml +++ b/providers/src/awscc/v00.00.00000/services/quicksight.yaml @@ -1,6898 +1,7582 @@ openapi: 3.0.0 info: title: QuickSight - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - AggregationFunction: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object + CancelResourceRequestOutput: properties: - NumericalAggregationFunction: - $ref: '#/components/schemas/NumericalAggregationFunction' - CategoricalAggregationFunction: - $ref: '#/components/schemas/CategoricalAggregationFunction' - DateAggregationFunction: - $ref: '#/components/schemas/DateAggregationFunction' - AttributeAggregationFunction: - $ref: '#/components/schemas/AttributeAggregationFunction' - additionalProperties: false - AggregationSortConfiguration: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput type: object + CreateResourceOutput: properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - SortDirection: - $ref: '#/components/schemas/SortDirection' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string required: - - Column - - SortDirection - additionalProperties: false - AllSheetsFilterScopeConfiguration: + - Identifier + title: DeleteResourceInput type: object - additionalProperties: false - AnalysisDefaults: + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object + GeneralServiceException: {} + GetResourceInput: properties: - DefaultNewSheetConfiguration: - $ref: '#/components/schemas/DefaultNewSheetConfiguration' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' required: - - DefaultNewSheetConfiguration + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + PivotTotalOptions: additionalProperties: false - AnalysisDefinition: type: object properties: - DataSetIdentifierDeclarations: - type: array - items: - $ref: '#/components/schemas/DataSetIdentifierDeclaration' - maxItems: 50 - minItems: 1 - Sheets: - type: array - items: - $ref: '#/components/schemas/SheetDefinition' - maxItems: 20 - minItems: 0 - CalculatedFields: - type: array - items: - $ref: '#/components/schemas/CalculatedField' - maxItems: 500 + TotalAggregationOptions: minItems: 0 - ParameterDeclarations: - type: array - items: - $ref: '#/components/schemas/ParameterDeclaration' maxItems: 200 - minItems: 0 - FilterGroups: - type: array - items: - $ref: '#/components/schemas/FilterGroup' - maxItems: 2000 - minItems: 0 - ColumnConfigurations: type: array items: - $ref: '#/components/schemas/ColumnConfiguration' - maxItems: 200 - minItems: 0 - AnalysisDefaults: - $ref: '#/components/schemas/AnalysisDefaults' - Options: - $ref: '#/components/schemas/AssetOptions' - required: - - DataSetIdentifierDeclarations + $ref: '#/components/schemas/TotalAggregationOption' + CustomLabel: + type: string + ValueCellStyle: + $ref: '#/components/schemas/TableCellStyle' + ScrollStatus: + $ref: '#/components/schemas/TableTotalsScrollStatus' + Placement: + $ref: '#/components/schemas/TableTotalsPlacement' + TotalCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalsVisibility: {} + MetricHeaderCellStyle: + $ref: '#/components/schemas/TableCellStyle' + Entity: + additionalProperties: false + type: object + properties: + Path: + pattern: \S + type: string + DateTimePickerControlDisplayOptions: additionalProperties: false + type: object + properties: + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + HelperTextVisibility: {} + DateIconVisibility: {} + DateTimeFormat: + minLength: 1 + type: string + maxLength: 128 AnalysisError: + description:

Analysis error.

+ additionalProperties: false type: object properties: Type: $ref: '#/components/schemas/AnalysisErrorType' Message: + pattern: \S + description:

The message associated with the analysis error.

type: string - pattern: .*\S.* ViolatedEntities: + minItems: 0 + maxItems: 200 + description:

Lists the violated entities that caused the analysis error

type: array items: $ref: '#/components/schemas/Entity' - maxItems: 200 - minItems: 0 + GeospatialMapConfiguration: additionalProperties: false - AnalysisErrorType: - type: string - enum: - - ACCESS_DENIED - - SOURCE_NOT_FOUND - - DATA_SET_NOT_FOUND - - INTERNAL_FAILURE - - PARAMETER_VALUE_INCOMPATIBLE - - PARAMETER_TYPE_INVALID - - PARAMETER_NOT_FOUND - - COLUMN_TYPE_MISMATCH - - COLUMN_GEOGRAPHIC_ROLE_MISMATCH - - COLUMN_REPLACEMENT_MISSING - AnalysisSourceEntity: type: object properties: - SourceTemplate: - $ref: '#/components/schemas/AnalysisSourceTemplate' + Legend: + $ref: '#/components/schemas/LegendOptions' + MapStyleOptions: + $ref: '#/components/schemas/GeospatialMapStyleOptions' + FieldWells: + $ref: '#/components/schemas/GeospatialMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + WindowOptions: + $ref: '#/components/schemas/GeospatialWindowOptions' + PointStyleOptions: + $ref: '#/components/schemas/GeospatialPointStyleOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + ThousandSeparatorOptions: additionalProperties: false - AnalysisSourceTemplate: type: object properties: - DataSetReferences: - type: array - items: - $ref: '#/components/schemas/DataSetReference' - minItems: 1 - Arn: - type: string - required: - - Arn - - DataSetReferences + Symbol: + $ref: '#/components/schemas/NumericSeparatorSymbol' + Visibility: {} + GroupingStyle: + $ref: '#/components/schemas/DigitGroupingStyle' + PredefinedHierarchy: additionalProperties: false - AnchorDateConfiguration: type: object properties: - AnchorOption: - $ref: '#/components/schemas/AnchorOption' - ParameterName: - type: string - maxLength: 2048 + HierarchyId: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - additionalProperties: false - AnchorOption: - type: string - enum: - - NOW - ArcAxisConfiguration: - type: object - properties: - Range: - $ref: '#/components/schemas/ArcAxisDisplayRange' - ReserveRange: - type: number - default: 0 + type: string + maxLength: 512 + DrillDownFilters: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/DrillDownFilter' + Columns: + minItems: 1 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ColumnIdentifier' + required: + - Columns + - HierarchyId + DateTimeFormatConfiguration: additionalProperties: false - ArcAxisDisplayRange: type: object properties: - Min: - type: number - default: null - Max: - type: number - default: null + NumericFormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + DateTimeFormat: + minLength: 1 + type: string + maxLength: 128 + FilterControl: additionalProperties: false - ArcConfiguration: type: object properties: - ArcAngle: - type: number - default: null - ArcThickness: - $ref: '#/components/schemas/ArcThicknessOptions' + Slider: + $ref: '#/components/schemas/FilterSliderControl' + TextArea: + $ref: '#/components/schemas/FilterTextAreaControl' + Dropdown: + $ref: '#/components/schemas/FilterDropDownControl' + TextField: + $ref: '#/components/schemas/FilterTextFieldControl' + List: + $ref: '#/components/schemas/FilterListControl' + DateTimePicker: + $ref: '#/components/schemas/FilterDateTimePickerControl' + RelativeDateTime: + $ref: '#/components/schemas/FilterRelativeDateTimeControl' + CrossSheet: + $ref: '#/components/schemas/FilterCrossSheetControl' + PivotTableSubtotalLevel: + type: string + enum: + - ALL + - CUSTOM + - LAST + FormatConfiguration: additionalProperties: false - ArcOptions: type: object properties: - ArcThickness: - $ref: '#/components/schemas/ArcThickness' - additionalProperties: false - ArcThickness: + NumberFormatConfiguration: + $ref: '#/components/schemas/NumberFormatConfiguration' + DateTimeFormatConfiguration: + $ref: '#/components/schemas/DateTimeFormatConfiguration' + StringFormatConfiguration: + $ref: '#/components/schemas/StringFormatConfiguration' + ResourceStatus: type: string enum: - - SMALL - - MEDIUM - - LARGE - - WHOLE - ArcThicknessOptions: + - CREATION_IN_PROGRESS + - CREATION_SUCCESSFUL + - CREATION_FAILED + - UPDATE_IN_PROGRESS + - UPDATE_SUCCESSFUL + - UPDATE_FAILED + - PENDING_UPDATE + - DELETED + CommitMode: type: string enum: - - SMALL - - MEDIUM - - LARGE - AssetOptions: + - AUTO + - MANUAL + RadarChartFieldWells: + additionalProperties: false type: object properties: - Timezone: - type: string - WeekStart: - $ref: '#/components/schemas/DayOfTheWeek' + RadarChartAggregatedFieldWells: + $ref: '#/components/schemas/RadarChartAggregatedFieldWells' + RollingDateConfiguration: additionalProperties: false - AttributeAggregationFunction: type: object properties: - SimpleAttributeAggregation: - $ref: '#/components/schemas/SimpleAttributeAggregationFunction' - ValueForMultipleValues: + Expression: + minLength: 1 + type: string + maxLength: 4096 + DataSetIdentifier: + minLength: 1 type: string + maxLength: 2048 + required: + - Expression + SeriesItem: additionalProperties: false - AxisBinding: - type: string - enum: - - PRIMARY_YAXIS - - SECONDARY_YAXIS - AxisDataOptions: type: object properties: - NumericAxisOptions: - $ref: '#/components/schemas/NumericAxisOptions' - DateAxisOptions: - $ref: '#/components/schemas/DateAxisOptions' + FieldSeriesItem: + $ref: '#/components/schemas/FieldSeriesItem' + DataFieldSeriesItem: + $ref: '#/components/schemas/DataFieldSeriesItem' + LineChartLineStyleSettings: additionalProperties: false - AxisDisplayDataDrivenRange: type: object + properties: + LineInterpolation: + $ref: '#/components/schemas/LineInterpolation' + LineStyle: + $ref: '#/components/schemas/LineChartLineStyle' + LineVisibility: {} + LineWidth: + description: String based length that is composed of value and unit in px + type: string + FilledMapSortConfiguration: additionalProperties: false - AxisDisplayMinMaxRange: type: object properties: - Minimum: - type: number - default: null - Maximum: - type: number - default: null + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + Parameters: + description:

A list of Amazon QuickSight parameters and the list's override values.

additionalProperties: false - AxisDisplayOptions: type: object properties: - TickLabelOptions: - $ref: '#/components/schemas/AxisTickLabelOptions' - AxisLineVisibility: - $ref: '#/components/schemas/Visibility' - GridLineVisibility: - $ref: '#/components/schemas/Visibility' - DataOptions: - $ref: '#/components/schemas/AxisDataOptions' - ScrollbarOptions: - $ref: '#/components/schemas/ScrollBarOptions' - AxisOffset: - type: string - description: String based length that is composed of value and unit in px + StringParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of string.

+ type: array + items: + $ref: '#/components/schemas/StringParameter' + DecimalParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of decimal.

+ type: array + items: + $ref: '#/components/schemas/DecimalParameter' + IntegerParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of integer.

+ type: array + items: + $ref: '#/components/schemas/IntegerParameter' + DateTimeParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of date-time.

+ type: array + items: + $ref: '#/components/schemas/DateTimeParameter' + MappedDataSetParameter: additionalProperties: false - AxisDisplayRange: type: object properties: - MinMax: - $ref: '#/components/schemas/AxisDisplayMinMaxRange' - DataDriven: - $ref: '#/components/schemas/AxisDisplayDataDrivenRange' + DataSetParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + required: + - DataSetIdentifier + - DataSetParameterName + ReferenceLineLabelHorizontalPosition: + type: string + enum: + - LEFT + - CENTER + - RIGHT + RelativeDateTimeControlDisplayOptions: additionalProperties: false - AxisLabelOptions: type: object properties: - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - CustomLabel: + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + DateTimeFormat: + minLength: 1 type: string - ApplyTo: - $ref: '#/components/schemas/AxisLabelReferenceOptions' + maxLength: 128 + BarChartVisual: additionalProperties: false - AxisLabelReferenceOptions: type: object properties: - FieldId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' + ChartConfiguration: + $ref: '#/components/schemas/BarChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - Column - - FieldId + - VisualId + ClusterMarkerConfiguration: additionalProperties: false - AxisLinearScale: type: object properties: - StepCount: - type: number - default: null - StepSize: - type: number - default: null + ClusterMarker: + $ref: '#/components/schemas/ClusterMarker' + TableCellConditionalFormatting: additionalProperties: false - AxisLogarithmicScale: type: object properties: - Base: - type: number - default: null + FieldId: + minLength: 1 + type: string + maxLength: 512 + TextFormat: + $ref: '#/components/schemas/TextConditionalFormat' + required: + - FieldId + AssetOptions: additionalProperties: false - AxisScale: type: object properties: - Linear: - $ref: '#/components/schemas/AxisLinearScale' - Logarithmic: - $ref: '#/components/schemas/AxisLogarithmicScale' + Timezone: + type: string + WeekStart: + $ref: '#/components/schemas/DayOfTheWeek' + DateAxisOptions: additionalProperties: false - AxisTickLabelOptions: type: object properties: - LabelOptions: - $ref: '#/components/schemas/LabelOptions' - RotationAngle: - type: number - default: null + MissingDateVisibility: {} + KPIActualValueConditionalFormatting: additionalProperties: false - BarChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - Colors: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - SmallMultiples: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + TableUnaggregatedFieldWells: additionalProperties: false - BarChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/BarChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/BarChartSortConfiguration' - Orientation: - $ref: '#/components/schemas/BarChartOrientation' - BarsArrangement: - $ref: '#/components/schemas/BarsArrangement' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - SmallMultiplesOptions: - $ref: '#/components/schemas/SmallMultiplesOptions' - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ValueAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - ValueLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 + Values: minItems: 0 - ContributionAnalysisDefaults: - type: array - items: - $ref: '#/components/schemas/ContributionAnalysisDefault' maxItems: 200 - minItems: 1 - additionalProperties: false - BarChartFieldWells: - type: object - properties: - BarChartAggregatedFieldWells: - $ref: '#/components/schemas/BarChartAggregatedFieldWells' - additionalProperties: false - BarChartOrientation: - type: string - enum: - - HORIZONTAL - - VERTICAL - BarChartSortConfiguration: - type: object - properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - ColorItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - SmallMultiplesSort: type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SmallMultiplesLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + $ref: '#/components/schemas/UnaggregatedField' + TreeMapVisual: additionalProperties: false - BarChartVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/BarChartConfiguration' + $ref: '#/components/schemas/TreeMapConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + AxisDisplayOptions: additionalProperties: false - BarsArrangement: - type: string - enum: - - CLUSTERED - - STACKED - - STACKED_PERCENT - BaseMapStyleType: - type: string - enum: - - LIGHT_GRAY - - DARK_GRAY - - STREET - - IMAGERY - BinCountOptions: type: object properties: - Value: - type: number - minimum: 0 + DataOptions: + $ref: '#/components/schemas/AxisDataOptions' + TickLabelOptions: + $ref: '#/components/schemas/AxisTickLabelOptions' + AxisOffset: + description: String based length that is composed of value and unit in px + type: string + AxisLineVisibility: {} + GridLineVisibility: {} + ScrollbarOptions: + $ref: '#/components/schemas/ScrollBarOptions' + DataPathLabelType: additionalProperties: false - BinWidthOptions: type: object properties: - Value: - type: number - minimum: 0 - BinCountLimit: - type: number - maximum: 1000 - minimum: 0 + FieldId: + minLength: 1 + type: string + maxLength: 512 + Visibility: {} + FieldValue: + minLength: 0 + type: string + maxLength: 2048 + FreeFormSectionLayoutConfiguration: additionalProperties: false - BodySectionConfiguration: type: object properties: - SectionId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Content: - $ref: '#/components/schemas/BodySectionContent' - Style: - $ref: '#/components/schemas/SectionStyle' - PageBreakConfiguration: - $ref: '#/components/schemas/SectionPageBreakConfiguration' - required: - - Content - - SectionId - additionalProperties: false - BodySectionContent: - type: object - properties: - Layout: - $ref: '#/components/schemas/SectionLayoutConfiguration' - additionalProperties: false - BoxPlotAggregatedFieldWells: - type: object - properties: - GroupBy: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + Elements: minItems: 0 - Values: + maxItems: 430 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 5 - minItems: 0 + $ref: '#/components/schemas/FreeFormLayoutElement' + required: + - Elements + DrillDownFilter: additionalProperties: false - BoxPlotChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/BoxPlotFieldWells' - SortConfiguration: - $ref: '#/components/schemas/BoxPlotSortConfiguration' - BoxPlotOptions: - $ref: '#/components/schemas/BoxPlotOptions' - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 - minItems: 0 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + NumericEqualityFilter: + $ref: '#/components/schemas/NumericEqualityDrillDownFilter' + TimeRangeFilter: + $ref: '#/components/schemas/TimeRangeDrillDownFilter' + CategoryFilter: + $ref: '#/components/schemas/CategoryDrillDownFilter' + CustomNarrativeOptions: additionalProperties: false - BoxPlotFieldWells: type: object properties: - BoxPlotAggregatedFieldWells: - $ref: '#/components/schemas/BoxPlotAggregatedFieldWells' + Narrative: + minLength: 0 + type: string + maxLength: 150000 + required: + - Narrative + LineChartDefaultSeriesSettings: additionalProperties: false - BoxPlotFillStyle: - type: string - enum: - - SOLID - - TRANSPARENT - BoxPlotOptions: type: object properties: - StyleOptions: - $ref: '#/components/schemas/BoxPlotStyleOptions' - OutlierVisibility: - $ref: '#/components/schemas/Visibility' - AllDataPointsVisibility: - $ref: '#/components/schemas/Visibility' + LineStyleSettings: + $ref: '#/components/schemas/LineChartLineStyleSettings' + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + MarkerStyleSettings: + $ref: '#/components/schemas/LineChartMarkerStyleSettings' + MaximumMinimumComputationType: + type: string + enum: + - MAXIMUM + - MINIMUM + IntegerParameter: + description:

An integer parameter.

additionalProperties: false - BoxPlotSortConfiguration: type: object properties: - CategorySort: + Values: + description:

The values for the integer parameter.

type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - PaginationConfiguration: - $ref: '#/components/schemas/PaginationConfiguration' - additionalProperties: false - BoxPlotStyleOptions: - type: object - properties: - FillStyle: - $ref: '#/components/schemas/BoxPlotFillStyle' + default: 0 + type: number + Name: + pattern: \S + description:

The name of the integer parameter.

+ type: string + required: + - Name + - Values + FunnelChartVisual: additionalProperties: false - BoxPlotVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/BoxPlotChartConfiguration' + $ref: '#/components/schemas/FunnelChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + FilterSelectableValues: additionalProperties: false - CalculatedField: - type: object - properties: - DataSetIdentifier: - type: string - maxLength: 2048 - minLength: 1 - Name: - type: string - maxLength: 127 - minLength: 1 - Expression: - type: string - maxLength: 32000 - minLength: 1 - required: - - DataSetIdentifier - - Expression - - Name - additionalProperties: false - CalculatedMeasureField: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Expression: - type: string - maxLength: 4096 - minLength: 1 - required: - - Expression - - FieldId + Values: + minItems: 0 + maxItems: 50000 + type: array + items: + type: string + LineChartConfiguration: additionalProperties: false - CascadingControlConfiguration: type: object properties: - SourceControls: + SortConfiguration: + $ref: '#/components/schemas/LineChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: + minItems: 0 + maxItems: 20 type: array items: - $ref: '#/components/schemas/CascadingControlSource' - maxItems: 200 + $ref: '#/components/schemas/ReferenceLine' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + SingleAxisOptions: + $ref: '#/components/schemas/SingleAxisOptions' + SmallMultiplesOptions: + $ref: '#/components/schemas/SmallMultiplesOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + XAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + DefaultSeriesSettings: + $ref: '#/components/schemas/LineChartDefaultSeriesSettings' + SecondaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + ForecastConfigurations: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ForecastConfiguration' + Series: minItems: 0 + maxItems: 2000 + type: array + items: + $ref: '#/components/schemas/SeriesItem' + Type: + $ref: '#/components/schemas/LineChartType' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + ContributionAnalysisDefaults: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ContributionAnalysisDefault' + FieldWells: + $ref: '#/components/schemas/LineChartFieldWells' + SecondaryYAxisDisplayOptions: + $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' + XAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + SectionAfterPageBreak: additionalProperties: false - CascadingControlSource: type: object properties: - SourceSheetControlId: - type: string - ColumnToMatch: - $ref: '#/components/schemas/ColumnIdentifier' + Status: + $ref: '#/components/schemas/SectionPageBreakStatus' + ComboChartAggregatedFieldWells: additionalProperties: false - CategoricalAggregationFunction: - type: string - enum: - - COUNT - - DISTINCT_COUNT - CategoricalDimensionField: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - HierarchyId: - type: string - maxLength: 512 - minLength: 1 - FormatConfiguration: - $ref: '#/components/schemas/StringFormatConfiguration' - required: - - Column - - FieldId + BarValues: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Category: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Colors: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + LineValues: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + LayerMapVisual: additionalProperties: false - CategoricalMeasureField: type: object properties: - FieldId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + ChartConfiguration: {} + DataSetIdentifier: minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - AggregationFunction: - $ref: '#/components/schemas/CategoricalAggregationFunction' - FormatConfiguration: - $ref: '#/components/schemas/StringFormatConfiguration' + type: string + maxLength: 2048 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 required: - - Column - - FieldId + - DataSetIdentifier + - VisualId + RelativeDateType: + type: string + enum: + - PREVIOUS + - THIS + - LAST + - NOW + - NEXT + GaugeChartOptions: additionalProperties: false - CategoryDrillDownFilter: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - CategoryValues: - type: array - items: - type: string - maxLength: 512 - minLength: 0 - maxItems: 100000 - minItems: 0 - required: - - CategoryValues - - Column + Arc: + $ref: '#/components/schemas/ArcConfiguration' + Comparison: + $ref: '#/components/schemas/ComparisonConfiguration' + PrimaryValueDisplayType: + $ref: '#/components/schemas/PrimaryValueDisplayType' + ArcAxis: + $ref: '#/components/schemas/ArcAxisConfiguration' + PrimaryValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + MeasureField: additionalProperties: false - CategoryFilter: type: object properties: - FilterId: + DateMeasureField: + $ref: '#/components/schemas/DateMeasureField' + NumericalMeasureField: + $ref: '#/components/schemas/NumericalMeasureField' + CategoricalMeasureField: + $ref: '#/components/schemas/CategoricalMeasureField' + CalculatedMeasureField: + $ref: '#/components/schemas/CalculatedMeasureField' + ScatterPlotVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/ScatterPlotConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Configuration: - $ref: '#/components/schemas/CategoryFilterConfiguration' + type: string + maxLength: 1024 + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - Column - - Configuration - - FilterId + - VisualId + AxisScale: additionalProperties: false - CategoryFilterConfiguration: type: object properties: - FilterListConfiguration: - $ref: '#/components/schemas/FilterListConfiguration' - CustomFilterListConfiguration: - $ref: '#/components/schemas/CustomFilterListConfiguration' - CustomFilterConfiguration: - $ref: '#/components/schemas/CustomFilterConfiguration' + Logarithmic: + $ref: '#/components/schemas/AxisLogarithmicScale' + Linear: + $ref: '#/components/schemas/AxisLinearScale' + HeatMapAggregatedFieldWells: additionalProperties: false - CategoryFilterMatchOperator: - type: string - enum: - - EQUALS - - DOES_NOT_EQUAL - - CONTAINS - - DOES_NOT_CONTAIN - - STARTS_WITH - - ENDS_WITH - CategoryFilterSelectAllOptions: - type: string - enum: - - FILTER_ALL_VALUES - ChartAxisLabelOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - SortIconVisibility: - $ref: '#/components/schemas/Visibility' - AxisLabelOptions: + Values: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/AxisLabelOptions' - maxItems: 100 + $ref: '#/components/schemas/MeasureField' + Columns: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Rows: minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + DefaultFilterDropDownControlOptions: additionalProperties: false - ClusterMarker: type: object properties: - SimpleClusterMarker: - $ref: '#/components/schemas/SimpleClusterMarker' + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/DropDownControlDisplayOptions' + CommitMode: + $ref: '#/components/schemas/CommitMode' + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' + GaugeChartFieldWells: additionalProperties: false - ClusterMarkerConfiguration: type: object properties: - ClusterMarker: - $ref: '#/components/schemas/ClusterMarker' + TargetValues: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Values: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + DateTimeParameter: + description:

A date-time parameter.

additionalProperties: false - ColorFillType: - type: string - enum: - - DISCRETE - - GRADIENT - ColorScale: type: object properties: - Colors: + Values: + description:

The values for the date-time parameter.

type: array items: - $ref: '#/components/schemas/DataColor' - maxItems: 3 - minItems: 2 - ColorFillType: - $ref: '#/components/schemas/ColorFillType' - NullValueColor: - $ref: '#/components/schemas/DataColor' + type: string + Name: + pattern: \S + description:

A display name for the date-time parameter.

+ type: string required: - - ColorFillType - - Colors + - Name + - Values + AxisLinearScale: additionalProperties: false - ColorsConfiguration: type: object properties: - CustomColors: - type: array - items: - $ref: '#/components/schemas/CustomColor' - maxItems: 50 - minItems: 0 + StepSize: + default: null + type: number + StepCount: + default: null + type: number + ColumnRole: + type: string + enum: + - DIMENSION + - MEASURE + BodySectionDynamicCategoryDimensionConfiguration: additionalProperties: false - ColumnConfiguration: type: object properties: Column: $ref: '#/components/schemas/ColumnIdentifier' - FormatConfiguration: - $ref: '#/components/schemas/FormatConfiguration' - Role: - $ref: '#/components/schemas/ColumnRole' - ColorsConfiguration: - $ref: '#/components/schemas/ColorsConfiguration' + SortByMetrics: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/ColumnSort' + Limit: + maximum: 1000 + type: number + minimum: 1 required: - Column + NegativeValueConfiguration: additionalProperties: false - ColumnHierarchy: type: object properties: - ExplicitHierarchy: - $ref: '#/components/schemas/ExplicitHierarchy' - DateTimeHierarchy: - $ref: '#/components/schemas/DateTimeHierarchy' - PredefinedHierarchy: - $ref: '#/components/schemas/PredefinedHierarchy' + DisplayMode: + $ref: '#/components/schemas/NegativeValueDisplayMode' + required: + - DisplayMode + PivotTableTotalOptions: additionalProperties: false - ColumnIdentifier: type: object properties: - DataSetIdentifier: - type: string - maxLength: 2048 - minLength: 1 - ColumnName: - type: string - maxLength: 127 - minLength: 1 - required: - - ColumnName - - DataSetIdentifier + ColumnSubtotalOptions: + $ref: '#/components/schemas/SubtotalOptions' + RowSubtotalOptions: + $ref: '#/components/schemas/SubtotalOptions' + RowTotalOptions: + $ref: '#/components/schemas/PivotTotalOptions' + ColumnTotalOptions: + $ref: '#/components/schemas/PivotTotalOptions' + DynamicDefaultValue: additionalProperties: false - ColumnRole: - type: string - enum: - - DIMENSION - - MEASURE - ColumnSort: type: object properties: - SortBy: + GroupNameColumn: + $ref: '#/components/schemas/ColumnIdentifier' + DefaultValueColumn: + $ref: '#/components/schemas/ColumnIdentifier' + UserNameColumn: $ref: '#/components/schemas/ColumnIdentifier' - Direction: - $ref: '#/components/schemas/SortDirection' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' required: - - Direction - - SortBy + - DefaultValueColumn + BodySectionConfiguration: additionalProperties: false - ColumnTooltipItem: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Label: + Content: + $ref: '#/components/schemas/BodySectionContent' + Style: + $ref: '#/components/schemas/SectionStyle' + PageBreakConfiguration: + $ref: '#/components/schemas/SectionPageBreakConfiguration' + SectionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - Visibility: - $ref: '#/components/schemas/Visibility' - Aggregation: - $ref: '#/components/schemas/AggregationFunction' + maxLength: 512 + RepeatConfiguration: + $ref: '#/components/schemas/BodySectionRepeatConfiguration' required: - - Column + - Content + - SectionId + WordCloudAggregatedFieldWells: additionalProperties: false - ComboChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - BarValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + GroupBy: minItems: 0 - Colors: + maxItems: 10 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Size: minItems: 0 - LineValues: + maxItems: 1 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 + DefaultGridLayoutConfiguration: additionalProperties: false - ComboChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/ComboChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/ComboChartSortConfiguration' - BarsArrangement: - $ref: '#/components/schemas/BarsArrangement' - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - SecondaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - SecondaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - BarDataLabels: - $ref: '#/components/schemas/DataLabelOptions' - LineDataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 - minItems: 0 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + CanvasSizeOptions: + $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' + required: + - CanvasSizeOptions + GradientStop: additionalProperties: false - ComboChartFieldWells: type: object properties: - ComboChartAggregatedFieldWells: - $ref: '#/components/schemas/ComboChartAggregatedFieldWells' + GradientOffset: + default: 0 + type: number + DataValue: + default: null + type: number + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + required: + - GradientOffset + GaugeChartPrimaryValueConditionalFormatting: additionalProperties: false - ComboChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - ColorItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + PluginVisual: additionalProperties: false - ComboChartVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + PluginArn: + type: string VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + ChartConfiguration: + $ref: '#/components/schemas/PluginVisualConfiguration' Title: $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/ComboChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 required: + - PluginArn - VisualId + BoxPlotFillStyle: + type: string + enum: + - SOLID + - TRANSPARENT + ImageInteractionOptions: additionalProperties: false - ComparisonConfiguration: type: object properties: - ComparisonMethod: - $ref: '#/components/schemas/ComparisonMethod' - ComparisonFormat: - $ref: '#/components/schemas/ComparisonFormatConfiguration' + ImageMenuOption: + $ref: '#/components/schemas/ImageMenuOption' + DataLabelType: additionalProperties: false - ComparisonFormatConfiguration: type: object properties: - NumberDisplayFormatConfiguration: - $ref: '#/components/schemas/NumberDisplayFormatConfiguration' - PercentageDisplayFormatConfiguration: - $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' - additionalProperties: false - ComparisonMethod: + MaximumLabelType: + $ref: '#/components/schemas/MaximumLabelType' + DataPathLabelType: + $ref: '#/components/schemas/DataPathLabelType' + RangeEndsLabelType: + $ref: '#/components/schemas/RangeEndsLabelType' + FieldLabelType: + $ref: '#/components/schemas/FieldLabelType' + MinimumLabelType: + $ref: '#/components/schemas/MinimumLabelType' + WordCloudCloudLayout: type: string enum: - - DIFFERENCE - - PERCENT_DIFFERENCE - - PERCENT - Computation: + - FLUID + - NORMAL + MaximumLabelType: + additionalProperties: false type: object properties: - TopBottomRanked: - $ref: '#/components/schemas/TopBottomRankedComputation' - TopBottomMovers: - $ref: '#/components/schemas/TopBottomMoversComputation' - TotalAggregation: - $ref: '#/components/schemas/TotalAggregationComputation' - MaximumMinimum: - $ref: '#/components/schemas/MaximumMinimumComputation' - MetricComparison: - $ref: '#/components/schemas/MetricComparisonComputation' - PeriodOverPeriod: - $ref: '#/components/schemas/PeriodOverPeriodComputation' - PeriodToDate: - $ref: '#/components/schemas/PeriodToDateComputation' - GrowthRate: - $ref: '#/components/schemas/GrowthRateComputation' - UniqueValues: - $ref: '#/components/schemas/UniqueValuesComputation' - Forecast: - $ref: '#/components/schemas/ForecastComputation' - additionalProperties: false - ConditionalFormattingColor: - type: object - properties: - Solid: - $ref: '#/components/schemas/ConditionalFormattingSolidColor' - Gradient: - $ref: '#/components/schemas/ConditionalFormattingGradientColor' + Visibility: {} + TooltipTarget: + type: string + enum: + - BOTH + - BAR + - LINE + DataLabelPosition: + type: string + enum: + - INSIDE + - OUTSIDE + - LEFT + - TOP + - BOTTOM + - RIGHT + DecimalParameter: + description:

A decimal parameter.

additionalProperties: false - ConditionalFormattingCustomIconCondition: type: object properties: - Expression: - type: string - maxLength: 4096 - minLength: 1 - IconOptions: - $ref: '#/components/schemas/ConditionalFormattingCustomIconOptions' - Color: + Values: + description:

The values for the decimal parameter.

+ type: array + items: + default: 0 + type: number + Name: + pattern: \S + description:

A display name for the decimal parameter.

type: string - pattern: ^#[A-F0-9]{6}$ - DisplayConfiguration: - $ref: '#/components/schemas/ConditionalFormattingIconDisplayConfiguration' required: - - Expression - - IconOptions + - Name + - Values + GeospatialMapStyleOptions: additionalProperties: false - ConditionalFormattingCustomIconOptions: type: object properties: - Icon: - $ref: '#/components/schemas/Icon' - UnicodeIcon: - type: string - pattern: ^[^\u0000-\u00FF]$ + BaseMapStyle: + $ref: '#/components/schemas/BaseMapStyleType' + Layout: additionalProperties: false - ConditionalFormattingGradientColor: type: object properties: - Expression: - type: string - maxLength: 4096 - minLength: 1 - Color: - $ref: '#/components/schemas/GradientColor' + Configuration: + $ref: '#/components/schemas/LayoutConfiguration' required: - - Color - - Expression + - Configuration + ReferenceLineValueLabelConfiguration: additionalProperties: false - ConditionalFormattingIcon: type: object properties: - IconSet: - $ref: '#/components/schemas/ConditionalFormattingIconSet' - CustomCondition: - $ref: '#/components/schemas/ConditionalFormattingCustomIconCondition' + FormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + RelativePosition: + $ref: '#/components/schemas/ReferenceLineValueLabelRelativePosition' + StringValueWhenUnsetConfiguration: additionalProperties: false - ConditionalFormattingIconDisplayConfiguration: type: object properties: - IconDisplayOption: - $ref: '#/components/schemas/ConditionalFormattingIconDisplayOption' + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + type: string + PivotTableSortBy: additionalProperties: false - ConditionalFormattingIconDisplayOption: - type: string - enum: - - ICON_ONLY - ConditionalFormattingIconSet: type: object properties: - Expression: - type: string - maxLength: 4096 - minLength: 1 - IconSetType: - $ref: '#/components/schemas/ConditionalFormattingIconSetType' - required: - - Expression + Field: + $ref: '#/components/schemas/FieldSort' + DataPath: + $ref: '#/components/schemas/DataPathSort' + Column: + $ref: '#/components/schemas/ColumnSort' + SimpleClusterMarker: additionalProperties: false - ConditionalFormattingIconSetType: - type: string - enum: - - PLUS_MINUS - - CHECK_X - - THREE_COLOR_ARROW - - THREE_GRAY_ARROW - - CARET_UP_MINUS_DOWN - - THREE_SHAPE - - THREE_CIRCLE - - FLAGS - - BARS - - FOUR_COLOR_ARROW - - FOUR_GRAY_ARROW - ConditionalFormattingSolidColor: type: object properties: - Expression: - type: string - maxLength: 4096 - minLength: 1 Color: - type: string pattern: ^#[A-F0-9]{6}$ - required: - - Expression + type: string + SheetImageSource: additionalProperties: false - ContributionAnalysisDefault: type: object properties: - MeasureFieldId: - type: string - maxLength: 512 - minLength: 1 - ContributorDimensions: - type: array - items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 4 - minItems: 1 - required: - - ContributorDimensions - - MeasureFieldId + SheetImageStaticFileSource: + $ref: '#/components/schemas/SheetImageStaticFileSource' + FilterDateTimePickerControl: additionalProperties: false - CrossDatasetTypes: - type: string - enum: - - ALL_DATASETS - - SINGLE_DATASET - CurrencyDisplayFormatConfiguration: type: object properties: - Prefix: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - maxLength: 128 + maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlDateTimePickerType' + DisplayOptions: + $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + Title: minLength: 1 - Suffix: type: string - maxLength: 128 + maxLength: 2048 + CommitMode: + $ref: '#/components/schemas/CommitMode' + SourceFilterId: minLength: 1 - SeparatorConfiguration: - $ref: '#/components/schemas/NumericSeparatorConfiguration' - Symbol: + pattern: ^[\w\-]+$ type: string - pattern: '[A-Z]{3}' - DecimalPlacesConfiguration: - $ref: '#/components/schemas/DecimalPlacesConfiguration' - NumberScale: - $ref: '#/components/schemas/NumberScale' - NegativeValueConfiguration: - $ref: '#/components/schemas/NegativeValueConfiguration' - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - additionalProperties: false - CustomActionFilterOperation: - type: object - properties: - SelectedFieldsConfiguration: - $ref: '#/components/schemas/FilterOperationSelectedFieldsConfiguration' - TargetVisualsConfiguration: - $ref: '#/components/schemas/FilterOperationTargetVisualsConfiguration' + maxLength: 512 required: - - SelectedFieldsConfiguration - - TargetVisualsConfiguration - additionalProperties: false - CustomActionNavigationOperation: - type: object - properties: - LocalNavigationConfiguration: - $ref: '#/components/schemas/LocalNavigationConfiguration' + - FilterControlId + - SourceFilterId + - Title + LegendPosition: + type: string + enum: + - AUTO + - RIGHT + - BOTTOM + - TOP + PluginVisualFieldWell: additionalProperties: false - CustomActionSetParametersOperation: type: object properties: - ParameterValueConfigurations: + Unaggregated: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/SetParameterValueConfiguration' + $ref: '#/components/schemas/UnaggregatedField' + AxisName: + $ref: '#/components/schemas/PluginVisualAxisName' + Measures: + minItems: 0 maxItems: 200 - minItems: 1 - required: - - ParameterValueConfigurations + type: array + items: + $ref: '#/components/schemas/MeasureField' + Dimensions: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + KPIVisualLayoutOptions: additionalProperties: false - CustomActionURLOperation: type: object properties: - URLTemplate: - type: string - maxLength: 2048 - minLength: 1 - URLTarget: - $ref: '#/components/schemas/URLTargetConfiguration' - required: - - URLTarget - - URLTemplate + StandardLayout: + $ref: '#/components/schemas/KPIVisualStandardLayout' + TimeRangeFilterValue: additionalProperties: false - CustomColor: type: object properties: - FieldValue: + RollingDate: + $ref: '#/components/schemas/RollingDateConfiguration' + StaticValue: + format: date-time + type: string + Parameter: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 - minLength: 0 - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - SpecialValue: - $ref: '#/components/schemas/SpecialValue' - required: - - Color + PivotTableRowsLabelOptions: additionalProperties: false - CustomContentConfiguration: type: object properties: - ContentUrl: - type: string - maxLength: 2048 + CustomLabel: minLength: 1 - ContentType: - $ref: '#/components/schemas/CustomContentType' - ImageScaling: - $ref: '#/components/schemas/CustomContentImageScalingConfiguration' + type: string + maxLength: 1024 + Visibility: {} + WordCloudOptions: additionalProperties: false - CustomContentImageScalingConfiguration: - type: string - enum: - - FIT_TO_HEIGHT - - FIT_TO_WIDTH - - DO_NOT_SCALE - - SCALE_TO_VISUAL - CustomContentType: - type: string - enum: - - IMAGE - - OTHER_EMBEDDED_CONTENT - CustomContentVisual: type: object properties: - VisualId: + WordOrientation: + $ref: '#/components/schemas/WordCloudWordOrientation' + WordScaling: + $ref: '#/components/schemas/WordCloudWordScaling' + CloudLayout: + $ref: '#/components/schemas/WordCloudCloudLayout' + MaximumStringLength: + maximum: 100 + type: number + minimum: 1 + WordCasing: + $ref: '#/components/schemas/WordCloudWordCasing' + WordPadding: + $ref: '#/components/schemas/WordCloudWordPadding' + ParameterDropDownControl: + additionalProperties: false + type: object + properties: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/DropDownControlDisplayOptions' + SourceParameterName: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/CustomContentConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - DataSetIdentifier: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + Title: minLength: 1 + type: string + maxLength: 2048 + CommitMode: + $ref: '#/components/schemas/CommitMode' + SelectableValues: + $ref: '#/components/schemas/ParameterSelectableValues' required: - - DataSetIdentifier - - VisualId + - ParameterControlId + - SourceParameterName + - Title + TableFieldOption: additionalProperties: false - CustomFilterConfiguration: type: object properties: - MatchOperator: - $ref: '#/components/schemas/CategoryFilterMatchOperator' - CategoryValue: - type: string - maxLength: 512 - minLength: 0 - SelectAllOptions: - $ref: '#/components/schemas/CategoryFilterSelectAllOptions' - ParameterName: + CustomLabel: + minLength: 1 type: string maxLength: 2048 + URLStyling: + $ref: '#/components/schemas/TableFieldURLConfiguration' + FieldId: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - NullOption: - $ref: '#/components/schemas/FilterNullOption' + type: string + maxLength: 512 + Visibility: {} + Width: + description: String based length that is composed of value and unit in px + type: string required: - - MatchOperator - - NullOption + - FieldId + IntegerParameterDeclaration: additionalProperties: false - CustomFilterListConfiguration: type: object properties: - MatchOperator: - $ref: '#/components/schemas/CategoryFilterMatchOperator' - CategoryValues: + MappedDataSetParameters: + minItems: 0 + maxItems: 150 type: array items: - type: string - maxLength: 512 - minLength: 0 - maxItems: 100000 - minItems: 0 - SelectAllOptions: - $ref: '#/components/schemas/CategoryFilterSelectAllOptions' - NullOption: - $ref: '#/components/schemas/FilterNullOption' + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/IntegerDefaultValues' + ParameterValueType: + $ref: '#/components/schemas/ParameterValueType' + ValueWhenUnset: + $ref: '#/components/schemas/IntegerValueWhenUnsetConfiguration' + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 required: - - MatchOperator - - NullOption + - Name + - ParameterValueType + FontConfiguration: additionalProperties: false - CustomNarrativeOptions: type: object properties: - Narrative: + FontFamily: type: string - maxLength: 150000 - minLength: 0 - required: - - Narrative + FontStyle: + $ref: '#/components/schemas/FontStyle' + FontSize: + $ref: '#/components/schemas/FontSize' + FontDecoration: + $ref: '#/components/schemas/FontDecoration' + FontColor: + pattern: ^#[A-F0-9]{6}$ + type: string + FontWeight: + $ref: '#/components/schemas/FontWeight' + VisualSubtitleLabelOptions: additionalProperties: false - CustomParameterValues: type: object properties: - StringValues: - type: array - items: - type: string - maxItems: 50000 - minItems: 0 - IntegerValues: - type: array - items: - type: number - maxItems: 50000 - minItems: 0 - DecimalValues: - type: array - items: - type: number - maxItems: 50000 - minItems: 0 - DateTimeValues: - type: array - items: - type: string - format: date-time - maxItems: 50000 - minItems: 0 + Visibility: {} + FormatText: + $ref: '#/components/schemas/LongFormatText' + GeospatialLayerItem: additionalProperties: false - CustomValuesConfiguration: type: object properties: - IncludeNullValue: - type: boolean - CustomValues: - $ref: '#/components/schemas/CustomParameterValues' + LayerId: + type: string + JoinDefinition: + $ref: '#/components/schemas/GeospatialLayerJoinDefinition' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/LayerCustomAction' + LayerType: + $ref: '#/components/schemas/GeospatialLayerType' + LayerDefinition: + $ref: '#/components/schemas/GeospatialLayerDefinition' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + Label: + type: string + Visibility: + $ref: '#/components/schemas/Visibility' + DataSource: + $ref: '#/components/schemas/GeospatialDataSourceItem' required: - - CustomValues + - LayerId + DataPathType: additionalProperties: false - DataBarsOptions: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - PositiveColor: - type: string - pattern: ^#[A-F0-9]{6}$ - NegativeColor: - type: string - pattern: ^#[A-F0-9]{6}$ - required: - - FieldId + PivotTableDataPathType: + $ref: '#/components/schemas/PivotTableDataPathType' + ArcAxisConfiguration: additionalProperties: false - DataColor: type: object properties: - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - DataValue: + Range: + $ref: '#/components/schemas/ArcAxisDisplayRange' + ReserveRange: + default: 0 type: number - default: null + NumericEqualityFilter: additionalProperties: false - DataFieldSeriesItem: type: object properties: - FieldId: - type: string - maxLength: 512 + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + Value: + default: null + type: number + ParameterName: minLength: 1 - FieldValue: + pattern: ^[a-zA-Z0-9]+$ type: string - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - Settings: - $ref: '#/components/schemas/LineChartSeriesSettings' + maxLength: 2048 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/NumericEqualityMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/NumericFilterSelectAllOptions' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - AxisBinding - - FieldId + - Column + - FilterId + - MatchOperator + - NullOption + ShapeConditionalFormat: additionalProperties: false - DataLabelContent: - type: string - enum: - - VALUE - - PERCENT - - VALUE_AND_PERCENT - DataLabelOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - CategoryLabelVisibility: - $ref: '#/components/schemas/Visibility' - MeasureLabelVisibility: - $ref: '#/components/schemas/Visibility' - DataLabelTypes: - type: array - items: - $ref: '#/components/schemas/DataLabelType' - maxItems: 100 - minItems: 0 - Position: - $ref: '#/components/schemas/DataLabelPosition' - LabelContent: - $ref: '#/components/schemas/DataLabelContent' - LabelFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - LabelColor: - type: string - pattern: ^#[A-F0-9]{6}$ - Overlap: - $ref: '#/components/schemas/DataLabelOverlap' - TotalsVisibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false - DataLabelOverlap: - type: string - enum: - - DISABLE_OVERLAP - - ENABLE_OVERLAP - DataLabelPosition: + BackgroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + required: + - BackgroundColor + GeospatialLayerType: type: string enum: - - INSIDE - - OUTSIDE - - LEFT - - TOP - - BOTTOM - - RIGHT - DataLabelType: + - POINT + - LINE + - POLYGON + GaugeChartArcConditionalFormatting: + additionalProperties: false type: object properties: - FieldLabelType: - $ref: '#/components/schemas/FieldLabelType' - DataPathLabelType: - $ref: '#/components/schemas/DataPathLabelType' - RangeEndsLabelType: - $ref: '#/components/schemas/RangeEndsLabelType' - MinimumLabelType: - $ref: '#/components/schemas/MinimumLabelType' - MaximumLabelType: - $ref: '#/components/schemas/MaximumLabelType' + ForegroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + AxisLabelOptions: additionalProperties: false - DataPathColor: type: object properties: - Element: - $ref: '#/components/schemas/DataPathValue' - Color: + CustomLabel: type: string - pattern: ^#[A-F0-9]{6}$ - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Color - - Element + ApplyTo: + $ref: '#/components/schemas/AxisLabelReferenceOptions' + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + DataSetReference: + description:

Dataset reference.

additionalProperties: false - DataPathLabelType: type: object properties: - FieldId: + DataSetArn: + description:

Dataset Amazon Resource Name (ARN).

type: string - maxLength: 512 - minLength: 1 - FieldValue: + DataSetPlaceholder: + pattern: \S + description:

Dataset placeholder.

type: string - maxLength: 2048 - minLength: 0 - Visibility: - $ref: '#/components/schemas/Visibility' + required: + - DataSetArn + - DataSetPlaceholder + ScatterPlotCategoricallyAggregatedFieldWells: additionalProperties: false - DataPathSort: type: object properties: - Direction: - $ref: '#/components/schemas/SortDirection' - SortPaths: + Category: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/DataPathValue' - maxItems: 20 + $ref: '#/components/schemas/DimensionField' + Size: minItems: 0 - required: - - Direction - - SortPaths - additionalProperties: false - DataPathType: - type: object - properties: - PivotTableDataPathType: - $ref: '#/components/schemas/PivotTableDataPathType' + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Label: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + XAxis: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + YAxis: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + LongFormatText: additionalProperties: false - DataPathValue: type: object properties: - FieldId: - type: string - maxLength: 512 + RichText: minLength: 1 - FieldValue: - type: string - maxLength: 2048 - minLength: 0 - DataPathType: - $ref: '#/components/schemas/DataPathType' - additionalProperties: false - DataSetIdentifierDeclaration: - type: object - properties: - Identifier: type: string maxLength: 2048 + PlainText: minLength: 1 - DataSetArn: type: string - required: - - DataSetArn - - Identifier + maxLength: 1024 + RadarChartAggregatedFieldWells: additionalProperties: false - DataSetReference: type: object properties: - DataSetPlaceholder: - type: string - pattern: .*\S.* - DataSetArn: - type: string - required: - - DataSetArn - - DataSetPlaceholder + Category: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Color: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/MeasureField' + FilterOperationTargetVisualsConfiguration: additionalProperties: false - DateAggregationFunction: - type: string - enum: - - COUNT - - DISTINCT_COUNT - - MIN - - MAX - DateAxisOptions: type: object properties: - MissingDateVisibility: - $ref: '#/components/schemas/Visibility' + SameSheetTargetVisualConfiguration: + $ref: '#/components/schemas/SameSheetTargetVisualConfiguration' + GrowthRateComputation: additionalProperties: false - DateDimensionField: type: object properties: - FieldId: - type: string - maxLength: 512 + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + PeriodSize: + default: 0 + maximum: 52 + type: number + minimum: 2 + ComputationId: minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - DateGranularity: - $ref: '#/components/schemas/TimeGranularity' - HierarchyId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - FormatConfiguration: - $ref: '#/components/schemas/DateTimeFormatConfiguration' + Name: + type: string required: - - Column - - FieldId + - ComputationId + KPIOptions: + additionalProperties: false + type: object + properties: + SecondaryValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + VisualLayoutOptions: + $ref: '#/components/schemas/KPIVisualLayoutOptions' + TrendArrows: + $ref: '#/components/schemas/TrendArrowOptions' + SecondaryValue: + $ref: '#/components/schemas/SecondaryValueOptions' + Comparison: + $ref: '#/components/schemas/ComparisonConfiguration' + PrimaryValueDisplayType: + $ref: '#/components/schemas/PrimaryValueDisplayType' + ProgressBar: + $ref: '#/components/schemas/ProgressBarOptions' + PrimaryValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + Sparkline: + $ref: '#/components/schemas/KPISparklineOptions' + AttributeAggregationFunction: + additionalProperties: false + type: object + properties: + SimpleAttributeAggregation: + $ref: '#/components/schemas/SimpleAttributeAggregationFunction' + ValueForMultipleValues: + type: string + SectionBasedLayoutCanvasSizeOptions: + additionalProperties: false + type: object + properties: + PaperCanvasSizeOptions: + $ref: '#/components/schemas/SectionBasedLayoutPaperCanvasSizeOptions' + NumericRangeFilter: additionalProperties: false - DateMeasureField: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' AggregationFunction: - $ref: '#/components/schemas/DateAggregationFunction' - FormatConfiguration: - $ref: '#/components/schemas/DateTimeFormatConfiguration' + $ref: '#/components/schemas/AggregationFunction' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + IncludeMaximum: + default: null + type: boolean + RangeMinimum: + $ref: '#/components/schemas/NumericRangeFilterValue' + NullOption: + $ref: '#/components/schemas/FilterNullOption' + SelectAllOptions: + $ref: '#/components/schemas/NumericFilterSelectAllOptions' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + RangeMaximum: + $ref: '#/components/schemas/NumericRangeFilterValue' + IncludeMinimum: + default: null + type: boolean required: - Column - - FieldId + - FilterId + - NullOption + FieldSortOptions: additionalProperties: false - DateTimeDefaultValues: type: object properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: + FieldSort: + $ref: '#/components/schemas/FieldSort' + ColumnSort: + $ref: '#/components/schemas/ColumnSort' + ColorsConfiguration: + additionalProperties: false + type: object + properties: + CustomColors: + minItems: 0 + maxItems: 50 type: array items: - type: string - format: date-time - maxItems: 50000 - minItems: 0 - RollingDate: - $ref: '#/components/schemas/RollingDateConfiguration' + $ref: '#/components/schemas/CustomColor' + HistogramBinType: + type: string + enum: + - BIN_COUNT + - BIN_WIDTH + ComboChartConfiguration: additionalProperties: false - DateTimeFormatConfiguration: type: object properties: - DateTimeFormat: - type: string - maxLength: 128 - minLength: 1 - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - NumericFormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' + SortConfiguration: + $ref: '#/components/schemas/ComboChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/ReferenceLine' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + BarDataLabels: + $ref: '#/components/schemas/DataLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + SingleAxisOptions: + $ref: '#/components/schemas/SingleAxisOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + BarsArrangement: + $ref: '#/components/schemas/BarsArrangement' + SecondaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + LineDataLabels: + $ref: '#/components/schemas/DataLabelOptions' + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/ComboChartFieldWells' + SecondaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + TreeMapFieldWells: additionalProperties: false + type: object + properties: + TreeMapAggregatedFieldWells: + $ref: '#/components/schemas/TreeMapAggregatedFieldWells' DateTimeHierarchy: + additionalProperties: false type: object properties: HierarchyId: + minLength: 1 type: string maxLength: 512 - minLength: 1 DrillDownFilters: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/DrillDownFilter' - maxItems: 10 - minItems: 0 required: - HierarchyId + PercentileAggregation: additionalProperties: false - DateTimeParameter: type: object properties: - Name: - type: string - pattern: .*\S.* - Values: - type: array - items: - type: string - required: - - Name - - Values + PercentileValue: + maximum: 100 + type: number + minimum: 0 + WaterfallChartGroupColorConfiguration: additionalProperties: false - DateTimeParameterDeclaration: type: object properties: - Name: + NegativeBarColor: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/DateTimeDefaultValues' - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - ValueWhenUnset: - $ref: '#/components/schemas/DateTimeValueWhenUnsetConfiguration' - MappedDataSetParameters: - type: array - items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 - required: - - Name - additionalProperties: false - DateTimePickerControlDisplayOptions: - type: object - properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - DateTimeFormat: + TotalBarColor: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 128 - minLength: 1 - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + PositiveBarColor: + pattern: ^#[A-F0-9]{6}$ + type: string + FunnelChartFieldWells: additionalProperties: false - DateTimeValueWhenUnsetConfiguration: type: object properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: - type: string - format: date-time + FunnelChartAggregatedFieldWells: + $ref: '#/components/schemas/FunnelChartAggregatedFieldWells' + StringParameterDeclaration: additionalProperties: false - DayOfTheWeek: - type: string - enum: - - SUNDAY - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - DecimalDefaultValues: type: object properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: + MappedDataSetParameters: + minItems: 0 + maxItems: 150 type: array items: - type: number - maxItems: 50000 - minItems: 0 - additionalProperties: false - DecimalParameter: - type: object - properties: + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/StringDefaultValues' + ParameterValueType: + $ref: '#/components/schemas/ParameterValueType' + ValueWhenUnset: + $ref: '#/components/schemas/StringValueWhenUnsetConfiguration' Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ type: string - pattern: .*\S.* - Values: - type: array - items: - type: number - default: 0 + maxLength: 2048 required: - Name - - Values + - ParameterValueType + DataLabelOptions: additionalProperties: false - DecimalParameterDeclaration: type: object properties: - ParameterValueType: - $ref: '#/components/schemas/ParameterValueType' - Name: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/DecimalDefaultValues' - ValueWhenUnset: - $ref: '#/components/schemas/DecimalValueWhenUnsetConfiguration' - MappedDataSetParameters: + DataLabelTypes: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 - required: - - Name - - ParameterValueType + $ref: '#/components/schemas/DataLabelType' + MeasureLabelVisibility: {} + Position: + $ref: '#/components/schemas/DataLabelPosition' + LabelContent: + $ref: '#/components/schemas/DataLabelContent' + Visibility: {} + TotalsVisibility: {} + Overlap: + $ref: '#/components/schemas/DataLabelOverlap' + CategoryLabelVisibility: {} + LabelColor: + pattern: ^#[A-F0-9]{6}$ + type: string + LabelFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + TreeMapConfiguration: additionalProperties: false - DecimalPlacesConfiguration: type: object properties: - DecimalPlaces: - type: number - maximum: 20 - minimum: 0 - required: - - DecimalPlaces + SortConfiguration: + $ref: '#/components/schemas/TreeMapSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + SizeLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/TreeMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + ColorScale: + $ref: '#/components/schemas/ColorScale' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + GroupLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FontSize: additionalProperties: false - DecimalValueWhenUnsetConfiguration: type: object properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: - type: number - default: null + Relative: + $ref: '#/components/schemas/RelativeFontSize' + Absolute: + description: String based length that is composed of value and unit in px + type: string + InnerFilter: additionalProperties: false - DefaultFreeFormLayoutConfiguration: type: object properties: - CanvasSizeOptions: - $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' - required: - - CanvasSizeOptions + CategoryInnerFilter: + $ref: '#/components/schemas/CategoryInnerFilter' + PivotTableFieldCollapseStateTarget: additionalProperties: false - DefaultGridLayoutConfiguration: type: object properties: - CanvasSizeOptions: - $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' + FieldId: + type: string + FieldDataPathValues: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/DataPathValue' + SheetVisualScopingConfiguration: + additionalProperties: false + type: object + properties: + Scope: + $ref: '#/components/schemas/FilterVisualScope' + SheetId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + VisualIds: + minItems: 0 + maxItems: 50 + type: array + items: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - CanvasSizeOptions + - Scope + - SheetId + WidgetStatus: + type: string + enum: + - ENABLED + - DISABLED + SheetImageTooltipConfiguration: additionalProperties: false - DefaultInteractiveLayoutConfiguration: type: object properties: - Grid: - $ref: '#/components/schemas/DefaultGridLayoutConfiguration' - FreeForm: - $ref: '#/components/schemas/DefaultFreeFormLayoutConfiguration' + Visibility: {} + TooltipText: + $ref: '#/components/schemas/SheetImageTooltipText' + BodySectionRepeatConfiguration: additionalProperties: false - DefaultNewSheetConfiguration: type: object properties: - InteractiveLayoutConfiguration: - $ref: '#/components/schemas/DefaultInteractiveLayoutConfiguration' - PaginatedLayoutConfiguration: - $ref: '#/components/schemas/DefaultPaginatedLayoutConfiguration' - SheetContentType: - $ref: '#/components/schemas/SheetContentType' + DimensionConfigurations: + minItems: 0 + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/BodySectionRepeatDimensionConfiguration' + NonRepeatingVisuals: + minItems: 0 + maxItems: 20 + type: array + items: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + PageBreakConfiguration: + $ref: '#/components/schemas/BodySectionRepeatPageBreakConfiguration' + SheetControlSliderType: + type: string + enum: + - SINGLE_POINT + - RANGE + TableBorderOptions: additionalProperties: false - DefaultPaginatedLayoutConfiguration: type: object properties: - SectionBased: - $ref: '#/components/schemas/DefaultSectionBasedLayoutConfiguration' + Thickness: + maximum: 4 + type: number + minimum: 1 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + Style: + $ref: '#/components/schemas/TableBorderStyle' + Icon: + type: string + enum: + - CARET_UP + - CARET_DOWN + - PLUS + - MINUS + - ARROW_UP + - ARROW_DOWN + - ARROW_LEFT + - ARROW_UP_LEFT + - ARROW_DOWN_LEFT + - ARROW_RIGHT + - ARROW_UP_RIGHT + - ARROW_DOWN_RIGHT + - FACE_UP + - FACE_DOWN + - FACE_FLAT + - ONE_BAR + - TWO_BAR + - THREE_BAR + - CIRCLE + - TRIANGLE + - SQUARE + - FLAG + - THUMBS_UP + - THUMBS_DOWN + - CHECKMARK + - X + DefaultFilterControlConfiguration: additionalProperties: false - DefaultSectionBasedLayoutConfiguration: type: object properties: - CanvasSizeOptions: - $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' + ControlOptions: + $ref: '#/components/schemas/DefaultFilterControlOptions' + Title: + minLength: 1 + type: string + maxLength: 2048 required: - - CanvasSizeOptions + - ControlOptions + - Title + DataBarsOptions: additionalProperties: false - DestinationParameterValueConfiguration: type: object properties: - CustomValuesConfiguration: - $ref: '#/components/schemas/CustomValuesConfiguration' - SelectAllValueOptions: - $ref: '#/components/schemas/SelectAllValueOptions' - SourceParameterName: + PositiveColor: + pattern: ^#[A-F0-9]{6}$ type: string - SourceField: + FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - SourceColumn: - $ref: '#/components/schemas/ColumnIdentifier' + NegativeColor: + pattern: ^#[A-F0-9]{6}$ + type: string + required: + - FieldId + TablePaginatedReportOptions: additionalProperties: false - DimensionField: type: object properties: - NumericalDimensionField: - $ref: '#/components/schemas/NumericalDimensionField' - CategoricalDimensionField: - $ref: '#/components/schemas/CategoricalDimensionField' - DateDimensionField: - $ref: '#/components/schemas/DateDimensionField' + OverflowColumnHeaderVisibility: {} + VerticalOverflowVisibility: {} + EmptyVisual: additionalProperties: false - DonutCenterOptions: type: object properties: - LabelVisibility: - $ref: '#/components/schemas/Visibility' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + required: + - DataSetIdentifier + - VisualId + KPISparklineOptions: additionalProperties: false - DonutOptions: type: object properties: - ArcOptions: - $ref: '#/components/schemas/ArcOptions' - DonutCenterOptions: - $ref: '#/components/schemas/DonutCenterOptions' + Type: + $ref: '#/components/schemas/KPISparklineType' + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + TooltipVisibility: {} + Visibility: {} + required: + - Type + CustomFilterConfiguration: additionalProperties: false - DrillDownFilter: type: object properties: - NumericEqualityFilter: - $ref: '#/components/schemas/NumericEqualityDrillDownFilter' - CategoryFilter: - $ref: '#/components/schemas/CategoryDrillDownFilter' - TimeRangeFilter: - $ref: '#/components/schemas/TimeRangeDrillDownFilter' - additionalProperties: false - DropDownControlDisplayOptions: - type: object - properties: - SelectAllOptions: - $ref: '#/components/schemas/ListControlSelectAllOptions' - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' - additionalProperties: false - DynamicDefaultValue: - type: object - properties: - UserNameColumn: - $ref: '#/components/schemas/ColumnIdentifier' - GroupNameColumn: - $ref: '#/components/schemas/ColumnIdentifier' - DefaultValueColumn: - $ref: '#/components/schemas/ColumnIdentifier' - required: - - DefaultValueColumn - additionalProperties: false - EmptyVisual: - type: object - properties: - VisualId: + CategoryValue: + minLength: 0 type: string maxLength: 512 + ParameterName: minLength: 1 - pattern: '[\w\-]+' - DataSetIdentifier: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 - minLength: 1 - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/CategoryFilterMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/CategoryFilterSelectAllOptions' required: - - DataSetIdentifier - - VisualId + - MatchOperator + - NullOption + CustomContentImageScalingConfiguration: + type: string + enum: + - FIT_TO_HEIGHT + - FIT_TO_WIDTH + - DO_NOT_SCALE + - SCALE_TO_VISUAL + DecimalDefaultValues: additionalProperties: false - Entity: type: object properties: - Path: - type: string - pattern: .*\S.* + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: + minItems: 0 + maxItems: 50000 + type: array + items: + type: number + TimeRangeFilter: additionalProperties: false - ExcludePeriodConfiguration: type: object properties: - Amount: - type: number + RangeMinimumValue: + $ref: '#/components/schemas/TimeRangeFilterValue' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RangeMaximumValue: + $ref: '#/components/schemas/TimeRangeFilterValue' + IncludeMaximum: default: null - Granularity: + type: boolean + TimeGranularity: $ref: '#/components/schemas/TimeGranularity' - Status: - $ref: '#/components/schemas/WidgetStatus' - required: - - Amount - - Granularity - additionalProperties: false - ExplicitHierarchy: - type: object - properties: - HierarchyId: + NullOption: + $ref: '#/components/schemas/FilterNullOption' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - Columns: - type: array - items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 10 - minItems: 2 - DrillDownFilters: - type: array - items: - $ref: '#/components/schemas/DrillDownFilter' - maxItems: 10 - minItems: 0 + IncludeMinimum: + default: null + type: boolean + ExcludePeriodConfiguration: + $ref: '#/components/schemas/ExcludePeriodConfiguration' required: - - Columns - - HierarchyId + - Column + - FilterId + - NullOption + WordCloudSortConfiguration: additionalProperties: false - FieldBasedTooltip: type: object properties: - AggregationVisibility: - $ref: '#/components/schemas/Visibility' - TooltipTitleType: - $ref: '#/components/schemas/TooltipTitleType' - TooltipFields: + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/TooltipItem' - maxItems: 100 - minItems: 0 + $ref: '#/components/schemas/FieldSortOptions' + RadarChartAreaStyleSettings: additionalProperties: false - FieldLabelType: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Visibility: - $ref: '#/components/schemas/Visibility' + Visibility: {} + AxisDisplayDataDrivenRange: + additionalProperties: false + type: object + FilterGroup: additionalProperties: false - FieldSeriesItem: type: object properties: - FieldId: + Status: + $ref: '#/components/schemas/WidgetStatus' + Filters: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/Filter' + CrossDataset: + $ref: '#/components/schemas/CrossDatasetTypes' + ScopeConfiguration: + $ref: '#/components/schemas/FilterScopeConfiguration' + FilterGroupId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - Settings: - $ref: '#/components/schemas/LineChartSeriesSettings' required: - - AxisBinding - - FieldId + - CrossDataset + - FilterGroupId + - Filters + - ScopeConfiguration + FontWeight: additionalProperties: false - FieldSort: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Direction: - $ref: '#/components/schemas/SortDirection' - required: - - Direction - - FieldId + Name: + $ref: '#/components/schemas/FontWeightName' + TooltipItem: additionalProperties: false - FieldSortOptions: type: object properties: - FieldSort: - $ref: '#/components/schemas/FieldSort' - ColumnSort: - $ref: '#/components/schemas/ColumnSort' + FieldTooltipItem: + $ref: '#/components/schemas/FieldTooltipItem' + ColumnTooltipItem: + $ref: '#/components/schemas/ColumnTooltipItem' + AxisDataOptions: additionalProperties: false - FieldTooltipItem: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Label: - type: string - Visibility: - $ref: '#/components/schemas/Visibility' - required: - - FieldId + DateAxisOptions: + $ref: '#/components/schemas/DateAxisOptions' + NumericAxisOptions: + $ref: '#/components/schemas/NumericAxisOptions' + FilterOperationSelectedFieldsConfiguration: additionalProperties: false - FilledMapAggregatedFieldWells: type: object properties: - Geospatial: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + SelectedColumns: minItems: 0 - Values: + maxItems: 10 + description:

The selected columns of a dataset.

type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 - additionalProperties: false - FilledMapConditionalFormatting: - type: object - properties: - ConditionalFormattingOptions: + $ref: '#/components/schemas/ColumnIdentifier' + SelectedFields: + minItems: 1 + maxItems: 20 type: array items: - $ref: '#/components/schemas/FilledMapConditionalFormattingOption' - maxItems: 200 - minItems: 0 - required: - - ConditionalFormattingOptions + minLength: 1 + type: string + maxLength: 512 + SelectedFieldOptions: + $ref: '#/components/schemas/SelectedFieldOptions' + BarsArrangement: + type: string + enum: + - CLUSTERED + - STACKED + - STACKED_PERCENT + ExcludePeriodConfiguration: additionalProperties: false - FilledMapConditionalFormattingOption: type: object properties: - Shape: - $ref: '#/components/schemas/FilledMapShapeConditionalFormatting' + Status: + $ref: '#/components/schemas/WidgetStatus' + Amount: + default: null + type: number + Granularity: + $ref: '#/components/schemas/TimeGranularity' required: - - Shape + - Amount + - Granularity + RadarChartShape: + type: string + enum: + - CIRCLE + - POLYGON + ScrollBarOptions: additionalProperties: false - FilledMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/FilledMapFieldWells' + VisibleRange: + $ref: '#/components/schemas/VisibleRangeOptions' + Visibility: {} + ConditionalFormattingCustomIconOptions: + additionalProperties: false + type: object + properties: + UnicodeIcon: + pattern: ^[^\u0000-\u00FF]$ + type: string + Icon: + $ref: '#/components/schemas/Icon' + DefaultInteractiveLayoutConfiguration: + additionalProperties: false + type: object + properties: + FreeForm: + $ref: '#/components/schemas/DefaultFreeFormLayoutConfiguration' + Grid: + $ref: '#/components/schemas/DefaultGridLayoutConfiguration' + LineChartSeriesSettings: + additionalProperties: false + type: object + properties: + LineStyleSettings: + $ref: '#/components/schemas/LineChartLineStyleSettings' + MarkerStyleSettings: + $ref: '#/components/schemas/LineChartMarkerStyleSettings' + SortDirection: + type: string + enum: + - ASC + - DESC + ScatterPlotConfiguration: + additionalProperties: false + type: object + properties: + YAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' SortConfiguration: - $ref: '#/components/schemas/FilledMapSortConfiguration' + $ref: '#/components/schemas/ScatterPlotSortConfiguration' Legend: $ref: '#/components/schemas/LegendOptions' + YAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/ScatterPlotFieldWells' Tooltip: $ref: '#/components/schemas/TooltipOptions' - WindowOptions: - $ref: '#/components/schemas/GeospatialWindowOptions' - MapStyleOptions: - $ref: '#/components/schemas/GeospatialMapStyleOptions' + XAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + XAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + GeospatialCircleSymbolStyle: additionalProperties: false - FilledMapFieldWells: type: object properties: - FilledMapAggregatedFieldWells: - $ref: '#/components/schemas/FilledMapAggregatedFieldWells' + FillColor: + $ref: '#/components/schemas/GeospatialColor' + StrokeWidth: + $ref: '#/components/schemas/GeospatialLineWidth' + StrokeColor: + $ref: '#/components/schemas/GeospatialColor' + CircleRadius: + $ref: '#/components/schemas/GeospatialCircleRadius' + CustomContentType: + type: string + enum: + - IMAGE + - OTHER_EMBEDDED_CONTENT + DefaultTextAreaControlOptions: additionalProperties: false - FilledMapShapeConditionalFormatting: type: object properties: - FieldId: - type: string - maxLength: 512 + Delimiter: minLength: 1 - Format: - $ref: '#/components/schemas/ShapeConditionalFormat' - required: - - FieldId + type: string + maxLength: 2048 + DisplayOptions: + $ref: '#/components/schemas/TextAreaControlDisplayOptions' + VisualCustomActionTrigger: + type: string + enum: + - DATA_POINT_CLICK + - DATA_POINT_MENU + SankeyDiagramAggregatedFieldWells: additionalProperties: false - FilledMapSortConfiguration: type: object properties: - CategorySort: + Destination: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/DimensionField' + Source: minItems: 0 - additionalProperties: false - FilledMapVisual: - type: object - properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/FilledMapConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/FilledMapConditionalFormatting' - ColumnHierarchies: + maxItems: 200 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 + $ref: '#/components/schemas/DimensionField' + Weight: minItems: 0 - Actions: + maxItems: 200 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - required: - - VisualId - additionalProperties: false - Filter: - type: object - properties: - CategoryFilter: - $ref: '#/components/schemas/CategoryFilter' - NumericRangeFilter: - $ref: '#/components/schemas/NumericRangeFilter' - NumericEqualityFilter: - $ref: '#/components/schemas/NumericEqualityFilter' - TimeEqualityFilter: - $ref: '#/components/schemas/TimeEqualityFilter' - TimeRangeFilter: - $ref: '#/components/schemas/TimeRangeFilter' - RelativeDatesFilter: - $ref: '#/components/schemas/RelativeDatesFilter' - TopBottomFilter: - $ref: '#/components/schemas/TopBottomFilter' + $ref: '#/components/schemas/MeasureField' + TableConditionalFormattingOption: additionalProperties: false - FilterControl: type: object properties: - DateTimePicker: - $ref: '#/components/schemas/FilterDateTimePickerControl' - List: - $ref: '#/components/schemas/FilterListControl' - Dropdown: - $ref: '#/components/schemas/FilterDropDownControl' - TextField: - $ref: '#/components/schemas/FilterTextFieldControl' - TextArea: - $ref: '#/components/schemas/FilterTextAreaControl' - Slider: - $ref: '#/components/schemas/FilterSliderControl' - RelativeDateTime: - $ref: '#/components/schemas/FilterRelativeDateTimeControl' + Row: + $ref: '#/components/schemas/TableRowConditionalFormatting' + Cell: + $ref: '#/components/schemas/TableCellConditionalFormatting' + ArcThickness: + type: string + enum: + - SMALL + - MEDIUM + - LARGE + - WHOLE + CalculatedMeasureField: additionalProperties: false - FilterDateTimePickerControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 + Expression: minLength: 1 - pattern: '[\w\-]+' - Title: type: string - maxLength: 2048 + maxLength: 4096 + FieldId: minLength: 1 - SourceFilterId: type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlDateTimePickerType' required: - - FilterControlId - - SourceFilterId - - Title + - Expression + - FieldId + FieldSeriesItem: additionalProperties: false + type: object + properties: + FieldId: + minLength: 1 + type: string + maxLength: 512 + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + Settings: + $ref: '#/components/schemas/LineChartSeriesSettings' + required: + - AxisBinding + - FieldId FilterDropDownControl: + additionalProperties: false type: object properties: FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/DropDownControlDisplayOptions' + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' Title: + minLength: 1 type: string maxLength: 2048 - minLength: 1 + CommitMode: + $ref: '#/components/schemas/CommitMode' SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/DropDownControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' SelectableValues: $ref: '#/components/schemas/FilterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' required: - FilterControlId - SourceFilterId - Title + BoxPlotAggregatedFieldWells: additionalProperties: false - FilterGroup: type: object properties: - FilterGroupId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Filters: + GroupBy: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/Filter' - maxItems: 20 + $ref: '#/components/schemas/DimensionField' + Values: minItems: 0 - ScopeConfiguration: - $ref: '#/components/schemas/FilterScopeConfiguration' - Status: - $ref: '#/components/schemas/WidgetStatus' - CrossDataset: - $ref: '#/components/schemas/CrossDatasetTypes' - required: - - CrossDataset - - FilterGroupId - - Filters - - ScopeConfiguration - additionalProperties: false - FilterListConfiguration: - type: object - properties: - MatchOperator: - $ref: '#/components/schemas/CategoryFilterMatchOperator' - CategoryValues: + maxItems: 5 type: array items: - type: string - maxLength: 512 - minLength: 0 - maxItems: 100000 - minItems: 0 - SelectAllOptions: - $ref: '#/components/schemas/CategoryFilterSelectAllOptions' - NullOption: - $ref: '#/components/schemas/FilterNullOption' - required: - - MatchOperator + $ref: '#/components/schemas/MeasureField' + RelativeDatesFilter: additionalProperties: false - FilterListControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 + RelativeDateValue: + default: null + type: number + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RelativeDateType: + $ref: '#/components/schemas/RelativeDateType' + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ParameterName: minLength: 1 - pattern: '[\w\-]+' - Title: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: minLength: 1 - SourceFilterId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/ListControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/FilterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' + AnchorDateConfiguration: + $ref: '#/components/schemas/AnchorDateConfiguration' + MinimumGranularity: + $ref: '#/components/schemas/TimeGranularity' + ExcludePeriodConfiguration: + $ref: '#/components/schemas/ExcludePeriodConfiguration' required: - - FilterControlId - - SourceFilterId - - Title + - AnchorDateConfiguration + - Column + - FilterId + - NullOption + - RelativeDateType + - TimeGranularity + ParameterControl: additionalProperties: false - FilterNullOption: + type: object + properties: + Slider: + $ref: '#/components/schemas/ParameterSliderControl' + TextArea: + $ref: '#/components/schemas/ParameterTextAreaControl' + Dropdown: + $ref: '#/components/schemas/ParameterDropDownControl' + TextField: + $ref: '#/components/schemas/ParameterTextFieldControl' + List: + $ref: '#/components/schemas/ParameterListControl' + DateTimePicker: + $ref: '#/components/schemas/ParameterDateTimePickerControl' + DigitGroupingStyle: type: string enum: - - ALL_VALUES - - NULLS_ONLY - - NON_NULLS_ONLY - FilterOperationSelectedFieldsConfiguration: + - DEFAULT + - LAKHS + ReferenceLineLabelConfiguration: + additionalProperties: false type: object properties: - SelectedFields: - type: array - items: - type: string - maxLength: 512 - minLength: 1 - maxItems: 20 - minItems: 1 - SelectedFieldOptions: - $ref: '#/components/schemas/SelectedFieldOptions' - SelectedColumns: - type: array - items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 10 - minItems: 0 + HorizontalPosition: + $ref: '#/components/schemas/ReferenceLineLabelHorizontalPosition' + ValueLabelConfiguration: + $ref: '#/components/schemas/ReferenceLineValueLabelConfiguration' + CustomLabelConfiguration: + $ref: '#/components/schemas/ReferenceLineCustomLabelConfiguration' + FontColor: + pattern: ^#[A-F0-9]{6}$ + type: string + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + VerticalPosition: + $ref: '#/components/schemas/ReferenceLineLabelVerticalPosition' + GeospatialCategoricalDataColor: additionalProperties: false - FilterOperationTargetVisualsConfiguration: type: object properties: - SameSheetTargetVisualConfiguration: - $ref: '#/components/schemas/SameSheetTargetVisualConfiguration' + DataValue: + type: string + Color: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string + required: + - Color + - DataValue + HistogramVisual: additionalProperties: false - FilterRelativeDateTimeControl: type: object properties: - FilterControlId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + ChartConfiguration: + $ref: '#/components/schemas/HistogramConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' Title: - type: string - maxLength: 2048 + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - SourceFilterId: type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/RelativeDateTimeControlDisplayOptions' + maxLength: 1024 required: - - FilterControlId - - SourceFilterId - - Title - additionalProperties: false - FilterScopeConfiguration: - type: object - properties: - SelectedSheets: - $ref: '#/components/schemas/SelectedSheetsFilterScopeConfiguration' - AllSheets: - $ref: '#/components/schemas/AllSheetsFilterScopeConfiguration' + - VisualId + DateTimeValueWhenUnsetConfiguration: additionalProperties: false - FilterSelectableValues: type: object properties: - Values: - type: array - items: - type: string - maxItems: 50000 - minItems: 0 + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + format: date-time + type: string + PivotTableVisual: additionalProperties: false - FilterSliderControl: type: object properties: - FilterControlId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/PivotTableConditionalFormatting' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + ChartConfiguration: + $ref: '#/components/schemas/PivotTableConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' Title: - type: string - maxLength: 2048 + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - SourceFilterId: type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/SliderControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlSliderType' - MaximumValue: - type: number - default: 0 - MinimumValue: - type: number - default: 0 - StepSize: - type: number - default: 0 + maxLength: 1024 required: - - FilterControlId - - MaximumValue - - MinimumValue - - SourceFilterId - - StepSize - - Title + - VisualId + PluginVisualItemsLimitConfiguration: additionalProperties: false - FilterTextAreaControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceFilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Delimiter: - type: string - maxLength: 2048 + ItemsLimit: + default: null + type: number + GridLayoutElement: + additionalProperties: false + type: object + properties: + ElementType: + $ref: '#/components/schemas/LayoutElementType' + ColumnSpan: + maximum: 36 + type: number + minimum: 1 + ColumnIndex: + maximum: 35 + type: number + minimum: 0 + RowIndex: + maximum: 9009 + type: number + minimum: 0 + RowSpan: + maximum: 21 + type: number + minimum: 1 + ElementId: minLength: 1 - DisplayOptions: - $ref: '#/components/schemas/TextAreaControlDisplayOptions' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - FilterControlId - - SourceFilterId - - Title + - ColumnSpan + - ElementId + - ElementType + - RowSpan + FreeFormLayoutElement: additionalProperties: false - FilterTextFieldControl: type: object properties: - FilterControlId: + ElementType: + $ref: '#/components/schemas/LayoutElementType' + BorderStyle: + $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' + Height: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: + Visibility: {} + RenderingRules: + minItems: 0 + maxItems: 10000 + type: array + items: + $ref: '#/components/schemas/SheetElementRenderingRule' + YAxisLocation: + description: String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value type: string - maxLength: 2048 + LoadingAnimation: + $ref: '#/components/schemas/LoadingAnimation' + Width: + description: String based length that is composed of value and unit in px + type: string + BackgroundStyle: + $ref: '#/components/schemas/FreeFormLayoutElementBackgroundStyle' + ElementId: minLength: 1 - SourceFilterId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/TextFieldControlDisplayOptions' + XAxisLocation: + description: String based length that is composed of value and unit in px + type: string + SelectedBorderStyle: + $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' required: - - FilterControlId - - SourceFilterId - - Title - additionalProperties: false - FilterVisualScope: + - ElementId + - ElementType + - Height + - Width + - XAxisLocation + - YAxisLocation + LineInterpolation: type: string enum: - - ALL_VISUALS - - SELECTED_VISUALS - FontConfiguration: + - LINEAR + - SMOOTH + - STEPPED + CustomValuesConfiguration: + additionalProperties: false type: object properties: - FontSize: - $ref: '#/components/schemas/FontSize' - FontDecoration: - $ref: '#/components/schemas/FontDecoration' - FontColor: - type: string - pattern: ^#[A-F0-9]{6}$ - FontWeight: - $ref: '#/components/schemas/FontWeight' - FontStyle: - $ref: '#/components/schemas/FontStyle' + IncludeNullValue: + type: boolean + CustomValues: + $ref: '#/components/schemas/CustomParameterValues' + required: + - CustomValues + DefaultNewSheetConfiguration: additionalProperties: false - FontDecoration: - type: string - enum: - - UNDERLINE - - NONE - FontSize: type: object properties: - Relative: - $ref: '#/components/schemas/RelativeFontSize' + SheetContentType: + $ref: '#/components/schemas/SheetContentType' + InteractiveLayoutConfiguration: + $ref: '#/components/schemas/DefaultInteractiveLayoutConfiguration' + PaginatedLayoutConfiguration: + $ref: '#/components/schemas/DefaultPaginatedLayoutConfiguration' + GaugeChartConditionalFormatting: additionalProperties: false - FontStyle: - type: string - enum: - - NORMAL - - ITALIC - FontWeight: type: object properties: - Name: - $ref: '#/components/schemas/FontWeightName' + ConditionalFormattingOptions: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/GaugeChartConditionalFormattingOption' + FilledMapFieldWells: additionalProperties: false - FontWeightName: - type: string - enum: - - NORMAL - - BOLD + type: object + properties: + FilledMapAggregatedFieldWells: + $ref: '#/components/schemas/FilledMapAggregatedFieldWells' + AxisDisplayRange: + additionalProperties: false + type: object + properties: + DataDriven: + $ref: '#/components/schemas/AxisDisplayDataDrivenRange' + MinMax: + $ref: '#/components/schemas/AxisDisplayMinMaxRange' ForecastComputation: + additionalProperties: false type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - PeriodsForward: - type: number - maximum: 1000 - minimum: 1 PeriodsBackward: - type: number maximum: 1000 - minimum: 0 - UpperBoundary: type: number - default: null - LowerBoundary: + minimum: 0 + PeriodsForward: + maximum: 1000 type: number - default: null + minimum: 1 PredictionInterval: - type: number maximum: 95 + type: number minimum: 50 Seasonality: $ref: '#/components/schemas/ForecastComputationSeasonality' CustomSeasonalityValue: - type: number default: null maximum: 180 + type: number minimum: 1 + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + UpperBoundary: + default: null + type: number + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string + LowerBoundary: + default: null + type: number required: - ComputationId - additionalProperties: false - ForecastComputationSeasonality: + WordCloudWordPadding: type: string enum: - - AUTOMATIC - - CUSTOM - ForecastConfiguration: + - NONE + - SMALL + - MEDIUM + - LARGE + PivotTableDataPathOption: + additionalProperties: false type: object properties: - ForecastProperties: - $ref: '#/components/schemas/TimeBasedForecastProperties' - Scenario: - $ref: '#/components/schemas/ForecastScenario' + DataPathList: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/DataPathValue' + Width: + description: String based length that is composed of value and unit in px + type: string + required: + - DataPathList + TextFieldControlDisplayOptions: additionalProperties: false - ForecastScenario: type: object properties: - WhatIfPointScenario: - $ref: '#/components/schemas/WhatIfPointScenario' - WhatIfRangeScenario: - $ref: '#/components/schemas/WhatIfRangeScenario' + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + PlaceholderOptions: + $ref: '#/components/schemas/TextControlPlaceholderOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + TransposedTableOption: additionalProperties: false - FormatConfiguration: type: object properties: - StringFormatConfiguration: - $ref: '#/components/schemas/StringFormatConfiguration' - NumberFormatConfiguration: - $ref: '#/components/schemas/NumberFormatConfiguration' - DateTimeFormatConfiguration: - $ref: '#/components/schemas/DateTimeFormatConfiguration' + ColumnWidth: + description: String based length that is composed of value and unit in px + type: string + ColumnIndex: + maximum: 9999 + type: number + minimum: 0 + ColumnType: + $ref: '#/components/schemas/TransposedColumnType' + required: + - ColumnType + AxisBinding: + type: string + enum: + - PRIMARY_YAXIS + - SECONDARY_YAXIS + PivotTableSortConfiguration: additionalProperties: false - FreeFormLayoutCanvasSizeOptions: type: object properties: - ScreenCanvasSizeOptions: - $ref: '#/components/schemas/FreeFormLayoutScreenCanvasSizeOptions' + FieldSortOptions: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/PivotFieldSortOptions' + ReferenceLinePatternType: + type: string + enum: + - SOLID + - DASHED + - DOTTED + NumericAxisOptions: additionalProperties: false - FreeFormLayoutConfiguration: type: object properties: - Elements: - type: array - items: - $ref: '#/components/schemas/FreeFormLayoutElement' - maxItems: 430 - minItems: 0 - CanvasSizeOptions: - $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' - required: - - Elements + Scale: + $ref: '#/components/schemas/AxisScale' + Range: + $ref: '#/components/schemas/AxisDisplayRange' + VisualCustomActionOperation: additionalProperties: false - FreeFormLayoutElement: type: object properties: - ElementId: - type: string - maxLength: 512 + NavigationOperation: + $ref: '#/components/schemas/CustomActionNavigationOperation' + SetParametersOperation: + $ref: '#/components/schemas/CustomActionSetParametersOperation' + FilterOperation: + $ref: '#/components/schemas/CustomActionFilterOperation' + URLOperation: + $ref: '#/components/schemas/CustomActionURLOperation' + NumericRangeFilterValue: + additionalProperties: false + type: object + properties: + StaticValue: + default: null + type: number + Parameter: minLength: 1 - pattern: '[\w\-]+' - ElementType: - $ref: '#/components/schemas/LayoutElementType' - XAxisLocation: - type: string - description: String based length that is composed of value and unit in px - YAxisLocation: - type: string - description: String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value - Width: + pattern: ^[a-zA-Z0-9]+$ type: string - description: String based length that is composed of value and unit in px - Height: + maxLength: 2048 + BoxPlotVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - description: String based length that is composed of value and unit in px - Visibility: - $ref: '#/components/schemas/Visibility' - RenderingRules: + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/BoxPlotChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/SheetElementRenderingRule' - maxItems: 10000 + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + ColumnHierarchies: minItems: 0 - BorderStyle: - $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' - SelectedBorderStyle: - $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' - BackgroundStyle: - $ref: '#/components/schemas/FreeFormLayoutElementBackgroundStyle' - LoadingAnimation: - $ref: '#/components/schemas/LoadingAnimation' + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - ElementId - - ElementType - - Height - - Width - - XAxisLocation - - YAxisLocation + - VisualId + CustomFilterListConfiguration: additionalProperties: false + type: object + properties: + CategoryValues: + minItems: 0 + maxItems: 100000 + type: array + items: + minLength: 0 + type: string + maxLength: 512 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/CategoryFilterMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/CategoryFilterSelectAllOptions' + required: + - MatchOperator + - NullOption FreeFormLayoutElementBackgroundStyle: + additionalProperties: false type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' Color: - type: string pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string + Visibility: {} + SheetImageScalingType: + type: string + enum: + - SCALE_TO_WIDTH + - SCALE_TO_HEIGHT + - SCALE_TO_CONTAINER + - SCALE_NONE + BoxPlotFieldWells: additionalProperties: false - FreeFormLayoutElementBorderStyle: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - Color: - type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + BoxPlotAggregatedFieldWells: + $ref: '#/components/schemas/BoxPlotAggregatedFieldWells' + SheetElementRenderingRule: additionalProperties: false - FreeFormLayoutScreenCanvasSizeOptions: type: object properties: - OptimizedViewPortWidth: + Expression: + minLength: 1 type: string - description: String based length that is composed of value and unit in px + maxLength: 4096 + ConfigurationOverrides: + $ref: '#/components/schemas/SheetElementConfigurationOverrides' required: - - OptimizedViewPortWidth + - ConfigurationOverrides + - Expression + TrendArrowOptions: additionalProperties: false - FreeFormSectionLayoutConfiguration: type: object properties: - Elements: - type: array - items: - $ref: '#/components/schemas/FreeFormLayoutElement' - maxItems: 430 - minItems: 0 + Visibility: {} + ValidationStrategy: + description:

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

+ additionalProperties: false + type: object + properties: + Mode: + $ref: '#/components/schemas/ValidationStrategyMode' required: - - Elements + - Mode + ConditionalFormattingIconSetType: + type: string + enum: + - PLUS_MINUS + - CHECK_X + - THREE_COLOR_ARROW + - THREE_GRAY_ARROW + - CARET_UP_MINUS_DOWN + - THREE_SHAPE + - THREE_CIRCLE + - FLAGS + - BARS + - FOUR_COLOR_ARROW + - FOUR_GRAY_ARROW + TableCellImageSizingConfiguration: + additionalProperties: false + type: object + properties: + TableCellImageScalingConfiguration: + $ref: '#/components/schemas/TableCellImageScalingConfiguration' + GeospatialHeatmapConfiguration: + additionalProperties: false + type: object + properties: + HeatmapColor: + $ref: '#/components/schemas/GeospatialHeatmapColorScale' + StaticFile: additionalProperties: false + type: object + properties: + ImageStaticFile: + $ref: '#/components/schemas/ImageStaticFile' + SpatialStaticFile: + $ref: '#/components/schemas/SpatialStaticFile' + PanelTitleOptions: + additionalProperties: false + type: object + properties: + Visibility: {} + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + HorizontalTextAlignment: + $ref: '#/components/schemas/HorizontalTextAlignment' FunnelChartAggregatedFieldWells: + additionalProperties: false type: object properties: Category: + minItems: 0 + maxItems: 1 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 Values: + minItems: 0 + maxItems: 1 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 + SelectAllValueOptions: + type: string + enum: + - ALL_VALUES + GeospatialCoordinateBounds: additionalProperties: false - FunnelChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/FunnelChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/FunnelChartSortConfiguration' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ValueLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - DataLabelOptions: - $ref: '#/components/schemas/FunnelChartDataLabelOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - additionalProperties: false - FunnelChartDataLabelOptions: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - CategoryLabelVisibility: - $ref: '#/components/schemas/Visibility' - MeasureLabelVisibility: - $ref: '#/components/schemas/Visibility' - Position: - $ref: '#/components/schemas/DataLabelPosition' - LabelFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - LabelColor: - type: string - pattern: ^#[A-F0-9]{6}$ - MeasureDataLabelStyle: - $ref: '#/components/schemas/FunnelChartMeasureDataLabelStyle' + West: + maximum: 1800 + type: number + minimum: -1800 + South: + maximum: 90 + type: number + minimum: -90 + North: + maximum: 90 + type: number + minimum: -90 + East: + maximum: 1800 + type: number + minimum: -1800 + required: + - East + - North + - South + - West + PivotTableConditionalFormattingScopeRole: + type: string + enum: + - FIELD + - FIELD_TOTAL + - GRAND_TOTAL + BoxPlotStyleOptions: additionalProperties: false - FunnelChartFieldWells: type: object properties: - FunnelChartAggregatedFieldWells: - $ref: '#/components/schemas/FunnelChartAggregatedFieldWells' + FillStyle: + $ref: '#/components/schemas/BoxPlotFillStyle' + StringDefaultValues: additionalProperties: false - FunnelChartMeasureDataLabelStyle: - type: string - enum: - - VALUE_ONLY - - PERCENTAGE_BY_FIRST_STAGE - - PERCENTAGE_BY_PREVIOUS_STAGE - - VALUE_AND_PERCENTAGE_BY_FIRST_STAGE - - VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE - FunnelChartSortConfiguration: type: object properties: - CategorySort: + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: + minItems: 0 + maxItems: 50000 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + type: string + SheetImageScalingConfiguration: additionalProperties: false - FunnelChartVisual: type: object properties: - VisualId: + ScalingType: + $ref: '#/components/schemas/SheetImageScalingType' + FreeFormLayoutElementBorderStyle: + additionalProperties: false + type: object + properties: + Color: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string - maxLength: 512 + Visibility: {} + CategoryFilter: + additionalProperties: false + type: object + properties: + Configuration: + $ref: '#/components/schemas/CategoryFilterConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - Column + - Configuration + - FilterId + VerticalTextAlignment: + type: string + enum: + - TOP + - MIDDLE + - BOTTOM + - AUTO + FilterNullOption: + type: string + enum: + - ALL_VALUES + - NULLS_ONLY + - NON_NULLS_ONLY + FilledMapVisual: + additionalProperties: false + type: object + properties: Subtitle: $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/FilledMapConditionalFormatting' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 ChartConfiguration: - $ref: '#/components/schemas/FunnelChartConfiguration' + $ref: '#/components/schemas/FilledMapConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + SmallMultiplesAxisScale: + type: string + enum: + - SHARED + - INDEPENDENT + FilterSliderControl: additionalProperties: false - GaugeChartArcConditionalFormatting: type: object properties: - ForegroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlSliderType' + StepSize: + default: 0 + type: number + DisplayOptions: + $ref: '#/components/schemas/SliderControlDisplayOptions' + Title: + minLength: 1 + type: string + maxLength: 2048 + MaximumValue: + default: 0 + type: number + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + MinimumValue: + default: 0 + type: number + required: + - FilterControlId + - MaximumValue + - MinimumValue + - SourceFilterId + - StepSize + - Title + PivotTableConditionalFormattingOption: additionalProperties: false - GaugeChartConditionalFormatting: type: object properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/GaugeChartConditionalFormattingOption' - maxItems: 100 - minItems: 0 + Cell: + $ref: '#/components/schemas/PivotTableCellConditionalFormatting' + DataLabelOverlap: + type: string + enum: + - DISABLE_OVERLAP + - ENABLE_OVERLAP + ConditionalFormattingIconDisplayConfiguration: additionalProperties: false - GaugeChartConditionalFormattingOption: type: object properties: - PrimaryValue: - $ref: '#/components/schemas/GaugeChartPrimaryValueConditionalFormatting' - Arc: - $ref: '#/components/schemas/GaugeChartArcConditionalFormatting' + IconDisplayOption: + $ref: '#/components/schemas/ConditionalFormattingIconDisplayOption' + SelectedFieldOptions: + type: string + enum: + - ALL_FIELDS + TableFieldLinkConfiguration: additionalProperties: false - GaugeChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/GaugeChartFieldWells' - GaugeChartOptions: - $ref: '#/components/schemas/GaugeChartOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - TooltipOptions: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + Target: + $ref: '#/components/schemas/URLTargetConfiguration' + Content: + $ref: '#/components/schemas/TableFieldLinkContentConfiguration' + required: + - Content + - Target + GeospatialHeatmapDataColor: additionalProperties: false - GaugeChartFieldWells: type: object properties: - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - TargetValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + required: + - Color + LineChartType: + type: string + enum: + - LINE + - AREA + - STACKED_AREA + DefaultTextFieldControlOptions: additionalProperties: false - GaugeChartOptions: type: object properties: - PrimaryValueDisplayType: - $ref: '#/components/schemas/PrimaryValueDisplayType' - Comparison: - $ref: '#/components/schemas/ComparisonConfiguration' - ArcAxis: - $ref: '#/components/schemas/ArcAxisConfiguration' - Arc: - $ref: '#/components/schemas/ArcConfiguration' - PrimaryValueFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' + DisplayOptions: + $ref: '#/components/schemas/TextFieldControlDisplayOptions' + TableTotalsPlacement: + type: string + enum: + - START + - END + - AUTO + LayoutConfiguration: additionalProperties: false - GaugeChartPrimaryValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + GridLayout: + $ref: '#/components/schemas/GridLayoutConfiguration' + FreeFormLayout: + $ref: '#/components/schemas/FreeFormLayoutConfiguration' + SectionBasedLayout: + $ref: '#/components/schemas/SectionBasedLayoutConfiguration' + ImageStaticFile: additionalProperties: false - GaugeChartVisual: type: object properties: - VisualId: + StaticFileId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/GaugeChartConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/GaugeChartConditionalFormatting' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Source: + $ref: '#/components/schemas/StaticFileSource' required: - - VisualId + - StaticFileId + PivotFieldSortOptions: additionalProperties: false - GeospatialCoordinateBounds: type: object properties: - North: - type: number - maximum: 90 - minimum: -90 - South: - type: number - maximum: 90 - minimum: -90 - West: - type: number - maximum: 1800 - minimum: -1800 - East: - type: number - maximum: 1800 - minimum: -1800 + SortBy: + $ref: '#/components/schemas/PivotTableSortBy' + FieldId: + minLength: 1 + type: string + maxLength: 512 required: - - East - - North - - South - - West + - FieldId + - SortBy + GeospatialLineStyle: + additionalProperties: false + type: object + properties: + LineSymbolStyle: + $ref: '#/components/schemas/GeospatialLineSymbolStyle' + SimpleAttributeAggregationFunction: + type: string + enum: + - UNIQUE_VALUE + ColorScale: additionalProperties: false - GeospatialHeatmapColorScale: type: object properties: Colors: + minItems: 2 + maxItems: 3 type: array items: - $ref: '#/components/schemas/GeospatialHeatmapDataColor' - maxItems: 2 - minItems: 2 + $ref: '#/components/schemas/DataColor' + ColorFillType: + $ref: '#/components/schemas/ColorFillType' + NullValueColor: + $ref: '#/components/schemas/DataColor' + required: + - ColorFillType + - Colors + WordCloudWordOrientation: + type: string + enum: + - HORIZONTAL + - HORIZONTAL_AND_VERTICAL + GridLayoutCanvasSizeOptions: additionalProperties: false - GeospatialHeatmapConfiguration: type: object properties: - HeatmapColor: - $ref: '#/components/schemas/GeospatialHeatmapColorScale' + ScreenCanvasSizeOptions: + $ref: '#/components/schemas/GridLayoutScreenCanvasSizeOptions' + ValueWhenUnsetOption: + type: string + enum: + - RECOMMENDED_VALUE + - 'NULL' + CategoryFilterMatchOperator: + type: string + enum: + - EQUALS + - DOES_NOT_EQUAL + - CONTAINS + - DOES_NOT_CONTAIN + - STARTS_WITH + - ENDS_WITH + ConditionalFormattingIconDisplayOption: + type: string + enum: + - ICON_ONLY + GeospatialPolygonStyle: additionalProperties: false - GeospatialHeatmapDataColor: type: object properties: - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - required: - - Color + PolygonSymbolStyle: + $ref: '#/components/schemas/GeospatialPolygonSymbolStyle' + GeospatialDataSourceItem: additionalProperties: false - GeospatialMapAggregatedFieldWells: type: object properties: - Geospatial: + StaticFileDataSource: + $ref: '#/components/schemas/GeospatialStaticFileSource' + KPIProgressBarConditionalFormatting: + additionalProperties: false + type: object + properties: + ForegroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + WaterfallChartAggregatedFieldWells: + additionalProperties: false + type: object + properties: + Categories: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Breakdowns: minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' maxItems: 200 - minItems: 0 - Colors: type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Values: minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + MissingDataConfiguration: additionalProperties: false - GeospatialMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/GeospatialMapFieldWells' - Legend: - $ref: '#/components/schemas/LegendOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - WindowOptions: - $ref: '#/components/schemas/GeospatialWindowOptions' - MapStyleOptions: - $ref: '#/components/schemas/GeospatialMapStyleOptions' - PointStyleOptions: - $ref: '#/components/schemas/GeospatialPointStyleOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + TreatmentOption: + $ref: '#/components/schemas/MissingDataTreatmentOption' + TableCellImageScalingConfiguration: + type: string + enum: + - FIT_TO_CELL_HEIGHT + - FIT_TO_CELL_WIDTH + - DO_NOT_SCALE + HeatMapSortConfiguration: additionalProperties: false + type: object + properties: + HeatMapRowSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + HeatMapRowItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + HeatMapColumnItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + HeatMapColumnSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + CategoricalAggregationFunction: + type: string + enum: + - COUNT + - DISTINCT_COUNT GeospatialMapFieldWells: + additionalProperties: false type: object properties: GeospatialMapAggregatedFieldWells: $ref: '#/components/schemas/GeospatialMapAggregatedFieldWells' + SelectedSheetsFilterScopeConfiguration: additionalProperties: false - GeospatialMapStyleOptions: type: object properties: - BaseMapStyle: - $ref: '#/components/schemas/BaseMapStyleType' + SheetVisualScopingConfigurations: + minItems: 1 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/SheetVisualScopingConfiguration' + PieChartSortConfiguration: additionalProperties: false - GeospatialMapVisual: type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/GeospatialMapConfiguration' - ColumnHierarchies: + SmallMultiplesSort: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 + $ref: '#/components/schemas/FieldSortOptions' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: minItems: 0 - Actions: + maxItems: 100 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - required: - - VisualId + $ref: '#/components/schemas/FieldSortOptions' + SmallMultiplesLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + FunnelChartConfiguration: additionalProperties: false - GeospatialPointStyleOptions: type: object properties: - SelectedPointStyle: - $ref: '#/components/schemas/GeospatialSelectedPointStyle' - ClusterMarkerConfiguration: - $ref: '#/components/schemas/ClusterMarkerConfiguration' - HeatmapConfiguration: - $ref: '#/components/schemas/GeospatialHeatmapConfiguration' + SortConfiguration: + $ref: '#/components/schemas/FunnelChartSortConfiguration' + DataLabelOptions: + $ref: '#/components/schemas/FunnelChartDataLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/FunnelChartFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + ValueLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + PluginVisualConfiguration: additionalProperties: false - GeospatialSelectedPointStyle: - type: string - enum: - - POINT - - CLUSTER - - HEATMAP - GeospatialWindowOptions: type: object properties: - Bounds: - $ref: '#/components/schemas/GeospatialCoordinateBounds' - MapZoomMode: - $ref: '#/components/schemas/MapZoomMode' + SortConfiguration: + $ref: '#/components/schemas/PluginVisualSortConfiguration' + VisualOptions: + $ref: '#/components/schemas/PluginVisualOptions' + FieldWells: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/PluginVisualFieldWell' + FilterCrossSheetControl: additionalProperties: false - GlobalTableBorderOptions: type: object properties: - UniformBorder: - $ref: '#/components/schemas/TableBorderOptions' - SideSpecificBorder: - $ref: '#/components/schemas/TableSideBorderOptions' + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - FilterControlId + - SourceFilterId + TotalAggregationFunction: additionalProperties: false - GradientColor: type: object properties: - Stops: - type: array - items: - $ref: '#/components/schemas/GradientStop' - maxItems: 100 - minItems: 0 + SimpleTotalAggregationFunction: + $ref: '#/components/schemas/SimpleTotalAggregationFunction' + GaugeChartConfiguration: additionalProperties: false - GradientStop: type: object properties: - GradientOffset: - type: number - default: 0 - DataValue: - type: number - default: null - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - required: - - GradientOffset + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/GaugeChartFieldWells' + TooltipOptions: + $ref: '#/components/schemas/TooltipOptions' + GaugeChartOptions: + $ref: '#/components/schemas/GaugeChartOptions' + ColorConfiguration: + $ref: '#/components/schemas/GaugeChartColorConfiguration' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + NumericalAggregationFunction: additionalProperties: false - GridLayoutCanvasSizeOptions: type: object properties: - ScreenCanvasSizeOptions: - $ref: '#/components/schemas/GridLayoutScreenCanvasSizeOptions' + PercentileAggregation: + $ref: '#/components/schemas/PercentileAggregation' + SimpleNumericalAggregation: + $ref: '#/components/schemas/SimpleNumericalAggregationFunction' + CustomActionNavigationOperation: additionalProperties: false - GridLayoutConfiguration: type: object properties: - Elements: + LocalNavigationConfiguration: + $ref: '#/components/schemas/LocalNavigationConfiguration' + GeospatialPointStyle: + additionalProperties: false + type: object + properties: + CircleSymbolStyle: {} + HorizontalTextAlignment: + type: string + enum: + - LEFT + - CENTER + - RIGHT + - AUTO + LayerCustomActionOperation: + additionalProperties: false + type: object + properties: + NavigationOperation: + $ref: '#/components/schemas/CustomActionNavigationOperation' + SetParametersOperation: + $ref: '#/components/schemas/CustomActionSetParametersOperation' + FilterOperation: + $ref: '#/components/schemas/CustomActionFilterOperation' + URLOperation: + $ref: '#/components/schemas/CustomActionURLOperation' + GeospatialLayerMapConfiguration: + additionalProperties: false + type: object + properties: + Legend: + $ref: '#/components/schemas/LegendOptions' + MapState: + $ref: '#/components/schemas/GeospatialMapState' + MapStyle: + $ref: '#/components/schemas/GeospatialMapStyle' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + MapLayers: type: array items: - $ref: '#/components/schemas/GridLayoutElement' - maxItems: 430 - minItems: 0 - CanvasSizeOptions: - $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' - required: - - Elements + $ref: '#/components/schemas/GeospatialLayerItem' + DecimalPlacesConfiguration: additionalProperties: false - GridLayoutElement: type: object properties: - ElementId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - ElementType: - $ref: '#/components/schemas/LayoutElementType' - ColumnIndex: - type: number - maximum: 35 - minimum: 0 - ColumnSpan: - type: number - maximum: 36 - minimum: 1 - RowIndex: + DecimalPlaces: + maximum: 20 type: number - maximum: 9009 minimum: 0 - RowSpan: - type: number - maximum: 21 - minimum: 1 required: - - ColumnSpan - - ElementId - - ElementType - - RowSpan + - DecimalPlaces + SectionBasedLayoutPaperCanvasSizeOptions: additionalProperties: false - GridLayoutScreenCanvasSizeOptions: type: object properties: - ResizeOption: - $ref: '#/components/schemas/ResizeOption' - OptimizedViewPortWidth: - type: string - description: String based length that is composed of value and unit in px - required: - - ResizeOption + PaperMargin: + $ref: '#/components/schemas/Spacing' + PaperSize: + $ref: '#/components/schemas/PaperSize' + PaperOrientation: + $ref: '#/components/schemas/PaperOrientation' + GeospatialLayerJoinDefinition: additionalProperties: false - GrowthRateComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: + ColorField: + $ref: '#/components/schemas/GeospatialLayerColorField' + ShapeKeyField: type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - PeriodSize: - type: number - default: 0 - maximum: 52 - minimum: 2 - required: - - ComputationId + DatasetKeyField: + $ref: '#/components/schemas/UnaggregatedField' + FilledMapConditionalFormatting: additionalProperties: false - HeaderFooterSectionConfiguration: type: object properties: - SectionId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Layout: - $ref: '#/components/schemas/SectionLayoutConfiguration' - Style: - $ref: '#/components/schemas/SectionStyle' + ConditionalFormattingOptions: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/FilledMapConditionalFormattingOption' required: - - Layout - - SectionId + - ConditionalFormattingOptions + BarChartSortConfiguration: additionalProperties: false - HeatMapAggregatedFieldWells: type: object properties: - Rows: + SmallMultiplesSort: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + $ref: '#/components/schemas/FieldSortOptions' + ColorSort: minItems: 0 - Columns: + maxItems: 100 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + $ref: '#/components/schemas/FieldSortOptions' + ColorItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: minItems: 0 - Values: + maxItems: 100 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 + $ref: '#/components/schemas/FieldSortOptions' + SmallMultiplesLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + SheetElementConfigurationOverrides: additionalProperties: false - HeatMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/HeatMapFieldWells' - SortConfiguration: - $ref: '#/components/schemas/HeatMapSortConfiguration' - RowLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColumnLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorScale: - $ref: '#/components/schemas/ColorScale' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' + Visibility: {} + DonutCenterOptions: additionalProperties: false - HeatMapFieldWells: type: object properties: - HeatMapAggregatedFieldWells: - $ref: '#/components/schemas/HeatMapAggregatedFieldWells' + LabelVisibility: {} + BodySectionContent: additionalProperties: false - HeatMapSortConfiguration: type: object properties: - HeatMapRowSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + Layout: + $ref: '#/components/schemas/SectionLayoutConfiguration' + TableRowConditionalFormatting: + additionalProperties: false + type: object + properties: + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + BackgroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + CategoryInnerFilter: + additionalProperties: false + type: object + properties: + Configuration: + $ref: '#/components/schemas/CategoryFilterConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + required: + - Column + - Configuration + GeospatialLineWidth: + additionalProperties: false + type: object + properties: + LineWidth: + type: number + minimum: 0 + PivotTableCellConditionalFormatting: + additionalProperties: false + type: object + properties: + Scope: + $ref: '#/components/schemas/PivotTableConditionalFormattingScope' + Scopes: minItems: 0 - HeatMapColumnSort: + maxItems: 3 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - HeatMapRowItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' - HeatMapColumnItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + $ref: '#/components/schemas/PivotTableConditionalFormattingScope' + FieldId: + minLength: 1 + type: string + maxLength: 512 + TextFormat: + $ref: '#/components/schemas/TextConditionalFormat' + required: + - FieldId + ListControlDisplayOptions: additionalProperties: false - HeatMapVisual: type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/HeatMapConfiguration' - ColumnHierarchies: + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + SearchOptions: + $ref: '#/components/schemas/ListControlSearchOptions' + SelectAllOptions: + $ref: '#/components/schemas/ListControlSelectAllOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + ScatterPlotUnaggregatedFieldWells: + additionalProperties: false + type: object + properties: + Category: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 + $ref: '#/components/schemas/DimensionField' + Size: minItems: 0 - Actions: + maxItems: 200 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + $ref: '#/components/schemas/MeasureField' + Label: minItems: 0 - required: - - VisualId - additionalProperties: false - HistogramAggregatedFieldWells: - type: object - properties: - Values: + maxItems: 200 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 + $ref: '#/components/schemas/DimensionField' + XAxis: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + YAxis: minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + GeospatialLayerDefinition: additionalProperties: false - HistogramBinOptions: type: object properties: - SelectedBinType: - $ref: '#/components/schemas/HistogramBinType' - BinCount: - $ref: '#/components/schemas/BinCountOptions' - BinWidth: - $ref: '#/components/schemas/BinWidthOptions' - StartValue: - type: number - default: null + PointLayer: + $ref: '#/components/schemas/GeospatialPointLayer' + PolygonLayer: + $ref: '#/components/schemas/GeospatialPolygonLayer' + LineLayer: + $ref: '#/components/schemas/GeospatialLineLayer' + PieChartAggregatedFieldWells: additionalProperties: false - HistogramBinType: - type: string - enum: - - BIN_COUNT - - BIN_WIDTH - HistogramConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/HistogramFieldWells' - XAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - XAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - YAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - BinOptions: - $ref: '#/components/schemas/HistogramBinOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + Category: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + SmallMultiples: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + GeospatialLineLayer: additionalProperties: false - HistogramFieldWells: type: object properties: - HistogramAggregatedFieldWells: - $ref: '#/components/schemas/HistogramAggregatedFieldWells' + Style: + $ref: '#/components/schemas/GeospatialLineStyle' + required: + - Style + LineChartVisual: additionalProperties: false - HistogramVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/HistogramConfiguration' + $ref: '#/components/schemas/LineChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + ColumnHierarchies: minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - VisualId + ScatterPlotFieldWells: additionalProperties: false - HorizontalTextAlignment: + type: object + properties: + ScatterPlotUnaggregatedFieldWells: + $ref: '#/components/schemas/ScatterPlotUnaggregatedFieldWells' + ScatterPlotCategoricallyAggregatedFieldWells: + $ref: '#/components/schemas/ScatterPlotCategoricallyAggregatedFieldWells' + FontStyle: type: string enum: - - LEFT - - CENTER - - RIGHT - - AUTO - Icon: + - NORMAL + - ITALIC + BarChartOrientation: type: string enum: - - CARET_UP - - CARET_DOWN - - PLUS - - MINUS - - ARROW_UP - - ARROW_DOWN - - ARROW_LEFT - - ARROW_UP_LEFT - - ARROW_DOWN_LEFT - - ARROW_RIGHT - - ARROW_UP_RIGHT - - ARROW_DOWN_RIGHT - - FACE_UP - - FACE_DOWN - - FACE_FLAT - - ONE_BAR - - TWO_BAR - - THREE_BAR - - CIRCLE - - TRIANGLE - - SQUARE - - FLAG - - THUMBS_UP - - THUMBS_DOWN - - CHECKMARK - - X - InsightConfiguration: - type: object - properties: - Computations: - type: array - items: - $ref: '#/components/schemas/Computation' - maxItems: 100 - minItems: 0 - CustomNarrative: - $ref: '#/components/schemas/CustomNarrativeOptions' + - HORIZONTAL + - VERTICAL + DataColor: additionalProperties: false - InsightVisual: type: object properties: - VisualId: + DataValue: + default: null + type: number + Color: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 512 + SetParameterValueConfiguration: + additionalProperties: false + type: object + properties: + DestinationParameterName: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - InsightConfiguration: - $ref: '#/components/schemas/InsightConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - DataSetIdentifier: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 - minLength: 1 + Value: + $ref: '#/components/schemas/DestinationParameterValueConfiguration' required: - - DataSetIdentifier - - VisualId + - DestinationParameterName + - Value + KPISparklineType: + type: string + enum: + - LINE + - AREA + BoxPlotChartConfiguration: additionalProperties: false - IntegerDefaultValues: type: object properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: + SortConfiguration: + $ref: '#/components/schemas/BoxPlotSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: + minItems: 0 + maxItems: 20 type: array items: - type: number - maxItems: 50000 - minItems: 0 + $ref: '#/components/schemas/ReferenceLine' + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/BoxPlotFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + BoxPlotOptions: + $ref: '#/components/schemas/BoxPlotOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + ScatterPlotSortConfiguration: additionalProperties: false - IntegerParameter: type: object properties: - Name: + ScatterPlotLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + TimeRangeDrillDownFilter: + additionalProperties: false + type: object + properties: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RangeMinimum: + format: date-time + type: string + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + RangeMaximum: + format: date-time type: string - pattern: .*\S.* - Values: - type: array - items: - type: number - default: 0 required: - - Name - - Values + - Column + - RangeMaximum + - RangeMinimum + - TimeGranularity + DataFieldSeriesItem: additionalProperties: false - IntegerParameterDeclaration: type: object properties: - ParameterValueType: - $ref: '#/components/schemas/ParameterValueType' - Name: - type: string - maxLength: 2048 + FieldId: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/IntegerDefaultValues' - ValueWhenUnset: - $ref: '#/components/schemas/IntegerValueWhenUnsetConfiguration' - MappedDataSetParameters: - type: array - items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 + type: string + maxLength: 512 + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + FieldValue: + type: string + Settings: + $ref: '#/components/schemas/LineChartSeriesSettings' required: - - Name - - ParameterValueType + - AxisBinding + - FieldId + BinWidthOptions: additionalProperties: false - IntegerValueWhenUnsetConfiguration: type: object properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: + BinCountLimit: + maximum: 1000 type: number - default: null + minimum: 0 + Value: + type: number + minimum: 0 + CascadingControlSource: additionalProperties: false - ItemsLimitConfiguration: type: object properties: - ItemsLimit: - type: number - default: null - OtherCategories: - $ref: '#/components/schemas/OtherCategories' + SourceSheetControlId: + type: string + ColumnToMatch: + $ref: '#/components/schemas/ColumnIdentifier' + TableOptions: additionalProperties: false - KPIActualValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + HeaderStyle: + $ref: '#/components/schemas/TableCellStyle' + CellStyle: + $ref: '#/components/schemas/TableCellStyle' + Orientation: + $ref: '#/components/schemas/TableOrientation' + RowAlternateColorOptions: + $ref: '#/components/schemas/RowAlternateColorOptions' + ColumnConfiguration: additionalProperties: false - KPIComparisonValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + Role: + $ref: '#/components/schemas/ColumnRole' + FormatConfiguration: + $ref: '#/components/schemas/FormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + ColorsConfiguration: + $ref: '#/components/schemas/ColorsConfiguration' + required: + - Column + ListControlSelectAllOptions: additionalProperties: false - KPIConditionalFormatting: type: object properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/KPIConditionalFormattingOption' - maxItems: 100 - minItems: 0 + Visibility: {} + NumericFilterSelectAllOptions: + type: string + enum: + - FILTER_ALL_VALUES + TableFieldIconSetType: + type: string + enum: + - LINK + ProgressBarOptions: additionalProperties: false - KPIConditionalFormattingOption: type: object properties: - PrimaryValue: - $ref: '#/components/schemas/KPIPrimaryValueConditionalFormatting' - ProgressBar: - $ref: '#/components/schemas/KPIProgressBarConditionalFormatting' - ActualValue: - $ref: '#/components/schemas/KPIActualValueConditionalFormatting' - ComparisonValue: - $ref: '#/components/schemas/KPIComparisonValueConditionalFormatting' + Visibility: {} + SheetControlLayoutConfiguration: additionalProperties: false - KPIConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/KPIFieldWells' - SortConfiguration: - $ref: '#/components/schemas/KPISortConfiguration' - KPIOptions: - $ref: '#/components/schemas/KPIOptions' + GridLayout: + $ref: '#/components/schemas/GridLayoutConfiguration' + YAxisOptions: additionalProperties: false - KPIFieldWells: type: object properties: - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - TargetValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - TrendGroups: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - additionalProperties: false - KPIOptions: + YAxis: + $ref: '#/components/schemas/SingleYAxisOption' + required: + - YAxis + ResourcePermission: type: object + description:

Permission for the resource.

properties: - ProgressBar: - $ref: '#/components/schemas/ProgressBarOptions' - TrendArrows: - $ref: '#/components/schemas/TrendArrowOptions' - SecondaryValue: - $ref: '#/components/schemas/SecondaryValueOptions' - Comparison: - $ref: '#/components/schemas/ComparisonConfiguration' - PrimaryValueDisplayType: - $ref: '#/components/schemas/PrimaryValueDisplayType' - PrimaryValueFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - SecondaryValueFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - Sparkline: - $ref: '#/components/schemas/KPISparklineOptions' - VisualLayoutOptions: - $ref: '#/components/schemas/KPIVisualLayoutOptions' - additionalProperties: false - KPIPrimaryValueConditionalFormatting: - type: object - properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + Principal: + type: string + maxLength: 256 + minLength: 1 + description: |- +

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
+ Actions: + type: array + items: + type: string + maxItems: 20 + minItems: 1 + description:

The IAM action to grant or revoke permissions on.

+ required: + - Actions + - Principal additionalProperties: false - KPIProgressBarConditionalFormatting: - type: object - properties: - ForegroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' + SubtotalOptions: additionalProperties: false - KPISortConfiguration: type: object properties: - TrendGroupSort: + CustomLabel: + type: string + FieldLevelOptions: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/PivotTableFieldSubtotalOptions' + ValueCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalsVisibility: {} + FieldLevel: + $ref: '#/components/schemas/PivotTableSubtotalLevel' + MetricHeaderCellStyle: + $ref: '#/components/schemas/TableCellStyle' + StyleTargets: minItems: 0 + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/TableStyleTarget' + PivotTablePaginatedReportOptions: additionalProperties: false - KPISparklineOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - Type: - $ref: '#/components/schemas/KPISparklineType' - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - TooltipVisibility: - $ref: '#/components/schemas/Visibility' - required: - - Type + OverflowColumnHeaderVisibility: {} + VerticalOverflowVisibility: {} + TableOrientation: + type: string + enum: + - VERTICAL + - HORIZONTAL + ClusterMarker: additionalProperties: false - KPISparklineType: + type: object + properties: + SimpleClusterMarker: + $ref: '#/components/schemas/SimpleClusterMarker' + FunnelChartMeasureDataLabelStyle: type: string enum: - - LINE - - AREA - KPIVisual: + - VALUE_ONLY + - PERCENTAGE_BY_FIRST_STAGE + - PERCENTAGE_BY_PREVIOUS_STAGE + - VALUE_AND_PERCENTAGE_BY_FIRST_STAGE + - VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE + ParameterValueType: + type: string + enum: + - MULTI_VALUED + - SINGLE_VALUED + ParameterSelectableValues: + additionalProperties: false type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/KPIConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/KPIConditionalFormatting' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + LinkToDataSetColumn: + $ref: '#/components/schemas/ColumnIdentifier' + Values: minItems: 0 - ColumnHierarchies: + maxItems: 50000 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId + type: string + SectionLayoutConfiguration: additionalProperties: false - KPIVisualLayoutOptions: type: object properties: - StandardLayout: - $ref: '#/components/schemas/KPIVisualStandardLayout' + FreeFormLayout: + $ref: '#/components/schemas/FreeFormSectionLayoutConfiguration' + required: + - FreeFormLayout + SheetControlLayout: additionalProperties: false - KPIVisualStandardLayout: type: object properties: - Type: - $ref: '#/components/schemas/KPIVisualStandardLayoutType' + Configuration: + $ref: '#/components/schemas/SheetControlLayoutConfiguration' required: - - Type - additionalProperties: false - KPIVisualStandardLayoutType: + - Configuration + FontWeightName: type: string enum: - - CLASSIC - - VERTICAL - LabelOptions: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - CustomLabel: - type: string + - NORMAL + - BOLD + HeatMapFieldWells: additionalProperties: false - Layout: type: object properties: - Configuration: - $ref: '#/components/schemas/LayoutConfiguration' - required: - - Configuration + HeatMapAggregatedFieldWells: + $ref: '#/components/schemas/HeatMapAggregatedFieldWells' + PercentVisibleRange: additionalProperties: false - LayoutConfiguration: type: object properties: - GridLayout: - $ref: '#/components/schemas/GridLayoutConfiguration' - FreeFormLayout: - $ref: '#/components/schemas/FreeFormLayoutConfiguration' - SectionBasedLayout: - $ref: '#/components/schemas/SectionBasedLayoutConfiguration' - additionalProperties: false - LayoutElementType: + From: + default: null + maximum: 100 + type: number + minimum: 0 + To: + default: null + maximum: 100 + type: number + minimum: 0 + PivotTableMetricPlacement: type: string enum: - - VISUAL - - FILTER_CONTROL - - PARAMETER_CONTROL - - TEXT_BOX - LegendOptions: + - ROW + - COLUMN + Computation: + additionalProperties: false type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - Title: - $ref: '#/components/schemas/LabelOptions' - Position: - $ref: '#/components/schemas/LegendPosition' - Width: - type: string - description: String based length that is composed of value and unit in px - Height: - type: string - description: String based length that is composed of value and unit in px + PeriodToDate: + $ref: '#/components/schemas/PeriodToDateComputation' + GrowthRate: + $ref: '#/components/schemas/GrowthRateComputation' + TopBottomRanked: + $ref: '#/components/schemas/TopBottomRankedComputation' + TotalAggregation: + $ref: '#/components/schemas/TotalAggregationComputation' + Forecast: + $ref: '#/components/schemas/ForecastComputation' + MaximumMinimum: + $ref: '#/components/schemas/MaximumMinimumComputation' + PeriodOverPeriod: + $ref: '#/components/schemas/PeriodOverPeriodComputation' + MetricComparison: + $ref: '#/components/schemas/MetricComparisonComputation' + TopBottomMovers: + $ref: '#/components/schemas/TopBottomMoversComputation' + UniqueValues: + $ref: '#/components/schemas/UniqueValuesComputation' + GeospatialPolygonLayer: additionalProperties: false - LegendPosition: + type: object + properties: + Style: + $ref: '#/components/schemas/GeospatialPolygonStyle' + required: + - Style + RelativeFontSize: type: string enum: - - AUTO - - RIGHT - - BOTTOM - - TOP - LineChartAggregatedFieldWells: + - EXTRA_SMALL + - SMALL + - MEDIUM + - LARGE + - EXTRA_LARGE + CascadingControlConfiguration: + additionalProperties: false type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + SourceControls: minItems: 0 - Colors: - type: array - items: - $ref: '#/components/schemas/DimensionField' maxItems: 200 - minItems: 0 - SmallMultiples: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 - additionalProperties: false - LineChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/LineChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/LineChartSortConfiguration' - ForecastConfigurations: - type: array - items: - $ref: '#/components/schemas/ForecastConfiguration' - maxItems: 10 - minItems: 0 - Type: - $ref: '#/components/schemas/LineChartType' - SmallMultiplesOptions: - $ref: '#/components/schemas/SmallMultiplesOptions' - XAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - XAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - SecondaryYAxisDisplayOptions: - $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' - SecondaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - DefaultSeriesSettings: - $ref: '#/components/schemas/LineChartDefaultSeriesSettings' - Series: - type: array - items: - $ref: '#/components/schemas/SeriesItem' - maxItems: 10 - minItems: 0 - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 - minItems: 0 - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ContributionAnalysisDefaults: type: array items: - $ref: '#/components/schemas/ContributionAnalysisDefault' - maxItems: 200 - minItems: 1 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - additionalProperties: false - LineChartDefaultSeriesSettings: - type: object - properties: - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - LineStyleSettings: - $ref: '#/components/schemas/LineChartLineStyleSettings' - MarkerStyleSettings: - $ref: '#/components/schemas/LineChartMarkerStyleSettings' + $ref: '#/components/schemas/CascadingControlSource' + StaticFileSource: additionalProperties: false - LineChartFieldWells: type: object properties: - LineChartAggregatedFieldWells: - $ref: '#/components/schemas/LineChartAggregatedFieldWells' - additionalProperties: false + UrlOptions: + $ref: '#/components/schemas/StaticFileUrlSourceOptions' + S3Options: + $ref: '#/components/schemas/StaticFileS3SourceOptions' LineChartLineStyle: type: string enum: - SOLID - DOTTED - DASHED - LineChartLineStyleSettings: + Visibility: + type: string + enum: + - HIDDEN + - VISIBLE + VisualMenuOption: + additionalProperties: false type: object properties: - LineVisibility: - $ref: '#/components/schemas/Visibility' - LineInterpolation: - $ref: '#/components/schemas/LineInterpolation' - LineStyle: - $ref: '#/components/schemas/LineChartLineStyle' - LineWidth: - type: string - description: String based length that is composed of value and unit in px - additionalProperties: false - LineChartMarkerShape: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + ComparisonMethod: type: string enum: - - CIRCLE - - TRIANGLE - - SQUARE - - DIAMOND - - ROUNDED_SQUARE - LineChartMarkerStyleSettings: + - DIFFERENCE + - PERCENT_DIFFERENCE + - PERCENT + CustomColor: + additionalProperties: false type: object properties: - MarkerVisibility: - $ref: '#/components/schemas/Visibility' - MarkerShape: - $ref: '#/components/schemas/LineChartMarkerShape' - MarkerSize: + Color: + pattern: ^#[A-F0-9]{6}$ type: string - description: String based length that is composed of value and unit in px - MarkerColor: + FieldValue: + minLength: 0 type: string - pattern: ^#[A-F0-9]{6}$ + maxLength: 2048 + SpecialValue: + $ref: '#/components/schemas/SpecialValue' + required: + - Color + SingleYAxisOption: + type: string + enum: + - PRIMARY_Y_AXIS + SpecialValue: + type: string + enum: + - EMPTY + - 'NULL' + - OTHER + DefaultSliderControlOptions: additionalProperties: false - LineChartSeriesSettings: type: object properties: - LineStyleSettings: - $ref: '#/components/schemas/LineChartLineStyleSettings' - MarkerStyleSettings: - $ref: '#/components/schemas/LineChartMarkerStyleSettings' + Type: + $ref: '#/components/schemas/SheetControlSliderType' + StepSize: + default: 0 + type: number + DisplayOptions: + $ref: '#/components/schemas/SliderControlDisplayOptions' + MaximumValue: + default: 0 + type: number + MinimumValue: + default: 0 + type: number + required: + - MaximumValue + - MinimumValue + - StepSize + WaterfallChartColorConfiguration: additionalProperties: false - LineChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' - SmallMultiplesSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SmallMultiplesLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + GroupColorConfiguration: + $ref: '#/components/schemas/WaterfallChartGroupColorConfiguration' + ParameterListControl: additionalProperties: false - LineChartType: - type: string - enum: - - LINE - - AREA - - STACKED_AREA - LineChartVisual: type: object properties: - VisualId: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/ListControlDisplayOptions' + SourceParameterName: minLength: 1 - pattern: '[\w\-]+' + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/LineChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + minLength: 1 + type: string + maxLength: 2048 + SelectableValues: + $ref: '#/components/schemas/ParameterSelectableValues' required: - - VisualId + - ParameterControlId + - SourceParameterName + - Title + PluginVisualTableQuerySort: additionalProperties: false - LineInterpolation: - type: string - enum: - - LINEAR - - SMOOTH - - STEPPED - LineSeriesAxisDisplayOptions: type: object properties: - AxisOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - MissingDataConfigurations: + ItemsLimitConfiguration: + $ref: '#/components/schemas/PluginVisualItemsLimitConfiguration' + RowSort: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/MissingDataConfiguration' - maxItems: 100 - minItems: 0 - additionalProperties: false - ListControlDisplayOptions: + $ref: '#/components/schemas/FieldSortOptions' + ParameterDateTimePickerControl: + additionalProperties: false type: object properties: - SearchOptions: - $ref: '#/components/schemas/ListControlSearchOptions' - SelectAllOptions: - $ref: '#/components/schemas/ListControlSelectAllOptions' - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + SourceParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + Title: + minLength: 1 + type: string + maxLength: 2048 + required: + - ParameterControlId + - SourceParameterName + - Title + PluginVisualAxisName: + type: string + enum: + - GROUP_BY + - VALUE + TreeMapSortConfiguration: additionalProperties: false - ListControlSearchOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + TreeMapSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + TreeMapGroupItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + LineChartFieldWells: additionalProperties: false - ListControlSelectAllOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + LineChartAggregatedFieldWells: + $ref: '#/components/schemas/LineChartAggregatedFieldWells' + RadarChartSeriesSettings: additionalProperties: false - LoadingAnimation: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + AreaStyleSettings: + $ref: '#/components/schemas/RadarChartAreaStyleSettings' + NumberScale: + type: string + enum: + - NONE + - AUTO + - THOUSANDS + - MILLIONS + - BILLIONS + - TRILLIONS + - LAKHS + - CRORES + BoxPlotSortConfiguration: additionalProperties: false - LocalNavigationConfiguration: type: object properties: - TargetSheetId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - required: - - TargetSheetId + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + PaginationConfiguration: + $ref: '#/components/schemas/PaginationConfiguration' + ImageMenuOption: additionalProperties: false - LongFormatText: type: object properties: - PlainText: - type: string - maxLength: 1024 - minLength: 1 - RichText: - type: string - maxLength: 2048 - minLength: 1 + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + CategoryDrillDownFilter: additionalProperties: false - MapZoomMode: + type: object + properties: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + CategoryValues: + minItems: 0 + maxItems: 100000 + type: array + items: + minLength: 0 + type: string + maxLength: 512 + required: + - CategoryValues + - Column + PivotTableFieldCollapseStateOption: + additionalProperties: false + type: object + properties: + Target: + $ref: '#/components/schemas/PivotTableFieldCollapseStateTarget' + State: + $ref: '#/components/schemas/PivotTableFieldCollapseState' + required: + - Target + DashboardBehavior: type: string enum: - - AUTO - - MANUAL - MappedDataSetParameter: + - ENABLED + - DISABLED + GridLayoutScreenCanvasSizeOptions: + additionalProperties: false type: object properties: - DataSetIdentifier: - type: string - maxLength: 2048 - minLength: 1 - DataSetParameterName: + OptimizedViewPortWidth: + description: String based length that is composed of value and unit in px type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + ResizeOption: + $ref: '#/components/schemas/ResizeOption' required: - - DataSetIdentifier - - DataSetParameterName + - ResizeOption + SankeyDiagramChartConfiguration: additionalProperties: false - MaximumLabelType: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + SortConfiguration: + $ref: '#/components/schemas/SankeyDiagramSortConfiguration' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/SankeyDiagramFieldWells' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + WordCloudVisual: additionalProperties: false - MaximumMinimumComputation: type: object properties: - ComputationId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/WordCloudChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - pattern: '[\w\-]+' - Name: type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - Type: - $ref: '#/components/schemas/MaximumMinimumComputationType' + maxLength: 1024 + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - ComputationId - - Type + - VisualId + FilterListConfiguration: additionalProperties: false - MaximumMinimumComputationType: - type: string - enum: - - MAXIMUM - - MINIMUM - MeasureField: type: object properties: - NumericalMeasureField: - $ref: '#/components/schemas/NumericalMeasureField' - CategoricalMeasureField: - $ref: '#/components/schemas/CategoricalMeasureField' - DateMeasureField: - $ref: '#/components/schemas/DateMeasureField' - CalculatedMeasureField: - $ref: '#/components/schemas/CalculatedMeasureField' + CategoryValues: + minItems: 0 + maxItems: 100000 + type: array + items: + minLength: 0 + type: string + maxLength: 512 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/CategoryFilterMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/CategoryFilterSelectAllOptions' + required: + - MatchOperator + SankeyDiagramVisual: additionalProperties: false - MetricComparisonComputation: type: object properties: - ComputationId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/SankeyDiagramChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - pattern: '[\w\-]+' - Name: type: string - Time: - $ref: '#/components/schemas/DimensionField' - FromValue: - $ref: '#/components/schemas/MeasureField' - TargetValue: - $ref: '#/components/schemas/MeasureField' + maxLength: 1024 required: - - ComputationId + - VisualId + TopBottomComputationType: + type: string + enum: + - TOP + - BOTTOM + ForecastConfiguration: additionalProperties: false - MinimumLabelType: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + ForecastProperties: + $ref: '#/components/schemas/TimeBasedForecastProperties' + Scenario: + $ref: '#/components/schemas/ForecastScenario' + SimpleTotalAggregationFunction: + type: string + enum: + - DEFAULT + - SUM + - AVERAGE + - MIN + - MAX + - NONE + ConditionalFormattingSolidColor: additionalProperties: false - MissingDataConfiguration: type: object properties: - TreatmentOption: - $ref: '#/components/schemas/MissingDataTreatmentOption' + Expression: + minLength: 1 + type: string + maxLength: 4096 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + required: + - Expression + WaterfallChartFieldWells: additionalProperties: false - MissingDataTreatmentOption: - type: string - enum: - - INTERPOLATE - - SHOW_AS_ZERO - - SHOW_AS_BLANK - NegativeValueConfiguration: type: object properties: - DisplayMode: - $ref: '#/components/schemas/NegativeValueDisplayMode' - required: - - DisplayMode + WaterfallChartAggregatedFieldWells: + $ref: '#/components/schemas/WaterfallChartAggregatedFieldWells' + GeospatialHeatmapColorScale: additionalProperties: false - NegativeValueDisplayMode: + type: object + properties: + Colors: + minItems: 2 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/GeospatialHeatmapDataColor' + AnalysisErrorType: type: string enum: - - POSITIVE - - NEGATIVE - NullValueFormatConfiguration: + - ACCESS_DENIED + - SOURCE_NOT_FOUND + - DATA_SET_NOT_FOUND + - INTERNAL_FAILURE + - PARAMETER_VALUE_INCOMPATIBLE + - PARAMETER_TYPE_INVALID + - PARAMETER_NOT_FOUND + - COLUMN_TYPE_MISMATCH + - COLUMN_GEOGRAPHIC_ROLE_MISMATCH + - COLUMN_REPLACEMENT_MISSING + DefaultFreeFormLayoutConfiguration: + additionalProperties: false type: object properties: - NullString: - type: string - maxLength: 128 - minLength: 1 + CanvasSizeOptions: + $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' required: - - NullString + - CanvasSizeOptions + FilledMapShapeConditionalFormatting: additionalProperties: false - NumberDisplayFormatConfiguration: type: object properties: - Prefix: - type: string - maxLength: 128 + Format: + $ref: '#/components/schemas/ShapeConditionalFormat' + FieldId: minLength: 1 - Suffix: type: string - maxLength: 128 - minLength: 1 - SeparatorConfiguration: - $ref: '#/components/schemas/NumericSeparatorConfiguration' - DecimalPlacesConfiguration: - $ref: '#/components/schemas/DecimalPlacesConfiguration' - NumberScale: - $ref: '#/components/schemas/NumberScale' - NegativeValueConfiguration: - $ref: '#/components/schemas/NegativeValueConfiguration' - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - additionalProperties: false - NumberFormatConfiguration: - type: object - properties: - FormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' + maxLength: 512 + required: + - FieldId + InsightConfiguration: additionalProperties: false - NumberScale: - type: string - enum: - - NONE - - AUTO - - THOUSANDS - - MILLIONS - - BILLIONS - - TRILLIONS - NumericAxisOptions: type: object properties: - Scale: - $ref: '#/components/schemas/AxisScale' - Range: - $ref: '#/components/schemas/AxisDisplayRange' + Computations: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/Computation' + CustomNarrative: + $ref: '#/components/schemas/CustomNarrativeOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + ReferenceLineStyleConfiguration: additionalProperties: false - NumericEqualityDrillDownFilter: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Value: - type: number - default: 0 - required: - - Column - - Value + Pattern: + $ref: '#/components/schemas/ReferenceLinePatternType' + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + ResizeOption: + type: string + enum: + - FIXED + - RESPONSIVE + FunnelChartDataLabelOptions: additionalProperties: false - NumericEqualityFilter: type: object properties: - FilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Value: - type: number - default: null - SelectAllOptions: - $ref: '#/components/schemas/NumericFilterSelectAllOptions' - MatchOperator: - $ref: '#/components/schemas/NumericEqualityMatchOperator' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - ParameterName: + MeasureLabelVisibility: {} + Position: + $ref: '#/components/schemas/DataLabelPosition' + Visibility: {} + CategoryLabelVisibility: {} + LabelColor: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - NullOption: - $ref: '#/components/schemas/FilterNullOption' - required: - - Column - - FilterId - - MatchOperator - - NullOption - additionalProperties: false + MeasureDataLabelStyle: + $ref: '#/components/schemas/FunnelChartMeasureDataLabelStyle' + LabelFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' NumericEqualityMatchOperator: type: string enum: - EQUALS - DOES_NOT_EQUAL - NumericFilterSelectAllOptions: - type: string - enum: - - FILTER_ALL_VALUES - NumericFormatConfiguration: + SecondaryValueOptions: + additionalProperties: false type: object properties: - NumberDisplayFormatConfiguration: - $ref: '#/components/schemas/NumberDisplayFormatConfiguration' - CurrencyDisplayFormatConfiguration: - $ref: '#/components/schemas/CurrencyDisplayFormatConfiguration' - PercentageDisplayFormatConfiguration: - $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + Visibility: {} + HeaderFooterSectionConfiguration: additionalProperties: false - NumericRangeFilter: type: object properties: - FilterId: + Layout: + $ref: '#/components/schemas/SectionLayoutConfiguration' + Style: + $ref: '#/components/schemas/SectionStyle' + SectionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - IncludeMinimum: - type: boolean - default: null - IncludeMaximum: - type: boolean - default: null - RangeMinimum: - $ref: '#/components/schemas/NumericRangeFilterValue' - RangeMaximum: - $ref: '#/components/schemas/NumericRangeFilterValue' - SelectAllOptions: - $ref: '#/components/schemas/NumericFilterSelectAllOptions' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - NullOption: - $ref: '#/components/schemas/FilterNullOption' required: - - Column - - FilterId - - NullOption + - Layout + - SectionId + BodySectionRepeatPageBreakConfiguration: additionalProperties: false - NumericRangeFilterValue: type: object properties: - StaticValue: - type: number - default: null - Parameter: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + After: + $ref: '#/components/schemas/SectionAfterPageBreak' + HeatMapConfiguration: additionalProperties: false - NumericSeparatorConfiguration: type: object properties: - DecimalSeparator: - $ref: '#/components/schemas/NumericSeparatorSymbol' - ThousandsSeparator: - $ref: '#/components/schemas/ThousandSeparatorOptions' - additionalProperties: false - NumericSeparatorSymbol: - type: string - enum: - - COMMA - - DOT - - SPACE - NumericalAggregationFunction: - type: object - properties: - SimpleNumericalAggregation: - $ref: '#/components/schemas/SimpleNumericalAggregationFunction' - PercentileAggregation: - $ref: '#/components/schemas/PercentileAggregation' + SortConfiguration: + $ref: '#/components/schemas/HeatMapSortConfiguration' + ColumnLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/HeatMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + ColorScale: + $ref: '#/components/schemas/ColorScale' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + RowLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + TransposedColumnType: + type: string + enum: + - ROW_HEADER_COLUMN + - VALUE_COLUMN + FilterListControl: additionalProperties: false - NumericalDimensionField: type: object properties: - FieldId: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/ListControlDisplayOptions' + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + Title: minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - HierarchyId: + type: string + maxLength: 2048 + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' + required: + - FilterControlId + - SourceFilterId + - Title + PeriodOverPeriodComputation: + additionalProperties: false + type: object + properties: + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: minLength: 1 - FormatConfiguration: - $ref: '#/components/schemas/NumberFormatConfiguration' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string required: - - Column - - FieldId + - ComputationId + Sheet: + description: |- +

A sheet, which is an object that contains a set of visuals that + are viewed together on one page in Amazon QuickSight. Every analysis and dashboard + contains at least one sheet. Each sheet contains at least one visualization widget, for + example a chart, pivot table, or narrative insight. Sheets can be associated with other + components, such as controls, filters, and so on.

additionalProperties: false - NumericalMeasureField: type: object properties: - FieldId: + SheetId: + minLength: 1 + pattern: ^[\w\-]+$ + description:

The unique identifier associated with a sheet.

type: string maxLength: 512 + Name: minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - AggregationFunction: - $ref: '#/components/schemas/NumericalAggregationFunction' - FormatConfiguration: - $ref: '#/components/schemas/NumberFormatConfiguration' - required: - - Column - - FieldId + description: |- +

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight + console.

+ type: string + maxLength: 2048 + ArcOptions: additionalProperties: false - OtherCategories: - type: string - enum: - - INCLUDE - - EXCLUDE - PaginationConfiguration: type: object properties: - PageSize: - type: number - default: null - PageNumber: - type: number - minimum: 0 + ArcThickness: + $ref: '#/components/schemas/ArcThickness' + DefaultSectionBasedLayoutConfiguration: + additionalProperties: false + type: object + properties: + CanvasSizeOptions: + $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' required: - - PageNumber - - PageSize + - CanvasSizeOptions + SectionStyle: additionalProperties: false - PanelBorderStyle: - type: string - enum: - - SOLID - - DASHED - - DOTTED - PanelConfiguration: type: object properties: - Title: - $ref: '#/components/schemas/PanelTitleOptions' - BorderVisibility: - $ref: '#/components/schemas/Visibility' - BorderThickness: - type: string - description: String based length that is composed of value and unit in px - BorderStyle: - $ref: '#/components/schemas/PanelBorderStyle' - BorderColor: - type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ - GutterVisibility: - $ref: '#/components/schemas/Visibility' - GutterSpacing: - type: string + Padding: + $ref: '#/components/schemas/Spacing' + Height: description: String based length that is composed of value and unit in px - BackgroundVisibility: - $ref: '#/components/schemas/Visibility' - BackgroundColor: type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + BarChartFieldWells: additionalProperties: false - PanelTitleOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - HorizontalTextAlignment: - $ref: '#/components/schemas/HorizontalTextAlignment' + BarChartAggregatedFieldWells: + $ref: '#/components/schemas/BarChartAggregatedFieldWells' + GeospatialMapAggregatedFieldWells: additionalProperties: false - PaperOrientation: - type: string - enum: - - PORTRAIT - - LANDSCAPE - PaperSize: - type: string - enum: - - US_LETTER - - US_LEGAL - - US_TABLOID_LEDGER - - A0 - - A1 - - A2 - - A3 - - A4 - - A5 - - JIS_B4 - - JIS_B5 - ParameterControl: type: object properties: - DateTimePicker: - $ref: '#/components/schemas/ParameterDateTimePickerControl' - List: - $ref: '#/components/schemas/ParameterListControl' - Dropdown: - $ref: '#/components/schemas/ParameterDropDownControl' - TextField: - $ref: '#/components/schemas/ParameterTextFieldControl' - TextArea: - $ref: '#/components/schemas/ParameterTextAreaControl' - Slider: - $ref: '#/components/schemas/ParameterSliderControl' + Colors: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Geospatial: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + GeospatialNullDataSettings: additionalProperties: false - ParameterDateTimePickerControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + SymbolStyle: + $ref: '#/components/schemas/GeospatialNullSymbolStyle' required: - - ParameterControlId - - SourceParameterName - - Title + - SymbolStyle + SingleAxisOptions: additionalProperties: false - ParameterDeclaration: type: object properties: - StringParameterDeclaration: - $ref: '#/components/schemas/StringParameterDeclaration' - DecimalParameterDeclaration: - $ref: '#/components/schemas/DecimalParameterDeclaration' - IntegerParameterDeclaration: - $ref: '#/components/schemas/IntegerParameterDeclaration' - DateTimeParameterDeclaration: - $ref: '#/components/schemas/DateTimeParameterDeclaration' + YAxisOptions: + $ref: '#/components/schemas/YAxisOptions' + DateMeasureField: additionalProperties: false - ParameterDropDownControl: type: object properties: - ParameterControlId: + AggregationFunction: + $ref: '#/components/schemas/DateAggregationFunction' + FormatConfiguration: + $ref: '#/components/schemas/DateTimeFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: + required: + - Column + - FieldId + GaugeChartColorConfiguration: + additionalProperties: false + type: object + properties: + ForegroundColor: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: + BackgroundColor: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/DropDownControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/ParameterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' - required: - - ParameterControlId - - SourceParameterName - - Title + TooltipTitleType: + type: string + enum: + - NONE + - PRIMARY_VALUE + GeospatialMapVisual: additionalProperties: false - ParameterListControl: type: object properties: - ParameterControlId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + ChartConfiguration: + $ref: '#/components/schemas/GeospatialMapConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' Title: - type: string - maxLength: 2048 + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - SourceParameterName: type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/ListControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/ParameterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' + maxLength: 1024 + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - ParameterControlId - - SourceParameterName - - Title + - VisualId + DefaultPaginatedLayoutConfiguration: additionalProperties: false - ParameterSelectableValues: type: object properties: - Values: + SectionBased: + $ref: '#/components/schemas/DefaultSectionBasedLayoutConfiguration' + AnalysisSourceTemplate: + description:

The source template of an analysis.

+ additionalProperties: false + type: object + properties: + DataSetReferences: + minItems: 1 + description:

The dataset references of the source template of an analysis.

type: array items: - type: string - maxItems: 50000 + $ref: '#/components/schemas/DataSetReference' + Arn: + description:

The Amazon Resource Name (ARN) of the source template of an analysis.

+ type: string + required: + - Arn + - DataSetReferences + ChartAxisLabelOptions: + additionalProperties: false + type: object + properties: + Visibility: {} + SortIconVisibility: {} + AxisLabelOptions: minItems: 0 - LinkToDataSetColumn: - $ref: '#/components/schemas/ColumnIdentifier' + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/AxisLabelOptions' + PivotTableRowsLayout: + type: string + enum: + - TABULAR + - HIERARCHY + WaterfallChartConfiguration: additionalProperties: false - ParameterSliderControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/SliderControlDisplayOptions' - MaximumValue: - type: number - default: 0 - MinimumValue: - type: number + CategoryAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + SortConfiguration: + $ref: '#/components/schemas/WaterfallChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/WaterfallChartFieldWells' + WaterfallChartOptions: + $ref: '#/components/schemas/WaterfallChartOptions' + ColorConfiguration: + $ref: '#/components/schemas/WaterfallChartColorConfiguration' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + CategoryAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + WhatIfPointScenario: + additionalProperties: false + type: object + properties: + Value: default: 0 - StepSize: type: number - default: 0 + Date: + format: date-time + type: string required: - - MaximumValue - - MinimumValue - - ParameterControlId - - SourceParameterName - - StepSize - - Title + - Date + - Value + AnalysisDefaults: additionalProperties: false - ParameterTextAreaControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - Delimiter: - type: string - maxLength: 2048 - minLength: 1 - DisplayOptions: - $ref: '#/components/schemas/TextAreaControlDisplayOptions' + DefaultNewSheetConfiguration: + $ref: '#/components/schemas/DefaultNewSheetConfiguration' required: - - ParameterControlId - - SourceParameterName - - Title + - DefaultNewSheetConfiguration + NumericalDimensionField: additionalProperties: false - ParameterTextFieldControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 + HierarchyId: minLength: 1 - pattern: '[\w\-]+' - Title: type: string - maxLength: 2048 + maxLength: 512 + FormatConfiguration: + $ref: '#/components/schemas/NumberFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: minLength: 1 - SourceParameterName: type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/TextFieldControlDisplayOptions' + maxLength: 512 required: - - ParameterControlId - - SourceParameterName - - Title + - Column + - FieldId + TableConfiguration: additionalProperties: false - ParameterValueType: - type: string - enum: - - MULTI_VALUED - - SINGLE_VALUED - Parameters: type: object properties: - StringParameters: - type: array - items: - $ref: '#/components/schemas/StringParameter' - maxItems: 100 - minItems: 0 - IntegerParameters: - type: array - items: - $ref: '#/components/schemas/IntegerParameter' - maxItems: 100 - minItems: 0 - DecimalParameters: - type: array - items: - $ref: '#/components/schemas/DecimalParameter' - maxItems: 100 + SortConfiguration: + $ref: '#/components/schemas/TableSortConfiguration' + PaginatedReportOptions: + $ref: '#/components/schemas/TablePaginatedReportOptions' + TableOptions: + $ref: '#/components/schemas/TableOptions' + TableInlineVisualizations: minItems: 0 - DateTimeParameters: + maxItems: 200 type: array items: - $ref: '#/components/schemas/DateTimeParameter' - maxItems: 100 - minItems: 0 - additionalProperties: false - PercentVisibleRange: - type: object - properties: - From: - type: number - default: null - maximum: 100 - minimum: 0 - To: - type: number - default: null - maximum: 100 - minimum: 0 - additionalProperties: false - PercentageDisplayFormatConfiguration: - type: object - properties: - Prefix: - type: string - maxLength: 128 - minLength: 1 - Suffix: - type: string - maxLength: 128 - minLength: 1 - SeparatorConfiguration: - $ref: '#/components/schemas/NumericSeparatorConfiguration' - DecimalPlacesConfiguration: - $ref: '#/components/schemas/DecimalPlacesConfiguration' - NegativeValueConfiguration: - $ref: '#/components/schemas/NegativeValueConfiguration' - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - additionalProperties: false - PercentileAggregation: - type: object - properties: - PercentileValue: - type: number - maximum: 100 - minimum: 0 - additionalProperties: false - PeriodOverPeriodComputation: - type: object - properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - required: - - ComputationId + $ref: '#/components/schemas/TableInlineVisualization' + FieldWells: + $ref: '#/components/schemas/TableFieldWells' + FieldOptions: + $ref: '#/components/schemas/TableFieldOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + TotalOptions: + $ref: '#/components/schemas/TotalOptions' + HistogramConfiguration: additionalProperties: false - PeriodToDateComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - PeriodTimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - ComputationId + YAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + BinOptions: + $ref: '#/components/schemas/HistogramBinOptions' + FieldWells: + $ref: '#/components/schemas/HistogramFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + XAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + XAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + TreeMapAggregatedFieldWells: additionalProperties: false - PieChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Sizes: minItems: 0 - Values: + maxItems: 1 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 200 + Colors: minItems: 0 - SmallMultiples: + maxItems: 1 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + $ref: '#/components/schemas/MeasureField' + Groups: minItems: 0 - additionalProperties: false - PieChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/PieChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/PieChartSortConfiguration' - DonutOptions: - $ref: '#/components/schemas/DonutOptions' - SmallMultiplesOptions: - $ref: '#/components/schemas/SmallMultiplesOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ValueLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - ContributionAnalysisDefaults: + maxItems: 1 type: array items: - $ref: '#/components/schemas/ContributionAnalysisDefault' - maxItems: 200 - minItems: 1 + $ref: '#/components/schemas/DimensionField' + ConditionalFormattingIcon: additionalProperties: false - PieChartFieldWells: type: object properties: - PieChartAggregatedFieldWells: - $ref: '#/components/schemas/PieChartAggregatedFieldWells' + CustomCondition: + $ref: '#/components/schemas/ConditionalFormattingCustomIconCondition' + IconSet: + $ref: '#/components/schemas/ConditionalFormattingIconSet' + NumberFormatConfiguration: additionalProperties: false - PieChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - SmallMultiplesSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SmallMultiplesLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + FormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + LayoutElementType: + type: string + enum: + - VISUAL + - FILTER_CONTROL + - PARAMETER_CONTROL + - TEXT_BOX + - IMAGE + WaterfallVisual: additionalProperties: false - PieChartVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/PieChartConfiguration' + $ref: '#/components/schemas/WaterfallChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + DateTimeDefaultValues: additionalProperties: false - PivotFieldSortOptions: - type: object - properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - SortBy: - $ref: '#/components/schemas/PivotTableSortBy' - required: - - FieldId - - SortBy - additionalProperties: false - PivotTableAggregatedFieldWells: type: object properties: - Rows: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 40 - minItems: 0 - Columns: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 40 + RollingDate: + $ref: '#/components/schemas/RollingDateConfiguration' + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: minItems: 0 - Values: + maxItems: 50000 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 40 - minItems: 0 + format: date-time + type: string + ReferenceLineValueLabelRelativePosition: + type: string + enum: + - BEFORE_CUSTOM_LABEL + - AFTER_CUSTOM_LABEL + BinCountOptions: additionalProperties: false - PivotTableCellConditionalFormatting: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - TextFormat: - $ref: '#/components/schemas/TextConditionalFormat' - Scope: - $ref: '#/components/schemas/PivotTableConditionalFormattingScope' - Scopes: - type: array - items: - $ref: '#/components/schemas/PivotTableConditionalFormattingScope' - maxItems: 3 - minItems: 0 - required: - - FieldId - additionalProperties: false - PivotTableConditionalFormatting: - type: object - properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableConditionalFormattingOption' - maxItems: 100 - minItems: 0 - additionalProperties: false - PivotTableConditionalFormattingOption: - type: object - properties: - Cell: - $ref: '#/components/schemas/PivotTableCellConditionalFormatting' + Value: + type: number + minimum: 0 + PivotTableOptions: additionalProperties: false - PivotTableConditionalFormattingScope: type: object properties: - Role: - $ref: '#/components/schemas/PivotTableConditionalFormattingScopeRole' + RowFieldNamesStyle: + $ref: '#/components/schemas/TableCellStyle' + RowHeaderStyle: + $ref: '#/components/schemas/TableCellStyle' + CollapsedRowDimensionsVisibility: {} + RowsLayout: + $ref: '#/components/schemas/PivotTableRowsLayout' + MetricPlacement: + $ref: '#/components/schemas/PivotTableMetricPlacement' + DefaultCellWidth: + description: String based length that is composed of value and unit in px + type: string + ColumnNamesVisibility: {} + RowsLabelOptions: + $ref: '#/components/schemas/PivotTableRowsLabelOptions' + SingleMetricVisibility: {} + ColumnHeaderStyle: + $ref: '#/components/schemas/TableCellStyle' + ToggleButtonsVisibility: {} + CellStyle: + $ref: '#/components/schemas/TableCellStyle' + RowAlternateColorOptions: + $ref: '#/components/schemas/RowAlternateColorOptions' + PeriodToDateComputation: additionalProperties: false - PivotTableConditionalFormattingScopeRole: - type: string - enum: - - FIELD - - FIELD_TOTAL - - GRAND_TOTAL - PivotTableConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/PivotTableFieldWells' - SortConfiguration: - $ref: '#/components/schemas/PivotTableSortConfiguration' - TableOptions: - $ref: '#/components/schemas/PivotTableOptions' - TotalOptions: - $ref: '#/components/schemas/PivotTableTotalOptions' - FieldOptions: - $ref: '#/components/schemas/PivotTableFieldOptions' - PaginatedReportOptions: - $ref: '#/components/schemas/PivotTablePaginatedReportOptions' + PeriodTimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string + required: + - ComputationId + TableAggregatedFieldWells: additionalProperties: false - PivotTableDataPathOption: type: object properties: - DataPathList: + GroupBy: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/DataPathValue' - maxItems: 20 + $ref: '#/components/schemas/DimensionField' + Values: minItems: 0 - Width: - type: string - description: String based length that is composed of value and unit in px - required: - - DataPathList + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + ReferenceLineStaticDataConfiguration: additionalProperties: false - PivotTableDataPathType: - type: string - enum: - - HIERARCHY_ROWS_LAYOUT_COLUMN - - MULTIPLE_ROW_METRICS_COLUMN - - EMPTY_COLUMN_HEADER - - COUNT_METRIC_COLUMN - PivotTableFieldCollapseState: + type: object + properties: + Value: + default: 0 + type: number + required: + - Value + DayOfTheWeek: type: string enum: - - COLLAPSED - - EXPANDED - PivotTableFieldCollapseStateOption: + - SUNDAY + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + TopBottomRankedComputation: + additionalProperties: false type: object properties: - Target: - $ref: '#/components/schemas/PivotTableFieldCollapseStateTarget' - State: - $ref: '#/components/schemas/PivotTableFieldCollapseState' + Type: + $ref: '#/components/schemas/TopBottomComputationType' + Category: + $ref: '#/components/schemas/DimensionField' + ResultSize: + default: 0 + maximum: 20 + type: number + minimum: 1 + Value: + $ref: '#/components/schemas/MeasureField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string required: - - Target + - ComputationId + - Type + BodySectionDynamicNumericDimensionConfiguration: additionalProperties: false - PivotTableFieldCollapseStateTarget: type: object properties: - FieldId: - type: string - FieldDataPathValues: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + SortByMetrics: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/DataPathValue' - maxItems: 20 - minItems: 0 + $ref: '#/components/schemas/ColumnSort' + Limit: + maximum: 1000 + type: number + minimum: 1 + required: + - Column + ParameterSliderControl: additionalProperties: false - PivotTableFieldOption: type: object properties: - FieldId: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + StepSize: + default: 0 + type: number + DisplayOptions: + $ref: '#/components/schemas/SliderControlDisplayOptions' + SourceParameterName: minLength: 1 - CustomLabel: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 + Title: minLength: 1 - Visibility: - $ref: '#/components/schemas/Visibility' + type: string + maxLength: 2048 + MaximumValue: + default: 0 + type: number + MinimumValue: + default: 0 + type: number required: - - FieldId - additionalProperties: false - PivotTableFieldOptions: - type: object - properties: - SelectedFieldOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableFieldOption' - maxItems: 100 - minItems: 0 - DataPathOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableDataPathOption' - maxItems: 100 - minItems: 0 - CollapseStateOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableFieldCollapseStateOption' + - MaximumValue + - MinimumValue + - ParameterControlId + - SourceParameterName + - StepSize + - Title + NegativeValueDisplayMode: + type: string + enum: + - POSITIVE + - NEGATIVE + ColorFillType: + type: string + enum: + - DISCRETE + - GRADIENT + SheetImageStaticFileSource: additionalProperties: false - PivotTableFieldSubtotalOptions: type: object properties: - FieldId: + StaticFileId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 + required: + - StaticFileId + TableFieldCustomIconContent: additionalProperties: false - PivotTableFieldWells: type: object properties: - PivotTableAggregatedFieldWells: - $ref: '#/components/schemas/PivotTableAggregatedFieldWells' + Icon: + $ref: '#/components/schemas/TableFieldIconSetType' + TableFieldURLConfiguration: additionalProperties: false - PivotTableMetricPlacement: - type: string - enum: - - ROW - - COLUMN - PivotTableOptions: type: object properties: - MetricPlacement: - $ref: '#/components/schemas/PivotTableMetricPlacement' - SingleMetricVisibility: - $ref: '#/components/schemas/Visibility' - ColumnNamesVisibility: - $ref: '#/components/schemas/Visibility' - ToggleButtonsVisibility: - $ref: '#/components/schemas/Visibility' - ColumnHeaderStyle: - $ref: '#/components/schemas/TableCellStyle' - RowHeaderStyle: - $ref: '#/components/schemas/TableCellStyle' - CellStyle: - $ref: '#/components/schemas/TableCellStyle' - RowFieldNamesStyle: - $ref: '#/components/schemas/TableCellStyle' - RowAlternateColorOptions: - $ref: '#/components/schemas/RowAlternateColorOptions' - CollapsedRowDimensionsVisibility: - $ref: '#/components/schemas/Visibility' - RowsLayout: - $ref: '#/components/schemas/PivotTableRowsLayout' - RowsLabelOptions: - $ref: '#/components/schemas/PivotTableRowsLabelOptions' - DefaultCellWidth: - type: string - description: String based length that is composed of value and unit in px - additionalProperties: false - PivotTablePaginatedReportOptions: - type: object - properties: - VerticalOverflowVisibility: - $ref: '#/components/schemas/Visibility' - OverflowColumnHeaderVisibility: - $ref: '#/components/schemas/Visibility' + LinkConfiguration: + $ref: '#/components/schemas/TableFieldLinkConfiguration' + ImageConfiguration: + $ref: '#/components/schemas/TableFieldImageConfiguration' + SheetControlInfoIconLabelOptions: additionalProperties: false - PivotTableRowsLabelOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - CustomLabel: - type: string - maxLength: 1024 + Visibility: {} + InfoIconText: minLength: 1 + type: string + maxLength: 100 + VisualPalette: additionalProperties: false - PivotTableRowsLayout: - type: string - enum: - - TABULAR - - HIERARCHY - PivotTableSortBy: - type: object - properties: - Field: - $ref: '#/components/schemas/FieldSort' - Column: - $ref: '#/components/schemas/ColumnSort' - DataPath: - $ref: '#/components/schemas/DataPathSort' - additionalProperties: false - PivotTableSortConfiguration: type: object properties: - FieldSortOptions: + ChartColor: + pattern: ^#[A-F0-9]{6}$ + type: string + ColorMap: + minItems: 0 + maxItems: 5000 type: array items: - $ref: '#/components/schemas/PivotFieldSortOptions' - maxItems: 200 - minItems: 0 - additionalProperties: false - PivotTableSubtotalLevel: + $ref: '#/components/schemas/DataPathColor' + MissingDataTreatmentOption: type: string enum: - - ALL - - CUSTOM - - LAST - PivotTableTotalOptions: + - INTERPOLATE + - SHOW_AS_ZERO + - SHOW_AS_BLANK + ReferenceLineLabelVerticalPosition: + type: string + enum: + - ABOVE + - BELOW + ItemsLimitConfiguration: + additionalProperties: false type: object properties: - RowSubtotalOptions: - $ref: '#/components/schemas/SubtotalOptions' - ColumnSubtotalOptions: - $ref: '#/components/schemas/SubtotalOptions' - RowTotalOptions: - $ref: '#/components/schemas/PivotTotalOptions' - ColumnTotalOptions: - $ref: '#/components/schemas/PivotTotalOptions' + ItemsLimit: + default: null + type: number + OtherCategories: + $ref: '#/components/schemas/OtherCategories' + FilterTextFieldControl: additionalProperties: false - PivotTableVisual: type: object properties: - VisualId: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + DisplayOptions: + $ref: '#/components/schemas/TextFieldControlDisplayOptions' Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/PivotTableConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/PivotTableConditionalFormatting' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + minLength: 1 + type: string + maxLength: 2048 + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - VisualId + - FilterControlId + - SourceFilterId + - Title + TablePinnedFieldOptions: additionalProperties: false - PivotTotalOptions: type: object properties: - TotalsVisibility: - $ref: '#/components/schemas/Visibility' - TotalAggregationOptions: + PinnedLeftFields: + minItems: 0 + maxItems: 201 type: array items: - $ref: '#/components/schemas/TotalAggregationOption' - maxItems: 200 - minItems: 0 - Placement: - $ref: '#/components/schemas/TableTotalsPlacement' - ScrollStatus: - $ref: '#/components/schemas/TableTotalsScrollStatus' - CustomLabel: - type: string - TotalCellStyle: - $ref: '#/components/schemas/TableCellStyle' - ValueCellStyle: - $ref: '#/components/schemas/TableCellStyle' - MetricHeaderCellStyle: - $ref: '#/components/schemas/TableCellStyle' + minLength: 1 + type: string + maxLength: 512 + OtherCategories: + type: string + enum: + - INCLUDE + - EXCLUDE + TimeEqualityFilter: additionalProperties: false - PredefinedHierarchy: type: object properties: - HierarchyId: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RollingDate: + $ref: '#/components/schemas/RollingDateConfiguration' + Value: + format: date-time type: string - maxLength: 512 + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ParameterName: minLength: 1 - Columns: - type: array - items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 10 - minItems: 1 - DrillDownFilters: - type: array - items: - $ref: '#/components/schemas/DrillDownFilter' - maxItems: 10 - minItems: 0 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - Columns - - HierarchyId + - Column + - FilterId + NumericFormatConfiguration: additionalProperties: false - PrimaryValueDisplayType: - type: string - enum: - - HIDDEN - - COMPARISON - - ACTUAL - ProgressBarOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + NumberDisplayFormatConfiguration: + $ref: '#/components/schemas/NumberDisplayFormatConfiguration' + CurrencyDisplayFormatConfiguration: + $ref: '#/components/schemas/CurrencyDisplayFormatConfiguration' + PercentageDisplayFormatConfiguration: + $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + DataPathColor: additionalProperties: false - RadarChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 + Element: + $ref: '#/components/schemas/DataPathValue' Color: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 20 - minItems: 0 - additionalProperties: false - RadarChartAreaStyleSettings: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' + pattern: ^#[A-F0-9]{6}$ + type: string + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + required: + - Color + - Element + CustomContentConfiguration: additionalProperties: false - RadarChartAxesRangeScale: - type: string - enum: - - AUTO - - INDEPENDENT - - SHARED - RadarChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/RadarChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/RadarChartSortConfiguration' - Shape: - $ref: '#/components/schemas/RadarChartShape' - BaseSeriesSettings: - $ref: '#/components/schemas/RadarChartSeriesSettings' - StartAngle: - type: number - maximum: 360 - minimum: -360 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - AlternateBandColorsVisibility: - $ref: '#/components/schemas/Visibility' - AlternateBandEvenColor: - type: string - pattern: ^#[A-F0-9]{6}$ - AlternateBandOddColor: + ContentUrl: + minLength: 1 type: string - pattern: ^#[A-F0-9]{6}$ - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - AxesRangeScale: - $ref: '#/components/schemas/RadarChartAxesRangeScale' - additionalProperties: false - RadarChartFieldWells: - type: object - properties: - RadarChartAggregatedFieldWells: - $ref: '#/components/schemas/RadarChartAggregatedFieldWells' + maxLength: 2048 + ContentType: + $ref: '#/components/schemas/CustomContentType' + ImageScaling: + $ref: '#/components/schemas/CustomContentImageScalingConfiguration' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + MapZoomMode: + type: string + enum: + - AUTO + - MANUAL + SheetControlListType: + type: string + enum: + - MULTI_SELECT + - SINGLE_SELECT + ArcThicknessOptions: + type: string + enum: + - SMALL + - MEDIUM + - LARGE + PivotTableDataPathType: + type: string + enum: + - HIERARCHY_ROWS_LAYOUT_COLUMN + - MULTIPLE_ROW_METRICS_COLUMN + - EMPTY_COLUMN_HEADER + - COUNT_METRIC_COLUMN + RadarChartAxesRangeScale: + type: string + enum: + - AUTO + - INDEPENDENT + - SHARED + GeospatialLineSymbolStyle: additionalProperties: false - RadarChartSeriesSettings: type: object properties: - AreaStyleSettings: - $ref: '#/components/schemas/RadarChartAreaStyleSettings' + FillColor: + $ref: '#/components/schemas/GeospatialColor' + LineWidth: + $ref: '#/components/schemas/GeospatialLineWidth' + ConditionalFormattingCustomIconCondition: additionalProperties: false - RadarChartShape: - type: string - enum: - - CIRCLE - - POLYGON - RadarChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - ColorItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + Expression: + minLength: 1 + type: string + maxLength: 4096 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + DisplayConfiguration: + $ref: '#/components/schemas/ConditionalFormattingIconDisplayConfiguration' + IconOptions: + $ref: '#/components/schemas/ConditionalFormattingCustomIconOptions' + required: + - Expression + - IconOptions + FilterTextAreaControl: additionalProperties: false - RadarChartVisual: type: object properties: - VisualId: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Delimiter: minLength: 1 - pattern: '[\w\-]+' + type: string + maxLength: 2048 + DisplayOptions: + $ref: '#/components/schemas/TextAreaControlDisplayOptions' Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' + minLength: 1 + type: string + maxLength: 2048 + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - FilterControlId + - SourceFilterId + - Title + BaseMapStyleType: + type: string + enum: + - LIGHT_GRAY + - DARK_GRAY + - STREET + - IMAGERY + InsightVisual: + additionalProperties: false + type: object + properties: Subtitle: $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/RadarChartConfiguration' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 minItems: 0 - ColumnHierarchies: + maxItems: 10 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + $ref: '#/components/schemas/VisualCustomAction' + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + InsightConfiguration: + $ref: '#/components/schemas/InsightConfiguration' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 required: + - DataSetIdentifier - VisualId + TableSortConfiguration: additionalProperties: false - RangeEndsLabelType: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + RowSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + PaginationConfiguration: + $ref: '#/components/schemas/PaginationConfiguration' + FreeFormLayoutScreenCanvasSizeOptions: additionalProperties: false - ReferenceLine: type: object properties: - Status: - $ref: '#/components/schemas/WidgetStatus' - DataConfiguration: - $ref: '#/components/schemas/ReferenceLineDataConfiguration' - StyleConfiguration: - $ref: '#/components/schemas/ReferenceLineStyleConfiguration' - LabelConfiguration: - $ref: '#/components/schemas/ReferenceLineLabelConfiguration' + OptimizedViewPortWidth: + description: String based length that is composed of value and unit in px + type: string required: - - DataConfiguration + - OptimizedViewPortWidth + ContributionAnalysisDefault: additionalProperties: false - ReferenceLineCustomLabelConfiguration: type: object properties: - CustomLabel: + MeasureFieldId: + minLength: 1 type: string - pattern: .*\S.* + maxLength: 512 + ContributorDimensions: + minItems: 1 + maxItems: 4 + type: array + items: + $ref: '#/components/schemas/ColumnIdentifier' required: - - CustomLabel + - ContributorDimensions + - MeasureFieldId + GradientColor: additionalProperties: false - ReferenceLineDataConfiguration: type: object properties: - StaticConfiguration: - $ref: '#/components/schemas/ReferenceLineStaticDataConfiguration' - DynamicConfiguration: - $ref: '#/components/schemas/ReferenceLineDynamicDataConfiguration' - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - SeriesType: - $ref: '#/components/schemas/ReferenceLineSeriesType' + Stops: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/GradientStop' + TableFieldImageConfiguration: additionalProperties: false - ReferenceLineDynamicDataConfiguration: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - MeasureAggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - Calculation: - $ref: '#/components/schemas/NumericalAggregationFunction' - required: - - Calculation - - Column + SizingOptions: + $ref: '#/components/schemas/TableCellImageSizingConfiguration' + GaugeChartConditionalFormattingOption: additionalProperties: false - ReferenceLineLabelConfiguration: type: object properties: - ValueLabelConfiguration: - $ref: '#/components/schemas/ReferenceLineValueLabelConfiguration' - CustomLabelConfiguration: - $ref: '#/components/schemas/ReferenceLineCustomLabelConfiguration' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - FontColor: - type: string - pattern: ^#[A-F0-9]{6}$ - HorizontalPosition: - $ref: '#/components/schemas/ReferenceLineLabelHorizontalPosition' - VerticalPosition: - $ref: '#/components/schemas/ReferenceLineLabelVerticalPosition' - additionalProperties: false - ReferenceLineLabelHorizontalPosition: - type: string - enum: - - LEFT - - CENTER - - RIGHT - ReferenceLineLabelVerticalPosition: - type: string - enum: - - ABOVE - - BELOW - ReferenceLinePatternType: - type: string - enum: - - SOLID - - DASHED - - DOTTED - ReferenceLineSeriesType: - type: string - enum: - - BAR - - LINE - ReferenceLineStaticDataConfiguration: - type: object - properties: - Value: - type: number - default: 0 - required: - - Value - additionalProperties: false - ReferenceLineStyleConfiguration: - type: object - properties: - Pattern: - $ref: '#/components/schemas/ReferenceLinePatternType' - Color: - type: string - pattern: ^#[A-F0-9]{6}$ + Arc: + $ref: '#/components/schemas/GaugeChartArcConditionalFormatting' + PrimaryValue: + $ref: '#/components/schemas/GaugeChartPrimaryValueConditionalFormatting' + PieChartFieldWells: additionalProperties: false - ReferenceLineValueLabelConfiguration: type: object properties: - RelativePosition: - $ref: '#/components/schemas/ReferenceLineValueLabelRelativePosition' - FormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' + PieChartAggregatedFieldWells: + $ref: '#/components/schemas/PieChartAggregatedFieldWells' + VisualCustomAction: additionalProperties: false - ReferenceLineValueLabelRelativePosition: - type: string - enum: - - BEFORE_CUSTOM_LABEL - - AFTER_CUSTOM_LABEL - RelativeDateTimeControlDisplayOptions: type: object properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - DateTimeFormat: + Status: + $ref: '#/components/schemas/WidgetStatus' + Trigger: + $ref: '#/components/schemas/VisualCustomActionTrigger' + CustomActionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - maxLength: 128 + maxLength: 512 + Name: minLength: 1 - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + type: string + maxLength: 256 + ActionOperations: + minItems: 1 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/VisualCustomActionOperation' + required: + - ActionOperations + - CustomActionId + - Name + - Trigger + TopBottomFilter: additionalProperties: false - RelativeDateType: - type: string - enum: - - PREVIOUS - - THIS - - LAST - - NOW - - NEXT - RelativeDatesFilter: type: object properties: - FilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + AggregationSortConfigurations: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/AggregationSortConfiguration' Column: $ref: '#/components/schemas/ColumnIdentifier' - AnchorDateConfiguration: - $ref: '#/components/schemas/AnchorDateConfiguration' - MinimumGranularity: - $ref: '#/components/schemas/TimeGranularity' TimeGranularity: $ref: '#/components/schemas/TimeGranularity' - RelativeDateType: - $ref: '#/components/schemas/RelativeDateType' - RelativeDateValue: - type: number - default: null ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 + Limit: + default: null + type: number + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - NullOption: - $ref: '#/components/schemas/FilterNullOption' - ExcludePeriodConfiguration: - $ref: '#/components/schemas/ExcludePeriodConfiguration' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - AnchorDateConfiguration + - AggregationSortConfigurations - Column - FilterId - - NullOption - - RelativeDateType - - TimeGranularity + KPIConfiguration: additionalProperties: false - RelativeFontSize: - type: string - enum: - - EXTRA_SMALL - - SMALL - - MEDIUM - - LARGE - - EXTRA_LARGE - ResizeOption: + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/KPISortConfiguration' + KPIOptions: + $ref: '#/components/schemas/KPIOptions' + FieldWells: + $ref: '#/components/schemas/KPIFieldWells' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + PivotTableFieldCollapseState: type: string enum: - - FIXED - - RESPONSIVE - ResourcePermission: + - COLLAPSED + - EXPANDED + MinimumLabelType: + additionalProperties: false type: object properties: - Principal: + Visibility: {} + CategoryFilterConfiguration: + additionalProperties: false + type: object + properties: + CustomFilterListConfiguration: + $ref: '#/components/schemas/CustomFilterListConfiguration' + CustomFilterConfiguration: + $ref: '#/components/schemas/CustomFilterConfiguration' + FilterListConfiguration: + $ref: '#/components/schemas/FilterListConfiguration' + GeospatialSolidColor: + description: Describes the properties for a solid color + additionalProperties: false + type: object + properties: + State: {} + Color: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string - maxLength: 256 - minLength: 1 - Actions: - type: array - items: - type: string - maxItems: 20 - minItems: 1 required: - - Actions - - Principal + - Color + NumericEqualityDrillDownFilter: additionalProperties: false - ResourceStatus: + type: object + properties: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + Value: + default: 0 + type: number + required: + - Column + - Value + TimeGranularity: type: string enum: - - CREATION_IN_PROGRESS - - CREATION_SUCCESSFUL - - CREATION_FAILED - - UPDATE_IN_PROGRESS - - UPDATE_SUCCESSFUL - - UPDATE_FAILED - - DELETED - RollingDateConfiguration: + - YEAR + - QUARTER + - MONTH + - WEEK + - DAY + - HOUR + - MINUTE + - SECOND + - MILLISECOND + GaugeChartVisual: + additionalProperties: false type: object properties: - DataSetIdentifier: - type: string - maxLength: 2048 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/GaugeChartConditionalFormatting' + VisualId: minLength: 1 - Expression: + pattern: ^[\w\-]+$ type: string - maxLength: 4096 + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/GaugeChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 + type: string + maxLength: 1024 required: - - Expression + - VisualId + FilledMapConfiguration: additionalProperties: false - RowAlternateColorOptions: type: object properties: - Status: - $ref: '#/components/schemas/WidgetStatus' - RowAlternateColors: - type: array - items: - type: string - pattern: ^#[A-F0-9]{6}$ - maxItems: 1 - minItems: 0 - UsePrimaryBackgroundColor: - $ref: '#/components/schemas/WidgetStatus' + SortConfiguration: + $ref: '#/components/schemas/FilledMapSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + MapStyleOptions: + $ref: '#/components/schemas/GeospatialMapStyleOptions' + FieldWells: + $ref: '#/components/schemas/FilledMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + WindowOptions: + $ref: '#/components/schemas/GeospatialWindowOptions' + VisibleRangeOptions: additionalProperties: false - SameSheetTargetVisualConfiguration: type: object properties: - TargetVisuals: - type: array - items: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - maxItems: 50 - minItems: 1 - TargetVisualOptions: - $ref: '#/components/schemas/TargetVisualOptions' + PercentRange: + $ref: '#/components/schemas/PercentVisibleRange' + ForecastComputationSeasonality: + type: string + enum: + - AUTOMATIC + - CUSTOM + KPIComparisonValueConditionalFormatting: additionalProperties: false - SankeyDiagramAggregatedFieldWells: type: object properties: - Source: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Destination: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Weight: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + RangeEndsLabelType: additionalProperties: false - SankeyDiagramChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/SankeyDiagramFieldWells' - SortConfiguration: - $ref: '#/components/schemas/SankeyDiagramSortConfiguration' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' + Visibility: {} + LegendOptions: additionalProperties: false - SankeyDiagramFieldWells: type: object properties: - SankeyDiagramAggregatedFieldWells: - $ref: '#/components/schemas/SankeyDiagramAggregatedFieldWells' + Position: + $ref: '#/components/schemas/LegendPosition' + ValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + Title: + $ref: '#/components/schemas/LabelOptions' + Visibility: {} + Height: + description: String based length that is composed of value and unit in px + type: string + Width: + description: String based length that is composed of value and unit in px + type: string + ShortFormatText: additionalProperties: false - SankeyDiagramSortConfiguration: type: object properties: - WeightSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SourceItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - DestinationItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + RichText: + minLength: 1 + type: string + maxLength: 1024 + PlainText: + minLength: 1 + type: string + maxLength: 512 + PieChartVisual: additionalProperties: false - SankeyDiagramVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/SankeyDiagramChartConfiguration' + $ref: '#/components/schemas/PieChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + ColumnHierarchies: minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - VisualId + ComparisonConfiguration: additionalProperties: false - ScatterPlotCategoricallyAggregatedFieldWells: type: object properties: - XAxis: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - YAxis: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Size: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - Label: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 + ComparisonMethod: + $ref: '#/components/schemas/ComparisonMethod' + ComparisonFormat: + $ref: '#/components/schemas/ComparisonFormatConfiguration' + ConditionalFormattingGradientColor: additionalProperties: false - ScatterPlotConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/ScatterPlotFieldWells' - XAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - XAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - YAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - YAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + Expression: + minLength: 1 + type: string + maxLength: 4096 + Color: + $ref: '#/components/schemas/GradientColor' + required: + - Color + - Expression + GeospatialCircleRadius: additionalProperties: false - ScatterPlotFieldWells: type: object properties: - ScatterPlotCategoricallyAggregatedFieldWells: - $ref: '#/components/schemas/ScatterPlotCategoricallyAggregatedFieldWells' - ScatterPlotUnaggregatedFieldWells: - $ref: '#/components/schemas/ScatterPlotUnaggregatedFieldWells' + Radius: + type: number + minimum: 0 + TableFieldCustomTextContent: additionalProperties: false - ScatterPlotUnaggregatedFieldWells: type: object properties: - XAxis: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - YAxis: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Size: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + Value: + type: string + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + required: + - FontConfiguration + ArcConfiguration: + additionalProperties: false + type: object + properties: + ArcAngle: + default: null + type: number + ArcThickness: + $ref: '#/components/schemas/ArcThicknessOptions' + LineChartSortConfiguration: + additionalProperties: false + type: object + properties: + CategoryItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + ColorItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + SmallMultiplesSort: minItems: 0 - Category: + maxItems: 100 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/FieldSortOptions' + CategorySort: minItems: 0 - Label: + maxItems: 100 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 + $ref: '#/components/schemas/FieldSortOptions' + SmallMultiplesLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + TotalAggregationComputation: additionalProperties: false - ScatterPlotVisual: type: object properties: - VisualId: + Value: + $ref: '#/components/schemas/MeasureField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/ScatterPlotConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + Name: + type: string + required: + - ComputationId + DateTimeParameterDeclaration: + additionalProperties: false + type: object + properties: + MappedDataSetParameters: minItems: 0 - ColumnHierarchies: + maxItems: 150 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/DateTimeDefaultValues' + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ValueWhenUnset: + $ref: '#/components/schemas/DateTimeValueWhenUnsetConfiguration' + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 required: - - VisualId + - Name + ParameterTextAreaControl: additionalProperties: false - ScrollBarOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - VisibleRange: - $ref: '#/components/schemas/VisibleRangeOptions' + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Delimiter: + minLength: 1 + type: string + maxLength: 2048 + DisplayOptions: + $ref: '#/components/schemas/TextAreaControlDisplayOptions' + SourceParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + Title: + minLength: 1 + type: string + maxLength: 2048 + required: + - ParameterControlId + - SourceParameterName + - Title + TableCellStyle: additionalProperties: false - SecondaryValueOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + VerticalTextAlignment: + $ref: '#/components/schemas/VerticalTextAlignment' + Visibility: {} + Height: + maximum: 500 + type: number + minimum: 8 + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + Border: + $ref: '#/components/schemas/GlobalTableBorderOptions' + TextWrap: + $ref: '#/components/schemas/TextWrap' + HorizontalTextAlignment: + $ref: '#/components/schemas/HorizontalTextAlignment' + BackgroundColor: + pattern: ^#[A-F0-9]{6}$ + type: string + IntegerValueWhenUnsetConfiguration: additionalProperties: false - SectionAfterPageBreak: type: object properties: - Status: - $ref: '#/components/schemas/SectionPageBreakStatus' + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + default: null + type: number + PaperSize: + type: string + enum: + - US_LETTER + - US_LEGAL + - US_TABLOID_LEDGER + - A0 + - A1 + - A2 + - A3 + - A4 + - A5 + - JIS_B4 + - JIS_B5 + ReferenceLine: additionalProperties: false - SectionBasedLayoutCanvasSizeOptions: type: object properties: - PaperCanvasSizeOptions: - $ref: '#/components/schemas/SectionBasedLayoutPaperCanvasSizeOptions' + Status: + $ref: '#/components/schemas/WidgetStatus' + DataConfiguration: + $ref: '#/components/schemas/ReferenceLineDataConfiguration' + LabelConfiguration: + $ref: '#/components/schemas/ReferenceLineLabelConfiguration' + StyleConfiguration: + $ref: '#/components/schemas/ReferenceLineStyleConfiguration' + required: + - DataConfiguration + HistogramAggregatedFieldWells: additionalProperties: false - SectionBasedLayoutConfiguration: type: object properties: - HeaderSections: - type: array - items: - $ref: '#/components/schemas/HeaderFooterSectionConfiguration' - maxItems: 1 - minItems: 0 - BodySections: - type: array - items: - $ref: '#/components/schemas/BodySectionConfiguration' - maxItems: 28 + Values: minItems: 0 - FooterSections: + maxItems: 1 type: array items: - $ref: '#/components/schemas/HeaderFooterSectionConfiguration' - maxItems: 1 - minItems: 0 - CanvasSizeOptions: - $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' - required: - - BodySections - - CanvasSizeOptions - - FooterSections - - HeaderSections + $ref: '#/components/schemas/MeasureField' + ColumnIdentifier: additionalProperties: false - SectionBasedLayoutPaperCanvasSizeOptions: type: object properties: - PaperSize: - $ref: '#/components/schemas/PaperSize' - PaperOrientation: - $ref: '#/components/schemas/PaperOrientation' - PaperMargin: - $ref: '#/components/schemas/Spacing' + ColumnName: + minLength: 1 + type: string + maxLength: 127 + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + required: + - ColumnName + - DataSetIdentifier + PivotTableConfiguration: additionalProperties: false - SectionLayoutConfiguration: type: object properties: - FreeFormLayout: - $ref: '#/components/schemas/FreeFormSectionLayoutConfiguration' - required: - - FreeFormLayout + SortConfiguration: + $ref: '#/components/schemas/PivotTableSortConfiguration' + PaginatedReportOptions: + $ref: '#/components/schemas/PivotTablePaginatedReportOptions' + TableOptions: + $ref: '#/components/schemas/PivotTableOptions' + FieldWells: + $ref: '#/components/schemas/PivotTableFieldWells' + FieldOptions: + $ref: '#/components/schemas/PivotTableFieldOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + TotalOptions: + $ref: '#/components/schemas/PivotTableTotalOptions' + GeospatialMapState: additionalProperties: false - SectionPageBreakConfiguration: type: object properties: - After: - $ref: '#/components/schemas/SectionAfterPageBreak' + Bounds: + $ref: '#/components/schemas/GeospatialCoordinateBounds' + MapNavigation: + $ref: '#/components/schemas/GeospatialMapNavigation' + LoadingAnimation: additionalProperties: false - SectionPageBreakStatus: - type: string - enum: - - ENABLED - - DISABLED - SectionStyle: type: object properties: - Height: - type: string - description: String based length that is composed of value and unit in px - Padding: - $ref: '#/components/schemas/Spacing' + Visibility: {} + TotalOptions: additionalProperties: false - SelectAllValueOptions: - type: string - enum: - - ALL_VALUES - SelectedFieldOptions: - type: string - enum: - - ALL_FIELDS - SelectedSheetsFilterScopeConfiguration: type: object properties: - SheetVisualScopingConfigurations: + TotalAggregationOptions: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/SheetVisualScopingConfiguration' - maxItems: 50 - minItems: 1 + $ref: '#/components/schemas/TotalAggregationOption' + CustomLabel: + type: string + ScrollStatus: + $ref: '#/components/schemas/TableTotalsScrollStatus' + Placement: + $ref: '#/components/schemas/TableTotalsPlacement' + TotalCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalsVisibility: {} + ForecastScenario: additionalProperties: false - SelectedTooltipType: - type: string - enum: - - BASIC - - DETAILED - SeriesItem: type: object properties: - FieldSeriesItem: - $ref: '#/components/schemas/FieldSeriesItem' - DataFieldSeriesItem: - $ref: '#/components/schemas/DataFieldSeriesItem' + WhatIfRangeScenario: + $ref: '#/components/schemas/WhatIfRangeScenario' + WhatIfPointScenario: + $ref: '#/components/schemas/WhatIfPointScenario' + RowAlternateColorOptions: additionalProperties: false - SetParameterValueConfiguration: type: object properties: - DestinationParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - Value: - $ref: '#/components/schemas/DestinationParameterValueConfiguration' - required: - - DestinationParameterName - - Value + Status: + $ref: '#/components/schemas/WidgetStatus' + UsePrimaryBackgroundColor: + $ref: '#/components/schemas/WidgetStatus' + RowAlternateColors: + minItems: 0 + maxItems: 1 + type: array + items: + pattern: ^#[A-F0-9]{6}$ + type: string + DefaultRelativeDateTimeControlOptions: additionalProperties: false - ShapeConditionalFormat: type: object properties: - BackgroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - required: - - BackgroundColor + DisplayOptions: + $ref: '#/components/schemas/RelativeDateTimeControlDisplayOptions' + CommitMode: + $ref: '#/components/schemas/CommitMode' + SectionPageBreakConfiguration: additionalProperties: false - Sheet: type: object properties: - SheetId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - maxLength: 2048 - minLength: 1 - additionalProperties: false + After: + $ref: '#/components/schemas/SectionAfterPageBreak' SheetContentType: type: string enum: - PAGINATED - INTERACTIVE - SheetControlDateTimePickerType: - type: string - enum: - - SINGLE_VALUED - - DATE_RANGE - SheetControlInfoIconLabelOptions: + TextControlPlaceholderOptions: + additionalProperties: false type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - InfoIconText: - type: string - maxLength: 100 - minLength: 1 + Visibility: {} + DonutOptions: additionalProperties: false - SheetControlLayout: type: object properties: - Configuration: - $ref: '#/components/schemas/SheetControlLayoutConfiguration' - required: - - Configuration + DonutCenterOptions: + $ref: '#/components/schemas/DonutCenterOptions' + ArcOptions: + $ref: '#/components/schemas/ArcOptions' + TableInlineVisualization: additionalProperties: false - SheetControlLayoutConfiguration: type: object properties: - GridLayout: - $ref: '#/components/schemas/GridLayoutConfiguration' + DataBars: + $ref: '#/components/schemas/DataBarsOptions' + CustomActionFilterOperation: additionalProperties: false - SheetControlListType: - type: string - enum: - - MULTI_SELECT - - SINGLE_SELECT - SheetControlSliderType: - type: string - enum: - - SINGLE_POINT - - RANGE - SheetDefinition: type: object properties: - SheetId: + SelectedFieldsConfiguration: + $ref: '#/components/schemas/FilterOperationSelectedFieldsConfiguration' + TargetVisualsConfiguration: + $ref: '#/components/schemas/FilterOperationTargetVisualsConfiguration' + required: + - SelectedFieldsConfiguration + - TargetVisualsConfiguration + RadarChartVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + ChartConfiguration: + $ref: '#/components/schemas/RadarChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 type: string maxLength: 1024 + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + CalculatedField: + additionalProperties: false + type: object + properties: + Expression: minLength: 1 - Description: type: string - maxLength: 1024 + maxLength: 32000 + DataSetIdentifier: minLength: 1 - Name: type: string maxLength: 2048 + Name: minLength: 1 - ParameterControls: - type: array - items: - $ref: '#/components/schemas/ParameterControl' - maxItems: 200 - minItems: 0 - FilterControls: - type: array - items: - $ref: '#/components/schemas/FilterControl' - maxItems: 200 - minItems: 0 - Visuals: - type: array - items: - $ref: '#/components/schemas/Visual' - maxItems: 50 + type: string + maxLength: 127 + required: + - DataSetIdentifier + - Expression + - Name + ValidationStrategyMode: + type: string + enum: + - STRICT + - LENIENT + WaterfallChartSortConfiguration: + additionalProperties: false + type: object + properties: + BreakdownItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: minItems: 0 - TextBoxes: - type: array - items: - $ref: '#/components/schemas/SheetTextBox' maxItems: 100 - minItems: 0 - Layouts: - type: array - items: - $ref: '#/components/schemas/Layout' - maxItems: 1 - minItems: 1 - SheetControlLayouts: type: array items: - $ref: '#/components/schemas/SheetControlLayout' - maxItems: 1 - minItems: 0 - ContentType: - $ref: '#/components/schemas/SheetContentType' - required: - - SheetId + $ref: '#/components/schemas/FieldSortOptions' + ColumnHierarchy: additionalProperties: false - SheetElementConfigurationOverrides: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + DateTimeHierarchy: + $ref: '#/components/schemas/DateTimeHierarchy' + ExplicitHierarchy: + $ref: '#/components/schemas/ExplicitHierarchy' + PredefinedHierarchy: + $ref: '#/components/schemas/PredefinedHierarchy' + NestedFilter: additionalProperties: false - SheetElementRenderingRule: type: object properties: - Expression: - type: string - maxLength: 4096 + Column: + $ref: '#/components/schemas/ColumnIdentifier' + InnerFilter: + $ref: '#/components/schemas/InnerFilter' + IncludeInnerSet: + default: false + type: boolean + FilterId: minLength: 1 - ConfigurationOverrides: - $ref: '#/components/schemas/SheetElementConfigurationOverrides' - required: - - ConfigurationOverrides - - Expression - additionalProperties: false - SheetTextBox: - type: object - properties: - SheetTextBoxId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Content: - type: string - maxLength: 150000 - minLength: 0 required: - - SheetTextBoxId + - Column + - FilterId + - IncludeInnerSet + - InnerFilter + StringParameter: + description:

A string parameter.

additionalProperties: false - SheetVisualScopingConfiguration: type: object properties: - SheetId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Scope: - $ref: '#/components/schemas/FilterVisualScope' - VisualIds: + Values: + description:

The values of a string parameter.

type: array items: type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - maxItems: 50 - minItems: 0 + Name: + pattern: \S + description:

A display name for a string parameter.

+ type: string required: - - Scope - - SheetId + - Name + - Values + MaximumMinimumComputation: additionalProperties: false - ShortFormatText: type: object properties: - PlainText: + Type: + $ref: '#/components/schemas/MaximumMinimumComputationType' + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - RichText: + Name: type: string - maxLength: 1024 - minLength: 1 + required: + - ComputationId + - Type + RadarChartSortConfiguration: additionalProperties: false - SimpleAttributeAggregationFunction: - type: string - enum: - - UNIQUE_VALUE - SimpleClusterMarker: type: object properties: - Color: - type: string - pattern: ^#[A-F0-9]{6}$ + ColorSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + ColorItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + GridLayoutConfiguration: additionalProperties: false - SimpleNumericalAggregationFunction: - type: string - enum: - - SUM - - AVERAGE - - MIN - - MAX - - COUNT - - DISTINCT_COUNT - - VAR - - VARP - - STDEV - - STDEVP - - MEDIAN - SimpleTotalAggregationFunction: - type: string - enum: - - DEFAULT - - SUM - - AVERAGE - - MIN - - MAX - - NONE - SliderControlDisplayOptions: type: object properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + CanvasSizeOptions: + $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' + Elements: + minItems: 0 + maxItems: 430 + type: array + items: + $ref: '#/components/schemas/GridLayoutElement' + required: + - Elements + PluginVisualOptions: additionalProperties: false - SmallMultiplesAxisPlacement: - type: string - enum: - - OUTSIDE - - INSIDE - SmallMultiplesAxisProperties: type: object properties: - Scale: - $ref: '#/components/schemas/SmallMultiplesAxisScale' - Placement: - $ref: '#/components/schemas/SmallMultiplesAxisPlacement' + VisualProperties: + type: array + items: + $ref: '#/components/schemas/PluginVisualProperty' + PluginVisualProperty: additionalProperties: false - SmallMultiplesAxisScale: + type: object + properties: + Value: + type: string + Name: + type: string + HistogramBinOptions: + additionalProperties: false + type: object + properties: + BinWidth: + $ref: '#/components/schemas/BinWidthOptions' + StartValue: + default: null + type: number + SelectedBinType: + $ref: '#/components/schemas/HistogramBinType' + BinCount: + $ref: '#/components/schemas/BinCountOptions' + TableBorderStyle: type: string enum: - - SHARED - - INDEPENDENT - SmallMultiplesOptions: + - NONE + - SOLID + PivotTableFieldSubtotalOptions: + additionalProperties: false type: object properties: - MaxVisibleRows: + FieldId: + minLength: 1 + type: string + maxLength: 512 + TimeBasedForecastProperties: + additionalProperties: false + type: object + properties: + PeriodsBackward: + maximum: 1000 + type: number + minimum: 0 + PeriodsForward: + maximum: 1000 type: number - maximum: 10 minimum: 1 - MaxVisibleColumns: + PredictionInterval: + maximum: 95 + type: number + minimum: 50 + Seasonality: + maximum: 180 type: number - maximum: 10 minimum: 1 - PanelConfiguration: - $ref: '#/components/schemas/PanelConfiguration' - XAxis: - $ref: '#/components/schemas/SmallMultiplesAxisProperties' - YAxis: - $ref: '#/components/schemas/SmallMultiplesAxisProperties' - additionalProperties: false - SortDirection: + UpperBoundary: + default: null + type: number + LowerBoundary: + default: null + type: number + SelectedTooltipType: type: string enum: - - ASC - - DESC - Spacing: + - BASIC + - DETAILED + SheetDefinition: + additionalProperties: false type: object properties: - Top: - type: string - description: String based length that is composed of value and unit - Bottom: - type: string - description: String based length that is composed of value and unit - Left: + Description: + minLength: 1 type: string - description: String based length that is composed of value and unit - Right: + maxLength: 1024 + ParameterControls: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ParameterControl' + ContentType: + $ref: '#/components/schemas/SheetContentType' + SheetId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - description: String based length that is composed of value and unit - additionalProperties: false - SpecialValue: - type: string - enum: - - EMPTY - - 'NULL' - - OTHER - StringDefaultValues: - type: object - properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: + maxLength: 512 + Images: + minItems: 0 + maxItems: 10 type: array items: - type: string - maxItems: 50000 + $ref: '#/components/schemas/SheetImage' + SheetControlLayouts: minItems: 0 - additionalProperties: false - StringFormatConfiguration: - type: object - properties: - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - NumericFormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' - additionalProperties: false - StringParameter: - type: object - properties: - Name: - type: string - pattern: .*\S.* - Values: + maxItems: 1 type: array items: - type: string - required: - - Name - - Values - additionalProperties: false - StringParameterDeclaration: - type: object - properties: - ParameterValueType: - $ref: '#/components/schemas/ParameterValueType' + $ref: '#/components/schemas/SheetControlLayout' + Title: + minLength: 1 + type: string + maxLength: 1024 Name: + minLength: 1 type: string maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/StringDefaultValues' - ValueWhenUnset: - $ref: '#/components/schemas/StringValueWhenUnsetConfiguration' - MappedDataSetParameters: + TextBoxes: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 - required: - - Name - - ParameterValueType + $ref: '#/components/schemas/SheetTextBox' + Layouts: + minItems: 1 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/Layout' + FilterControls: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/FilterControl' + Visuals: + minItems: 0 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/Visual' + required: + - SheetId + Filter: additionalProperties: false - StringValueWhenUnsetConfiguration: type: object properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: - type: string + NestedFilter: + $ref: '#/components/schemas/NestedFilter' + NumericEqualityFilter: + $ref: '#/components/schemas/NumericEqualityFilter' + NumericRangeFilter: + $ref: '#/components/schemas/NumericRangeFilter' + TimeRangeFilter: + $ref: '#/components/schemas/TimeRangeFilter' + RelativeDatesFilter: + $ref: '#/components/schemas/RelativeDatesFilter' + TopBottomFilter: + $ref: '#/components/schemas/TopBottomFilter' + TimeEqualityFilter: + $ref: '#/components/schemas/TimeEqualityFilter' + CategoryFilter: + $ref: '#/components/schemas/CategoryFilter' + ReferenceLineCustomLabelConfiguration: additionalProperties: false - StyledCellType: - type: string - enum: - - TOTAL - - METRIC_HEADER - - VALUE - SubtotalOptions: type: object properties: - TotalsVisibility: - $ref: '#/components/schemas/Visibility' CustomLabel: + pattern: \S type: string - FieldLevel: - $ref: '#/components/schemas/PivotTableSubtotalLevel' - FieldLevelOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableFieldSubtotalOptions' - maxItems: 100 + required: + - CustomLabel + KPIFieldWells: + additionalProperties: false + type: object + properties: + TargetValues: minItems: 0 - TotalCellStyle: - $ref: '#/components/schemas/TableCellStyle' - ValueCellStyle: - $ref: '#/components/schemas/TableCellStyle' - MetricHeaderCellStyle: - $ref: '#/components/schemas/TableCellStyle' - StyleTargets: + maxItems: 200 type: array items: - $ref: '#/components/schemas/TableStyleTarget' - maxItems: 3 + $ref: '#/components/schemas/MeasureField' + TrendGroups: minItems: 0 - additionalProperties: false - TableAggregatedFieldWells: - type: object - properties: - GroupBy: + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 Values: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 + WordCloudWordCasing: + type: string + enum: + - LOWER_CASE + - EXISTING_CASE + PaginationConfiguration: additionalProperties: false - TableBorderOptions: type: object properties: - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - Thickness: + PageSize: + default: null type: number - maximum: 4 - minimum: 1 - Style: - $ref: '#/components/schemas/TableBorderStyle' + PageNumber: + type: number + minimum: 0 + required: + - PageNumber + - PageSize + ComboChartFieldWells: additionalProperties: false - TableBorderStyle: - type: string - enum: - - NONE - - SOLID - TableCellConditionalFormatting: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - TextFormat: - $ref: '#/components/schemas/TextConditionalFormat' - required: - - FieldId - additionalProperties: false - TableCellImageScalingConfiguration: + ComboChartAggregatedFieldWells: + $ref: '#/components/schemas/ComboChartAggregatedFieldWells' + CrossDatasetTypes: type: string enum: - - FIT_TO_CELL_HEIGHT - - FIT_TO_CELL_WIDTH - - DO_NOT_SCALE - TableCellImageSizingConfiguration: - type: object - properties: - TableCellImageScalingConfiguration: - $ref: '#/components/schemas/TableCellImageScalingConfiguration' + - ALL_DATASETS + - SINGLE_DATASET + CustomActionSetParametersOperation: additionalProperties: false - TableCellStyle: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - TextWrap: - $ref: '#/components/schemas/TextWrap' - HorizontalTextAlignment: - $ref: '#/components/schemas/HorizontalTextAlignment' - VerticalTextAlignment: - $ref: '#/components/schemas/VerticalTextAlignment' - BackgroundColor: - type: string - pattern: ^#[A-F0-9]{6}$ - Height: - type: number - maximum: 500 - minimum: 8 - Border: - $ref: '#/components/schemas/GlobalTableBorderOptions' - additionalProperties: false + ParameterValueConfigurations: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/SetParameterValueConfiguration' + required: + - ParameterValueConfigurations TableConditionalFormatting: + additionalProperties: false type: object properties: ConditionalFormattingOptions: + minItems: 0 + maxItems: 500 type: array items: $ref: '#/components/schemas/TableConditionalFormattingOption' - maxItems: 100 - minItems: 0 - additionalProperties: false - TableConditionalFormattingOption: - type: object - properties: - Cell: - $ref: '#/components/schemas/TableCellConditionalFormatting' - Row: - $ref: '#/components/schemas/TableRowConditionalFormatting' + WhatIfRangeScenario: additionalProperties: false - TableConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/TableFieldWells' - SortConfiguration: - $ref: '#/components/schemas/TableSortConfiguration' - TableOptions: - $ref: '#/components/schemas/TableOptions' - TotalOptions: - $ref: '#/components/schemas/TotalOptions' - FieldOptions: - $ref: '#/components/schemas/TableFieldOptions' - PaginatedReportOptions: - $ref: '#/components/schemas/TablePaginatedReportOptions' - TableInlineVisualizations: - type: array - items: - $ref: '#/components/schemas/TableInlineVisualization' - maxItems: 200 - minItems: 0 + StartDate: + format: date-time + type: string + Value: + default: 0 + type: number + EndDate: + format: date-time + type: string + required: + - EndDate + - StartDate + - Value + PluginVisualSortConfiguration: additionalProperties: false - TableFieldCustomIconContent: type: object properties: - Icon: - $ref: '#/components/schemas/TableFieldIconSetType' + PluginVisualTableQuerySort: + $ref: '#/components/schemas/PluginVisualTableQuerySort' + CategoricalMeasureField: additionalProperties: false - TableFieldCustomTextContent: type: object properties: - Value: + AggregationFunction: + $ref: '#/components/schemas/CategoricalAggregationFunction' + FormatConfiguration: + $ref: '#/components/schemas/StringFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 type: string - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' + maxLength: 512 required: - - FontConfiguration + - Column + - FieldId + ListControlSearchOptions: additionalProperties: false - TableFieldIconSetType: - type: string - enum: - - LINK - TableFieldImageConfiguration: type: object properties: - SizingOptions: - $ref: '#/components/schemas/TableCellImageSizingConfiguration' + Visibility: {} + UniqueValuesComputation: additionalProperties: false - TableFieldLinkConfiguration: type: object properties: - Target: - $ref: '#/components/schemas/URLTargetConfiguration' - Content: - $ref: '#/components/schemas/TableFieldLinkContentConfiguration' - required: - - Content - - Target - additionalProperties: false - TableFieldLinkContentConfiguration: - type: object - properties: - CustomTextContent: - $ref: '#/components/schemas/TableFieldCustomTextContent' - CustomIconContent: - $ref: '#/components/schemas/TableFieldCustomIconContent' - additionalProperties: false - TableFieldOption: - type: object - properties: - FieldId: - type: string - maxLength: 512 + Category: + $ref: '#/components/schemas/DimensionField' + ComputationId: minLength: 1 - Width: + pattern: ^[\w\-]+$ type: string - description: String based length that is composed of value and unit in px - CustomLabel: + maxLength: 512 + Name: type: string - maxLength: 2048 - minLength: 1 - Visibility: - $ref: '#/components/schemas/Visibility' - URLStyling: - $ref: '#/components/schemas/TableFieldURLConfiguration' required: - - FieldId - additionalProperties: false - TableFieldOptions: - type: object - properties: - SelectedFieldOptions: - type: array - items: - $ref: '#/components/schemas/TableFieldOption' - maxItems: 100 - minItems: 0 - Order: - type: array - items: - type: string - maxLength: 512 - minLength: 1 - maxItems: 200 - minItems: 0 - PinnedFieldOptions: - $ref: '#/components/schemas/TablePinnedFieldOptions' + - ComputationId + SmallMultiplesAxisProperties: additionalProperties: false - TableFieldURLConfiguration: type: object properties: - LinkConfiguration: - $ref: '#/components/schemas/TableFieldLinkConfiguration' - ImageConfiguration: - $ref: '#/components/schemas/TableFieldImageConfiguration' + Placement: + $ref: '#/components/schemas/SmallMultiplesAxisPlacement' + Scale: + $ref: '#/components/schemas/SmallMultiplesAxisScale' + KPIVisualStandardLayoutType: + type: string + enum: + - CLASSIC + - VERTICAL + LabelOptions: additionalProperties: false - TableFieldWells: type: object properties: - TableAggregatedFieldWells: - $ref: '#/components/schemas/TableAggregatedFieldWells' - TableUnaggregatedFieldWells: - $ref: '#/components/schemas/TableUnaggregatedFieldWells' + CustomLabel: + type: string + Visibility: {} + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + UnaggregatedField: additionalProperties: false - TableInlineVisualization: type: object properties: - DataBars: - $ref: '#/components/schemas/DataBarsOptions' + FormatConfiguration: + $ref: '#/components/schemas/FormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - Column + - FieldId + BarChartConfiguration: additionalProperties: false - TableOptions: type: object properties: + SortConfiguration: + $ref: '#/components/schemas/BarChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/ReferenceLine' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + SmallMultiplesOptions: + $ref: '#/components/schemas/SmallMultiplesOptions' Orientation: - $ref: '#/components/schemas/TableOrientation' - HeaderStyle: - $ref: '#/components/schemas/TableCellStyle' - CellStyle: - $ref: '#/components/schemas/TableCellStyle' - RowAlternateColorOptions: - $ref: '#/components/schemas/RowAlternateColorOptions' - additionalProperties: false - TableOrientation: - type: string - enum: - - VERTICAL - - HORIZONTAL - TablePaginatedReportOptions: - type: object - properties: - VerticalOverflowVisibility: - $ref: '#/components/schemas/Visibility' - OverflowColumnHeaderVisibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false - TablePinnedFieldOptions: - type: object - properties: - PinnedLeftFields: + $ref: '#/components/schemas/BarChartOrientation' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + ValueLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + BarsArrangement: + $ref: '#/components/schemas/BarsArrangement' + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + ContributionAnalysisDefaults: + minItems: 1 + maxItems: 200 type: array items: - type: string - maxLength: 512 - minLength: 1 - maxItems: 201 - minItems: 0 + $ref: '#/components/schemas/ContributionAnalysisDefault' + FieldWells: + $ref: '#/components/schemas/BarChartFieldWells' + ValueAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + FieldTooltipItem: additionalProperties: false - TableRowConditionalFormatting: type: object properties: - BackgroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - additionalProperties: false + TooltipTarget: + $ref: '#/components/schemas/TooltipTarget' + FieldId: + minLength: 1 + type: string + maxLength: 512 + Label: + type: string + Visibility: {} + required: + - FieldId TableSideBorderOptions: + additionalProperties: false type: object properties: - InnerVertical: + Left: $ref: '#/components/schemas/TableBorderOptions' - InnerHorizontal: + Top: $ref: '#/components/schemas/TableBorderOptions' - Left: + InnerHorizontal: $ref: '#/components/schemas/TableBorderOptions' Right: $ref: '#/components/schemas/TableBorderOptions' - Top: - $ref: '#/components/schemas/TableBorderOptions' Bottom: $ref: '#/components/schemas/TableBorderOptions' + InnerVertical: + $ref: '#/components/schemas/TableBorderOptions' + LineChartMarkerStyleSettings: additionalProperties: false - TableSortConfiguration: type: object properties: - RowSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - PaginationConfiguration: - $ref: '#/components/schemas/PaginationConfiguration' + MarkerShape: + $ref: '#/components/schemas/LineChartMarkerShape' + MarkerSize: + description: String based length that is composed of value and unit in px + type: string + MarkerVisibility: {} + MarkerColor: + pattern: ^#[A-F0-9]{6}$ + type: string + ComparisonFormatConfiguration: additionalProperties: false - TableStyleTarget: type: object properties: - CellType: - $ref: '#/components/schemas/StyledCellType' + NumberDisplayFormatConfiguration: + $ref: '#/components/schemas/NumberDisplayFormatConfiguration' + PercentageDisplayFormatConfiguration: + $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + FilterRelativeDateTimeControl: + additionalProperties: false + type: object + properties: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/RelativeDateTimeControlDisplayOptions' + Title: + minLength: 1 + type: string + maxLength: 2048 + CommitMode: + $ref: '#/components/schemas/CommitMode' + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - CellType + - FilterControlId + - SourceFilterId + - Title + PivotTableConditionalFormatting: additionalProperties: false - TableTotalsPlacement: - type: string - enum: - - START - - END - - AUTO - TableTotalsScrollStatus: - type: string - enum: - - PINNED - - SCROLLED - TableUnaggregatedFieldWells: type: object properties: - Values: + ConditionalFormattingOptions: + minItems: 0 + maxItems: 500 type: array items: - $ref: '#/components/schemas/UnaggregatedField' - maxItems: 200 - minItems: 0 + $ref: '#/components/schemas/PivotTableConditionalFormattingOption' + TableFieldOptions: additionalProperties: false - TableVisual: type: object properties: - VisualId: - type: string - maxLength: 512 + Order: + minItems: 0 + maxItems: 200 + type: array + items: + minLength: 1 + type: string + maxLength: 512 + PinnedFieldOptions: + $ref: '#/components/schemas/TablePinnedFieldOptions' + TransposedTableOptions: + minItems: 0 + maxItems: 10001 + type: array + items: + $ref: '#/components/schemas/TransposedTableOption' + SelectedFieldOptions: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/TableFieldOption' + ReferenceLineSeriesType: + type: string + enum: + - BAR + - LINE + ReferenceLineDynamicDataConfiguration: + additionalProperties: false + type: object + properties: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + MeasureAggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + Calculation: + $ref: '#/components/schemas/NumericalAggregationFunction' + required: + - Calculation + - Column + SheetTextBox: + additionalProperties: false + type: object + properties: + SheetTextBoxId: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Content: + minLength: 0 + type: string + maxLength: 150000 + required: + - SheetTextBoxId + DateDimensionField: + additionalProperties: false + type: object + properties: + HierarchyId: + minLength: 1 + type: string + maxLength: 512 + FormatConfiguration: + $ref: '#/components/schemas/DateTimeFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 + DateGranularity: + $ref: '#/components/schemas/TimeGranularity' + required: + - Column + - FieldId + DefaultFilterListControlOptions: + additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/ListControlDisplayOptions' + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' + PrimaryValueDisplayType: + type: string + enum: + - HIDDEN + - COMPARISON + - ACTUAL + KPIVisual: + additionalProperties: false + type: object + properties: Subtitle: $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/TableConfiguration' ConditionalFormatting: - $ref: '#/components/schemas/TableConditionalFormatting' + $ref: '#/components/schemas/KPIConditionalFormatting' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/KPIConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + ColumnHierarchies: minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - VisualId + AggregationSortConfiguration: additionalProperties: false - Tag: type: object properties: - Value: - type: string - maxLength: 256 + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + SortDirection: + $ref: '#/components/schemas/SortDirection' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + required: + - Column + - SortDirection + PercentageDisplayFormatConfiguration: + additionalProperties: false + type: object + properties: + NegativeValueConfiguration: + $ref: '#/components/schemas/NegativeValueConfiguration' + DecimalPlacesConfiguration: + $ref: '#/components/schemas/DecimalPlacesConfiguration' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + Suffix: minLength: 1 - Key: type: string maxLength: 128 + SeparatorConfiguration: + $ref: '#/components/schemas/NumericSeparatorConfiguration' + Prefix: minLength: 1 + type: string + maxLength: 128 + TableVisual: additionalProperties: false - required: - - Key - - Value - TargetVisualOptions: - type: string - enum: - - ALL_VISUALS - TextAreaControlDisplayOptions: type: object properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - PlaceholderOptions: - $ref: '#/components/schemas/TextControlPlaceholderOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/TableConditionalFormatting' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/TableConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + required: + - VisualId + ComboChartSortConfiguration: additionalProperties: false - TextConditionalFormat: type: object properties: - BackgroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + ColorSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + ColorItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + SheetImage: additionalProperties: false - TextControlPlaceholderOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ImageCustomAction' + SheetImageId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Tooltip: + $ref: '#/components/schemas/SheetImageTooltipConfiguration' + Scaling: + $ref: '#/components/schemas/SheetImageScalingConfiguration' + Interactions: + $ref: '#/components/schemas/ImageInteractionOptions' + Source: + $ref: '#/components/schemas/SheetImageSource' + ImageContentAltText: + minLength: 1 + type: string + maxLength: 1024 + required: + - SheetImageId + - Source + TextAreaControlDisplayOptions: additionalProperties: false - TextFieldControlDisplayOptions: type: object properties: TitleOptions: @@ -6901,2653 +7585,3988 @@ components: $ref: '#/components/schemas/TextControlPlaceholderOptions' InfoIconLabelOptions: $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + DataPathSort: additionalProperties: false - TextWrap: - type: string - enum: - - NONE - - WRAP - ThousandSeparatorOptions: type: object properties: - Symbol: - $ref: '#/components/schemas/NumericSeparatorSymbol' - Visibility: - $ref: '#/components/schemas/Visibility' + SortPaths: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/DataPathValue' + Direction: + $ref: '#/components/schemas/SortDirection' + required: + - Direction + - SortPaths + DecimalParameterDeclaration: additionalProperties: false - TimeBasedForecastProperties: type: object properties: - PeriodsForward: - type: number - maximum: 1000 - minimum: 1 - PeriodsBackward: - type: number - maximum: 1000 - minimum: 0 - UpperBoundary: - type: number - default: null - LowerBoundary: - type: number - default: null - PredictionInterval: - type: number - maximum: 95 - minimum: 50 - Seasonality: - type: number - maximum: 180 - minimum: 1 - additionalProperties: false - TimeEqualityFilter: - type: object - properties: - FilterId: - type: string - maxLength: 512 + MappedDataSetParameters: + minItems: 0 + maxItems: 150 + type: array + items: + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/DecimalDefaultValues' + ParameterValueType: + $ref: '#/components/schemas/ParameterValueType' + ValueWhenUnset: + $ref: '#/components/schemas/DecimalValueWhenUnsetConfiguration' + Name: minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Value: - type: string - format: date-time - RollingDate: - $ref: '#/components/schemas/RollingDateConfiguration' - ParameterName: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' required: - - Column - - FilterId - additionalProperties: false - TimeGranularity: + - Name + - ParameterValueType + FilterVisualScope: type: string enum: - - YEAR - - QUARTER - - MONTH - - WEEK - - DAY - - HOUR - - MINUTE - - SECOND - - MILLISECOND - TimeRangeDrillDownFilter: - type: object - properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - RangeMinimum: - type: string - format: date-time - RangeMaximum: - type: string - format: date-time - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Column - - RangeMaximum - - RangeMinimum - - TimeGranularity - additionalProperties: false - TimeRangeFilter: - type: object - properties: - FilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - IncludeMinimum: - type: boolean - default: null - IncludeMaximum: - type: boolean - default: null - RangeMinimumValue: - $ref: '#/components/schemas/TimeRangeFilterValue' - RangeMaximumValue: - $ref: '#/components/schemas/TimeRangeFilterValue' - NullOption: - $ref: '#/components/schemas/FilterNullOption' - ExcludePeriodConfiguration: - $ref: '#/components/schemas/ExcludePeriodConfiguration' - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Column - - FilterId - - NullOption + - ALL_VISUALS + - SELECTED_VISUALS + ImageCustomAction: additionalProperties: false - TimeRangeFilterValue: type: object properties: - StaticValue: - type: string - format: date-time - RollingDate: - $ref: '#/components/schemas/RollingDateConfiguration' - Parameter: - type: string - maxLength: 2048 + Status: + $ref: '#/components/schemas/WidgetStatus' + Trigger: + $ref: '#/components/schemas/ImageCustomActionTrigger' + CustomActionId: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - additionalProperties: false - TooltipItem: - type: object - properties: - FieldTooltipItem: - $ref: '#/components/schemas/FieldTooltipItem' - ColumnTooltipItem: - $ref: '#/components/schemas/ColumnTooltipItem' - additionalProperties: false - TooltipOptions: - type: object - properties: - TooltipVisibility: - $ref: '#/components/schemas/Visibility' - SelectedTooltipType: - $ref: '#/components/schemas/SelectedTooltipType' - FieldBasedTooltip: - $ref: '#/components/schemas/FieldBasedTooltip' - additionalProperties: false - TooltipTitleType: - type: string - enum: - - NONE - - PRIMARY_VALUE - TopBottomComputationType: - type: string - enum: - - TOP - - BOTTOM - TopBottomFilter: - type: object - properties: - FilterId: + pattern: ^[\w\-]+$ type: string maxLength: 512 + Name: minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Limit: - type: number - default: null - AggregationSortConfigurations: + type: string + maxLength: 256 + ActionOperations: + minItems: 1 + maxItems: 2 type: array items: - $ref: '#/components/schemas/AggregationSortConfiguration' - maxItems: 100 - minItems: 0 - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - ParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + $ref: '#/components/schemas/ImageCustomActionOperation' required: - - AggregationSortConfigurations - - Column - - FilterId - additionalProperties: false + - ActionOperations + - CustomActionId + - Name + - Trigger TopBottomMoversComputation: + additionalProperties: false type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Time: - $ref: '#/components/schemas/DimensionField' + Type: + $ref: '#/components/schemas/TopBottomComputationType' Category: $ref: '#/components/schemas/DimensionField' Value: $ref: '#/components/schemas/MeasureField' + SortOrder: + $ref: '#/components/schemas/TopBottomSortOrder' + Time: + $ref: '#/components/schemas/DimensionField' MoverSize: - type: number default: 0 maximum: 20 + type: number minimum: 1 - SortOrder: - $ref: '#/components/schemas/TopBottomSortOrder' - Type: - $ref: '#/components/schemas/TopBottomComputationType' - required: - - ComputationId - - Type - additionalProperties: false - TopBottomRankedComputation: - type: object - properties: ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' Name: type: string - Category: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - ResultSize: - type: number - default: 0 - maximum: 20 - minimum: 1 - Type: - $ref: '#/components/schemas/TopBottomComputationType' required: - ComputationId - Type - additionalProperties: false - TopBottomSortOrder: + TextWrap: type: string enum: - - PERCENT_DIFFERENCE - - ABSOLUTE_DIFFERENCE - TotalAggregationComputation: + - NONE + - WRAP + AnchorOption: + type: string + enum: + - NOW + FieldSort: + additionalProperties: false type: object properties: - ComputationId: - type: string - maxLength: 512 + FieldId: minLength: 1 - pattern: '[\w\-]+' - Name: type: string - Value: - $ref: '#/components/schemas/MeasureField' + maxLength: 512 + Direction: + $ref: '#/components/schemas/SortDirection' required: - - ComputationId + - Direction + - FieldId + AxisDisplayMinMaxRange: additionalProperties: false - TotalAggregationFunction: type: object properties: - SimpleTotalAggregationFunction: - $ref: '#/components/schemas/SimpleTotalAggregationFunction' + Minimum: + default: null + type: number + Maximum: + default: null + type: number + SectionPageBreakStatus: + type: string + enum: + - ENABLED + - DISABLED + AxisLabelReferenceOptions: additionalProperties: false - TotalAggregationOption: type: object properties: + Column: + $ref: '#/components/schemas/ColumnIdentifier' FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - TotalAggregationFunction: - $ref: '#/components/schemas/TotalAggregationFunction' required: + - Column - FieldId - - TotalAggregationFunction + DateAggregationFunction: + type: string + enum: + - COUNT + - DISTINCT_COUNT + - MIN + - MAX + TopBottomSortOrder: + type: string + enum: + - PERCENT_DIFFERENCE + - ABSOLUTE_DIFFERENCE + DropDownControlDisplayOptions: additionalProperties: false - TotalOptions: type: object properties: - TotalsVisibility: - $ref: '#/components/schemas/Visibility' - TotalAggregationOptions: - type: array - items: - $ref: '#/components/schemas/TotalAggregationOption' - maxItems: 200 - minItems: 0 - Placement: - $ref: '#/components/schemas/TableTotalsPlacement' - ScrollStatus: - $ref: '#/components/schemas/TableTotalsScrollStatus' - CustomLabel: - type: string - TotalCellStyle: - $ref: '#/components/schemas/TableCellStyle' + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + SelectAllOptions: + $ref: '#/components/schemas/ListControlSelectAllOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + FieldLabelType: additionalProperties: false - TreeMapAggregatedFieldWells: type: object properties: - Groups: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 - Sizes: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 - Colors: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 + FieldId: + minLength: 1 + type: string + maxLength: 512 + Visibility: {} + SpatialStaticFile: additionalProperties: false - TreeMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/TreeMapFieldWells' - SortConfiguration: - $ref: '#/components/schemas/TreeMapSortConfiguration' - GroupLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - SizeLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorScale: - $ref: '#/components/schemas/ColorScale' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' + StaticFileId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Source: + $ref: '#/components/schemas/StaticFileSource' + required: + - StaticFileId + AxisLogarithmicScale: additionalProperties: false - TreeMapFieldWells: type: object properties: - TreeMapAggregatedFieldWells: - $ref: '#/components/schemas/TreeMapAggregatedFieldWells' + Base: + default: null + type: number + GeospatialLayerColorField: additionalProperties: false - TreeMapSortConfiguration: type: object properties: - TreeMapSort: + ColorValuesFields: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/MeasureField' + ColorDimensionsFields: minItems: 0 - TreeMapGroupItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + KPISortConfiguration: additionalProperties: false - TreeMapVisual: type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/TreeMapConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + TrendGroupSort: minItems: 0 - ColumnHierarchies: + maxItems: 100 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId + $ref: '#/components/schemas/FieldSortOptions' + GlobalTableBorderOptions: additionalProperties: false - TrendArrowOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + UniformBorder: + $ref: '#/components/schemas/TableBorderOptions' + SideSpecificBorder: + $ref: '#/components/schemas/TableSideBorderOptions' + DataSetIdentifierDeclaration: additionalProperties: false - URLTargetConfiguration: + type: object + properties: + Identifier: + minLength: 1 + type: string + maxLength: 2048 + DataSetArn: + type: string + required: + - DataSetArn + - Identifier + TableTotalsScrollStatus: type: string enum: - - NEW_TAB - - NEW_WINDOW - - SAME_TAB - UnaggregatedField: + - PINNED + - SCROLLED + StyledCellType: + type: string + enum: + - TOTAL + - METRIC_HEADER + - VALUE + TotalAggregationOption: + additionalProperties: false type: object properties: + TotalAggregationFunction: + $ref: '#/components/schemas/TotalAggregationFunction' FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - FormatConfiguration: - $ref: '#/components/schemas/FormatConfiguration' required: - - Column - FieldId + - TotalAggregationFunction + DataPathValue: additionalProperties: false - UniqueValuesComputation: type: object properties: - ComputationId: + DataPathType: + $ref: '#/components/schemas/DataPathType' + FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: + FieldValue: + minLength: 0 type: string - Category: - $ref: '#/components/schemas/DimensionField' - required: - - ComputationId + maxLength: 2048 + PivotTableFieldOption: additionalProperties: false - ValidationStrategy: type: object properties: - Mode: - $ref: '#/components/schemas/ValidationStrategyMode' + CustomLabel: + minLength: 1 + type: string + maxLength: 2048 + FieldId: + minLength: 1 + type: string + maxLength: 512 + Visibility: {} required: - - Mode + - FieldId + LayerCustomAction: additionalProperties: false - ValidationStrategyMode: - type: string - enum: - - STRICT - - LENIENT - ValueWhenUnsetOption: - type: string - enum: - - RECOMMENDED_VALUE - - 'NULL' - VerticalTextAlignment: - type: string - enum: - - TOP - - MIDDLE - - BOTTOM - - AUTO - Visibility: - type: string - enum: - - HIDDEN - - VISIBLE - VisibleRangeOptions: - type: object - properties: - PercentRange: - $ref: '#/components/schemas/PercentVisibleRange' - additionalProperties: false - Visual: - type: object - properties: - TableVisual: - $ref: '#/components/schemas/TableVisual' - PivotTableVisual: - $ref: '#/components/schemas/PivotTableVisual' - BarChartVisual: - $ref: '#/components/schemas/BarChartVisual' - KPIVisual: - $ref: '#/components/schemas/KPIVisual' - PieChartVisual: - $ref: '#/components/schemas/PieChartVisual' - GaugeChartVisual: - $ref: '#/components/schemas/GaugeChartVisual' - LineChartVisual: - $ref: '#/components/schemas/LineChartVisual' - HeatMapVisual: - $ref: '#/components/schemas/HeatMapVisual' - TreeMapVisual: - $ref: '#/components/schemas/TreeMapVisual' - GeospatialMapVisual: - $ref: '#/components/schemas/GeospatialMapVisual' - FilledMapVisual: - $ref: '#/components/schemas/FilledMapVisual' - FunnelChartVisual: - $ref: '#/components/schemas/FunnelChartVisual' - ScatterPlotVisual: - $ref: '#/components/schemas/ScatterPlotVisual' - ComboChartVisual: - $ref: '#/components/schemas/ComboChartVisual' - BoxPlotVisual: - $ref: '#/components/schemas/BoxPlotVisual' - WaterfallVisual: - $ref: '#/components/schemas/WaterfallVisual' - HistogramVisual: - $ref: '#/components/schemas/HistogramVisual' - WordCloudVisual: - $ref: '#/components/schemas/WordCloudVisual' - InsightVisual: - $ref: '#/components/schemas/InsightVisual' - SankeyDiagramVisual: - $ref: '#/components/schemas/SankeyDiagramVisual' - CustomContentVisual: - $ref: '#/components/schemas/CustomContentVisual' - EmptyVisual: - $ref: '#/components/schemas/EmptyVisual' - RadarChartVisual: - $ref: '#/components/schemas/RadarChartVisual' - additionalProperties: false - VisualCustomAction: type: object properties: + Status: + $ref: '#/components/schemas/WidgetStatus' + Trigger: + $ref: '#/components/schemas/LayerCustomActionTrigger' CustomActionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' Name: + minLength: 1 type: string maxLength: 256 - minLength: 1 - Status: - $ref: '#/components/schemas/WidgetStatus' - Trigger: - $ref: '#/components/schemas/VisualCustomActionTrigger' ActionOperations: + minItems: 1 + maxItems: 2 type: array items: - $ref: '#/components/schemas/VisualCustomActionOperation' - maxItems: 2 - minItems: 1 + $ref: '#/components/schemas/LayerCustomActionOperation' required: - ActionOperations - CustomActionId - Name - Trigger + SectionBasedLayoutConfiguration: additionalProperties: false - VisualCustomActionOperation: - type: object - properties: - FilterOperation: - $ref: '#/components/schemas/CustomActionFilterOperation' - NavigationOperation: - $ref: '#/components/schemas/CustomActionNavigationOperation' - URLOperation: - $ref: '#/components/schemas/CustomActionURLOperation' - SetParametersOperation: - $ref: '#/components/schemas/CustomActionSetParametersOperation' - additionalProperties: false - VisualCustomActionTrigger: - type: string - enum: - - DATA_POINT_CLICK - - DATA_POINT_MENU - VisualPalette: type: object properties: - ChartColor: - type: string - pattern: ^#[A-F0-9]{6}$ - ColorMap: - type: array - items: - $ref: '#/components/schemas/DataPathColor' - maxItems: 5000 + CanvasSizeOptions: + $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' + FooterSections: minItems: 0 - additionalProperties: false - VisualSubtitleLabelOptions: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FormatText: - $ref: '#/components/schemas/LongFormatText' - additionalProperties: false - VisualTitleLabelOptions: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FormatText: - $ref: '#/components/schemas/ShortFormatText' - additionalProperties: false - WaterfallChartAggregatedFieldWells: - type: object - properties: - Categories: + maxItems: 1 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/HeaderFooterSectionConfiguration' + BodySections: minItems: 0 - Values: + maxItems: 28 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + $ref: '#/components/schemas/BodySectionConfiguration' + HeaderSections: minItems: 0 - Breakdowns: + maxItems: 1 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 + $ref: '#/components/schemas/HeaderFooterSectionConfiguration' + required: + - BodySections + - CanvasSizeOptions + - FooterSections + - HeaderSections + ConditionalFormattingColor: additionalProperties: false - WaterfallChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/WaterfallChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/WaterfallChartSortConfiguration' - WaterfallChartOptions: - $ref: '#/components/schemas/WaterfallChartOptions' - CategoryAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - CategoryAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + Gradient: + $ref: '#/components/schemas/ConditionalFormattingGradientColor' + Solid: + $ref: '#/components/schemas/ConditionalFormattingSolidColor' + FreeFormLayoutCanvasSizeOptions: additionalProperties: false - WaterfallChartFieldWells: type: object properties: - WaterfallChartAggregatedFieldWells: - $ref: '#/components/schemas/WaterfallChartAggregatedFieldWells' + ScreenCanvasSizeOptions: + $ref: '#/components/schemas/FreeFormLayoutScreenCanvasSizeOptions' + GeospatialMapStyle: additionalProperties: false - WaterfallChartOptions: type: object properties: - TotalBarLabel: + BaseMapStyle: + $ref: '#/components/schemas/BaseMapStyleType' + BaseMapVisibility: + $ref: '#/components/schemas/Visibility' + BackgroundColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string + NumericSeparatorSymbol: + type: string + enum: + - COMMA + - DOT + - SPACE + QueryExecutionMode: + type: string + enum: + - AUTO + - MANUAL + TargetVisualOptions: + type: string + enum: + - ALL_VISUALS + DecimalValueWhenUnsetConfiguration: additionalProperties: false - WaterfallChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - BreakdownItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + default: null + type: number + QueryExecutionOptions: additionalProperties: false - WaterfallVisual: type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/WaterfallChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId + QueryExecutionMode: + $ref: '#/components/schemas/QueryExecutionMode' + ColumnSort: additionalProperties: false - WhatIfPointScenario: type: object properties: - Date: - type: string - format: date-time - Value: - type: number - default: 0 + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + SortBy: + $ref: '#/components/schemas/ColumnIdentifier' + Direction: + $ref: '#/components/schemas/SortDirection' required: - - Date - - Value + - Direction + - SortBy + DefaultDateTimePickerControlOptions: additionalProperties: false - WhatIfRangeScenario: type: object properties: - StartDate: - type: string - format: date-time - EndDate: - type: string - format: date-time - Value: - type: number - default: 0 + Type: + $ref: '#/components/schemas/SheetControlDateTimePickerType' + DisplayOptions: + $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + CommitMode: + $ref: '#/components/schemas/CommitMode' + GeospatialPointLayer: + additionalProperties: false + type: object + properties: + Style: + $ref: '#/components/schemas/GeospatialPointStyle' required: - - EndDate - - StartDate - - Value + - Style + NumericalMeasureField: additionalProperties: false - WidgetStatus: + type: object + properties: + AggregationFunction: + $ref: '#/components/schemas/NumericalAggregationFunction' + FormatConfiguration: + $ref: '#/components/schemas/NumberFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - Column + - FieldId + PanelBorderStyle: type: string enum: - - ENABLED - - DISABLED - WordCloudAggregatedFieldWells: + - SOLID + - DASHED + - DOTTED + Spacing: + additionalProperties: false type: object properties: - GroupBy: + Left: + description: String based length that is composed of value and unit + type: string + Top: + description: String based length that is composed of value and unit + type: string + Right: + description: String based length that is composed of value and unit + type: string + Bottom: + description: String based length that is composed of value and unit + type: string + KPIVisualStandardLayout: + additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/KPIVisualStandardLayoutType' + required: + - Type + LineChartAggregatedFieldWells: + additionalProperties: false + type: object + properties: + Category: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 10 + Colors: minItems: 0 - Size: + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/MeasureField' + SmallMultiples: + minItems: 0 maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + CategoryFilterSelectAllOptions: + type: string + enum: + - FILTER_ALL_VALUES + CustomActionURLOperation: + additionalProperties: false + type: object + properties: + URLTemplate: + minLength: 1 + type: string + maxLength: 2048 + URLTarget: + $ref: '#/components/schemas/URLTargetConfiguration' + required: + - URLTarget + - URLTemplate + FreeFormLayoutConfiguration: + additionalProperties: false + type: object + properties: + CanvasSizeOptions: + $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' + Elements: minItems: 0 + maxItems: 430 + type: array + items: + $ref: '#/components/schemas/FreeFormLayoutElement' + required: + - Elements + MetricComparisonComputation: additionalProperties: false - WordCloudChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/WordCloudFieldWells' - SortConfiguration: - $ref: '#/components/schemas/WordCloudSortConfiguration' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - WordCloudOptions: - $ref: '#/components/schemas/WordCloudOptions' + TargetValue: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + FromValue: + $ref: '#/components/schemas/MeasureField' + Name: + type: string + required: + - ComputationId + GeospatialGradientColor: additionalProperties: false - WordCloudCloudLayout: + type: object + properties: + DefaultOpacity: + maximum: 1 + type: number + minimum: 0 + StepColors: + minItems: 2 + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/GeospatialGradientStepColor' + NullDataVisibility: + $ref: '#/components/schemas/Visibility' + NullDataSettings: + $ref: '#/components/schemas/GeospatialNullDataSettings' + required: + - StepColors + TableFieldLinkContentConfiguration: + additionalProperties: false + type: object + properties: + CustomIconContent: + $ref: '#/components/schemas/TableFieldCustomIconContent' + CustomTextContent: + $ref: '#/components/schemas/TableFieldCustomTextContent' + TextConditionalFormat: + additionalProperties: false + type: object + properties: + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + BackgroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + PivotTableConditionalFormattingScope: + additionalProperties: false + type: object + properties: + Role: + $ref: '#/components/schemas/PivotTableConditionalFormattingScopeRole' + ImageCustomActionTrigger: type: string enum: - - FLUID - - NORMAL - WordCloudFieldWells: + - CLICK + - MENU + ColumnTooltipItem: + additionalProperties: false type: object properties: - WordCloudAggregatedFieldWells: - $ref: '#/components/schemas/WordCloudAggregatedFieldWells' + Aggregation: + $ref: '#/components/schemas/AggregationFunction' + TooltipTarget: + $ref: '#/components/schemas/TooltipTarget' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + Label: + type: string + Visibility: {} + required: + - Column + GeospatialGradientStepColor: additionalProperties: false - WordCloudOptions: type: object properties: - WordOrientation: - $ref: '#/components/schemas/WordCloudWordOrientation' - WordScaling: - $ref: '#/components/schemas/WordCloudWordScaling' - CloudLayout: - $ref: '#/components/schemas/WordCloudCloudLayout' - WordCasing: - $ref: '#/components/schemas/WordCloudWordCasing' - WordPadding: - $ref: '#/components/schemas/WordCloudWordPadding' - MaximumStringLength: + DataValue: + default: 0 type: number - maximum: 100 - minimum: 1 + Color: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string + required: + - Color + - DataValue + PivotTableFieldOptions: additionalProperties: false - WordCloudSortConfiguration: type: object properties: - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - CategorySort: + CollapseStateOptions: type: array items: - $ref: '#/components/schemas/FieldSortOptions' + $ref: '#/components/schemas/PivotTableFieldCollapseStateOption' + DataPathOptions: + minItems: 0 maxItems: 100 + type: array + items: + $ref: '#/components/schemas/PivotTableDataPathOption' + SelectedFieldOptions: minItems: 0 - additionalProperties: false - WordCloudVisual: + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/PivotTableFieldOption' + Tag: type: object + description: |- +

The key or keys of the key-value pairs for the resource tag or tags assigned to the + resource.

properties: - VisualId: + Key: type: string - maxLength: 512 + maxLength: 128 minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/WordCloudChartConfiguration' - Actions: + description:

Tag key.

+ Value: + type: string + maxLength: 256 + minLength: 1 + description:

Tag value.

+ required: + - Key + - Value + additionalProperties: false + FilterScopeConfiguration: + additionalProperties: false + type: object + properties: + AllSheets: + $ref: '#/components/schemas/AllSheetsFilterScopeConfiguration' + SelectedSheets: + $ref: '#/components/schemas/SelectedSheetsFilterScopeConfiguration' + AnchorDateConfiguration: + additionalProperties: false + type: object + properties: + AnchorOption: + $ref: '#/components/schemas/AnchorOption' + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + DestinationParameterValueConfiguration: + additionalProperties: false + type: object + properties: + CustomValuesConfiguration: + $ref: '#/components/schemas/CustomValuesConfiguration' + SourceParameterName: + type: string + SelectAllValueOptions: + $ref: '#/components/schemas/SelectAllValueOptions' + SourceField: + minLength: 1 + type: string + maxLength: 512 + SourceColumn: + $ref: '#/components/schemas/ColumnIdentifier' + FilledMapConditionalFormattingOption: + additionalProperties: false + type: object + properties: + Shape: + $ref: '#/components/schemas/FilledMapShapeConditionalFormatting' + required: + - Shape + CategoricalDimensionField: + additionalProperties: false + type: object + properties: + HierarchyId: + minLength: 1 + type: string + maxLength: 512 + FormatConfiguration: + $ref: '#/components/schemas/StringFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - Column + - FieldId + IntegerDefaultValues: + additionalProperties: false + type: object + properties: + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: + minItems: 0 + maxItems: 50000 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + type: number + StringFormatConfiguration: + additionalProperties: false + type: object + properties: + NumericFormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + GeospatialPointStyleOptions: + additionalProperties: false + type: object + properties: + SelectedPointStyle: + $ref: '#/components/schemas/GeospatialSelectedPointStyle' + ClusterMarkerConfiguration: + $ref: '#/components/schemas/ClusterMarkerConfiguration' + HeatmapConfiguration: + $ref: '#/components/schemas/GeospatialHeatmapConfiguration' + NullValueFormatConfiguration: + additionalProperties: false + type: object + properties: + NullString: + minLength: 1 + type: string + maxLength: 128 + required: + - NullString + DefaultFilterControlOptions: + additionalProperties: false + type: object + properties: + DefaultSliderOptions: + $ref: '#/components/schemas/DefaultSliderControlOptions' + DefaultRelativeDateTimeOptions: + $ref: '#/components/schemas/DefaultRelativeDateTimeControlOptions' + DefaultTextFieldOptions: + $ref: '#/components/schemas/DefaultTextFieldControlOptions' + DefaultTextAreaOptions: + $ref: '#/components/schemas/DefaultTextAreaControlOptions' + DefaultDropdownOptions: + $ref: '#/components/schemas/DefaultFilterDropDownControlOptions' + DefaultDateTimePickerOptions: + $ref: '#/components/schemas/DefaultDateTimePickerControlOptions' + DefaultListOptions: + $ref: '#/components/schemas/DefaultFilterListControlOptions' + ExplicitHierarchy: + additionalProperties: false + type: object + properties: + HierarchyId: + minLength: 1 + type: string + maxLength: 512 + DrillDownFilters: minItems: 0 - ColumnHierarchies: + maxItems: 10 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + $ref: '#/components/schemas/DrillDownFilter' + Columns: + minItems: 2 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ColumnIdentifier' required: - - VisualId + - Columns + - HierarchyId + StaticFileUrlSourceOptions: additionalProperties: false - WordCloudWordCasing: - type: string - enum: - - LOWER_CASE - - EXISTING_CASE - WordCloudWordOrientation: - type: string - enum: - - HORIZONTAL - - HORIZONTAL_AND_VERTICAL - WordCloudWordPadding: - type: string - enum: - - NONE - - SMALL - - MEDIUM - - LARGE - WordCloudWordScaling: - type: string - enum: - - EMPHASIZE - - NORMAL - Analysis: type: object properties: - AnalysisId: + Url: type: string - maxLength: 512 + required: + - Url + SheetImageTooltipText: + additionalProperties: false + type: object + properties: + PlainText: minLength: 1 - pattern: '[\w\-]+' - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ - CreatedTime: type: string - format: date-time - DataSetArns: + maxLength: 1024 + TooltipOptions: + additionalProperties: false + type: object + properties: + SelectedTooltipType: + $ref: '#/components/schemas/SelectedTooltipType' + TooltipVisibility: {} + FieldBasedTooltip: + $ref: '#/components/schemas/FieldBasedTooltip' + FieldBasedTooltip: + additionalProperties: false + type: object + properties: + TooltipFields: + minItems: 0 + maxItems: 100 type: array items: - type: string - maxItems: 100 + $ref: '#/components/schemas/TooltipItem' + AggregationVisibility: {} + TooltipTitleType: + $ref: '#/components/schemas/TooltipTitleType' + FilledMapAggregatedFieldWells: + additionalProperties: false + type: object + properties: + Values: minItems: 0 - Definition: - $ref: '#/components/schemas/AnalysisDefinition' - Errors: + maxItems: 1 type: array items: - $ref: '#/components/schemas/AnalysisError' - minItems: 1 - LastUpdatedTime: - type: string - format: date-time - Name: - type: string - maxLength: 2048 - minLength: 1 - Parameters: - $ref: '#/components/schemas/Parameters' - Permissions: + $ref: '#/components/schemas/MeasureField' + Geospatial: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - Sheets: + $ref: '#/components/schemas/DimensionField' + BarChartAggregatedFieldWells: + additionalProperties: false + type: object + properties: + Category: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/Sheet' - maxItems: 20 + $ref: '#/components/schemas/DimensionField' + Colors: minItems: 0 - SourceEntity: - $ref: '#/components/schemas/AnalysisSourceEntity' - Status: - $ref: '#/components/schemas/ResourceStatus' - Tags: + maxItems: 200 type: array items: - $ref: '#/components/schemas/Tag' + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 maxItems: 200 - minItems: 1 - ThemeArn: - type: string - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - required: - - AwsAccountId - - AnalysisId - - Name - x-stackql-resource-name: analysis - x-stackql-primaryIdentifier: - - AnalysisId - - AwsAccountId - x-create-only-properties: - - AnalysisId - - AwsAccountId - x-read-only-properties: - - Arn - - CreatedTime - - DataSetArns - - LastUpdatedTime - x-required-permissions: - create: - - quicksight:DescribeAnalysis - - quicksight:DescribeAnalysisPermissions - - quicksight:CreateAnalysis - - quicksight:DescribeTemplate - - quicksight:DescribeTheme - - quicksight:PassDataSet - - quicksight:TagResource - - quicksight:UntagResource - - quicksight:ListTagsForResource - read: - - quicksight:DescribeAnalysis - - quicksight:DescribeAnalysisPermissions - - quicksight:ListTagsForResource - update: - - quicksight:DescribeAnalysis - - quicksight:DescribeAnalysisPermissions - - quicksight:UpdateAnalysis - - quicksight:UpdateAnalysisPermissions - - quicksight:DescribeTemplate - - quicksight:DescribeTheme - - quicksight:PassDataSet - - quicksight:TagResource - - quicksight:UntagResource - - quicksight:ListTagsForResource - delete: - - quicksight:DescribeAnalysis - - quicksight:DeleteAnalysis - list: - - quicksight:ListAnalyses - AdHocFilteringOption: - type: object - properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false - DashboardBehavior: + type: array + items: + $ref: '#/components/schemas/MeasureField' + SmallMultiples: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + WordCloudWordScaling: type: string enum: - - ENABLED - - DISABLED - DashboardError: + - EMPHASIZE + - NORMAL + GeospatialSelectedPointStyle: + type: string + enum: + - POINT + - CLUSTER + - HEATMAP + LayerCustomActionTrigger: + type: string + enum: + - DATA_POINT_CLICK + - DATA_POINT_MENU + ComboChartVisual: + additionalProperties: false type: object properties: - Type: - $ref: '#/components/schemas/DashboardErrorType' - Message: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - pattern: .*\S.* - ViolatedEntities: + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/ComboChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/Entity' - maxItems: 200 + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: + minLength: 1 + type: string + maxLength: 1024 + ColumnHierarchies: minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + ConditionalFormattingIconSet: additionalProperties: false - DashboardErrorType: - type: string - enum: - - ACCESS_DENIED - - SOURCE_NOT_FOUND - - DATA_SET_NOT_FOUND - - INTERNAL_FAILURE - - PARAMETER_VALUE_INCOMPATIBLE - - PARAMETER_TYPE_INVALID - - PARAMETER_NOT_FOUND - - COLUMN_TYPE_MISMATCH - - COLUMN_GEOGRAPHIC_ROLE_MISMATCH - - COLUMN_REPLACEMENT_MISSING - DashboardPublishOptions: type: object properties: - AdHocFilteringOption: - $ref: '#/components/schemas/AdHocFilteringOption' - ExportToCSVOption: - $ref: '#/components/schemas/ExportToCSVOption' - SheetControlsOption: - $ref: '#/components/schemas/SheetControlsOption' - VisualPublishOptions: - $ref: '#/components/schemas/DashboardVisualPublishOptions' - SheetLayoutElementMaximizationOption: - $ref: '#/components/schemas/SheetLayoutElementMaximizationOption' - VisualMenuOption: - $ref: '#/components/schemas/VisualMenuOption' - VisualAxisSortOption: - $ref: '#/components/schemas/VisualAxisSortOption' - ExportWithHiddenFieldsOption: - $ref: '#/components/schemas/ExportWithHiddenFieldsOption' - DataPointDrillUpDownOption: - $ref: '#/components/schemas/DataPointDrillUpDownOption' - DataPointMenuLabelOption: - $ref: '#/components/schemas/DataPointMenuLabelOption' - DataPointTooltipOption: - $ref: '#/components/schemas/DataPointTooltipOption' + Expression: + minLength: 1 + type: string + maxLength: 4096 + IconSetType: + $ref: '#/components/schemas/ConditionalFormattingIconSetType' + required: + - Expression + AxisTickLabelOptions: additionalProperties: false - DashboardSourceEntity: type: object properties: - SourceTemplate: - $ref: '#/components/schemas/DashboardSourceTemplate' + RotationAngle: + default: null + type: number + LabelOptions: + $ref: '#/components/schemas/LabelOptions' + DimensionField: additionalProperties: false - DashboardSourceTemplate: type: object properties: - DataSetReferences: - type: array - items: - $ref: '#/components/schemas/DataSetReference' - minItems: 1 - Arn: - type: string - required: - - Arn - - DataSetReferences - additionalProperties: false - DashboardUIState: + DateDimensionField: + $ref: '#/components/schemas/DateDimensionField' + NumericalDimensionField: + $ref: '#/components/schemas/NumericalDimensionField' + CategoricalDimensionField: + $ref: '#/components/schemas/CategoricalDimensionField' + FontDecoration: type: string enum: - - EXPANDED - - COLLAPSED - DashboardVersion: + - UNDERLINE + - NONE + PivotTableAggregatedFieldWells: + additionalProperties: false type: object properties: - CreatedTime: - type: string - format: date-time - Errors: + Values: + minItems: 0 + maxItems: 40 type: array items: - $ref: '#/components/schemas/DashboardError' - minItems: 1 - VersionNumber: - type: number - minimum: 1 - Status: - $ref: '#/components/schemas/ResourceStatus' - Arn: - type: string - SourceEntityArn: - type: string - DataSetArns: + $ref: '#/components/schemas/MeasureField' + Columns: + minItems: 0 + maxItems: 40 type: array items: - type: string - maxItems: 100 + $ref: '#/components/schemas/DimensionField' + Rows: minItems: 0 - Description: - type: string - maxLength: 512 - minLength: 1 - ThemeArn: - type: string - Sheets: + maxItems: 40 type: array items: - $ref: '#/components/schemas/Sheet' - maxItems: 20 - minItems: 0 + $ref: '#/components/schemas/DimensionField' + FunnelChartSortConfiguration: additionalProperties: false - DashboardVersionDefinition: type: object properties: - DataSetIdentifierDeclarations: - type: array - items: - $ref: '#/components/schemas/DataSetIdentifierDeclaration' - maxItems: 50 - minItems: 1 - Sheets: - type: array - items: - $ref: '#/components/schemas/SheetDefinition' - maxItems: 20 - minItems: 0 - CalculatedFields: - type: array - items: - $ref: '#/components/schemas/CalculatedField' - maxItems: 500 + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: minItems: 0 - ParameterDeclarations: + maxItems: 100 type: array items: - $ref: '#/components/schemas/ParameterDeclaration' - maxItems: 200 - minItems: 0 - FilterGroups: - type: array - items: - $ref: '#/components/schemas/FilterGroup' - maxItems: 2000 - minItems: 0 - ColumnConfigurations: - type: array - items: - $ref: '#/components/schemas/ColumnConfiguration' - maxItems: 200 - minItems: 0 - AnalysisDefaults: - $ref: '#/components/schemas/AnalysisDefaults' - Options: - $ref: '#/components/schemas/AssetOptions' - required: - - DataSetIdentifierDeclarations + $ref: '#/components/schemas/FieldSortOptions' + ImageCustomActionOperation: additionalProperties: false - DashboardVisualPublishOptions: type: object properties: - ExportHiddenFieldsOption: - $ref: '#/components/schemas/ExportHiddenFieldsOption' + NavigationOperation: + $ref: '#/components/schemas/CustomActionNavigationOperation' + SetParametersOperation: + $ref: '#/components/schemas/CustomActionSetParametersOperation' + URLOperation: + $ref: '#/components/schemas/CustomActionURLOperation' + AllSheetsFilterScopeConfiguration: additionalProperties: false - DataPointDrillUpDownOption: type: object - properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + HistogramFieldWells: additionalProperties: false - DataPointMenuLabelOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + HistogramAggregatedFieldWells: + $ref: '#/components/schemas/HistogramAggregatedFieldWells' + GeospatialCategoricalColor: additionalProperties: false - DataPointTooltipOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + CategoryDataColors: + type: array + items: + $ref: '#/components/schemas/GeospatialCategoricalDataColor' + DefaultOpacity: + maximum: 1 + type: number + minimum: 0 + NullDataVisibility: + $ref: '#/components/schemas/Visibility' + NullDataSettings: + $ref: '#/components/schemas/GeospatialNullDataSettings' + required: + - CategoryDataColors + PieChartConfiguration: additionalProperties: false - ExportHiddenFieldsOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + SortConfiguration: + $ref: '#/components/schemas/PieChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + ContributionAnalysisDefaults: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ContributionAnalysisDefault' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/PieChartFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + DonutOptions: + $ref: '#/components/schemas/DonutOptions' + SmallMultiplesOptions: + $ref: '#/components/schemas/SmallMultiplesOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + ValueLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + SheetControlDateTimePickerType: + type: string + enum: + - SINGLE_VALUED + - DATE_RANGE + ReferenceLineDataConfiguration: additionalProperties: false - ExportToCSVOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + DynamicConfiguration: + $ref: '#/components/schemas/ReferenceLineDynamicDataConfiguration' + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + SeriesType: + $ref: '#/components/schemas/ReferenceLineSeriesType' + StaticConfiguration: + $ref: '#/components/schemas/ReferenceLineStaticDataConfiguration' + CurrencyDisplayFormatConfiguration: additionalProperties: false - ExportWithHiddenFieldsOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + NegativeValueConfiguration: + $ref: '#/components/schemas/NegativeValueConfiguration' + DecimalPlacesConfiguration: + $ref: '#/components/schemas/DecimalPlacesConfiguration' + NumberScale: + $ref: '#/components/schemas/NumberScale' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + Suffix: + minLength: 1 + type: string + maxLength: 128 + SeparatorConfiguration: + $ref: '#/components/schemas/NumericSeparatorConfiguration' + Symbol: + pattern: ^[A-Z]{3}$ + type: string + Prefix: + minLength: 1 + type: string + maxLength: 128 + SameSheetTargetVisualConfiguration: additionalProperties: false - LinkSharingConfiguration: type: object properties: - Permissions: + TargetVisualOptions: + $ref: '#/components/schemas/TargetVisualOptions' + TargetVisuals: + minItems: 1 + maxItems: 50 type: array items: - $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - additionalProperties: false - SheetControlsOption: - type: object - properties: - VisibilityState: - $ref: '#/components/schemas/DashboardUIState' + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + SliderControlDisplayOptions: additionalProperties: false - SheetLayoutElementMaximizationOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + GeospatialPolygonSymbolStyle: additionalProperties: false - VisualAxisSortOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + FillColor: {} + StrokeWidth: {} + StrokeColor: {} + GeospatialColorState: + description: Defines view state of the color + type: string + enum: + - ENABLED + - DISABLED + LineSeriesAxisDisplayOptions: additionalProperties: false - VisualMenuOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + MissingDataConfigurations: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/MissingDataConfiguration' + AxisOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + HeatMapVisual: additionalProperties: false - Dashboard: type: object properties: - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ - CreatedTime: - type: string - format: date-time - DashboardId: - type: string - maxLength: 512 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: minLength: 1 - pattern: '[\w\-]+' - DashboardPublishOptions: - $ref: '#/components/schemas/DashboardPublishOptions' - Definition: - $ref: '#/components/schemas/DashboardVersionDefinition' - LastPublishedTime: - type: string - format: date-time - LastUpdatedTime: + pattern: ^[\w\-]+$ type: string - format: date-time - LinkEntities: + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/HeatMapConfiguration' + Actions: + minItems: 0 + maxItems: 10 type: array items: - type: string - maxLength: 1024 - minLength: 1 - pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512} - maxItems: 5 - minItems: 0 - LinkSharingConfiguration: - $ref: '#/components/schemas/LinkSharingConfiguration' - Name: - type: string - maxLength: 2048 + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - Parameters: - $ref: '#/components/schemas/Parameters' - Permissions: + type: string + maxLength: 1024 + ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: - $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - SourceEntity: - $ref: '#/components/schemas/DashboardSourceEntity' - Tags: + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + SankeyDiagramSortConfiguration: + additionalProperties: false + type: object + properties: + WeightSort: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - ThemeArn: - type: string - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - Version: - $ref: '#/components/schemas/DashboardVersion' - VersionDescription: + $ref: '#/components/schemas/FieldSortOptions' + SourceItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + DestinationItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + LocalNavigationConfiguration: + additionalProperties: false + type: object + properties: + TargetSheetId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - required: - - AwsAccountId - - DashboardId - - Name - x-stackql-resource-name: dashboard - x-stackql-primaryIdentifier: - - AwsAccountId - - DashboardId - x-create-only-properties: - - AwsAccountId - - DashboardId - x-read-only-properties: - - Arn - - CreatedTime - - LastPublishedTime - - LastUpdatedTime - - Version - x-required-permissions: - create: - - quicksight:DescribeDashboard - - quicksight:DescribeDashboardPermissions - - quicksight:CreateDashboard - - quicksight:DescribeTemplate - - quicksight:DescribeTheme - - quicksight:PassDataSet - - quicksight:TagResource - - quicksight:UntagResource - - quicksight:ListTagsForResource - read: - - quicksight:DescribeDashboard - - quicksight:DescribeDashboardPermissions - - quicksight:ListTagsForResource - update: - - quicksight:DescribeDashboard - - quicksight:DescribeDashboardPermissions - - quicksight:UpdateDashboard - - quicksight:UpdateDashboardLinks - - quicksight:UpdateDashboardPermissions - - quicksight:UpdateDashboardPublishedVersion - - quicksight:DescribeTemplate - - quicksight:DescribeTheme - - quicksight:PassDataSet - - quicksight:TagResource - - quicksight:UntagResource - - quicksight:ListTagsForResource - delete: - - quicksight:DescribeDashboard - - quicksight:DeleteDashboard - list: - - quicksight:ListDashboards - CalculatedColumn: - type: object - description:

A calculated column for a dataset.

- properties: - ColumnId: - type: string - maxLength: 64 - minLength: 1 - description: |- -

A unique ID to identify a calculated column. During a dataset update, if the column ID - of a calculated column matches that of an existing calculated column, Amazon QuickSight - preserves the existing calculated column.

- ColumnName: - type: string - maxLength: 128 - minLength: 1 - description:

Column name.

- Expression: - type: string - maxLength: 4096 - minLength: 1 - description:

An expression that defines the calculated column.

required: - - ColumnId - - ColumnName - - Expression + - TargetSheetId + AnalysisSourceEntity: + description:

The source entity of an analysis.

additionalProperties: false - CastColumnTypeOperation: type: object - description:

A transform operation that casts a column to a different type.

properties: - ColumnName: - type: string - maxLength: 128 - minLength: 1 - description:

Column name.

- Format: - type: string - maxLength: 32 - minLength: 0 - description: |- -

When casting a column from string to datetime type, you can supply a string in a - format supported by Amazon QuickSight to denote the source data format.

- NewColumnType: - $ref: '#/components/schemas/ColumnDataType' - SubType: - $ref: '#/components/schemas/ColumnSubDataType' - required: - - ColumnName - - NewColumnType - additionalProperties: false - ColumnDataType: - type: string - enum: - - STRING - - INTEGER - - DECIMAL - - DATETIME - ColumnSubDataType: + SourceTemplate: + $ref: '#/components/schemas/AnalysisSourceTemplate' + DataLabelContent: type: string enum: - - FIXED - - FLOAT - ColumnDescription: + - VALUE + - PERCENT + - VALUE_AND_PERCENT + WaterfallChartOptions: + additionalProperties: false type: object - description:

Metadata that contains a description for a column.

properties: - Text: + TotalBarLabel: type: string - maxLength: 500 - minLength: 0 - description:

The text of a description for a column.

+ SankeyDiagramFieldWells: additionalProperties: false - ColumnGroup: type: object - description: |- -

Groupings of columns that work together in certain Amazon QuickSight features. This is - a variant type structure. For this structure to be valid, only one of the attributes can - be non-null.

properties: - GeoSpatialColumnGroup: - $ref: '#/components/schemas/GeoSpatialColumnGroup' + SankeyDiagramAggregatedFieldWells: + $ref: '#/components/schemas/SankeyDiagramAggregatedFieldWells' + SmallMultiplesAxisPlacement: + type: string + enum: + - OUTSIDE + - INSIDE + TableFieldWells: additionalProperties: false - ColumnLevelPermissionRule: type: object properties: - ColumnNames: - type: array - items: - type: string - minItems: 1 - Principals: - type: array - items: - type: string - maxItems: 100 - minItems: 1 + TableUnaggregatedFieldWells: + $ref: '#/components/schemas/TableUnaggregatedFieldWells' + TableAggregatedFieldWells: + $ref: '#/components/schemas/TableAggregatedFieldWells' + RadarChartConfiguration: additionalProperties: false - ColumnTag: type: object - description: |- -

A tag for a column in a TagColumnOperation structure. This is a - variant type structure. For this structure to be valid, only one of the attributes can - be non-null.

properties: - ColumnGeographicRole: - $ref: '#/components/schemas/GeoSpatialDataRole' - ColumnDescription: - $ref: '#/components/schemas/ColumnDescription' + SortConfiguration: + $ref: '#/components/schemas/RadarChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + Shape: + $ref: '#/components/schemas/RadarChartShape' + BaseSeriesSettings: + $ref: '#/components/schemas/RadarChartSeriesSettings' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + AxesRangeScale: + $ref: '#/components/schemas/RadarChartAxesRangeScale' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + AlternateBandColorsVisibility: {} + StartAngle: + maximum: 360 + type: number + minimum: -360 + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + FieldWells: + $ref: '#/components/schemas/RadarChartFieldWells' + ColorAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + AlternateBandOddColor: + pattern: ^#[A-F0-9]{6}$ + type: string + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + AlternateBandEvenColor: + pattern: ^#[A-F0-9]{6}$ + type: string + VisualTitleLabelOptions: additionalProperties: false - CreateColumnsOperation: type: object - description: |- -

A transform operation that creates calculated columns. Columns created in one such - operation form a lexical closure.

properties: - Columns: - type: array - items: - $ref: '#/components/schemas/CalculatedColumn' - maxItems: 128 - minItems: 1 - description:

Calculated columns to create.

- required: - - Columns + Visibility: {} + FormatText: + $ref: '#/components/schemas/ShortFormatText' + ParameterTextFieldControl: additionalProperties: false - CustomSql: type: object - description:

A physical table type built from the results of the custom SQL query.

properties: - DataSourceArn: - type: string - description:

The Amazon Resource Name (ARN) of the data source.

- SqlQuery: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - maxLength: 65536 + maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/TextFieldControlDisplayOptions' + SourceParameterName: minLength: 1 - description:

The SQL query.

- Columns: - type: array - items: - $ref: '#/components/schemas/InputColumn' - maxItems: 2048 - minItems: 1 - description:

The column schema from the SQL query result set.

- Name: + pattern: ^[a-zA-Z0-9]+$ type: string - maxLength: 128 + maxLength: 2048 + Title: minLength: 1 - description:

A display name for the SQL query result.

+ type: string + maxLength: 2048 required: - - Columns - - DataSourceArn - - Name - - SqlQuery - additionalProperties: false - DataSetImportMode: + - ParameterControlId + - SourceParameterName + - Title + URLTargetConfiguration: type: string enum: - - SPICE - - DIRECT_QUERY - DatasetParameter: - type: object - description:

A parameter created in the dataset that could be of any one data type such as string, integer, decimal or datetime.

- properties: - StringDatasetParameter: - $ref: '#/components/schemas/StringDatasetParameter' - DecimalDatasetParameter: - $ref: '#/components/schemas/DecimalDatasetParameter' - IntegerDatasetParameter: - $ref: '#/components/schemas/IntegerDatasetParameter' - DateTimeDatasetParameter: - $ref: '#/components/schemas/DateTimeDatasetParameter' - additionalProperties: false - DatasetParameterId: - type: string - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9-]+$ - description:

Identifier of the parameter created in the dataset.

- DatasetParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - description:

Name of the parameter created in the dataset.

- DatasetParameterValueType: - type: string - enum: - - MULTI_VALUED - - SINGLE_VALUED - description:

Every parameter value could be either a single value or multi value which helps to validate before evaluation.

- DateTimeDatasetParameter: - type: object - description:

A parameter created in the dataset of date time data type.

- properties: - Id: - $ref: '#/components/schemas/DatasetParameterId' - Name: - $ref: '#/components/schemas/DatasetParameterName' - ValueType: - $ref: '#/components/schemas/DatasetParameterValueType' - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - DefaultValues: - $ref: '#/components/schemas/DateTimeDatasetParameterDefaultValues' - required: - - Id - - Name - - ValueType - additionalProperties: false - DateTimeDatasetParameterDefaultValues: - type: object - description:

List of default values defined for a given string date time parameter type. Currently only static values are supported.

- properties: - StaticValues: - $ref: '#/components/schemas/DateTimeDatasetParameterValueList' - description:

List of static default values defined for a given string date time parameter type.

- additionalProperties: false - DateTimeDatasetParameterValueList: - type: array - items: - type: string - description:

Default value defined for the dataset parameter of date time type.

- maxItems: 32 - minItems: 1 - DecimalDatasetParameter: - type: object - description:

A parameter created in the dataset of decimal data type.

- properties: - Id: - $ref: '#/components/schemas/DatasetParameterId' - Name: - $ref: '#/components/schemas/DatasetParameterName' - ValueType: - $ref: '#/components/schemas/DatasetParameterValueType' - DefaultValues: - $ref: '#/components/schemas/DecimalDatasetParameterDefaultValues' - required: - - Id - - Name - - ValueType + - NEW_TAB + - NEW_WINDOW + - SAME_TAB + WordCloudFieldWells: additionalProperties: false - DecimalDatasetParameterDefaultValues: type: object - description:

List of default values defined for a given decimal dataset parameter type. Currently only static values are supported.

properties: - StaticValues: - $ref: '#/components/schemas/DecimalDatasetParameterValueList' - description:

List of static default values defined for a given decimal dataset parameter type.

+ WordCloudAggregatedFieldWells: + $ref: '#/components/schemas/WordCloudAggregatedFieldWells' + AggregationFunction: additionalProperties: false - DecimalDatasetParameterValueList: - type: array - items: - type: number - description:

Default value defined for the dataset parameter of decimal type.

- maxItems: 32 - minItems: 1 - IntegerDatasetParameter: type: object - description:

A parameter created in the dataset of integer data type.

properties: - Id: - $ref: '#/components/schemas/DatasetParameterId' - Name: - $ref: '#/components/schemas/DatasetParameterName' - ValueType: - $ref: '#/components/schemas/DatasetParameterValueType' - DefaultValues: - $ref: '#/components/schemas/IntegerDatasetParameterDefaultValues' - required: - - Id - - Name - - ValueType + AttributeAggregationFunction: + $ref: '#/components/schemas/AttributeAggregationFunction' + DateAggregationFunction: + $ref: '#/components/schemas/DateAggregationFunction' + NumericalAggregationFunction: + $ref: '#/components/schemas/NumericalAggregationFunction' + CategoricalAggregationFunction: + $ref: '#/components/schemas/CategoricalAggregationFunction' + GeospatialColor: additionalProperties: false - IntegerDatasetParameterDefaultValues: type: object - description:

List of default values defined for a given integer dataset parameter type. Currently only static values are supported.

properties: - StaticValues: - $ref: '#/components/schemas/IntegerDatasetParameterValueList' - description:

List of static default values defined for a given integer dataset parameter type.

+ Gradient: + $ref: '#/components/schemas/GeospatialGradientColor' + Categorical: + $ref: '#/components/schemas/GeospatialCategoricalColor' + Solid: + $ref: '#/components/schemas/GeospatialSolidColor' + TableStyleTarget: additionalProperties: false - IntegerDatasetParameterValueList: - type: array - items: - type: number - description:

Default value defined for the dataset parameter of integer type.

- maxItems: 32 - minItems: 1 - StringDatasetParameter: type: object - description:

A parameter created in the dataset of string data type.

properties: - Id: - $ref: '#/components/schemas/DatasetParameterId' - Name: - $ref: '#/components/schemas/DatasetParameterName' - ValueType: - $ref: '#/components/schemas/DatasetParameterValueType' - DefaultValues: - $ref: '#/components/schemas/StringDatasetParameterDefaultValues' + CellType: + $ref: '#/components/schemas/StyledCellType' required: - - Id - - Name - - ValueType + - CellType + GeospatialWindowOptions: additionalProperties: false - StringDatasetParameterDefaultValues: type: object - description:

List of default values defined for a given string dataset parameter type. Currently only static values are supported.

properties: - StaticValues: - $ref: '#/components/schemas/StringDatasetParameterValueList' - description:

List of static default values defined for a given string dataset parameter type.

+ Bounds: + $ref: '#/components/schemas/GeospatialCoordinateBounds' + MapZoomMode: + $ref: '#/components/schemas/MapZoomMode' + KPIConditionalFormatting: additionalProperties: false - StringDatasetParameterValueList: - type: array - items: - type: string - description:

Default value defined for the dataset parameter of string type.

- maxItems: 32 - minItems: 1 - FieldFolder: type: object properties: - Description: - type: string - maxLength: 500 - minLength: 0 - Columns: + ConditionalFormattingOptions: + minItems: 0 + maxItems: 100 type: array items: - type: string - maxItems: 5000 - minItems: 0 + $ref: '#/components/schemas/KPIConditionalFormattingOption' + KPIConditionalFormattingOption: additionalProperties: false - FieldFolderMap: type: object - x-patternProperties: - .+: - $ref: '#/components/schemas/FieldFolder' - additionalProperties: false - FileFormat: + properties: + PrimaryValue: + $ref: '#/components/schemas/KPIPrimaryValueConditionalFormatting' + ActualValue: + $ref: '#/components/schemas/KPIActualValueConditionalFormatting' + ComparisonValue: + $ref: '#/components/schemas/KPIComparisonValueConditionalFormatting' + ProgressBar: + $ref: '#/components/schemas/KPIProgressBarConditionalFormatting' + LineChartMarkerShape: type: string enum: - - CSV - - TSV - - CLF - - ELF - - XLSX - - JSON - FilterOperation: - type: object - description:

A transform operation that filters rows based on a condition.

- properties: - ConditionExpression: - type: string - maxLength: 4096 - minLength: 1 - description: |- -

An expression that must evaluate to a Boolean value. Rows for which the expression - evaluates to true are kept in the dataset.

- required: - - ConditionExpression + - CIRCLE + - TRIANGLE + - SQUARE + - DIAMOND + - ROUNDED_SQUARE + GeospatialStaticFileSource: additionalProperties: false - GeoSpatialColumnGroup: type: object - description:

Geospatial column group that denotes a hierarchy.

properties: - Columns: - type: array - items: - type: string - maxLength: 128 - minLength: 1 - maxItems: 16 - minItems: 1 - description:

Columns in this hierarchy.

- CountryCode: - $ref: '#/components/schemas/GeoSpatialCountryCode' - Name: - type: string - maxLength: 64 + StaticFileId: minLength: 1 - description:

A display name for the hierarchy.

+ pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - Columns - - Name + - StaticFileId + ArcAxisDisplayRange: additionalProperties: false - GeoSpatialCountryCode: - type: string - enum: - - US - GeoSpatialDataRole: - type: string - enum: - - COUNTRY - - STATE - - COUNTY - - CITY - - POSTCODE - - LONGITUDE - - LATITUDE - - POLITICAL1 - InputColumn: type: object - description:

Metadata for a column that is used as the input of a transform operation.

properties: - Type: - $ref: '#/components/schemas/InputColumnDataType' - SubType: - $ref: '#/components/schemas/ColumnSubDataType' - Name: - type: string - maxLength: 128 - minLength: 1 - description:

The name of this column in the underlying data source.

- required: - - Name - - Type + Min: + default: null + type: number + Max: + default: null + type: number + ParameterDeclaration: additionalProperties: false - InputColumnDataType: - type: string - enum: - - STRING - - INTEGER - - DECIMAL - - DATETIME - - BIT - - BOOLEAN - - JSON - RefreshConfiguration: type: object - description:

Refresh Configuration.

properties: - IncrementalRefresh: - $ref: '#/components/schemas/IncrementalRefresh' + StringParameterDeclaration: + $ref: '#/components/schemas/StringParameterDeclaration' + DateTimeParameterDeclaration: + $ref: '#/components/schemas/DateTimeParameterDeclaration' + DecimalParameterDeclaration: + $ref: '#/components/schemas/DecimalParameterDeclaration' + IntegerParameterDeclaration: + $ref: '#/components/schemas/IntegerParameterDeclaration' + Visual: additionalProperties: false - IncrementalRefresh: type: object - description:

Incremental Refresh

properties: - LookbackWindow: - $ref: '#/components/schemas/LookbackWindow' + FunnelChartVisual: + $ref: '#/components/schemas/FunnelChartVisual' + BoxPlotVisual: + $ref: '#/components/schemas/BoxPlotVisual' + GeospatialMapVisual: + $ref: '#/components/schemas/GeospatialMapVisual' + ScatterPlotVisual: + $ref: '#/components/schemas/ScatterPlotVisual' + RadarChartVisual: + $ref: '#/components/schemas/RadarChartVisual' + ComboChartVisual: + $ref: '#/components/schemas/ComboChartVisual' + WordCloudVisual: + $ref: '#/components/schemas/WordCloudVisual' + SankeyDiagramVisual: + $ref: '#/components/schemas/SankeyDiagramVisual' + GaugeChartVisual: + $ref: '#/components/schemas/GaugeChartVisual' + FilledMapVisual: + $ref: '#/components/schemas/FilledMapVisual' + WaterfallVisual: + $ref: '#/components/schemas/WaterfallVisual' + CustomContentVisual: + $ref: '#/components/schemas/CustomContentVisual' + PieChartVisual: + $ref: '#/components/schemas/PieChartVisual' + KPIVisual: + $ref: '#/components/schemas/KPIVisual' + HistogramVisual: + $ref: '#/components/schemas/HistogramVisual' + PluginVisual: + $ref: '#/components/schemas/PluginVisual' + TableVisual: + $ref: '#/components/schemas/TableVisual' + PivotTableVisual: + $ref: '#/components/schemas/PivotTableVisual' + BarChartVisual: + $ref: '#/components/schemas/BarChartVisual' + HeatMapVisual: + $ref: '#/components/schemas/HeatMapVisual' + TreeMapVisual: + $ref: '#/components/schemas/TreeMapVisual' + InsightVisual: + $ref: '#/components/schemas/InsightVisual' + LineChartVisual: + $ref: '#/components/schemas/LineChartVisual' + EmptyVisual: + $ref: '#/components/schemas/EmptyVisual' + WordCloudChartConfiguration: additionalProperties: false - LookbackWindow: type: object properties: - ColumnName: - type: string - description:

Column Name

- Size: - type: number - description:

Size

- minimum: 1 - SizeUnit: - $ref: '#/components/schemas/SizeUnit' + SortConfiguration: + $ref: '#/components/schemas/WordCloudSortConfiguration' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/WordCloudFieldWells' + WordCloudOptions: + $ref: '#/components/schemas/WordCloudOptions' + Interactions: + $ref: '#/components/schemas/VisualInteractionOptions' + CustomContentVisual: additionalProperties: false - SizeUnit: - type: string - enum: - - HOUR - - DAY - - WEEK - JoinInstruction: type: object - description:

Join instruction.

properties: - OnClause: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/CustomContentConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + DataSetIdentifier: minLength: 1 - description:

On Clause.

- Type: - $ref: '#/components/schemas/JoinType' - LeftJoinKeyProperties: - $ref: '#/components/schemas/JoinKeyProperties' - LeftOperand: type: string - maxLength: 64 + maxLength: 2048 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + VisualContentAltText: minLength: 1 - pattern: '[0-9a-zA-Z-]*' - description:

Left operand.

- RightOperand: type: string - maxLength: 64 - minLength: 1 - pattern: '[0-9a-zA-Z-]*' - description:

Right operand.

- RightJoinKeyProperties: - $ref: '#/components/schemas/JoinKeyProperties' + maxLength: 1024 required: - - LeftOperand - - OnClause - - RightOperand - - Type - additionalProperties: false - JoinKeyProperties: - type: object - properties: - UniqueKey: - type: boolean - additionalProperties: false - JoinType: + - DataSetIdentifier + - VisualId + GeospatialMapNavigation: type: string enum: - - INNER - - OUTER - - LEFT - - RIGHT - LogicalTable: - type: object - description: |- -

A logical table is a unit that joins and that data - transformations operate on. A logical table has a source, which can be either a physical - table or result of a join. When a logical table points to a physical table, the logical - table acts as a mutable copy of that physical table through transform operations.

- properties: - Alias: - type: string - maxLength: 64 - minLength: 1 - description:

A display name for the logical table.

- DataTransforms: - type: array - items: - $ref: '#/components/schemas/TransformOperation' - maxItems: 2048 - minItems: 1 - description:

Transform operations that act on this logical table.

- Source: - $ref: '#/components/schemas/LogicalTableSource' - required: - - Alias - - Source - additionalProperties: false - LogicalTableMap: - type: object - maxProperties: 64 - minProperties: 1 - x-patternProperties: - '[0-9a-zA-Z-]*': - $ref: '#/components/schemas/LogicalTable' + - ENABLED + - DISABLED + PanelConfiguration: additionalProperties: false - LogicalTableSource: type: object - description: |- -

Information about the source of a logical table. This is a variant type structure. For - this structure to be valid, only one of the attributes can be non-null.

properties: - PhysicalTableId: + BorderThickness: + description: String based length that is composed of value and unit in px type: string - maxLength: 64 - minLength: 1 - pattern: '[0-9a-zA-Z-]*' - description:

Physical table ID.

- JoinInstruction: - $ref: '#/components/schemas/JoinInstruction' - DataSetArn: + BorderStyle: + $ref: '#/components/schemas/PanelBorderStyle' + GutterSpacing: + description: String based length that is composed of value and unit in px type: string - description:

The Amazon Resource Name (ARN) for the dataset.

- additionalProperties: false - NewDefaultValues: - type: object - properties: - StringStaticValues: - $ref: '#/components/schemas/StringDatasetParameterValueList' - DecimalStaticValues: - $ref: '#/components/schemas/DecimalDatasetParameterValueList' - DateTimeStaticValues: - $ref: '#/components/schemas/DateTimeDatasetParameterValueList' - IntegerStaticValues: - $ref: '#/components/schemas/IntegerDatasetParameterValueList' - additionalProperties: false - OutputColumn: - type: object - description:

Output column.

- properties: - Type: - $ref: '#/components/schemas/ColumnDataType' - SubType: - $ref: '#/components/schemas/ColumnSubDataType' - Description: + BackgroundVisibility: {} + BorderVisibility: {} + BorderColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string - maxLength: 500 - minLength: 0 - description:

A description for a column.

- Name: + Title: + $ref: '#/components/schemas/PanelTitleOptions' + GutterVisibility: {} + BackgroundColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string - maxLength: 128 - minLength: 1 - description:

A display name for the dataset.

+ StaticFileS3SourceOptions: additionalProperties: false - OverrideDatasetParameterOperation: type: object - description:

A transform operation that overrides the dataset parameter values defined in another dataset.

properties: - ParameterName: - $ref: '#/components/schemas/DatasetParameterName' - description:

The name of the parameter to be overridden with different values.

- NewParameterName: - $ref: '#/components/schemas/DatasetParameterName' - description:

The new name for the parameter.

- NewDefaultValues: - $ref: '#/components/schemas/NewDefaultValues' - description:

The new default values for the parameter.

+ BucketName: + type: string + ObjectKey: + type: string + Region: + type: string required: - - ParameterName + - BucketName + - ObjectKey + - Region + SmallMultiplesOptions: additionalProperties: false - PhysicalTable: type: object - description: |- -

A view of a data source that contains information about the shape of the data in the - underlying source. This is a variant type structure. For this structure to be valid, - only one of the attributes can be non-null.

properties: - RelationalTable: - $ref: '#/components/schemas/RelationalTable' - CustomSql: - $ref: '#/components/schemas/CustomSql' - S3Source: - $ref: '#/components/schemas/S3Source' + MaxVisibleRows: + maximum: 10 + type: number + minimum: 1 + PanelConfiguration: + $ref: '#/components/schemas/PanelConfiguration' + MaxVisibleColumns: + maximum: 10 + type: number + minimum: 1 + XAxis: + $ref: '#/components/schemas/SmallMultiplesAxisProperties' + YAxis: + $ref: '#/components/schemas/SmallMultiplesAxisProperties' + BodySectionRepeatDimensionConfiguration: additionalProperties: false - PhysicalTableMap: type: object - maxProperties: 32 - minProperties: 0 - x-patternProperties: - '[0-9a-zA-Z-]*': - $ref: '#/components/schemas/PhysicalTable' + properties: + DynamicNumericDimensionConfiguration: + $ref: '#/components/schemas/BodySectionDynamicNumericDimensionConfiguration' + DynamicCategoryDimensionConfiguration: + $ref: '#/components/schemas/BodySectionDynamicCategoryDimensionConfiguration' + AnalysisDefinition: additionalProperties: false - ProjectOperation: type: object - description: |- -

A transform operation that projects columns. Operations that come after a projection - can only refer to projected columns.

properties: - ProjectedColumns: + Options: + $ref: '#/components/schemas/AssetOptions' + FilterGroups: + minItems: 0 + maxItems: 2000 type: array items: - type: string - maxItems: 2000 - minItems: 1 - description:

Projected columns.

- required: - - ProjectedColumns - additionalProperties: false - RelationalTable: - type: object - description:

A physical table type for relational data sources.

- properties: - DataSourceArn: - type: string - description:

The Amazon Resource Name (ARN) for the data source.

- InputColumns: + $ref: '#/components/schemas/FilterGroup' + QueryExecutionOptions: + $ref: '#/components/schemas/QueryExecutionOptions' + StaticFiles: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/InputColumn' - maxItems: 2048 + $ref: '#/components/schemas/StaticFile' + CalculatedFields: + minItems: 0 + maxItems: 500 + type: array + items: + $ref: '#/components/schemas/CalculatedField' + DataSetIdentifierDeclarations: minItems: 1 - description:

The column schema of the table.

- Schema: - type: string - maxLength: 64 - minLength: 0 - description:

The schema name. This name applies to certain relational database engines.

- Catalog: - type: string - description:

The catalog associated with a table.

- maxLength: 256 - minLength: 0 - Name: - type: string - maxLength: 64 - minLength: 1 - description:

The name of the relational table.

+ maxItems: 50 + type: array + items: + $ref: '#/components/schemas/DataSetIdentifierDeclaration' + ColumnConfigurations: + minItems: 0 + maxItems: 2000 + type: array + items: + $ref: '#/components/schemas/ColumnConfiguration' + AnalysisDefaults: + $ref: '#/components/schemas/AnalysisDefaults' + Sheets: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/SheetDefinition' + ParameterDeclarations: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ParameterDeclaration' required: - - DataSourceArn - - InputColumns - - Name + - DataSetIdentifierDeclarations + PaperOrientation: + type: string + enum: + - PORTRAIT + - LANDSCAPE + GeospatialNullSymbolStyle: additionalProperties: false - RenameColumnOperation: type: object - description:

A transform operation that renames a column.

properties: - NewColumnName: + FillColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string - maxLength: 128 - minLength: 1 - description:

The new name for the column.

- ColumnName: + StrokeWidth: + type: number + minimum: 0 + StrokeColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ type: string - maxLength: 128 - minLength: 1 - description:

The name of the column to be renamed.

- required: - - ColumnName - - NewColumnName + NumericSeparatorConfiguration: additionalProperties: false - RowLevelPermissionDataSet: type: object - description:

The row-level security configuration for the dataset.

properties: - Arn: - type: string - description:

The Amazon Resource Name (ARN) of the permission dataset.

- Namespace: - type: string - maxLength: 64 - minLength: 0 - pattern: ^[a-zA-Z0-9._-]*$ - description:

The namespace associated with the row-level permissions dataset.

- PermissionPolicy: - $ref: '#/components/schemas/RowLevelPermissionPolicy' - FormatVersion: - $ref: '#/components/schemas/RowLevelPermissionFormatVersion' - Status: - $ref: '#/components/schemas/Status' - required: - - Arn - - PermissionPolicy + DecimalSeparator: + $ref: '#/components/schemas/NumericSeparatorSymbol' + ThousandsSeparator: + $ref: '#/components/schemas/ThousandSeparatorOptions' + ContextMenuOption: additionalProperties: false - RowLevelPermissionPolicy: - type: string - enum: - - GRANT_ACCESS - - DENY_ACCESS - RowLevelPermissionFormatVersion: - type: string - enum: - - VERSION_1 - - VERSION_2 - RowLevelPermissionTagConfiguration: type: object - description:

The configuration of tags on a dataset to set row-level security.

properties: - Status: - $ref: '#/components/schemas/Status' - TagRules: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + CustomParameterValues: + additionalProperties: false + type: object + properties: + DecimalValues: + minItems: 0 + maxItems: 50000 type: array items: - $ref: '#/components/schemas/RowLevelPermissionTagRule' - maxItems: 50 - minItems: 1 - description:

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

- TagRuleConfigurations: + type: number + IntegerValues: + minItems: 0 + maxItems: 50000 type: array items: - $ref: '#/components/schemas/RowLevelPermissionTagRuleConfiguration' - maxItems: 50 - minItems: 1 - description:

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

- required: - - TagRules - additionalProperties: false - Status: + type: number + StringValues: + minItems: 0 + maxItems: 50000 + type: array + items: + type: string + DateTimeValues: + minItems: 0 + maxItems: 50000 + type: array + items: + format: date-time + type: string + SimpleNumericalAggregationFunction: type: string enum: - - ENABLED - - DISABLED - RowLevelPermissionTagRule: + - SUM + - AVERAGE + - MIN + - MAX + - COUNT + - DISTINCT_COUNT + - VAR + - VARP + - STDEV + - STDEVP + - MEDIAN + BoxPlotOptions: + additionalProperties: false type: object - description:

Permission for the resource.

properties: - ColumnName: - type: string - description:

The column name that a tag key is assigned to.

- TagKey: - type: string - maxLength: 128 - minLength: 1 - description:

The unique key for a tag.

- MatchAllValue: - type: string - maxLength: 256 - minLength: 1 - description:

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

- TagMultiValueDelimiter: - type: string - maxLength: 10 - description:

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

- required: - - ColumnName - - TagKey + StyleOptions: + $ref: '#/components/schemas/BoxPlotStyleOptions' + OutlierVisibility: {} + AllDataPointsVisibility: {} + KPIPrimaryValueConditionalFormatting: additionalProperties: false - RowLevelPermissionTagRuleConfiguration: - type: array - items: - type: string - maxLength: 128 - minLength: 1 - maxItems: 50 - minItems: 1 - S3Source: type: object - description:

A physical table type for as S3 data source.

properties: - DataSourceArn: - type: string - description:

The amazon Resource Name (ARN) for the data source.

- InputColumns: - type: array - items: - $ref: '#/components/schemas/InputColumn' - maxItems: 2048 - minItems: 1 - description:

A physical table type for as S3 data source.

- UploadSettings: - $ref: '#/components/schemas/UploadSettings' - required: - - DataSourceArn - - InputColumns + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + NumberDisplayFormatConfiguration: additionalProperties: false - TagColumnOperation: type: object - description:

A transform operation that tags a column with additional information.

properties: - ColumnName: + NegativeValueConfiguration: + $ref: '#/components/schemas/NegativeValueConfiguration' + DecimalPlacesConfiguration: + $ref: '#/components/schemas/DecimalPlacesConfiguration' + NumberScale: + $ref: '#/components/schemas/NumberScale' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + Suffix: + minLength: 1 type: string maxLength: 128 + SeparatorConfiguration: + $ref: '#/components/schemas/NumericSeparatorConfiguration' + Prefix: minLength: 1 - description:

The column that this operation acts on.

- Tags: - type: array - items: - $ref: '#/components/schemas/ColumnTag' - maxItems: 16 - minItems: 1 - description: |- -

The dataset column tag, currently only used for geospatial type tagging. .

- -

This is not tags for the AWS tagging feature. .

- - required: - - ColumnName - - Tags + type: string + maxLength: 128 + VisualInteractionOptions: additionalProperties: false - TextQualifier: - type: string - enum: - - DOUBLE_QUOTE - - SINGLE_QUOTE - TransformOperation: type: object - description: |- -

A data transformation on a logical table. This is a variant type structure. For this - structure to be valid, only one of the attributes can be non-null.

- properties: - TagColumnOperation: - $ref: '#/components/schemas/TagColumnOperation' - FilterOperation: - $ref: '#/components/schemas/FilterOperation' - CastColumnTypeOperation: - $ref: '#/components/schemas/CastColumnTypeOperation' - CreateColumnsOperation: - $ref: '#/components/schemas/CreateColumnsOperation' - RenameColumnOperation: - $ref: '#/components/schemas/RenameColumnOperation' - ProjectOperation: - $ref: '#/components/schemas/ProjectOperation' - OverrideDatasetParameterOperation: - $ref: '#/components/schemas/OverrideDatasetParameterOperation' - additionalProperties: false - UploadSettings: - type: object - description:

Information about the format for a source file or files.

- properties: - ContainsHeader: - type: boolean - description:

Whether the file has a header row, or the files each have a header row.

- TextQualifier: - $ref: '#/components/schemas/TextQualifier' - Format: - $ref: '#/components/schemas/FileFormat' - StartFromRow: - type: number - minimum: 1 - description:

A row number to start reading data from.

- Delimiter: - type: string - maxLength: 1 - minLength: 1 - description:

The delimiter between values in the file.

- additionalProperties: false - IngestionWaitPolicy: - type: object - description:

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

- properties: - WaitForSpiceIngestion: - type: boolean - description: |- -

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true). - Applicable only when DataSetImportMode mode is set to SPICE.

- default: true - IngestionWaitTimeInHours: - type: number - description: |- -

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. - Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

- minimum: 1 - maximum: 36 - default: 36 - additionalProperties: false - DataSetUsageConfiguration: - type: object - description:

The dataset usage configuration for the dataset.

properties: - DisableUseAsDirectQuerySource: - type: boolean - DisableUseAsImportedSource: - type: boolean + ContextMenuOption: + $ref: '#/components/schemas/ContextMenuOption' + VisualMenuOption: + $ref: '#/components/schemas/VisualMenuOption' + PivotTableFieldWells: additionalProperties: false - DataSetRefreshProperties: type: object - description:

The dataset refresh properties for the dataset.

properties: - RefreshConfiguration: - $ref: '#/components/schemas/RefreshConfiguration' - additionalProperties: false - DataSet: + PivotTableAggregatedFieldWells: + $ref: '#/components/schemas/PivotTableAggregatedFieldWells' + Analysis: type: object properties: - Arn: - type: string - description:

The Amazon Resource Name (ARN) of the resource.

- AwsAccountId: + Status: + $ref: '#/components/schemas/ResourceStatus' + CreatedTime: + format: date-time + description:

The time that the analysis was created.

type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ - ColumnGroups: - type: array - items: - $ref: '#/components/schemas/ColumnGroup' - maxItems: 8 - minItems: 1 - description:

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

- ColumnLevelPermissionRules: + Parameters: + $ref: '#/components/schemas/Parameters' + DataSetArns: + minItems: 0 + maxItems: 100 + description:

The ARNs of the datasets of the analysis.

type: array items: - $ref: '#/components/schemas/ColumnLevelPermissionRule' - minItems: 1 - ConsumedSpiceCapacityInBytes: - type: number - description: |- -

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't - imported into SPICE.

- CreatedTime: + type: string + SourceEntity: + $ref: '#/components/schemas/AnalysisSourceEntity' + ThemeArn: + description:

The ARN of the theme of the analysis.

type: string - description:

The time that this dataset was created.

- format: string - DataSetId: + Definition: + $ref: '#/components/schemas/AnalysisDefinition' + LastUpdatedTime: + format: date-time + description:

The time that the analysis was last updated.

type: string - DatasetParameters: + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' + FolderArns: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/DatasetParameter' - maxItems: 32 - minItems: 1 - description:

The parameters declared in the dataset.

- FieldFolders: - $ref: '#/components/schemas/FieldFolderMap' - ImportMode: - $ref: '#/components/schemas/DataSetImportMode' - LastUpdatedTime: - type: string - description:

The last time that this dataset was updated.

- format: string - LogicalTableMap: - $ref: '#/components/schemas/LogicalTableMap' + type: string Name: - type: string - maxLength: 128 minLength: 1 - description:

The display name for the dataset.

- OutputColumns: + description:

The descriptive name of the analysis.

+ type: string + maxLength: 2048 + Errors: + minItems: 1 + description:

Errors associated with the analysis.

type: array items: - $ref: '#/components/schemas/OutputColumn' - description: |- -

The list of columns after all transforms. These columns are available in templates, - analyses, and dashboards.

+ $ref: '#/components/schemas/AnalysisError' + AnalysisId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 Permissions: + minItems: 1 + maxItems: 64 type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - description:

A list of resource permissions on the dataset.

- PhysicalTableMap: - $ref: '#/components/schemas/PhysicalTableMap' - RowLevelPermissionDataSet: - $ref: '#/components/schemas/RowLevelPermissionDataSet' - RowLevelPermissionTagConfiguration: - $ref: '#/components/schemas/RowLevelPermissionTagConfiguration' + Arn: + description:

The Amazon Resource Name (ARN) of the analysis.

+ type: string Tags: + minItems: 1 + maxItems: 200 type: array items: $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

- IngestionWaitPolicy: - $ref: '#/components/schemas/IngestionWaitPolicy' - DataSetUsageConfiguration: - $ref: '#/components/schemas/DataSetUsageConfiguration' - DataSetRefreshProperties: - $ref: '#/components/schemas/DataSetRefreshProperties' - x-stackql-resource-name: data_set - x-stackql-primaryIdentifier: + Sheets: + minItems: 0 + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

+ type: array + items: + $ref: '#/components/schemas/Sheet' + required: + - AwsAccountId + - AnalysisId + - Name + x-stackql-resource-name: analysis + description: Definition of the AWS::QuickSight::Analysis Resource Type. + x-type-name: AWS::QuickSight::Analysis + x-stackql-primary-identifier: + - AnalysisId - AwsAccountId - - DataSetId x-create-only-properties: + - AnalysisId - AwsAccountId - - DataSetId + x-write-only-properties: + - Definition + - Parameters + - SourceEntity + - Status + - ValidationStrategy + - FolderArns x-read-only-properties: - Arn - - ConsumedSpiceCapacityInBytes - CreatedTime + - DataSetArns - LastUpdatedTime - - OutputColumns + x-required-properties: + - AwsAccountId + - AnalysisId + - Name + x-tagging: + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - quicksight:DescribeAnalysis + - quicksight:DescribeAnalysisPermissions + - quicksight:ListTagsForResource create: - - quicksight:DescribeDataSet - - quicksight:DescribeDataSetPermissions - - quicksight:DescribeIngestion - - quicksight:ListIngestions - - quicksight:CreateDataSet - - quicksight:PassDataSource + - quicksight:DescribeAnalysis + - quicksight:DescribeAnalysisPermissions + - quicksight:CreateAnalysis + - quicksight:DescribeTemplate + - quicksight:DescribeTheme - quicksight:PassDataSet - quicksight:TagResource + - quicksight:UntagResource - quicksight:ListTagsForResource - - quicksight:DescribeDataSetRefreshProperties - - quicksight:PutDataSetRefreshProperties - read: - - quicksight:DescribeDataSet - - quicksight:DescribeDataSetPermissions - - quicksight:ListTagsForResource - - quicksight:DescribeDataSetRefreshProperties + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource update: - - quicksight:DescribeDataSet - - quicksight:DescribeDataSetPermissions - - quicksight:PassDataSource - - quicksight:UpdateDataSet - - quicksight:UpdateDataSetPermissions + - quicksight:DescribeAnalysis + - quicksight:DescribeAnalysisPermissions + - quicksight:UpdateAnalysis + - quicksight:UpdateAnalysisPermissions + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + - quicksight:DescribeTemplate + - quicksight:DescribeTheme - quicksight:PassDataSet - - quicksight:DescribeIngestion - - quicksight:ListIngestions - - quicksight:CancelIngestion - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource - - quicksight:PutDataSetRefreshProperties - - quicksight:DescribeDataSetRefreshProperties - - quicksight:DeleteDataSetRefreshProperties - delete: - - quicksight:DescribeDataSet - - quicksight:DeleteDataSet - - quicksight:ListTagsForResource - - quicksight:DescribeIngestion - - quicksight:DeleteDataSetRefreshProperties - - quicksight:DescribeDataSetRefreshProperties list: - - quicksight:DescribeDataSet - - quicksight:ListDataSets - AmazonElasticsearchParameters: + - quicksight:ListAnalyses + delete: + - quicksight:DescribeAnalysis + - quicksight:DeleteAnalysis + Capabilities: + type: object + properties: + ExportToCsv: + $ref: '#/components/schemas/CapabilityState' + ExportToExcel: + $ref: '#/components/schemas/CapabilityState' + ExportToPdf: + $ref: '#/components/schemas/CapabilityState' + PrintReports: + $ref: '#/components/schemas/CapabilityState' + CreateAndUpdateThemes: + $ref: '#/components/schemas/CapabilityState' + AddOrRunAnomalyDetectionForAnalyses: + $ref: '#/components/schemas/CapabilityState' + ShareAnalyses: + $ref: '#/components/schemas/CapabilityState' + CreateAndUpdateDatasets: + $ref: '#/components/schemas/CapabilityState' + ShareDatasets: + $ref: '#/components/schemas/CapabilityState' + SubscribeDashboardEmailReports: + $ref: '#/components/schemas/CapabilityState' + CreateAndUpdateDashboardEmailReports: + $ref: '#/components/schemas/CapabilityState' + ShareDashboards: + $ref: '#/components/schemas/CapabilityState' + CreateAndUpdateThresholdAlerts: + $ref: '#/components/schemas/CapabilityState' + RenameSharedFolders: + $ref: '#/components/schemas/CapabilityState' + CreateSharedFolders: + $ref: '#/components/schemas/CapabilityState' + CreateAndUpdateDataSources: + $ref: '#/components/schemas/CapabilityState' + ShareDataSources: + $ref: '#/components/schemas/CapabilityState' + ViewAccountSPICECapacity: + $ref: '#/components/schemas/CapabilityState' + CreateSPICEDataset: + $ref: '#/components/schemas/CapabilityState' + ExportToPdfInScheduledReports: + $ref: '#/components/schemas/CapabilityState' + ExportToCsvInScheduledReports: + $ref: '#/components/schemas/CapabilityState' + ExportToExcelInScheduledReports: + $ref: '#/components/schemas/CapabilityState' + IncludeContentInScheduledReportsEmail: + $ref: '#/components/schemas/CapabilityState' + additionalProperties: false + CapabilityState: + type: string + enum: + - DENY + CustomPermissions: type: object - description:

Amazon Elasticsearch Service parameters.

properties: - Domain: + Arn: + type: string + AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + Capabilities: + $ref: '#/components/schemas/Capabilities' + CustomPermissionsName: type: string maxLength: 64 minLength: 1 - description:

The Amazon Elasticsearch Service domain.

+ pattern: ^[a-zA-Z0-9+=,.@_-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 required: - - Domain - AmazonOpenSearchParameters: + - AwsAccountId + - CustomPermissionsName + x-stackql-resource-name: custom_permissions + description: Definition of the AWS::QuickSight::CustomPermissions Resource Type. + x-type-name: AWS::QuickSight::CustomPermissions + x-stackql-primary-identifier: + - AwsAccountId + - CustomPermissionsName + x-create-only-properties: + - AwsAccountId + - CustomPermissionsName + x-read-only-properties: + - Arn + x-required-properties: + - AwsAccountId + - CustomPermissionsName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + x-required-permissions: + create: + - quicksight:CreateCustomPermissions + - quicksight:TagResource + read: + - quicksight:DescribeCustomPermissions + - quicksight:ListTagsForResource + update: + - quicksight:UpdateCustomPermissions + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + delete: + - quicksight:DeleteCustomPermissions + list: + - quicksight:ListCustomPermissions + ExportToCSVOption: + description:

Export to .csv option.

+ additionalProperties: false type: object - description:

Amazon OpenSearch Service parameters.

properties: - Domain: - type: string - maxLength: 64 - minLength: 1 - description:

The Amazon OpenSearch Service domain.

- required: - - Domain - AthenaParameters: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DataPointDrillUpDownOption: + description:

The drill down options for data points in a dashbaord.

+ additionalProperties: false type: object - description:

Amazon Athena parameters.

properties: - WorkGroup: - type: string - maxLength: 128 - minLength: 1 - description:

The workgroup that Amazon Athena uses.

- RoleArn: - type: string - maxLength: 2048 - minLength: 20 - description:

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

- AuroraParameters: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + VisualAxisSortOption: + additionalProperties: false type: object - description:

Amazon Aurora parameters.

properties: - Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

- Database: - type: string - maxLength: 128 - minLength: 1 - description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

- required: - - Database - - Host - - Port - AuroraPostgreSqlParameters: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardError: + description:

Dashboard error.

+ additionalProperties: false type: object - description:

Amazon Aurora with PostgreSQL compatibility parameters.

properties: - Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

- Database: - type: string - maxLength: 128 - minLength: 1 - description:

Database.

- Host: + Type: + $ref: '#/components/schemas/DashboardErrorType' + Message: + pattern: \S + description:

Message.

type: string - maxLength: 256 - minLength: 1 - description:

Host.

- required: - - Database - - Host - - Port - AwsIotAnalyticsParameters: + ViolatedEntities: + minItems: 0 + maxItems: 200 + description:

Lists the violated entities that caused the dashboard error.

+ type: array + items: + $ref: '#/components/schemas/Entity' + ExportWithHiddenFieldsOption: + description:

Determines whether or not hidden fields are visible on exported dashbaords.

+ additionalProperties: false type: object - description:

AWS IoT Analytics parameters.

properties: - DataSetName: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardPublishOptions: + description:

Dashboard publish options.

+ additionalProperties: false + type: object + properties: + SheetControlsOption: + $ref: '#/components/schemas/SheetControlsOption' + DataPointDrillUpDownOption: + $ref: '#/components/schemas/DataPointDrillUpDownOption' + AdHocFilteringOption: + $ref: '#/components/schemas/AdHocFilteringOption' + VisualPublishOptions: + $ref: '#/components/schemas/DashboardVisualPublishOptions' + VisualAxisSortOption: + $ref: '#/components/schemas/VisualAxisSortOption' + ExportWithHiddenFieldsOption: + $ref: '#/components/schemas/ExportWithHiddenFieldsOption' + ExportToCSVOption: + $ref: '#/components/schemas/ExportToCSVOption' + DataPointMenuLabelOption: + $ref: '#/components/schemas/DataPointMenuLabelOption' + VisualMenuOption: + $ref: '#/components/schemas/VisualMenuOption' + DataPointTooltipOption: + $ref: '#/components/schemas/DataPointTooltipOption' + SheetLayoutElementMaximizationOption: + $ref: '#/components/schemas/SheetLayoutElementMaximizationOption' + DataPointTooltipOption: + description:

The data point tooltip options.

+ additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardSourceTemplate: + description:

Dashboard source template.

+ additionalProperties: false + type: object + properties: + DataSetReferences: + minItems: 1 + description:

Dataset references.

+ type: array + items: + $ref: '#/components/schemas/DataSetReference' + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

type: string - maxLength: 128 - minLength: 1 - description:

Dataset name.

required: - - DataSetName - CredentialPair: + - Arn + - DataSetReferences + LinkSharingConfiguration: + additionalProperties: false type: object - description:

The combination of user name and password that are used as credentials.

properties: - AlternateDataSourceParameters: + Permissions: + minItems: 1 + maxItems: 64 type: array items: - $ref: '#/components/schemas/DataSourceParameters' - maxItems: 50 + $ref: '#/components/schemas/ResourcePermission' + DashboardVersion: + description:

Dashboard version.

+ additionalProperties: false + type: object + properties: + Status: + $ref: '#/components/schemas/ResourceStatus' + Errors: minItems: 1 - description: |- -

A set of alternate data source parameters that you want to share for these - credentials. The credentials are applied in tandem with the data source parameters when - you copy a data source by using a create or update request. The API operation compares - the DataSourceParameters structure that's in the request with the - structures in the AlternateDataSourceParameters allow list. If the - structures are an exact match, the request is allowed to use the new data source with - the existing credentials. If the AlternateDataSourceParameters list is - null, the DataSourceParameters originally used with these - Credentials is automatically allowed.

- Username: + description:

Errors associated with this dashboard version.

+ type: array + items: + $ref: '#/components/schemas/DashboardError' + CreatedTime: + format: date-time + description:

The time that this dashboard version was created.

type: string - maxLength: 64 + Description: minLength: 1 - description:

User name.

- Password: + description:

Description.

type: string - maxLength: 1024 - minLength: 1 - description:

Password.

- required: - - Password - - Username - DatabricksParameters: - type: object - description:

Databricks parameters.

- properties: - Host: + maxLength: 512 + DataSetArns: + minItems: 0 + maxItems: 100 + description: |- +

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this + version of the dashboard.

+ type: array + items: + type: string + ThemeArn: + description:

The ARN of the theme associated with a version of the dashboard.

type: string - maxLength: 256 - minLength: 1 - description:

Host.

- Port: + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + SourceEntityArn: + description:

Source entity ARN.

+ type: string + VersionNumber: + description:

Version number for this version of the dashboard.

type: number - maximum: 65535 minimum: 1 - description:

Port.

- SqlEndpointPath: - type: string - maxLength: 4096 - minLength: 1 - description:

The HTTP Path of the Databricks data source.

- required: - - Host - - Port + Sheets: + minItems: 0 + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

+ type: array + items: + $ref: '#/components/schemas/Sheet' + SheetLayoutElementMaximizationOption: + description:

The sheet layout maximization options of a dashbaord.

+ additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardVersionDefinition: + additionalProperties: false + type: object + properties: + Options: + $ref: '#/components/schemas/AssetOptions' + FilterGroups: + minItems: 0 + maxItems: 2000 + type: array + items: + $ref: '#/components/schemas/FilterGroup' + StaticFiles: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/StaticFile' + CalculatedFields: + minItems: 0 + maxItems: 500 + type: array + items: + $ref: '#/components/schemas/CalculatedField' + DataSetIdentifierDeclarations: + minItems: 1 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/DataSetIdentifierDeclaration' + ColumnConfigurations: + minItems: 0 + maxItems: 2000 + type: array + items: + $ref: '#/components/schemas/ColumnConfiguration' + AnalysisDefaults: + $ref: '#/components/schemas/AnalysisDefaults' + Sheets: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/SheetDefinition' + ParameterDeclarations: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ParameterDeclaration' + required: + - DataSetIdentifierDeclarations + AdHocFilteringOption: + description:

An ad hoc (one-time) filtering option.

+ additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + ExportHiddenFieldsOption: + description:

Determines if hidden fields are included in an exported dashboard.

+ additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardUIState: + type: string + enum: + - EXPANDED + - COLLAPSED + DataPointMenuLabelOption: + description:

The data point menu options of a dashboard.

+ additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardErrorType: + type: string + enum: + - ACCESS_DENIED + - SOURCE_NOT_FOUND + - DATA_SET_NOT_FOUND + - INTERNAL_FAILURE + - PARAMETER_VALUE_INCOMPATIBLE + - PARAMETER_TYPE_INVALID + - PARAMETER_NOT_FOUND + - COLUMN_TYPE_MISMATCH + - COLUMN_GEOGRAPHIC_ROLE_MISMATCH + - COLUMN_REPLACEMENT_MISSING + SheetControlsOption: + description:

Sheet controls option.

+ additionalProperties: false + type: object + properties: + VisibilityState: + $ref: '#/components/schemas/DashboardUIState' + DashboardSourceEntity: + description:

Dashboard source entity.

+ additionalProperties: false + type: object + properties: + SourceTemplate: + $ref: '#/components/schemas/DashboardSourceTemplate' + DashboardVisualPublishOptions: + description:

The visual publish options of a visual in a dashboard

+ additionalProperties: false + type: object + properties: + ExportHiddenFieldsOption: + $ref: '#/components/schemas/ExportHiddenFieldsOption' + Dashboard: + type: object + properties: + CreatedTime: + format: date-time + description:

The time that this dashboard was created.

+ type: string + Parameters: + $ref: '#/components/schemas/Parameters' + VersionDescription: + minLength: 1 + type: string + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/DashboardSourceEntity' + ThemeArn: + type: string + Definition: + $ref: '#/components/schemas/DashboardVersionDefinition' + LastUpdatedTime: + format: date-time + description:

The last time that this dashboard was updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' + FolderArns: + minItems: 0 + maxItems: 10 + type: array + items: + type: string + DashboardId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + LinkSharingConfiguration: + $ref: '#/components/schemas/LinkSharingConfiguration' + Name: + minLength: 1 + type: string + maxLength: 2048 + DashboardPublishOptions: + $ref: '#/components/schemas/DashboardPublishOptions' + LastPublishedTime: + format: date-time + description:

The last time that this dashboard was published.

+ type: string + Version: + $ref: '#/components/schemas/DashboardVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + LinkEntities: + minItems: 0 + maxItems: 5 + type: array + items: + minLength: 1 + pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512}$ + type: string + maxLength: 1024 + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + Tags: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - AwsAccountId + - DashboardId + - Name + x-stackql-resource-name: dashboard + description: Definition of the AWS::QuickSight::Dashboard Resource Type. + x-type-name: AWS::QuickSight::Dashboard + x-stackql-primary-identifier: + - AwsAccountId + - DashboardId + x-create-only-properties: + - AwsAccountId + - DashboardId + x-write-only-properties: + - DashboardPublishOptions + - Definition + - LinkSharingConfiguration + - Parameters + - SourceEntity + - ThemeArn + - VersionDescription + - ValidationStrategy + - FolderArns + x-read-only-properties: + - Arn + - CreatedTime + - LastPublishedTime + - LastUpdatedTime + - Version + x-required-properties: + - AwsAccountId + - DashboardId + - Name + x-tagging: + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + x-required-permissions: + read: + - quicksight:DescribeDashboard + - quicksight:DescribeDashboardPermissions + - quicksight:ListTagsForResource + create: + - quicksight:DescribeDashboard + - quicksight:DescribeDashboardPermissions + - quicksight:CreateDashboard + - quicksight:DescribeTemplate + - quicksight:DescribeTheme + - quicksight:PassDataSet + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + update: + - quicksight:DescribeDashboard + - quicksight:DescribeDashboardPermissions + - quicksight:UpdateDashboard + - quicksight:UpdateDashboardLinks + - quicksight:UpdateDashboardPermissions + - quicksight:UpdateDashboardPublishedVersion + - quicksight:DescribeTemplate + - quicksight:DescribeTheme + - quicksight:PassDataSet + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + list: + - quicksight:ListDashboards + delete: + - quicksight:DescribeDashboard + - quicksight:DeleteDashboard + RowLevelPermissionPolicy: + type: string + enum: + - GRANT_ACCESS + - DENY_ACCESS + RowLevelPermissionTagRule: + description:

A set of rules associated with a tag.

+ additionalProperties: false + type: object + properties: + ColumnName: + description:

The column name that a tag key is assigned to.

+ type: string + TagKey: + minLength: 1 + description:

The unique key for a tag.

+ type: string + maxLength: 128 + MatchAllValue: + minLength: 1 + description:

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

+ type: string + maxLength: 256 + TagMultiValueDelimiter: + minLength: 0 + description:

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

+ type: string + maxLength: 10 + required: + - TagKey + FileFormat: + type: string + enum: + - CSV + - TSV + - CLF + - ELF + - XLSX + - JSON + JoinKeyProperties: + description:

Properties associated with the columns participating in a join.

+ additionalProperties: false + type: object + properties: + UniqueKey: + description: |- +

A value that indicates that a row in a table is uniquely identified by the columns in + a join key. This is used by Amazon QuickSight to optimize query performance.

+ type: boolean + DecimalDatasetParameterDefaultValues: + description:

The default values of a decimal parameter.

+ additionalProperties: false + type: object + properties: + StaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given decimal parameter.

+ type: array + items: + default: 0 + description:

The default value for the decimal parameter.

+ type: number + Status: + type: string + enum: + - ENABLED + - DISABLED + PhysicalTableMap: + x-patternProperties: + ^[0-9a-zA-Z-]*$: + $ref: '#/components/schemas/PhysicalTable' + maxProperties: 32 + additionalProperties: false + type: object + minProperties: 0 + RefreshConfiguration: + description:

The refresh configuration of a dataset.

+ additionalProperties: false + type: object + properties: + IncrementalRefresh: + $ref: '#/components/schemas/IncrementalRefresh' + required: + - IncrementalRefresh + RelationalTable: + description:

A physical table type for relational data sources.

+ additionalProperties: false + type: object + properties: + DataSourceArn: + description:

The Amazon Resource Name (ARN) for the data source.

+ type: string + InputColumns: + minItems: 0 + maxItems: 2048 + description:

The column schema of the table.

+ type: array + items: + $ref: '#/components/schemas/InputColumn' + Schema: + minLength: 0 + description:

The schema name. This name applies to certain relational database engines.

+ type: string + maxLength: 256 + Catalog: + minLength: 0 + description:

The catalog associated with a table.

+ type: string + maxLength: 256 + Name: + minLength: 1 + description:

The name of the relational table.

+ type: string + maxLength: 256 + required: + - DataSourceArn + - Name + PerformanceConfiguration: + additionalProperties: false + type: object + properties: + UniqueKeys: + minItems: 1 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/UniqueKey' + InputColumn: + description:

Metadata for a column that is used as the input of a transform operation.

+ additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/InputColumnDataType' + SubType: + $ref: '#/components/schemas/ColumnDataSubType' + Name: + minLength: 1 + description:

The name of this column in the underlying data source.

+ type: string + maxLength: 127 + required: + - Name + - Type + LogicalTableMap: + x-patternProperties: + ^[0-9a-zA-Z-]*$: + $ref: '#/components/schemas/LogicalTable' + maxProperties: 64 + additionalProperties: false + type: object + minProperties: 1 + DateTimeDatasetParameterDefaultValues: + description:

The default values of a date time parameter.

+ additionalProperties: false + type: object + properties: + StaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given date time parameter.

+ type: array + items: + description:

The default value for the date time parameter.

+ type: string + LogicalTableSource: + description: |- +

Information about the source of a logical table. This is a variant type structure. For + this structure to be valid, only one of the attributes can be non-null.

+ additionalProperties: false + type: object + properties: + PhysicalTableId: + minLength: 1 + pattern: ^[0-9a-zA-Z-]*$ + description:

Physical table ID.

+ type: string + maxLength: 64 + JoinInstruction: + $ref: '#/components/schemas/JoinInstruction' + DataSetArn: + description:

The Amazon Resource Number (ARN) of the parent dataset.

+ type: string + TextQualifier: + type: string + enum: + - DOUBLE_QUOTE + - SINGLE_QUOTE + DecimalDatasetParameter: + description:

A decimal parameter for a dataset.

+ additionalProperties: false + type: object + properties: + ValueType: + $ref: '#/components/schemas/DatasetParameterValueType' + DefaultValues: + $ref: '#/components/schemas/DecimalDatasetParameterDefaultValues' + Id: + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the decimal parameter created in the dataset.

+ type: string + maxLength: 128 + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the decimal parameter that is created in the dataset.

+ type: string + maxLength: 2048 + required: + - Id + - Name + - ValueType + DateTimeDatasetParameter: + description:

A date time parameter for a dataset.

+ additionalProperties: false + type: object + properties: + ValueType: + $ref: '#/components/schemas/DatasetParameterValueType' + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + DefaultValues: + $ref: '#/components/schemas/DateTimeDatasetParameterDefaultValues' + Id: + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the parameter that is created in the dataset.

+ type: string + maxLength: 128 + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the date time parameter that is created in the dataset.

+ type: string + maxLength: 2048 + required: + - Id + - Name + - ValueType + RefreshFailureAlertStatus: + type: string + enum: + - ENABLED + - DISABLED + GeoSpatialColumnGroup: + description:

Geospatial column group that denotes a hierarchy.

+ additionalProperties: false + type: object + properties: + Columns: + minItems: 1 + maxItems: 16 + description:

Columns in this hierarchy.

+ type: array + items: + minLength: 1 + type: string + maxLength: 127 + CountryCode: + $ref: '#/components/schemas/GeoSpatialCountryCode' + Name: + minLength: 1 + description:

A display name for the hierarchy.

+ type: string + maxLength: 64 + required: + - Columns + - Name + GeoSpatialCountryCode: + type: string + enum: + - US + OverrideDatasetParameterOperation: + description:

A transform operation that overrides the dataset parameter values that are defined in another dataset.

+ additionalProperties: false + type: object + properties: + NewDefaultValues: + $ref: '#/components/schemas/NewDefaultValues' + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the parameter to be overridden with different values.

+ type: string + maxLength: 2048 + NewParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The new name for the parameter.

+ type: string + maxLength: 2048 + required: + - ParameterName + DatasetParameter: + description:

A dataset parameter.

+ additionalProperties: false + type: object + properties: + IntegerDatasetParameter: + $ref: '#/components/schemas/IntegerDatasetParameter' + DateTimeDatasetParameter: + $ref: '#/components/schemas/DateTimeDatasetParameter' + DecimalDatasetParameter: + $ref: '#/components/schemas/DecimalDatasetParameter' + StringDatasetParameter: + $ref: '#/components/schemas/StringDatasetParameter' + IntegerDatasetParameterDefaultValues: + description:

The default values of an integer parameter.

+ additionalProperties: false + type: object + properties: + StaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given integer parameter.

+ type: array + items: + default: 0 + description:

The default value for the integer parameter.

+ type: number + DataSetUseAs: + type: string + enum: + - RLS_RULES + StringDatasetParameterDefaultValues: + description:

The default values of a string parameter.

+ additionalProperties: false + type: object + properties: + StaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given string parameter.

+ type: array + items: + minLength: 0 + description:

The default value for the string parameter.

+ type: string + maxLength: 512 + LookbackWindowSizeUnit: + type: string + enum: + - HOUR + - DAY + - WEEK + ProjectOperation: + description: |- +

A transform operation that projects columns. Operations that come after a projection + can only refer to projected columns.

+ additionalProperties: false + type: object + properties: + ProjectedColumns: + minItems: 0 + maxItems: 2000 + description:

Projected columns.

+ type: array + items: + type: string + IntegerDatasetParameter: + description:

An integer parameter for a dataset.

+ additionalProperties: false + type: object + properties: + ValueType: + $ref: '#/components/schemas/DatasetParameterValueType' + DefaultValues: + $ref: '#/components/schemas/IntegerDatasetParameterDefaultValues' + Id: + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the integer parameter created in the dataset.

+ type: string + maxLength: 128 + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the integer parameter that is created in the dataset.

+ type: string + maxLength: 2048 + required: + - Id + - Name + - ValueType + RefreshFailureConfiguration: + additionalProperties: false + type: object + properties: + EmailAlert: + $ref: '#/components/schemas/RefreshFailureEmailAlert' + LogicalTable: + description: |- +

A logical table is a unit that joins and that data + transformations operate on. A logical table has a source, which can be either a physical + table or result of a join. When a logical table points to a physical table, the logical + table acts as a mutable copy of that physical table through transform operations.

+ additionalProperties: false + type: object + properties: + Alias: + minLength: 1 + description:

A display name for the logical table.

+ type: string + maxLength: 64 + DataTransforms: + minItems: 1 + maxItems: 2048 + description:

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

+ type: array + items: + $ref: '#/components/schemas/TransformOperation' + Source: + $ref: '#/components/schemas/LogicalTableSource' + required: + - Alias + IngestionWaitPolicy: + description:

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

+ additionalProperties: false + type: object + properties: + WaitForSpiceIngestion: + default: true + description: |- +

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true). + Applicable only when DataSetImportMode mode is set to SPICE.

+ type: boolean + IngestionWaitTimeInHours: + default: 36 + description: |- +

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. + Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

+ maximum: 36 + type: number + minimum: 1 + StringDatasetParameter: + description:

A string parameter for a dataset.

+ additionalProperties: false + type: object + properties: + ValueType: + $ref: '#/components/schemas/DatasetParameterValueType' + DefaultValues: + $ref: '#/components/schemas/StringDatasetParameterDefaultValues' + Id: + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the string parameter that is created in the dataset.

+ type: string + maxLength: 128 + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the string parameter that is created in the dataset.

+ type: string + maxLength: 2048 + required: + - Id + - Name + - ValueType + RefreshFailureEmailAlert: + additionalProperties: false + type: object + properties: + AlertStatus: + $ref: '#/components/schemas/RefreshFailureAlertStatus' + UntagColumnOperation: + description:

A transform operation that removes tags associated with a column.

+ additionalProperties: false + type: object + properties: + ColumnName: + minLength: 1 + description:

The column that this operation acts on.

+ type: string + maxLength: 127 + TagNames: + description:

The column tags to remove from this column.

+ type: array + items: + $ref: '#/components/schemas/ColumnTagName' + required: + - ColumnName + - TagNames + FilterOperation: + description:

A transform operation that filters rows based on a condition.

+ additionalProperties: false + type: object + properties: + ConditionExpression: + minLength: 1 + description: |- +

An expression that must evaluate to a Boolean value. Rows for which the expression + evaluates to true are kept in the dataset.

+ type: string + maxLength: 4096 + ColumnLevelPermissionRule: + description: |- +

A rule defined to grant access on one or more restricted columns. + Each dataset can have multiple rules. + To create a restricted column, you add it to one or more rules. + Each rule must contain at least one column and at least one user or group. + To be able to see a restricted column, a user or group needs to be added + to a rule for that column.

+ additionalProperties: false + type: object + properties: + ColumnNames: + minItems: 1 + description:

An array of column names.

+ type: array + items: + type: string + Principals: + minItems: 1 + maxItems: 100 + description:

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

+ type: array + items: + type: string + CastColumnTypeOperation: + description:

A transform operation that casts a column to a different type.

+ additionalProperties: false + type: object + properties: + ColumnName: + minLength: 1 + description:

Column name.

+ type: string + maxLength: 127 + SubType: + $ref: '#/components/schemas/ColumnDataSubType' + Format: + minLength: 0 + description: |- +

When casting a column from string to datetime type, you can supply a string in a + format supported by Amazon QuickSight to denote the source data format.

+ type: string + maxLength: 32 + NewColumnType: + $ref: '#/components/schemas/ColumnDataType' + required: + - NewColumnType + UploadSettings: + description:

Information about the format for a source file or files.

+ additionalProperties: false + type: object + properties: + ContainsHeader: + description:

Whether the file has a header row, or the files each have a header row.

+ type: boolean + TextQualifier: + $ref: '#/components/schemas/TextQualifier' + Format: + $ref: '#/components/schemas/FileFormat' + StartFromRow: + description:

A row number to start reading data from.

+ type: number + minimum: 1 + Delimiter: + minLength: 1 + description:

The delimiter between values in the file.

+ type: string + maxLength: 1 + CreateColumnsOperation: + description: |- +

A transform operation that creates calculated columns. Columns created in one such + operation form a lexical closure.

+ additionalProperties: false + type: object + properties: + Columns: + minItems: 0 + maxItems: 256 + description:

Calculated columns to create.

+ type: array + items: + $ref: '#/components/schemas/CalculatedColumn' + TagColumnOperation: + description:

A transform operation that tags a column with additional information.

+ additionalProperties: false + type: object + properties: + ColumnName: + minLength: 1 + description:

The column that this operation acts on.

+ type: string + maxLength: 127 + Tags: + minItems: 1 + maxItems: 16 + description: |- +

The dataset column tag, currently only used for geospatial type tagging.

+ +

This is not tags for the Amazon Web Services tagging feature.

+ + type: array + items: + $ref: '#/components/schemas/ColumnTag' + required: + - ColumnName + - Tags + LookbackWindow: + description:

The lookback window setup of an incremental refresh configuration.

+ additionalProperties: false + type: object + properties: + ColumnName: + description:

The name of the lookback window column.

+ type: string + SizeUnit: + $ref: '#/components/schemas/LookbackWindowSizeUnit' + Size: + default: 0 + description:

The lookback window column size.

+ type: number + minimum: 1 + required: + - ColumnName + - Size + - SizeUnit + DatasetParameterValueType: + type: string + enum: + - MULTI_VALUED + - SINGLE_VALUED + CalculatedColumn: + description:

A calculated column for a dataset.

+ additionalProperties: false + type: object + properties: + ColumnId: + minLength: 1 + description: |- +

A unique ID to identify a calculated column. During a dataset update, if the column ID + of a calculated column matches that of an existing calculated column, Amazon QuickSight + preserves the existing calculated column.

+ type: string + maxLength: 64 + ColumnName: + minLength: 1 + description:

Column name.

+ type: string + maxLength: 127 + Expression: + minLength: 1 + description:

An expression that defines the calculated column.

+ type: string + maxLength: 250000 + required: + - ColumnId + - ColumnName + - Expression + DataSetRefreshProperties: + description:

The refresh properties of a dataset.

+ additionalProperties: false + type: object + properties: + RefreshConfiguration: + $ref: '#/components/schemas/RefreshConfiguration' + FailureConfiguration: + $ref: '#/components/schemas/RefreshFailureConfiguration' + S3Source: + description:

A physical table type for an S3 data source.

+ additionalProperties: false + type: object + properties: + DataSourceArn: + description:

The Amazon Resource Name (ARN) for the data source.

+ type: string + InputColumns: + minItems: 0 + maxItems: 2048 + description: |- +

A physical table type for an S3 data source.

+ +

For files that aren't JSON, only STRING data types are supported in input columns.

+ + type: array + items: + $ref: '#/components/schemas/InputColumn' + UploadSettings: + $ref: '#/components/schemas/UploadSettings' + required: + - DataSourceArn + FieldFolder: + description:

A FieldFolder element is a folder that contains fields and nested subfolders.

+ additionalProperties: false + type: object + properties: + Description: + minLength: 0 + description:

The description for a field folder.

+ type: string + maxLength: 500 + Columns: + minItems: 0 + maxItems: 5000 + description:

A folder has a list of columns. A column can only be in one folder.

+ type: array + items: + type: string + IncrementalRefresh: + description:

The incremental refresh configuration for a dataset.

+ additionalProperties: false + type: object + properties: + LookbackWindow: + $ref: '#/components/schemas/LookbackWindow' + required: + - LookbackWindow + OutputColumn: + description:

Output column.

+ additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/ColumnDataType' + Description: + minLength: 0 + description:

A description for a column.

+ type: string + maxLength: 500 + SubType: + $ref: '#/components/schemas/ColumnDataSubType' + Name: + minLength: 1 + description:

The display name of the column..

+ type: string + maxLength: 127 + PhysicalTable: + description: |- +

A view of a data source that contains information about the shape of the data in the + underlying source. This is a variant type structure. For this structure to be valid, + only one of the attributes can be non-null.

+ additionalProperties: false + type: object + properties: + RelationalTable: + $ref: '#/components/schemas/RelationalTable' + CustomSql: + $ref: '#/components/schemas/CustomSql' + S3Source: + $ref: '#/components/schemas/S3Source' + ColumnDataSubType: + type: string + enum: + - FLOAT + - FIXED + ColumnTag: + description: |- +

A tag for a column in a + + TagColumnOperation + + structure. This is a + variant type structure. For this structure to be valid, only one of the attributes can + be non-null.

+ additionalProperties: false + type: object + properties: + ColumnGeographicRole: + $ref: '#/components/schemas/GeoSpatialDataRole' + ColumnDescription: + $ref: '#/components/schemas/ColumnDescription' + ColumnDescription: + description:

Metadata that contains a description for a column.

+ additionalProperties: false + type: object + properties: + Text: + minLength: 0 + description:

The text of a description for a column.

+ type: string + maxLength: 500 + DataSetImportMode: + type: string + enum: + - SPICE + - DIRECT_QUERY + RowLevelPermissionDataSet: + description: |- +

Information about a dataset that contains permissions for row-level security (RLS). + The permissions dataset maps fields to users or groups. For more information, see + Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User + Guide.

+

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is + not supported for new RLS datasets.

+ additionalProperties: false + type: object + properties: + Status: + $ref: '#/components/schemas/Status' + FormatVersion: + $ref: '#/components/schemas/RowLevelPermissionFormatVersion' + Arn: + description:

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

+ type: string + Namespace: + minLength: 0 + pattern: ^[a-zA-Z0-9._-]*$ + description:

The namespace associated with the dataset that contains permissions for RLS.

+ type: string + maxLength: 64 + PermissionPolicy: + $ref: '#/components/schemas/RowLevelPermissionPolicy' + required: + - Arn + - PermissionPolicy + ColumnTagName: + type: string + enum: + - COLUMN_GEOGRAPHIC_ROLE + - COLUMN_DESCRIPTION + RenameColumnOperation: + description:

A transform operation that renames a column.

+ additionalProperties: false + type: object + properties: + NewColumnName: + minLength: 1 + description:

The new name for the column.

+ type: string + maxLength: 127 + ColumnName: + minLength: 1 + description:

The name of the column to be renamed.

+ type: string + maxLength: 127 + FieldFolderMap: + x-patternProperties: + .+: + $ref: '#/components/schemas/FieldFolder' + additionalProperties: false + type: object + RowLevelPermissionFormatVersion: + type: string + enum: + - VERSION_1 + - VERSION_2 + ColumnDataType: + type: string + enum: + - STRING + - INTEGER + - DECIMAL + - DATETIME + JoinInstruction: + description:

The instructions associated with a join.

+ additionalProperties: false + type: object + properties: + OnClause: + minLength: 1 + description:

The join instructions provided in the ON clause of a join.

+ type: string + maxLength: 512 + Type: + $ref: '#/components/schemas/JoinType' + LeftJoinKeyProperties: + $ref: '#/components/schemas/JoinKeyProperties' + LeftOperand: + minLength: 1 + pattern: ^[0-9a-zA-Z-]*$ + description:

The operand on the left side of a join.

+ type: string + maxLength: 64 + RightOperand: + minLength: 1 + pattern: ^[0-9a-zA-Z-]*$ + description:

The operand on the right side of a join.

+ type: string + maxLength: 64 + RightJoinKeyProperties: + $ref: '#/components/schemas/JoinKeyProperties' + required: + - LeftOperand + - OnClause + - RightOperand + - Type + JoinType: + type: string + enum: + - INNER + - OUTER + - LEFT + - RIGHT + RowLevelPermissionTagConfiguration: + description:

The configuration of tags on a dataset to set row-level security.

+ additionalProperties: false + type: object + properties: + Status: + $ref: '#/components/schemas/Status' + TagRules: + minItems: 1 + maxItems: 50 + description:

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

+ type: array + items: + $ref: '#/components/schemas/RowLevelPermissionTagRule' + TagRuleConfigurations: + minItems: 1 + maxItems: 50 + description:

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

+ type: array + items: + minItems: 1 + maxItems: 50 + type: array + items: + minLength: 1 + type: string + maxLength: 128 + required: + - TagRules + TransformOperation: + description: |- +

A data transformation on a logical table. This is a variant type structure. For this + structure to be valid, only one of the attributes can be non-null.

+ additionalProperties: false + type: object + properties: + TagColumnOperation: + $ref: '#/components/schemas/TagColumnOperation' + RenameColumnOperation: + $ref: '#/components/schemas/RenameColumnOperation' + UntagColumnOperation: + $ref: '#/components/schemas/UntagColumnOperation' + OverrideDatasetParameterOperation: + $ref: '#/components/schemas/OverrideDatasetParameterOperation' + FilterOperation: + $ref: '#/components/schemas/FilterOperation' + CastColumnTypeOperation: + $ref: '#/components/schemas/CastColumnTypeOperation' + CreateColumnsOperation: + $ref: '#/components/schemas/CreateColumnsOperation' + ProjectOperation: + $ref: '#/components/schemas/ProjectOperation' + InputColumnDataType: + type: string + enum: + - STRING + - INTEGER + - DECIMAL + - DATETIME + - BIT + - BOOLEAN + - JSON + UniqueKey: + additionalProperties: false + type: object + properties: + ColumnNames: + minItems: 1 + maxItems: 1 + type: array + items: + minLength: 1 + type: string + maxLength: 127 + GeoSpatialDataRole: + type: string + enum: + - COUNTRY + - STATE + - COUNTY + - CITY + - POSTCODE + - LONGITUDE + - LATITUDE + - POLITICAL1 + - CENSUS_TRACT + - CENSUS_BLOCK_GROUP + - CENSUS_BLOCK + NewDefaultValues: + description:

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

+ additionalProperties: false + type: object + properties: + DecimalStaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given decimal parameter.

+ type: array + items: + default: 0 + description:

The default value for the decimal parameter.

+ type: number + IntegerStaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given integer parameter.

+ type: array + items: + default: 0 + description:

The default value for the integer parameter.

+ type: number + StringStaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given string parameter.

+ type: array + items: + minLength: 0 + description:

The default value for the string parameter.

+ type: string + maxLength: 512 + DateTimeStaticValues: + minItems: 0 + maxItems: 32 + description:

A list of static default values for a given date time parameter.

+ type: array + items: + description:

The default value for the date time parameter.

+ type: string + DataSetUsageConfiguration: + description:

The usage configuration to apply to child datasets that reference this dataset as a source.

+ additionalProperties: false + type: object + properties: + DisableUseAsImportedSource: + default: false + description:

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

+ type: boolean + DisableUseAsDirectQuerySource: + default: false + description:

An option that controls whether a child dataset of a direct query can use this dataset as a source.

+ type: boolean + ColumnGroup: + description: |- +

Groupings of columns that work together in certain Amazon QuickSight features. This is + a variant type structure. For this structure to be valid, only one of the attributes can + be non-null.

+ additionalProperties: false + type: object + properties: + GeoSpatialColumnGroup: + $ref: '#/components/schemas/GeoSpatialColumnGroup' + CustomSql: + description:

A physical table type built from the results of the custom SQL query.

+ additionalProperties: false + type: object + properties: + DataSourceArn: + description:

The Amazon Resource Name (ARN) of the data source.

+ type: string + SqlQuery: + minLength: 1 + description:

The SQL query.

+ type: string + maxLength: 168000 + Columns: + minItems: 0 + maxItems: 2048 + description:

The column schema from the SQL query result set.

+ type: array + items: + $ref: '#/components/schemas/InputColumn' + Name: + minLength: 1 + description:

A display name for the SQL query result.

+ type: string + maxLength: 128 + required: + - DataSourceArn + - Name + - SqlQuery + DataSet: + type: object + properties: + CreatedTime: + format: string + description:

The time that this dataset was created.

+ type: string + FolderArns: + minItems: 0 + maxItems: 10 + description:

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

+ type: array + items: + type: string + ConsumedSpiceCapacityInBytes: + default: 0 + description: |- +

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't + imported into SPICE.

+ type: number + RowLevelPermissionDataSet: + $ref: '#/components/schemas/RowLevelPermissionDataSet' + IngestionWaitPolicy: + $ref: '#/components/schemas/IngestionWaitPolicy' + ColumnLevelPermissionRules: + minItems: 1 + description: |- +

A set of one or more definitions of a + ColumnLevelPermissionRule + .

+ type: array + items: + $ref: '#/components/schemas/ColumnLevelPermissionRule' + Name: + minLength: 1 + description:

The display name for the dataset.

+ type: string + maxLength: 128 + Permissions: + minItems: 1 + maxItems: 64 + description:

A list of resource permissions on the dataset.

+ type: array + items: + $ref: '#/components/schemas/ResourcePermission' + UseAs: + $ref: '#/components/schemas/DataSetUseAs' + Tags: + minItems: 1 + maxItems: 200 + description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+ type: array + items: + $ref: '#/components/schemas/Tag' + PhysicalTableMap: + $ref: '#/components/schemas/PhysicalTableMap' + FieldFolders: + $ref: '#/components/schemas/FieldFolderMap' + LastUpdatedTime: + format: string + description:

The last time that this dataset was updated.

+ type: string + DataSetId: + type: string + PerformanceConfiguration: + $ref: '#/components/schemas/PerformanceConfiguration' + DataSetRefreshProperties: + $ref: '#/components/schemas/DataSetRefreshProperties' + RowLevelPermissionTagConfiguration: + $ref: '#/components/schemas/RowLevelPermissionTagConfiguration' + ColumnGroups: + minItems: 1 + maxItems: 8 + description:

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

+ type: array + items: + $ref: '#/components/schemas/ColumnGroup' + ImportMode: + $ref: '#/components/schemas/DataSetImportMode' + DatasetParameters: + minItems: 0 + maxItems: 32 + description:

The parameter declarations of the dataset.

+ type: array + items: + $ref: '#/components/schemas/DatasetParameter' + LogicalTableMap: + $ref: '#/components/schemas/LogicalTableMap' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + DataSetUsageConfiguration: + $ref: '#/components/schemas/DataSetUsageConfiguration' + OutputColumns: + description: |- +

The list of columns after all transforms. These columns are available in templates, + analyses, and dashboards.

+ type: array + items: + $ref: '#/components/schemas/OutputColumn' + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + x-stackql-resource-name: data_set + description: Definition of the AWS::QuickSight::DataSet Resource Type. + x-type-name: AWS::QuickSight::DataSet + x-stackql-primary-identifier: + - AwsAccountId + - DataSetId + x-create-only-properties: + - AwsAccountId + - DataSetId + x-write-only-properties: + - FieldFolders + - IngestionWaitPolicy + - FolderArns + x-read-only-properties: + - Arn + - ConsumedSpiceCapacityInBytes + - CreatedTime + - LastUpdatedTime + - OutputColumns + x-tagging: + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - quicksight:DescribeDataSet + - quicksight:DescribeDataSetPermissions + - quicksight:ListTagsForResource + - quicksight:DescribeDataSetRefreshProperties + create: + - quicksight:DescribeDataSet + - quicksight:DescribeDataSetPermissions + - quicksight:DescribeIngestion + - quicksight:ListIngestions + - quicksight:CreateDataSet + - quicksight:PassDataSource + - quicksight:PassDataSet + - quicksight:TagResource + - quicksight:ListTagsForResource + - quicksight:DescribeDataSetRefreshProperties + - quicksight:PutDataSetRefreshProperties + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + update: + - quicksight:DescribeDataSet + - quicksight:DescribeDataSetPermissions + - quicksight:PassDataSource + - quicksight:UpdateDataSet + - quicksight:UpdateDataSetPermissions + - quicksight:PassDataSet + - quicksight:DescribeIngestion + - quicksight:ListIngestions + - quicksight:CancelIngestion + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + - quicksight:PutDataSetRefreshProperties + - quicksight:DescribeDataSetRefreshProperties + - quicksight:DeleteDataSetRefreshProperties + list: + - quicksight:DescribeDataSet + - quicksight:ListDataSets + delete: + - quicksight:DescribeDataSet + - quicksight:DeleteDataSet + - quicksight:ListTagsForResource + - quicksight:DescribeIngestion + - quicksight:DeleteDataSetRefreshProperties + - quicksight:DescribeDataSetRefreshProperties + ImpalaParameters: + additionalProperties: false + type: object + properties: + Port: + default: 0 + maximum: 65535 + type: number + minimum: 1 + Host: + minLength: 1 + type: string + maxLength: 256 + SqlEndpointPath: + minLength: 1 + type: string + maxLength: 4096 + required: + - Host + - Port - SqlEndpointPath - DataSourceCredentials: + AuroraPostgreSqlParameters: + description:

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

+ additionalProperties: false type: object + properties: + Port: + default: 0 + maximum: 65535 + description:

The port that Amazon Aurora PostgreSQL is listening on.

+ type: number + minimum: 1 + Database: + minLength: 1 + description:

The Amazon Aurora PostgreSQL database to connect to.

+ type: string + maxLength: 128 + Host: + minLength: 1 + description:

The Amazon Aurora PostgreSQL-Compatible host to connect to.

+ type: string + maxLength: 256 + required: + - Database + - Host + - Port + DataSourceCredentials: description: |-

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

+ additionalProperties: false + type: object properties: - CopySourceArn: + SecretArn: + minLength: 1 + pattern: ^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$ + description:

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

type: string - pattern: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+ + maxLength: 2048 + CopySourceArn: + pattern: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$ description: |-

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

+ type: string CredentialPair: $ref: '#/components/schemas/CredentialPair' - SecretArn: + ManifestFileLocation: + description:

Amazon S3 manifest file location.

+ additionalProperties: false + type: object + properties: + Bucket: + minLength: 1 + description:

Amazon S3 bucket.

type: string - pattern: ^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+ - maxLength: 2048 + maxLength: 1024 + Key: + minLength: 1 + description:

Amazon S3 key that identifies an object.

+ type: string + maxLength: 1024 + required: + - Bucket + - Key + StarburstParameters: + description:

The parameters that are required to connect to a Starburst data source.

+ additionalProperties: false + type: object + properties: + Port: + default: 0 + maximum: 65535 + description:

The port for the Starburst data source.

+ type: number + minimum: 1 + DatabaseAccessControlRole: + minLength: 0 + type: string + maxLength: 128 + ProductType: + $ref: '#/components/schemas/StarburstProductType' + OAuthParameters: + $ref: '#/components/schemas/OAuthParameters' + Host: + minLength: 1 + description:

The host name of the Starburst data source.

+ type: string + maxLength: 256 + Catalog: + minLength: 0 + description:

The catalog name for the Starburst data source.

+ type: string + maxLength: 128 + AuthenticationType: + $ref: '#/components/schemas/AuthenticationType' + required: + - Catalog + - Host + - Port + RedshiftParameters: + description: |- +

The parameters for Amazon Redshift. The ClusterId field can be blank if + Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

+ additionalProperties: false + type: object + properties: + IAMParameters: + $ref: '#/components/schemas/RedshiftIAMParameters' + ClusterId: + minLength: 1 + description: |- +

Cluster ID. This field can be blank if the Host and Port are + provided.

+ type: string + maxLength: 64 + Port: + default: 0 + maximum: 65535 + description:

Port. This field can be blank if the ClusterId is provided.

+ type: number + minimum: 0 + Database: + minLength: 1 + description:

Database.

+ type: string + maxLength: 128 + Host: minLength: 1 - description:

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

- DataSourceErrorInfo: + description:

Host. This field can be blank if ClusterId is provided.

+ type: string + maxLength: 256 + IdentityCenterConfiguration: + $ref: '#/components/schemas/IdentityCenterConfiguration' + required: + - Database + VpcConnectionProperties: + description:

VPC connection properties.

+ additionalProperties: false type: object - description:

Error information for the data source creation or update.

properties: - Type: - $ref: '#/components/schemas/DataSourceErrorInfoType' - Message: + VpcConnectionArn: + description:

The Amazon Resource Name (ARN) for the VPC connection.

type: string - description:

Error message.

- DataSourceErrorInfoType: - type: string - enum: - - ACCESS_DENIED - - COPY_SOURCE_NOT_FOUND - - TIMEOUT - - ENGINE_VERSION_NOT_SUPPORTED - - UNKNOWN_HOST - - GENERIC_SQL_FAILURE - - CONFLICT - - UNKNOWN - DataSourceParameters: + required: + - VpcConnectionArn + SnowflakeParameters: + description:

The parameters for Snowflake.

+ additionalProperties: false type: object - description: |- -

The parameters that Amazon QuickSight uses to connect to your underlying data source. - This is a variant type structure. For this structure to be valid, only one of the - attributes can be non-null.

properties: - AuroraPostgreSqlParameters: - $ref: '#/components/schemas/AuroraPostgreSqlParameters' - TeradataParameters: - $ref: '#/components/schemas/TeradataParameters' - RdsParameters: - $ref: '#/components/schemas/RdsParameters' - AthenaParameters: - $ref: '#/components/schemas/AthenaParameters' - SparkParameters: - $ref: '#/components/schemas/SparkParameters' - MariaDbParameters: - $ref: '#/components/schemas/MariaDbParameters' - OracleParameters: - $ref: '#/components/schemas/OracleParameters' - PrestoParameters: - $ref: '#/components/schemas/PrestoParameters' - RedshiftParameters: - $ref: '#/components/schemas/RedshiftParameters' - MySqlParameters: - $ref: '#/components/schemas/MySqlParameters' - SqlServerParameters: - $ref: '#/components/schemas/SqlServerParameters' - SnowflakeParameters: - $ref: '#/components/schemas/SnowflakeParameters' - AmazonElasticsearchParameters: - $ref: '#/components/schemas/AmazonElasticsearchParameters' - AmazonOpenSearchParameters: - $ref: '#/components/schemas/AmazonOpenSearchParameters' - PostgreSqlParameters: - $ref: '#/components/schemas/PostgreSqlParameters' - AuroraParameters: - $ref: '#/components/schemas/AuroraParameters' - S3Parameters: - $ref: '#/components/schemas/S3Parameters' - DatabricksParameters: - $ref: '#/components/schemas/DatabricksParameters' - StarburstParameters: - $ref: '#/components/schemas/StarburstParameters' - TrinoParameters: - $ref: '#/components/schemas/TrinoParameters' + Warehouse: + minLength: 0 + description:

Warehouse.

+ type: string + maxLength: 128 + DatabaseAccessControlRole: + minLength: 0 + type: string + maxLength: 128 + Database: + minLength: 1 + description:

Database.

+ type: string + maxLength: 128 + OAuthParameters: + $ref: '#/components/schemas/OAuthParameters' + Host: + minLength: 1 + description:

Host.

+ type: string + maxLength: 256 + AuthenticationType: + $ref: '#/components/schemas/AuthenticationType' + required: + - Database + - Host + - Warehouse DataSourceType: type: string enum: @@ -9559,6 +11578,13 @@ components: - AURORA_POSTGRESQL - AWS_IOT_ANALYTICS - DATABRICKS + - DENODO + - DREMIO + - DYNAMODB + - SAPHANA + - DB2_AS400 + - EXASOL + - FILE - GITHUB - JIRA - MARIADB @@ -9566,373 +11592,613 @@ components: - ORACLE - POSTGRESQL - PRESTO + - QBUSINESS - REDSHIFT - S3 + - S3_TABLES + - S3_KNOWLEDGE_BASE - SALESFORCE - SERVICENOW - SNOWFLAKE - SPARK + - SPICE - SQLSERVER - TERADATA - - TWITTER - TIMESTREAM - - STARBURST + - TWITTER + - BIGQUERY + - GOOGLE_ANALYTICS - TRINO - ManifestFileLocation: + - STARBURST + - MONGO + - MONGO_ATLAS + - DOCUMENTDB + - APPFLOW + - IMPALA + - GLUE + - GOOGLE_DRIVE + - CONFLUENCE + - SHAREPOINT + - ONE_DRIVE + - WEB_CRAWLER + OAuthParameters: + additionalProperties: false type: object - description:

Amazon S3 manifest file location.

properties: - Bucket: + TokenProviderUrl: + minLength: 1 type: string - maxLength: 1024 + maxLength: 2048 + OAuthScope: minLength: 1 - description:

Amazon S3 bucket.

- Key: type: string - maxLength: 1024 + maxLength: 128 + IdentityProviderVpcConnectionProperties: + $ref: '#/components/schemas/VpcConnectionProperties' + IdentityProviderResourceUri: minLength: 1 - description:

Amazon S3 key that identifies an object.

+ type: string + maxLength: 2048 required: - - Bucket - - Key - MariaDbParameters: + - TokenProviderUrl + AmazonElasticsearchParameters: + description:

The parameters for OpenSearch.

+ additionalProperties: false + type: object + properties: + Domain: + minLength: 1 + description:

The OpenSearch domain.

+ type: string + maxLength: 64 + required: + - Domain + AmazonOpenSearchParameters: + description:

The parameters for OpenSearch.

+ additionalProperties: false + type: object + properties: + Domain: + minLength: 1 + description:

The OpenSearch domain.

+ type: string + maxLength: 64 + required: + - Domain + AuroraParameters: + description:

Parameters for Amazon Aurora.

+ additionalProperties: false type: object - description:

MariaDB parameters.

properties: Port: - type: number + default: 0 maximum: 65535 + description:

Port.

+ type: number minimum: 1 + Database: + minLength: 1 + description:

Database.

+ type: string + maxLength: 128 + Host: + minLength: 1 + description:

Host.

+ type: string + maxLength: 256 + required: + - Database + - Host + - Port + S3Parameters: + description:

The parameters for S3.

+ additionalProperties: false + type: object + properties: + ManifestFileLocation: + $ref: '#/components/schemas/ManifestFileLocation' + RoleArn: + minLength: 20 + description:

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

+ type: string + maxLength: 2048 + required: + - ManifestFileLocation + IdentityCenterConfiguration: + description:

The parameters for an IAM Identity Center configuration.

+ additionalProperties: false + type: object + properties: + EnableIdentityPropagation: + default: null + description:

A Boolean option that controls whether Trusted Identity Propagation should be used.

+ type: boolean + SslProperties: + description: |- +

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your + underlying data source.

+ additionalProperties: false + type: object + properties: + DisableSsl: + default: false + description:

A Boolean option to control whether SSL should be disabled.

+ type: boolean + DataSourceErrorInfoType: + type: string + enum: + - ACCESS_DENIED + - COPY_SOURCE_NOT_FOUND + - TIMEOUT + - ENGINE_VERSION_NOT_SUPPORTED + - UNKNOWN_HOST + - GENERIC_SQL_FAILURE + - CONFLICT + - UNKNOWN + AuthenticationType: + type: string + enum: + - PASSWORD + - TOKEN + - X509 + DataSourceErrorInfo: + description:

Error information for the data source creation or update.

+ additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/DataSourceErrorInfoType' + Message: + description:

Error message.

+ type: string + TeradataParameters: + description:

The parameters for Teradata.

+ additionalProperties: false + type: object + properties: + Port: + default: 0 + maximum: 65535 description:

Port.

+ type: number + minimum: 1 Database: + minLength: 1 + description:

Database.

+ type: string + maxLength: 128 + Host: + minLength: 1 + description:

Host.

+ type: string + maxLength: 256 + required: + - Database + - Host + - Port + RdsParameters: + description:

The parameters for Amazon RDS.

+ additionalProperties: false + type: object + properties: + InstanceId: + minLength: 1 + description:

Instance ID.

+ type: string + maxLength: 64 + Database: + minLength: 1 + description:

Database.

+ type: string + maxLength: 128 + required: + - Database + - InstanceId + AthenaParameters: + description:

Parameters for Amazon Athena.

+ additionalProperties: false + type: object + properties: + WorkGroup: + minLength: 1 + description:

The workgroup that Amazon Athena uses.

type: string maxLength: 128 - minLength: 1 - description:

Database.

- Host: + IdentityCenterConfiguration: + $ref: '#/components/schemas/IdentityCenterConfiguration' + RoleArn: + minLength: 20 + description:

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

type: string - maxLength: 256 - minLength: 1 - description:

Host.

- required: - - Database - - Host - - Port - MySqlParameters: + maxLength: 2048 + SparkParameters: + description:

The parameters for Spark.

+ additionalProperties: false type: object - description:

MySQL parameters.

properties: Port: - type: number + default: 0 maximum: 65535 - minimum: 1 description:

Port.

- Database: - type: string - maxLength: 128 - minLength: 1 - description:

Database.

+ type: number + minimum: 1 Host: - type: string - maxLength: 256 minLength: 1 description:

Host.

+ type: string + maxLength: 256 required: - - Database - Host - Port - OracleParameters: + MariaDbParameters: + description:

The parameters for MariaDB.

+ additionalProperties: false type: object properties: Port: - type: number + default: 0 maximum: 65535 + description:

Port.

+ type: number minimum: 1 Database: + minLength: 1 + description:

Database.

type: string maxLength: 128 - minLength: 1 Host: + minLength: 1 + description:

Host.

type: string maxLength: 256 - minLength: 1 required: - Database - Host - Port - PostgreSqlParameters: + OracleParameters: + description:

The parameters for Oracle.

+ additionalProperties: false type: object - description:

PostgreSQL parameters.

properties: + UseServiceName: + default: false + type: boolean Port: - type: number + default: 0 maximum: 65535 + description:

The port.

+ type: number minimum: 1 - description:

Port.

Database: + minLength: 1 + description:

The database.

type: string maxLength: 128 - minLength: 1 - description:

Database.

Host: + minLength: 1 + description:

An Oracle host.

type: string maxLength: 256 - minLength: 1 - description:

Host.

required: - Database - Host - Port PrestoParameters: + description:

The parameters for Presto.

+ additionalProperties: false type: object - description:

Presto parameters.

properties: Port: - type: number + default: 0 maximum: 65535 - minimum: 1 description:

Port.

+ type: number + minimum: 1 Host: - type: string - maxLength: 256 minLength: 1 description:

Host.

- Catalog: type: string - maxLength: 128 + maxLength: 256 + Catalog: minLength: 0 description:

Catalog.

+ type: string + maxLength: 128 required: - Catalog - Host - Port - RdsParameters: + AwsIotAnalyticsParameters: + description:

The parameters for IoT Analytics.

+ additionalProperties: false type: object - description:

Amazon RDS parameters.

properties: - InstanceId: - type: string - maxLength: 64 + DataSetName: minLength: 1 - description:

Instance ID.

- Database: + description:

Dataset name.

type: string maxLength: 128 - minLength: 1 - description:

Database.

required: - - Database - - InstanceId - RedshiftParameters: - type: object + - DataSetName + StarburstProductType: + type: string + enum: + - GALAXY + - ENTERPRISE + DataSourceParameters: description: |- -

Amazon Redshift parameters. The ClusterId field can be blank if - Host and Port are both set. The Host and - Port fields can be blank if the ClusterId field is set.

+

The parameters that Amazon QuickSight uses to connect to your underlying data source. + This is a variant type structure. For this structure to be valid, only one of the + attributes can be non-null.

+ additionalProperties: false + type: object + properties: + AuroraPostgreSqlParameters: + $ref: '#/components/schemas/AuroraPostgreSqlParameters' + TeradataParameters: + $ref: '#/components/schemas/TeradataParameters' + RdsParameters: + $ref: '#/components/schemas/RdsParameters' + AthenaParameters: + $ref: '#/components/schemas/AthenaParameters' + SparkParameters: + $ref: '#/components/schemas/SparkParameters' + MariaDbParameters: + $ref: '#/components/schemas/MariaDbParameters' + OracleParameters: + $ref: '#/components/schemas/OracleParameters' + PrestoParameters: + $ref: '#/components/schemas/PrestoParameters' + StarburstParameters: + $ref: '#/components/schemas/StarburstParameters' + RedshiftParameters: + $ref: '#/components/schemas/RedshiftParameters' + MySqlParameters: + $ref: '#/components/schemas/MySqlParameters' + SqlServerParameters: + $ref: '#/components/schemas/SqlServerParameters' + SnowflakeParameters: + $ref: '#/components/schemas/SnowflakeParameters' + AmazonElasticsearchParameters: + $ref: '#/components/schemas/AmazonElasticsearchParameters' + AmazonOpenSearchParameters: + $ref: '#/components/schemas/AmazonOpenSearchParameters' + PostgreSqlParameters: + $ref: '#/components/schemas/PostgreSqlParameters' + AuroraParameters: + $ref: '#/components/schemas/AuroraParameters' + S3Parameters: + $ref: '#/components/schemas/S3Parameters' + TrinoParameters: + $ref: '#/components/schemas/TrinoParameters' + DatabricksParameters: + $ref: '#/components/schemas/DatabricksParameters' + MySqlParameters: + description:

The parameters for MySQL.

+ additionalProperties: false + type: object properties: - ClusterId: - type: string - maxLength: 64 - minLength: 1 - description: |- -

Cluster ID. This field can be blank if the Host and Port are - provided.

Port: - type: number + default: 0 maximum: 65535 - minimum: 0 - description:

Port. This field can be blank if the ClusterId is provided.

+ description:

Port.

+ type: number + minimum: 1 Database: - type: string - maxLength: 128 minLength: 1 description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host. This field can be blank if ClusterId is provided.

- required: - - Database - S3Parameters: - type: object - description:

S3 parameters.

- properties: - ManifestFileLocation: - $ref: '#/components/schemas/ManifestFileLocation' - RoleArn: - type: string - maxLength: 2048 - minLength: 20 - description:

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

- required: - - ManifestFileLocation - SnowflakeParameters: - type: object - description:

Snowflake parameters.

- properties: - Warehouse: - type: string - maxLength: 128 - minLength: 0 - description:

Warehouse.

- Database: type: string maxLength: 128 - minLength: 1 - description:

Database.

Host: - type: string - maxLength: 256 minLength: 1 description:

Host.

- required: - - Database - - Host - - Warehouse - StarburstParameters: - type: object - description:

Starburst parameters.

- properties: - Host: type: string maxLength: 256 - minLength: 1 - description:

Host.

- Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

- Catalog: - type: string - maxLength: 128 - minLength: 0 - description:

Catalog.

- ProductType: - $ref: '#/components/schemas/StarburstProductType' required: + - Database - Host - Port - - Catalog - StarburstProductType: - type: string - enum: - - GALAXY - - ENTERPRISE - TrinoParameters: + RedshiftIAMParameters: + description: |- +

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see + GetClusterCredentials + .

+ additionalProperties: false type: object - description:

Trino parameters.

properties: - Host: - type: string - maxLength: 256 + AutoCreateDatabaseUser: + default: false + description:

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

+ type: boolean + DatabaseUser: minLength: 1 - description:

Host.

- Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

- Catalog: + description:

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

type: string - maxLength: 128 - minLength: 0 - description:

Catalog.

+ maxLength: 64 + RoleArn: + minLength: 20 + description:

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

+ type: string + maxLength: 2048 + DatabaseGroups: + minItems: 1 + maxItems: 50 + description:

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

+ type: array + items: + minLength: 1 + type: string + maxLength: 64 required: - - Host - - Port - - Catalog - SparkParameters: + - RoleArn + SqlServerParameters: + description:

The parameters for SQL Server.

+ additionalProperties: false type: object - description:

Spark parameters.

properties: Port: - type: number + default: 0 maximum: 65535 - minimum: 1 description:

Port.

- Host: + type: number + minimum: 1 + Database: + minLength: 1 + description:

Database.

type: string - maxLength: 256 + maxLength: 128 + Host: minLength: 1 description:

Host.

+ type: string + maxLength: 256 required: + - Database - Host - Port - SqlServerParameters: + CredentialPair: + description:

The combination of user name and password that are used as credentials.

+ additionalProperties: false + type: object + properties: + AlternateDataSourceParameters: + minItems: 1 + maxItems: 50 + description: |- +

A set of alternate data source parameters that you want to share for these + credentials. The credentials are applied in tandem with the data source parameters when + you copy a data source by using a create or update request. The API operation compares + the DataSourceParameters structure that's in the request with the + structures in the AlternateDataSourceParameters allow list. If the + structures are an exact match, the request is allowed to use the new data source with + the existing credentials. If the AlternateDataSourceParameters list is + null, the DataSourceParameters originally used with these + Credentials is automatically allowed.

+ type: array + items: + $ref: '#/components/schemas/DataSourceParameters' + Username: + minLength: 1 + description:

User name.

+ type: string + maxLength: 64 + Password: + minLength: 1 + description:

Password.

+ type: string + maxLength: 1024 + required: + - Password + - Username + PostgreSqlParameters: + description:

The parameters for PostgreSQL.

+ additionalProperties: false type: object - description:

SQL Server parameters.

properties: Port: - type: number + default: 0 maximum: 65535 - minimum: 1 description:

Port.

+ type: number + minimum: 1 Database: - type: string - maxLength: 128 minLength: 1 description:

Database.

- Host: type: string - maxLength: 256 + maxLength: 128 + Host: minLength: 1 description:

Host.

+ type: string + maxLength: 256 required: - Database - Host - Port - SslProperties: - type: object - description: |- -

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your - underlying data source.

- properties: - DisableSsl: - type: boolean - description:

A Boolean option to control whether SSL should be disabled.

- TeradataParameters: + TrinoParameters: + description:

The parameters that are required to connect to a Trino data source.

+ additionalProperties: false type: object - description:

Teradata parameters.

properties: Port: - type: number + default: 0 maximum: 65535 + description:

The port for the Trino data source.

+ type: number minimum: 1 - description:

Port.

- Database: - type: string - maxLength: 128 - minLength: 1 - description:

Database.

Host: + minLength: 1 + description:

The host name of the Trino data source.

type: string maxLength: 256 - minLength: 1 - description:

Host.

+ Catalog: + minLength: 0 + description:

The catalog name for the Trino data source.

+ type: string + maxLength: 128 required: - - Database + - Catalog - Host - Port - VpcConnectionProperties: + DatabricksParameters: + description:

The parameters that are required to connect to a Databricks data source.

+ additionalProperties: false type: object - description:

VPC connection properties.

properties: - VpcConnectionArn: + Port: + default: 0 + maximum: 65535 + description:

The port for the Databricks data source.

+ type: number + minimum: 1 + Host: + minLength: 1 + description:

The host name of the Databricks data source.

type: string - description:

The Amazon Resource Name (ARN) for the VPC connection.

+ maxLength: 256 + SqlEndpointPath: + minLength: 1 + description:

The HTTP path of the Databricks data source.

+ type: string + maxLength: 4096 required: - - VpcConnectionArn + - Host + - Port + - SqlEndpointPath DataSource: type: object properties: - AlternateDataSourceParameters: + Status: + $ref: '#/components/schemas/ResourceStatus' + CreatedTime: + format: date-time + description:

The time that this data source was created.

+ type: string + ErrorInfo: + $ref: '#/components/schemas/DataSourceErrorInfo' + LastUpdatedTime: + format: date-time + description:

The last time that this data source was updated.

+ type: string + FolderArns: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/DataSourceParameters' - maxItems: 50 + type: string + Name: + minLength: 1 + type: string + maxLength: 128 + DataSourceParameters: + $ref: '#/components/schemas/DataSourceParameters' + Type: + $ref: '#/components/schemas/DataSourceType' + VpcConnectionProperties: + $ref: '#/components/schemas/VpcConnectionProperties' + AlternateDataSourceParameters: minItems: 1 + maxItems: 50 description: |-

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source @@ -9943,9 +12209,119 @@ components: existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

- Arn: + type: array + items: + $ref: '#/components/schemas/DataSourceParameters' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + Arn: description:

The Amazon Resource Name (ARN) of the data source.

+ type: string + SslProperties: + $ref: '#/components/schemas/SslProperties' + Credentials: + $ref: '#/components/schemas/DataSourceCredentials' + DataSourceId: + type: string + Tags: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/Tag' + required: + - Name + - Type + x-stackql-resource-name: data_source + description: Definition of the AWS::QuickSight::DataSource Resource Type. + x-type-name: AWS::QuickSight::DataSource + x-stackql-primary-identifier: + - AwsAccountId + - DataSourceId + x-create-only-properties: + - AwsAccountId + - DataSourceId + - Type + x-write-only-properties: + - Credentials + - FolderArns + x-read-only-properties: + - Arn + - CreatedTime + - LastUpdatedTime + - Status + x-required-properties: + - Name + - Type + x-tagging: + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - quicksight:DescribeDataSource + - quicksight:DescribeDataSourcePermissions + - quicksight:ListTagsForResource + create: + - quicksight:CreateDataSource + - quicksight:DescribeDataSource + - quicksight:DescribeDataSourcePermissions + - quicksight:TagResource + - quicksight:ListTagsForResource + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + update: + - quicksight:DescribeDataSource + - quicksight:DescribeDataSourcePermissions + - quicksight:UpdateDataSource + - quicksight:UpdateDataSourcePermissions + - quicksight:CreateFolderMembership + - quicksight:DeleteFolderMembership + - quicksight:ListFoldersForResource + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + list: + - quicksight:DescribeDataSource + - quicksight:ListDataSources + delete: + - quicksight:DescribeDataSource + - quicksight:DescribeDataSourcePermissions + - quicksight:DeleteDataSource + - quicksight:ListTagsForResource + FolderType: + type: string + enum: + - SHARED + - RESTRICTED + SharingModel: + type: string + enum: + - ACCOUNT + - NAMESPACE + Folder: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) for the folder.

+ pattern: ^arn:.* AwsAccountId: type: string maxLength: 12 @@ -9953,87 +12329,93 @@ components: pattern: ^[0-9]{12}$ CreatedTime: type: string - description:

The time that this data source was created.

+ description:

The time that the folder was created.

format: date-time - Credentials: - $ref: '#/components/schemas/DataSourceCredentials' - DataSourceId: + FolderId: type: string - DataSourceParameters: - $ref: '#/components/schemas/DataSourceParameters' - ErrorInfo: - $ref: '#/components/schemas/DataSourceErrorInfo' + maxLength: 2048 + minLength: 1 + pattern: ^[\w\-]+$ + FolderType: + $ref: '#/components/schemas/FolderType' LastUpdatedTime: type: string - description:

The last time that this data source was updated.

+ description:

The time that the folder was last updated.

format: date-time Name: type: string - maxLength: 128 + maxLength: 200 minLength: 1 - description:

A display name for the data source.

+ ParentFolderArn: + type: string Permissions: type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - description:

A list of resource permissions on the data source.

- SslProperties: - $ref: '#/components/schemas/SslProperties' - Status: - $ref: '#/components/schemas/ResourceStatus' + maxItems: 64 + minItems: 1 + x-insertionOrder: false + SharingModel: + $ref: '#/components/schemas/SharingModel' Tags: type: array items: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 1 - description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

- Type: - $ref: '#/components/schemas/DataSourceType' - VpcConnectionProperties: - $ref: '#/components/schemas/VpcConnectionProperties' - x-stackql-resource-name: data_source - x-stackql-primaryIdentifier: + x-insertionOrder: false + x-stackql-resource-name: folder + description: Definition of the AWS::QuickSight::Folder Resource Type. + x-type-name: AWS::QuickSight::Folder + x-stackql-primary-identifier: - AwsAccountId - - DataSourceId + - FolderId x-create-only-properties: + - ParentFolderArn + - SharingModel + - FolderType + - FolderId - AwsAccountId - - DataSourceId - - Type + x-write-only-properties: + - ParentFolderArn x-read-only-properties: - Arn - CreatedTime - LastUpdatedTime - - Status - x-required-permissions: - create: - - quicksight:CreateDataSource - - quicksight:DescribeDataSource - - quicksight:DescribeDataSourcePermissions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: - quicksight:TagResource + - quicksight:UntagResource - quicksight:ListTagsForResource + x-required-permissions: read: - - quicksight:DescribeDataSource - - quicksight:DescribeDataSourcePermissions + - quicksight:DescribeFolder + - quicksight:DescribeFolderPermissions + - quicksight:ListTagsForResource + create: + - quicksight:CreateFolder + - quicksight:DescribeFolder + - quicksight:UpdateFolderPermissions + - quicksight:DescribeFolderPermissions + - quicksight:TagResource - quicksight:ListTagsForResource update: - - quicksight:DescribeDataSource - - quicksight:DescribeDataSourcePermissions - - quicksight:UpdateDataSource - - quicksight:UpdateDataSourcePermissions + - quicksight:DescribeFolder + - quicksight:UpdateFolder + - quicksight:DescribeFolderPermissions + - quicksight:UpdateFolderPermissions + - quicksight:ListTagsForResource - quicksight:TagResource - quicksight:UntagResource - - quicksight:ListTagsForResource delete: - - quicksight:DescribeDataSource - - quicksight:DescribeDataSourcePermissions - - quicksight:DeleteDataSource - - quicksight:ListTagsForResource + - quicksight:DeleteFolder list: - - quicksight:DescribeDataSource - - quicksight:ListDataSources + - quicksight:ListFolders RefreshScheduleMap: type: object properties: @@ -10117,7 +12499,9 @@ components: $ref: '#/components/schemas/RefreshScheduleMap' required: [] x-stackql-resource-name: refresh_schedule - x-stackql-primaryIdentifier: + description: Definition of the AWS::QuickSight::RefreshSchedule Resource Type. + x-type-name: AWS::QuickSight::RefreshSchedule + x-stackql-primary-identifier: - AwsAccountId - DataSetId - Schedule/ScheduleId @@ -10127,6 +12511,12 @@ components: - Schedule/ScheduleId x-read-only-properties: - Arn + x-required-properties: [] + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - quicksight:CreateRefreshSchedule @@ -10141,258 +12531,326 @@ components: - quicksight:ListRefreshSchedules read: - quicksight:DescribeRefreshSchedule - ColumnGroupColumnSchema: - type: object - properties: - Name: - type: string + TemplateVersionDefinition: additionalProperties: false - ColumnGroupSchema: type: object properties: - Name: - type: string - ColumnGroupColumnSchemaList: + Options: + $ref: '#/components/schemas/AssetOptions' + FilterGroups: + minItems: 0 + maxItems: 2000 type: array items: - $ref: '#/components/schemas/ColumnGroupColumnSchema' + $ref: '#/components/schemas/FilterGroup' + QueryExecutionOptions: + $ref: '#/components/schemas/QueryExecutionOptions' + CalculatedFields: + minItems: 0 maxItems: 500 + type: array + items: + $ref: '#/components/schemas/CalculatedField' + DataSetConfigurations: minItems: 0 - additionalProperties: false - ColumnSchema: - type: object - properties: - Name: - type: string - DataType: - type: string - GeographicRole: - type: string - additionalProperties: false - DataSetConfiguration: - type: object - properties: - Placeholder: - type: string - DataSetSchema: - $ref: '#/components/schemas/DataSetSchema' - ColumnGroupSchemaList: + maxItems: 30 type: array items: - $ref: '#/components/schemas/ColumnGroupSchema' - maxItems: 500 + $ref: '#/components/schemas/DataSetConfiguration' + ColumnConfigurations: minItems: 0 - additionalProperties: false - DataSetSchema: - type: object - properties: - ColumnSchemaList: + maxItems: 2000 type: array items: - $ref: '#/components/schemas/ColumnSchema' - maxItems: 500 + $ref: '#/components/schemas/ColumnConfiguration' + AnalysisDefaults: + $ref: '#/components/schemas/AnalysisDefaults' + Sheets: minItems: 0 - additionalProperties: false - TemplateError: - type: object - properties: - Type: - $ref: '#/components/schemas/TemplateErrorType' - Message: - type: string - pattern: .*\S.* - ViolatedEntities: + maxItems: 20 type: array items: - $ref: '#/components/schemas/Entity' - maxItems: 200 + $ref: '#/components/schemas/SheetDefinition' + ParameterDeclarations: minItems: 0 - additionalProperties: false - TemplateErrorType: - type: string - enum: - - SOURCE_NOT_FOUND - - DATA_SET_NOT_FOUND - - INTERNAL_FAILURE - - ACCESS_DENIED - TemplateSourceAnalysis: - type: object - properties: - Arn: - type: string - DataSetReferences: + maxItems: 200 type: array items: - $ref: '#/components/schemas/DataSetReference' - minItems: 1 + $ref: '#/components/schemas/ParameterDeclaration' required: - - Arn - - DataSetReferences + - DataSetConfigurations + ColumnSchema: + description:

The column schema.

additionalProperties: false - TemplateSourceEntity: type: object properties: - SourceAnalysis: - $ref: '#/components/schemas/TemplateSourceAnalysis' - SourceTemplate: - $ref: '#/components/schemas/TemplateSourceTemplate' + DataType: + description:

The data type of the column schema.

+ type: string + GeographicRole: + description:

The geographic role of the column schema.

+ type: string + Name: + description:

The name of the column schema.

+ type: string + ColumnGroupColumnSchema: + description:

A structure describing the name, data type, and geographic role of the columns.

additionalProperties: false - TemplateSourceTemplate: type: object properties: - Arn: + Name: + description:

The name of the column group's column schema.

type: string - required: - - Arn - additionalProperties: false TemplateVersion: + description:

A version of a template.

+ additionalProperties: false type: object properties: - CreatedTime: - type: string - format: date-time + Status: + $ref: '#/components/schemas/ResourceStatus' Errors: + minItems: 1 + description:

Errors associated with this template version.

type: array items: $ref: '#/components/schemas/TemplateError' - minItems: 1 - VersionNumber: - type: number - minimum: 1 - Status: - $ref: '#/components/schemas/ResourceStatus' + CreatedTime: + format: date-time + description:

The time that this template version was created.

+ type: string + Description: + minLength: 1 + description:

The description of the template.

+ type: string + maxLength: 512 + ThemeArn: + description:

The ARN of the theme associated with this version of the template.

+ type: string DataSetConfigurations: + minItems: 0 + maxItems: 30 + description: |- +

Schema of the dataset identified by the placeholder. Any dashboard created from this + template should be bound to new datasets matching the same schema described through this + API operation.

type: array items: $ref: '#/components/schemas/DataSetConfiguration' - maxItems: 30 - minItems: 0 - Description: - type: string - maxLength: 512 - minLength: 1 SourceEntityArn: + description: |- +

The Amazon Resource Name (ARN) of an analysis or template that was used to create this + template.

type: string - ThemeArn: - type: string + VersionNumber: + description:

The version number of the template version.

+ type: number + minimum: 1 Sheets: + minItems: 0 + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

type: array items: $ref: '#/components/schemas/Sheet' - maxItems: 20 - minItems: 0 + DataSetSchema: + description:

Dataset schema.

additionalProperties: false - TemplateVersionDefinition: type: object properties: - DataSetConfigurations: - type: array - items: - $ref: '#/components/schemas/DataSetConfiguration' - maxItems: 30 + ColumnSchemaList: minItems: 0 - Sheets: + maxItems: 500 + description:

A structure containing the list of column schemas.

type: array items: - $ref: '#/components/schemas/SheetDefinition' - maxItems: 20 + $ref: '#/components/schemas/ColumnSchema' + TemplateSourceTemplate: + description:

The source template of the template.

+ additionalProperties: false + type: object + properties: + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + required: + - Arn + ColumnGroupSchema: + description:

The column group schema.

+ additionalProperties: false + type: object + properties: + ColumnGroupColumnSchemaList: minItems: 0 - CalculatedFields: + maxItems: 500 + description:

A structure containing the list of schemas for column group columns.

type: array items: - $ref: '#/components/schemas/CalculatedField' - maxItems: 500 + $ref: '#/components/schemas/ColumnGroupColumnSchema' + Name: + description:

The name of the column group schema.

+ type: string + TemplateErrorType: + type: string + enum: + - SOURCE_NOT_FOUND + - DATA_SET_NOT_FOUND + - INTERNAL_FAILURE + - ACCESS_DENIED + TemplateError: + description:

List of errors that occurred when the template version creation failed.

+ additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/TemplateErrorType' + Message: + pattern: \S + description:

Description of the error type.

+ type: string + ViolatedEntities: minItems: 0 - ParameterDeclarations: + maxItems: 200 + description:

An error path that shows which entities caused the template error.

type: array items: - $ref: '#/components/schemas/ParameterDeclaration' - maxItems: 200 - minItems: 0 - FilterGroups: + $ref: '#/components/schemas/Entity' + TemplateSourceAnalysis: + description:

The source analysis of the template.

+ additionalProperties: false + type: object + properties: + DataSetReferences: + minItems: 1 + description: |- +

A structure containing information about the dataset references used as placeholders + in the template.

type: array items: - $ref: '#/components/schemas/FilterGroup' - maxItems: 2000 + $ref: '#/components/schemas/DataSetReference' + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + required: + - Arn + - DataSetReferences + DataSetConfiguration: + description:

Dataset configuration.

+ additionalProperties: false + type: object + properties: + Placeholder: + description:

Placeholder.

+ type: string + DataSetSchema: + $ref: '#/components/schemas/DataSetSchema' + ColumnGroupSchemaList: minItems: 0 - ColumnConfigurations: + maxItems: 500 + description:

A structure containing the list of column group schemas.

type: array items: - $ref: '#/components/schemas/ColumnConfiguration' - maxItems: 200 - minItems: 0 - AnalysisDefaults: - $ref: '#/components/schemas/AnalysisDefaults' - Options: - $ref: '#/components/schemas/AssetOptions' - required: - - DataSetConfigurations + $ref: '#/components/schemas/ColumnGroupSchema' + TemplateSourceEntity: + description:

The source entity of the template.

additionalProperties: false + type: object + properties: + SourceAnalysis: + $ref: '#/components/schemas/TemplateSourceAnalysis' + SourceTemplate: + $ref: '#/components/schemas/TemplateSourceTemplate' Template: type: object properties: - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ CreatedTime: - type: string format: date-time + description:

Time when this was created.

+ type: string + VersionDescription: + minLength: 1 + type: string + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/TemplateSourceEntity' Definition: $ref: '#/components/schemas/TemplateVersionDefinition' LastUpdatedTime: - type: string format: date-time + description:

Time when this was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' Name: + minLength: 1 type: string maxLength: 2048 - minLength: 1 + Version: + $ref: '#/components/schemas/TemplateVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 Permissions: + minItems: 1 + maxItems: 64 type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - SourceEntity: - $ref: '#/components/schemas/TemplateSourceEntity' + Arn: + description:

The Amazon Resource Name (ARN) of the template.

+ type: string Tags: + minItems: 1 + maxItems: 200 type: array items: $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 TemplateId: - type: string - maxLength: 512 minLength: 1 - pattern: '[\w\-]+' - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - Version: - $ref: '#/components/schemas/TemplateVersion' - VersionDescription: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 required: - AwsAccountId - TemplateId x-stackql-resource-name: template - x-stackql-primaryIdentifier: + description: Definition of the AWS::QuickSight::Template Resource Type. + x-type-name: AWS::QuickSight::Template + x-stackql-primary-identifier: - AwsAccountId - TemplateId x-create-only-properties: - AwsAccountId - TemplateId + x-write-only-properties: + - Definition + - VersionDescription + - SourceEntity + - ValidationStrategy x-read-only-properties: - Arn - CreatedTime - LastUpdatedTime - Version + x-required-properties: + - AwsAccountId + - TemplateId + x-tagging: + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - quicksight:DescribeTemplate + - quicksight:DescribeTemplatePermissions + - quicksight:ListTagsForResource create: - quicksight:DescribeTemplate - quicksight:DescribeTemplatePermissions @@ -10401,10 +12859,6 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource - read: - - quicksight:DescribeTemplate - - quicksight:DescribeTemplatePermissions - - quicksight:ListTagsForResource update: - quicksight:DescribeTemplate - quicksight:DescribeTemplatePermissions @@ -10414,20 +12868,26 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource + list: + - quicksight:ListTemplates delete: - quicksight:DescribeTemplate - quicksight:DeleteTemplate - list: - - quicksight:ListTemplates BorderStyle: type: object + description:

The display options for tile borders for visuals.

properties: Show: type: boolean default: null + description:

The option to enable display of borders for visuals.

additionalProperties: false DataColorPalette: type: object + description: |- +

The theme colors that are used for data colors in charts. The colors description is a + hexadecimal color code that consists of six alphanumerical characters, prefixed with + #, for example #37BFF5.

properties: Colors: type: array @@ -10436,6 +12896,7 @@ components: pattern: ^#[A-F0-9]{6}$ maxItems: 100 minItems: 0 + description:

The hexadecimal codes for the colors.

MinMaxGradient: type: array items: @@ -10443,9 +12904,13 @@ components: pattern: ^#[A-F0-9]{6}$ maxItems: 100 minItems: 0 + description:

The minimum and maximum hexadecimal codes that describe a color gradient.

EmptyFillColor: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The hexadecimal code of a color that applies to charts where a lack of data is + highlighted.

additionalProperties: false Font: type: object @@ -10455,20 +12920,27 @@ components: additionalProperties: false GutterStyle: type: object + description:

The display options for gutter spacing between tiles on a sheet.

properties: Show: type: boolean default: null + description: |- +

This Boolean value controls whether to display a gutter space between sheet tiles. +

additionalProperties: false MarginStyle: type: object + description:

The display options for margins around the outside edge of sheets.

properties: Show: type: boolean default: null + description:

This Boolean value controls whether to display sheet margins.

additionalProperties: false SheetStyle: type: object + description:

The theme display options for sheets.

properties: Tile: $ref: '#/components/schemas/TileStyle' @@ -10477,6 +12949,9 @@ components: additionalProperties: false ThemeConfiguration: type: object + description: |- +

The theme configuration. This configuration contains all of the display properties for + a theme.

properties: DataColorPalette: $ref: '#/components/schemas/DataColorPalette' @@ -10489,12 +12964,14 @@ components: additionalProperties: false ThemeError: type: object + description:

Theme error.

properties: Type: $ref: '#/components/schemas/ThemeErrorType' Message: type: string - pattern: .*\S.* + pattern: \S + description:

The error message.

additionalProperties: false ThemeErrorType: type: string @@ -10508,23 +12985,31 @@ components: - ALL ThemeVersion: type: object + description:

A version of a theme.

properties: VersionNumber: type: number minimum: 1 + description:

The version number of the theme.

Arn: type: string + description:

The Amazon Resource Name (ARN) of the resource.

Description: type: string maxLength: 512 minLength: 1 + description:

The description of the theme.

BaseThemeId: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ + description: |- +

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All + themes initially inherit from a default Amazon QuickSight theme.

CreatedTime: type: string + description:

The date and time that this theme version was created.

format: date-time Configuration: $ref: '#/components/schemas/ThemeConfiguration' @@ -10533,11 +13018,13 @@ components: items: $ref: '#/components/schemas/ThemeError' minItems: 1 + description:

Errors associated with the theme.

Status: $ref: '#/components/schemas/ResourceStatus' additionalProperties: false TileLayoutStyle: type: object + description:

The display options for the layout of tiles on a sheet.

properties: Gutter: $ref: '#/components/schemas/GutterStyle' @@ -10546,6 +13033,7 @@ components: additionalProperties: false TileStyle: type: object + description:

Display options related to tiles on a sheet.

properties: Border: $ref: '#/components/schemas/BorderStyle' @@ -10562,61 +13050,104 @@ components: additionalProperties: false UIColorPalette: type: object + description: |- +

The theme colors that apply to UI and to charts, excluding data colors. The colors + description is a hexadecimal color code that consists of six alphanumerical characters, + prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User + Guide. +

properties: PrimaryForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The color of text and other foreground elements that appear over the primary + background regions, such as grid lines, borders, table banding, icons, and so on.

PrimaryBackground: type: string pattern: ^#[A-F0-9]{6}$ + description:

The background color that applies to visuals and other high emphasis UI.

SecondaryForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any sheet title, sheet control text, or UI that + appears over the secondary background.

SecondaryBackground: type: string pattern: ^#[A-F0-9]{6}$ + description:

The background color that applies to the sheet background and sheet controls.

Accent: type: string pattern: ^#[A-F0-9]{6}$ + description:

This color is that applies to selected states and buttons.

AccentForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + accent color.

Danger: type: string pattern: ^#[A-F0-9]{6}$ + description:

The color that applies to error messages.

DangerForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + error color.

Warning: type: string pattern: ^#[A-F0-9]{6}$ + description:

This color that applies to warning and informational messages.

WarningForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + warning color.

Success: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The color that applies to success messages, for example the check mark for a + successful download.

SuccessForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + success color.

Dimension: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The color that applies to the names of fields that are identified as + dimensions.

DimensionForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + dimension color.

Measure: type: string pattern: ^#[A-F0-9]{6}$ + description:

The color that applies to the names of fields that are identified as measures.

MeasureForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + measure color.

additionalProperties: false Theme: type: object properties: Arn: type: string + description:

The Amazon Resource Name (ARN) of the theme.

AwsAccountId: type: string maxLength: 12 @@ -10626,14 +13157,16 @@ components: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ Configuration: $ref: '#/components/schemas/ThemeConfiguration' CreatedTime: type: string + description:

The date and time that the theme was created.

format: date-time LastUpdatedTime: type: string + description:

The date and time that the theme was last updated.

format: date-time Name: type: string @@ -10655,7 +13188,7 @@ components: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ Type: $ref: '#/components/schemas/ThemeType' Version: @@ -10671,7 +13204,9 @@ components: - Configuration - Name x-stackql-resource-name: theme - x-stackql-primaryIdentifier: + description: Definition of the AWS::QuickSight::Theme Resource Type. + x-type-name: AWS::QuickSight::Theme + x-stackql-primary-identifier: - ThemeId - AwsAccountId x-create-only-properties: @@ -10683,6 +13218,22 @@ components: - LastUpdatedTime - Arn - Type + x-required-properties: + - AwsAccountId + - ThemeId + - BaseThemeId + - Configuration + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource x-required-permissions: read: - quicksight:DescribeTheme @@ -10791,6 +13342,16 @@ components: - SINGULAR - RANGE - COLLECTIVE + CustomInstructions: + type: object + properties: + CustomInstructionsString: + type: string + maxLength: 5000 + minLength: 0 + required: + - CustomInstructionsString + additionalProperties: false DataAggregation: type: object properties: @@ -11079,6 +13640,8 @@ components: IsIncludedInTopic: type: boolean default: false + DisableIndexing: + type: boolean ColumnDataRole: $ref: '#/components/schemas/ColumnDataRole' TimeGranularity: @@ -11102,13 +13665,13 @@ components: NeverAggregateInFilter: type: boolean default: false - NonAdditive: - type: boolean - default: false CellValueSynonyms: type: array items: $ref: '#/components/schemas/CellValueSynonym' + NonAdditive: + type: boolean + default: false required: - CalculatedFieldName - Expression @@ -11166,6 +13729,8 @@ components: IsIncludedInTopic: type: boolean default: false + DisableIndexing: + type: boolean ComparativeOrder: $ref: '#/components/schemas/ComparativeOrder' SemanticType: @@ -11185,16 +13750,23 @@ components: NeverAggregateInFilter: type: boolean default: false - NonAdditive: - type: boolean - default: false CellValueSynonyms: type: array items: $ref: '#/components/schemas/CellValueSynonym' + NonAdditive: + type: boolean + default: false required: - ColumnName additionalProperties: false + TopicConfigOptions: + type: object + description: Model for configuration of a Topic + properties: + QBusinessInsightsEnabled: + type: boolean + additionalProperties: false TopicDateRangeFilter: type: object properties: @@ -11215,12 +13787,14 @@ components: type: string maxLength: 256 minLength: 0 + UserExperienceVersion: + $ref: '#/components/schemas/TopicUserExperienceVersion' DataSets: type: array items: $ref: '#/components/schemas/DatasetMetadata' - UserExperienceVersion: - $ref: '#/components/schemas/TopicUserExperienceVersion' + ConfigOptions: + $ref: '#/components/schemas/TopicConfigOptions' additionalProperties: false TopicFilter: type: object @@ -11374,249 +13948,1340 @@ components: UndefinedSpecifiedValueType: type: string enum: - - LEAST - - MOST - Topic: + - LEAST + - MOST + Topic: + type: object + properties: + Arn: + type: string + AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + ConfigOptions: + $ref: '#/components/schemas/TopicConfigOptions' + CustomInstructions: + $ref: '#/components/schemas/CustomInstructions' + DataSets: + type: array + items: + $ref: '#/components/schemas/DatasetMetadata' + Description: + type: string + maxLength: 256 + minLength: 0 + FolderArns: + type: array + items: + type: string + maxItems: 20 + minItems: 0 + Name: + type: string + maxLength: 128 + minLength: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + TopicId: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[A-Za-z0-9-_.\\+]*$ + UserExperienceVersion: + $ref: '#/components/schemas/TopicUserExperienceVersion' + x-stackql-resource-name: topic + description: Definition of the AWS::QuickSight::Topic Resource Type. + x-type-name: AWS::QuickSight::Topic + x-stackql-primary-identifier: + - AwsAccountId + - TopicId + x-create-only-properties: + - AwsAccountId + - FolderArns + - TopicId + - Tags + x-write-only-properties: + - FolderArns + x-read-only-properties: + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - quicksight:TagResource + - quicksight:ListTagsForResource + x-required-permissions: + create: + - quicksight:CreateTopic + - quicksight:PassDataSet + - quicksight:DescribeTopicRefresh + - quicksight:TagResource + read: + - quicksight:DescribeTopic + - quicksight:ListTagsForResource + update: + - quicksight:UpdateTopic + - quicksight:PassDataSet + - quicksight:DescribeTopicRefresh + delete: + - quicksight:DeleteTopic + list: + - quicksight:ListTopics + NetworkInterface: + type: object + description:

The structure that contains information about a network interface.

+ properties: + SubnetId: + type: string + maxLength: 255 + minLength: 1 + pattern: ^subnet-[0-9a-z]*$ + description:

The subnet ID associated with the network interface.

+ AvailabilityZone: + type: string + description:

The availability zone that the network interface resides in.

+ ErrorMessage: + type: string + description:

An error message.

+ Status: + $ref: '#/components/schemas/NetworkInterfaceStatus' + NetworkInterfaceId: + type: string + maxLength: 255 + minLength: 0 + pattern: ^eni-[0-9a-z]*$ + description:

The network interface ID.

+ additionalProperties: false + NetworkInterfaceStatus: + type: string + enum: + - CREATING + - AVAILABLE + - CREATION_FAILED + - UPDATING + - UPDATE_FAILED + - DELETING + - DELETED + - DELETION_FAILED + - DELETION_SCHEDULED + - ATTACHMENT_FAILED_ROLLBACK_FAILED + VPCConnectionAvailabilityStatus: + type: string + enum: + - AVAILABLE + - UNAVAILABLE + - PARTIALLY_AVAILABLE + VPCConnectionResourceStatus: + type: string + enum: + - CREATION_IN_PROGRESS + - CREATION_SUCCESSFUL + - CREATION_FAILED + - UPDATE_IN_PROGRESS + - UPDATE_SUCCESSFUL + - UPDATE_FAILED + - DELETION_IN_PROGRESS + - DELETION_FAILED + - DELETED + VPCConnection: type: object properties: Arn: type: string + description:

The Amazon Resource Name (ARN) of the VPC connection.

+ AvailabilityStatus: + $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' AwsAccountId: type: string maxLength: 12 minLength: 12 pattern: ^[0-9]{12}$ - DataSets: + CreatedTime: + type: string + description:

The time that the VPC connection was created.

+ format: date-time + DnsResolvers: type: array items: - $ref: '#/components/schemas/DatasetMetadata' - Description: + type: string + x-insertionOrder: false + LastUpdatedTime: type: string - maxLength: 256 - minLength: 0 + description:

The time that the VPC connection was last updated.

+ format: date-time Name: type: string maxLength: 128 minLength: 1 - TopicId: + NetworkInterfaces: + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + maxItems: 15 + minItems: 0 + description:

A list of network interfaces.

+ x-insertionOrder: false + RoleArn: type: string - maxLength: 256 - minLength: 0 - pattern: ^[A-Za-z0-9-_.\\+]*$ - UserExperienceVersion: - $ref: '#/components/schemas/TopicUserExperienceVersion' - x-stackql-resource-name: topic - x-stackql-primaryIdentifier: + SecurityGroupIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^sg-[0-9a-z]*$ + maxItems: 16 + minItems: 1 + x-insertionOrder: false + Status: + $ref: '#/components/schemas/VPCConnectionResourceStatus' + SubnetIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^subnet-[0-9a-z]*$ + maxItems: 15 + minItems: 2 + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + x-insertionOrder: false + VPCConnectionId: + type: string + maxLength: 1000 + minLength: 1 + pattern: '[\w\-]+' + VPCId: + type: string + description:

The Amazon EC2 VPC ID associated with the VPC connection.

+ x-stackql-resource-name: vpc_connection + description: Definition of the AWS::QuickSight::VPCConnection Resource Type. + x-type-name: AWS::QuickSight::VPCConnection + x-stackql-primary-identifier: - AwsAccountId - - TopicId + - VPCConnectionId x-create-only-properties: - AwsAccountId - - TopicId + - VPCConnectionId + x-write-only-properties: + - SubnetIds x-read-only-properties: - Arn + - CreatedTime + - LastUpdatedTime + - NetworkInterfaces + - Status + - VPCId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource x-required-permissions: create: - - quicksight:CreateTopic - - quicksight:PassDataSet - - quicksight:DescribeTopicRefresh + - quicksight:CreateVPCConnection + - quicksight:DescribeVPCConnection + - quicksight:ListTagsForResource + - quicksight:TagResource + - iam:PassRole read: - - quicksight:DescribeTopic + - quicksight:DescribeVPCConnection + - quicksight:ListTagsForResource update: - - quicksight:UpdateTopic - - quicksight:PassDataSet - - quicksight:DescribeTopicRefresh + - quicksight:DescribeVPCConnection + - quicksight:UpdateVPCConnection + - quicksight:TagResource + - quicksight:UntagResource + - quicksight:ListTagsForResource + - iam:PassRole delete: - - quicksight:DeleteTopic + - quicksight:DescribeVPCConnection + - quicksight:DeleteVPCConnection + - quicksight:ListTagsForResource + - iam:PassRole list: - - quicksight:ListTopics - Arn: - type: string - DnsResolvers: - type: array - items: - type: string - x-insertionOrder: false - NetworkInterfaces: - type: array - items: - $ref: '#/components/schemas/NetworkInterface' - maxItems: 15 - x-insertionOrder: false - NetworkInterface: + - quicksight:ListVPCConnections + CreateAnalysisRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + $ref: '#/components/schemas/ResourceStatus' + CreatedTime: + format: date-time + description:

The time that the analysis was created.

+ type: string + Parameters: + $ref: '#/components/schemas/Parameters' + DataSetArns: + minItems: 0 + maxItems: 100 + description:

The ARNs of the datasets of the analysis.

+ type: array + items: + type: string + SourceEntity: + $ref: '#/components/schemas/AnalysisSourceEntity' + ThemeArn: + description:

The ARN of the theme of the analysis.

+ type: string + Definition: + $ref: '#/components/schemas/AnalysisDefinition' + LastUpdatedTime: + format: date-time + description:

The time that the analysis was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' + FolderArns: + minItems: 0 + maxItems: 10 + type: array + items: + type: string + Name: + minLength: 1 + description:

The descriptive name of the analysis.

+ type: string + maxLength: 2048 + Errors: + minItems: 1 + description:

Errors associated with the analysis.

+ type: array + items: + $ref: '#/components/schemas/AnalysisError' + AnalysisId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + Arn: + description:

The Amazon Resource Name (ARN) of the analysis.

+ type: string + Tags: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/Tag' + Sheets: + minItems: 0 + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

+ type: array + items: + $ref: '#/components/schemas/Sheet' + x-stackQL-stringOnly: true + x-title: CreateAnalysisRequest + type: object + required: [] + CreateCustomPermissionsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + Capabilities: + $ref: '#/components/schemas/Capabilities' + CustomPermissionsName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9+=,.@_-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + x-stackQL-stringOnly: true + x-title: CreateCustomPermissionsRequest + type: object + required: [] + CreateDashboardRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedTime: + format: date-time + description:

The time that this dashboard was created.

+ type: string + Parameters: + $ref: '#/components/schemas/Parameters' + VersionDescription: + minLength: 1 + type: string + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/DashboardSourceEntity' + ThemeArn: + type: string + Definition: + $ref: '#/components/schemas/DashboardVersionDefinition' + LastUpdatedTime: + format: date-time + description:

The last time that this dashboard was updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' + FolderArns: + minItems: 0 + maxItems: 10 + type: array + items: + type: string + DashboardId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + LinkSharingConfiguration: + $ref: '#/components/schemas/LinkSharingConfiguration' + Name: + minLength: 1 + type: string + maxLength: 2048 + DashboardPublishOptions: + $ref: '#/components/schemas/DashboardPublishOptions' + LastPublishedTime: + format: date-time + description:

The last time that this dashboard was published.

+ type: string + Version: + $ref: '#/components/schemas/DashboardVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + LinkEntities: + minItems: 0 + maxItems: 5 + type: array + items: + minLength: 1 + pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512}$ + type: string + maxLength: 1024 + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + Tags: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDashboardRequest + type: object + required: [] + CreateDataSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedTime: + format: string + description:

The time that this dataset was created.

+ type: string + FolderArns: + minItems: 0 + maxItems: 10 + description:

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

+ type: array + items: + type: string + ConsumedSpiceCapacityInBytes: + default: 0 + description: |- +

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't + imported into SPICE.

+ type: number + RowLevelPermissionDataSet: + $ref: '#/components/schemas/RowLevelPermissionDataSet' + IngestionWaitPolicy: + $ref: '#/components/schemas/IngestionWaitPolicy' + ColumnLevelPermissionRules: + minItems: 1 + description: |- +

A set of one or more definitions of a + ColumnLevelPermissionRule + .

+ type: array + items: + $ref: '#/components/schemas/ColumnLevelPermissionRule' + Name: + minLength: 1 + description:

The display name for the dataset.

+ type: string + maxLength: 128 + Permissions: + minItems: 1 + maxItems: 64 + description:

A list of resource permissions on the dataset.

+ type: array + items: + $ref: '#/components/schemas/ResourcePermission' + UseAs: + $ref: '#/components/schemas/DataSetUseAs' + Tags: + minItems: 1 + maxItems: 200 + description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+ type: array + items: + $ref: '#/components/schemas/Tag' + PhysicalTableMap: + $ref: '#/components/schemas/PhysicalTableMap' + FieldFolders: + $ref: '#/components/schemas/FieldFolderMap' + LastUpdatedTime: + format: string + description:

The last time that this dataset was updated.

+ type: string + DataSetId: + type: string + PerformanceConfiguration: + $ref: '#/components/schemas/PerformanceConfiguration' + DataSetRefreshProperties: + $ref: '#/components/schemas/DataSetRefreshProperties' + RowLevelPermissionTagConfiguration: + $ref: '#/components/schemas/RowLevelPermissionTagConfiguration' + ColumnGroups: + minItems: 1 + maxItems: 8 + description:

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

+ type: array + items: + $ref: '#/components/schemas/ColumnGroup' + ImportMode: + $ref: '#/components/schemas/DataSetImportMode' + DatasetParameters: + minItems: 0 + maxItems: 32 + description:

The parameter declarations of the dataset.

+ type: array + items: + $ref: '#/components/schemas/DatasetParameter' + LogicalTableMap: + $ref: '#/components/schemas/LogicalTableMap' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + DataSetUsageConfiguration: + $ref: '#/components/schemas/DataSetUsageConfiguration' + OutputColumns: + description: |- +

The list of columns after all transforms. These columns are available in templates, + analyses, and dashboards.

+ type: array + items: + $ref: '#/components/schemas/OutputColumn' + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + x-stackQL-stringOnly: true + x-title: CreateDataSetRequest + type: object + required: [] + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + $ref: '#/components/schemas/ResourceStatus' + CreatedTime: + format: date-time + description:

The time that this data source was created.

+ type: string + ErrorInfo: + $ref: '#/components/schemas/DataSourceErrorInfo' + LastUpdatedTime: + format: date-time + description:

The last time that this data source was updated.

+ type: string + FolderArns: + minItems: 0 + maxItems: 10 + type: array + items: + type: string + Name: + minLength: 1 + type: string + maxLength: 128 + DataSourceParameters: + $ref: '#/components/schemas/DataSourceParameters' + Type: + $ref: '#/components/schemas/DataSourceType' + VpcConnectionProperties: + $ref: '#/components/schemas/VpcConnectionProperties' + AlternateDataSourceParameters: + minItems: 1 + maxItems: 50 + description: |- +

A set of alternate data source parameters that you want to share for the credentials + stored with this data source. The credentials are applied in tandem with the data source + parameters when you copy a data source by using a create or update request. The API + operation compares the DataSourceParameters structure that's in the request + with the structures in the AlternateDataSourceParameters allow list. If the + structures are an exact match, the request is allowed to use the credentials from this + existing data source. If the AlternateDataSourceParameters list is null, + the Credentials originally used with this DataSourceParameters + are automatically allowed.

+ type: array + items: + $ref: '#/components/schemas/DataSourceParameters' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + Arn: + description:

The Amazon Resource Name (ARN) of the data source.

+ type: string + SslProperties: + $ref: '#/components/schemas/SslProperties' + Credentials: + $ref: '#/components/schemas/DataSourceCredentials' + DataSourceId: + type: string + Tags: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateFolderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) for the folder.

+ pattern: ^arn:.* + AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + CreatedTime: + type: string + description:

The time that the folder was created.

+ format: date-time + FolderId: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[\w\-]+$ + FolderType: + $ref: '#/components/schemas/FolderType' + LastUpdatedTime: + type: string + description:

The time that the folder was last updated.

+ format: date-time + Name: + type: string + maxLength: 200 + minLength: 1 + ParentFolderArn: + type: string + Permissions: + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + maxItems: 64 + minItems: 1 + x-insertionOrder: false + SharingModel: + $ref: '#/components/schemas/SharingModel' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateFolderRequest + type: object + required: [] + CreateRefreshScheduleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) of the data source.

+ AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + DataSetId: + type: string + Schedule: + $ref: '#/components/schemas/RefreshScheduleMap' + x-stackQL-stringOnly: true + x-title: CreateRefreshScheduleRequest + type: object + required: [] + CreateTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CreatedTime: + format: date-time + description:

Time when this was created.

+ type: string + VersionDescription: + minLength: 1 + type: string + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/TemplateSourceEntity' + Definition: + $ref: '#/components/schemas/TemplateVersionDefinition' + LastUpdatedTime: + format: date-time + description:

Time when this was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' + Name: + minLength: 1 + type: string + maxLength: 2048 + Version: + $ref: '#/components/schemas/TemplateVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + Arn: + description:

The Amazon Resource Name (ARN) of the template.

+ type: string + Tags: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/Tag' + TemplateId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + x-stackQL-stringOnly: true + x-title: CreateTemplateRequest type: object + required: [] + CreateThemeRequest: properties: - SubnetId: - $ref: '#/components/schemas/SubnetId' - AvailabilityZone: + ClientToken: type: string - ErrorMessage: + RoleArn: type: string - Status: + TypeName: type: string - enum: - - CREATING - - AVAILABLE - - CREATION_FAILED - - UPDATING - - UPDATE_FAILED - - DELETING - - DELETED - - DELETION_FAILED - - DELETION_SCHEDULED - - ATTACHMENT_FAILED_ROLLBACK_FAILED - NetworkInterfaceId: - $ref: '#/components/schemas/NetworkInterfaceId' - additionalProperties: false - required: [] - NetworkInterfaceId: - type: string - pattern: ^eni-[0-9a-z]*$ - maxLength: 255 - RoleArn: - type: string - SecurityGroupIds: - type: array - items: - $ref: '#/components/schemas/SecurityGroupId' - maxItems: 16 - minItems: 1 - x-insertionOrder: false - SecurityGroupId: - type: string - pattern: ^sg-[0-9a-z]*$ - maxItems: 255 - minItems: 1 - SubnetIds: - type: array - items: - $ref: '#/components/schemas/SubnetId' - maxItems: 15 - minItems: 2 - x-insertionOrder: false - SubnetId: - type: string - pattern: ^subnet-[0-9a-z]*$ - maxLength: 255 - minLength: 1 - Tags: - type: array - items: - $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - x-insertionOrder: false - VPCConnectionId: - type: string - maxLength: 1000 - minLength: 1 - pattern: '[\w\-]+' - VPCId: - type: string - VPCConnectionResourceStatus: - type: string - enum: - - CREATION_IN_PROGRESS - - CREATION_SUCCESSFUL - - CREATION_FAILED - - UPDATE_IN_PROGRESS - - UPDATE_SUCCESSFUL - - UPDATE_FAILED - - DELETION_IN_PROGRESS - - DELETION_FAILED - - DELETED - VPCConnectionAvailabilityStatus: - type: string - enum: - - AVAILABLE - - UNAVAILABLE - - PARTIALLY_AVAILABLE - VPCConnection: + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) of the theme.

+ AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + BaseThemeId: + type: string + maxLength: 512 + minLength: 1 + pattern: ^[\w\-]+$ + Configuration: + $ref: '#/components/schemas/ThemeConfiguration' + CreatedTime: + type: string + description:

The date and time that the theme was created.

+ format: date-time + LastUpdatedTime: + type: string + description:

The date and time that the theme was last updated.

+ format: date-time + Name: + type: string + maxLength: 2048 + minLength: 1 + Permissions: + type: array + items: + $ref: '#/components/schemas/ResourcePermission' + maxItems: 64 + minItems: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + ThemeId: + type: string + maxLength: 512 + minLength: 1 + pattern: ^[\w\-]+$ + Type: + $ref: '#/components/schemas/ThemeType' + Version: + $ref: '#/components/schemas/ThemeVersion' + VersionDescription: + type: string + maxLength: 512 + minLength: 1 + x-stackQL-stringOnly: true + x-title: CreateThemeRequest type: object + required: [] + CreateTopicRequest: properties: - Arn: - $ref: '#/components/schemas/Arn' - AwsAccountId: + ClientToken: type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ - Name: + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + ConfigOptions: + $ref: '#/components/schemas/TopicConfigOptions' + CustomInstructions: + $ref: '#/components/schemas/CustomInstructions' + DataSets: + type: array + items: + $ref: '#/components/schemas/DatasetMetadata' + Description: + type: string + maxLength: 256 + minLength: 0 + FolderArns: + type: array + items: + type: string + maxItems: 20 + minItems: 0 + Name: + type: string + maxLength: 128 + minLength: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + TopicId: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[A-Za-z0-9-_.\\+]*$ + UserExperienceVersion: + $ref: '#/components/schemas/TopicUserExperienceVersion' + x-stackQL-stringOnly: true + x-title: CreateTopicRequest + type: object + required: [] + CreateVPCConnectionRequest: + properties: + ClientToken: type: string - maxLength: 128 - minLength: 1 - VPCConnectionId: - $ref: '#/components/schemas/VPCConnectionId' - VPCId: - $ref: '#/components/schemas/VPCId' - SecurityGroupIds: - $ref: '#/components/schemas/SecurityGroupIds' - SubnetIds: - $ref: '#/components/schemas/SubnetIds' - DnsResolvers: - $ref: '#/components/schemas/DnsResolvers' - Status: - $ref: '#/components/schemas/VPCConnectionResourceStatus' - AvailabilityStatus: - $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' - NetworkInterfaces: - $ref: '#/components/schemas/NetworkInterfaces' RoleArn: - $ref: '#/components/schemas/RoleArn' - CreatedTime: type: string - format: date-time - LastUpdatedTime: + TypeName: type: string - format: date-time - Tags: - $ref: '#/components/schemas/Tags' - x-stackql-resource-name: vpc_connection - x-stackql-primaryIdentifier: - - AwsAccountId - - VPCConnectionId - x-create-only-properties: - - AwsAccountId - - VPCConnectionId - x-read-only-properties: - - Arn - - CreatedTime - - LastUpdatedTime - - NetworkInterfaces - - Status - - VPCId - x-required-permissions: - create: - - quicksight:CreateVPCConnection - - quicksight:DescribeVPCConnection - - quicksight:ListTagsForResource - - quicksight:TagResource - - iam:PassRole - read: - - quicksight:DescribeVPCConnection - - quicksight:ListTagsForResource - update: - - quicksight:DescribeVPCConnection - - quicksight:UpdateVPCConnection - - quicksight:TagResource - - quicksight:UntagResource - - quicksight:ListTagsForResource - - iam:PassRole - delete: - - quicksight:DescribeVPCConnection - - quicksight:DeleteVPCConnection - - quicksight:ListTagsForResource - - iam:PassRole - list: - - quicksight:ListVPCConnections + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description:

The Amazon Resource Name (ARN) of the VPC connection.

+ AvailabilityStatus: + $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' + AwsAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + CreatedTime: + type: string + description:

The time that the VPC connection was created.

+ format: date-time + DnsResolvers: + type: array + items: + type: string + x-insertionOrder: false + LastUpdatedTime: + type: string + description:

The time that the VPC connection was last updated.

+ format: date-time + Name: + type: string + maxLength: 128 + minLength: 1 + NetworkInterfaces: + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + maxItems: 15 + minItems: 0 + description:

A list of network interfaces.

+ x-insertionOrder: false + RoleArn: + type: string + SecurityGroupIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^sg-[0-9a-z]*$ + maxItems: 16 + minItems: 1 + x-insertionOrder: false + Status: + $ref: '#/components/schemas/VPCConnectionResourceStatus' + SubnetIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^subnet-[0-9a-z]*$ + maxItems: 15 + minItems: 2 + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + x-insertionOrder: false + VPCConnectionId: + type: string + maxLength: 1000 + minLength: 1 + pattern: '[\w\-]+' + VPCId: + type: string + description:

The Amazon EC2 VPC ID associated with the VPC connection.

+ x-stackQL-stringOnly: true + x-title: CreateVPCConnectionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: analyses: name: analyses id: awscc.quicksight.analyses x-cfn-schema-name: Analysis - x-type: list + x-cfn-type-name: AWS::QuickSight::Analysis + x-identifiers: + - AnalysisId + - AwsAccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Analysis&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Analysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Analysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Analysis" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/analyses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/analyses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/analyses/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.DataSetArns') as data_set_arns, + JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, + JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, + JSON_EXTRACT(Properties, '$.FolderArns') as folder_arns, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Errors') as errors, + JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.Permissions') as permissions, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Sheets') as sheets + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'DataSetArns') as data_set_arns, + json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'ThemeArn') as theme_arn, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, + json_extract_path_text(Properties, 'FolderArns') as folder_arns, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Errors') as errors, + json_extract_path_text(Properties, 'AnalysisId') as analysis_id, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Sheets') as sheets + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' + AND data__Identifier = '|' + AND region = 'us-east-1' + analyses_list_only: + name: analyses_list_only + id: awscc.quicksight.analyses_list_only + x-cfn-schema-name: Analysis + x-cfn-type-name: AWS::QuickSight::Analysis + x-identifiers: + - AnalysisId + - AwsAccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AnalysisId') as analysis_id, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' + AND region = 'us-east-1' + custom_permissions: + name: custom_permissions + id: awscc.quicksight.custom_permissions + x-cfn-schema-name: CustomPermissions + x-cfn-type-name: AWS::QuickSight::CustomPermissions + x-identifiers: + - AwsAccountId + - CustomPermissionsName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomPermissions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::CustomPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::CustomPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::CustomPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_permissions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/custom_permissions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.Capabilities') as capabilities, + JSON_EXTRACT(Properties, '$.CustomPermissionsName') as custom_permissions_name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::CustomPermissions' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'CustomPermissionsName') as custom_permissions_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::CustomPermissions' + AND data__Identifier = '|' + AND region = 'us-east-1' + custom_permissions_list_only: + name: custom_permissions_list_only + id: awscc.quicksight.custom_permissions_list_only + x-cfn-schema-name: CustomPermissions + x-cfn-type-name: AWS::QuickSight::CustomPermissions x-identifiers: - - AnalysisId - AwsAccountId + - CustomPermissionsName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11624,89 +15289,149 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.CustomPermissionsName') as custom_permissions_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::CustomPermissions' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AnalysisId') as analysis_id, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'CustomPermissionsName') as custom_permissions_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::CustomPermissions' AND region = 'us-east-1' - analysis: - name: analysis - id: awscc.quicksight.analysis - x-cfn-schema-name: Analysis - x-type: get + dashboards: + name: dashboards + id: awscc.quicksight.dashboards + x-cfn-schema-name: Dashboard + x-cfn-type-name: AWS::QuickSight::Dashboard x-identifiers: - - AnalysisId - AwsAccountId + - DashboardId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Dashboard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.DataSetArns') as data_set_arns, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, + JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, + JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, JSON_EXTRACT(Properties, '$.Definition') as definition, - JSON_EXTRACT(Properties, '$.Errors') as errors, JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, + JSON_EXTRACT(Properties, '$.FolderArns') as folder_arns, + JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id, + JSON_EXTRACT(Properties, '$.LinkSharingConfiguration') as link_sharing_configuration, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.DashboardPublishOptions') as dashboard_publish_options, + JSON_EXTRACT(Properties, '$.LastPublishedTime') as last_published_time, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.Sheets') as sheets, - JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, - JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LinkEntities') as link_entities, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AnalysisId') as analysis_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'DataSetArns') as data_set_arns, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'ThemeArn') as theme_arn, json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'Errors') as errors, json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, + json_extract_path_text(Properties, 'FolderArns') as folder_arns, + json_extract_path_text(Properties, 'DashboardId') as dashboard_id, + json_extract_path_text(Properties, 'LinkSharingConfiguration') as link_sharing_configuration, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'DashboardPublishOptions') as dashboard_publish_options, + json_extract_path_text(Properties, 'LastPublishedTime') as last_published_time, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'Sheets') as sheets, - json_extract_path_text(Properties, 'SourceEntity') as source_entity, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ThemeArn') as theme_arn, - json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'LinkEntities') as link_entities, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' + AND data__Identifier = '|' AND region = 'us-east-1' - dashboards: - name: dashboards - id: awscc.quicksight.dashboards + dashboards_list_only: + name: dashboards_list_only + id: awscc.quicksight.dashboards_list_only x-cfn-schema-name: Dashboard - x-type: list + x-cfn-type-name: AWS::QuickSight::Dashboard x-identifiers: - AwsAccountId - DashboardId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11727,80 +15452,146 @@ components: json_extract_path_text(Properties, 'DashboardId') as dashboard_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Dashboard' AND region = 'us-east-1' - dashboard: - name: dashboard - id: awscc.quicksight.dashboard - x-cfn-schema-name: Dashboard - x-type: get + data_sets: + name: data_sets + id: awscc.quicksight.data_sets + x-cfn-schema-name: DataSet + x-cfn-type-name: AWS::QuickSight::DataSet x-identifiers: - AwsAccountId - - DashboardId + - DataSetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id, - JSON_EXTRACT(Properties, '$.DashboardPublishOptions') as dashboard_publish_options, - JSON_EXTRACT(Properties, '$.Definition') as definition, - JSON_EXTRACT(Properties, '$.LastPublishedTime') as last_published_time, - JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, - JSON_EXTRACT(Properties, '$.LinkEntities') as link_entities, - JSON_EXTRACT(Properties, '$.LinkSharingConfiguration') as link_sharing_configuration, + JSON_EXTRACT(Properties, '$.FolderArns') as folder_arns, + JSON_EXTRACT(Properties, '$.ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, + JSON_EXTRACT(Properties, '$.RowLevelPermissionDataSet') as row_level_permission_data_set, + JSON_EXTRACT(Properties, '$.IngestionWaitPolicy') as ingestion_wait_policy, + JSON_EXTRACT(Properties, '$.ColumnLevelPermissionRules') as column_level_permission_rules, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Parameters') as parameters, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, + JSON_EXTRACT(Properties, '$.UseAs') as use_as, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, - JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.VersionDescription') as version_description - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PhysicalTableMap') as physical_table_map, + JSON_EXTRACT(Properties, '$.FieldFolders') as field_folders, + JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, + JSON_EXTRACT(Properties, '$.PerformanceConfiguration') as performance_configuration, + JSON_EXTRACT(Properties, '$.DataSetRefreshProperties') as data_set_refresh_properties, + JSON_EXTRACT(Properties, '$.RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, + JSON_EXTRACT(Properties, '$.ColumnGroups') as column_groups, + JSON_EXTRACT(Properties, '$.ImportMode') as import_mode, + JSON_EXTRACT(Properties, '$.DatasetParameters') as dataset_parameters, + JSON_EXTRACT(Properties, '$.LogicalTableMap') as logical_table_map, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.DataSetUsageConfiguration') as data_set_usage_configuration, + JSON_EXTRACT(Properties, '$.OutputColumns') as output_columns, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'DashboardId') as dashboard_id, - json_extract_path_text(Properties, 'DashboardPublishOptions') as dashboard_publish_options, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'LastPublishedTime') as last_published_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'LinkEntities') as link_entities, - json_extract_path_text(Properties, 'LinkSharingConfiguration') as link_sharing_configuration, + json_extract_path_text(Properties, 'FolderArns') as folder_arns, + json_extract_path_text(Properties, 'ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, + json_extract_path_text(Properties, 'RowLevelPermissionDataSet') as row_level_permission_data_set, + json_extract_path_text(Properties, 'IngestionWaitPolicy') as ingestion_wait_policy, + json_extract_path_text(Properties, 'ColumnLevelPermissionRules') as column_level_permission_rules, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Parameters') as parameters, json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'UseAs') as use_as, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ThemeArn') as theme_arn, - json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'VersionDescription') as version_description - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'PhysicalTableMap') as physical_table_map, + json_extract_path_text(Properties, 'FieldFolders') as field_folders, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'DataSetId') as data_set_id, + json_extract_path_text(Properties, 'PerformanceConfiguration') as performance_configuration, + json_extract_path_text(Properties, 'DataSetRefreshProperties') as data_set_refresh_properties, + json_extract_path_text(Properties, 'RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, + json_extract_path_text(Properties, 'ColumnGroups') as column_groups, + json_extract_path_text(Properties, 'ImportMode') as import_mode, + json_extract_path_text(Properties, 'DatasetParameters') as dataset_parameters, + json_extract_path_text(Properties, 'LogicalTableMap') as logical_table_map, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DataSetUsageConfiguration') as data_set_usage_configuration, + json_extract_path_text(Properties, 'OutputColumns') as output_columns, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' + AND data__Identifier = '|' AND region = 'us-east-1' - data_sets: - name: data_sets - id: awscc.quicksight.data_sets + data_sets_list_only: + name: data_sets_list_only + id: awscc.quicksight.data_sets_list_only x-cfn-schema-name: DataSet - x-type: list + x-cfn-type-name: AWS::QuickSight::DataSet x-identifiers: - AwsAccountId - DataSetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11821,86 +15612,130 @@ components: json_extract_path_text(Properties, 'DataSetId') as data_set_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSet' AND region = 'us-east-1' - data_set: - name: data_set - id: awscc.quicksight.data_set - x-cfn-schema-name: DataSet - x-type: get + data_sources: + name: data_sources + id: awscc.quicksight.data_sources + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::QuickSight::DataSource x-identifiers: - AwsAccountId - - DataSetId + - DataSourceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.ColumnGroups') as column_groups, - JSON_EXTRACT(Properties, '$.ColumnLevelPermissionRules') as column_level_permission_rules, - JSON_EXTRACT(Properties, '$.ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, + JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, - JSON_EXTRACT(Properties, '$.DatasetParameters') as dataset_parameters, - JSON_EXTRACT(Properties, '$.FieldFolders') as field_folders, - JSON_EXTRACT(Properties, '$.ImportMode') as import_mode, + JSON_EXTRACT(Properties, '$.ErrorInfo') as error_info, JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, - JSON_EXTRACT(Properties, '$.LogicalTableMap') as logical_table_map, + JSON_EXTRACT(Properties, '$.FolderArns') as folder_arns, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.OutputColumns') as output_columns, + JSON_EXTRACT(Properties, '$.DataSourceParameters') as data_source_parameters, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.VpcConnectionProperties') as vpc_connection_properties, + JSON_EXTRACT(Properties, '$.AlternateDataSourceParameters') as alternate_data_source_parameters, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.PhysicalTableMap') as physical_table_map, - JSON_EXTRACT(Properties, '$.RowLevelPermissionDataSet') as row_level_permission_data_set, - JSON_EXTRACT(Properties, '$.RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.IngestionWaitPolicy') as ingestion_wait_policy, - JSON_EXTRACT(Properties, '$.DataSetUsageConfiguration') as data_set_usage_configuration, - JSON_EXTRACT(Properties, '$.DataSetRefreshProperties') as data_set_refresh_properties - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.SslProperties') as ssl_properties, + JSON_EXTRACT(Properties, '$.Credentials') as credentials, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSource' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'ColumnGroups') as column_groups, - json_extract_path_text(Properties, 'ColumnLevelPermissionRules') as column_level_permission_rules, - json_extract_path_text(Properties, 'ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, + json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'DataSetId') as data_set_id, - json_extract_path_text(Properties, 'DatasetParameters') as dataset_parameters, - json_extract_path_text(Properties, 'FieldFolders') as field_folders, - json_extract_path_text(Properties, 'ImportMode') as import_mode, + json_extract_path_text(Properties, 'ErrorInfo') as error_info, json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'LogicalTableMap') as logical_table_map, + json_extract_path_text(Properties, 'FolderArns') as folder_arns, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OutputColumns') as output_columns, + json_extract_path_text(Properties, 'DataSourceParameters') as data_source_parameters, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'VpcConnectionProperties') as vpc_connection_properties, + json_extract_path_text(Properties, 'AlternateDataSourceParameters') as alternate_data_source_parameters, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'PhysicalTableMap') as physical_table_map, - json_extract_path_text(Properties, 'RowLevelPermissionDataSet') as row_level_permission_data_set, - json_extract_path_text(Properties, 'RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'IngestionWaitPolicy') as ingestion_wait_policy, - json_extract_path_text(Properties, 'DataSetUsageConfiguration') as data_set_usage_configuration, - json_extract_path_text(Properties, 'DataSetRefreshProperties') as data_set_refresh_properties - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'SslProperties') as ssl_properties, + json_extract_path_text(Properties, 'Credentials') as credentials, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSource' + AND data__Identifier = '|' AND region = 'us-east-1' - data_sources: - name: data_sources - id: awscc.quicksight.data_sources + data_sources_list_only: + name: data_sources_list_only + id: awscc.quicksight.data_sources_list_only x-cfn-schema-name: DataSource - x-type: list + x-cfn-type-name: AWS::QuickSight::DataSource x-identifiers: - AwsAccountId - DataSourceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11921,75 +15756,118 @@ components: json_extract_path_text(Properties, 'DataSourceId') as data_source_id FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSource' AND region = 'us-east-1' - data_source: - name: data_source - id: awscc.quicksight.data_source - x-cfn-schema-name: DataSource - x-type: get + folders: + name: folders + id: awscc.quicksight.folders + x-cfn-schema-name: Folder + x-cfn-type-name: AWS::QuickSight::Folder x-identifiers: - AwsAccountId - - DataSourceId + - FolderId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Folder&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Folder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Folder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Folder" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/folders/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/folders/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/folders/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AlternateDataSourceParameters') as alternate_data_source_parameters, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.Credentials') as credentials, - JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, - JSON_EXTRACT(Properties, '$.DataSourceParameters') as data_source_parameters, - JSON_EXTRACT(Properties, '$.ErrorInfo') as error_info, + JSON_EXTRACT(Properties, '$.FolderId') as folder_id, + JSON_EXTRACT(Properties, '$.FolderType') as folder_type, JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ParentFolderArn') as parent_folder_arn, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.SslProperties') as ssl_properties, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.VpcConnectionProperties') as vpc_connection_properties - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.SharingModel') as sharing_model, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Folder' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AlternateDataSourceParameters') as alternate_data_source_parameters, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'Credentials') as credentials, - json_extract_path_text(Properties, 'DataSourceId') as data_source_id, - json_extract_path_text(Properties, 'DataSourceParameters') as data_source_parameters, - json_extract_path_text(Properties, 'ErrorInfo') as error_info, + json_extract_path_text(Properties, 'FolderId') as folder_id, + json_extract_path_text(Properties, 'FolderType') as folder_type, json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ParentFolderArn') as parent_folder_arn, json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SslProperties') as ssl_properties, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'VpcConnectionProperties') as vpc_connection_properties - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSource' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'SharingModel') as sharing_model, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Folder' + AND data__Identifier = '|' AND region = 'us-east-1' - refresh_schedules: - name: refresh_schedules - id: awscc.quicksight.refresh_schedules - x-cfn-schema-name: RefreshSchedule - x-type: list + folders_list_only: + name: folders_list_only + id: awscc.quicksight.folders_list_only + x-cfn-schema-name: Folder + x-cfn-type-name: AWS::QuickSight::Folder x-identifiers: - AwsAccountId - - DataSetId - - Schedule/ScheduleId + - FolderId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -11998,9 +15876,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, - JSON_EXTRACT(Properties, '$.Schedule.ScheduleId') as schedule__schedule_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' + JSON_EXTRACT(Properties, '$.FolderId') as folder_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Folder' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -12008,23 +15885,70 @@ components: SELECT region, json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DataSetId') as data_set_id, - json_extract_path_text(Properties, 'Schedule', 'ScheduleId') as schedule__schedule_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' + json_extract_path_text(Properties, 'FolderId') as folder_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Folder' AND region = 'us-east-1' - refresh_schedule: - name: refresh_schedule - id: awscc.quicksight.refresh_schedule + refresh_schedules: + name: refresh_schedules + id: awscc.quicksight.refresh_schedules x-cfn-schema-name: RefreshSchedule - x-type: get + x-cfn-type-name: AWS::QuickSight::RefreshSchedule x-identifiers: - AwsAccountId - DataSetId - Schedule/ScheduleId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RefreshSchedule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::RefreshSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::RefreshSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::RefreshSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12037,7 +15961,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12049,14 +15973,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' AND data__Identifier = '||' AND region = 'us-east-1' - templates: - name: templates - id: awscc.quicksight.templates - x-cfn-schema-name: Template - x-type: list + refresh_schedules_list_only: + name: refresh_schedules_list_only + id: awscc.quicksight.refresh_schedules_list_only + x-cfn-schema-name: RefreshSchedule + x-cfn-type-name: AWS::QuickSight::RefreshSchedule x-identifiers: - AwsAccountId - - TemplateId + - DataSetId + - Schedule/ScheduleId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12065,8 +15996,9 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.TemplateId') as template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' + JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, + JSON_EXTRACT(Properties, '$.Schedule.ScheduleId') as schedule__schedule_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -12074,71 +16006,126 @@ components: SELECT region, json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'TemplateId') as template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' + json_extract_path_text(Properties, 'DataSetId') as data_set_id, + json_extract_path_text(Properties, 'Schedule', 'ScheduleId') as schedule__schedule_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' AND region = 'us-east-1' - template: - name: template - id: awscc.quicksight.template + templates: + name: templates + id: awscc.quicksight.templates x-cfn-schema-name: Template - x-type: get + x-cfn-type-name: AWS::QuickSight::Template x-identifiers: - AwsAccountId - TemplateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Template&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, + JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, JSON_EXTRACT(Properties, '$.Definition') as definition, JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TemplateId') as template_id, - JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.VersionDescription') as version_description + JSON_EXTRACT(Properties, '$.TemplateId') as template_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Template' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'SourceEntity') as source_entity, json_extract_path_text(Properties, 'Definition') as definition, json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateId') as template_id, - json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'VersionDescription') as version_description + json_extract_path_text(Properties, 'TemplateId') as template_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Template' AND data__Identifier = '|' AND region = 'us-east-1' - themes: - name: themes - id: awscc.quicksight.themes - x-cfn-schema-name: Theme - x-type: list + templates_list_only: + name: templates_list_only + id: awscc.quicksight.templates_list_only + x-cfn-schema-name: Template + x-cfn-type-name: AWS::QuickSight::Template x-identifiers: - - ThemeId - AwsAccountId + - TemplateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12146,31 +16133,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ThemeId') as theme_id, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.TemplateId') as template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ThemeId') as theme_id, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'TemplateId') as template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' AND region = 'us-east-1' - theme: - name: theme - id: awscc.quicksight.theme + themes: + name: themes + id: awscc.quicksight.themes x-cfn-schema-name: Theme - x-type: get + x-cfn-type-name: AWS::QuickSight::Theme x-identifiers: - ThemeId - AwsAccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Theme&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Theme" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Theme" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Theme" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/themes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/themes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/themes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12192,7 +16227,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -12213,14 +16248,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Theme' AND data__Identifier = '|' AND region = 'us-east-1' - topics: - name: topics - id: awscc.quicksight.topics - x-cfn-schema-name: Topic - x-type: list + themes_list_only: + name: themes_list_only + id: awscc.quicksight.themes_list_only + x-cfn-schema-name: Theme + x-cfn-type-name: AWS::QuickSight::Theme x-identifiers: + - ThemeId - AwsAccountId - - TopicId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12228,69 +16269,131 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.TopicId') as topic_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' + JSON_EXTRACT(Properties, '$.ThemeId') as theme_id, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'TopicId') as topic_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' + json_extract_path_text(Properties, 'ThemeId') as theme_id, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' AND region = 'us-east-1' - topic: - name: topic - id: awscc.quicksight.topic + topics: + name: topics + id: awscc.quicksight.topics x-cfn-schema-name: Topic - x-type: get + x-cfn-type-name: AWS::QuickSight::Topic x-identifiers: - AwsAccountId - TopicId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Topic&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Topic" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Topic" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::Topic" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topics/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/topics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.ConfigOptions') as config_options, + JSON_EXTRACT(Properties, '$.CustomInstructions') as custom_instructions, JSON_EXTRACT(Properties, '$.DataSets') as data_sets, JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.FolderArns') as folder_arns, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.TopicId') as topic_id, JSON_EXTRACT(Properties, '$.UserExperienceVersion') as user_experience_version FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Topic' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'ConfigOptions') as config_options, + json_extract_path_text(Properties, 'CustomInstructions') as custom_instructions, json_extract_path_text(Properties, 'DataSets') as data_sets, json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FolderArns') as folder_arns, json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'TopicId') as topic_id, json_extract_path_text(Properties, 'UserExperienceVersion') as user_experience_version FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Topic' AND data__Identifier = '|' AND region = 'us-east-1' - vpc_connections: - name: vpc_connections - id: awscc.quicksight.vpc_connections - x-cfn-schema-name: VPCConnection - x-type: list + topics_list_only: + name: topics_list_only + id: awscc.quicksight.topics_list_only + x-cfn-schema-name: Topic + x-cfn-type-name: AWS::QuickSight::Topic x-identifiers: - AwsAccountId - - VPCConnectionId + - TopicId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -12299,8 +16402,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' + JSON_EXTRACT(Properties, '$.TopicId') as topic_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -12308,64 +16411,761 @@ components: SELECT region, json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' + json_extract_path_text(Properties, 'TopicId') as topic_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' AND region = 'us-east-1' - vpc_connection: - name: vpc_connection - id: awscc.quicksight.vpc_connection + vpc_connections: + name: vpc_connections + id: awscc.quicksight.vpc_connections x-cfn-schema-name: VPCConnection - x-type: get + x-cfn-type-name: AWS::QuickSight::VPCConnection x-identifiers: - AwsAccountId - VPCConnectionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCConnection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::VPCConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::VPCConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::VPCConnection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AvailabilityStatus') as availability_status, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id, - JSON_EXTRACT(Properties, '$.VPCId') as vpc_id, - JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, - JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, JSON_EXTRACT(Properties, '$.DnsResolvers') as dns_resolvers, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.AvailabilityStatus') as availability_status, + JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.NetworkInterfaces') as network_interfaces, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id, + JSON_EXTRACT(Properties, '$.VPCId') as vpc_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AvailabilityStatus') as availability_status, json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id, - json_extract_path_text(Properties, 'VPCId') as vpc_id, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'CreatedTime') as created_time, json_extract_path_text(Properties, 'DnsResolvers') as dns_resolvers, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AvailabilityStatus') as availability_status, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id, + json_extract_path_text(Properties, 'VPCId') as vpc_id FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' AND data__Identifier = '|' AND region = 'us-east-1' + vpc_connections_list_only: + name: vpc_connections_list_only + id: awscc.quicksight.vpc_connections_list_only + x-cfn-schema-name: VPCConnection + x-cfn-type-name: AWS::QuickSight::VPCConnection + x-identifiers: + - AwsAccountId + - VPCConnectionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Analysis&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAnalysis + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAnalysisRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomPermissions&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomPermissions + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomPermissionsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Dashboard&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDashboard + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDashboardRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Folder&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFolder + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFolderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RefreshSchedule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRefreshSchedule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRefreshScheduleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Template&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Theme&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTheme + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateThemeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Topic&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTopic + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTopicRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VPCConnection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVPCConnection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVPCConnectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ram.yaml b/providers/src/awscc/v00.00.00000/services/ram.yaml index a5d2a426..a61429bb 100644 --- a/providers/src/awscc/v00.00.00000/services/ram.yaml +++ b/providers/src/awscc/v00.00.00000/services/ram.yaml @@ -1,27 +1,404 @@ openapi: 3.0.0 info: title: RAM - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: + description: A key-value pair to associate with a resource. type: object - additionalProperties: false properties: Key: type: string description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 1 - maxLength: 128 Value: type: string description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 0 - maxLength: 256 required: - Key - Value + additionalProperties: false Permission: type: object properties: @@ -55,7 +432,9 @@ components: - ResourceType - PolicyTemplate x-stackql-resource-name: permission - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::RAM::Permission + x-type-name: AWS::RAM::Permission + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name @@ -66,6 +445,19 @@ components: - Version - IsResourceTypeDefault - PermissionType + x-required-properties: + - Name + - ResourceType + - PolicyTemplate + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ram:TagResource + - ram:UntagResource x-required-permissions: create: - ram:CreatePermission @@ -88,14 +480,327 @@ components: list: - ram:ListPermissions - ram:ListPermissionVersions + ResourceShare: + type: object + properties: + AllowExternalPrincipals: + description: Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + type: boolean + Arn: + type: string + Name: + description: Specifies the name of the resource share. + type: string + PermissionArns: + description: Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + type: array + x-insertionOrder: false + items: + type: string + Principals: + description: |- + Specifies the principals to associate with the resource share. The possible values are: + + - An AWS account ID + + - An Amazon Resource Name (ARN) of an organization in AWS Organizations + + - An ARN of an organizational unit (OU) in AWS Organizations + + - An ARN of an IAM role + + - An ARN of an IAM user + type: array + x-insertionOrder: false + items: + type: string + ResourceArns: + description: Specifies a list of one or more ARNs of the resources to associate with the resource share. + type: array + x-insertionOrder: false + items: + type: string + Sources: + description: Specifies from which source accounts the service principal has access to the resources in this resource share. + type: array + x-insertionOrder: false + items: + type: string + Tags: + description: Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - Name + x-stackql-resource-name: resource_share + description: Resource type definition for AWS::RAM::ResourceShare + x-type-name: AWS::RAM::ResourceShare + x-stackql-primary-identifier: + - Arn + x-write-only-properties: + - PermissionArns + - Principals + - ResourceArns + - Sources + x-read-only-properties: + - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ram:TagResource + - ram:UntagResource + x-required-permissions: + create: + - ram:CreateResourceShare + - ram:TagResource + read: + - ram:GetResourceShares + update: + - ram:GetPermission + - ram:GetResourceShares + - ram:GetResourceShareAssociations + - ram:ListResourceSharePermissions + - ram:UpdateResourceShare + - ram:AssociateResourceSharePermission + - ram:AssociateResourceShare + - ram:DisassociateResourceShare + - ram:UntagResource + - ram:TagResource + delete: + - ram:DeleteResourceShare + - ram:GetResourceShares + list: + - ram:GetResourceShares + CreatePermissionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + Name: + description: The name of the permission. + type: string + Version: + description: Version of the permission. + type: string + IsResourceTypeDefault: + description: Set to true to use this as the default permission. + type: boolean + PermissionType: + type: string + ResourceType: + description: The resource type this permission can be used with. + type: string + PolicyTemplate: + description: Policy template for the permission. + type: object + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePermissionRequest + type: object + required: [] + CreateResourceShareRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllowExternalPrincipals: + description: Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + type: boolean + Arn: + type: string + Name: + description: Specifies the name of the resource share. + type: string + PermissionArns: + description: Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + type: array + x-insertionOrder: false + items: + type: string + Principals: + description: |- + Specifies the principals to associate with the resource share. The possible values are: + + - An AWS account ID + + - An Amazon Resource Name (ARN) of an organization in AWS Organizations + + - An ARN of an organizational unit (OU) in AWS Organizations + + - An ARN of an IAM role + + - An ARN of an IAM user + type: array + x-insertionOrder: false + items: + type: string + ResourceArns: + description: Specifies a list of one or more ARNs of the resources to associate with the resource share. + type: array + x-insertionOrder: false + items: + type: string + Sources: + description: Specifies from which source accounts the service principal has access to the resources in this resource share. + type: array + x-insertionOrder: false + items: + type: string + Tags: + description: Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateResourceShareRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: permissions: name: permissions id: awscc.ram.permissions x-cfn-schema-name: Permission - x-type: list + x-cfn-type-name: AWS::RAM::Permission + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RAM::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RAM::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RAM::Permission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.IsResourceTypeDefault') as is_resource_type_default, + JSON_EXTRACT(Properties, '$.PermissionType') as permission_type, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, + JSON_EXTRACT(Properties, '$.PolicyTemplate') as policy_template, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::Permission' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'IsResourceTypeDefault') as is_resource_type_default, + json_extract_path_text(Properties, 'PermissionType') as permission_type, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'PolicyTemplate') as policy_template, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::Permission' + AND data__Identifier = '' + AND region = 'us-east-1' + permissions_list_only: + name: permissions_list_only + id: awscc.ram.permissions_list_only + x-cfn-schema-name: Permission + x-cfn-type-name: AWS::RAM::Permission x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -114,46 +819,362 @@ components: json_extract_path_text(Properties, 'Arn') as arn FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::Permission' AND region = 'us-east-1' - permission: - name: permission - id: awscc.ram.permission - x-cfn-schema-name: Permission - x-type: get + resource_shares: + name: resource_shares + id: awscc.ram.resource_shares + x-cfn-schema-name: ResourceShare + x-cfn-type-name: AWS::RAM::ResourceShare x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceShare&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RAM::ResourceShare" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RAM::ResourceShare" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RAM::ResourceShare" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_shares/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_shares/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_shares/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.AllowExternalPrincipals') as allow_external_principals, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.IsResourceTypeDefault') as is_resource_type_default, - JSON_EXTRACT(Properties, '$.PermissionType') as permission_type, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, - JSON_EXTRACT(Properties, '$.PolicyTemplate') as policy_template, + JSON_EXTRACT(Properties, '$.PermissionArns') as permission_arns, + JSON_EXTRACT(Properties, '$.Principals') as principals, + JSON_EXTRACT(Properties, '$.ResourceArns') as resource_arns, + JSON_EXTRACT(Properties, '$.Sources') as sources, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::Permission' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::ResourceShare' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'AllowExternalPrincipals') as allow_external_principals, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'IsResourceTypeDefault') as is_resource_type_default, - json_extract_path_text(Properties, 'PermissionType') as permission_type, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'PolicyTemplate') as policy_template, + json_extract_path_text(Properties, 'PermissionArns') as permission_arns, + json_extract_path_text(Properties, 'Principals') as principals, + json_extract_path_text(Properties, 'ResourceArns') as resource_arns, + json_extract_path_text(Properties, 'Sources') as sources, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::Permission' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::ResourceShare' AND data__Identifier = '' AND region = 'us-east-1' + resource_shares_list_only: + name: resource_shares_list_only + id: awscc.ram.resource_shares_list_only + x-cfn-schema-name: ResourceShare + x-cfn-type-name: AWS::RAM::ResourceShare + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::ResourceShare' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::ResourceShare' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Permission&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePermission + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePermissionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceShare&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceShare + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceShareRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/rbin.yaml b/providers/src/awscc/v00.00.00000/services/rbin.yaml new file mode 100644 index 00000000..ffb9ff1d --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/rbin.yaml @@ -0,0 +1,981 @@ +openapi: 3.0.0 +info: + title: Rbin + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + description: Metadata of a retention rule, consisting of a key-value pair. + type: object + additionalProperties: false + properties: + Key: + description: A unique identifier for the tag. + type: string + minLength: 1 + maxLength: 128 + Value: + description: String which you can use to describe or define the tag. + type: string + minLength: 0 + maxLength: 256 + required: + - Key + - Value + ResourceTag: + description: The resource tag of the rule. + type: object + properties: + ResourceTagKey: + description: The tag key of the resource. + type: string + minLength: 1 + maxLength: 128 + ResourceTagValue: + description: The tag value of the resource + type: string + minLength: 0 + maxLength: 256 + additionalProperties: false + required: + - ResourceTagKey + - ResourceTagValue + RetentionPeriod: + description: The retention period of the rule. + type: object + properties: + RetentionPeriodValue: + description: The retention period value of the rule. + type: integer + minimum: 1 + maximum: 3650 + RetentionPeriodUnit: + description: The retention period unit of the rule + type: string + enum: + - DAYS + additionalProperties: false + required: + - RetentionPeriodValue + - RetentionPeriodUnit + UnlockDelay: + type: object + properties: + UnlockDelayValue: + description: The unlock delay period, measured in the unit specified for UnlockDelayUnit. + type: integer + minimum: 7 + maximum: 30 + UnlockDelayUnit: + description: The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days. + type: string + enum: + - DAYS + additionalProperties: false + Rule: + type: object + properties: + Arn: + description: Rule Arn is unique for each rule. + type: string + minLength: 0 + maxLength: 1011 + Identifier: + description: The unique ID of the retention rule. + type: string + pattern: '[0-9a-zA-Z]{11}' + Description: + description: The description of the retention rule. + type: string + maxLength: 255 + ResourceTags: + description: Information about the resource tags used to identify resources that are retained by the retention rule. + type: array + maxItems: 50 + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/ResourceTag' + ExcludeResourceTags: + description: Information about the exclude resource tags used to identify resources that are excluded by the retention rule. + type: array + maxItems: 5 + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/ResourceTag' + ResourceType: + description: The resource type retained by the retention rule. + type: string + enum: + - EBS_SNAPSHOT + - EC2_IMAGE + Tags: + description: Information about the tags assigned to the retention rule. + type: array + maxItems: 200 + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + RetentionPeriod: + description: Information about the retention period for which the retention rule is to retain resources. + $ref: '#/components/schemas/RetentionPeriod' + Status: + description: The state of the retention rule. Only retention rules that are in the available state retain resources. + type: string + pattern: pending|available + LockConfiguration: + description: Information about the retention rule lock configuration. + $ref: '#/components/schemas/UnlockDelay' + LockState: + description: The lock state for the retention rule. + type: string + pattern: locked|pending_unlock|unlocked + required: + - RetentionPeriod + - ResourceType + x-stackql-resource-name: rule + description: Resource Type definition for AWS::Rbin::Rule + x-type-name: AWS::Rbin::Rule + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - Identifier + x-create-only-properties: + - ResourceType + x-write-only-properties: + - LockConfiguration + - LockConfiguration/UnlockDelayValue + - LockConfiguration/UnlockDelayUnit + x-read-only-properties: + - Arn + - Identifier + - LockState + x-required-properties: + - RetentionPeriod + - ResourceType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rbin:TagResource + - rbin:UntagResource + - rbin:ListTagsForResource + x-required-permissions: + create: + - rbin:CreateRule + - rbin:GetRule + - rbin:LockRule + - rbin:TagResource + - iam:PassRole + read: + - rbin:GetRule + - rbin:ListTagsForResource + - iam:PassRole + update: + - rbin:GetRule + - rbin:UpdateRule + - rbin:LockRule + - rbin:UnlockRule + - rbin:TagResource + - rbin:UntagResource + - rbin:ListTagsForResource + - iam:PassRole + delete: + - rbin:GetRule + - rbin:DeleteRule + - iam:PassRole + list: + - rbin:ListRules + - rbin:ListTagsForResource + - iam:PassRole + CreateRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Rule Arn is unique for each rule. + type: string + minLength: 0 + maxLength: 1011 + Identifier: + description: The unique ID of the retention rule. + type: string + pattern: '[0-9a-zA-Z]{11}' + Description: + description: The description of the retention rule. + type: string + maxLength: 255 + ResourceTags: + description: Information about the resource tags used to identify resources that are retained by the retention rule. + type: array + maxItems: 50 + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/ResourceTag' + ExcludeResourceTags: + description: Information about the exclude resource tags used to identify resources that are excluded by the retention rule. + type: array + maxItems: 5 + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/ResourceTag' + ResourceType: + description: The resource type retained by the retention rule. + type: string + enum: + - EBS_SNAPSHOT + - EC2_IMAGE + Tags: + description: Information about the tags assigned to the retention rule. + type: array + maxItems: 200 + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + RetentionPeriod: + description: Information about the retention period for which the retention rule is to retain resources. + $ref: '#/components/schemas/RetentionPeriod' + Status: + description: The state of the retention rule. Only retention rules that are in the available state retain resources. + type: string + pattern: pending|available + LockConfiguration: + description: Information about the retention rule lock configuration. + $ref: '#/components/schemas/UnlockDelay' + LockState: + description: The lock state for the retention rule. + type: string + pattern: locked|pending_unlock|unlocked + x-stackQL-stringOnly: true + x-title: CreateRuleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + rules: + name: rules + id: awscc.rbin.rules + x-cfn-schema-name: Rule + x-cfn-type-name: AWS::Rbin::Rule + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rbin::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rbin::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rbin::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Identifier') as identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ResourceTags') as resource_tags, + JSON_EXTRACT(Properties, '$.ExcludeResourceTags') as exclude_resource_tags, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.RetentionPeriod') as retention_period, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.LockConfiguration') as lock_configuration, + JSON_EXTRACT(Properties, '$.LockState') as lock_state + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Rbin::Rule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Identifier') as identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags, + json_extract_path_text(Properties, 'ExcludeResourceTags') as exclude_resource_tags, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'RetentionPeriod') as retention_period, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'LockConfiguration') as lock_configuration, + json_extract_path_text(Properties, 'LockState') as lock_state + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Rbin::Rule' + AND data__Identifier = '' + AND region = 'us-east-1' + rules_list_only: + name: rules_list_only + id: awscc.rbin.rules_list_only + x-cfn-schema-name: Rule + x-cfn-type-name: AWS::Rbin::Rule + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rbin::Rule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rbin::Rule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/rds.yaml b/providers/src/awscc/v00.00.00000/services/rds.yaml index d973a4e6..1e102d0a 100644 --- a/providers/src/awscc/v00.00.00000/services/rds.yaml +++ b/providers/src/awscc/v00.00.00000/services/rds.yaml @@ -1,23 +1,405 @@ openapi: 3.0.0 info: title: RDS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: - description: A key-value pair to associate with a resource. + description: |- + Metadata assigned to an Amazon RDS resource consisting of a key-value pair. + For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. type: object additionalProperties: false properties: Key: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + description: 'A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can''t be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").' minLength: 1 maxLength: 128 Value: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + description: 'A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can''t be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', '':'', ''/'', ''='', ''+'', ''-'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").' minLength: 0 maxLength: 256 required: @@ -27,12 +409,12 @@ components: properties: DatabaseInstallationFilesS3BucketName: type: string - description: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + description: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. minLength: 3 maxLength: 63 DatabaseInstallationFilesS3Prefix: type: string - description: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + description: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. minLength: 1 maxLength: 255 Description: @@ -42,48 +424,72 @@ components: maxLength: 1000 Engine: type: string - description: The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + description: |- + The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` minLength: 1 maxLength: 35 EngineVersion: type: string - description: The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + description: |- + The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:*``^[a-z0-9_.-]{1,60$``} minLength: 1 maxLength: 60 KMSKeyId: type: string - description: The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + description: |- + The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. minLength: 1 maxLength: 2048 Manifest: type: string - description: The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + description: |- + The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + The following JSON fields are valid: + + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. minLength: 1 maxLength: 51000 DBEngineVersionArn: type: string - description: The ARN of the custom engine version. + description: '' + SourceCustomDbEngineVersionIdentifier: + type: string + description: The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. + UseAwsProvidedLatestImage: + type: boolean + description: Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. + ImageId: + type: string + description: A value that indicates the ID of the AMI. Status: type: string - description: The availability status to be assigned to the CEV. + description: A value that indicates the status of a custom engine version (CEV). default: available enum: - available - inactive - inactive-except-restore Tags: - description: An array of key-value pairs to apply to this resource. + description: A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - - DatabaseInstallationFilesS3BucketName - Engine - EngineVersion x-stackql-resource-name: customdb_engine_version - x-stackql-primaryIdentifier: + description: Creates a custom DB engine version (CEV). + x-type-name: AWS::RDS::CustomDBEngineVersion + x-stackql-primary-identifier: - Engine - EngineVersion x-create-only-properties: @@ -91,14 +497,39 @@ components: - EngineVersion - DatabaseInstallationFilesS3BucketName - DatabaseInstallationFilesS3Prefix + - ImageId - KMSKeyId - Manifest + - SourceCustomDbEngineVersionIdentifier + - UseAwsProvidedLatestImage + x-write-only-properties: + - Manifest + - SourceCustomDbEngineVersionIdentifier + - UseAwsProvidedLatestImage x-read-only-properties: - DBEngineVersionArn + x-required-properties: + - Engine + - EngineVersion + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: + - ec2:CopySnapshot + - ec2:DeleteSnapshot + - ec2:DescribeSnapshots - kms:CreateGrant + - kms:Decrypt - kms:DescribeKey + - kms:GenerateDataKey + - kms:ReEncrypt - mediaimport:CreateDatabaseBinarySnapshot - rds:AddTagsToResource - rds:CreateCustomDBEngineVersion @@ -149,15 +580,20 @@ components: additionalProperties: false properties: Address: - description: The reader endpoint for the DB cluster. + description: The host address of the reader endpoint. type: string + description: |- + The ``ReadEndpoint`` return value specifies the reader endpoint for the DB cluster. + The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. + If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. + For more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) in the *Amazon Aurora User Guide*. DBClusterRole: description: Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster. type: object additionalProperties: false properties: FeatureName: - description: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. + description: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*. type: string RoleArn: description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. @@ -165,53 +601,73 @@ components: required: - RoleArn ServerlessV2ScalingConfiguration: - description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + description: |- + The ``ServerlessV2ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*. + If you have an Aurora cluster, you must set this attribute before you add a DB instance that uses the ``db.serverless`` DB instance class. For more information, see [Clusters that use Aurora Serverless v2 must have a capacity range specified](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.capacity-range) in the *Amazon Aurora User Guide*. + This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the ``ScalingConfiguration`` property. + Valid for: Aurora Serverless v2 DB clusters type: object additionalProperties: false properties: MinCapacity: - description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. + description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. type: number MaxCapacity: - description: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. + description: |- + The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. + The maximum capacity must be higher than 0.5 ACUs. For more information, see [Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*. + Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ``ParameterApplyStatus`` value for the DB instance changes to ``pending-reboot``. You can update the parameter values by rebooting the DB instance after changing the capacity range. type: number + SecondsUntilAutoPause: + type: integer + description: |- + Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. + Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. ScalingConfiguration: - description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. + description: |- + The ``ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster. + For more information, see [Using Amazon Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*. + This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property. + Valid for: Aurora Serverless v1 DB clusters only type: object additionalProperties: false properties: AutoPause: - description: A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). + description: |- + Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in ``serverless`` DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). + If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. type: boolean MaxCapacity: description: |- - The maximum capacity for an Aurora DB cluster in serverless DB engine mode. - For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. - The maximum capacity must be greater than or equal to the minimum capacity. + The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode. + For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``. + For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``. + The maximum capacity must be greater than or equal to the minimum capacity. type: integer MinCapacity: description: |- - The minimum capacity for an Aurora DB cluster in serverless DB engine mode. - For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. - The minimum capacity must be less than or equal to the maximum capacity. + The minimum capacity for an Aurora DB cluster in ``serverless`` DB engine mode. + For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``. + For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``. + The minimum capacity must be less than or equal to the maximum capacity. type: integer SecondsBeforeTimeout: description: |- - The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. - The default is 300. + The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. + Specify a value between 60 and 600 seconds. type: integer SecondsUntilAutoPause: - description: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + description: |- + The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused. + Specify a value between 300 and 86,400 seconds. type: integer TimeoutAction: description: |- - The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. - ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. - RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. - - For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. + The action to take when the timeout is reached, either ``ForceApplyCapacityChange`` or ``RollbackCapacityChange``. + ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible. + ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period. + If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. + For more information, see [Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*. type: string MasterUserSecret: type: object @@ -219,7 +675,7 @@ components: properties: SecretArn: type: string - description: The Amazon Resource Name (ARN) of the secret. + description: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see [Return values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values). KmsKeyId: type: string description: The AWS KMS key identifier that is used to encrypt the secret. @@ -231,227 +687,555 @@ components: properties: Endpoint: $ref: '#/components/schemas/Endpoint' + description: '' ReadEndpoint: $ref: '#/components/schemas/ReadEndpoint' + description: '' AllocatedStorage: - description: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. + description: |- + The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. + Valid for Cluster Type: Multi-AZ DB clusters only + This setting is required to create a Multi-AZ DB cluster. type: integer AssociatedRoles: - description: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + description: |- + Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: array uniqueItems: true items: $ref: '#/components/schemas/DBClusterRole' AvailabilityZones: - description: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. + description: |- + A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters only type: array uniqueItems: true items: type: string AutoMinorVersionUpgrade: - description: A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. + description: |- + Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster. + For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades). type: boolean BacktrackWindow: - description: The target backtrack window, in seconds. To disable backtracking, set this value to 0. - default: 0 + description: |- + The target backtrack window, in seconds. To disable backtracking, set this value to ``0``. + Valid for Cluster Type: Aurora MySQL DB clusters only + Default: ``0`` + Constraints: + + If specified, this value must be set to a number from 0 to 259,200 (72 hours). minimum: 0 type: integer BackupRetentionPeriod: - description: The number of days for which automated backups are retained. + description: |- + The number of days for which automated backups are retained. + Default: 1 + Constraints: + + Must be a value from 1 to 35 + + Valid for: Aurora DB clusters and Multi-AZ DB clusters default: 1 minimum: 1 type: integer + ClusterScalabilityType: + type: string + description: |- + Specifies the scalability mode of the Aurora DB cluster. When set to ``limitless``, the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to ``standard`` (the default), the cluster uses normal DB instance creation. + *Important:* Automated backup retention isn't supported with Aurora Limitless Database clusters. If you set this property to ``limitless``, you cannot set ``DeleteAutomatedBackups`` to ``false``. To create a backup, use manual snapshots instead. CopyTagsToSnapshot: - description: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. + description: |- + A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: boolean + DatabaseInsightsMode: + description: |- + The mode of Database Insights to enable for the DB cluster. + If you set this value to ``advanced``, you must also set the ``PerformanceInsightsEnabled`` parameter to ``true`` and the ``PerformanceInsightsRetentionPeriod`` parameter to 465. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + type: string DatabaseName: - description: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. + description: |- + The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string DBClusterArn: type: string - description: The Amazon Resource Name (ARN) for the DB cluster. + description: '' DBClusterInstanceClass: - description: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. + description: |- + The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ``db.m6gd.xlarge``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. + For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*. + This setting is required to create a Multi-AZ DB cluster. + Valid for Cluster Type: Multi-AZ DB clusters only type: string DBClusterResourceId: - description: The AWS Region-unique, immutable identifier for the DB cluster. + description: '' type: string DBInstanceParameterGroupName: - description: The name of the DB parameter group to apply to all instances of the DB cluster. + description: |- + The name of the DB parameter group to apply to all instances of the DB cluster. + When you apply a parameter group using the ``DBInstanceParameterGroupName`` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window. + Valid for Cluster Type: Aurora DB clusters only + Default: The existing name setting + Constraints: + + The DB parameter group must be in the same DB parameter group family as this DB cluster. + + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only. type: string DBSystemId: description: Reserved for future use. type: string GlobalClusterIdentifier: description: |- - If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. - - If you aren't configuring a global database cluster, don't specify this property. + If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource. + If you aren't configuring a global database cluster, don't specify this property. + To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property. + For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters only type: string pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ minLength: 0 maxLength: 63 DBClusterIdentifier: - description: The DB cluster identifier. This parameter is stored as a lowercase string. + description: |- + The DB cluster identifier. This parameter is stored as a lowercase string. + Constraints: + + Must contain from 1 to 63 letters, numbers, or hyphens. + + First character must be a letter. + + Can't end with a hyphen or contain two consecutive hyphens. + + Example: ``my-cluster1`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ minLength: 1 maxLength: 63 DBClusterParameterGroupName: - description: The name of the DB cluster parameter group to associate with this DB cluster. + description: |- + The name of the DB cluster parameter group to associate with this DB cluster. + If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. + If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started. + To list all of the available DB cluster parameter group names, use the following command: + ``aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string - default: default.aurora5.6 DBSubnetGroupName: - description: A DB subnet group that you want to associate with this DB cluster. + description: |- + A DB subnet group that you want to associate with this DB cluster. + If you are restoring a DB cluster to a point in time with ``RestoreType`` set to ``copy-on-write``, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string + DeleteAutomatedBackups: + type: boolean + description: Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule. DeletionProtection: - description: A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. + description: |- + A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: boolean Domain: - description: The Active Directory directory ID to create the DB cluster in. + description: |- + Indicates the directory ID of the Active Directory to create the DB cluster. + For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. + For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters only type: string DomainIAMRoleName: - description: Specify the name of the IAM role to be used when making API calls to the Directory Service. + description: |- + Specifies the name of the IAM role to use when making API calls to the Directory Service. + Valid for: Aurora DB clusters only type: string EnableCloudwatchLogsExports: - description: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + description: |- + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*. + *Aurora MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Aurora PostgreSQL* + Valid values: ``postgresql`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: array uniqueItems: true items: type: string EnableGlobalWriteForwarding: - description: Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. + description: |- + Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. + You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. + Valid for Cluster Type: Aurora DB clusters only type: boolean EnableHttpEndpoint: - description: A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. + description: |- + Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. + When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. + For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*. + Valid for Cluster Type: Aurora DB clusters only type: boolean EnableIAMDatabaseAuthentication: - description: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + description: |- + A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.* + Valid for: Aurora DB clusters only + type: boolean + EnableLocalWriteForwarding: + description: |- + Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. + Valid for: Aurora DB clusters only type: boolean Engine: - description: 'The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql' + description: |- + The name of the database engine to be used for this DB cluster. + Valid Values: + + ``aurora-mysql`` + + ``aurora-postgresql`` + + ``mysql`` + + ``postgres`` + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + EngineLifecycleSupport: + description: |- + The life cycle type for this DB cluster. + By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. + You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: + + Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* + + Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* + + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` + Default: ``open-source-rds-extended-support`` type: string EngineMode: - description: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. + description: |- + The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``. + The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode. + For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*: + + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) + + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) + + Valid for Cluster Type: Aurora DB clusters only type: string EngineVersion: - description: The version number of the database engine to use. + description: |- + The version number of the database engine to use. + To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command: + ``aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`` + You can supply either ``5.7`` or ``8.0`` to use the default engine version for Aurora MySQL version 2 or version 3, respectively. + To list all of the available engine versions for Aurora PostgreSQL, use the following command: + ``aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`` + To list all of the available engine versions for RDS for MySQL, use the following command: + ``aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"`` + To list all of the available engine versions for RDS for PostgreSQL, use the following command: + ``aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"`` + *Aurora MySQL* + For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*. + *Aurora PostgreSQL* + For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*. + *MySQL* + For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*. + *PostgreSQL* + For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string ManageMasterUserPassword: - description: A value that indicates whether to manage the master user password with AWS Secrets Manager. + description: |- + Specifies whether to manage the master user password with AWS Secrets Manager. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Constraints: + + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. type: boolean Iops: - description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. + description: |- + The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. + For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. + This setting is required to create a Multi-AZ DB cluster. + Valid for Cluster Type: Multi-AZ DB clusters only + Constraints: + + Must be a multiple between .5 and 50 of the storage amount for the DB cluster. type: integer KmsKeyId: - description: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. + description: |- + The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the ``StorageEncrypted`` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the ``StorageEncrypted`` property to ``true``. + If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used. + If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set ``KmsKeyId`` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string MasterUsername: - description: The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. + description: |- + The name of the master user for the DB cluster. + If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string pattern: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ minLength: 1 MasterUserPassword: - description: The master password for the DB instance. + description: |- + The master password for the DB instance. + If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string MasterUserSecret: $ref: '#/components/schemas/MasterUserSecret' - description: Contains the secret managed by RDS in AWS Secrets Manager for the master user password. + description: |- + The secret managed by RDS in AWS Secrets Manager for the master user password. + When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the ``SecretArn`` property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* MonitoringInterval: - description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. + description: |- + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ``0``. + If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` + Default: ``0`` type: integer - default: 0 MonitoringRoleArn: - description: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. + description: |- + The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. + If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters type: string NetworkType: - description: The network type of the DB cluster. + description: |- + The network type of the DB cluster. + Valid values: + + ``IPV4`` + + ``DUAL`` + + The network type is determined by the ``DBSubnetGroup`` specified for the DB cluster. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). + For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.* + Valid for: Aurora DB clusters only type: string PerformanceInsightsEnabled: - description: A value that indicates whether to turn on Performance Insights for the DB cluster. + description: |- + Specifies whether to turn on Performance Insights for the DB cluster. + For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters type: boolean PerformanceInsightsKmsKeyId: - description: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. + description: |- + The AWS KMS key identifier for encryption of Performance Insights data. + The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + If you don't specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS-account. Your AWS-account has a different default KMS key for each AWS-Region. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters type: string PerformanceInsightsRetentionPeriod: - description: The amount of time, in days, to retain Performance Insights data. + description: |- + The number of days to retain Performance Insights data. When creating a DB cluster without enabling Performance Insights, you can't specify the parameter ``PerformanceInsightsRetentionPeriod``. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: + + ``7`` + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + ``731`` + + Default: ``7`` days + If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error. type: integer Port: - description: 'The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.' + description: |- + The port number on which the DB instances in the DB cluster accept connections. + Default: + + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL) + + When ``EngineMode`` is ``serverless``: + + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` + + ``5432`` when ``Engine`` is ``aurora-postgresql`` + + + The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: integer PreferredBackupWindow: - description: The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. + description: |- + The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.* + Constraints: + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. + + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string PreferredMaintenanceWindow: - description: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. + description: |- + The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Format: ``ddd:hh24:mi-ddd:hh24:mi`` + The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Maintaining an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.* + Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + Constraints: Minimum 30-minute window. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string PubliclyAccessible: - description: A value that indicates whether the DB cluster is publicly accessible. + description: |- + Specifies whether the DB cluster is publicly accessible. + When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. + When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. + Valid for Cluster Type: Multi-AZ DB clusters only + Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. + If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. + + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. + + If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. + + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. type: boolean ReplicationSourceIdentifier: - description: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + description: |- + The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. + Valid for: Aurora DB clusters only type: string RestoreToTime: - description: 'The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z' + description: |- + The date and time to restore the DB cluster to. + Valid Values: Value must be a time in Universal Coordinated Time (UTC) format + Constraints: + + Must be before the latest restorable time for the DB instance + + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided + + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled + + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` + + This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property. + Example: ``2015-03-07T23:45:00Z`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string RestoreType: description: |- The type of restore to be performed. You can specify one of the following values: - full-copy - The new DB cluster is restored as a full copy of the source DB cluster. - copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. + + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster. + + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster. + + If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string - default: full-copy ServerlessV2ScalingConfiguration: - description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + description: |- + The scaling configuration of an Aurora Serverless V2 DB cluster. + This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property. + Valid for: Aurora Serverless v2 DB clusters only $ref: '#/components/schemas/ServerlessV2ScalingConfiguration' ScalingConfiguration: - description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. + description: |- + The scaling configuration of an Aurora Serverless v1 DB cluster. + This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property. + Valid for: Aurora Serverless v1 DB clusters only $ref: '#/components/schemas/ScalingConfiguration' SnapshotIdentifier: - description: >- + description: |- The identifier for the DB snapshot or DB cluster snapshot to restore from. - - You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. - - After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different - from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. + You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. + After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted. + If you specify the ``SnapshotIdentifier`` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties: + + ``GlobalClusterIdentifier`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``ReplicationSourceIdentifier`` + + ``RestoreType`` + + ``SourceDBClusterIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an encrypted snapshot) + + ``UseLatestRestorableTime`` + + Constraints: + + Must match the identifier of an existing Snapshot. + + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: string SourceDBClusterIdentifier: - description: The identifier of the source DB cluster from which to restore. + description: |- + When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore. + Constraints: + + Must match the identifier of an existing DBCluster. + + Cannot be specified if ``SourceDbClusterResourceId`` is specified. You must specify either ``SourceDBClusterIdentifier`` or ``SourceDbClusterResourceId``, but not both. + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + SourceDbClusterResourceId: + description: The resource ID of the source DB cluster from which to restore. type: string SourceRegion: - description: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. + description: |- + The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``. + Valid for: Aurora DB clusters only type: string StorageEncrypted: description: |- - Indicates whether the DB instance is encrypted. - If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. + Indicates whether the DB cluster is encrypted. + If you specify the ``KmsKeyId`` property, then you must enable encryption. + If you specify the ``SourceDBClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used. + If you specify the ``SnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. + If you specify the ``SnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to ``false``. + If you specify both the ``StorageEncrypted`` and ``SnapshotIdentifier`` properties without specifying the ``KmsKeyId`` property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: boolean + StorageThroughput: + description: '' + type: integer StorageType: - description: Specifies the storage type to be associated with the DB cluster. + description: |- + The storage type to associate with the DB cluster. + For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings). + This setting is required to create a Multi-AZ DB cluster. + When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: + + Aurora DB clusters - ``aurora | aurora-iopt1`` + + Multi-AZ DB clusters - ``io1 | io2 | gp3`` + + Default: + + Aurora DB clusters - ``aurora`` + + Multi-AZ DB clusters - ``io1`` + + When you create an Aurora DB cluster with the storage type set to ``aurora-iopt1``, the storage type is returned in the response. The storage type isn't returned when you set it to ``aurora``. type: string Tags: type: array maxItems: 50 uniqueItems: true x-insertionOrder: false - description: An array of key-value pairs to apply to this resource. + description: |- + Tags to assign to the DB cluster. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters items: $ref: '#/components/schemas/Tag' UseLatestRestorableTime: - description: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. + description: |- + A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. + Valid for: Aurora DB clusters and Multi-AZ DB clusters type: boolean VpcSecurityGroupIds: - description: A list of EC2 VPC security groups to associate with this DB cluster. + description: |- + A list of EC2 VPC security groups to associate with this DB cluster. + If you plan to update the resource, don't specify VPC security groups in a shared VPC. + Valid for: Aurora DB clusters and Multi-AZ DB clusters uniqueItems: true items: type: string type: array x-stackql-resource-name: db_cluster - x-stackql-primaryIdentifier: + description: |- + The ``AWS::RDS::DBCluster`` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster. + For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*. + For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*. + You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported. + *Updating DB clusters* + When properties labeled "*Update requires:*[Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster. + We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure: + 1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance. + 1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html). + 1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use. + After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted. + 1. Update the stack. + + Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: ``PreferredBackupWindow``, ``PreferredMaintenanceWindow``, and ``Port``. This limitation doesn't apply to provisioned DB clusters. + For more information about updating other properties of this resource, see ``ModifyDBCluster``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html). + *Deleting DB clusters* + The default ``DeletionPolicy`` for ``AWS::RDS::DBCluster`` resources is ``Snapshot``. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html). + x-type-name: AWS::RDS::DBCluster + x-stackql-primary-identifier: - DBClusterIdentifier x-create-only-properties: - AvailabilityZones + - ClusterScalabilityType - DBClusterIdentifier - DBSubnetGroupName - DBSystemId @@ -463,18 +1247,45 @@ components: - RestoreType - SnapshotIdentifier - SourceDBClusterIdentifier + - SourceDbClusterResourceId - SourceRegion - StorageEncrypted - UseLatestRestorableTime + x-conditional-create-only-properties: + - Engine + - GlobalClusterIdentifier + - MasterUsername + x-write-only-properties: + - ClusterScalabilityType + - DBInstanceParameterGroupName + - DeleteAutomatedBackups + - MasterUserPassword + - RestoreToTime + - RestoreType + - SnapshotIdentifier + - SourceDBClusterIdentifier + - SourceDbClusterResourceId + - SourceRegion + - UseLatestRestorableTime x-read-only-properties: - DBClusterArn - DBClusterResourceId - Endpoint - Endpoint/Address - Endpoint/Port - - ReadEndpoint/Port + - ReadEndpoint - ReadEndpoint/Address - MasterUserSecret/SecretArn + - StorageThroughput + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -484,11 +1295,15 @@ components: - rds:CreateDBCluster - rds:CreateDBInstance - rds:DescribeDBClusters + - rds:DescribeDBClusterAutomatedBackups + - rds:DescribeDBClusterSnapshots + - rds:DescribeDBSnapshots - rds:DescribeEvents - rds:EnableHttpEndpoint - rds:ModifyDBCluster - rds:RestoreDBClusterFromSnapshot - rds:RestoreDBClusterToPointInTime + - rds:DescribeDBClusterSnapshots - secretsmanager:CreateSecret - secretsmanager:TagResource read: @@ -512,6 +1327,7 @@ components: - secretsmanager:CreateSecret - secretsmanager:TagResource delete: + - rds:AddTagsToResource - rds:CreateDBClusterSnapshot - rds:DeleteDBCluster - rds:DeleteDBInstance @@ -524,19 +1340,44 @@ components: type: object properties: Description: - description: A friendly description for this DB cluster parameter group. + description: The description for the DB cluster parameter group. type: string Family: - description: The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. + description: |- + The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. + *Aurora MySQL* + Example: ``aurora-mysql5.7``, ``aurora-mysql8.0`` + *Aurora PostgreSQL* + Example: ``aurora-postgresql14`` + *RDS for MySQL* + Example: ``mysql8.0`` + *RDS for PostgreSQL* + Example: ``postgres13`` + To list all of the available parameter group families for a DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` + For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql`` + The output contains duplicates. + The following are the valid DB engine values: + + ``aurora-mysql`` + + ``aurora-postgresql`` + + ``mysql`` + + ``postgres`` type: string Parameters: - description: An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. + description: Provides a list of parameters for the DB cluster parameter group. type: object DBClusterParameterGroupName: type: string pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$ + description: |- + The name of the DB cluster parameter group. + Constraints: + + Must not match the name of an existing DB cluster parameter group. + + This value is stored as a lowercase string. Tags: - description: The list of tags for the cluster parameter group. + description: Tags to assign to the DB cluster parameter group. type: array maxItems: 50 x-insertionOrder: false @@ -547,12 +1388,31 @@ components: - Family - Parameters x-stackql-resource-name: db_cluster_parameter_group - x-stackql-primaryIdentifier: + description: |- + The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group. + For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. + If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. + If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started. + x-type-name: AWS::RDS::DBClusterParameterGroup + x-stackql-primary-identifier: - DBClusterParameterGroupName x-create-only-properties: - DBClusterParameterGroupName - Description - Family + x-required-properties: + - Description + - Family + - Parameters + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -568,7 +1428,6 @@ components: read: - rds:DescribeDBClusterParameterGroups - rds:DescribeDBClusterParameters - - rds:DescribeEngineDefaultClusterParameters - rds:ListTagsForResource update: - rds:AddTagsToResource @@ -596,7 +1455,7 @@ components: format: date-time description: The expiration date of the DB instance’s server certificate. description: |- - Returns the details of the DB instance’s server certificate. + The details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. DBInstanceRole: type: object @@ -612,6 +1471,23 @@ components: - FeatureName - RoleArn description: Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance. + DBInstanceStatusInfo: + type: object + additionalProperties: false + properties: + Message: + type: string + description: Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank. + Normal: + type: boolean + description: Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). + Status: + type: string + description: The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated. + StatusType: + type: string + description: This value is currently "read replication." + description: Provides a list of status information for a DB instance. ProcessorFeature: type: object additionalProperties: false @@ -624,8 +1500,8 @@ components: description: The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``. Value: type: string - description: The value of a processor feature name. - description: The ``ProcessorFeature`` property type specifies the processor features of a DB instance class status. + description: The value of a processor feature. + description: The ``ProcessorFeature`` property type specifies the processor features of a DB instance class. DBInstance: type: object properties: @@ -638,15 +1514,49 @@ components: Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* Constraints to the amount of storage for each storage type are the following: - + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. - + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. - + + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. + *MySQL* Constraints to the amount of storage for each storage type are the following: - + General Purpose (SSD) storage (gp2): Must be an integer fro - pattern: ^[0-9]*$ - AllowMajorVersionUpgrade: - type: boolean + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *MariaDB* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *PostgreSQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *Oracle* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 10 to 3072. + + *SQL Server* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Provisioned IOPS storage (io1): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Magnetic storage (standard): + + Enterprise and Standard editions: Must be an integer from 20 to 1024. + + Web and Express editions: Must be an integer from 20 to 1024. + pattern: ^[0-9]*$ + AllowMajorVersionUpgrade: + type: boolean description: |- A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. @@ -663,7 +1573,19 @@ components: description: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. AutomaticBackupReplicationRegion: type: string - description: The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. + description: The AWS-Region associated with the automated backup. + AutomaticBackupReplicationKmsKeyId: + type: string + description: The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``. + AutomaticBackupReplicationRetentionPeriod: + type: integer + minimum: 1 + description: |- + The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the ``AutomaticBackupReplicationRegion`` parameter. + If not specified, this parameter defaults to the value of the ``BackupRetentionPeriod`` parameter. The maximum allowed value is 35. + AutomaticRestartTime: + type: string + description: '' AvailabilityZone: type: string description: |- @@ -678,23 +1600,33 @@ components: BackupRetentionPeriod: type: integer minimum: 0 - default: 1 description: |- The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. - *Amazon Aurora* + *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas + BackupTarget: + type: string + description: |- + The location for storing automated backups and manual snapshots. + Valid Values: + + ``local`` (Dedicated Local Zone) + + ``outposts`` (AWS Outposts) + + ``region`` (AWS-Region) + + Default: ``region`` + For more information, see [Working with Amazon RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*. CACertificateIdentifier: type: string description: |- The identifier of the CA certificate for this DB instance. - Specifying or updating this property triggers a reboot. For more information about CA certificate identifiers for RDS DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide*. For more information about CA certificate identifiers for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. + For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. CertificateDetails: $ref: '#/components/schemas/CertificateDetails' - description: The details of the DB instance's server certificate. + description: '' CertificateRotationRestart: type: boolean description: |- @@ -702,8 +1634,10 @@ components: By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: - + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* - + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Gui + + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. + + This setting doesn't apply to RDS Custom DB instances. CharacterSetName: type: string description: |- @@ -726,9 +1660,16 @@ components: + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. + DatabaseInsightsMode: + description: |- + The mode of Database Insights to enable for the DB instance. + Aurora DB instances inherit this value from the DB cluster, so you can't change this value. + type: string DBClusterIdentifier: type: string - description: The identifier of the DB cluster that the instance will belong to. + description: |- + The identifier of the DB cluster that this DB instance will belong to. + This setting doesn't apply to RDS Custom DB instances. DBClusterSnapshotIdentifier: type: string description: |- @@ -745,9 +1686,9 @@ components: description: '' DBInstanceClass: type: string - description: |- - The compute and memory capacity of the DB instance, for example, ``db.m4.large``. Not all DB instance classes are available in all AWS Regions, or for all database engines. - For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/). + description: >- + The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance + classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. DBInstanceIdentifier: type: string pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ @@ -757,6 +1698,9 @@ components: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + DBInstanceStatus: + type: string + description: '' DbiResourceId: type: string description: '' @@ -770,10 +1714,10 @@ components: *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: - + Must contain 1 to 64 letters or numbers. - + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - + Can't be a word reserved by the specified database engine. - + + Must contain 1 to 64 letters or numbers. + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Can't be a word reserved by the specified database engine. + *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: @@ -781,13 +1725,32 @@ components: + Can't be a word reserved by the specified database engine *MariaDB* - The name of the database to create when the DB instance is + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *PostgreSQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. + Constraints: + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Must contain 1 to 63 characters. + + Can't be a word reserved by the specified database engine + + *Oracle* + The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. + Default: ``ORCL`` + Constraints: + + Can't be longer than 8 characters + + *SQL Server* + Not applicable. Must be null. DBParameterGroupName: type: string description: |- The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. To list all of the available DB parameter group names, use the following command: - ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` + ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. DBSecurityGroups: @@ -799,35 +1762,57 @@ components: A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - + ``AllocatedStorage`` - + ``AutoMinorVersionUpgrade`` - + ``AvailabilityZone`` - + ``BackupRetentionPeriod`` - + ``CharacterSetName`` - + ``DBInstanceClass`` - + ``DBName`` - + ``DBParameterGroupName`` - + ``DBSecurityGroups`` - + ``DBSubnetGroupName`` - + ``Engine`` - + ``EngineVersion`` - + ``Iops`` - + ``LicenseModel`` - + + + ``AllocatedStorage`` + + ``AutoMinorVersionUpgrade`` + + ``AvailabilityZone`` + + ``BackupRetentionPeriod`` + + ``CharacterSetName`` + + ``DBInstanceClass`` + + ``DBName`` + + ``DBParameterGroupName`` + + ``DBSecurityGroups`` + + ``DBSubnetGroupName`` + + ``Engine`` + + ``EngineVersion`` + + ``Iops`` + + ``LicenseModel`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``MultiAZ`` + + ``OptionGroupName`` + + ``PreferredBackupWindow`` + + ``PreferredMaintenanceWindow`` + + All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. DBSnapshotIdentifier: type: string description: |- The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. - Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazo + Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime``. For information about the properties that you can specify, see the [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) action in the *Amazon RDS API Reference*. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + + ``CharacterSetName`` + + ``DBClusterIdentifier`` + + ``DBName`` + + ``KmsKeyId`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``PromotionTier`` + + ``SourceDBInstanceIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an unencrypted snapshot) + + ``Timezone`` + + *Amazon Aurora* + Not applicable. Snapshot restore is managed by the DB cluster. DBSubnetGroupName: type: string description: |- A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. - If there's no DB subnet group, then the DB instance isn't a VPC DB instance. - For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* - Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. + If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a ``DBSubnetGroupName``, the DB instance fails to launch. + For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. DBSystemId: type: string description: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. @@ -838,14 +1823,13 @@ components: type: boolean description: |- A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. - *Amazon Aurora* + *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. DeletionProtection: type: boolean description: |- - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). - *Amazon Aurora* - Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. + Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. Domain: type: string description: |- @@ -899,22 +1883,22 @@ components: *Amazon Aurora* Not applicable. CloudWatch Logs exports are managed by the DB cluster. *Db2* - Valid values: ``diag.log``, ``notify.log`` + Valid values: ``diag.log``, ``notify.log`` *MariaDB* - Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Microsoft SQL Server* - Valid values: ``agent``, ``error`` - *MySQL* - Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + Valid values: ``agent``, ``error`` + *MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Oracle* - Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` + Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` *PostgreSQL* Valid values: ``postgresql``, ``upgrade`` EnableIAMDatabaseAuthentication: type: boolean description: |- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* + This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. EnablePerformanceInsights: @@ -924,36 +1908,43 @@ components: This setting doesn't apply to RDS Custom DB instances. Endpoint: $ref: '#/components/schemas/Endpoint' - description: |- - The connection endpoint for the DB instance. - The endpoint might not be shown for instances with the status of ``creating``. + description: '' Engine: type: string description: |- - The name of the database engine that you want to use for this DB instance. - Not every database engine is available in every AWS Region. - When you are creating a DB instance, the ``Engine`` property is required. + The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. + This property is required when creating a DB instance. + You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) - + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) - + ``db2-ae`` - + ``db2-se`` - + ``mariadb`` - + ``mysql`` - + ``oracle-ee`` - + ``oracle-ee-cdb`` - + ``oracle-se2`` - + ``oracle-se2-cdb`` - + ``postgres`` - + ``sqlserver-ee`` - + ``sqlserver-se`` - + ``sqlserver-ex`` - + ``sqlserver-web`` + + ``db2-ae`` + + ``db2-se`` + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` + EngineLifecycleSupport: + type: string + description: |- + The life cycle type for this DB instance. + By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. + This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. + You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*. + Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` + Default: ``open-source-rds-extended-support`` EngineVersion: type: string description: |- @@ -964,17 +1955,27 @@ components: Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* - *MariaDB* + *MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* - *Microsoft SQL Server* - See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu + *Microsoft SQL Server* + See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* + *MySQL* + See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Oracle* + See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* + *PostgreSQL* + See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.* ManageMasterUserPassword: type: boolean description: |- Specifies whether to manage the master user password with AWS Secrets Manager. - For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. + InstanceCreateTime: + type: string + description: '' + format: date-time Iops: type: integer description: |- @@ -982,15 +1983,26 @@ components: If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. Constraints: - + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. - + For RDS for SQL Server - Must be a multip + + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. + IsStorageConfigUpgradeAvailable: + type: boolean + description: '' KmsKeyId: type: string description: |- The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. - If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. + If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID. + If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. - If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us + If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot. + If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The KMS key identifier is managed by the DB cluster. + LatestRestorableTime: + type: string + description: '' + format: date-time LicenseModel: type: string description: |- @@ -1006,6 +2018,9 @@ components: + RDS for PostgreSQL - ``postgresql-license`` If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. + ListenerEndpoint: + $ref: '#/components/schemas/Endpoint' + description: '' MasterUsername: type: string pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,127}$ @@ -1023,17 +2038,32 @@ components: *RDS for MariaDB* Constraints: - + Must be 1 to 16 letters or numbers. + + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. *RDS for Microsoft SQL Server* Constraints: - + Must be 1 to 128 letters or numbers. + + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MySQL* - Constrain + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for Oracle* + Constraints: + + Must be 1 to 30 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for PostgreSQL* + Constraints: + + Must be 1 to 63 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. minLength: 1 maxLength: 128 MasterUserPassword: @@ -1069,12 +2099,12 @@ components: + RDS Custom MonitoringInterval: type: integer - default: 0 description: |- - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. - If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. - This setting doesn't apply to RDS Custom. - Valid Values: ``0, 1, 5, 10, 15, 30, 60`` + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify ``0``. + If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0``. + This setting doesn't apply to RDS Custom DB instances. + Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` + Default: ``0`` MonitoringRoleArn: type: string description: |- @@ -1084,10 +2114,8 @@ components: MultiAZ: type: boolean description: |- - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. - For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* - Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. + Specifies whether the DB instance is a Multi-AZ deployment. You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment. + This setting doesn't apply to Amazon Aurora because the DB instance Availability Zones (AZs) are managed by the DB cluster. NcharCharacterSetName: type: string description: |- @@ -1108,6 +2136,9 @@ components: description: |- Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. + PercentProgress: + type: string + description: '' PerformanceInsightsKMSKeyId: type: string description: |- @@ -1118,11 +2149,11 @@ components: PerformanceInsightsRetentionPeriod: type: integer description: |- - The number of days to retain Performance Insights data. + The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter ``PerformanceInsightsRetentionPeriod``. This setting doesn't apply to RDS Custom DB instances. Valid Values: + ``7`` - + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + ``731`` Default: ``7`` days @@ -1131,20 +2162,28 @@ components: type: string description: |- The port number on which the database accepts connections. - *Amazon Aurora* - Not applicable. The port number is managed by the DB cluster. - *Db2* - Default value: ``50000`` + This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. + Valid Values: ``1150-65535`` + Default: + + RDS for Db2 - ``50000`` + + RDS for MariaDB - ``3306`` + + RDS for Microsoft SQL Server - ``1433`` + + RDS for MySQL - ``3306`` + + RDS for Oracle - ``1521`` + + RDS for PostgreSQL - ``5432`` + + Constraints: + + For RDS for Microsoft SQL Server, the value can't be ``1234``, ``1434``, ``3260``, ``3343``, ``3389``, ``47001``, or ``49152-49156``. pattern: ^\d*$ PreferredBackupWindow: type: string description: |- - The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* Constraints: - + Must be in the format ``hh24:mi-hh24:mi``. - + Must be in Universal Coordinated Time (UTC). - + Must not conflict with the preferred maintenance window. - + Must be at least 30 minutes. + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster. @@ -1152,8 +2191,8 @@ components: type: string description: |- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). - Format: ``ddd:hh24:mi-ddd:hh24:mi`` - The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* + Format: ``ddd:hh24:mi-ddd:hh24:mi`` + The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Maintaining a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. ProcessorFeatures: @@ -1166,17 +2205,26 @@ components: PromotionTier: type: integer minimum: 0 - default: 1 description: |- The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. - Default: ``1`` + Default: ``1`` Valid Values: ``0 - 15`` PubliclyAccessible: type: boolean description: |- Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. + ReadReplicaDBClusterIdentifiers: + type: array + items: + type: string + description: '' + ReadReplicaDBInstanceIdentifiers: + type: array + items: + type: string + description: '' ReplicaMode: description: |- The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. @@ -1186,7 +2234,7 @@ components: type: string RestoreTime: description: |- - The date and time to restore from. + The date and time to restore from. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. @@ -1195,6 +2243,12 @@ components: Example: ``2009-09-07T23:45:00Z`` type: string format: date-time + ResumeFullAutomationModeTime: + type: string + description: '' + SecondaryAvailabilityZone: + type: string + description: '' SourceDBClusterIdentifier: description: |- The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. @@ -1217,36 +2271,44 @@ components: description: |- If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. - The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. - + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the + The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance. + If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance. + + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. SourceRegion: type: string description: The ID of the region that contains the source DB instance for the read replica. + StatusInfos: + type: array + items: + $ref: '#/components/schemas/DBInstanceStatusInfo' + description: '' StorageEncrypted: type: boolean description: |- A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. - If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. - If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. - If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. - *Amazon Aurora* - Not applicable. The encrypt + If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. + If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. + If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. + *Amazon Aurora* + Not applicable. The encryption for DB instances is managed by the DB cluster. StorageType: type: string description: |- - Specifies the storage type to be associated with the DB instance. - Valid values: ``gp2 | gp3 | io1 | standard`` - The ``standard`` value is also known as magnetic. - If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. - Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` - For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* - Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs). + The storage type to associate with the DB instance. + If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. + This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. + Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` + Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp3``. StorageThroughput: type: integer description: |- - Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. + Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. Tags: type: array @@ -1254,7 +2316,7 @@ components: uniqueItems: false items: $ref: '#/components/schemas/Tag' - description: An optional array of key-value pairs to apply to this DB instance. + description: Tags to assign to the DB instance. TdeCredentialArn: type: string description: '' @@ -1263,7 +2325,7 @@ components: description: '' Timezone: type: string - description: The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). + description: The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). UseDefaultProcessorFeatures: type: boolean description: |- @@ -1272,7 +2334,7 @@ components: UseLatestRestorableTime: type: boolean description: |- - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. + Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided. VPCSecurityGroups: @@ -1286,34 +2348,128 @@ components: If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. - + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc + + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. + + To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. + *Amazon Aurora* + Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting. + ApplyImmediately: + type: boolean + description: |- + Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the ``PreferredMaintenanceWindow`` setting. If set to ``false``, changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state. + In addition to the settings described in [Modifying a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html), this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group. + Default: ``true`` x-stackql-resource-name: db_instance - x-stackql-primaryIdentifier: + description: |- + The ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. + For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*. + For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*. + If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation. + If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html). + *Updating DB instances* + When properties labeled "*Update requires:*[Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance. + We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure: + 1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance. + 1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html). + 1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the ``DBSnapshotIdentifier`` property with the ID of the DB snapshot that you want to use. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you can delete the ``DBSnapshotIdentifier`` property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + 1. Update the stack. + + For more information about updating other properties of this resource, see ``ModifyDBInstance``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html). + *Deleting DB instances* + For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the ``DBClusterIdentifier`` property: + 1. For ``AWS::RDS::DBInstance`` resources that don't specify the ``DBClusterIdentifier`` property, AWS CloudFormation saves a snapshot of the DB instance. + 1. For ``AWS::RDS::DBInstance`` resources that do specify the ``DBClusterIdentifier`` property, AWS CloudFormation deletes the DB instance. + + For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html). + x-type-name: AWS::RDS::DBInstance + x-stackql-primary-identifier: - DBInstanceIdentifier x-create-only-properties: + - BackupTarget - CharacterSetName - CustomIAMInstanceProfile - DBClusterIdentifier - DBInstanceIdentifier - DBName - DBSubnetGroupName + - DBSystemId - KmsKeyId - MasterUsername - NcharCharacterSetName - - Port - SourceRegion - StorageEncrypted - Timezone + x-conditional-create-only-properties: + - AutoMinorVersionUpgrade + - AvailabilityZone + - BackupRetentionPeriod + - DBClusterSnapshotIdentifier + - DBParameterGroupName + - DBSnapshotIdentifier + - Engine + - MultiAZ + - PerformanceInsightsKMSKeyId + - PreferredMaintenanceWindow + - RestoreTime + - SourceDBClusterIdentifier + - SourceDBInstanceAutomatedBackupsArn + - SourceDBInstanceIdentifier + - SourceDbiResourceId + - StorageType + - UseLatestRestorableTime + x-write-only-properties: + - AllowMajorVersionUpgrade + - AutomaticBackupReplicationKmsKeyId + - CertificateRotationRestart + - DBSnapshotIdentifier + - DeleteAutomatedBackups + - MasterUserPassword + - RestoreTime + - SourceDBInstanceAutomatedBackupsArn + - SourceDBInstanceIdentifier + - SourceDbiResourceId + - SourceRegion + - TdeCredentialPassword + - UseDefaultProcessorFeatures + - UseLatestRestorableTime + - ApplyImmediately x-read-only-properties: + - AutomaticRestartTime + - CertificateDetails + - CertificateDetails/CAIdentifier + - CertificateDetails/ValidTill + - Endpoint - Endpoint/Address - Endpoint/Port - Endpoint/HostedZoneId - DbiResourceId - DBInstanceArn - - DBSystemId + - DBInstanceStatus + - InstanceCreateTime + - IsStorageConfigUpgradeAvailable + - LatestRestorableTime + - ListenerEndpoint + - ListenerEndpoint/Address + - ListenerEndpoint/Port + - ListenerEndpoint/HostedZoneId - MasterUserSecret/SecretArn - - CertificateDetails/CAIdentifier - - CertificateDetails/ValidTill + - PercentProgress + - ReadReplicaDBClusterIdentifiers + - ReadReplicaDBInstanceIdentifiers + - ResumeFullAutomationModeTime + - SecondaryAvailabilityZone + - StatusInfos + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - ec2:DescribeAccountAttributes @@ -1375,6 +2531,7 @@ components: - rds:DescribeDBEngineVersions - rds:DescribeDBInstances - rds:DescribeDBParameterGroups + - rds:DescribeDBInstanceAutomatedBackups - rds:DescribeEvents - rds:ModifyDBInstance - rds:PromoteReadReplica @@ -1386,6 +2543,7 @@ components: - secretsmanager:CreateSecret - secretsmanager:TagResource delete: + - rds:AddTagsToResource - rds:CreateDBSnapshot - rds:DeleteDBInstance - rds:DescribeDBInstances @@ -1411,25 +2569,36 @@ components: type: string Family: description: |- - The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. - The DB parameter group family can't be changed when updating a DB parameter group. - To list all of the available parameter group families, use the following command: - ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"`` - The output contains duplicates. - For more information, see ``CreateDBParameterGroup``. + The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. + To list all of the available parameter group families for a DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` + For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`` + The output contains duplicates. + The following are the valid DB engine values: + + ``aurora-mysql`` + + ``aurora-postgresql`` + + ``db2-ae`` + + ``db2-se`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` type: string Parameters: description: |- - An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. - RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance. - For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*. - For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. - AWS CloudFormation doesn't support specifying an apply method for each individual + A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. + For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. + AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used. type: object Tags: - description: |- - An optional array of key-value pairs to apply to this DB parameter group. - Currently, this is the only property that supports drift detection. + description: Tags to assign to the DB parameter group. type: array maxItems: 50 uniqueItems: false @@ -1440,12 +2609,31 @@ components: - Family - Description x-stackql-resource-name: db_parameter_group - x-stackql-primaryIdentifier: + description: |- + The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family. + This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource. + For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*. + For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. + Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot. + x-type-name: AWS::RDS::DBParameterGroup + x-stackql-primary-identifier: - DBParameterGroupName x-create-only-properties: - DBParameterGroupName - Description - Family + x-required-properties: + - Family + - Description + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -1460,7 +2648,6 @@ components: read: - rds:DescribeDBParameterGroups - rds:DescribeDBParameters - - rds:DescribeEngineDefaultParameters - rds:ListTagsForResource update: - rds:AddTagsToResource @@ -1501,6 +2688,7 @@ components: type: string enum: - MYSQL_NATIVE_PASSWORD + - MYSQL_CACHING_SHA2_PASSWORD - POSTGRES_SCRAM_SHA_256 - POSTGRES_MD5 - SQL_SERVER_AUTHENTICATION @@ -1587,7 +2775,9 @@ components: - RoleArn - VpcSubnetIds x-stackql-resource-name: db_proxy - x-stackql-primaryIdentifier: + description: Resource schema for AWS::RDS::DBProxy + x-type-name: AWS::RDS::DBProxy + x-stackql-primary-identifier: - DBProxyName x-create-only-properties: - DBProxyName @@ -1597,6 +2787,22 @@ components: - DBProxyArn - Endpoint - VpcId + x-required-properties: + - Auth + - DBProxyName + - EngineFamily + - RoleArn + - VpcSubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource + - rds:ListTagsForResource x-required-permissions: create: - rds:CreateDBProxy @@ -1672,7 +2878,9 @@ components: - DBProxyEndpointName - VpcSubnetIds x-stackql-resource-name: db_proxy_endpoint - x-stackql-primaryIdentifier: + description: Resource schema for AWS::RDS::DBProxyEndpoint. + x-type-name: AWS::RDS::DBProxyEndpoint + x-stackql-primary-identifier: - DBProxyEndpointName x-create-only-properties: - DBProxyName @@ -1683,6 +2891,20 @@ components: - Endpoint - VpcId - IsDefault + x-required-properties: + - DBProxyName + - DBProxyEndpointName + - VpcSubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource + - rds:ListTagsForResource x-required-permissions: create: - rds:CreateDBProxyEndpoint @@ -1757,13 +2979,23 @@ components: - DBProxyName - TargetGroupName x-stackql-resource-name: db_proxy_target_group - x-stackql-primaryIdentifier: + description: Resource schema for AWS::RDS::DBProxyTargetGroup + x-type-name: AWS::RDS::DBProxyTargetGroup + x-stackql-primary-identifier: - TargetGroupArn x-create-only-properties: - DBProxyName - TargetGroupName x-read-only-properties: - TargetGroupArn + x-required-properties: + - DBProxyName + - TargetGroupName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - rds:DescribeDBProxies @@ -1782,6 +3014,116 @@ components: - rds:DeregisterDBProxyTargets list: - rds:DescribeDBProxyTargetGroups + DBShardGroup: + type: object + properties: + DBShardGroupResourceId: + description: '' + type: string + DBShardGroupIdentifier: + description: The name of the DB shard group. + type: string + minLength: 1 + maxLength: 63 + DBClusterIdentifier: + description: The name of the primary DB cluster for the DB shard group. + type: string + minLength: 1 + maxLength: 63 + ComputeRedundancy: + description: |- + Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following: + + 0 - Creates a DB shard group without a standby DB data access shard. This is the default value. + + 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ). + + 2 - Creates a DB shard group with two standby DB data access shard in two different AZs. + minimum: 0 + type: integer + MaxACU: + description: The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + type: number + MinACU: + description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs). + type: number + PubliclyAccessible: + description: |- + Specifies whether the DB shard group is publicly accessible. + When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. + When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. + Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. + If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private. + + If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public. + + If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private. + + If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public. + type: boolean + Endpoint: + description: '' + type: string + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group. + items: + $ref: '#/components/schemas/Tag' + required: + - DBClusterIdentifier + - MaxACU + x-stackql-resource-name: db_shard_group + description: |- + Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. + Valid for: Aurora DB clusters only + x-type-name: AWS::RDS::DBShardGroup + x-stackql-primary-identifier: + - DBShardGroupIdentifier + x-create-only-properties: + - DBClusterIdentifier + - DBShardGroupIdentifier + - PubliclyAccessible + x-write-only-properties: + - MinACU + x-read-only-properties: + - DBShardGroupResourceId + - Endpoint + x-required-properties: + - DBClusterIdentifier + - MaxACU + x-tagging: + cloudFormationSystemTags: true + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - rds:AddTagsToResource + - rds:CreateDBShardGroup + - rds:DescribeDBClusters + - rds:DescribeDBShardGroups + - rds:ListTagsForResource + read: + - rds:DescribeDBShardGroups + - rds:ListTagsForResource + update: + - rds:AddTagsToResource + - rds:DescribeDBShardGroups + - rds:DescribeDBClusters + - rds:RemoveTagsFromResource + - rds:ModifyDBShardGroup + - rds:ListTagsForResource + delete: + - rds:DeleteDBShardGroup + - rds:DescribeDBClusters + - rds:DescribeDbShardGroups + list: + - rds:DescribeDBShardGroups + - rds:ListTagsForResource DBSubnetGroup: type: object properties: @@ -1790,14 +3132,18 @@ components: description: The description for the DB subnet group. DBSubnetGroupName: type: string - pattern: ^(?!default$)[a-zA-Z]{1}[a-zA-Z0-9-_\.\s]{0,254}$ description: |- The name for the DB subnet group. This value is stored as a lowercase string. - Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default". - Example: ``mysubnetgroup`` + Constraints: + + Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. + + Must not be default. + + First character must be a letter. + + Example: ``mydbsubnetgroup`` SubnetIds: type: array uniqueItems: false + x-insertionOrder: false items: type: string description: The EC2 Subnet IDs for the DB subnet group. @@ -1806,17 +3152,33 @@ components: maxItems: 50 uniqueItems: false x-insertionOrder: false - description: An optional array of key-value pairs to apply to this DB subnet group. + description: Tags to assign to the DB subnet group. items: $ref: '#/components/schemas/Tag' required: - DBSubnetGroupDescription - SubnetIds x-stackql-resource-name: db_subnet_group - x-stackql-primaryIdentifier: + description: |- + The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. + For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*. + x-type-name: AWS::RDS::DBSubnetGroup + x-stackql-primary-identifier: - DBSubnetGroupName x-create-only-properties: - DBSubnetGroupName + x-required-properties: + - DBSubnetGroupDescription + - SubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -1844,7 +3206,7 @@ components: type: object properties: Tags: - description: An array of key-value pairs to apply to this resource. + description: An optional array of key-value pairs to apply to this subscription. type: array maxItems: 50 uniqueItems: false @@ -1852,40 +3214,71 @@ components: items: $ref: '#/components/schemas/Tag' SubscriptionName: - description: The name of the subscription. + description: |- + The name of the subscription. + Constraints: The name must be less than 255 characters. type: string maxLength: 255 Enabled: - description: A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. + description: Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. type: boolean default: true EventCategories: - description: A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. + description: >- + A list of event categories for a particular source type (``SourceType``) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this + list by using the ``DescribeEventCategories`` operation. type: array uniqueItems: true items: type: string SnsTopicArn: - description: The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. + description: |- + The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. + RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*. type: string SourceIds: - description: The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. + description: |- + The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. + Constraints: + + If ``SourceIds`` are supplied, ``SourceType`` must also be provided. + + If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied. + + If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied. + + If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied. + + If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied. + + If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied. + + If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied. + + If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied. type: array uniqueItems: true x-insertionOrder: false items: type: string SourceType: - description: The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. + description: |- + The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance``. For RDS Proxy events, specify ``db-proxy``. If this value isn't specified, all events are returned. + Valid Values:``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment`` type: string required: - SnsTopicArn x-stackql-resource-name: event_subscription - x-stackql-primaryIdentifier: + description: The ``AWS::RDS::EventSubscription`` resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*. + x-type-name: AWS::RDS::EventSubscription + x-stackql-primary-identifier: - SubscriptionName x-create-only-properties: - SubscriptionName - SnsTopicArn + x-required-properties: + - SnsTopicArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -1910,6 +3303,13 @@ components: - rds:DescribeEventSubscriptions list: - rds:DescribeEventSubscriptions + GlobalEndpoint: + type: object + additionalProperties: false + properties: + Address: + description: The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster. + type: string GlobalCluster: type: object properties: @@ -1922,16 +3322,29 @@ components: - aurora - aurora-mysql - aurora-postgresql - EngineVersion: - description: The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. - type: string - DeletionProtection: - description: The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. - type: boolean + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + EngineLifecycleSupport: + description: The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. + type: string + EngineVersion: + description: The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. + type: string + DeletionProtection: + description: The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. + type: boolean GlobalClusterIdentifier: description: The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string. type: string pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + minLength: 1 + maxLength: 63 SourceDBClusterIdentifier: description: The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string. type: string @@ -1943,14 +3356,29 @@ components: The storage encryption setting for the new global database cluster. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. type: boolean + GlobalEndpoint: + $ref: '#/components/schemas/GlobalEndpoint' x-stackql-resource-name: global_cluster - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::RDS::GlobalCluster + x-type-name: AWS::RDS::GlobalCluster + x-stackql-primary-identifier: - GlobalClusterIdentifier x-create-only-properties: - GlobalClusterIdentifier - SourceDBClusterIdentifier - StorageEncrypted - Engine + x-read-only-properties: + - GlobalEndpoint + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - rds:CreateGlobalCluster @@ -1961,6 +3389,8 @@ components: update: - rds:ModifyGlobalCluster - rds:DescribeGlobalClusters + - rds:AddTagsToResource + - rds:RemoveTagsFromResource delete: - rds:DescribeGlobalClusters - rds:DeleteGlobalCluster @@ -1993,45 +3423,72 @@ components: type: string minLength: 1 maxLength: 64 + Description: + type: string + description: A description of the integration. + minLength: 1 + maxLength: 1000 Tags: type: array maxItems: 50 uniqueItems: true x-insertionOrder: false - description: An array of key-value pairs to apply to this resource. + description: A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*. items: $ref: '#/components/schemas/Tag' + DataFilter: + type: string + description: Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. + minLength: 1 + maxLength: 25600 + pattern: '[a-zA-Z0-9_ "\\\-$,*.:?+\/]*' SourceArn: type: string - description: The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication. + description: The Amazon Resource Name (ARN) of the database to use as the source for replication. TargetArn: type: string description: The ARN of the Redshift data warehouse to use as the target for replication. IntegrationArn: type: string - description: The ARN of the integration. + description: '' KMSKeyId: type: string - description: An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource. + description: The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key. AdditionalEncryptionContext: $ref: '#/components/schemas/EncryptionContextMap' + description: |- + An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*. + You can only include this parameter if you specify the ``KMSKeyId`` parameter. CreateTime: type: string + description: '' required: - SourceArn - TargetArn x-stackql-resource-name: integration - x-stackql-primaryIdentifier: + description: A zero-ETL integration with Amazon Redshift. + x-type-name: AWS::RDS::Integration + x-stackql-primary-identifier: - IntegrationArn x-create-only-properties: - SourceArn - TargetArn - KMSKeyId - AdditionalEncryptionContext - - IntegrationName x-read-only-properties: - IntegrationArn - CreateTime + x-required-properties: + - SourceArn + - TargetArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - rds:CreateIntegration @@ -2046,17 +3503,18 @@ components: - rds:DescribeIntegrations - rds:AddTagsToResource - rds:RemoveTagsFromResource + - rds:ModifyIntegration delete: - rds:DeleteIntegration - rds:DescribeIntegrations list: - rds:DescribeIntegrations OptionConfiguration: - description: The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource. + description: The ``OptionConfiguration`` property type specifies an individual option, and its settings, within an ``AWS::RDS::OptionGroup`` resource. type: object properties: DBSecurityGroupMemberships: - description: A list of DBSecurityGroupMembership name strings used for this option. + description: A list of DB security groups used for this option. type: array uniqueItems: true x-insertionOrder: false @@ -2078,7 +3536,7 @@ components: description: The optional port for the option. type: integer VpcSecurityGroupMemberships: - description: A list of VpcSecurityGroupMembership name strings used for this option. + description: A list of VPC security group names used for this option. type: array uniqueItems: true x-insertionOrder: false @@ -2088,7 +3546,7 @@ components: required: - OptionName OptionSetting: - description: The OptionSetting property type specifies the value for an option within an OptionSetting property. + description: The ``OptionSetting`` property type specifies the value for an option within an ``OptionSetting`` property. type: object properties: Name: @@ -2102,19 +3560,41 @@ components: type: object properties: OptionGroupName: - description: Specifies the name of the option group. + description: |- + The name of the option group to be created. + Constraints: + + Must be 1 to 255 letters, numbers, or hyphens + + First character must be a letter + + Can't end with a hyphen or contain two consecutive hyphens + + Example: ``myoptiongroup`` + If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group. + This value is stored as a lowercase string. type: string OptionGroupDescription: - description: Provides a description of the option group. + description: The description of the option group. type: string EngineName: - description: Indicates the name of the engine that this option group can be applied to. + description: |- + Specifies the name of the engine that this option group should be associated with. + Valid Values: + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` type: string MajorEngineVersion: - description: Indicates the major engine version associated with this option group. + description: Specifies the major version of the engine that this option group should be associated with. type: string OptionConfigurations: - description: Indicates what options are available in the option group. + description: A list of all available options for an option group. type: array x-arrayType: AttributeList x-insertionOrder: false @@ -2122,7 +3602,7 @@ components: $ref: '#/components/schemas/OptionConfiguration' Tags: type: array - description: An array of key-value pairs to apply to this resource. + description: Tags to assign to the option group. x-insertionOrder: false items: $ref: '#/components/schemas/Tag' @@ -2131,13 +3611,28 @@ components: - MajorEngineVersion - OptionGroupDescription x-stackql-resource-name: option_group - x-stackql-primaryIdentifier: + description: The ``AWS::RDS::OptionGroup`` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine. + x-type-name: AWS::RDS::OptionGroup + x-stackql-primary-identifier: - OptionGroupName x-create-only-properties: - EngineName - MajorEngineVersion - OptionGroupDescription - OptionGroupName + x-required-properties: + - EngineName + - MajorEngineVersion + - OptionGroupDescription + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rds:AddTagsToResource + - rds:RemoveTagsFromResource x-required-permissions: create: - iam:CreateServiceLinkedRole @@ -2163,47 +3658,2270 @@ components: - rds:RemoveTagsFromResource list: - rds:DescribeOptionGroups + CreateCustomDBEngineVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DatabaseInstallationFilesS3BucketName: + type: string + description: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. + minLength: 3 + maxLength: 63 + DatabaseInstallationFilesS3Prefix: + type: string + description: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. + minLength: 1 + maxLength: 255 + Description: + type: string + description: An optional description of your CEV. + minLength: 1 + maxLength: 1000 + Engine: + type: string + description: |- + The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` + minLength: 1 + maxLength: 35 + EngineVersion: + type: string + description: |- + The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:*``^[a-z0-9_.-]{1,60$``} + minLength: 1 + maxLength: 60 + KMSKeyId: + type: string + description: |- + The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. + minLength: 1 + maxLength: 2048 + Manifest: + type: string + description: |- + The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + The following JSON fields are valid: + + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. + minLength: 1 + maxLength: 51000 + DBEngineVersionArn: + type: string + description: '' + SourceCustomDbEngineVersionIdentifier: + type: string + description: The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. + UseAwsProvidedLatestImage: + type: boolean + description: Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. + ImageId: + type: string + description: A value that indicates the ID of the AMI. + Status: + type: string + description: A value that indicates the status of a custom engine version (CEV). + default: available + enum: + - available + - inactive + - inactive-except-restore + Tags: + description: A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCustomDBEngineVersionRequest + type: object + required: [] + CreateDBClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Endpoint: + $ref: '#/components/schemas/Endpoint' + description: '' + ReadEndpoint: + $ref: '#/components/schemas/ReadEndpoint' + description: '' + AllocatedStorage: + description: |- + The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. + Valid for Cluster Type: Multi-AZ DB clusters only + This setting is required to create a Multi-AZ DB cluster. + type: integer + AssociatedRoles: + description: |- + Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/DBClusterRole' + AvailabilityZones: + description: |- + A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters only + type: array + uniqueItems: true + items: + type: string + AutoMinorVersionUpgrade: + description: |- + Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster. + For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades). + type: boolean + BacktrackWindow: + description: |- + The target backtrack window, in seconds. To disable backtracking, set this value to ``0``. + Valid for Cluster Type: Aurora MySQL DB clusters only + Default: ``0`` + Constraints: + + If specified, this value must be set to a number from 0 to 259,200 (72 hours). + minimum: 0 + type: integer + BackupRetentionPeriod: + description: |- + The number of days for which automated backups are retained. + Default: 1 + Constraints: + + Must be a value from 1 to 35 + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + default: 1 + minimum: 1 + type: integer + ClusterScalabilityType: + type: string + description: |- + Specifies the scalability mode of the Aurora DB cluster. When set to ``limitless``, the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to ``standard`` (the default), the cluster uses normal DB instance creation. + *Important:* Automated backup retention isn't supported with Aurora Limitless Database clusters. If you set this property to ``limitless``, you cannot set ``DeleteAutomatedBackups`` to ``false``. To create a backup, use manual snapshots instead. + CopyTagsToSnapshot: + description: |- + A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: boolean + DatabaseInsightsMode: + description: |- + The mode of Database Insights to enable for the DB cluster. + If you set this value to ``advanced``, you must also set the ``PerformanceInsightsEnabled`` parameter to ``true`` and the ``PerformanceInsightsRetentionPeriod`` parameter to 465. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + type: string + DatabaseName: + description: |- + The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + DBClusterArn: + type: string + description: '' + DBClusterInstanceClass: + description: |- + The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ``db.m6gd.xlarge``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. + For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*. + This setting is required to create a Multi-AZ DB cluster. + Valid for Cluster Type: Multi-AZ DB clusters only + type: string + DBClusterResourceId: + description: '' + type: string + DBInstanceParameterGroupName: + description: |- + The name of the DB parameter group to apply to all instances of the DB cluster. + When you apply a parameter group using the ``DBInstanceParameterGroupName`` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window. + Valid for Cluster Type: Aurora DB clusters only + Default: The existing name setting + Constraints: + + The DB parameter group must be in the same DB parameter group family as this DB cluster. + + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only. + type: string + DBSystemId: + description: Reserved for future use. + type: string + GlobalClusterIdentifier: + description: |- + If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource. + If you aren't configuring a global database cluster, don't specify this property. + To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property. + For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters only + type: string + pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + minLength: 0 + maxLength: 63 + DBClusterIdentifier: + description: |- + The DB cluster identifier. This parameter is stored as a lowercase string. + Constraints: + + Must contain from 1 to 63 letters, numbers, or hyphens. + + First character must be a letter. + + Can't end with a hyphen or contain two consecutive hyphens. + + Example: ``my-cluster1`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + minLength: 1 + maxLength: 63 + DBClusterParameterGroupName: + description: |- + The name of the DB cluster parameter group to associate with this DB cluster. + If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. + If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started. + To list all of the available DB cluster parameter group names, use the following command: + ``aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + DBSubnetGroupName: + description: |- + A DB subnet group that you want to associate with this DB cluster. + If you are restoring a DB cluster to a point in time with ``RestoreType`` set to ``copy-on-write``, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + DeleteAutomatedBackups: + type: boolean + description: Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule. + DeletionProtection: + description: |- + A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: boolean + Domain: + description: |- + Indicates the directory ID of the Active Directory to create the DB cluster. + For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. + For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*. + Valid for: Aurora DB clusters only + type: string + DomainIAMRoleName: + description: |- + Specifies the name of the IAM role to use when making API calls to the Directory Service. + Valid for: Aurora DB clusters only + type: string + EnableCloudwatchLogsExports: + description: |- + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*. + *Aurora MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Aurora PostgreSQL* + Valid values: ``postgresql`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: array + uniqueItems: true + items: + type: string + EnableGlobalWriteForwarding: + description: |- + Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. + You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. + Valid for Cluster Type: Aurora DB clusters only + type: boolean + EnableHttpEndpoint: + description: |- + Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. + When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. + For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*. + Valid for Cluster Type: Aurora DB clusters only + type: boolean + EnableIAMDatabaseAuthentication: + description: |- + A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.* + Valid for: Aurora DB clusters only + type: boolean + EnableLocalWriteForwarding: + description: |- + Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. + Valid for: Aurora DB clusters only + type: boolean + Engine: + description: |- + The name of the database engine to be used for this DB cluster. + Valid Values: + + ``aurora-mysql`` + + ``aurora-postgresql`` + + ``mysql`` + + ``postgres`` + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + EngineLifecycleSupport: + description: |- + The life cycle type for this DB cluster. + By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. + You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: + + Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* + + Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* + + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` + Default: ``open-source-rds-extended-support`` + type: string + EngineMode: + description: |- + The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``. + The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode. + For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*: + + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) + + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) + + Valid for Cluster Type: Aurora DB clusters only + type: string + EngineVersion: + description: |- + The version number of the database engine to use. + To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command: + ``aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`` + You can supply either ``5.7`` or ``8.0`` to use the default engine version for Aurora MySQL version 2 or version 3, respectively. + To list all of the available engine versions for Aurora PostgreSQL, use the following command: + ``aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`` + To list all of the available engine versions for RDS for MySQL, use the following command: + ``aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"`` + To list all of the available engine versions for RDS for PostgreSQL, use the following command: + ``aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"`` + *Aurora MySQL* + For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*. + *Aurora PostgreSQL* + For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*. + *MySQL* + For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*. + *PostgreSQL* + For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + ManageMasterUserPassword: + description: |- + Specifies whether to manage the master user password with AWS Secrets Manager. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Constraints: + + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. + type: boolean + Iops: + description: |- + The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. + For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. + This setting is required to create a Multi-AZ DB cluster. + Valid for Cluster Type: Multi-AZ DB clusters only + Constraints: + + Must be a multiple between .5 and 50 of the storage amount for the DB cluster. + type: integer + KmsKeyId: + description: |- + The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the ``StorageEncrypted`` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the ``StorageEncrypted`` property to ``true``. + If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used. + If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set ``KmsKeyId`` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + MasterUsername: + description: |- + The name of the master user for the DB cluster. + If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + pattern: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ + minLength: 1 + MasterUserPassword: + description: |- + The master password for the DB instance. + If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + MasterUserSecret: + $ref: '#/components/schemas/MasterUserSecret' + description: |- + The secret managed by RDS in AWS Secrets Manager for the master user password. + When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the ``SecretArn`` property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* + MonitoringInterval: + description: |- + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ``0``. + If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` + Default: ``0`` + type: integer + MonitoringRoleArn: + description: |- + The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. + If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + type: string + NetworkType: + description: |- + The network type of the DB cluster. + Valid values: + + ``IPV4`` + + ``DUAL`` + + The network type is determined by the ``DBSubnetGroup`` specified for the DB cluster. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). + For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.* + Valid for: Aurora DB clusters only + type: string + PerformanceInsightsEnabled: + description: |- + Specifies whether to turn on Performance Insights for the DB cluster. + For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + type: boolean + PerformanceInsightsKmsKeyId: + description: |- + The AWS KMS key identifier for encryption of Performance Insights data. + The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + If you don't specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS-account. Your AWS-account has a different default KMS key for each AWS-Region. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + type: string + PerformanceInsightsRetentionPeriod: + description: |- + The number of days to retain Performance Insights data. When creating a DB cluster without enabling Performance Insights, you can't specify the parameter ``PerformanceInsightsRetentionPeriod``. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: + + ``7`` + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + ``731`` + + Default: ``7`` days + If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error. + type: integer + Port: + description: |- + The port number on which the DB instances in the DB cluster accept connections. + Default: + + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL) + + When ``EngineMode`` is ``serverless``: + + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` + + ``5432`` when ``Engine`` is ``aurora-postgresql`` + + + The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: integer + PreferredBackupWindow: + description: |- + The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.* + Constraints: + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + PreferredMaintenanceWindow: + description: |- + The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Format: ``ddd:hh24:mi-ddd:hh24:mi`` + The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Maintaining an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.* + Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + Constraints: Minimum 30-minute window. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + PubliclyAccessible: + description: |- + Specifies whether the DB cluster is publicly accessible. + When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. + When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. + Valid for Cluster Type: Multi-AZ DB clusters only + Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. + If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. + + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. + + If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. + + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. + type: boolean + ReplicationSourceIdentifier: + description: |- + The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. + Valid for: Aurora DB clusters only + type: string + RestoreToTime: + description: |- + The date and time to restore the DB cluster to. + Valid Values: Value must be a time in Universal Coordinated Time (UTC) format + Constraints: + + Must be before the latest restorable time for the DB instance + + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided + + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled + + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` + + This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property. + Example: ``2015-03-07T23:45:00Z`` + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + RestoreType: + description: |- + The type of restore to be performed. You can specify one of the following values: + + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster. + + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster. + + If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + ServerlessV2ScalingConfiguration: + description: |- + The scaling configuration of an Aurora Serverless V2 DB cluster. + This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property. + Valid for: Aurora Serverless v2 DB clusters only + $ref: '#/components/schemas/ServerlessV2ScalingConfiguration' + ScalingConfiguration: + description: |- + The scaling configuration of an Aurora Serverless v1 DB cluster. + This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property. + Valid for: Aurora Serverless v1 DB clusters only + $ref: '#/components/schemas/ScalingConfiguration' + SnapshotIdentifier: + description: |- + The identifier for the DB snapshot or DB cluster snapshot to restore from. + You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. + After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted. + If you specify the ``SnapshotIdentifier`` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties: + + ``GlobalClusterIdentifier`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``ReplicationSourceIdentifier`` + + ``RestoreType`` + + ``SourceDBClusterIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an encrypted snapshot) + + ``UseLatestRestorableTime`` + + Constraints: + + Must match the identifier of an existing Snapshot. + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + SourceDBClusterIdentifier: + description: |- + When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore. + Constraints: + + Must match the identifier of an existing DBCluster. + + Cannot be specified if ``SourceDbClusterResourceId`` is specified. You must specify either ``SourceDBClusterIdentifier`` or ``SourceDbClusterResourceId``, but not both. + + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: string + SourceDbClusterResourceId: + description: The resource ID of the source DB cluster from which to restore. + type: string + SourceRegion: + description: |- + The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``. + Valid for: Aurora DB clusters only + type: string + StorageEncrypted: + description: |- + Indicates whether the DB cluster is encrypted. + If you specify the ``KmsKeyId`` property, then you must enable encryption. + If you specify the ``SourceDBClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used. + If you specify the ``SnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. + If you specify the ``SnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to ``false``. + If you specify both the ``StorageEncrypted`` and ``SnapshotIdentifier`` properties without specifying the ``KmsKeyId`` property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: boolean + StorageThroughput: + description: '' + type: integer + StorageType: + description: |- + The storage type to associate with the DB cluster. + For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings). + This setting is required to create a Multi-AZ DB cluster. + When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + Valid Values: + + Aurora DB clusters - ``aurora | aurora-iopt1`` + + Multi-AZ DB clusters - ``io1 | io2 | gp3`` + + Default: + + Aurora DB clusters - ``aurora`` + + Multi-AZ DB clusters - ``io1`` + + When you create an Aurora DB cluster with the storage type set to ``aurora-iopt1``, the storage type is returned in the response. The storage type isn't returned when you set it to ``aurora``. + type: string + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: |- + Tags to assign to the DB cluster. + Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + items: + $ref: '#/components/schemas/Tag' + UseLatestRestorableTime: + description: |- + A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + type: boolean + VpcSecurityGroupIds: + description: |- + A list of EC2 VPC security groups to associate with this DB cluster. + If you plan to update the resource, don't specify VPC security groups in a shared VPC. + Valid for: Aurora DB clusters and Multi-AZ DB clusters + uniqueItems: true + items: + type: string + type: array + x-stackQL-stringOnly: true + x-title: CreateDBClusterRequest + type: object + required: [] + CreateDBClusterParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: The description for the DB cluster parameter group. + type: string + Family: + description: |- + The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. + *Aurora MySQL* + Example: ``aurora-mysql5.7``, ``aurora-mysql8.0`` + *Aurora PostgreSQL* + Example: ``aurora-postgresql14`` + *RDS for MySQL* + Example: ``mysql8.0`` + *RDS for PostgreSQL* + Example: ``postgres13`` + To list all of the available parameter group families for a DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` + For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql`` + The output contains duplicates. + The following are the valid DB engine values: + + ``aurora-mysql`` + + ``aurora-postgresql`` + + ``mysql`` + + ``postgres`` + type: string + Parameters: + description: Provides a list of parameters for the DB cluster parameter group. + type: object + DBClusterParameterGroupName: + type: string + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$ + description: |- + The name of the DB cluster parameter group. + Constraints: + + Must not match the name of an existing DB cluster parameter group. + + This value is stored as a lowercase string. + Tags: + description: Tags to assign to the DB cluster parameter group. + type: array + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBClusterParameterGroupRequest + type: object + required: [] + CreateDBInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllocatedStorage: + type: string + description: |- + The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. + If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). + *Amazon Aurora* + Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. + *Db2* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. + + *MySQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *MariaDB* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *PostgreSQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *Oracle* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 10 to 3072. + + *SQL Server* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Provisioned IOPS storage (io1): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Magnetic storage (standard): + + Enterprise and Standard editions: Must be an integer from 20 to 1024. + + Web and Express editions: Must be an integer from 20 to 1024. + pattern: ^[0-9]*$ + AllowMajorVersionUpgrade: + type: boolean + description: |- + A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. + Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. + AssociatedRoles: + type: array + items: + $ref: '#/components/schemas/DBInstanceRole' + description: |- + The IAMlong (IAM) roles associated with the DB instance. + *Amazon Aurora* + Not applicable. The associated roles are managed by the DB cluster. + AutoMinorVersionUpgrade: + type: boolean + description: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. + AutomaticBackupReplicationRegion: + type: string + description: The AWS-Region associated with the automated backup. + AutomaticBackupReplicationKmsKeyId: + type: string + description: The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``. + AutomaticBackupReplicationRetentionPeriod: + type: integer + minimum: 1 + description: |- + The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the ``AutomaticBackupReplicationRegion`` parameter. + If not specified, this parameter defaults to the value of the ``BackupRetentionPeriod`` parameter. The maximum allowed value is 35. + AutomaticRestartTime: + type: string + description: '' + AvailabilityZone: + type: string + description: |- + The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). + For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. + Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. + Constraints: + + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + + The specified Availability Zone must be in the same AWS-Region as the current endpoint. + + Example: ``us-east-1d`` + BackupRetentionPeriod: + type: integer + minimum: 0 + description: |- + The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. + *Amazon Aurora* + Not applicable. The retention period for automated backups is managed by the DB cluster. + Default: 1 + Constraints: + + Must be a value from 0 to 35 + + Can't be set to 0 if the DB instance is a source to read replicas + BackupTarget: + type: string + description: |- + The location for storing automated backups and manual snapshots. + Valid Values: + + ``local`` (Dedicated Local Zone) + + ``outposts`` (AWS Outposts) + + ``region`` (AWS-Region) + + Default: ``region`` + For more information, see [Working with Amazon RDS on Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the *Amazon RDS User Guide*. + CACertificateIdentifier: + type: string + description: |- + The identifier of the CA certificate for this DB instance. + For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. + CertificateDetails: + $ref: '#/components/schemas/CertificateDetails' + description: '' + CertificateRotationRestart: + type: boolean + description: |- + Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. + By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. + Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. + If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. + + This setting doesn't apply to RDS Custom DB instances. + CharacterSetName: + type: string + description: |- + For supported engines, indicates that the DB instance should be associated with the specified character set. + *Amazon Aurora* + Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). + CopyTagsToSnapshot: + type: boolean + description: |- + Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. + This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. + CustomIAMInstanceProfile: + type: string + description: |- + The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. + This setting is required for RDS Custom. + Constraints: + + The profile must exist in your account. + + The profile must have an IAM role that Amazon EC2 has permissions to assume. + + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. + + For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. + DatabaseInsightsMode: + description: |- + The mode of Database Insights to enable for the DB instance. + Aurora DB instances inherit this value from the DB cluster, so you can't change this value. + type: string + DBClusterIdentifier: + type: string + description: |- + The identifier of the DB cluster that this DB instance will belong to. + This setting doesn't apply to RDS Custom DB instances. + DBClusterSnapshotIdentifier: + type: string + description: |- + The identifier for the Multi-AZ DB cluster snapshot to restore from. + For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. + Constraints: + + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + + Can't be specified when ``DBSnapshotIdentifier`` is specified. + + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + + Can't be the identifier of an Aurora DB cluster snapshot. + DBInstanceArn: + type: string + description: '' + DBInstanceClass: + type: string + description: >- + The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance + classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. + DBInstanceIdentifier: + type: string + pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + minLength: 1 + maxLength: 63 + description: |- + A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + DBInstanceStatus: + type: string + description: '' + DbiResourceId: + type: string + description: '' + DBName: + type: string + description: |- + The meaning of this parameter differs according to the database engine you use. + If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. + *Amazon Aurora* + Not applicable. The database name is managed by the DB cluster. + *Db2* + The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Can't be a word reserved by the specified database engine. + + *MySQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *MariaDB* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *PostgreSQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. + Constraints: + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Must contain 1 to 63 characters. + + Can't be a word reserved by the specified database engine + + *Oracle* + The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. + Default: ``ORCL`` + Constraints: + + Can't be longer than 8 characters + + *SQL Server* + Not applicable. Must be null. + DBParameterGroupName: + type: string + description: |- + The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. + To list all of the available DB parameter group names, use the following command: + ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` + If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. + DBSecurityGroups: + type: array + uniqueItems: true + items: + type: string + description: |- + A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. + If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. + If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + + ``AllocatedStorage`` + + ``AutoMinorVersionUpgrade`` + + ``AvailabilityZone`` + + ``BackupRetentionPeriod`` + + ``CharacterSetName`` + + ``DBInstanceClass`` + + ``DBName`` + + ``DBParameterGroupName`` + + ``DBSecurityGroups`` + + ``DBSubnetGroupName`` + + ``Engine`` + + ``EngineVersion`` + + ``Iops`` + + ``LicenseModel`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``MultiAZ`` + + ``OptionGroupName`` + + ``PreferredBackupWindow`` + + ``PreferredMaintenanceWindow`` + + All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. + DBSnapshotIdentifier: + type: string + description: |- + The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. + By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. + Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime``. For information about the properties that you can specify, see the [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) action in the *Amazon RDS API Reference*. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + + ``CharacterSetName`` + + ``DBClusterIdentifier`` + + ``DBName`` + + ``KmsKeyId`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``PromotionTier`` + + ``SourceDBInstanceIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an unencrypted snapshot) + + ``Timezone`` + + *Amazon Aurora* + Not applicable. Snapshot restore is managed by the DB cluster. + DBSubnetGroupName: + type: string + description: |- + A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. + If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a ``DBSubnetGroupName``, the DB instance fails to launch. + For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. + DBSystemId: + type: string + description: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. + DedicatedLogVolume: + type: boolean + description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. + DeleteAutomatedBackups: + type: boolean + description: |- + A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. + *Amazon Aurora* + Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. + DeletionProtection: + type: boolean + description: |- + Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. + Domain: + type: string + description: |- + The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. + For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. + DomainAuthSecretArn: + type: string + description: |- + The ARN for the Secrets Manager secret with the credentials for the user joining the domain. + Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` + DomainDnsIps: + type: array + items: + type: string + description: |- + The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. + Constraints: + + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. + + Example: ``123.124.125.126,234.235.236.237`` + DomainFqdn: + type: string + description: |- + The fully qualified domain name (FQDN) of an Active Directory domain. + Constraints: + + Can't be longer than 64 characters. + + Example: ``mymanagedADtest.mymanagedAD.mydomain`` + DomainIAMRoleName: + type: string + description: |- + The name of the IAM role to use when making API calls to the Directory Service. + This setting doesn't apply to the following DB instances: + + Amazon Aurora (The domain is managed by the DB cluster.) + + RDS Custom + DomainOu: + type: string + description: |- + The Active Directory organizational unit for your DB instance to join. + Constraints: + + Must be in the distinguished name format. + + Can't be longer than 64 characters. + + Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` + EnableCloudwatchLogsExports: + type: array + items: + type: string + description: |- + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. + *Amazon Aurora* + Not applicable. CloudWatch Logs exports are managed by the DB cluster. + *Db2* + Valid values: ``diag.log``, ``notify.log`` + *MariaDB* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Microsoft SQL Server* + Valid values: ``agent``, ``error`` + *MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Oracle* + Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` + *PostgreSQL* + Valid values: ``postgresql``, ``upgrade`` + EnableIAMDatabaseAuthentication: + type: boolean + description: |- + A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* + *Amazon Aurora* + Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. + EnablePerformanceInsights: + type: boolean + description: |- + Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. + This setting doesn't apply to RDS Custom DB instances. + Endpoint: + $ref: '#/components/schemas/Endpoint' + description: '' + Engine: + type: string + description: |- + The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. + This property is required when creating a DB instance. + You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. + Valid Values: + + ``aurora-mysql`` (for Aurora MySQL DB instances) + + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + + ``db2-ae`` + + ``db2-se`` + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` + EngineLifecycleSupport: + type: string + description: |- + The life cycle type for this DB instance. + By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. + This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. + You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*. + Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` + Default: ``open-source-rds-extended-support`` + EngineVersion: + type: string + description: |- + The version number of the database engine to use. + For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. + The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. + *Amazon Aurora* + Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. + *Db2* + See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *MariaDB* + See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Microsoft SQL Server* + See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* + *MySQL* + See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Oracle* + See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* + *PostgreSQL* + See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.* + ManageMasterUserPassword: + type: boolean + description: |- + Specifies whether to manage the master user password with AWS Secrets Manager. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + Constraints: + + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. + InstanceCreateTime: + type: string + description: '' + format: date-time + Iops: + type: integer + description: |- + The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. + If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. + If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. + Constraints: + + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. + IsStorageConfigUpgradeAvailable: + type: boolean + description: '' + KmsKeyId: + type: string + description: |- + The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. + If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID. + If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used. + If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. + If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot. + If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The KMS key identifier is managed by the DB cluster. + LatestRestorableTime: + type: string + description: '' + format: date-time + LicenseModel: + type: string + description: |- + License model information for this DB instance. + Valid Values: + + Aurora MySQL - ``general-public-license`` + + Aurora PostgreSQL - ``postgresql-license`` + + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + + RDS for MariaDB - ``general-public-license`` + + RDS for Microsoft SQL Server - ``license-included`` + + RDS for MySQL - ``general-public-license`` + + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + + RDS for PostgreSQL - ``postgresql-license`` + + If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. + ListenerEndpoint: + $ref: '#/components/schemas/Endpoint' + description: '' + MasterUsername: + type: string + pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,127}$ + description: |- + The master user name for the DB instance. + If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. + When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. + *Amazon Aurora* + Not applicable. The name for the master user is managed by the DB cluster. + *RDS for Db2* + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for MariaDB* + Constraints: + + Must be 1 to 16 letters or numbers. + + Can't be a reserved word for the chosen database engine. + + *RDS for Microsoft SQL Server* + Constraints: + + Must be 1 to 128 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for MySQL* + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for Oracle* + Constraints: + + Must be 1 to 30 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for PostgreSQL* + Constraints: + + Must be 1 to 63 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + minLength: 1 + maxLength: 128 + MasterUserPassword: + type: string + description: |- + The password for the master user. The password can include any printable ASCII character except "/", """, or "@". + *Amazon Aurora* + Not applicable. The password for the master user is managed by the DB cluster. + *RDS for Db2* + Must contain from 8 to 255 characters. + *RDS for MariaDB* + Constraints: Must contain from 8 to 41 characters. + *RDS for Microsoft SQL Server* + Constraints: Must contain from 8 to 128 characters. + *RDS for MySQL* + Constraints: Must contain from 8 to 41 characters. + *RDS for Oracle* + Constraints: Must contain from 8 to 30 characters. + *RDS for PostgreSQL* + Constraints: Must contain from 8 to 128 characters. + MasterUserSecret: + $ref: '#/components/schemas/MasterUserSecret' + description: |- + The secret managed by RDS in AWS Secrets Manager for the master user password. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + MaxAllocatedStorage: + type: integer + description: |- + The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. + For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. + This setting doesn't apply to the following DB instances: + + Amazon Aurora (Storage is managed by the DB cluster.) + + RDS Custom + MonitoringInterval: + type: integer + description: |- + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify ``0``. + If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0``. + This setting doesn't apply to RDS Custom DB instances. + Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` + Default: ``0`` + MonitoringRoleArn: + type: string + description: |- + The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. + If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. + This setting doesn't apply to RDS Custom DB instances. + MultiAZ: + type: boolean + description: |- + Specifies whether the DB instance is a Multi-AZ deployment. You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment. + This setting doesn't apply to Amazon Aurora because the DB instance Availability Zones (AZs) are managed by the DB cluster. + NcharCharacterSetName: + type: string + description: |- + The name of the NCHAR character set for the Oracle DB instance. + This setting doesn't apply to RDS Custom DB instances. + NetworkType: + description: |- + The network type of the DB instance. + Valid values: + + ``IPV4`` + + ``DUAL`` + + The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). + For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* + type: string + OptionGroupName: + type: string + description: |- + Indicates that the DB instance should be associated with the specified option group. + Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. + PercentProgress: + type: string + description: '' + PerformanceInsightsKMSKeyId: + type: string + description: |- + The AWS KMS key identifier for encryption of Performance Insights data. + The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. + For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). + PerformanceInsightsRetentionPeriod: + type: integer + description: |- + The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter ``PerformanceInsightsRetentionPeriod``. + This setting doesn't apply to RDS Custom DB instances. + Valid Values: + + ``7`` + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + ``731`` + + Default: ``7`` days + If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. + Port: + type: string + description: |- + The port number on which the database accepts connections. + This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. + Valid Values: ``1150-65535`` + Default: + + RDS for Db2 - ``50000`` + + RDS for MariaDB - ``3306`` + + RDS for Microsoft SQL Server - ``1433`` + + RDS for MySQL - ``3306`` + + RDS for Oracle - ``1521`` + + RDS for PostgreSQL - ``5432`` + + Constraints: + + For RDS for Microsoft SQL Server, the value can't be ``1234``, ``1434``, ``3260``, ``3343``, ``3389``, ``47001``, or ``49152-49156``. + pattern: ^\d*$ + PreferredBackupWindow: + type: string + description: |- + The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + Constraints: + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. + + *Amazon Aurora* + Not applicable. The daily time range for creating automated backups is managed by the DB cluster. + PreferredMaintenanceWindow: + type: string + description: |- + The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Format: ``ddd:hh24:mi-ddd:hh24:mi`` + The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Maintaining a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* + This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. + Constraints: Minimum 30-minute window. + ProcessorFeatures: + type: array + items: + $ref: '#/components/schemas/ProcessorFeature' + description: |- + The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. + PromotionTier: + type: integer + minimum: 0 + description: |- + The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. + This setting doesn't apply to RDS Custom DB instances. + Default: ``1`` + Valid Values: ``0 - 15`` + PubliclyAccessible: + type: boolean + description: |- + Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. + The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. + ReadReplicaDBClusterIdentifiers: + type: array + items: + type: string + description: '' + ReadReplicaDBInstanceIdentifiers: + type: array + items: + type: string + description: '' + ReplicaMode: + description: |- + The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. + This setting is only supported in RDS for Oracle. + Default: ``open-read-only`` + Valid Values: ``open-read-only`` or ``mounted`` + type: string + RestoreTime: + description: |- + The date and time to restore from. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*. + Constraints: + + Must be a time in Universal Coordinated Time (UTC) format. + + Must be before the latest restorable time for the DB instance. + + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. + + Example: ``2009-09-07T23:45:00Z`` + type: string + format: date-time + ResumeFullAutomationModeTime: + type: string + description: '' + SecondaryAvailabilityZone: + type: string + description: '' + SourceDBClusterIdentifier: + description: |- + The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. + Constraints: + + Must be the identifier of an existing Multi-AZ DB cluster. + + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. + type: string + SourceDbiResourceId: + type: string + description: The resource ID of the source DB instance from which to restore. + SourceDBInstanceAutomatedBackupsArn: + type: string + description: |- + The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. + This setting doesn't apply to RDS Custom. + SourceDBInstanceIdentifier: + type: string + description: |- + If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance. + If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance. + + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. + SourceRegion: + type: string + description: The ID of the region that contains the source DB instance for the read replica. + StatusInfos: + type: array + items: + $ref: '#/components/schemas/DBInstanceStatusInfo' + description: '' + StorageEncrypted: + type: boolean + description: |- + A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. + If you specify the ``KmsKeyId`` property, then you must enable encryption. + If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. + If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. + If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. + *Amazon Aurora* + Not applicable. The encryption for DB instances is managed by the DB cluster. + StorageType: + type: string + description: |- + The storage type to associate with the DB instance. + If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. + This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. + Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` + Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp3``. + StorageThroughput: + type: integer + description: |- + Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the ``gp3`` storage type. + This setting doesn't apply to RDS Custom or Amazon Aurora. + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + description: Tags to assign to the DB instance. + TdeCredentialArn: + type: string + description: '' + TdeCredentialPassword: + type: string + description: '' + Timezone: + type: string + description: The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). + UseDefaultProcessorFeatures: + type: boolean + description: |- + Specifies whether the DB instance class of the DB instance uses its default processor features. + This setting doesn't apply to RDS Custom DB instances. + UseLatestRestorableTime: + type: boolean + description: |- + Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*. + Constraints: + + Can't be specified if the ``RestoreTime`` parameter is provided. + VPCSecurityGroups: + type: array + uniqueItems: true + items: + type: string + description: |- + A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. + If you plan to update the resource, don't specify VPC security groups in a shared VPC. + If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. + You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + + You can't revert to using an RDS security group after you establish a VPC security group membership. + + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. + + To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. + *Amazon Aurora* + Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting. + ApplyImmediately: + type: boolean + description: |- + Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the ``PreferredMaintenanceWindow`` setting. If set to ``false``, changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state. + In addition to the settings described in [Modifying a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html), this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group. + Default: ``true`` + x-stackQL-stringOnly: true + x-title: CreateDBInstanceRequest + type: object + required: [] + CreateDBParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DBParameterGroupName: + description: |- + The name of the DB parameter group. + Constraints: + + Must be 1 to 255 letters, numbers, or hyphens. + + First character must be a letter + + Can't end with a hyphen or contain two consecutive hyphens + + If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group. + This value is stored as a lowercase string. + type: string + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$ + Description: + description: Provides the customer-specified description for this DB parameter group. + type: string + Family: + description: |- + The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. + To list all of the available parameter group families for a DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine `` + For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`` + The output contains duplicates. + The following are the valid DB engine values: + + ``aurora-mysql`` + + ``aurora-postgresql`` + + ``db2-ae`` + + ``db2-se`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` + type: string + Parameters: + description: |- + A mapping of parameter names and values for the parameter update. You must specify at least one parameter name and value. + For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. + AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used. + type: object + Tags: + description: Tags to assign to the DB parameter group. + type: array + maxItems: 50 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBParameterGroupRequest + type: object + required: [] + CreateDBProxyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Auth: + description: The authorization mechanism that the proxy uses. + type: array + x-insertionOrder: false + minItems: 1 + items: + $ref: '#/components/schemas/AuthFormat' + DBProxyArn: + description: The Amazon Resource Name (ARN) for the proxy. + type: string + DBProxyName: + description: The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. + type: string + pattern: '[0-z]*' + maxLength: 64 + DebugLogging: + description: Whether the proxy includes detailed information about SQL statements in its logs. + type: boolean + Endpoint: + description: The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application. + type: string + EngineFamily: + description: The kinds of databases that the proxy can connect to. + type: string + enum: + - MYSQL + - POSTGRESQL + - SQLSERVER + IdleClientTimeout: + description: The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. + type: integer + RequireTLS: + description: A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. + type: boolean + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. + type: string + Tags: + description: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagFormat' + VpcId: + description: VPC ID to associate with the new DB proxy. + type: string + VpcSecurityGroupIds: + description: VPC security group IDs to associate with the new proxy. + type: array + x-insertionOrder: false + minItems: 1 + items: + type: string + VpcSubnetIds: + description: VPC subnet IDs to associate with the new proxy. + type: array + x-insertionOrder: false + minItems: 2 + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateDBProxyRequest + type: object + required: [] + CreateDBProxyEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DBProxyEndpointName: + description: The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region. + type: string + pattern: '[0-z]*' + maxLength: 64 + DBProxyEndpointArn: + description: The Amazon Resource Name (ARN) for the DB proxy endpoint. + type: string + pattern: arn:aws[A-Za-z0-9-]{0,64}:rds:[A-Za-z0-9-]{1,64}:[0-9]{12}:.* + DBProxyName: + description: The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. + type: string + pattern: '[0-z]*' + maxLength: 64 + VpcId: + description: VPC ID to associate with the new DB proxy endpoint. + type: string + VpcSecurityGroupIds: + description: VPC security group IDs to associate with the new DB proxy endpoint. + type: array + x-insertionOrder: false + minItems: 1 + items: + type: string + VpcSubnetIds: + description: VPC subnet IDs to associate with the new DB proxy endpoint. + type: array + minItems: 2 + x-insertionOrder: false + items: + type: string + Endpoint: + description: The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. + type: string + maxLength: 256 + TargetRole: + description: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. + type: string + enum: + - READ_WRITE + - READ_ONLY + IsDefault: + description: A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only. + type: boolean + Tags: + description: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagFormat' + x-stackQL-stringOnly: true + x-title: CreateDBProxyEndpointRequest + type: object + required: [] + CreateDBProxyTargetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DBProxyName: + description: The identifier for the proxy. + type: string + pattern: '[A-z][0-z]*' + maxLength: 64 + TargetGroupArn: + description: The Amazon Resource Name (ARN) representing the target group. + type: string + TargetGroupName: + description: The identifier for the DBProxyTargetGroup + type: string + enum: + - default + ConnectionPoolConfigurationInfo: + $ref: '#/components/schemas/ConnectionPoolConfigurationInfoFormat' + DBInstanceIdentifiers: + type: array + x-insertionOrder: false + items: + type: string + DBClusterIdentifiers: + type: array + x-insertionOrder: false + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateDBProxyTargetGroupRequest + type: object + required: [] + CreateDBShardGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DBShardGroupResourceId: + description: '' + type: string + DBShardGroupIdentifier: + description: The name of the DB shard group. + type: string + minLength: 1 + maxLength: 63 + DBClusterIdentifier: + description: The name of the primary DB cluster for the DB shard group. + type: string + minLength: 1 + maxLength: 63 + ComputeRedundancy: + description: |- + Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following: + + 0 - Creates a DB shard group without a standby DB data access shard. This is the default value. + + 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ). + + 2 - Creates a DB shard group with two standby DB data access shard in two different AZs. + minimum: 0 + type: integer + MaxACU: + description: The maximum capacity of the DB shard group in Aurora capacity units (ACUs). + type: number + MinACU: + description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs). + type: number + PubliclyAccessible: + description: |- + Specifies whether the DB shard group is publicly accessible. + When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it. + When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. + Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. + If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private. + + If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public. + + If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: + + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private. + + If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public. + type: boolean + Endpoint: + description: '' + type: string + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBShardGroupRequest + type: object + required: [] + CreateDBSubnetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DBSubnetGroupDescription: + type: string + description: The description for the DB subnet group. + DBSubnetGroupName: + type: string + description: |- + The name for the DB subnet group. This value is stored as a lowercase string. + Constraints: + + Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. + + Must not be default. + + First character must be a letter. + + Example: ``mydbsubnetgroup`` + SubnetIds: + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + description: The EC2 Subnet IDs for the DB subnet group. + Tags: + type: array + maxItems: 50 + uniqueItems: false + x-insertionOrder: false + description: Tags to assign to the DB subnet group. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDBSubnetGroupRequest + type: object + required: [] + CreateEventSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Tags: + description: An optional array of key-value pairs to apply to this subscription. + type: array + maxItems: 50 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + SubscriptionName: + description: |- + The name of the subscription. + Constraints: The name must be less than 255 characters. + type: string + maxLength: 255 + Enabled: + description: Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. + type: boolean + default: true + EventCategories: + description: >- + A list of event categories for a particular source type (``SourceType``) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see + this list by using the ``DescribeEventCategories`` operation. + type: array + uniqueItems: true + items: + type: string + SnsTopicArn: + description: |- + The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. + RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*. + type: string + SourceIds: + description: |- + The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. + Constraints: + + If ``SourceIds`` are supplied, ``SourceType`` must also be provided. + + If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied. + + If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied. + + If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied. + + If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied. + + If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied. + + If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied. + + If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + SourceType: + description: |- + The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance``. For RDS Proxy events, specify ``db-proxy``. If this value isn't specified, all events are returned. + Valid Values:``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment`` + type: string + x-stackQL-stringOnly: true + x-title: CreateEventSubscriptionRequest + type: object + required: [] + CreateGlobalClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Engine: + description: |- + The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora). + If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. + type: string + enum: + - aurora + - aurora-mysql + - aurora-postgresql + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + EngineLifecycleSupport: + description: The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. + type: string + EngineVersion: + description: The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. + type: string + DeletionProtection: + description: The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. + type: boolean + GlobalClusterIdentifier: + description: The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string. + type: string + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + minLength: 1 + maxLength: 63 + SourceDBClusterIdentifier: + description: The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string. + type: string + oneOf: + - pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + - pattern: ^(?=.{40,128}$)arn.* + StorageEncrypted: + description: |2- + The storage encryption setting for the new global database cluster. + If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. + type: boolean + GlobalEndpoint: + $ref: '#/components/schemas/GlobalEndpoint' + x-stackQL-stringOnly: true + x-title: CreateGlobalClusterRequest + type: object + required: [] + CreateIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IntegrationName: + description: The name of the integration. + type: string + minLength: 1 + maxLength: 64 + Description: + type: string + description: A description of the integration. + minLength: 1 + maxLength: 1000 + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*. + items: + $ref: '#/components/schemas/Tag' + DataFilter: + type: string + description: Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. + minLength: 1 + maxLength: 25600 + pattern: '[a-zA-Z0-9_ "\\\-$,*.:?+\/]*' + SourceArn: + type: string + description: The Amazon Resource Name (ARN) of the database to use as the source for replication. + TargetArn: + type: string + description: The ARN of the Redshift data warehouse to use as the target for replication. + IntegrationArn: + type: string + description: '' + KMSKeyId: + type: string + description: The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key. + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + description: |- + An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see [Encryption context](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the *Key Management Service Developer Guide*. + You can only include this parameter if you specify the ``KMSKeyId`` parameter. + CreateTime: + type: string + description: '' + x-stackQL-stringOnly: true + x-title: CreateIntegrationRequest + type: object + required: [] + CreateOptionGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OptionGroupName: + description: |- + The name of the option group to be created. + Constraints: + + Must be 1 to 255 letters, numbers, or hyphens + + First character must be a letter + + Can't end with a hyphen or contain two consecutive hyphens + + Example: ``myoptiongroup`` + If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group. + This value is stored as a lowercase string. + type: string + OptionGroupDescription: + description: The description of the option group. + type: string + EngineName: + description: |- + Specifies the name of the engine that this option group should be associated with. + Valid Values: + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` + type: string + MajorEngineVersion: + description: Specifies the major version of the engine that this option group should be associated with. + type: string + OptionConfigurations: + description: A list of all available options for an option group. + type: array + x-arrayType: AttributeList + x-insertionOrder: false + items: + $ref: '#/components/schemas/OptionConfiguration' + Tags: + type: array + description: Tags to assign to the option group. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOptionGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: customdb_engine_versions: name: customdb_engine_versions id: awscc.rds.customdb_engine_versions x-cfn-schema-name: CustomDBEngineVersion - x-type: list - x-identifiers: - - Engine - - EngineVersion - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Engine') as engine, - JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'EngineVersion') as engine_version - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' - AND region = 'us-east-1' - customdb_engine_version: - name: customdb_engine_version - id: awscc.rds.customdb_engine_version - x-cfn-schema-name: CustomDBEngineVersion - x-type: get + x-cfn-type-name: AWS::RDS::CustomDBEngineVersion x-identifiers: - Engine - EngineVersion + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CustomDBEngineVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::CustomDBEngineVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::CustomDBEngineVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::CustomDBEngineVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2216,13 +5934,16 @@ components: JSON_EXTRACT(Properties, '$.KMSKeyId') as kms_key_id, JSON_EXTRACT(Properties, '$.Manifest') as manifest, JSON_EXTRACT(Properties, '$.DBEngineVersionArn') as db_engine_version_arn, + JSON_EXTRACT(Properties, '$.SourceCustomDbEngineVersionIdentifier') as source_custom_db_engine_version_identifier, + JSON_EXTRACT(Properties, '$.UseAwsProvidedLatestImage') as use_aws_provided_latest_image, + JSON_EXTRACT(Properties, '$.ImageId') as image_id, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2235,18 +5956,28 @@ components: json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, json_extract_path_text(Properties, 'Manifest') as manifest, json_extract_path_text(Properties, 'DBEngineVersionArn') as db_engine_version_arn, + json_extract_path_text(Properties, 'SourceCustomDbEngineVersionIdentifier') as source_custom_db_engine_version_identifier, + json_extract_path_text(Properties, 'UseAwsProvidedLatestImage') as use_aws_provided_latest_image, + json_extract_path_text(Properties, 'ImageId') as image_id, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' AND data__Identifier = '|' AND region = 'us-east-1' - db_clusters: - name: db_clusters - id: awscc.rds.db_clusters - x-cfn-schema-name: DBCluster - x-type: list + customdb_engine_versions_list_only: + name: customdb_engine_versions_list_only + id: awscc.rds.customdb_engine_versions_list_only + x-cfn-schema-name: CustomDBEngineVersion + x-cfn-type-name: AWS::RDS::CustomDBEngineVersion x-identifiers: - - DBClusterIdentifier + - Engine + - EngineVersion + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2254,28 +5985,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' + JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineVersion') as engine_version + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' AND region = 'us-east-1' - db_cluster: - name: db_cluster - id: awscc.rds.db_cluster + db_clusters: + name: db_clusters + id: awscc.rds.db_clusters x-cfn-schema-name: DBCluster - x-type: get + x-cfn-type-name: AWS::RDS::DBCluster x-identifiers: - DBClusterIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2288,7 +6069,9 @@ components: JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, JSON_EXTRACT(Properties, '$.BacktrackWindow') as backtrack_window, JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, + JSON_EXTRACT(Properties, '$.ClusterScalabilityType') as cluster_scalability_type, JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, + JSON_EXTRACT(Properties, '$.DatabaseInsightsMode') as database_insights_mode, JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, JSON_EXTRACT(Properties, '$.DBClusterArn') as db_cluster_arn, JSON_EXTRACT(Properties, '$.DBClusterInstanceClass') as db_cluster_instance_class, @@ -2299,6 +6082,7 @@ components: JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name, JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, + JSON_EXTRACT(Properties, '$.DeleteAutomatedBackups') as delete_automated_backups, JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, JSON_EXTRACT(Properties, '$.Domain') as domain, JSON_EXTRACT(Properties, '$.DomainIAMRoleName') as domain_iam_role_name, @@ -2306,7 +6090,9 @@ components: JSON_EXTRACT(Properties, '$.EnableGlobalWriteForwarding') as enable_global_write_forwarding, JSON_EXTRACT(Properties, '$.EnableHttpEndpoint') as enable_http_endpoint, JSON_EXTRACT(Properties, '$.EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + JSON_EXTRACT(Properties, '$.EnableLocalWriteForwarding') as enable_local_write_forwarding, JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.EngineLifecycleSupport') as engine_lifecycle_support, JSON_EXTRACT(Properties, '$.EngineMode') as engine_mode, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, JSON_EXTRACT(Properties, '$.ManageMasterUserPassword') as manage_master_user_password, @@ -2332,8 +6118,10 @@ components: JSON_EXTRACT(Properties, '$.ScalingConfiguration') as scaling_configuration, JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, + JSON_EXTRACT(Properties, '$.SourceDbClusterResourceId') as source_db_cluster_resource_id, JSON_EXTRACT(Properties, '$.SourceRegion') as source_region, JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, + JSON_EXTRACT(Properties, '$.StorageThroughput') as storage_throughput, JSON_EXTRACT(Properties, '$.StorageType') as storage_type, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.UseLatestRestorableTime') as use_latest_restorable_time, @@ -2342,7 +6130,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2355,7 +6143,9 @@ components: json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, json_extract_path_text(Properties, 'BacktrackWindow') as backtrack_window, json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'ClusterScalabilityType') as cluster_scalability_type, json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, + json_extract_path_text(Properties, 'DatabaseInsightsMode') as database_insights_mode, json_extract_path_text(Properties, 'DatabaseName') as database_name, json_extract_path_text(Properties, 'DBClusterArn') as db_cluster_arn, json_extract_path_text(Properties, 'DBClusterInstanceClass') as db_cluster_instance_class, @@ -2366,6 +6156,7 @@ components: json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'DeleteAutomatedBackups') as delete_automated_backups, json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, json_extract_path_text(Properties, 'Domain') as domain, json_extract_path_text(Properties, 'DomainIAMRoleName') as domain_iam_role_name, @@ -2373,7 +6164,9 @@ components: json_extract_path_text(Properties, 'EnableGlobalWriteForwarding') as enable_global_write_forwarding, json_extract_path_text(Properties, 'EnableHttpEndpoint') as enable_http_endpoint, json_extract_path_text(Properties, 'EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + json_extract_path_text(Properties, 'EnableLocalWriteForwarding') as enable_local_write_forwarding, json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineLifecycleSupport') as engine_lifecycle_support, json_extract_path_text(Properties, 'EngineMode') as engine_mode, json_extract_path_text(Properties, 'EngineVersion') as engine_version, json_extract_path_text(Properties, 'ManageMasterUserPassword') as manage_master_user_password, @@ -2399,8 +6192,10 @@ components: json_extract_path_text(Properties, 'ScalingConfiguration') as scaling_configuration, json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, + json_extract_path_text(Properties, 'SourceDbClusterResourceId') as source_db_cluster_resource_id, json_extract_path_text(Properties, 'SourceRegion') as source_region, json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, + json_extract_path_text(Properties, 'StorageThroughput') as storage_throughput, json_extract_path_text(Properties, 'StorageType') as storage_type, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, @@ -2408,13 +6203,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBCluster' AND data__Identifier = '' AND region = 'us-east-1' - db_cluster_parameter_groups: - name: db_cluster_parameter_groups - id: awscc.rds.db_cluster_parameter_groups - x-cfn-schema-name: DBClusterParameterGroup - x-type: list + db_clusters_list_only: + name: db_clusters_list_only + id: awscc.rds.db_clusters_list_only + x-cfn-schema-name: DBCluster + x-cfn-type-name: AWS::RDS::DBCluster x-identifiers: - - DBClusterParameterGroupName + - DBClusterIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2422,28 +6223,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' AND region = 'us-east-1' - db_cluster_parameter_group: - name: db_cluster_parameter_group - id: awscc.rds.db_cluster_parameter_group + db_cluster_parameter_groups: + name: db_cluster_parameter_groups + id: awscc.rds.db_cluster_parameter_groups x-cfn-schema-name: DBClusterParameterGroup - x-type: get + x-cfn-type-name: AWS::RDS::DBClusterParameterGroup x-identifiers: - DBClusterParameterGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBClusterParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2457,7 +6306,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2470,13 +6319,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' AND data__Identifier = '' AND region = 'us-east-1' - db_instances: - name: db_instances - id: awscc.rds.db_instances - x-cfn-schema-name: DBInstance - x-type: list + db_cluster_parameter_groups_list_only: + name: db_cluster_parameter_groups_list_only + id: awscc.rds.db_cluster_parameter_groups_list_only + x-cfn-schema-name: DBClusterParameterGroup + x-cfn-type-name: AWS::RDS::DBClusterParameterGroup x-identifiers: - - DBInstanceIdentifier + - DBClusterParameterGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2484,28 +6339,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' + JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' + json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' AND region = 'us-east-1' - db_instance: - name: db_instance - id: awscc.rds.db_instance - x-cfn-schema-name: DBInstance - x-type: get + db_instances: + name: db_instances + id: awscc.rds.db_instances + x-cfn-schema-name: DBInstance + x-cfn-type-name: AWS::RDS::DBInstance x-identifiers: - DBInstanceIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2515,19 +6418,25 @@ components: JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, JSON_EXTRACT(Properties, '$.AutomaticBackupReplicationRegion') as automatic_backup_replication_region, + JSON_EXTRACT(Properties, '$.AutomaticBackupReplicationKmsKeyId') as automatic_backup_replication_kms_key_id, + JSON_EXTRACT(Properties, '$.AutomaticBackupReplicationRetentionPeriod') as automatic_backup_replication_retention_period, + JSON_EXTRACT(Properties, '$.AutomaticRestartTime') as automatic_restart_time, JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, + JSON_EXTRACT(Properties, '$.BackupTarget') as backup_target, JSON_EXTRACT(Properties, '$.CACertificateIdentifier') as ca_certificate_identifier, JSON_EXTRACT(Properties, '$.CertificateDetails') as certificate_details, JSON_EXTRACT(Properties, '$.CertificateRotationRestart') as certificate_rotation_restart, JSON_EXTRACT(Properties, '$.CharacterSetName') as character_set_name, JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, JSON_EXTRACT(Properties, '$.CustomIAMInstanceProfile') as custom_iam_instance_profile, + JSON_EXTRACT(Properties, '$.DatabaseInsightsMode') as database_insights_mode, JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, JSON_EXTRACT(Properties, '$.DBClusterSnapshotIdentifier') as db_cluster_snapshot_identifier, JSON_EXTRACT(Properties, '$.DBInstanceArn') as db_instance_arn, JSON_EXTRACT(Properties, '$.DBInstanceClass') as db_instance_class, JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier, + JSON_EXTRACT(Properties, '$.DBInstanceStatus') as db_instance_status, JSON_EXTRACT(Properties, '$.DbiResourceId') as dbi_resource_id, JSON_EXTRACT(Properties, '$.DBName') as db_name, JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name, @@ -2549,11 +6458,16 @@ components: JSON_EXTRACT(Properties, '$.EnablePerformanceInsights') as enable_performance_insights, JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.EngineLifecycleSupport') as engine_lifecycle_support, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, JSON_EXTRACT(Properties, '$.ManageMasterUserPassword') as manage_master_user_password, + JSON_EXTRACT(Properties, '$.InstanceCreateTime') as instance_create_time, JSON_EXTRACT(Properties, '$.Iops') as iops, + JSON_EXTRACT(Properties, '$.IsStorageConfigUpgradeAvailable') as is_storage_config_upgrade_available, JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.LatestRestorableTime') as latest_restorable_time, JSON_EXTRACT(Properties, '$.LicenseModel') as license_model, + JSON_EXTRACT(Properties, '$.ListenerEndpoint') as listener_endpoint, JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, JSON_EXTRACT(Properties, '$.MasterUserSecret') as master_user_secret, @@ -2564,6 +6478,7 @@ components: JSON_EXTRACT(Properties, '$.NcharCharacterSetName') as nchar_character_set_name, JSON_EXTRACT(Properties, '$.NetworkType') as network_type, JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name, + JSON_EXTRACT(Properties, '$.PercentProgress') as percent_progress, JSON_EXTRACT(Properties, '$.PerformanceInsightsKMSKeyId') as performance_insights_kms_key_id, JSON_EXTRACT(Properties, '$.PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, JSON_EXTRACT(Properties, '$.Port') as port, @@ -2572,13 +6487,18 @@ components: JSON_EXTRACT(Properties, '$.ProcessorFeatures') as processor_features, JSON_EXTRACT(Properties, '$.PromotionTier') as promotion_tier, JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, + JSON_EXTRACT(Properties, '$.ReadReplicaDBClusterIdentifiers') as read_replica_db_cluster_identifiers, + JSON_EXTRACT(Properties, '$.ReadReplicaDBInstanceIdentifiers') as read_replica_db_instance_identifiers, JSON_EXTRACT(Properties, '$.ReplicaMode') as replica_mode, JSON_EXTRACT(Properties, '$.RestoreTime') as restore_time, + JSON_EXTRACT(Properties, '$.ResumeFullAutomationModeTime') as resume_full_automation_mode_time, + JSON_EXTRACT(Properties, '$.SecondaryAvailabilityZone') as secondary_availability_zone, JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, JSON_EXTRACT(Properties, '$.SourceDbiResourceId') as source_dbi_resource_id, JSON_EXTRACT(Properties, '$.SourceDBInstanceAutomatedBackupsArn') as source_db_instance_automated_backups_arn, JSON_EXTRACT(Properties, '$.SourceDBInstanceIdentifier') as source_db_instance_identifier, JSON_EXTRACT(Properties, '$.SourceRegion') as source_region, + JSON_EXTRACT(Properties, '$.StatusInfos') as status_infos, JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, JSON_EXTRACT(Properties, '$.StorageType') as storage_type, JSON_EXTRACT(Properties, '$.StorageThroughput') as storage_throughput, @@ -2588,12 +6508,13 @@ components: JSON_EXTRACT(Properties, '$.Timezone') as timezone, JSON_EXTRACT(Properties, '$.UseDefaultProcessorFeatures') as use_default_processor_features, JSON_EXTRACT(Properties, '$.UseLatestRestorableTime') as use_latest_restorable_time, - JSON_EXTRACT(Properties, '$.VPCSecurityGroups') as vpc_security_groups + JSON_EXTRACT(Properties, '$.VPCSecurityGroups') as vpc_security_groups, + JSON_EXTRACT(Properties, '$.ApplyImmediately') as apply_immediately FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBInstance' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2603,19 +6524,25 @@ components: json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, json_extract_path_text(Properties, 'AutomaticBackupReplicationRegion') as automatic_backup_replication_region, + json_extract_path_text(Properties, 'AutomaticBackupReplicationKmsKeyId') as automatic_backup_replication_kms_key_id, + json_extract_path_text(Properties, 'AutomaticBackupReplicationRetentionPeriod') as automatic_backup_replication_retention_period, + json_extract_path_text(Properties, 'AutomaticRestartTime') as automatic_restart_time, json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'BackupTarget') as backup_target, json_extract_path_text(Properties, 'CACertificateIdentifier') as ca_certificate_identifier, json_extract_path_text(Properties, 'CertificateDetails') as certificate_details, json_extract_path_text(Properties, 'CertificateRotationRestart') as certificate_rotation_restart, json_extract_path_text(Properties, 'CharacterSetName') as character_set_name, json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, json_extract_path_text(Properties, 'CustomIAMInstanceProfile') as custom_iam_instance_profile, + json_extract_path_text(Properties, 'DatabaseInsightsMode') as database_insights_mode, json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, json_extract_path_text(Properties, 'DBClusterSnapshotIdentifier') as db_cluster_snapshot_identifier, json_extract_path_text(Properties, 'DBInstanceArn') as db_instance_arn, json_extract_path_text(Properties, 'DBInstanceClass') as db_instance_class, json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier, + json_extract_path_text(Properties, 'DBInstanceStatus') as db_instance_status, json_extract_path_text(Properties, 'DbiResourceId') as dbi_resource_id, json_extract_path_text(Properties, 'DBName') as db_name, json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name, @@ -2637,11 +6564,16 @@ components: json_extract_path_text(Properties, 'EnablePerformanceInsights') as enable_performance_insights, json_extract_path_text(Properties, 'Endpoint') as endpoint, json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineLifecycleSupport') as engine_lifecycle_support, json_extract_path_text(Properties, 'EngineVersion') as engine_version, json_extract_path_text(Properties, 'ManageMasterUserPassword') as manage_master_user_password, + json_extract_path_text(Properties, 'InstanceCreateTime') as instance_create_time, json_extract_path_text(Properties, 'Iops') as iops, + json_extract_path_text(Properties, 'IsStorageConfigUpgradeAvailable') as is_storage_config_upgrade_available, json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'LatestRestorableTime') as latest_restorable_time, json_extract_path_text(Properties, 'LicenseModel') as license_model, + json_extract_path_text(Properties, 'ListenerEndpoint') as listener_endpoint, json_extract_path_text(Properties, 'MasterUsername') as master_username, json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, json_extract_path_text(Properties, 'MasterUserSecret') as master_user_secret, @@ -2652,6 +6584,7 @@ components: json_extract_path_text(Properties, 'NcharCharacterSetName') as nchar_character_set_name, json_extract_path_text(Properties, 'NetworkType') as network_type, json_extract_path_text(Properties, 'OptionGroupName') as option_group_name, + json_extract_path_text(Properties, 'PercentProgress') as percent_progress, json_extract_path_text(Properties, 'PerformanceInsightsKMSKeyId') as performance_insights_kms_key_id, json_extract_path_text(Properties, 'PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, json_extract_path_text(Properties, 'Port') as port, @@ -2660,13 +6593,18 @@ components: json_extract_path_text(Properties, 'ProcessorFeatures') as processor_features, json_extract_path_text(Properties, 'PromotionTier') as promotion_tier, json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'ReadReplicaDBClusterIdentifiers') as read_replica_db_cluster_identifiers, + json_extract_path_text(Properties, 'ReadReplicaDBInstanceIdentifiers') as read_replica_db_instance_identifiers, json_extract_path_text(Properties, 'ReplicaMode') as replica_mode, json_extract_path_text(Properties, 'RestoreTime') as restore_time, + json_extract_path_text(Properties, 'ResumeFullAutomationModeTime') as resume_full_automation_mode_time, + json_extract_path_text(Properties, 'SecondaryAvailabilityZone') as secondary_availability_zone, json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, json_extract_path_text(Properties, 'SourceDbiResourceId') as source_dbi_resource_id, json_extract_path_text(Properties, 'SourceDBInstanceAutomatedBackupsArn') as source_db_instance_automated_backups_arn, json_extract_path_text(Properties, 'SourceDBInstanceIdentifier') as source_db_instance_identifier, json_extract_path_text(Properties, 'SourceRegion') as source_region, + json_extract_path_text(Properties, 'StatusInfos') as status_infos, json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, json_extract_path_text(Properties, 'StorageType') as storage_type, json_extract_path_text(Properties, 'StorageThroughput') as storage_throughput, @@ -2676,17 +6614,24 @@ components: json_extract_path_text(Properties, 'Timezone') as timezone, json_extract_path_text(Properties, 'UseDefaultProcessorFeatures') as use_default_processor_features, json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, - json_extract_path_text(Properties, 'VPCSecurityGroups') as vpc_security_groups + json_extract_path_text(Properties, 'VPCSecurityGroups') as vpc_security_groups, + json_extract_path_text(Properties, 'ApplyImmediately') as apply_immediately FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBInstance' AND data__Identifier = '' AND region = 'us-east-1' - db_parameter_groups: - name: db_parameter_groups - id: awscc.rds.db_parameter_groups - x-cfn-schema-name: DBParameterGroup - x-type: list + db_instances_list_only: + name: db_instances_list_only + id: awscc.rds.db_instances_list_only + x-cfn-schema-name: DBInstance + x-cfn-type-name: AWS::RDS::DBInstance x-identifiers: - - DBParameterGroupName + - DBInstanceIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2694,28 +6639,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' + JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' + json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' AND region = 'us-east-1' - db_parameter_group: - name: db_parameter_group - id: awscc.rds.db_parameter_group + db_parameter_groups: + name: db_parameter_groups + id: awscc.rds.db_parameter_groups x-cfn-schema-name: DBParameterGroup - x-type: get + x-cfn-type-name: AWS::RDS::DBParameterGroup x-identifiers: - DBParameterGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2729,7 +6722,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2742,13 +6735,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' AND data__Identifier = '' AND region = 'us-east-1' - db_proxies: - name: db_proxies - id: awscc.rds.db_proxies - x-cfn-schema-name: DBProxy - x-type: list + db_parameter_groups_list_only: + name: db_parameter_groups_list_only + id: awscc.rds.db_parameter_groups_list_only + x-cfn-schema-name: DBParameterGroup + x-cfn-type-name: AWS::RDS::DBParameterGroup x-identifiers: - - DBProxyName + - DBParameterGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2756,28 +6755,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBProxyName') as db_proxy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' + JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' + json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' AND region = 'us-east-1' - db_proxy: - name: db_proxy - id: awscc.rds.db_proxy + db_proxies: + name: db_proxies + id: awscc.rds.db_proxies x-cfn-schema-name: DBProxy - x-type: get + x-cfn-type-name: AWS::RDS::DBProxy x-identifiers: - DBProxyName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBProxy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_proxies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_proxies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_proxies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2799,7 +6846,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2820,13 +6867,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxy' AND data__Identifier = '' AND region = 'us-east-1' - db_proxy_endpoints: - name: db_proxy_endpoints - id: awscc.rds.db_proxy_endpoints - x-cfn-schema-name: DBProxyEndpoint - x-type: list + db_proxies_list_only: + name: db_proxies_list_only + id: awscc.rds.db_proxies_list_only + x-cfn-schema-name: DBProxy + x-cfn-type-name: AWS::RDS::DBProxy x-identifiers: - - DBProxyEndpointName + - DBProxyName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2834,28 +6887,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBProxyEndpointName') as db_proxy_endpoint_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' + JSON_EXTRACT(Properties, '$.DBProxyName') as db_proxy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBProxyEndpointName') as db_proxy_endpoint_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' + json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' AND region = 'us-east-1' - db_proxy_endpoint: - name: db_proxy_endpoint - id: awscc.rds.db_proxy_endpoint + db_proxy_endpoints: + name: db_proxy_endpoints + id: awscc.rds.db_proxy_endpoints x-cfn-schema-name: DBProxyEndpoint - x-type: get + x-cfn-type-name: AWS::RDS::DBProxyEndpoint x-identifiers: - DBProxyEndpointName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBProxyEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxyEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxyEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxyEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2874,7 +6975,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2892,13 +6993,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' AND data__Identifier = '' AND region = 'us-east-1' - db_proxy_target_groups: - name: db_proxy_target_groups - id: awscc.rds.db_proxy_target_groups - x-cfn-schema-name: DBProxyTargetGroup - x-type: list + db_proxy_endpoints_list_only: + name: db_proxy_endpoints_list_only + id: awscc.rds.db_proxy_endpoints_list_only + x-cfn-schema-name: DBProxyEndpoint + x-cfn-type-name: AWS::RDS::DBProxyEndpoint x-identifiers: - - TargetGroupArn + - DBProxyEndpointName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2906,28 +7013,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' + JSON_EXTRACT(Properties, '$.DBProxyEndpointName') as db_proxy_endpoint_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' + json_extract_path_text(Properties, 'DBProxyEndpointName') as db_proxy_endpoint_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' AND region = 'us-east-1' - db_proxy_target_group: - name: db_proxy_target_group - id: awscc.rds.db_proxy_target_group + db_proxy_target_groups: + name: db_proxy_target_groups + id: awscc.rds.db_proxy_target_groups x-cfn-schema-name: DBProxyTargetGroup - x-type: get + x-cfn-type-name: AWS::RDS::DBProxyTargetGroup x-identifiers: - TargetGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBProxyTargetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxyTargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxyTargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBProxyTargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2942,7 +7097,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2956,13 +7111,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' AND data__Identifier = '' AND region = 'us-east-1' - db_subnet_groups: - name: db_subnet_groups - id: awscc.rds.db_subnet_groups - x-cfn-schema-name: DBSubnetGroup - x-type: list + db_proxy_target_groups_list_only: + name: db_proxy_target_groups_list_only + id: awscc.rds.db_proxy_target_groups_list_only + x-cfn-schema-name: DBProxyTargetGroup + x-cfn-type-name: AWS::RDS::DBProxyTargetGroup x-identifiers: - - DBSubnetGroupName + - TargetGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2970,28 +7131,200 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' + JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' AND region = 'us-east-1' - db_subnet_group: - name: db_subnet_group - id: awscc.rds.db_subnet_group + db_shard_groups: + name: db_shard_groups + id: awscc.rds.db_shard_groups + x-cfn-schema-name: DBShardGroup + x-cfn-type-name: AWS::RDS::DBShardGroup + x-identifiers: + - DBShardGroupIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBShardGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBShardGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBShardGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBShardGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_shard_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_shard_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_shard_groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DBShardGroupResourceId') as db_shard_group_resource_id, + JSON_EXTRACT(Properties, '$.DBShardGroupIdentifier') as db_shard_group_identifier, + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, + JSON_EXTRACT(Properties, '$.ComputeRedundancy') as compute_redundancy, + JSON_EXTRACT(Properties, '$.MaxACU') as max_ac_u, + JSON_EXTRACT(Properties, '$.MinACU') as min_ac_u, + JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBShardGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DBShardGroupResourceId') as db_shard_group_resource_id, + json_extract_path_text(Properties, 'DBShardGroupIdentifier') as db_shard_group_identifier, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, + json_extract_path_text(Properties, 'ComputeRedundancy') as compute_redundancy, + json_extract_path_text(Properties, 'MaxACU') as max_ac_u, + json_extract_path_text(Properties, 'MinACU') as min_ac_u, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBShardGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + db_shard_groups_list_only: + name: db_shard_groups_list_only + id: awscc.rds.db_shard_groups_list_only + x-cfn-schema-name: DBShardGroup + x-cfn-type-name: AWS::RDS::DBShardGroup + x-identifiers: + - DBShardGroupIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DBShardGroupIdentifier') as db_shard_group_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBShardGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBShardGroupIdentifier') as db_shard_group_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBShardGroup' + AND region = 'us-east-1' + db_subnet_groups: + name: db_subnet_groups + id: awscc.rds.db_subnet_groups x-cfn-schema-name: DBSubnetGroup - x-type: get + x-cfn-type-name: AWS::RDS::DBSubnetGroup x-identifiers: - DBSubnetGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBSubnetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3004,7 +7337,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3016,13 +7349,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' AND data__Identifier = '' AND region = 'us-east-1' - event_subscriptions: - name: event_subscriptions - id: awscc.rds.event_subscriptions - x-cfn-schema-name: EventSubscription - x-type: list + db_subnet_groups_list_only: + name: db_subnet_groups_list_only + id: awscc.rds.db_subnet_groups_list_only + x-cfn-schema-name: DBSubnetGroup + x-cfn-type-name: AWS::RDS::DBSubnetGroup x-identifiers: - - SubscriptionName + - DBSubnetGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3030,28 +7369,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' AND region = 'us-east-1' - event_subscription: - name: event_subscription - id: awscc.rds.event_subscription + event_subscriptions: + name: event_subscriptions + id: awscc.rds.event_subscriptions x-cfn-schema-name: EventSubscription - x-type: get + x-cfn-type-name: AWS::RDS::EventSubscription x-identifiers: - SubscriptionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::EventSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::EventSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::EventSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3067,7 +7454,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3082,13 +7469,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::EventSubscription' AND data__Identifier = '' AND region = 'us-east-1' - global_clusters: - name: global_clusters - id: awscc.rds.global_clusters - x-cfn-schema-name: GlobalCluster - x-type: list + event_subscriptions_list_only: + name: event_subscriptions_list_only + id: awscc.rds.event_subscriptions_list_only + x-cfn-schema-name: EventSubscription + x-cfn-type-name: AWS::RDS::EventSubscription x-identifiers: - - GlobalClusterIdentifier + - SubscriptionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3096,63 +7489,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' + JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' AND region = 'us-east-1' - global_cluster: - name: global_cluster - id: awscc.rds.global_cluster + global_clusters: + name: global_clusters + id: awscc.rds.global_clusters x-cfn-schema-name: GlobalCluster - x-type: get + x-cfn-type-name: AWS::RDS::GlobalCluster x-identifiers: - GlobalClusterIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GlobalCluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::GlobalCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::GlobalCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::GlobalCluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/global_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.EngineLifecycleSupport') as engine_lifecycle_support, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier, JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, - JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted + JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, + JSON_EXTRACT(Properties, '$.GlobalEndpoint') as global_endpoint FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::GlobalCluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EngineLifecycleSupport') as engine_lifecycle_support, json_extract_path_text(Properties, 'EngineVersion') as engine_version, json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier, json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, - json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted + json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, + json_extract_path_text(Properties, 'GlobalEndpoint') as global_endpoint FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::GlobalCluster' AND data__Identifier = '' AND region = 'us-east-1' - integrations: - name: integrations - id: awscc.rds.integrations - x-cfn-schema-name: Integration - x-type: list + global_clusters_list_only: + name: global_clusters_list_only + id: awscc.rds.global_clusters_list_only + x-cfn-schema-name: GlobalCluster + x-cfn-type-name: AWS::RDS::GlobalCluster x-identifiers: - - IntegrationArn + - GlobalClusterIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3160,34 +7613,84 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' + JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IntegrationArn') as integration_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' + json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' AND region = 'us-east-1' - integration: - name: integration - id: awscc.rds.integration + integrations: + name: integrations + id: awscc.rds.integrations x-cfn-schema-name: Integration - x-type: get + x-cfn-type-name: AWS::RDS::Integration x-identifiers: - IntegrationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.IntegrationName') as integration_name, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.DataFilter') as data_filter, JSON_EXTRACT(Properties, '$.SourceArn') as source_arn, JSON_EXTRACT(Properties, '$.TargetArn') as target_arn, JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn, @@ -3198,13 +7701,15 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'IntegrationName') as integration_name, + json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DataFilter') as data_filter, json_extract_path_text(Properties, 'SourceArn') as source_arn, json_extract_path_text(Properties, 'TargetArn') as target_arn, json_extract_path_text(Properties, 'IntegrationArn') as integration_arn, @@ -3214,13 +7719,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::Integration' AND data__Identifier = '' AND region = 'us-east-1' - option_groups: - name: option_groups - id: awscc.rds.option_groups - x-cfn-schema-name: OptionGroup - x-type: list + integrations_list_only: + name: integrations_list_only + id: awscc.rds.integrations_list_only + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::RDS::Integration x-identifiers: - - OptionGroupName + - IntegrationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -3228,28 +7739,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' + JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'OptionGroupName') as option_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' AND region = 'us-east-1' - option_group: - name: option_group - id: awscc.rds.option_group + option_groups: + name: option_groups + id: awscc.rds.option_groups x-cfn-schema-name: OptionGroup - x-type: get + x-cfn-type-name: AWS::RDS::OptionGroup x-identifiers: - OptionGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OptionGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::OptionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::OptionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::OptionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/option_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/option_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/option_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3264,7 +7823,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3278,3 +7837,775 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::OptionGroup' AND data__Identifier = '' AND region = 'us-east-1' + option_groups_list_only: + name: option_groups_list_only + id: awscc.rds.option_groups_list_only + x-cfn-schema-name: OptionGroup + x-cfn-type-name: AWS::RDS::OptionGroup + x-identifiers: + - OptionGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OptionGroupName') as option_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CustomDBEngineVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCustomDBEngineVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCustomDBEngineVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBClusterParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBClusterParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBClusterParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBProxy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBProxy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBProxyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBProxyEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBProxyEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBProxyEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBProxyTargetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBProxyTargetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBProxyTargetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBShardGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBShardGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBShardGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DBSubnetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDBSubnetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDBSubnetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GlobalCluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGlobalCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGlobalClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OptionGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOptionGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOptionGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/redshift.yaml b/providers/src/awscc/v00.00.00000/services/redshift.yaml index 4a853a72..29f31a3c 100644 --- a/providers/src/awscc/v00.00.00000/services/redshift.yaml +++ b/providers/src/awscc/v00.00.00000/services/redshift.yaml @@ -1,171 +1,550 @@ openapi: 3.0.0 info: title: Redshift - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - Tag: - description: A key-value pair to associate with a resource. + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object + CancelResourceRequestOutput: properties: - Key: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 1 - maxLength: 128 - Value: + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 0 - maxLength: 256 required: - - Key - - Value - additionalProperties: false - LoggingProperties: + - DesiredState + title: CreateResourceInput type: object - additionalProperties: false + CreateResourceOutput: properties: - BucketName: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: type: string - S3KeyPrefix: + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: type: string - Endpoint: + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput type: object - additionalProperties: false + DeleteResourceOutput: properties: - Port: - type: string - Address: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: type: string - Cluster: type: object + GetResourceRequestStatusInput: properties: - ClusterIdentifier: - description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: type: string - maxLength: 63 - ClusterNamespaceArn: - description: The Amazon Resource Name (ARN) of the cluster namespace. + EventTime: + type: number + Identifier: type: string - MasterUsername: - description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. + Operation: type: string - maxLength: 128 - MasterUserPassword: - description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. + OperationStatus: type: string - maxLength: 64 - NodeType: - description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge' + RequestToken: type: string - AllowVersionUpgrade: - description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True - type: boolean - AutomatedSnapshotRetentionPeriod: - description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 - type: integer - AvailabilityZone: - description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' + ResourceModel: type: string - ClusterParameterGroupName: - description: The name of the parameter group to be associated with this cluster. + RetryAfter: + type: number + StatusMessage: type: string - maxLength: 255 - ClusterType: - description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required + TypeName: type: string - ClusterVersion: - description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: type: string - ClusterSubnetGroupName: - description: The name of a cluster subnet group to be associated with this cluster. + Properties: type: string - DBName: - description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Endpoint: + additionalProperties: false + type: object + properties: + Address: type: string - ElasticIp: - description: The Elastic IP (EIP) address for the cluster. + Port: type: string - Encrypted: - description: If true, the data in the cluster is encrypted at rest. - type: boolean - HsmClientCertificateIdentifier: - description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM + LoggingProperties: + additionalProperties: false + type: object + properties: + BucketName: type: string - HsmConfigurationIdentifier: - description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + S3KeyPrefix: type: string - KmsKeyId: - description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + LogDestinationType: type: string - NumberOfNodes: - description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. + LogExports: + maxItems: 3 + x-insertionOrder: false + type: array + items: + type: string + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ' + minLength: 0 + maxLength: 256 + required: + - Key + Cluster: + type: object + properties: + RevisionTarget: + description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. + type: string + AutomatedSnapshotRetentionPeriod: + description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 type: integer + Encrypted: + description: If true, the data in the cluster is encrypted at rest. + type: boolean Port: description: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings type: integer - PreferredMaintenanceWindow: - description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + NumberOfNodes: + description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. + type: integer + DestinationRegion: + description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' type: string - PubliclyAccessible: - description: If true, the cluster can be accessed from a public network. + AllowVersionUpgrade: + description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True type: boolean - ClusterSecurityGroups: - description: A list of security groups to be associated with this cluster. - type: array - x-insertionOrder: false + Endpoint: + $ref: '#/components/schemas/Endpoint' + NamespaceResourcePolicy: + description: The namespace resource policy document that will be attached to a Redshift cluster. + type: object + MaintenanceTrackName: + description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. + type: string + OwnerAccount: + type: string + MultiAZ: + description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. + type: boolean + Tags: + maxItems: 50 uniqueItems: false + description: The list of tags for the cluster parameter group. + x-insertionOrder: false + type: array items: - type: string + $ref: '#/components/schemas/Tag' + SnapshotClusterIdentifier: + description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + type: string IamRoles: + maxItems: 50 description: A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request - type: array x-insertionOrder: false - maxItems: 50 + type: array items: + relationshipRef: + typeName: AWS::IAM::Role + propertyPath: /properties/Arn type: string - Tags: - description: The list of tags for the cluster parameter group. - type: array - x-insertionOrder: false - maxItems: 50 + KmsKeyId: + description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + SnapshotCopyManual: + description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. + type: boolean + ManageMasterPassword: + description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + type: boolean + AvailabilityZone: + description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' + type: string + ClusterSecurityGroups: uniqueItems: false - items: - $ref: '#/components/schemas/Tag' - VpcSecurityGroupIds: - description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. - type: array + description: A list of security groups to be associated with this cluster. x-insertionOrder: false - uniqueItems: false + type: array items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::Redshift::ClusterSecurityGroup + propertyPath: /properties/Id type: string - SnapshotClusterIdentifier: - description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account type: string - SnapshotIdentifier: - description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + maxLength: 63 + MasterUserPassword: + description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. type: string - OwnerAccount: + maxLength: 64 + ClusterSubnetGroupName: + description: The name of a cluster subnet group to be associated with this cluster. type: string LoggingProperties: $ref: '#/components/schemas/LoggingProperties' - Endpoint: - $ref: '#/components/schemas/Endpoint' - DestinationRegion: - description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' + DeferMaintenance: + description: A boolean indicating whether to enable the deferred maintenance window. + type: boolean + NodeType: + description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.large | ra3.4xlarge | ra3.16xlarge' type: string - SnapshotCopyRetentionPeriod: - description: |- - The number of days to retain automated snapshots in the destination region after they are copied from the source region. - - Default is 7. - - Constraints: Must be at least 1 and no more than 35. - type: integer - SnapshotCopyGrantName: - description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + MasterUsername: + description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. + type: string + maxLength: 128 + PubliclyAccessible: + description: If true, the cluster can be accessed from a public network. + type: boolean + DeferMaintenanceIdentifier: + description: A unique identifier for the deferred maintenance window. type: string ManualSnapshotRetentionPeriod: description: |- @@ -173,12 +552,15 @@ components: The value must be either -1 or an integer between 1 and 3,653. type: integer - SnapshotCopyManual: - description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. - type: boolean - AvailabilityZoneRelocation: - description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. - type: boolean + ResourceAction: + description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs + type: string + HsmClientCertificateIdentifier: + description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM + type: string + ElasticIp: + description: The Elastic IP (EIP) address for the cluster. + type: string AvailabilityZoneRelocationStatus: description: The availability zone relocation status of the cluster type: string @@ -190,66 +572,100 @@ components: disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA. type: string - Classic: - description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. + SnapshotIdentifier: + description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + type: string + AvailabilityZoneRelocation: + description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. type: boolean + SnapshotCopyGrantName: + description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + type: string EnhancedVpcRouting: description: |- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. - If this option is true , enhanced VPC routing is enabled. - - Default: false - type: boolean - MaintenanceTrackName: - description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. - type: string - DeferMaintenance: - description: A boolean indicating whether to enable the deferred maintenance window. - type: boolean - DeferMaintenanceIdentifier: - description: A unique identifier for the deferred maintenance window. - type: string - DeferMaintenanceStartTime: - description: A timestamp indicating the start time for the deferred maintenance window. + If this option is true , enhanced VPC routing is enabled. + + Default: false + type: boolean + ClusterParameterGroupName: + description: The name of the parameter group to be associated with this cluster. type: string + maxLength: 255 DeferMaintenanceEndTime: description: A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. type: string - DeferMaintenanceDuration: - description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. - type: integer - RevisionTarget: - description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. - type: string - ResourceAction: - description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs - type: string RotateEncryptionKey: description: A boolean indicating if we want to rotate Encryption Keys. type: boolean - MultiAZ: - description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. - type: boolean - NamespaceResourcePolicy: - description: The namespace resource policy document that will be attached to a Redshift cluster. - type: object - ManageMasterPassword: - description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + VpcSecurityGroupIds: + uniqueItems: false + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId + type: string + ClusterNamespaceArn: + description: The Amazon Resource Name (ARN) of the cluster namespace. + type: string + MasterPasswordSecretArn: + description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + type: string + ClusterVersion: + description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. + type: string + HsmConfigurationIdentifier: + description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + type: string + PreferredMaintenanceWindow: + description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + type: string + DeferMaintenanceStartTime: + description: A timestamp indicating the start time for the deferred maintenance window. + type: string + ClusterType: + description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required + type: string + Classic: + description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. type: boolean MasterPasswordSecretKmsKeyId: description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId type: string - MasterPasswordSecretArn: - description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + DeferMaintenanceDuration: + description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. + type: integer + DBName: + description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. type: string + SnapshotCopyRetentionPeriod: + description: |- + The number of days to retain automated snapshots in the destination region after they are copied from the source region. + + Default is 7. + + Constraints: Must be at least 1 and no more than 35. + type: integer required: - NodeType - MasterUsername - DBName - ClusterType x-stackql-resource-name: cluster - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::Redshift::Cluster + x-stackql-primary-identifier: - ClusterIdentifier x-create-only-properties: - ClusterIdentifier @@ -259,13 +675,34 @@ components: - SnapshotClusterIdentifier - ClusterSubnetGroupName - MasterUsername + x-write-only-properties: + - MasterUserPassword + - Classic + - SnapshotIdentifier + - DeferMaintenance + - DeferMaintenanceDuration + - ManageMasterPassword x-read-only-properties: - DeferMaintenanceIdentifier - Endpoint/Port - Endpoint/Address - ClusterNamespaceArn - MasterPasswordSecretArn + x-required-properties: + - NodeType + - MasterUsername + - DBName + - ClusterType + x-tagging: + taggable: true x-required-permissions: + read: + - redshift:DescribeClusters + - redshift:DescribeLoggingStatus + - redshift:DescribeSnapshotCopyGrant + - redshift:DescribeClusterDbRevisions + - redshift:DescribeTags + - redshift:GetResourcePolicy create: - iam:PassRole - iam:CreateServiceLinkedRole @@ -279,33 +716,22 @@ components: - redshift:GetResourcePolicy - redshift:PutResourcePolicy - redshift:ModifyClusterMaintenance - - ec2:DescribeVpcs - - ec2:DescribeSubnets - - ec2:DescribeNetworkInterfaces - - ec2:DescribeAddresses + - ec2:Describe* - ec2:AssociateAddress - ec2:CreateNetworkInterface - ec2:ModifyNetworkInterfaceAttribute - ec2:CreateVpcEndpoint - - ec2:DescribeVpcEndpoints - ec2:ModifyVpcEndpoint - ec2:AllocateAddress - ec2:CreateSecurityGroup - - ec2:DescribeVpcAttribute - - ec2:DescribeSecurityGroups - - ec2:DescribeInternetGateways - - ec2:DescribeSecurityGroupRules - - ec2:DescribeAvailabilityZones - - ec2:DescribeNetworkAcls - - ec2:DescribeRouteTables - cloudwatch:PutMetricData - read: - - redshift:DescribeClusters - - redshift:DescribeLoggingStatus - - redshift:DescribeSnapshotCopyGrant - - redshift:DescribeClusterDbRevisions - - redshift:DescribeTags - - redshift:GetResourcePolicy + - kms:GenerateDataKey + - kms:CreateGrant + - kms:DescribeKey + - kms:Encrypt + - kms:Decrypt + - secretsmanager:CreateSecret + - secretsmanager:TagResource update: - iam:PassRole - redshift:DescribeClusters @@ -334,13 +760,20 @@ components: - redshift:GetResourcePolicy - redshift:DeleteResourcePolicy - cloudwatch:PutMetricData - delete: + - kms:GenerateDataKey + - kms:CreateGrant + - kms:DescribeKey + - kms:Encrypt + - kms:Decrypt + - secretsmanager:CreateSecret + - secretsmanager:TagResource + list: - redshift:DescribeTags - redshift:DescribeClusters - - redshift:DeleteCluster - list: + delete: - redshift:DescribeTags - redshift:DescribeClusters + - redshift:DeleteCluster Parameter: type: object additionalProperties: false @@ -383,12 +816,27 @@ components: - Description - ParameterGroupFamily x-stackql-resource-name: cluster_parameter_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Redshift::ClusterParameterGroup + x-type-name: AWS::Redshift::ClusterParameterGroup + x-stackql-primary-identifier: - ParameterGroupName x-create-only-properties: - ParameterGroupName - ParameterGroupFamily - Description + x-required-properties: + - Description + - ParameterGroupFamily + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - redshift:DescribeTags + - redshift:CreateTags + - redshift:DeleteTags x-required-permissions: create: - redshift:CreateClusterParameterGroup @@ -423,6 +871,7 @@ components: - initech:UpdateReport delete: - redshift:DescribeTags + - redshift:DeleteTags - redshift:DescribeClusterParameterGroups - redshift:DeleteClusterParameterGroup - redshift:DescribeClusterParameters @@ -445,6 +894,9 @@ components: maxItems: 20 items: type: string + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId Tags: description: The list of tags for the cluster parameter group. type: array @@ -460,10 +912,25 @@ components: - Description - SubnetIds x-stackql-resource-name: cluster_subnet_group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Redshift::ClusterSubnetGroup. Specifies an Amazon Redshift subnet group. + x-type-name: AWS::Redshift::ClusterSubnetGroup + x-stackql-primary-identifier: - ClusterSubnetGroupName x-read-only-properties: - ClusterSubnetGroupName + x-required-properties: + - Description + - SubnetIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - redshift:DescribeTags + - redshift:CreateTags + - redshift:DeleteTags x-required-permissions: create: - redshift:CreateClusterSubnetGroup @@ -513,6 +980,7 @@ components: - redshift:DeleteClusterSubnetGroup - redshift:DescribeClusterSubnetGroups - redshift:DescribeTags + - redshift:DeleteTags - ec2:AllocateAddress - ec2:AssociateAddress - ec2:AttachNetworkInterface @@ -538,98 +1006,106 @@ components: - ec2:DescribeVpcs VpcSecurityGroup: description: Describes the members of a VPC security group. + additionalProperties: false type: object properties: - VpcSecurityGroupId: + Status: + description: The status of the VPC security group. type: string + VpcSecurityGroupId: description: The identifier of the VPC security group. - Status: type: string - description: The status of the VPC security group. - additionalProperties: false NetworkInterface: description: Describes a network interface. + additionalProperties: false type: object properties: - NetworkInterfaceId: + PrivateIpAddress: + description: The IPv4 address of the network interface within the subnet. type: string - description: The network interface identifier. - SubnetId: + AvailabilityZone: + description: The Availability Zone. type: string + SubnetId: description: The subnet identifier. - PrivateIpAddress: type: string - description: The IPv4 address of the network interface within the subnet. - AvailabilityZone: + NetworkInterfaceId: + description: The network interface identifier. type: string - description: The Availability Zone. - additionalProperties: false EndpointAccess: type: object properties: + EndpointStatus: + description: The status of the endpoint. + type: string + VpcEndpoint: + description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. + additionalProperties: false + type: object + properties: + VpcId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/VpcId + description: The VPC identifier that the endpoint is associated. + type: string + NetworkInterfaces: + description: One or more network interfaces of the endpoint. Also known as an interface endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + VpcEndpointId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/Id + description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. + type: string Address: description: The DNS address of the endpoint. type: string - ClusterIdentifier: - description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + EndpointName: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ + description: The name of the endpoint. type: string - VpcSecurityGroups: - description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. - type: array + VpcSecurityGroupIds: + description: A list of vpc security group ids to apply to the created endpoint access. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/VpcSecurityGroup' + type: string ResourceOwner: - description: The AWS account ID of the owner of the cluster. - type: string pattern: ^\d{12}$ - EndpointStatus: - description: The status of the endpoint. - type: string - EndpointName: - description: The name of the endpoint. - type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ - EndpointCreateTime: - description: The time (UTC) that the endpoint was created. + description: The AWS account ID of the owner of the cluster. type: string SubnetGroupName: + pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ description: The subnet group name where Amazon Redshift chooses to deploy the endpoint. type: string - pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ Port: description: The port number on which the cluster accepts incoming connections. type: integer - VpcSecurityGroupIds: - description: A list of vpc security group ids to apply to the created endpoint access. - type: array + EndpointCreateTime: + description: The time (UTC) that the endpoint was created. + type: string + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + type: string + VpcSecurityGroups: + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. x-insertionOrder: false + type: array items: - type: string - VpcEndpoint: - description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. - type: object - properties: - VpcEndpointId: - type: string - description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. - VpcId: - type: string - description: The VPC identifier that the endpoint is associated. - NetworkInterfaces: - type: array - x-insertionOrder: false - description: One or more network interfaces of the endpoint. Also known as an interface endpoint. - items: - $ref: '#/components/schemas/NetworkInterface' - additionalProperties: false + $ref: '#/components/schemas/VpcSecurityGroup' required: - ClusterIdentifier - SubnetGroupName - EndpointName - VpcSecurityGroupIds x-stackql-resource-name: endpoint_access - x-stackql-primaryIdentifier: + description: Resource schema for a Redshift-managed VPC endpoint. + x-type-name: AWS::Redshift::EndpointAccess + x-stackql-primary-identifier: - EndpointName x-create-only-properties: - EndpointName @@ -651,21 +1127,28 @@ components: - VpcEndpoint/NetworkInterfaces/*/PrivateIpAddress - VpcEndpoint/NetworkInterfaces/*/SubnetId - VpcEndpoint/NetworkInterfaces/*/AvailabilityZone + x-required-properties: + - ClusterIdentifier + - SubnetGroupName + - EndpointName + - VpcSecurityGroupIds + x-tagging: + taggable: false x-required-permissions: - create: - - redshift:CreateEndpointAccess + read: - redshift:DescribeEndpointAccess - - ec2:CreateClientVpnEndpoint - - ec2:CreateVpcEndpoint + - ec2:DescribeClientVpnEndpoints + - ec2:DescribeVpcEndpoint - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - read: + create: + - redshift:CreateEndpointAccess - redshift:DescribeEndpointAccess - - ec2:DescribeClientVpnEndpoints - - ec2:DescribeVpcEndpoint + - ec2:CreateClientVpnEndpoint + - ec2:CreateVpcEndpoint - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses @@ -681,88 +1164,95 @@ components: - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - delete: - - redshift:DeleteEndpointAccess + list: - redshift:DescribeEndpointAccess - - ec2:DeleteClientVpnEndpoint - - ec2:DeleteVpcEndpoint + - ec2:DescribeClientVpnEndpoints + - ec2:DescribeVpcEndpoints - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - - ec2:DescribeVpcEndpoint - list: + delete: + - redshift:DeleteEndpointAccess - redshift:DescribeEndpointAccess - - ec2:DescribeClientVpnEndpoints - - ec2:DescribeVpcEndpoints + - ec2:DeleteClientVpnEndpoint + - ec2:DeleteVpcEndpoint - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - AwsAccount: + - ec2:DescribeVpcEndpoint + VpcId: + x-relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId + pattern: ^vpc-[A-Za-z0-9]{1,17}$ type: string + AwsAccount: pattern: ^\d{12}$ - VpcId: type: string - pattern: ^vpc-[A-Za-z0-9]{1,17}$ EndpointAuthorization: type: object properties: - Grantor: - description: The AWS account ID of the cluster owner. - $ref: '#/components/schemas/AwsAccount' + Status: + description: The status of the authorization action. + type: string Grantee: description: The AWS account ID of the grantee of the cluster. $ref: '#/components/schemas/AwsAccount' - ClusterIdentifier: - description: The cluster identifier. - type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + Account: + description: The target AWS account ID to grant or revoke access for. + $ref: '#/components/schemas/AwsAccount' + Grantor: + description: The AWS account ID of the cluster owner. + $ref: '#/components/schemas/AwsAccount' + EndpointCount: + description: The number of Redshift-managed VPC endpoints created for the authorization. + type: integer AuthorizeTime: description: The time (UTC) when the authorization was created. type: string - ClusterStatus: - description: The status of the cluster. - type: string - Status: - description: The status of the authorization action. - type: string - AllowedAllVPCs: - description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. - type: boolean AllowedVPCs: description: The VPCs allowed access to the cluster. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VpcId' - EndpointCount: - description: The number of Redshift-managed VPC endpoints created for the authorization. - type: integer - Account: - description: The target AWS account ID to grant or revoke access for. - $ref: '#/components/schemas/AwsAccount' + Force: + description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' + type: boolean + AllowedAllVPCs: + description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. + type: boolean VpcIds: description: The virtual private cloud (VPC) identifiers to grant or revoke access to. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VpcId' - Force: - description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' - type: boolean + ClusterIdentifier: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + description: The cluster identifier. + type: string + ClusterStatus: + description: The status of the cluster. + type: string required: - ClusterIdentifier - Account x-stackql-resource-name: endpoint_authorization - x-stackql-primaryIdentifier: + description: Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts. + x-type-name: AWS::Redshift::EndpointAuthorization + x-stackql-primary-identifier: - ClusterIdentifier - Account x-create-only-properties: - ClusterIdentifier - Account + x-write-only-properties: + - Force x-read-only-properties: - Grantor - Grantee @@ -772,16 +1262,23 @@ components: - AllowedAllVPCs - AllowedVPCs - EndpointCount + x-required-properties: + - ClusterIdentifier + - Account + x-tagging: + taggable: false x-required-permissions: + read: + - redshift:DescribeEndpointAuthorization create: - redshift:AuthorizeEndpointAccess - redshift:DescribeEndpointAuthorization - read: - - redshift:DescribeEndpointAuthorization update: - redshift:AuthorizeEndpointAccess - redshift:DescribeEndpointAuthorization - redshift:RevokeEndpointAccess + list: + - redshift:DescribeEndpointAuthorization delete: - redshift:RevokeEndpointAccess - redshift:DeleteEndpointAccess @@ -792,18 +1289,26 @@ components: - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - list: - - redshift:DescribeEndpointAuthorization EventSubscription: type: object properties: - SubscriptionName: - description: The name of the Amazon Redshift event notification subscription + Status: + description: The status of the Amazon Redshift event notification subscription. type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,255}$ - SnsTopicArn: - description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + enum: + - active + - no-permission + - topic-not-exist + CustSubscriptionId: + description: The name of the Amazon Redshift event notification subscription. type: string + EventCategoriesList: + uniqueItems: true + description: The list of Amazon Redshift event categories specified in the event notification subscription. + x-insertionOrder: false + type: array + items: + type: string SourceType: description: The type of source that will be generating the events. type: string @@ -813,17 +1318,11 @@ components: - cluster-security-group - cluster-snapshot - scheduled-action - SourceIds: - description: A list of one or more identifiers of Amazon Redshift source objects. - type: array - x-insertionOrder: false - items: - type: string EventCategories: + uniqueItems: true description: Specifies the Amazon Redshift event categories to be published by the event notification subscription. - type: array x-insertionOrder: false - uniqueItems: true + type: array items: type: string enum: @@ -832,54 +1331,52 @@ components: - monitoring - security - pending + Enabled: + description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. + type: boolean Severity: description: Specifies the Amazon Redshift event severity to be published by the event notification subscription. type: string enum: - ERROR - INFO - Enabled: - description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. - type: boolean - Tags: - description: An array of key-value pairs to apply to this resource. - type: array + SubscriptionName: + pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$ + description: The name of the Amazon Redshift event notification subscription + type: string + SourceIds: + description: A list of one or more identifiers of Amazon Redshift source objects. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Tag' + type: string CustomerAwsId: description: The AWS account associated with the Amazon Redshift event notification subscription. type: string - CustSubscriptionId: - description: The name of the Amazon Redshift event notification subscription. - type: string - Status: - description: The status of the Amazon Redshift event notification subscription. - type: string - enum: - - active - - no-permission - - topic-not-exist - SubscriptionCreationTime: - description: The date and time the Amazon Redshift event notification subscription was created. - type: string SourceIdsList: description: A list of the sources that publish events to the Amazon Redshift event notification subscription. - type: array x-insertionOrder: false + type: array items: type: string - EventCategoriesList: - description: The list of Amazon Redshift event categories specified in the event notification subscription. - type: array + SnsTopicArn: + description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + type: string + SubscriptionCreationTime: + description: The date and time the Amazon Redshift event notification subscription was created. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. x-insertionOrder: false - uniqueItems: true + type: array items: - type: string + $ref: '#/components/schemas/Tag' required: - SubscriptionName x-stackql-resource-name: event_subscription - x-stackql-primaryIdentifier: + description: The `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription. + x-type-name: AWS::Redshift::EventSubscription + x-stackql-primary-identifier: - SubscriptionName x-create-only-properties: - SubscriptionName @@ -890,133 +1387,260 @@ components: - SubscriptionCreationTime - SourceIdsList - EventCategoriesList + x-required-properties: + - SubscriptionName + x-tagging: + permissions: + - redshift:DescribeTags + - redshift:CreateTags + - redshift:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - redshift:DescribeEventSubscriptions + - redshift:DescribeTags create: - redshift:CreateEventSubscription - redshift:CreateTags - redshift:DescribeTags - redshift:DescribeEventSubscriptions - read: - - redshift:DescribeEventSubscriptions - - redshift:DescribeTags update: - redshift:ModifyEventSubscription - redshift:CreateTags - redshift:DescribeTags - redshift:DescribeEventSubscriptions - redshift:DeleteTags + list: + - redshift:DescribeTags + - redshift:DescribeEventSubscriptions delete: - redshift:DescribeEventSubscriptions - redshift:DeleteEventSubscription - redshift:DescribeTags - redshift:DeleteTags + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + EncryptionContextMap: + type: object + x-patternProperties: + ^[\s\S]*$: + type: string + maxLength: 131072 + minLength: 0 + description: An optional set of non-secret key–value pairs that contains additional contextual information about the data. + additionalProperties: false + Integration: + type: object + properties: + IntegrationArn: + type: string + description: The Amazon Resource Name (ARN) of the integration. + IntegrationName: + description: The name of the integration. + type: string + minLength: 1 + maxLength: 64 + SourceArn: + type: string + description: The Amazon Resource Name (ARN) of the database to use as the source for replication + TargetArn: + type: string + description: The Amazon Resource Name (ARN) of the Redshift data warehouse to use as the target for replication + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + CreateTime: + type: string + description: The time (UTC) when the integration was created. + KMSKeyId: + type: string + description: An KMS key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default AWS owned KMS key is used. + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + required: + - SourceArn + - TargetArn + x-stackql-resource-name: integration + description: Integration from a source AWS service to a Redshift cluster + x-type-name: AWS::Redshift::Integration + x-stackql-primary-identifier: + - IntegrationArn + x-create-only-properties: + - SourceArn + - TargetArn + - KMSKeyId + - AdditionalEncryptionContext + x-read-only-properties: + - IntegrationArn + - CreateTime + x-required-properties: + - SourceArn + - TargetArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - redshift:CreateTags + - redshift:DeleteTags + - redshift:DescribeTags + x-required-permissions: + create: + - redshift:CreateIntegration + - redshift:DescribeIntegrations + - redshift:CreateTags + - redshift:DescribeTags + - redshift:DescribeClusters + - redshift:CreateInboundIntegration + - redshift-serverless:ListNamespaces + - kms:CreateGrant + - kms:DescribeKey + read: + - redshift:DescribeIntegrations + - redshift:DescribeTags + update: + - redshift:DescribeIntegrations + - redshift:ModifyIntegration + - redshift:CreateTags + - redshift:DeleteTags + - redshift:DescribeClusters + - redshift:DescribeTags + - redshift-serverless:ListNamespaces + delete: + - redshift:DeleteTags + - redshift:DeleteIntegration + - redshift:DescribeIntegrations list: - redshift:DescribeTags - - redshift:DescribeEventSubscriptions + - redshift:DescribeIntegrations + ScheduledActionType: + oneOf: + - additionalProperties: false + properties: + ResizeCluster: + $ref: '#/components/schemas/ResizeClusterMessage' + - additionalProperties: false + properties: + PauseCluster: + $ref: '#/components/schemas/PauseClusterMessage' + - additionalProperties: false + properties: + ResumeCluster: + $ref: '#/components/schemas/ResumeClusterMessage' + type: object ResizeClusterMessage: description: Describes a resize cluster operation. For example, a scheduled action to run the `ResizeCluster` API operation. + additionalProperties: false type: object properties: - ClusterIdentifier: - type: string - ClusterType: - type: string NodeType: type: string NumberOfNodes: type: integer + ClusterType: + type: string Classic: type: boolean + ClusterIdentifier: + type: string required: - ClusterIdentifier - additionalProperties: false PauseClusterMessage: description: Describes a pause cluster operation. For example, a scheduled action to run the `PauseCluster` API operation. + additionalProperties: false type: object properties: ClusterIdentifier: type: string required: - ClusterIdentifier - additionalProperties: false ResumeClusterMessage: description: Describes a resume cluster operation. For example, a scheduled action to run the `ResumeCluster` API operation. + additionalProperties: false type: object properties: ClusterIdentifier: type: string required: - ClusterIdentifier - additionalProperties: false - ScheduledActionType: - type: object - oneOf: - - properties: - ResizeCluster: - $ref: '#/components/schemas/ResizeClusterMessage' - additionalProperties: false - - properties: - PauseCluster: - $ref: '#/components/schemas/PauseClusterMessage' - additionalProperties: false - - properties: - ResumeCluster: - $ref: '#/components/schemas/ResumeClusterMessage' - additionalProperties: false timestamp: type: string ScheduledAction: type: object properties: + ScheduledActionDescription: + description: The description of the scheduled action. + type: string ScheduledActionName: description: The name of the scheduled action. The name must be unique within an account. type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,60}$ - TargetAction: - description: A JSON format string of the Amazon Redshift API operation with input parameters. - $ref: '#/components/schemas/ScheduledActionType' + EndTime: + description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. + $ref: '#/components/schemas/timestamp' + State: + description: The state of the scheduled action. + type: string + enum: + - ACTIVE + - DISABLED Schedule: description: The schedule in `at( )` or `cron( )` format. type: string IamRole: description: The IAM role to assume to run the target action. type: string - ScheduledActionDescription: - description: The description of the scheduled action. - type: string - pattern: ^(?=^[\x09\x0a\x0d\x20-\xff]*$).{1,255}$ StartTime: - description: The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. - $ref: '#/components/schemas/timestamp' - EndTime: - description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. + description: The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. $ref: '#/components/schemas/timestamp' Enable: description: If true, the schedule is enabled. If false, the scheduled action does not trigger. type: boolean - State: - description: The state of the scheduled action. - type: string - enum: - - ACTIVE - - DISABLED + TargetAction: + description: A JSON format string of the Amazon Redshift API operation with input parameters. + $ref: '#/components/schemas/ScheduledActionType' NextInvocations: description: List of times when the scheduled action will run. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/timestamp' required: - ScheduledActionName x-stackql-resource-name: scheduled_action - x-stackql-primaryIdentifier: + description: The `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action. + x-type-name: AWS::Redshift::ScheduledAction + x-stackql-primary-identifier: - ScheduledActionName x-create-only-properties: - ScheduledActionName x-read-only-properties: - State - NextInvocations + x-required-properties: + - ScheduledActionName + x-tagging: + taggable: false x-required-permissions: + read: + - redshift:DescribeScheduledActions + - redshift:DescribeTags create: - redshift:CreateScheduledAction - redshift:DescribeScheduledActions @@ -1025,9 +1649,6 @@ components: - redshift:ResumeCluster - redshift:ResizeCluster - iam:PassRole - read: - - redshift:DescribeScheduledActions - - redshift:DescribeTags update: - redshift:DescribeScheduledActions - redshift:ModifyScheduledAction @@ -1036,183 +1657,879 @@ components: - redshift:ResizeCluster - redshift:DescribeTags - iam:PassRole - delete: + list: - redshift:DescribeTags - redshift:DescribeScheduledActions - - redshift:DeleteScheduledAction - list: + delete: - redshift:DescribeTags - redshift:DescribeScheduledActions + - redshift:DeleteScheduledAction + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RevisionTarget: + description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. + type: string + AutomatedSnapshotRetentionPeriod: + description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 + type: integer + Encrypted: + description: If true, the data in the cluster is encrypted at rest. + type: boolean + Port: + description: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings + type: integer + NumberOfNodes: + description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. + type: integer + DestinationRegion: + description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' + type: string + AllowVersionUpgrade: + description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True + type: boolean + Endpoint: + $ref: '#/components/schemas/Endpoint' + NamespaceResourcePolicy: + description: The namespace resource policy document that will be attached to a Redshift cluster. + type: object + MaintenanceTrackName: + description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. + type: string + OwnerAccount: + type: string + MultiAZ: + description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. + type: boolean + Tags: + maxItems: 50 + uniqueItems: false + description: The list of tags for the cluster parameter group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + SnapshotClusterIdentifier: + description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + type: string + IamRoles: + maxItems: 50 + description: A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::IAM::Role + propertyPath: /properties/Arn + type: string + KmsKeyId: + description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + SnapshotCopyManual: + description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. + type: boolean + ManageMasterPassword: + description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + type: boolean + AvailabilityZone: + description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' + type: string + ClusterSecurityGroups: + uniqueItems: false + description: A list of security groups to be associated with this cluster. + x-insertionOrder: false + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::Redshift::ClusterSecurityGroup + propertyPath: /properties/Id + type: string + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + type: string + maxLength: 63 + MasterUserPassword: + description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. + type: string + maxLength: 64 + ClusterSubnetGroupName: + description: The name of a cluster subnet group to be associated with this cluster. + type: string + LoggingProperties: + $ref: '#/components/schemas/LoggingProperties' + DeferMaintenance: + description: A boolean indicating whether to enable the deferred maintenance window. + type: boolean + NodeType: + description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.large | ra3.4xlarge | ra3.16xlarge' + type: string + MasterUsername: + description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. + type: string + maxLength: 128 + PubliclyAccessible: + description: If true, the cluster can be accessed from a public network. + type: boolean + DeferMaintenanceIdentifier: + description: A unique identifier for the deferred maintenance window. + type: string + ManualSnapshotRetentionPeriod: + description: |- + The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. + + The value must be either -1 or an integer between 1 and 3,653. + type: integer + ResourceAction: + description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs + type: string + HsmClientCertificateIdentifier: + description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM + type: string + ElasticIp: + description: The Elastic IP (EIP) address for the cluster. + type: string + AvailabilityZoneRelocationStatus: + description: The availability zone relocation status of the cluster + type: string + AquaConfigurationStatus: + description: | + The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following. + + enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. + disabled - Don't use AQUA. + auto - Amazon Redshift determines whether to use AQUA. + type: string + SnapshotIdentifier: + description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + type: string + AvailabilityZoneRelocation: + description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. + type: boolean + SnapshotCopyGrantName: + description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + type: string + EnhancedVpcRouting: + description: |- + An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. + + If this option is true , enhanced VPC routing is enabled. + + Default: false + type: boolean + ClusterParameterGroupName: + description: The name of the parameter group to be associated with this cluster. + type: string + maxLength: 255 + DeferMaintenanceEndTime: + description: A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. + type: string + RotateEncryptionKey: + description: A boolean indicating if we want to rotate Encryption Keys. + type: boolean + VpcSecurityGroupIds: + uniqueItems: false + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId + type: string + ClusterNamespaceArn: + description: The Amazon Resource Name (ARN) of the cluster namespace. + type: string + MasterPasswordSecretArn: + description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + type: string + ClusterVersion: + description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. + type: string + HsmConfigurationIdentifier: + description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + type: string + PreferredMaintenanceWindow: + description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + type: string + DeferMaintenanceStartTime: + description: A timestamp indicating the start time for the deferred maintenance window. + type: string + ClusterType: + description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required + type: string + Classic: + description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. + type: boolean + MasterPasswordSecretKmsKeyId: + description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + DeferMaintenanceDuration: + description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. + type: integer + DBName: + description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. + type: string + SnapshotCopyRetentionPeriod: + description: |- + The number of days to retain automated snapshots in the destination region after they are copied from the source region. + + Default is 7. + + Constraints: Must be at least 1 and no more than 35. + type: integer + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateClusterParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ParameterGroupName: + type: string + description: The name of the cluster parameter group. + maxLength: 255 + Description: + type: string + description: A description of the parameter group. + ParameterGroupFamily: + type: string + description: The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. + Parameters: + type: array + description: An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Parameter' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateClusterParameterGroupRequest + type: object + required: [] + CreateClusterSubnetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: The description of the parameter group. + type: string + SubnetIds: + description: The list of VPC subnet IDs + type: array + x-insertionOrder: false + maxItems: 20 + items: + type: string + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + Tags: + description: The list of tags for the cluster parameter group. + type: array + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + ClusterSubnetGroupName: + description: 'This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default". ' + type: string + maxLength: 255 + x-stackQL-stringOnly: true + x-title: CreateClusterSubnetGroupRequest + type: object + required: [] + CreateEndpointAccessRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EndpointStatus: + description: The status of the endpoint. + type: string + VpcEndpoint: + description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. + additionalProperties: false + type: object + properties: + VpcId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/VpcId + description: The VPC identifier that the endpoint is associated. + type: string + NetworkInterfaces: + description: One or more network interfaces of the endpoint. Also known as an interface endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + VpcEndpointId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/Id + description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. + type: string + Address: + description: The DNS address of the endpoint. + type: string + EndpointName: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ + description: The name of the endpoint. + type: string + VpcSecurityGroupIds: + description: A list of vpc security group ids to apply to the created endpoint access. + x-insertionOrder: false + type: array + items: + type: string + ResourceOwner: + pattern: ^\d{12}$ + description: The AWS account ID of the owner of the cluster. + type: string + SubnetGroupName: + pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ + description: The subnet group name where Amazon Redshift chooses to deploy the endpoint. + type: string + Port: + description: The port number on which the cluster accepts incoming connections. + type: integer + EndpointCreateTime: + description: The time (UTC) that the endpoint was created. + type: string + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + type: string + VpcSecurityGroups: + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/VpcSecurityGroup' + x-stackQL-stringOnly: true + x-title: CreateEndpointAccessRequest + type: object + required: [] + CreateEndpointAuthorizationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: The status of the authorization action. + type: string + Grantee: + description: The AWS account ID of the grantee of the cluster. + $ref: '#/components/schemas/AwsAccount' + Account: + description: The target AWS account ID to grant or revoke access for. + $ref: '#/components/schemas/AwsAccount' + Grantor: + description: The AWS account ID of the cluster owner. + $ref: '#/components/schemas/AwsAccount' + EndpointCount: + description: The number of Redshift-managed VPC endpoints created for the authorization. + type: integer + AuthorizeTime: + description: The time (UTC) when the authorization was created. + type: string + AllowedVPCs: + description: The VPCs allowed access to the cluster. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/VpcId' + Force: + description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' + type: boolean + AllowedAllVPCs: + description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. + type: boolean + VpcIds: + description: The virtual private cloud (VPC) identifiers to grant or revoke access to. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/VpcId' + ClusterIdentifier: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + description: The cluster identifier. + type: string + ClusterStatus: + description: The status of the cluster. + type: string + x-stackQL-stringOnly: true + x-title: CreateEndpointAuthorizationRequest + type: object + required: [] + CreateEventSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Status: + description: The status of the Amazon Redshift event notification subscription. + type: string + enum: + - active + - no-permission + - topic-not-exist + CustSubscriptionId: + description: The name of the Amazon Redshift event notification subscription. + type: string + EventCategoriesList: + uniqueItems: true + description: The list of Amazon Redshift event categories specified in the event notification subscription. + x-insertionOrder: false + type: array + items: + type: string + SourceType: + description: The type of source that will be generating the events. + type: string + enum: + - cluster + - cluster-parameter-group + - cluster-security-group + - cluster-snapshot + - scheduled-action + EventCategories: + uniqueItems: true + description: Specifies the Amazon Redshift event categories to be published by the event notification subscription. + x-insertionOrder: false + type: array + items: + type: string + enum: + - configuration + - management + - monitoring + - security + - pending + Enabled: + description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. + type: boolean + Severity: + description: Specifies the Amazon Redshift event severity to be published by the event notification subscription. + type: string + enum: + - ERROR + - INFO + SubscriptionName: + pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$ + description: The name of the Amazon Redshift event notification subscription + type: string + SourceIds: + description: A list of one or more identifiers of Amazon Redshift source objects. + x-insertionOrder: false + type: array + items: + type: string + CustomerAwsId: + description: The AWS account associated with the Amazon Redshift event notification subscription. + type: string + SourceIdsList: + description: A list of the sources that publish events to the Amazon Redshift event notification subscription. + x-insertionOrder: false + type: array + items: + type: string + SnsTopicArn: + description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + type: string + SubscriptionCreationTime: + description: The date and time the Amazon Redshift event notification subscription was created. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEventSubscriptionRequest + type: object + required: [] + CreateIntegrationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IntegrationArn: + type: string + description: The Amazon Resource Name (ARN) of the integration. + IntegrationName: + description: The name of the integration. + type: string + minLength: 1 + maxLength: 64 + SourceArn: + type: string + description: The Amazon Resource Name (ARN) of the database to use as the source for replication + TargetArn: + type: string + description: The Amazon Resource Name (ARN) of the Redshift data warehouse to use as the target for replication + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + CreateTime: + type: string + description: The time (UTC) when the integration was created. + KMSKeyId: + type: string + description: An KMS key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default AWS owned KMS key is used. + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + x-stackQL-stringOnly: true + x-title: CreateIntegrationRequest + type: object + required: [] + CreateScheduledActionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ScheduledActionDescription: + description: The description of the scheduled action. + type: string + ScheduledActionName: + description: The name of the scheduled action. The name must be unique within an account. + type: string + EndTime: + description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. + $ref: '#/components/schemas/timestamp' + State: + description: The state of the scheduled action. + type: string + enum: + - ACTIVE + - DISABLED + Schedule: + description: The schedule in `at( )` or `cron( )` format. + type: string + IamRole: + description: The IAM role to assume to run the target action. + type: string + StartTime: + description: The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. + $ref: '#/components/schemas/timestamp' + Enable: + description: If true, the schedule is enabled. If false, the scheduled action does not trigger. + type: boolean + TargetAction: + description: A JSON format string of the Amazon Redshift API operation with input parameters. + $ref: '#/components/schemas/ScheduledActionType' + NextInvocations: + description: List of times when the scheduled action will run. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/timestamp' + x-stackQL-stringOnly: true + x-title: CreateScheduledActionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: clusters: name: clusters id: awscc.redshift.clusters x-cfn-schema-name: Cluster - x-type: list - x-identifiers: - - ClusterIdentifier - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: awscc.redshift.cluster - x-cfn-schema-name: Cluster - x-type: get + x-cfn-type-name: AWS::Redshift::Cluster x-identifiers: - ClusterIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, - JSON_EXTRACT(Properties, '$.ClusterNamespaceArn') as cluster_namespace_arn, - JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, - JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, - JSON_EXTRACT(Properties, '$.NodeType') as node_type, - JSON_EXTRACT(Properties, '$.AllowVersionUpgrade') as allow_version_upgrade, + JSON_EXTRACT(Properties, '$.RevisionTarget') as revision_target, JSON_EXTRACT(Properties, '$.AutomatedSnapshotRetentionPeriod') as automated_snapshot_retention_period, - JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, - JSON_EXTRACT(Properties, '$.ClusterParameterGroupName') as cluster_parameter_group_name, - JSON_EXTRACT(Properties, '$.ClusterType') as cluster_type, - JSON_EXTRACT(Properties, '$.ClusterVersion') as cluster_version, - JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name, - JSON_EXTRACT(Properties, '$.DBName') as db_name, - JSON_EXTRACT(Properties, '$.ElasticIp') as elastic_ip, JSON_EXTRACT(Properties, '$.Encrypted') as encrypted, - JSON_EXTRACT(Properties, '$.HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, - JSON_EXTRACT(Properties, '$.HsmConfigurationIdentifier') as hsm_configuration_identifier, - JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.NumberOfNodes') as number_of_nodes, JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, - JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, - JSON_EXTRACT(Properties, '$.ClusterSecurityGroups') as cluster_security_groups, - JSON_EXTRACT(Properties, '$.IamRoles') as iam_roles, + JSON_EXTRACT(Properties, '$.NumberOfNodes') as number_of_nodes, + JSON_EXTRACT(Properties, '$.DestinationRegion') as destination_region, + JSON_EXTRACT(Properties, '$.AllowVersionUpgrade') as allow_version_upgrade, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.NamespaceResourcePolicy') as namespace_resource_policy, + JSON_EXTRACT(Properties, '$.MaintenanceTrackName') as maintenance_track_name, + JSON_EXTRACT(Properties, '$.OwnerAccount') as owner_account, + JSON_EXTRACT(Properties, '$.MultiAZ') as multi_az, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, JSON_EXTRACT(Properties, '$.SnapshotClusterIdentifier') as snapshot_cluster_identifier, - JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, - JSON_EXTRACT(Properties, '$.OwnerAccount') as owner_account, + JSON_EXTRACT(Properties, '$.IamRoles') as iam_roles, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.SnapshotCopyManual') as snapshot_copy_manual, + JSON_EXTRACT(Properties, '$.ManageMasterPassword') as manage_master_password, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.ClusterSecurityGroups') as cluster_security_groups, + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, + JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name, JSON_EXTRACT(Properties, '$.LoggingProperties') as logging_properties, - JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, - JSON_EXTRACT(Properties, '$.DestinationRegion') as destination_region, - JSON_EXTRACT(Properties, '$.SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period, - JSON_EXTRACT(Properties, '$.SnapshotCopyGrantName') as snapshot_copy_grant_name, + JSON_EXTRACT(Properties, '$.DeferMaintenance') as defer_maintenance, + JSON_EXTRACT(Properties, '$.NodeType') as node_type, + JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, + JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, + JSON_EXTRACT(Properties, '$.DeferMaintenanceIdentifier') as defer_maintenance_identifier, JSON_EXTRACT(Properties, '$.ManualSnapshotRetentionPeriod') as manual_snapshot_retention_period, - JSON_EXTRACT(Properties, '$.SnapshotCopyManual') as snapshot_copy_manual, - JSON_EXTRACT(Properties, '$.AvailabilityZoneRelocation') as availability_zone_relocation, + JSON_EXTRACT(Properties, '$.ResourceAction') as resource_action, + JSON_EXTRACT(Properties, '$.HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, + JSON_EXTRACT(Properties, '$.ElasticIp') as elastic_ip, JSON_EXTRACT(Properties, '$.AvailabilityZoneRelocationStatus') as availability_zone_relocation_status, JSON_EXTRACT(Properties, '$.AquaConfigurationStatus') as aqua_configuration_status, - JSON_EXTRACT(Properties, '$.Classic') as classic, + JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, + JSON_EXTRACT(Properties, '$.AvailabilityZoneRelocation') as availability_zone_relocation, + JSON_EXTRACT(Properties, '$.SnapshotCopyGrantName') as snapshot_copy_grant_name, JSON_EXTRACT(Properties, '$.EnhancedVpcRouting') as enhanced_vpc_routing, - JSON_EXTRACT(Properties, '$.MaintenanceTrackName') as maintenance_track_name, - JSON_EXTRACT(Properties, '$.DeferMaintenance') as defer_maintenance, - JSON_EXTRACT(Properties, '$.DeferMaintenanceIdentifier') as defer_maintenance_identifier, - JSON_EXTRACT(Properties, '$.DeferMaintenanceStartTime') as defer_maintenance_start_time, + JSON_EXTRACT(Properties, '$.ClusterParameterGroupName') as cluster_parameter_group_name, JSON_EXTRACT(Properties, '$.DeferMaintenanceEndTime') as defer_maintenance_end_time, - JSON_EXTRACT(Properties, '$.DeferMaintenanceDuration') as defer_maintenance_duration, - JSON_EXTRACT(Properties, '$.RevisionTarget') as revision_target, - JSON_EXTRACT(Properties, '$.ResourceAction') as resource_action, JSON_EXTRACT(Properties, '$.RotateEncryptionKey') as rotate_encryption_key, - JSON_EXTRACT(Properties, '$.MultiAZ') as multi_az, - JSON_EXTRACT(Properties, '$.NamespaceResourcePolicy') as namespace_resource_policy, - JSON_EXTRACT(Properties, '$.ManageMasterPassword') as manage_master_password, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, + JSON_EXTRACT(Properties, '$.ClusterNamespaceArn') as cluster_namespace_arn, + JSON_EXTRACT(Properties, '$.MasterPasswordSecretArn') as master_password_secret_arn, + JSON_EXTRACT(Properties, '$.ClusterVersion') as cluster_version, + JSON_EXTRACT(Properties, '$.HsmConfigurationIdentifier') as hsm_configuration_identifier, + JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.DeferMaintenanceStartTime') as defer_maintenance_start_time, + JSON_EXTRACT(Properties, '$.ClusterType') as cluster_type, + JSON_EXTRACT(Properties, '$.Classic') as classic, JSON_EXTRACT(Properties, '$.MasterPasswordSecretKmsKeyId') as master_password_secret_kms_key_id, - JSON_EXTRACT(Properties, '$.MasterPasswordSecretArn') as master_password_secret_arn + JSON_EXTRACT(Properties, '$.DeferMaintenanceDuration') as defer_maintenance_duration, + JSON_EXTRACT(Properties, '$.DBName') as db_name, + JSON_EXTRACT(Properties, '$.SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Cluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'ClusterNamespaceArn') as cluster_namespace_arn, - json_extract_path_text(Properties, 'MasterUsername') as master_username, - json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, - json_extract_path_text(Properties, 'NodeType') as node_type, - json_extract_path_text(Properties, 'AllowVersionUpgrade') as allow_version_upgrade, + json_extract_path_text(Properties, 'RevisionTarget') as revision_target, json_extract_path_text(Properties, 'AutomatedSnapshotRetentionPeriod') as automated_snapshot_retention_period, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'ClusterParameterGroupName') as cluster_parameter_group_name, - json_extract_path_text(Properties, 'ClusterType') as cluster_type, - json_extract_path_text(Properties, 'ClusterVersion') as cluster_version, - json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name, - json_extract_path_text(Properties, 'DBName') as db_name, - json_extract_path_text(Properties, 'ElasticIp') as elastic_ip, json_extract_path_text(Properties, 'Encrypted') as encrypted, - json_extract_path_text(Properties, 'HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, - json_extract_path_text(Properties, 'HsmConfigurationIdentifier') as hsm_configuration_identifier, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'NumberOfNodes') as number_of_nodes, json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'ClusterSecurityGroups') as cluster_security_groups, - json_extract_path_text(Properties, 'IamRoles') as iam_roles, + json_extract_path_text(Properties, 'NumberOfNodes') as number_of_nodes, + json_extract_path_text(Properties, 'DestinationRegion') as destination_region, + json_extract_path_text(Properties, 'AllowVersionUpgrade') as allow_version_upgrade, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'NamespaceResourcePolicy') as namespace_resource_policy, + json_extract_path_text(Properties, 'MaintenanceTrackName') as maintenance_track_name, + json_extract_path_text(Properties, 'OwnerAccount') as owner_account, + json_extract_path_text(Properties, 'MultiAZ') as multi_az, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, json_extract_path_text(Properties, 'SnapshotClusterIdentifier') as snapshot_cluster_identifier, - json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, - json_extract_path_text(Properties, 'OwnerAccount') as owner_account, + json_extract_path_text(Properties, 'IamRoles') as iam_roles, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SnapshotCopyManual') as snapshot_copy_manual, + json_extract_path_text(Properties, 'ManageMasterPassword') as manage_master_password, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'ClusterSecurityGroups') as cluster_security_groups, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, + json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, + json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name, json_extract_path_text(Properties, 'LoggingProperties') as logging_properties, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'DestinationRegion') as destination_region, - json_extract_path_text(Properties, 'SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period, - json_extract_path_text(Properties, 'SnapshotCopyGrantName') as snapshot_copy_grant_name, + json_extract_path_text(Properties, 'DeferMaintenance') as defer_maintenance, + json_extract_path_text(Properties, 'NodeType') as node_type, + json_extract_path_text(Properties, 'MasterUsername') as master_username, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'DeferMaintenanceIdentifier') as defer_maintenance_identifier, json_extract_path_text(Properties, 'ManualSnapshotRetentionPeriod') as manual_snapshot_retention_period, - json_extract_path_text(Properties, 'SnapshotCopyManual') as snapshot_copy_manual, - json_extract_path_text(Properties, 'AvailabilityZoneRelocation') as availability_zone_relocation, + json_extract_path_text(Properties, 'ResourceAction') as resource_action, + json_extract_path_text(Properties, 'HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, + json_extract_path_text(Properties, 'ElasticIp') as elastic_ip, json_extract_path_text(Properties, 'AvailabilityZoneRelocationStatus') as availability_zone_relocation_status, json_extract_path_text(Properties, 'AquaConfigurationStatus') as aqua_configuration_status, - json_extract_path_text(Properties, 'Classic') as classic, + json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, + json_extract_path_text(Properties, 'AvailabilityZoneRelocation') as availability_zone_relocation, + json_extract_path_text(Properties, 'SnapshotCopyGrantName') as snapshot_copy_grant_name, json_extract_path_text(Properties, 'EnhancedVpcRouting') as enhanced_vpc_routing, - json_extract_path_text(Properties, 'MaintenanceTrackName') as maintenance_track_name, - json_extract_path_text(Properties, 'DeferMaintenance') as defer_maintenance, - json_extract_path_text(Properties, 'DeferMaintenanceIdentifier') as defer_maintenance_identifier, - json_extract_path_text(Properties, 'DeferMaintenanceStartTime') as defer_maintenance_start_time, + json_extract_path_text(Properties, 'ClusterParameterGroupName') as cluster_parameter_group_name, json_extract_path_text(Properties, 'DeferMaintenanceEndTime') as defer_maintenance_end_time, - json_extract_path_text(Properties, 'DeferMaintenanceDuration') as defer_maintenance_duration, - json_extract_path_text(Properties, 'RevisionTarget') as revision_target, - json_extract_path_text(Properties, 'ResourceAction') as resource_action, json_extract_path_text(Properties, 'RotateEncryptionKey') as rotate_encryption_key, - json_extract_path_text(Properties, 'MultiAZ') as multi_az, - json_extract_path_text(Properties, 'NamespaceResourcePolicy') as namespace_resource_policy, - json_extract_path_text(Properties, 'ManageMasterPassword') as manage_master_password, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'ClusterNamespaceArn') as cluster_namespace_arn, + json_extract_path_text(Properties, 'MasterPasswordSecretArn') as master_password_secret_arn, + json_extract_path_text(Properties, 'ClusterVersion') as cluster_version, + json_extract_path_text(Properties, 'HsmConfigurationIdentifier') as hsm_configuration_identifier, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'DeferMaintenanceStartTime') as defer_maintenance_start_time, + json_extract_path_text(Properties, 'ClusterType') as cluster_type, + json_extract_path_text(Properties, 'Classic') as classic, json_extract_path_text(Properties, 'MasterPasswordSecretKmsKeyId') as master_password_secret_kms_key_id, - json_extract_path_text(Properties, 'MasterPasswordSecretArn') as master_password_secret_arn + json_extract_path_text(Properties, 'DeferMaintenanceDuration') as defer_maintenance_duration, + json_extract_path_text(Properties, 'DBName') as db_name, + json_extract_path_text(Properties, 'SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Cluster' AND data__Identifier = '' AND region = 'us-east-1' - cluster_parameter_groups: - name: cluster_parameter_groups - id: awscc.redshift.cluster_parameter_groups - x-cfn-schema-name: ClusterParameterGroup - x-type: list + clusters_list_only: + name: clusters_list_only + id: awscc.redshift.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::Redshift::Cluster x-identifiers: - - ParameterGroupName + - ClusterIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1220,28 +2537,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' AND region = 'us-east-1' - cluster_parameter_group: - name: cluster_parameter_group - id: awscc.redshift.cluster_parameter_group + cluster_parameter_groups: + name: cluster_parameter_groups + id: awscc.redshift.cluster_parameter_groups x-cfn-schema-name: ClusterParameterGroup - x-type: get + x-cfn-type-name: AWS::Redshift::ClusterParameterGroup x-identifiers: - ParameterGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1255,7 +2620,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1268,13 +2633,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' AND data__Identifier = '' AND region = 'us-east-1' - cluster_subnet_groups: - name: cluster_subnet_groups - id: awscc.redshift.cluster_subnet_groups - x-cfn-schema-name: ClusterSubnetGroup - x-type: list + cluster_parameter_groups_list_only: + name: cluster_parameter_groups_list_only + id: awscc.redshift.cluster_parameter_groups_list_only + x-cfn-schema-name: ClusterParameterGroup + x-cfn-type-name: AWS::Redshift::ClusterParameterGroup x-identifiers: - - ClusterSubnetGroupName + - ParameterGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1282,28 +2653,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' + JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' AND region = 'us-east-1' - cluster_subnet_group: - name: cluster_subnet_group - id: awscc.redshift.cluster_subnet_group + cluster_subnet_groups: + name: cluster_subnet_groups + id: awscc.redshift.cluster_subnet_groups x-cfn-schema-name: ClusterSubnetGroup - x-type: get + x-cfn-type-name: AWS::Redshift::ClusterSubnetGroup x-identifiers: - ClusterSubnetGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterSubnetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterSubnetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1316,7 +2735,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1328,13 +2747,147 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' AND data__Identifier = '' AND region = 'us-east-1' - endpoint_accesses: - name: endpoint_accesses - id: awscc.redshift.endpoint_accesses + cluster_subnet_groups_list_only: + name: cluster_subnet_groups_list_only + id: awscc.redshift.cluster_subnet_groups_list_only + x-cfn-schema-name: ClusterSubnetGroup + x-cfn-type-name: AWS::Redshift::ClusterSubnetGroup + x-identifiers: + - ClusterSubnetGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' + AND region = 'us-east-1' + endpoint_accesses: + name: endpoint_accesses + id: awscc.redshift.endpoint_accesses + x-cfn-schema-name: EndpointAccess + x-cfn-type-name: AWS::Redshift::EndpointAccess + x-identifiers: + - EndpointName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EndpointAccess&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EndpointAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EndpointAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EndpointAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.EndpointStatus') as endpoint_status, + JSON_EXTRACT(Properties, '$.VpcEndpoint') as vpc_endpoint, + JSON_EXTRACT(Properties, '$.Address') as address, + JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, + JSON_EXTRACT(Properties, '$.ResourceOwner') as resource_owner, + JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name, + JSON_EXTRACT(Properties, '$.Port') as port, + JSON_EXTRACT(Properties, '$.EndpointCreateTime') as endpoint_create_time, + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.VpcSecurityGroups') as vpc_security_groups + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EndpointStatus') as endpoint_status, + json_extract_path_text(Properties, 'VpcEndpoint') as vpc_endpoint, + json_extract_path_text(Properties, 'Address') as address, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'ResourceOwner') as resource_owner, + json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'EndpointCreateTime') as endpoint_create_time, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, + json_extract_path_text(Properties, 'VpcSecurityGroups') as vpc_security_groups + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' + AND data__Identifier = '' + AND region = 'us-east-1' + endpoint_accesses_list_only: + name: endpoint_accesses_list_only + id: awscc.redshift.endpoint_accesses_list_only x-cfn-schema-name: EndpointAccess - x-type: list + x-cfn-type-name: AWS::Redshift::EndpointAccess x-identifiers: - EndpointName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1353,63 +2906,120 @@ components: json_extract_path_text(Properties, 'EndpointName') as endpoint_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' AND region = 'us-east-1' - endpoint_access: - name: endpoint_access - id: awscc.redshift.endpoint_access - x-cfn-schema-name: EndpointAccess - x-type: get + endpoint_authorizations: + name: endpoint_authorizations + id: awscc.redshift.endpoint_authorizations + x-cfn-schema-name: EndpointAuthorization + x-cfn-type-name: AWS::Redshift::EndpointAuthorization x-identifiers: - - EndpointName + - ClusterIdentifier + - Account + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EndpointAuthorization&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EndpointAuthorization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EndpointAuthorization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EndpointAuthorization" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Address') as address, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Grantee') as grantee, + JSON_EXTRACT(Properties, '$.Account') as account, + JSON_EXTRACT(Properties, '$.Grantor') as grantor, + JSON_EXTRACT(Properties, '$.EndpointCount') as endpoint_count, + JSON_EXTRACT(Properties, '$.AuthorizeTime') as authorize_time, + JSON_EXTRACT(Properties, '$.AllowedVPCs') as allowed_vpcs, + JSON_EXTRACT(Properties, '$.Force') as _force, + JSON_EXTRACT(Properties, '$.AllowedAllVPCs') as allowed_all_vpcs, + JSON_EXTRACT(Properties, '$.VpcIds') as vpc_ids, JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, - JSON_EXTRACT(Properties, '$.VpcSecurityGroups') as vpc_security_groups, - JSON_EXTRACT(Properties, '$.ResourceOwner') as resource_owner, - JSON_EXTRACT(Properties, '$.EndpointStatus') as endpoint_status, - JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name, - JSON_EXTRACT(Properties, '$.EndpointCreateTime') as endpoint_create_time, - JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name, - JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, - JSON_EXTRACT(Properties, '$.VpcEndpoint') as vpc_endpoint - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterStatus') as cluster_status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Address') as address, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Grantee') as grantee, + json_extract_path_text(Properties, 'Account') as account, + json_extract_path_text(Properties, 'Grantor') as grantor, + json_extract_path_text(Properties, 'EndpointCount') as endpoint_count, + json_extract_path_text(Properties, 'AuthorizeTime') as authorize_time, + json_extract_path_text(Properties, 'AllowedVPCs') as allowed_vpcs, + json_extract_path_text(Properties, 'Force') as _force, + json_extract_path_text(Properties, 'AllowedAllVPCs') as allowed_all_vpcs, + json_extract_path_text(Properties, 'VpcIds') as vpc_ids, json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'VpcSecurityGroups') as vpc_security_groups, - json_extract_path_text(Properties, 'ResourceOwner') as resource_owner, - json_extract_path_text(Properties, 'EndpointStatus') as endpoint_status, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'EndpointCreateTime') as endpoint_create_time, - json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'VpcEndpoint') as vpc_endpoint - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' - AND data__Identifier = '' + json_extract_path_text(Properties, 'ClusterStatus') as cluster_status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' + AND data__Identifier = '|' AND region = 'us-east-1' - endpoint_authorizations: - name: endpoint_authorizations - id: awscc.redshift.endpoint_authorizations + endpoint_authorizations_list_only: + name: endpoint_authorizations_list_only + id: awscc.redshift.endpoint_authorizations_list_only x-cfn-schema-name: EndpointAuthorization - x-type: list + x-cfn-type-name: AWS::Redshift::EndpointAuthorization x-identifiers: - ClusterIdentifier - Account + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1430,65 +3040,122 @@ components: json_extract_path_text(Properties, 'Account') as account FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' AND region = 'us-east-1' - endpoint_authorization: - name: endpoint_authorization - id: awscc.redshift.endpoint_authorization - x-cfn-schema-name: EndpointAuthorization - x-type: get + event_subscriptions: + name: event_subscriptions + id: awscc.redshift.event_subscriptions + x-cfn-schema-name: EventSubscription + x-cfn-type-name: AWS::Redshift::EventSubscription x-identifiers: - - ClusterIdentifier - - Account + - SubscriptionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EventSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EventSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::EventSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Grantor') as grantor, - JSON_EXTRACT(Properties, '$.Grantee') as grantee, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, - JSON_EXTRACT(Properties, '$.AuthorizeTime') as authorize_time, - JSON_EXTRACT(Properties, '$.ClusterStatus') as cluster_status, JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.AllowedAllVPCs') as allowed_all_vpcs, - JSON_EXTRACT(Properties, '$.AllowedVPCs') as allowed_vpcs, - JSON_EXTRACT(Properties, '$.EndpointCount') as endpoint_count, - JSON_EXTRACT(Properties, '$.Account') as account, - JSON_EXTRACT(Properties, '$.VpcIds') as vpc_ids, - JSON_EXTRACT(Properties, '$.Force') as _force - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.CustSubscriptionId') as cust_subscription_id, + JSON_EXTRACT(Properties, '$.EventCategoriesList') as event_categories_list, + JSON_EXTRACT(Properties, '$.SourceType') as source_type, + JSON_EXTRACT(Properties, '$.EventCategories') as event_categories, + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.Severity') as severity, + JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name, + JSON_EXTRACT(Properties, '$.SourceIds') as source_ids, + JSON_EXTRACT(Properties, '$.CustomerAwsId') as customer_aws_id, + JSON_EXTRACT(Properties, '$.SourceIdsList') as source_ids_list, + JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, + JSON_EXTRACT(Properties, '$.SubscriptionCreationTime') as subscription_creation_time, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Grantor') as grantor, - json_extract_path_text(Properties, 'Grantee') as grantee, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'AuthorizeTime') as authorize_time, - json_extract_path_text(Properties, 'ClusterStatus') as cluster_status, json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AllowedAllVPCs') as allowed_all_vpcs, - json_extract_path_text(Properties, 'AllowedVPCs') as allowed_vpcs, - json_extract_path_text(Properties, 'EndpointCount') as endpoint_count, - json_extract_path_text(Properties, 'Account') as account, - json_extract_path_text(Properties, 'VpcIds') as vpc_ids, - json_extract_path_text(Properties, 'Force') as _force - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' - AND data__Identifier = '|' + json_extract_path_text(Properties, 'CustSubscriptionId') as cust_subscription_id, + json_extract_path_text(Properties, 'EventCategoriesList') as event_categories_list, + json_extract_path_text(Properties, 'SourceType') as source_type, + json_extract_path_text(Properties, 'EventCategories') as event_categories, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Severity') as severity, + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, + json_extract_path_text(Properties, 'SourceIds') as source_ids, + json_extract_path_text(Properties, 'CustomerAwsId') as customer_aws_id, + json_extract_path_text(Properties, 'SourceIdsList') as source_ids_list, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'SubscriptionCreationTime') as subscription_creation_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' + AND data__Identifier = '' AND region = 'us-east-1' - event_subscriptions: - name: event_subscriptions - id: awscc.redshift.event_subscriptions + event_subscriptions_list_only: + name: event_subscriptions_list_only + id: awscc.redshift.event_subscriptions_list_only x-cfn-schema-name: EventSubscription - x-type: list + x-cfn-type-name: AWS::Redshift::EventSubscription x-identifiers: - SubscriptionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1507,68 +3174,110 @@ components: json_extract_path_text(Properties, 'SubscriptionName') as subscription_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EventSubscription' AND region = 'us-east-1' - event_subscription: - name: event_subscription - id: awscc.redshift.event_subscription - x-cfn-schema-name: EventSubscription - x-type: get + integrations: + name: integrations + id: awscc.redshift.integrations + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::Redshift::Integration x-identifiers: - - SubscriptionName + - IntegrationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::Integration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name, - JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, - JSON_EXTRACT(Properties, '$.SourceType') as source_type, - JSON_EXTRACT(Properties, '$.SourceIds') as source_ids, - JSON_EXTRACT(Properties, '$.EventCategories') as event_categories, - JSON_EXTRACT(Properties, '$.Severity') as severity, - JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn, + JSON_EXTRACT(Properties, '$.IntegrationName') as integration_name, + JSON_EXTRACT(Properties, '$.SourceArn') as source_arn, + JSON_EXTRACT(Properties, '$.TargetArn') as target_arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.CustomerAwsId') as customer_aws_id, - JSON_EXTRACT(Properties, '$.CustSubscriptionId') as cust_subscription_id, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.SubscriptionCreationTime') as subscription_creation_time, - JSON_EXTRACT(Properties, '$.SourceIdsList') as source_ids_list, - JSON_EXTRACT(Properties, '$.EventCategoriesList') as event_categories_list - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CreateTime') as create_time, + JSON_EXTRACT(Properties, '$.KMSKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.AdditionalEncryptionContext') as additional_encryption_context + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Integration' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'SourceType') as source_type, - json_extract_path_text(Properties, 'SourceIds') as source_ids, - json_extract_path_text(Properties, 'EventCategories') as event_categories, - json_extract_path_text(Properties, 'Severity') as severity, - json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn, + json_extract_path_text(Properties, 'IntegrationName') as integration_name, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'TargetArn') as target_arn, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CustomerAwsId') as customer_aws_id, - json_extract_path_text(Properties, 'CustSubscriptionId') as cust_subscription_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'SubscriptionCreationTime') as subscription_creation_time, - json_extract_path_text(Properties, 'SourceIdsList') as source_ids_list, - json_extract_path_text(Properties, 'EventCategoriesList') as event_categories_list - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' - AND data__Identifier = '' + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Integration' + AND data__Identifier = '' AND region = 'us-east-1' - scheduled_actions: - name: scheduled_actions - id: awscc.redshift.scheduled_actions - x-cfn-schema-name: ScheduledAction - x-type: list + integrations_list_only: + name: integrations_list_only + id: awscc.redshift.integrations_list_only + x-cfn-schema-name: Integration + x-cfn-type-name: AWS::Redshift::Integration x-identifiers: - - ScheduledActionName + - IntegrationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1576,61 +3285,629 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' + JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Integration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Integration' AND region = 'us-east-1' - scheduled_action: - name: scheduled_action - id: awscc.redshift.scheduled_action + scheduled_actions: + name: scheduled_actions + id: awscc.redshift.scheduled_actions x-cfn-schema-name: ScheduledAction - x-type: get + x-cfn-type-name: AWS::Redshift::ScheduledAction x-identifiers: - ScheduledActionName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScheduledAction&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ScheduledAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ScheduledAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ScheduledAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ScheduledActionDescription') as scheduled_action_description, JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name, - JSON_EXTRACT(Properties, '$.TargetAction') as target_action, + JSON_EXTRACT(Properties, '$.EndTime') as end_time, + JSON_EXTRACT(Properties, '$.State') as state, JSON_EXTRACT(Properties, '$.Schedule') as schedule, JSON_EXTRACT(Properties, '$.IamRole') as iam_role, - JSON_EXTRACT(Properties, '$.ScheduledActionDescription') as scheduled_action_description, JSON_EXTRACT(Properties, '$.StartTime') as start_time, - JSON_EXTRACT(Properties, '$.EndTime') as end_time, JSON_EXTRACT(Properties, '$.Enable') as enable, - JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.TargetAction') as target_action, JSON_EXTRACT(Properties, '$.NextInvocations') as next_invocations FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'ScheduledActionDescription') as scheduled_action_description, json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, - json_extract_path_text(Properties, 'TargetAction') as target_action, + json_extract_path_text(Properties, 'EndTime') as end_time, + json_extract_path_text(Properties, 'State') as state, json_extract_path_text(Properties, 'Schedule') as schedule, json_extract_path_text(Properties, 'IamRole') as iam_role, - json_extract_path_text(Properties, 'ScheduledActionDescription') as scheduled_action_description, json_extract_path_text(Properties, 'StartTime') as start_time, - json_extract_path_text(Properties, 'EndTime') as end_time, json_extract_path_text(Properties, 'Enable') as enable, - json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'TargetAction') as target_action, json_extract_path_text(Properties, 'NextInvocations') as next_invocations FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' AND data__Identifier = '' AND region = 'us-east-1' + scheduled_actions_list_only: + name: scheduled_actions_list_only + id: awscc.redshift.scheduled_actions_list_only + x-cfn-schema-name: ScheduledAction + x-cfn-type-name: AWS::Redshift::ScheduledAction + x-identifiers: + - ScheduledActionName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ClusterParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateClusterParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ClusterSubnetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateClusterSubnetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterSubnetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EndpointAccess&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEndpointAccess + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEndpointAccessRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EndpointAuthorization&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEndpointAuthorization + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEndpointAuthorizationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EventSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEventSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEventSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Integration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIntegration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIntegrationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScheduledAction&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScheduledAction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduledActionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/redshiftserverless.yaml b/providers/src/awscc/v00.00.00000/services/redshiftserverless.yaml index 0831d037..5adfa0d0 100644 --- a/providers/src/awscc/v00.00.00000/services/redshiftserverless.yaml +++ b/providers/src/awscc/v00.00.00000/services/redshiftserverless.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: RedshiftServerless - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: LogExport: type: string @@ -99,11 +479,18 @@ components: required: - NamespaceName x-stackql-resource-name: namespace - x-stackql-primaryIdentifier: + description: Definition of AWS::RedshiftServerless::Namespace Resource Type + x-type-name: AWS::RedshiftServerless::Namespace + x-stackql-primary-identifier: - NamespaceName x-create-only-properties: - NamespaceName - - Tags + x-write-only-properties: + - AdminUserPassword + - FinalSnapshotName + - FinalSnapshotRetentionPeriod + - ManageAdminPassword + - RedshiftIdcApplicationArn x-read-only-properties: - Namespace - Namespace/NamespaceArn @@ -117,8 +504,21 @@ components: - Namespace/LogExports - Namespace/Status - Namespace/CreationDate + x-required-properties: + - NamespaceName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:UntagResource x-required-permissions: create: + - iam:CreateServiceLinkedRole - iam:PassRole - kms:TagResource - kms:UntagResource @@ -137,6 +537,8 @@ components: - redshift-serverless:GetNamespace - redshift-serverless:ListSnapshotCopyConfigurations - redshift-serverless:CreateSnapshotCopyConfiguration + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource - redshift:GetResourcePolicy - redshift:PutResourcePolicy - secretsmanager:CreateSecret @@ -146,6 +548,7 @@ components: read: - iam:PassRole - redshift-serverless:GetNamespace + - redshift-serverless:ListTagsForResource - redshift:GetResourcePolicy - redshift-serverless:ListSnapshotCopyConfigurations update: @@ -169,6 +572,9 @@ components: - redshift-serverless:CreateSnapshotCopyConfiguration - redshift-serverless:UpdateSnapshotCopyConfiguration - redshift-serverless:DeleteSnapshotCopyConfiguration + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:UntagResource - redshift:GetResourcePolicy - redshift:PutResourcePolicy - redshift:DeleteResourcePolicy @@ -182,6 +588,8 @@ components: - iam:PassRole - redshift-serverless:DeleteNamespace - redshift-serverless:GetNamespace + - redshift-serverless:ListTagsForResource + - redshift-serverless:UntagResource - kms:RetireGrant - secretsmanager:DescribeSecret - secretsmanager:DeleteSecret @@ -189,6 +597,7 @@ components: list: - iam:PassRole - redshift-serverless:ListNamespaces + - redshift-serverless:ListTagsForResource NamespaceStatus: type: string enum: @@ -222,6 +631,114 @@ components: required: - DestinationRegion additionalProperties: false + SnapshotStatus: + type: string + enum: + - AVAILABLE + - CREATING + - DELETED + - CANCELLED + - FAILED + - COPYING + Snapshot: + type: object + properties: + SnapshotName: + description: The name of the snapshot. + type: string + pattern: ^(?=^[a-z0-9-]+$).{3,64}$ + maxLength: 64 + minLength: 3 + NamespaceName: + description: The namespace the snapshot is associated with. + type: string + pattern: ^(?=^[a-z0-9-]+$).{3,64}$ + maxLength: 64 + minLength: 3 + OwnerAccount: + description: The owner account of the snapshot. + type: string + RetentionPeriod: + description: The retention period of the snapshot. + type: integer + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Snapshot: + description: Definition for snapshot resource + $ref: '#/components/schemas/Snapshot' + required: + - SnapshotName + x-stackql-resource-name: snapshot + description: Resource Type definition for AWS::RedshiftServerless::Snapshot Resource Type. + x-type-name: AWS::RedshiftServerless::Snapshot + x-stackql-primary-identifier: + - SnapshotName + x-create-only-properties: + - NamespaceName + - SnapshotName + - Tags + - Tags/*/Key + - Tags/*/Value + x-read-only-properties: + - Snapshot + - OwnerAccount + - Snapshot/SnapshotName + - Snapshot/NamespaceName + - Snapshot/NamespaceArn + - Snapshot/SnapshotArn + - Snapshot/SnapshotCreateTime + - Snapshot/Status + - Snapshot/AdminUsername + - Snapshot/KmsKeyId + - Snapshot/OwnerAccount + - Snapshot/RetentionPeriod + x-required-properties: + - SnapshotName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:UntagResource + x-required-permissions: + create: + - redshift-serverless:CreateSnapshot + - redshift-serverless:GetSnapshot + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:GetNamespace + read: + - redshift-serverless:GetSnapshot + - redshift-serverless:ListTagsForResource + - redshift-serverless:GetNamespace + update: + - redshift-serverless:UpdateSnapshot + - redshift-serverless:GetSnapshot + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:UntagResource + - redshift-serverless:GetNamespace + delete: + - redshift-serverless:DeleteSnapshot + - redshift-serverless:GetSnapshot + - redshift-serverless:ListTagsForResource + - redshift-serverless:UntagResource + - redshift-serverless:GetNamespace + list: + - redshift-serverless:ListSnapshots + - redshift-serverless:GetSnapshot + - redshift-serverless:ListTagsForResource + - redshift-serverless:GetNamespace ConfigParameter: type: object properties: @@ -259,6 +776,16 @@ components: AvailabilityZone: type: string additionalProperties: false + PerformanceTarget: + type: object + properties: + Status: + $ref: '#/components/schemas/PerformanceTargetStatus' + Level: + type: integer + minimum: 1 + maximum: 100 + additionalProperties: false VpcEndpoint: type: object properties: @@ -334,6 +861,22 @@ components: Port: description: The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. type: integer + PricePerformanceTarget: + description: A property that represents the price performance target settings for the workgroup. + type: object + $ref: '#/components/schemas/PerformanceTarget' + SnapshotArn: + description: The Amazon Resource Name (ARN) of the snapshot to restore from. + type: string + SnapshotName: + description: The snapshot name to restore from. + type: string + SnapshotOwnerAccount: + description: The Amazon Web Services account that owns the snapshot. + type: string + RecoveryPointId: + description: The recovery point id to restore from. + type: string Tags: description: The map of the key-value pairs used to tag the workgroup. type: array @@ -342,19 +885,33 @@ components: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 0 + TrackName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_]+$ Workgroup: description: Definition for workgroup resource $ref: '#/components/schemas/Workgroup' required: - WorkgroupName x-stackql-resource-name: workgroup - x-stackql-primaryIdentifier: + description: Definition of AWS::RedshiftServerless::Workgroup Resource Type + x-type-name: AWS::RedshiftServerless::Workgroup + x-stackql-primary-identifier: - WorkgroupName x-create-only-properties: - WorkgroupName - NamespaceName + x-write-only-properties: + - ConfigParameters + - SecurityGroupIds + - SubnetIds + - SnapshotArn + - SnapshotName + - SnapshotOwnerAccount + - RecoveryPointId x-read-only-properties: - - Workgroup - Workgroup/WorkgroupId - Workgroup/WorkgroupArn - Workgroup/WorkgroupName @@ -366,6 +923,7 @@ components: - Workgroup/ConfigParameters/*/ParameterValue - Workgroup/SecurityGroupIds - Workgroup/SubnetIds + - Workgroup/TrackName - Workgroup/Status - Workgroup/Endpoint/Address - Workgroup/Endpoint/Port @@ -377,6 +935,18 @@ components: - Workgroup/Endpoint/VpcEndpoints/*/NetworkInterfaces/*/AvailabilityZone - Workgroup/PubliclyAccessible - Workgroup/CreationDate + x-required-properties: + - WorkgroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:UntagResource x-required-permissions: create: - ec2:DescribeVpcAttribute @@ -389,6 +959,11 @@ components: - redshift-serverless:CreateNamespace - redshift-serverless:CreateWorkgroup - redshift-serverless:GetWorkgroup + - redshift-serverless:GetNamespace + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:RestoreFromSnapshot + - redshift-serverless:RestoreFromRecoveryPoint read: - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups @@ -398,6 +973,7 @@ components: - ec2:DescribeAccountAttributes - ec2:DescribeAvailabilityZones - redshift-serverless:GetWorkgroup + - redshift-serverless:ListTagsForResource update: - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups @@ -411,6 +987,11 @@ components: - redshift-serverless:UntagResource - redshift-serverless:GetWorkgroup - redshift-serverless:UpdateWorkgroup + - redshift-serverless:ListTagsForResource + - redshift-serverless:TagResource + - redshift-serverless:UntagResource + - redshift-serverless:RestoreFromSnapshot + - redshift-serverless:RestoreFromRecoveryPoint delete: - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups @@ -420,7 +1001,10 @@ components: - ec2:DescribeAccountAttributes - ec2:DescribeAvailabilityZones - redshift-serverless:GetWorkgroup + - redshift-serverless:GetNamespace - redshift-serverless:DeleteWorkgroup + - redshift-serverless:ListTagsForResource + - redshift-serverless:UntagResource list: - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups @@ -430,6 +1014,7 @@ components: - ec2:DescribeAccountAttributes - ec2:DescribeAvailabilityZones - redshift-serverless:ListWorkgroups + - redshift-serverless:ListTagsForResource WorkgroupStatus: type: string enum: @@ -437,43 +1022,331 @@ components: - AVAILABLE - MODIFYING - DELETING + PerformanceTargetStatus: + type: string + enum: + - ENABLED + - DISABLED + CreateNamespaceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdminPasswordSecretKmsKeyId: + description: The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true. + type: string + AdminUserPassword: + description: The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true. + type: string + maxLength: 64 + minLength: 8 + pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[^\x00-\x20\x22\x27\x2f\x40\x5c\x7f-\uffff]+ + AdminUsername: + description: The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. + type: string + pattern: '[a-zA-Z][a-zA-Z_0-9+.@-]*' + DbName: + description: The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. + type: string + pattern: '[a-zA-Z][a-zA-Z_0-9+.@-]*' + maxLength: 127 + DefaultIamRoleArn: + description: The default IAM role ARN for the namespace that is being created. + type: string + IamRoles: + description: A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10. + type: array + x-insertionOrder: false + items: + type: string + maxLength: 512 + minLength: 0 + KmsKeyId: + description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace. + type: string + LogExports: + description: 'The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog' + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/LogExport' + maxItems: 16 + minItems: 0 + ManageAdminPassword: + description: If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password. + type: boolean + Namespace: + $ref: '#/components/schemas/Namespace' + description: Definition of Namespace resource. + NamespaceName: + description: A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account. + type: string + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9-]+$ + Tags: + description: The list of tags for the namespace. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + FinalSnapshotName: + description: The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace + type: string + pattern: '[a-z][a-z0-9]*(-[a-z0-9]+)*' + maxLength: 255 + FinalSnapshotRetentionPeriod: + description: The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. + type: integer + NamespaceResourcePolicy: + description: The resource policy document that will be attached to the namespace. + type: object + RedshiftIdcApplicationArn: + description: The ARN for the Redshift application that integrates with IAM Identity Center. + type: string + SnapshotCopyConfigurations: + description: The snapshot copy configurations for the namespace. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SnapshotCopyConfiguration' + maxItems: 1 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateNamespaceRequest + type: object + required: [] + CreateSnapshotRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SnapshotName: + description: The name of the snapshot. + type: string + pattern: ^(?=^[a-z0-9-]+$).{3,64}$ + maxLength: 64 + minLength: 3 + NamespaceName: + description: The namespace the snapshot is associated with. + type: string + pattern: ^(?=^[a-z0-9-]+$).{3,64}$ + maxLength: 64 + minLength: 3 + OwnerAccount: + description: The owner account of the snapshot. + type: string + RetentionPeriod: + description: The retention period of the snapshot. + type: integer + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Snapshot: + description: Definition for snapshot resource + $ref: '#/components/schemas/Snapshot' + x-stackQL-stringOnly: true + x-title: CreateSnapshotRequest + type: object + required: [] + CreateWorkgroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkgroupName: + description: The name of the workgroup. + type: string + pattern: ^(?=^[a-z0-9-]+$).{3,64}$ + maxLength: 64 + minLength: 3 + NamespaceName: + description: The namespace the workgroup is associated with. + type: string + pattern: ^(?=^[a-z0-9-]+$).{3,64}$ + maxLength: 64 + minLength: 3 + BaseCapacity: + description: The base compute capacity of the workgroup in Redshift Processing Units (RPUs). + type: integer + MaxCapacity: + description: The max compute capacity of the workgroup in Redshift Processing Units (RPUs). + type: integer + EnhancedVpcRouting: + description: The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. + type: boolean + default: false + ConfigParameters: + description: A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ConfigParameter' + minItems: 1 + SecurityGroupIds: + description: A list of security group IDs to associate with the workgroup. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^sg-[0-9a-fA-F]{8,}$ + maxLength: 255 + minLength: 0 + maxItems: 32 + minItems: 1 + SubnetIds: + description: A list of subnet IDs the workgroup is associated with. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^subnet-[0-9a-fA-F]{8,}$ + maxLength: 255 + minLength: 0 + maxItems: 32 + minItems: 1 + PubliclyAccessible: + description: A value that specifies whether the workgroup can be accessible from a public network. + type: boolean + default: false + Port: + description: The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. + type: integer + PricePerformanceTarget: + description: A property that represents the price performance target settings for the workgroup. + type: object + $ref: '#/components/schemas/PerformanceTarget' + SnapshotArn: + description: The Amazon Resource Name (ARN) of the snapshot to restore from. + type: string + SnapshotName: + description: The snapshot name to restore from. + type: string + SnapshotOwnerAccount: + description: The Amazon Web Services account that owns the snapshot. + type: string + RecoveryPointId: + description: The recovery point id to restore from. + type: string + Tags: + description: The map of the key-value pairs used to tag the workgroup. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + TrackName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_]+$ + Workgroup: + description: Definition for workgroup resource + $ref: '#/components/schemas/Workgroup' + x-stackQL-stringOnly: true + x-title: CreateWorkgroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: namespaces: name: namespaces id: awscc.redshiftserverless.namespaces x-cfn-schema-name: Namespace - x-type: list - x-identifiers: - - NamespaceName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NamespaceName') as namespace_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NamespaceName') as namespace_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' - AND region = 'us-east-1' - namespace: - name: namespace - id: awscc.redshiftserverless.namespace - x-cfn-schema-name: Namespace - x-type: get + x-cfn-type-name: AWS::RedshiftServerless::Namespace x-identifiers: - NamespaceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Namespace&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Namespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Namespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Namespace" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -499,7 +1372,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -524,13 +1397,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' AND data__Identifier = '' AND region = 'us-east-1' - workgroups: - name: workgroups - id: awscc.redshiftserverless.workgroups - x-cfn-schema-name: Workgroup - x-type: list + namespaces_list_only: + name: namespaces_list_only + id: awscc.redshiftserverless.namespaces_list_only + x-cfn-schema-name: Namespace + x-cfn-type-name: AWS::RedshiftServerless::Namespace x-identifiers: - - WorkgroupName + - NamespaceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -538,28 +1417,194 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.WorkgroupName') as workgroup_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' + JSON_EXTRACT(Properties, '$.NamespaceName') as namespace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'WorkgroupName') as workgroup_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' + json_extract_path_text(Properties, 'NamespaceName') as namespace_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' AND region = 'us-east-1' - workgroup: - name: workgroup - id: awscc.redshiftserverless.workgroup + snapshots: + name: snapshots + id: awscc.redshiftserverless.snapshots + x-cfn-schema-name: Snapshot + x-cfn-type-name: AWS::RedshiftServerless::Snapshot + x-identifiers: + - SnapshotName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Snapshot&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Snapshot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Snapshot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Snapshot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.SnapshotName') as snapshot_name, + JSON_EXTRACT(Properties, '$.NamespaceName') as namespace_name, + JSON_EXTRACT(Properties, '$.OwnerAccount') as owner_account, + JSON_EXTRACT(Properties, '$.RetentionPeriod') as retention_period, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Snapshot') as snapshot + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Snapshot' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SnapshotName') as snapshot_name, + json_extract_path_text(Properties, 'NamespaceName') as namespace_name, + json_extract_path_text(Properties, 'OwnerAccount') as owner_account, + json_extract_path_text(Properties, 'RetentionPeriod') as retention_period, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Snapshot') as snapshot + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Snapshot' + AND data__Identifier = '' + AND region = 'us-east-1' + snapshots_list_only: + name: snapshots_list_only + id: awscc.redshiftserverless.snapshots_list_only + x-cfn-schema-name: Snapshot + x-cfn-type-name: AWS::RedshiftServerless::Snapshot + x-identifiers: + - SnapshotName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SnapshotName') as snapshot_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Snapshot' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SnapshotName') as snapshot_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Snapshot' + AND region = 'us-east-1' + workgroups: + name: workgroups + id: awscc.redshiftserverless.workgroups x-cfn-schema-name: Workgroup - x-type: get + x-cfn-type-name: AWS::RedshiftServerless::Workgroup x-identifiers: - WorkgroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workgroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Workgroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Workgroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RedshiftServerless::Workgroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workgroups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workgroups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workgroups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -574,13 +1619,19 @@ components: JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, JSON_EXTRACT(Properties, '$.Port') as port, + JSON_EXTRACT(Properties, '$.PricePerformanceTarget') as price_performance_target, + JSON_EXTRACT(Properties, '$.SnapshotArn') as snapshot_arn, + JSON_EXTRACT(Properties, '$.SnapshotName') as snapshot_name, + JSON_EXTRACT(Properties, '$.SnapshotOwnerAccount') as snapshot_owner_account, + JSON_EXTRACT(Properties, '$.RecoveryPointId') as recovery_point_id, JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TrackName') as track_name, JSON_EXTRACT(Properties, '$.Workgroup') as workgroup FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -595,8 +1646,324 @@ components: json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'PricePerformanceTarget') as price_performance_target, + json_extract_path_text(Properties, 'SnapshotArn') as snapshot_arn, + json_extract_path_text(Properties, 'SnapshotName') as snapshot_name, + json_extract_path_text(Properties, 'SnapshotOwnerAccount') as snapshot_owner_account, + json_extract_path_text(Properties, 'RecoveryPointId') as recovery_point_id, json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrackName') as track_name, json_extract_path_text(Properties, 'Workgroup') as workgroup FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' AND data__Identifier = '' AND region = 'us-east-1' + workgroups_list_only: + name: workgroups_list_only + id: awscc.redshiftserverless.workgroups_list_only + x-cfn-schema-name: Workgroup + x-cfn-type-name: AWS::RedshiftServerless::Workgroup + x-identifiers: + - WorkgroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkgroupName') as workgroup_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkgroupName') as workgroup_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Namespace&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNamespace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNamespaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Snapshot&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSnapshot + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSnapshotRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workgroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkgroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkgroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/refactorspaces.yaml b/providers/src/awscc/v00.00.00000/services/refactorspaces.yaml index cfa4210b..f31e7514 100644 --- a/providers/src/awscc/v00.00.00000/services/refactorspaces.yaml +++ b/providers/src/awscc/v00.00.00000/services/refactorspaces.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: RefactorSpaces - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ApiGatewayEndpointType: type: string @@ -118,7 +498,9 @@ components: - Name - ProxyType x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Definition of AWS::RefactorSpaces::Application Resource Type + x-type-name: AWS::RefactorSpaces::Application + x-stackql-primary-identifier: - EnvironmentIdentifier - ApplicationIdentifier x-create-only-properties: @@ -127,6 +509,8 @@ components: - Name - ProxyType - VpcId + x-write-only-properties: + - ApiGatewayProxy x-read-only-properties: - ApplicationIdentifier - Arn @@ -136,6 +520,12 @@ components: - NlbName - ProxyUrl - StageName + x-required-properties: + - EnvironmentIdentifier + - VpcId + - Name + - ProxyType + x-taggable: true x-required-permissions: create: - refactor-spaces:GetApplication @@ -155,10 +545,6 @@ components: - apigateway:POST - apigateway:PUT - apigateway:UpdateRestApiPolicy - - apigateway:Update* - - apigateway:Delete* - - apigateway:Get* - - apigateway:Put* - elasticloadbalancing:CreateLoadBalancer - elasticloadbalancing:DescribeLoadBalancers - elasticloadbalancing:DescribeTags @@ -180,10 +566,10 @@ components: - ec2:DeleteTags - ec2:RevokeSecurityGroupIngress - elasticloadbalancing:DeleteLoadBalancer - - apigateway:Update* - - apigateway:Delete* - - apigateway:Get* - - apigateway:Put* + - apigateway:DELETE + - apigateway:GET + - apigateway:PUT + - apigateway:UpdateRestApiPolicy list: - refactor-spaces:ListApplications - refactor-spaces:ListTagsForResource @@ -228,20 +614,33 @@ components: items: $ref: '#/components/schemas/Tag' description: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. - required: - - Name - - NetworkFabricType x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: Definition of AWS::RefactorSpaces::Environment Resource Type + x-type-name: AWS::RefactorSpaces::Environment + x-stackql-primary-identifier: - EnvironmentIdentifier x-create-only-properties: - Description - Name - NetworkFabricType + x-write-only-properties: + - Description + - Name + - NetworkFabricType x-read-only-properties: - EnvironmentIdentifier - Arn - TransitGatewayId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - refactor-spaces:TagResource + - refactor-spaces:ListTagsForResource + - refactor-spaces:UntagResource x-required-permissions: create: - refactor-spaces:CreateEnvironment @@ -274,6 +673,10 @@ components: read: - refactor-spaces:GetEnvironment - refactor-spaces:ListTagsForResource + update: + - refactor-spaces:GetEnvironment + - refactor-spaces:TagResource + - refactor-spaces:UntagResource delete: - refactor-spaces:GetEnvironment - refactor-spaces:DeleteEnvironment @@ -386,7 +789,9 @@ components: - ServiceIdentifier - RouteType x-stackql-resource-name: route - x-stackql-primaryIdentifier: + description: Definition of AWS::RefactorSpaces::Route Resource Type + x-type-name: AWS::RefactorSpaces::Route + x-stackql-primary-identifier: - EnvironmentIdentifier - ApplicationIdentifier - RouteIdentifier @@ -399,10 +804,21 @@ components: - UriPathRoute/Methods - UriPathRoute/IncludeChildPaths - UriPathRoute/AppendSourcePath + x-write-only-properties: + - RouteType + - ServiceIdentifier + - DefaultRoute + - UriPathRoute x-read-only-properties: - RouteIdentifier - PathResourceToId - Arn + x-required-properties: + - EnvironmentIdentifier + - ApplicationIdentifier + - ServiceIdentifier + - RouteType + x-taggable: true x-required-permissions: create: - refactor-spaces:CreateRoute @@ -571,7 +987,9 @@ components: - EndpointType - Name x-stackql-resource-name: service - x-stackql-primaryIdentifier: + description: Definition of AWS::RefactorSpaces::Service Resource Type + x-type-name: AWS::RefactorSpaces::Service + x-stackql-primary-identifier: - EnvironmentIdentifier - ApplicationIdentifier - ServiceIdentifier @@ -584,9 +1002,22 @@ components: - Name - UrlEndpoint - VpcId + x-write-only-properties: + - Description + - EndpointType + - LambdaEndpoint + - Name + - UrlEndpoint + - VpcId x-read-only-properties: - ServiceIdentifier - Arn + x-required-properties: + - EnvironmentIdentifier + - ApplicationIdentifier + - EndpointType + - Name + x-taggable: true x-required-permissions: create: - refactor-spaces:CreateService @@ -603,7 +1034,7 @@ components: - ec2:CreateRoute - lambda:GetFunctionConfiguration read: - - refactor-spacess:GetService + - refactor-spaces:GetService - refactor-spaces:ListTagsForResource delete: - refactor-spaces:DeleteService @@ -622,47 +1053,313 @@ components: list: - refactor-spaces:ListServices - refactor-spaces:ListTagsForResource + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApiGatewayProxy: + $ref: '#/components/schemas/ApiGatewayProxyInput' + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$ + ApiGatewayId: + type: string + maxLength: 10 + minLength: 10 + pattern: ^[a-z0-9]{10}$ + VpcLinkId: + type: string + maxLength: 10 + minLength: 10 + pattern: ^[a-z0-9]{10}$ + NlbArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:(aws[a-zA-Z-]*)?:elasticloadbalancing:[a-zA-Z0-9\\-]+:\\w{12}:[a-zA-Z_0-9+=,.@\\-_\/]+$ + NlbName: + type: string + maxLength: 32 + minLength: 1 + pattern: ^(?!internal-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+.*[^-]$ + ApplicationIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^app-([0-9A-Za-z]{10}$) + EnvironmentIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^env-([0-9A-Za-z]{10}$) + Name: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$ + ProxyType: + $ref: '#/components/schemas/ProxyType' + VpcId: + type: string + maxLength: 21 + minLength: 12 + pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$ + StageName: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[-a-zA-Z0-9_]*$ + ProxyUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^http://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + description: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$ + EnvironmentIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^env-([0-9A-Za-z]{10}$) + Name: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$ + NetworkFabricType: + $ref: '#/components/schemas/NetworkFabricType' + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$ + TransitGatewayId: + type: string + maxLength: 21 + minLength: 21 + pattern: ^tgw-[-a-f0-9]{17}$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + description: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + CreateRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PathResourceToId: + type: string + Arn: + type: string + minLength: 20 + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$ + ApplicationIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^app-([0-9A-Za-z]{10}$) + EnvironmentIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^env-([0-9A-Za-z]{10}$) + RouteIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^rte-([0-9A-Za-z]{10}$) + RouteType: + $ref: '#/components/schemas/RouteType' + ServiceIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^svc-([0-9A-Za-z]{10}$) + DefaultRoute: + $ref: '#/components/schemas/DefaultRouteInput' + UriPathRoute: + $ref: '#/components/schemas/UriPathRouteInput' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + description: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. + x-stackQL-stringOnly: true + x-title: CreateRouteRequest + type: object + required: [] + CreateServiceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + minLength: 20 + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$ + ApplicationIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^app-([0-9A-Za-z]{10}$) + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$ + EndpointType: + $ref: '#/components/schemas/ServiceEndpointType' + EnvironmentIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^env-([0-9A-Za-z]{10}$) + LambdaEndpoint: + $ref: '#/components/schemas/LambdaEndpointInput' + Name: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$ + ServiceIdentifier: + type: string + maxLength: 14 + minLength: 14 + pattern: ^svc-([0-9A-Za-z]{10}$) + UrlEndpoint: + $ref: '#/components/schemas/UrlEndpointInput' + VpcId: + type: string + maxLength: 21 + minLength: 12 + pattern: ^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + description: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. + x-stackQL-stringOnly: true + x-title: CreateServiceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.refactorspaces.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - EnvironmentIdentifier - - ApplicationIdentifier - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, - JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.refactorspaces.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::RefactorSpaces::Application x-identifiers: - EnvironmentIdentifier - ApplicationIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -685,7 +1382,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -707,13 +1404,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Application' AND data__Identifier = '|' AND region = 'us-east-1' - environments: - name: environments - id: awscc.refactorspaces.environments - x-cfn-schema-name: Environment - x-type: list + applications_list_only: + name: applications_list_only + id: awscc.refactorspaces.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::RefactorSpaces::Application x-identifiers: - EnvironmentIdentifier + - ApplicationIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -721,28 +1425,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' AND region = 'us-east-1' - environment: - name: environment - id: awscc.refactorspaces.environment + environments: + name: environments + id: awscc.refactorspaces.environments x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::RefactorSpaces::Environment x-identifiers: - EnvironmentIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -758,7 +1512,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -773,15 +1527,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' AND data__Identifier = '' AND region = 'us-east-1' - routes: - name: routes - id: awscc.refactorspaces.routes - x-cfn-schema-name: Route - x-type: list + environments_list_only: + name: environments_list_only + id: awscc.refactorspaces.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::RefactorSpaces::Environment x-identifiers: - EnvironmentIdentifier - - ApplicationIdentifier - - RouteIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -789,34 +1547,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, - JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, - JSON_EXTRACT(Properties, '$.RouteIdentifier') as route_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'RouteIdentifier') as route_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' AND region = 'us-east-1' - route: - name: route - id: awscc.refactorspaces.route + routes: + name: routes + id: awscc.refactorspaces.routes x-cfn-schema-name: Route - x-type: get + x-cfn-type-name: AWS::RefactorSpaces::Route x-identifiers: - EnvironmentIdentifier - ApplicationIdentifier - RouteIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Route&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Route" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -835,7 +1637,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -853,15 +1655,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Route' AND data__Identifier = '||' AND region = 'us-east-1' - services: - name: services - id: awscc.refactorspaces.services - x-cfn-schema-name: Service - x-type: list + routes_list_only: + name: routes_list_only + id: awscc.refactorspaces.routes_list_only + x-cfn-schema-name: Route + x-cfn-type-name: AWS::RefactorSpaces::Route x-identifiers: - EnvironmentIdentifier - ApplicationIdentifier - - ServiceIdentifier + - RouteIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -871,8 +1679,8 @@ components: region, JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, - JSON_EXTRACT(Properties, '$.ServiceIdentifier') as service_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' + JSON_EXTRACT(Properties, '$.RouteIdentifier') as route_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -881,22 +1689,57 @@ components: region, json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' + json_extract_path_text(Properties, 'RouteIdentifier') as route_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' AND region = 'us-east-1' - service: - name: service - id: awscc.refactorspaces.service + services: + name: services + id: awscc.refactorspaces.services x-cfn-schema-name: Service - x-type: get + x-cfn-type-name: AWS::RefactorSpaces::Service x-identifiers: - EnvironmentIdentifier - ApplicationIdentifier - ServiceIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RefactorSpaces::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -916,7 +1759,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -935,3 +1778,361 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Service' AND data__Identifier = '||' AND region = 'us-east-1' + services_list_only: + name: services_list_only + id: awscc.refactorspaces.services_list_only + x-cfn-schema-name: Service + x-cfn-type-name: AWS::RefactorSpaces::Service + x-identifiers: + - EnvironmentIdentifier + - ApplicationIdentifier + - ServiceIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, + JSON_EXTRACT(Properties, '$.ServiceIdentifier') as service_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Route&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateService + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/rekognition.yaml b/providers/src/awscc/v00.00.00000/services/rekognition.yaml index 4bbb398c..fa02581e 100644 --- a/providers/src/awscc/v00.00.00000/services/rekognition.yaml +++ b/providers/src/awscc/v00.00.00000/services/rekognition.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Rekognition - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: description: The ARN of the stream processor @@ -53,12 +433,26 @@ components: required: - CollectionId x-stackql-resource-name: collection - x-stackql-primaryIdentifier: + description: The AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group + x-type-name: AWS::Rekognition::Collection + x-stackql-primary-identifier: - CollectionId x-create-only-properties: - CollectionId x-read-only-properties: - Arn + x-required-properties: + - CollectionId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rekognition:ListTagsForResource + - rekognition:TagResource + - rekognition:UntagResource x-required-permissions: create: - rekognition:CreateCollection @@ -93,12 +487,16 @@ components: required: - ProjectName x-stackql-resource-name: project - x-stackql-primaryIdentifier: + description: The AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions. + x-type-name: AWS::Rekognition::Project + x-stackql-primary-identifier: - ProjectName x-create-only-properties: - ProjectName x-read-only-properties: - Arn + x-required-properties: + - ProjectName x-required-permissions: create: - rekognition:CreateProject @@ -327,7 +725,11 @@ components: - RoleArn - KinesisVideoStream x-stackql-resource-name: stream_processor - x-stackql-primaryIdentifier: + description: |+ + The AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos. + + x-type-name: AWS::Rekognition::StreamProcessor + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -346,6 +748,20 @@ components: - Arn - Status - StatusMessage + x-required-properties: + - RoleArn + - KinesisVideoStream + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - rekognition:TagResource + - rekognition:UntagResource + - rekognition:ListTagsForResource x-required-permissions: create: - rekognition:CreateStreamProcessor @@ -365,43 +781,202 @@ components: - rekognition:DeleteStreamProcessor list: - rekognition:ListStreamProcessors + CreateCollectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + CollectionId: + $ref: '#/components/schemas/CollectionId' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateCollectionRequest + type: object + required: [] + CreateProjectRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + ProjectName: + $ref: '#/components/schemas/ProjectName' + x-stackQL-stringOnly: true + x-title: CreateProjectRequest + type: object + required: [] + CreateStreamProcessorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + Name: + description: Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor. + type: string + minLength: 1 + maxLength: 128 + pattern: '[a-zA-Z0-9_.\-]+' + KmsKeyId: + description: The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket. + type: string + RoleArn: + description: ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic. + type: string + maxLength: 2048 + pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.* + KinesisVideoStream: + $ref: '#/components/schemas/KinesisVideoStream' + FaceSearchSettings: + $ref: '#/components/schemas/FaceSearchSettings' + ConnectedHomeSettings: + $ref: '#/components/schemas/ConnectedHomeSettings' + KinesisDataStream: + $ref: '#/components/schemas/KinesisDataStream' + S3Destination: + $ref: '#/components/schemas/S3Destination' + NotificationChannel: + $ref: '#/components/schemas/NotificationChannel' + DataSharingPreference: + $ref: '#/components/schemas/DataSharingPreference' + PolygonRegionsOfInterest: + description: The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + items: + $ref: '#/components/schemas/Polygon' + BoundingBoxRegionsOfInterest: + description: The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + items: + $ref: '#/components/schemas/BoundingBox' + Status: + description: Current status of the stream processor. + type: string + StatusMessage: + description: Detailed status message about the stream processor. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStreamProcessorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: collections: name: collections id: awscc.rekognition.collections x-cfn-schema-name: Collection - x-type: list - x-identifiers: - - CollectionId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CollectionId') as collection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CollectionId') as collection_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' - AND region = 'us-east-1' - collection: - name: collection - id: awscc.rekognition.collection - x-cfn-schema-name: Collection - x-type: get + x-cfn-type-name: AWS::Rekognition::Collection x-identifiers: - CollectionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Collection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::Collection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::Collection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::Collection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/collections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -413,7 +988,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -424,13 +999,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::Collection' AND data__Identifier = '' AND region = 'us-east-1' - projects: - name: projects - id: awscc.rekognition.projects - x-cfn-schema-name: Project - x-type: list + collections_list_only: + name: collections_list_only + id: awscc.rekognition.collections_list_only + x-cfn-schema-name: Collection + x-cfn-type-name: AWS::Rekognition::Collection x-identifiers: - - ProjectName + - CollectionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -438,28 +1019,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProjectName') as project_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' + JSON_EXTRACT(Properties, '$.CollectionId') as collection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProjectName') as project_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' + json_extract_path_text(Properties, 'CollectionId') as collection_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' AND region = 'us-east-1' - project: - name: project - id: awscc.rekognition.project + projects: + name: projects + id: awscc.rekognition.projects x-cfn-schema-name: Project - x-type: get + x-cfn-type-name: AWS::Rekognition::Project x-identifiers: - ProjectName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -470,7 +1086,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -480,13 +1096,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::Project' AND data__Identifier = '' AND region = 'us-east-1' - stream_processors: - name: stream_processors - id: awscc.rekognition.stream_processors - x-cfn-schema-name: StreamProcessor - x-type: list + projects_list_only: + name: projects_list_only + id: awscc.rekognition.projects_list_only + x-cfn-schema-name: Project + x-cfn-type-name: AWS::Rekognition::Project x-identifiers: - - Name + - ProjectName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -494,28 +1116,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' + JSON_EXTRACT(Properties, '$.ProjectName') as project_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' + json_extract_path_text(Properties, 'ProjectName') as project_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' AND region = 'us-east-1' - stream_processor: - name: stream_processor - id: awscc.rekognition.stream_processor + stream_processors: + name: stream_processors + id: awscc.rekognition.stream_processors x-cfn-schema-name: StreamProcessor - x-type: get + x-cfn-type-name: AWS::Rekognition::StreamProcessor x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StreamProcessor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::StreamProcessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::StreamProcessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Rekognition::StreamProcessor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stream_processors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stream_processors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/stream_processors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -540,7 +1210,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -564,3 +1234,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' AND data__Identifier = '' AND region = 'us-east-1' + stream_processors_list_only: + name: stream_processors_list_only + id: awscc.rekognition.stream_processors_list_only + x-cfn-schema-name: StreamProcessor + x-cfn-type-name: AWS::Rekognition::StreamProcessor + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Collection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCollection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCollectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StreamProcessor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStreamProcessor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStreamProcessorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/resiliencehub.yaml b/providers/src/awscc/v00.00.00000/services/resiliencehub.yaml index ba3c6c4f..cc533969 100644 --- a/providers/src/awscc/v00.00.00000/services/resiliencehub.yaml +++ b/providers/src/awscc/v00.00.00000/services/resiliencehub.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ResilienceHub - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: TagValue: type: string @@ -167,13 +547,29 @@ components: - AppTemplateBody - ResourceMappings x-stackql-resource-name: app - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::ResilienceHub::App. + x-type-name: AWS::ResilienceHub::App + x-stackql-primary-identifier: - AppArn x-create-only-properties: - Name x-read-only-properties: - AppArn - DriftStatus + x-required-properties: + - Name + - AppTemplateBody + - ResourceMappings + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - resiliencehub:TagResource + - resiliencehub:ListTagsForResource + - resiliencehub:UntagResource x-required-permissions: create: - cloudformation:DescribeStacks @@ -195,12 +591,23 @@ components: - sns:GetTopicAttributes - route53:List* - iam:PassRole - - resiliencehub:* + - resiliencehub:CreateApp + - resiliencehub:DescribeApp + - resiliencehub:DescribeAppVersionTemplate + - resiliencehub:PutDraftAppVersionTemplate + - resiliencehub:AddDraftAppVersionResourceMappings + - resiliencehub:ListAppVersionResourceMappings + - resiliencehub:ListAppVersions + - resiliencehub:PublishAppVersion + - resiliencehub:ListTagsForResource + - resiliencehub:TagResource + - resiliencehub:UntagResource read: - resiliencehub:DescribeApp - resiliencehub:DescribeAppVersionTemplate - resiliencehub:ListAppVersionResourceMappings - resiliencehub:ListTagsForResource + - resiliencehub:ListAppVersions update: - cloudformation:DescribeStacks - cloudformation:ListStackResources @@ -221,7 +628,18 @@ components: - sns:GetTopicAttributes - route53:List* - iam:PassRole - - resiliencehub:* + - resiliencehub:UpdateApp + - resiliencehub:DescribeApp + - resiliencehub:DescribeAppVersionTemplate + - resiliencehub:PutDraftAppVersionTemplate + - resiliencehub:AddDraftAppVersionResourceMappings + - resiliencehub:RemoveDraftAppVersionResourceMappings + - resiliencehub:ListAppVersionResourceMappings + - resiliencehub:ListAppVersions + - resiliencehub:PublishAppVersion + - resiliencehub:ListTagsForResource + - resiliencehub:TagResource + - resiliencehub:UntagResource delete: - resiliencehub:DeleteApp - resiliencehub:UntagResource @@ -244,9 +662,19 @@ components: additionalProperties: false PolicyMap: type: object - x-patternProperties: - .*{1,8}: + properties: + AZ: + $ref: '#/components/schemas/FailurePolicy' + Hardware: + $ref: '#/components/schemas/FailurePolicy' + Software: + $ref: '#/components/schemas/FailurePolicy' + Region: $ref: '#/components/schemas/FailurePolicy' + required: + - AZ + - Hardware + - Software additionalProperties: false ResiliencyPolicy: type: object @@ -288,10 +716,26 @@ components: - Tier - Policy x-stackql-resource-name: resiliency_policy - x-stackql-primaryIdentifier: + description: Resource Type Definition for Resiliency Policy. + x-type-name: AWS::ResilienceHub::ResiliencyPolicy + x-stackql-primary-identifier: - PolicyArn x-read-only-properties: - PolicyArn + x-required-properties: + - PolicyName + - Tier + - Policy + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - resiliencehub:TagResource + - resiliencehub:ListTagsForResource + - resiliencehub:UntagResource x-required-permissions: create: - resiliencehub:CreateResiliencyPolicy @@ -311,43 +755,193 @@ components: - resiliencehub:UntagResource list: - resiliencehub:ListResiliencyPolicies + CreateAppRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the app. + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$ + Description: + description: App description. + type: string + minLength: 0 + maxLength: 500 + AppArn: + type: string + description: Amazon Resource Name (ARN) of the App. + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + ResiliencyPolicyArn: + type: string + description: Amazon Resource Name (ARN) of the Resiliency Policy. + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + Tags: + $ref: '#/components/schemas/TagMap' + AppTemplateBody: + description: A string containing full ResilienceHub app template body. + type: string + minLength: 0 + maxLength: 409600 + pattern: ^[\w\s:,-\.'\/{}\[\]:"]+$ + ResourceMappings: + description: An array of ResourceMapping objects. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ResourceMapping' + AppAssessmentSchedule: + description: Assessment execution schedule. + type: string + enum: + - Disabled + - Daily + PermissionModel: + $ref: '#/components/schemas/PermissionModel' + EventSubscriptions: + description: The list of events you would like to subscribe and get notification for. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/EventSubscription' + DriftStatus: + description: Indicates if compliance drifts (deviations) were detected while running an assessment for your application. + type: string + enum: + - NotChecked + - NotDetected + - Detected + x-stackQL-stringOnly: true + x-title: CreateAppRequest + type: object + required: [] + CreateResiliencyPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyName: + description: Name of Resiliency Policy. + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$ + PolicyDescription: + description: Description of Resiliency Policy. + type: string + maxLength: 500 + DataLocationConstraint: + type: string + description: Data Location Constraint of the Policy. + enum: + - AnyLocation + - SameContinent + - SameCountry + Tier: + type: string + description: Resiliency Policy Tier. + enum: + - MissionCritical + - Critical + - Important + - CoreServices + - NonCritical + Policy: + $ref: '#/components/schemas/PolicyMap' + PolicyArn: + type: string + description: Amazon Resource Name (ARN) of the Resiliency Policy. + pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$ + Tags: + $ref: '#/components/schemas/TagMap' + x-stackQL-stringOnly: true + x-title: CreateResiliencyPolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: apps: name: apps id: awscc.resiliencehub.apps x-cfn-schema-name: App - x-type: list - x-identifiers: - - AppArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppArn') as app_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppArn') as app_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' - AND region = 'us-east-1' - app: - name: app - id: awscc.resiliencehub.app - x-cfn-schema-name: App - x-type: get + x-cfn-type-name: AWS::ResilienceHub::App x-identifiers: - AppArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__App&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResilienceHub::App" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResilienceHub::App" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResilienceHub::App" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/apps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -367,7 +961,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -386,13 +980,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResilienceHub::App' AND data__Identifier = '' AND region = 'us-east-1' - resiliency_policies: - name: resiliency_policies - id: awscc.resiliencehub.resiliency_policies - x-cfn-schema-name: ResiliencyPolicy - x-type: list + apps_list_only: + name: apps_list_only + id: awscc.resiliencehub.apps_list_only + x-cfn-schema-name: App + x-cfn-type-name: AWS::ResilienceHub::App x-identifiers: - - PolicyArn + - AppArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -400,28 +1000,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' + JSON_EXTRACT(Properties, '$.AppArn') as app_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyArn') as policy_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' + json_extract_path_text(Properties, 'AppArn') as app_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' AND region = 'us-east-1' - resiliency_policy: - name: resiliency_policy - id: awscc.resiliencehub.resiliency_policy + resiliency_policies: + name: resiliency_policies + id: awscc.resiliencehub.resiliency_policies x-cfn-schema-name: ResiliencyPolicy - x-type: get + x-cfn-type-name: AWS::ResilienceHub::ResiliencyPolicy x-identifiers: - PolicyArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResiliencyPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResilienceHub::ResiliencyPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResilienceHub::ResiliencyPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResilienceHub::ResiliencyPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -437,7 +1085,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -452,3 +1100,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' AND data__Identifier = '' AND region = 'us-east-1' + resiliency_policies_list_only: + name: resiliency_policies_list_only + id: awscc.resiliencehub.resiliency_policies_list_only + x-cfn-schema-name: ResiliencyPolicy + x-cfn-type-name: AWS::ResilienceHub::ResiliencyPolicy + x-identifiers: + - PolicyArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__App&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApp + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResiliencyPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResiliencyPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResiliencyPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/resourceexplorer2.yaml b/providers/src/awscc/v00.00.00000/services/resourceexplorer2.yaml index 3ac3efda..5c315410 100644 --- a/providers/src/awscc/v00.00.00000/services/resourceexplorer2.yaml +++ b/providers/src/awscc/v00.00.00000/services/resourceexplorer2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ResourceExplorer2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DefaultViewAssociation: type: object @@ -17,10 +397,16 @@ components: required: - ViewArn x-stackql-resource-name: default_view_association - x-stackql-primaryIdentifier: + description: Definition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type + x-type-name: AWS::ResourceExplorer2::DefaultViewAssociation + x-stackql-primary-identifier: - AssociatedAwsPrincipal x-read-only-properties: - AssociatedAwsPrincipal + x-required-properties: + - ViewArn + x-tagging: + taggable: false x-required-permissions: create: - resource-explorer-2:GetDefaultView @@ -66,11 +452,25 @@ components: required: - Type x-stackql-resource-name: index - x-stackql-primaryIdentifier: + description: Definition of AWS::ResourceExplorer2::Index Resource Type + x-type-name: AWS::ResourceExplorer2::Index + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn - IndexState + x-required-properties: + - Type + x-tagging: + taggable: true + tagOnCreate: true + cloudFormationSystemTags: false + tagUpdatable: true + tagProperty: /properties/Tags + permissions: + - resource-explorer-2:ListTagsForResource + - resource-explorer-2:TagResource + - resource-explorer-2:UntagResource x-required-permissions: create: - resource-explorer-2:CreateIndex @@ -134,13 +534,27 @@ components: required: - ViewName x-stackql-resource-name: view - x-stackql-primaryIdentifier: + description: Definition of AWS::ResourceExplorer2::View Resource Type + x-type-name: AWS::ResourceExplorer2::View + x-stackql-primary-identifier: - ViewArn x-create-only-properties: - Scope - ViewName x-read-only-properties: - ViewArn + x-required-properties: + - ViewName + x-tagging: + taggable: true + tagOnCreate: true + cloudFormationSystemTags: false + tagUpdatable: true + tagProperty: /properties/Tags + permissions: + - resource-explorer-2:ListTagsForResource + - resource-explorer-2:TagResource + - resource-explorer-2:UntagResource x-required-permissions: create: - resource-explorer-2:CreateView @@ -158,18 +572,153 @@ components: - resource-explorer-2:UntagResource list: - resource-explorer-2:ListViews + CreateDefaultViewAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ViewArn: + type: string + AssociatedAwsPrincipal: + description: The AWS principal that the default view is associated with, used as the unique identifier for this resource. + type: string + pattern: ^[0-9]{12}$ + x-stackQL-stringOnly: true + x-title: CreateDefaultViewAssociationRequest + type: object + required: [] + CreateIndexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + Tags: + $ref: '#/components/schemas/TagMap' + Type: + $ref: '#/components/schemas/IndexType' + IndexState: + $ref: '#/components/schemas/IndexState' + x-stackQL-stringOnly: true + x-title: CreateIndexRequest + type: object + required: [] + CreateViewRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Filters: + $ref: '#/components/schemas/SearchFilter' + IncludedProperties: + type: array + items: + $ref: '#/components/schemas/IncludedProperty' + Scope: + type: string + Tags: + $ref: '#/components/schemas/TagMap' + ViewArn: + type: string + ViewName: + type: string + pattern: ^[a-zA-Z0-9\-]{1,64}$ + x-stackQL-stringOnly: true + x-title: CreateViewRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - default_view_association: - name: default_view_association - id: awscc.resourceexplorer2.default_view_association + default_view_associations: + name: default_view_associations + id: awscc.resourceexplorer2.default_view_associations x-cfn-schema-name: DefaultViewAssociation - x-type: get + x-cfn-type-name: AWS::ResourceExplorer2::DefaultViewAssociation x-identifiers: - AssociatedAwsPrincipal + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DefaultViewAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::DefaultViewAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::DefaultViewAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::DefaultViewAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -180,7 +729,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -194,38 +743,61 @@ components: name: indices id: awscc.resourceexplorer2.indices x-cfn-schema-name: Index - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' - AND region = 'us-east-1' - index: - name: index - id: awscc.resourceexplorer2.index - x-cfn-schema-name: Index - x-type: get + x-cfn-type-name: AWS::ResourceExplorer2::Index x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -238,7 +810,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -250,13 +822,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' AND data__Identifier = '' AND region = 'us-east-1' - views: - name: views - id: awscc.resourceexplorer2.views - x-cfn-schema-name: View - x-type: list + indices_list_only: + name: indices_list_only + id: awscc.resourceexplorer2.indices_list_only + x-cfn-schema-name: Index + x-cfn-type-name: AWS::ResourceExplorer2::Index x-identifiers: - - ViewArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -264,28 +842,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ViewArn') as view_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ViewArn') as view_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' AND region = 'us-east-1' - view: - name: view - id: awscc.resourceexplorer2.view + views: + name: views + id: awscc.resourceexplorer2.views x-cfn-schema-name: View - x-type: get + x-cfn-type-name: AWS::ResourceExplorer2::View x-identifiers: - ViewArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__View&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::View" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::View" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceExplorer2::View" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -300,7 +926,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -314,3 +940,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceExplorer2::View' AND data__Identifier = '' AND region = 'us-east-1' + views_list_only: + name: views_list_only + id: awscc.resourceexplorer2.views_list_only + x-cfn-schema-name: View + x-cfn-type-name: AWS::ResourceExplorer2::View + x-identifiers: + - ViewArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ViewArn') as view_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ViewArn') as view_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DefaultViewAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDefaultViewAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDefaultViewAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIndex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIndexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__View&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateView + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateViewRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/resourcegroups.yaml b/providers/src/awscc/v00.00.00000/services/resourcegroups.yaml index dd72766a..3ce2ba73 100644 --- a/providers/src/awscc/v00.00.00000/services/resourcegroups.yaml +++ b/providers/src/awscc/v00.00.00000/services/resourcegroups.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ResourceGroups - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ResourceQuery: type: object @@ -102,12 +482,26 @@ components: required: - Name x-stackql-resource-name: group - x-stackql-primaryIdentifier: + description: Schema for ResourceGroups::Group + x-type-name: AWS::ResourceGroups::Group + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - resource-groups:Tag + - resource-groups:Untag + - resource-groups:GetTags x-required-permissions: create: - resource-groups:CreateGroup @@ -139,14 +533,314 @@ components: - resource-groups:UnGroupResources list: - resource-groups:ListGroups + TagSyncTask: + type: object + properties: + Group: + description: The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task + type: string + maxLength: 1600 + minLength: 12 + pattern: ([a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})|(arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}) + GroupArn: + description: The Amazon resource name (ARN) of the ApplicationGroup for which the TagSyncTask is created + type: string + maxLength: 1600 + minLength: 12 + pattern: arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26} + GroupName: + description: The Name of the application group for which the TagSyncTask is created + type: string + maxLength: 300 + minLength: 1 + pattern: '[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}' + TaskArn: + description: The ARN of the TagSyncTask resource + type: string + maxLength: 1600 + minLength: 12 + pattern: arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26} + TagKey: + description: The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application. + type: string + maxLength: 128 + minLength: 1 + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + TagValue: + description: The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application. + type: string + maxLength: 256 + minLength: 0 + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + RoleArn: + description: The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf. + type: string + maxLength: 2048 + minLength: 20 + pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ + Status: + description: The status of the TagSyncTask + type: string + enum: + - ACTIVE + - ERROR + required: + - Group + - TagKey + - TagValue + - RoleArn + x-stackql-resource-name: tag_sync_task + description: Schema for ResourceGroups::TagSyncTask + x-type-name: AWS::ResourceGroups::TagSyncTask + x-stackql-primary-identifier: + - TaskArn + x-create-only-properties: + - Group + - TagKey + - TagValue + - RoleArn + x-read-only-properties: + - TaskArn + - Status + - GroupName + - GroupArn + x-required-properties: + - Group + - TagKey + - TagValue + - RoleArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - resource-groups:StartTagSyncTask + - resource-groups:CreateGroup + - iam:PassRole + read: + - resource-groups:GetTagSyncTask + delete: + - resource-groups:CancelTagSyncTask + - resource-groups:DeleteGroup + list: + - resource-groups:ListTagSyncTasks + CreateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the resource group + type: string + maxLength: 128 + Description: + description: The description of the resource group + type: string + maxLength: 512 + ResourceQuery: + $ref: '#/components/schemas/ResourceQuery' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The Resource Group ARN. + type: string + Configuration: + $ref: '#/components/schemas/Configuration' + Resources: + type: array + items: + type: string + x-stackQL-stringOnly: true + x-title: CreateGroupRequest + type: object + required: [] + CreateTagSyncTaskRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Group: + description: The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task + type: string + maxLength: 1600 + minLength: 12 + pattern: ([a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})|(arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}) + GroupArn: + description: The Amazon resource name (ARN) of the ApplicationGroup for which the TagSyncTask is created + type: string + maxLength: 1600 + minLength: 12 + pattern: arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26} + GroupName: + description: The Name of the application group for which the TagSyncTask is created + type: string + maxLength: 300 + minLength: 1 + pattern: '[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}' + TaskArn: + description: The ARN of the TagSyncTask resource + type: string + maxLength: 1600 + minLength: 12 + pattern: arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26} + TagKey: + description: The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application. + type: string + maxLength: 128 + minLength: 1 + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + TagValue: + description: The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application. + type: string + maxLength: 256 + minLength: 0 + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + RoleArn: + description: The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf. + type: string + maxLength: 2048 + minLength: 20 + pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ + Status: + description: The status of the TagSyncTask + type: string + enum: + - ACTIVE + - ERROR + x-stackQL-stringOnly: true + x-title: CreateTagSyncTaskRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: groups: name: groups id: awscc.resourcegroups.groups x-cfn-schema-name: Group - x-type: list + x-cfn-type-name: AWS::ResourceGroups::Group x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceGroups::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceGroups::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceGroups::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ResourceQuery') as resource_query, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.Resources') as resources + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::Group' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ResourceQuery') as resource_query, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Resources') as resources + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::Group' + AND data__Identifier = '' + AND region = 'us-east-1' + groups_list_only: + name: groups_list_only + id: awscc.resourcegroups.groups_list_only + x-cfn-schema-name: Group + x-cfn-type-name: AWS::ResourceGroups::Group + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -165,44 +859,349 @@ components: json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::Group' AND region = 'us-east-1' - group: - name: group - id: awscc.resourcegroups.group - x-cfn-schema-name: Group - x-type: get + tag_sync_tasks: + name: tag_sync_tasks + id: awscc.resourcegroups.tag_sync_tasks + x-cfn-schema-name: TagSyncTask + x-cfn-type-name: AWS::ResourceGroups::TagSyncTask x-identifiers: - - Name + - TaskArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TagSyncTask&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceGroups::TagSyncTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ResourceGroups::TagSyncTask" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tag_sync_tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tag_sync_tasks/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.ResourceQuery') as resource_query, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Configuration') as configuration, - JSON_EXTRACT(Properties, '$.Resources') as resources - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::Group' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Group') as group_id, + JSON_EXTRACT(Properties, '$.GroupArn') as group_arn, + JSON_EXTRACT(Properties, '$.GroupName') as group_name, + JSON_EXTRACT(Properties, '$.TaskArn') as task_arn, + JSON_EXTRACT(Properties, '$.TagKey') as tag_key, + JSON_EXTRACT(Properties, '$.TagValue') as tag_value, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::TagSyncTask' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ResourceQuery') as resource_query, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'Resources') as resources - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::Group' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Group') as group_id, + json_extract_path_text(Properties, 'GroupArn') as group_arn, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'TaskArn') as task_arn, + json_extract_path_text(Properties, 'TagKey') as tag_key, + json_extract_path_text(Properties, 'TagValue') as tag_value, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::TagSyncTask' + AND data__Identifier = '' + AND region = 'us-east-1' + tag_sync_tasks_list_only: + name: tag_sync_tasks_list_only + id: awscc.resourcegroups.tag_sync_tasks_list_only + x-cfn-schema-name: TagSyncTask + x-cfn-type-name: AWS::ResourceGroups::TagSyncTask + x-identifiers: + - TaskArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TaskArn') as task_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::TagSyncTask' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TaskArn') as task_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::TagSyncTask' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TagSyncTask&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTagSyncTask + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTagSyncTaskRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/robomaker.yaml b/providers/src/awscc/v00.00.00000/services/robomaker.yaml index c2627848..3640c8bf 100644 --- a/providers/src/awscc/v00.00.00000/services/robomaker.yaml +++ b/providers/src/awscc/v00.00.00000/services/robomaker.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: RoboMaker - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: type: string @@ -33,12 +413,15 @@ components: pattern: '[a-zA-Z0-9_\-]{1,255}$' required: [] x-stackql-resource-name: fleet - x-stackql-primaryIdentifier: + description: AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments. + x-type-name: AWS::RoboMaker::Fleet + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: [] x-required-permissions: create: - robomaker:CreateFleet @@ -84,7 +467,9 @@ components: - GreengrassGroupId - Architecture x-stackql-resource-name: robot - x-stackql-primaryIdentifier: + description: AWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot. + x-type-name: AWS::RoboMaker::Robot + x-stackql-primary-identifier: - Arn x-create-only-properties: - GreengrassGroupId @@ -93,6 +478,9 @@ components: - Fleet x-read-only-properties: - Arn + x-required-properties: + - GreengrassGroupId + - Architecture x-required-permissions: create: - robomaker:CreateRobot @@ -186,12 +574,19 @@ components: required: - RobotSoftwareSuite x-stackql-resource-name: robot_application - x-stackql-primaryIdentifier: + description: This schema is for testing purpose only. + x-type-name: AWS::RoboMaker::RobotApplication + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name + x-write-only-properties: + - RobotSoftwareSuite/Version + - Sources x-read-only-properties: - Arn + x-required-properties: + - RobotSoftwareSuite x-required-permissions: create: - robomaker:CreateRobotApplication @@ -235,7 +630,9 @@ components: required: - Application x-stackql-resource-name: robot_application_version - x-stackql-primaryIdentifier: + description: AWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses. + x-type-name: AWS::RoboMaker::RobotApplicationVersion + x-stackql-primary-identifier: - Arn x-create-only-properties: - Application @@ -243,6 +640,8 @@ components: x-read-only-properties: - ApplicationVersion - Arn + x-required-properties: + - Application x-required-permissions: create: - robomaker:CreateRobotApplicationVersion @@ -337,12 +736,22 @@ components: - RobotSoftwareSuite - SimulationSoftwareSuite x-stackql-resource-name: simulation_application - x-stackql-primaryIdentifier: + description: This schema is for testing purpose only. + x-type-name: AWS::RoboMaker::SimulationApplication + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name + x-write-only-properties: + - RenderingEngine + - RobotSoftwareSuite/Version + - Sources + - SimulationSoftwareSuite/Version x-read-only-properties: - Arn + x-required-properties: + - RobotSoftwareSuite + - SimulationSoftwareSuite x-required-permissions: create: - robomaker:CreateSimulationApplication @@ -386,7 +795,9 @@ components: required: - Application x-stackql-resource-name: simulation_application_version - x-stackql-primaryIdentifier: + description: AWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses. + x-type-name: AWS::RoboMaker::SimulationApplicationVersion + x-stackql-primary-identifier: - Arn x-create-only-properties: - Application @@ -394,6 +805,8 @@ components: x-read-only-properties: - ApplicationVersion - Arn + x-required-properties: + - Application x-required-permissions: create: - robomaker:CreateSimulationApplicationVersion @@ -408,43 +821,291 @@ components: - robomaker:DescribeSimulationApplication read: - robomaker:DescribeSimulationApplication + CreateFleetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + Tags: + $ref: '#/components/schemas/Tags' + Name: + description: The name of the fleet. + type: string + minLength: 1 + maxLength: 255 + pattern: '[a-zA-Z0-9_\-]{1,255}$' + x-stackQL-stringOnly: true + x-title: CreateFleetRequest + type: object + required: [] + CreateRobotRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + Fleet: + description: The Amazon Resource Name (ARN) of the fleet. + type: string + minLength: 1 + maxLength: 1224 + Architecture: + description: The target architecture of the robot. + type: string + enum: + - X86_64 + - ARM64 + - ARMHF + GreengrassGroupId: + description: The Greengrass group id. + type: string + minLength: 1 + maxLength: 1224 + Tags: + $ref: '#/components/schemas/Tags' + Name: + description: The name for the robot. + type: string + minLength: 1 + maxLength: 255 + x-stackQL-stringOnly: true + x-title: CreateRobotRequest + type: object + required: [] + CreateRobotApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the robot application. + type: string + minLength: 1 + maxLength: 255 + Sources: + description: The sources of the robot application. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SourceConfig' + Environment: + description: The URI of the Docker image for the robot application. + type: string + RobotSoftwareSuite: + $ref: '#/components/schemas/RobotSoftwareSuite' + CurrentRevisionId: + description: The revision ID of robot application. + type: string + minLength: 1 + maxLength: 40 + Arn: + $ref: '#/components/schemas/Arn' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateRobotApplicationRequest + type: object + required: [] + CreateRobotApplicationVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Application: + $ref: '#/components/schemas/Arn' + CurrentRevisionId: + description: The revision ID of robot application. + type: string + minLength: 1 + maxLength: 40 + pattern: '[a-zA-Z0-9_.\-]*' + ApplicationVersion: + type: string + Arn: + $ref: '#/components/schemas/Arn' + x-stackQL-stringOnly: true + x-title: CreateRobotApplicationVersionRequest + type: object + required: [] + CreateSimulationApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + Name: + description: The name of the simulation application. + type: string + minLength: 1 + maxLength: 255 + pattern: '[a-zA-Z0-9_\-]*' + CurrentRevisionId: + description: The current revision id. + type: string + RenderingEngine: + description: The rendering engine for the simulation application. + $ref: '#/components/schemas/RenderingEngine' + RobotSoftwareSuite: + description: The robot software suite used by the simulation application. + $ref: '#/components/schemas/RobotSoftwareSuite' + SimulationSoftwareSuite: + description: The simulation software suite used by the simulation application. + $ref: '#/components/schemas/SimulationSoftwareSuite' + Sources: + description: The sources of the simulation application. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/SourceConfig' + Environment: + description: The URI of the Docker image for the robot application. + type: string + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateSimulationApplicationRequest + type: object + required: [] + CreateSimulationApplicationVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Application: + $ref: '#/components/schemas/Arn' + CurrentRevisionId: + description: The revision ID of robot application. + type: string + minLength: 1 + maxLength: 40 + pattern: '[a-zA-Z0-9_.\-]*' + ApplicationVersion: + type: string + Arn: + $ref: '#/components/schemas/Arn' + x-stackQL-stringOnly: true + x-title: CreateSimulationApplicationVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: fleets: name: fleets id: awscc.robomaker.fleets x-cfn-schema-name: Fleet - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' - AND region = 'us-east-1' - fleet: - name: fleet - id: awscc.robomaker.fleet - x-cfn-schema-name: Fleet - x-type: get + x-cfn-type-name: AWS::RoboMaker::Fleet x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::Fleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -456,7 +1117,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -467,13 +1128,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::Fleet' AND data__Identifier = '' AND region = 'us-east-1' - robots: - name: robots - id: awscc.robomaker.robots - x-cfn-schema-name: Robot - x-type: list + fleets_list_only: + name: fleets_list_only + id: awscc.robomaker.fleets_list_only + x-cfn-schema-name: Fleet + x-cfn-type-name: AWS::RoboMaker::Fleet x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -482,7 +1149,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -490,19 +1157,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' AND region = 'us-east-1' - robot: - name: robot - id: awscc.robomaker.robot + robots: + name: robots + id: awscc.robomaker.robots x-cfn-schema-name: Robot - x-type: get + x-cfn-type-name: AWS::RoboMaker::Robot x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Robot&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::Robot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::Robot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::Robot" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/robots/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/robots/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/robots/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -517,7 +1232,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -531,13 +1246,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::Robot' AND data__Identifier = '' AND region = 'us-east-1' - robot_applications: - name: robot_applications - id: awscc.robomaker.robot_applications - x-cfn-schema-name: RobotApplication - x-type: list + robots_list_only: + name: robots_list_only + id: awscc.robomaker.robots_list_only + x-cfn-schema-name: Robot + x-cfn-type-name: AWS::RoboMaker::Robot x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -546,7 +1267,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -554,19 +1275,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' AND region = 'us-east-1' - robot_application: - name: robot_application - id: awscc.robomaker.robot_application + robot_applications: + name: robot_applications + id: awscc.robomaker.robot_applications x-cfn-schema-name: RobotApplication - x-type: get + x-cfn-type-name: AWS::RoboMaker::RobotApplication x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RobotApplication&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::RobotApplication" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::RobotApplication" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::RobotApplication" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/robot_applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/robot_applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/robot_applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -582,7 +1351,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -597,13 +1366,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' AND data__Identifier = '' AND region = 'us-east-1' - robot_application_version: - name: robot_application_version - id: awscc.robomaker.robot_application_version - x-cfn-schema-name: RobotApplicationVersion - x-type: get + robot_applications_list_only: + name: robot_applications_list_only + id: awscc.robomaker.robot_applications_list_only + x-cfn-schema-name: RobotApplication + x-cfn-type-name: AWS::RoboMaker::RobotApplication x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -611,63 +1386,146 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Application') as application, - JSON_EXTRACT(Properties, '$.CurrentRevisionId') as current_revision_id, - JSON_EXTRACT(Properties, '$.ApplicationVersion') as application_version, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplicationVersion' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Application') as application, - json_extract_path_text(Properties, 'CurrentRevisionId') as current_revision_id, - json_extract_path_text(Properties, 'ApplicationVersion') as application_version, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplicationVersion' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' AND region = 'us-east-1' - simulation_applications: - name: simulation_applications - id: awscc.robomaker.simulation_applications - x-cfn-schema-name: SimulationApplication - x-type: list + robot_application_versions: + name: robot_application_versions + id: awscc.robomaker.robot_application_versions + x-cfn-schema-name: RobotApplicationVersion + x-cfn-type-name: AWS::RoboMaker::RobotApplicationVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RobotApplicationVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::RobotApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::RobotApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/robot_application_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/robot_application_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Application') as application, + JSON_EXTRACT(Properties, '$.CurrentRevisionId') as current_revision_id, + JSON_EXTRACT(Properties, '$.ApplicationVersion') as application_version, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplicationVersion' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'Application') as application, + json_extract_path_text(Properties, 'CurrentRevisionId') as current_revision_id, + json_extract_path_text(Properties, 'ApplicationVersion') as application_version, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplicationVersion' + AND data__Identifier = '' AND region = 'us-east-1' - simulation_application: - name: simulation_application - id: awscc.robomaker.simulation_application + simulation_applications: + name: simulation_applications + id: awscc.robomaker.simulation_applications x-cfn-schema-name: SimulationApplication - x-type: get + x-cfn-type-name: AWS::RoboMaker::SimulationApplication x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SimulationApplication&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::SimulationApplication" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::SimulationApplication" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::SimulationApplication" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -685,7 +1543,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -702,17 +1560,83 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' AND data__Identifier = '' AND region = 'us-east-1' - simulation_application_version: - name: simulation_application_version - id: awscc.robomaker.simulation_application_version - x-cfn-schema-name: SimulationApplicationVersion - x-type: get + simulation_applications_list_only: + name: simulation_applications_list_only + id: awscc.robomaker.simulation_applications_list_only + x-cfn-schema-name: SimulationApplication + x-cfn-type-name: AWS::RoboMaker::SimulationApplication x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' + AND region = 'us-east-1' + simulation_application_versions: + name: simulation_application_versions + id: awscc.robomaker.simulation_application_versions + x-cfn-schema-name: SimulationApplicationVersion + x-cfn-type-name: AWS::RoboMaker::SimulationApplicationVersion + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SimulationApplicationVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::SimulationApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RoboMaker::SimulationApplicationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simulation_application_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simulation_application_versions/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -725,7 +1649,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -737,3 +1661,408 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplicationVersion' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Fleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Robot&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRobot + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRobotRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RobotApplication&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRobotApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRobotApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RobotApplicationVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRobotApplicationVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRobotApplicationVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SimulationApplication&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSimulationApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSimulationApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SimulationApplicationVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSimulationApplicationVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSimulationApplicationVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/rolesanywhere.yaml b/providers/src/awscc/v00.00.00000/services/rolesanywhere.yaml index 8d0bb8f2..51aa136a 100644 --- a/providers/src/awscc/v00.00.00000/services/rolesanywhere.yaml +++ b/providers/src/awscc/v00.00.00000/services/rolesanywhere.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: RolesAnywhere - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -45,15 +425,29 @@ components: - Name - CrlData x-stackql-resource-name: crl - x-stackql-primaryIdentifier: + description: Definition of AWS::RolesAnywhere::CRL Resource Type + x-type-name: AWS::RolesAnywhere::CRL + x-stackql-primary-identifier: - CrlId x-read-only-properties: - CrlId + x-required-properties: + - Name + - CrlData + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rolesanywhere:UntagResource + - rolesanywhere:TagResource + - rolesanywhere:ListTagsForResource x-required-permissions: create: - rolesanywhere:ImportCrl - rolesanywhere:TagResource - - rolesanywhere:ListTagsForResource read: - rolesanywhere:GetCrl - rolesanywhere:ListTagsForResource @@ -69,6 +463,33 @@ components: list: - rolesanywhere:ListCrls - rolesanywhere:ListTagsForResource + AttributeMapping: + type: object + properties: + MappingRules: + type: array + items: + $ref: '#/components/schemas/MappingRule' + CertificateField: + $ref: '#/components/schemas/CertificateField' + required: + - CertificateField + - MappingRules + additionalProperties: false + MappingRule: + type: object + properties: + Specifier: + type: string + required: + - Specifier + additionalProperties: false + CertificateField: + type: string + enum: + - x509Subject + - x509Issuer + - x509SAN Profile: type: object properties: @@ -105,15 +526,40 @@ components: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 0 + AttributeMappings: + type: array + items: + $ref: '#/components/schemas/AttributeMapping' + AcceptRoleSessionName: + type: boolean required: - Name - RoleArns x-stackql-resource-name: profile - x-stackql-primaryIdentifier: + description: Definition of AWS::RolesAnywhere::Profile Resource Type + x-type-name: AWS::RolesAnywhere::Profile + x-stackql-primary-identifier: - ProfileId + x-create-only-properties: + - RequireInstanceProperties + x-write-only-properties: + - RequireInstanceProperties x-read-only-properties: - ProfileId - ProfileArn + x-required-properties: + - Name + - RoleArns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rolesanywhere:UntagResource + - rolesanywhere:TagResource + - rolesanywhere:ListTagsForResource x-required-permissions: create: - iam:GetRole @@ -121,7 +567,8 @@ components: - iam:PassRole - rolesanywhere:CreateProfile - rolesanywhere:TagResource - - rolesanywhere:ListTagsForResource + - rolesanywhere:PutAttributeMapping + - rolesanywhere:DeleteAttributeMapping read: - rolesanywhere:GetProfile - rolesanywhere:ListTagsForResource @@ -129,12 +576,15 @@ components: - iam:GetRole - iam:GetPolicy - iam:PassRole + - rolesanywhere:GetProfile - rolesanywhere:UpdateProfile - rolesanywhere:EnableProfile - rolesanywhere:DisableProfile - rolesanywhere:TagResource - rolesanywhere:UntagResource - rolesanywhere:ListTagsForResource + - rolesanywhere:PutAttributeMapping + - rolesanywhere:DeleteAttributeMapping delete: - rolesanywhere:DeleteProfile list: @@ -173,6 +623,9 @@ components: $ref: '#/components/schemas/TrustAnchorType' SourceData: $ref: '#/components/schemas/SourceData' + required: + - SourceType + - SourceData additionalProperties: false SourceData: oneOf: @@ -197,7 +650,6 @@ components: enum: - AWS_ACM_PCA - CERTIFICATE_BUNDLE - - SELF_SIGNED_REPOSITORY TrustAnchor: type: object properties: @@ -229,17 +681,31 @@ components: - Name - Source x-stackql-resource-name: trust_anchor - x-stackql-primaryIdentifier: + description: Definition of AWS::RolesAnywhere::TrustAnchor Resource Type. + x-type-name: AWS::RolesAnywhere::TrustAnchor + x-stackql-primary-identifier: - TrustAnchorId x-read-only-properties: - TrustAnchorId - TrustAnchorArn + x-required-properties: + - Name + - Source + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rolesanywhere:UntagResource + - rolesanywhere:TagResource + - rolesanywhere:ListTagsForResource x-required-permissions: create: - iam:CreateServiceLinkedRole - rolesanywhere:CreateTrustAnchor - rolesanywhere:TagResource - - rolesanywhere:ListTagsForResource read: - rolesanywhere:GetTrustAnchor - rolesanywhere:ListTagsForResource @@ -259,43 +725,205 @@ components: list: - rolesanywhere:ListTrustAnchors - rolesanywhere:ListTagsForResource + CreateCRLRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CrlData: + type: string + CrlId: + type: string + pattern: '[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}' + Enabled: + type: boolean + Name: + type: string + TrustAnchorArn: + type: string + pattern: ^arn:aws(-[^:]+)?:rolesanywhere(:.*){2}(:trust-anchor.*)$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateCRLRequest + type: object + required: [] + CreateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DurationSeconds: + type: number + maximum: 43200 + minimum: 900 + Enabled: + type: boolean + ManagedPolicyArns: + type: array + items: + type: string + Name: + type: string + ProfileArn: + type: string + ProfileId: + type: string + pattern: '[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}' + RequireInstanceProperties: + type: boolean + RoleArns: + type: array + items: + type: string + maxLength: 1011 + minLength: 1 + SessionPolicy: + type: string + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + AttributeMappings: + type: array + items: + $ref: '#/components/schemas/AttributeMapping' + AcceptRoleSessionName: + type: boolean + x-stackQL-stringOnly: true + x-title: CreateProfileRequest + type: object + required: [] + CreateTrustAnchorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Enabled: + type: boolean + Name: + type: string + NotificationSettings: + type: array + items: + $ref: '#/components/schemas/NotificationSetting' + maxItems: 50 + minItems: 0 + Source: + $ref: '#/components/schemas/Source' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + TrustAnchorId: + type: string + pattern: '[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}' + TrustAnchorArn: + type: string + pattern: '[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}' + x-stackQL-stringOnly: true + x-title: CreateTrustAnchorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: crls: name: crls id: awscc.rolesanywhere.crls x-cfn-schema-name: CRL - x-type: list - x-identifiers: - - CrlId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CrlId') as crl_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CrlId') as crl_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' - AND region = 'us-east-1' - crl: - name: crl - id: awscc.rolesanywhere.crl - x-cfn-schema-name: CRL - x-type: get + x-cfn-type-name: AWS::RolesAnywhere::CRL x-identifiers: - CrlId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CRL&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::CRL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::CRL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::CRL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/crls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/crls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/crls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -310,7 +938,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -324,13 +952,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' AND data__Identifier = '' AND region = 'us-east-1' - profiles: - name: profiles - id: awscc.rolesanywhere.profiles - x-cfn-schema-name: Profile - x-type: list + crls_list_only: + name: crls_list_only + id: awscc.rolesanywhere.crls_list_only + x-cfn-schema-name: CRL + x-cfn-type-name: AWS::RolesAnywhere::CRL x-identifiers: - - ProfileId + - CrlId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -338,28 +972,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' + JSON_EXTRACT(Properties, '$.CrlId') as crl_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProfileId') as profile_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' + json_extract_path_text(Properties, 'CrlId') as crl_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' AND region = 'us-east-1' - profile: - name: profile - id: awscc.rolesanywhere.profile + profiles: + name: profiles + id: awscc.rolesanywhere.profiles x-cfn-schema-name: Profile - x-type: get + x-cfn-type-name: AWS::RolesAnywhere::Profile x-identifiers: - ProfileId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -373,12 +1055,14 @@ components: JSON_EXTRACT(Properties, '$.RequireInstanceProperties') as require_instance_properties, JSON_EXTRACT(Properties, '$.RoleArns') as role_arns, JSON_EXTRACT(Properties, '$.SessionPolicy') as session_policy, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AttributeMappings') as attribute_mappings, + JSON_EXTRACT(Properties, '$.AcceptRoleSessionName') as accept_role_session_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -392,17 +1076,25 @@ components: json_extract_path_text(Properties, 'RequireInstanceProperties') as require_instance_properties, json_extract_path_text(Properties, 'RoleArns') as role_arns, json_extract_path_text(Properties, 'SessionPolicy') as session_policy, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AttributeMappings') as attribute_mappings, + json_extract_path_text(Properties, 'AcceptRoleSessionName') as accept_role_session_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' AND data__Identifier = '' AND region = 'us-east-1' - trust_anchors: - name: trust_anchors - id: awscc.rolesanywhere.trust_anchors - x-cfn-schema-name: TrustAnchor - x-type: list + profiles_list_only: + name: profiles_list_only + id: awscc.rolesanywhere.profiles_list_only + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::RolesAnywhere::Profile x-identifiers: - - TrustAnchorId + - ProfileId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -410,28 +1102,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrustAnchorId') as trust_anchor_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrustAnchorId') as trust_anchor_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' AND region = 'us-east-1' - trust_anchor: - name: trust_anchor - id: awscc.rolesanywhere.trust_anchor + trust_anchors: + name: trust_anchors + id: awscc.rolesanywhere.trust_anchors x-cfn-schema-name: TrustAnchor - x-type: get + x-cfn-type-name: AWS::RolesAnywhere::TrustAnchor x-identifiers: - TrustAnchorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrustAnchor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::TrustAnchor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::TrustAnchor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RolesAnywhere::TrustAnchor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -447,7 +1187,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -462,3 +1202,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' AND data__Identifier = '' AND region = 'us-east-1' + trust_anchors_list_only: + name: trust_anchors_list_only + id: awscc.rolesanywhere.trust_anchors_list_only + x-cfn-schema-name: TrustAnchor + x-cfn-type-name: AWS::RolesAnywhere::TrustAnchor + x-identifiers: + - TrustAnchorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TrustAnchorId') as trust_anchor_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrustAnchorId') as trust_anchor_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CRL&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCRL + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCRLRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrustAnchor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrustAnchor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrustAnchorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/route53.yaml b/providers/src/awscc/v00.00.00000/services/route53.yaml index 0b8024fc..a35cc200 100644 --- a/providers/src/awscc/v00.00.00000/services/route53.yaml +++ b/providers/src/awscc/v00.00.00000/services/route53.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Route53 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Location: type: object @@ -49,13 +429,20 @@ components: required: - Name x-stackql-resource-name: cidr_collection - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Route53::CidrCollection. + x-type-name: AWS::Route53::CidrCollection + x-stackql-primary-identifier: - Id x-create-only-properties: - Name x-read-only-properties: - Id - Arn + x-required-properties: + - Name + x-tagging: + taggable: false + tagUpdatable: false x-required-permissions: create: - route53:CreateCidrCollection @@ -68,6 +455,7 @@ components: delete: - route53:DeleteCidrCollection - route53:ChangeCidrCollection + - route53:ListCidrBlocks list: - route53:ListCidrCollections - route53:ListCidrBlocks @@ -81,10 +469,16 @@ components: required: - HostedZoneId x-stackql-resource-name: dnssec - x-stackql-primaryIdentifier: + description: Resource used to control (enable/disable) DNSSEC in a specific hosted zone. + x-type-name: AWS::Route53::DNSSEC + x-stackql-primary-identifier: - HostedZoneId x-create-only-properties: - HostedZoneId + x-required-properties: + - HostedZoneId + x-tagging: + taggable: false x-required-permissions: create: - route53:GetDNSSEC @@ -230,7 +624,9 @@ components: required: - HealthCheckConfig x-stackql-resource-name: health_check - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53::HealthCheck. + x-type-name: AWS::Route53::HealthCheck + x-stackql-primary-identifier: - HealthCheckId x-create-only-properties: - HealthCheckConfig/Type @@ -238,6 +634,17 @@ components: - HealthCheckConfig/RequestInterval x-read-only-properties: - HealthCheckId + x-required-properties: + - HealthCheckConfig + x-tagging: + taggable: true + tagOnCreate: false + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/HealthCheckTags + permissions: + - route53:ChangeTagsForResource + - route53:ListTagsForResource x-required-permissions: create: - route53:CreateHealthCheck @@ -257,105 +664,161 @@ components: list: - route53:ListHealthChecks - route53:ListTagsForResource - HostedZoneConfig: - description: |- - A complex type that contains an optional comment. - - If you don't want to specify a comment, omit the HostedZoneConfig and Comment elements. - type: object - additionalProperties: false - properties: - Comment: - description: Any comments that you want to include about the hosted zone. - type: string - maxLength: 256 HostedZoneTag: description: A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone. - type: object additionalProperties: false + type: object properties: - Key: - type: string - description: The key name of the tag. - maxLength: 128 Value: + description: |- + The value of ``Value`` depends on the operation that you want to perform: + + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + + *Edit a tag*: ``Value`` is the new value that you want to assign the tag. type: string - description: The value for the tag. maxLength: 256 + Key: + description: |- + The value of ``Key`` depends on the operation that you want to perform: + + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + + *Delete a key*: ``Key`` is the name of the tag you want to remove. + + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check. + type: string + maxLength: 128 required: - Value - Key - QueryLoggingConfig: - description: A complex type that contains information about a configuration for DNS query logging. - type: object + VPC: + description: |- + *Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. additionalProperties: false + type: object properties: - CloudWatchLogsLogGroupArn: - description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. + VPCRegion: + description: |- + *Private hosted zones only:* The region that an Amazon VPC was created in. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. + type: string + VPCId: + description: |- + *Private hosted zones only:* The ID of an Amazon VPC. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. type: string required: - - CloudWatchLogsLogGroupArn - VPC: - description: A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. - type: object + - VPCId + - VPCRegion + HostedZoneConfig: + description: A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements. additionalProperties: false + type: object properties: - VPCId: - description: The ID of an Amazon VPC. + Comment: + description: Any comments that you want to include about the hosted zone. type: string - VPCRegion: - description: The region that an Amazon VPC was created in. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a list of up to date regions. + maxLength: 256 + QueryLoggingConfig: + description: A complex type that contains information about a configuration for DNS query logging. + additionalProperties: false + type: object + properties: + CloudWatchLogsLogGroupArn: + description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. type: string required: - - VPCId - - VPCRegion + - CloudWatchLogsLogGroupArn HostedZone: type: object properties: - Id: - type: string - HostedZoneConfig: - $ref: '#/components/schemas/HostedZoneConfig' HostedZoneTags: + uniqueItems: true description: |- Adds, edits, or deletes tags for a health check or a hosted zone. - - For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. - type: array - uniqueItems: true + For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/HostedZoneTag' - Name: - description: |- - The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. - - If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function. - type: string - maxLength: 1024 - QueryLoggingConfig: - $ref: '#/components/schemas/QueryLoggingConfig' VPCs: - description: A complex type that contains information about the VPCs that are associated with the specified hosted zone. - type: array uniqueItems: true + description: |- + *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VPC' + HostedZoneConfig: + description: |- + A complex type that contains an optional comment. + If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. + $ref: '#/components/schemas/HostedZoneConfig' + Id: + description: '' + type: string NameServers: - type: array uniqueItems: false + description: '' + type: array items: type: string + QueryLoggingConfig: + description: |- + Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. + DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + + Route 53 edge location that responded to the DNS query + + Domain or subdomain that was requested + + DNS record type, such as A or AAAA + + DNS response code, such as ``NoError`` or ``ServFail`` + + + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. + $ref: '#/components/schemas/QueryLoggingConfig' + Name: + description: |- + The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. + If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function. + type: string + maxLength: 1024 x-stackql-resource-name: hosted_zone - x-stackql-primaryIdentifier: + description: |- + Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). + You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. + For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/). + Note the following: + + You can't create a hosted zone for a top-level domain (TLD) such as .com. + + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. + + When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``. + The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission. + When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition. + The following are the supported partitions: + + ``aws`` - AWS-Regions + + ``aws-cn`` - China Regions + + ``aws-us-gov`` - govcloud-us-region + + For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + x-type-name: AWS::Route53::HostedZone + x-stackql-primary-identifier: - Id x-create-only-properties: - Name x-read-only-properties: - Id - NameServers + x-tagging: + permissions: + - route53:ChangeTagsForResource + - route53:ListTagsForResource + taggable: true + tagOnCreate: false + tagUpdatable: true + tagProperty: /properties/HostedZoneTags + cloudFormationSystemTags: false x-required-permissions: + read: + - route53:GetHostedZone + - route53:ListTagsForResource + - route53:ListQueryLoggingConfigs create: - route53:CreateHostedZone - route53:CreateQueryLoggingConfig @@ -363,13 +826,11 @@ components: - route53:GetChange - route53:AssociateVPCWithHostedZone - ec2:DescribeVpcs - read: - - route53:GetHostedZone - - route53:ListTagsForResource - - route53:ListQueryLoggingConfigs update: - route53:GetChange + - route53:GetHostedZone - route53:ListTagsForResource + - route53:ListQueryLoggingConfigs - route53:UpdateHostedZoneComment - route53:ChangeTagsForResource - route53:AssociateVPCWithHostedZone @@ -377,17 +838,16 @@ components: - route53:CreateQueryLoggingConfig - route53:DeleteQueryLoggingConfig - ec2:DescribeVpcs - delete: - - route53:DeleteHostedZone - - route53:DeleteQueryLoggingConfig - - route53:ListQueryLoggingConfigs - - route53:GetChange list: - route53:GetHostedZone - route53:ListHostedZones - - route53:ListHostedZonesByName - route53:ListQueryLoggingConfigs - route53:ListTagsForResource + delete: + - route53:DeleteHostedZone + - route53:DeleteQueryLoggingConfig + - route53:ListQueryLoggingConfigs + - route53:GetChange KeySigningKey: type: object properties: @@ -416,13 +876,22 @@ components: - Name - KeyManagementServiceArn x-stackql-resource-name: key_signing_key - x-stackql-primaryIdentifier: + description: Represents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. + x-type-name: AWS::Route53::KeySigningKey + x-stackql-primary-identifier: - HostedZoneId - Name x-create-only-properties: - HostedZoneId - Name - KeyManagementServiceArn + x-required-properties: + - Status + - HostedZoneId + - Name + - KeyManagementServiceArn + x-tagging: + taggable: false x-required-permissions: create: - route53:CreateKeySigningKey @@ -450,43 +919,336 @@ components: list: - route53:GetDNSSEC - route53:ListHostedZones + CreateCidrCollectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: UUID of the CIDR collection. + type: string + Name: + description: A unique name for the CIDR collection. + type: string + pattern: ^[0-9A-Za-z_\-]+$ + minLength: 1 + maxLength: 64 + Arn: + description: The Amazon resource name (ARN) to uniquely identify the AWS resource. + type: string + Locations: + description: A complex type that contains information about the list of CIDR locations. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Location' + x-stackQL-stringOnly: true + x-title: CreateCidrCollectionRequest + type: object + required: [] + CreateDNSSECRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HostedZoneId: + description: The unique string (ID) used to identify a hosted zone. + type: string + pattern: ^[A-Z0-9]{1,32}$ + x-stackQL-stringOnly: true + x-title: CreateDNSSECRequest + type: object + required: [] + CreateHealthCheckRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HealthCheckId: + type: string + HealthCheckConfig: + description: A complex type that contains information about the health check. + type: object + properties: + AlarmIdentifier: + $ref: '#/components/schemas/AlarmIdentifier' + ChildHealthChecks: + type: array + items: + type: string + maxItems: 256 + x-insertionOrder: false + EnableSNI: + type: boolean + FailureThreshold: + type: integer + minimum: 1 + maximum: 10 + FullyQualifiedDomainName: + type: string + maxLength: 255 + HealthThreshold: + type: integer + minimum: 0 + maximum: 256 + InsufficientDataHealthStatus: + type: string + enum: + - Healthy + - LastKnownStatus + - Unhealthy + Inverted: + type: boolean + IPAddress: + type: string + maxLength: 45 + pattern: >- + ^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + MeasureLatency: + type: boolean + Port: + type: integer + minimum: 1 + maximum: 65535 + Regions: + type: array + items: + type: string + maxItems: 64 + x-insertionOrder: false + RequestInterval: + type: integer + minimum: 10 + maximum: 30 + ResourcePath: + type: string + maxLength: 255 + SearchString: + type: string + maxLength: 255 + RoutingControlArn: + type: string + minLength: 1 + maxLength: 255 + Type: + type: string + enum: + - CALCULATED + - CLOUDWATCH_METRIC + - HTTP + - HTTP_STR_MATCH + - HTTPS + - HTTPS_STR_MATCH + - TCP + - RECOVERY_CONTROL + required: + - Type + additionalProperties: false + HealthCheckTags: + type: array + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/HealthCheckTag' + x-stackQL-stringOnly: true + x-title: CreateHealthCheckRequest + type: object + required: [] + CreateHostedZoneRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HostedZoneTags: + uniqueItems: true + description: |- + Adds, edits, or deletes tags for a health check or a hosted zone. + For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/HostedZoneTag' + VPCs: + uniqueItems: true + description: |- + *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/VPC' + HostedZoneConfig: + description: |- + A complex type that contains an optional comment. + If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. + $ref: '#/components/schemas/HostedZoneConfig' + Id: + description: '' + type: string + NameServers: + uniqueItems: false + description: '' + type: array + items: + type: string + QueryLoggingConfig: + description: |- + Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. + DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + + Route 53 edge location that responded to the DNS query + + Domain or subdomain that was requested + + DNS record type, such as A or AAAA + + DNS response code, such as ``NoError`` or ``ServFail`` + + + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. + $ref: '#/components/schemas/QueryLoggingConfig' + Name: + description: |- + The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. + If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function. + type: string + maxLength: 1024 + x-stackQL-stringOnly: true + x-title: CreateHostedZoneRequest + type: object + required: [] + CreateKeySigningKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HostedZoneId: + description: The unique string (ID) used to identify a hosted zone. + type: string + pattern: ^[A-Z0-9]{1,32}$ + Status: + description: A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE. + type: string + enum: + - ACTIVE + - INACTIVE + Name: + description: An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone. + type: string + pattern: ^[a-zA-Z0-9_]{3,128}$ + KeyManagementServiceArn: + description: The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone. + type: string + minLength: 1 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateKeySigningKeyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: cidr_collections: name: cidr_collections id: awscc.route53.cidr_collections x-cfn-schema-name: CidrCollection - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' - AND region = 'us-east-1' - cidr_collection: - name: cidr_collection - id: awscc.route53.cidr_collection - x-cfn-schema-name: CidrCollection - x-type: get + x-cfn-type-name: AWS::Route53::CidrCollection x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CidrCollection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::CidrCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::CidrCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::CidrCollection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -499,7 +1261,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -511,13 +1273,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::CidrCollection' AND data__Identifier = '' AND region = 'us-east-1' - dnssecs: - name: dnssecs - id: awscc.route53.dnssecs - x-cfn-schema-name: DNSSEC - x-type: list + cidr_collections_list_only: + name: cidr_collections_list_only + id: awscc.route53.cidr_collections_list_only + x-cfn-schema-name: CidrCollection + x-cfn-type-name: AWS::Route53::CidrCollection x-identifiers: - - HostedZoneId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -525,28 +1293,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' AND region = 'us-east-1' - dnssec: - name: dnssec - id: awscc.route53.dnssec + dnssecs: + name: dnssecs + id: awscc.route53.dnssecs x-cfn-schema-name: DNSSEC - x-type: get + x-cfn-type-name: AWS::Route53::DNSSEC x-identifiers: - HostedZoneId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DNSSEC&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::DNSSEC" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::DNSSEC" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dnssecs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dnssecs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -556,7 +1359,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -565,13 +1368,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::DNSSEC' AND data__Identifier = '' AND region = 'us-east-1' - health_checks: - name: health_checks - id: awscc.route53.health_checks - x-cfn-schema-name: HealthCheck - x-type: list + dnssecs_list_only: + name: dnssecs_list_only + id: awscc.route53.dnssecs_list_only + x-cfn-schema-name: DNSSEC + x-cfn-type-name: AWS::Route53::DNSSEC x-identifiers: - - HealthCheckId + - HostedZoneId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -579,28 +1388,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.HealthCheckId') as health_check_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' + JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'HealthCheckId') as health_check_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' AND region = 'us-east-1' - health_check: - name: health_check - id: awscc.route53.health_check + health_checks: + name: health_checks + id: awscc.route53.health_checks x-cfn-schema-name: HealthCheck - x-type: get + x-cfn-type-name: AWS::Route53::HealthCheck x-identifiers: - HealthCheckId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HealthCheck&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::HealthCheck" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::HealthCheck" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::HealthCheck" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -612,7 +1469,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -623,13 +1480,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HealthCheck' AND data__Identifier = '' AND region = 'us-east-1' - hosted_zones: - name: hosted_zones - id: awscc.route53.hosted_zones - x-cfn-schema-name: HostedZone - x-type: list + health_checks_list_only: + name: health_checks_list_only + id: awscc.route53.health_checks_list_only + x-cfn-schema-name: HealthCheck + x-cfn-type-name: AWS::Route53::HealthCheck x-identifiers: - - Id + - HealthCheckId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -637,66 +1500,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' + JSON_EXTRACT(Properties, '$.HealthCheckId') as health_check_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' + json_extract_path_text(Properties, 'HealthCheckId') as health_check_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' AND region = 'us-east-1' - hosted_zone: - name: hosted_zone - id: awscc.route53.hosted_zone + hosted_zones: + name: hosted_zones + id: awscc.route53.hosted_zones x-cfn-schema-name: HostedZone - x-type: get + x-cfn-type-name: AWS::Route53::HostedZone x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HostedZone&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::HostedZone" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::HostedZone" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::HostedZone" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.HostedZoneConfig') as hosted_zone_config, JSON_EXTRACT(Properties, '$.HostedZoneTags') as hosted_zone_tags, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.QueryLoggingConfig') as query_logging_config, JSON_EXTRACT(Properties, '$.VPCs') as vpcs, - JSON_EXTRACT(Properties, '$.NameServers') as name_servers + JSON_EXTRACT(Properties, '$.HostedZoneConfig') as hosted_zone_config, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.NameServers') as name_servers, + JSON_EXTRACT(Properties, '$.QueryLoggingConfig') as query_logging_config, + JSON_EXTRACT(Properties, '$.Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HostedZone' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'HostedZoneConfig') as hosted_zone_config, json_extract_path_text(Properties, 'HostedZoneTags') as hosted_zone_tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'QueryLoggingConfig') as query_logging_config, json_extract_path_text(Properties, 'VPCs') as vpcs, - json_extract_path_text(Properties, 'NameServers') as name_servers + json_extract_path_text(Properties, 'HostedZoneConfig') as hosted_zone_config, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'NameServers') as name_servers, + json_extract_path_text(Properties, 'QueryLoggingConfig') as query_logging_config, + json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HostedZone' AND data__Identifier = '' AND region = 'us-east-1' - key_signing_keys: - name: key_signing_keys - id: awscc.route53.key_signing_keys - x-cfn-schema-name: KeySigningKey - x-type: list + hosted_zones_list_only: + name: hosted_zones_list_only + id: awscc.route53.hosted_zones_list_only + x-cfn-schema-name: HostedZone + x-cfn-type-name: AWS::Route53::HostedZone x-identifiers: - - HostedZoneId - - Name + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -704,31 +1620,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' AND region = 'us-east-1' - key_signing_key: - name: key_signing_key - id: awscc.route53.key_signing_key + key_signing_keys: + name: key_signing_keys + id: awscc.route53.key_signing_keys x-cfn-schema-name: KeySigningKey - x-type: get + x-cfn-type-name: AWS::Route53::KeySigningKey x-identifiers: - HostedZoneId - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KeySigningKey&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::KeySigningKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::KeySigningKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53::KeySigningKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -741,7 +1703,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -753,3 +1715,400 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::KeySigningKey' AND data__Identifier = '|' AND region = 'us-east-1' + key_signing_keys_list_only: + name: key_signing_keys_list_only + id: awscc.route53.key_signing_keys_list_only + x-cfn-schema-name: KeySigningKey + x-cfn-type-name: AWS::Route53::KeySigningKey + x-identifiers: + - HostedZoneId + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CidrCollection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCidrCollection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCidrCollectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DNSSEC&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDNSSEC + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDNSSECRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HealthCheck&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHealthCheck + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHealthCheckRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HostedZone&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHostedZone + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHostedZoneRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__KeySigningKey&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKeySigningKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeySigningKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/route53profiles.yaml b/providers/src/awscc/v00.00.00000/services/route53profiles.yaml new file mode 100644 index 00000000..9ed77e1f --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/route53profiles.yaml @@ -0,0 +1,1378 @@ +openapi: 3.0.0 +info: + title: Route53Profiles + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Value + - Key + Profile: + type: object + properties: + Name: + type: string + description: The name of the profile. + minLength: 1 + maxLength: 64 + ClientToken: + type: string + description: The id of the creator request + minLength: 1 + maxLength: 64 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver profile. + Id: + type: string + description: The ID of the profile. + required: + - Name + x-stackql-resource-name: profile + description: Resource Type definition for AWS::Route53Profiles::Profile + x-type-name: AWS::Route53Profiles::Profile + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + x-read-only-properties: + - Arn + - Id + - ClientToken + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53profiles:TagResource + - route53profiles:UntagResource + x-required-permissions: + create: + - route53profiles:CreateProfile + - route53profiles:GetProfile + - route53profiles:TagResource + - route53profiles:ListTagsForResource + update: + - route53profiles:GetProfile + - route53profiles:TagResource + - route53profiles:UntagResource + - route53profiles:ListTagsForResource + read: + - route53profiles:GetProfile + - route53profiles:ListTagsForResource + delete: + - route53profiles:DeleteProfile + - route53profiles:GetProfile + - route53profiles:UntagResource + - route53profiles:ListTagsForResource + list: + - route53profiles:ListProfiles + - route53profiles:ListTagsForResource + ProfileAssociation: + type: object + properties: + ResourceId: + description: The resource that you associated the profile with. + type: string + ProfileId: + description: The ID of the profile that you associated with the resource that is specified by ResourceId. + type: string + Id: + description: Primary Identifier for Profile Association + type: string + Name: + description: The name of an association between a Profile and a VPC. + type: string + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the profile association. + required: + - ResourceId + - ProfileId + - Name + x-stackql-resource-name: profile_association + description: Resource Type definition for AWS::Route53Profiles::ProfileAssociation + x-type-name: AWS::Route53Profiles::ProfileAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + - ResourceId + - ProfileId + x-write-only-properties: + - Arn + x-read-only-properties: + - Id + x-required-properties: + - ResourceId + - ProfileId + - Name + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53profiles:TagResource + - route53profiles:UntagResource + x-required-permissions: + create: + - route53profiles:AssociateProfile + - route53profiles:GetProfileAssociation + - route53profiles:ListProfileAssociations + - ec2:DescribeVpcs + - route53profiles:TagResource + - route53profiles:ListTagsForResource + update: + - route53profiles:GetProfileAssociation + - route53profiles:TagResource + - route53profiles:UntagResource + - route53profiles:ListTagsForResource + read: + - route53profiles:GetProfileAssociation + - route53profiles:ListTagsForResource + delete: + - route53profiles:DisassociateProfile + - route53profiles:GetProfileAssociation + - route53profiles:UntagResource + - route53profiles:ListTagsForResource + list: + - route53profiles:ListProfileAssociations + - route53profiles:ListTagsForResource + ProfileResourceAssociation: + type: object + properties: + ProfileId: + description: The ID of the profile that you associated the resource to that is specified by ResourceArn. + type: string + Id: + description: Primary Identifier for Profile Resource Association + type: string + Name: + description: The name of an association between the Profile and resource. + type: string + ResourceArn: + description: The arn of the resource that you associated to the Profile. + type: string + ResourceProperties: + description: A JSON-formatted string with key-value pairs specifying the properties of the associated resource. + type: string + ResourceType: + description: The type of the resource associated to the Profile. + type: string + required: + - ProfileId + - Name + - ResourceArn + x-stackql-resource-name: profile_resource_association + description: Resource Type definition for AWS::Route53Profiles::ProfileResourceAssociation + x-type-name: AWS::Route53Profiles::ProfileResourceAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - ProfileId + - Name + - ResourceArn + x-read-only-properties: + - Id + - ResourceType + x-required-properties: + - ProfileId + - Name + - ResourceArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - route53profiles:AssociateResourceToProfile + - route53profiles:GetProfileResourceAssociation + - route53resolver:GetFirewallRuleGroup + - route53resolver:GetResolverRule + - route53:GetHostedZone + - route53resolver:GetResolverQueryLogConfig + - ec2:DescribeVpcEndpoints + read: + - route53profiles:GetProfileResourceAssociation + delete: + - route53profiles:DisassociateResourceFromProfile + - route53profiles:GetProfileResourceAssociation + - route53resolver:GetFirewallRuleGroup + - route53resolver:GetResolverRule + - route53:GetHostedZone + - route53resolver:GetResolverQueryLogConfig + - ec2:DescribeVpcEndpoints + list: + - route53profiles:ListProfileResourceAssociations + update: + - route53profiles:UpdateProfileResourceAssociation + CreateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + description: The name of the profile. + minLength: 1 + maxLength: 64 + ClientToken: + type: string + description: The id of the creator request + minLength: 1 + maxLength: 64 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver profile. + Id: + type: string + description: The ID of the profile. + x-stackQL-stringOnly: true + x-title: CreateProfileRequest + type: object + required: [] + CreateProfileAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceId: + description: The resource that you associated the profile with. + type: string + ProfileId: + description: The ID of the profile that you associated with the resource that is specified by ResourceId. + type: string + Id: + description: Primary Identifier for Profile Association + type: string + Name: + description: The name of an association between a Profile and a VPC. + type: string + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the profile association. + x-stackQL-stringOnly: true + x-title: CreateProfileAssociationRequest + type: object + required: [] + CreateProfileResourceAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProfileId: + description: The ID of the profile that you associated the resource to that is specified by ResourceArn. + type: string + Id: + description: Primary Identifier for Profile Resource Association + type: string + Name: + description: The name of an association between the Profile and resource. + type: string + ResourceArn: + description: The arn of the resource that you associated to the Profile. + type: string + ResourceProperties: + description: A JSON-formatted string with key-value pairs specifying the properties of the associated resource. + type: string + ResourceType: + description: The type of the resource associated to the Profile. + type: string + x-stackQL-stringOnly: true + x-title: CreateProfileResourceAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + profiles: + name: profiles + id: awscc.route53profiles.profiles + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::Route53Profiles::Profile + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ClientToken') as client_token, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + profiles_list_only: + name: profiles_list_only + id: awscc.route53profiles.profiles_list_only + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::Route53Profiles::Profile + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND region = 'us-east-1' + profile_associations: + name: profile_associations + id: awscc.route53profiles.profile_associations + x-cfn-schema-name: ProfileAssociation + x-cfn-type-name: AWS::Route53Profiles::ProfileAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProfileAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profile_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profile_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profile_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + profile_associations_list_only: + name: profile_associations_list_only + id: awscc.route53profiles.profile_associations_list_only + x-cfn-schema-name: ProfileAssociation + x-cfn-type-name: AWS::Route53Profiles::ProfileAssociation + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND region = 'us-east-1' + profile_resource_associations: + name: profile_resource_associations + id: awscc.route53profiles.profile_resource_associations + x-cfn-schema-name: ProfileResourceAssociation + x-cfn-type-name: AWS::Route53Profiles::ProfileResourceAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProfileResourceAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profile_resource_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profile_resource_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profile_resource_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.ResourceProperties') as resource_properties, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ResourceProperties') as resource_properties, + json_extract_path_text(Properties, 'ResourceType') as resource_type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + profile_resource_associations_list_only: + name: profile_resource_associations_list_only + id: awscc.route53profiles.profile_resource_associations_list_only + x-cfn-schema-name: ProfileResourceAssociation + x-cfn-type-name: AWS::Route53Profiles::ProfileResourceAssociation + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProfileAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfileAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProfileResourceAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfileResourceAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileResourceAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/route53recoverycontrol.yaml b/providers/src/awscc/v00.00.00000/services/route53recoverycontrol.yaml index f1e159e1..971babfb 100644 --- a/providers/src/awscc/v00.00.00000/services/route53recoverycontrol.yaml +++ b/providers/src/awscc/v00.00.00000/services/route53recoverycontrol.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Route53RecoveryControl - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ClusterEndpoint: type: object @@ -44,6 +424,7 @@ components: type: string minLength: 1 maxLength: 2048 + pattern: ^[A-Za-z0-9:\/_-]*$ Status: description: 'Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.' type: string @@ -64,10 +445,18 @@ components: $ref: '#/components/schemas/Tag' maxItems: 20 x-insertionOrder: false + NetworkType: + description: Cluster supports IPv4 endpoints and Dual-stack IPv4 and IPv6 endpoints. NetworkType can be IPV4 or DUALSTACK. + type: string + enum: + - IPV4 + - DUALSTACK required: - Name x-stackql-resource-name: cluster - x-stackql-primaryIdentifier: + description: AWS Route53 Recovery Control Cluster resource schema + x-type-name: AWS::Route53RecoveryControl::Cluster + x-stackql-primary-identifier: - ClusterArn x-create-only-properties: - Name @@ -76,6 +465,18 @@ components: - ClusterArn - ClusterEndpoints - Status + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-control-config:TagResource + - route53-recovery-control-config:UntagResource + - route53-recovery-control-config:ListTagsForResource x-required-permissions: create: - route53-recovery-control-config:CreateCluster @@ -88,6 +489,10 @@ components: delete: - route53-recovery-control-config:DescribeCluster - route53-recovery-control-config:DeleteCluster + update: + - route53-recovery-control-config:DescribeCluster + - route53-recovery-control-config:ListTagsForResource + - route53-recovery-control-config:UpdateCluster list: - route53-recovery-control-config:ListClusters ControlPanel: @@ -96,9 +501,11 @@ components: ClusterArn: description: Cluster to associate with the Control Panel type: string + pattern: ^[A-Za-z0-9:\/_-]*$ ControlPanelArn: description: The Amazon Resource Name (ARN) of the cluster. type: string + pattern: ^[A-Za-z0-9:\/_-]*$ Name: description: The name of the control panel. You can use any non-white space character in the name. type: string @@ -127,7 +534,9 @@ components: required: - Name x-stackql-resource-name: control_panel - x-stackql-primaryIdentifier: + description: AWS Route53 Recovery Control Control Panel resource schema . + x-type-name: AWS::Route53RecoveryControl::ControlPanel + x-stackql-primary-identifier: - ControlPanelArn x-create-only-properties: - ClusterArn @@ -137,6 +546,18 @@ components: - Status - RoutingControlCount - DefaultControlPanel + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-control-config:TagResource + - route53-recovery-control-config:UntagResource + - route53-recovery-control-config:ListTagsForResource x-required-permissions: create: - route53-recovery-control-config:CreateControlPanel @@ -164,9 +585,11 @@ components: RoutingControlArn: description: The Amazon Resource Name (ARN) of the routing control. type: string + pattern: ^[A-Za-z0-9:\/_-]*$ ControlPanelArn: description: The Amazon Resource Name (ARN) of the control panel. type: string + pattern: ^[A-Za-z0-9:\/_-]*$ Name: description: The name of the routing control. You can use any non-white space character in the name. type: string @@ -182,17 +605,26 @@ components: ClusterArn: description: Arn associated with Control Panel type: string + pattern: ^[A-Za-z0-9:\/_-]*$ required: - Name x-stackql-resource-name: routing_control - x-stackql-primaryIdentifier: + description: AWS Route53 Recovery Control Routing Control resource schema . + x-type-name: AWS::Route53RecoveryControl::RoutingControl + x-stackql-primary-identifier: - RoutingControlArn x-create-only-properties: - ControlPanelArn - ClusterArn + x-write-only-properties: + - ClusterArn x-read-only-properties: - RoutingControlArn - Status + x-required-properties: + - Name + x-tagging: + taggable: false x-required-permissions: create: - route53-recovery-control-config:CreateRoutingControl @@ -313,16 +745,31 @@ components: x-insertionOrder: false required: [] x-stackql-resource-name: safety_rule - x-stackql-primaryIdentifier: + description: Resource schema for AWS Route53 Recovery Control basic constructs and validation rules. + x-type-name: AWS::Route53RecoveryControl::SafetyRule + x-stackql-primary-identifier: - SafetyRuleArn - x-create-only-properties: + x-conditional-create-only-properties: - ControlPanelArn - RuleConfig - - ControlPanelArn - Tags + - AssertionRule/AssertedControls + - GatingRule/GatingControls + - GatingRule/TargetControls x-read-only-properties: - SafetyRuleArn - Status + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-control-config:TagResource + - route53-recovery-control-config:UntagResource + - route53-recovery-control-config:ListTagsForResource x-required-permissions: create: - route53-recovery-control-config:CreateSafetyRule @@ -345,43 +792,263 @@ components: - route53-recovery-control-config:DeleteSafetyRule list: - route53-recovery-control-config:ListSafetyRules + CreateClusterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of a Cluster. You can use any non-white space character in the name + type: string + minLength: 1 + maxLength: 64 + ClusterArn: + description: The Amazon Resource Name (ARN) of the cluster. + type: string + minLength: 1 + maxLength: 2048 + pattern: ^[A-Za-z0-9:\/_-]*$ + Status: + description: 'Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.' + type: string + enum: + - PENDING + - DEPLOYED + - PENDING_DELETION + ClusterEndpoints: + description: Endpoints for the cluster. + type: array + items: + $ref: '#/components/schemas/ClusterEndpoint' + x-insertionOrder: false + Tags: + description: A collection of tags associated with a resource + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + NetworkType: + description: Cluster supports IPv4 endpoints and Dual-stack IPv4 and IPv6 endpoints. NetworkType can be IPV4 or DUALSTACK. + type: string + enum: + - IPV4 + - DUALSTACK + x-stackQL-stringOnly: true + x-title: CreateClusterRequest + type: object + required: [] + CreateControlPanelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterArn: + description: Cluster to associate with the Control Panel + type: string + pattern: ^[A-Za-z0-9:\/_-]*$ + ControlPanelArn: + description: The Amazon Resource Name (ARN) of the cluster. + type: string + pattern: ^[A-Za-z0-9:\/_-]*$ + Name: + description: The name of the control panel. You can use any non-white space character in the name. + type: string + minLength: 1 + maxLength: 64 + Status: + description: 'The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.' + type: string + enum: + - PENDING + - DEPLOYED + - PENDING_DELETION + DefaultControlPanel: + description: A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false. + type: boolean + RoutingControlCount: + description: Count of associated routing controls + type: integer + Tags: + description: A collection of tags associated with a resource + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateControlPanelRequest + type: object + required: [] + CreateRoutingControlRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RoutingControlArn: + description: The Amazon Resource Name (ARN) of the routing control. + type: string + pattern: ^[A-Za-z0-9:\/_-]*$ + ControlPanelArn: + description: The Amazon Resource Name (ARN) of the control panel. + type: string + pattern: ^[A-Za-z0-9:\/_-]*$ + Name: + description: The name of the routing control. You can use any non-white space character in the name. + type: string + minLength: 1 + maxLength: 64 + Status: + description: 'The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.' + type: string + enum: + - PENDING + - DEPLOYED + - PENDING_DELETION + ClusterArn: + description: Arn associated with Control Panel + type: string + pattern: ^[A-Za-z0-9:\/_-]*$ + x-stackQL-stringOnly: true + x-title: CreateRoutingControlRequest + type: object + required: [] + CreateSafetyRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssertionRule: + $ref: '#/components/schemas/AssertionRule' + GatingRule: + $ref: '#/components/schemas/GatingRule' + Name: + $ref: '#/components/schemas/SafetyRuleName' + SafetyRuleArn: + description: The Amazon Resource Name (ARN) of the safety rule. + type: string + ControlPanelArn: + description: The Amazon Resource Name (ARN) of the control panel. + type: string + Status: + description: 'The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.' + type: string + enum: + - PENDING + - DEPLOYED + - PENDING_DELETION + RuleConfig: + $ref: '#/components/schemas/RuleConfig' + Tags: + description: A collection of tags associated with a resource + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateSafetyRuleRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: clusters: name: clusters id: awscc.route53recoverycontrol.clusters x-cfn-schema-name: Cluster - x-type: list - x-identifiers: - - ClusterArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: awscc.route53recoverycontrol.cluster - x-cfn-schema-name: Cluster - x-type: get + x-cfn-type-name: AWS::Route53RecoveryControl::Cluster x-identifiers: - ClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -390,12 +1057,13 @@ components: JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn, JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.ClusterEndpoints') as cluster_endpoints, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.NetworkType') as network_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -404,17 +1072,24 @@ components: json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'ClusterEndpoints') as cluster_endpoints, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'NetworkType') as network_type FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' AND data__Identifier = '' AND region = 'us-east-1' - control_panels: - name: control_panels - id: awscc.route53recoverycontrol.control_panels - x-cfn-schema-name: ControlPanel - x-type: list + clusters_list_only: + name: clusters_list_only + id: awscc.route53recoverycontrol.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::Route53RecoveryControl::Cluster x-identifiers: - - ControlPanelArn + - ClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -422,28 +1097,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ControlPanelArn') as control_panel_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' AND region = 'us-east-1' - control_panel: - name: control_panel - id: awscc.route53recoverycontrol.control_panel + control_panels: + name: control_panels + id: awscc.route53recoverycontrol.control_panels x-cfn-schema-name: ControlPanel - x-type: get + x-cfn-type-name: AWS::Route53RecoveryControl::ControlPanel x-identifiers: - ControlPanelArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ControlPanel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::ControlPanel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::ControlPanel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::ControlPanel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/control_panels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/control_panels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/control_panels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -459,7 +1182,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -474,13 +1197,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' AND data__Identifier = '' AND region = 'us-east-1' - routing_controls: - name: routing_controls - id: awscc.route53recoverycontrol.routing_controls - x-cfn-schema-name: RoutingControl - x-type: list + control_panels_list_only: + name: control_panels_list_only + id: awscc.route53recoverycontrol.control_panels_list_only + x-cfn-schema-name: ControlPanel + x-cfn-type-name: AWS::Route53RecoveryControl::ControlPanel x-identifiers: - - RoutingControlArn + - ControlPanelArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -488,28 +1217,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RoutingControlArn') as routing_control_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' + JSON_EXTRACT(Properties, '$.ControlPanelArn') as control_panel_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RoutingControlArn') as routing_control_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' + json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' AND region = 'us-east-1' - routing_control: - name: routing_control - id: awscc.route53recoverycontrol.routing_control + routing_controls: + name: routing_controls + id: awscc.route53recoverycontrol.routing_controls x-cfn-schema-name: RoutingControl - x-type: get + x-cfn-type-name: AWS::Route53RecoveryControl::RoutingControl x-identifiers: - RoutingControlArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RoutingControl&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::RoutingControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::RoutingControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::RoutingControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routing_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routing_controls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/routing_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -523,7 +1300,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -536,13 +1313,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' AND data__Identifier = '' AND region = 'us-east-1' - safety_rules: - name: safety_rules - id: awscc.route53recoverycontrol.safety_rules - x-cfn-schema-name: SafetyRule - x-type: list + routing_controls_list_only: + name: routing_controls_list_only + id: awscc.route53recoverycontrol.routing_controls_list_only + x-cfn-schema-name: RoutingControl + x-cfn-type-name: AWS::Route53RecoveryControl::RoutingControl x-identifiers: - - SafetyRuleArn + - RoutingControlArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -550,28 +1333,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SafetyRuleArn') as safety_rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' + JSON_EXTRACT(Properties, '$.RoutingControlArn') as routing_control_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SafetyRuleArn') as safety_rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' + json_extract_path_text(Properties, 'RoutingControlArn') as routing_control_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' AND region = 'us-east-1' - safety_rule: - name: safety_rule - id: awscc.route53recoverycontrol.safety_rule + safety_rules: + name: safety_rules + id: awscc.route53recoverycontrol.safety_rules x-cfn-schema-name: SafetyRule - x-type: get + x-cfn-type-name: AWS::Route53RecoveryControl::SafetyRule x-identifiers: - SafetyRuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SafetyRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::SafetyRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::SafetyRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryControl::SafetyRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/safety_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/safety_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/safety_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -588,7 +1419,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -604,3 +1435,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' AND data__Identifier = '' AND region = 'us-east-1' + safety_rules_list_only: + name: safety_rules_list_only + id: awscc.route53recoverycontrol.safety_rules_list_only + x-cfn-schema-name: SafetyRule + x-cfn-type-name: AWS::Route53RecoveryControl::SafetyRule + x-identifiers: + - SafetyRuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SafetyRuleArn') as safety_rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SafetyRuleArn') as safety_rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ControlPanel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateControlPanel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateControlPanelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RoutingControl&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRoutingControl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoutingControlRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SafetyRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSafetyRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSafetyRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/route53recoveryreadiness.yaml b/providers/src/awscc/v00.00.00000/services/route53recoveryreadiness.yaml index 99ac29a7..57c3574b 100644 --- a/providers/src/awscc/v00.00.00000/services/route53recoveryreadiness.yaml +++ b/providers/src/awscc/v00.00.00000/services/route53recoveryreadiness.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Route53RecoveryReadiness - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -50,13 +430,25 @@ components: maxItems: 20 x-insertionOrder: false x-stackql-resource-name: cell - x-stackql-primaryIdentifier: + description: The API Schema for AWS Route53 Recovery Readiness Cells. + x-type-name: AWS::Route53RecoveryReadiness::Cell + x-stackql-primary-identifier: - CellName x-create-only-properties: - CellName x-read-only-properties: - CellArn - ParentReadinessScopes + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-readiness:TagResource + - route53-recovery-readiness:UntagResource + - route53-recovery-readiness:ListTagsForResource x-required-permissions: create: - route53-recovery-readiness:CreateCell @@ -104,12 +496,24 @@ components: maxItems: 20 x-insertionOrder: false x-stackql-resource-name: readiness_check - x-stackql-primaryIdentifier: + description: Aws Route53 Recovery Readiness Check Schema and API specification. + x-type-name: AWS::Route53RecoveryReadiness::ReadinessCheck + x-stackql-primary-identifier: - ReadinessCheckName x-create-only-properties: - ReadinessCheckName x-read-only-properties: - ReadinessCheckArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-readiness:TagResource + - route53-recovery-readiness:UntagResource + - route53-recovery-readiness:ListTagsForResources x-required-permissions: create: - route53-recovery-readiness:CreateReadinessCheck @@ -163,12 +567,24 @@ components: maxItems: 20 x-insertionOrder: false x-stackql-resource-name: recovery_group - x-stackql-primaryIdentifier: + description: AWS Route53 Recovery Readiness Recovery Group Schema and API specifications. + x-type-name: AWS::Route53RecoveryReadiness::RecoveryGroup + x-stackql-primary-identifier: - RecoveryGroupName x-create-only-properties: - RecoveryGroupName x-read-only-properties: - RecoveryGroupArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-readiness:TagResource + - route53-recovery-readiness:UntagResource + - route53-recovery-readiness:ListTagsForResource x-required-permissions: create: - route53-recovery-readiness:CreateRecoveryGroup @@ -299,13 +715,28 @@ components: - ResourceSetType - Resources x-stackql-resource-name: resource_set - x-stackql-primaryIdentifier: + description: Schema for the AWS Route53 Recovery Readiness ResourceSet Resource and API. + x-type-name: AWS::Route53RecoveryReadiness::ResourceSet + x-stackql-primary-identifier: - ResourceSetName x-create-only-properties: - ResourceSetName - ResourceSetType x-read-only-properties: - ResourceSetArn + x-required-properties: + - ResourceSetType + - Resources + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - route53-recovery-readiness:TagResource + - route53-recovery-readiness:UntagResource + - route53-recovery-readiness:ListTagsForResource x-required-permissions: create: - route53-recovery-readiness:CreateResourceSet @@ -330,43 +761,249 @@ components: - route53-recovery-readiness:GetResourceSet list: - route53-recovery-readiness:ListResourceSets + CreateCellRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CellName: + description: The name of the cell to create. + type: string + pattern: '[a-zA-Z0-9_]+' + maxLength: 64 + CellArn: + description: The Amazon Resource Name (ARN) of the cell. + type: string + maxLength: 256 + Cells: + description: A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions. + type: array + items: + type: string + maxItems: 5 + x-insertionOrder: false + ParentReadinessScopes: + description: The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element. + type: array + items: + type: string + maxItems: 5 + x-insertionOrder: false + Tags: + description: A collection of tags associated with a resource + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateCellRequest + type: object + required: [] + CreateReadinessCheckRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceSetName: + description: The name of the resource set to check. + type: string + pattern: '[a-zA-Z0-9_]+' + minLength: 1 + maxLength: 64 + ReadinessCheckName: + description: Name of the ReadinessCheck to create. + type: string + pattern: '[a-zA-Z0-9_]+' + minLength: 1 + maxLength: 64 + ReadinessCheckArn: + description: The Amazon Resource Name (ARN) of the readiness check. + type: string + maxLength: 256 + Tags: + description: A collection of tags associated with a resource. + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateReadinessCheckRequest + type: object + required: [] + CreateRecoveryGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RecoveryGroupName: + description: The name of the recovery group to create. + type: string + pattern: '[a-zA-Z0-9_]+' + minLength: 1 + maxLength: 64 + Cells: + description: A list of the cell Amazon Resource Names (ARNs) in the recovery group. + type: array + items: + type: string + minLength: 1 + maxLength: 256 + maxItems: 5 + x-insertionOrder: false + RecoveryGroupArn: + description: A collection of tags associated with a resource. + type: string + maxLength: 256 + Tags: + description: A collection of tags associated with a resource. + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateRecoveryGroupRequest + type: object + required: [] + CreateResourceSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceSetName: + description: The name of the resource set to create. + type: string + Resources: + description: A list of resource objects in the resource set. + type: array + items: + $ref: '#/components/schemas/Resource' + minItems: 1 + maxItems: 6 + x-insertionOrder: false + ResourceSetArn: + description: The Amazon Resource Name (ARN) of the resource set. + type: string + minLength: 1 + maxLength: 256 + ResourceSetType: + description: |- + The resource type of the resources in the resource set. Enter one of the following values for resource type: + + AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource + type: string + Tags: + description: A tag to associate with the parameters for a resource set. + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 20 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateResourceSetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: cells: name: cells id: awscc.route53recoveryreadiness.cells x-cfn-schema-name: Cell - x-type: list - x-identifiers: - - CellName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CellName') as cell_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CellName') as cell_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' - AND region = 'us-east-1' - cell: - name: cell - id: awscc.route53recoveryreadiness.cell - x-cfn-schema-name: Cell - x-type: get + x-cfn-type-name: AWS::Route53RecoveryReadiness::Cell x-identifiers: - CellName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cell&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::Cell" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::Cell" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::Cell" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cells/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cells/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cells/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -380,7 +1017,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -393,13 +1030,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' AND data__Identifier = '' AND region = 'us-east-1' - readiness_checks: - name: readiness_checks - id: awscc.route53recoveryreadiness.readiness_checks - x-cfn-schema-name: ReadinessCheck - x-type: list + cells_list_only: + name: cells_list_only + id: awscc.route53recoveryreadiness.cells_list_only + x-cfn-schema-name: Cell + x-cfn-type-name: AWS::Route53RecoveryReadiness::Cell x-identifiers: - - ReadinessCheckName + - CellName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -407,28 +1050,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ReadinessCheckName') as readiness_check_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' + JSON_EXTRACT(Properties, '$.CellName') as cell_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ReadinessCheckName') as readiness_check_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' + json_extract_path_text(Properties, 'CellName') as cell_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' AND region = 'us-east-1' - readiness_check: - name: readiness_check - id: awscc.route53recoveryreadiness.readiness_check + readiness_checks: + name: readiness_checks + id: awscc.route53recoveryreadiness.readiness_checks x-cfn-schema-name: ReadinessCheck - x-type: get + x-cfn-type-name: AWS::Route53RecoveryReadiness::ReadinessCheck x-identifiers: - ReadinessCheckName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReadinessCheck&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::ReadinessCheck" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::ReadinessCheck" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::ReadinessCheck" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -441,7 +1132,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -453,13 +1144,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' AND data__Identifier = '' AND region = 'us-east-1' - recovery_groups: - name: recovery_groups - id: awscc.route53recoveryreadiness.recovery_groups - x-cfn-schema-name: RecoveryGroup - x-type: list + readiness_checks_list_only: + name: readiness_checks_list_only + id: awscc.route53recoveryreadiness.readiness_checks_list_only + x-cfn-schema-name: ReadinessCheck + x-cfn-type-name: AWS::Route53RecoveryReadiness::ReadinessCheck x-identifiers: - - RecoveryGroupName + - ReadinessCheckName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -467,28 +1164,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RecoveryGroupName') as recovery_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' + JSON_EXTRACT(Properties, '$.ReadinessCheckName') as readiness_check_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RecoveryGroupName') as recovery_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' + json_extract_path_text(Properties, 'ReadinessCheckName') as readiness_check_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' AND region = 'us-east-1' - recovery_group: - name: recovery_group - id: awscc.route53recoveryreadiness.recovery_group + recovery_groups: + name: recovery_groups + id: awscc.route53recoveryreadiness.recovery_groups x-cfn-schema-name: RecoveryGroup - x-type: get + x-cfn-type-name: AWS::Route53RecoveryReadiness::RecoveryGroup x-identifiers: - RecoveryGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RecoveryGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::RecoveryGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::RecoveryGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::RecoveryGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -501,7 +1246,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -513,13 +1258,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' AND data__Identifier = '' AND region = 'us-east-1' - resource_sets: - name: resource_sets - id: awscc.route53recoveryreadiness.resource_sets - x-cfn-schema-name: ResourceSet - x-type: list + recovery_groups_list_only: + name: recovery_groups_list_only + id: awscc.route53recoveryreadiness.recovery_groups_list_only + x-cfn-schema-name: RecoveryGroup + x-cfn-type-name: AWS::Route53RecoveryReadiness::RecoveryGroup x-identifiers: - - ResourceSetName + - RecoveryGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -527,28 +1278,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResourceSetName') as resource_set_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' + JSON_EXTRACT(Properties, '$.RecoveryGroupName') as recovery_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' + json_extract_path_text(Properties, 'RecoveryGroupName') as recovery_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' AND region = 'us-east-1' - resource_set: - name: resource_set - id: awscc.route53recoveryreadiness.resource_set + resource_sets: + name: resource_sets + id: awscc.route53recoveryreadiness.resource_sets x-cfn-schema-name: ResourceSet - x-type: get + x-cfn-type-name: AWS::Route53RecoveryReadiness::ResourceSet x-identifiers: - ResourceSetName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::ResourceSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::ResourceSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53RecoveryReadiness::ResourceSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -562,7 +1361,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -575,3 +1374,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' AND data__Identifier = '' AND region = 'us-east-1' + resource_sets_list_only: + name: resource_sets_list_only + id: awscc.route53recoveryreadiness.resource_sets_list_only + x-cfn-schema-name: ResourceSet + x-cfn-type-name: AWS::Route53RecoveryReadiness::ResourceSet + x-identifiers: + - ResourceSetName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ResourceSetName') as resource_set_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cell&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCell + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCellRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReadinessCheck&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReadinessCheck + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReadinessCheckRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RecoveryGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRecoveryGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRecoveryGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/route53resolver.yaml b/providers/src/awscc/v00.00.00000/services/route53resolver.yaml index 3fc9865d..a2422b49 100644 --- a/providers/src/awscc/v00.00.00000/services/route53resolver.yaml +++ b/providers/src/awscc/v00.00.00000/services/route53resolver.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Route53Resolver - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Domains: description: An inline list of domains to use for this domain list. @@ -102,10 +482,15 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: firewall_domain_list - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::FirewallDomainList. + x-type-name: AWS::Route53Resolver::FirewallDomainList + x-stackql-primary-identifier: - Id x-create-only-properties: - Name + x-write-only-properties: + - Domains + - DomainFileUrl x-read-only-properties: - Id - Arn @@ -116,42 +501,41 @@ components: - CreatorRequestId - CreationTime - ModificationTime + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource x-required-permissions: create: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:CreateFirewallDomainList + - route53resolver:GetFirewallDomainList + - route53resolver:ImportFirewallDomains + - route53resolver:UpdateFirewallDomains + - route53resolver:TagResource + - route53resolver:ListTagsForResource list: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:ListFirewallDomainLists + - route53resolver:ListTagsForResource read: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallDomainList + - route53resolver:ListTagsForResource delete: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallDomainList + - route53resolver:DeleteFirewallDomainList + - route53resolver:UntagResource + - route53resolver:ListTagsForResource update: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallDomainList + - route53resolver:ImportFirewallDomains + - route53resolver:UpdateFirewallDomains + - route53resolver:TagResource + - route53resolver:UntagResource + - route53resolver:ListTagsForResource FirewallRule: description: Firewall Rule associating the Rule Group to a Domain List type: object @@ -161,6 +545,11 @@ components: type: string minLength: 1 maxLength: 64 + FirewallThreatProtectionId: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 Priority: description: Rule Priority type: integer @@ -198,8 +587,26 @@ components: type: string minLength: 1 maxLength: 16 + ConfidenceThreshold: + description: FirewallDomainRedirectionAction + type: string + enum: + - LOW + - MEDIUM + - HIGH + DnsThreatProtection: + description: FirewallDomainRedirectionAction + type: string + enum: + - DGA + - DNS_TUNNELING + FirewallDomainRedirectionAction: + description: FirewallDomainRedirectionAction + type: string + enum: + - INSPECT_REDIRECTION_DOMAIN + - TRUST_REDIRECTION_DOMAIN required: - - FirewallDomainListId - Priority - Action additionalProperties: false @@ -278,7 +685,9 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: firewall_rule_group - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::FirewallRuleGroup. + x-type-name: AWS::Route53Resolver::FirewallRuleGroup + x-stackql-primary-identifier: - Id x-create-only-properties: - Name @@ -293,42 +702,48 @@ components: - CreatorRequestId - CreationTime - ModificationTime + - FirewallRules/*/FirewallThreatProtectionId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource x-required-permissions: create: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:CreateFirewallRuleGroup + - route53resolver:GetFirewallRuleGroup + - route53resolver:ListFirewallRules + - route53resolver:CreateFirewallRule + - route53resolver:DeleteFirewallRule + - route53resolver:TagResource + - route53resolver:ListTagsForResource read: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallRuleGroup + - route53resolver:ListFirewallRules + - route53resolver:ListTagsForResource list: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:ListFirewallRuleGroups + - route53resolver:ListTagsForResource delete: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallRuleGroup + - route53resolver:DeleteFirewallRuleGroup + - route53resolver:ListFirewallRules + - route53resolver:DeleteFirewallRule + - route53resolver:UntagResource + - route53resolver:ListTagsForResource update: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallRuleGroup + - route53resolver:ListFirewallRules + - route53resolver:CreateFirewallRule + - route53resolver:UpdateFirewallRule + - route53resolver:DeleteFirewallRule + - route53resolver:TagResource + - route53resolver:UntagResource + - route53resolver:ListTagsForResource FirewallRuleGroupAssociation: type: object properties: @@ -410,7 +825,9 @@ components: - VpcId - Priority x-stackql-resource-name: firewall_rule_group_association - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation. + x-type-name: AWS::Route53Resolver::FirewallRuleGroupAssociation + x-stackql-primary-identifier: - Id x-create-only-properties: - FirewallRuleGroupId @@ -424,42 +841,43 @@ components: - CreatorRequestId - CreationTime - ModificationTime + x-required-properties: + - FirewallRuleGroupId + - VpcId + - Priority + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource x-required-permissions: create: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:AssociateFirewallRuleGroup + - route53resolver:GetFirewallRuleGroupAssociation + - route53resolver:TagResource + - route53resolver:ListTagsForResource + - ec2:DescribeVpcs read: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:GetFirewallRuleGroupAssociation + - route53resolver:ListTagsForResource list: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:ListFirewallRuleGroupAssociations + - route53resolver:ListTagsForResource delete: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:DisassociateFirewallRuleGroup + - route53resolver:GetFirewallRuleGroupAssociation + - route53resolver:UntagResource + - route53resolver:ListTagsForResource update: - - route53resolver:* - - ec2:* - - logs:* - - iam:* - - lambda:* - - s3:* + - route53resolver:UpdateFirewallRuleGroupAssociation + - route53resolver:GetFirewallRuleGroupAssociation + - route53resolver:TagResource + - route53resolver:UntagResource + - route53resolver:ListTagsForResource OutpostResolver: type: object properties: @@ -534,7 +952,9 @@ components: - PreferredInstanceType - Name x-stackql-resource-name: outpost_resolver - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::OutpostResolver. + x-type-name: AWS::Route53Resolver::OutpostResolver + x-stackql-primary-identifier: - Id x-create-only-properties: - OutpostArn @@ -546,12 +966,27 @@ components: - CreationTime - ModificationTime - CreatorRequestId + x-required-properties: + - OutpostArn + - PreferredInstanceType + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource x-required-permissions: create: - route53resolver:CreateOutpostResolver - route53resolver:GetOutpostResolver + - route53resolver:ListOutpostResolvers - route53resolver:ListTagsForResource - outposts:GetOutpost + - route53resolver:TagResource read: - route53resolver:GetOutpostResolver - route53resolver:ListTagsForResource @@ -604,7 +1039,9 @@ components: - ResourceId - AutodefinedReverseFlag x-stackql-resource-name: resolver_config - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::ResolverConfig. + x-type-name: AWS::Route53Resolver::ResolverConfig + x-stackql-primary-identifier: - ResourceId x-create-only-properties: - ResourceId @@ -613,6 +1050,11 @@ components: - OwnerId - Id - AutodefinedReverse + x-required-properties: + - ResourceId + - AutodefinedReverseFlag + x-tagging: + taggable: false x-required-permissions: create: - route53resolver:UpdateResolverConfig @@ -655,7 +1097,9 @@ components: - DISABLING - DISABLED x-stackql-resource-name: resolverdnssec_config - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::ResolverDNSSECConfig. + x-type-name: AWS::Route53Resolver::ResolverDNSSECConfig + x-stackql-primary-identifier: - Id x-create-only-properties: - ResourceId @@ -663,6 +1107,8 @@ components: - OwnerId - Id - ValidationStatus + x-tagging: + taggable: false x-required-permissions: create: - resolverdnssec:CreateConfig @@ -680,6 +1126,161 @@ components: list: - resolverdnssec:ListConfig - route53resolver:ListResolverDnssecConfigs + IpAddressRequest: + type: object + additionalProperties: false + properties: + Ip: + type: string + description: The IPv4 address that you want to use for DNS queries. + Ipv6: + type: string + description: The IPv6 address that you want to use for DNS queries. + SubnetId: + type: string + description: The ID of the subnet that contains the IP address. + required: + - SubnetId + ResolverEndpoint: + type: object + properties: + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver endpoint, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi. + Direction: + type: string + description: |- + Indicates whether the Resolver endpoint allows inbound or outbound DNS queries: + - INBOUND: allows DNS queries to your VPC from your network + - OUTBOUND: allows DNS queries from your VPC to your network + - INBOUND_DELEGATION: allows DNS queries to your VPC from your network with authoritative answers from private hosted zones + HostVPCId: + type: string + description: The ID of the VPC that you want to create the resolver endpoint in. + IpAddressCount: + type: string + description: The number of IP addresses that the resolver endpoint can use for DNS queries. + IpAddresses: + type: array + description: The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpAddressRequest' + Name: + type: string + description: A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. + OutpostArn: + type: string + description: The ARN (Amazon Resource Name) for the Outpost. + PreferredInstanceType: + type: string + description: The Amazon EC2 instance type. + Protocols: + type: array + description: Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only. + uniqueItems: false + x-insertionOrder: false + items: + type: string + ResolverEndpointId: + type: string + description: The ID of the resolver endpoint. + ResolverEndpointType: + type: string + description: The Resolver endpoint IP address type. + enum: + - IPV6 + - IPV4 + - DUALSTACK + SecurityGroupIds: + type: array + description: The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network. + uniqueItems: false + x-insertionOrder: false + items: + type: string + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - Direction + - IpAddresses + - SecurityGroupIds + x-stackql-resource-name: resolver_endpoint + description: Resource type definition for AWS::Route53Resolver::ResolverEndpoint + x-type-name: AWS::Route53Resolver::ResolverEndpoint + x-stackql-primary-identifier: + - ResolverEndpointId + x-create-only-properties: + - Direction + - OutpostArn + - PreferredInstanceType + - SecurityGroupIds + x-read-only-properties: + - Arn + - HostVPCId + - IpAddressCount + - ResolverEndpointId + x-required-properties: + - Direction + - IpAddresses + - SecurityGroupIds + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource + x-required-permissions: + create: + - route53resolver:CreateResolverEndpoint + - route53resolver:GetResolverEndpoint + - route53resolver:ListResolverEndpointIpAddresses + - route53resolver:ListTagsForResource + - route53resolver:TagResource + - route53resolver:UntagResource + - ec2:CreateNetworkInterface + - ec2:DescribeNetworkInterfaces + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + - ec2:DescribeVpcs + read: + - route53resolver:GetResolverEndpoint + - route53resolver:ListResolverEndpointIpAddresses + - route53resolver:ListTagsForResource + update: + - route53resolver:AssociateResolverEndpointIpAddress + - route53resolver:DisassociateResolverEndpointIpAddress + - route53resolver:GetResolverEndpoint + - route53resolver:ListResolverEndpointIpAddresses + - route53resolver:ListTagsForResource + - route53resolver:TagResource + - route53resolver:UntagResource + - route53resolver:UpdateResolverEndpoint + - ec2:AssignIpv6Addresses + - ec2:CreateNetworkInterface + - ec2:DeleteNetworkInterface + - ec2:DescribeNetworkInterfaces + - ec2:DescribeSecurityGroups + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - ec2:ModifyNetworkInterfaceAttribute + - ec2:UnassignIpv6Addresses + delete: + - route53resolver:DeleteResolverEndpoint + - route53resolver:GetResolverEndpoint + - ec2:DeleteNetworkInterface + - ec2:DescribeNetworkInterfaces + list: + - route53resolver:ListResolverEndpoints ResolverQueryLoggingConfig: type: object properties: @@ -737,12 +1338,22 @@ components: type: string minLength: 20 maxLength: 40 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' x-stackql-resource-name: resolver_query_logging_config - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig. + x-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfig + x-stackql-primary-identifier: - Id x-create-only-properties: - Name - DestinationArn + - Tags x-read-only-properties: - OwnerId - Status @@ -752,6 +1363,15 @@ components: - CreatorRequestId - CreationTime - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource x-required-permissions: create: - resolverquerylogging:CreateConfig @@ -767,17 +1387,25 @@ components: - logs:DescribeResourcePolicies - logs:DescribeLogGroups - iam:CreateServiceLinkedRole + - route53resolver:ListTagsForResource + - route53resolver:TagResource + - route53resolver:ListResolverQueryLogConfigs read: - resolverquerylogging:GetConfig - route53resolver:GetResolverQueryLogConfig + - route53resolver:ListTagsForResource + - route53resolver:ListResolverQueryLogConfigs delete: - resolverquerylogging:DeleteConfig - resolverquerylogging:ListConfig - route53resolver:DeleteResolverQueryLogConfig - route53resolver:ListResolverQueryLogConfigs + - route53resolver:UntagResource + - route53resolver:ListTagsForResource list: - resolverquerylogging:ListConfig - route53resolver:ListResolverQueryLogConfigs + - route53resolver:ListTagsForResource ResolverQueryLoggingConfigAssociation: type: object properties: @@ -822,7 +1450,9 @@ components: minLength: 20 maxLength: 40 x-stackql-resource-name: resolver_query_logging_config_association - x-stackql-primaryIdentifier: + description: Resource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation. + x-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation + x-stackql-primary-identifier: - Id x-create-only-properties: - ResolverQueryLogConfigId @@ -833,6 +1463,8 @@ components: - ErrorMessage - CreationTime - Id + x-tagging: + taggable: false x-required-permissions: create: - resolverquerylogging:AssociateConfig @@ -873,6 +1505,11 @@ components: enum: - Do53 - DoH + ServerNameIndication: + type: string + description: The SNI of the target name servers for DoH/DoH-FIPS outbound endpoints + minLength: 0 + maxLength: 255 ResolverRule: type: object properties: @@ -898,6 +1535,12 @@ components: - FORWARD - SYSTEM - RECURSIVE + - DELEGATE + DelegationRecord: + type: string + description: The name server domain for queries to be delegated to if a query matches the delegation record. + minLength: 1 + maxLength: 256 Tags: type: array description: An array of key-value pairs to apply to this resource. @@ -919,16 +1562,30 @@ components: type: string description: The ID of the endpoint that the rule is associated with. required: - - DomainName - RuleType x-stackql-resource-name: resolver_rule - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Route53Resolver::ResolverRule + x-type-name: AWS::Route53Resolver::ResolverRule + x-stackql-primary-identifier: - ResolverRuleId x-create-only-properties: - RuleType + x-conditional-create-only-properties: + - DomainName x-read-only-properties: - Arn - ResolverRuleId + x-required-properties: + - RuleType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - route53resolver:TagResource + - route53resolver:UntagResource x-required-permissions: create: - route53resolver:CreateResolverRule @@ -968,7 +1625,11 @@ components: - VPCId - ResolverRuleId x-stackql-resource-name: resolver_rule_association - x-stackql-primaryIdentifier: + description: >- + In the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a + resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. + x-type-name: AWS::Route53Resolver::ResolverRuleAssociation + x-stackql-primary-identifier: - ResolverRuleAssociationId x-create-only-properties: - Name @@ -976,6 +1637,11 @@ components: - ResolverRuleId x-read-only-properties: - ResolverRuleAssociationId + x-required-properties: + - VPCId + - ResolverRuleId + x-tagging: + taggable: false x-required-permissions: create: - route53resolver:AssociateResolverRule @@ -988,43 +1654,813 @@ components: - route53resolver:GetResolverRuleAssociation list: - route53resolver:ListResolverRuleAssociations - x-stackQL-resources: - firewall_domain_lists: - name: firewall_domain_lists - id: awscc.route53resolver.firewall_domain_lists - x-cfn-schema-name: FirewallDomainList - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' - AND region = 'us-east-1' - firewall_domain_list: - name: firewall_domain_list - id: awscc.route53resolver.firewall_domain_list - x-cfn-schema-name: FirewallDomainList - x-type: get - x-identifiers: - - Id - config: - views: + - ec2:DescribeVpcs + CreateFirewallDomainListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 + Arn: + description: Arn + type: string + minLength: 1 + maxLength: 600 + Name: + description: FirewallDomainListName + type: string + pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+) + minLength: 1 + maxLength: 64 + DomainCount: + description: Count + type: integer + minimum: 0 + Status: + description: ResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED. + type: string + enum: + - COMPLETE + - DELETING + - UPDATING + - COMPLETE_IMPORT_FAILED + - IMPORTING + - INACTIVE_OWNER_ACCOUNT_CLOSED + StatusMessage: + description: FirewallDomainListAssociationStatus + type: string + ManagedOwnerName: + description: ServicePrincipal + type: string + minLength: 1 + maxLength: 512 + CreatorRequestId: + description: The id of the creator request. + type: string + minLength: 1 + maxLength: 255 + CreationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + ModificationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + Domains: + $ref: '#/components/schemas/Domains' + DomainFileUrl: + description: S3 URL to import domains from. + type: string + minLength: 1 + maxLength: 1024 + Tags: + description: Tags + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFirewallDomainListRequest + type: object + required: [] + CreateFirewallRuleGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 + Arn: + description: Arn + type: string + minLength: 1 + maxLength: 600 + Name: + description: FirewallRuleGroupName + type: string + pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+) + minLength: 1 + maxLength: 64 + RuleCount: + description: Count + type: integer + Status: + description: ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED. + type: string + enum: + - COMPLETE + - DELETING + - UPDATING + - INACTIVE_OWNER_ACCOUNT_CLOSED + StatusMessage: + description: FirewallRuleGroupStatus + type: string + OwnerId: + description: AccountId + type: string + minLength: 12 + maxLength: 32 + ShareStatus: + description: ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME. + type: string + enum: + - NOT_SHARED + - SHARED_WITH_ME + - SHARED_BY_ME + CreatorRequestId: + description: The id of the creator request. + type: string + minLength: 1 + maxLength: 255 + CreationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + ModificationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + FirewallRules: + description: FirewallRules + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/FirewallRule' + Tags: + description: Tags + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFirewallRuleGroupRequest + type: object + required: [] + CreateFirewallRuleGroupAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Id + type: string + minLength: 1 + maxLength: 64 + Arn: + description: Arn + type: string + minLength: 1 + maxLength: 600 + FirewallRuleGroupId: + description: FirewallRuleGroupId + type: string + minLength: 1 + maxLength: 64 + VpcId: + description: VpcId + type: string + minLength: 1 + maxLength: 64 + Name: + description: FirewallRuleGroupAssociationName + type: string + pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+) + minLength: 0 + maxLength: 64 + Priority: + description: Priority + type: integer + MutationProtection: + description: MutationProtectionStatus + type: string + enum: + - ENABLED + - DISABLED + ManagedOwnerName: + description: ServicePrincipal + type: string + minLength: 1 + maxLength: 512 + Status: + description: ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED. + type: string + enum: + - COMPLETE + - DELETING + - UPDATING + - INACTIVE_OWNER_ACCOUNT_CLOSED + StatusMessage: + description: FirewallDomainListAssociationStatus + type: string + CreatorRequestId: + description: The id of the creator request. + type: string + minLength: 1 + maxLength: 255 + CreationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + ModificationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + Tags: + description: Tags + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateFirewallRuleGroupAssociationRequest + type: object + required: [] + CreateOutpostResolverRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Id + type: string + minLength: 1 + maxLength: 64 + CreatorRequestId: + description: The id of the creator request. + type: string + minLength: 1 + maxLength: 255 + Name: + description: The OutpostResolver name. + type: string + minLength: 1 + maxLength: 255 + Arn: + description: The OutpostResolver ARN. + type: string + minLength: 1 + maxLength: 1024 + OutpostArn: + description: The Outpost ARN. + type: string + minLength: 1 + maxLength: 1024 + PreferredInstanceType: + description: The OutpostResolver instance type. + type: string + minLength: 1 + maxLength: 255 + Status: + description: The OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION. + type: string + enum: + - CREATING + - OPERATIONAL + - DELETING + - UPDATING + - ACTION_NEEDED + - FAILED_CREATION + - FAILED_DELETION + StatusMessage: + description: The OutpostResolver status message. + type: string + InstanceCount: + description: The number of OutpostResolvers. + type: integer + minimum: 4 + maximum: 256 + CreationTime: + description: The OutpostResolver creation time + type: string + minLength: 20 + maxLength: 40 + ModificationTime: + description: The OutpostResolver last modified time + type: string + minLength: 20 + maxLength: 40 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateOutpostResolverRequest + type: object + required: [] + CreateResolverConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Id + type: string + minLength: 1 + maxLength: 64 + OwnerId: + description: AccountId + type: string + minLength: 12 + maxLength: 32 + ResourceId: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 + AutodefinedReverse: + description: ResolverAutodefinedReverseStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED. + type: string + enum: + - ENABLING + - ENABLED + - DISABLING + - DISABLED + AutodefinedReverseFlag: + description: Represents the desired status of AutodefinedReverse. The only supported value on creation is DISABLE. Deletion of this resource will return AutodefinedReverse to its default value (ENABLED). + type: string + enum: + - DISABLE + x-stackQL-stringOnly: true + x-title: CreateResolverConfigRequest + type: object + required: [] + CreateResolverDNSSECConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Id + type: string + minLength: 1 + maxLength: 64 + OwnerId: + description: AccountId + type: string + minLength: 12 + maxLength: 32 + ResourceId: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 + ValidationStatus: + description: ResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED. + type: string + enum: + - ENABLING + - ENABLED + - DISABLING + - DISABLED + x-stackQL-stringOnly: true + x-title: CreateResolverDNSSECConfigRequest + type: object + required: [] + CreateResolverEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver endpoint, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi. + Direction: + type: string + description: |- + Indicates whether the Resolver endpoint allows inbound or outbound DNS queries: + - INBOUND: allows DNS queries to your VPC from your network + - OUTBOUND: allows DNS queries from your VPC to your network + - INBOUND_DELEGATION: allows DNS queries to your VPC from your network with authoritative answers from private hosted zones + HostVPCId: + type: string + description: The ID of the VPC that you want to create the resolver endpoint in. + IpAddressCount: + type: string + description: The number of IP addresses that the resolver endpoint can use for DNS queries. + IpAddresses: + type: array + description: The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/IpAddressRequest' + Name: + type: string + description: A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. + OutpostArn: + type: string + description: The ARN (Amazon Resource Name) for the Outpost. + PreferredInstanceType: + type: string + description: The Amazon EC2 instance type. + Protocols: + type: array + description: Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only. + uniqueItems: false + x-insertionOrder: false + items: + type: string + ResolverEndpointId: + type: string + description: The ID of the resolver endpoint. + ResolverEndpointType: + type: string + description: The Resolver endpoint IP address type. + enum: + - IPV6 + - IPV4 + - DUALSTACK + SecurityGroupIds: + type: array + description: The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network. + uniqueItems: false + x-insertionOrder: false + items: + type: string + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateResolverEndpointRequest + type: object + required: [] + CreateResolverQueryLoggingConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 + OwnerId: + description: AccountId + type: string + minLength: 12 + maxLength: 32 + Status: + description: ResolverQueryLogConfigStatus, possible values are CREATING, CREATED, DELETED AND FAILED. + type: string + enum: + - CREATING + - CREATED + - DELETING + - FAILED + ShareStatus: + description: ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME. + type: string + enum: + - NOT_SHARED + - SHARED_WITH_ME + - SHARED_BY_ME + AssociationCount: + description: Count + type: integer + Arn: + description: Arn + type: string + minLength: 1 + maxLength: 600 + Name: + description: ResolverQueryLogConfigName + type: string + pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+) + minLength: 1 + maxLength: 64 + CreatorRequestId: + description: The id of the creator request. + type: string + minLength: 1 + maxLength: 255 + DestinationArn: + description: destination arn + type: string + minLength: 1 + maxLength: 600 + CreationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateResolverQueryLoggingConfigRequest + type: object + required: [] + CreateResolverQueryLoggingConfigAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Id + type: string + minLength: 1 + maxLength: 64 + ResolverQueryLogConfigId: + description: ResolverQueryLogConfigId + type: string + minLength: 1 + maxLength: 64 + ResourceId: + description: ResourceId + type: string + minLength: 1 + maxLength: 64 + Status: + description: ResolverQueryLogConfigAssociationStatus + type: string + enum: + - CREATING + - ACTIVE + - ACTION_NEEDED + - DELETING + - FAILED + - OVERRIDDEN + Error: + description: ResolverQueryLogConfigAssociationError + type: string + enum: + - NONE + - DESTINATION_NOT_FOUND + - ACCESS_DENIED + ErrorMessage: + description: ResolverQueryLogConfigAssociationErrorMessage + type: string + CreationTime: + description: Rfc3339TimeString + type: string + minLength: 20 + maxLength: 40 + x-stackQL-stringOnly: true + x-title: CreateResolverQueryLoggingConfigAssociationRequest + type: object + required: [] + CreateResolverRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResolverEndpointId: + type: string + description: The ID of the endpoint that the rule is associated with. + minLength: 1 + maxLength: 64 + DomainName: + type: string + description: DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps + minLength: 1 + maxLength: 256 + Name: + type: string + description: The name for the Resolver rule + minLength: 0 + maxLength: 64 + RuleType: + type: string + description: When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM. + enum: + - FORWARD + - SYSTEM + - RECURSIVE + - DELEGATE + DelegationRecord: + type: string + description: The name server domain for queries to be delegated to if a query matches the delegation record. + minLength: 1 + maxLength: 256 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + TargetIps: + type: array + description: An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/TargetAddress' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver rule. + ResolverRuleId: + type: string + description: The ID of the endpoint that the rule is associated with. + x-stackQL-stringOnly: true + x-title: CreateResolverRuleRequest + type: object + required: [] + CreateResolverRuleAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VPCId: + description: The ID of the VPC that you associated the Resolver rule with. + type: string + ResolverRuleId: + description: The ID of the Resolver rule that you associated with the VPC that is specified by ``VPCId``. + type: string + ResolverRuleAssociationId: + description: '' + type: string + Name: + description: The name of an association between a Resolver rule and a VPC. + type: string + x-stackQL-stringOnly: true + x-title: CreateResolverRuleAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + firewall_domain_lists: + name: firewall_domain_lists + id: awscc.route53resolver.firewall_domain_lists + x-cfn-schema-name: FirewallDomainList + x-cfn-type-name: AWS::Route53Resolver::FirewallDomainList + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FirewallDomainList&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallDomainList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallDomainList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallDomainList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/update_resource' + config: + views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1046,7 +2482,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1067,13 +2503,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' AND data__Identifier = '' AND region = 'us-east-1' - firewall_rule_groups: - name: firewall_rule_groups - id: awscc.route53resolver.firewall_rule_groups - x-cfn-schema-name: FirewallRuleGroup - x-type: list + firewall_domain_lists_list_only: + name: firewall_domain_lists_list_only + id: awscc.route53resolver.firewall_domain_lists_list_only + x-cfn-schema-name: FirewallDomainList + x-cfn-type-name: AWS::Route53Resolver::FirewallDomainList x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1082,7 +2524,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1090,19 +2532,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' AND region = 'us-east-1' - firewall_rule_group: - name: firewall_rule_group - id: awscc.route53resolver.firewall_rule_group + firewall_rule_groups: + name: firewall_rule_groups + id: awscc.route53resolver.firewall_rule_groups x-cfn-schema-name: FirewallRuleGroup - x-type: get + x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FirewallRuleGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallRuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallRuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallRuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1124,7 +2614,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1145,13 +2635,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' AND data__Identifier = '' AND region = 'us-east-1' - firewall_rule_group_associations: - name: firewall_rule_group_associations - id: awscc.route53resolver.firewall_rule_group_associations - x-cfn-schema-name: FirewallRuleGroupAssociation - x-type: list + firewall_rule_groups_list_only: + name: firewall_rule_groups_list_only + id: awscc.route53resolver.firewall_rule_groups_list_only + x-cfn-schema-name: FirewallRuleGroup + x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroup x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1160,7 +2656,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1168,19 +2664,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' AND region = 'us-east-1' - firewall_rule_group_association: - name: firewall_rule_group_association - id: awscc.route53resolver.firewall_rule_group_association + firewall_rule_group_associations: + name: firewall_rule_group_associations + id: awscc.route53resolver.firewall_rule_group_associations x-cfn-schema-name: FirewallRuleGroupAssociation - x-type: get + x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroupAssociation x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FirewallRuleGroupAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallRuleGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallRuleGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::FirewallRuleGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1203,7 +2747,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1225,13 +2769,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' AND data__Identifier = '' AND region = 'us-east-1' - outpost_resolvers: - name: outpost_resolvers - id: awscc.route53resolver.outpost_resolvers - x-cfn-schema-name: OutpostResolver - x-type: list + firewall_rule_group_associations_list_only: + name: firewall_rule_group_associations_list_only + id: awscc.route53resolver.firewall_rule_group_associations_list_only + x-cfn-schema-name: FirewallRuleGroupAssociation + x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroupAssociation x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1240,7 +2790,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1248,19 +2798,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' AND region = 'us-east-1' - outpost_resolver: - name: outpost_resolver - id: awscc.route53resolver.outpost_resolver + outpost_resolvers: + name: outpost_resolvers + id: awscc.route53resolver.outpost_resolvers x-cfn-schema-name: OutpostResolver - x-type: get + x-cfn-type-name: AWS::Route53Resolver::OutpostResolver x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OutpostResolver&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::OutpostResolver" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::OutpostResolver" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::OutpostResolver" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1281,7 +2879,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1301,13 +2899,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' AND data__Identifier = '' AND region = 'us-east-1' - resolver_configs: - name: resolver_configs - id: awscc.route53resolver.resolver_configs - x-cfn-schema-name: ResolverConfig - x-type: list + outpost_resolvers_list_only: + name: outpost_resolvers_list_only + id: awscc.route53resolver.outpost_resolvers_list_only + x-cfn-schema-name: OutpostResolver + x-cfn-type-name: AWS::Route53Resolver::OutpostResolver x-identifiers: - - ResourceId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1315,28 +2919,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResourceId') as resource_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' AND region = 'us-east-1' - resolver_config: - name: resolver_config - id: awscc.route53resolver.resolver_config + resolver_configs: + name: resolver_configs + id: awscc.route53resolver.resolver_configs x-cfn-schema-name: ResolverConfig - x-type: get + x-cfn-type-name: AWS::Route53Resolver::ResolverConfig x-identifiers: - ResourceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_configs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1350,7 +2989,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1363,13 +3002,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' AND data__Identifier = '' AND region = 'us-east-1' - resolverdnssec_configs: - name: resolverdnssec_configs - id: awscc.route53resolver.resolverdnssec_configs - x-cfn-schema-name: ResolverDNSSECConfig - x-type: list + resolver_configs_list_only: + name: resolver_configs_list_only + id: awscc.route53resolver.resolver_configs_list_only + x-cfn-schema-name: ResolverConfig + x-cfn-type-name: AWS::Route53Resolver::ResolverConfig x-identifiers: - - Id + - ResourceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1377,28 +3022,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' + json_extract_path_text(Properties, 'ResourceId') as resource_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' AND region = 'us-east-1' - resolverdnssec_config: - name: resolverdnssec_config - id: awscc.route53resolver.resolverdnssec_config + resolverdnssec_configs: + name: resolverdnssec_configs + id: awscc.route53resolver.resolverdnssec_configs x-cfn-schema-name: ResolverDNSSECConfig - x-type: get + x-cfn-type-name: AWS::Route53Resolver::ResolverDNSSECConfig x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverDNSSECConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverDNSSECConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverDNSSECConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolverdnssec_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolverdnssec_configs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1411,7 +3091,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1423,13 +3103,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' AND data__Identifier = '' AND region = 'us-east-1' - resolver_query_logging_configs: - name: resolver_query_logging_configs - id: awscc.route53resolver.resolver_query_logging_configs - x-cfn-schema-name: ResolverQueryLoggingConfig - x-type: list + resolverdnssec_configs_list_only: + name: resolverdnssec_configs_list_only + id: awscc.route53resolver.resolverdnssec_configs_list_only + x-cfn-schema-name: ResolverDNSSECConfig + x-cfn-type-name: AWS::Route53Resolver::ResolverDNSSECConfig x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1438,7 +3124,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1446,19 +3132,186 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' AND region = 'us-east-1' - resolver_query_logging_config: - name: resolver_query_logging_config - id: awscc.route53resolver.resolver_query_logging_config + resolver_endpoints: + name: resolver_endpoints + id: awscc.route53resolver.resolver_endpoints + x-cfn-schema-name: ResolverEndpoint + x-cfn-type-name: AWS::Route53Resolver::ResolverEndpoint + x-identifiers: + - ResolverEndpointId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverEndpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverEndpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resolver_endpoints/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Direction') as direction, + JSON_EXTRACT(Properties, '$.HostVPCId') as host_vpc_id, + JSON_EXTRACT(Properties, '$.IpAddressCount') as ip_address_count, + JSON_EXTRACT(Properties, '$.IpAddresses') as ip_addresses, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OutpostArn') as outpost_arn, + JSON_EXTRACT(Properties, '$.PreferredInstanceType') as preferred_instance_type, + JSON_EXTRACT(Properties, '$.Protocols') as protocols, + JSON_EXTRACT(Properties, '$.ResolverEndpointId') as resolver_endpoint_id, + JSON_EXTRACT(Properties, '$.ResolverEndpointType') as resolver_endpoint_type, + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Direction') as direction, + json_extract_path_text(Properties, 'HostVPCId') as host_vpc_id, + json_extract_path_text(Properties, 'IpAddressCount') as ip_address_count, + json_extract_path_text(Properties, 'IpAddresses') as ip_addresses, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'PreferredInstanceType') as preferred_instance_type, + json_extract_path_text(Properties, 'Protocols') as protocols, + json_extract_path_text(Properties, 'ResolverEndpointId') as resolver_endpoint_id, + json_extract_path_text(Properties, 'ResolverEndpointType') as resolver_endpoint_type, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + resolver_endpoints_list_only: + name: resolver_endpoints_list_only + id: awscc.route53resolver.resolver_endpoints_list_only + x-cfn-schema-name: ResolverEndpoint + x-cfn-type-name: AWS::Route53Resolver::ResolverEndpoint + x-identifiers: + - ResolverEndpointId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ResolverEndpointId') as resolver_endpoint_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverEndpoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResolverEndpointId') as resolver_endpoint_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverEndpoint' + AND region = 'us-east-1' + resolver_query_logging_configs: + name: resolver_query_logging_configs + id: awscc.route53resolver.resolver_query_logging_configs x-cfn-schema-name: ResolverQueryLoggingConfig - x-type: get + x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfig x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverQueryLoggingConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverQueryLoggingConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverQueryLoggingConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_query_logging_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_query_logging_configs/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1472,12 +3325,13 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.CreatorRequestId') as creator_request_id, JSON_EXTRACT(Properties, '$.DestinationArn') as destination_arn, - JSON_EXTRACT(Properties, '$.CreationTime') as creation_time + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1491,17 +3345,24 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, json_extract_path_text(Properties, 'DestinationArn') as destination_arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' AND data__Identifier = '' AND region = 'us-east-1' - resolver_query_logging_config_associations: - name: resolver_query_logging_config_associations - id: awscc.route53resolver.resolver_query_logging_config_associations - x-cfn-schema-name: ResolverQueryLoggingConfigAssociation - x-type: list + resolver_query_logging_configs_list_only: + name: resolver_query_logging_configs_list_only + id: awscc.route53resolver.resolver_query_logging_configs_list_only + x-cfn-schema-name: ResolverQueryLoggingConfig + x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfig x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1510,7 +3371,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1518,19 +3379,54 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' AND region = 'us-east-1' - resolver_query_logging_config_association: - name: resolver_query_logging_config_association - id: awscc.route53resolver.resolver_query_logging_config_association + resolver_query_logging_config_associations: + name: resolver_query_logging_config_associations + id: awscc.route53resolver.resolver_query_logging_config_associations x-cfn-schema-name: ResolverQueryLoggingConfigAssociation - x-type: get + x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverQueryLoggingConfigAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_query_logging_config_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_query_logging_config_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1546,7 +3442,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1561,13 +3457,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' AND data__Identifier = '' AND region = 'us-east-1' - resolver_rules: - name: resolver_rules - id: awscc.route53resolver.resolver_rules - x-cfn-schema-name: ResolverRule - x-type: list + resolver_query_logging_config_associations_list_only: + name: resolver_query_logging_config_associations_list_only + id: awscc.route53resolver.resolver_query_logging_config_associations_list_only + x-cfn-schema-name: ResolverQueryLoggingConfigAssociation + x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation x-identifiers: - - ResolverRuleId + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1575,28 +3477,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResolverRuleId') as resolver_rule_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' AND region = 'us-east-1' - resolver_rule: - name: resolver_rule - id: awscc.route53resolver.resolver_rule + resolver_rules: + name: resolver_rules + id: awscc.route53resolver.resolver_rules x-cfn-schema-name: ResolverRule - x-type: get + x-cfn-type-name: AWS::Route53Resolver::ResolverRule x-identifiers: - ResolverRuleId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1605,6 +3555,7 @@ components: JSON_EXTRACT(Properties, '$.DomainName') as domain_name, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.RuleType') as rule_type, + JSON_EXTRACT(Properties, '$.DelegationRecord') as delegation_record, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.TargetIps') as target_ips, JSON_EXTRACT(Properties, '$.Arn') as arn, @@ -1613,7 +3564,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1622,6 +3573,7 @@ components: json_extract_path_text(Properties, 'DomainName') as domain_name, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'RuleType') as rule_type, + json_extract_path_text(Properties, 'DelegationRecord') as delegation_record, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'TargetIps') as target_ips, json_extract_path_text(Properties, 'Arn') as arn, @@ -1629,13 +3581,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' AND data__Identifier = '' AND region = 'us-east-1' - resolver_rule_associations: - name: resolver_rule_associations - id: awscc.route53resolver.resolver_rule_associations - x-cfn-schema-name: ResolverRuleAssociation - x-type: list + resolver_rules_list_only: + name: resolver_rules_list_only + id: awscc.route53resolver.resolver_rules_list_only + x-cfn-schema-name: ResolverRule + x-cfn-type-name: AWS::Route53Resolver::ResolverRule x-identifiers: - - ResolverRuleAssociationId + - ResolverRuleId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1643,28 +3601,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResolverRuleAssociationId') as resolver_rule_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' + JSON_EXTRACT(Properties, '$.ResolverRuleId') as resolver_rule_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResolverRuleAssociationId') as resolver_rule_association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' + json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' AND region = 'us-east-1' - resolver_rule_association: - name: resolver_rule_association - id: awscc.route53resolver.resolver_rule_association + resolver_rule_associations: + name: resolver_rule_associations + id: awscc.route53resolver.resolver_rule_associations x-cfn-schema-name: ResolverRuleAssociation - x-type: get + x-cfn-type-name: AWS::Route53Resolver::ResolverRuleAssociation x-identifiers: - ResolverRuleAssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResolverRuleAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverRuleAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Resolver::ResolverRuleAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_rule_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_rule_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1677,7 +3670,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1689,3 +3682,649 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' AND data__Identifier = '' AND region = 'us-east-1' + resolver_rule_associations_list_only: + name: resolver_rule_associations_list_only + id: awscc.route53resolver.resolver_rule_associations_list_only + x-cfn-schema-name: ResolverRuleAssociation + x-cfn-type-name: AWS::Route53Resolver::ResolverRuleAssociation + x-identifiers: + - ResolverRuleAssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ResolverRuleAssociationId') as resolver_rule_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResolverRuleAssociationId') as resolver_rule_association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FirewallDomainList&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFirewallDomainList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFirewallDomainListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FirewallRuleGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFirewallRuleGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFirewallRuleGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FirewallRuleGroupAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFirewallRuleGroupAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFirewallRuleGroupAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OutpostResolver&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOutpostResolver + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOutpostResolverRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverDNSSECConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverDNSSECConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverDNSSECConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverEndpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverQueryLoggingConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverQueryLoggingConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverQueryLoggingConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverQueryLoggingConfigAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverQueryLoggingConfigAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverQueryLoggingConfigAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResolverRuleAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResolverRuleAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResolverRuleAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/rum.yaml b/providers/src/awscc/v00.00.00000/services/rum.yaml index c0e6e708..917e72a4 100644 --- a/providers/src/awscc/v00.00.00000/services/rum.yaml +++ b/providers/src/awscc/v00.00.00000/services/rum.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: RUM - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AppMonitorConfiguration: description: AppMonitor configuration @@ -247,6 +627,24 @@ components: maxLength: 4000 required: - Name + ResourcePolicy: + description: A structure that defines resource policy attached to your app monitor. + additionalProperties: false + type: object + properties: + PolicyDocument: + type: string + description: 'The JSON to use as the resource policy. The document can be up to 4 KB in size. ' + PolicyRevisionId: + type: string + description: |- + A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy. + + When you assign a policy revision ID, then later requests about that policy will be rejected with an InvalidPolicyRevisionIdException error if they don't provide the correct current revision ID. + minLength: 1 + maxLength: 255 + required: + - PolicyDocument CustomEventsStatus: type: string enum: @@ -260,6 +658,28 @@ components: Status: description: Indicates whether AppMonitor accepts custom events. $ref: '#/components/schemas/CustomEventsStatus' + DeobfuscationConfiguration: + description: A structure that contains the configuration for how an app monitor can deobfuscate stack traces. + additionalProperties: false + type: object + properties: + JavaScriptSourceMaps: + description: A structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps. + additionalProperties: false + type: object + properties: + Status: + description: Specifies whether JavaScript error stack traces should be unminified for this app monitor. The default is for JavaScript error stack trace unminification to be DISABLED + type: string + enum: + - ENABLED + - DISABLED + S3Uri: + description: The S3Uri of the bucket or folder that stores the source map files. It is required if status is ENABLED. + type: string + pattern: ^s3://[a-z0-9][-.a-z0-9]{1,62}(?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$ + required: + - Status AppMonitor: type: object properties: @@ -276,11 +696,21 @@ components: minLength: 1 maxLength: 255 Domain: - description: The top-level internet domain name for which your application has administrative authority. + description: The top-level internet domain name for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list. type: string pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1})) minLength: 1 maxLength: 253 + DomainList: + description: The top-level internet domain names for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list. + type: array + minItems: 1 + maxItems: 5 + items: + type: string + pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1})) + minLength: 1 + maxLength: 253 CwLogEnabled: description: Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false type: boolean @@ -290,18 +720,38 @@ components: $ref: '#/components/schemas/AppMonitorConfiguration' CustomEvents: $ref: '#/components/schemas/CustomEvents' + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + DeobfuscationConfiguration: + $ref: '#/components/schemas/DeobfuscationConfiguration' required: - Name - - Domain x-stackql-resource-name: app_monitor - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::RUM::AppMonitor + x-type-name: AWS::RUM::AppMonitor + x-stackql-primary-identifier: - Name + x-stackql-additional-identifiers: + - - Id x-create-only-properties: - Name x-read-only-properties: - Id + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - rum:UntagResource + - rum:TagResource + - rum:ListTagsForResource x-required-permissions: create: + - rum:GetAppMonitor - rum:CreateAppMonitor - dynamodb:GetItem - dynamodb:PutItem @@ -318,11 +768,17 @@ components: - logs:DescribeLogGroups - logs:PutRetentionPolicy - rum:TagResource + - rum:ListTagsForResource - cognito-identity:DescribeIdentityPool - iam:GetRole - iam:CreateServiceLinkedRole + - iam:PassRole - rum:PutRumMetricsDestination - rum:BatchCreateRumMetricDefinitions + - rum:ListRumMetricsDestinations + - rum:BatchGetRumMetricDefinitions + - rum:GetResourcePolicy + - rum:PutResourcePolicy read: - rum:GetAppMonitor - dynamodb:GetItem @@ -332,7 +788,9 @@ components: - rum:ListTagsForResource - rum:ListRumMetricsDestinations - rum:BatchGetRumMetricDefinitions + - rum:GetResourcePolicy update: + - rum:GetAppMonitor - rum:UpdateAppMonitor - dynamodb:GetItem - dynamodb:PutItem @@ -355,6 +813,7 @@ components: - rum:ListTagsForResource - iam:GetRole - iam:CreateServiceLinkedRole + - iam:PassRole - rum:PutRumMetricsDestination - rum:DeleteRumMetricsDestination - rum:ListRumMetricsDestinations @@ -362,7 +821,11 @@ components: - rum:BatchDeleteRumMetricDefinitions - rum:BatchGetRumMetricDefinitions - rum:UpdateRumMetricDefinition + - rum:GetResourcePolicy + - rum:PutResourcePolicy + - rum:DeleteResourcePolicy delete: + - rum:GetAppMonitor - rum:DeleteAppMonitor - dynamodb:DeleteItem - dynamodb:Query @@ -370,8 +833,14 @@ components: - s3:DeleteObject - s3:DoesObjectExist - rum:UntagResource + - rum:ListTagsForResource - rum:DeleteRumMetricsDestination - rum:BatchDeleteRumMetricDefinitions + - rum:ListRumMetricsDestinations + - rum:BatchGetRumMetricDefinitions + - rum:GetResourcePolicy + - rum:PutResourcePolicy + - rum:DeleteResourcePolicy list: - rum:ListAppMonitors - dynamodb:DescribeTable @@ -384,43 +853,131 @@ components: - s3:GetObjectAcl - logs:DescribeLogGroups - rum:ListTagsForResource + CreateAppMonitorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The unique ID of the new app monitor. + type: string + pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ + minLength: 36 + maxLength: 36 + Name: + description: A name for the app monitor + type: string + pattern: '[\.\-_/#A-Za-z0-9]+' + minLength: 1 + maxLength: 255 + Domain: + description: The top-level internet domain name for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list. + type: string + pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1})) + minLength: 1 + maxLength: 253 + DomainList: + description: The top-level internet domain names for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list. + type: array + minItems: 1 + maxItems: 5 + items: + type: string + pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1})) + minLength: 1 + maxLength: 253 + CwLogEnabled: + description: Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false + type: boolean + Tags: + $ref: '#/components/schemas/TagDef' + AppMonitorConfiguration: + $ref: '#/components/schemas/AppMonitorConfiguration' + CustomEvents: + $ref: '#/components/schemas/CustomEvents' + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + DeobfuscationConfiguration: + $ref: '#/components/schemas/DeobfuscationConfiguration' + x-stackQL-stringOnly: true + x-title: CreateAppMonitorRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: app_monitors: name: app_monitors id: awscc.rum.app_monitors x-cfn-schema-name: AppMonitor - x-type: list + x-cfn-type-name: AWS::RUM::AppMonitor x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AppMonitor&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RUM::AppMonitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RUM::AppMonitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RUM::AppMonitor" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_monitors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/app_monitors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' - AND region = 'us-east-1' - app_monitor: - name: app_monitor - id: awscc.rum.app_monitor - x-cfn-schema-name: AppMonitor - x-type: get - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -428,15 +985,18 @@ components: JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.DomainList') as domain_list, JSON_EXTRACT(Properties, '$.CwLogEnabled') as cw_log_enabled, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.AppMonitorConfiguration') as app_monitor_configuration, - JSON_EXTRACT(Properties, '$.CustomEvents') as custom_events + JSON_EXTRACT(Properties, '$.CustomEvents') as custom_events, + JSON_EXTRACT(Properties, '$.ResourcePolicy') as resource_policy, + JSON_EXTRACT(Properties, '$.DeobfuscationConfiguration') as deobfuscation_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RUM::AppMonitor' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -444,10 +1004,239 @@ components: json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'DomainList') as domain_list, json_extract_path_text(Properties, 'CwLogEnabled') as cw_log_enabled, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'AppMonitorConfiguration') as app_monitor_configuration, - json_extract_path_text(Properties, 'CustomEvents') as custom_events + json_extract_path_text(Properties, 'CustomEvents') as custom_events, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, + json_extract_path_text(Properties, 'DeobfuscationConfiguration') as deobfuscation_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::RUM::AppMonitor' AND data__Identifier = '' AND region = 'us-east-1' + app_monitors_list_only: + name: app_monitors_list_only + id: awscc.rum.app_monitors_list_only + x-cfn-schema-name: AppMonitor + x-cfn-type-name: AWS::RUM::AppMonitor + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AppMonitor&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAppMonitor + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppMonitorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/s3.yaml b/providers/src/awscc/v00.00.00000/services/s3.yaml index 1f6e022f..fbedce33 100644 --- a/providers/src/awscc/v00.00.00000/services/s3.yaml +++ b/providers/src/awscc/v00.00.00000/services/s3.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: S3 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Grantee: type: object @@ -102,27 +482,47 @@ components: - Permission - AccessGrantsLocationId x-stackql-resource-name: access_grant - x-stackql-primaryIdentifier: + description: The AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance. + x-type-name: AWS::S3::AccessGrant + x-stackql-primary-identifier: - AccessGrantId x-create-only-properties: - S3PrefixType - Tags + x-write-only-properties: + - S3PrefixType x-read-only-properties: - AccessGrantId - AccessGrantArn - GrantScope + x-required-properties: + - Grantee + - Permission + - AccessGrantsLocationId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - s3:UntagResource + - s3:TagResource + - s3:ListTagsForResource x-required-permissions: create: - s3:CreateAccessGrant - s3:TagResource read: - s3:GetAccessGrant + - s3:ListTagsForResource delete: - s3:DeleteAccessGrant list: - s3:ListAccessGrants update: - s3:TagResource + - s3:UntagResource AccessGrantsInstanceArn: description: The Amazon Resource Name (ARN) of the specified Access Grants instance. type: string @@ -153,23 +553,41 @@ components: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: access_grants_instance - x-stackql-primaryIdentifier: + description: The AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations + x-type-name: AWS::S3::AccessGrantsInstance + x-stackql-primary-identifier: - AccessGrantsInstanceArn x-create-only-properties: - Tags x-read-only-properties: - AccessGrantsInstanceArn - AccessGrantsInstanceId + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - s3:UntagResource + - s3:TagResource + - s3:ListTagsForResource x-required-permissions: create: - s3:CreateAccessGrantsInstance + - s3:AssociateAccessGrantsIdentityCenter - s3:TagResource read: - s3:GetAccessGrantsInstance + - s3:ListTagsForResource delete: + - s3:GetAccessGrantsInstance - s3:DeleteAccessGrantsInstance + - s3:DissociateAccessGrantsIdentityCenter update: - s3:TagResource + - s3:UntagResource list: - s3:ListAccessGrantsInstances AccessGrantsLocation: @@ -201,13 +619,26 @@ components: $ref: '#/components/schemas/Tag' required: [] x-stackql-resource-name: access_grants_location - x-stackql-primaryIdentifier: + description: The AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants. + x-type-name: AWS::S3::AccessGrantsLocation + x-stackql-primary-identifier: - AccessGrantsLocationId x-create-only-properties: - Tags x-read-only-properties: - AccessGrantsLocationArn - AccessGrantsLocationId + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - s3:UntagResource + - s3:TagResource + - s3:ListTagsForResource x-required-permissions: create: - s3:CreateAccessGrantsLocation @@ -215,6 +646,7 @@ components: - s3:TagResource read: - s3:GetAccessGrantsLocation + - s3:ListTagsForResource delete: - s3:DeleteAccessGrantsLocation list: @@ -222,6 +654,7 @@ components: update: - s3:UpdateAccessGrantsLocation - s3:TagResource + - s3:UntagResource - iam:PassRole VpcConfiguration: description: The Virtual Private Cloud (VPC) configuration for a bucket access point. @@ -233,28 +666,28 @@ components: minLength: 1 maxLength: 1024 PublicAccessBlockConfiguration: + additionalProperties: false type: object properties: - BlockPublicAcls: + RestrictPublicBuckets: + description: |- + Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. + Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. + type: boolean + BlockPublicPolicy: + description: Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. type: boolean + BlockPublicAcls: description: |- Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior: - PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. - PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. - IgnorePublicAcls: type: boolean + IgnorePublicAcls: description: Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. - BlockPublicPolicy: type: boolean - description: Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. - RestrictPublicBuckets: - type: boolean - description: |- - Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. - Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. - additionalProperties: false Arn: description: The Amazon Resource Name (ARN) of the specified resource. type: string @@ -303,10 +736,18 @@ components: description: The Amazon Resource Name (ARN) of the specified accesspoint. x-examples: - arn:aws:s3:us-west-2:123456789012:accesspoint/test + Tags: + description: An arbitrary set of tags (key-value pairs) for this S3 Access Point. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array required: - Bucket x-stackql-resource-name: access_point - x-stackql-primaryIdentifier: + description: The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. + x-type-name: AWS::S3::AccessPoint + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -317,27 +758,44 @@ components: - Alias - NetworkOrigin - Arn + x-required-properties: + - Bucket + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - s3:TagResource + - s3:UntagResource + - s3:ListTagsForResource x-required-permissions: create: - s3:CreateAccessPoint - s3:PutAccessPointPolicy + - s3:GetAccessPoint - s3:PutAccessPointPublicAccessBlock + - s3:TagResource read: - s3:GetAccessPoint - s3:GetAccessPointPolicy + - s3:ListTagsForResource update: - s3:PutAccessPointPolicy - s3:PutAccessPointPublicAccessBlock - s3:DeleteAccessPointPolicy - s3:GetAccessPoint - s3:GetAccessPointPolicy + - s3:TagResource + - s3:UntagResource delete: - s3:DeleteAccessPointPolicy - s3:DeleteAccessPoint list: - s3:ListAccessPoints TagFilter: - description: Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. + description: Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. For more information, see [Categorizing your storage using tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) in the *Amazon Simple Storage Service User Guide*. type: object additionalProperties: false properties: @@ -427,8 +885,8 @@ components: description: Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. DataExport: description: Specifies how Amazon S3 Storage Lens metrics should be exported. - type: object additionalProperties: false + type: object properties: S3BucketDestination: $ref: '#/components/schemas/S3BucketDestination' @@ -449,7 +907,10 @@ components: required: - ServerSideEncryptionConfiguration ServerSideEncryptionRule: - description: Specifies the default server-side encryption configuration. + description: |- + Specifies the default server-side encryption configuration. + + *General purpose buckets* - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. + + *Directory buckets* - When you specify an [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. type: object additionalProperties: false properties: @@ -462,22 +923,29 @@ components: $ref: '#/components/schemas/ServerSideEncryptionByDefault' description: Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. ServerSideEncryptionByDefault: - description: >- - Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket - encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*. + description: |- + Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html). + + *General purpose buckets* - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key (``aws/s3``) in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. + + *Directory buckets* - Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket's lifetime. The [managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (``aws/s3``) isn't supported. + + *Directory buckets* - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. type: object properties: KMSMasterKeyID: description: |- - AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. - You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. - + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` - + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` - + Key Alias: ``alias/alias-name`` + AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. + + *General purpose buckets* - This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. + + *Directory buckets* - This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms``. + + You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key Alias: ``alias/alias-name`` + + If you are using encryption with cross-account or AWS service operations, you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). + + *General purpose buckets* - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. + + *Directory buckets* - When you specify an [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. - If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. - If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). - Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*. + Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*. type: string SSEAlgorithm: type: string @@ -485,7 +953,9 @@ components: - aws:kms - AES256 - aws:kms:dsse - description: Server-side encryption algorithm to use for the default encryption. + description: |- + Server-side encryption algorithm to use for the default encryption. + For directory buckets, there are only two supported values for server-side encryption: ``AES256`` and ``aws:kms``. additionalProperties: false required: - SSEAlgorithm @@ -681,6 +1151,18 @@ components: x-insertionOrder: true items: $ref: '#/components/schemas/Rule' + TransitionDefaultMinimumObjectSize: + description: |- + Indicates which default minimum object size behavior is applied to the lifecycle configuration. + This parameter applies to general purpose buckets only. It isn't supported for directory bucket lifecycle configurations. + + ``all_storage_classes_128K`` - Objects smaller than 128 KB will not transition to any storage class by default. + + ``varies_by_storage_class`` - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB. + + To customize the minimum object size for any transition you can add a filter that specifies a custom ``ObjectSizeGreaterThan`` or ``ObjectSizeLessThan`` in the body of your transition rule. Custom filters always take precedence over the default transition behavior. + type: string + enum: + - varies_by_storage_class + - all_storage_classes_128K required: - Rules description: Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. @@ -839,7 +1321,9 @@ components: description: Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. TransitionInDays: type: integer - description: Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer. + description: >- + Indicates the number of days after creation when objects are transitioned to the specified storage class. If the specified storage class is ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE``, valid values are ``0`` or positive integers. If the specified storage class is ``STANDARD_IA`` or ``ONEZONE_IA``, valid values are positive integers greater than ``30``. Be aware that some storage classes have a minimum storage duration and that you're charged for + transitioning objects before their minimum storage duration. For more information, see [Constraints and considerations for transitions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-transition-general-considerations.html#lifecycle-configuration-constraints) in the *Amazon S3 User Guide*. additionalProperties: false description: Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*. required: @@ -887,7 +1371,10 @@ components: properties: PartitionDateSource: type: string - description: Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime. + description: |- + Specifies the partition date source for the partitioned prefix. ``PartitionDateSource`` can be ``EventTime`` or ``DeliveryTime``. + For ``DeliveryTime``, the time in the log file names corresponds to the delivery time for the log files. + For ``EventTime``, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key. enum: - EventTime - DeliveryTime @@ -1035,7 +1522,7 @@ components: Rules: type: array uniqueItems: true - x-insertionOrder: true + x-insertionOrder: false items: $ref: '#/components/schemas/FilterRule' description: A list of containers for the key-value pair that defines the criteria for the filter rule. @@ -1085,7 +1572,7 @@ components: DefaultRetention: type: object description: |- - The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. additionalProperties: false @@ -1160,7 +1647,7 @@ components: DeleteMarkerReplication: $ref: '#/components/schemas/DeleteMarkerReplication' description: >- - Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule + Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication````Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). @@ -1210,7 +1697,7 @@ components: - Enabled description: Indicates whether to replicate delete markers. Disabled by default. description: >- - Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule + Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication````Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). @@ -1268,7 +1755,9 @@ components: - Owner EncryptionConfiguration: type: object - description: Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. + description: |- + Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. + If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. additionalProperties: false properties: ReplicaKmsKeyID: @@ -1401,7 +1890,9 @@ components: required: - Status VersioningConfiguration: - description: Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*. + description: |- + Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*. + When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket. type: object additionalProperties: false properties: @@ -1483,7 +1974,7 @@ components: properties: KeyPrefixEquals: description: |- - The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. + The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``docs/``, which identifies all objects in the docs/ folder. Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied. type: string HttpErrorCodeReturnedEquals: @@ -1507,6 +1998,143 @@ components: - https required: - HostName + MetadataTableConfiguration: + type: object + additionalProperties: false + properties: + S3TablesDestination: + $ref: '#/components/schemas/S3TablesDestination' + description: The destination information for the metadata table configuration. The destination table bucket must be in the same Region and AWS-account as the general purpose bucket. The specified metadata table name must be unique within the ``aws_s3_metadata`` namespace in the destination table bucket. + required: + - S3TablesDestination + description: The metadata table configuration of an S3 general purpose bucket. For more information, see [Accelerating data discovery with S3 Metadata](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html) and [Setting up permissions for configuring metadata tables](https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html). + S3TablesDestination: + type: object + additionalProperties: false + properties: + TableBucketArn: + type: string + description: The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS-account as the general purpose bucket. + TableName: + type: string + description: The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the ``aws_s3_metadata`` namespace in the destination table bucket. + TableNamespace: + type: string + description: The table bucket namespace for the metadata table in your metadata table configuration. This value is always ``aws_s3_metadata``. + TableArn: + type: string + description: The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the ``aws_s3_metadata`` namespace in the destination table bucket. + required: + - TableBucketArn + - TableName + description: The destination information for the metadata table configuration. The destination table bucket must be in the same Region and AWS-account as the general purpose bucket. The specified metadata table name must be unique within the ``aws_s3_metadata`` namespace in the destination table bucket. + RecordExpiration: + type: object + additionalProperties: false + properties: + Expiration: + type: string + enum: + - ENABLED + - DISABLED + description: Specifies whether record expiration is enabled or disabled. + Days: + type: integer + description: The number of days after which records expire. Required if Expiration is ENABLED. + required: + - Expiration + description: '' + MetadataTableEncryptionConfiguration: + type: object + additionalProperties: false + properties: + SseAlgorithm: + type: string + enum: + - aws:kms + - AES256 + description: Specifies the server-side encryption algorithm to use for encrypting tables. + KmsKeyArn: + type: string + description: The ARN of the KMS key. Required if SseAlgorithm is aws:kms. + required: + - SseAlgorithm + description: '' + MetadataDestination: + type: object + additionalProperties: false + properties: + TableBucketType: + type: string + enum: + - aws + - customer + description: The type of the table bucket. + TableBucketArn: + type: string + description: The ARN of the table bucket. + TableNamespace: + type: string + description: The namespace of the table. + required: + - TableBucketType + description: '' + JournalTableConfiguration: + type: object + additionalProperties: false + properties: + TableName: + type: string + description: The name of the journal table. + TableArn: + type: string + description: The ARN of the journal table. + RecordExpiration: + $ref: '#/components/schemas/RecordExpiration' + EncryptionConfiguration: + $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' + description: The encryption configuration for the journal table. + required: + - RecordExpiration + description: '' + InventoryTableConfiguration: + type: object + additionalProperties: false + properties: + TableName: + type: string + description: The name of the inventory table. + TableArn: + type: string + description: The ARN of the inventory table. + ConfigurationState: + type: string + enum: + - ENABLED + - DISABLED + description: Specifies whether inventory table configuration is enabled or disabled. + EncryptionConfiguration: + $ref: '#/components/schemas/MetadataTableEncryptionConfiguration' + description: The encryption configuration for the inventory table. + required: + - ConfigurationState + description: '' + MetadataConfiguration: + type: object + additionalProperties: false + description: '' + properties: + Destination: + $ref: '#/components/schemas/MetadataDestination' + description: The destination information for the metadata configuration. + JournalTableConfiguration: + $ref: '#/components/schemas/JournalTableConfiguration' + description: The configuration for the journal table. + InventoryTableConfiguration: + $ref: '#/components/schemas/InventoryTableConfiguration' + description: The configuration for the inventory table. + required: + - JournalTableConfiguration Bucket: type: object properties: @@ -1542,11 +2170,8 @@ components: BucketName: description: >- A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 - buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. + buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) in the *Amazon S3 User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$ type: string CorsConfiguration: $ref: '#/components/schemas/CorsConfiguration' @@ -1578,13 +2203,19 @@ components: type: array uniqueItems: true x-insertionOrder: true + MetadataTableConfiguration: + $ref: '#/components/schemas/MetadataTableConfiguration' + description: The metadata table configuration of an S3 general purpose bucket. + MetadataConfiguration: + $ref: '#/components/schemas/MetadataConfiguration' + description: '' NotificationConfiguration: $ref: '#/components/schemas/NotificationConfiguration' description: Configuration that defines how Amazon S3 handles bucket notifications. ObjectLockConfiguration: $ref: '#/components/schemas/ObjectLockConfiguration' description: |- - This operation is not supported by directory buckets. + This operation is not supported for directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. @@ -1611,49 +2242,84 @@ components: type: array VersioningConfiguration: $ref: '#/components/schemas/VersioningConfiguration' - description: Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. + description: |- + Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. + When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket. WebsiteConfiguration: $ref: '#/components/schemas/WebsiteConfiguration' description: Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). Arn: $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the specified bucket. + description: '' x-examples: - arn:aws:s3:::mybucket DomainName: - description: The IPv4 DNS name of the specified bucket. + description: '' x-examples: - mystack-mybucket-kdwwxmddtr2g.s3.amazonaws.com type: string DualStackDomainName: - description: The IPv6 DNS name of the specified bucket. For more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html). + description: '' x-examples: - mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com type: string RegionalDomainName: - description: Returns the regional domain name of the specified bucket. + description: '' x-examples: - mystack-mybucket-kdwwxmddtr2g.s3.us-east-2.amazonaws.com type: string WebsiteURL: - description: The Amazon S3 website endpoint for the specified bucket. + description: '' x-examples: - 'Example (IPv4): http://mystack-mybucket-kdwwxmddtr2g.s3-website-us-east-2.amazonaws.com/' - 'Example (IPv6): http://mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com/' format: uri type: string x-stackql-resource-name: bucket - x-stackql-primaryIdentifier: + description: |- + The ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. + To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html). + You can only delete empty buckets. Deletion fails for buckets that have contents. + x-type-name: AWS::S3::Bucket + x-stackql-primary-identifier: - BucketName x-create-only-properties: - BucketName - - ObjectLockEnabled + - MetadataConfiguration/JournalTableConfiguration/EncryptionConfiguration + x-write-only-properties: + - AccessControl + - MetadataConfiguration/JournalTableConfiguration/EncryptionConfiguration + - MetadataConfiguration/InventoryTableConfiguration/EncryptionConfiguration + - LifecycleConfiguration/Rules/*/NoncurrentVersionExpirationInDays + - LifecycleConfiguration/Rules/*/NoncurrentVersionTransition + - LifecycleConfiguration/Rules/*/Transition + - ReplicationConfiguration/Rules/*/Prefix + - LifecycleConfiguration/Rules/*/ExpiredObjectDeleteMarker x-read-only-properties: - Arn - DomainName - DualStackDomainName - RegionalDomainName + - MetadataTableConfiguration/S3TablesDestination/TableNamespace + - MetadataTableConfiguration/S3TablesDestination/TableArn + - MetadataConfiguration/Destination + - MetadataConfiguration/JournalTableConfiguration/TableName + - MetadataConfiguration/JournalTableConfiguration/TableArn + - MetadataConfiguration/InventoryTableConfiguration/TableName + - MetadataConfiguration/InventoryTableConfiguration/TableArn - WebsiteURL + x-required-properties: + - BucketName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - s3:PutBucketTagging + - s3:GetBucketTagging + - s3:DeleteBucketTagging x-required-permissions: create: - s3:CreateBucket @@ -1681,6 +2347,16 @@ components: - s3:PutObjectLockConfiguration - s3:PutBucketOwnershipControls - s3:PutIntelligentTieringConfiguration + - s3:GetBucketMetadataTableConfiguration + - s3:CreateBucketMetadataTableConfiguration + - s3tables:CreateNamespace + - s3tables:CreateTable + - s3tables:CreateTableBucket + - s3tables:GetTable + - s3tables:PutTableEncryption + - s3tables:PutTablePolicy + - s3tables:GetTableMetadataLocation + - s3tables:UpdateTableMetadataLocation read: - s3:GetAccelerateConfiguration - s3:GetLifecycleConfiguration @@ -1700,6 +2376,7 @@ components: - s3:GetBucketTagging - s3:GetBucketOwnershipControls - s3:GetIntelligentTieringConfiguration + - s3:GetBucketMetadataTableConfiguration - s3:ListBucket update: - s3:PutBucketAcl @@ -1714,6 +2391,19 @@ components: - s3:PutBucketReplication - s3:PutBucketWebsite - s3:PutAccelerateConfiguration + - s3:GetBucketMetadataTableConfiguration + - s3:DeleteBucketMetadataTableConfiguration + - s3:CreateBucketMetadataTableConfiguration + - s3:UpdateBucketMetadataJournalTableConfiguration + - s3:UpdateBucketMetadataInventoryTableConfiguration + - s3tables:CreateNamespace + - s3tables:CreateTable + - s3tables:CreateTableBucket + - s3tables:GetTable + - s3tables:PutTableEncryption + - s3tables:PutTablePolicy + - s3tables:GetTableMetadataLocation + - s3tables:UpdateTableMetadataLocation - s3:PutBucketPublicAccessBlock - s3:PutReplicationConfiguration - s3:PutBucketOwnershipControls @@ -1751,10 +2441,30 @@ components: - Bucket - PolicyDocument x-stackql-resource-name: bucket_policy - x-stackql-primaryIdentifier: + description: |- + Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. + If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error. + As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. + When using the ``AWS::S3::BucketPolicy`` resource, you can create, update, and delete bucket policies for S3 buckets located in Regions that are different from the stack's Region. However, the CloudFormation stacks should be deployed in the US East (N. Virginia) or ``us-east-1`` Region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows. + If the [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) is not specified or set to ``Delete``, the bucket policy will be removed when the stack is deleted. If set to ``Retain``, the bucket policy will be preserved even after the stack is deleted. + For example, a CloudFormation stack in ``us-east-1`` can use the ``AWS::S3::BucketPolicy`` resource to manage the bucket policy for an S3 bucket in ``us-west-2``. The retention or removal of the bucket policy during the stack deletion is determined by the ``DeletionPolicy`` attribute specified in the stack template. + For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html). + The following operations are related to ``PutBucketPolicy``: + + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) + + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) + x-type-name: AWS::S3::BucketPolicy + x-stackql-primary-identifier: - Bucket x-create-only-properties: - Bucket + x-required-properties: + - Bucket + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - s3:GetBucketPolicy @@ -1771,51 +2481,53 @@ components: - s3:GetBucketPolicy - s3:ListAllMyBuckets Region: + additionalProperties: false type: object properties: Bucket: - type: string minLength: 3 - maxLength: 63 pattern: ^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$ - BucketAccountId: type: string + maxLength: 63 + BucketAccountId: minLength: 12 - maxLength: 12 pattern: ^[0-9]{12}$ + type: string + maxLength: 12 required: - Bucket - additionalProperties: false MultiRegionAccessPoint: type: object properties: - Name: - description: The name you want to assign to this Multi Region Access Point. - type: string - pattern: ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$ - minLength: 3 - maxLength: 50 + PublicAccessBlockConfiguration: + description: The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. + $ref: '#/components/schemas/PublicAccessBlockConfiguration' Alias: description: The alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point type: string CreatedAt: description: The timestamp of the when the Multi Region Access Point is created type: string - PublicAccessBlockConfiguration: - description: The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. - $ref: '#/components/schemas/PublicAccessBlockConfiguration' Regions: + minItems: 1 + uniqueItems: true description: The list of buckets that you want to associate this Multi Region Access Point with. type: array - uniqueItems: true - minItems: 1 items: description: The name of the bucket that represents of the region belonging to this Multi Region Access Point. $ref: '#/components/schemas/Region' + Name: + minLength: 3 + pattern: ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$ + description: The name you want to assign to this Multi Region Access Point. + type: string + maxLength: 50 required: - Regions x-stackql-resource-name: multi_region_access_point - x-stackql-primaryIdentifier: + description: AWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies. + x-type-name: AWS::S3::MultiRegionAccessPoint + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -1824,19 +2536,23 @@ components: x-read-only-properties: - Alias - CreatedAt + x-required-properties: + - Regions + x-tagging: + taggable: false x-required-permissions: + read: + - s3:GetMultiRegionAccessPoint create: - s3:CreateMultiRegionAccessPoint - s3:DescribeMultiRegionAccessPointOperation - s3:GetMultiRegionAccessPoint - read: - - s3:GetMultiRegionAccessPoint + list: + - s3:ListMultiRegionAccessPoints delete: - s3:DeleteMultiRegionAccessPoint - s3:DescribeMultiRegionAccessPointOperation - s3:GetMultiRegionAccessPoint - list: - - s3:ListMultiRegionAccessPoints MultiRegionAccessPointPolicy: type: object properties: @@ -1866,13 +2582,20 @@ components: - Policy - MrapName x-stackql-resource-name: multi_region_access_point_policy - x-stackql-primaryIdentifier: + description: The policy to be attached to a Multi Region Access Point + x-type-name: AWS::S3::MultiRegionAccessPointPolicy + x-stackql-primary-identifier: - MrapName x-create-only-properties: - MrapName x-read-only-properties: - PolicyStatus - PolicyStatus/IsPublic + x-required-properties: + - Policy + - MrapName + x-tagging: + taggable: false x-required-permissions: update: - s3:PutMultiRegionAccessPointPolicy @@ -1887,196 +2610,144 @@ components: create: - s3:PutMultiRegionAccessPointPolicy - s3:DescribeMultiRegionAccessPointOperation - Id: - description: The ID that identifies the Amazon S3 Storage Lens configuration. - type: string - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9\-_.]+$ - BucketsAndRegions: - description: S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration. - type: object + PrefixLevel: + description: Prefix-level metrics configurations. additionalProperties: false - properties: - Buckets: - type: array - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/Arn' - Regions: - type: array - x-insertionOrder: false - uniqueItems: true - items: - type: string - description: An AWS Region. - AwsOrg: - description: The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration. type: object - additionalProperties: false properties: - Arn: - $ref: '#/components/schemas/Arn' + StorageMetrics: + $ref: '#/components/schemas/PrefixLevelStorageMetrics' required: - - Arn - ActivityMetrics: - description: Enables activity metrics. - type: object + - StorageMetrics + StorageLensConfiguration: + description: Specifies the details of Amazon S3 Storage Lens configuration. additionalProperties: false + type: object properties: + AccountLevel: + $ref: '#/components/schemas/AccountLevel' + Exclude: + $ref: '#/components/schemas/BucketsAndRegions' IsEnabled: - description: Specifies whether activity metrics are enabled or disabled. + description: Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled. type: boolean - AdvancedCostOptimizationMetrics: - description: Enables advanced cost optimization metrics. - type: object + Include: + $ref: '#/components/schemas/BucketsAndRegions' + AwsOrg: + $ref: '#/components/schemas/AwsOrg' + Id: + $ref: '#/components/schemas/Id' + StorageLensArn: + description: The ARN for the Amazon S3 Storage Lens configuration. + type: string + DataExport: + $ref: '#/components/schemas/DataExport' + required: + - Id + - AccountLevel + - IsEnabled + StorageLensGroupArn: + description: The ARN for the Amazon S3 Storage Lens Group configuration. + type: string + PrefixLevelStorageMetrics: additionalProperties: false + type: object properties: IsEnabled: - description: Specifies whether advanced cost optimization metrics are enabled or disabled. + description: Specifies whether prefix-level storage metrics are enabled or disabled. type: boolean - AdvancedDataProtectionMetrics: - description: Enables advanced data protection metrics. - type: object + SelectionCriteria: + $ref: '#/components/schemas/SelectionCriteria' + AwsOrg: + description: The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration. additionalProperties: false + type: object properties: - IsEnabled: - description: Specifies whether advanced data protection metrics are enabled or disabled. - type: boolean + Arn: + $ref: '#/components/schemas/Arn' + required: + - Arn + Encryption: + oneOf: + - additionalProperties: false + properties: + SSES3: + description: S3 default server-side encryption. + additionalProperties: false + type: object + required: + - SSES3 + - additionalProperties: false + properties: + SSEKMS: + $ref: '#/components/schemas/SSEKMS' + required: + - SSEKMS + description: Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS). + type: object DetailedStatusCodesMetrics: description: Enables detailed status codes metrics. - type: object additionalProperties: false + type: object properties: IsEnabled: description: Specifies whether detailed status codes metrics are enabled or disabled. type: boolean - SelectionCriteria: - description: Selection criteria for prefix-level metrics. - type: object + AdvancedDataProtectionMetrics: + description: Enables advanced data protection metrics. additionalProperties: false - properties: - MaxDepth: - description: Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze. - type: integer - Delimiter: - description: Delimiter to divide S3 key into hierarchy of prefixes. - type: string - MinStorageBytesPercentage: - description: The minimum storage bytes threshold for the prefixes to be included in the analysis. - type: number - PrefixLevelStorageMetrics: type: object - additionalProperties: false properties: IsEnabled: - description: Specifies whether prefix-level storage metrics are enabled or disabled. + description: Specifies whether advanced data protection metrics are enabled or disabled. type: boolean - SelectionCriteria: - $ref: '#/components/schemas/SelectionCriteria' - PrefixLevel: - description: Prefix-level metrics configurations. - type: object + AccountLevel: + description: Account-level metrics configurations. additionalProperties: false - properties: - StorageMetrics: - $ref: '#/components/schemas/PrefixLevelStorageMetrics' - required: - - StorageMetrics - BucketLevel: - description: Bucket-level metrics configurations. type: object - additionalProperties: false properties: + AdvancedDataProtectionMetrics: + $ref: '#/components/schemas/AdvancedDataProtectionMetrics' + StorageLensGroupLevel: + $ref: '#/components/schemas/StorageLensGroupLevel' ActivityMetrics: $ref: '#/components/schemas/ActivityMetrics' + BucketLevel: + $ref: '#/components/schemas/BucketLevel' AdvancedCostOptimizationMetrics: $ref: '#/components/schemas/AdvancedCostOptimizationMetrics' - AdvancedDataProtectionMetrics: - $ref: '#/components/schemas/AdvancedDataProtectionMetrics' DetailedStatusCodesMetrics: $ref: '#/components/schemas/DetailedStatusCodesMetrics' - PrefixLevel: - $ref: '#/components/schemas/PrefixLevel' - StorageLensGroupArn: - description: The ARN for the Amazon S3 Storage Lens Group configuration. - type: string + required: + - BucketLevel + StorageLensGroupLevel: + description: Specifies the details of Amazon S3 Storage Lens Group configuration. + additionalProperties: false + type: object + properties: + StorageLensGroupSelectionCriteria: + $ref: '#/components/schemas/StorageLensGroupSelectionCriteria' StorageLensGroupSelectionCriteria: description: Selection criteria for Storage Lens Group level metrics - type: object additionalProperties: false + type: object properties: - Include: - type: array - x-insertionOrder: false + Exclude: uniqueItems: true + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/StorageLensGroupArn' - Exclude: - type: array - x-insertionOrder: false + Include: uniqueItems: true + x-insertionOrder: false + type: array items: $ref: '#/components/schemas/StorageLensGroupArn' - StorageLensGroupLevel: - description: Specifies the details of Amazon S3 Storage Lens Group configuration. - type: object - additionalProperties: false - properties: - StorageLensGroupSelectionCriteria: - $ref: '#/components/schemas/StorageLensGroupSelectionCriteria' - AccountLevel: - description: Account-level metrics configurations. - type: object - additionalProperties: false - properties: - ActivityMetrics: - $ref: '#/components/schemas/ActivityMetrics' - AdvancedCostOptimizationMetrics: - $ref: '#/components/schemas/AdvancedCostOptimizationMetrics' - AdvancedDataProtectionMetrics: - $ref: '#/components/schemas/AdvancedDataProtectionMetrics' - DetailedStatusCodesMetrics: - $ref: '#/components/schemas/DetailedStatusCodesMetrics' - BucketLevel: - $ref: '#/components/schemas/BucketLevel' - StorageLensGroupLevel: - $ref: '#/components/schemas/StorageLensGroupLevel' - required: - - BucketLevel - SSEKMS: - description: AWS KMS server-side encryption. - type: object - additionalProperties: false - properties: - KeyId: - description: The ARN of the KMS key to use for encryption. - type: string - required: - - KeyId - Encryption: - description: Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS). - type: object - oneOf: - - additionalProperties: false - properties: - SSES3: - description: S3 default server-side encryption. - type: object - additionalProperties: false - required: - - SSES3 - - additionalProperties: false - properties: - SSEKMS: - $ref: '#/components/schemas/SSEKMS' - required: - - SSEKMS S3BucketDestination: description: S3 bucket destination settings for the Amazon S3 Storage Lens metrics export. - type: object additionalProperties: false + type: object properties: OutputSchemaVersion: description: The version of the output schema to use when exporting Amazon S3 Storage Lens metrics. @@ -2092,79 +2763,148 @@ components: AccountId: description: The AWS account ID that owns the destination S3 bucket. type: string - Arn: - description: The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed. - type: string Prefix: description: The prefix to use for Amazon S3 Storage Lens export. type: string Encryption: $ref: '#/components/schemas/Encryption' + Arn: + description: The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed. + type: string required: - OutputSchemaVersion - Format - AccountId - Arn + ActivityMetrics: + description: Enables activity metrics. + additionalProperties: false + type: object + properties: + IsEnabled: + description: Specifies whether activity metrics are enabled or disabled. + type: boolean + SelectionCriteria: + description: Selection criteria for prefix-level metrics. + additionalProperties: false + type: object + properties: + Delimiter: + description: Delimiter to divide S3 key into hierarchy of prefixes. + type: string + MaxDepth: + description: Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze. + type: integer + MinStorageBytesPercentage: + description: The minimum storage bytes threshold for the prefixes to be included in the analysis. + type: number CloudWatchMetrics: description: CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export. + additionalProperties: false type: object + properties: + IsEnabled: + description: Specifies whether CloudWatch metrics are enabled or disabled. + type: boolean + required: + - IsEnabled + SSEKMS: + description: AWS KMS server-side encryption. additionalProperties: false + type: object properties: - IsEnabled: - description: Specifies whether CloudWatch metrics are enabled or disabled. - type: boolean + KeyId: + description: The ARN of the KMS key to use for encryption. + type: string required: - - IsEnabled - StorageLensConfiguration: - description: Specifies the details of Amazon S3 Storage Lens configuration. + - KeyId + BucketsAndRegions: + description: S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration. + additionalProperties: false + type: object + properties: + Regions: + uniqueItems: true + x-insertionOrder: false + type: array + items: + description: An AWS Region. + type: string + Buckets: + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Arn' + Id: + minLength: 1 + pattern: ^[a-zA-Z0-9\-_.]+$ + description: The ID that identifies the Amazon S3 Storage Lens configuration. + type: string + maxLength: 64 + BucketLevel: + description: Bucket-level metrics configurations. + additionalProperties: false type: object + properties: + AdvancedDataProtectionMetrics: + $ref: '#/components/schemas/AdvancedDataProtectionMetrics' + PrefixLevel: + $ref: '#/components/schemas/PrefixLevel' + ActivityMetrics: + $ref: '#/components/schemas/ActivityMetrics' + AdvancedCostOptimizationMetrics: + $ref: '#/components/schemas/AdvancedCostOptimizationMetrics' + DetailedStatusCodesMetrics: + $ref: '#/components/schemas/DetailedStatusCodesMetrics' + AdvancedCostOptimizationMetrics: + description: Enables advanced cost optimization metrics. additionalProperties: false + type: object properties: - Id: - $ref: '#/components/schemas/Id' - Include: - $ref: '#/components/schemas/BucketsAndRegions' - Exclude: - $ref: '#/components/schemas/BucketsAndRegions' - AwsOrg: - $ref: '#/components/schemas/AwsOrg' - AccountLevel: - $ref: '#/components/schemas/AccountLevel' - DataExport: - $ref: '#/components/schemas/DataExport' IsEnabled: - description: Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled. + description: Specifies whether advanced cost optimization metrics are enabled or disabled. type: boolean - StorageLensArn: - description: The ARN for the Amazon S3 Storage Lens configuration. - type: string - required: - - Id - - AccountLevel - - IsEnabled StorageLens: type: object properties: StorageLensConfiguration: $ref: '#/components/schemas/StorageLensConfiguration' Tags: + maxItems: 50 + uniqueItems: true description: A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration. - type: array x-insertionOrder: false - uniqueItems: true + type: array items: $ref: '#/components/schemas/Tag' - maxItems: 50 required: - StorageLensConfiguration x-stackql-resource-name: storage_lens - x-stackql-primaryIdentifier: + description: The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations. + x-type-name: AWS::S3::StorageLens + x-stackql-primary-identifier: - StorageLensConfiguration/Id x-create-only-properties: - StorageLensConfiguration/Id x-read-only-properties: - StorageLensConfiguration/StorageLensArn + x-required-properties: + - StorageLensConfiguration + x-tagging: + permissions: + - s3:PutStorageLensConfigurationTagging + - s3:GetStorageLensConfigurationTagging + - s3:DeleteStorageLensConfigurationTagging + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: + read: + - s3:GetStorageLensConfiguration + - s3:GetStorageLensConfigurationTagging create: - s3:PutStorageLensConfiguration - s3:PutStorageLensConfigurationTagging @@ -2175,9 +2915,6 @@ components: - organizations:ListAWSServiceAccessForOrganization - organizations:ListDelegatedAdministrators - iam:CreateServiceLinkedRole - read: - - s3:GetStorageLensConfiguration - - s3:GetStorageLensConfigurationTagging update: - s3:PutStorageLensConfiguration - s3:PutStorageLensConfigurationTagging @@ -2188,11 +2925,11 @@ components: - organizations:ListAWSServiceAccessForOrganization - organizations:ListDelegatedAdministrators - iam:CreateServiceLinkedRole + list: + - s3:ListStorageLensConfigurations delete: - s3:DeleteStorageLensConfiguration - s3:DeleteStorageLensConfigurationTagging - list: - - s3:ListStorageLensConfigurations Name: description: The name that identifies the Amazon S3 Storage Lens Group. type: string @@ -2324,12 +3061,27 @@ components: - Name - Filter x-stackql-resource-name: storage_lens_group - x-stackql-primaryIdentifier: + description: The AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group. + x-type-name: AWS::S3::StorageLensGroup + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - StorageLensGroupArn + x-required-properties: + - Name + - Filter + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - s3:TagResource + - s3:UntagResource + - s3:ListTagsForResource x-required-permissions: create: - s3:CreateStorageLensGroup @@ -2349,43 +3101,593 @@ components: - s3:DeleteStorageLensGroup list: - s3:ListStorageLensGroups + CreateAccessGrantRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessGrantId: + description: The ID assigned to this access grant. + type: string + x-examples: + - 7c89cbd1-0f4e-40e3-861d-afb906952b77 + AccessGrantsLocationId: + description: The custom S3 location to be accessed by the grantee + type: string + x-examples: + - 125f332b-a499-4eb6-806f-8a6a1aa4cb96 + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + Permission: + description: The level of access to be afforded to the grantee + type: string + enum: + - READ + - WRITE + - READWRITE + ApplicationArn: + description: The ARN of the application grantees will use to access the location + type: string + S3PrefixType: + description: The type of S3SubPrefix. + type: string + enum: + - Object + GrantScope: + description: The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix. + type: string + AccessGrantArn: + $ref: '#/components/schemas/AccessGrantArn' + description: The Amazon Resource Name (ARN) of the specified access grant. + x-examples: + - arn:aws:s3:us-east-2:111122223333:access-grants/default/grant/7c89cbd1-0f4e-40e3-861d-afb906952b77 + Grantee: + $ref: '#/components/schemas/Grantee' + description: The principal who will be granted permission to access S3. + AccessGrantsLocationConfiguration: + $ref: '#/components/schemas/AccessGrantsLocationConfiguration' + description: The configuration options of the grant location, which is the S3 path to the data to which you are granting access. + x-stackQL-stringOnly: true + x-title: CreateAccessGrantRequest + type: object + required: [] + CreateAccessGrantsInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessGrantsInstanceArn: + $ref: '#/components/schemas/AccessGrantsInstanceArn' + description: The Amazon Resource Name (ARN) of the specified Access Grants instance. + x-examples: + - arn:aws:s3:us-east-2:479290226168:access-grants/default + IdentityCenterArn: + $ref: '#/components/schemas/IdentityCenterArn' + description: The Amazon Resource Name (ARN) of the specified AWS Identity Center. + x-examples: + - arn:aws:sso:::instance/ssoins-6987e6a2fc43873b + AccessGrantsInstanceId: + type: string + description: A unique identifier for the specified access grants instance. + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAccessGrantsInstanceRequest + type: object + required: [] + CreateAccessGrantsLocationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessGrantsLocationArn: + description: The Amazon Resource Name (ARN) of the specified Access Grants location. + type: string + x-examples: + - arn:aws:s3:us-east-2:479290226168:access-grants/default/location/125f332b-a499-4eb6-806f-8a6a1aa4cb96 + AccessGrantsLocationId: + type: string + description: The unique identifier for the specified Access Grants location. + IamRoleArn: + description: The Amazon Resource Name (ARN) of the access grant location's associated IAM role. + type: string + x-examples: + - arn:aws:iamw::123456789012:role/rolename + LocationScope: + type: string + description: Descriptor for where the location actually points + x-examples: + - s3://test-bucket-access-grants-cmh/prefixA + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAccessGrantsLocationRequest + type: object + required: [] + CreateAccessPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name. + type: string + pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ + minLength: 3 + maxLength: 50 + Alias: + description: The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications. + type: string + pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ + minLength: 3 + maxLength: 63 + Bucket: + description: The name of the bucket that you want to associate this Access Point with. + type: string + minLength: 3 + maxLength: 255 + BucketAccountId: + description: The AWS account ID associated with the S3 bucket associated with this access point. + type: string + pattern: ^\d{12}$ + maxLength: 64 + VpcConfiguration: + description: If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). + $ref: '#/components/schemas/VpcConfiguration' + PublicAccessBlockConfiguration: + description: The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + Policy: + description: The Access Point Policy you want to apply to this access point. + type: object + NetworkOrigin: + description: Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies. + type: string + enum: + - Internet + - VPC + Arn: + $ref: '#/components/schemas/Arn' + description: The Amazon Resource Name (ARN) of the specified accesspoint. + x-examples: + - arn:aws:s3:us-west-2:123456789012:accesspoint/test + Tags: + description: An arbitrary set of tags (key-value pairs) for this S3 Access Point. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array + x-stackQL-stringOnly: true + x-title: CreateAccessPointRequest + type: object + required: [] + CreateBucketRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccelerateConfiguration: + $ref: '#/components/schemas/AccelerateConfiguration' + description: Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. + AccessControl: + description: |- + This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. + A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. + S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. + The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*. + enum: + - AuthenticatedRead + - AwsExecRead + - BucketOwnerFullControl + - BucketOwnerRead + - LogDeliveryWrite + - Private + - PublicRead + - PublicReadWrite + type: string + AnalyticsConfigurations: + description: Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. + items: + $ref: '#/components/schemas/AnalyticsConfiguration' + type: array + uniqueItems: true + x-insertionOrder: true + BucketEncryption: + $ref: '#/components/schemas/BucketEncryption' + description: Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. + BucketName: + description: >- + A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 + buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) in the *Amazon S3 User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. + type: string + CorsConfiguration: + $ref: '#/components/schemas/CorsConfiguration' + description: Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. + IntelligentTieringConfigurations: + description: Defines how Amazon S3 handles Intelligent-Tiering storage. + items: + $ref: '#/components/schemas/IntelligentTieringConfiguration' + type: array + uniqueItems: true + x-insertionOrder: true + InventoryConfigurations: + description: Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*. + items: + $ref: '#/components/schemas/InventoryConfiguration' + type: array + uniqueItems: true + x-insertionOrder: true + LifecycleConfiguration: + $ref: '#/components/schemas/LifecycleConfiguration' + description: Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. + LoggingConfiguration: + $ref: '#/components/schemas/LoggingConfiguration' + description: Settings that define where logs are stored. + MetricsConfigurations: + description: Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). + items: + $ref: '#/components/schemas/MetricsConfiguration' + type: array + uniqueItems: true + x-insertionOrder: true + MetadataTableConfiguration: + $ref: '#/components/schemas/MetadataTableConfiguration' + description: The metadata table configuration of an S3 general purpose bucket. + MetadataConfiguration: + $ref: '#/components/schemas/MetadataConfiguration' + description: '' + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + description: Configuration that defines how Amazon S3 handles bucket notifications. + ObjectLockConfiguration: + $ref: '#/components/schemas/ObjectLockConfiguration' + description: |- + This operation is not supported for directory buckets. + Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + + The ``DefaultRetention`` settings require both a mode and a period. + + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). + ObjectLockEnabled: + description: Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket. + type: boolean + OwnershipControls: + description: Configuration that defines how Amazon S3 handles Object Ownership rules. + $ref: '#/components/schemas/OwnershipControls' + PublicAccessBlockConfiguration: + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + description: Configuration that defines how Amazon S3 handles public access. + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + description: |- + Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. + Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. + Tags: + description: An arbitrary set of tags (key-value pairs) for this S3 bucket. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + type: array + VersioningConfiguration: + $ref: '#/components/schemas/VersioningConfiguration' + description: |- + Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. + When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket. + WebsiteConfiguration: + $ref: '#/components/schemas/WebsiteConfiguration' + description: Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). + Arn: + $ref: '#/components/schemas/Arn' + description: '' + x-examples: + - arn:aws:s3:::mybucket + DomainName: + description: '' + x-examples: + - mystack-mybucket-kdwwxmddtr2g.s3.amazonaws.com + type: string + DualStackDomainName: + description: '' + x-examples: + - mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com + type: string + RegionalDomainName: + description: '' + x-examples: + - mystack-mybucket-kdwwxmddtr2g.s3.us-east-2.amazonaws.com + type: string + WebsiteURL: + description: '' + x-examples: + - 'Example (IPv4): http://mystack-mybucket-kdwwxmddtr2g.s3-website-us-east-2.amazonaws.com/' + - 'Example (IPv6): http://mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com/' + format: uri + type: string + x-stackQL-stringOnly: true + x-title: CreateBucketRequest + type: object + required: [] + CreateBucketPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Bucket: + description: The name of the Amazon S3 bucket to which the policy applies. + type: string + PolicyDocument: + description: >- + A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource + description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*. + type: object + x-stackQL-stringOnly: true + x-title: CreateBucketPolicyRequest + type: object + required: [] + CreateMultiRegionAccessPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PublicAccessBlockConfiguration: + description: The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + Alias: + description: The alias is a unique identifier to, and is part of the public DNS name for this Multi Region Access Point + type: string + CreatedAt: + description: The timestamp of the when the Multi Region Access Point is created + type: string + Regions: + minItems: 1 + uniqueItems: true + description: The list of buckets that you want to associate this Multi Region Access Point with. + type: array + items: + description: The name of the bucket that represents of the region belonging to this Multi Region Access Point. + $ref: '#/components/schemas/Region' + Name: + minLength: 3 + pattern: ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$ + description: The name you want to assign to this Multi Region Access Point. + type: string + maxLength: 50 + x-stackQL-stringOnly: true + x-title: CreateMultiRegionAccessPointRequest + type: object + required: [] + CreateMultiRegionAccessPointPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MrapName: + description: The name of the Multi Region Access Point to apply policy + type: string + pattern: ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$ + minLength: 3 + maxLength: 50 + Policy: + description: Policy document to apply to a Multi Region Access Point + type: object + PolicyStatus: + description: The Policy Status associated with this Multi Region Access Point + type: object + properties: + IsPublic: + type: string + description: Specifies whether the policy is public or not. + enum: + - 'true' + - 'false' + additionalProperties: false + required: + - IsPublic + x-stackQL-stringOnly: true + x-title: CreateMultiRegionAccessPointPolicyRequest + type: object + required: [] + CreateStorageLensRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StorageLensConfiguration: + $ref: '#/components/schemas/StorageLensConfiguration' + Tags: + maxItems: 50 + uniqueItems: true + description: A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStorageLensRequest + type: object + required: [] + CreateStorageLensGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + $ref: '#/components/schemas/Name' + Filter: + $ref: '#/components/schemas/Filter' + StorageLensGroupArn: + description: The ARN for the Amazon S3 Storage Lens Group. + type: string + Tags: + description: A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group. + type: array + x-insertionOrder: true + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateStorageLensGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_grants: name: access_grants id: awscc.s3.access_grants x-cfn-schema-name: AccessGrant - x-type: list - x-identifiers: - - AccessGrantId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessGrantId') as access_grant_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessGrantId') as access_grant_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' - AND region = 'us-east-1' - access_grant: - name: access_grant - id: awscc.s3.access_grant - x-cfn-schema-name: AccessGrant - x-type: get + x-cfn-type-name: AWS::S3::AccessGrant x-identifiers: - AccessGrantId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessGrant&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_grants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_grants/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_grants/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2404,7 +3706,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2419,16 +3721,22 @@ components: json_extract_path_text(Properties, 'AccessGrantArn') as access_grant_arn, json_extract_path_text(Properties, 'Grantee') as grantee, json_extract_path_text(Properties, 'AccessGrantsLocationConfiguration') as access_grants_location_configuration - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrant' - AND data__Identifier = '' - AND region = 'us-east-1' - access_grants_instances: - name: access_grants_instances - id: awscc.s3.access_grants_instances - x-cfn-schema-name: AccessGrantsInstance - x-type: list + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrant' + AND data__Identifier = '' + AND region = 'us-east-1' + access_grants_list_only: + name: access_grants_list_only + id: awscc.s3.access_grants_list_only + x-cfn-schema-name: AccessGrant + x-cfn-type-name: AWS::S3::AccessGrant x-identifiers: - - AccessGrantsInstanceArn + - AccessGrantId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2436,28 +3744,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AccessGrantsInstanceArn') as access_grants_instance_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' + JSON_EXTRACT(Properties, '$.AccessGrantId') as access_grant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AccessGrantsInstanceArn') as access_grants_instance_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' + json_extract_path_text(Properties, 'AccessGrantId') as access_grant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' AND region = 'us-east-1' - access_grants_instance: - name: access_grants_instance - id: awscc.s3.access_grants_instance + access_grants_instances: + name: access_grants_instances + id: awscc.s3.access_grants_instances x-cfn-schema-name: AccessGrantsInstance - x-type: get + x-cfn-type-name: AWS::S3::AccessGrantsInstance x-identifiers: - AccessGrantsInstanceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessGrantsInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrantsInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrantsInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrantsInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2470,7 +3826,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2482,13 +3838,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' AND data__Identifier = '' AND region = 'us-east-1' - access_grants_locations: - name: access_grants_locations - id: awscc.s3.access_grants_locations - x-cfn-schema-name: AccessGrantsLocation - x-type: list + access_grants_instances_list_only: + name: access_grants_instances_list_only + id: awscc.s3.access_grants_instances_list_only + x-cfn-schema-name: AccessGrantsInstance + x-cfn-type-name: AWS::S3::AccessGrantsInstance x-identifiers: - - AccessGrantsLocationId + - AccessGrantsInstanceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2496,28 +3858,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AccessGrantsLocationId') as access_grants_location_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' + JSON_EXTRACT(Properties, '$.AccessGrantsInstanceArn') as access_grants_instance_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' + json_extract_path_text(Properties, 'AccessGrantsInstanceArn') as access_grants_instance_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' AND region = 'us-east-1' - access_grants_location: - name: access_grants_location - id: awscc.s3.access_grants_location + access_grants_locations: + name: access_grants_locations + id: awscc.s3.access_grants_locations x-cfn-schema-name: AccessGrantsLocation - x-type: get + x-cfn-type-name: AWS::S3::AccessGrantsLocation x-identifiers: - AccessGrantsLocationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessGrantsLocation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrantsLocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrantsLocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessGrantsLocation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2531,7 +3941,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2544,13 +3954,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' AND data__Identifier = '' AND region = 'us-east-1' - access_points: - name: access_points - id: awscc.s3.access_points - x-cfn-schema-name: AccessPoint - x-type: list + access_grants_locations_list_only: + name: access_grants_locations_list_only + id: awscc.s3.access_grants_locations_list_only + x-cfn-schema-name: AccessGrantsLocation + x-cfn-type-name: AWS::S3::AccessGrantsLocation x-identifiers: - - Name + - AccessGrantsLocationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2558,28 +3974,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' + JSON_EXTRACT(Properties, '$.AccessGrantsLocationId') as access_grants_location_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' + json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' AND region = 'us-east-1' - access_point: - name: access_point - id: awscc.s3.access_point + access_points: + name: access_points + id: awscc.s3.access_points x-cfn-schema-name: AccessPoint - x-type: get + x-cfn-type-name: AWS::S3::AccessPoint x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2592,12 +4056,13 @@ components: JSON_EXTRACT(Properties, '$.PublicAccessBlockConfiguration') as public_access_block_configuration, JSON_EXTRACT(Properties, '$.Policy') as policy, JSON_EXTRACT(Properties, '$.NetworkOrigin') as network_origin, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessPoint' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2610,17 +4075,24 @@ components: json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, json_extract_path_text(Properties, 'Policy') as policy, json_extract_path_text(Properties, 'NetworkOrigin') as network_origin, - json_extract_path_text(Properties, 'Arn') as arn + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessPoint' AND data__Identifier = '' AND region = 'us-east-1' - buckets: - name: buckets - id: awscc.s3.buckets - x-cfn-schema-name: Bucket - x-type: list + access_points_list_only: + name: access_points_list_only + id: awscc.s3.access_points_list_only + x-cfn-schema-name: AccessPoint + x-cfn-type-name: AWS::S3::AccessPoint x-identifiers: - - BucketName + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2628,28 +4100,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BucketName') as bucket_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BucketName') as bucket_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' AND region = 'us-east-1' - bucket: - name: bucket - id: awscc.s3.bucket + buckets: + name: buckets + id: awscc.s3.buckets x-cfn-schema-name: Bucket - x-type: get + x-cfn-type-name: AWS::S3::Bucket x-identifiers: - BucketName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Bucket&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2665,6 +4185,8 @@ components: JSON_EXTRACT(Properties, '$.LifecycleConfiguration') as lifecycle_configuration, JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration, JSON_EXTRACT(Properties, '$.MetricsConfigurations') as metrics_configurations, + JSON_EXTRACT(Properties, '$.MetadataTableConfiguration') as metadata_table_configuration, + JSON_EXTRACT(Properties, '$.MetadataConfiguration') as metadata_configuration, JSON_EXTRACT(Properties, '$.NotificationConfiguration') as notification_configuration, JSON_EXTRACT(Properties, '$.ObjectLockConfiguration') as object_lock_configuration, JSON_EXTRACT(Properties, '$.ObjectLockEnabled') as object_lock_enabled, @@ -2678,13 +4200,12 @@ components: JSON_EXTRACT(Properties, '$.DomainName') as domain_name, JSON_EXTRACT(Properties, '$.DualStackDomainName') as dual_stack_domain_name, JSON_EXTRACT(Properties, '$.RegionalDomainName') as regional_domain_name, - SPLIT_PART(SPLIT_PART(JSON_EXTRACT(Properties, '$.RegionalDomainName'), '.s3.', 2), '.', 1) as bucket_location, JSON_EXTRACT(Properties, '$.WebsiteURL') as website_url FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::Bucket' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2700,6 +4221,8 @@ components: json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, json_extract_path_text(Properties, 'MetricsConfigurations') as metrics_configurations, + json_extract_path_text(Properties, 'MetadataTableConfiguration') as metadata_table_configuration, + json_extract_path_text(Properties, 'MetadataConfiguration') as metadata_configuration, json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, json_extract_path_text(Properties, 'ObjectLockConfiguration') as object_lock_configuration, json_extract_path_text(Properties, 'ObjectLockEnabled') as object_lock_enabled, @@ -2713,18 +4236,23 @@ components: json_extract_path_text(Properties, 'DomainName') as domain_name, json_extract_path_text(Properties, 'DualStackDomainName') as dual_stack_domain_name, json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, - SPLIT_PART(SPLIT_PART(json_extract_path_text(Properties, 'RegionalDomainName'), '.s3.', 2), '.', 1) as bucket_location, json_extract_path_text(Properties, 'WebsiteURL') as website_url FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::Bucket' AND data__Identifier = '' AND region = 'us-east-1' - bucket_policies: - name: bucket_policies - id: awscc.s3.bucket_policies - x-cfn-schema-name: BucketPolicy - x-type: list + buckets_list_only: + name: buckets_list_only + id: awscc.s3.buckets_list_only + x-cfn-schema-name: Bucket + x-cfn-type-name: AWS::S3::Bucket x-identifiers: - - Bucket + - BucketName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2732,28 +4260,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Bucket') as bucket - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' + JSON_EXTRACT(Properties, '$.BucketName') as bucket_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Bucket') as bucket - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' + json_extract_path_text(Properties, 'BucketName') as bucket_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' AND region = 'us-east-1' - bucket_policy: - name: bucket_policy - id: awscc.s3.bucket_policy + bucket_policies: + name: bucket_policies + id: awscc.s3.bucket_policies x-cfn-schema-name: BucketPolicy - x-type: get + x-cfn-type-name: AWS::S3::BucketPolicy x-identifiers: - Bucket + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BucketPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2764,7 +4340,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2774,13 +4350,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::BucketPolicy' AND data__Identifier = '' AND region = 'us-east-1' - multi_region_access_points: - name: multi_region_access_points - id: awscc.s3.multi_region_access_points - x-cfn-schema-name: MultiRegionAccessPoint - x-type: list + bucket_policies_list_only: + name: bucket_policies_list_only + id: awscc.s3.bucket_policies_list_only + x-cfn-schema-name: BucketPolicy + x-cfn-type-name: AWS::S3::BucketPolicy x-identifiers: - - Name + - Bucket + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2788,61 +4370,102 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' + JSON_EXTRACT(Properties, '$.Bucket') as bucket + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' + json_extract_path_text(Properties, 'Bucket') as bucket + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' AND region = 'us-east-1' - multi_region_access_point: - name: multi_region_access_point - id: awscc.s3.multi_region_access_point + multi_region_access_points: + name: multi_region_access_points + id: awscc.s3.multi_region_access_points x-cfn-schema-name: MultiRegionAccessPoint - x-type: get + x-cfn-type-name: AWS::S3::MultiRegionAccessPoint x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MultiRegionAccessPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::MultiRegionAccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::MultiRegionAccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multi_region_access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multi_region_access_points/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.PublicAccessBlockConfiguration') as public_access_block_configuration, JSON_EXTRACT(Properties, '$.Alias') as alias, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.PublicAccessBlockConfiguration') as public_access_block_configuration, - JSON_EXTRACT(Properties, '$.Regions') as regions + JSON_EXTRACT(Properties, '$.Regions') as regions, + JSON_EXTRACT(Properties, '$.Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, json_extract_path_text(Properties, 'Alias') as alias, json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, - json_extract_path_text(Properties, 'Regions') as regions + json_extract_path_text(Properties, 'Regions') as regions, + json_extract_path_text(Properties, 'Name') as name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' AND data__Identifier = '' AND region = 'us-east-1' - multi_region_access_point_policies: - name: multi_region_access_point_policies - id: awscc.s3.multi_region_access_point_policies - x-cfn-schema-name: MultiRegionAccessPointPolicy - x-type: list + multi_region_access_points_list_only: + name: multi_region_access_points_list_only + id: awscc.s3.multi_region_access_points_list_only + x-cfn-schema-name: MultiRegionAccessPoint + x-cfn-type-name: AWS::S3::MultiRegionAccessPoint x-identifiers: - - MrapName + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2850,28 +4473,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MrapName') as mrap_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPointPolicy' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'MrapName') as mrap_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPointPolicy' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' AND region = 'us-east-1' - multi_region_access_point_policy: - name: multi_region_access_point_policy - id: awscc.s3.multi_region_access_point_policy + multi_region_access_point_policies: + name: multi_region_access_point_policies + id: awscc.s3.multi_region_access_point_policies x-cfn-schema-name: MultiRegionAccessPointPolicy - x-type: get + x-cfn-type-name: AWS::S3::MultiRegionAccessPointPolicy x-identifiers: - MrapName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MultiRegionAccessPointPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::MultiRegionAccessPointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::MultiRegionAccessPointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::MultiRegionAccessPointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2883,7 +4554,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2898,13 +4569,61 @@ components: name: storage_lens id: awscc.s3.storage_lens x-cfn-schema-name: StorageLens - x-type: get + x-cfn-type-name: AWS::S3::StorageLens x-identifiers: - StorageLensConfiguration/Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StorageLens&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLens" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLens" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLens" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_lens/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_lens/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/storage_lens/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2915,7 +4634,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2925,13 +4644,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::StorageLens' AND data__Identifier = '' AND region = 'us-east-1' - storage_lens_groups: - name: storage_lens_groups - id: awscc.s3.storage_lens_groups - x-cfn-schema-name: StorageLensGroup - x-type: list + storage_lens_list_only: + name: storage_lens_list_only + id: awscc.s3.storage_lens_list_only + x-cfn-schema-name: StorageLens + x-cfn-type-name: AWS::S3::StorageLens x-identifiers: - - Name + - StorageLensConfiguration/Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2939,28 +4664,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' + JSON_EXTRACT(Properties, '$.StorageLensConfiguration.Id') as storage_lens_configuration__id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLens' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' + json_extract_path_text(Properties, 'StorageLensConfiguration', 'Id') as storage_lens_configuration__id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLens' AND region = 'us-east-1' - storage_lens_group: - name: storage_lens_group - id: awscc.s3.storage_lens_group + storage_lens_groups: + name: storage_lens_groups + id: awscc.s3.storage_lens_groups x-cfn-schema-name: StorageLensGroup - x-type: get + x-cfn-type-name: AWS::S3::StorageLensGroup x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StorageLensGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLensGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLensGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLensGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2973,7 +4746,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2985,3 +4758,607 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3::StorageLensGroup' AND data__Identifier = '' AND region = 'us-east-1' + storage_lens_groups_list_only: + name: storage_lens_groups_list_only + id: awscc.s3.storage_lens_groups_list_only + x-cfn-schema-name: StorageLensGroup + x-cfn-type-name: AWS::S3::StorageLensGroup + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessGrant&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessGrant + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessGrantRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessGrantsInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessGrantsInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessGrantsInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessGrantsLocation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessGrantsLocation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessGrantsLocationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Bucket&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBucket + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBucketRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BucketPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBucketPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBucketPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MultiRegionAccessPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMultiRegionAccessPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMultiRegionAccessPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MultiRegionAccessPointPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMultiRegionAccessPointPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMultiRegionAccessPointPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StorageLens&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStorageLens + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStorageLensRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StorageLensGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStorageLensGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStorageLensGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/s3express.yaml b/providers/src/awscc/v00.00.00000/services/s3express.yaml index 7dee4953..e454c1a3 100644 --- a/providers/src/awscc/v00.00.00000/services/s3express.yaml +++ b/providers/src/awscc/v00.00.00000/services/s3express.yaml @@ -1,10 +1,571 @@ openapi: 3.0.0 info: title: S3Express - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + VpcConfiguration: + description: The Virtual Private Cloud (VPC) configuration for a bucket access point. + type: object + properties: + VpcId: + description: If this field is specified, this access point will only allow connections from the specified VPC ID. + type: string + minLength: 1 + maxLength: 1024 + PublicAccessBlockConfiguration: + type: object + properties: + BlockPublicAcls: + type: boolean + description: |- + Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior: + - PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. + - PUT Object calls fail if the request includes a public ACL. + . - PUT Bucket calls fail if the request includes a public ACL. + Enabling this setting doesn't affect existing policies or ACLs. + IgnorePublicAcls: + type: boolean + description: Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. + BlockPublicPolicy: + type: boolean + description: Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. + RestrictPublicBuckets: + type: boolean + description: |- + Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. + Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. + Arn: + description: The Amazon Resource Name (ARN) of the specified bucket. + type: string + Scope: + type: object + properties: + Prefixes: + description: You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Permissions: + description: You can include one or more API operations as permissions + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + enum: + - GetObject + - GetObjectAttributes + - ListMultipartUploadParts + - ListBucket + - ListBucketMultipartUploads + - PutObject + - DeleteObject + - AbortMultipartUpload + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + pattern: ^(?!aws:.*)([\p{L}\p{Z}\p{N}_.:=+\/\-@%]*)$ + Value: + type: string + minLength: 0 + maxLength: 256 + pattern: ^([\p{L}\p{Z}\p{N}_.:=+\/\-@%]*)$ + required: + - Key + - Value + AccessPoint: + type: object + properties: + Name: + description: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name. For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (AWS Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. + type: string + pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ + minLength: 3 + maxLength: 50 + Bucket: + description: The name of the bucket that you want to associate this Access Point with. + type: string + minLength: 3 + maxLength: 255 + BucketAccountId: + description: The AWS account ID associated with the S3 bucket associated with this access point. + type: string + pattern: ^\d{12}$ + maxLength: 64 + VpcConfiguration: + description: If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). + $ref: '#/components/schemas/VpcConfiguration' + PublicAccessBlockConfiguration: + description: The PublicAccessBlock configuration that you want to apply to this Access Point. + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + Scope: + description: For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. + $ref: '#/components/schemas/Scope' + Policy: + description: The Access Point Policy you want to apply to this access point. + type: object + NetworkOrigin: + description: Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies. + type: string + enum: + - Internet + - VPC + Arn: + $ref: '#/components/schemas/Arn' + description: The Amazon Resource Name (ARN) of the specified accesspoint. + x-examples: + - arn:aws:s3express:us-west-2:123456789012:accesspoint/my-accesspoint--usw2-az1--xa-s3 + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - Bucket + x-stackql-resource-name: access_point + description: The AWS::S3Express::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets. + x-type-name: AWS::S3Express::AccessPoint + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - Bucket + - BucketAccountId + - VpcConfiguration + x-read-only-properties: + - NetworkOrigin + - Arn + x-required-properties: + - Bucket + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - s3express:TagResource + - s3express:UntagResource + x-required-permissions: + create: + - s3express:CreateAccessPoint + - s3express:PutAccessPointPolicy + - s3express:GetAccessPoint + - s3express:PutAccessPointScope + - s3express:GetAccessPointScope + - s3express:TagResource + read: + - s3express:GetAccessPoint + - s3express:GetAccessPointPolicy + - s3express:GetAccessPointScope + - s3express:ListTagsForResource + update: + - s3express:PutAccessPointPolicy + - s3express:DeleteAccessPointPolicy + - s3express:PutAccessPointScope + - s3express:DeleteAccessPointScope + - s3express:TagResource + - s3express:UntagResource + - s3express:GetAccessPoint + - s3express:GetAccessPointPolicy + - s3express:GetAccessPointScope + - s3express:ListTagsForResource + delete: + - s3express:DeleteAccessPointPolicy + - s3express:DeleteAccessPoint + - s3express:DeleteAccessPointScope + list: + - s3express:ListAccessPointsForDirectoryBuckets BucketPolicy: type: object properties: @@ -18,10 +579,20 @@ components: - Bucket - PolicyDocument x-stackql-resource-name: bucket_policy - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::S3Express::BucketPolicy. + x-type-name: AWS::S3Express::BucketPolicy + x-stackql-primary-identifier: - Bucket x-create-only-properties: - Bucket + x-required-properties: + - Bucket + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - s3express:GetBucketPolicy @@ -37,35 +608,150 @@ components: list: - s3express:GetBucketPolicy - s3express:ListAllMyDirectoryBuckets - Arn: - description: The Amazon Resource Name (ARN) of the specified bucket. - type: string + BucketEncryption: + description: Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). + type: object + additionalProperties: false + properties: + ServerSideEncryptionConfiguration: + description: Specifies the default server-side-encryption configuration. + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/ServerSideEncryptionRule' + required: + - ServerSideEncryptionConfiguration + ServerSideEncryptionRule: + description: Specifies the default server-side encryption configuration. + type: object + additionalProperties: false + properties: + BucketKeyEnabled: + description: Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true. + type: boolean + ServerSideEncryptionByDefault: + $ref: '#/components/schemas/ServerSideEncryptionByDefault' + ServerSideEncryptionByDefault: + description: Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. + type: object + properties: + KMSMasterKeyID: + description: AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key + type: string + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + SSEAlgorithm: + type: string + enum: + - aws:kms + - AES256 + additionalProperties: false + required: + - SSEAlgorithm + LifecycleConfiguration: + type: object + additionalProperties: false + properties: + Rules: + description: A lifecycle rule for individual objects in an Amazon S3 Express bucket. + type: array + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/Rule' + required: + - Rules + Rule: + type: object + description: 'You must specify at least one of the following properties: AbortIncompleteMultipartUpload, or ExpirationInDays.' + additionalProperties: false + properties: + AbortIncompleteMultipartUpload: + $ref: '#/components/schemas/AbortIncompleteMultipartUpload' + ExpirationInDays: + type: integer + Id: + type: string + maxLength: 255 + Prefix: + type: string + Status: + type: string + enum: + - Enabled + - Disabled + ObjectSizeGreaterThan: + type: string + maxLength: 20 + pattern: '[0-9]+' + ObjectSizeLessThan: + type: string + maxLength: 20 + pattern: '[0-9]+' + required: + - Status + AbortIncompleteMultipartUpload: + description: Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. + type: object + additionalProperties: false + properties: + DaysAfterInitiation: + description: Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload. + type: integer + minimum: 0 + required: + - DaysAfterInitiation DirectoryBucket: type: object properties: BucketName: - description: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + description: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. maxLength: 63 pattern: ^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$ type: string LocationName: - description: Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + description: Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. + type: string + AvailabilityZoneName: + description: Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. + x-examples: + - us-east-1f type: string DataRedundancy: - description: Specifies the number of Availability Zone that's used for redundancy for the bucket. + description: Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. type: string enum: - SingleAvailabilityZone + - SingleLocalZone Arn: $ref: '#/components/schemas/Arn' description: Returns the Amazon Resource Name (ARN) of the specified bucket. x-examples: - arn:aws:s3express:us-west-2:123456789123:bucket/DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 + BucketEncryption: + $ref: '#/components/schemas/BucketEncryption' + LifecycleConfiguration: + $ref: '#/components/schemas/LifecycleConfiguration' + description: Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - LocationName - DataRedundancy x-stackql-resource-name: directory_bucket - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::S3Express::DirectoryBucket. + x-type-name: AWS::S3Express::DirectoryBucket + x-stackql-primary-identifier: - BucketName x-create-only-properties: - BucketName @@ -73,25 +759,299 @@ components: - DataRedundancy x-read-only-properties: - Arn + - AvailabilityZoneName + x-required-properties: + - LocationName + - DataRedundancy + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - s3express:TagResource + - s3express:UntagResource x-required-permissions: create: + - kms:GenerateDataKey + - kms:Decrypt - s3express:CreateBucket - s3express:ListAllMyDirectoryBuckets + - s3express:PutEncryptionConfiguration + - s3express:PutLifecycleConfiguration + - s3express:TagResource read: - s3express:ListAllMyDirectoryBuckets + - ec2:DescribeAvailabilityZones + - s3express:GetEncryptionConfiguration + - s3express:GetLifecycleConfiguration + - s3express:ListTagsForResource + update: + - kms:GenerateDataKey + - kms:Decrypt + - s3express:PutEncryptionConfiguration + - s3express:PutLifecycleConfiguration + - s3express:TagResource + - s3express:UntagResource delete: - s3express:DeleteBucket - s3express:ListAllMyDirectoryBuckets list: - s3express:ListAllMyDirectoryBuckets + CreateAccessPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name. For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (AWS Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. + type: string + pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ + minLength: 3 + maxLength: 50 + Bucket: + description: The name of the bucket that you want to associate this Access Point with. + type: string + minLength: 3 + maxLength: 255 + BucketAccountId: + description: The AWS account ID associated with the S3 bucket associated with this access point. + type: string + pattern: ^\d{12}$ + maxLength: 64 + VpcConfiguration: + description: If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). + $ref: '#/components/schemas/VpcConfiguration' + PublicAccessBlockConfiguration: + description: The PublicAccessBlock configuration that you want to apply to this Access Point. + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + Scope: + description: For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. + $ref: '#/components/schemas/Scope' + Policy: + description: The Access Point Policy you want to apply to this access point. + type: object + NetworkOrigin: + description: Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies. + type: string + enum: + - Internet + - VPC + Arn: + $ref: '#/components/schemas/Arn' + description: The Amazon Resource Name (ARN) of the specified accesspoint. + x-examples: + - arn:aws:s3express:us-west-2:123456789012:accesspoint/my-accesspoint--usw2-az1--xa-s3 + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAccessPointRequest + type: object + required: [] + CreateBucketPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Bucket: + description: The name of the S3 directory bucket to which the policy applies. + type: string + PolicyDocument: + description: A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + type: object + x-stackQL-stringOnly: true + x-title: CreateBucketPolicyRequest + type: object + required: [] + CreateDirectoryBucketRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BucketName: + description: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + maxLength: 63 + pattern: ^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$ + type: string + LocationName: + description: Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. + type: string + AvailabilityZoneName: + description: Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. + x-examples: + - us-east-1f + type: string + DataRedundancy: + description: Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. + type: string + enum: + - SingleAvailabilityZone + - SingleLocalZone + Arn: + $ref: '#/components/schemas/Arn' + description: Returns the Amazon Resource Name (ARN) of the specified bucket. + x-examples: + - arn:aws:s3express:us-west-2:123456789123:bucket/DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 + BucketEncryption: + $ref: '#/components/schemas/BucketEncryption' + LifecycleConfiguration: + $ref: '#/components/schemas/LifecycleConfiguration' + description: Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. + Tags: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDirectoryBucketRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - bucket_policies: - name: bucket_policies - id: awscc.s3express.bucket_policies - x-cfn-schema-name: BucketPolicy - x-type: list + access_points: + name: access_points + id: awscc.s3express.access_points + x-cfn-schema-name: AccessPoint + x-cfn-type-name: AWS::S3Express::AccessPoint x-identifiers: - - Bucket + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Bucket') as bucket, + JSON_EXTRACT(Properties, '$.BucketAccountId') as bucket_account_id, + JSON_EXTRACT(Properties, '$.VpcConfiguration') as vpc_configuration, + JSON_EXTRACT(Properties, '$.PublicAccessBlockConfiguration') as public_access_block_configuration, + JSON_EXTRACT(Properties, '$.Scope') as scope, + JSON_EXTRACT(Properties, '$.Policy') as policy, + JSON_EXTRACT(Properties, '$.NetworkOrigin') as network_origin, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::AccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'BucketAccountId') as bucket_account_id, + json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, + json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'NetworkOrigin') as network_origin, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::AccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + access_points_list_only: + name: access_points_list_only + id: awscc.s3express.access_points_list_only + x-cfn-schema-name: AccessPoint + x-cfn-type-name: AWS::S3Express::AccessPoint + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -99,28 +1059,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Bucket') as bucket - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::AccessPoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Bucket') as bucket - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::AccessPoint' AND region = 'us-east-1' - bucket_policy: - name: bucket_policy - id: awscc.s3express.bucket_policy + bucket_policies: + name: bucket_policies + id: awscc.s3express.bucket_policies x-cfn-schema-name: BucketPolicy - x-type: get + x-cfn-type-name: AWS::S3Express::BucketPolicy x-identifiers: - Bucket + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BucketPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -131,7 +1139,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -141,13 +1149,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' AND data__Identifier = '' AND region = 'us-east-1' - directory_buckets: - name: directory_buckets - id: awscc.s3express.directory_buckets - x-cfn-schema-name: DirectoryBucket - x-type: list + bucket_policies_list_only: + name: bucket_policies_list_only + id: awscc.s3express.bucket_policies_list_only + x-cfn-schema-name: BucketPolicy + x-cfn-type-name: AWS::S3Express::BucketPolicy x-identifiers: - - BucketName + - Bucket + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -155,49 +1169,415 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BucketName') as bucket_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' + JSON_EXTRACT(Properties, '$.Bucket') as bucket + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BucketName') as bucket_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' + json_extract_path_text(Properties, 'Bucket') as bucket + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' AND region = 'us-east-1' - directory_bucket: - name: directory_bucket - id: awscc.s3express.directory_bucket + directory_buckets: + name: directory_buckets + id: awscc.s3express.directory_buckets x-cfn-schema-name: DirectoryBucket - x-type: get + x-cfn-type-name: AWS::S3Express::DirectoryBucket x-identifiers: - BucketName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DirectoryBucket&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::DirectoryBucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::DirectoryBucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Express::DirectoryBucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/directory_buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/directory_buckets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/directory_buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.BucketName') as bucket_name, JSON_EXTRACT(Properties, '$.LocationName') as location_name, + JSON_EXTRACT(Properties, '$.AvailabilityZoneName') as availability_zone_name, JSON_EXTRACT(Properties, '$.DataRedundancy') as data_redundancy, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.BucketEncryption') as bucket_encryption, + JSON_EXTRACT(Properties, '$.LifecycleConfiguration') as lifecycle_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'BucketName') as bucket_name, json_extract_path_text(Properties, 'LocationName') as location_name, + json_extract_path_text(Properties, 'AvailabilityZoneName') as availability_zone_name, json_extract_path_text(Properties, 'DataRedundancy') as data_redundancy, - json_extract_path_text(Properties, 'Arn') as arn + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BucketEncryption') as bucket_encryption, + json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' AND data__Identifier = '' AND region = 'us-east-1' + directory_buckets_list_only: + name: directory_buckets_list_only + id: awscc.s3express.directory_buckets_list_only + x-cfn-schema-name: DirectoryBucket + x-cfn-type-name: AWS::S3Express::DirectoryBucket + x-identifiers: + - BucketName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.BucketName') as bucket_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BucketName') as bucket_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BucketPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBucketPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBucketPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DirectoryBucket&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDirectoryBucket + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDirectoryBucketRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/s3objectlambda.yaml b/providers/src/awscc/v00.00.00000/services/s3objectlambda.yaml index ec783d20..6ee4cb6f 100644 --- a/providers/src/awscc/v00.00.00000/services/s3objectlambda.yaml +++ b/providers/src/awscc/v00.00.00000/services/s3objectlambda.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: S3ObjectLambda - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: PublicAccessBlockConfiguration: type: object @@ -141,7 +521,9 @@ components: required: - ObjectLambdaConfiguration x-stackql-resource-name: access_point - x-stackql-primaryIdentifier: + description: The AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions + x-type-name: AWS::S3ObjectLambda::AccessPoint + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -154,6 +536,10 @@ components: - PolicyStatus/IsPublic - CreationDate - PublicAccessBlockConfiguration + x-required-properties: + - ObjectLambdaConfiguration + x-tagging: + taggable: false x-required-permissions: create: - s3:CreateAccessPointForObjectLambda @@ -190,10 +576,17 @@ components: - ObjectLambdaAccessPoint - PolicyDocument x-stackql-resource-name: access_point_policy - x-stackql-primaryIdentifier: + description: AWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda + x-type-name: AWS::S3ObjectLambda::AccessPointPolicy + x-stackql-primary-identifier: - ObjectLambdaAccessPoint x-create-only-properties: - ObjectLambdaAccessPoint + x-required-properties: + - ObjectLambdaAccessPoint + - PolicyDocument + x-tagging: + taggable: false x-required-permissions: create: - s3:PutAccessPointPolicyForObjectLambda @@ -206,43 +599,138 @@ components: delete: - s3:DeleteAccessPointPolicyForObjectLambda - s3:GetAccessPointPolicyForObjectLambda + CreateAccessPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this Object lambda Access Point. + type: string + pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ + minLength: 3 + maxLength: 45 + Alias: + $ref: '#/components/schemas/Alias' + Arn: + type: string + pattern: arn:[^:]+:s3-object-lambda:[^:]*:\d{12}:accesspoint/.* + CreationDate: + description: The date and time when the Object lambda Access Point was created. + type: string + PublicAccessBlockConfiguration: + description: The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. + $ref: '#/components/schemas/PublicAccessBlockConfiguration' + PolicyStatus: + $ref: '#/components/schemas/PolicyStatus' + ObjectLambdaConfiguration: + description: The Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions + $ref: '#/components/schemas/ObjectLambdaConfiguration' + x-stackQL-stringOnly: true + x-title: CreateAccessPointRequest + type: object + required: [] + CreateAccessPointPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ObjectLambdaAccessPoint: + description: The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies. + type: string + pattern: ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$ + minLength: 3 + maxLength: 45 + PolicyDocument: + description: 'A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. ' + type: object + x-stackQL-stringOnly: true + x-title: CreateAccessPointPolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_points: name: access_points id: awscc.s3objectlambda.access_points x-cfn-schema-name: AccessPoint - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: awscc.s3objectlambda.access_point - x-cfn-schema-name: AccessPoint - x-type: get + x-cfn-type-name: AWS::S3ObjectLambda::AccessPoint x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3ObjectLambda::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3ObjectLambda::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3ObjectLambda::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -258,7 +746,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -273,17 +761,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' AND data__Identifier = '' AND region = 'us-east-1' - access_point_policy: - name: access_point_policy - id: awscc.s3objectlambda.access_point_policy + access_points_list_only: + name: access_points_list_only + id: awscc.s3objectlambda.access_points_list_only + x-cfn-schema-name: AccessPoint + x-cfn-type-name: AWS::S3ObjectLambda::AccessPoint + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' + AND region = 'us-east-1' + access_point_policies: + name: access_point_policies + id: awscc.s3objectlambda.access_point_policies x-cfn-schema-name: AccessPointPolicy - x-type: get + x-cfn-type-name: AWS::S3ObjectLambda::AccessPointPolicy x-identifiers: - ObjectLambdaAccessPoint + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPointPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3ObjectLambda::AccessPointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3ObjectLambda::AccessPointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3ObjectLambda::AccessPointPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -294,7 +861,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -304,3 +871,240 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPointPolicy' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPointPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPointPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPointPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/s3outposts.yaml b/providers/src/awscc/v00.00.00000/services/s3outposts.yaml index e2b56af3..c364d405 100644 --- a/providers/src/awscc/v00.00.00000/services/s3outposts.yaml +++ b/providers/src/awscc/v00.00.00000/services/s3outposts.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: S3Outposts - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: VpcConfiguration: type: object @@ -46,7 +426,9 @@ components: - Name - VpcConfiguration x-stackql-resource-name: access_point - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::S3Outposts::AccessPoint + x-type-name: AWS::S3Outposts::AccessPoint + x-stackql-primary-identifier: - Arn x-create-only-properties: - Bucket @@ -54,6 +436,15 @@ components: - VpcConfiguration x-read-only-properties: - Arn + x-required-properties: + - Bucket + - Name + - VpcConfiguration + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - s3-outposts:CreateAccessPoint @@ -245,13 +636,28 @@ components: - BucketName - OutpostId x-stackql-resource-name: bucket - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::S3Outposts::Bucket + x-type-name: AWS::S3Outposts::Bucket + x-stackql-primary-identifier: - Arn x-create-only-properties: - BucketName - OutpostId x-read-only-properties: - Arn + x-required-properties: + - BucketName + - OutpostId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - s3-outposts:DeleteBucketTagging + - s3-outposts:PutBucketTagging + - s3-outposts:GetBucketTagging x-required-permissions: create: - s3-outposts:CreateBucket @@ -285,10 +691,20 @@ components: - Bucket - PolicyDocument x-stackql-resource-name: bucket_policy - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::S3Outposts::BucketPolicy + x-type-name: AWS::S3Outposts::BucketPolicy + x-stackql-primary-identifier: - Bucket x-create-only-properties: - Bucket + x-required-properties: + - Bucket + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - s3-outposts:PutBucketPolicy @@ -395,7 +811,9 @@ components: - SecurityGroupId - SubnetId x-stackql-resource-name: endpoint - x-stackql-primaryIdentifier: + description: Resource Type Definition for AWS::S3Outposts::Endpoint + x-type-name: AWS::S3Outposts::Endpoint + x-stackql-primary-identifier: - Arn x-create-only-properties: - OutpostId @@ -410,6 +828,15 @@ components: - Id - NetworkInterfaces - Status + x-required-properties: + - OutpostId + - SecurityGroupId + - SubnetId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - s3-outposts:CreateEndpoint @@ -419,43 +846,265 @@ components: - s3-outposts:DeleteEndpoint list: - s3-outposts:ListEndpoints + CreateAccessPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the specified AccessPoint. + maxLength: 2048 + minLength: 20 + pattern: ^arn:[^:]+:s3-outposts:[a-zA-Z0-9\-]+:\d{12}:outpost\/[^:]+\/accesspoint\/[^:]+$ + type: string + Bucket: + description: The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with. + maxLength: 2048 + minLength: 20 + pattern: ^arn:[^:]+:s3-outposts:[a-zA-Z0-9\-]+:\d{12}:outpost\/[^:]+\/bucket\/[^:]+$ + type: string + Name: + description: A name for the AccessPoint. + maxLength: 50 + minLength: 3 + pattern: ^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$ + type: string + VpcConfiguration: + description: Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint. + $ref: '#/components/schemas/VpcConfiguration' + Policy: + description: The access point policy associated with this access point. + type: object + x-stackQL-stringOnly: true + x-title: CreateAccessPointRequest + type: object + required: [] + CreateBucketRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the specified bucket. + maxLength: 2048 + minLength: 20 + pattern: ^arn:[^:]+:s3-outposts:[a-zA-Z0-9\-]+:\d{12}:outpost\/[^:]+\/bucket\/[^:]+$ + type: string + BucketName: + description: A name for the bucket. + maxLength: 63 + minLength: 3 + pattern: (?=^.{3,63}$)(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$) + type: string + OutpostId: + description: The id of the customer outpost on which the bucket resides. + pattern: ^(op-[a-f0-9]{17}|\d{12}|ec2)$ + type: string + Tags: + description: An arbitrary set of tags (key-value pairs) for this S3Outposts bucket. + items: + $ref: '#/components/schemas/Tag' + type: array + x-insertionOrder: false + uniqueItems: true + LifecycleConfiguration: + description: Rules that define how Amazon S3Outposts manages objects during their lifetime. + $ref: '#/components/schemas/LifecycleConfiguration' + x-stackQL-stringOnly: true + x-title: CreateBucketRequest + type: object + required: [] + CreateBucketPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Bucket: + description: The Amazon Resource Name (ARN) of the specified bucket. + maxLength: 2048 + minLength: 20 + pattern: ^arn:[^:]+:s3-outposts:[a-zA-Z0-9\-]+:\d{12}:outpost\/[^:]+\/bucket\/[^:]+$ + type: string + PolicyDocument: + description: A policy document containing permissions to add to the specified bucket. + type: object + x-stackQL-stringOnly: true + x-title: CreateBucketPolicyRequest + type: object + required: [] + CreateEndpointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the endpoint. + minLength: 5 + maxLength: 500 + type: string + pattern: ^arn:[^:]+:s3-outposts:[a-zA-Z0-9\-]+:\d{12}:outpost\/[^:]+\/endpoint/[a-zA-Z0-9]{19}$ + CidrBlock: + description: The VPC CIDR committed by this endpoint. + minLength: 1 + maxLength: 20 + type: string + CreationTime: + description: The time the endpoint was created. + $ref: '#/components/schemas/iso8601UTC' + Id: + description: The ID of the endpoint. + minLength: 5 + maxLength: 500 + type: string + pattern: ^[a-zA-Z0-9]{19}$ + NetworkInterfaces: + description: The network interfaces of the endpoint. + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/NetworkInterface' + OutpostId: + description: The id of the customer outpost on which the bucket resides. + pattern: ^(op-[a-f0-9]{17}|\d{12}|ec2)$ + type: string + SecurityGroupId: + description: The ID of the security group to use with the endpoint. + minLength: 1 + maxLength: 100 + type: string + pattern: ^sg-([0-9a-f]{8}|[0-9a-f]{17})$ + Status: + type: string + enum: + - Available + - Pending + - Deleting + - Create_Failed + - Delete_Failed + SubnetId: + description: The ID of the subnet in the selected VPC. The subnet must belong to the Outpost. + minLength: 1 + maxLength: 100 + type: string + pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$ + AccessType: + description: The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool. + type: string + enum: + - CustomerOwnedIp + - Private + default: Private + CustomerOwnedIpv4Pool: + description: The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint. + type: string + pattern: ^ipv4pool-coip-([0-9a-f]{17})$ + FailedReason: + description: The failure reason, if any, for a create or delete endpoint operation. + $ref: '#/components/schemas/FailedReason' + x-stackQL-stringOnly: true + x-title: CreateEndpointRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_points: name: access_points id: awscc.s3outposts.access_points x-cfn-schema-name: AccessPoint - x-type: list + x-cfn-type-name: AWS::S3Outposts::AccessPoint x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::AccessPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: awscc.s3outposts.access_point - x-cfn-schema-name: AccessPoint - x-type: get - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -469,7 +1118,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -482,13 +1131,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' AND data__Identifier = '' AND region = 'us-east-1' - buckets: - name: buckets - id: awscc.s3outposts.buckets - x-cfn-schema-name: Bucket - x-type: list + access_points_list_only: + name: access_points_list_only + id: awscc.s3outposts.access_points_list_only + x-cfn-schema-name: AccessPoint + x-cfn-type-name: AWS::S3Outposts::AccessPoint x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -497,7 +1152,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -505,19 +1160,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' AND region = 'us-east-1' - bucket: - name: bucket - id: awscc.s3outposts.bucket + buckets: + name: buckets + id: awscc.s3outposts.buckets x-cfn-schema-name: Bucket - x-type: get + x-cfn-type-name: AWS::S3Outposts::Bucket x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Bucket&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::Bucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -531,7 +1234,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -544,13 +1247,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::Bucket' AND data__Identifier = '' AND region = 'us-east-1' - bucket_policy: - name: bucket_policy - id: awscc.s3outposts.bucket_policy - x-cfn-schema-name: BucketPolicy - x-type: get + buckets_list_only: + name: buckets_list_only + id: awscc.s3outposts.buckets_list_only + x-cfn-schema-name: Bucket + x-cfn-type-name: AWS::S3Outposts::Bucket x-identifiers: - - Bucket + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -558,59 +1267,142 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Bucket') as bucket, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::BucketPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Bucket') as bucket, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::BucketPolicy' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' AND region = 'us-east-1' - endpoints: - name: endpoints - id: awscc.s3outposts.endpoints - x-cfn-schema-name: Endpoint - x-type: list + bucket_policies: + name: bucket_policies + id: awscc.s3outposts.bucket_policies + x-cfn-schema-name: BucketPolicy + x-cfn-type-name: AWS::S3Outposts::BucketPolicy x-identifiers: - - Arn + - Bucket + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BucketPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::BucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' + data__Identifier, + JSON_EXTRACT(Properties, '$.Bucket') as bucket, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::BucketPolicy' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' + data__Identifier, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::BucketPolicy' + AND data__Identifier = '' AND region = 'us-east-1' - endpoint: - name: endpoint - id: awscc.s3outposts.endpoint + endpoints: + name: endpoints + id: awscc.s3outposts.endpoints x-cfn-schema-name: Endpoint - x-type: get + x-cfn-type-name: AWS::S3Outposts::Endpoint x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Endpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Outposts::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -631,7 +1423,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -651,3 +1443,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' AND data__Identifier = '' AND region = 'us-east-1' + endpoints_list_only: + name: endpoints_list_only + id: awscc.s3outposts.endpoints_list_only + x-cfn-schema-name: Endpoint + x-cfn-type-name: AWS::S3Outposts::Endpoint + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Bucket&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBucket + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBucketRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BucketPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBucketPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBucketPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Endpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/s3tables.yaml b/providers/src/awscc/v00.00.00000/services/s3tables.yaml new file mode 100644 index 00000000..42d11125 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/s3tables.yaml @@ -0,0 +1,1670 @@ +openapi: 3.0.0 +info: + title: S3Tables + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + TableBucketARN: + description: The Amazon Resource Name (ARN) of the specified table bucket. + type: string + x-examples: + - arn:aws:s3tables:us-west-2:123456789012:bucket/mytablebucket + Namespace: + description: The namespace that the table belongs to. + type: string + WithoutMetadata: + description: Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to 'IcebergMetadata', and its only possible value is 'Yes'. + type: string + enum: + - 'Yes' + Compaction: + description: Settings governing the Compaction maintenance action. Contains details about the compaction settings for an Iceberg table. + additionalProperties: false + type: object + properties: + Status: + description: Indicates whether the Compaction maintenance action is enabled. + type: string + enum: + - enabled + - disabled + TargetFileSizeMB: + description: The target file size for the table in MB. + type: integer + minimum: 64 + SchemaField: + description: Contains details about the schema for an Iceberg table + additionalProperties: false + type: object + properties: + Type: + description: The field type + type: string + Required: + description: A Boolean value that specifies whether values are required for each row in this field + type: boolean + Name: + description: The name of the field + type: string + required: + - Name + - Type + TableName: + description: The name for the table. + type: string + IcebergSchema: + description: Contains details about the schema for an Iceberg table + additionalProperties: false + type: object + properties: + SchemaFieldList: + $ref: '#/components/schemas/SchemaFieldList' + required: + - SchemaFieldList + SchemaFieldList: + description: Contains details about the schema for an Iceberg table + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/SchemaField' + VersionToken: + description: The version token of the table + type: string + TableARN: + description: The Amazon Resource Name (ARN) of the specified table. + type: string + x-examples: + - arn:aws:s3tables:us-west-2:123456789012:bucket/mytablebucket/table/813aadd1-a378-4d0f-8467-e3247306f309 + OpenTableFormat: + description: Format of the table. + type: string + enum: + - ICEBERG + IcebergMetadata: + description: Contains details about the metadata for an Iceberg table. + additionalProperties: false + type: object + properties: + IcebergSchema: + $ref: '#/components/schemas/IcebergSchema' + required: + - IcebergSchema + WarehouseLocation: + description: The warehouse location of the table. + type: string + SnapshotManagement: + description: Contains details about the snapshot management settings for an Iceberg table. A snapshot is expired when it exceeds MinSnapshotsToKeep and MaxSnapshotAgeHours. + additionalProperties: false + type: object + properties: + Status: + description: Indicates whether the SnapshotManagement maintenance action is enabled. + type: string + enum: + - enabled + - disabled + MinSnapshotsToKeep: + description: The minimum number of snapshots to keep. + type: integer + minimum: 1 + MaxSnapshotAgeHours: + description: The maximum age of a snapshot before it can be expired. + type: integer + minimum: 1 + Table: + type: object + properties: + WithoutMetadata: + $ref: '#/components/schemas/WithoutMetadata' + Compaction: + $ref: '#/components/schemas/Compaction' + Namespace: + $ref: '#/components/schemas/Namespace' + TableName: + $ref: '#/components/schemas/TableName' + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + VersionToken: + $ref: '#/components/schemas/VersionToken' + TableARN: + $ref: '#/components/schemas/TableARN' + OpenTableFormat: + $ref: '#/components/schemas/OpenTableFormat' + IcebergMetadata: + $ref: '#/components/schemas/IcebergMetadata' + WarehouseLocation: + $ref: '#/components/schemas/WarehouseLocation' + SnapshotManagement: + $ref: '#/components/schemas/SnapshotManagement' + required: + - TableBucketARN + - Namespace + - TableName + - OpenTableFormat + x-stackql-resource-name: table + description: Resource Type definition for AWS::S3Tables::Table + x-type-name: AWS::S3Tables::Table + x-stackql-primary-identifier: + - TableARN + x-create-only-properties: + - TableBucketARN + - OpenTableFormat + - IcebergMetadata + - WithoutMetadata + x-write-only-properties: + - IcebergMetadata + - WithoutMetadata + x-read-only-properties: + - TableARN + - WarehouseLocation + - VersionToken + x-required-properties: + - TableBucketARN + - Namespace + - TableName + - OpenTableFormat + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - s3tables:GetTable + - s3tables:GetTableMaintenanceConfiguration + create: + - s3tables:CreateTable + - s3tables:PutTableData + - s3tables:GetTable + - s3tables:PutTableMaintenanceConfiguration + update: + - s3tables:GetTable + - s3tables:RenameTable + - s3tables:PutTableMaintenanceConfiguration + list: + - s3tables:ListTables + - s3tables:ListTableBuckets + - s3tables:ListNamespaces + delete: + - s3tables:GetTable + - s3tables:DeleteTable + TableBucketName: + description: A name for the table bucket. + type: string + minLength: 3 + maxLength: 63 + UnreferencedFileRemoval: + description: Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + additionalProperties: false + type: object + properties: + Status: + description: Indicates whether the Unreferenced File Removal maintenance action is enabled. + type: string + enum: + - Enabled + - Disabled + UnreferencedDays: + description: For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + type: integer + minimum: 1 + NoncurrentDays: + description: S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + type: integer + minimum: 1 + EncryptionConfiguration: + type: object + description: Specifies encryption settings for the table bucket + properties: + SSEAlgorithm: + type: string + description: Server-side encryption algorithm + enum: + - AES256 + - aws:kms + KMSKeyArn: + type: string + description: ARN of the KMS key to use for encryption + additionalProperties: false + TableBucket: + type: object + properties: + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + TableBucketName: + $ref: '#/components/schemas/TableBucketName' + UnreferencedFileRemoval: + $ref: '#/components/schemas/UnreferencedFileRemoval' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + required: + - TableBucketName + x-stackql-resource-name: table_bucket + description: Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + x-type-name: AWS::S3Tables::TableBucket + x-stackql-primary-identifier: + - TableBucketARN + x-create-only-properties: + - TableBucketName + x-read-only-properties: + - TableBucketARN + x-required-properties: + - TableBucketName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - s3tables:CreateTableBucket + - s3tables:PutTableBucketMaintenanceConfiguration + - s3tables:PutTableBucketEncryption + - s3tables:GetTableBucket + - s3tables:GetTableBucketMaintenanceConfiguration + - s3tables:GetTableBucketEncryption + - kms:DescribeKey + read: + - s3tables:GetTableBucket + - s3tables:GetTableBucketMaintenanceConfiguration + - s3tables:GetTableBucketEncryption + update: + - s3tables:PutTableBucketMaintenanceConfiguration + - s3tables:PutTableBucketEncryption + - s3tables:GetTableBucketMaintenanceConfiguration + - s3tables:GetTableBucketEncryption + - s3tables:DeleteTableBucketEncryption + - s3tables:GetTableBucket + - kms:DescribeKey + delete: + - s3tables:DeleteTableBucket + list: + - s3tables:ListTableBuckets + ResourcePolicy: + description: A policy document containing permissions to add to the specified table. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + type: object + TableBucketPolicy: + type: object + properties: + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + required: + - ResourcePolicy + - TableBucketARN + x-stackql-resource-name: table_bucket_policy + description: Applies an IAM resource policy to a table bucket. + x-type-name: AWS::S3Tables::TableBucketPolicy + x-stackql-primary-identifier: + - TableBucketARN + x-create-only-properties: + - TableBucketARN + x-required-properties: + - ResourcePolicy + - TableBucketARN + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - s3tables:GetTableBucket + - s3tables:GetTableBucketPolicy + - s3tables:PutTableBucketPolicy + read: + - s3tables:GetTableBucketPolicy + update: + - s3tables:GetTableBucketPolicy + - s3tables:PutTableBucketPolicy + delete: + - s3tables:GetTableBucketPolicy + - s3tables:DeleteTableBucketPolicy + list: + - s3tables:GetTableBucketPolicy + - s3tables:ListTableBuckets + TablePolicy: + type: object + properties: + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + TableName: + $ref: '#/components/schemas/TableName' + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + TableARN: + $ref: '#/components/schemas/TableARN' + Namespace: + $ref: '#/components/schemas/Namespace' + required: + - TableARN + - ResourcePolicy + x-stackql-resource-name: table_policy + description: Resource Type definition for AWS::S3Tables::TablePolicy + x-type-name: AWS::S3Tables::TablePolicy + x-stackql-primary-identifier: + - TableARN + x-create-only-properties: + - TableARN + x-read-only-properties: + - TableBucketARN + - Namespace + - TableName + x-required-properties: + - TableARN + - ResourcePolicy + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - s3tables:GetTablePolicy + - s3tables:PutTablePolicy + - s3tables:GetTable + read: + - s3tables:GetTable + - s3tables:GetTablePolicy + update: + - s3tables:GetTablePolicy + - s3tables:PutTablePolicy + - s3tables:GetTable + delete: + - s3tables:GetTablePolicy + - s3tables:DeleteTablePolicy + - s3tables:GetTable + list: + - s3tables:ListTables + - s3tables:GetTablePolicy + CreateTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WithoutMetadata: + $ref: '#/components/schemas/WithoutMetadata' + Compaction: + $ref: '#/components/schemas/Compaction' + Namespace: + $ref: '#/components/schemas/Namespace' + TableName: + $ref: '#/components/schemas/TableName' + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + VersionToken: + $ref: '#/components/schemas/VersionToken' + TableARN: + $ref: '#/components/schemas/TableARN' + OpenTableFormat: + $ref: '#/components/schemas/OpenTableFormat' + IcebergMetadata: + $ref: '#/components/schemas/IcebergMetadata' + WarehouseLocation: + $ref: '#/components/schemas/WarehouseLocation' + SnapshotManagement: + $ref: '#/components/schemas/SnapshotManagement' + x-stackQL-stringOnly: true + x-title: CreateTableRequest + type: object + required: [] + CreateTableBucketRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + TableBucketName: + $ref: '#/components/schemas/TableBucketName' + UnreferencedFileRemoval: + $ref: '#/components/schemas/UnreferencedFileRemoval' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + x-stackQL-stringOnly: true + x-title: CreateTableBucketRequest + type: object + required: [] + CreateTableBucketPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + x-stackQL-stringOnly: true + x-title: CreateTableBucketPolicyRequest + type: object + required: [] + CreateTablePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + TableName: + $ref: '#/components/schemas/TableName' + TableBucketARN: + $ref: '#/components/schemas/TableBucketARN' + TableARN: + $ref: '#/components/schemas/TableARN' + Namespace: + $ref: '#/components/schemas/Namespace' + x-stackQL-stringOnly: true + x-title: CreateTablePolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + tables: + name: tables + id: awscc.s3tables.tables + x-cfn-schema-name: Table + x-cfn-type-name: AWS::S3Tables::Table + x-identifiers: + - TableARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.WithoutMetadata') as without_metadata, + JSON_EXTRACT(Properties, '$.Compaction') as compaction, + JSON_EXTRACT(Properties, '$.Namespace') as namespace, + JSON_EXTRACT(Properties, '$.TableName') as table_name, + JSON_EXTRACT(Properties, '$.TableBucketARN') as table_bucket_arn, + JSON_EXTRACT(Properties, '$.VersionToken') as version_token, + JSON_EXTRACT(Properties, '$.TableARN') as table_arn, + JSON_EXTRACT(Properties, '$.OpenTableFormat') as open_table_format, + JSON_EXTRACT(Properties, '$.IcebergMetadata') as iceberg_metadata, + JSON_EXTRACT(Properties, '$.WarehouseLocation') as warehouse_location, + JSON_EXTRACT(Properties, '$.SnapshotManagement') as snapshot_management + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::Table' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WithoutMetadata') as without_metadata, + json_extract_path_text(Properties, 'Compaction') as compaction, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'TableBucketARN') as table_bucket_arn, + json_extract_path_text(Properties, 'VersionToken') as version_token, + json_extract_path_text(Properties, 'TableARN') as table_arn, + json_extract_path_text(Properties, 'OpenTableFormat') as open_table_format, + json_extract_path_text(Properties, 'IcebergMetadata') as iceberg_metadata, + json_extract_path_text(Properties, 'WarehouseLocation') as warehouse_location, + json_extract_path_text(Properties, 'SnapshotManagement') as snapshot_management + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::Table' + AND data__Identifier = '' + AND region = 'us-east-1' + tables_list_only: + name: tables_list_only + id: awscc.s3tables.tables_list_only + x-cfn-schema-name: Table + x-cfn-type-name: AWS::S3Tables::Table + x-identifiers: + - TableARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TableARN') as table_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::Table' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableARN') as table_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::Table' + AND region = 'us-east-1' + table_buckets: + name: table_buckets + id: awscc.s3tables.table_buckets + x-cfn-schema-name: TableBucket + x-cfn-type-name: AWS::S3Tables::TableBucket + x-identifiers: + - TableBucketARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TableBucket&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TableBucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TableBucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TableBucket" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/table_buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/table_buckets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/table_buckets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.TableBucketARN') as table_bucket_arn, + JSON_EXTRACT(Properties, '$.TableBucketName') as table_bucket_name, + JSON_EXTRACT(Properties, '$.UnreferencedFileRemoval') as unreferenced_file_removal, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::TableBucket' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TableBucketARN') as table_bucket_arn, + json_extract_path_text(Properties, 'TableBucketName') as table_bucket_name, + json_extract_path_text(Properties, 'UnreferencedFileRemoval') as unreferenced_file_removal, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::TableBucket' + AND data__Identifier = '' + AND region = 'us-east-1' + table_buckets_list_only: + name: table_buckets_list_only + id: awscc.s3tables.table_buckets_list_only + x-cfn-schema-name: TableBucket + x-cfn-type-name: AWS::S3Tables::TableBucket + x-identifiers: + - TableBucketARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TableBucketARN') as table_bucket_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::TableBucket' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableBucketARN') as table_bucket_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::TableBucket' + AND region = 'us-east-1' + table_bucket_policies: + name: table_bucket_policies + id: awscc.s3tables.table_bucket_policies + x-cfn-schema-name: TableBucketPolicy + x-cfn-type-name: AWS::S3Tables::TableBucketPolicy + x-identifiers: + - TableBucketARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TableBucketPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TableBucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TableBucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TableBucketPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/table_bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/table_bucket_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/table_bucket_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourcePolicy') as resource_policy, + JSON_EXTRACT(Properties, '$.TableBucketARN') as table_bucket_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::TableBucketPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, + json_extract_path_text(Properties, 'TableBucketARN') as table_bucket_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::TableBucketPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + table_bucket_policies_list_only: + name: table_bucket_policies_list_only + id: awscc.s3tables.table_bucket_policies_list_only + x-cfn-schema-name: TableBucketPolicy + x-cfn-type-name: AWS::S3Tables::TableBucketPolicy + x-identifiers: + - TableBucketARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TableBucketARN') as table_bucket_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::TableBucketPolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableBucketARN') as table_bucket_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::TableBucketPolicy' + AND region = 'us-east-1' + table_policies: + name: table_policies + id: awscc.s3tables.table_policies + x-cfn-schema-name: TablePolicy + x-cfn-type-name: AWS::S3Tables::TablePolicy + x-identifiers: + - TableARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TablePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TablePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TablePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3Tables::TablePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/table_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/table_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/table_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourcePolicy') as resource_policy, + JSON_EXTRACT(Properties, '$.TableName') as table_name, + JSON_EXTRACT(Properties, '$.TableBucketARN') as table_bucket_arn, + JSON_EXTRACT(Properties, '$.TableARN') as table_arn, + JSON_EXTRACT(Properties, '$.Namespace') as namespace + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::TablePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'TableBucketARN') as table_bucket_arn, + json_extract_path_text(Properties, 'TableARN') as table_arn, + json_extract_path_text(Properties, 'Namespace') as namespace + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::S3Tables::TablePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + table_policies_list_only: + name: table_policies_list_only + id: awscc.s3tables.table_policies_list_only + x-cfn-schema-name: TablePolicy + x-cfn-type-name: AWS::S3Tables::TablePolicy + x-identifiers: + - TableARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TableARN') as table_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::TablePolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableARN') as table_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::S3Tables::TablePolicy' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TableBucket&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTableBucket + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTableBucketRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TableBucketPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTableBucketPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTableBucketPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TablePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTablePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTablePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/sagemaker.yaml b/providers/src/awscc/v00.00.00000/services/sagemaker.yaml index cdc9721f..0cf9ed36 100644 --- a/providers/src/awscc/v00.00.00000/services/sagemaker.yaml +++ b/providers/src/awscc/v00.00.00000/services/sagemaker.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: SageMaker - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ResourceSpec: type: object @@ -86,6 +466,11 @@ components: description: The ARN of the image version created on the instance. maxLength: 256 pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$ + LifecycleConfigArn: + type: string + description: The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource. + maxLength: 256 + pattern: ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$ Tag: type: object additionalProperties: false @@ -147,13 +532,23 @@ components: minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} + BuiltInLifecycleConfigArn: + type: string + description: The lifecycle configuration that runs before the default lifecycle configuration. + maxLength: 256 + pattern: ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$ + RecoveryMode: + type: boolean + description: Indicates whether the application is launched in recovery mode. required: - AppName - AppType - DomainId - UserProfileName x-stackql-resource-name: app - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SageMaker::App + x-type-name: AWS::SageMaker::App + x-stackql-primary-identifier: - AppName - AppType - DomainId @@ -163,22 +558,48 @@ components: - AppType - DomainId - UserProfileName - - Tags - ResourceSpec x-read-only-properties: - AppArn + - BuiltInLifecycleConfigArn + x-required-properties: + - AppName + - AppType + - DomainId + - UserProfileName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags x-required-permissions: create: - sagemaker:CreateApp - sagemaker:DescribeApp + - sagemaker:AddTags + - sagemaker:ListTags read: - sagemaker:DescribeApp - sagemaker:DescribeApp + - sagemaker:ListTags + update: + - sagemaker:DescribeApp + - sagemaker:AddTags + - sagemaker:DeleteTags + - sagemaker:ListTags delete: - sagemaker:DeleteApp - sagemaker:DescribeApp + - sagemaker:DeleteTags + - sagemaker:ListTags list: - sagemaker:ListApps + - sagemaker:ListTags KernelGatewayImageConfig: type: object description: The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app. @@ -204,6 +625,14 @@ components: ContainerConfig: $ref: '#/components/schemas/ContainerConfig' description: The container configuration for a SageMaker image. + CodeEditorAppImageConfig: + type: object + description: The configuration for the kernels in a SageMaker image running as a CodeEditor app. + additionalProperties: false + properties: + ContainerConfig: + $ref: '#/components/schemas/ContainerConfig' + description: The container configuration for a SageMaker image. ContainerConfig: type: object description: The container configuration for a SageMaker image. @@ -320,6 +749,9 @@ components: JupyterLabAppImageConfig: $ref: '#/components/schemas/JupyterLabAppImageConfig' description: The JupyterLabAppImageConfig. + CodeEditorAppImageConfig: + $ref: '#/components/schemas/CodeEditorAppImageConfig' + description: The CodeEditorAppImageConfig. Tags: type: array description: A list of tags to apply to the AppImageConfig. @@ -331,2174 +763,5270 @@ components: required: - AppImageConfigName x-stackql-resource-name: app_image_config - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SageMaker::AppImageConfig + x-type-name: AWS::SageMaker::AppImageConfig + x-stackql-primary-identifier: - AppImageConfigName x-create-only-properties: - AppImageConfigName - - Tags x-read-only-properties: - AppImageConfigArn + x-required-properties: + - AppImageConfigName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags x-required-permissions: create: - sagemaker:CreateAppImageConfig - sagemaker:DescribeAppImageConfig + - sagemaker:AddTags + - sagemaker:ListTags read: - sagemaker:DescribeAppImageConfig + - sagemaker:ListTags update: - sagemaker:UpdateAppImageConfig - sagemaker:DescribeAppImageConfig + - sagemaker:AddTags + - sagemaker:DeleteTags + - sagemaker:ListTags delete: - sagemaker:DeleteAppImageConfig - sagemaker:DescribeAppImageConfig + - sagemaker:DeleteTags list: - sagemaker:ListAppImageConfigs - DataQualityBaselineConfig: - type: object + - sagemaker:ListTags + ClusterOrchestratorEksConfig: + description: Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to, additionalProperties: false - description: Baseline configuration used to validate that the data conforms to the specified constraints and statistics. + type: object properties: - BaseliningJobName: - $ref: '#/components/schemas/ProcessingJobName' - ConstraintsResource: - $ref: '#/components/schemas/ConstraintsResource' - StatisticsResource: - $ref: '#/components/schemas/StatisticsResource' - ConstraintsResource: + ClusterArn: + description: The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster + type: string + required: + - ClusterArn + RollingUpdatePolicy: type: object additionalProperties: false - description: The baseline constraints resource for a monitoring job. properties: - S3Uri: - description: The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against. - $ref: '#/components/schemas/S3Uri' - StatisticsResource: - type: object + MaximumBatchSize: + $ref: '#/components/schemas/CapacitySize' + description: Specifies the maximum batch size for each rolling update. + MaximumExecutionTimeoutInSeconds: + type: integer + description: The maximum time allowed for the rolling update, in seconds. + RollbackMaximumBatchSize: + $ref: '#/components/schemas/CapacitySize' + description: The maximum batch size for rollback during an update failure. + WaitIntervalInSeconds: + type: integer + description: The time to wait between steps during the rolling update, in seconds. + required: + - MaximumBatchSize + - WaitIntervalInSeconds + AlarmDetails: + description: The details of the alarm to monitor during the AMI update. additionalProperties: false - description: The baseline statistics resource for a monitoring job. + type: object properties: - S3Uri: - description: The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against. - $ref: '#/components/schemas/S3Uri' - S3Uri: - type: string - description: The Amazon S3 URI. - pattern: ^(https|s3)://([^/]+)/?(.*)$ - maxLength: 1024 - DataQualityAppSpecification: + AlarmName: + minLength: 1 + pattern: (?!\s*$).+ + description: The name of the alarm. + type: string + maxLength: 256 + required: + - AlarmName + ClusterInstanceStorageConfig: + oneOf: + - additionalProperties: false + type: object + properties: + EbsVolumeConfig: + $ref: '#/components/schemas/ClusterEbsVolumeConfig' + description: Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. + type: object + VpcConfig: + description: Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html type: object additionalProperties: false - description: Container image configuration object for the monitoring job. properties: - ContainerArguments: + SecurityGroupIds: + description: The VPC security group IDs, in the form 'sg-xxxxxxxx'. Specify the security groups for the VPC that is specified in the 'Subnets' field. type: array - description: An array of arguments for the container used to run the monitoring job. - maxItems: 50 + uniqueItems: false + x-insertionOrder: false + minItems: 0 + maxItems: 5 items: type: string - minLength: 1 - maxLength: 256 - ContainerEntrypoint: + minLength: 0 + maxLength: 32 + pattern: '[-0-9a-zA-Z]+' + Subnets: + description: The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see https://docs.aws.amazon.com/sagemaker/latest/dg/regions-quotas.html type: array - description: Specifies the entrypoint for a container used to run the monitoring job. - maxItems: 100 + uniqueItems: false + x-insertionOrder: false + minItems: 0 + maxItems: 16 items: type: string - minLength: 1 - maxLength: 256 - ImageUri: - type: string - description: The container image to be run by the monitoring job. - pattern: .* - maxLength: 255 - PostAnalyticsProcessorSourceUri: - description: An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers. - $ref: '#/components/schemas/S3Uri' - RecordPreprocessorSourceUri: - description: An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers - $ref: '#/components/schemas/S3Uri' - Environment: - type: object - additionalProperties: false - description: Sets the environment variables in the Docker container - x-patternProperties: - '[a-zA-Z_][a-zA-Z0-9_]*': - type: string - minLength: 1 - maxLength: 256 - '[\S\s]*': - type: string - maxLength: 256 + minLength: 0 + maxLength: 32 + pattern: '[-0-9a-zA-Z]+' required: - - ImageUri - DataQualityJobInput: - type: object + - SecurityGroupIds + - Subnets + ClusterRestrictedInstanceGroup: + description: Details of a restricted instance group in a SageMaker HyperPod cluster. additionalProperties: false - description: The inputs for a monitoring job. + type: object properties: - EndpointInput: - $ref: '#/components/schemas/EndpointInput' - BatchTransformInput: - $ref: '#/components/schemas/BatchTransformInput' - EndpointInput: - type: object - additionalProperties: false - description: The endpoint for a monitoring job. - properties: - EndpointName: - $ref: '#/components/schemas/EndpointName' - LocalPath: - type: string - description: Path to the filesystem where the endpoint data is available to the container. - pattern: .* - maxLength: 256 - S3DataDistributionType: - type: string - description: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated - enum: - - FullyReplicated - - ShardedByS3Key - S3InputMode: - type: string - description: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. - enum: - - Pipe - - File - ExcludeFeaturesAttribute: + OverrideVpcConfig: + $ref: '#/components/schemas/VpcConfig' + InstanceCount: + description: The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster. + type: integer + minimum: 0 + OnStartDeepHealthChecks: + $ref: '#/components/schemas/OnStartDeepHealthChecks' + EnvironmentConfig: + $ref: '#/components/schemas/EnvironmentConfig' + InstanceGroupName: + $ref: '#/components/schemas/InstanceGroupName' + InstanceStorageConfigs: + $ref: '#/components/schemas/ClusterInstanceStorageConfigs' + CurrentCount: + description: The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster. + type: integer + minimum: 0 + TrainingPlanArn: + minLength: 50 + pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$ + description: The Amazon Resource Name (ARN) of the training plan to use for this cluster restricted instance group. For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan. type: string - description: Indexes or names of the features to be excluded from analysis - maxLength: 100 + maxLength: 2048 + InstanceType: + $ref: '#/components/schemas/InstanceType' + ThreadsPerCore: + description: The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. + maximum: 2 + type: integer + minimum: 1 + ExecutionRole: + $ref: '#/components/schemas/ExecutionRole' required: - - EndpointName - - LocalPath - BatchTransformInput: + - ExecutionRole + - InstanceCount + - InstanceGroupName + - InstanceType + - EnvironmentConfig + AutoRollbackConfiguration: type: object additionalProperties: false - description: The batch transform input for a monitoring job. properties: - DataCapturedDestinationS3Uri: - type: string - description: A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data. - pattern: ^(https|s3)://([^/]+)/?(.*)$ - maxLength: 512 - DatasetFormat: - $ref: '#/components/schemas/DatasetFormat' - LocalPath: - type: string - description: Path to the filesystem where the endpoint data is available to the container. - pattern: .* - maxLength: 256 - S3DataDistributionType: - type: string - description: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated - enum: - - FullyReplicated - - ShardedByS3Key - S3InputMode: - type: string - description: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. - enum: - - Pipe - - File - ExcludeFeaturesAttribute: - type: string - description: Indexes or names of the features to be excluded from analysis - maxLength: 100 + Alarms: + type: array + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/Alarm' required: - - DataCapturedDestinationS3Uri - - DatasetFormat - - LocalPath - MonitoringOutputConfig: - type: object + - Alarms + ImageId: + minLength: 7 + pattern: ^ami-[0-9a-fA-F]{8,17}|default$ + description: AMI Id to be used for launching EC2 instances - HyperPodPublicAmiId or CustomAmiId + type: string + maxLength: 21 + CapacitySizeConfig: + description: The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances. additionalProperties: false - description: The output configuration for monitoring jobs. + type: object properties: - KmsKeyId: + Type: + pattern: INSTANCE_COUNT|CAPACITY_PERCENTAGE + description: Specifies whether SageMaker should process the update by amount or percentage of instances. type: string - description: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. - pattern: .* - maxLength: 2048 - MonitoringOutputs: - type: array - description: Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded. - minLength: 1 - maxLength: 1 - items: - $ref: '#/components/schemas/MonitoringOutput' + Value: + description: Specifies the amount or percentage of instances SageMaker updates at a time. + type: integer + minimum: 1 required: - - MonitoringOutputs - MonitoringOutput: + - Type + - Value + InstanceType: + description: The instance type of the instance group of a SageMaker HyperPod cluster. + type: string + ExecutionRole: + minLength: 20 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + description: The execution role for the instance group to assume. + type: string + maxLength: 2048 + DeepHealthCheckType: + description: The type of deep health check(s) to be performed on the instances in the SageMaker HyperPod cluster instance group. + type: string + enum: + - InstanceStress + - InstanceConnectivity + EnvironmentConfig: + description: The configuration for the restricted instance groups (RIG) environment. + additionalProperties: false type: object + properties: + FSxLustreConfig: + $ref: '#/components/schemas/FSxLustreConfig' + InstanceGroupName: + minLength: 1 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + description: The name of the instance group of a SageMaker HyperPod cluster. + type: string + maxLength: 63 + ClusterInstanceGroupsList: + minItems: 1 + description: The instance groups of the SageMaker HyperPod cluster. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ClusterInstanceGroup' + ClusterRestrictedInstanceGroupsList: + minItems: 1 + description: The restricted instance groups of the SageMaker HyperPod cluster. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ClusterRestrictedInstanceGroup' + Orchestrator: + description: Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster. additionalProperties: false - description: The output object for a monitoring job. + type: object properties: - S3Output: - $ref: '#/components/schemas/S3Output' + Eks: + $ref: '#/components/schemas/ClusterOrchestratorEksConfig' required: - - S3Output - S3Output: - type: object + - Eks + ClusterEbsVolumeConfig: + description: Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker. additionalProperties: false - description: Information about where and how to store the results of a monitoring job. + type: object properties: - LocalPath: + VolumeSizeInGB: + description: The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker. + maximum: 16384 + type: integer + minimum: 1 + VolumeKmsKeyId: + minLength: 0 + pattern: ^[a-zA-Z0-9:/_-]*$ type: string - description: The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data. - pattern: .* - maxLength: 256 - S3UploadMode: + maxLength: 2048 + RootVolume: + type: boolean + ClusterLifeCycleConfig: + description: The lifecycle configuration for a SageMaker HyperPod cluster. + additionalProperties: false + type: object + properties: + SourceS3Uri: + pattern: ^(https|s3)://([^/]+)/?(.*)$ + description: An Amazon S3 bucket path where your lifecycle scripts are stored. type: string - description: Whether to upload the results of the monitoring job continuously or after the job completes. - enum: - - Continuous - - EndOfJob - S3Uri: + maxLength: 1024 + OnCreate: + minLength: 1 + pattern: ^[\S\s]+$ + description: The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation. type: string - description: A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. - pattern: ^(https|s3)://([^/]+)/?(.*)$ - maxLength: 512 + maxLength: 128 required: - - LocalPath - - S3Uri - MonitoringResources: - type: object + - OnCreate + - SourceS3Uri + OnStartDeepHealthChecks: + description: Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/DeepHealthCheckType' + ClusterInstanceGroup: + description: Details of an instance group in a SageMaker HyperPod cluster. additionalProperties: false - description: Identifies the resources to deploy for a monitoring job. - properties: - ClusterConfig: - $ref: '#/components/schemas/ClusterConfig' - required: - - ClusterConfig - ClusterConfig: type: object - additionalProperties: false - description: Configuration for the cluster used to run model monitoring jobs. properties: - InstanceCount: - description: The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1. - type: integer - minimum: 1 - maximum: 100 - InstanceType: - description: The ML compute instance type for the processing job. + InstanceGroupName: + $ref: '#/components/schemas/InstanceGroupName' + InstanceStorageConfigs: + $ref: '#/components/schemas/ClusterInstanceStorageConfigs' + LifeCycleConfig: + $ref: '#/components/schemas/ClusterLifeCycleConfig' + TrainingPlanArn: + minLength: 50 + pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$ + description: The Amazon Resource Name (ARN) of the training plan to use for this cluster instance group. For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan. type: string - VolumeKmsKeyId: - description: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job. - type: string - minimum: 1 - maximum: 2048 - VolumeSizeInGB: - description: The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario. + maxLength: 2048 + ThreadsPerCore: + description: The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. + maximum: 2 type: integer minimum: 1 - maximum: 16384 + OverrideVpcConfig: + $ref: '#/components/schemas/VpcConfig' + InstanceCount: + description: The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster. + type: integer + minimum: 0 + OnStartDeepHealthChecks: + $ref: '#/components/schemas/OnStartDeepHealthChecks' + ImageId: + $ref: '#/components/schemas/ImageId' + CurrentCount: + description: The number of instances that are currently in the instance group of a SageMaker HyperPod cluster. + type: integer + minimum: 0 + ScheduledUpdateConfig: + $ref: '#/components/schemas/ScheduledUpdateConfig' + InstanceType: + $ref: '#/components/schemas/InstanceType' + ExecutionRole: + $ref: '#/components/schemas/ExecutionRole' required: + - ExecutionRole - InstanceCount + - InstanceGroupName - InstanceType - - VolumeSizeInGB - NetworkConfig: - type: object + - LifeCycleConfig + ClusterAutoScalingConfig: + description: Configuration for cluster auto-scaling additionalProperties: false - description: Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs. - properties: - EnableInterContainerTrafficEncryption: - description: Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. - type: boolean - EnableNetworkIsolation: - description: Whether to allow inbound and outbound network calls to and from the containers used for the processing job. - type: boolean - VpcConfig: - $ref: '#/components/schemas/VpcConfig' - VpcConfig: type: object + properties: + Mode: + description: The auto-scaling mode for the cluster + type: string + enum: + - Enable + - Disable + AutoScalerType: + default: Karpenter + description: The type of auto-scaler to use + type: string + enum: + - Karpenter + required: + - Mode + ScheduledUpdateConfig: + description: The configuration object of the schedule that SageMaker follows when updating the AMI. additionalProperties: false - description: Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. + type: object properties: - SecurityGroupIds: - description: The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. - type: array - minItems: 1 - maxItems: 5 - items: - type: string - maxLength: 32 - pattern: '[-0-9a-zA-Z]+' - Subnets: - description: The ID of the subnets in the VPC to which you want to connect to your monitoring jobs. - type: array - minItems: 1 - maxItems: 16 - items: - type: string - maxLength: 32 - pattern: '[-0-9a-zA-Z]+' + ScheduleExpression: + minLength: 1 + pattern: cron\((?:[0-5][0-9]|[0-9]|) (?:[01][0-9]|2[0-3]|[0-9]) (?:[1-9]|0[1-9]|[12][0-9]|3[01]|\?) (?:[1-9]|0[1-9]|1[0-2]|\*|\*/(?:[1-9]|1[0-2])|) (?:MON|TUE|WED|THU|FRI|SAT|SUN|[1-7]|\?|L|(?:[1-7]#[1-5])|(?:[1-7]L)) (?:20[2-9][0-9]|\*|)\) + description: A cron expression that specifies the schedule that SageMaker follows when updating the AMI. + type: string + maxLength: 256 + DeploymentConfig: + $ref: '#/components/schemas/DeploymentConfig' required: - - SecurityGroupIds - - Subnets - StoppingCondition: + - ScheduleExpression + ClusterInstanceStorageConfigs: + maxItems: 1 + description: The instance storage configuration for the instance group. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/ClusterInstanceStorageConfig' + DeploymentConfig: type: object additionalProperties: false - description: Specifies a time limit for how long the monitoring job is allowed to run. properties: - MaxRuntimeInSeconds: - description: The maximum runtime allowed in seconds. + AutoRollbackConfiguration: + $ref: '#/components/schemas/AutoRollbackConfig' + description: Configuration for automatic rollback if an error occurs during deployment. + BlueGreenUpdatePolicy: + $ref: '#/components/schemas/BlueGreenUpdatePolicy' + description: Configuration for blue-green update deployment policies. + RollingUpdatePolicy: + $ref: '#/components/schemas/RollingUpdatePolicy' + description: Configuration for rolling update deployment policies. + FSxLustreConfig: + description: Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster. + additionalProperties: false + type: object + properties: + SizeInGiB: + description: The storage capacity of the FSx for Lustre file system, specified in gibibytes (GiB). + maximum: 100800 type: integer - minimum: 1 - maximum: 86400 + minimum: 1200 + PerUnitStorageThroughput: + description: The throughput capacity of the FSx for Lustre file system, measured in MB/s per TiB of storage. + maximum: 1000 + type: integer + minimum: 125 required: - - MaxRuntimeInSeconds - EndpointName: - type: string - description: The name of the endpoint used to run the monitoring job. - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])* - maxLength: 63 - JobDefinitionName: - type: string - description: The name of the job definition. - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ - maxLength: 63 - ProcessingJobName: - type: string - description: The name of a processing job - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ - minLength: 1 - maxLength: 63 - DatasetFormat: - description: The dataset format of the data to monitor - type: object - properties: - Csv: - $ref: '#/components/schemas/Csv' - Json: - $ref: '#/components/schemas/Json' - Parquet: - $ref: '#/components/schemas/Parquet' - Csv: - description: The CSV format - type: object - properties: - Header: - description: A boolean flag indicating if given CSV has header - type: boolean - Json: - description: The Json format - type: object - properties: - Line: - description: A boolean flag indicating if it is JSON line format - type: boolean - Parquet: - description: A flag indicating if the dataset format is Parquet - type: boolean - DataQualityJobDefinition: + - SizeInGiB + - PerUnitStorageThroughput + Cluster: type: object properties: - JobDefinitionArn: - description: The Amazon Resource Name (ARN) of job definition. + ClusterArn: + pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$ + description: The Amazon Resource Name (ARN) of the HyperPod Cluster. type: string - minLength: 1 maxLength: 256 - JobDefinitionName: - $ref: '#/components/schemas/JobDefinitionName' - DataQualityBaselineConfig: - $ref: '#/components/schemas/DataQualityBaselineConfig' - DataQualityAppSpecification: - $ref: '#/components/schemas/DataQualityAppSpecification' - DataQualityJobInput: - $ref: '#/components/schemas/DataQualityJobInput' - DataQualityJobOutputConfig: - $ref: '#/components/schemas/MonitoringOutputConfig' - JobResources: - $ref: '#/components/schemas/MonitoringResources' - NetworkConfig: - $ref: '#/components/schemas/NetworkConfig' - EndpointName: - $ref: '#/components/schemas/EndpointName' - RoleArn: - description: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. + VpcConfig: + $ref: '#/components/schemas/VpcConfig' + NodeRecovery: + description: If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected. type: string - pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + enum: + - Automatic + - None + InstanceGroups: + $ref: '#/components/schemas/ClusterInstanceGroupsList' + RestrictedInstanceGroups: + $ref: '#/components/schemas/ClusterRestrictedInstanceGroupsList' + Orchestrator: + $ref: '#/components/schemas/Orchestrator' + ClusterRole: minLength: 20 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + description: The cluster role for the autoscaler to assume. + type: string maxLength: 2048 - StoppingCondition: - $ref: '#/components/schemas/StoppingCondition' - Tags: - type: array - maxItems: 50 - description: An array of key-value pairs to apply to this resource. - items: - $ref: '#/components/schemas/Tag' - CreationTime: - description: The time at which the job definition was created. + NodeProvisioningMode: + description: Determines the scaling strategy for the SageMaker HyperPod cluster. When set to 'Continuous', enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release. type: string - required: - - DataQualityAppSpecification - - DataQualityJobInput - - DataQualityJobOutputConfig - - JobResources - - RoleArn - x-stackql-resource-name: data_quality_job_definition - x-stackql-primaryIdentifier: - - JobDefinitionArn - x-create-only-properties: - - JobDefinitionName - - DataQualityAppSpecification - - DataQualityBaselineConfig - - DataQualityJobInput - - DataQualityJobOutputConfig - - JobResources - - NetworkConfig - - RoleArn - - StoppingCondition - - Tags - - EndpointName - x-read-only-properties: - - CreationTime - - JobDefinitionArn - x-required-permissions: - create: - - sagemaker:CreateDataQualityJobDefinition - - sagemaker:DescribeDataQualityJobDefinition - - sagemaker:AddTags - - iam:PassRole - delete: - - sagemaker:DeleteDataQualityJobDefinition - read: - - sagemaker:DescribeDataQualityJobDefinition - list: - - sagemaker:ListDataQualityJobDefinitions - - sagemaker:ListTags - Device: - type: object - properties: - DeviceFleetName: - description: The name of the edge device fleet + enum: + - Continuous + CreationTime: + description: The time at which the HyperPod cluster was created. type: string - pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$ + ClusterName: minLength: 1 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ + description: The name of the HyperPod Cluster. + type: string maxLength: 63 - Device: - description: The Edge Device you want to register against a device fleet - $ref: '#/components/schemas/Device' + FailureMessage: + description: The failure message of the HyperPod Cluster. + type: string + AutoScaling: + $ref: '#/components/schemas/ClusterAutoScalingConfig' + ClusterStatus: + description: The status of the HyperPod Cluster. + type: string + enum: + - Creating + - Deleting + - Failed + - InService + - RollingBack + - SystemUpdating + - Updating Tags: - description: Associate tags with the resource + maxItems: 50 + uniqueItems: true + description: Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging. + x-insertionOrder: false type: array items: $ref: '#/components/schemas/Tag' - required: - - DeviceFleetName - x-stackql-resource-name: device - x-stackql-primaryIdentifier: - - Device/DeviceName + required: [] + x-stackql-resource-name: cluster + description: Resource Type definition for AWS::SageMaker::Cluster + x-type-name: AWS::SageMaker::Cluster + x-stackql-primary-identifier: + - ClusterArn + x-stackql-additional-identifiers: + - - ClusterName x-create-only-properties: - - Device/DeviceName + - ClusterName + - VpcConfig + - Orchestrator + - InstanceGroups/*/OverrideVpcConfig + - InstanceGroups/*/ExecutionRole + - InstanceGroups/*/InstanceGroupName + - InstanceGroups/*/InstanceType + - InstanceGroups/*/ThreadsPerCore + - RestrictedInstanceGroups/*/OverrideVpcConfig + - RestrictedInstanceGroups/*/ExecutionRole + - RestrictedInstanceGroups/*/InstanceGroupName + - RestrictedInstanceGroups/*/InstanceType + - RestrictedInstanceGroups/*/ThreadsPerCore + x-read-only-properties: + - ClusterArn + - CreationTime + - ClusterStatus + - FailureMessage + - InstanceGroups/*/CurrentCount + - RestrictedInstanceGroups/*/CurrentCount + x-required-properties: [] + x-tagging: + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false x-required-permissions: - create: - - sagemaker:RegisterDevices read: - - sagemaker:DescribeDevice + - sagemaker:DescribeCluster + - sagemaker:ListTags + create: + - sagemaker:CreateCluster + - sagemaker:DescribeCluster + - sagemaker:UpdateClusterSoftware + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:BatchAddClusterNodes + - sagemaker:BatchDeleteClusterNodes + - eks:DescribeAccessEntry + - eks:DescribeCluster + - eks:CreateAccessEntry + - eks:DeleteAccessEntry + - eks:AssociateAccessPolicy + - iam:CreateServiceLinkedRole + - iam:PassRole + - kms:DescribeKey + - kms:CreateGrant + - ec2:DescribeImages + - ec2:DescribeSnapshots + - ec2:ModifyImageAttribute + - ec2:ModifySnapshotAttribute update: - - sagemaker:UpdateDevices + - sagemaker:UpdateCluster + - sagemaker:UpdateClusterSoftware + - sagemaker:DescribeCluster + - sagemaker:ListTags + - sagemaker:AddTags + - sagemaker:DeleteTags + - sagemaker:BatchAddClusterNodes + - sagemaker:BatchDeleteClusterNodes + - eks:DescribeAccessEntry + - eks:DescribeCluster + - eks:CreateAccessEntry + - eks:DeleteAccessEntry + - eks:AssociateAccessPolicy + - iam:PassRole + - kms:DescribeKey + - kms:CreateGrant + - sagemaker:BatchAddClusterNodes + - sagemaker:BatchDeleteClusterNodes + - ec2:DescribeImages + - ec2:DescribeSnapshots + - ec2:ModifyImageAttribute + - ec2:ModifySnapshotAttribute + list: + - sagemaker:ListClusters delete: - - sagemaker:DeregisterDevices - EdgeOutputConfig: + - sagemaker:DeleteCluster + - sagemaker:DescribeCluster + - eks:DescribeAccessEntry + - eks:DeleteAccessEntry + DataQualityBaselineConfig: type: object + additionalProperties: false + description: Baseline configuration used to validate that the data conforms to the specified constraints and statistics. properties: - S3OutputLocation: - description: The Amazon Simple Storage (S3) bucket URI - type: string - pattern: ^s3://([^/]+)/?(.*)$ - maxLength: 1024 - KmsKeyId: - description: The KMS key id used for encryption on the S3 bucket - type: string - pattern: '[a-zA-Z0-9:_-]+' - minLength: 1 - maxLength: 2048 - required: - - S3OutputLocation + BaseliningJobName: + $ref: '#/components/schemas/ProcessingJobName' + ConstraintsResource: + $ref: '#/components/schemas/ConstraintsResource' + StatisticsResource: + $ref: '#/components/schemas/StatisticsResource' + ConstraintsResource: + type: object additionalProperties: false - DeviceFleet: + description: The baseline constraints resource for a monitoring job. + properties: + S3Uri: + description: The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against. + $ref: '#/components/schemas/S3Uri' + StatisticsResource: type: object + additionalProperties: false + description: The baseline statistics resource for a monitoring job. properties: - Description: - description: Description for the edge device fleet - type: string - pattern: '[\S\s]+' - minLength: 0 - maxLength: 800 - DeviceFleetName: - description: The name of the edge device fleet - type: string - pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$ - minLength: 1 - maxLength: 63 - OutputConfig: - description: S3 bucket and an ecryption key id (if available) to store outputs for the fleet - $ref: '#/components/schemas/EdgeOutputConfig' - RoleArn: - description: Role associated with the device fleet - type: string - pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - minLength: 20 - maxLength: 2048 - Tags: - description: Associate tags with the resource - type: array - items: - $ref: '#/components/schemas/Tag' - required: - - DeviceFleetName - - OutputConfig - - RoleArn - x-stackql-resource-name: device_fleet - x-stackql-primaryIdentifier: - - DeviceFleetName - x-create-only-properties: - - DeviceFleetName - x-required-permissions: - create: - - sagemaker:CreateDeviceFleet - - iam:PassRole - read: - - sagemaker:DescribeDeviceFleet - update: - - sagemaker:UpdateDeviceFleet - - iam:PassRole - delete: - - sagemaker:DeleteDeviceFleet - UserSettings: + S3Uri: + description: The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against. + $ref: '#/components/schemas/S3Uri' + S3Uri: + type: string + description: The Amazon S3 URI. + pattern: ^(https|s3)://([^/]+)/?(.*)$ + maxLength: 1024 + DataQualityAppSpecification: type: object - description: A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called. additionalProperties: false + description: Container image configuration object for the monitoring job. properties: - ExecutionRole: - type: string - description: The user profile Amazon Resource Name (ARN). - minLength: 20 - maxLength: 2048 - pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - JupyterServerAppSettings: - $ref: '#/components/schemas/JupyterServerAppSettings' - description: The Jupyter server's app settings. - KernelGatewayAppSettings: - $ref: '#/components/schemas/KernelGatewayAppSettings' - description: The kernel gateway app settings. - RStudioServerProAppSettings: - $ref: '#/components/schemas/RStudioServerProAppSettings' - JupyterLabAppSettings: - $ref: '#/components/schemas/JupyterLabAppSettings' - SpaceStorageSettings: - $ref: '#/components/schemas/DefaultSpaceStorageSettings' - CodeEditorAppSettings: - $ref: '#/components/schemas/CodeEditorAppSettings' - DefaultLandingUri: - type: string - description: Defines which Amazon SageMaker application users are directed to by default. - maxLength: 1023 - StudioWebPortal: - type: string - description: Indicates whether the Studio experience is available to users. If not, users cannot access Studio. - enum: - - ENABLED - - DISABLED - CustomPosixUserConfig: - $ref: '#/components/schemas/CustomPosixUserConfig' - CustomFileSystemConfigs: - type: array - uniqueItems: true - minItems: 0 - maxItems: 2 - items: - $ref: '#/components/schemas/CustomFileSystemConfig' - SecurityGroups: + ContainerArguments: type: array - description: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. - uniqueItems: false - minItems: 0 - maxItems: 5 + description: An array of arguments for the container used to run the monitoring job. + maxItems: 50 items: type: string - maxLength: 32 - pattern: '[-0-9a-zA-Z]+' - SharingSettings: - $ref: '#/components/schemas/SharingSettings' - description: The sharing settings. - DefaultSpaceSettings: - type: object - description: A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called. - additionalProperties: false - properties: - ExecutionRole: - type: string - description: The execution role for the space. - minLength: 20 - maxLength: 2048 - pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - JupyterServerAppSettings: - $ref: '#/components/schemas/JupyterServerAppSettings' - description: The Jupyter server's app settings. - KernelGatewayAppSettings: - $ref: '#/components/schemas/KernelGatewayAppSettings' - description: The kernel gateway app settings. - SecurityGroups: + minLength: 1 + maxLength: 256 + ContainerEntrypoint: type: array - description: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. - uniqueItems: false - x-insertionOrder: false - minItems: 0 - maxItems: 5 + description: Specifies the entrypoint for a container used to run the monitoring job. + maxItems: 100 items: type: string - maxLength: 32 - pattern: '[-0-9a-zA-Z]+' + minLength: 1 + maxLength: 256 + ImageUri: + type: string + description: The container image to be run by the monitoring job. + pattern: .* + maxLength: 255 + PostAnalyticsProcessorSourceUri: + description: An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers. + $ref: '#/components/schemas/S3Uri' + RecordPreprocessorSourceUri: + description: An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers + $ref: '#/components/schemas/S3Uri' + Environment: + type: object + additionalProperties: false + description: Sets the environment variables in the Docker container + x-patternProperties: + '[a-zA-Z_][a-zA-Z0-9_]*': + type: string + minLength: 1 + maxLength: 256 + '[\S\s]*': + type: string + maxLength: 256 required: - - ExecutionRole - JupyterServerAppSettings: + - ImageUri + DataQualityJobInput: type: object - description: The JupyterServer app settings. additionalProperties: false + description: The inputs for a monitoring job. properties: - DefaultResourceSpec: - $ref: '#/components/schemas/ResourceSpec' - KernelGatewayAppSettings: + EndpointInput: + $ref: '#/components/schemas/EndpointInput' + BatchTransformInput: + $ref: '#/components/schemas/BatchTransformInput' + EndpointInput: type: object - description: The kernel gateway app settings. additionalProperties: false + description: The endpoint for a monitoring job. properties: - CustomImages: - type: array - description: A list of custom SageMaker images that are configured to run as a KernelGateway app. - uniqueItems: false - minItems: 0 - maxItems: 30 - items: - $ref: '#/components/schemas/CustomImage' - DefaultResourceSpec: - $ref: '#/components/schemas/ResourceSpec' - description: The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. - JupyterLabAppSettings: + EndpointName: + $ref: '#/components/schemas/EndpointName' + LocalPath: + type: string + description: Path to the filesystem where the endpoint data is available to the container. + pattern: .* + maxLength: 256 + S3DataDistributionType: + type: string + description: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated + enum: + - FullyReplicated + - ShardedByS3Key + S3InputMode: + type: string + description: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. + enum: + - Pipe + - File + ExcludeFeaturesAttribute: + type: string + description: Indexes or names of the features to be excluded from analysis + maxLength: 100 + required: + - EndpointName + - LocalPath + BatchTransformInput: type: object - description: The JupyterLab app settings. additionalProperties: false + description: The batch transform input for a monitoring job. properties: - DefaultResourceSpec: - $ref: '#/components/schemas/ResourceSpec' - description: The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. - LifecycleConfigArns: - type: array - description: A list of LifecycleConfigArns available for use with JupyterLab apps. - uniqueItems: false - minItems: 0 - maxItems: 30 - items: - $ref: '#/components/schemas/StudioLifecycleConfigArn' - CodeRepositories: - type: array - description: A list of CodeRepositories available for use with JupyterLab apps. - uniqueItems: false - minItems: 0 - maxItems: 30 - items: - $ref: '#/components/schemas/CodeRepository' - CustomImages: - type: array - description: A list of custom images available for use for JupyterLab apps - uniqueItems: false - minItems: 0 - maxItems: 30 - items: - $ref: '#/components/schemas/CustomImage' - CodeRepository: + DataCapturedDestinationS3Uri: + type: string + description: A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data. + pattern: ^(https|s3)://([^/]+)/?(.*)$ + maxLength: 512 + DatasetFormat: + $ref: '#/components/schemas/DatasetFormat' + LocalPath: + type: string + description: Path to the filesystem where the endpoint data is available to the container. + pattern: .* + maxLength: 256 + S3DataDistributionType: + type: string + description: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated + enum: + - FullyReplicated + - ShardedByS3Key + S3InputMode: + type: string + description: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. + enum: + - Pipe + - File + ExcludeFeaturesAttribute: + type: string + description: Indexes or names of the features to be excluded from analysis + maxLength: 100 + required: + - DataCapturedDestinationS3Uri + - DatasetFormat + - LocalPath + MonitoringOutputConfig: type: object additionalProperties: false + description: The output configuration for monitoring jobs. properties: - RepositoryUrl: + KmsKeyId: type: string - description: A CodeRepository (valid URL) to be used within Jupyter's Git extension. - maxLength: 256 - pattern: ^https://([.\-_a-zA-Z0-9]+/?){3,1016}$ + description: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. + pattern: .* + maxLength: 2048 + MonitoringOutputs: + type: array + description: Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded. + minLength: 1 + maxLength: 1 + items: + $ref: '#/components/schemas/MonitoringOutput' required: - - RepositoryUrl - DefaultSpaceStorageSettings: + - MonitoringOutputs + MonitoringOutput: type: object - description: Default storage settings for a space. additionalProperties: false + description: The output object for a monitoring job. properties: - DefaultEbsStorageSettings: - $ref: '#/components/schemas/DefaultEbsStorageSettings' - DefaultEbsStorageSettings: + S3Output: + $ref: '#/components/schemas/S3Output' + required: + - S3Output + S3Output: + description: Configuration for uploading output data to Amazon S3 from the processing container. type: object - description: Properties related to the Amazon Elastic Block Store volume. additionalProperties: false properties: - DefaultEbsVolumeSizeInGb: - description: Default size of the Amazon EBS volume in Gb - $ref: '#/components/schemas/SpaceEbsVolumeSizeInGb' - MaximumEbsVolumeSizeInGb: - description: Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb. - $ref: '#/components/schemas/SpaceEbsVolumeSizeInGb' + LocalPath: + description: The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked. + type: string + minLength: 0 + maxLength: 256 + pattern: .* + S3UploadMode: + description: Whether to upload the results of the processing job continuously or after the job completes. + type: string + enum: + - Continuous + - EndOfJob + S3Uri: + description: A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job. + type: string + minLength: 0 + maxLength: 1024 + pattern: (https|s3)://([^/]+)/?(.*) required: - - DefaultEbsVolumeSizeInGb - - MaximumEbsVolumeSizeInGb - SpaceEbsVolumeSizeInGb: - type: integer - minimum: 5 - maximum: 16384 - CodeEditorAppSettings: + - S3Uri + - S3UploadMode + MonitoringResources: type: object - description: The CodeEditor app settings. additionalProperties: false + description: Identifies the resources to deploy for a monitoring job. properties: - DefaultResourceSpec: - $ref: '#/components/schemas/ResourceSpec' - description: The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. - LifecycleConfigArns: - type: array - description: A list of LifecycleConfigArns available for use with CodeEditor apps. - uniqueItems: false - minItems: 0 - maxItems: 30 - items: - $ref: '#/components/schemas/StudioLifecycleConfigArn' - StudioLifecycleConfigArn: - type: string - description: The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource. - maxLength: 256 - pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.* - CustomPosixUserConfig: + ClusterConfig: + $ref: '#/components/schemas/ClusterConfig' + required: + - ClusterConfig + ClusterConfig: + description: Configuration for the cluster used to run a processing job. type: object additionalProperties: false properties: - Uid: + InstanceCount: + description: The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1. type: integer - minimum: 10000 - maximum: 4000000 - Gid: + minimum: 1 + maximum: 100 + InstanceType: + description: The ML compute instance type for the processing job. + type: string + enum: + - ml.t3.medium + - ml.t3.large + - ml.t3.xlarge + - ml.t3.2xlarge + - ml.m4.xlarge + - ml.m4.2xlarge + - ml.m4.4xlarge + - ml.m4.10xlarge + - ml.m4.16xlarge + - ml.c4.xlarge + - ml.c4.2xlarge + - ml.c4.4xlarge + - ml.c4.8xlarge + - ml.c5.xlarge + - ml.c5.2xlarge + - ml.c5.4xlarge + - ml.c5.9xlarge + - ml.c5.18xlarge + - ml.m5.large + - ml.m5.xlarge + - ml.m5.2xlarge + - ml.m5.4xlarge + - ml.m5.12xlarge + - ml.m5.24xlarge + - ml.r5.large + - ml.r5.xlarge + - ml.r5.2xlarge + - ml.r5.4xlarge + - ml.r5.8xlarge + - ml.r5.12xlarge + - ml.r5.16xlarge + - ml.r5.24xlarge + - ml.g4dn.xlarge + - ml.g4dn.2xlarge + - ml.g4dn.4xlarge + - ml.g4dn.8xlarge + - ml.g4dn.12xlarge + - ml.g4dn.16xlarge + - ml.g5.xlarge + - ml.g5.2xlarge + - ml.g5.4xlarge + - ml.g5.8xlarge + - ml.g5.16xlarge + - ml.g5.12xlarge + - ml.g5.24xlarge + - ml.g5.48xlarge + - ml.r5d.large + - ml.r5d.xlarge + - ml.r5d.2xlarge + - ml.r5d.4xlarge + - ml.r5d.8xlarge + - ml.r5d.12xlarge + - ml.r5d.16xlarge + - ml.r5d.24xlarge + - ml.g6.xlarge + - ml.g6.2xlarge + - ml.g6.4xlarge + - ml.g6.8xlarge + - ml.g6.12xlarge + - ml.g6.16xlarge + - ml.g6.24xlarge + - ml.g6.48xlarge + - ml.g6e.xlarge + - ml.g6e.2xlarge + - ml.g6e.4xlarge + - ml.g6e.8xlarge + - ml.g6e.12xlarge + - ml.g6e.16xlarge + - ml.g6e.24xlarge + - ml.g6e.48xlarge + - ml.m6i.large + - ml.m6i.xlarge + - ml.m6i.2xlarge + - ml.m6i.4xlarge + - ml.m6i.8xlarge + - ml.m6i.12xlarge + - ml.m6i.16xlarge + - ml.m6i.24xlarge + - ml.m6i.32xlarge + - ml.c6i.xlarge + - ml.c6i.2xlarge + - ml.c6i.4xlarge + - ml.c6i.8xlarge + - ml.c6i.12xlarge + - ml.c6i.16xlarge + - ml.c6i.24xlarge + - ml.c6i.32xlarge + - ml.m7i.large + - ml.m7i.xlarge + - ml.m7i.2xlarge + - ml.m7i.4xlarge + - ml.m7i.8xlarge + - ml.m7i.12xlarge + - ml.m7i.16xlarge + - ml.m7i.24xlarge + - ml.m7i.48xlarge + - ml.c7i.large + - ml.c7i.xlarge + - ml.c7i.2xlarge + - ml.c7i.4xlarge + - ml.c7i.8xlarge + - ml.c7i.12xlarge + - ml.c7i.16xlarge + - ml.c7i.24xlarge + - ml.c7i.48xlarge + - ml.r7i.large + - ml.r7i.xlarge + - ml.r7i.2xlarge + - ml.r7i.4xlarge + - ml.r7i.8xlarge + - ml.r7i.12xlarge + - ml.r7i.16xlarge + - ml.r7i.24xlarge + - ml.r7i.48xlarge + VolumeSizeInGB: + description: The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario. type: integer - minimum: 1001 - maximum: 4000000 + minimum: 1 + maximum: 16384 + VolumeKmsKeyId: + description: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job. + type: string + minLength: 0 + maxLength: 2048 + pattern: '[a-zA-Z0-9:/_-]*' required: - - Uid - - Gid - CustomFileSystemConfig: + - InstanceCount + - InstanceType + - VolumeSizeInGB + NetworkConfig: + description: Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs. type: object additionalProperties: false properties: - EFSFileSystemConfig: - $ref: '#/components/schemas/EFSFileSystemConfig' - EFSFileSystemConfig: + EnableInterContainerTrafficEncryption: + description: Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. + type: boolean + EnableNetworkIsolation: + description: Whether to allow inbound and outbound network calls to and from the containers used for the processing job. + type: boolean + VpcConfig: + $ref: '#/components/schemas/VpcConfig' + StoppingCondition: + description: Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped. type: object additionalProperties: false properties: - FileSystemPath: - type: string - pattern: ^\/\S*$ - minLength: 1 - maxLength: 256 - FileSystemId: - type: string - minLength: 11 - maxLength: 21 - pattern: ^(fs-[0-9a-f]{8,})$ + MaxRuntimeInSeconds: + description: Specifies the maximum runtime in seconds. + type: integer + minimum: 1 + maximum: 777600 required: - - FileSystemId - CustomImage: + - MaxRuntimeInSeconds + EndpointName: + type: string + description: The name of the endpoint used to run the monitoring job. + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])* + maxLength: 63 + JobDefinitionName: + type: string + description: The name of the job definition. + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + maxLength: 63 + ProcessingJobName: + type: string + description: The name of a processing job + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + minLength: 1 + maxLength: 63 + DatasetFormat: + description: The dataset format of the data to monitor type: object - description: A custom SageMaker image. - additionalProperties: false properties: - AppImageConfigName: - type: string - description: The Name of the AppImageConfig. - maxLength: 63 - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - ImageName: - type: string - description: The name of the CustomImage. Must be unique to your account. - maxLength: 63 - pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$ - ImageVersionNumber: - type: integer - description: The version number of the CustomImage. - minimum: 0 - required: - - AppImageConfigName - - ImageName - SharingSettings: + Csv: + $ref: '#/components/schemas/Csv' + Json: + $ref: '#/components/schemas/Json' + Parquet: + $ref: '#/components/schemas/Parquet' + Csv: + description: The CSV format type: object - description: Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. - additionalProperties: false properties: - NotebookOutputOption: - type: string - description: Whether to include the notebook cell output when sharing the notebook. The default is Disabled. - enum: - - Allowed - - Disabled - S3KmsKeyId: - type: string - description: When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - maxLength: 2048 - pattern: .* - S3OutputPath: - type: string - description: When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots. - maxLength: 1024 - pattern: ^(https|s3)://([^/]+)/?(.*)$ - DomainSettings: + Header: + description: A boolean flag indicating if given CSV has header + type: boolean + Json: + description: The Json format type: object - description: A collection of Domain settings. - additionalProperties: false properties: - SecurityGroupIds: - type: array - description: The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps. - uniqueItems: false - x-insertionOrder: false - minItems: 1 - maxItems: 3 - items: - type: string - maxLength: 32 - pattern: '[-0-9a-zA-Z]+' - RStudioServerProDomainSettings: - $ref: '#/components/schemas/RStudioServerProDomainSettings' - DockerSettings: - $ref: '#/components/schemas/DockerSettings' - DockerSettings: + Line: + description: A boolean flag indicating if it is JSON line format + type: boolean + Parquet: + description: A flag indicating if the dataset format is Parquet + type: boolean + DataQualityJobDefinition: type: object - description: A collection of settings that are required to start docker-proxy server. - additionalProperties: false properties: - EnableDockerAccess: + JobDefinitionArn: + description: The Amazon Resource Name (ARN) of job definition. type: string - description: The flag to enable/disable docker-proxy server - enum: - - ENABLED - - DISABLED - VpcOnlyTrustedAccounts: - type: array - description: A list of account id's that would be used to pull images from in VpcOnly mode - uniqueItems: false - x-insertionOrder: false - minItems: 0 - maxItems: 10 - items: - type: string - maxLength: 12 - pattern: ^[0-9]$ - RStudioServerProDomainSettings: - type: object - description: A collection of settings that update the current configuration for the RStudioServerPro Domain-level app. - additionalProperties: false - properties: - DomainExecutionRoleArn: + minLength: 1 + maxLength: 256 + JobDefinitionName: + $ref: '#/components/schemas/JobDefinitionName' + DataQualityBaselineConfig: + $ref: '#/components/schemas/DataQualityBaselineConfig' + DataQualityAppSpecification: + $ref: '#/components/schemas/DataQualityAppSpecification' + DataQualityJobInput: + $ref: '#/components/schemas/DataQualityJobInput' + DataQualityJobOutputConfig: + $ref: '#/components/schemas/MonitoringOutputConfig' + JobResources: + $ref: '#/components/schemas/MonitoringResources' + NetworkConfig: + $ref: '#/components/schemas/NetworkConfig' + EndpointName: + $ref: '#/components/schemas/EndpointName' + RoleArn: + description: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. type: string - description: The ARN of the execution role for the RStudioServerPro Domain-level app. + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ minLength: 20 maxLength: 2048 - pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - RStudioConnectUrl: - type: string - description: A URL pointing to an RStudio Connect server. - pattern: ^(https:|http:|www\.)\S* - RStudioPackageManagerUrl: - type: string - description: A URL pointing to an RStudio Package Manager server. - pattern: ^(https:|http:|www\.)\S* - DefaultResourceSpec: - $ref: '#/components/schemas/ResourceSpec' - required: - - DomainExecutionRoleArn - RSessionAppSettings: - type: object - description: A collection of settings that apply to an RSessionGateway app. - additionalProperties: false - properties: - CustomImages: + StoppingCondition: + $ref: '#/components/schemas/StoppingCondition' + Tags: type: array - description: A list of custom SageMaker images that are configured to run as a KernelGateway app. - x-insertionOrder: false - uniqueItems: false - minItems: 0 - maxItems: 30 + maxItems: 50 + description: An array of key-value pairs to apply to this resource. items: - $ref: '#/components/schemas/CustomImage' - DefaultResourceSpec: - $ref: '#/components/schemas/ResourceSpec' - RStudioServerProAppSettings: - type: object - description: A collection of settings that configure user interaction with the RStudioServerPro app. - additionalProperties: false - properties: - AccessStatus: - type: string - description: Indicates whether the current user has access to the RStudioServerPro app. - enum: - - ENABLED - - DISABLED - UserGroup: + $ref: '#/components/schemas/Tag' + CreationTime: + description: The time at which the job definition was created. type: string - description: The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard. - enum: - - R_STUDIO_ADMIN - - R_STUDIO_USER - Domain: - description: The machine learning domain of the model package you specified. - type: string - FeatureDefinition: + required: + - DataQualityAppSpecification + - DataQualityJobInput + - DataQualityJobOutputConfig + - JobResources + - RoleArn + x-stackql-resource-name: data_quality_job_definition + description: Resource Type definition for AWS::SageMaker::DataQualityJobDefinition + x-type-name: AWS::SageMaker::DataQualityJobDefinition + x-stackql-primary-identifier: + - JobDefinitionArn + x-create-only-properties: + - JobDefinitionName + - DataQualityAppSpecification + - DataQualityBaselineConfig + - DataQualityJobInput + - DataQualityJobOutputConfig + - JobResources + - NetworkConfig + - RoleArn + - StoppingCondition + - Tags + - EndpointName + x-write-only-properties: + - EndpointName + x-read-only-properties: + - CreationTime + - JobDefinitionArn + x-required-properties: + - DataQualityAppSpecification + - DataQualityJobInput + - DataQualityJobOutputConfig + - JobResources + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + x-required-permissions: + create: + - sagemaker:CreateDataQualityJobDefinition + - sagemaker:DescribeDataQualityJobDefinition + - sagemaker:AddTags + - sagemaker:ListTags + - iam:PassRole + delete: + - sagemaker:DeleteDataQualityJobDefinition + read: + - sagemaker:DescribeDataQualityJobDefinition + - sagemaker:ListTags + list: + - sagemaker:ListDataQualityJobDefinitions + - sagemaker:ListTags + Device: type: object - additionalProperties: false properties: - FeatureName: + DeviceFleetName: + description: The name of the edge device fleet type: string + pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$ minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} - FeatureType: - type: string - enum: - - Integral - - Fractional - - String + maxLength: 63 + Device: + description: The Edge Device you want to register against a device fleet + $ref: '#/components/schemas/Device' + Tags: + description: Associate tags with the resource + type: array + items: + $ref: '#/components/schemas/Tag' required: - - FeatureName - - FeatureType - KmsKeyId: - type: string - maxLength: 2048 - StorageType: - type: string - enum: - - Standard - - InMemory - TtlDuration: - type: object - description: TTL configuration of the feature group - additionalProperties: false - properties: - Unit: - $ref: '#/components/schemas/Unit' - Value: - $ref: '#/components/schemas/Value' - Unit: - type: string - description: Unit of ttl configuration - enum: - - Seconds - - Minutes - - Hours - - Days - - Weeks - Value: - type: integer - description: Value of ttl configuration - OnlineStoreSecurityConfig: - type: object - additionalProperties: false - properties: - KmsKeyId: - $ref: '#/components/schemas/KmsKeyId' - S3StorageConfig: + - DeviceFleetName + x-stackql-resource-name: device + description: Resource schema for AWS::SageMaker::Device + x-type-name: AWS::SageMaker::Device + x-stackql-primary-identifier: + - Device/DeviceName + x-create-only-properties: + - Device/DeviceName + x-required-properties: + - DeviceFleetName + x-required-permissions: + create: + - sagemaker:RegisterDevices + read: + - sagemaker:DescribeDevice + update: + - sagemaker:UpdateDevices + delete: + - sagemaker:DeregisterDevices + EdgeOutputConfig: type: object - additionalProperties: false properties: - S3Uri: + S3OutputLocation: + description: The Amazon Simple Storage (S3) bucket URI type: string + pattern: ^s3://([^/]+)/?(.*)$ maxLength: 1024 - pattern: ^(https|s3)://([^/]+)/?(.*)$ KmsKeyId: - $ref: '#/components/schemas/KmsKeyId' + description: The KMS key id used for encryption on the S3 bucket + type: string + pattern: '[a-zA-Z0-9:_-]+' + minLength: 1 + maxLength: 2048 required: - - S3Uri - DataCatalogConfig: - type: object + - S3OutputLocation additionalProperties: false + DeviceFleet: + type: object properties: - TableName: + Description: + description: Description for the edge device fleet type: string - minLength: 1 - maxLength: 255 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*" - Catalog: + pattern: '[\S\s]+' + minLength: 0 + maxLength: 800 + DeviceFleetName: + description: The name of the edge device fleet type: string + pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$ minLength: 1 - maxLength: 255 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*" - Database: + maxLength: 63 + OutputConfig: + description: S3 bucket and an ecryption key id (if available) to store outputs for the fleet + $ref: '#/components/schemas/EdgeOutputConfig' + RoleArn: + description: Role associated with the device fleet type: string - minLength: 1 - maxLength: 255 - pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*" - required: - - TableName - - Catalog - - Database - TableFormat: - type: string - description: Format for the offline store feature group. Iceberg is the optimal format for feature groups shared between offline and online stores. - enum: - - Iceberg - - Glue - ThroughputMode: - type: string - description: Throughput mode configuration of the feature group - enum: - - OnDemand - - Provisioned - ThroughputConfig: - type: object - additionalProperties: false - properties: - ThroughputMode: - $ref: '#/components/schemas/ThroughputMode' - ProvisionedReadCapacityUnits: - type: integer - description: For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. - ProvisionedWriteCapacityUnits: - type: integer - description: For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. - required: - - ThroughputMode - FeatureGroup: - type: object - properties: - FeatureGroupName: - type: string - description: The Name of the FeatureGroup. - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} - RecordIdentifierFeatureName: - type: string - description: The Record Identifier Feature Name. - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} - EventTimeFeatureName: - type: string - description: The Event Time Feature Name. - minLength: 1 - maxLength: 64 - pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} - FeatureDefinitions: - type: array - description: An Array of Feature Definition - uniqueItems: false - x-insertionOrder: false - minItems: 1 - maxItems: 2500 - items: - $ref: '#/components/schemas/FeatureDefinition' - OnlineStoreConfig: - type: object - additionalProperties: false - properties: - SecurityConfig: - $ref: '#/components/schemas/OnlineStoreSecurityConfig' - EnableOnlineStore: - type: boolean - StorageType: - $ref: '#/components/schemas/StorageType' - TtlDuration: - $ref: '#/components/schemas/TtlDuration' - OfflineStoreConfig: - type: object - additionalProperties: false - properties: - S3StorageConfig: - $ref: '#/components/schemas/S3StorageConfig' - DisableGlueTableCreation: - type: boolean - DataCatalogConfig: - $ref: '#/components/schemas/DataCatalogConfig' - TableFormat: - $ref: '#/components/schemas/TableFormat' - required: - - S3StorageConfig - ThroughputConfig: - $ref: '#/components/schemas/ThroughputConfig' - RoleArn: - type: string - description: Role Arn + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ minLength: 20 maxLength: 2048 - pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - Description: - type: string - description: Description about the FeatureGroup. - maxLength: 128 - CreationTime: - description: A timestamp of FeatureGroup creation time. - type: string - FeatureGroupStatus: - description: The status of the feature group. - type: string Tags: + description: Associate tags with the resource type: array - description: An array of key-value pair to apply to this resource. - uniqueItems: false - x-insertionOrder: false - maxItems: 50 items: $ref: '#/components/schemas/Tag' required: - - FeatureGroupName - - RecordIdentifierFeatureName - - EventTimeFeatureName - - FeatureDefinitions - x-stackql-resource-name: feature_group - x-stackql-primaryIdentifier: - - FeatureGroupName + - DeviceFleetName + - OutputConfig + - RoleArn + x-stackql-resource-name: device_fleet + description: Resource schema for AWS::SageMaker::DeviceFleet + x-type-name: AWS::SageMaker::DeviceFleet + x-stackql-primary-identifier: + - DeviceFleetName x-create-only-properties: - - FeatureGroupName - - RecordIdentifierFeatureName - - EventTimeFeatureName - - OnlineStoreConfig/SecurityConfig - - OnlineStoreConfig/EnableOnlineStore - - OnlineStoreConfig/StorageType - - OfflineStoreConfig + - DeviceFleetName + x-required-properties: + - DeviceFleetName + - OutputConfig - RoleArn - - Description - - Tags - x-read-only-properties: - - CreationTime - - FeatureGroupStatus x-required-permissions: create: + - sagemaker:CreateDeviceFleet - iam:PassRole - - kms:CreateGrant - - kms:DescribeKey - - glue:CreateTable - - glue:GetTable - - glue:CreateDatabase - - glue:GetDatabase - - sagemaker:CreateFeatureGroup - - sagemaker:DescribeFeatureGroup - - sagemaker:AddTags - - sagemaker:ListTags - update: - - sagemaker:UpdateFeatureGroup - - sagemaker:DescribeFeatureGroup - - sagemaker:AddTags - - sagemaker:ListTags - - sagemaker:DeleteTags read: - - sagemaker:DescribeFeatureGroup - - sagemaker:ListTags + - sagemaker:DescribeDeviceFleet + update: + - sagemaker:UpdateDeviceFleet + - iam:PassRole delete: - - sagemaker:DeleteFeatureGroup - - sagemaker:DescribeFeatureGroup - list: - - sagemaker:ListFeatureGroups - ImageName: - type: string - description: The name of the image this version belongs to. - pattern: ^[A-Za-z0-9]([-.]?[A-Za-z0-9])*$ - minLength: 1 - maxLength: 63 - ImageArn: - type: string - description: The Amazon Resource Name (ARN) of the parent image. - minLength: 1 - maxLength: 256 - pattern: ^arn:aws(-[\w]+)*:sagemaker:[a-z0-9\-]*:[0-9]{12}:image\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$ - ImageRoleArn: - description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. - type: string - minLength: 1 - maxLength: 256 - pattern: ^arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*$ - ImageDisplayName: - type: string - description: The display name of the image. - pattern: ^[A-Za-z0-9 -_]+$ - minLength: 1 - maxLength: 128 - ImageDescription: - type: string - description: A description of the image. - pattern: .+ - minLength: 1 - maxLength: 512 - Image: + - sagemaker:DeleteDeviceFleet + UserSettings: type: object + description: A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called. + additionalProperties: false properties: - ImageName: - $ref: '#/components/schemas/ImageName' - ImageArn: - $ref: '#/components/schemas/ImageArn' - ImageRoleArn: - $ref: '#/components/schemas/ImageRoleArn' - ImageDisplayName: - $ref: '#/components/schemas/ImageDisplayName' - ImageDescription: - $ref: '#/components/schemas/ImageDescription' - Tags: + ExecutionRole: + type: string + description: The user profile Amazon Resource Name (ARN). + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + AutoMountHomeEFS: + type: string + description: 'Indicates whether auto-mounting of an EFS volume is supported for the user profile. ' + enum: + - Enabled + - Disabled + - DefaultAsDomain + JupyterServerAppSettings: + $ref: '#/components/schemas/JupyterServerAppSettings' + description: The Jupyter server's app settings. + KernelGatewayAppSettings: + $ref: '#/components/schemas/KernelGatewayAppSettings' + description: The kernel gateway app settings. + RStudioServerProAppSettings: + $ref: '#/components/schemas/RStudioServerProAppSettings' + JupyterLabAppSettings: + $ref: '#/components/schemas/JupyterLabAppSettings' + SpaceStorageSettings: + $ref: '#/components/schemas/DefaultSpaceStorageSettings' + CodeEditorAppSettings: + $ref: '#/components/schemas/CodeEditorAppSettings' + StudioWebPortalSettings: + $ref: '#/components/schemas/StudioWebPortalSettings' + DefaultLandingUri: + type: string + description: Defines which Amazon SageMaker application users are directed to by default. + maxLength: 1023 + StudioWebPortal: + type: string + description: Indicates whether the Studio experience is available to users. If not, users cannot access Studio. + enum: + - ENABLED + - DISABLED + CustomPosixUserConfig: + $ref: '#/components/schemas/CustomPosixUserConfig' + CustomFileSystemConfigs: type: array - maxItems: 50 - description: An array of key-value pairs to apply to this resource. + uniqueItems: true + minItems: 0 + maxItems: 2 items: - $ref: '#/components/schemas/Tag' - required: - - ImageName - - ImageRoleArn - x-stackql-resource-name: image - x-stackql-primaryIdentifier: - - ImageArn - x-create-only-properties: - - ImageName - x-read-only-properties: - - ImageArn - x-required-permissions: - create: - - sagemaker:CreateImage - - sagemaker:DescribeImage - - iam:PassRole - - sagemaker:AddTags - - sagemaker:ListTags - read: - - sagemaker:DescribeImage - - sagemaker:ListTags - update: - - sagemaker:UpdateImage - - sagemaker:DescribeImage - - sagemaker:ListTags - - sagemaker:AddTags - - sagemaker:DeleteTags - - iam:PassRole - delete: - - sagemaker:DeleteImage - - sagemaker:DescribeImage - list: - - sagemaker:ListImages - ImageVersionArn: - type: string - description: The Amazon Resource Name (ARN) of the image version. - minLength: 1 - maxLength: 256 - pattern: ^arn:aws(-[\w]+)*:sagemaker:[a-z0-9\-]*:[0-9]{12}:image-version\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*\/[0-9]+$ - BaseImage: - type: string - description: The registry path of the container image on which this image version is based. - minLength: 1 - maxLength: 255 - pattern: .+ - ContainerImage: - description: The image to use for the container that will be materialized for the inference component - type: string - pattern: '[\S]+' - maxLength: 255 - Alias: + $ref: '#/components/schemas/CustomFileSystemConfig' + SecurityGroups: + type: array + description: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. + uniqueItems: false + minItems: 0 + maxItems: 5 + items: + type: string + maxLength: 32 + pattern: '[-0-9a-zA-Z]+' + SharingSettings: + $ref: '#/components/schemas/SharingSettings' + description: The sharing settings. + DefaultSpaceSettings: + type: object + description: A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called. + additionalProperties: false + properties: + ExecutionRole: + type: string + description: The execution role for the space. + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + JupyterServerAppSettings: + $ref: '#/components/schemas/JupyterServerAppSettings' + description: The Jupyter server's app settings. + KernelGatewayAppSettings: + $ref: '#/components/schemas/KernelGatewayAppSettings' + description: The kernel gateway app settings. + SecurityGroups: + type: array + description: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. + uniqueItems: false + x-insertionOrder: false + minItems: 0 + maxItems: 5 + items: + type: string + maxLength: 32 + pattern: '[-0-9a-zA-Z]+' + JupyterLabAppSettings: + $ref: '#/components/schemas/JupyterLabAppSettings' + description: The Jupyter lab's app settings. + SpaceStorageSettings: + $ref: '#/components/schemas/DefaultSpaceStorageSettings' + description: The Jupyter lab's space storage settings. + CustomPosixUserConfig: + $ref: '#/components/schemas/CustomPosixUserConfig' + description: The Jupyter lab's custom posix user configurations. + CustomFileSystemConfigs: + type: array + uniqueItems: true + minItems: 0 + maxItems: 2 + items: + $ref: '#/components/schemas/CustomFileSystemConfig' + required: + - ExecutionRole + JupyterServerAppSettings: + type: object + description: The JupyterServer app settings. + additionalProperties: false + properties: + DefaultResourceSpec: + $ref: '#/components/schemas/ResourceSpec' + LifecycleConfigArns: + type: array + description: A list of LifecycleConfigArns available for use with JupyterServer apps. + uniqueItems: false + minItems: 0 + maxItems: 30 + items: + $ref: '#/components/schemas/StudioLifecycleConfigArn' + KernelGatewayAppSettings: + type: object + description: The kernel gateway app settings. + additionalProperties: false + properties: + CustomImages: + type: array + description: A list of custom SageMaker images that are configured to run as a KernelGateway app. + uniqueItems: false + minItems: 0 + maxItems: 30 + items: + $ref: '#/components/schemas/CustomImage' + DefaultResourceSpec: + $ref: '#/components/schemas/ResourceSpec' + description: The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. + LifecycleConfigArns: + type: array + description: A list of LifecycleConfigArns available for use with KernelGateway apps. + uniqueItems: false + minItems: 0 + maxItems: 30 + items: + $ref: '#/components/schemas/StudioLifecycleConfigArn' + JupyterLabAppSettings: + type: object + description: The JupyterLab app settings. + additionalProperties: false + properties: + DefaultResourceSpec: + $ref: '#/components/schemas/ResourceSpec' + description: The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. + LifecycleConfigArns: + type: array + description: A list of LifecycleConfigArns available for use with JupyterLab apps. + uniqueItems: false + minItems: 0 + maxItems: 30 + items: + $ref: '#/components/schemas/StudioLifecycleConfigArn' + CodeRepositories: + type: array + description: A list of CodeRepositories available for use with JupyterLab apps. + uniqueItems: false + minItems: 0 + maxItems: 30 + items: + $ref: '#/components/schemas/CodeRepository' + CustomImages: + type: array + description: A list of custom images available for use for JupyterLab apps + uniqueItems: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/CustomImage' + AppLifecycleManagement: + $ref: '#/components/schemas/AppLifecycleManagement' + BuiltInLifecycleConfigArn: + type: string + description: The lifecycle configuration that runs before the default lifecycle configuration. + maxLength: 256 + pattern: ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$ + AppLifecycleManagement: + type: object + properties: + IdleSettings: + $ref: '#/components/schemas/IdleSettings' + additionalProperties: false + IdleSettings: + type: object + properties: + LifecycleManagement: + $ref: '#/components/schemas/LifecycleManagement' + IdleTimeoutInMinutes: + $ref: '#/components/schemas/IdleTimeoutInMinutes' + MinIdleTimeoutInMinutes: + $ref: '#/components/schemas/MinIdleTimeoutInMinutes' + MaxIdleTimeoutInMinutes: + $ref: '#/components/schemas/MaxIdleTimeoutInMinutes' + additionalProperties: false + LifecycleManagement: type: string - description: The alias of the image version. - minLength: 1 - maxLength: 128 - pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$ - Aliases: - type: array - description: List of aliases for the image version. - items: - $ref: '#/components/schemas/Alias' - Version: + description: A flag to enable/disable AppLifecycleManagement settings + enum: + - ENABLED + - DISABLED + IdleTimeoutInMinutes: type: integer - description: The version number of the image version. - minimum: 1 - VendorGuidance: + description: The idle timeout value set in minutes + minimum: 60 + maximum: 525600 + MinIdleTimeoutInMinutes: + type: integer + description: The minimum idle timeout value set in minutes + minimum: 60 + maximum: 525600 + MaxIdleTimeoutInMinutes: + type: integer + description: The maximum idle timeout value set in minutes + minimum: 60 + maximum: 525600 + CodeRepository: + type: object + additionalProperties: false + properties: + RepositoryUrl: + type: string + description: A CodeRepository (valid URL) to be used within Jupyter's Git extension. + maxLength: 256 + pattern: ^https://([.\-_a-zA-Z0-9]+/?){3,1016}$ + required: + - RepositoryUrl + DefaultSpaceStorageSettings: + type: object + description: Default storage settings for a space. + additionalProperties: false + properties: + DefaultEbsStorageSettings: + $ref: '#/components/schemas/DefaultEbsStorageSettings' + DefaultEbsStorageSettings: + type: object + description: Properties related to the Amazon Elastic Block Store volume. + additionalProperties: false + properties: + DefaultEbsVolumeSizeInGb: + description: Default size of the Amazon EBS volume in Gb + $ref: '#/components/schemas/SpaceEbsVolumeSizeInGb' + MaximumEbsVolumeSizeInGb: + description: Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb. + $ref: '#/components/schemas/SpaceEbsVolumeSizeInGb' + required: + - DefaultEbsVolumeSizeInGb + - MaximumEbsVolumeSizeInGb + SpaceEbsVolumeSizeInGb: + type: integer + minimum: 5 + maximum: 16384 + CodeEditorAppSettings: + type: object + description: The CodeEditor app settings. + additionalProperties: false + properties: + DefaultResourceSpec: + $ref: '#/components/schemas/ResourceSpec' + description: The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. + LifecycleConfigArns: + type: array + description: A list of LifecycleConfigArns available for use with CodeEditor apps. + uniqueItems: false + minItems: 0 + maxItems: 30 + items: + $ref: '#/components/schemas/StudioLifecycleConfigArn' + CustomImages: + type: array + description: A list of custom images for use for CodeEditor apps. + uniqueItems: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/CustomImage' + AppLifecycleManagement: + $ref: '#/components/schemas/AppLifecycleManagement' + BuiltInLifecycleConfigArn: + type: string + description: The lifecycle configuration that runs before the default lifecycle configuration. + maxLength: 256 + pattern: ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$ + StudioLifecycleConfigArn: type: string - description: The availability of the image version specified by the maintainer. - enum: - - NOT_PROVIDED - - STABLE - - TO_BE_ARCHIVED - - ARCHIVED - JobType: + description: The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource. + maxLength: 256 + pattern: ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$ + CustomPosixUserConfig: + type: object + additionalProperties: false + properties: + Uid: + type: integer + minimum: 10000 + maximum: 4000000 + Gid: + type: integer + minimum: 1001 + maximum: 4000000 + required: + - Uid + - Gid + CustomFileSystemConfig: + type: object + additionalProperties: false + properties: + EFSFileSystemConfig: + $ref: '#/components/schemas/EFSFileSystemConfig' + FSxLustreFileSystemConfig: + $ref: '#/components/schemas/FSxLustreFileSystemConfig' + S3FileSystemConfig: + $ref: '#/components/schemas/S3FileSystemConfig' + EFSFileSystemConfig: + type: object + additionalProperties: false + properties: + FileSystemPath: + type: string + pattern: ^\/\S*$ + minLength: 1 + maxLength: 256 + FileSystemId: + type: string + minLength: 11 + maxLength: 21 + pattern: ^(fs-[0-9a-f]{8,})$ + required: + - FileSystemId + FSxLustreFileSystemConfig: + type: object + additionalProperties: false + properties: + FileSystemPath: + type: string + pattern: ^\/\S*$ + minLength: 1 + maxLength: 256 + FileSystemId: + type: string + minLength: 11 + maxLength: 21 + pattern: ^(fs-[0-9a-f]{8,})$ + required: + - FileSystemId + S3FileSystemConfig: + type: object + additionalProperties: false + properties: + MountPath: + type: string + minLength: 0 + maxLength: 1024 + S3Uri: + type: string + pattern: (s3)://([^/]+)/?(.*) + minLength: 0 + maxLength: 1024 + CustomImage: + type: object + description: A custom SageMaker image. + additionalProperties: false + properties: + AppImageConfigName: + type: string + description: The Name of the AppImageConfig. + maxLength: 63 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} + ImageName: + type: string + description: The name of the CustomImage. Must be unique to your account. + maxLength: 63 + pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$ + ImageVersionNumber: + type: integer + description: The version number of the CustomImage. + minimum: 0 + required: + - AppImageConfigName + - ImageName + SharingSettings: + type: object + description: Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. + additionalProperties: false + properties: + NotebookOutputOption: + type: string + description: Whether to include the notebook cell output when sharing the notebook. The default is Disabled. + enum: + - Allowed + - Disabled + S3KmsKeyId: + type: string + description: When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. + maxLength: 2048 + pattern: .* + S3OutputPath: + type: string + description: When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots. + maxLength: 1024 + pattern: ^(https|s3)://([^/]+)/?(.*)$ + DomainSettings: + type: object + description: A collection of Domain settings. + additionalProperties: false + properties: + SecurityGroupIds: + type: array + description: The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps. + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 3 + items: + type: string + maxLength: 32 + pattern: '[-0-9a-zA-Z]+' + RStudioServerProDomainSettings: + $ref: '#/components/schemas/RStudioServerProDomainSettings' + DockerSettings: + $ref: '#/components/schemas/DockerSettings' + ExecutionRoleIdentityConfig: + type: string + description: The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. + enum: + - USER_PROFILE_NAME + - DISABLED + UnifiedStudioSettings: + $ref: '#/components/schemas/UnifiedStudioSettings' + DockerSettings: + type: object + description: A collection of settings that are required to start docker-proxy server. + additionalProperties: false + properties: + EnableDockerAccess: + type: string + description: The flag to enable/disable docker-proxy server + enum: + - ENABLED + - DISABLED + VpcOnlyTrustedAccounts: + type: array + description: A list of account id's that would be used to pull images from in VpcOnly mode + uniqueItems: false + x-insertionOrder: false + minItems: 0 + maxItems: 20 + items: + type: string + minLength: 12 + maxLength: 12 + pattern: ^\d+$ + UnifiedStudioSettings: + type: object + description: A collection of settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio. + additionalProperties: false + properties: + StudioWebPortalAccess: + type: string + description: | + Sets whether you can access the domain in Amazon SageMaker Studio: + + ENABLED + You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces. + DISABLED + You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface. + enum: + - ENABLED + - DISABLED + DomainAccountId: + type: string + description: The ID of the AWS account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain. + minLength: 12 + maxLength: 12 + pattern: ^\d+$ + DomainRegion: + type: string + description: The AWS Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located. + pattern: '[a-zA-Z]{2}-[a-zA-Z\-]+-\d+' + DomainId: + type: string + description: The ID of the Amazon SageMaker Unified Studio domain associated with this domain. + minLength: 1 + maxLength: 36 + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + ProjectId: + type: string + description: The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain. + pattern: ^[a-zA-Z0-9_-]{1,36}$ + EnvironmentId: + type: string + description: The ID of the environment that Amazon SageMaker Unified Studio associates with the domain. + minLength: 1 + maxLength: 36 + pattern: ^[a-zA-Z0-9_-]{1,36}$ + ProjectS3Path: + type: string + description: The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain. + minLength: 1 + maxLength: 100 + pattern: '[\w\.-]+$' + RStudioServerProDomainSettings: + type: object + description: A collection of settings that update the current configuration for the RStudioServerPro Domain-level app. + additionalProperties: false + properties: + DomainExecutionRoleArn: + type: string + description: The ARN of the execution role for the RStudioServerPro Domain-level app. + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + RStudioConnectUrl: + type: string + description: A URL pointing to an RStudio Connect server. + pattern: ^(https:|http:|www\.)\S* + RStudioPackageManagerUrl: + type: string + description: A URL pointing to an RStudio Package Manager server. + pattern: ^(https:|http:|www\.)\S* + DefaultResourceSpec: + $ref: '#/components/schemas/ResourceSpec' + required: + - DomainExecutionRoleArn + RSessionAppSettings: + type: object + description: A collection of settings that apply to an RSessionGateway app. + additionalProperties: false + properties: + CustomImages: + type: array + description: A list of custom SageMaker images that are configured to run as a KernelGateway app. + x-insertionOrder: false + uniqueItems: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/CustomImage' + DefaultResourceSpec: + $ref: '#/components/schemas/ResourceSpec' + RStudioServerProAppSettings: + type: object + description: A collection of settings that configure user interaction with the RStudioServerPro app. + additionalProperties: false + properties: + AccessStatus: + type: string + description: Indicates whether the current user has access to the RStudioServerPro app. + enum: + - ENABLED + - DISABLED + UserGroup: + type: string + description: The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard. + enum: + - R_STUDIO_ADMIN + - R_STUDIO_USER + StudioWebPortalSettings: + type: object + description: Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level. + additionalProperties: false + properties: + HiddenMlTools: + type: array + description: The machine learning tools that are hidden from the Studio left navigation pane. + x-insertionOrder: false + uniqueItems: true + minItems: 0 + items: + $ref: '#/components/schemas/MlTools' + HiddenAppTypes: + type: array + description: Applications supported in Studio that are hidden from the Studio left navigation pane. + x-insertionOrder: false + uniqueItems: true + minItems: 0 + items: + $ref: '#/components/schemas/AppType' + HiddenInstanceTypes: + type: array + description: The instance types you are hiding from the Studio user interface. + x-insertionOrder: false + uniqueItems: true + minItems: 0 + items: + $ref: '#/components/schemas/AppInstanceType' + HiddenSageMakerImageVersionAliases: + type: array + description: The version aliases you are hiding from the Studio user interface. + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 5 + items: + $ref: '#/components/schemas/HiddenSageMakerImage' + MlTools: type: string - description: Indicates SageMaker job type compatibility. enum: - - TRAINING - - INFERENCE - - NOTEBOOK_KERNEL - MLFramework: + - DataWrangler + - FeatureStore + - EmrClusters + - AutoMl + - Experiments + - Training + - ModelEvaluation + - Pipelines + - Models + - JumpStart + - InferenceRecommender + - Endpoints + - Projects + - InferenceOptimization + - HyperPodClusters + - Comet + - DeepchecksLLMEvaluation + - Fiddler + - LakeraGuard + - PerformanceEvaluation + AppType: type: string - description: The machine learning framework vended in the image version. - pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$ - minLength: 1 - maxLength: 128 - ProgrammingLang: + enum: + - JupyterServer + - TensorBoard + - RStudioServerPro + - JupyterLab + - CodeEditor + - DetailedProfiler + - Canvas + AppInstanceType: type: string - description: The supported programming language and its version. - pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$ - minLength: 1 - maxLength: 128 - Processor: + description: The instance type that the image version runs on. + enum: + - system + - ml.t3.micro + - ml.t3.small + - ml.t3.medium + - ml.t3.large + - ml.t3.xlarge + - ml.t3.2xlarge + - ml.m5.large + - ml.m5.xlarge + - ml.m5.2xlarge + - ml.m5.4xlarge + - ml.m5.8xlarge + - ml.m5.12xlarge + - ml.m5.16xlarge + - ml.m5.24xlarge + - ml.m5d.large + - ml.m5d.xlarge + - ml.m5d.2xlarge + - ml.m5d.4xlarge + - ml.m5d.8xlarge + - ml.m5d.12xlarge + - ml.m5d.16xlarge + - ml.m5d.24xlarge + - ml.c5.large + - ml.c5.xlarge + - ml.c5.2xlarge + - ml.c5.4xlarge + - ml.c5.9xlarge + - ml.c5.12xlarge + - ml.c5.18xlarge + - ml.c5.24xlarge + - ml.p3.2xlarge + - ml.p3.8xlarge + - ml.p3.16xlarge + - ml.p3dn.24xlarge + - ml.g4dn.xlarge + - ml.g4dn.2xlarge + - ml.g4dn.4xlarge + - ml.g4dn.8xlarge + - ml.g4dn.12xlarge + - ml.g4dn.16xlarge + - ml.r5.large + - ml.r5.xlarge + - ml.r5.2xlarge + - ml.r5.4xlarge + - ml.r5.8xlarge + - ml.r5.12xlarge + - ml.r5.16xlarge + - ml.r5.24xlarge + - ml.g5.xlarge + - ml.g5.2xlarge + - ml.g5.4xlarge + - ml.g5.8xlarge + - ml.g5.12xlarge + - ml.g5.16xlarge + - ml.g5.24xlarge + - ml.g5.48xlarge + - ml.g6.xlarge + - ml.g6.2xlarge + - ml.g6.4xlarge + - ml.g6.8xlarge + - ml.g6.12xlarge + - ml.g6.16xlarge + - ml.g6.24xlarge + - ml.g6.48xlarge + - ml.g6e.xlarge + - ml.g6e.2xlarge + - ml.g6e.4xlarge + - ml.g6e.8xlarge + - ml.g6e.12xlarge + - ml.g6e.16xlarge + - ml.g6e.24xlarge + - ml.g6e.48xlarge + - ml.geospatial.interactive + - ml.p4d.24xlarge + - ml.p4de.24xlarge + - ml.trn1.2xlarge + - ml.trn1.32xlarge + - ml.trn1n.32xlarge + - ml.p5.48xlarge + - ml.m6i.large + - ml.m6i.xlarge + - ml.m6i.2xlarge + - ml.m6i.4xlarge + - ml.m6i.8xlarge + - ml.m6i.12xlarge + - ml.m6i.16xlarge + - ml.m6i.24xlarge + - ml.m6i.32xlarge + - ml.m7i.large + - ml.m7i.xlarge + - ml.m7i.2xlarge + - ml.m7i.4xlarge + - ml.m7i.8xlarge + - ml.m7i.12xlarge + - ml.m7i.16xlarge + - ml.m7i.24xlarge + - ml.m7i.48xlarge + - ml.c6i.large + - ml.c6i.xlarge + - ml.c6i.2xlarge + - ml.c6i.4xlarge + - ml.c6i.8xlarge + - ml.c6i.12xlarge + - ml.c6i.16xlarge + - ml.c6i.24xlarge + - ml.c6i.32xlarge + - ml.c7i.large + - ml.c7i.xlarge + - ml.c7i.2xlarge + - ml.c7i.4xlarge + - ml.c7i.8xlarge + - ml.c7i.12xlarge + - ml.c7i.16xlarge + - ml.c7i.24xlarge + - ml.c7i.48xlarge + - ml.r6i.large + - ml.r6i.xlarge + - ml.r6i.2xlarge + - ml.r6i.4xlarge + - ml.r6i.8xlarge + - ml.r6i.12xlarge + - ml.r6i.16xlarge + - ml.r6i.24xlarge + - ml.r6i.32xlarge + - ml.r7i.large + - ml.r7i.xlarge + - ml.r7i.2xlarge + - ml.r7i.4xlarge + - ml.r7i.8xlarge + - ml.r7i.12xlarge + - ml.r7i.16xlarge + - ml.r7i.24xlarge + - ml.r7i.48xlarge + - ml.m6id.large + - ml.m6id.xlarge + - ml.m6id.2xlarge + - ml.m6id.4xlarge + - ml.m6id.8xlarge + - ml.m6id.12xlarge + - ml.m6id.16xlarge + - ml.m6id.24xlarge + - ml.m6id.32xlarge + - ml.c6id.large + - ml.c6id.xlarge + - ml.c6id.2xlarge + - ml.c6id.4xlarge + - ml.c6id.8xlarge + - ml.c6id.12xlarge + - ml.c6id.16xlarge + - ml.c6id.24xlarge + - ml.c6id.32xlarge + - ml.r6id.large + - ml.r6id.xlarge + - ml.r6id.2xlarge + - ml.r6id.4xlarge + - ml.r6id.8xlarge + - ml.r6id.12xlarge + - ml.r6id.16xlarge + - ml.r6id.24xlarge + - ml.r6id.32xlarge + HiddenSageMakerImage: + type: object + additionalProperties: false + properties: + SageMakerImageName: + type: string + description: The SageMaker image name that you are hiding from the Studio user interface. + enum: + - sagemaker_distribution + VersionAliases: + type: array + uniqueItems: false + x-insertionOrder: false + maxItems: 20 + items: + type: string + minLength: 1 + maxLength: 128 + pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$ + Domain: + description: The machine learning domain of the model package you specified. + type: string + Alarm: + type: object + additionalProperties: false + properties: + AlarmName: + type: string + minLength: 1 + maxLength: 255 + pattern: ^(?!\s*$).+ + required: + - AlarmName + AutoRollbackConfig: + type: object + additionalProperties: false + properties: + Alarms: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/Alarm' + description: List of CloudWatch alarms to monitor during the deployment. If any alarm goes off, the deployment is rolled back. + required: + - Alarms + BlueGreenUpdatePolicy: + type: object + additionalProperties: false + properties: + MaximumExecutionTimeoutInSeconds: + type: integer + description: The maximum time allowed for the blue/green update, in seconds. + TerminationWaitInSeconds: + type: integer + description: The wait time before terminating the old endpoint during a blue/green deployment. + TrafficRoutingConfiguration: + $ref: '#/components/schemas/TrafficRoutingConfig' + description: The traffic routing configuration for the blue/green deployment. + required: + - TrafficRoutingConfiguration + CapacitySize: + type: object + additionalProperties: false + properties: + Type: + type: string + description: Specifies whether the `Value` is an instance count or a capacity unit. + Value: + type: integer + description: The value representing either the number of instances or the number of capacity units. + required: + - Type + - Value + TrafficRoutingConfig: + type: object + additionalProperties: false + properties: + CanarySize: + $ref: '#/components/schemas/CapacitySize' + description: Specifies the size of the canary traffic in a canary deployment. + LinearStepSize: + $ref: '#/components/schemas/CapacitySize' + description: Specifies the step size for linear traffic routing. + Type: + type: string + description: Specifies the type of traffic routing (e.g., 'AllAtOnce', 'Canary', 'Linear'). + WaitIntervalInSeconds: + type: integer + description: Specifies the wait interval between traffic shifts, in seconds. + required: + - Type + VariantProperty: + type: object + additionalProperties: false + properties: + VariantPropertyType: + type: string + description: The type of variant property (e.g., 'DesiredInstanceCount', 'DesiredWeight', 'DataCaptureConfig'). + Endpoint: + type: object + properties: + DeploymentConfig: + $ref: '#/components/schemas/DeploymentConfig' + description: Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies. + EndpointArn: + type: string + description: The Amazon Resource Name (ARN) of the endpoint. + EndpointConfigName: + type: string + description: The name of the endpoint configuration for the SageMaker endpoint. This is a required property. + EndpointName: + type: string + description: The name of the SageMaker endpoint. This name must be unique within an AWS Region. + ExcludeRetainedVariantProperties: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/VariantProperty' + description: Specifies a list of variant properties that you want to exclude when updating an endpoint. + RetainAllVariantProperties: + type: boolean + description: When set to true, retains all variant properties for an endpoint when it is updated. + RetainDeploymentConfig: + type: boolean + description: When set to true, retains the deployment configuration during endpoint updates. + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + description: An array of key-value pairs to apply to this resource. + required: + - EndpointConfigName + x-stackql-resource-name: endpoint + description: Resource Type definition for AWS::SageMaker::Endpoint + x-type-name: AWS::SageMaker::Endpoint + x-stackql-primary-identifier: + - EndpointArn + x-create-only-properties: + - EndpointName + x-write-only-properties: + - ExcludeRetainedVariantProperties + - RetainAllVariantProperties + - RetainDeploymentConfig + x-read-only-properties: + - EndpointArn + - EndpointName + x-required-properties: + - EndpointConfigName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:DeleteTags + - sagemaker:ListTags + x-required-permissions: + create: + - sagemaker:CreateEndpoint + - sagemaker:DescribeEndpoint + - sagemaker:AddTags + read: + - sagemaker:DescribeEndpoint + - sagemaker:ListTags + update: + - sagemaker:UpdateEndpoint + - sagemaker:DescribeEndpoint + - sagemaker:AddTags + - sagemaker:DeleteTags + delete: + - sagemaker:DeleteEndpoint + - sagemaker:DescribeEndpoint + list: + - sagemaker:ListEndpoints + FeatureDefinition: + type: object + additionalProperties: false + properties: + FeatureName: + type: string + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} + FeatureType: + type: string + enum: + - Integral + - Fractional + - String + required: + - FeatureName + - FeatureType + KmsKeyId: + type: string + maxLength: 2048 + StorageType: + type: string + enum: + - Standard + - InMemory + TtlDuration: + type: object + description: TTL configuration of the feature group + additionalProperties: false + properties: + Unit: + $ref: '#/components/schemas/Unit' + Value: + $ref: '#/components/schemas/Value' + Unit: + type: string + description: Unit of ttl configuration + enum: + - Seconds + - Minutes + - Hours + - Days + - Weeks + Value: + type: integer + description: Value of ttl configuration + OnlineStoreSecurityConfig: + type: object + additionalProperties: false + properties: + KmsKeyId: + $ref: '#/components/schemas/KmsKeyId' + S3StorageConfig: + type: object + additionalProperties: false + properties: + S3Uri: + type: string + maxLength: 1024 + pattern: ^(https|s3)://([^/]+)/?(.*)$ + KmsKeyId: + $ref: '#/components/schemas/KmsKeyId' + required: + - S3Uri + DataCatalogConfig: + type: object + additionalProperties: false + properties: + TableName: + type: string + minLength: 1 + maxLength: 255 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*" + Catalog: + type: string + minLength: 1 + maxLength: 255 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*" + Database: + type: string + minLength: 1 + maxLength: 255 + pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\t]*" + required: + - TableName + - Catalog + - Database + TableFormat: + type: string + description: Format for the offline store feature group. Iceberg is the optimal format for feature groups shared between offline and online stores. + enum: + - Iceberg + - Glue + ThroughputMode: + type: string + description: Throughput mode configuration of the feature group + enum: + - OnDemand + - Provisioned + ThroughputConfig: + type: object + additionalProperties: false + properties: + ThroughputMode: + $ref: '#/components/schemas/ThroughputMode' + ProvisionedReadCapacityUnits: + type: integer + description: For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. + ProvisionedWriteCapacityUnits: + type: integer + description: For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. + required: + - ThroughputMode + FeatureGroup: + type: object + properties: + FeatureGroupName: + type: string + description: The Name of the FeatureGroup. + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} + RecordIdentifierFeatureName: + type: string + description: The Record Identifier Feature Name. + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} + EventTimeFeatureName: + type: string + description: The Event Time Feature Name. + minLength: 1 + maxLength: 64 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} + FeatureDefinitions: + type: array + description: An Array of Feature Definition + uniqueItems: false + x-insertionOrder: false + minItems: 1 + maxItems: 2500 + items: + $ref: '#/components/schemas/FeatureDefinition' + OnlineStoreConfig: + type: object + additionalProperties: false + properties: + SecurityConfig: + $ref: '#/components/schemas/OnlineStoreSecurityConfig' + EnableOnlineStore: + type: boolean + StorageType: + $ref: '#/components/schemas/StorageType' + TtlDuration: + $ref: '#/components/schemas/TtlDuration' + OfflineStoreConfig: + type: object + additionalProperties: false + properties: + S3StorageConfig: + $ref: '#/components/schemas/S3StorageConfig' + DisableGlueTableCreation: + type: boolean + DataCatalogConfig: + $ref: '#/components/schemas/DataCatalogConfig' + TableFormat: + $ref: '#/components/schemas/TableFormat' + required: + - S3StorageConfig + ThroughputConfig: + $ref: '#/components/schemas/ThroughputConfig' + RoleArn: + type: string + description: Role Arn + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + Description: + type: string + description: Description about the FeatureGroup. + maxLength: 128 + CreationTime: + description: A timestamp of FeatureGroup creation time. + type: string + FeatureGroupStatus: + description: The status of the feature group. + type: string + Tags: + type: array + description: An array of key-value pair to apply to this resource. + uniqueItems: false + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + required: + - FeatureGroupName + - RecordIdentifierFeatureName + - EventTimeFeatureName + - FeatureDefinitions + x-stackql-resource-name: feature_group + description: Resource Type definition for AWS::SageMaker::FeatureGroup + x-type-name: AWS::SageMaker::FeatureGroup + x-stackql-primary-identifier: + - FeatureGroupName + x-create-only-properties: + - FeatureGroupName + - RecordIdentifierFeatureName + - EventTimeFeatureName + - OnlineStoreConfig/SecurityConfig + - OnlineStoreConfig/EnableOnlineStore + - OnlineStoreConfig/StorageType + - OfflineStoreConfig + - RoleArn + - Description + - Tags + x-read-only-properties: + - CreationTime + - FeatureGroupStatus + x-required-properties: + - FeatureGroupName + - RecordIdentifierFeatureName + - EventTimeFeatureName + - FeatureDefinitions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + x-required-permissions: + create: + - iam:PassRole + - kms:CreateGrant + - kms:DescribeKey + - glue:CreateTable + - glue:GetTable + - glue:CreateDatabase + - glue:GetDatabase + - sagemaker:CreateFeatureGroup + - sagemaker:DescribeFeatureGroup + - sagemaker:AddTags + - sagemaker:ListTags + update: + - sagemaker:UpdateFeatureGroup + - sagemaker:DescribeFeatureGroup + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + read: + - sagemaker:DescribeFeatureGroup + - sagemaker:ListTags + delete: + - sagemaker:DeleteFeatureGroup + - sagemaker:DescribeFeatureGroup + list: + - sagemaker:ListFeatureGroups + ImageName: + type: string + description: The name of the image this version belongs to. + pattern: ^[A-Za-z0-9]([-.]?[A-Za-z0-9])*$ + minLength: 1 + maxLength: 63 + ImageArn: + type: string + description: The Amazon Resource Name (ARN) of the parent image. + minLength: 1 + maxLength: 256 + pattern: ^arn:aws(-[\w]+)*:sagemaker:[a-z0-9\-]*:[0-9]{12}:image\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*$ + ImageRoleArn: + description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. + type: string + minLength: 1 + maxLength: 256 + pattern: ^arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*$ + ImageDisplayName: + type: string + description: The display name of the image. + pattern: ^[A-Za-z0-9 -_]+$ + minLength: 1 + maxLength: 128 + ImageDescription: + type: string + description: A description of the image. + pattern: .+ + minLength: 1 + maxLength: 512 + Image: + type: object + properties: + ImageName: + $ref: '#/components/schemas/ImageName' + ImageArn: + $ref: '#/components/schemas/ImageArn' + ImageRoleArn: + $ref: '#/components/schemas/ImageRoleArn' + ImageDisplayName: + $ref: '#/components/schemas/ImageDisplayName' + ImageDescription: + $ref: '#/components/schemas/ImageDescription' + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + required: + - ImageName + - ImageRoleArn + x-stackql-resource-name: image + description: Resource Type definition for AWS::SageMaker::Image + x-type-name: AWS::SageMaker::Image + x-stackql-primary-identifier: + - ImageArn + x-stackql-additional-identifiers: + - - ImageName + x-create-only-properties: + - ImageName + x-read-only-properties: + - ImageArn + x-required-properties: + - ImageName + - ImageRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + x-required-permissions: + create: + - sagemaker:CreateImage + - sagemaker:DescribeImage + - iam:PassRole + - sagemaker:AddTags + - sagemaker:ListTags + read: + - sagemaker:DescribeImage + - sagemaker:ListTags + update: + - sagemaker:UpdateImage + - sagemaker:DescribeImage + - sagemaker:ListTags + - sagemaker:AddTags + - sagemaker:DeleteTags + - iam:PassRole + delete: + - sagemaker:DeleteImage + - sagemaker:DescribeImage + list: + - sagemaker:ListImages + ImageVersionArn: + type: string + description: The Amazon Resource Name (ARN) of the image version. + minLength: 1 + maxLength: 256 + pattern: ^arn:aws(-[\w]+)*:sagemaker:[a-z0-9\-]*:[0-9]{12}:image-version\/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*\/[0-9]+$ + BaseImage: + type: string + description: The registry path of the container image on which this image version is based. + minLength: 1 + maxLength: 255 + pattern: .+ + ContainerImage: + description: The image to use for the container that will be materialized for the inference component + type: string + pattern: '[\S]+' + maxLength: 255 + Alias: + type: string + description: The alias of the image version. + minLength: 1 + maxLength: 128 + pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$ + Aliases: + type: array + description: List of aliases for the image version. + items: + $ref: '#/components/schemas/Alias' + Version: + type: integer + description: The version number of the image version. + minimum: 1 + VendorGuidance: + type: string + description: The availability of the image version specified by the maintainer. + enum: + - NOT_PROVIDED + - STABLE + - TO_BE_ARCHIVED + - ARCHIVED + JobType: + type: string + description: Indicates SageMaker job type compatibility. + enum: + - TRAINING + - INFERENCE + - NOTEBOOK_KERNEL + MLFramework: + type: string + description: The machine learning framework vended in the image version. + pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$ + minLength: 1 + maxLength: 128 + ProgrammingLang: + type: string + description: The supported programming language and its version. + pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$ + minLength: 1 + maxLength: 128 + Processor: + type: string + description: Indicates CPU or GPU compatibility. + enum: + - CPU + - GPU + Horovod: + type: boolean + description: Indicates Horovod compatibility. + ReleaseNotes: + type: string + description: The maintainer description of the image version. + pattern: .* + minLength: 1 + maxLength: 255 + ImageVersion: + type: object + properties: + ImageName: + $ref: '#/components/schemas/ImageName' + ImageArn: + $ref: '#/components/schemas/ImageArn' + ImageVersionArn: + $ref: '#/components/schemas/ImageVersionArn' + BaseImage: + $ref: '#/components/schemas/BaseImage' + ContainerImage: + $ref: '#/components/schemas/ContainerImage' + Version: + $ref: '#/components/schemas/Version' + Alias: + $ref: '#/components/schemas/Alias' + Aliases: + $ref: '#/components/schemas/Aliases' + VendorGuidance: + $ref: '#/components/schemas/VendorGuidance' + JobType: + $ref: '#/components/schemas/JobType' + MLFramework: + $ref: '#/components/schemas/MLFramework' + ProgrammingLang: + $ref: '#/components/schemas/ProgrammingLang' + Processor: + $ref: '#/components/schemas/Processor' + Horovod: + $ref: '#/components/schemas/Horovod' + ReleaseNotes: + $ref: '#/components/schemas/ReleaseNotes' + required: + - ImageName + - BaseImage + x-stackql-resource-name: image_version + description: Resource Type definition for AWS::SageMaker::ImageVersion + x-type-name: AWS::SageMaker::ImageVersion + x-stackql-primary-identifier: + - ImageVersionArn + x-create-only-properties: + - ImageName + - BaseImage + x-write-only-properties: + - Aliases + - Alias + x-read-only-properties: + - ImageVersionArn + - ImageArn + - Version + - ContainerImage + x-required-properties: + - ImageName + - BaseImage + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - sagemaker:CreateImageVersion + - sagemaker:DescribeImageVersion + read: + - sagemaker:DescribeImageVersion + update: + - sagemaker:UpdateImageVersion + - sagemaker:DescribeImageVersion + - sagemaker:ListAliases + delete: + - sagemaker:DeleteImageVersion + - sagemaker:DescribeImageVersion + list: + - sagemaker:ListImageVersions + InferenceComponentArn: + description: The Amazon Resource Name (ARN) of the inference component + type: string + minLength: 1 + maxLength: 256 + InferenceComponentName: + description: The name of the inference component + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + maxLength: 63 + EndpointArn: + description: The Amazon Resource Name (ARN) of the endpoint the inference component is associated with + type: string + minLength: 1 + maxLength: 256 + VariantName: + description: The name of the endpoint variant the inference component is associated with + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + maxLength: 63 + FailureReason: + description: The failure reason if the inference component is in a failed state + type: string + maxLength: 63 + ModelName: + description: The name of the model to use with the inference component + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + maxLength: 63 + Timestamp: + type: string + DeployedImage: + description: '' + type: object + additionalProperties: false + properties: + SpecifiedImage: + $ref: '#/components/schemas/ContainerImage' + ResolvedImage: + $ref: '#/components/schemas/ContainerImage' + ResolutionTime: + $ref: '#/components/schemas/Timestamp' + Url: + type: string + pattern: ^(https|s3)://([^/]+)/?(.*)$ + maxLength: 1024 + EnvironmentMap: + description: Environment variables to specify on the container + type: object + additionalProperties: false + maxProperties: 16 + x-patternProperties: + ^[a-zA-Z_][a-zA-Z0-9_]{1,1024}$: + type: string + pattern: ^[\S\s]*$ + maxLength: 1024 + InferenceComponentContainerSpecification: + description: '' + type: object + additionalProperties: false + properties: + DeployedImage: + $ref: '#/components/schemas/DeployedImage' + Image: + $ref: '#/components/schemas/ContainerImage' + ArtifactUrl: + $ref: '#/components/schemas/Url' + Environment: + $ref: '#/components/schemas/EnvironmentMap' + StartupParameterTimeoutInSeconds: + type: integer + minimum: 60 + maximum: 3600 + BaseInferenceComponentName: + description: The name of the base inference component + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ + maxLength: 63 + InferenceComponentStartupParameters: + description: '' + type: object + additionalProperties: false + properties: + ModelDataDownloadTimeoutInSeconds: + $ref: '#/components/schemas/StartupParameterTimeoutInSeconds' + ContainerStartupHealthCheckTimeoutInSeconds: + $ref: '#/components/schemas/StartupParameterTimeoutInSeconds' + NumberOfCpuCores: + type: number + minimum: 0.25 + NumberOfAcceleratorDevices: + type: number + minimum: 1 + MemoryInMb: + type: integer + minimum: 128 + InferenceComponentComputeResourceRequirements: + description: '' + type: object + additionalProperties: false + properties: + NumberOfCpuCoresRequired: + $ref: '#/components/schemas/NumberOfCpuCores' + NumberOfAcceleratorDevicesRequired: + $ref: '#/components/schemas/NumberOfAcceleratorDevices' + MinMemoryRequiredInMb: + $ref: '#/components/schemas/MemoryInMb' + MaxMemoryRequiredInMb: + $ref: '#/components/schemas/MemoryInMb' + InferenceComponentSpecification: + description: The specification for the inference component + type: object + additionalProperties: false + properties: + ModelName: + $ref: '#/components/schemas/ModelName' + BaseInferenceComponentName: + $ref: '#/components/schemas/BaseInferenceComponentName' + Container: + $ref: '#/components/schemas/InferenceComponentContainerSpecification' + StartupParameters: + $ref: '#/components/schemas/InferenceComponentStartupParameters' + ComputeResourceRequirements: + $ref: '#/components/schemas/InferenceComponentComputeResourceRequirements' + InferenceComponentCopyCount: + description: The number of copies for the inference component + type: integer + minimum: 0 + InferenceComponentRuntimeConfig: + description: The runtime config for the inference component + type: object + additionalProperties: false + properties: + CopyCount: + $ref: '#/components/schemas/InferenceComponentCopyCount' + DesiredCopyCount: + $ref: '#/components/schemas/InferenceComponentCopyCount' + CurrentCopyCount: + $ref: '#/components/schemas/InferenceComponentCopyCount' + InferenceComponentDeploymentConfig: + description: The deployment config for the inference component + type: object + additionalProperties: false + properties: + RollingUpdatePolicy: + $ref: '#/components/schemas/InferenceComponentRollingUpdatePolicy' + AutoRollbackConfiguration: + $ref: '#/components/schemas/AutoRollbackConfiguration' + InferenceComponentRollingUpdatePolicy: + description: The rolling update policy for the inference component + type: object + additionalProperties: false + properties: + MaximumBatchSize: + $ref: '#/components/schemas/InferenceComponentCapacitySize' + WaitIntervalInSeconds: + $ref: '#/components/schemas/WaitIntervalInSeconds' + RollbackMaximumBatchSize: + $ref: '#/components/schemas/InferenceComponentCapacitySize' + MaximumExecutionTimeoutInSeconds: + $ref: '#/components/schemas/MaximumExecutionTimeoutInSeconds' + WaitIntervalInSeconds: + type: integer + minimum: 0 + maximum: 3600 + MaximumExecutionTimeoutInSeconds: + type: integer + minimum: 600 + maximum: 28800 + InferenceComponentCapacitySize: + type: object + description: Capacity size configuration for the inference component + required: + - Type + - Value + additionalProperties: false + properties: + Type: + $ref: '#/components/schemas/InferenceComponentCapacitySizeType' + Value: + $ref: '#/components/schemas/CapacitySizeValue' + InferenceComponentCapacitySizeType: + type: string + enum: + - COPY_COUNT + - CAPACITY_PERCENT + CapacitySizeValue: + description: The number of copies for the inference component + type: integer + InferenceComponentStatus: + type: string + enum: + - InService + - Creating + - Updating + - Failed + - Deleting + TagList: + type: array + maxItems: 50 + description: An array of tags to apply to the resource + items: + $ref: '#/components/schemas/Tag' + InferenceComponent: + type: object + properties: + InferenceComponentArn: + $ref: '#/components/schemas/InferenceComponentArn' + InferenceComponentName: + $ref: '#/components/schemas/InferenceComponentName' + EndpointArn: + $ref: '#/components/schemas/EndpointArn' + EndpointName: + $ref: '#/components/schemas/EndpointName' + VariantName: + $ref: '#/components/schemas/VariantName' + FailureReason: + $ref: '#/components/schemas/FailureReason' + Specification: + $ref: '#/components/schemas/InferenceComponentSpecification' + RuntimeConfig: + $ref: '#/components/schemas/InferenceComponentRuntimeConfig' + DeploymentConfig: + $ref: '#/components/schemas/InferenceComponentDeploymentConfig' + InferenceComponentStatus: + $ref: '#/components/schemas/InferenceComponentStatus' + CreationTime: + $ref: '#/components/schemas/Timestamp' + LastModifiedTime: + $ref: '#/components/schemas/Timestamp' + Tags: + $ref: '#/components/schemas/TagList' + required: + - EndpointName + - Specification + x-stackql-resource-name: inference_component + description: Resource Type definition for AWS::SageMaker::InferenceComponent + x-type-name: AWS::SageMaker::InferenceComponent + x-stackql-primary-identifier: + - InferenceComponentArn + x-write-only-properties: + - Specification/Container/Image + - RuntimeConfig/CopyCount + - DeploymentConfig + x-read-only-properties: + - InferenceComponentArn + - Specification/Container/DeployedImage + - RuntimeConfig/DesiredCopyCount + - RuntimeConfig/CurrentCopyCount + - CreationTime + - LastModifiedTime + - FailureReason + - InferenceComponentStatus + x-required-properties: + - EndpointName + - Specification + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + x-required-permissions: + create: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:CreateInferenceComponent + - sagemaker:DescribeInferenceComponent + update: + - sagemaker:UpdateInferenceComponent + - sagemaker:UpdateInferenceComponentRuntimeConfig + - sagemaker:DescribeInferenceComponent + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + delete: + - sagemaker:DescribeInferenceComponent + - sagemaker:DeleteInferenceComponent + - sagemaker:DeleteTags + read: + - sagemaker:DescribeInferenceComponent + - sagemaker:ListTags + list: + - sagemaker:ListInferenceComponents + - sagemaker:DescribeInferenceComponent + - sagemaker:ListTags + EndpointMetadata: + description: The metadata of the endpoint on which the inference experiment ran. + type: object + additionalProperties: false + properties: + EndpointName: + $ref: '#/components/schemas/EndpointName' + EndpointConfigName: + description: The name of the endpoint configuration. + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])* + maxLength: 63 + EndpointStatus: + description: The status of the endpoint. For possible values of the status of an endpoint. + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])* + enum: + - Creating + - Updating + - SystemUpdating + - RollingBack + - InService + - OutOfService + - Deleting + - Failed + required: + - EndpointName + CaptureContentTypeHeader: + description: Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data. + type: object + additionalProperties: false + properties: + CsvContentTypes: + description: The list of all content type headers that SageMaker will treat as CSV and capture accordingly. + type: array + minItems: 1 + maxItems: 10 + items: + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*/[a-zA-Z0-9](-*[a-zA-Z0-9.])* + minLength: 1 + maxLength: 256 + JsonContentTypes: + description: The list of all content type headers that SageMaker will treat as JSON and capture accordingly. + type: array + minItems: 1 + maxItems: 10 + items: + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*/[a-zA-Z0-9](-*[a-zA-Z0-9.])* + minLength: 1 + maxLength: 256 + DataStorageConfig: + description: The Amazon S3 location and configuration for storing inference request and response data. + type: object + additionalProperties: false + properties: + Destination: + description: The Amazon S3 bucket where the inference request and response data is stored. + type: string + pattern: ^(https|s3)://([^/])/?(.*)$ + maxLength: 512 + KmsKey: + description: The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. + type: string + pattern: .* + maxLength: 2048 + ContentType: + $ref: '#/components/schemas/CaptureContentTypeHeader' + required: + - Destination + InferenceExperimentSchedule: + description: The duration for which you want the inference experiment to run. + type: object + additionalProperties: false + properties: + StartTime: + description: The timestamp at which the inference experiment started or will start. + type: string + EndTime: + description: The timestamp at which the inference experiment ended or will end. + type: string + RealTimeInferenceConfig: + description: The infrastructure configuration for deploying the model to a real-time inference endpoint. + type: object + additionalProperties: false + properties: + InstanceType: + description: The instance type the model is deployed to. + type: string + InstanceCount: + description: The number of instances of the type specified by InstanceType. + type: integer + required: + - InstanceType + - InstanceCount + ModelInfrastructureConfig: + description: The configuration for the infrastructure that the model will be deployed to. + type: object + additionalProperties: false + properties: + InfrastructureType: + description: The type of the inference experiment that you want to run. + type: string + enum: + - RealTimeInference + RealTimeInferenceConfig: + $ref: '#/components/schemas/RealTimeInferenceConfig' + required: + - InfrastructureType + - RealTimeInferenceConfig + ModelVariantConfig: + description: Contains information about the deployment options of a model. + type: object + additionalProperties: false + properties: + ModelName: + description: The name of the Amazon SageMaker Model entity. + type: string + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])* + maxLength: 63 + VariantName: + description: The name of the variant. + type: string + pattern: ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])? + maxLength: 63 + InfrastructureConfig: + $ref: '#/components/schemas/ModelInfrastructureConfig' + required: + - ModelName + - VariantName + - InfrastructureConfig + ShadowModelVariantConfig: + description: The name and sampling percentage of a shadow variant. + type: object + additionalProperties: false + properties: + ShadowModelVariantName: + description: The name of the shadow variant. + type: string + pattern: ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])? + maxLength: 63 + SamplingPercentage: + description: The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant. + type: integer + maximum: 100 + required: + - ShadowModelVariantName + - SamplingPercentage + ShadowModeConfig: + description: The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates. + type: object + additionalProperties: false + properties: + SourceModelVariantName: + description: The name of the production variant, which takes all the inference requests. + type: string + pattern: ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])? + maxLength: 63 + ShadowModelVariants: + description: List of shadow variant configurations. + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/ShadowModelVariantConfig' + required: + - SourceModelVariantName + - ShadowModelVariants + InferenceExperiment: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the inference experiment. + type: string + pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-experiment/[a-zA-Z_0-9+=,.@\-_/]+$ + minLength: 20 + maxLength: 256 + Name: + description: The name for the inference experiment. + type: string + minLength: 1 + maxLength: 120 + Type: + description: The type of the inference experiment that you want to run. + type: string + enum: + - ShadowMode + Description: + description: The description of the inference experiment. + type: string + pattern: .* + minLength: 1 + maxLength: 1024 + RoleArn: + description: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. + type: string + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + minLength: 20 + maxLength: 2048 + EndpointName: + $ref: '#/components/schemas/EndpointName' + EndpointMetadata: + $ref: '#/components/schemas/EndpointMetadata' + Schedule: + $ref: '#/components/schemas/InferenceExperimentSchedule' + KmsKey: + type: string + description: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. + pattern: .* + maxLength: 2048 + DataStorageConfig: + $ref: '#/components/schemas/DataStorageConfig' + ModelVariants: + type: array + description: An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant. + maxItems: 2 + items: + $ref: '#/components/schemas/ModelVariantConfig' + ShadowModeConfig: + $ref: '#/components/schemas/ShadowModeConfig' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + CreationTime: + description: The timestamp at which you created the inference experiment. + type: string + LastModifiedTime: + description: The timestamp at which you last modified the inference experiment. + type: string + Status: + description: The status of the inference experiment. + type: string + enum: + - Creating + - Created + - Updating + - Starting + - Stopping + - Running + - Completed + - Cancelled + StatusReason: + description: The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment. + type: string + pattern: .* + minLength: 1 + maxLength: 1024 + DesiredState: + description: The desired state of the experiment after starting or stopping operation. + type: string + enum: + - Running + - Completed + - Cancelled + required: + - Name + - Type + - RoleArn + - EndpointName + - ModelVariants + x-stackql-resource-name: inference_experiment + description: Resource Type definition for AWS::SageMaker::InferenceExperiment + x-type-name: AWS::SageMaker::InferenceExperiment + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - Type + - RoleArn + - EndpointName + - KmsKey + x-read-only-properties: + - Arn + - CreationTime + - LastModifiedTime + - EndpointMetadata + - Status + x-required-properties: + - Name + - Type + - RoleArn + - EndpointName + - ModelVariants + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - sagemaker:CreateInferenceExperiment + - sagemaker:DescribeInferenceExperiment + - sagemaker:AddTags + - sagemaker:ListTags + - iam:PassRole + delete: + - sagemaker:DeleteInferenceExperiment + - sagemaker:DescribeInferenceExperiment + - sagemaker:StopInferenceExperiment + - sagemaker:ListTags + list: + - sagemaker:ListInferenceExperiments + read: + - sagemaker:DescribeInferenceExperiment + - sagemaker:ListTags + update: + - sagemaker:UpdateInferenceExperiment + - sagemaker:StartInferenceExperiment + - sagemaker:StopInferenceExperiment + - sagemaker:DescribeInferenceExperiment + - sagemaker:AddTags + - sagemaker:DeleteTags + - sagemaker:ListTags + MlflowTrackingServer: + type: object + properties: + TrackingServerName: + type: string + description: The name of the MLFlow Tracking Server. + minLength: 1 + maxLength: 256 + pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$ + TrackingServerArn: + description: The Amazon Resource Name (ARN) of the MLFlow Tracking Server. + type: string + maxLength: 2048 + pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:mlflow-tracking-server/.*$ + TrackingServerSize: + type: string + description: The size of the MLFlow Tracking Server. + enum: + - Small + - Medium + - Large + MlflowVersion: + type: string + description: The MLFlow Version used on the MLFlow Tracking Server. + minLength: 1 + maxLength: 32 + pattern: ^\d+(\.\d+)+$ + RoleArn: + type: string + description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. + minLength: 20 + maxLength: 2048 + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role\/?[a-zA-Z_0-9+=,.@\-_\/]+$ + ArtifactStoreUri: + type: string + description: The Amazon S3 URI for MLFlow Tracking Server artifacts. + minLength: 1 + maxLength: 2048 + pattern: ^s3:\/\/([^\/]+)\/?(.*)$ + AutomaticModelRegistration: + type: boolean + description: A flag to enable Automatic SageMaker Model Registration. + WeeklyMaintenanceWindowStart: + type: string + description: The start of the time window for maintenance of the MLFlow Tracking Server in UTC time. + pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)$ + maxLength: 9 + Tags: + type: array + minItems: 1 + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - TrackingServerName + - ArtifactStoreUri + - RoleArn + x-stackql-resource-name: mlflow_tracking_server + description: Resource Type definition for AWS::SageMaker::MlflowTrackingServer + x-type-name: AWS::SageMaker::MlflowTrackingServer + x-stackql-primary-identifier: + - TrackingServerName + x-create-only-properties: + - TrackingServerName + x-conditional-create-only-properties: + - MlflowVersion + - RoleArn + x-read-only-properties: + - TrackingServerArn + x-required-properties: + - TrackingServerName + - ArtifactStoreUri + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + - sagemaker:DeleteTags + x-required-permissions: + create: + - sagemaker:CreateMlflowTrackingServer + - sagemaker:DescribeMlflowTrackingServer + - sagemaker:AddTags + - sagemaker:ListTags + - iam:PassRole + read: + - sagemaker:DescribeMlflowTrackingServer + - sagemaker:ListTags + update: + - sagemaker:UpdateMlflowTrackingServer + - sagemaker:DescribeMlflowTrackingServer + - sagemaker:ListTags + - sagemaker:AddTags + - sagemaker:DeleteTags + - iam:PassRole + delete: + - sagemaker:DeleteMlflowTrackingServer + - sagemaker:DescribeMlflowTrackingServer + list: + - sagemaker:ListMlflowTrackingServers + ModelBiasBaselineConfig: + type: object + additionalProperties: false + description: Baseline configuration used to validate that the data conforms to the specified constraints and statistics. + properties: + BaseliningJobName: + $ref: '#/components/schemas/ProcessingJobName' + ConstraintsResource: + $ref: '#/components/schemas/ConstraintsResource' + ModelBiasAppSpecification: + type: object + additionalProperties: false + description: Container image configuration object for the monitoring job. + properties: + ImageUri: + type: string + description: The container image to be run by the monitoring job. + pattern: .* + maxLength: 255 + ConfigUri: + description: The S3 URI to an analysis configuration file + $ref: '#/components/schemas/S3Uri' + Environment: + type: object + additionalProperties: false + description: Sets the environment variables in the Docker container + x-patternProperties: + '[a-zA-Z_][a-zA-Z0-9_]*': + type: string + minLength: 1 + maxLength: 256 + '[\S\s]*': + type: string + maxLength: 256 + required: + - ImageUri + - ConfigUri + ModelBiasJobInput: + type: object + additionalProperties: false + description: The inputs for a monitoring job. + properties: + EndpointInput: + $ref: '#/components/schemas/EndpointInput' + BatchTransformInput: + $ref: '#/components/schemas/BatchTransformInput' + GroundTruthS3Input: + $ref: '#/components/schemas/MonitoringGroundTruthS3Input' + required: + - GroundTruthS3Input + MonitoringTimeOffsetString: + type: string + description: The time offsets in ISO duration format + pattern: ^.?P.* + minLength: 1 + maxLength: 15 + MonitoringGroundTruthS3Input: + type: object + additionalProperties: false + description: 'Ground truth input provided in S3 ' + properties: + S3Uri: + type: string + description: A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. + pattern: ^(https|s3)://([^/]+)/?(.*)$ + maxLength: 512 + required: + - S3Uri + ModelBiasJobDefinition: + type: object + properties: + JobDefinitionArn: + description: The Amazon Resource Name (ARN) of job definition. + type: string + minLength: 1 + maxLength: 256 + JobDefinitionName: + $ref: '#/components/schemas/JobDefinitionName' + ModelBiasBaselineConfig: + $ref: '#/components/schemas/ModelBiasBaselineConfig' + ModelBiasAppSpecification: + $ref: '#/components/schemas/ModelBiasAppSpecification' + ModelBiasJobInput: + $ref: '#/components/schemas/ModelBiasJobInput' + ModelBiasJobOutputConfig: + $ref: '#/components/schemas/MonitoringOutputConfig' + JobResources: + $ref: '#/components/schemas/MonitoringResources' + NetworkConfig: + $ref: '#/components/schemas/NetworkConfig' + EndpointName: + $ref: '#/components/schemas/EndpointName' + RoleArn: + description: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. + type: string + pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ + minLength: 20 + maxLength: 2048 + StoppingCondition: + $ref: '#/components/schemas/StoppingCondition' + Tags: + type: array + maxItems: 50 + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + CreationTime: + description: The time at which the job definition was created. + type: string + required: + - ModelBiasAppSpecification + - ModelBiasJobInput + - ModelBiasJobOutputConfig + - JobResources + - RoleArn + x-stackql-resource-name: model_bias_job_definition + description: Resource Type definition for AWS::SageMaker::ModelBiasJobDefinition + x-type-name: AWS::SageMaker::ModelBiasJobDefinition + x-stackql-primary-identifier: + - JobDefinitionArn + x-create-only-properties: + - JobDefinitionName + - ModelBiasAppSpecification + - ModelBiasBaselineConfig + - ModelBiasJobInput + - ModelBiasJobOutputConfig + - JobResources + - NetworkConfig + - RoleArn + - StoppingCondition + - Tags + - EndpointName + x-write-only-properties: + - EndpointName + x-read-only-properties: + - CreationTime + - JobDefinitionArn + x-required-properties: + - ModelBiasAppSpecification + - ModelBiasJobInput + - ModelBiasJobOutputConfig + - JobResources + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sagemaker:AddTags + - sagemaker:ListTags + x-required-permissions: + create: + - sagemaker:CreateModelBiasJobDefinition + - sagemaker:DescribeModelBiasJobDefinition + - iam:PassRole + - sagemaker:AddTags + - sagemaker:ListTags + delete: + - sagemaker:DeleteModelBiasJobDefinition + read: + - sagemaker:DescribeModelBiasJobDefinition + - sagemaker:ListTags + list: + - sagemaker:ListModelBiasJobDefinitions + - sagemaker:ListTags + SecurityConfig: + description: An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data. + type: object + additionalProperties: false + properties: + KmsKeyId: + description: The AWS KMS Key ID (KMSKeyId) used for encryption of model package information. + type: string + maxLength: 2048 + pattern: ^[a-zA-Z0-9:/_-]*$ + required: + - KmsKeyId + UserContext: + description: Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. + type: object + additionalProperties: false + properties: + UserProfileArn: + description: The Amazon Resource Name (ARN) of the user's profile. + type: string + default: UnsetValue + UserProfileName: + description: The name of the user's profile. + type: string + default: UnsetValue + DomainId: + description: The domain associated with the user. + type: string + default: UnsetValue + Content: + type: object + description: The content of the model card. + additionalProperties: false + properties: + ModelOverview: + $ref: '#/components/schemas/ModelOverview' + ModelPackageDetails: + $ref: '#/components/schemas/ModelPackageDetails' + IntendedUses: + $ref: '#/components/schemas/IntendedUses' + BusinessDetails: + $ref: '#/components/schemas/BusinessDetails' + TrainingDetails: + $ref: '#/components/schemas/TrainingDetails' + EvaluationDetails: + $ref: '#/components/schemas/EvaluationDetails' + AdditionalInformation: + $ref: '#/components/schemas/AdditionalInformation' + ModelOverview: + type: object + description: Overview about the model. + additionalProperties: false + properties: + ModelDescription: + description: description of model. + type: string + maxLength: 1024 + ModelOwner: + description: Owner of model. + type: string + maxLength: 1024 + ModelCreator: + description: Creator of model. + type: string + maxLength: 1024 + ProblemType: + description: Problem being solved with the model. + type: string + maxLength: 1024 + AlgorithmType: + description: Algorithm used to solve the problem. + type: string + maxLength: 1024 + ModelId: + description: SageMaker Model Arn or Non SageMaker Model id. + type: string + maxLength: 1024 + ModelArtifact: + description: Location of the model artifact. + type: array + x-insertionOrder: true + maxItems: 15 + items: + type: string + maxLength: 1024 + ModelName: + description: Name of the model. + type: string + maxLength: 1024 + ModelVersion: + description: Version of the model. + type: number + minimum: 1 + InferenceEnvironment: + description: Overview about the inference. + type: object + additionalProperties: false + properties: + ContainerImage: + description: SageMaker inference image uri. + type: array + x-insertionOrder: true + maxItems: 15 + items: + type: string + maxLength: 1024 + ModelPackageDetails: + description: Metadata information related to model package version + type: object + additionalProperties: false + properties: + ModelPackageDescription: + description: A brief summary of the model package + type: string + maxLength: 1024 + ModelPackageArn: + description: The Amazon Resource Name (ARN) of the model package + type: string + minLength: 1 + maxLength: 2048 + CreatedBy: + description: Information about the user who created model package. + $ref: '#/components/schemas/ModelPackageCreator' + ModelPackageStatus: + description: Current status of model package + type: string + enum: + - Pending + - InProgress + - Completed + - Failed + - Deleting + ModelApprovalStatus: + description: Current approval status of model package + type: string + enum: + - Approved + - Rejected + - PendingManualApproval + ApprovalDescription: + description: A description provided for the model approval + type: string + maxLength: 1024 + ModelPackageGroupName: + description: If the model is a versioned model, the name of the model group that the versioned model belongs to. + type: string + minLength: 1 + maxLength: 63 + ModelPackageName: + description: Name of the model package + type: string + minLength: 1 + maxLength: 63 + ModelPackageVersion: + description: Version of the model package + type: number + minimum: 1 + Domain: + description: The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing. + type: string + Task: + description: The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification. + type: string + SourceAlgorithms: + description: A list of algorithms that were used to create a model package. + $ref: '#/components/schemas/SourceAlgorithms' + InferenceSpecification: + description: Details about inference jobs that can be run with models based on this model package. + $ref: '#/components/schemas/InferenceSpecification' + IntendedUses: + description: Intended usage of model. + type: object + additionalProperties: false + properties: + PurposeOfModel: + description: Why the model was developed? + type: string + maxLength: 2048 + IntendedUses: + description: intended use cases. + type: string + maxLength: 2048 + FactorsAffectingModelEfficiency: + type: string + maxLength: 2048 + RiskRating: + $ref: '#/components/schemas/RiskRating' + ExplanationsForRiskRating: + type: string + maxLength: 2048 + BusinessDetails: + description: Business details. + type: object + additionalProperties: false + properties: + BusinessProblem: + type: string + description: What business problem does the model solve? + maxLength: 2048 + BusinessStakeholders: + type: string + description: Business stakeholders. + maxLength: 2048 + LineOfBusiness: + type: string + description: Line of business. + maxLength: 2048 + TrainingDetails: + description: Overview about the training. + type: object + additionalProperties: false + properties: + ObjectiveFunction: + $ref: '#/components/schemas/ObjectiveFunction' + TrainingObservations: + type: string + maxLength: 1024 + TrainingJobDetails: + type: object + additionalProperties: false + properties: + TrainingArn: + description: SageMaker Training job arn. + type: string + maxLength: 1024 + TrainingDatasets: + description: Location of the model datasets. + type: array + x-insertionOrder: true + maxItems: 15 + items: + type: string + maxLength: 1024 + TrainingEnvironment: + type: object + additionalProperties: false + properties: + ContainerImage: + description: SageMaker training image uri. + type: array + x-insertionOrder: true + maxItems: 15 + items: + type: string + maxLength: 1024 + TrainingMetrics: + type: array + x-insertionOrder: true + items: + maxItems: 50 + $ref: '#/components/schemas/TrainingMetric' + UserProvidedTrainingMetrics: + type: array + x-insertionOrder: true + items: + maxItems: 50 + $ref: '#/components/schemas/TrainingMetric' + HyperParameters: + type: array + x-insertionOrder: true + items: + maxItems: 100 + $ref: '#/components/schemas/TrainingHyperParameter' + UserProvidedHyperParameters: + type: array + x-insertionOrder: true + items: + maxItems: 100 + $ref: '#/components/schemas/TrainingHyperParameter' + EvaluationDetails: + type: array + default: [] + x-insertionOrder: true + items: + $ref: '#/components/schemas/EvaluationDetail' + EvaluationDetail: + description: item of evaluation details + type: object + required: + - Name + additionalProperties: false + properties: + Name: + type: string + pattern: .{1,63} + EvaluationObservation: + type: string + maxLength: 2096 + EvaluationJobArn: + type: string + maxLength: 256 + Datasets: + type: array + x-insertionOrder: true + items: + type: string + maxLength: 1024 + maxItems: 10 + Metadata: + description: additional attributes associated with the evaluation results. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z_][a-zA-Z0-9_]*': + type: string + maxLength: 1024 + MetricGroups: + type: array + x-insertionOrder: true + default: [] + items: + $ref: '#/components/schemas/MetricGroup' + MetricGroup: + type: object + description: item in metric groups + additionalProperties: false + required: + - Name + - MetricData + properties: + Name: + type: string + pattern: .{1,63} + MetricData: + type: array + x-insertionOrder: true + items: + anyOf: + - $ref: '#/components/schemas/SimpleMetric' + - $ref: '#/components/schemas/LinearGraphMetric' + - $ref: '#/components/schemas/BarChartMetric' + - $ref: '#/components/schemas/MatrixMetric' + AdditionalInformation: + type: object + additionalProperties: false + properties: + EthicalConsiderations: + description: Any ethical considerations that the author wants to provide. + type: string + maxLength: 2048 + CaveatsAndRecommendations: + description: Caveats and recommendations for people who might use this model in their applications. + type: string + maxLength: 2048 + CustomDetails: + type: object + description: customer details. + additionalProperties: false + x-patternProperties: + '[a-zA-Z_][a-zA-Z0-9_]*': + type: string + maxLength: 1024 + ModelPackageCreator: + type: object + additionalProperties: false + properties: + UserProfileName: + description: The name of the user's profile in Studio + type: string + maxLength: 63 + SourceAlgorithms: + type: array + minItems: 1 + maxItems: 1 + x-insertionOrder: true + items: + $ref: '#/components/schemas/SourceAlgorithm' + SourceAlgorithm: + description: Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. + type: object + additionalProperties: false + properties: + AlgorithmName: + description: The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. + type: string + minLength: 1 + maxLength: 170 + pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'AppArn') as app_arn, json_extract_path_text(Properties, 'AppName') as app_name, json_extract_path_text(Properties, 'AppType') as app_type, json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'UserProfileName') as user_profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' + json_extract_path_text(Properties, 'ResourceSpec') as resource_spec, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, + json_extract_path_text(Properties, 'BuiltInLifecycleConfigArn') as built_in_lifecycle_config_arn, + json_extract_path_text(Properties, 'RecoveryMode') as recovery_mode + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::App' + AND data__Identifier = '|||' AND region = 'us-east-1' - app: - name: app - id: awscc.sagemaker.app + apps_list_only: + name: apps_list_only + id: awscc.sagemaker.apps_list_only x-cfn-schema-name: App - x-type: get + x-cfn-type-name: AWS::SageMaker::App x-identifiers: - AppName - AppType - DomainId - UserProfileName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5096,40 +9784,123 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AppArn') as app_arn, JSON_EXTRACT(Properties, '$.AppName') as app_name, JSON_EXTRACT(Properties, '$.AppType') as app_type, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.ResourceSpec') as resource_spec, - JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::App' - AND data__Identifier = '|||' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppArn') as app_arn, json_extract_path_text(Properties, 'AppName') as app_name, json_extract_path_text(Properties, 'AppType') as app_type, json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'ResourceSpec') as resource_spec, - json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'UserProfileName') as user_profile_name - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::App' - AND data__Identifier = '|||' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' AND region = 'us-east-1' app_image_configs: name: app_image_configs id: awscc.sagemaker.app_image_configs x-cfn-schema-name: AppImageConfig - x-type: list + x-cfn-type-name: AWS::SageMaker::AppImageConfig + x-identifiers: + - AppImageConfigName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AppImageConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::AppImageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::AppImageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::AppImageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AppImageConfigArn') as app_image_config_arn, + JSON_EXTRACT(Properties, '$.AppImageConfigName') as app_image_config_name, + JSON_EXTRACT(Properties, '$.KernelGatewayImageConfig') as kernel_gateway_image_config, + JSON_EXTRACT(Properties, '$.JupyterLabAppImageConfig') as jupyter_lab_app_image_config, + JSON_EXTRACT(Properties, '$.CodeEditorAppImageConfig') as code_editor_app_image_config, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppImageConfigArn') as app_image_config_arn, + json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name, + json_extract_path_text(Properties, 'KernelGatewayImageConfig') as kernel_gateway_image_config, + json_extract_path_text(Properties, 'JupyterLabAppImageConfig') as jupyter_lab_app_image_config, + json_extract_path_text(Properties, 'CodeEditorAppImageConfig') as code_editor_app_image_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + app_image_configs_list_only: + name: app_image_configs_list_only + id: awscc.sagemaker.app_image_configs_list_only + x-cfn-schema-name: AppImageConfig + x-cfn-type-name: AWS::SageMaker::AppImageConfig x-identifiers: - AppImageConfigName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5148,50 +9919,122 @@ components: json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' AND region = 'us-east-1' - app_image_config: - name: app_image_config - id: awscc.sagemaker.app_image_config - x-cfn-schema-name: AppImageConfig - x-type: get + clusters: + name: clusters + id: awscc.sagemaker.clusters + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::SageMaker::Cluster x-identifiers: - - AppImageConfigName + - ClusterArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Cluster" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AppImageConfigArn') as app_image_config_arn, - JSON_EXTRACT(Properties, '$.AppImageConfigName') as app_image_config_name, - JSON_EXTRACT(Properties, '$.KernelGatewayImageConfig') as kernel_gateway_image_config, - JSON_EXTRACT(Properties, '$.JupyterLabAppImageConfig') as jupyter_lab_app_image_config, + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn, + JSON_EXTRACT(Properties, '$.VpcConfig') as vpc_config, + JSON_EXTRACT(Properties, '$.NodeRecovery') as node_recovery, + JSON_EXTRACT(Properties, '$.InstanceGroups') as instance_groups, + JSON_EXTRACT(Properties, '$.RestrictedInstanceGroups') as restricted_instance_groups, + JSON_EXTRACT(Properties, '$.Orchestrator') as orchestrator, + JSON_EXTRACT(Properties, '$.ClusterRole') as cluster_role, + JSON_EXTRACT(Properties, '$.NodeProvisioningMode') as node_provisioning_mode, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.FailureMessage') as failure_message, + JSON_EXTRACT(Properties, '$.AutoScaling') as auto_scaling, + JSON_EXTRACT(Properties, '$.ClusterStatus') as cluster_status, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Cluster' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AppImageConfigArn') as app_image_config_arn, - json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name, - json_extract_path_text(Properties, 'KernelGatewayImageConfig') as kernel_gateway_image_config, - json_extract_path_text(Properties, 'JupyterLabAppImageConfig') as jupyter_lab_app_image_config, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, + json_extract_path_text(Properties, 'VpcConfig') as vpc_config, + json_extract_path_text(Properties, 'NodeRecovery') as node_recovery, + json_extract_path_text(Properties, 'InstanceGroups') as instance_groups, + json_extract_path_text(Properties, 'RestrictedInstanceGroups') as restricted_instance_groups, + json_extract_path_text(Properties, 'Orchestrator') as orchestrator, + json_extract_path_text(Properties, 'ClusterRole') as cluster_role, + json_extract_path_text(Properties, 'NodeProvisioningMode') as node_provisioning_mode, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'FailureMessage') as failure_message, + json_extract_path_text(Properties, 'AutoScaling') as auto_scaling, + json_extract_path_text(Properties, 'ClusterStatus') as cluster_status, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Cluster' + AND data__Identifier = '' AND region = 'us-east-1' - data_quality_job_definitions: - name: data_quality_job_definitions - id: awscc.sagemaker.data_quality_job_definitions - x-cfn-schema-name: DataQualityJobDefinition - x-type: list + clusters_list_only: + name: clusters_list_only + id: awscc.sagemaker.clusters_list_only + x-cfn-schema-name: Cluster + x-cfn-type-name: AWS::SageMaker::Cluster x-identifiers: - - JobDefinitionArn + - ClusterArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5199,28 +10042,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Cluster' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Cluster' AND region = 'us-east-1' - data_quality_job_definition: - name: data_quality_job_definition - id: awscc.sagemaker.data_quality_job_definition + data_quality_job_definitions: + name: data_quality_job_definitions + id: awscc.sagemaker.data_quality_job_definitions x-cfn-schema-name: DataQualityJobDefinition - x-type: get + x-cfn-type-name: AWS::SageMaker::DataQualityJobDefinition x-identifiers: - JobDefinitionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataQualityJobDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::DataQualityJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::DataQualityJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_quality_job_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_quality_job_definitions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5242,7 +10120,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5263,17 +10141,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' AND data__Identifier = '' AND region = 'us-east-1' - device: - name: device - id: awscc.sagemaker.device + data_quality_job_definitions_list_only: + name: data_quality_job_definitions_list_only + id: awscc.sagemaker.data_quality_job_definitions_list_only + x-cfn-schema-name: DataQualityJobDefinition + x-cfn-type-name: AWS::SageMaker::DataQualityJobDefinition + x-identifiers: + - JobDefinitionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' + AND region = 'us-east-1' + devices: + name: devices + id: awscc.sagemaker.devices x-cfn-schema-name: Device - x-type: get + x-cfn-type-name: AWS::SageMaker::Device x-identifiers: - Device/DeviceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Device&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Device" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Device" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Device" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/devices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5285,7 +10242,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5296,17 +10253,65 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Device' AND data__Identifier = '' AND region = 'us-east-1' - device_fleet: - name: device_fleet - id: awscc.sagemaker.device_fleet + device_fleets: + name: device_fleets + id: awscc.sagemaker.device_fleets x-cfn-schema-name: DeviceFleet - x-type: get + x-cfn-type-name: AWS::SageMaker::DeviceFleet x-identifiers: - DeviceFleetName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DeviceFleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::DeviceFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::DeviceFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::DeviceFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/device_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/device_fleets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/device_fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5320,7 +10325,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5333,13 +10338,110 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::DeviceFleet' AND data__Identifier = '' AND region = 'us-east-1' - feature_groups: - name: feature_groups - id: awscc.sagemaker.feature_groups - x-cfn-schema-name: FeatureGroup - x-type: list + endpoints: + name: endpoints + id: awscc.sagemaker.endpoints + x-cfn-schema-name: Endpoint + x-cfn-type-name: AWS::SageMaker::Endpoint x-identifiers: - - FeatureGroupName + - EndpointArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Endpoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Endpoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DeploymentConfig') as deployment_config, + JSON_EXTRACT(Properties, '$.EndpointArn') as endpoint_arn, + JSON_EXTRACT(Properties, '$.EndpointConfigName') as endpoint_config_name, + JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name, + JSON_EXTRACT(Properties, '$.ExcludeRetainedVariantProperties') as exclude_retained_variant_properties, + JSON_EXTRACT(Properties, '$.RetainAllVariantProperties') as retain_all_variant_properties, + JSON_EXTRACT(Properties, '$.RetainDeploymentConfig') as retain_deployment_config, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Endpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeploymentConfig') as deployment_config, + json_extract_path_text(Properties, 'EndpointArn') as endpoint_arn, + json_extract_path_text(Properties, 'EndpointConfigName') as endpoint_config_name, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'ExcludeRetainedVariantProperties') as exclude_retained_variant_properties, + json_extract_path_text(Properties, 'RetainAllVariantProperties') as retain_all_variant_properties, + json_extract_path_text(Properties, 'RetainDeploymentConfig') as retain_deployment_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Endpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + endpoints_list_only: + name: endpoints_list_only + id: awscc.sagemaker.endpoints_list_only + x-cfn-schema-name: Endpoint + x-cfn-type-name: AWS::SageMaker::Endpoint + x-identifiers: + - EndpointArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5347,28 +10449,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.FeatureGroupName') as feature_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' + JSON_EXTRACT(Properties, '$.EndpointArn') as endpoint_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Endpoint' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'FeatureGroupName') as feature_group_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' + json_extract_path_text(Properties, 'EndpointArn') as endpoint_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Endpoint' AND region = 'us-east-1' - feature_group: - name: feature_group - id: awscc.sagemaker.feature_group + feature_groups: + name: feature_groups + id: awscc.sagemaker.feature_groups x-cfn-schema-name: FeatureGroup - x-type: get + x-cfn-type-name: AWS::SageMaker::FeatureGroup x-identifiers: - FeatureGroupName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FeatureGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::FeatureGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::FeatureGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::FeatureGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5389,7 +10539,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5409,13 +10559,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' AND data__Identifier = '' AND region = 'us-east-1' - images: - name: images - id: awscc.sagemaker.images - x-cfn-schema-name: Image - x-type: list + feature_groups_list_only: + name: feature_groups_list_only + id: awscc.sagemaker.feature_groups_list_only + x-cfn-schema-name: FeatureGroup + x-cfn-type-name: AWS::SageMaker::FeatureGroup x-identifiers: - - ImageArn + - FeatureGroupName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5423,28 +10579,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ImageArn') as image_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' + JSON_EXTRACT(Properties, '$.FeatureGroupName') as feature_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ImageArn') as image_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' + json_extract_path_text(Properties, 'FeatureGroupName') as feature_group_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' AND region = 'us-east-1' - image: - name: image - id: awscc.sagemaker.image + images: + name: images + id: awscc.sagemaker.images x-cfn-schema-name: Image - x-type: get + x-cfn-type-name: AWS::SageMaker::Image x-identifiers: - ImageArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Image&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Image" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Image" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Image" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/images/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/images/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/images/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5459,7 +10663,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5473,13 +10677,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Image' AND data__Identifier = '' AND region = 'us-east-1' - image_versions: - name: image_versions - id: awscc.sagemaker.image_versions - x-cfn-schema-name: ImageVersion - x-type: list + images_list_only: + name: images_list_only + id: awscc.sagemaker.images_list_only + x-cfn-schema-name: Image + x-cfn-type-name: AWS::SageMaker::Image x-identifiers: - - ImageVersionArn + - ImageArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5487,28 +10697,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ImageVersionArn') as image_version_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' + JSON_EXTRACT(Properties, '$.ImageArn') as image_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ImageVersionArn') as image_version_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' + json_extract_path_text(Properties, 'ImageArn') as image_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' AND region = 'us-east-1' - image_version: - name: image_version - id: awscc.sagemaker.image_version + image_versions: + name: image_versions + id: awscc.sagemaker.image_versions x-cfn-schema-name: ImageVersion - x-type: get + x-cfn-type-name: AWS::SageMaker::ImageVersion x-identifiers: - ImageVersionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ImageVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ImageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ImageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ImageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/image_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/image_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/image_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5532,7 +10790,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5555,13 +10813,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' AND data__Identifier = '' AND region = 'us-east-1' - inference_components: - name: inference_components - id: awscc.sagemaker.inference_components - x-cfn-schema-name: InferenceComponent - x-type: list + image_versions_list_only: + name: image_versions_list_only + id: awscc.sagemaker.image_versions_list_only + x-cfn-schema-name: ImageVersion + x-cfn-type-name: AWS::SageMaker::ImageVersion x-identifiers: - - InferenceComponentArn + - ImageVersionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5569,28 +10833,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InferenceComponentArn') as inference_component_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' + JSON_EXTRACT(Properties, '$.ImageVersionArn') as image_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InferenceComponentArn') as inference_component_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' + json_extract_path_text(Properties, 'ImageVersionArn') as image_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' AND region = 'us-east-1' - inference_component: - name: inference_component - id: awscc.sagemaker.inference_component + inference_components: + name: inference_components + id: awscc.sagemaker.inference_components x-cfn-schema-name: InferenceComponent - x-type: get + x-cfn-type-name: AWS::SageMaker::InferenceComponent x-identifiers: - InferenceComponentArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InferenceComponent&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::InferenceComponent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::InferenceComponent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::InferenceComponent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inference_components/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inference_components/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/inference_components/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5603,6 +10915,7 @@ components: JSON_EXTRACT(Properties, '$.FailureReason') as failure_reason, JSON_EXTRACT(Properties, '$.Specification') as specification, JSON_EXTRACT(Properties, '$.RuntimeConfig') as runtime_config, + JSON_EXTRACT(Properties, '$.DeploymentConfig') as deployment_config, JSON_EXTRACT(Properties, '$.InferenceComponentStatus') as inference_component_status, JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, @@ -5611,7 +10924,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5624,6 +10937,7 @@ components: json_extract_path_text(Properties, 'FailureReason') as failure_reason, json_extract_path_text(Properties, 'Specification') as specification, json_extract_path_text(Properties, 'RuntimeConfig') as runtime_config, + json_extract_path_text(Properties, 'DeploymentConfig') as deployment_config, json_extract_path_text(Properties, 'InferenceComponentStatus') as inference_component_status, json_extract_path_text(Properties, 'CreationTime') as creation_time, json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, @@ -5631,13 +10945,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' AND data__Identifier = '' AND region = 'us-east-1' - inference_experiments: - name: inference_experiments - id: awscc.sagemaker.inference_experiments - x-cfn-schema-name: InferenceExperiment - x-type: list + inference_components_list_only: + name: inference_components_list_only + id: awscc.sagemaker.inference_components_list_only + x-cfn-schema-name: InferenceComponent + x-cfn-type-name: AWS::SageMaker::InferenceComponent x-identifiers: - - Name + - InferenceComponentArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5645,28 +10965,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' + JSON_EXTRACT(Properties, '$.InferenceComponentArn') as inference_component_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' + json_extract_path_text(Properties, 'InferenceComponentArn') as inference_component_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' AND region = 'us-east-1' - inference_experiment: - name: inference_experiment - id: awscc.sagemaker.inference_experiment + inference_experiments: + name: inference_experiments + id: awscc.sagemaker.inference_experiments x-cfn-schema-name: InferenceExperiment - x-type: get + x-cfn-type-name: AWS::SageMaker::InferenceExperiment x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InferenceExperiment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::InferenceExperiment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::InferenceExperiment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::InferenceExperiment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5693,7 +11061,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5719,13 +11087,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' AND data__Identifier = '' AND region = 'us-east-1' - model_bias_job_definitions: - name: model_bias_job_definitions - id: awscc.sagemaker.model_bias_job_definitions - x-cfn-schema-name: ModelBiasJobDefinition - x-type: list + inference_experiments_list_only: + name: inference_experiments_list_only + id: awscc.sagemaker.inference_experiments_list_only + x-cfn-schema-name: InferenceExperiment + x-cfn-type-name: AWS::SageMaker::InferenceExperiment x-identifiers: - - JobDefinitionArn + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5733,77 +11107,123 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' AND region = 'us-east-1' - model_bias_job_definition: - name: model_bias_job_definition - id: awscc.sagemaker.model_bias_job_definition - x-cfn-schema-name: ModelBiasJobDefinition - x-type: get + mlflow_tracking_servers: + name: mlflow_tracking_servers + id: awscc.sagemaker.mlflow_tracking_servers + x-cfn-schema-name: MlflowTrackingServer + x-cfn-type-name: AWS::SageMaker::MlflowTrackingServer x-identifiers: - - JobDefinitionArn + - TrackingServerName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MlflowTrackingServer&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::MlflowTrackingServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::MlflowTrackingServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::MlflowTrackingServer" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mlflow_tracking_servers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mlflow_tracking_servers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mlflow_tracking_servers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn, - JSON_EXTRACT(Properties, '$.JobDefinitionName') as job_definition_name, - JSON_EXTRACT(Properties, '$.ModelBiasBaselineConfig') as model_bias_baseline_config, - JSON_EXTRACT(Properties, '$.ModelBiasAppSpecification') as model_bias_app_specification, - JSON_EXTRACT(Properties, '$.ModelBiasJobInput') as model_bias_job_input, - JSON_EXTRACT(Properties, '$.ModelBiasJobOutputConfig') as model_bias_job_output_config, - JSON_EXTRACT(Properties, '$.JobResources') as job_resources, - JSON_EXTRACT(Properties, '$.NetworkConfig') as network_config, - JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name, + JSON_EXTRACT(Properties, '$.TrackingServerName') as tracking_server_name, + JSON_EXTRACT(Properties, '$.TrackingServerArn') as tracking_server_arn, + JSON_EXTRACT(Properties, '$.TrackingServerSize') as tracking_server_size, + JSON_EXTRACT(Properties, '$.MlflowVersion') as mlflow_version, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.StoppingCondition') as stopping_condition, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.CreationTime') as creation_time - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ArtifactStoreUri') as artifact_store_uri, + JSON_EXTRACT(Properties, '$.AutomaticModelRegistration') as automatic_model_registration, + JSON_EXTRACT(Properties, '$.WeeklyMaintenanceWindowStart') as weekly_maintenance_window_start, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::MlflowTrackingServer' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, - json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, - json_extract_path_text(Properties, 'ModelBiasBaselineConfig') as model_bias_baseline_config, - json_extract_path_text(Properties, 'ModelBiasAppSpecification') as model_bias_app_specification, - json_extract_path_text(Properties, 'ModelBiasJobInput') as model_bias_job_input, - json_extract_path_text(Properties, 'ModelBiasJobOutputConfig') as model_bias_job_output_config, - json_extract_path_text(Properties, 'JobResources') as job_resources, - json_extract_path_text(Properties, 'NetworkConfig') as network_config, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'TrackingServerName') as tracking_server_name, + json_extract_path_text(Properties, 'TrackingServerArn') as tracking_server_arn, + json_extract_path_text(Properties, 'TrackingServerSize') as tracking_server_size, + json_extract_path_text(Properties, 'MlflowVersion') as mlflow_version, json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' - AND data__Identifier = '' + json_extract_path_text(Properties, 'ArtifactStoreUri') as artifact_store_uri, + json_extract_path_text(Properties, 'AutomaticModelRegistration') as automatic_model_registration, + json_extract_path_text(Properties, 'WeeklyMaintenanceWindowStart') as weekly_maintenance_window_start, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::MlflowTrackingServer' + AND data__Identifier = '' AND region = 'us-east-1' - model_cards: - name: model_cards - id: awscc.sagemaker.model_cards - x-cfn-schema-name: ModelCard - x-type: list + mlflow_tracking_servers_list_only: + name: mlflow_tracking_servers_list_only + id: awscc.sagemaker.mlflow_tracking_servers_list_only + x-cfn-schema-name: MlflowTrackingServer + x-cfn-type-name: AWS::SageMaker::MlflowTrackingServer x-identifiers: - - ModelCardName + - TrackingServerName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5811,75 +11231,118 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ModelCardName') as model_card_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelCard' + JSON_EXTRACT(Properties, '$.TrackingServerName') as tracking_server_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MlflowTrackingServer' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ModelCardName') as model_card_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelCard' + json_extract_path_text(Properties, 'TrackingServerName') as tracking_server_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MlflowTrackingServer' AND region = 'us-east-1' - model_card: - name: model_card - id: awscc.sagemaker.model_card - x-cfn-schema-name: ModelCard - x-type: get + model_bias_job_definitions: + name: model_bias_job_definitions + id: awscc.sagemaker.model_bias_job_definitions + x-cfn-schema-name: ModelBiasJobDefinition + x-cfn-type-name: AWS::SageMaker::ModelBiasJobDefinition x-identifiers: - - ModelCardName + - JobDefinitionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModelBiasJobDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelBiasJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelBiasJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_bias_job_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_bias_job_definitions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ModelCardArn') as model_card_arn, - JSON_EXTRACT(Properties, '$.ModelCardVersion') as model_card_version, - JSON_EXTRACT(Properties, '$.ModelCardName') as model_card_name, - JSON_EXTRACT(Properties, '$.SecurityConfig') as security_config, - JSON_EXTRACT(Properties, '$.ModelCardStatus') as model_card_status, - JSON_EXTRACT(Properties, '$.Content') as content, - JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, - JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, - JSON_EXTRACT(Properties, '$.LastModifiedBy') as last_modified_by, - JSON_EXTRACT(Properties, '$.ModelCardProcessingStatus') as model_card_processing_status, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelCard' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn, + JSON_EXTRACT(Properties, '$.JobDefinitionName') as job_definition_name, + JSON_EXTRACT(Properties, '$.ModelBiasBaselineConfig') as model_bias_baseline_config, + JSON_EXTRACT(Properties, '$.ModelBiasAppSpecification') as model_bias_app_specification, + JSON_EXTRACT(Properties, '$.ModelBiasJobInput') as model_bias_job_input, + JSON_EXTRACT(Properties, '$.ModelBiasJobOutputConfig') as model_bias_job_output_config, + JSON_EXTRACT(Properties, '$.JobResources') as job_resources, + JSON_EXTRACT(Properties, '$.NetworkConfig') as network_config, + JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.StoppingCondition') as stopping_condition, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ModelCardArn') as model_card_arn, - json_extract_path_text(Properties, 'ModelCardVersion') as model_card_version, - json_extract_path_text(Properties, 'ModelCardName') as model_card_name, - json_extract_path_text(Properties, 'SecurityConfig') as security_config, - json_extract_path_text(Properties, 'ModelCardStatus') as model_card_status, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'LastModifiedBy') as last_modified_by, - json_extract_path_text(Properties, 'ModelCardProcessingStatus') as model_card_processing_status, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelCard' - AND data__Identifier = '' + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, + json_extract_path_text(Properties, 'ModelBiasBaselineConfig') as model_bias_baseline_config, + json_extract_path_text(Properties, 'ModelBiasAppSpecification') as model_bias_app_specification, + json_extract_path_text(Properties, 'ModelBiasJobInput') as model_bias_job_input, + json_extract_path_text(Properties, 'ModelBiasJobOutputConfig') as model_bias_job_output_config, + json_extract_path_text(Properties, 'JobResources') as job_resources, + json_extract_path_text(Properties, 'NetworkConfig') as network_config, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' + AND data__Identifier = '' AND region = 'us-east-1' - model_explainability_job_definitions: - name: model_explainability_job_definitions - id: awscc.sagemaker.model_explainability_job_definitions - x-cfn-schema-name: ModelExplainabilityJobDefinition - x-type: list + model_bias_job_definitions_list_only: + name: model_bias_job_definitions_list_only + id: awscc.sagemaker.model_bias_job_definitions_list_only + x-cfn-schema-name: ModelBiasJobDefinition + x-cfn-type-name: AWS::SageMaker::ModelBiasJobDefinition x-identifiers: - JobDefinitionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5888,7 +11351,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -5896,19 +11359,54 @@ components: SELECT region, json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' AND region = 'us-east-1' - model_explainability_job_definition: - name: model_explainability_job_definition - id: awscc.sagemaker.model_explainability_job_definition + model_explainability_job_definitions: + name: model_explainability_job_definitions + id: awscc.sagemaker.model_explainability_job_definitions x-cfn-schema-name: ModelExplainabilityJobDefinition - x-type: get + x-cfn-type-name: AWS::SageMaker::ModelExplainabilityJobDefinition x-identifiers: - JobDefinitionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModelExplainabilityJobDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelExplainabilityJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelExplainabilityJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_explainability_job_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_explainability_job_definitions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5930,7 +11428,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5951,13 +11449,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' AND data__Identifier = '' AND region = 'us-east-1' - model_packages: - name: model_packages - id: awscc.sagemaker.model_packages - x-cfn-schema-name: ModelPackage - x-type: list + model_explainability_job_definitions_list_only: + name: model_explainability_job_definitions_list_only + id: awscc.sagemaker.model_explainability_job_definitions_list_only + x-cfn-schema-name: ModelExplainabilityJobDefinition + x-cfn-type-name: AWS::SageMaker::ModelExplainabilityJobDefinition x-identifiers: - - ModelPackageArn + - JobDefinitionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -5965,28 +11469,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ModelPackageArn') as model_package_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ModelPackageArn') as model_package_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' AND region = 'us-east-1' - model_package: - name: model_package - id: awscc.sagemaker.model_package + model_packages: + name: model_packages + id: awscc.sagemaker.model_packages x-cfn-schema-name: ModelPackage - x-type: get + x-cfn-type-name: AWS::SageMaker::ModelPackage x-identifiers: - ModelPackageArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModelPackage&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelPackage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelPackage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelPackage" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_packages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_packages/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/model_packages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6017,12 +11569,15 @@ components: JSON_EXTRACT(Properties, '$.ModelPackageStatus') as model_package_status, JSON_EXTRACT(Properties, '$.ModelPackageVersion') as model_package_version, JSON_EXTRACT(Properties, '$.AdditionalInferenceSpecificationsToAdd') as additional_inference_specifications_to_add, - JSON_EXTRACT(Properties, '$.ModelPackageStatusDetails') as model_package_status_details + JSON_EXTRACT(Properties, '$.ModelPackageStatusDetails') as model_package_status_details, + JSON_EXTRACT(Properties, '$.SourceUri') as source_uri, + JSON_EXTRACT(Properties, '$.ModelCard') as model_card, + JSON_EXTRACT(Properties, '$.SecurityConfig') as security_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6053,17 +11608,26 @@ components: json_extract_path_text(Properties, 'ModelPackageStatus') as model_package_status, json_extract_path_text(Properties, 'ModelPackageVersion') as model_package_version, json_extract_path_text(Properties, 'AdditionalInferenceSpecificationsToAdd') as additional_inference_specifications_to_add, - json_extract_path_text(Properties, 'ModelPackageStatusDetails') as model_package_status_details + json_extract_path_text(Properties, 'ModelPackageStatusDetails') as model_package_status_details, + json_extract_path_text(Properties, 'SourceUri') as source_uri, + json_extract_path_text(Properties, 'ModelCard') as model_card, + json_extract_path_text(Properties, 'SecurityConfig') as security_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' AND data__Identifier = '' AND region = 'us-east-1' - model_package_groups: - name: model_package_groups - id: awscc.sagemaker.model_package_groups - x-cfn-schema-name: ModelPackageGroup - x-type: list + model_packages_list_only: + name: model_packages_list_only + id: awscc.sagemaker.model_packages_list_only + x-cfn-schema-name: ModelPackage + x-cfn-type-name: AWS::SageMaker::ModelPackage x-identifiers: - - ModelPackageGroupArn + - ModelPackageArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6071,28 +11635,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ModelPackageGroupArn') as model_package_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' + JSON_EXTRACT(Properties, '$.ModelPackageArn') as model_package_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ModelPackageGroupArn') as model_package_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' + json_extract_path_text(Properties, 'ModelPackageArn') as model_package_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' AND region = 'us-east-1' - model_package_group: - name: model_package_group - id: awscc.sagemaker.model_package_group + model_package_groups: + name: model_package_groups + id: awscc.sagemaker.model_package_groups x-cfn-schema-name: ModelPackageGroup - x-type: get + x-cfn-type-name: AWS::SageMaker::ModelPackageGroup x-identifiers: - ModelPackageGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModelPackageGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelPackageGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelPackageGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelPackageGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6108,7 +11720,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6123,13 +11735,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' AND data__Identifier = '' AND region = 'us-east-1' - model_quality_job_definitions: - name: model_quality_job_definitions - id: awscc.sagemaker.model_quality_job_definitions - x-cfn-schema-name: ModelQualityJobDefinition - x-type: list + model_package_groups_list_only: + name: model_package_groups_list_only + id: awscc.sagemaker.model_package_groups_list_only + x-cfn-schema-name: ModelPackageGroup + x-cfn-type-name: AWS::SageMaker::ModelPackageGroup x-identifiers: - - JobDefinitionArn + - ModelPackageGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6137,28 +11755,63 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' + JSON_EXTRACT(Properties, '$.ModelPackageGroupArn') as model_package_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' + json_extract_path_text(Properties, 'ModelPackageGroupArn') as model_package_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' AND region = 'us-east-1' - model_quality_job_definition: - name: model_quality_job_definition - id: awscc.sagemaker.model_quality_job_definition + model_quality_job_definitions: + name: model_quality_job_definitions + id: awscc.sagemaker.model_quality_job_definitions x-cfn-schema-name: ModelQualityJobDefinition - x-type: get + x-cfn-type-name: AWS::SageMaker::ModelQualityJobDefinition x-identifiers: - JobDefinitionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ModelQualityJobDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelQualityJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ModelQualityJobDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_quality_job_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_quality_job_definitions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6180,7 +11833,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6201,13 +11854,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' AND data__Identifier = '' AND region = 'us-east-1' - monitoring_schedules: - name: monitoring_schedules - id: awscc.sagemaker.monitoring_schedules - x-cfn-schema-name: MonitoringSchedule - x-type: list + model_quality_job_definitions_list_only: + name: model_quality_job_definitions_list_only + id: awscc.sagemaker.model_quality_job_definitions_list_only + x-cfn-schema-name: ModelQualityJobDefinition + x-cfn-type-name: AWS::SageMaker::ModelQualityJobDefinition x-identifiers: - - MonitoringScheduleArn + - JobDefinitionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6215,28 +11874,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.MonitoringScheduleArn') as monitoring_schedule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' AND region = 'us-east-1' - monitoring_schedule: - name: monitoring_schedule - id: awscc.sagemaker.monitoring_schedule + monitoring_schedules: + name: monitoring_schedules + id: awscc.sagemaker.monitoring_schedules x-cfn-schema-name: MonitoringSchedule - x-type: get + x-cfn-type-name: AWS::SageMaker::MonitoringSchedule x-identifiers: - MonitoringScheduleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MonitoringSchedule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::MonitoringSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::MonitoringSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::MonitoringSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6255,7 +11962,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6273,13 +11980,151 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' AND data__Identifier = '' AND region = 'us-east-1' - pipelines: - name: pipelines - id: awscc.sagemaker.pipelines - x-cfn-schema-name: Pipeline - x-type: list + monitoring_schedules_list_only: + name: monitoring_schedules_list_only + id: awscc.sagemaker.monitoring_schedules_list_only + x-cfn-schema-name: MonitoringSchedule + x-cfn-type-name: AWS::SageMaker::MonitoringSchedule + x-identifiers: + - MonitoringScheduleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.MonitoringScheduleArn') as monitoring_schedule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' + AND region = 'us-east-1' + partner_apps: + name: partner_apps + id: awscc.sagemaker.partner_apps + x-cfn-schema-name: PartnerApp + x-cfn-type-name: AWS::SageMaker::PartnerApp + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PartnerApp&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::PartnerApp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::PartnerApp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::PartnerApp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/partner_apps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/partner_apps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/partner_apps/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.Tier') as tier, + JSON_EXTRACT(Properties, '$.EnableIamSessionBasedIdentity') as enable_iam_session_based_identity, + JSON_EXTRACT(Properties, '$.ApplicationConfig') as application_config, + JSON_EXTRACT(Properties, '$.AuthType') as auth_type, + JSON_EXTRACT(Properties, '$.BaseUrl') as base_url, + JSON_EXTRACT(Properties, '$.MaintenanceConfig') as maintenance_config, + JSON_EXTRACT(Properties, '$.ClientToken') as client_token, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::PartnerApp' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'EnableIamSessionBasedIdentity') as enable_iam_session_based_identity, + json_extract_path_text(Properties, 'ApplicationConfig') as application_config, + json_extract_path_text(Properties, 'AuthType') as auth_type, + json_extract_path_text(Properties, 'BaseUrl') as base_url, + json_extract_path_text(Properties, 'MaintenanceConfig') as maintenance_config, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::PartnerApp' + AND data__Identifier = '' + AND region = 'us-east-1' + partner_apps_list_only: + name: partner_apps_list_only + id: awscc.sagemaker.partner_apps_list_only + x-cfn-schema-name: PartnerApp + x-cfn-type-name: AWS::SageMaker::PartnerApp x-identifiers: - - PipelineName + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6287,28 +12132,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::PartnerApp' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::PartnerApp' AND region = 'us-east-1' - pipeline: - name: pipeline - id: awscc.sagemaker.pipeline + pipelines: + name: pipelines + id: awscc.sagemaker.pipelines x-cfn-schema-name: Pipeline - x-type: get + x-cfn-type-name: AWS::SageMaker::Pipeline x-identifiers: - PipelineName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Pipeline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6324,7 +12217,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6339,13 +12232,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Pipeline' AND data__Identifier = '' AND region = 'us-east-1' - projects: - name: projects - id: awscc.sagemaker.projects - x-cfn-schema-name: Project - x-type: list + pipelines_list_only: + name: pipelines_list_only + id: awscc.sagemaker.pipelines_list_only + x-cfn-schema-name: Pipeline + x-cfn-type-name: AWS::SageMaker::Pipeline x-identifiers: - - ProjectArn + - PipelineName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6353,28 +12252,213 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProjectArn') as project_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' + JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProjectArn') as project_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' + json_extract_path_text(Properties, 'PipelineName') as pipeline_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' + AND region = 'us-east-1' + processing_jobs: + name: processing_jobs + id: awscc.sagemaker.processing_jobs + x-cfn-schema-name: ProcessingJob + x-cfn-type-name: AWS::SageMaker::ProcessingJob + x-identifiers: + - ProcessingJobArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProcessingJob&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ProcessingJob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ProcessingJob" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/processing_jobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/processing_jobs/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AppSpecification') as app_specification, + JSON_EXTRACT(Properties, '$.Environment') as environment, + JSON_EXTRACT(Properties, '$.ExperimentConfig') as experiment_config, + JSON_EXTRACT(Properties, '$.NetworkConfig') as network_config, + JSON_EXTRACT(Properties, '$.ProcessingInputs') as processing_inputs, + JSON_EXTRACT(Properties, '$.ProcessingJobName') as processing_job_name, + JSON_EXTRACT(Properties, '$.ProcessingOutputConfig') as processing_output_config, + JSON_EXTRACT(Properties, '$.ProcessingResources') as processing_resources, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.StoppingCondition') as stopping_condition, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.ProcessingJobArn') as processing_job_arn, + JSON_EXTRACT(Properties, '$.AutoMLJobArn') as auto_ml_job_arn, + JSON_EXTRACT(Properties, '$.ExitMessage') as exit_message, + JSON_EXTRACT(Properties, '$.FailureReason') as failure_reason, + JSON_EXTRACT(Properties, '$.MonitoringScheduleArn') as monitoring_schedule_arn, + JSON_EXTRACT(Properties, '$.TrainingJobArn') as training_job_arn, + JSON_EXTRACT(Properties, '$.ProcessingJobStatus') as processing_job_status, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.LastModifiedTime') as last_modified_time, + JSON_EXTRACT(Properties, '$.ProcessingStartTime') as processing_start_time, + JSON_EXTRACT(Properties, '$.ProcessingEndTime') as processing_end_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ProcessingJob' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppSpecification') as app_specification, + json_extract_path_text(Properties, 'Environment') as environment, + json_extract_path_text(Properties, 'ExperimentConfig') as experiment_config, + json_extract_path_text(Properties, 'NetworkConfig') as network_config, + json_extract_path_text(Properties, 'ProcessingInputs') as processing_inputs, + json_extract_path_text(Properties, 'ProcessingJobName') as processing_job_name, + json_extract_path_text(Properties, 'ProcessingOutputConfig') as processing_output_config, + json_extract_path_text(Properties, 'ProcessingResources') as processing_resources, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ProcessingJobArn') as processing_job_arn, + json_extract_path_text(Properties, 'AutoMLJobArn') as auto_ml_job_arn, + json_extract_path_text(Properties, 'ExitMessage') as exit_message, + json_extract_path_text(Properties, 'FailureReason') as failure_reason, + json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn, + json_extract_path_text(Properties, 'TrainingJobArn') as training_job_arn, + json_extract_path_text(Properties, 'ProcessingJobStatus') as processing_job_status, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'ProcessingStartTime') as processing_start_time, + json_extract_path_text(Properties, 'ProcessingEndTime') as processing_end_time + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ProcessingJob' + AND data__Identifier = '' + AND region = 'us-east-1' + processing_jobs_list_only: + name: processing_jobs_list_only + id: awscc.sagemaker.processing_jobs_list_only + x-cfn-schema-name: ProcessingJob + x-cfn-type-name: AWS::SageMaker::ProcessingJob + x-identifiers: + - ProcessingJobArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ProcessingJobArn') as processing_job_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ProcessingJob' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProcessingJobArn') as processing_job_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ProcessingJob' AND region = 'us-east-1' - project: - name: project - id: awscc.sagemaker.project + projects: + name: projects + id: awscc.sagemaker.projects x-cfn-schema-name: Project - x-type: get + x-cfn-type-name: AWS::SageMaker::Project x-identifiers: - ProjectArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6387,12 +12471,13 @@ components: JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, JSON_EXTRACT(Properties, '$.ServiceCatalogProvisioningDetails') as service_catalog_provisioning_details, JSON_EXTRACT(Properties, '$.ServiceCatalogProvisionedProductDetails') as service_catalog_provisioned_product_details, + JSON_EXTRACT(Properties, '$.TemplateProviderDetails') as template_provider_details, JSON_EXTRACT(Properties, '$.ProjectStatus') as project_status FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Project' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6405,18 +12490,24 @@ components: json_extract_path_text(Properties, 'CreationTime') as creation_time, json_extract_path_text(Properties, 'ServiceCatalogProvisioningDetails') as service_catalog_provisioning_details, json_extract_path_text(Properties, 'ServiceCatalogProvisionedProductDetails') as service_catalog_provisioned_product_details, + json_extract_path_text(Properties, 'TemplateProviderDetails') as template_provider_details, json_extract_path_text(Properties, 'ProjectStatus') as project_status FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Project' AND data__Identifier = '' AND region = 'us-east-1' - spaces: - name: spaces - id: awscc.sagemaker.spaces - x-cfn-schema-name: Space - x-type: list + projects_list_only: + name: projects_list_only + id: awscc.sagemaker.projects_list_only + x-cfn-schema-name: Project + x-cfn-type-name: AWS::SageMaker::Project x-identifiers: - - DomainId - - SpaceName + - ProjectArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6424,31 +12515,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.SpaceName') as space_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' + JSON_EXTRACT(Properties, '$.ProjectArn') as project_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'SpaceName') as space_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' + json_extract_path_text(Properties, 'ProjectArn') as project_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' AND region = 'us-east-1' - space: - name: space - id: awscc.sagemaker.space + spaces: + name: spaces + id: awscc.sagemaker.spaces x-cfn-schema-name: Space - x-type: get + x-cfn-type-name: AWS::SageMaker::Space x-identifiers: - DomainId - SpaceName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Space&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Space" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Space" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::Space" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/spaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/spaces/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/spaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6466,7 +12603,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6483,14 +12620,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Space' AND data__Identifier = '|' AND region = 'us-east-1' - user_profiles: - name: user_profiles - id: awscc.sagemaker.user_profiles - x-cfn-schema-name: UserProfile - x-type: list + spaces_list_only: + name: spaces_list_only + id: awscc.sagemaker.spaces_list_only + x-cfn-schema-name: Space + x-cfn-type-name: AWS::SageMaker::Space x-identifiers: - - UserProfileName - DomainId + - SpaceName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -6498,31 +12641,182 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.SpaceName') as space_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, - json_extract_path_text(Properties, 'DomainId') as domain_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'SpaceName') as space_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' + AND region = 'us-east-1' + studio_lifecycle_configs: + name: studio_lifecycle_configs + id: awscc.sagemaker.studio_lifecycle_configs + x-cfn-schema-name: StudioLifecycleConfig + x-cfn-type-name: AWS::SageMaker::StudioLifecycleConfig + x-identifiers: + - StudioLifecycleConfigName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StudioLifecycleConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::StudioLifecycleConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::StudioLifecycleConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studio_lifecycle_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studio_lifecycle_configs/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.StudioLifecycleConfigArn') as studio_lifecycle_config_arn, + JSON_EXTRACT(Properties, '$.StudioLifecycleConfigAppType') as studio_lifecycle_config_app_type, + JSON_EXTRACT(Properties, '$.StudioLifecycleConfigContent') as studio_lifecycle_config_content, + JSON_EXTRACT(Properties, '$.StudioLifecycleConfigName') as studio_lifecycle_config_name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::StudioLifecycleConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StudioLifecycleConfigArn') as studio_lifecycle_config_arn, + json_extract_path_text(Properties, 'StudioLifecycleConfigAppType') as studio_lifecycle_config_app_type, + json_extract_path_text(Properties, 'StudioLifecycleConfigContent') as studio_lifecycle_config_content, + json_extract_path_text(Properties, 'StudioLifecycleConfigName') as studio_lifecycle_config_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::StudioLifecycleConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + studio_lifecycle_configs_list_only: + name: studio_lifecycle_configs_list_only + id: awscc.sagemaker.studio_lifecycle_configs_list_only + x-cfn-schema-name: StudioLifecycleConfig + x-cfn-type-name: AWS::SageMaker::StudioLifecycleConfig + x-identifiers: + - StudioLifecycleConfigName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.StudioLifecycleConfigName') as studio_lifecycle_config_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::StudioLifecycleConfig' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StudioLifecycleConfigName') as studio_lifecycle_config_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::StudioLifecycleConfig' AND region = 'us-east-1' - user_profile: - name: user_profile - id: awscc.sagemaker.user_profile + user_profiles: + name: user_profiles + id: awscc.sagemaker.user_profiles x-cfn-schema-name: UserProfile - x-type: get + x-cfn-type-name: AWS::SageMaker::UserProfile x-identifiers: - UserProfileName - DomainId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6538,7 +12832,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6553,3 +12847,1282 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::UserProfile' AND data__Identifier = '|' AND region = 'us-east-1' + user_profiles_list_only: + name: user_profiles_list_only + id: awscc.sagemaker.user_profiles_list_only + x-cfn-schema-name: UserProfile + x-cfn-type-name: AWS::SageMaker::UserProfile + x-identifiers: + - UserProfileName + - DomainId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, + json_extract_path_text(Properties, 'DomainId') as domain_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__App&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApp + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AppImageConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAppImageConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAppImageConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCluster + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateClusterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataQualityJobDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataQualityJobDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataQualityJobDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Device&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDevice + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeviceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DeviceFleet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDeviceFleet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDeviceFleetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Endpoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEndpoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEndpointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FeatureGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFeatureGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFeatureGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Image&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateImage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateImageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ImageVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateImageVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateImageVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InferenceComponent&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInferenceComponent + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInferenceComponentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InferenceExperiment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInferenceExperiment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInferenceExperimentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MlflowTrackingServer&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMlflowTrackingServer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMlflowTrackingServerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModelBiasJobDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModelBiasJobDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelBiasJobDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModelExplainabilityJobDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModelExplainabilityJobDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelExplainabilityJobDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModelPackage&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModelPackage + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelPackageRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModelPackageGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModelPackageGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelPackageGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ModelQualityJobDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateModelQualityJobDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateModelQualityJobDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MonitoringSchedule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMonitoringSchedule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMonitoringScheduleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PartnerApp&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePartnerApp + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePartnerAppRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Pipeline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePipeline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePipelineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProcessingJob&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProcessingJob + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProcessingJobRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProject + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Space&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSpace + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSpaceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StudioLifecycleConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStudioLifecycleConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStudioLifecycleConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/scheduler.yaml b/providers/src/awscc/v00.00.00000/services/scheduler.yaml index a6562140..a393f639 100644 --- a/providers/src/awscc/v00.00.00000/services/scheduler.yaml +++ b/providers/src/awscc/v00.00.00000/services/scheduler.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Scheduler - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AssignPublicIp: type: string @@ -74,7 +454,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:aws(-[a-z]+)?:sqs:[a-z0-9\-]+:\d{12}:[a-zA-Z0-9\-_]+$ + pattern: ^arn:aws[a-z-]*:sqs:[a-z0-9\-]+:\d{12}:[a-zA-Z0-9\-_]+$ description: The ARN of the SQS queue specified as the target for the dead-letter queue. additionalProperties: false EcsParameters: @@ -340,7 +720,7 @@ components: type: string maxLength: 1600 minLength: 1 - pattern: ^arn:aws(-[a-z]+)?:iam::\d{12}:role\/[\w+=,.@\/-]+$ + pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@\/-]+$ description: The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered. DeadLetterConfig: $ref: '#/components/schemas/DeadLetterConfig' @@ -371,7 +751,7 @@ components: type: string maxLength: 1224 minLength: 1 - pattern: ^arn:aws(-[a-z]+)?:scheduler:[a-z0-9\-]+:\d{12}:schedule\/[0-9a-zA-Z-_.]+\/[0-9a-zA-Z-_.]+$ + pattern: ^arn:aws[a-z-]*:scheduler:[a-z0-9\-]+:\d{12}:schedule\/[0-9a-zA-Z-_.]+\/[0-9a-zA-Z-_.]+$ description: The Amazon Resource Name (ARN) of the schedule. Description: type: string @@ -394,7 +774,7 @@ components: type: string maxLength: 2048 minLength: 1 - pattern: ^arn:aws(-[a-z]+)?:kms:[a-z0-9\-]+:\d{12}:(key|alias)\/[0-9a-zA-Z-_]*$ + pattern: ^arn:aws[a-z-]*:kms:[a-z0-9\-]+:\d{12}:(key|alias)\/[0-9a-zA-Z-_]*$ description: The ARN for a KMS Key that will be used to encrypt customer data. Name: type: string @@ -424,12 +804,23 @@ components: - ScheduleExpression - Target x-stackql-resource-name: schedule - x-stackql-primaryIdentifier: + description: Definition of AWS::Scheduler::Schedule Resource Type + x-type-name: AWS::Scheduler::Schedule + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - FlexibleTimeWindow + - ScheduleExpression + - Target + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - scheduler:CreateSchedule @@ -477,7 +868,7 @@ components: type: string maxLength: 1224 minLength: 1 - pattern: ^arn:aws(-[a-z]+)?:scheduler:[a-z0-9\-]+:\d{12}:schedule-group\/[0-9a-zA-Z-_.]+$ + pattern: ^arn:aws[a-z-]*:scheduler:[a-z0-9\-]+:\d{12}:schedule-group\/[0-9a-zA-Z-_.]+$ description: The Amazon Resource Name (ARN) of the schedule group. CreationDate: type: string @@ -503,7 +894,9 @@ components: description: The list of tags to associate with the schedule group. x-insertionOrder: false x-stackql-resource-name: schedule_group - x-stackql-primaryIdentifier: + description: Definition of AWS::Scheduler::ScheduleGroup Resource Type + x-type-name: AWS::Scheduler::ScheduleGroup + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -512,6 +905,16 @@ components: - CreationDate - LastModificationDate - State + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - scheduler:UntagResource + - scheduler:ListTagsForResource + - scheduler:TagResource x-required-permissions: create: - scheduler:TagResource @@ -532,43 +935,188 @@ components: - scheduler:DeleteSchedule list: - scheduler:ListScheduleGroups + CreateScheduleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 1224 + minLength: 1 + pattern: ^arn:aws[a-z-]*:scheduler:[a-z0-9\-]+:\d{12}:schedule\/[0-9a-zA-Z-_.]+\/[0-9a-zA-Z-_.]+$ + description: The Amazon Resource Name (ARN) of the schedule. + Description: + type: string + maxLength: 512 + minLength: 0 + description: The description of the schedule. + EndDate: + type: string + description: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. + format: date-time + FlexibleTimeWindow: + $ref: '#/components/schemas/FlexibleTimeWindow' + GroupName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[0-9a-zA-Z-_.]+$ + description: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used. + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws[a-z-]*:kms:[a-z0-9\-]+:\d{12}:(key|alias)\/[0-9a-zA-Z-_]*$ + description: The ARN for a KMS Key that will be used to encrypt customer data. + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[0-9a-zA-Z-_.]+$ + ScheduleExpression: + type: string + maxLength: 256 + minLength: 1 + description: The scheduling expression. + ScheduleExpressionTimezone: + type: string + maxLength: 50 + minLength: 1 + description: The timezone in which the scheduling expression is evaluated. + StartDate: + type: string + description: The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. + format: date-time + State: + $ref: '#/components/schemas/ScheduleState' + Target: + $ref: '#/components/schemas/Target' + x-stackQL-stringOnly: true + x-title: CreateScheduleRequest + type: object + required: [] + CreateScheduleGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 1224 + minLength: 1 + pattern: ^arn:aws[a-z-]*:scheduler:[a-z0-9\-]+:\d{12}:schedule-group\/[0-9a-zA-Z-_.]+$ + description: The Amazon Resource Name (ARN) of the schedule group. + CreationDate: + type: string + description: The time at which the schedule group was created. + format: date-time + LastModificationDate: + type: string + description: The time at which the schedule group was last modified. + format: date-time + Name: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[0-9a-zA-Z-_.]+$ + State: + $ref: '#/components/schemas/ScheduleGroupState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: The list of tags to associate with the schedule group. + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateScheduleGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: schedules: name: schedules id: awscc.scheduler.schedules x-cfn-schema-name: Schedule - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' - AND region = 'us-east-1' - schedule: - name: schedule - id: awscc.scheduler.schedule - x-cfn-schema-name: Schedule - x-type: get + x-cfn-type-name: AWS::Scheduler::Schedule x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Schedule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Scheduler::Schedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Scheduler::Schedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Scheduler::Schedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -589,7 +1137,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -609,13 +1157,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Scheduler::Schedule' AND data__Identifier = '' AND region = 'us-east-1' - schedule_groups: - name: schedule_groups - id: awscc.scheduler.schedule_groups - x-cfn-schema-name: ScheduleGroup - x-type: list + schedules_list_only: + name: schedules_list_only + id: awscc.scheduler.schedules_list_only + x-cfn-schema-name: Schedule + x-cfn-type-name: AWS::Scheduler::Schedule x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -624,7 +1178,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -632,19 +1186,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' AND region = 'us-east-1' - schedule_group: - name: schedule_group - id: awscc.scheduler.schedule_group + schedule_groups: + name: schedule_groups + id: awscc.scheduler.schedule_groups x-cfn-schema-name: ScheduleGroup - x-type: get + x-cfn-type-name: AWS::Scheduler::ScheduleGroup x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScheduleGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Scheduler::ScheduleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Scheduler::ScheduleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Scheduler::ScheduleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -659,7 +1261,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -673,3 +1275,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' AND data__Identifier = '' AND region = 'us-east-1' + schedule_groups_list_only: + name: schedule_groups_list_only + id: awscc.scheduler.schedule_groups_list_only + x-cfn-schema-name: ScheduleGroup + x-cfn-type-name: AWS::Scheduler::ScheduleGroup + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Schedule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSchedule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScheduleGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScheduleGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduleGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/secretsmanager.yaml b/providers/src/awscc/v00.00.00000/services/secretsmanager.yaml index ea58b6e9..490dd70f 100644 --- a/providers/src/awscc/v00.00.00000/services/secretsmanager.yaml +++ b/providers/src/awscc/v00.00.00000/services/secretsmanager.yaml @@ -1,10 +1,562 @@ openapi: 3.0.0 info: title: SecretsManager - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + ResourcePolicy: + type: object + properties: + Id: + type: string + description: The Arn of the secret. + SecretId: + type: string + minLength: 1 + maxLength: 2048 + description: The ARN or name of the secret to attach the resource-based policy. + ResourcePolicy: + type: object + description: A JSON-formatted string for an AWS resource-based policy. + BlockPublicPolicy: + type: boolean + description: Specifies whether to block resource-based policies that allow broad access to the secret. + required: + - ResourcePolicy + - SecretId + x-stackql-resource-name: resource_policy + description: Resource Type definition for AWS::SecretsManager::ResourcePolicy + x-type-name: AWS::SecretsManager::ResourcePolicy + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SecretId + x-write-only-properties: + - BlockPublicPolicy + x-read-only-properties: + - Id + x-required-properties: + - ResourcePolicy + - SecretId + x-tagging: + taggable: false + x-required-permissions: + create: + - secretsmanager:PutResourcePolicy + - secretsmanager:GetResourcePolicy + read: + - secretsmanager:GetResourcePolicy + update: + - secretsmanager:PutResourcePolicy + - secretsmanager:GetResourcePolicy + delete: + - secretsmanager:DeleteResourcePolicy + - secretsmanager:GetResourcePolicy + list: + - secretsmanager:GetResourcePolicy + - secretsmanager:ListSecrets + HostedRotationLambda: + additionalProperties: false + type: object + properties: + Runtime: + description: The python runtime associated with the Lambda function + type: string + KmsKeyArn: + description: The ARN of the KMS key that Secrets Manager uses to encrypt the secret. If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If aws/secretsmanager doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. + type: string + MasterSecretArn: + description: The ARN of the secret that contains superuser credentials, if you use the alternating users rotation strategy. CloudFormation grants the execution role for the Lambda rotation function GetSecretValue permission to the secret in this property. + type: string + RotationLambdaName: + description: The name of the Lambda rotation function. + type: string + RotationType: + description: The type of rotation template to use + type: string + ExcludeCharacters: + description: A string of the characters that you don't want in the password. + type: string + VpcSecurityGroupIds: + description: A comma-separated list of security group IDs applied to the target database. + type: string + MasterSecretKmsKeyArn: + description: The ARN of the KMS key that Secrets Manager used to encrypt the superuser secret, if you use the alternating users strategy and the superuser secret is encrypted with a customer managed key. You don't need to specify this property if the superuser secret is encrypted using the key aws/secretsmanager. CloudFormation grants the execution role for the Lambda rotation function Decrypt, DescribeKey, and GenerateDataKey permission to the key in this property. + type: string + SuperuserSecretArn: + description: The ARN of the secret that contains superuser credentials, if you use the alternating users rotation strategy. CloudFormation grants the execution role for the Lambda rotation function GetSecretValue permission to the secret in this property. + type: string + SuperuserSecretKmsKeyArn: + description: The ARN of the KMS key that Secrets Manager used to encrypt the superuser secret, if you use the alternating users strategy and the superuser secret is encrypted with a customer managed key. You don't need to specify this property if the superuser secret is encrypted using the key aws/secretsmanager. CloudFormation grants the execution role for the Lambda rotation function Decrypt, DescribeKey, and GenerateDataKey permission to the key in this property. + type: string + VpcSubnetIds: + description: A comma separated list of VPC subnet IDs of the target database network. The Lambda rotation function is in the same subnet group. + type: string + required: + - RotationType + RotationRules: + additionalProperties: false + type: object + properties: + ScheduleExpression: + description: A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. + type: string + Duration: + description: >- + The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC + day. + type: string + AutomaticallyAfterDays: + description: The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated. + type: integer + RotationSchedule: + type: object + properties: + HostedRotationLambda: + description: Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates. To use a rotation function that already exists, specify RotationLambdaARN instead. + $ref: '#/components/schemas/HostedRotationLambda' + SecretId: + description: The ARN or name of the secret to rotate. + type: string + Id: + description: The ARN of the secret. + type: string + RotateImmediatelyOnUpdate: + description: Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. + type: boolean + RotationLambdaARN: + description: The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function. + type: string + RotationRules: + description: A structure that defines the rotation configuration for this secret. + $ref: '#/components/schemas/RotationRules' + required: + - SecretId + x-stackql-resource-name: rotation_schedule + description: Resource Type definition for AWS::SecretsManager::RotationSchedule + x-type-name: AWS::SecretsManager::RotationSchedule + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SecretId + x-write-only-properties: + - RotateImmediatelyOnUpdate + - HostedRotationLambda + - HostedRotationLambda/ExcludeCharacters + - HostedRotationLambda/KmsKeyArn + - HostedRotationLambda/MasterSecretArn + - HostedRotationLambda/MasterSecretKmsKeyArn + - HostedRotationLambda/RotationLambdaName + - HostedRotationLambda/RotationType + - HostedRotationLambda/Runtime + - HostedRotationLambda/SuperuserSecretArn + - HostedRotationLambda/SuperuserSecretKmsKeyArn + - HostedRotationLambda/VpcSecurityGroupIds + - HostedRotationLambda/VpcSubnetIds + x-read-only-properties: + - Id + x-required-properties: + - SecretId + x-tagging: + taggable: false + x-required-permissions: + read: + - secretsmanager:DescribeSecret + create: + - secretsmanager:RotateSecret + - secretsmanager:DescribeSecret + - lambda:InvokeFunction + update: + - secretsmanager:RotateSecret + - secretsmanager:DescribeSecret + - lambda:InvokeFunction + list: + - secretsmanager:DescribeSecret + - secretsmanager:ListSecrets + delete: + - secretsmanager:CancelRotateSecret + - secretsmanager:DescribeSecret GenerateSecretString: type: object additionalProperties: false @@ -41,7 +593,7 @@ components: description: Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. description: |- Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. - *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). + *Required permissions:*``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). ReplicaRegion: type: object description: Specifies a ``Region`` and the ``KmsKeyId`` for a replica secret. @@ -107,7 +659,15 @@ components: ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`` Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. - If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazo + If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). + For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. + The following restrictions apply to tags: + + Maximum number of tags per secret: 50 + + Maximum key length: 127 Unicode characters in UTF-8 + + Maximum value length: 255 Unicode characters in UTF-8 + + Tag keys and values are case sensitive. + + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. uniqueItems: false x-insertionOrder: false items: @@ -119,18 +679,39 @@ components: The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN. x-stackql-resource-name: secret - x-stackql-primaryIdentifier: + description: |- + Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. + For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html). + For RS admin user credentials, see [AWS::Redshift::Cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html). + To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html). + For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html). + For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html). + x-type-name: AWS::SecretsManager::Secret + x-stackql-primary-identifier: - Id x-create-only-properties: - Name + x-write-only-properties: + - SecretString + - GenerateSecretString x-read-only-properties: - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - secretsmanager:UntagResource + - secretsmanager:TagResource x-required-permissions: create: - secretsmanager:DescribeSecret - secretsmanager:GetRandomPassword - secretsmanager:CreateSecret - secretsmanager:TagResource + - secretsmanager:ReplicateSecretToRegions delete: - secretsmanager:DeleteSecret - secretsmanager:DescribeSecret @@ -148,14 +729,329 @@ components: - secretsmanager:GetSecretValue - secretsmanager:ReplicateSecretToRegions - secretsmanager:RemoveRegionsFromReplication + SecretTargetAttachment: + type: object + properties: + Id: + type: string + SecretId: + type: string + TargetType: + type: string + TargetId: + type: string + required: + - TargetType + - TargetId + - SecretId + x-stackql-resource-name: secret_target_attachment + description: Resource Type definition for AWS::SecretsManager::SecretTargetAttachment + x-type-name: AWS::SecretsManager::SecretTargetAttachment + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SecretId + x-read-only-properties: + - Id + x-required-properties: + - TargetType + - TargetId + - SecretId + x-tagging: + taggable: false + x-required-permissions: + read: + - secretsmanager:GetSecretValue + list: + - secretsmanager:GetSecretValue + - secretsmanager:ListSecrets + create: + - secretsmanager:GetSecretValue + - secretsmanager:PutSecretValue + - rds:DescribeDBInstances + - redshift:DescribeClusters + - rds:DescribeDBClusters + - docdb-elastic:GetCluster + - redshift-serverless:ListWorkgroups + - redshift-serverless:GetNamespace + delete: + - secretsmanager:GetSecretValue + - secretsmanager:PutSecretValue + update: + - secretsmanager:GetSecretValue + - secretsmanager:PutSecretValue + - rds:DescribeDBInstances + - redshift:DescribeClusters + - rds:DescribeDBClusters + - docdb-elastic:GetCluster + - redshift-serverless:ListWorkgroups + - redshift-serverless:GetNamespace + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: The Arn of the secret. + SecretId: + type: string + minLength: 1 + maxLength: 2048 + description: The ARN or name of the secret to attach the resource-based policy. + ResourcePolicy: + type: object + description: A JSON-formatted string for an AWS resource-based policy. + BlockPublicPolicy: + type: boolean + description: Specifies whether to block resource-based policies that allow broad access to the secret. + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateRotationScheduleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HostedRotationLambda: + description: Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates. To use a rotation function that already exists, specify RotationLambdaARN instead. + $ref: '#/components/schemas/HostedRotationLambda' + SecretId: + description: The ARN or name of the secret to rotate. + type: string + Id: + description: The ARN of the secret. + type: string + RotateImmediatelyOnUpdate: + description: Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. + type: boolean + RotationLambdaARN: + description: The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function. + type: string + RotationRules: + description: A structure that defines the rotation configuration for this secret. + $ref: '#/components/schemas/RotationRules' + x-stackQL-stringOnly: true + x-title: CreateRotationScheduleRequest + type: object + required: [] + CreateSecretRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: The description of the secret. + KmsKeyId: + type: string + description: |- + The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). + To use a KMS key in a different account, use the key ARN or the alias ARN. + If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. + If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key. + SecretString: + type: string + description: The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. + GenerateSecretString: + $ref: '#/components/schemas/GenerateSecretString' + description: |- + A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. + We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. + ReplicaRegions: + type: array + description: A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/ReplicaRegion' + Id: + type: string + description: '' + Tags: + type: array + description: |- + A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: + ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`` + Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". + Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. + If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). + For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. + The following restrictions apply to tags: + + Maximum number of tags per secret: 50 + + Maximum key length: 127 Unicode characters in UTF-8 + + Maximum value length: 255 Unicode characters in UTF-8 + + Tag keys and values are case sensitive. + + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Name: + type: string + description: |- + The name of the new secret. + The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- + Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN. + x-stackQL-stringOnly: true + x-title: CreateSecretRequest + type: object + required: [] + CreateSecretTargetAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + SecretId: + type: string + TargetType: + type: string + TargetId: + type: string + x-stackQL-stringOnly: true + x-title: CreateSecretTargetAttachmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - secrets: - name: secrets - id: awscc.secretsmanager.secrets - x-cfn-schema-name: Secret - x-type: list + resource_policies: + name: resource_policies + id: awscc.secretsmanager.resource_policies + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::SecretsManager::ResourcePolicy x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.SecretId') as secret_id, + JSON_EXTRACT(Properties, '$.ResourcePolicy') as resource_policy, + JSON_EXTRACT(Properties, '$.BlockPublicPolicy') as block_public_policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SecretId') as secret_id, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, + json_extract_path_text(Properties, 'BlockPublicPolicy') as block_public_policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.secretsmanager.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::SecretsManager::ResourcePolicy + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -164,7 +1060,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::ResourcePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -172,19 +1068,185 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::ResourcePolicy' AND region = 'us-east-1' - secret: - name: secret - id: awscc.secretsmanager.secret - x-cfn-schema-name: Secret - x-type: get + rotation_schedules: + name: rotation_schedules + id: awscc.secretsmanager.rotation_schedules + x-cfn-schema-name: RotationSchedule + x-cfn-type-name: AWS::SecretsManager::RotationSchedule + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RotationSchedule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::RotationSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::RotationSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::RotationSchedule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rotation_schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rotation_schedules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rotation_schedules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.HostedRotationLambda') as hosted_rotation_lambda, + JSON_EXTRACT(Properties, '$.SecretId') as secret_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.RotateImmediatelyOnUpdate') as rotate_immediately_on_update, + JSON_EXTRACT(Properties, '$.RotationLambdaARN') as rotation_lambda_arn, + JSON_EXTRACT(Properties, '$.RotationRules') as rotation_rules + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::RotationSchedule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'HostedRotationLambda') as hosted_rotation_lambda, + json_extract_path_text(Properties, 'SecretId') as secret_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RotateImmediatelyOnUpdate') as rotate_immediately_on_update, + json_extract_path_text(Properties, 'RotationLambdaARN') as rotation_lambda_arn, + json_extract_path_text(Properties, 'RotationRules') as rotation_rules + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::RotationSchedule' + AND data__Identifier = '' + AND region = 'us-east-1' + rotation_schedules_list_only: + name: rotation_schedules_list_only + id: awscc.secretsmanager.rotation_schedules_list_only + x-cfn-schema-name: RotationSchedule + x-cfn-type-name: AWS::SecretsManager::RotationSchedule x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::RotationSchedule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::RotationSchedule' + AND region = 'us-east-1' + secrets: + name: secrets + id: awscc.secretsmanager.secrets + x-cfn-schema-name: Secret + x-cfn-type-name: AWS::SecretsManager::Secret + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Secret&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::Secret" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::Secret" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::Secret" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/secrets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/secrets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -201,7 +1263,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -217,3 +1279,469 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::Secret' AND data__Identifier = '' AND region = 'us-east-1' + secrets_list_only: + name: secrets_list_only + id: awscc.secretsmanager.secrets_list_only + x-cfn-schema-name: Secret + x-cfn-type-name: AWS::SecretsManager::Secret + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' + AND region = 'us-east-1' + secret_target_attachments: + name: secret_target_attachments + id: awscc.secretsmanager.secret_target_attachments + x-cfn-schema-name: SecretTargetAttachment + x-cfn-type-name: AWS::SecretsManager::SecretTargetAttachment + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecretTargetAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::SecretTargetAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::SecretTargetAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecretsManager::SecretTargetAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/secret_target_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/secret_target_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/secret_target_attachments/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.SecretId') as secret_id, + JSON_EXTRACT(Properties, '$.TargetType') as target_type, + JSON_EXTRACT(Properties, '$.TargetId') as target_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::SecretTargetAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SecretId') as secret_id, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'TargetId') as target_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::SecretTargetAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + secret_target_attachments_list_only: + name: secret_target_attachments_list_only + id: awscc.secretsmanager.secret_target_attachments_list_only + x-cfn-schema-name: SecretTargetAttachment + x-cfn-type-name: AWS::SecretsManager::SecretTargetAttachment + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::SecretTargetAttachment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::SecretTargetAttachment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RotationSchedule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRotationSchedule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRotationScheduleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Secret&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecret + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecretRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecretTargetAttachment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecretTargetAttachment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecretTargetAttachmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/securityhub.yaml b/providers/src/awscc/v00.00.00000/services/securityhub.yaml index 8616b06b..6ea24529 100644 --- a/providers/src/awscc/v00.00.00000/services/securityhub.yaml +++ b/providers/src/awscc/v00.00.00000/services/securityhub.yaml @@ -1,55 +1,498 @@ openapi: 3.0.0 info: title: SecurityHub - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Region: + type: string + pattern: ^[a-zA-Z0-9-]{1,32}$ Tags: - description: A key-value pair to associate with a resource. + description: 'A key-value pair to associate with the Security Hub V2 resource. You can specify a key that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: object - additionalProperties: false x-patternProperties: - ^[a-zA-Z0-9-_]{1,128}$: + ^(?!aws:)[a-zA-Z+-=._:/]{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. minLength: 0 maxLength: 256 + additionalProperties: false + maxProperties: 50 + AggregatorV2: + type: object + properties: + AggregatorV2Arn: + description: The ARN of the AggregatorV2 being created and assigned as the unique identifier + type: string + pattern: arn:aws\S*:securityhub:\S* + RegionLinkingMode: + description: Indicates to link a list of included Regions + type: string + enum: + - SPECIFIED_REGIONS + LinkedRegions: + description: The list of included Regions + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Region' + Tags: + $ref: '#/components/schemas/Tags' + AggregationRegion: + description: The aggregation Region of the AggregatorV2 + $ref: '#/components/schemas/Region' + required: + - RegionLinkingMode + - LinkedRegions + x-stackql-resource-name: aggregator_v2 + description: The AWS::SecurityHub::AggregatorV2 resource represents the AWS Security Hub AggregatorV2 in your account. One aggregatorv2 resource is created for each account in non opt-in region in which you configure region linking mode. + x-type-name: AWS::SecurityHub::AggregatorV2 + x-stackql-primary-identifier: + - AggregatorV2Arn + x-read-only-properties: + - AggregatorV2Arn + - AggregationRegion + x-required-properties: + - RegionLinkingMode + - LinkedRegions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - securityhub:ListTagsForResource + - securityhub:TagResource + - securityhub:UntagResource + x-required-permissions: + create: + - securityhub:CreateAggregatorV2 + - securityhub:GetAggregatorV2 + - securityhub:TagResource + - securityhub:ListTagsForResource + read: + - securityhub:GetAggregatorV2 + - securityhub:ListTagsForResource + update: + - securityhub:UpdateAggregatorV2 + - securityhub:GetAggregatorV2 + - securityhub:TagResource + - securityhub:UntagResource + - securityhub:ListTagsForResource + delete: + - securityhub:DeleteAggregatorV2 + list: + - securityhub:ListAggregatorsV2 + - securityhub:ListTagsForResource NonEmptyString: type: string - minLength: 1 + pattern: .*\S.* DateFilter: - description: '' + description: A date filter for querying findings. properties: DateRange: $ref: '#/components/schemas/DateRange' - description: '' End: $ref: '#/components/schemas/ISO8601DateString' - description: '' Start: $ref: '#/components/schemas/ISO8601DateString' - description: '' type: object - oneOf: - - required: - - DateRange - - allOf: - - required: - - Start - - required: - - End additionalProperties: false DateRange: - description: '' + description: A date range for the date filter. properties: Unit: - description: '' + description: A date range unit for the date filter. enum: - DAYS type: string Value: - description: '' + description: A date range value for the date filter. type: number required: - Unit @@ -57,7 +500,7 @@ components: type: object additionalProperties: false BooleanFilter: - description: '' + description: Boolean filter for querying findings. properties: Value: description: The value of the boolean. @@ -67,22 +510,18 @@ components: type: object additionalProperties: false MapFilter: - description: '' + description: A map filter for filtering AWS Security Hub findings. properties: Comparison: - description: '' + description: The condition to apply to the key value when filtering Security Hub findings with a map filter. enum: - EQUALS - NOT_EQUALS - - CONTAINS - - NOT_CONTAINS type: string Key: - description: '' - type: string + $ref: '#/components/schemas/NonEmptyString' Value: - description: '' - type: string + $ref: '#/components/schemas/NonEmptyString' required: - Comparison - Key @@ -90,36 +529,26 @@ components: type: object additionalProperties: false NumberFilter: - description: '' + description: A number filter for querying findings. properties: Eq: - description: '' + description: The equal-to condition to be applied to a single field when querying for findings. type: number Gte: - description: '' + description: The greater-than-equal condition to be applied to a single field when querying for findings. type: number Lte: - description: '' + description: The less-than-equal condition to be applied to a single field when querying for findings. type: number - oneOf: - - required: - - Eq - - anyOf: - - required: - - Gte - - required: - - Lte type: object additionalProperties: false StringFilter: - description: '' + description: A string filter for filtering AWS Security Hub findings. properties: Comparison: $ref: '#/components/schemas/StringFilterComparison' - description: '' Value: - description: '' - type: string + $ref: '#/components/schemas/NonEmptyString' required: - Comparison - Value @@ -132,13 +561,11 @@ components: - PREFIX - NOT_EQUALS - PREFIX_NOT_EQUALS - - CONTAINS - - NOT_CONTAINS type: string ISO8601DateString: description: The date and time, in UTC and ISO 8601 format. type: string - pattern: ^(\d\d\d\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\d)|[3][0-1])[T](?:([0-1](\d)|[2][0-3]):[0-5](\d):[0-5](\d)|23:59:60)(?:\.(\d)+)?([Z]|[+-](\d\d)(:?(\d\d))?)$ + pattern: ^([\+-]?\d{4}(?!\d{2}))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([tT]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$ arn: description: The Amazon Resource Name (ARN) of the automation rule. type: string @@ -182,33 +609,45 @@ components: description: The Amazon Resource Name (ARN) for the product that generated a related finding. Id: $ref: '#/components/schemas/arnOrId' - description: '' + description: |- + The product-generated identifier for a related finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. additionalProperties: false required: - ProductArn - Id NoteUpdate: - description: '' + description: The updated note. type: object properties: Text: - description: '' + description: The updated note text. type: string minLength: 1 maxLength: 512 UpdatedBy: $ref: '#/components/schemas/arnOrId' - description: '' + description: The principal that updated the note. additionalProperties: false required: - Text - UpdatedBy WorkflowUpdate: - description: '' + description: Used to update information about the investigation into the finding. type: object properties: Status: - description: '' + description: |- + The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to ``SUPPRESSED`` or ``RESOLVED`` does not prevent a new finding for the same issue. + The allowed values are the following. + + ``NEW`` - The initial state of a finding, before it is reviewed. + Security Hub also resets ``WorkFlowStatus`` from ``NOTIFIED`` or ``RESOLVED`` to ``NEW`` in the following cases: + + The record state changes from ``ARCHIVED`` to ``ACTIVE``. + + The compliance status changes from ``PASSED`` to either ``WARNING``, ``FAILED``, or ``NOT_AVAILABLE``. + + + ``NOTIFIED`` - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. + + ``RESOLVED`` - The finding was reviewed and remediated and is now considered resolved. + + ``SUPPRESSED`` - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated. type: string enum: - NEW @@ -219,14 +658,20 @@ components: - Status additionalProperties: false SeverityUpdate: - description: '' + description: Updates to the severity information for a finding. type: object properties: Product: - description: '' + description: The native severity as defined by the AWS service or integrated partner product that generated the finding. type: number Label: - description: '' + description: |- + The severity value of the finding. The allowed values are the following. + + ``INFORMATIONAL`` - No issue was found. + + ``LOW`` - The issue does not require action on its own. + + ``MEDIUM`` - The issue must be addressed but not urgently. + + ``HIGH`` - The issue must be addressed as a priority. + + ``CRITICAL`` - The issue must be remediated immediately to avoid it escalating. type: string enum: - INFORMATIONAL @@ -236,14 +681,21 @@ components: - CRITICAL Normalized: $ref: '#/components/schemas/int100' - description: '' + description: |- + The normalized severity for the finding. This attribute is to be deprecated in favor of ``Label``. + If you provide ``Normalized`` and don't provide ``Label``, ``Label`` is set automatically as follows. + + 0 - ``INFORMATIONAL`` + + 1–39 - ``LOW`` + + 40–69 - ``MEDIUM`` + + 70–89 - ``HIGH`` + + 90–100 - ``CRITICAL`` additionalProperties: false AutomationRulesFindingFieldsUpdate: - description: The rule action will update the ``Note`` field of a finding. + description: Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria. type: object properties: Types: - description: '' + description: The rule action updates the ``Types`` field of a finding. type: array maxItems: 50 uniqueItems: true @@ -256,15 +708,15 @@ components: $ref: '#/components/schemas/SeverityUpdate' Confidence: $ref: '#/components/schemas/int100' - description: '' + description: The rule action updates the ``Confidence`` field of a finding. Criticality: $ref: '#/components/schemas/int100' - description: '' + description: The rule action updates the ``Criticality`` field of a finding. UserDefinedFields: $ref: '#/components/schemas/map' - description: '' + description: The rule action updates the ``UserDefinedFields`` field of a finding. VerificationState: - description: '' + description: The rule action updates the ``VerificationState`` field of a finding. type: string enum: - UNKNOWN @@ -287,231 +739,308 @@ components: description: The rule action will update the ``Workflow`` field of a finding. $ref: '#/components/schemas/WorkflowUpdate' AutomationRulesAction: - description: '' + description: One or more actions that ASHlong takes when a finding matches the defined criteria of a rule. type: object properties: Type: - description: '' + description: Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule. type: string enum: - FINDING_FIELDS_UPDATE FindingFieldsUpdate: $ref: '#/components/schemas/AutomationRulesFindingFieldsUpdate' - description: '' + description: Specifies that the automation rule action is an update to a finding field. required: - Type - FindingFieldsUpdate AutomationRulesFindingFilters: - description: '' + description: The criteria that determine which findings a rule applies to. type: object additionalProperties: false properties: ProductArn: - description: '' + description: |- + The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 AwsAccountId: - description: '' + description: |- + The AWS-account ID in which a finding was generated. + Array Members: Minimum number of 1 item. Maximum number of 100 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 100 Id: - description: '' + description: |- + The product-specific identifier for a finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 GeneratorId: - description: '' + description: |- + The identifier for the solution-specific component that generated a finding. + Array Members: Minimum number of 1 item. Maximum number of 100 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 100 Type: - description: '' + description: |- + One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see [Types taxonomy for ASFF](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) in the *User Guide*. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 FirstObservedAt: - description: '' + description: |- + A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product. + For more information about the validation and formatting of timestamp fields in ASHlong, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps). + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/DateFilter' type: array maxItems: 20 LastObservedAt: - description: '' + description: |- + A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding. + For more information about the validation and formatting of timestamp fields in ASHlong, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps). + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/DateFilter' type: array maxItems: 20 CreatedAt: - description: '' + description: |- + A timestamp that indicates when this finding record was created. + For more information about the validation and formatting of timestamp fields in ASHlong, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps). + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/DateFilter' type: array maxItems: 20 UpdatedAt: - description: '' + description: |- + A timestamp that indicates when the finding record was most recently updated. + For more information about the validation and formatting of timestamp fields in ASHlong, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps). + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/DateFilter' type: array maxItems: 20 Confidence: - description: '' + description: >- + The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. ``Confidence`` is scored on a 0–100 basis using a ratio scale. A value of ``0`` means 0 percent confidence, and a value of ``100`` means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see + [Confidence](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence) in the *User Guide*. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/NumberFilter' type: array maxItems: 20 Criticality: - description: '' + description: >- + The level of importance that is assigned to the resources that are associated with a finding. ``Criticality`` is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of ``0`` means that the underlying resources have no criticality, and a score of ``100`` is reserved for the most critical resources. For more information, see [Criticality](https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality) in the + *User Guide*. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/NumberFilter' type: array maxItems: 20 Title: - description: '' + description: |- + A finding's title. + Array Members: Minimum number of 1 item. Maximum number of 100 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 100 Description: - description: '' + description: |- + A finding's description. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 SourceUrl: - description: '' + description: |- + Provides a URL that links to a page about the current finding in the finding product. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ProductName: - description: '' + description: |- + Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 CompanyName: - description: '' + description: |- + The name of the company for the product that generated the finding. For control-based findings, the company is AWS. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 SeverityLabel: - description: '' + description: |- + The severity value of the finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ResourceType: - description: '' + description: |- + A finding's title. + Array Members: Minimum number of 1 item. Maximum number of 100 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ResourceId: - description: '' + description: |- + The identifier for the given resource type. For AWS resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs, this is the identifier as defined by the AWS-service that created the resource. For non-AWS resources, this is a unique identifier that is associated with the resource. + Array Members: Minimum number of 1 item. Maximum number of 100 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 100 ResourcePartition: - description: '' + description: |- + The partition in which the resource that the finding pertains to is located. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ResourceRegion: - description: '' + description: |- + The AWS-Region where the resource that a finding pertains to is located. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ResourceTags: - description: '' + description: |- + A list of AWS tags associated with a resource at the time the finding was processed. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/MapFilter' type: array maxItems: 20 ResourceDetailsOther: - description: '' + description: |- + Custom fields and values about the resource that a finding pertains to. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/MapFilter' type: array maxItems: 20 ComplianceStatus: - description: '' + description: |- + The result of a security check. This field is only used for findings generated from controls. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ComplianceSecurityControlId: - description: '' + description: |- + The security control ID for which a finding was generated. Security control IDs are the same across standards. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 ComplianceAssociatedStandardsId: - description: '' + description: |- + The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API response. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 VerificationState: - description: '' + description: |- + Provides the veracity of a finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 WorkflowStatus: - description: '' + description: |- + Provides information about the status of the investigation into a finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 RecordState: - description: '' + description: |- + Provides the current state of a finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 RelatedFindingsProductArn: - description: '' + description: |- + The ARN for the product that generated a related finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 RelatedFindingsId: - description: '' + description: |- + The product-generated identifier for a related finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 NoteText: - description: '' + description: |- + The text of a user-defined note that's added to a finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 NoteUpdatedAt: - description: '' + description: |- + The timestamp of when the note was updated. + For more information about the validation and formatting of timestamp fields in ASHlong, see [Timestamps](https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps). + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/DateFilter' type: array maxItems: 20 NoteUpdatedBy: - description: '' + description: |- + The principal that created a note. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/StringFilter' type: array maxItems: 20 UserDefinedFields: - description: '' + description: |- + A list of user-defined name and value string pairs added to a finding. + Array Members: Minimum number of 1 item. Maximum number of 20 items. items: $ref: '#/components/schemas/MapFilter' type: array @@ -530,17 +1059,17 @@ components: - ENABLED - DISABLED RuleOrder: - description: '' + description: An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first. type: integer minimum: 1 maximum: 1000 Description: - description: '' + description: A description of the rule. type: string minLength: 1 maxLength: 1024 RuleName: - description: '' + description: The name of the rule. type: string minLength: 1 maxLength: 256 @@ -556,11 +1085,11 @@ components: minLength: 1 maxLength: 256 IsTerminal: - description: '' + description: Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal. type: boolean Actions: type: array - description: '' + description: One or more actions to update finding fields if a finding matches the conditions specified in ``Criteria``. items: $ref: '#/components/schemas/AutomationRulesAction' minItems: 1 @@ -569,16 +1098,40 @@ components: description: A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding. $ref: '#/components/schemas/AutomationRulesFindingFilters' Tags: - description: '' + description: User-defined tags associated with an automation rule. $ref: '#/components/schemas/Tags' + required: + - RuleOrder + - RuleName + - Description + - Criteria + - Actions x-stackql-resource-name: automation_rule - x-stackql-primaryIdentifier: + description: The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*. + x-type-name: AWS::SecurityHub::AutomationRule + x-stackql-primary-identifier: - RuleArn x-read-only-properties: - RuleArn - CreatedAt - UpdatedAt - CreatedBy + x-required-properties: + - RuleOrder + - RuleName + - Description + - Criteria + - Actions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - securityhub:ListTagsForResource + - securityhub:TagResource + - securityhub:UntagResource x-required-permissions: create: - securityhub:CreateAutomationRule @@ -599,123 +1152,3664 @@ components: list: - securityhub:ListAutomationRules - securityhub:ListTagsForResource - Hub: + OcsfFindingFilters: + description: The filtering conditions that align with OCSF standards type: object + additionalProperties: false properties: - ARN: - description: An ARN is automatically created for the customer. - type: string - pattern: ^arn:.* - EnableDefaultStandards: - description: Whether to enable the security standards that Security Hub has designated as automatically enabled. - type: boolean - ControlFindingGenerator: - description: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. - type: string - pattern: ^(SECURITY_CONTROL|STANDARD_CONTROL)$ - AutoEnableControls: - description: Whether to automatically enable new controls when they are added to standards that are enabled - type: boolean + CompositeFilters: + description: Enables the creation of complex filtering conditions by combining filter + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/CompositeFilter' + CompositeOperator: + $ref: '#/components/schemas/AllowedOperators' + CompositeFilter: + description: Enables the creation of filtering criteria for security findings + type: object + additionalProperties: false + properties: + StringFilters: + description: Enables filtering based on string field values + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/OcsfStringFilter' + minItems: 1 + maxItems: 20 + DateFilters: + description: Enables filtering based on date and timestamp fields + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/OcsfDateFilter' + minItems: 1 + maxItems: 20 + BooleanFilters: + description: Enables filtering based on boolean field values + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/OcsfBooleanFilter' + minItems: 1 + maxItems: 20 + NumberFilters: + description: Enables filtering based on numerical field values + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/OcsfNumberFilter' + minItems: 1 + maxItems: 20 + MapFilters: + description: Enables filtering based on map field value + items: + $ref: '#/components/schemas/OcsfMapFilter' + type: array + minItems: 1 + maxItems: 20 + Operator: + $ref: '#/components/schemas/AllowedOperators' + OcsfStringFilter: + description: Enables filtering of security findings based on string field values in OCSF + type: object + additionalProperties: false + properties: + FieldName: + $ref: '#/components/schemas/OcsfStringField' + Filter: + $ref: '#/components/schemas/StringFilter' + required: + - FieldName + - Filter + OcsfDateFilter: + description: Enables filtering of security findings based on date and timestamp fields in OCSF + type: object + additionalProperties: false + properties: + FieldName: + type: string + description: The name of the field + enum: + - finding_info.created_time_dt + - finding_info.first_seen_time_dt + - finding_info.last_seen_time_dt + - finding_info.modified_time_dt + Filter: + $ref: '#/components/schemas/DateFilter' + required: + - FieldName + - Filter + OcsfBooleanFilter: + description: Enables filtering of security findings based on boolean field values in OCSF + type: object + additionalProperties: false + properties: + FieldName: + description: The name of the field + type: string + enum: + - compliance.assessments.meets_criteria + - vulnerabilities.is_exploit_available + - vulnerabilities.is_fix_available + Filter: + $ref: '#/components/schemas/BooleanFilter' + required: + - FieldName + - Filter + OcsfNumberFilter: + description: Enables filtering of security findings based on numerical field values in OCSF + type: object + additionalProperties: false + properties: + FieldName: + description: The name of the field + type: string + enum: + - activity_id + - compliance.status_id + - confidence_score + - severity_id + - status_id + - finding_info.related_events_count + Filter: + $ref: '#/components/schemas/NumberFilter' + required: + - FieldName + - Filter + OcsfMapFilter: + description: Enables filtering of security findings based on map field values in OCSF + properties: + FieldName: + description: The name of the field + enum: + - resources.tags + type: string + Filter: + $ref: '#/components/schemas/MapFilter' + required: + - FieldName + - Filter + type: object + additionalProperties: false + OcsfStringField: + description: The name of the field + type: string + enum: + - metadata.uid + - activity_name + - cloud.account.name + - cloud.account.uid + - cloud.provider + - cloud.region + - compliance.assessments.category + - compliance.assessments.name + - compliance.control + - compliance.status + - compliance.standards + - finding_info.desc + - finding_info.src_url + - finding_info.title + - finding_info.types + - finding_info.uid + - finding_info.related_events.uid + - finding_info.related_events.product.uid + - finding_info.related_events.title + - metadata.product.feature.uid + - metadata.product.name + - metadata.product.uid + - metadata.product.vendor_name + - remediation.desc + - remediation.references + - resources.cloud_partition + - resources.name + - resources.region + - resources.type + - resources.uid + - severity + - status + - comment + - vulnerabilities.fix_coverage + - class_name + AllowedOperators: + description: The logical operator used to combine multiple conditions + type: string + enum: + - AND + - OR + Criteria: + type: object + description: Defines the parameters and conditions used to evaluate and filter security findings + additionalProperties: false + properties: + OcsfFindingCriteria: + $ref: '#/components/schemas/OcsfFindingFilters' + AutomationRulesActionV2: + description: Allows you to configure automated responses + type: object + additionalProperties: false + properties: + Type: + description: The category of action to be executed by the automation rule + type: string + enum: + - FINDING_FIELDS_UPDATE + - EXTERNAL_INTEGRATION + FindingFieldsUpdate: + $ref: '#/components/schemas/AutomationRulesFindingFieldsUpdateV2' + ExternalIntegrationConfiguration: + $ref: '#/components/schemas/ExternalIntegrationConfiguration' + required: + - Type + AutomationRulesFindingFieldsUpdateV2: + description: The changes to be applied to fields in a security finding when an automation rule is triggered + type: object + additionalProperties: false + properties: + SeverityId: + description: The severity level to be assigned to findings that match the automation rule criteria + type: integer + Comment: + description: Notes or contextual information for findings that are modified by the automation rule + type: string + pattern: .*\S.* + StatusId: + description: The status to be applied to findings that match automation rule criteria + type: integer + ExternalIntegrationConfiguration: + description: The settings for integrating automation rule actions with external systems or service + type: object + additionalProperties: false + properties: + ConnectorArn: + description: The ARN of the connector that establishes the integration + type: string + pattern: .*\S.* + AutomationRuleV2: + type: object + properties: + RuleName: + description: The name of the automation rule + type: string + pattern: .*\S.* + minLength: 1 + maxLength: 256 + RuleStatus: + description: The status of the automation rule + type: string + enum: + - ENABLED + - DISABLED + Description: + description: A description of the automation rule + type: string + pattern: .*\S.* + minLength: 1 + maxLength: 256 + RuleOrder: + description: The value for the rule priority + type: number + minimum: 1 + maximum: 1000 + Criteria: + $ref: '#/components/schemas/Criteria' + Actions: + description: A list of actions to be performed when the rule criteria is met + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/AutomationRulesActionV2' + minItems: 1 + maxItems: 1 Tags: $ref: '#/components/schemas/Tags' - SubscribedAt: - description: The date and time when Security Hub was enabled in the account. + RuleArn: + description: The ARN of the automation rule type: string - x-stackql-resource-name: hub - x-stackql-primaryIdentifier: - - ARN + pattern: ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:automation-rulev2/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + RuleId: + description: The ID of the automation rule + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + CreatedAt: + $ref: '#/components/schemas/ISO8601DateString' + UpdatedAt: + $ref: '#/components/schemas/ISO8601DateString' + required: + - RuleName + - Description + - RuleOrder + - Criteria + - Actions + x-stackql-resource-name: automation_rule_v2 + description: Resource schema for AWS::SecurityHub::AutomationRuleV2 + x-type-name: AWS::SecurityHub::AutomationRuleV2 + x-stackql-primary-identifier: + - RuleArn x-read-only-properties: - - ARN - - SubscribedAt + - RuleArn + - RuleId + - CreatedAt + - UpdatedAt + x-required-properties: + - RuleName + - Description + - RuleOrder + - Criteria + - Actions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - securityhub:ListTagsForResource + - securityhub:TagResource + - securityhub:UntagResource x-required-permissions: create: - - securityhub:EnableSecurityHub - - securityhub:UpdateSecurityHubConfiguration + - securityhub:CreateAutomationRuleV2 + - securityhub:GetAutomationRuleV2 - securityhub:TagResource - securityhub:ListTagsForResource read: - - securityhub:DescribeHub + - securityhub:GetAutomationRuleV2 - securityhub:ListTagsForResource update: - - securityhub:DescribeHub - - securityhub:UpdateSecurityHubConfiguration + - securityhub:UpdateAutomationRuleV2 + - securityhub:GetAutomationRuleV2 - securityhub:TagResource - securityhub:UntagResource - securityhub:ListTagsForResource delete: - - securityhub:DisableSecurityHub + - securityhub:GetAutomationRuleV2 + - securityhub:DeleteAutomationRuleV2 list: - - securityhub:DescribeHub + - securityhub:ListAutomationRulesV2 - securityhub:ListTagsForResource - StandardsControl: - description: Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*. + ParameterValue: type: object properties: - StandardsControlArn: - type: string - description: The Amazon Resource Name (ARN) of the control. - pattern: arn:aws\S*:securityhub:\S* - Reason: - type: string - description: A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required. - required: - - StandardsControlArn + Boolean: + description: A control parameter that is a boolean. + type: boolean + Double: + description: A control parameter that is a double. + type: number + Enum: + description: A control parameter that is a enum. + $ref: '#/components/schemas/NonEmptyString' + EnumList: + description: A control parameter that is a list of enums. + $ref: '#/components/schemas/NonEmptyStringList' + Integer: + description: A control parameter that is a integer. + type: integer + IntegerList: + description: A control parameter that is a list of integers. + $ref: '#/components/schemas/IntegerList' + String: + description: A control parameter that is a string. + $ref: '#/components/schemas/NonEmptyString' + StringList: + description: A control parameter that is a list of strings. + $ref: '#/components/schemas/NonEmptyStringList' + oneOf: + - required: + - Boolean + - required: + - Double + - required: + - Enum + - required: + - EnumList + - required: + - Integer + - required: + - IntegerList + - required: + - String + - required: + - StringList additionalProperties: false - Standard: + ParameterConfiguration: type: object properties: - StandardsSubscriptionArn: - description: '' + ValueType: type: string - pattern: arn:aws\S*:securityhub:\S* - StandardsArn: - description: The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation. + enum: + - DEFAULT + - CUSTOM + Value: + $ref: '#/components/schemas/ParameterValue' + additionalProperties: false + required: + - ValueType + SecurityControlCustomParameter: + type: object + additionalProperties: false + description: An object of security control and control parameter value that are included in a configuration policy. + properties: + Parameters: + type: object + minProperties: 1 + description: An object that specifies parameter values for a control in a configuration policy. + additionalProperties: false + x-patternProperties: + ^[-_+=.:/@\w\s]{1,128}$: + $ref: '#/components/schemas/ParameterConfiguration' + SecurityControlId: type: string - pattern: arn:aws\S*:securityhub:\S - DisabledStandardsControls: - description: |- - Specifies which controls are to be disabled in a standard. - *Maximum*: ``100`` + description: The ID of the security control. + maxLength: 2048 + SecurityControlsConfiguration: + type: object + description: An object that defines which security controls are enabled in an AWS Security Hub configuration policy. + additionalProperties: false + properties: + DisabledSecurityControlIdentifiers: type: array - minItems: 0 - maxItems: 100 + description: A list of security controls that are disabled in the configuration policy + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true items: - $ref: '#/components/schemas/StandardsControl' + type: string + maxLength: 2048 + EnabledSecurityControlIdentifiers: + type: array + description: A list of security controls that are enabled in the configuration policy. + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true + items: + type: string + maxLength: 2048 + SecurityControlCustomParameters: + type: array + description: A list of security controls and control parameter values that are included in a configuration policy. + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/SecurityControlCustomParameter' + SecurityHubPolicy: + type: object + description: An object that defines how AWS Security Hub is configured. + additionalProperties: false + properties: + EnabledStandardIdentifiers: + type: array + description: A list that defines which security standards are enabled in the configuration policy. + maxItems: 1000 x-insertionOrder: true uniqueItems: true + items: + type: string + maxLength: 2048 + ServiceEnabled: + description: Indicates whether Security Hub is enabled in the policy. + type: boolean + SecurityControlsConfiguration: + $ref: '#/components/schemas/SecurityControlsConfiguration' + Policy: + description: An object that defines how Security Hub is configured. + type: object + additionalProperties: false + properties: + SecurityHub: + $ref: '#/components/schemas/SecurityHubPolicy' + ConfigurationPolicy: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the configuration policy. + type: string + pattern: ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + Name: + description: The name of the configuration policy. + type: string + minLength: 1 + maxLength: 128 + Description: + description: The description of the configuration policy. + type: string + minLength: 0 + maxLength: 512 + ConfigurationPolicy: + $ref: '#/components/schemas/Policy' + Id: + description: The universally unique identifier (UUID) of the configuration policy. + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + CreatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + ServiceEnabled: + type: boolean + description: Indicates whether the service that the configuration policy applies to is enabled in the policy. + Tags: + $ref: '#/components/schemas/Tags' required: - - StandardsArn - x-stackql-resource-name: standard - x-stackql-primaryIdentifier: - - StandardsSubscriptionArn - x-create-only-properties: - - StandardsArn + - ConfigurationPolicy + - Name + x-stackql-resource-name: configuration_policy + description: The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account. + x-type-name: AWS::SecurityHub::ConfigurationPolicy + x-stackql-primary-identifier: + - Arn x-read-only-properties: - - StandardsSubscriptionArn + - Arn + - Id + - CreatedAt + - UpdatedAt + - ServiceEnabled + x-required-properties: + - ConfigurationPolicy + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - securityhub:ListTagsForResource + - securityhub:TagResource + - securityhub:UntagResource x-required-permissions: create: - - securityhub:GetEnabledStandards - - securityhub:BatchEnableStandards - - securityhub:UpdateStandardsControl + - securityhub:CreateConfigurationPolicy + - securityhub:TagResource + - securityhub:ListTagsForResource read: - - securityhub:GetEnabledStandards - - securityhub:DescribeStandardsControls + - securityhub:GetConfigurationPolicy + - securityhub:ListTagsForResource + update: + - securityhub:UpdateConfigurationPolicy + - securityhub:TagResource + - securityhub:UntagResource + - securityhub:ListTagsForResource + delete: + - securityhub:GetConfigurationPolicy + - securityhub:DeleteConfigurationPolicy + list: + - securityhub:ListConfigurationPolicies + - securityhub:ListTagsForResource + DelegatedAdmin: + type: object + properties: + DelegatedAdminIdentifier: + description: '' + type: string + pattern: ^[0-9]{12}/[a-zA-Z0-9-]{1,32}$ + AdminAccountId: + description: The AWS-account identifier of the account to designate as the Security Hub administrator account. + type: string + pattern: ^[0-9]{12}$ + Status: + description: '' + type: string + enum: + - ENABLED + - DISABLE_IN_PROGRESS + required: + - AdminAccountId + x-stackql-resource-name: delegated_admin + description: >- + The ``AWS::SecurityHub::DelegatedAdmin`` resource designates the delegated ASHlong administrator account for an organization. You must enable the integration between ASH and AOlong before you can designate a delegated ASH administrator. Only the management account for an organization can designate the delegated ASH administrator account. For more information, see [Designating the delegated + administrator](https://docs.aws.amazon.com/securityhub/latest/userguide/designate-orgs-admin-account.html#designate-admin-instructions) in the *User Guide*. + To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account. + To designate multiple delegated administrators in different organizations and AWS-Regions, we recommend using [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html). + Tags aren't supported for this resource. + x-type-name: AWS::SecurityHub::DelegatedAdmin + x-stackql-primary-identifier: + - DelegatedAdminIdentifier + x-create-only-properties: + - AdminAccountId + x-read-only-properties: + - DelegatedAdminIdentifier + - Status + x-required-properties: + - AdminAccountId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - securityhub:EnableOrganizationAdminAccount + - organizations:DescribeOrganization + - organizations:EnableAWSServiceAccess + - organizations:RegisterDelegatedAdministrator + read: + - securityhub:ListOrganizationAdminAccounts + - organizations:DescribeOrganization + delete: + - securityhub:DisableOrganizationAdminAccount + - organizations:DescribeOrganization + list: + - securityhub:ListOrganizationAdminAccounts + - organizations:DescribeOrganization + FindingAggregator: + type: object + properties: + FindingAggregatorArn: + description: '' + type: string + pattern: arn:aws\S*:securityhub:\S* + RegionLinkingMode: + description: |- + Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them. + The selected option also determines how to use the Regions provided in the Regions list. + In CFN, the options for this property are as follows: + + ``ALL_REGIONS`` - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. + + ``ALL_REGIONS_EXCEPT_SPECIFIED`` - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the ``Regions`` parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. + + ``SPECIFIED_REGIONS`` - Indicates to aggregate findings only from the Regions listed in the ``Regions`` parameter. Security Hub does not automatically aggregate findings from new Regions. + type: string + enum: + - ALL_REGIONS + - ALL_REGIONS_EXCEPT_SPECIFIED + - SPECIFIED_REGIONS + Regions: + description: |- + If ``RegionLinkingMode`` is ``ALL_REGIONS_EXCEPT_SPECIFIED``, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region. + If ``RegionLinkingMode`` is ``SPECIFIED_REGIONS``, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region. + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Region' + FindingAggregationRegion: + description: '' + $ref: '#/components/schemas/Region' + required: + - RegionLinkingMode + x-stackql-resource-name: finding_aggregator + description: >- + The ``AWS::SecurityHub::FindingAggregator`` resource enables cross-Region aggregation. When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see [Cross-Region + aggregation](https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) in the *User Guide* + This resource must be created in the Region that you want to designate as your aggregation Region. + Cross-Region aggregation is also a prerequisite for using [central configuration](https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html) in ASH. + x-type-name: AWS::SecurityHub::FindingAggregator + x-stackql-primary-identifier: + - FindingAggregatorArn + x-read-only-properties: + - FindingAggregatorArn + - FindingAggregationRegion + x-required-properties: + - RegionLinkingMode + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:CreateFindingAggregator + read: + - securityhub:GetFindingAggregator + update: + - securityhub:UpdateFindingAggregator + delete: + - securityhub:DeleteFindingAggregator + list: + - securityhub:ListFindingAggregators + Hub: + type: object + properties: + ARN: + description: An ARN is automatically created for the customer. + type: string + pattern: ^arn:.* + EnableDefaultStandards: + description: Whether to enable the security standards that Security Hub has designated as automatically enabled. + type: boolean + ControlFindingGenerator: + description: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. + type: string + pattern: ^(SECURITY_CONTROL|STANDARD_CONTROL)$ + AutoEnableControls: + description: Whether to automatically enable new controls when they are added to standards that are enabled + type: boolean + Tags: + $ref: '#/components/schemas/Tags' + SubscribedAt: + description: The date and time when Security Hub was enabled in the account. + type: string + x-stackql-resource-name: hub + description: |+ + The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub. + + x-type-name: AWS::SecurityHub::Hub + x-stackql-primary-identifier: + - ARN + x-write-only-properties: + - EnableDefaultStandards + x-read-only-properties: + - ARN + - SubscribedAt + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - securityhub:ListTagsForResource + - securityhub:TagResource + - securityhub:UntagResource + x-required-permissions: + create: + - securityhub:EnableSecurityHub + - securityhub:UpdateSecurityHubConfiguration + - securityhub:TagResource + - securityhub:ListTagsForResource + read: + - securityhub:DescribeHub + - securityhub:ListTagsForResource + update: + - securityhub:DescribeHub + - securityhub:UpdateSecurityHubConfiguration + - securityhub:TagResource + - securityhub:UntagResource + - securityhub:ListTagsForResource + delete: + - securityhub:DisableSecurityHub + list: + - securityhub:DescribeHub + - securityhub:ListTagsForResource + HubV2: + type: object + properties: + HubV2Arn: + description: The Amazon Resource Name of the Security Hub V2 resource. + type: string + pattern: arn:aws(?:-[a-z]+)*:securityhub:[a-z0-9-]+:\d{12}:hubv2/[^/](.{0,1022}[^/:])?$ + SubscribedAt: + $ref: '#/components/schemas/ISO8601DateString' + Tags: + $ref: '#/components/schemas/Tags' + x-stackql-resource-name: hub_v2 + description: The AWS::SecurityHub::HubV2 resource represents the implementation of the AWS Security Hub V2 service in your account. Only one hubv2 resource can created in each region in which you enable Security Hub V2. + x-type-name: AWS::SecurityHub::HubV2 + x-stackql-primary-identifier: + - HubV2Arn + x-read-only-properties: + - HubV2Arn + - SubscribedAt + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - securityhub:ListTagsForResource + - securityhub:TagResource + - securityhub:UntagResource + x-required-permissions: + create: + - securityhub:EnableSecurityHubV2 + - securityhub:DescribeSecurityHubV2 + - securityhub:TagResource + - iam:CreateServiceLinkedRole + read: + - securityhub:DescribeSecurityHubV2 + - securityhub:ListTagsForResource + update: + - securityhub:DescribeSecurityHubV2 + - securityhub:TagResource + - securityhub:UntagResource + - securityhub:ListTagsForResource + delete: + - securityhub:DescribeSecurityHubV2 + - securityhub:DisableSecurityHubV2 + list: + - securityhub:DescribeSecurityHubV2 + - securityhub:ListTagsForResource + IpFilter: + description: The IP filter for querying findings. + properties: + Cidr: + description: A finding's CIDR value. + $ref: '#/components/schemas/NonEmptyString' + required: + - Cidr + type: object + additionalProperties: false + KeywordFilter: + description: A keyword filter for querying findings. + properties: + Value: + description: A value for the keyword. + $ref: '#/components/schemas/NonEmptyString' + required: + - Value + type: object + additionalProperties: false + AwsSecurityFindingFilters: + description: A collection of filters that are applied to all active findings aggregated by AWS Security Hub. + type: object + additionalProperties: false + properties: + ProductArn: + description: The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + AwsAccountId: + description: The AWS account ID in which a finding is generated. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + AwsAccountName: + description: The name of the AWS account in which a finding is generated. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Id: + description: The security findings provider-specific identifier for a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + GeneratorId: + description: The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Type: + description: A finding type in the format of namespace/category/classifier that classifies a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Region: + description: The Region from which the finding was generated. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FirstObservedAt: + description: An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + LastObservedAt: + description: An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + CreatedAt: + description: An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + UpdatedAt: + description: An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + SeverityLabel: + description: The label of a finding's severity. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Confidence: + description: A finding's confidence. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Criticality: + description: The level of importance assigned to the resources associated with the finding. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Title: + description: A finding's title. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Description: + description: A finding's description. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + RecommendationText: + description: The recommendation of what to do about the issue described in a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + SourceUrl: + description: A URL that links to a page about the current finding in the security findings provider's solution. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProductFields: + description: A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format. + items: + $ref: '#/components/schemas/MapFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProductName: + description: The name of the solution (product) that generates findings. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + CompanyName: + description: The name of the findings provider (company) that owns the solution (product) that generates findings. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + UserDefinedFields: + description: A list of name/value string pairs associated with the finding. + items: + $ref: '#/components/schemas/MapFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + MalwareName: + description: The name of the malware that was observed. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + MalwareType: + description: The type of the malware that was observed. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + MalwarePath: + description: The filesystem path of the malware that was observed. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + MalwareState: + description: The state of the malware that was observed. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkDirection: + description: Indicates the direction of network traffic associated with a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkProtocol: + description: The protocol of network-related information about a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkSourceIpV4: + description: The source IPv4 address of network-related information about a finding. + items: + $ref: '#/components/schemas/IpFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkSourceIpV6: + description: The source IPv6 address of network-related information about a finding. + items: + $ref: '#/components/schemas/IpFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkSourcePort: + description: The source port of network-related information about a finding. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkSourceDomain: + description: The source domain of network-related information about a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkSourceMac: + description: The source media access control (MAC) address of network-related information about a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkDestinationIpV4: + description: The destination IPv4 address of network-related information about a finding. + items: + $ref: '#/components/schemas/IpFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkDestinationIpV6: + description: The destination IPv6 address of network-related information about a finding. + items: + $ref: '#/components/schemas/IpFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkDestinationPort: + description: The destination port of network-related information about a finding. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NetworkDestinationDomain: + description: The destination domain of network-related information about a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProcessName: + description: The name of the process. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProcessPath: + description: The path to the process executable. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProcessPid: + description: The process ID. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProcessParentPid: + description: The parent process ID. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProcessLaunchedAt: + description: A timestamp that identifies when the process was launched. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ProcessTerminatedAt: + description: A timestamp that identifies when the process was terminated. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ThreatIntelIndicatorType: + description: The type of a threat intelligence indicator. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ThreatIntelIndicatorValue: + description: The value of a threat intelligence indicator. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ThreatIntelIndicatorCategory: + description: The category of a threat intelligence indicator. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ThreatIntelIndicatorLastObservedAt: + description: A timestamp that identifies the last observation of a threat intelligence indicator. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ThreatIntelIndicatorSource: + description: The source of the threat intelligence. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ThreatIntelIndicatorSourceUrl: + description: The URL for more details from the source of the threat intelligence. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceType: + description: Specifies the type of the resource that details are provided for. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceId: + description: The canonical identifier for the given resource type. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourcePartition: + description: The canonical AWS partition name that the Region is assigned to. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceRegion: + description: The canonical AWS external Region name where this resource is located. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceTags: + description: A list of AWS tags associated with a resource at the time the finding was processed. + items: + $ref: '#/components/schemas/MapFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceType: + description: The instance type of the instance. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceImageId: + description: The Amazon Machine Image (AMI) ID of the instance. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceIpV4Addresses: + description: The IPv4 addresses associated with the instance. + items: + $ref: '#/components/schemas/IpFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceIpV6Addresses: + description: The IPv6 addresses associated with the instance. + items: + $ref: '#/components/schemas/IpFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceKeyName: + description: The key name associated with the instance. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceIamInstanceProfileArn: + description: The IAM profile ARN of the instance. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceVpcId: + description: The identifier of the VPC that the instance was launched in. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceSubnetId: + description: The identifier of the subnet that the instance was launched in. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsEc2InstanceLaunchedAt: + description: The date and time the instance was launched. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsS3BucketOwnerId: + description: The canonical user ID of the owner of the S3 bucket. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsS3BucketOwnerName: + description: The display name of the owner of the S3 bucket. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsIamAccessKeyStatus: + description: The status of the IAM access key related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsIamAccessKeyCreatedAt: + description: The creation date/time of the IAM access key related to a finding. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceContainerName: + description: The name of the container related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceContainerImageId: + description: The identifier of the image related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceContainerImageName: + description: The name of the image related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceContainerLaunchedAt: + description: A timestamp that identifies when the container was started. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceDetailsOther: + description: The details of a resource that doesn't have a specific subfield for the resource type defined. + items: + $ref: '#/components/schemas/MapFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ComplianceStatus: + description: Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + VerificationState: + description: The veracity of a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + WorkflowState: + description: The workflow state of a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + WorkflowStatus: + description: The status of the investigation into a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + RecordState: + description: The updated record state for the finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + RelatedFindingsProductArn: + description: The ARN of the solution that generated a related finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + RelatedFindingsId: + description: The solution-generated identifier for a related finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceApplicationArn: + description: The ARN of the application that is related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceApplicationName: + description: The name of the application that is related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NoteText: + description: The text of a note. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NoteUpdatedAt: + description: The timestamp of when the note was updated. + items: + $ref: '#/components/schemas/DateFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + NoteUpdatedBy: + description: The principal that created a note. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Sample: + description: Indicates whether or not sample findings are included in the filter results. + items: + $ref: '#/components/schemas/BooleanFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ComplianceAssociatedStandardsId: + description: The unique identifier of a standard in which a control is enabled. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ComplianceSecurityControlId: + description: The unique identifier of a control across standards. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ComplianceSecurityControlParametersName: + description: The name of a security control parameter. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ComplianceSecurityControlParametersValue: + description: The current value of a security control parameter. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsConfidence: + description: The finding provider value for the finding confidence. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsCriticality: + description: The finding provider value for the level of importance assigned to the resources associated with the findings. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsRelatedFindingsId: + description: The finding identifier of a related finding that is identified by the finding provider. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsRelatedFindingsProductArn: + description: The ARN of the solution that generated a related finding that is identified by the finding provider. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsSeverityLabel: + description: The finding provider value for the severity label. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsSeverityOriginal: + description: The finding provider's original value for the severity. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + FindingProviderFieldsTypes: + description: One or more finding types that the finding provider assigned to the finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsIamAccessKeyPrincipalName: + description: The name of the principal that is associated with an IAM access key. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsIamUserUserName: + description: The name of an IAM user. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + VulnerabilitiesExploitAvailable: + description: Indicates whether a software vulnerability in your environment has a known exploit. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + VulnerabilitiesFixAvailable: + description: Indicates whether a vulnerability is fixed in a newer version of the affected software packages. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Keyword: + description: A keyword for a finding. + items: + $ref: '#/components/schemas/KeywordFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + ResourceAwsIamAccessKeyUserName: + description: The user associated with the IAM access key related to a finding. + items: + $ref: '#/components/schemas/StringFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + SeverityNormalized: + description: The normalized severity of a finding. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + SeverityProduct: + description: The native severity as defined by the security findings provider's solution that generated the finding. + items: + $ref: '#/components/schemas/NumberFilter' + type: array + x-insertionOrder: true + uniqueItems: true + maxItems: 20 + Insight: + type: object + properties: + InsightArn: + description: The ARN of a Security Hub insight + type: string + pattern: arn:aws\S*:securityhub:\S* + Name: + description: The name of a Security Hub insight + type: string + minLength: 1 + maxLength: 128 + Filters: + description: One or more attributes used to filter the findings included in the insight + $ref: '#/components/schemas/AwsSecurityFindingFilters' + maxProperties: 10 + GroupByAttribute: + description: The grouping attribute for the insight's findings + $ref: '#/components/schemas/NonEmptyString' + required: + - Filters + - Name + - GroupByAttribute + x-stackql-resource-name: insight + description: The AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings. + x-type-name: AWS::SecurityHub::Insight + x-stackql-primary-identifier: + - InsightArn + x-read-only-properties: + - InsightArn + x-required-properties: + - Filters + - Name + - GroupByAttribute + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:CreateInsight + read: + - securityhub:GetInsights + update: + - securityhub:UpdateInsight + delete: + - securityhub:GetInsights + - securityhub:DeleteInsight + list: + - securityhub:GetInsights + OrganizationConfiguration: + type: object + properties: + AutoEnable: + description: Whether to automatically enable Security Hub in new member accounts when they join the organization. + type: boolean + AutoEnableStandards: + description: Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. + type: string + enum: + - DEFAULT + - NONE + ConfigurationType: + description: Indicates whether the organization uses local or central configuration. + type: string + enum: + - CENTRAL + - LOCAL + Status: + description: Describes whether central configuration could be enabled as the ConfigurationType for the organization. + type: string + enum: + - PENDING + - ENABLED + - FAILED + StatusMessage: + description: Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL. + type: string + MemberAccountLimitReached: + description: Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account. + type: boolean + OrganizationConfigurationIdentifier: + description: The identifier of the OrganizationConfiguration being created and assigned as the unique identifier. + type: string + pattern: ^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$ + required: + - AutoEnable + x-stackql-resource-name: organization_configuration + description: The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator. + x-type-name: AWS::SecurityHub::OrganizationConfiguration + x-stackql-primary-identifier: + - OrganizationConfigurationIdentifier + x-read-only-properties: + - OrganizationConfigurationIdentifier + - Status + - StatusMessage + - MemberAccountLimitReached + x-required-properties: + - AutoEnable + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:UpdateOrganizationConfiguration + - securityhub:DescribeOrganizationConfiguration + - organizations:DescribeOrganization + read: + - securityhub:DescribeOrganizationConfiguration + update: + - securityhub:UpdateOrganizationConfiguration + - securityhub:DescribeOrganizationConfiguration + - organizations:DescribeOrganization + delete: + - securityhub:UpdateOrganizationConfiguration + - securityhub:DescribeOrganizationConfiguration + - securityhub:ListFindingAggregators + - organizations:DescribeOrganization + list: + - securityhub:DescribeOrganizationConfiguration + PolicyAssociation: + type: object + properties: + ConfigurationPolicyId: + description: The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$ + AssociationStatus: + description: The current status of the association between the specified target and the configuration + type: string + enum: + - SUCCESS + - PENDING + - FAILED + AssociationType: + description: Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent + type: string + enum: + - APPLIED + - INHERITED + AssociationStatusMessage: + description: An explanation for a FAILED value for AssociationStatus + type: string + TargetId: + description: The identifier of the target account, organizational unit, or the root + type: string + TargetType: + description: Indicates whether the target is an AWS account, organizational unit, or the organization root + type: string + enum: + - ACCOUNT + - ORGANIZATIONAL_UNIT + - ROOT + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated + type: string + AssociationIdentifier: + description: A unique identifier to indicates if the target has an association + type: string + required: + - TargetId + - TargetType + - ConfigurationPolicyId + x-stackql-resource-name: policy_association + description: The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region. + x-type-name: AWS::SecurityHub::PolicyAssociation + x-stackql-primary-identifier: + - AssociationIdentifier + x-create-only-properties: + - TargetId + - TargetType + x-read-only-properties: + - AssociationStatus + - AssociationType + - AssociationStatusMessage + - UpdatedAt + - AssociationIdentifier + x-required-properties: + - TargetId + - TargetType + - ConfigurationPolicyId + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:StartConfigurationPolicyAssociation + - securityhub:GetConfigurationPolicyAssociation + read: + - securityhub:GetConfigurationPolicyAssociation + - securityhub:GetConfigurationPolicyAssociation + update: + - securityhub:StartConfigurationPolicyAssociation + - securityhub:GetConfigurationPolicyAssociation + delete: + - securityhub:StartConfigurationPolicyDisassociation + - securityhub:GetConfigurationPolicyAssociation + list: + - securityhub:ListConfigurationPolicyAssociations + ProductSubscription: + type: object + properties: + ProductArn: + description: The generic ARN of the product being subscribed to + type: string + pattern: arn:aws\S*:securityhub:\S* + ProductSubscriptionArn: + description: The ARN of the product subscription for the account + type: string + pattern: arn:aws\S*:securityhub:\S* + required: + - ProductArn + x-stackql-resource-name: product_subscription + description: The AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled. + x-type-name: AWS::SecurityHub::ProductSubscription + x-stackql-primary-identifier: + - ProductSubscriptionArn + x-create-only-properties: + - ProductArn + x-read-only-properties: + - ProductSubscriptionArn + x-required-properties: + - ProductArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - securityhub:EnableImportFindingsForProduct + read: + - securityhub:ListEnabledProductsForImport + delete: + - securityhub:ListEnabledProductsForImport + - securityhub:DisableImportFindingsForProduct + list: + - securityhub:ListEnabledProductsForImport + NonEmptyStringList: + items: + $ref: '#/components/schemas/NonEmptyString' + type: array + IntegerList: + items: + type: integer + type: array + Parameters: + type: object + x-patternProperties: + .*\S.*: + $ref: '#/components/schemas/ParameterConfiguration' + additionalProperties: false + SecurityControl: + type: object + properties: + SecurityControlId: + description: The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3. + $ref: '#/components/schemas/NonEmptyString' + SecurityControlArn: + description: The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard. + $ref: '#/components/schemas/NonEmptyString' + LastUpdateReason: + description: The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. + type: string + pattern: "^([^\0-\x7F]|[-_ a-zA-Z0-9])+$" + Parameters: + description: An object that identifies the name of a control parameter, its current value, and whether it has been customized. + $ref: '#/components/schemas/Parameters' + required: + - Parameters + x-stackql-resource-name: security_control + description: A security control in Security Hub describes a security best practice related to a specific resource. + x-type-name: AWS::SecurityHub::SecurityControl + x-stackql-primary-identifier: + - SecurityControlId + x-stackql-additional-identifiers: + - - SecurityControlArn + x-create-only-properties: + - SecurityControlId + x-required-properties: + - Parameters + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:UpdateSecurityControl + - securityhub:UpdateStandardsControl + read: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + update: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:UpdateSecurityControl + - securityhub:UpdateStandardsControl + delete: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:UpdateSecurityControl + - securityhub:UpdateStandardsControl + list: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:ListSecurityControlDefinitions + StandardsControl: + description: Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*. + type: object + properties: + StandardsControlArn: + type: string + description: The Amazon Resource Name (ARN) of the control. + pattern: arn:aws\S*:securityhub:\S* + Reason: + type: string + description: A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required. + required: + - StandardsControlArn + additionalProperties: false + Standard: + type: object + properties: + StandardsSubscriptionArn: + description: '' + type: string + pattern: arn:aws\S*:securityhub:\S* + StandardsArn: + description: The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation. + type: string + pattern: arn:aws\S*:securityhub:\S + DisabledStandardsControls: + description: |- + Specifies which controls are to be disabled in a standard. + *Maximum*: ``100`` + type: array + minItems: 0 + maxItems: 100 + items: + $ref: '#/components/schemas/StandardsControl' + x-insertionOrder: true + uniqueItems: true + required: + - StandardsArn + x-stackql-resource-name: standard + description: |- + The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation. + You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable. + For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*. + x-type-name: AWS::SecurityHub::Standard + x-stackql-primary-identifier: + - StandardsSubscriptionArn + x-stackql-additional-identifiers: + - - StandardsArn + x-create-only-properties: + - StandardsArn + x-read-only-properties: + - StandardsSubscriptionArn + x-required-properties: + - StandardsArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - securityhub:GetEnabledStandards + - securityhub:BatchEnableStandards + - securityhub:UpdateStandardsControl + read: + - securityhub:GetEnabledStandards + - securityhub:DescribeStandardsControls + update: + - securityhub:GetEnabledStandards + - securityhub:UpdateStandardsControl + delete: + - securityhub:GetEnabledStandards + - securityhub:BatchDisableStandards + list: + - securityhub:GetEnabledStandards + CreateAggregatorV2Request: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AggregatorV2Arn: + description: The ARN of the AggregatorV2 being created and assigned as the unique identifier + type: string + pattern: arn:aws\S*:securityhub:\S* + RegionLinkingMode: + description: Indicates to link a list of included Regions + type: string + enum: + - SPECIFIED_REGIONS + LinkedRegions: + description: The list of included Regions + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Region' + Tags: + $ref: '#/components/schemas/Tags' + AggregationRegion: + description: The aggregation Region of the AggregatorV2 + $ref: '#/components/schemas/Region' + x-stackQL-stringOnly: true + x-title: CreateAggregatorV2Request + type: object + required: [] + CreateAutomationRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleArn: + description: '' + type: string + pattern: arn:aws\S*:securityhub:\S* + RuleStatus: + description: Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created. + type: string + enum: + - ENABLED + - DISABLED + RuleOrder: + description: An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first. + type: integer + minimum: 1 + maximum: 1000 + Description: + description: A description of the rule. + type: string + minLength: 1 + maxLength: 1024 + RuleName: + description: The name of the rule. + type: string + minLength: 1 + maxLength: 256 + CreatedAt: + description: '' + $ref: '#/components/schemas/ISO8601DateString' + UpdatedAt: + description: '' + $ref: '#/components/schemas/ISO8601DateString' + CreatedBy: + description: '' + type: string + minLength: 1 + maxLength: 256 + IsTerminal: + description: Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal. + type: boolean + Actions: + type: array + description: One or more actions to update finding fields if a finding matches the conditions specified in ``Criteria``. + items: + $ref: '#/components/schemas/AutomationRulesAction' + minItems: 1 + maxItems: 1 + Criteria: + description: A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding. + $ref: '#/components/schemas/AutomationRulesFindingFilters' + Tags: + description: User-defined tags associated with an automation rule. + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateAutomationRuleRequest + type: object + required: [] + CreateAutomationRuleV2Request: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleName: + description: The name of the automation rule + type: string + pattern: .*\S.* + minLength: 1 + maxLength: 256 + RuleStatus: + description: The status of the automation rule + type: string + enum: + - ENABLED + - DISABLED + Description: + description: A description of the automation rule + type: string + pattern: .*\S.* + minLength: 1 + maxLength: 256 + RuleOrder: + description: The value for the rule priority + type: number + minimum: 1 + maximum: 1000 + Criteria: + $ref: '#/components/schemas/Criteria' + Actions: + description: A list of actions to be performed when the rule criteria is met + type: array + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/AutomationRulesActionV2' + minItems: 1 + maxItems: 1 + Tags: + $ref: '#/components/schemas/Tags' + RuleArn: + description: The ARN of the automation rule + type: string + pattern: ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:automation-rulev2/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + RuleId: + description: The ID of the automation rule + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + CreatedAt: + $ref: '#/components/schemas/ISO8601DateString' + UpdatedAt: + $ref: '#/components/schemas/ISO8601DateString' + x-stackQL-stringOnly: true + x-title: CreateAutomationRuleV2Request + type: object + required: [] + CreateConfigurationPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the configuration policy. + type: string + pattern: ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + Name: + description: The name of the configuration policy. + type: string + minLength: 1 + maxLength: 128 + Description: + description: The description of the configuration policy. + type: string + minLength: 0 + maxLength: 512 + ConfigurationPolicy: + $ref: '#/components/schemas/Policy' + Id: + description: The universally unique identifier (UUID) of the configuration policy. + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + CreatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + ServiceEnabled: + type: boolean + description: Indicates whether the service that the configuration policy applies to is enabled in the policy. + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateConfigurationPolicyRequest + type: object + required: [] + CreateDelegatedAdminRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DelegatedAdminIdentifier: + description: '' + type: string + pattern: ^[0-9]{12}/[a-zA-Z0-9-]{1,32}$ + AdminAccountId: + description: The AWS-account identifier of the account to designate as the Security Hub administrator account. + type: string + pattern: ^[0-9]{12}$ + Status: + description: '' + type: string + enum: + - ENABLED + - DISABLE_IN_PROGRESS + x-stackQL-stringOnly: true + x-title: CreateDelegatedAdminRequest + type: object + required: [] + CreateFindingAggregatorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FindingAggregatorArn: + description: '' + type: string + pattern: arn:aws\S*:securityhub:\S* + RegionLinkingMode: + description: |- + Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them. + The selected option also determines how to use the Regions provided in the Regions list. + In CFN, the options for this property are as follows: + + ``ALL_REGIONS`` - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. + + ``ALL_REGIONS_EXCEPT_SPECIFIED`` - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the ``Regions`` parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. + + ``SPECIFIED_REGIONS`` - Indicates to aggregate findings only from the Regions listed in the ``Regions`` parameter. Security Hub does not automatically aggregate findings from new Regions. + type: string + enum: + - ALL_REGIONS + - ALL_REGIONS_EXCEPT_SPECIFIED + - SPECIFIED_REGIONS + Regions: + description: |- + If ``RegionLinkingMode`` is ``ALL_REGIONS_EXCEPT_SPECIFIED``, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region. + If ``RegionLinkingMode`` is ``SPECIFIED_REGIONS``, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region. + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Region' + FindingAggregationRegion: + description: '' + $ref: '#/components/schemas/Region' + x-stackQL-stringOnly: true + x-title: CreateFindingAggregatorRequest + type: object + required: [] + CreateHubRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ARN: + description: An ARN is automatically created for the customer. + type: string + pattern: ^arn:.* + EnableDefaultStandards: + description: Whether to enable the security standards that Security Hub has designated as automatically enabled. + type: boolean + ControlFindingGenerator: + description: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. + type: string + pattern: ^(SECURITY_CONTROL|STANDARD_CONTROL)$ + AutoEnableControls: + description: Whether to automatically enable new controls when they are added to standards that are enabled + type: boolean + Tags: + $ref: '#/components/schemas/Tags' + SubscribedAt: + description: The date and time when Security Hub was enabled in the account. + type: string + x-stackQL-stringOnly: true + x-title: CreateHubRequest + type: object + required: [] + CreateHubV2Request: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + HubV2Arn: + description: The Amazon Resource Name of the Security Hub V2 resource. + type: string + pattern: arn:aws(?:-[a-z]+)*:securityhub:[a-z0-9-]+:\d{12}:hubv2/[^/](.{0,1022}[^/:])?$ + SubscribedAt: + $ref: '#/components/schemas/ISO8601DateString' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateHubV2Request + type: object + required: [] + CreateInsightRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InsightArn: + description: The ARN of a Security Hub insight + type: string + pattern: arn:aws\S*:securityhub:\S* + Name: + description: The name of a Security Hub insight + type: string + minLength: 1 + maxLength: 128 + Filters: + description: One or more attributes used to filter the findings included in the insight + $ref: '#/components/schemas/AwsSecurityFindingFilters' + maxProperties: 10 + GroupByAttribute: + description: The grouping attribute for the insight's findings + $ref: '#/components/schemas/NonEmptyString' + x-stackQL-stringOnly: true + x-title: CreateInsightRequest + type: object + required: [] + CreateOrganizationConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoEnable: + description: Whether to automatically enable Security Hub in new member accounts when they join the organization. + type: boolean + AutoEnableStandards: + description: Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. + type: string + enum: + - DEFAULT + - NONE + ConfigurationType: + description: Indicates whether the organization uses local or central configuration. + type: string + enum: + - CENTRAL + - LOCAL + Status: + description: Describes whether central configuration could be enabled as the ConfigurationType for the organization. + type: string + enum: + - PENDING + - ENABLED + - FAILED + StatusMessage: + description: Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL. + type: string + MemberAccountLimitReached: + description: Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account. + type: boolean + OrganizationConfigurationIdentifier: + description: The identifier of the OrganizationConfiguration being created and assigned as the unique identifier. + type: string + pattern: ^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$ + x-stackQL-stringOnly: true + x-title: CreateOrganizationConfigurationRequest + type: object + required: [] + CreatePolicyAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConfigurationPolicyId: + description: The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$ + AssociationStatus: + description: The current status of the association between the specified target and the configuration + type: string + enum: + - SUCCESS + - PENDING + - FAILED + AssociationType: + description: Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent + type: string + enum: + - APPLIED + - INHERITED + AssociationStatusMessage: + description: An explanation for a FAILED value for AssociationStatus + type: string + TargetId: + description: The identifier of the target account, organizational unit, or the root + type: string + TargetType: + description: Indicates whether the target is an AWS account, organizational unit, or the organization root + type: string + enum: + - ACCOUNT + - ORGANIZATIONAL_UNIT + - ROOT + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated + type: string + AssociationIdentifier: + description: A unique identifier to indicates if the target has an association + type: string + x-stackQL-stringOnly: true + x-title: CreatePolicyAssociationRequest + type: object + required: [] + CreateProductSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProductArn: + description: The generic ARN of the product being subscribed to + type: string + pattern: arn:aws\S*:securityhub:\S* + ProductSubscriptionArn: + description: The ARN of the product subscription for the account + type: string + pattern: arn:aws\S*:securityhub:\S* + x-stackQL-stringOnly: true + x-title: CreateProductSubscriptionRequest + type: object + required: [] + CreateSecurityControlRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SecurityControlId: + description: The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3. + $ref: '#/components/schemas/NonEmptyString' + SecurityControlArn: + description: The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard. + $ref: '#/components/schemas/NonEmptyString' + LastUpdateReason: + description: The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. + type: string + pattern: "^([^\0-\x7F]|[-_ a-zA-Z0-9])+$" + Parameters: + description: An object that identifies the name of a control parameter, its current value, and whether it has been customized. + $ref: '#/components/schemas/Parameters' + x-stackQL-stringOnly: true + x-title: CreateSecurityControlRequest + type: object + required: [] + CreateStandardRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + StandardsSubscriptionArn: + description: '' + type: string + pattern: arn:aws\S*:securityhub:\S* + StandardsArn: + description: The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation. + type: string + pattern: arn:aws\S*:securityhub:\S + DisabledStandardsControls: + description: |- + Specifies which controls are to be disabled in a standard. + *Maximum*: ``100`` + type: array + minItems: 0 + maxItems: 100 + items: + $ref: '#/components/schemas/StandardsControl' + x-insertionOrder: true + uniqueItems: true + x-stackQL-stringOnly: true + x-title: CreateStandardRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + aggregator_v2s: + name: aggregator_v2s + id: awscc.securityhub.aggregator_v2s + x-cfn-schema-name: AggregatorV2 + x-cfn-type-name: AWS::SecurityHub::AggregatorV2 + x-identifiers: + - AggregatorV2Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AggregatorV2&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AggregatorV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AggregatorV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AggregatorV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aggregator_v2s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aggregator_v2s/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aggregator_v2s/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AggregatorV2Arn') as aggregator_v2_arn, + JSON_EXTRACT(Properties, '$.RegionLinkingMode') as region_linking_mode, + JSON_EXTRACT(Properties, '$.LinkedRegions') as linked_regions, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AggregationRegion') as aggregation_region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AggregatorV2' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AggregatorV2Arn') as aggregator_v2_arn, + json_extract_path_text(Properties, 'RegionLinkingMode') as region_linking_mode, + json_extract_path_text(Properties, 'LinkedRegions') as linked_regions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AggregationRegion') as aggregation_region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AggregatorV2' + AND data__Identifier = '' + AND region = 'us-east-1' + aggregator_v2s_list_only: + name: aggregator_v2s_list_only + id: awscc.securityhub.aggregator_v2s_list_only + x-cfn-schema-name: AggregatorV2 + x-cfn-type-name: AWS::SecurityHub::AggregatorV2 + x-identifiers: + - AggregatorV2Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AggregatorV2Arn') as aggregator_v2_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AggregatorV2' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AggregatorV2Arn') as aggregator_v2_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AggregatorV2' + AND region = 'us-east-1' + automation_rules: + name: automation_rules + id: awscc.securityhub.automation_rules + x-cfn-schema-name: AutomationRule + x-cfn-type-name: AWS::SecurityHub::AutomationRule + x-identifiers: + - RuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutomationRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/automation_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/automation_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/automation_rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.RuleStatus') as rule_status, + JSON_EXTRACT(Properties, '$.RuleOrder') as rule_order, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.RuleName') as rule_name, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.IsTerminal') as is_terminal, + JSON_EXTRACT(Properties, '$.Actions') as actions, + JSON_EXTRACT(Properties, '$.Criteria') as criteria, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'RuleStatus') as rule_status, + json_extract_path_text(Properties, 'RuleOrder') as rule_order, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'IsTerminal') as is_terminal, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Criteria') as criteria, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND data__Identifier = '' + AND region = 'us-east-1' + automation_rules_list_only: + name: automation_rules_list_only + id: awscc.securityhub.automation_rules_list_only + x-cfn-schema-name: AutomationRule + x-cfn-type-name: AWS::SecurityHub::AutomationRule + x-identifiers: + - RuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND region = 'us-east-1' + automation_rule_v2s: + name: automation_rule_v2s + id: awscc.securityhub.automation_rule_v2s + x-cfn-schema-name: AutomationRuleV2 + x-cfn-type-name: AWS::SecurityHub::AutomationRuleV2 + x-identifiers: + - RuleArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AutomationRuleV2&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRuleV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRuleV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRuleV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/automation_rule_v2s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/automation_rule_v2s/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/automation_rule_v2s/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.RuleName') as rule_name, + JSON_EXTRACT(Properties, '$.RuleStatus') as rule_status, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.RuleOrder') as rule_order, + JSON_EXTRACT(Properties, '$.Criteria') as criteria, + JSON_EXTRACT(Properties, '$.Actions') as actions, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.RuleId') as rule_id, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRuleV2' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'RuleStatus') as rule_status, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RuleOrder') as rule_order, + json_extract_path_text(Properties, 'Criteria') as criteria, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'RuleId') as rule_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRuleV2' + AND data__Identifier = '' + AND region = 'us-east-1' + automation_rule_v2s_list_only: + name: automation_rule_v2s_list_only + id: awscc.securityhub.automation_rule_v2s_list_only + x-cfn-schema-name: AutomationRuleV2 + x-cfn-type-name: AWS::SecurityHub::AutomationRuleV2 + x-identifiers: + - RuleArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRuleV2' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRuleV2' + AND region = 'us-east-1' + configuration_policies: + name: configuration_policies + id: awscc.securityhub.configuration_policies + x-cfn-schema-name: ConfigurationPolicy + x-cfn-type-name: AWS::SecurityHub::ConfigurationPolicy + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ConfigurationPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ConfigurationPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ConfigurationPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ConfigurationPolicy') as configuration_policy, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.ServiceEnabled') as service_enabled, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ConfigurationPolicy') as configuration_policy, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'ServiceEnabled') as service_enabled, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + configuration_policies_list_only: + name: configuration_policies_list_only + id: awscc.securityhub.configuration_policies_list_only + x-cfn-schema-name: ConfigurationPolicy + x-cfn-type-name: AWS::SecurityHub::ConfigurationPolicy + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND region = 'us-east-1' + delegated_admins: + name: delegated_admins + id: awscc.securityhub.delegated_admins + x-cfn-schema-name: DelegatedAdmin + x-cfn-type-name: AWS::SecurityHub::DelegatedAdmin + x-identifiers: + - DelegatedAdminIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DelegatedAdmin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::DelegatedAdmin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::DelegatedAdmin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delegated_admins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delegated_admins/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DelegatedAdminIdentifier') as delegated_admin_identifier, + JSON_EXTRACT(Properties, '$.AdminAccountId') as admin_account_id, + JSON_EXTRACT(Properties, '$.Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DelegatedAdminIdentifier') as delegated_admin_identifier, + json_extract_path_text(Properties, 'AdminAccountId') as admin_account_id, + json_extract_path_text(Properties, 'Status') as status + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' + AND data__Identifier = '' + AND region = 'us-east-1' + delegated_admins_list_only: + name: delegated_admins_list_only + id: awscc.securityhub.delegated_admins_list_only + x-cfn-schema-name: DelegatedAdmin + x-cfn-type-name: AWS::SecurityHub::DelegatedAdmin + x-identifiers: + - DelegatedAdminIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DelegatedAdminIdentifier') as delegated_admin_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DelegatedAdminIdentifier') as delegated_admin_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' + AND region = 'us-east-1' + finding_aggregators: + name: finding_aggregators + id: awscc.securityhub.finding_aggregators + x-cfn-schema-name: FindingAggregator + x-cfn-type-name: AWS::SecurityHub::FindingAggregator + x-identifiers: + - FindingAggregatorArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FindingAggregator&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::FindingAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::FindingAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::FindingAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/finding_aggregators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/finding_aggregators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/finding_aggregators/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.FindingAggregatorArn') as finding_aggregator_arn, + JSON_EXTRACT(Properties, '$.RegionLinkingMode') as region_linking_mode, + JSON_EXTRACT(Properties, '$.Regions') as regions, + JSON_EXTRACT(Properties, '$.FindingAggregationRegion') as finding_aggregation_region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FindingAggregatorArn') as finding_aggregator_arn, + json_extract_path_text(Properties, 'RegionLinkingMode') as region_linking_mode, + json_extract_path_text(Properties, 'Regions') as regions, + json_extract_path_text(Properties, 'FindingAggregationRegion') as finding_aggregation_region + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND data__Identifier = '' + AND region = 'us-east-1' + finding_aggregators_list_only: + name: finding_aggregators_list_only + id: awscc.securityhub.finding_aggregators_list_only + x-cfn-schema-name: FindingAggregator + x-cfn-type-name: AWS::SecurityHub::FindingAggregator + x-identifiers: + - FindingAggregatorArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.FindingAggregatorArn') as finding_aggregator_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FindingAggregatorArn') as finding_aggregator_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND region = 'us-east-1' + hubs: + name: hubs + id: awscc.securityhub.hubs + x-cfn-schema-name: Hub + x-cfn-type-name: AWS::SecurityHub::Hub + x-identifiers: + - ARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Hub&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Hub" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Hub" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Hub" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hubs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hubs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hubs/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ARN') as arn, + JSON_EXTRACT(Properties, '$.EnableDefaultStandards') as enable_default_standards, + JSON_EXTRACT(Properties, '$.ControlFindingGenerator') as control_finding_generator, + JSON_EXTRACT(Properties, '$.AutoEnableControls') as auto_enable_controls, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.SubscribedAt') as subscribed_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Hub' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'EnableDefaultStandards') as enable_default_standards, + json_extract_path_text(Properties, 'ControlFindingGenerator') as control_finding_generator, + json_extract_path_text(Properties, 'AutoEnableControls') as auto_enable_controls, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SubscribedAt') as subscribed_at + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Hub' + AND data__Identifier = '' + AND region = 'us-east-1' + hubs_list_only: + name: hubs_list_only + id: awscc.securityhub.hubs_list_only + x-cfn-schema-name: Hub + x-cfn-type-name: AWS::SecurityHub::Hub + x-identifiers: + - ARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ARN') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ARN') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + AND region = 'us-east-1' + hub_v2s: + name: hub_v2s + id: awscc.securityhub.hub_v2s + x-cfn-schema-name: HubV2 + x-cfn-type-name: AWS::SecurityHub::HubV2 + x-identifiers: + - HubV2Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__HubV2&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::HubV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::HubV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::HubV2" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hub_v2s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hub_v2s/methods/delete_resource' update: - - securityhub:GetEnabledStandards - - securityhub:UpdateStandardsControl + - $ref: '#/components/x-stackQL-resources/hub_v2s/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.HubV2Arn') as hub_v2_arn, + JSON_EXTRACT(Properties, '$.SubscribedAt') as subscribed_at, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::HubV2' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'HubV2Arn') as hub_v2_arn, + json_extract_path_text(Properties, 'SubscribedAt') as subscribed_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::HubV2' + AND data__Identifier = '' + AND region = 'us-east-1' + hub_v2s_list_only: + name: hub_v2s_list_only + id: awscc.securityhub.hub_v2s_list_only + x-cfn-schema-name: HubV2 + x-cfn-type-name: AWS::SecurityHub::HubV2 + x-identifiers: + - HubV2Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.HubV2Arn') as hub_v2_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::HubV2' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HubV2Arn') as hub_v2_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::HubV2' + AND region = 'us-east-1' + insights: + name: insights + id: awscc.securityhub.insights + x-cfn-schema-name: Insight + x-cfn-type-name: AWS::SecurityHub::Insight + x-identifiers: + - InsightArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Insight&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Insight" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Insight" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Insight" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/insights/methods/create_resource' delete: - - securityhub:GetEnabledStandards - - securityhub:BatchDisableStandards - list: - - securityhub:GetEnabledStandards - x-stackQL-resources: - automation_rules: - name: automation_rules - id: awscc.securityhub.automation_rules - x-cfn-schema-name: AutomationRule - x-type: list + - $ref: '#/components/x-stackQL-resources/insights/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/insights/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.InsightArn') as insight_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Filters') as filters, + JSON_EXTRACT(Properties, '$.GroupByAttribute') as group_by_attribute + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Insight' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InsightArn') as insight_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Filters') as filters, + json_extract_path_text(Properties, 'GroupByAttribute') as group_by_attribute + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Insight' + AND data__Identifier = '' + AND region = 'us-east-1' + insights_list_only: + name: insights_list_only + id: awscc.securityhub.insights_list_only + x-cfn-schema-name: Insight + x-cfn-type-name: AWS::SecurityHub::Insight x-identifiers: - - RuleArn + - InsightArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -723,75 +4817,241 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + JSON_EXTRACT(Properties, '$.InsightArn') as insight_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Insight' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RuleArn') as rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + json_extract_path_text(Properties, 'InsightArn') as insight_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Insight' AND region = 'us-east-1' - automation_rule: - name: automation_rule - id: awscc.securityhub.automation_rule - x-cfn-schema-name: AutomationRule - x-type: get + organization_configurations: + name: organization_configurations + id: awscc.securityhub.organization_configurations + x-cfn-schema-name: OrganizationConfiguration + x-cfn-type-name: AWS::SecurityHub::OrganizationConfiguration x-identifiers: - - RuleArn + - OrganizationConfigurationIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::OrganizationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::OrganizationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::OrganizationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organization_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organization_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/organization_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AutoEnable') as auto_enable, + JSON_EXTRACT(Properties, '$.AutoEnableStandards') as auto_enable_standards, + JSON_EXTRACT(Properties, '$.ConfigurationType') as configuration_type, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.MemberAccountLimitReached') as member_account_limit_reached, + JSON_EXTRACT(Properties, '$.OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AutoEnable') as auto_enable, + json_extract_path_text(Properties, 'AutoEnableStandards') as auto_enable_standards, + json_extract_path_text(Properties, 'ConfigurationType') as configuration_type, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'MemberAccountLimitReached') as member_account_limit_reached, + json_extract_path_text(Properties, 'OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + organization_configurations_list_only: + name: organization_configurations_list_only + id: awscc.securityhub.organization_configurations_list_only + x-cfn-schema-name: OrganizationConfiguration + x-cfn-type-name: AWS::SecurityHub::OrganizationConfiguration + x-identifiers: + - OrganizationConfigurationIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND region = 'us-east-1' + policy_associations: + name: policy_associations + id: awscc.securityhub.policy_associations + x-cfn-schema-name: PolicyAssociation + x-cfn-type-name: AWS::SecurityHub::PolicyAssociation + x-identifiers: + - AssociationIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PolicyAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::PolicyAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::PolicyAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::PolicyAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policy_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, - JSON_EXTRACT(Properties, '$.RuleStatus') as rule_status, - JSON_EXTRACT(Properties, '$.RuleOrder') as rule_order, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.RuleName') as rule_name, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.ConfigurationPolicyId') as configuration_policy_id, + JSON_EXTRACT(Properties, '$.AssociationStatus') as association_status, + JSON_EXTRACT(Properties, '$.AssociationType') as association_type, + JSON_EXTRACT(Properties, '$.AssociationStatusMessage') as association_status_message, + JSON_EXTRACT(Properties, '$.TargetId') as target_id, + JSON_EXTRACT(Properties, '$.TargetType') as target_type, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, - JSON_EXTRACT(Properties, '$.IsTerminal') as is_terminal, - JSON_EXTRACT(Properties, '$.Actions') as actions, - JSON_EXTRACT(Properties, '$.Criteria') as criteria, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssociationIdentifier') as association_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'RuleArn') as rule_arn, - json_extract_path_text(Properties, 'RuleStatus') as rule_status, - json_extract_path_text(Properties, 'RuleOrder') as rule_order, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RuleName') as rule_name, - json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'ConfigurationPolicyId') as configuration_policy_id, + json_extract_path_text(Properties, 'AssociationStatus') as association_status, + json_extract_path_text(Properties, 'AssociationType') as association_type, + json_extract_path_text(Properties, 'AssociationStatusMessage') as association_status_message, + json_extract_path_text(Properties, 'TargetId') as target_id, + json_extract_path_text(Properties, 'TargetType') as target_type, json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'IsTerminal') as is_terminal, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'Criteria') as criteria, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' - AND data__Identifier = '' + json_extract_path_text(Properties, 'AssociationIdentifier') as association_identifier + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' + AND data__Identifier = '' AND region = 'us-east-1' - hubs: - name: hubs - id: awscc.securityhub.hubs - x-cfn-schema-name: Hub - x-type: list + policy_associations_list_only: + name: policy_associations_list_only + id: awscc.securityhub.policy_associations_list_only + x-cfn-schema-name: PolicyAssociation + x-cfn-type-name: AWS::SecurityHub::PolicyAssociation x-identifiers: - - ARN + - AssociationIdentifier + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -799,63 +5059,210 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ARN') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + JSON_EXTRACT(Properties, '$.AssociationIdentifier') as association_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ARN') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + json_extract_path_text(Properties, 'AssociationIdentifier') as association_identifier + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' AND region = 'us-east-1' - hub: - name: hub - id: awscc.securityhub.hub - x-cfn-schema-name: Hub - x-type: get + product_subscriptions: + name: product_subscriptions + id: awscc.securityhub.product_subscriptions + x-cfn-schema-name: ProductSubscription + x-cfn-type-name: AWS::SecurityHub::ProductSubscription x-identifiers: - - ARN + - ProductSubscriptionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProductSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ProductSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ProductSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/product_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/product_subscriptions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ARN') as arn, - JSON_EXTRACT(Properties, '$.EnableDefaultStandards') as enable_default_standards, - JSON_EXTRACT(Properties, '$.ControlFindingGenerator') as control_finding_generator, - JSON_EXTRACT(Properties, '$.AutoEnableControls') as auto_enable_controls, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.SubscribedAt') as subscribed_at - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Hub' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProductArn') as product_arn, + JSON_EXTRACT(Properties, '$.ProductSubscriptionArn') as product_subscription_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProductArn') as product_arn, + json_extract_path_text(Properties, 'ProductSubscriptionArn') as product_subscription_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + product_subscriptions_list_only: + name: product_subscriptions_list_only + id: awscc.securityhub.product_subscriptions_list_only + x-cfn-schema-name: ProductSubscription + x-cfn-type-name: AWS::SecurityHub::ProductSubscription + x-identifiers: + - ProductSubscriptionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ProductSubscriptionArn') as product_subscription_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProductSubscriptionArn') as product_subscription_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + AND region = 'us-east-1' + security_controls: + name: security_controls + id: awscc.securityhub.security_controls + x-cfn-schema-name: SecurityControl + x-cfn-type-name: AWS::SecurityHub::SecurityControl + x-identifiers: + - SecurityControlId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityControl&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::SecurityControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::SecurityControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::SecurityControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_controls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_controls/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.SecurityControlId') as security_control_id, + JSON_EXTRACT(Properties, '$.SecurityControlArn') as security_control_arn, + JSON_EXTRACT(Properties, '$.LastUpdateReason') as last_update_reason, + JSON_EXTRACT(Properties, '$.Parameters') as parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ARN') as arn, - json_extract_path_text(Properties, 'EnableDefaultStandards') as enable_default_standards, - json_extract_path_text(Properties, 'ControlFindingGenerator') as control_finding_generator, - json_extract_path_text(Properties, 'AutoEnableControls') as auto_enable_controls, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SubscribedAt') as subscribed_at - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Hub' - AND data__Identifier = '' + json_extract_path_text(Properties, 'SecurityControlId') as security_control_id, + json_extract_path_text(Properties, 'SecurityControlArn') as security_control_arn, + json_extract_path_text(Properties, 'LastUpdateReason') as last_update_reason, + json_extract_path_text(Properties, 'Parameters') as parameters + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' + AND data__Identifier = '' AND region = 'us-east-1' - standards: - name: standards - id: awscc.securityhub.standards - x-cfn-schema-name: Standard - x-type: list + security_controls_list_only: + name: security_controls_list_only + id: awscc.securityhub.security_controls_list_only + x-cfn-schema-name: SecurityControl + x-cfn-type-name: AWS::SecurityHub::SecurityControl x-identifiers: - - StandardsSubscriptionArn + - SecurityControlId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -863,28 +5270,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StandardsSubscriptionArn') as standards_subscription_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + JSON_EXTRACT(Properties, '$.SecurityControlId') as security_control_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StandardsSubscriptionArn') as standards_subscription_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + json_extract_path_text(Properties, 'SecurityControlId') as security_control_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' AND region = 'us-east-1' - standard: - name: standard - id: awscc.securityhub.standard + standards: + name: standards + id: awscc.securityhub.standards x-cfn-schema-name: Standard - x-type: get + x-cfn-type-name: AWS::SecurityHub::Standard x-identifiers: - StandardsSubscriptionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Standard&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Standard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Standard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Standard" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/standards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/standards/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/standards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -896,7 +5351,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -907,3 +5362,775 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Standard' AND data__Identifier = '' AND region = 'us-east-1' + standards_list_only: + name: standards_list_only + id: awscc.securityhub.standards_list_only + x-cfn-schema-name: Standard + x-cfn-type-name: AWS::SecurityHub::Standard + x-identifiers: + - StandardsSubscriptionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.StandardsSubscriptionArn') as standards_subscription_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StandardsSubscriptionArn') as standards_subscription_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AggregatorV2&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAggregatorV2 + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAggregatorV2Request' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutomationRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutomationRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutomationRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AutomationRuleV2&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAutomationRuleV2 + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAutomationRuleV2Request' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DelegatedAdmin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDelegatedAdmin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDelegatedAdminRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__FindingAggregator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFindingAggregator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFindingAggregatorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Hub&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHub + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHubRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__HubV2&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateHubV2 + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateHubV2Request' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Insight&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInsight + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInsightRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PolicyAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicyAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProductSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProductSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProductSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityControl&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityControl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityControlRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Standard&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStandard + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStandardRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/securitylake.yaml b/providers/src/awscc/v00.00.00000/services/securitylake.yaml new file mode 100644 index 00000000..f881c001 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/securitylake.yaml @@ -0,0 +1,1739 @@ +openapi: 3.0.0 +info: + title: SecurityLake + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + AwsLogSource: + type: object + properties: + SourceName: + type: string + description: The name for a AWS source. This must be a Regionally unique value. + SourceVersion: + type: string + pattern: ^(latest|[0-9]\.[0-9])$ + description: The version for a AWS source. This must be a Regionally unique value. + description: Amazon Security Lake supports log and event collection for natively supported AWS services. + additionalProperties: false + EncryptionConfiguration: + description: Provides encryption details of Amazon Security Lake object. + type: object + additionalProperties: false + properties: + KmsKeyId: + description: The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object. + type: string + LifecycleConfiguration: + description: Provides lifecycle details of Amazon Security Lake object. + type: object + additionalProperties: false + properties: + Expiration: + $ref: '#/components/schemas/Expiration' + Transitions: + description: Provides data storage transition details of Amazon Security Lake object. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Transitions' + Expiration: + description: Provides data expiration details of Amazon Security Lake object. + type: object + additionalProperties: false + properties: + Days: + $ref: '#/components/schemas/Days' + Days: + description: Number of days before data expires in the Amazon Security Lake object. + type: integer + minimum: 1 + Transitions: + type: object + additionalProperties: false + properties: + Days: + description: Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object. + type: integer + minimum: 1 + StorageClass: + description: The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads. + type: string + ReplicationConfiguration: + description: Provides replication details of Amazon Security Lake object. + type: object + additionalProperties: false + properties: + Regions: + $ref: '#/components/schemas/Regions' + RoleArn: + description: Replication settings for the Amazon S3 buckets. This parameter uses the AWS Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct. + type: string + pattern: ^arn:.*$ + Regions: + description: Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same AWS account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different AWS Regions or within the same Region as the source bucket. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + pattern: ^(us(-gov)?|af|ap|ca|eu|me|sa)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\d+$ + Tag: + type: object + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + description: The name of the tag. This is a general label that acts as a category for a more specific tag value (value). + Value: + type: string + minLength: 0 + maxLength: 256 + description: The value that is associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string. + required: + - Key + - Value + additionalProperties: false + DataLake: + type: object + properties: + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + LifecycleConfiguration: + $ref: '#/components/schemas/LifecycleConfiguration' + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + MetaStoreManagerRoleArn: + description: The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources. + type: string + pattern: ^arn:.*$ + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The Amazon Resource Name (ARN) created by you to provide to the subscriber. + type: string + minLength: 1 + maxLength: 1011 + S3BucketArn: + description: The ARN for the Amazon Security Lake Amazon S3 bucket. + type: string + x-stackql-resource-name: data_lake + description: Resource Type definition for AWS::SecurityLake::DataLake + x-type-name: AWS::SecurityLake::DataLake + x-stackql-primary-identifier: + - Arn + x-write-only-properties: + - MetaStoreManagerRoleArn + x-read-only-properties: + - Arn + - S3BucketArn + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - securitylake:TagResource + - securitylake:UntagResource + - securitylake:ListTagsForResource + x-required-permissions: + create: + - events:* + - iam:CreateServiceLinkedRole + - iam:GetRole + - iam:ListAttachedRolePolicies + - iam:PutRolePolicy + - iam:PassRole + - glue:* + - organizations:* + - kms:DescribeKey + - kms:CreateGrant + - lakeformation:* + - lambda:* + - s3:* + - securitylake:CreateDataLake + - securitylake:TagResource + - securitylake:List* + - sqs:* + update: + - events:* + - iam:CreateServiceLinkedRole + - iam:DeleteRolePolicy + - iam:GetRole + - iam:PassRole + - iam:PutRolePolicy + - kms:DescribeKey + - kms:CreateGrant + - lakeformation:* + - lambda:* + - organizations:* + - s3:* + - securitylake:List* + - securitylake:TagResource + - securitylake:UntagResource + - securitylake:UpdateDataLake + - sqs:* + delete: + - organizations:* + - securitylake:DeleteDataLake + - securitylake:List* + read: + - securitylake:List* + list: + - securitylake:List* + AccessTypes: + type: array + x-insertionOrder: true + items: + type: string + enum: + - LAKEFORMATION + - S3 + minItems: 1 + uniqueItems: true + description: The Amazon S3 or AWS Lake Formation access type. + CustomLogSource: + type: object + properties: + SourceName: + type: string + pattern: ^[\\\w\-_:/.]*$ + minLength: 1 + maxLength: 64 + description: The name for a third-party custom source. This must be a Regionally unique value. + SourceVersion: + type: string + pattern: ^[A-Za-z0-9\-\.\_]*$ + minLength: 1 + maxLength: 32 + description: The version for a third-party custom source. This must be a Regionally unique value. + additionalProperties: false + Source: + properties: + AwsLogSource: + $ref: '#/components/schemas/AwsLogSource' + CustomLogSource: + $ref: '#/components/schemas/CustomLogSource' + additionalProperties: false + oneOf: + - required: + - AwsLogSource + - required: + - CustomLogSource + Subscriber: + type: object + properties: + AccessTypes: + $ref: '#/components/schemas/AccessTypes' + DataLakeArn: + description: The ARN for the data lake. + type: string + minLength: 1 + maxLength: 256 + SubscriberIdentity: + type: object + properties: + ExternalId: + type: string + pattern: ^[\w+=,.@:/-]*$ + minLength: 2 + maxLength: 1224 + description: The external ID used to establish trust relationship with the AWS identity. + Principal: + type: string + pattern: ^([0-9]{12}|[a-z0-9\.\-]*\.(amazonaws|amazon)\.com)$ + description: The AWS identity principal. + required: + - ExternalId + - Principal + description: The AWS identity used to access your data. + additionalProperties: false + SubscriberName: + type: string + pattern: ^[\\\w\s\-_:/,.@=+]*$ + minLength: 1 + maxLength: 64 + description: The name of your Security Lake subscriber account. + SubscriberDescription: + type: string + description: The description for your subscriber account in Security Lake. + Tags: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Tag' + description: An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string. + Sources: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Source' + description: The supported AWS services from which logs and events are collected. + ResourceShareArn: + type: string + ResourceShareName: + type: string + SubscriberRoleArn: + type: string + S3BucketArn: + type: string + SubscriberArn: + type: string + required: + - AccessTypes + - DataLakeArn + - Sources + - SubscriberIdentity + - SubscriberName + x-stackql-resource-name: subscriber + description: Resource Type definition for AWS::SecurityLake::Subscriber + x-type-name: AWS::SecurityLake::Subscriber + x-stackql-primary-identifier: + - SubscriberArn + x-create-only-properties: + - DataLakeArn + x-read-only-properties: + - SubscriberArn + - S3BucketArn + - SubscriberRoleArn + - ResourceShareArn + - ResourceShareName + x-required-properties: + - AccessTypes + - DataLakeArn + - Sources + - SubscriberIdentity + - SubscriberName + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - securitylake:TagResource + - securitylake:UntagResource + - securitylake:ListTagsForResource + x-required-permissions: + create: + - securitylake:CreateSubscriber + - securitylake:CreateCustomLogSource + - securitylake:CreateDataLake + - securitylake:TagResource + - securitylake:GetSubscriber + - securitylake:ListSubscribers + - securitylake:ListTagsForResource + - iam:GetRole + - iam:GetRolePolicy + - iam:PutRolePolicy + - iam:CreateRole + - iam:CreateServiceLinkedRole + - glue:GetDatabase + - glue:GetTable + - lakeformation:RegisterResource + - lakeformation:GrantPermissions + - lakeformation:RevokePermissions + - lakeformation:ListPermissions + - ram:GetResourceShareAssociations + - ram:CreateResourceShare + - ram:UpdateResourceShare + - ram:GetResourceShares + read: + - securitylake:GetSubscriber + - securitylake:ListTagsForResource + update: + - securitylake:UpdateSubscriber + - securitylake:GetSubscriber + - securitylake:TagResource + - securitylake:UntagResource + - securitylake:ListTagsForResource + - glue:GetDatabase + - glue:GetTable + - lakeformation:ListPermissions + - lakeformation:GrantPermissions + - lakeformation:RevokePermissions + - ram:CreateResourceShare + - ram:GetResourceShares + - ram:GetResourceShareAssociations + - ram:UpdateResourceShare + - ram:DeleteResourceShare + - iam:CreateRole + - iam:GetRole + - iam:DeleteRole + - iam:PutRolePolicy + - iam:DeleteRolePolicy + - iam:ListRolePolicies + - events:CreateApiDestination + - events:CreateConnection + - events:ListApiDestinations + - events:ListConnections + - events:PutRule + - events:UpdateApiDestination + - events:UpdateConnection + - events:DeleteApiDestination + - events:DeleteConnection + - events:DeleteRule + - events:RemoveTargets + - events:ListTargetsByRule + - events:DescribeRule + - events:PutTargets + delete: + - securitylake:DeleteSubscriber + - iam:GetRole + - iam:ListRolePolicies + - iam:DeleteRole + - iam:DeleteRolePolicy + - glue:GetTable + - lakeformation:RevokePermissions + - lakeformation:ListPermissions + - ram:GetResourceShares + - ram:DeleteResourceShare + - events:DeleteApiDestination + - events:DeleteConnection + - events:DeleteRule + - events:ListApiDestinations + - events:ListTargetsByRule + - events:DescribeRule + - events:RemoveTargets + - sqs:DeleteQueue + - sqs:GetQueueUrl + list: + - securitylake:ListSubscribers + HttpsNotificationConfiguration: + type: object + properties: + AuthorizationApiKeyName: + type: string + description: The key name for the notification subscription. + AuthorizationApiKeyValue: + type: string + description: The key value for the notification subscription. + Endpoint: + type: string + pattern: ^https?://.+$ + description: The subscription endpoint in Security Lake. + HttpMethod: + type: string + enum: + - POST + - PUT + description: The HTTPS method used for the notification subscription. + TargetRoleArn: + type: string + pattern: ^arn:.*$ + description: The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. + description: The configuration for HTTPS subscriber notification. + additionalProperties: false + required: + - Endpoint + - TargetRoleArn + SqsNotificationConfiguration: + type: object + description: The configurations for SQS subscriber notification. The members of this structure are context-dependent. + NotificationConfiguration: + type: object + properties: + HttpsNotificationConfiguration: + $ref: '#/components/schemas/HttpsNotificationConfiguration' + SqsNotificationConfiguration: + $ref: '#/components/schemas/SqsNotificationConfiguration' + additionalProperties: false + oneOf: + - required: + - HttpsNotificationConfiguration + - required: + - SqsNotificationConfiguration + SubscriberNotification: + type: object + properties: + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + SubscriberArn: + description: The ARN for the subscriber + type: string + pattern: ^arn:.*$ + SubscriberEndpoint: + description: The endpoint the subscriber should listen to for notifications + type: string + required: + - SubscriberArn + - NotificationConfiguration + x-stackql-resource-name: subscriber_notification + description: Resource Type definition for AWS::SecurityLake::SubscriberNotification + x-type-name: AWS::SecurityLake::SubscriberNotification + x-stackql-primary-identifier: + - SubscriberArn + x-create-only-properties: + - SubscriberArn + x-write-only-properties: + - NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyName + - NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyValue + - NotificationConfiguration/HttpsNotificationConfiguration/Endpoint + - NotificationConfiguration/HttpsNotificationConfiguration/HttpMethod + - NotificationConfiguration/HttpsNotificationConfiguration/TargetRoleArn + x-read-only-properties: + - SubscriberEndpoint + x-required-properties: + - SubscriberArn + - NotificationConfiguration + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + x-required-permissions: + create: + - securitylake:CreateDataLake + - securitylake:CreateSubscriber + - securitylake:CreateSubscriberNotification + - securitylake:GetSubscriber + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + - iam:DeleteRolePolicy + - iam:PassRole + - s3:PutBucketNotification + - s3:GetBucketNotification + - events:CreateApiDestination + - events:CreateConnection + - events:CreateRule + - events:UpdateConnection + - events:DeleteConnection + - events:UpdateApiDestination + - events:DeleteApiDestination + - events:ListApiDestinations + - events:ListConnections + - events:PutRule + - events:DescribeRule + - events:DeleteRule + - events:PutTargets + - events:RemoveTargets + - events:ListTargetsByRule + - secretsmanager:CreateSecret + - sqs:CreateQueue + - sqs:GetQueueAttributes + - sqs:GetQueueUrl + - sqs:SetQueueAttributes + read: + - securitylake:GetSubscriber + update: + - securitylake:UpdateSubscriberNotification + - securitylake:GetSubscriber + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + - iam:DeleteRolePolicy + - iam:PassRole + - events:CreateApiDestination + - events:CreateConnection + - events:UpdateConnection + - events:DeleteConnection + - events:UpdateApiDestination + - events:DeleteApiDestination + - events:DeleteRule + - events:ListApiDestinations + - events:ListConnections + - events:PutRule + - events:DescribeRule + - events:DeleteRule + - events:PutTargets + - events:RemoveTargets + - events:ListTargetsByRule + - secretsmanager:CreateSecret + - s3:GetBucketNotificationConfiguration + - s3:PutBucketNotificationConfiguration + - s3:PutBucketNotification + - s3:GetBucketNotification + - sqs:CreateQueue + - sqs:DeleteQueue + - sqs:GetQueueAttributes + - sqs:SetQueueAttributes + delete: + - securitylake:DeleteSubscriberNotification + - securitylake:GetSubscriber + - iam:DeleteRole + - iam:DeleteRolePolicy + - events:DeleteApiDestination + - events:DeleteConnection + - events:DeleteRule + - events:ListTargetsByRule + - events:DescribeRule + - events:RemoveTargets + - sqs:DeleteQueue + list: + - securitylake:ListSubscribers + CreateDataLakeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + LifecycleConfiguration: + $ref: '#/components/schemas/LifecycleConfiguration' + ReplicationConfiguration: + $ref: '#/components/schemas/ReplicationConfiguration' + MetaStoreManagerRoleArn: + description: The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources. + type: string + pattern: ^arn:.*$ + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: The Amazon Resource Name (ARN) created by you to provide to the subscriber. + type: string + minLength: 1 + maxLength: 1011 + S3BucketArn: + description: The ARN for the Amazon Security Lake Amazon S3 bucket. + type: string + x-stackQL-stringOnly: true + x-title: CreateDataLakeRequest + type: object + required: [] + CreateSubscriberRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessTypes: + $ref: '#/components/schemas/AccessTypes' + DataLakeArn: + description: The ARN for the data lake. + type: string + minLength: 1 + maxLength: 256 + SubscriberIdentity: + type: object + properties: + ExternalId: + type: string + pattern: ^[\w+=,.@:/-]*$ + minLength: 2 + maxLength: 1224 + description: The external ID used to establish trust relationship with the AWS identity. + Principal: + type: string + pattern: ^([0-9]{12}|[a-z0-9\.\-]*\.(amazonaws|amazon)\.com)$ + description: The AWS identity principal. + required: + - ExternalId + - Principal + description: The AWS identity used to access your data. + additionalProperties: false + SubscriberName: + type: string + pattern: ^[\\\w\s\-_:/,.@=+]*$ + minLength: 1 + maxLength: 64 + description: The name of your Security Lake subscriber account. + SubscriberDescription: + type: string + description: The description for your subscriber account in Security Lake. + Tags: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Tag' + description: An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string. + Sources: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/Source' + description: The supported AWS services from which logs and events are collected. + ResourceShareArn: + type: string + ResourceShareName: + type: string + SubscriberRoleArn: + type: string + S3BucketArn: + type: string + SubscriberArn: + type: string + x-stackQL-stringOnly: true + x-title: CreateSubscriberRequest + type: object + required: [] + CreateSubscriberNotificationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + SubscriberArn: + description: The ARN for the subscriber + type: string + pattern: ^arn:.*$ + SubscriberEndpoint: + description: The endpoint the subscriber should listen to for notifications + type: string + x-stackQL-stringOnly: true + x-title: CreateSubscriberNotificationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + data_lakes: + name: data_lakes + id: awscc.securitylake.data_lakes + x-cfn-schema-name: DataLake + x-cfn-type-name: AWS::SecurityLake::DataLake + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataLake&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::DataLake" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::DataLake" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::DataLake" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_lakes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_lakes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_lakes/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration, + JSON_EXTRACT(Properties, '$.LifecycleConfiguration') as lifecycle_configuration, + JSON_EXTRACT(Properties, '$.ReplicationConfiguration') as replication_configuration, + JSON_EXTRACT(Properties, '$.MetaStoreManagerRoleArn') as meta_store_manager_role_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.S3BucketArn') as s3_bucket_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::DataLake' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, + json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, + json_extract_path_text(Properties, 'MetaStoreManagerRoleArn') as meta_store_manager_role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::DataLake' + AND data__Identifier = '' + AND region = 'us-east-1' + data_lakes_list_only: + name: data_lakes_list_only + id: awscc.securitylake.data_lakes_list_only + x-cfn-schema-name: DataLake + x-cfn-type-name: AWS::SecurityLake::DataLake + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::DataLake' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::DataLake' + AND region = 'us-east-1' + subscribers: + name: subscribers + id: awscc.securitylake.subscribers + x-cfn-schema-name: Subscriber + x-cfn-type-name: AWS::SecurityLake::Subscriber + x-identifiers: + - SubscriberArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Subscriber&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::Subscriber" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::Subscriber" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::Subscriber" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subscribers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subscribers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subscribers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccessTypes') as access_types, + JSON_EXTRACT(Properties, '$.DataLakeArn') as data_lake_arn, + JSON_EXTRACT(Properties, '$.SubscriberIdentity') as subscriber_identity, + JSON_EXTRACT(Properties, '$.SubscriberName') as subscriber_name, + JSON_EXTRACT(Properties, '$.SubscriberDescription') as subscriber_description, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Sources') as sources, + JSON_EXTRACT(Properties, '$.ResourceShareArn') as resource_share_arn, + JSON_EXTRACT(Properties, '$.ResourceShareName') as resource_share_name, + JSON_EXTRACT(Properties, '$.SubscriberRoleArn') as subscriber_role_arn, + JSON_EXTRACT(Properties, '$.S3BucketArn') as s3_bucket_arn, + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessTypes') as access_types, + json_extract_path_text(Properties, 'DataLakeArn') as data_lake_arn, + json_extract_path_text(Properties, 'SubscriberIdentity') as subscriber_identity, + json_extract_path_text(Properties, 'SubscriberName') as subscriber_name, + json_extract_path_text(Properties, 'SubscriberDescription') as subscriber_description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Sources') as sources, + json_extract_path_text(Properties, 'ResourceShareArn') as resource_share_arn, + json_extract_path_text(Properties, 'ResourceShareName') as resource_share_name, + json_extract_path_text(Properties, 'SubscriberRoleArn') as subscriber_role_arn, + json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND data__Identifier = '' + AND region = 'us-east-1' + subscribers_list_only: + name: subscribers_list_only + id: awscc.securitylake.subscribers_list_only + x-cfn-schema-name: Subscriber + x-cfn-type-name: AWS::SecurityLake::Subscriber + x-identifiers: + - SubscriberArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND region = 'us-east-1' + subscriber_notifications: + name: subscriber_notifications + id: awscc.securitylake.subscriber_notifications + x-cfn-schema-name: SubscriberNotification + x-cfn-type-name: AWS::SecurityLake::SubscriberNotification + x-identifiers: + - SubscriberArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubscriberNotification&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::SubscriberNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::SubscriberNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::SubscriberNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subscriber_notifications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subscriber_notifications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subscriber_notifications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.NotificationConfiguration') as notification_configuration, + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn, + JSON_EXTRACT(Properties, '$.SubscriberEndpoint') as subscriber_endpoint + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn, + json_extract_path_text(Properties, 'SubscriberEndpoint') as subscriber_endpoint + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' + AND data__Identifier = '' + AND region = 'us-east-1' + subscriber_notifications_list_only: + name: subscriber_notifications_list_only + id: awscc.securitylake.subscriber_notifications_list_only + x-cfn-schema-name: SubscriberNotification + x-cfn-type-name: AWS::SecurityLake::SubscriberNotification + x-identifiers: + - SubscriberArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataLake&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataLake + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataLakeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Subscriber&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubscriber + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubscriberRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SubscriberNotification&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubscriberNotification + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubscriberNotificationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/servicecatalog.yaml b/providers/src/awscc/v00.00.00000/services/servicecatalog.yaml index f5292970..4f417b38 100644 --- a/providers/src/awscc/v00.00.00000/services/servicecatalog.yaml +++ b/providers/src/awscc/v00.00.00000/services/servicecatalog.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ServiceCatalog - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ProvisioningPreferences: type: object @@ -146,7 +526,10 @@ components: additionalProperties: false maxProperties: 100 x-stackql-resource-name: cloud_formation_provisioned_product - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct + x-type-name: AWS::ServiceCatalog::CloudFormationProvisionedProduct + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html + x-stackql-primary-identifier: - ProvisionedProductId x-create-only-properties: - NotificationArns @@ -158,13 +541,214 @@ components: - ProvisionedProductId x-required-permissions: create: - - '*' + - servicecatalog:provisionProduct + - cloudformation:CreateStack read: - - '*' + - servicecatalog:describeProvisionedProduct + - cloudformation:ListStacks update: - - '*' + - servicecatalog:updateProvisionedProduct + - cloudformation:UpdateStack delete: - - '*' + - servicecatalog:terminateProvisionedProduct + - servicecatalog:describeRecord + - cloudformation:DeleteStack + LaunchNotificationConstraint: + type: object + properties: + Id: + type: string + Description: + type: string + NotificationArns: + type: array + uniqueItems: false + items: + type: string + AcceptLanguage: + type: string + PortfolioId: + type: string + ProductId: + type: string + required: + - NotificationArns + - PortfolioId + - ProductId + x-stackql-resource-name: launch_notification_constraint + description: Resource Type definition for AWS::ServiceCatalog::LaunchNotificationConstraint + x-type-name: AWS::ServiceCatalog::LaunchNotificationConstraint + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - PortfolioId + - ProductId + x-read-only-properties: + - Id + x-required-properties: + - NotificationArns + - PortfolioId + - ProductId + LaunchTemplateConstraint: + type: object + properties: + Id: + type: string + Description: + type: string + AcceptLanguage: + type: string + PortfolioId: + type: string + ProductId: + type: string + Rules: + type: string + required: + - PortfolioId + - ProductId + - Rules + x-stackql-resource-name: launch_template_constraint + description: Resource Type definition for AWS::ServiceCatalog::LaunchTemplateConstraint + x-type-name: AWS::ServiceCatalog::LaunchTemplateConstraint + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - PortfolioId + - ProductId + x-read-only-properties: + - Id + x-required-properties: + - PortfolioId + - ProductId + - Rules + PortfolioPrincipalAssociation: + type: object + properties: + Id: + type: string + PrincipalARN: + type: string + AcceptLanguage: + type: string + PortfolioId: + type: string + PrincipalType: + type: string + required: + - PortfolioId + - PrincipalType + - PrincipalARN + x-stackql-resource-name: portfolio_principal_association + description: Resource Type definition for AWS::ServiceCatalog::PortfolioPrincipalAssociation + x-type-name: AWS::ServiceCatalog::PortfolioPrincipalAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - PortfolioId + - AcceptLanguage + - PrincipalARN + - PrincipalType + x-read-only-properties: + - Id + x-required-properties: + - PortfolioId + - PrincipalType + - PrincipalARN + PortfolioProductAssociation: + type: object + properties: + Id: + type: string + SourcePortfolioId: + type: string + AcceptLanguage: + type: string + PortfolioId: + type: string + ProductId: + type: string + required: + - PortfolioId + - ProductId + x-stackql-resource-name: portfolio_product_association + description: Resource Type definition for AWS::ServiceCatalog::PortfolioProductAssociation + x-type-name: AWS::ServiceCatalog::PortfolioProductAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SourcePortfolioId + - PortfolioId + - AcceptLanguage + - ProductId + x-read-only-properties: + - Id + x-required-properties: + - PortfolioId + - ProductId + PortfolioShare: + type: object + properties: + AcceptLanguage: + type: string + PortfolioId: + type: string + AccountId: + type: string + ShareTagOptions: + type: boolean + Id: + type: string + required: + - AccountId + - PortfolioId + x-stackql-resource-name: portfolio_share + description: Resource Type definition for AWS::ServiceCatalog::PortfolioShare + x-type-name: AWS::ServiceCatalog::PortfolioShare + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - AcceptLanguage + - AccountId + - PortfolioId + x-read-only-properties: + - Id + x-required-properties: + - AccountId + - PortfolioId + ResourceUpdateConstraint: + type: object + properties: + Id: + type: string + Description: + type: string + AcceptLanguage: + type: string + TagUpdateOnProvisionedProduct: + type: string + PortfolioId: + type: string + ProductId: + type: string + required: + - TagUpdateOnProvisionedProduct + - PortfolioId + - ProductId + x-stackql-resource-name: resource_update_constraint + description: Resource Type definition for AWS::ServiceCatalog::ResourceUpdateConstraint + x-type-name: AWS::ServiceCatalog::ResourceUpdateConstraint + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - PortfolioId + - ProductId + x-read-only-properties: + - Id + x-required-properties: + - TagUpdateOnProvisionedProduct + - PortfolioId + - ProductId DefinitionParameter: type: object properties: @@ -212,10 +796,18 @@ components: - DefinitionType - Definition x-stackql-resource-name: service_action - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalog::ServiceAction + x-type-name: AWS::ServiceCatalog::ServiceAction + x-stackql-primary-identifier: - Id + x-write-only-properties: + - AcceptLanguage x-read-only-properties: - Id + x-required-properties: + - Name + - DefinitionType + - Definition x-required-permissions: create: - servicecatalog:CreateServiceAction @@ -254,7 +846,9 @@ components: - ProvisioningArtifactId - ServiceActionId x-stackql-resource-name: service_action_association - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalog::ServiceActionAssociation + x-type-name: AWS::ServiceCatalog::ServiceActionAssociation + x-stackql-primary-identifier: - ProductId - ProvisioningArtifactId - ServiceActionId @@ -262,6 +856,10 @@ components: - ProductId - ProvisioningArtifactId - ServiceActionId + x-required-properties: + - ProductId + - ProvisioningArtifactId + - ServiceActionId x-required-permissions: create: - servicecatalog:AssociateServiceActionWithProvisioningArtifact @@ -273,18 +871,331 @@ components: - servicecatalog:ListServiceActionsForProvisioningArtifact list: - servicecatalog:ListServiceActionsForProvisioningArtifact + TagOption: + type: object + properties: + Id: + type: string + description: The TagOption identifier. + Active: + type: boolean + description: The TagOption active state. + Value: + type: string + description: The TagOption value. + Key: + type: string + description: The TagOption key. + required: + - Value + - Key + x-stackql-resource-name: tag_option + description: Resource type definition for AWS::ServiceCatalog::TagOption + x-type-name: AWS::ServiceCatalog::TagOption + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Value + - Key + x-read-only-properties: + - Id + x-required-properties: + - Value + - Key + x-tagging: + taggable: false + x-required-permissions: + create: + - servicecatalog:CreateTagOption + read: + - servicecatalog:DescribeTagOption + update: + - servicecatalog:UpdateTagOption + - servicecatalog:DescribeTagOption + delete: + - servicecatalog:DeleteTagOption + list: + - servicecatalog:ListTagOptions + TagOptionAssociation: + type: object + properties: + Id: + type: string + TagOptionId: + type: string + ResourceId: + type: string + required: + - TagOptionId + - ResourceId + x-stackql-resource-name: tag_option_association + description: Resource Type definition for AWS::ServiceCatalog::TagOptionAssociation + x-type-name: AWS::ServiceCatalog::TagOptionAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - TagOptionId + - ResourceId + x-read-only-properties: + - Id + x-required-properties: + - TagOptionId + - ResourceId + CreateCloudFormationProvisionedProductRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AcceptLanguage: + type: string + enum: + - en + - jp + - zh + NotificationArns: + type: array + uniqueItems: true + items: + type: string + maxItems: 5 + PathId: + type: string + minLength: 1 + maxLength: 100 + PathName: + type: string + minLength: 1 + maxLength: 100 + ProductId: + type: string + minLength: 1 + maxLength: 100 + ProductName: + type: string + minLength: 1 + maxLength: 128 + ProvisionedProductName: + type: string + minLength: 1 + maxLength: 128 + ProvisioningArtifactId: + type: string + minLength: 1 + maxLength: 100 + ProvisioningArtifactName: + type: string + ProvisioningParameters: + type: array + items: + $ref: '#/components/schemas/ProvisioningParameter' + ProvisioningPreferences: + $ref: '#/components/schemas/ProvisioningPreferences' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + ProvisionedProductId: + type: string + minLength: 1 + maxLength: 50 + RecordId: + type: string + minLength: 1 + maxLength: 50 + CloudformationStackArn: + type: string + minLength: 1 + maxLength: 256 + Outputs: + description: List of key-value pair outputs. + type: object + x-patternProperties: + ^[A-Za-z0-9]{1,64}$: + $ref: '#/components/schemas/OutputType' + additionalProperties: false + maxProperties: 100 + x-stackQL-stringOnly: true + x-title: CreateCloudFormationProvisionedProductRequest + type: object + required: [] + CreateServiceActionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AcceptLanguage: + type: string + enum: + - en + - jp + - zh + Name: + type: string + minLength: 1 + maxLength: 256 + DefinitionType: + type: string + enum: + - SSM_AUTOMATION + Definition: + type: array + items: + $ref: '#/components/schemas/DefinitionParameter' + Description: + type: string + maxLength: 1024 + Id: + type: string + minLength: 1 + maxLength: 100 + x-stackQL-stringOnly: true + x-title: CreateServiceActionRequest + type: object + required: [] + CreateServiceActionAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProductId: + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\Z + minLength: 1 + maxLength: 100 + ProvisioningArtifactId: + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\Z + minLength: 1 + maxLength: 100 + ServiceActionId: + type: string + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{1,99}\Z + minLength: 1 + maxLength: 100 + x-stackQL-stringOnly: true + x-title: CreateServiceActionAssociationRequest + type: object + required: [] + CreateTagOptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + description: The TagOption identifier. + Active: + type: boolean + description: The TagOption active state. + Value: + type: string + description: The TagOption value. + Key: + type: string + description: The TagOption key. + x-stackQL-stringOnly: true + x-title: CreateTagOptionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - cloud_formation_provisioned_product: - name: cloud_formation_provisioned_product - id: awscc.servicecatalog.cloud_formation_provisioned_product + cloud_formation_provisioned_products: + name: cloud_formation_provisioned_products + id: awscc.servicecatalog.cloud_formation_provisioned_products x-cfn-schema-name: CloudFormationProvisionedProduct - x-type: get + x-cfn-type-name: AWS::ServiceCatalog::CloudFormationProvisionedProduct x-identifiers: - ProvisionedProductId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__CloudFormationProvisionedProduct&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::CloudFormationProvisionedProduct" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::CloudFormationProvisionedProduct" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::CloudFormationProvisionedProduct" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -309,7 +1220,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -333,38 +1244,184 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::CloudFormationProvisionedProduct' AND data__Identifier = '' AND region = 'us-east-1' + launch_notification_constraints: + name: launch_notification_constraints + id: awscc.servicecatalog.launch_notification_constraints + x-cfn-schema-name: LaunchNotificationConstraint + x-cfn-type-name: AWS::ServiceCatalog::LaunchNotificationConstraint + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + launch_template_constraints: + name: launch_template_constraints + id: awscc.servicecatalog.launch_template_constraints + x-cfn-schema-name: LaunchTemplateConstraint + x-cfn-type-name: AWS::ServiceCatalog::LaunchTemplateConstraint + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + portfolio_principal_associations: + name: portfolio_principal_associations + id: awscc.servicecatalog.portfolio_principal_associations + x-cfn-schema-name: PortfolioPrincipalAssociation + x-cfn-type-name: AWS::ServiceCatalog::PortfolioPrincipalAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + portfolio_product_associations: + name: portfolio_product_associations + id: awscc.servicecatalog.portfolio_product_associations + x-cfn-schema-name: PortfolioProductAssociation + x-cfn-type-name: AWS::ServiceCatalog::PortfolioProductAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + portfolio_shares: + name: portfolio_shares + id: awscc.servicecatalog.portfolio_shares + x-cfn-schema-name: PortfolioShare + x-cfn-type-name: AWS::ServiceCatalog::PortfolioShare + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + resource_update_constraints: + name: resource_update_constraints + id: awscc.servicecatalog.resource_update_constraints + x-cfn-schema-name: ResourceUpdateConstraint + x-cfn-type-name: AWS::ServiceCatalog::ResourceUpdateConstraint + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] service_actions: name: service_actions id: awscc.servicecatalog.service_actions x-cfn-schema-name: ServiceAction - x-type: list + x-cfn-type-name: AWS::ServiceCatalog::ServiceAction x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceAction&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::ServiceAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::ServiceAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::ServiceAction" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_actions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AcceptLanguage') as accept_language, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.DefinitionType') as definition_type, + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'AcceptLanguage') as accept_language, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DefinitionType') as definition_type, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' + AND data__Identifier = '' AND region = 'us-east-1' - service_action: - name: service_action - id: awscc.servicecatalog.service_action + service_actions_list_only: + name: service_actions_list_only + id: awscc.servicecatalog.service_actions_list_only x-cfn-schema-name: ServiceAction - x-type: get + x-cfn-type-name: AWS::ServiceCatalog::ServiceAction x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -372,71 +1429,102 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AcceptLanguage') as accept_language, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.DefinitionType') as definition_type, - JSON_EXTRACT(Properties, '$.Definition') as definition, - JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AcceptLanguage') as accept_language, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DefinitionType') as definition_type, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' AND region = 'us-east-1' service_action_associations: name: service_action_associations id: awscc.servicecatalog.service_action_associations x-cfn-schema-name: ServiceActionAssociation - x-type: list + x-cfn-type-name: AWS::ServiceCatalog::ServiceActionAssociation x-identifiers: - ProductId - ProvisioningArtifactId - ServiceActionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceActionAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::ServiceActionAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::ServiceActionAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_action_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_action_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.ProductId') as product_id, JSON_EXTRACT(Properties, '$.ProvisioningArtifactId') as provisioning_artifact_id, JSON_EXTRACT(Properties, '$.ServiceActionId') as service_action_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, json_extract_path_text(Properties, 'ProductId') as product_id, json_extract_path_text(Properties, 'ProvisioningArtifactId') as provisioning_artifact_id, json_extract_path_text(Properties, 'ServiceActionId') as service_action_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + AND data__Identifier = '||' AND region = 'us-east-1' - service_action_association: - name: service_action_association - id: awscc.servicecatalog.service_action_association + service_action_associations_list_only: + name: service_action_associations_list_only + id: awscc.servicecatalog.service_action_associations_list_only x-cfn-schema-name: ServiceActionAssociation - x-type: get + x-cfn-type-name: AWS::ServiceCatalog::ServiceActionAssociation x-identifiers: - ProductId - ProvisioningArtifactId - ServiceActionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -444,22 +1532,466 @@ components: ddl: |- SELECT region, - data__Identifier, JSON_EXTRACT(Properties, '$.ProductId') as product_id, JSON_EXTRACT(Properties, '$.ProvisioningArtifactId') as provisioning_artifact_id, JSON_EXTRACT(Properties, '$.ServiceActionId') as service_action_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' - AND data__Identifier = '||' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, json_extract_path_text(Properties, 'ProductId') as product_id, json_extract_path_text(Properties, 'ProvisioningArtifactId') as provisioning_artifact_id, json_extract_path_text(Properties, 'ServiceActionId') as service_action_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' - AND data__Identifier = '||' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + AND region = 'us-east-1' + tag_options: + name: tag_options + id: awscc.servicecatalog.tag_options + x-cfn-schema-name: TagOption + x-cfn-type-name: AWS::ServiceCatalog::TagOption + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TagOption&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::TagOption" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::TagOption" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalog::TagOption" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tag_options/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tag_options/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tag_options/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Active') as active, + JSON_EXTRACT(Properties, '$.Value') as value, + JSON_EXTRACT(Properties, '$.Key') as key + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::TagOption' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Active') as active, + json_extract_path_text(Properties, 'Value') as value, + json_extract_path_text(Properties, 'Key') as key + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::TagOption' + AND data__Identifier = '' AND region = 'us-east-1' + tag_options_list_only: + name: tag_options_list_only + id: awscc.servicecatalog.tag_options_list_only + x-cfn-schema-name: TagOption + x-cfn-type-name: AWS::ServiceCatalog::TagOption + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::TagOption' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::TagOption' + AND region = 'us-east-1' + tag_option_associations: + name: tag_option_associations + id: awscc.servicecatalog.tag_option_associations + x-cfn-schema-name: TagOptionAssociation + x-cfn-type-name: AWS::ServiceCatalog::TagOptionAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__CloudFormationProvisionedProduct&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCloudFormationProvisionedProduct + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCloudFormationProvisionedProductRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceAction&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceAction + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceActionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceActionAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceActionAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceActionAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TagOption&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTagOption + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTagOptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/servicecatalogappregistry.yaml b/providers/src/awscc/v00.00.00000/services/servicecatalogappregistry.yaml index 656bf043..30126b1b 100644 --- a/providers/src/awscc/v00.00.00000/services/servicecatalogappregistry.yaml +++ b/providers/src/awscc/v00.00.00000/services/servicecatalogappregistry.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: ServiceCatalogAppRegistry - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tags: type: object @@ -53,14 +433,31 @@ components: required: - Name x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalogAppRegistry::Application + x-type-name: AWS::ServiceCatalogAppRegistry::Application + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-application.html + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Name x-read-only-properties: - Id - Arn - ApplicationName - ApplicationTagKey - ApplicationTagValue + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - servicecatalog:TagResource + - servicecatalog:UntagResource + - servicecatalog:ListTagsForResource x-required-permissions: create: - servicecatalog:CreateApplication @@ -106,11 +503,29 @@ components: - Name - Attributes x-stackql-resource-name: attribute_group - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup. + x-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroup + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-attributegroup.html + x-stackql-primary-identifier: - Id + x-stackql-additional-identifiers: + - - Name x-read-only-properties: - Id - Arn + x-required-properties: + - Name + - Attributes + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - servicecatalog:TagResource + - servicecatalog:UntagResource + - servicecatalog:ListTagsForResource x-required-permissions: create: - servicecatalog:CreateAttributeGroup @@ -152,7 +567,10 @@ components: - Application - AttributeGroup x-stackql-resource-name: attribute_group_association - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation. + x-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-attributegroupassociation.html + x-stackql-primary-identifier: - ApplicationArn - AttributeGroupArn x-create-only-properties: @@ -161,6 +579,14 @@ components: x-read-only-properties: - ApplicationArn - AttributeGroupArn + x-required-properties: + - Application + - AttributeGroup + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - servicecatalog:AssociateAttributeGroup @@ -199,7 +625,10 @@ components: - Resource - ResourceType x-stackql-resource-name: resource_association - x-stackql-primaryIdentifier: + description: Resource Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation + x-type-name: AWS::ServiceCatalogAppRegistry::ResourceAssociation + x-documentation-url: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-appregistry-resourceassociation.html + x-stackql-primary-identifier: - ApplicationArn - ResourceArn - ResourceType @@ -210,6 +639,15 @@ components: x-read-only-properties: - ApplicationArn - ResourceArn + x-required-properties: + - Application + - Resource + - ResourceType + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - servicecatalog:AssociateResource @@ -220,43 +658,234 @@ components: - servicecatalog:DisassociateResource list: - servicecatalog:ListAssociatedResources + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + pattern: '[a-z0-9]{26}' + Arn: + type: string + pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+ + Name: + type: string + description: 'The name of the application. ' + minLength: 1 + maxLength: 256 + pattern: \w+ + Description: + type: string + description: 'The description of the application. ' + maxLength: 1024 + Tags: + $ref: '#/components/schemas/Tags' + ApplicationTagKey: + type: string + description: The key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value. + maxLength: 128 + pattern: \w+ + ApplicationTagValue: + type: string + description: 'The value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value. ' + maxLength: 256 + pattern: \[a-zA-Z0-9_-:/]+ + ApplicationName: + type: string + description: 'The name of the application. ' + minLength: 1 + maxLength: 256 + pattern: \w+ + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateAttributeGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + pattern: '[a-z0-9]{12}' + Arn: + type: string + pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[a-z0-9]+ + Name: + type: string + description: 'The name of the attribute group. ' + minLength: 1 + maxLength: 256 + pattern: \w+ + Description: + type: string + description: 'The description of the attribute group. ' + maxLength: 1024 + Attributes: + type: object + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateAttributeGroupRequest + type: object + required: [] + CreateAttributeGroupAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Application: + type: string + description: The name or the Id of the Application. + minLength: 1 + maxLength: 256 + pattern: \w+|[a-z0-9]{12} + AttributeGroup: + type: string + description: The name or the Id of the AttributeGroup. + minLength: 1 + maxLength: 256 + pattern: \w+|[a-z0-9]{12} + ApplicationArn: + type: string + pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+ + AttributeGroupArn: + type: string + pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[a-z0-9]+ + x-stackQL-stringOnly: true + x-title: CreateAttributeGroupAssociationRequest + type: object + required: [] + CreateResourceAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Application: + type: string + description: The name or the Id of the Application. + minLength: 1 + maxLength: 256 + pattern: \w+|[a-z0-9]{12} + Resource: + type: string + description: The name or the Id of the Resource. + pattern: \w+|arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12} + ResourceType: + type: string + description: The type of the CFN Resource for now it's enum CFN_STACK. + enum: + - CFN_STACK + ApplicationArn: + type: string + pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+ + ResourceArn: + type: string + pattern: arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12} + x-stackQL-stringOnly: true + x-title: CreateResourceAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.servicecatalogappregistry.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.servicecatalogappregistry.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::Application x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -273,7 +902,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -289,13 +918,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' AND data__Identifier = '' AND region = 'us-east-1' - attribute_groups: - name: attribute_groups - id: awscc.servicecatalogappregistry.attribute_groups - x-cfn-schema-name: AttributeGroup - x-type: list + applications_list_only: + name: applications_list_only + id: awscc.servicecatalogappregistry.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::Application x-identifiers: - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -304,7 +939,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -312,19 +947,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' AND region = 'us-east-1' - attribute_group: - name: attribute_group - id: awscc.servicecatalogappregistry.attribute_group + attribute_groups: + name: attribute_groups + id: awscc.servicecatalogappregistry.attribute_groups x-cfn-schema-name: AttributeGroup - x-type: get + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroup x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AttributeGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::AttributeGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::AttributeGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::AttributeGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -339,7 +1022,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -353,14 +1036,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' AND data__Identifier = '' AND region = 'us-east-1' - attribute_group_associations: - name: attribute_group_associations - id: awscc.servicecatalogappregistry.attribute_group_associations - x-cfn-schema-name: AttributeGroupAssociation - x-type: list + attribute_groups_list_only: + name: attribute_groups_list_only + id: awscc.servicecatalogappregistry.attribute_groups_list_only + x-cfn-schema-name: AttributeGroup + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroup x-identifiers: - - ApplicationArn - - AttributeGroupArn + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -368,31 +1056,64 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, - JSON_EXTRACT(Properties, '$.AttributeGroupArn') as attribute_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'AttributeGroupArn') as attribute_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' AND region = 'us-east-1' - attribute_group_association: - name: attribute_group_association - id: awscc.servicecatalogappregistry.attribute_group_association + attribute_group_associations: + name: attribute_group_associations + id: awscc.servicecatalogappregistry.attribute_group_associations x-cfn-schema-name: AttributeGroupAssociation - x-type: get + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation x-identifiers: - ApplicationArn - AttributeGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AttributeGroupAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/attribute_group_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/attribute_group_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -405,7 +1126,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -417,15 +1138,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' AND data__Identifier = '|' AND region = 'us-east-1' - resource_associations: - name: resource_associations - id: awscc.servicecatalogappregistry.resource_associations - x-cfn-schema-name: ResourceAssociation - x-type: list + attribute_group_associations_list_only: + name: attribute_group_associations_list_only + id: awscc.servicecatalogappregistry.attribute_group_associations_list_only + x-cfn-schema-name: AttributeGroupAssociation + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation x-identifiers: - ApplicationArn - - ResourceArn - - ResourceType + - AttributeGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -434,9 +1160,8 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' + JSON_EXTRACT(Properties, '$.AttributeGroupArn') as attribute_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -444,23 +1169,57 @@ components: SELECT region, json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'ResourceType') as resource_type - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' + json_extract_path_text(Properties, 'AttributeGroupArn') as attribute_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' AND region = 'us-east-1' - resource_association: - name: resource_association - id: awscc.servicecatalogappregistry.resource_association + resource_associations: + name: resource_associations + id: awscc.servicecatalogappregistry.resource_associations x-cfn-schema-name: ResourceAssociation - x-type: get + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::ResourceAssociation x-identifiers: - ApplicationArn - ResourceArn - ResourceType + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::ResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ServiceCatalogAppRegistry::ResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -474,7 +1233,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -487,3 +1246,361 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' AND data__Identifier = '||' AND region = 'us-east-1' + resource_associations_list_only: + name: resource_associations_list_only + id: awscc.servicecatalogappregistry.resource_associations_list_only + x-cfn-schema-name: ResourceAssociation + x-cfn-type-name: AWS::ServiceCatalogAppRegistry::ResourceAssociation + x-identifiers: + - ApplicationArn + - ResourceArn + - ResourceType + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ResourceType') as resource_type + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AttributeGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAttributeGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAttributeGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AttributeGroupAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAttributeGroupAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAttributeGroupAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ses.yaml b/providers/src/awscc/v00.00.00000/services/ses.yaml index b5697fc2..0cc29efa 100644 --- a/providers/src/awscc/v00.00.00000/services/ses.yaml +++ b/providers/src/awscc/v00.00.00000/services/ses.yaml @@ -1,10 +1,407 @@ openapi: 3.0.0 info: title: SES - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9/_\+=\.:@\-]+$ + Value: + type: string + maxLength: 256 + minLength: 0 + pattern: ^[a-zA-Z0-9/_\+=\.:@\-]*$ + required: + - Key + - Value + additionalProperties: false TrackingOptions: description: An object that defines the open and click tracking options for emails that you send using the configuration set. type: object @@ -13,6 +410,10 @@ components: CustomRedirectDomain: type: string description: The domain to use for tracking open and click events. + HttpsPolicy: + type: string + description: The https policy to use for tracking open and click events. + pattern: REQUIRE|REQUIRE_OPEN_ONLY|OPTIONAL DeliveryOptions: description: An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. type: object @@ -25,6 +426,11 @@ components: SendingPoolName: type: string description: The name of the dedicated IP pool to associate with the configuration set. + MaxDeliverySeconds: + type: number + description: Specifies the maximum time until which SES will retry sending emails + minimum: 300 + maximum: 50400 ReputationOptions: description: An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. type: object @@ -106,14 +512,38 @@ components: $ref: '#/components/schemas/SuppressionOptions' VdmOptions: $ref: '#/components/schemas/VdmOptions' + Tags: + description: The tags (keys and values) associated with the contact list. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 x-stackql-resource-name: configuration_set - x-stackql-primaryIdentifier: + description: Resource schema for AWS::SES::ConfigurationSet. + x-type-name: AWS::SES::ConfigurationSet + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource x-required-permissions: create: - ses:CreateConfigurationSet + - ses:UntagResource + - ses:TagResource + - ses:DescribeConfigurationSet + - ses:GetConfigurationSet read: - ses:GetConfigurationSet - ses:DescribeConfigurationSet @@ -124,6 +554,9 @@ components: - ses:PutConfigurationSetSendingOptions - ses:PutConfigurationSetSuppressionOptions - ses:PutConfigurationSetVdmOptions + - ses:DescribeConfigurationSet + - ses:UntagResource + - ses:TagResource delete: - ses:DeleteConfigurationSet list: @@ -155,8 +588,23 @@ components: SnsDestination: description: An object that contains SNS topic ARN associated event destination. $ref: '#/components/schemas/SnsDestination' + EventBridgeDestination: + description: An object that contains Event bus ARN associated with the event bridge destination. + $ref: '#/components/schemas/EventBridgeDestination' required: - MatchingEventTypes + EventBridgeDestination: + type: object + additionalProperties: false + description: An object that contains Event bus ARN associated with the event bridge destination. + properties: + EventBusArn: + type: string + minLength: 36 + maxLength: 1024 + pattern: ^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:\d{12}:event-bus/[^:]+$ + required: + - EventBusArn SnsDestination: type: object additionalProperties: false @@ -234,12 +682,19 @@ components: - ConfigurationSetName - EventDestination x-stackql-resource-name: configuration_set_event_destination - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SES::ConfigurationSetEventDestination + x-type-name: AWS::SES::ConfigurationSetEventDestination + x-stackql-primary-identifier: - Id x-create-only-properties: - ConfigurationSetName x-read-only-properties: - Id + x-required-properties: + - ConfigurationSetName + - EventDestination + x-tagging: + taggable: false x-required-permissions: create: - ses:CreateConfigurationSetEventDestination @@ -253,21 +708,9 @@ components: read: - ses:GetConfigurationSetEventDestinations - ses:DescribeConfigurationSet - Tag: - type: object - properties: - Key: - type: string - minLength: 1 - maxLength: 128 - Value: - type: string - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false + list: + - ses:GetConfigurationSetEventDestinations + - ses:DescribeConfigurationSet Topic: type: object properties: @@ -320,21 +763,39 @@ components: minItems: 0 maxItems: 50 x-stackql-resource-name: contact_list - x-stackql-primaryIdentifier: + description: Resource schema for AWS::SES::ContactList. + x-type-name: AWS::SES::ContactList + x-stackql-primary-identifier: - ContactListName x-create-only-properties: - ContactListName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource x-required-permissions: create: - ses:CreateContactList + - ses:UntagResource + - ses:TagResource + - ses:GetContactList read: - ses:GetContactList + - ses:ListTagsForResource update: - ses:UpdateContactList - ses:UntagResource - ses:TagResource + - ses:GetContactList delete: - ses:DeleteContactList + - ses:GetContactList list: - ses:ListContactLists DedicatedIpPool: @@ -348,22 +809,50 @@ components: type: string description: Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD. pattern: ^(STANDARD|MANAGED)$ + Tags: + description: The tags (keys and values) associated with the dedicated IP pool. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 x-stackql-resource-name: dedicated_ip_pool - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SES::DedicatedIpPool + x-type-name: AWS::SES::DedicatedIpPool + x-stackql-primary-identifier: - PoolName x-create-only-properties: - PoolName + x-conditional-create-only-properties: + - ScalingMode + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource x-required-permissions: create: - ses:CreateDedicatedIpPool - ses:GetDedicatedIpPool - ses:GetDedicatedIps + - ses:TagResource + - ses:UntagResource read: - ses:GetDedicatedIpPool - ses:GetDedicatedIps + - ses:ListTagsForResource update: - ses:PutDedicatedIpPoolScalingAttributes - ses:GetDedicatedIpPool + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource delete: - ses:DeleteDedicatedIpPool list: @@ -447,13 +936,26 @@ components: type: string DkimDNSTokenValue3: type: string + Tags: + description: The tags (keys and values) associated with the email identity. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 required: - EmailIdentity x-stackql-resource-name: email_identity - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SES::EmailIdentity + x-type-name: AWS::SES::EmailIdentity + x-stackql-primary-identifier: - EmailIdentity x-create-only-properties: - EmailIdentity + x-write-only-properties: + - DkimSigningAttributes/DomainSigningSelector + - DkimSigningAttributes/DomainSigningPrivateKey x-read-only-properties: - DkimDNSTokenName1 - DkimDNSTokenName2 @@ -461,6 +963,17 @@ components: - DkimDNSTokenValue1 - DkimDNSTokenValue2 - DkimDNSTokenValue3 + x-required-properties: + - EmailIdentity + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource x-required-permissions: create: - ses:CreateEmailIdentity @@ -468,6 +981,8 @@ components: - ses:PutEmailIdentityFeedbackAttributes - ses:PutEmailIdentityDkimAttributes - ses:GetEmailIdentity + - ses:TagResource + - ses:UntagResource read: - ses:GetEmailIdentity update: @@ -477,97 +992,3124 @@ components: - ses:PutEmailIdentityDkimSigningAttributes - ses:PutEmailIdentityDkimAttributes - ses:GetEmailIdentity + - ses:TagResource + - ses:UntagResource delete: - ses:DeleteEmailIdentity list: - ses:ListEmailIdentities - Template: + MailManagerAddonInstance: type: object properties: - Id: + AddonInstanceArn: type: string - Template: - $ref: '#/components/schemas/Template' - x-stackql-resource-name: template - x-stackql-primaryIdentifier: - - Id + AddonInstanceId: + type: string + maxLength: 67 + minLength: 4 + pattern: ^ai-[a-zA-Z0-9]{1,64}$ + AddonName: + type: string + AddonSubscriptionId: + type: string + maxLength: 67 + minLength: 4 + pattern: ^as-[a-zA-Z0-9]{1,64}$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + required: + - AddonSubscriptionId + x-stackql-resource-name: mail_manager_addon_instance + description: Definition of AWS::SES::MailManagerAddonInstance Resource Type + x-type-name: AWS::SES::MailManagerAddonInstance + x-stackql-primary-identifier: + - AddonInstanceId x-create-only-properties: - - Template/TemplateName + - AddonSubscriptionId x-read-only-properties: - - Id + - AddonInstanceArn + - AddonInstanceId + - AddonName + x-required-properties: + - AddonSubscriptionId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource x-required-permissions: create: - - ses:CreateEmailTemplate - - ses:GetEmailTemplate - - ses:CreateTemplate - - ses:GetTemplate + - ses:TagResource + - ses:ListTagsForResource + - ses:GetAddonInstance + - ses:CreateAddonInstance read: - - ses:GetEmailTemplate - - ses:GetTemplate - delete: - - ses:DeleteEmailTemplate - - ses:DeleteTemplate + - ses:ListTagsForResource + - ses:GetAddonInstance update: - - ses:GetEmailTemplate - - ses:UpdateEmailTemplate - - ses:GetTemplate - - ses:UpdateTemplate + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetAddonInstance + delete: + - ses:GetAddonInstance + - ses:DeleteAddonInstance list: - - ses:ListEmailTemplates - - ses:ListTemplates - DashboardAttributes: + - ses:ListAddonInstances + MailManagerAddonSubscription: type: object - additionalProperties: false - description: Preferences regarding the Dashboard feature. properties: - EngagementMetrics: + AddonName: type: string - description: Whether emails sent from this account have engagement tracking enabled. - pattern: ENABLED|DISABLED - GuardianAttributes: - type: object - additionalProperties: false - description: Preferences regarding the Guardian feature. - properties: - OptimizedSharedDelivery: + AddonSubscriptionArn: type: string - description: Whether emails sent from this account have optimized delivery algorithm enabled. - pattern: ENABLED|DISABLED - VdmAttributes: + AddonSubscriptionId: + type: string + maxLength: 67 + minLength: 4 + pattern: ^as-[a-zA-Z0-9]{1,64}$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + required: + - AddonName + x-stackql-resource-name: mail_manager_addon_subscription + description: Definition of AWS::SES::MailManagerAddonSubscription Resource Type + x-type-name: AWS::SES::MailManagerAddonSubscription + x-stackql-primary-identifier: + - AddonSubscriptionId + x-create-only-properties: + - AddonName + x-read-only-properties: + - AddonSubscriptionArn + - AddonSubscriptionId + x-required-properties: + - AddonName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + x-required-permissions: + create: + - ses:TagResource + - ses:ListTagsForResource + - ses:GetAddonSubscription + - ses:CreateAddonSubscription + read: + - ses:ListTagsForResource + - ses:GetAddonSubscription + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetAddonSubscription + delete: + - ses:GetAddonSubscription + - ses:DeleteAddonSubscription + list: + - ses:ListAddonSubscriptions + MailManagerAddressList: type: object properties: - VdmAttributesResourceId: + AddressListArn: type: string - description: Unique identifier for this resource - DashboardAttributes: - $ref: '#/components/schemas/DashboardAttributes' - GuardianAttributes: - $ref: '#/components/schemas/GuardianAttributes' - x-stackql-resource-name: vdm_attributes - x-stackql-primaryIdentifier: - - VdmAttributesResourceId + AddressListId: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + AddressListName: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackql-resource-name: mail_manager_address_list + description: Definition of AWS::SES::MailManagerAddressList Resource Type + x-type-name: AWS::SES::MailManagerAddressList + x-stackql-primary-identifier: + - AddressListId + x-create-only-properties: + - AddressListName x-read-only-properties: - - VdmAttributesResourceId + - AddressListId + - AddressListArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource x-required-permissions: create: - - ses:PutAccountVdmAttributes - - ses:GetAccount + - ses:TagResource + - ses:ListTagsForResource + - ses:GetAddressList + - ses:CreateAddressList read: - - ses:GetAccount - update: - - ses:PutAccountVdmAttributes - - ses:GetAccount + - ses:ListTagsForResource + - ses:GetAddressList delete: - - ses:PutAccountVdmAttributes - - ses:GetAccount - x-stackQL-resources: - configuration_sets: - name: configuration_sets - id: awscc.ses.configuration_sets + - ses:GetAddressList + - ses:DeleteAddressList + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetAddressList + list: + - ses:ListAddressLists + ArchiveRetention: + oneOf: + - type: object + title: RetentionPeriod + properties: + RetentionPeriod: + $ref: '#/components/schemas/RetentionPeriod' + required: + - RetentionPeriod + additionalProperties: false + ArchiveState: + type: string + enum: + - ACTIVE + - PENDING_DELETION + RetentionPeriod: + type: string + enum: + - THREE_MONTHS + - SIX_MONTHS + - NINE_MONTHS + - ONE_YEAR + - EIGHTEEN_MONTHS + - TWO_YEARS + - THIRTY_MONTHS + - THREE_YEARS + - FOUR_YEARS + - FIVE_YEARS + - SIX_YEARS + - SEVEN_YEARS + - EIGHT_YEARS + - NINE_YEARS + - TEN_YEARS + - PERMANENT + MailManagerArchive: + type: object + properties: + ArchiveArn: + type: string + ArchiveId: + type: string + maxLength: 66 + minLength: 1 + ArchiveName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$ + ArchiveState: + $ref: '#/components/schemas/ArchiveState' + KmsKeyArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$ + Retention: + $ref: '#/components/schemas/ArchiveRetention' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackql-resource-name: mail_manager_archive + description: Definition of AWS::SES::MailManagerArchive Resource Type + x-type-name: AWS::SES::MailManagerArchive + x-stackql-primary-identifier: + - ArchiveId + x-create-only-properties: + - KmsKeyArn + x-read-only-properties: + - ArchiveArn + - ArchiveId + - ArchiveState + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + x-required-permissions: + create: + - ses:TagResource + - ses:ListTagsForResource + - ses:GetArchive + - ses:CreateArchive + - kms:DescribeKey + - kms:Decrypt + - kms:GenerateDataKey + read: + - ses:ListTagsForResource + - ses:GetArchive + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetArchive + - ses:UpdateArchive + delete: + - ses:GetArchive + - ses:DeleteArchive + list: + - ses:ListArchives + IngressPointConfiguration: + oneOf: + - type: object + title: SmtpPassword + properties: + SmtpPassword: + type: string + maxLength: 64 + minLength: 8 + pattern: ^[A-Za-z0-9!@#$%^&*()_+\-=\[\]{}|.,?]+$ + required: + - SmtpPassword + additionalProperties: false + - type: object + title: SecretArn + properties: + SecretArn: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$ + required: + - SecretArn + additionalProperties: false + IngressPointStatus: + type: string + enum: + - PROVISIONING + - DEPROVISIONING + - UPDATING + - ACTIVE + - CLOSED + - FAILED + IngressPointStatusToUpdate: + type: string + enum: + - ACTIVE + - CLOSED + IngressPointType: + type: string + enum: + - OPEN + - AUTH + IpType: + type: string + enum: + - IPV4 + - DUAL_STACK + NetworkConfiguration: + oneOf: + - type: object + title: PublicNetworkConfiguration + properties: + PublicNetworkConfiguration: + $ref: '#/components/schemas/PublicNetworkConfiguration' + required: + - PublicNetworkConfiguration + additionalProperties: false + - type: object + title: PrivateNetworkConfiguration + properties: + PrivateNetworkConfiguration: + $ref: '#/components/schemas/PrivateNetworkConfiguration' + required: + - PrivateNetworkConfiguration + additionalProperties: false + PrivateNetworkConfiguration: + type: object + properties: + VpcEndpointId: + type: string + pattern: ^vpce-[a-zA-Z0-9]{17}$ + required: + - VpcEndpointId + additionalProperties: false + PublicNetworkConfiguration: + type: object + properties: + IpType: + allOf: + - $ref: '#/components/schemas/IpType' + - default: IPV4 + required: + - IpType + additionalProperties: false + MailManagerIngressPoint: + type: object + properties: + ARecord: + type: string + TrafficPolicyId: + type: string + maxLength: 100 + minLength: 1 + IngressPointConfiguration: + $ref: '#/components/schemas/IngressPointConfiguration' + IngressPointArn: + type: string + IngressPointId: + type: string + maxLength: 100 + minLength: 1 + IngressPointName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^[A-Za-z0-9_\-]+$ + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + RuleSetId: + type: string + maxLength: 100 + minLength: 1 + Status: + $ref: '#/components/schemas/IngressPointStatus' + StatusToUpdate: + $ref: '#/components/schemas/IngressPointStatusToUpdate' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/IngressPointType' + required: + - Type + - TrafficPolicyId + - RuleSetId + x-stackql-resource-name: mail_manager_ingress_point + description: Definition of AWS::SES::MailManagerIngressPoint Resource Type + x-type-name: AWS::SES::MailManagerIngressPoint + x-stackql-primary-identifier: + - IngressPointId + x-create-only-properties: + - NetworkConfiguration + - Type + x-write-only-properties: + - IngressPointConfiguration + x-read-only-properties: + - IngressPointId + - IngressPointArn + - Status + - ARecord + x-required-properties: + - Type + - TrafficPolicyId + - RuleSetId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + x-required-permissions: + create: + - ses:TagResource + - ses:ListTagsForResource + - ses:GetIngressPoint + - ses:CreateIngressPoint + - iam:CreateServiceLinkedRole + - ec2:DescribeVpcEndpoints + read: + - ses:ListTagsForResource + - ses:GetIngressPoint + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetIngressPoint + - ses:UpdateIngressPoint + delete: + - ses:GetIngressPoint + - ses:DeleteIngressPoint + list: + - ses:ListIngressPoints + NoAuthentication: + type: object + additionalProperties: false + RelayAuthentication: + oneOf: + - type: object + title: SecretArn + properties: + SecretArn: + type: string + pattern: ^arn:(aws|aws-cn|aws-us-gov):secretsmanager:[a-z0-9-]+:\d{12}:secret:[a-zA-Z0-9/_+=,.@-]+$ + required: + - SecretArn + additionalProperties: false + - type: object + title: NoAuthentication + properties: + NoAuthentication: + $ref: '#/components/schemas/NoAuthentication' + required: + - NoAuthentication + additionalProperties: false + MailManagerRelay: + type: object + properties: + Authentication: + $ref: '#/components/schemas/RelayAuthentication' + RelayArn: + type: string + RelayId: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + RelayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]+$ + ServerName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-\.]+$ + ServerPort: + type: number + maximum: 65535 + minimum: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + required: + - Authentication + - ServerName + - ServerPort + x-stackql-resource-name: mail_manager_relay + description: Definition of AWS::SES::MailManagerRelay Resource Type + x-type-name: AWS::SES::MailManagerRelay + x-stackql-primary-identifier: + - RelayId + x-read-only-properties: + - RelayArn + - RelayId + x-required-properties: + - Authentication + - ServerName + - ServerPort + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + x-required-permissions: + create: + - ses:TagResource + - ses:ListTagsForResource + - ses:GetRelay + - ses:CreateRelay + read: + - ses:ListTagsForResource + - ses:GetRelay + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetRelay + - ses:UpdateRelay + delete: + - ses:GetRelay + - ses:DeleteRelay + list: + - ses:ListRelays + ActionFailurePolicy: + type: string + enum: + - CONTINUE + - DROP + AddHeaderAction: + type: object + properties: + HeaderName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[xX]\-[a-zA-Z0-9\-]+$ + HeaderValue: + type: string + maxLength: 128 + minLength: 1 + required: + - HeaderName + - HeaderValue + additionalProperties: false + Analysis: + type: object + properties: + Analyzer: + type: string + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + ResultField: + type: string + maxLength: 256 + minLength: 1 + pattern: ^(addon\.)?[\sa-zA-Z0-9_]+$ + required: + - Analyzer + - ResultField + additionalProperties: false + RuleIsInAddressList: + type: object + properties: + Attribute: + $ref: '#/components/schemas/RuleAddressListEmailAttribute' + AddressLists: + type: array + items: + type: string + maxItems: 1 + minItems: 1 + uniqueItems: true + required: + - Attribute + - AddressLists + additionalProperties: false + ArchiveAction: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + TargetArchive: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + required: + - TargetArchive + additionalProperties: false + DeliverToMailboxAction: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + MailboxArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + required: + - MailboxArn + - RoleArn + additionalProperties: false + SnsAction: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + TopicArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:(aws|aws-cn|aws-us-gov):sns:[a-z]{2}-[a-z]+-\d{1}:\d{12}:[\w\-]{1,256}$ + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + Encoding: + $ref: '#/components/schemas/SnsNotificationEncoding' + PayloadType: + $ref: '#/components/schemas/SnsNotificationPayloadType' + required: + - TopicArn + - RoleArn + additionalProperties: false + SnsNotificationEncoding: + type: string + enum: + - UTF-8 + - BASE64 + SnsNotificationPayloadType: + type: string + enum: + - CONTENT + - HEADERS + DeliverToQBusinessAction: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-z0-9-]+$ + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-z0-9-]+$ + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + required: + - ApplicationId + - IndexId + - RoleArn + additionalProperties: false + DropAction: + type: object + additionalProperties: false + MailFrom: + type: string + enum: + - REPLACE + - PRESERVE + RelayAction: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + Relay: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + MailFrom: + $ref: '#/components/schemas/MailFrom' + required: + - Relay + additionalProperties: false + ReplaceRecipientAction: + type: object + properties: + ReplaceWith: + type: array + items: + type: string + maxLength: 254 + minLength: 0 + pattern: ^[0-9A-Za-z@+.-]+$ + maxItems: 100 + minItems: 1 + uniqueItems: true + additionalProperties: false + Rule: + type: object + properties: + Name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + Conditions: + type: array + items: + $ref: '#/components/schemas/RuleCondition' + maxItems: 10 + minItems: 0 + Unless: + type: array + items: + $ref: '#/components/schemas/RuleCondition' + maxItems: 10 + minItems: 0 + Actions: + type: array + items: + $ref: '#/components/schemas/RuleAction' + maxItems: 10 + minItems: 1 + required: + - Actions + additionalProperties: false + RuleAction: + oneOf: + - type: object + title: Drop + properties: + Drop: + $ref: '#/components/schemas/DropAction' + required: + - Drop + additionalProperties: false + - type: object + title: Relay + properties: + Relay: + $ref: '#/components/schemas/RelayAction' + required: + - Relay + additionalProperties: false + - type: object + title: Archive + properties: + Archive: + $ref: '#/components/schemas/ArchiveAction' + required: + - Archive + additionalProperties: false + - type: object + title: WriteToS3 + properties: + WriteToS3: + $ref: '#/components/schemas/S3Action' + required: + - WriteToS3 + additionalProperties: false + - type: object + title: Send + properties: + Send: + $ref: '#/components/schemas/SendAction' + required: + - Send + additionalProperties: false + - type: object + title: AddHeader + properties: + AddHeader: + $ref: '#/components/schemas/AddHeaderAction' + required: + - AddHeader + additionalProperties: false + - type: object + title: ReplaceRecipient + properties: + ReplaceRecipient: + $ref: '#/components/schemas/ReplaceRecipientAction' + required: + - ReplaceRecipient + additionalProperties: false + - type: object + title: DeliverToMailbox + properties: + DeliverToMailbox: + $ref: '#/components/schemas/DeliverToMailboxAction' + required: + - DeliverToMailbox + additionalProperties: false + - type: object + title: DeliverToQBusiness + properties: + DeliverToQBusiness: + $ref: '#/components/schemas/DeliverToQBusinessAction' + required: + - DeliverToQBusiness + additionalProperties: false + - type: object + title: PublishToSns + properties: + PublishToSns: + $ref: '#/components/schemas/SnsAction' + required: + - PublishToSns + additionalProperties: false + RuleBooleanEmailAttribute: + type: string + enum: + - READ_RECEIPT_REQUESTED + - TLS + - TLS_WRAPPED + RuleBooleanExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/RuleBooleanToEvaluate' + Operator: + $ref: '#/components/schemas/RuleBooleanOperator' + required: + - Evaluate + - Operator + additionalProperties: false + RuleBooleanOperator: + type: string + enum: + - IS_TRUE + - IS_FALSE + RuleBooleanToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/RuleBooleanEmailAttribute' + required: + - Attribute + additionalProperties: false + - type: object + title: Analysis + properties: + Analysis: + $ref: '#/components/schemas/Analysis' + required: + - Analysis + additionalProperties: false + - type: object + title: IsInAddressList + properties: + IsInAddressList: + $ref: '#/components/schemas/RuleIsInAddressList' + required: + - IsInAddressList + additionalProperties: false + RuleCondition: + oneOf: + - type: object + title: BooleanExpression + properties: + BooleanExpression: + $ref: '#/components/schemas/RuleBooleanExpression' + required: + - BooleanExpression + additionalProperties: false + - type: object + title: StringExpression + properties: + StringExpression: + $ref: '#/components/schemas/RuleStringExpression' + required: + - StringExpression + additionalProperties: false + - type: object + title: NumberExpression + properties: + NumberExpression: + $ref: '#/components/schemas/RuleNumberExpression' + required: + - NumberExpression + additionalProperties: false + - type: object + title: IpExpression + properties: + IpExpression: + $ref: '#/components/schemas/RuleIpExpression' + required: + - IpExpression + additionalProperties: false + - type: object + title: VerdictExpression + properties: + VerdictExpression: + $ref: '#/components/schemas/RuleVerdictExpression' + required: + - VerdictExpression + additionalProperties: false + - type: object + title: DmarcExpression + properties: + DmarcExpression: + $ref: '#/components/schemas/RuleDmarcExpression' + required: + - DmarcExpression + additionalProperties: false + RuleDmarcExpression: + type: object + properties: + Operator: + $ref: '#/components/schemas/RuleDmarcOperator' + Values: + type: array + items: + $ref: '#/components/schemas/RuleDmarcPolicy' + maxItems: 10 + minItems: 1 + required: + - Operator + - Values + additionalProperties: false + RuleDmarcOperator: + type: string + enum: + - EQUALS + - NOT_EQUALS + RuleDmarcPolicy: + type: string + enum: + - NONE + - QUARANTINE + - REJECT + RuleIpEmailAttribute: + type: string + enum: + - SOURCE_IP + RuleIpExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/RuleIpToEvaluate' + Operator: + $ref: '#/components/schemas/RuleIpOperator' + Values: + type: array + items: + type: string + maxLength: 43 + minLength: 1 + pattern: ^(([0-9]|.|:|/)*)$ + maxItems: 10 + minItems: 1 + required: + - Evaluate + - Operator + - Values + additionalProperties: false + RuleIpOperator: + type: string + enum: + - CIDR_MATCHES + - NOT_CIDR_MATCHES + RuleIpToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/RuleIpEmailAttribute' + required: + - Attribute + additionalProperties: false + RuleNumberEmailAttribute: + type: string + enum: + - MESSAGE_SIZE + RuleNumberExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/RuleNumberToEvaluate' + Operator: + $ref: '#/components/schemas/RuleNumberOperator' + Value: + type: number + required: + - Evaluate + - Operator + - Value + additionalProperties: false + RuleNumberOperator: + type: string + enum: + - EQUALS + - NOT_EQUALS + - LESS_THAN + - GREATER_THAN + - LESS_THAN_OR_EQUAL + - GREATER_THAN_OR_EQUAL + RuleAddressListEmailAttribute: + type: string + enum: + - RECIPIENT + - MAIL_FROM + - SENDER + - FROM + - TO + - CC + RuleNumberToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/RuleNumberEmailAttribute' + required: + - Attribute + additionalProperties: false + RuleStringEmailAttribute: + type: string + enum: + - MAIL_FROM + - HELO + - RECIPIENT + - SENDER + - FROM + - SUBJECT + - TO + - CC + RuleStringExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/RuleStringToEvaluate' + Operator: + $ref: '#/components/schemas/RuleStringOperator' + Values: + type: array + items: + type: string + maxLength: 4096 + minLength: 1 + maxItems: 10 + minItems: 1 + required: + - Evaluate + - Operator + - Values + additionalProperties: false + RuleStringOperator: + type: string + enum: + - EQUALS + - NOT_EQUALS + - STARTS_WITH + - ENDS_WITH + - CONTAINS + RuleStringToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/RuleStringEmailAttribute' + required: + - Attribute + additionalProperties: false + - type: object + title: MimeHeaderAttribute + properties: + MimeHeaderAttribute: + type: string + pattern: ^X-[a-zA-Z0-9-]{1,256}$ + required: + - MimeHeaderAttribute + additionalProperties: false + - type: object + title: Analysis + properties: + Analysis: + $ref: '#/components/schemas/Analysis' + required: + - Analysis + additionalProperties: false + RuleVerdict: + type: string + enum: + - PASS + - FAIL + - GRAY + - PROCESSING_FAILED + RuleVerdictAttribute: + type: string + enum: + - SPF + - DKIM + RuleVerdictExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/RuleVerdictToEvaluate' + Operator: + $ref: '#/components/schemas/RuleVerdictOperator' + Values: + type: array + items: + $ref: '#/components/schemas/RuleVerdict' + maxItems: 10 + minItems: 1 + required: + - Evaluate + - Operator + - Values + additionalProperties: false + RuleVerdictOperator: + type: string + enum: + - EQUALS + - NOT_EQUALS + RuleVerdictToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/RuleVerdictAttribute' + required: + - Attribute + additionalProperties: false + - type: object + title: Analysis + properties: + Analysis: + $ref: '#/components/schemas/Analysis' + required: + - Analysis + additionalProperties: false + S3Action: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + S3Bucket: + type: string + maxLength: 62 + minLength: 1 + pattern: ^[a-zA-Z0-9.-]+$ + S3Prefix: + type: string + maxLength: 62 + minLength: 1 + pattern: ^[a-zA-Z0-9!_.*'()/-]+$ + S3SseKmsKeyId: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^[a-zA-Z0-9-:/]+$ + required: + - RoleArn + - S3Bucket + additionalProperties: false + SendAction: + type: object + properties: + ActionFailurePolicy: + $ref: '#/components/schemas/ActionFailurePolicy' + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + required: + - RoleArn + additionalProperties: false + MailManagerRuleSet: + type: object + properties: + RuleSetArn: + type: string + RuleSetId: + type: string + maxLength: 100 + minLength: 1 + RuleSetName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + Rules: + type: array + items: + $ref: '#/components/schemas/Rule' + maxItems: 40 + minItems: 0 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + required: + - Rules + x-stackql-resource-name: mail_manager_rule_set + description: Definition of AWS::SES::MailManagerRuleSet Resource Type + x-type-name: AWS::SES::MailManagerRuleSet + x-stackql-primary-identifier: + - RuleSetId + x-read-only-properties: + - RuleSetArn + - RuleSetId + x-required-properties: + - Rules + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + x-required-permissions: + create: + - ses:TagResource + - ses:ListTagsForResource + - ses:GetRuleSet + - ses:CreateRuleSet + read: + - ses:ListTagsForResource + - ses:GetRuleSet + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetRuleSet + - ses:UpdateRuleSet + delete: + - ses:GetRuleSet + - ses:DeleteRuleSet + list: + - ses:ListRuleSets + AcceptAction: + type: string + enum: + - ALLOW + - DENY + IngressAnalysis: + type: object + properties: + Analyzer: + type: string + pattern: ^[a-zA-Z0-9:_/+=,@.#-]+$ + ResultField: + type: string + maxLength: 256 + minLength: 1 + pattern: ^(addon\.)?[\sa-zA-Z0-9_]+$ + required: + - Analyzer + - ResultField + additionalProperties: false + IngressAddressListEmailAttribute: + type: string + enum: + - RECIPIENT + IngressIsInAddressList: + type: object + properties: + Attribute: + $ref: '#/components/schemas/IngressAddressListEmailAttribute' + AddressLists: + type: array + items: + type: string + maxItems: 1 + minItems: 1 + uniqueItems: true + required: + - AddressLists + - Attribute + additionalProperties: false + IngressBooleanExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/IngressBooleanToEvaluate' + Operator: + $ref: '#/components/schemas/IngressBooleanOperator' + required: + - Evaluate + - Operator + additionalProperties: false + IngressBooleanOperator: + type: string + enum: + - IS_TRUE + - IS_FALSE + IngressBooleanToEvaluate: + oneOf: + - type: object + title: Analysis + properties: + Analysis: + $ref: '#/components/schemas/IngressAnalysis' + required: + - Analysis + additionalProperties: false + - type: object + title: IsInAddressList + properties: + IsInAddressList: + $ref: '#/components/schemas/IngressIsInAddressList' + required: + - IsInAddressList + additionalProperties: false + IngressIpOperator: + type: string + enum: + - CIDR_MATCHES + - NOT_CIDR_MATCHES + IngressIpToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/IngressIpv4Attribute' + required: + - Attribute + additionalProperties: false + IngressIpv4Attribute: + type: string + enum: + - SENDER_IP + IngressIpv4Expression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/IngressIpToEvaluate' + Operator: + $ref: '#/components/schemas/IngressIpOperator' + Values: + type: array + items: + type: string + pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/([0-9]|[12][0-9]|3[0-2])$ + required: + - Evaluate + - Operator + - Values + additionalProperties: false + IngressIpv6Attribute: + type: string + enum: + - SENDER_IPV6 + IngressIpv6Expression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/IngressIpv6ToEvaluate' + Operator: + $ref: '#/components/schemas/IngressIpOperator' + Values: + type: array + items: + type: string + maxLength: 49 + pattern: ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9])$ + required: + - Evaluate + - Operator + - Values + additionalProperties: false + IngressIpv6ToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/IngressIpv6Attribute' + required: + - Attribute + additionalProperties: false + IngressStringEmailAttribute: + type: string + enum: + - RECIPIENT + IngressStringExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/IngressStringToEvaluate' + Operator: + $ref: '#/components/schemas/IngressStringOperator' + Values: + type: array + items: + type: string + required: + - Evaluate + - Operator + - Values + additionalProperties: false + IngressStringOperator: + type: string + enum: + - EQUALS + - NOT_EQUALS + - STARTS_WITH + - ENDS_WITH + - CONTAINS + IngressStringToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/IngressStringEmailAttribute' + required: + - Attribute + additionalProperties: false + - type: object + title: Analysis + properties: + Analysis: + $ref: '#/components/schemas/IngressAnalysis' + required: + - Analysis + additionalProperties: false + IngressTlsAttribute: + type: string + enum: + - TLS_PROTOCOL + IngressTlsProtocolAttribute: + type: string + enum: + - TLS1_2 + - TLS1_3 + IngressTlsProtocolExpression: + type: object + properties: + Evaluate: + $ref: '#/components/schemas/IngressTlsProtocolToEvaluate' + Operator: + $ref: '#/components/schemas/IngressTlsProtocolOperator' + Value: + $ref: '#/components/schemas/IngressTlsProtocolAttribute' + required: + - Evaluate + - Operator + - Value + additionalProperties: false + IngressTlsProtocolOperator: + type: string + enum: + - MINIMUM_TLS_VERSION + - IS + IngressTlsProtocolToEvaluate: + oneOf: + - type: object + title: Attribute + properties: + Attribute: + $ref: '#/components/schemas/IngressTlsAttribute' + required: + - Attribute + additionalProperties: false + PolicyCondition: + oneOf: + - type: object + title: StringExpression + properties: + StringExpression: + $ref: '#/components/schemas/IngressStringExpression' + required: + - StringExpression + additionalProperties: false + - type: object + title: IpExpression + properties: + IpExpression: + $ref: '#/components/schemas/IngressIpv4Expression' + required: + - IpExpression + additionalProperties: false + - type: object + title: Ipv6Expression + properties: + Ipv6Expression: + $ref: '#/components/schemas/IngressIpv6Expression' + required: + - Ipv6Expression + additionalProperties: false + - type: object + title: TlsExpression + properties: + TlsExpression: + $ref: '#/components/schemas/IngressTlsProtocolExpression' + required: + - TlsExpression + additionalProperties: false + - type: object + title: BooleanExpression + properties: + BooleanExpression: + $ref: '#/components/schemas/IngressBooleanExpression' + required: + - BooleanExpression + additionalProperties: false + PolicyStatement: + type: object + properties: + Conditions: + type: array + items: + $ref: '#/components/schemas/PolicyCondition' + minItems: 1 + Action: + $ref: '#/components/schemas/AcceptAction' + required: + - Action + - Conditions + additionalProperties: false + MailManagerTrafficPolicy: + type: object + properties: + DefaultAction: + $ref: '#/components/schemas/AcceptAction' + MaxMessageSizeBytes: + type: number + minimum: 1 + PolicyStatements: + type: array + items: + $ref: '#/components/schemas/PolicyStatement' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + TrafficPolicyArn: + type: string + TrafficPolicyId: + type: string + maxLength: 100 + minLength: 1 + TrafficPolicyName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^[A-Za-z0-9_\-]+$ + required: + - DefaultAction + - PolicyStatements + x-stackql-resource-name: mail_manager_traffic_policy + description: Definition of AWS::SES::MailManagerTrafficPolicy Resource Type + x-type-name: AWS::SES::MailManagerTrafficPolicy + x-stackql-primary-identifier: + - TrafficPolicyId + x-read-only-properties: + - TrafficPolicyArn + - TrafficPolicyId + x-required-properties: + - DefaultAction + - PolicyStatements + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ses:TagResource + - ses:UntagResource + x-required-permissions: + create: + - ses:TagResource + - ses:ListTagsForResource + - ses:GetTrafficPolicy + - ses:CreateTrafficPolicy + read: + - ses:ListTagsForResource + - ses:GetTrafficPolicy + update: + - ses:TagResource + - ses:UntagResource + - ses:ListTagsForResource + - ses:GetTrafficPolicy + - ses:UpdateTrafficPolicy + delete: + - ses:GetTrafficPolicy + - ses:DeleteTrafficPolicy + list: + - ses:ListTrafficPolicies + Template: + type: object + properties: + Id: + type: string + Template: + $ref: '#/components/schemas/Template' + x-stackql-resource-name: template + description: Resource Type definition for AWS::SES::Template + x-type-name: AWS::SES::Template + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Template/TemplateName + x-read-only-properties: + - Id + x-tagging: + taggable: false + x-required-permissions: + create: + - ses:CreateEmailTemplate + - ses:GetEmailTemplate + - ses:CreateTemplate + - ses:GetTemplate + read: + - ses:GetEmailTemplate + - ses:GetTemplate + delete: + - ses:DeleteEmailTemplate + - ses:DeleteTemplate + update: + - ses:GetEmailTemplate + - ses:UpdateEmailTemplate + - ses:GetTemplate + - ses:UpdateTemplate + list: + - ses:ListEmailTemplates + - ses:ListTemplates + DashboardAttributes: + type: object + additionalProperties: false + description: Preferences regarding the Dashboard feature. + properties: + EngagementMetrics: + type: string + description: Whether emails sent from this account have engagement tracking enabled. + pattern: ENABLED|DISABLED + GuardianAttributes: + type: object + additionalProperties: false + description: Preferences regarding the Guardian feature. + properties: + OptimizedSharedDelivery: + type: string + description: Whether emails sent from this account have optimized delivery algorithm enabled. + pattern: ENABLED|DISABLED + VdmAttributes: + type: object + properties: + VdmAttributesResourceId: + type: string + description: Unique identifier for this resource + DashboardAttributes: + $ref: '#/components/schemas/DashboardAttributes' + GuardianAttributes: + $ref: '#/components/schemas/GuardianAttributes' + x-stackql-resource-name: vdm_attributes + description: Resource Type definition for AWS::SES::VdmAttributes + x-type-name: AWS::SES::VdmAttributes + x-stackql-primary-identifier: + - VdmAttributesResourceId + x-read-only-properties: + - VdmAttributesResourceId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ses:PutAccountVdmAttributes + - ses:GetAccount + read: + - ses:GetAccount + update: + - ses:PutAccountVdmAttributes + - ses:GetAccount + delete: + - ses:PutAccountVdmAttributes + - ses:GetAccount + CreateConfigurationSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the configuration set. + type: string + pattern: ^[a-zA-Z0-9_-]{1,64}$ + TrackingOptions: + $ref: '#/components/schemas/TrackingOptions' + DeliveryOptions: + $ref: '#/components/schemas/DeliveryOptions' + ReputationOptions: + $ref: '#/components/schemas/ReputationOptions' + SendingOptions: + $ref: '#/components/schemas/SendingOptions' + SuppressionOptions: + $ref: '#/components/schemas/SuppressionOptions' + VdmOptions: + $ref: '#/components/schemas/VdmOptions' + Tags: + description: The tags (keys and values) associated with the contact list. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateConfigurationSetRequest + type: object + required: [] + CreateConfigurationSetEventDestinationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + ConfigurationSetName: + description: The name of the configuration set that contains the event destination. + type: string + EventDestination: + description: The event destination object. + $ref: '#/components/schemas/EventDestination' + x-stackQL-stringOnly: true + x-title: CreateConfigurationSetEventDestinationRequest + type: object + required: [] + CreateContactListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContactListName: + description: The name of the contact list. + type: string + pattern: ^[a-zA-Z0-9_-]{1,64}$ + Description: + description: The description of the contact list. + type: string + maxLength: 500 + Topics: + description: The topics associated with the contact list. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Topic' + minItems: 0 + maxItems: 20 + Tags: + description: The tags (keys and values) associated with the contact list. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateContactListRequest + type: object + required: [] + CreateDedicatedIpPoolRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PoolName: + type: string + description: The name of the dedicated IP pool. + pattern: ^[a-z0-9_-]{0,64}$ + ScalingMode: + type: string + description: Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD. + pattern: ^(STANDARD|MANAGED)$ + Tags: + description: The tags (keys and values) associated with the dedicated IP pool. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateDedicatedIpPoolRequest + type: object + required: [] + CreateEmailIdentityRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + EmailIdentity: + type: string + description: The email address or domain to verify. + ConfigurationSetAttributes: + $ref: '#/components/schemas/ConfigurationSetAttributes' + DkimSigningAttributes: + $ref: '#/components/schemas/DkimSigningAttributes' + DkimAttributes: + $ref: '#/components/schemas/DkimAttributes' + MailFromAttributes: + $ref: '#/components/schemas/MailFromAttributes' + FeedbackAttributes: + $ref: '#/components/schemas/FeedbackAttributes' + DkimDNSTokenName1: + type: string + DkimDNSTokenName2: + type: string + DkimDNSTokenName3: + type: string + DkimDNSTokenValue1: + type: string + DkimDNSTokenValue2: + type: string + DkimDNSTokenValue3: + type: string + Tags: + description: The tags (keys and values) associated with the email identity. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 50 + x-stackQL-stringOnly: true + x-title: CreateEmailIdentityRequest + type: object + required: [] + CreateMailManagerAddonInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AddonInstanceArn: + type: string + AddonInstanceId: + type: string + maxLength: 67 + minLength: 4 + pattern: ^ai-[a-zA-Z0-9]{1,64}$ + AddonName: + type: string + AddonSubscriptionId: + type: string + maxLength: 67 + minLength: 4 + pattern: ^as-[a-zA-Z0-9]{1,64}$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateMailManagerAddonInstanceRequest + type: object + required: [] + CreateMailManagerAddonSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AddonName: + type: string + AddonSubscriptionArn: + type: string + AddonSubscriptionId: + type: string + maxLength: 67 + minLength: 4 + pattern: ^as-[a-zA-Z0-9]{1,64}$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateMailManagerAddonSubscriptionRequest + type: object + required: [] + CreateMailManagerAddressListRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AddressListArn: + type: string + AddressListId: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + AddressListName: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateMailManagerAddressListRequest + type: object + required: [] + CreateMailManagerArchiveRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ArchiveArn: + type: string + ArchiveId: + type: string + maxLength: 66 + minLength: 1 + ArchiveName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$ + ArchiveState: + $ref: '#/components/schemas/ArchiveState' + KmsKeyArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$ + Retention: + $ref: '#/components/schemas/ArchiveRetention' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateMailManagerArchiveRequest + type: object + required: [] + CreateMailManagerIngressPointRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ARecord: + type: string + TrafficPolicyId: + type: string + maxLength: 100 + minLength: 1 + IngressPointConfiguration: + $ref: '#/components/schemas/IngressPointConfiguration' + IngressPointArn: + type: string + IngressPointId: + type: string + maxLength: 100 + minLength: 1 + IngressPointName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^[A-Za-z0-9_\-]+$ + NetworkConfiguration: + $ref: '#/components/schemas/NetworkConfiguration' + RuleSetId: + type: string + maxLength: 100 + minLength: 1 + Status: + $ref: '#/components/schemas/IngressPointStatus' + StatusToUpdate: + $ref: '#/components/schemas/IngressPointStatusToUpdate' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/IngressPointType' + x-stackQL-stringOnly: true + x-title: CreateMailManagerIngressPointRequest + type: object + required: [] + CreateMailManagerRelayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Authentication: + $ref: '#/components/schemas/RelayAuthentication' + RelayArn: + type: string + RelayId: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + RelayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-_]+$ + ServerName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9-\.]+$ + ServerPort: + type: number + maximum: 65535 + minimum: 1 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateMailManagerRelayRequest + type: object + required: [] + CreateMailManagerRuleSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RuleSetArn: + type: string + RuleSetId: + type: string + maxLength: 100 + minLength: 1 + RuleSetName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9_.-]+$ + Rules: + type: array + items: + $ref: '#/components/schemas/Rule' + maxItems: 40 + minItems: 0 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateMailManagerRuleSetRequest + type: object + required: [] + CreateMailManagerTrafficPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DefaultAction: + $ref: '#/components/schemas/AcceptAction' + MaxMessageSizeBytes: + type: number + minimum: 1 + PolicyStatements: + type: array + items: + $ref: '#/components/schemas/PolicyStatement' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + TrafficPolicyArn: + type: string + TrafficPolicyId: + type: string + maxLength: 100 + minLength: 1 + TrafficPolicyName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^[A-Za-z0-9_\-]+$ + x-stackQL-stringOnly: true + x-title: CreateMailManagerTrafficPolicyRequest + type: object + required: [] + CreateTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + Template: + $ref: '#/components/schemas/Template' + x-stackQL-stringOnly: true + x-title: CreateTemplateRequest + type: object + required: [] + CreateVdmAttributesRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VdmAttributesResourceId: + type: string + description: Unique identifier for this resource + DashboardAttributes: + $ref: '#/components/schemas/DashboardAttributes' + GuardianAttributes: + $ref: '#/components/schemas/GuardianAttributes' + x-stackQL-stringOnly: true + x-title: CreateVdmAttributesRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + configuration_sets: + name: configuration_sets + id: awscc.ses.configuration_sets + x-cfn-schema-name: ConfigurationSet + x-cfn-type-name: AWS::SES::ConfigurationSet + x-identifiers: + - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ConfigurationSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ConfigurationSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ConfigurationSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.TrackingOptions') as tracking_options, + JSON_EXTRACT(Properties, '$.DeliveryOptions') as delivery_options, + JSON_EXTRACT(Properties, '$.ReputationOptions') as reputation_options, + JSON_EXTRACT(Properties, '$.SendingOptions') as sending_options, + JSON_EXTRACT(Properties, '$.SuppressionOptions') as suppression_options, + JSON_EXTRACT(Properties, '$.VdmOptions') as vdm_options, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'TrackingOptions') as tracking_options, + json_extract_path_text(Properties, 'DeliveryOptions') as delivery_options, + json_extract_path_text(Properties, 'ReputationOptions') as reputation_options, + json_extract_path_text(Properties, 'SendingOptions') as sending_options, + json_extract_path_text(Properties, 'SuppressionOptions') as suppression_options, + json_extract_path_text(Properties, 'VdmOptions') as vdm_options, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + AND data__Identifier = '' + AND region = 'us-east-1' + configuration_sets_list_only: + name: configuration_sets_list_only + id: awscc.ses.configuration_sets_list_only x-cfn-schema-name: ConfigurationSet - x-type: list + x-cfn-type-name: AWS::SES::ConfigurationSet + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + AND region = 'us-east-1' + configuration_set_event_destinations: + name: configuration_set_event_destinations + id: awscc.ses.configuration_set_event_destinations + x-cfn-schema-name: ConfigurationSetEventDestination + x-cfn-type-name: AWS::SES::ConfigurationSetEventDestination + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationSetEventDestination&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ConfigurationSetEventDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ConfigurationSetEventDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ConfigurationSetEventDestination" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.ConfigurationSetName') as configuration_set_name, + JSON_EXTRACT(Properties, '$.EventDestination') as event_destination + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSetEventDestination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ConfigurationSetName') as configuration_set_name, + json_extract_path_text(Properties, 'EventDestination') as event_destination + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSetEventDestination' + AND data__Identifier = '' + AND region = 'us-east-1' + configuration_set_event_destinations_list_only: + name: configuration_set_event_destinations_list_only + id: awscc.ses.configuration_set_event_destinations_list_only + x-cfn-schema-name: ConfigurationSetEventDestination + x-cfn-type-name: AWS::SES::ConfigurationSetEventDestination + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSetEventDestination' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSetEventDestination' + AND region = 'us-east-1' + contact_lists: + name: contact_lists + id: awscc.ses.contact_lists + x-cfn-schema-name: ContactList + x-cfn-type-name: AWS::SES::ContactList + x-identifiers: + - ContactListName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContactList&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ContactList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ContactList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::ContactList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_lists/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/contact_lists/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ContactListName') as contact_list_name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Topics') as topics, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ContactList' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContactListName') as contact_list_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Topics') as topics, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ContactList' + AND data__Identifier = '' + AND region = 'us-east-1' + contact_lists_list_only: + name: contact_lists_list_only + id: awscc.ses.contact_lists_list_only + x-cfn-schema-name: ContactList + x-cfn-type-name: AWS::SES::ContactList + x-identifiers: + - ContactListName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ContactListName') as contact_list_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ContactListName') as contact_list_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' + AND region = 'us-east-1' + dedicated_ip_pools: + name: dedicated_ip_pools + id: awscc.ses.dedicated_ip_pools + x-cfn-schema-name: DedicatedIpPool + x-cfn-type-name: AWS::SES::DedicatedIpPool + x-identifiers: + - PoolName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DedicatedIpPool&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::DedicatedIpPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::DedicatedIpPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::DedicatedIpPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PoolName') as pool_name, + JSON_EXTRACT(Properties, '$.ScalingMode') as scaling_mode, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PoolName') as pool_name, + json_extract_path_text(Properties, 'ScalingMode') as scaling_mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + AND data__Identifier = '' + AND region = 'us-east-1' + dedicated_ip_pools_list_only: + name: dedicated_ip_pools_list_only + id: awscc.ses.dedicated_ip_pools_list_only + x-cfn-schema-name: DedicatedIpPool + x-cfn-type-name: AWS::SES::DedicatedIpPool + x-identifiers: + - PoolName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PoolName') as pool_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PoolName') as pool_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + AND region = 'us-east-1' + email_identities: + name: email_identities + id: awscc.ses.email_identities + x-cfn-schema-name: EmailIdentity + x-cfn-type-name: AWS::SES::EmailIdentity + x-identifiers: + - EmailIdentity + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EmailIdentity&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::EmailIdentity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::EmailIdentity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::EmailIdentity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/email_identities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/email_identities/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/email_identities/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.EmailIdentity') as email_identity, + JSON_EXTRACT(Properties, '$.ConfigurationSetAttributes') as configuration_set_attributes, + JSON_EXTRACT(Properties, '$.DkimSigningAttributes') as dkim_signing_attributes, + JSON_EXTRACT(Properties, '$.DkimAttributes') as dkim_attributes, + JSON_EXTRACT(Properties, '$.MailFromAttributes') as mail_from_attributes, + JSON_EXTRACT(Properties, '$.FeedbackAttributes') as feedback_attributes, + JSON_EXTRACT(Properties, '$.DkimDNSTokenName1') as dkim_dns_token_name1, + JSON_EXTRACT(Properties, '$.DkimDNSTokenName2') as dkim_dns_token_name2, + JSON_EXTRACT(Properties, '$.DkimDNSTokenName3') as dkim_dns_token_name3, + JSON_EXTRACT(Properties, '$.DkimDNSTokenValue1') as dkim_dns_token_value1, + JSON_EXTRACT(Properties, '$.DkimDNSTokenValue2') as dkim_dns_token_value2, + JSON_EXTRACT(Properties, '$.DkimDNSTokenValue3') as dkim_dns_token_value3, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::EmailIdentity' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EmailIdentity') as email_identity, + json_extract_path_text(Properties, 'ConfigurationSetAttributes') as configuration_set_attributes, + json_extract_path_text(Properties, 'DkimSigningAttributes') as dkim_signing_attributes, + json_extract_path_text(Properties, 'DkimAttributes') as dkim_attributes, + json_extract_path_text(Properties, 'MailFromAttributes') as mail_from_attributes, + json_extract_path_text(Properties, 'FeedbackAttributes') as feedback_attributes, + json_extract_path_text(Properties, 'DkimDNSTokenName1') as dkim_dns_token_name1, + json_extract_path_text(Properties, 'DkimDNSTokenName2') as dkim_dns_token_name2, + json_extract_path_text(Properties, 'DkimDNSTokenName3') as dkim_dns_token_name3, + json_extract_path_text(Properties, 'DkimDNSTokenValue1') as dkim_dns_token_value1, + json_extract_path_text(Properties, 'DkimDNSTokenValue2') as dkim_dns_token_value2, + json_extract_path_text(Properties, 'DkimDNSTokenValue3') as dkim_dns_token_value3, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::EmailIdentity' + AND data__Identifier = '' + AND region = 'us-east-1' + email_identities_list_only: + name: email_identities_list_only + id: awscc.ses.email_identities_list_only + x-cfn-schema-name: EmailIdentity + x-cfn-type-name: AWS::SES::EmailIdentity + x-identifiers: + - EmailIdentity + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.EmailIdentity') as email_identity + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EmailIdentity') as email_identity + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' + AND region = 'us-east-1' + mail_manager_addon_instances: + name: mail_manager_addon_instances + id: awscc.ses.mail_manager_addon_instances + x-cfn-schema-name: MailManagerAddonInstance + x-cfn-type-name: AWS::SES::MailManagerAddonInstance + x-identifiers: + - AddonInstanceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerAddonInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddonInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddonInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddonInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_addon_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_addon_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_addon_instances/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AddonInstanceArn') as addon_instance_arn, + JSON_EXTRACT(Properties, '$.AddonInstanceId') as addon_instance_id, + JSON_EXTRACT(Properties, '$.AddonName') as addon_name, + JSON_EXTRACT(Properties, '$.AddonSubscriptionId') as addon_subscription_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerAddonInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AddonInstanceArn') as addon_instance_arn, + json_extract_path_text(Properties, 'AddonInstanceId') as addon_instance_id, + json_extract_path_text(Properties, 'AddonName') as addon_name, + json_extract_path_text(Properties, 'AddonSubscriptionId') as addon_subscription_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerAddonInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + mail_manager_addon_instances_list_only: + name: mail_manager_addon_instances_list_only + id: awscc.ses.mail_manager_addon_instances_list_only + x-cfn-schema-name: MailManagerAddonInstance + x-cfn-type-name: AWS::SES::MailManagerAddonInstance + x-identifiers: + - AddonInstanceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AddonInstanceId') as addon_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerAddonInstance' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AddonInstanceId') as addon_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerAddonInstance' + AND region = 'us-east-1' + mail_manager_addon_subscriptions: + name: mail_manager_addon_subscriptions + id: awscc.ses.mail_manager_addon_subscriptions + x-cfn-schema-name: MailManagerAddonSubscription + x-cfn-type-name: AWS::SES::MailManagerAddonSubscription + x-identifiers: + - AddonSubscriptionId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerAddonSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddonSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddonSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddonSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_addon_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_addon_subscriptions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_addon_subscriptions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AddonName') as addon_name, + JSON_EXTRACT(Properties, '$.AddonSubscriptionArn') as addon_subscription_arn, + JSON_EXTRACT(Properties, '$.AddonSubscriptionId') as addon_subscription_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerAddonSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AddonName') as addon_name, + json_extract_path_text(Properties, 'AddonSubscriptionArn') as addon_subscription_arn, + json_extract_path_text(Properties, 'AddonSubscriptionId') as addon_subscription_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerAddonSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + mail_manager_addon_subscriptions_list_only: + name: mail_manager_addon_subscriptions_list_only + id: awscc.ses.mail_manager_addon_subscriptions_list_only + x-cfn-schema-name: MailManagerAddonSubscription + x-cfn-type-name: AWS::SES::MailManagerAddonSubscription x-identifiers: - - Name + - AddonSubscriptionId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -575,65 +4117,113 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + JSON_EXTRACT(Properties, '$.AddonSubscriptionId') as addon_subscription_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerAddonSubscription' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + json_extract_path_text(Properties, 'AddonSubscriptionId') as addon_subscription_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerAddonSubscription' AND region = 'us-east-1' - configuration_set: - name: configuration_set - id: awscc.ses.configuration_set - x-cfn-schema-name: ConfigurationSet - x-type: get + mail_manager_address_lists: + name: mail_manager_address_lists + id: awscc.ses.mail_manager_address_lists + x-cfn-schema-name: MailManagerAddressList + x-cfn-type-name: AWS::SES::MailManagerAddressList x-identifiers: - - Name + - AddressListId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerAddressList&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddressList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddressList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerAddressList" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_address_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_address_lists/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_address_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.TrackingOptions') as tracking_options, - JSON_EXTRACT(Properties, '$.DeliveryOptions') as delivery_options, - JSON_EXTRACT(Properties, '$.ReputationOptions') as reputation_options, - JSON_EXTRACT(Properties, '$.SendingOptions') as sending_options, - JSON_EXTRACT(Properties, '$.SuppressionOptions') as suppression_options, - JSON_EXTRACT(Properties, '$.VdmOptions') as vdm_options - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AddressListArn') as address_list_arn, + JSON_EXTRACT(Properties, '$.AddressListId') as address_list_id, + JSON_EXTRACT(Properties, '$.AddressListName') as address_list_name, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerAddressList' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'TrackingOptions') as tracking_options, - json_extract_path_text(Properties, 'DeliveryOptions') as delivery_options, - json_extract_path_text(Properties, 'ReputationOptions') as reputation_options, - json_extract_path_text(Properties, 'SendingOptions') as sending_options, - json_extract_path_text(Properties, 'SuppressionOptions') as suppression_options, - json_extract_path_text(Properties, 'VdmOptions') as vdm_options - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSet' - AND data__Identifier = '' + json_extract_path_text(Properties, 'AddressListArn') as address_list_arn, + json_extract_path_text(Properties, 'AddressListId') as address_list_id, + json_extract_path_text(Properties, 'AddressListName') as address_list_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerAddressList' + AND data__Identifier = '' AND region = 'us-east-1' - configuration_set_event_destination: - name: configuration_set_event_destination - id: awscc.ses.configuration_set_event_destination - x-cfn-schema-name: ConfigurationSetEventDestination - x-type: get + mail_manager_address_lists_list_only: + name: mail_manager_address_lists_list_only + id: awscc.ses.mail_manager_address_lists_list_only + x-cfn-schema-name: MailManagerAddressList + x-cfn-type-name: AWS::SES::MailManagerAddressList x-identifiers: - - Id + - AddressListId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -641,32 +4231,119 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.ConfigurationSetName') as configuration_set_name, - JSON_EXTRACT(Properties, '$.EventDestination') as event_destination - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSetEventDestination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AddressListId') as address_list_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerAddressList' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AddressListId') as address_list_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerAddressList' + AND region = 'us-east-1' + mail_manager_archives: + name: mail_manager_archives + id: awscc.ses.mail_manager_archives + x-cfn-schema-name: MailManagerArchive + x-cfn-type-name: AWS::SES::MailManagerArchive + x-identifiers: + - ArchiveId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerArchive&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerArchive" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerArchive" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerArchive" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_archives/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_archives/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_archives/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ArchiveArn') as archive_arn, + JSON_EXTRACT(Properties, '$.ArchiveId') as archive_id, + JSON_EXTRACT(Properties, '$.ArchiveName') as archive_name, + JSON_EXTRACT(Properties, '$.ArchiveState') as archive_state, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, + JSON_EXTRACT(Properties, '$.Retention') as retention, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerArchive' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ConfigurationSetName') as configuration_set_name, - json_extract_path_text(Properties, 'EventDestination') as event_destination - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSetEventDestination' - AND data__Identifier = '' + json_extract_path_text(Properties, 'ArchiveArn') as archive_arn, + json_extract_path_text(Properties, 'ArchiveId') as archive_id, + json_extract_path_text(Properties, 'ArchiveName') as archive_name, + json_extract_path_text(Properties, 'ArchiveState') as archive_state, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Retention') as retention, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerArchive' + AND data__Identifier = '' AND region = 'us-east-1' - contact_lists: - name: contact_lists - id: awscc.ses.contact_lists - x-cfn-schema-name: ContactList - x-type: list + mail_manager_archives_list_only: + name: mail_manager_archives_list_only + id: awscc.ses.mail_manager_archives_list_only + x-cfn-schema-name: MailManagerArchive + x-cfn-type-name: AWS::SES::MailManagerArchive x-identifiers: - - ContactListName + - ArchiveId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -674,59 +4351,249 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ContactListName') as contact_list_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' + JSON_EXTRACT(Properties, '$.ArchiveId') as archive_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerArchive' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ContactListName') as contact_list_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' + json_extract_path_text(Properties, 'ArchiveId') as archive_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerArchive' AND region = 'us-east-1' - contact_list: - name: contact_list - id: awscc.ses.contact_list - x-cfn-schema-name: ContactList - x-type: get + mail_manager_ingress_points: + name: mail_manager_ingress_points + id: awscc.ses.mail_manager_ingress_points + x-cfn-schema-name: MailManagerIngressPoint + x-cfn-type-name: AWS::SES::MailManagerIngressPoint x-identifiers: - - ContactListName + - IngressPointId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerIngressPoint&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerIngressPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerIngressPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerIngressPoint" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_ingress_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_ingress_points/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_ingress_points/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ARecord') as a_record, + JSON_EXTRACT(Properties, '$.TrafficPolicyId') as traffic_policy_id, + JSON_EXTRACT(Properties, '$.IngressPointConfiguration') as ingress_point_configuration, + JSON_EXTRACT(Properties, '$.IngressPointArn') as ingress_point_arn, + JSON_EXTRACT(Properties, '$.IngressPointId') as ingress_point_id, + JSON_EXTRACT(Properties, '$.IngressPointName') as ingress_point_name, + JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, + JSON_EXTRACT(Properties, '$.RuleSetId') as rule_set_id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusToUpdate') as status_to_update, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerIngressPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ARecord') as a_record, + json_extract_path_text(Properties, 'TrafficPolicyId') as traffic_policy_id, + json_extract_path_text(Properties, 'IngressPointConfiguration') as ingress_point_configuration, + json_extract_path_text(Properties, 'IngressPointArn') as ingress_point_arn, + json_extract_path_text(Properties, 'IngressPointId') as ingress_point_id, + json_extract_path_text(Properties, 'IngressPointName') as ingress_point_name, + json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, + json_extract_path_text(Properties, 'RuleSetId') as rule_set_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusToUpdate') as status_to_update, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerIngressPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + mail_manager_ingress_points_list_only: + name: mail_manager_ingress_points_list_only + id: awscc.ses.mail_manager_ingress_points_list_only + x-cfn-schema-name: MailManagerIngressPoint + x-cfn-type-name: AWS::SES::MailManagerIngressPoint + x-identifiers: + - IngressPointId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.IngressPointId') as ingress_point_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerIngressPoint' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IngressPointId') as ingress_point_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerIngressPoint' + AND region = 'us-east-1' + mail_manager_relays: + name: mail_manager_relays + id: awscc.ses.mail_manager_relays + x-cfn-schema-name: MailManagerRelay + x-cfn-type-name: AWS::SES::MailManagerRelay + x-identifiers: + - RelayId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerRelay&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerRelay" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerRelay" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerRelay" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_relays/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_relays/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_relays/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ContactListName') as contact_list_name, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Topics') as topics, + JSON_EXTRACT(Properties, '$.Authentication') as authentication, + JSON_EXTRACT(Properties, '$.RelayArn') as relay_arn, + JSON_EXTRACT(Properties, '$.RelayId') as relay_id, + JSON_EXTRACT(Properties, '$.RelayName') as relay_name, + JSON_EXTRACT(Properties, '$.ServerName') as server_name, + JSON_EXTRACT(Properties, '$.ServerPort') as server_port, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ContactList' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerRelay' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ContactListName') as contact_list_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Topics') as topics, + json_extract_path_text(Properties, 'Authentication') as authentication, + json_extract_path_text(Properties, 'RelayArn') as relay_arn, + json_extract_path_text(Properties, 'RelayId') as relay_id, + json_extract_path_text(Properties, 'RelayName') as relay_name, + json_extract_path_text(Properties, 'ServerName') as server_name, + json_extract_path_text(Properties, 'ServerPort') as server_port, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ContactList' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerRelay' + AND data__Identifier = '' AND region = 'us-east-1' - dedicated_ip_pools: - name: dedicated_ip_pools - id: awscc.ses.dedicated_ip_pools - x-cfn-schema-name: DedicatedIpPool - x-type: list + mail_manager_relays_list_only: + name: mail_manager_relays_list_only + id: awscc.ses.mail_manager_relays_list_only + x-cfn-schema-name: MailManagerRelay + x-cfn-type-name: AWS::SES::MailManagerRelay x-identifiers: - - PoolName + - RelayId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -734,55 +4601,115 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PoolName') as pool_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + JSON_EXTRACT(Properties, '$.RelayId') as relay_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerRelay' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PoolName') as pool_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + json_extract_path_text(Properties, 'RelayId') as relay_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerRelay' AND region = 'us-east-1' - dedicated_ip_pool: - name: dedicated_ip_pool - id: awscc.ses.dedicated_ip_pool - x-cfn-schema-name: DedicatedIpPool - x-type: get + mail_manager_rule_sets: + name: mail_manager_rule_sets + id: awscc.ses.mail_manager_rule_sets + x-cfn-schema-name: MailManagerRuleSet + x-cfn-type-name: AWS::SES::MailManagerRuleSet x-identifiers: - - PoolName + - RuleSetId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerRuleSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerRuleSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerRuleSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerRuleSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_rule_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_rule_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_rule_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.PoolName') as pool_name, - JSON_EXTRACT(Properties, '$.ScalingMode') as scaling_mode - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RuleSetArn') as rule_set_arn, + JSON_EXTRACT(Properties, '$.RuleSetId') as rule_set_id, + JSON_EXTRACT(Properties, '$.RuleSetName') as rule_set_name, + JSON_EXTRACT(Properties, '$.Rules') as rules, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerRuleSet' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'PoolName') as pool_name, - json_extract_path_text(Properties, 'ScalingMode') as scaling_mode - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' - AND data__Identifier = '' + json_extract_path_text(Properties, 'RuleSetArn') as rule_set_arn, + json_extract_path_text(Properties, 'RuleSetId') as rule_set_id, + json_extract_path_text(Properties, 'RuleSetName') as rule_set_name, + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerRuleSet' + AND data__Identifier = '' AND region = 'us-east-1' - email_identities: - name: email_identities - id: awscc.ses.email_identities - x-cfn-schema-name: EmailIdentity - x-type: list + mail_manager_rule_sets_list_only: + name: mail_manager_rule_sets_list_only + id: awscc.ses.mail_manager_rule_sets_list_only + x-cfn-schema-name: MailManagerRuleSet + x-cfn-type-name: AWS::SES::MailManagerRuleSet x-identifiers: - - EmailIdentity + - RuleSetId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -790,75 +4717,119 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.EmailIdentity') as email_identity - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' + JSON_EXTRACT(Properties, '$.RuleSetId') as rule_set_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerRuleSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'EmailIdentity') as email_identity - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' + json_extract_path_text(Properties, 'RuleSetId') as rule_set_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerRuleSet' AND region = 'us-east-1' - email_identity: - name: email_identity - id: awscc.ses.email_identity - x-cfn-schema-name: EmailIdentity - x-type: get + mail_manager_traffic_policies: + name: mail_manager_traffic_policies + id: awscc.ses.mail_manager_traffic_policies + x-cfn-schema-name: MailManagerTrafficPolicy + x-cfn-type-name: AWS::SES::MailManagerTrafficPolicy x-identifiers: - - EmailIdentity + - TrafficPolicyId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MailManagerTrafficPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerTrafficPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerTrafficPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::MailManagerTrafficPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mail_manager_traffic_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mail_manager_traffic_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/mail_manager_traffic_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.EmailIdentity') as email_identity, - JSON_EXTRACT(Properties, '$.ConfigurationSetAttributes') as configuration_set_attributes, - JSON_EXTRACT(Properties, '$.DkimSigningAttributes') as dkim_signing_attributes, - JSON_EXTRACT(Properties, '$.DkimAttributes') as dkim_attributes, - JSON_EXTRACT(Properties, '$.MailFromAttributes') as mail_from_attributes, - JSON_EXTRACT(Properties, '$.FeedbackAttributes') as feedback_attributes, - JSON_EXTRACT(Properties, '$.DkimDNSTokenName1') as dkim_dns_token_name1, - JSON_EXTRACT(Properties, '$.DkimDNSTokenName2') as dkim_dns_token_name2, - JSON_EXTRACT(Properties, '$.DkimDNSTokenName3') as dkim_dns_token_name3, - JSON_EXTRACT(Properties, '$.DkimDNSTokenValue1') as dkim_dns_token_value1, - JSON_EXTRACT(Properties, '$.DkimDNSTokenValue2') as dkim_dns_token_value2, - JSON_EXTRACT(Properties, '$.DkimDNSTokenValue3') as dkim_dns_token_value3 - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::EmailIdentity' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DefaultAction') as default_action, + JSON_EXTRACT(Properties, '$.MaxMessageSizeBytes') as max_message_size_bytes, + JSON_EXTRACT(Properties, '$.PolicyStatements') as policy_statements, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TrafficPolicyArn') as traffic_policy_arn, + JSON_EXTRACT(Properties, '$.TrafficPolicyId') as traffic_policy_id, + JSON_EXTRACT(Properties, '$.TrafficPolicyName') as traffic_policy_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerTrafficPolicy' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'EmailIdentity') as email_identity, - json_extract_path_text(Properties, 'ConfigurationSetAttributes') as configuration_set_attributes, - json_extract_path_text(Properties, 'DkimSigningAttributes') as dkim_signing_attributes, - json_extract_path_text(Properties, 'DkimAttributes') as dkim_attributes, - json_extract_path_text(Properties, 'MailFromAttributes') as mail_from_attributes, - json_extract_path_text(Properties, 'FeedbackAttributes') as feedback_attributes, - json_extract_path_text(Properties, 'DkimDNSTokenName1') as dkim_dns_token_name1, - json_extract_path_text(Properties, 'DkimDNSTokenName2') as dkim_dns_token_name2, - json_extract_path_text(Properties, 'DkimDNSTokenName3') as dkim_dns_token_name3, - json_extract_path_text(Properties, 'DkimDNSTokenValue1') as dkim_dns_token_value1, - json_extract_path_text(Properties, 'DkimDNSTokenValue2') as dkim_dns_token_value2, - json_extract_path_text(Properties, 'DkimDNSTokenValue3') as dkim_dns_token_value3 - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::EmailIdentity' - AND data__Identifier = '' + json_extract_path_text(Properties, 'DefaultAction') as default_action, + json_extract_path_text(Properties, 'MaxMessageSizeBytes') as max_message_size_bytes, + json_extract_path_text(Properties, 'PolicyStatements') as policy_statements, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrafficPolicyArn') as traffic_policy_arn, + json_extract_path_text(Properties, 'TrafficPolicyId') as traffic_policy_id, + json_extract_path_text(Properties, 'TrafficPolicyName') as traffic_policy_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::MailManagerTrafficPolicy' + AND data__Identifier = '' AND region = 'us-east-1' - templates: - name: templates - id: awscc.ses.templates - x-cfn-schema-name: Template - x-type: list + mail_manager_traffic_policies_list_only: + name: mail_manager_traffic_policies_list_only + id: awscc.ses.mail_manager_traffic_policies_list_only + x-cfn-schema-name: MailManagerTrafficPolicy + x-cfn-type-name: AWS::SES::MailManagerTrafficPolicy x-identifiers: - - Id + - TrafficPolicyId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -866,28 +4837,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' + JSON_EXTRACT(Properties, '$.TrafficPolicyId') as traffic_policy_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerTrafficPolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' + json_extract_path_text(Properties, 'TrafficPolicyId') as traffic_policy_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::MailManagerTrafficPolicy' AND region = 'us-east-1' - template: - name: template - id: awscc.ses.template + templates: + name: templates + id: awscc.ses.templates x-cfn-schema-name: Template - x-type: get + x-cfn-type-name: AWS::SES::Template x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Template&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::Template" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -898,7 +4917,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -908,17 +4927,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::Template' AND data__Identifier = '' AND region = 'us-east-1' + templates_list_only: + name: templates_list_only + id: awscc.ses.templates_list_only + x-cfn-schema-name: Template + x-cfn-type-name: AWS::SES::Template + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' + AND region = 'us-east-1' vdm_attributes: name: vdm_attributes id: awscc.ses.vdm_attributes x-cfn-schema-name: VdmAttributes - x-type: get + x-cfn-type-name: AWS::SES::VdmAttributes x-identifiers: - VdmAttributesResourceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VdmAttributes&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::VdmAttributes" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::VdmAttributes" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::VdmAttributes" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vdm_attributes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vdm_attributes/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vdm_attributes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -930,7 +5028,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -941,3 +5039,786 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SES::VdmAttributes' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationSetEventDestination&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationSetEventDestination + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationSetEventDestinationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContactList&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContactList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContactListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DedicatedIpPool&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDedicatedIpPool + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDedicatedIpPoolRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__EmailIdentity&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEmailIdentity + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEmailIdentityRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerAddonInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerAddonInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerAddonInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerAddonSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerAddonSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerAddonSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerAddressList&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerAddressList + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerAddressListRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerArchive&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerArchive + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerArchiveRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerIngressPoint&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerIngressPoint + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerIngressPointRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerRelay&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerRelay + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerRelayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerRuleSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerRuleSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerRuleSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MailManagerTrafficPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMailManagerTrafficPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMailManagerTrafficPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Template&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VdmAttributes&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVdmAttributes + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVdmAttributesRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/shield.yaml b/providers/src/awscc/v00.00.00000/services/shield.yaml index eecf9cca..ee06912c 100644 --- a/providers/src/awscc/v00.00.00000/services/shield.yaml +++ b/providers/src/awscc/v00.00.00000/services/shield.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Shield - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: DRTAccess: type: object @@ -27,10 +407,16 @@ components: required: - RoleArn x-stackql-resource-name: drt_access - x-stackql-primaryIdentifier: + description: Config the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation. + x-type-name: AWS::Shield::DRTAccess + x-stackql-primary-identifier: - AccountId x-read-only-properties: - AccountId + x-required-properties: + - RoleArn + x-tagging: + taggable: false x-required-permissions: create: - shield:DescribeDRTAccess @@ -65,7 +451,8 @@ components: - s3:GetBucketPolicy - s3:PutBucketPolicy - s3:DeleteBucketPolicy - list: [] + list: + - shield:DescribeDRTAccess EmergencyContact: description: An emergency contact is used by Shield Response Team (SRT) to contact you for escalations to the SRT and to initiate proactive customer support. An emergency contact requires an email address. type: object @@ -118,10 +505,17 @@ components: - ProactiveEngagementStatus - EmergencyContactList x-stackql-resource-name: proactive_engagement - x-stackql-primaryIdentifier: + description: Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. + x-type-name: AWS::Shield::ProactiveEngagement + x-stackql-primary-identifier: - AccountId x-read-only-properties: - AccountId + x-required-properties: + - ProactiveEngagementStatus + - EmergencyContactList + x-tagging: + taggable: false x-required-permissions: create: - shield:DescribeSubscription @@ -244,7 +638,9 @@ components: - Name - ResourceArn x-stackql-resource-name: protection - x-stackql-primaryIdentifier: + description: Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses. + x-type-name: AWS::Shield::Protection + x-stackql-primary-identifier: - ProtectionArn x-create-only-properties: - Name @@ -252,6 +648,20 @@ components: x-read-only-properties: - ProtectionId - ProtectionArn + x-required-properties: + - Name + - ResourceArn + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - shield:ListTagsForResource + - shield:UntagResource + - shield:TagResource x-required-permissions: create: - shield:CreateProtection @@ -352,12 +762,29 @@ components: - Pattern - ProtectionGroupId x-stackql-resource-name: protection_group - x-stackql-primaryIdentifier: + description: A grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives. + x-type-name: AWS::Shield::ProtectionGroup + x-stackql-primary-identifier: - ProtectionGroupArn x-create-only-properties: - ProtectionGroupId x-read-only-properties: - ProtectionGroupArn + x-required-properties: + - Aggregation + - Pattern + - ProtectionGroupId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - shield:ListTagsForResource + - shield:UntagResource + - shield:TagResource x-required-permissions: create: - shield:CreateProtectionGroup @@ -375,43 +802,265 @@ components: - shield:UntagResource list: - shield:ListProtectionGroups + CreateDRTAccessRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + type: string + LogBucketList: + description: Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription. + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 10 + items: + type: string + minLength: 3 + maxLength: 63 + RoleArn: + description: Authorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs. + type: string + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreateDRTAccessRequest + type: object + required: [] + CreateProactiveEngagementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + type: string + ProactiveEngagementStatus: + description: |- + If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. + If `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support. + type: string + enum: + - ENABLED + - DISABLED + EmergencyContactList: + description: |- + A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support. + To enable proactive engagement, the contact list must include at least one phone number. + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/EmergencyContact' + x-stackQL-stringOnly: true + x-title: CreateProactiveEngagementRequest + type: object + required: [] + CreateProtectionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProtectionId: + description: The unique identifier (ID) of the protection. + type: string + ProtectionArn: + description: The ARN (Amazon Resource Name) of the protection. + type: string + Name: + description: Friendly name for the Protection. + type: string + minLength: 1 + maxLength: 128 + pattern: '[ a-zA-Z0-9_\.\-]*' + ResourceArn: + description: The ARN (Amazon Resource Name) of the resource to be protected. + type: string + minLength: 1 + maxLength: 2048 + HealthCheckArns: + description: The Amazon Resource Names (ARNs) of the health check to associate with the protection. + type: array + x-insertionOrder: false + maxItems: 1 + items: + type: string + minLength: 1 + maxLength: 2048 + ApplicationLayerAutomaticResponseConfiguration: + $ref: '#/components/schemas/ApplicationLayerAutomaticResponseConfiguration' + Tags: + description: One or more tag key-value pairs for the Protection object. + type: array + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateProtectionRequest + type: object + required: [] + CreateProtectionGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProtectionGroupId: + description: The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. + type: string + pattern: '[a-zA-Z0-9\-]*' + minLength: 1 + maxLength: 36 + ProtectionGroupArn: + description: The ARN (Amazon Resource Name) of the protection group. + type: string + Aggregation: + description: |- + Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events. + * Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically. + * Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers. + * Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions. + type: string + enum: + - SUM + - MEAN + - MAX + Pattern: + description: The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type. + type: string + enum: + - ALL + - ARBITRARY + - BY_RESOURCE_TYPE + Members: + description: The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set `Pattern` to `ARBITRARY` and you must not set it for any other `Pattern` setting. + type: array + x-insertionOrder: false + maxItems: 10000 + items: + type: string + minLength: 1 + maxLength: 2048 + ResourceType: + description: The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting. + type: string + enum: + - CLOUDFRONT_DISTRIBUTION + - ROUTE_53_HOSTED_ZONE + - ELASTIC_IP_ALLOCATION + - CLASSIC_LOAD_BALANCER + - APPLICATION_LOAD_BALANCER + - GLOBAL_ACCELERATOR + Tags: + description: One or more tag key-value pairs for the Protection object. + type: array + x-insertionOrder: false + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateProtectionGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: drt_accesses: name: drt_accesses id: awscc.shield.drt_accesses x-cfn-schema-name: DRTAccess - x-type: list - x-identifiers: - - AccountId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::DRTAccess' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::DRTAccess' - AND region = 'us-east-1' - drt_access: - name: drt_access - id: awscc.shield.drt_access - x-cfn-schema-name: DRTAccess - x-type: get + x-cfn-type-name: AWS::Shield::DRTAccess x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DRTAccess&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::DRTAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::DRTAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::DRTAccess" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -423,7 +1072,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -434,13 +1083,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::DRTAccess' AND data__Identifier = '' AND region = 'us-east-1' - proactive_engagements: - name: proactive_engagements - id: awscc.shield.proactive_engagements - x-cfn-schema-name: ProactiveEngagement - x-type: list + drt_accesses_list_only: + name: drt_accesses_list_only + id: awscc.shield.drt_accesses_list_only + x-cfn-schema-name: DRTAccess + x-cfn-type-name: AWS::Shield::DRTAccess x-identifiers: - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -449,7 +1104,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::DRTAccess' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -457,19 +1112,67 @@ components: SELECT region, json_extract_path_text(Properties, 'AccountId') as account_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::DRTAccess' AND region = 'us-east-1' - proactive_engagement: - name: proactive_engagement - id: awscc.shield.proactive_engagement + proactive_engagements: + name: proactive_engagements + id: awscc.shield.proactive_engagements x-cfn-schema-name: ProactiveEngagement - x-type: get + x-cfn-type-name: AWS::Shield::ProactiveEngagement x-identifiers: - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProactiveEngagement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::ProactiveEngagement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::ProactiveEngagement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::ProactiveEngagement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -481,7 +1184,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -492,13 +1195,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' AND data__Identifier = '' AND region = 'us-east-1' - protections: - name: protections - id: awscc.shield.protections - x-cfn-schema-name: Protection - x-type: list + proactive_engagements_list_only: + name: proactive_engagements_list_only + id: awscc.shield.proactive_engagements_list_only + x-cfn-schema-name: ProactiveEngagement + x-cfn-type-name: AWS::Shield::ProactiveEngagement x-identifiers: - - ProtectionArn + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -506,28 +1215,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProtectionArn') as protection_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProtectionArn') as protection_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' AND region = 'us-east-1' - protection: - name: protection - id: awscc.shield.protection + protections: + name: protections + id: awscc.shield.protections x-cfn-schema-name: Protection - x-type: get + x-cfn-type-name: AWS::Shield::Protection x-identifiers: - ProtectionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Protection&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::Protection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::Protection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::Protection" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/protections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/protections/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/protections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -543,7 +1300,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -558,13 +1315,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::Protection' AND data__Identifier = '' AND region = 'us-east-1' - protection_groups: - name: protection_groups - id: awscc.shield.protection_groups - x-cfn-schema-name: ProtectionGroup - x-type: list + protections_list_only: + name: protections_list_only + id: awscc.shield.protections_list_only + x-cfn-schema-name: Protection + x-cfn-type-name: AWS::Shield::Protection x-identifiers: - - ProtectionGroupArn + - ProtectionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -572,28 +1335,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProtectionGroupArn') as protection_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' + JSON_EXTRACT(Properties, '$.ProtectionArn') as protection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProtectionGroupArn') as protection_group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' + json_extract_path_text(Properties, 'ProtectionArn') as protection_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' AND region = 'us-east-1' - protection_group: - name: protection_group - id: awscc.shield.protection_group + protection_groups: + name: protection_groups + id: awscc.shield.protection_groups x-cfn-schema-name: ProtectionGroup - x-type: get + x-cfn-type-name: AWS::Shield::ProtectionGroup x-identifiers: - ProtectionGroupArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProtectionGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::ProtectionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::ProtectionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Shield::ProtectionGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/protection_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/protection_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/protection_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -609,7 +1420,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -624,3 +1435,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' AND data__Identifier = '' AND region = 'us-east-1' + protection_groups_list_only: + name: protection_groups_list_only + id: awscc.shield.protection_groups_list_only + x-cfn-schema-name: ProtectionGroup + x-cfn-type-name: AWS::Shield::ProtectionGroup + x-identifiers: + - ProtectionGroupArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ProtectionGroupArn') as protection_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProtectionGroupArn') as protection_group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DRTAccess&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDRTAccess + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDRTAccessRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProactiveEngagement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProactiveEngagement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProactiveEngagementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Protection&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProtection + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProtectionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProtectionGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProtectionGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProtectionGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/signer.yaml b/providers/src/awscc/v00.00.00000/services/signer.yaml index dc9a6c23..114864a0 100644 --- a/providers/src/awscc/v00.00.00000/services/signer.yaml +++ b/providers/src/awscc/v00.00.00000/services/signer.yaml @@ -1,15 +1,396 @@ openapi: 3.0.0 info: title: Signer - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ProfilePermission: type: object properties: ProfileName: type: string + pattern: ^[0-9a-zA-Z_]{2,64}$ ProfileVersion: type: string pattern: ^[0-9a-zA-Z]{10}$ @@ -25,7 +406,9 @@ components: - Principal - StatementId x-stackql-resource-name: profile_permission - x-stackql-primaryIdentifier: + description: An example resource schema demonstrating some basic constructs and validation rules. + x-type-name: AWS::Signer::ProfilePermission + x-stackql-primary-identifier: - StatementId - ProfileName x-create-only-properties: @@ -34,6 +417,16 @@ components: - Principal - StatementId - ProfileVersion + x-required-properties: + - ProfileName + - Action + - Principal + - StatementId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - signer:AddProfilePermission @@ -54,6 +447,11 @@ components: Arn: type: string pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + ProfileName: + type: string + minLength: 2 + maxLength: 64 + pattern: ^[0-9a-zA-Z_]{2,64}$ ProfileVersion: type: string pattern: ^[0-9a-zA-Z]{10}$ @@ -86,8 +484,8 @@ components: type: object properties: ProfileName: - description: 'A name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. ' - type: string + description: 'A name for the signing profile. If you don''t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. ' + $ref: '#/components/schemas/ProfileName' ProfileVersion: description: A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name. $ref: '#/components/schemas/ProfileVersion' @@ -111,9 +509,15 @@ components: required: - PlatformId x-stackql-resource-name: signing_profile - x-stackql-primaryIdentifier: + description: A signing profile is a signing template that can be used to carry out a pre-defined signing job. + x-type-name: AWS::Signer::SigningProfile + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ProfileName + - - ProfileVersionArn x-create-only-properties: + - ProfileName - PlatformId - SignatureValidityPeriod x-read-only-properties: @@ -121,6 +525,18 @@ components: - ProfileVersion - Arn - ProfileVersionArn + x-required-properties: + - PlatformId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - signer:TagResource + - signer:UntagResource + - signer:ListTagsForResource x-required-permissions: create: - signer:PutSigningProfile @@ -136,47 +552,130 @@ components: - signer:TagResource - signer:UntagResource - signer:GetSigningProfile + CreateProfilePermissionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProfileName: + type: string + pattern: ^[0-9a-zA-Z_]{2,64}$ + ProfileVersion: + type: string + pattern: ^[0-9a-zA-Z]{10}$ + Action: + type: string + Principal: + type: string + StatementId: + type: string + x-stackQL-stringOnly: true + x-title: CreateProfilePermissionRequest + type: object + required: [] + CreateSigningProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProfileName: + description: 'A name for the signing profile. If you don''t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. ' + $ref: '#/components/schemas/ProfileName' + ProfileVersion: + description: A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name. + $ref: '#/components/schemas/ProfileVersion' + Arn: + description: The Amazon Resource Name (ARN) of the specified signing profile. + $ref: '#/components/schemas/Arn' + ProfileVersionArn: + description: The Amazon Resource Name (ARN) of the specified signing profile version. + $ref: '#/components/schemas/Arn' + SignatureValidityPeriod: + description: Signature validity period of the profile. + $ref: '#/components/schemas/SignatureValidityPeriod' + PlatformId: + description: The ID of the target signing platform. + $ref: '#/components/schemas/PlatformId' + Tags: + type: array + description: A list of tags associated with the signing profile. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSigningProfileRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: profile_permissions: name: profile_permissions id: awscc.signer.profile_permissions x-cfn-schema-name: ProfilePermission - x-type: list - x-identifiers: - - StatementId - - ProfileName - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StatementId') as statement_id, - JSON_EXTRACT(Properties, '$.ProfileName') as profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StatementId') as statement_id, - json_extract_path_text(Properties, 'ProfileName') as profile_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' - AND region = 'us-east-1' - profile_permission: - name: profile_permission - id: awscc.signer.profile_permission - x-cfn-schema-name: ProfilePermission - x-type: get + x-cfn-type-name: AWS::Signer::ProfilePermission x-identifiers: - StatementId - ProfileName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProfilePermission&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Signer::ProfilePermission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Signer::ProfilePermission" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profile_permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profile_permissions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -190,7 +689,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -203,13 +702,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Signer::ProfilePermission' AND data__Identifier = '|' AND region = 'us-east-1' - signing_profiles: - name: signing_profiles - id: awscc.signer.signing_profiles - x-cfn-schema-name: SigningProfile - x-type: list + profile_permissions_list_only: + name: profile_permissions_list_only + id: awscc.signer.profile_permissions_list_only + x-cfn-schema-name: ProfilePermission + x-cfn-type-name: AWS::Signer::ProfilePermission x-identifiers: - - Arn + - StatementId + - ProfileName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -217,28 +723,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' + JSON_EXTRACT(Properties, '$.StatementId') as statement_id, + JSON_EXTRACT(Properties, '$.ProfileName') as profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' + json_extract_path_text(Properties, 'StatementId') as statement_id, + json_extract_path_text(Properties, 'ProfileName') as profile_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' AND region = 'us-east-1' - signing_profile: - name: signing_profile - id: awscc.signer.signing_profile + signing_profiles: + name: signing_profiles + id: awscc.signer.signing_profiles x-cfn-schema-name: SigningProfile - x-type: get + x-cfn-type-name: AWS::Signer::SigningProfile x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SigningProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Signer::SigningProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Signer::SigningProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Signer::SigningProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -254,7 +810,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -269,3 +825,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Signer::SigningProfile' AND data__Identifier = '' AND region = 'us-east-1' + signing_profiles_list_only: + name: signing_profiles_list_only + id: awscc.signer.signing_profiles_list_only + x-cfn-schema-name: SigningProfile + x-cfn-type-name: AWS::Signer::SigningProfile + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProfilePermission&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfilePermission + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfilePermissionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SigningProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSigningProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSigningProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/simspaceweaver.yaml b/providers/src/awscc/v00.00.00000/services/simspaceweaver.yaml index a1420acf..e1baca89 100644 --- a/providers/src/awscc/v00.00.00000/services/simspaceweaver.yaml +++ b/providers/src/awscc/v00.00.00000/services/simspaceweaver.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: SimSpaceWeaver - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: S3Location: type: object @@ -51,7 +431,9 @@ components: - Name - RoleArn x-stackql-resource-name: simulation - x-stackql-primaryIdentifier: + description: AWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation. + x-type-name: AWS::SimSpaceWeaver::Simulation + x-stackql-primary-identifier: - Name x-create-only-properties: - Name @@ -61,6 +443,14 @@ components: - MaximumDuration x-read-only-properties: - DescribePayload + x-required-properties: + - Name + - RoleArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - simspaceweaver:StartSimulation @@ -80,43 +470,111 @@ components: - simspaceweaver:DescribeSimulation list: - simspaceweaver:ListSimulations + CreateSimulationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name of the simulation. + type: string + minLength: 1 + maxLength: 2048 + pattern: '[a-zA-Z0-9_\-]{1,2048}$' + RoleArn: + description: Role ARN. + type: string + SchemaS3Location: + $ref: '#/components/schemas/S3Location' + DescribePayload: + description: Json object with all simulation details + type: string + MaximumDuration: + description: The maximum running time of the simulation. + type: string + minLength: 2 + maxLength: 6 + SnapshotS3Location: + $ref: '#/components/schemas/S3Location' + x-stackQL-stringOnly: true + x-title: CreateSimulationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: simulations: name: simulations id: awscc.simspaceweaver.simulations x-cfn-schema-name: Simulation - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' - AND region = 'us-east-1' - simulation: - name: simulation - id: awscc.simspaceweaver.simulation - x-cfn-schema-name: Simulation - x-type: get + x-cfn-type-name: AWS::SimSpaceWeaver::Simulation x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Simulation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SimSpaceWeaver::Simulation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SimSpaceWeaver::Simulation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SimSpaceWeaver::Simulation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simulations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simulations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/simulations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -131,7 +589,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -145,3 +603,229 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' AND data__Identifier = '' AND region = 'us-east-1' + simulations_list_only: + name: simulations_list_only + id: awscc.simspaceweaver.simulations_list_only + x-cfn-schema-name: Simulation + x-cfn-type-name: AWS::SimSpaceWeaver::Simulation + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Simulation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSimulation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSimulationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/sns.yaml b/providers/src/awscc/v00.00.00000/services/sns.yaml index 13ff1bb2..6814233a 100644 --- a/providers/src/awscc/v00.00.00000/services/sns.yaml +++ b/providers/src/awscc/v00.00.00000/services/sns.yaml @@ -1,41 +1,429 @@ openapi: 3.0.0 info: title: SNS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: - schemas: - Tag: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput type: object - additionalProperties: false + CancelResourceRequestOutput: properties: - Key: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.' - Value: + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: type: string - description: The value for the tag. You can specify a value that is 0 to 256 characters in length. required: - - Value - - Key + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: Subscription: type: object additionalProperties: false properties: Endpoint: type: string + description: The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*. Protocol: type: string + description: The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*. required: - Endpoint - Protocol + description: |- + ``Subscription`` is an embedded property that describes the subscription endpoints of an SNS topic. + For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the [AWS::SNS::Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) resource. + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + description: The required key portion of the tag. + Value: + type: string + description: The optional value portion of the tag. + required: + - Value + - Key + description: The list of tags to be added to the specified topic. LoggingConfig: type: object additionalProperties: false properties: Protocol: type: string - description: Indicates one of the supported protocols for the SNS topic + description: |- + Indicates one of the supported protocols for the Amazon SNS topic. + At least one of the other three ``LoggingConfig`` properties is recommend along with ``Protocol``. enum: - http/s - sqs @@ -44,39 +432,38 @@ components: - application SuccessFeedbackRoleArn: type: string - description: The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch + description: The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch. SuccessFeedbackSampleRate: type: string - description: The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100 + description: The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100. FailureFeedbackRoleArn: type: string - description: The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch + description: The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch. required: - Protocol + description: The ``LoggingConfig`` property type specifies the ``Delivery`` status logging configuration for an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html). Topic: type: object properties: DisplayName: - description: The display name to use for an Amazon SNS topic with SMS subscriptions. + description: The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. type: string KmsMasterKeyId: description: |- - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. - - This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html). + The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. + This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html). type: string DataProtectionPolicy: description: |- The body of the policy document you want to use for this topic. - - You can only add one policy per topic. - - The policy must be in JSON string format. - - Length Constraints: Maximum length of 30720 + You can only add one policy per topic. + The policy must be in JSON string format. + Length Constraints: Maximum length of 30,720. type: object Subscription: - description: The SNS subscriptions (endpoints) for this topic. + description: |- + The SNS subscriptions (endpoints) for this topic. + If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted. type: array uniqueItems: false x-insertionOrder: false @@ -86,52 +473,80 @@ components: description: Set to true to create a FIFO topic. type: boolean ContentBasedDeduplication: - description: |+ - Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. - - When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). - - (Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action. - + description: |- + Enables content-based deduplication for FIFO topics. + + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). + (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action. type: boolean ArchivePolicy: - description: The archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days. + description: The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days. type: object + FifoThroughputScope: + description: '' + type: string Tags: type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' + description: |- + The list of tags to add to a new topic. + To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions. TopicName: description: |- - The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo. - - If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type. + The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. type: string TopicArn: type: string + description: '' SignatureVersion: - description: Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. + description: The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``. type: string TracingConfig: - description: Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics. + description: Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. type: string DeliveryStatusLogging: - description: Delivery status logging configuration for supported protocols for an Amazon SNS topic. + description: |- + The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols: + + HTTP + + Amazon Kinesis Data Firehose + + AWS Lambda + + Platform application endpoint + + Amazon Simple Queue Service + + Once configured, log entries are sent to Amazon CloudWatch Logs. type: array uniqueItems: true x-insertionOrder: false items: $ref: '#/components/schemas/LoggingConfig' x-stackql-resource-name: topic - x-stackql-primaryIdentifier: + description: |- + The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published. + One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*. + The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*. + x-type-name: AWS::SNS::Topic + x-stackql-primary-identifier: - TopicArn x-create-only-properties: - TopicName - FifoTopic x-read-only-properties: - TopicArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sns:TagResource + - sns:UntagResource + - sns:ListTagsForResource x-required-permissions: create: - sns:CreateTopic @@ -177,10 +592,20 @@ components: - PolicyDocument - TopicArn x-stackql-resource-name: topic_inline_policy - x-stackql-primaryIdentifier: + description: Schema for AWS::SNS::TopicInlinePolicy + x-type-name: AWS::SNS::TopicInlinePolicy + x-stackql-primary-identifier: - TopicArn x-create-only-properties: - TopicArn + x-required-properties: + - PolicyDocument + - TopicArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - sns:SetTopicAttributes @@ -193,74 +618,192 @@ components: update: - sns:SetTopicAttributes - sns:GetTopicAttributes - TopicPolicy: + CreateTopicRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DisplayName: + description: The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. + type: string + KmsMasterKeyId: + description: |- + The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. + This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html). + type: string + DataProtectionPolicy: + description: |- + The body of the policy document you want to use for this topic. + You can only add one policy per topic. + The policy must be in JSON string format. + Length Constraints: Maximum length of 30,720. + type: object + Subscription: + description: |- + The SNS subscriptions (endpoints) for this topic. + If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Subscription' + FifoTopic: + description: Set to true to create a FIFO topic. + type: boolean + ContentBasedDeduplication: + description: |- + Enables content-based deduplication for FIFO topics. + + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). + (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action. + type: boolean + ArchivePolicy: + description: The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days. + type: object + FifoThroughputScope: + description: '' + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + description: |- + The list of tags to add to a new topic. + To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions. + TopicName: + description: |- + The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + type: string + TopicArn: + type: string + description: '' + SignatureVersion: + description: The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``. + type: string + TracingConfig: + description: Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. + type: string + DeliveryStatusLogging: + description: |- + The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols: + + HTTP + + Amazon Kinesis Data Firehose + + AWS Lambda + + Platform application endpoint + + Amazon Simple Queue Service + + Once configured, log entries are sent to Amazon CloudWatch Logs. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/LoggingConfig' + x-stackQL-stringOnly: true + x-title: CreateTopicRequest type: object + required: [] + CreateTopicInlinePolicyRequest: properties: - Id: - description: The provider-assigned unique ID for this managed resource. + ClientToken: type: string - PolicyDocument: - description: A policy document that contains permissions to add to the specified SNS topics. + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object - Topics: - description: The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html) resource. - type: array - uniqueItems: false - x-insertionOrder: false - items: - type: string - required: - - PolicyDocument - - Topics - x-stackql-resource-name: topic_policy - x-stackql-primaryIdentifier: - - Id - x-read-only-properties: - - Id - x-required-permissions: - create: - - sns:SetTopicAttributes - update: - - sns:SetTopicAttributes - delete: - - sns:SetTopicAttributes + properties: + PolicyDocument: + description: A policy document that contains permissions to add to the specified SNS topics. + type: object + TopicArn: + description: The Amazon Resource Name (ARN) of the topic to which you want to add the policy. + type: string + x-stackQL-stringOnly: true + x-title: CreateTopicInlinePolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: topics: name: topics id: awscc.sns.topics x-cfn-schema-name: Topic - x-type: list - x-identifiers: - - TopicArn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TopicArn') as topic_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TopicArn') as topic_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' - AND region = 'us-east-1' - topic: - name: topic - id: awscc.sns.topic - x-cfn-schema-name: Topic - x-type: get + x-cfn-type-name: AWS::SNS::Topic x-identifiers: - TopicArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Topic&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SNS::Topic" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SNS::Topic" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SNS::Topic" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topics/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/topics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -272,6 +815,7 @@ components: JSON_EXTRACT(Properties, '$.FifoTopic') as fifo_topic, JSON_EXTRACT(Properties, '$.ContentBasedDeduplication') as content_based_deduplication, JSON_EXTRACT(Properties, '$.ArchivePolicy') as archive_policy, + JSON_EXTRACT(Properties, '$.FifoThroughputScope') as fifo_throughput_scope, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.TopicName') as topic_name, JSON_EXTRACT(Properties, '$.TopicArn') as topic_arn, @@ -282,7 +826,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -294,6 +838,7 @@ components: json_extract_path_text(Properties, 'FifoTopic') as fifo_topic, json_extract_path_text(Properties, 'ContentBasedDeduplication') as content_based_deduplication, json_extract_path_text(Properties, 'ArchivePolicy') as archive_policy, + json_extract_path_text(Properties, 'FifoThroughputScope') as fifo_throughput_scope, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'TopicName') as topic_name, json_extract_path_text(Properties, 'TopicArn') as topic_arn, @@ -303,17 +848,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SNS::Topic' AND data__Identifier = '' AND region = 'us-east-1' - topic_inline_policy: - name: topic_inline_policy - id: awscc.sns.topic_inline_policy - x-cfn-schema-name: TopicInlinePolicy - x-type: get + topics_list_only: + name: topics_list_only + id: awscc.sns.topics_list_only + x-cfn-schema-name: Topic + x-cfn-type-name: AWS::SNS::Topic x-identifiers: - TopicArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TopicArn') as topic_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TopicArn') as topic_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' + AND region = 'us-east-1' + topic_inline_policies: + name: topic_inline_policies + id: awscc.sns.topic_inline_policies + x-cfn-schema-name: TopicInlinePolicy + x-cfn-type-name: AWS::SNS::TopicInlinePolicy + x-identifiers: + - TopicArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TopicInlinePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SNS::TopicInlinePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SNS::TopicInlinePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SNS::TopicInlinePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -324,7 +948,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -334,3 +958,240 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SNS::TopicInlinePolicy' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Topic&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTopic + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTopicRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TopicInlinePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTopicInlinePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTopicInlinePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/sqs.yaml b/providers/src/awscc/v00.00.00000/services/sqs.yaml index 79811cf3..b42274c7 100644 --- a/providers/src/awscc/v00.00.00000/services/sqs.yaml +++ b/providers/src/awscc/v00.00.00000/services/sqs.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: SQS - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -18,69 +398,117 @@ components: required: - Value - Key + description: '' Queue: type: object properties: QueueUrl: type: string - description: URL of the source queue. + description: '' Arn: type: string - description: Amazon Resource Name (ARN) of the queue. + description: '' ContentBasedDeduplication: type: boolean - description: For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. + description: For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*. DeduplicationScope: - description: Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. + description: |- + For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. + To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. type: string DelaySeconds: type: integer - description: The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0. + description: The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``. FifoQueue: type: boolean - description: If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue. + description: If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [Amazon SQS FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Developer Guide*. FifoThroughputLimit: - description: Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. + description: |- + For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. + To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. type: string KmsDataKeyReusePeriodSeconds: type: integer - description: The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). + description: |- + The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). + A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*. KmsMasterKeyId: type: string - description: The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs. + description: |- + The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (for example ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + + The Key Management Service (KMS) section of the [Security best practices for Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/best-practices.html) in the *Key Management Service Developer Guide* SqsManagedSseEnabled: type: boolean - description: Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ). + description: Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default. MaximumMessageSize: type: integer - description: The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB). + description: The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB). MessageRetentionPeriod: type: integer - description: The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days). + description: The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days). QueueName: type: string - description: A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. + description: |- + A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [Amazon SQS FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Developer Guide*. + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. ReceiveMessageWaitTimeSeconds: type: integer - description: Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. + description: >- + Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long + polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*. RedriveAllowPolicy: type: object - description: The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. + description: |- + The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + + + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``. RedrivePolicy: type: object - description: A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue. + description: |- + The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + + ``maxReceiveCount``: The number of times a message is received by a consumer of the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. + + The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. + *JSON* + ``{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }`` + *YAML* + ``deadLetterTargetArn : String`` + ``maxReceiveCount : Integer`` Tags: type: array - description: The tags that you attach to this queue. + description: The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*. uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' VisibilityTimeout: type: integer - description: The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. + description: |- + The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. + Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. + For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*. x-stackql-resource-name: queue - x-stackql-primaryIdentifier: + description: |- + The ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue. + Keep the following caveats in mind: + + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue. + You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. + + If you don't provide a value for a property, the queue is created with the default value for the property. + + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. + + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues. + + For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/create-queue-cloudformation.html) in the *Developer Guide*. + x-type-name: AWS::SQS::Queue + x-stackql-primary-identifier: - QueueUrl x-create-only-properties: - FifoQueue @@ -88,6 +516,16 @@ components: x-read-only-properties: - QueueUrl - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sqs:TagQueue + - sqs:UntagQueue + - sqs:ListQueueTags x-required-permissions: create: - sqs:CreateQueue @@ -122,10 +560,20 @@ components: - PolicyDocument - Queue x-stackql-resource-name: queue_inline_policy - x-stackql-primaryIdentifier: + description: Schema for SQS QueueInlinePolicy + x-type-name: AWS::SQS::QueueInlinePolicy + x-stackql-primary-identifier: - Queue x-create-only-properties: - Queue + x-required-properties: + - PolicyDocument + - Queue + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - sqs:SetQueueAttributes @@ -141,74 +589,209 @@ components: - sqs:SetQueueAttributes - sqs:GetQueueAttributes - sqs:GetQueueUrl - QueuePolicy: + CreateQueueRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + QueueUrl: + type: string + description: '' + Arn: + type: string + description: '' + ContentBasedDeduplication: + type: boolean + description: For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*. + DeduplicationScope: + description: |- + For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. + To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. + type: string + DelaySeconds: + type: integer + description: The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``. + FifoQueue: + type: boolean + description: If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [Amazon SQS FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Developer Guide*. + FifoThroughputLimit: + description: |- + For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. + To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. + type: string + KmsDataKeyReusePeriodSeconds: + type: integer + description: |- + The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). + A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*. + KmsMasterKeyId: + type: string + description: |- + The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (for example ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + + The Key Management Service (KMS) section of the [Security best practices for Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/best-practices.html) in the *Key Management Service Developer Guide* + SqsManagedSseEnabled: + type: boolean + description: >- + Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by + default. + MaximumMessageSize: + type: integer + description: The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB). + MessageRetentionPeriod: + type: integer + description: The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days). + QueueName: + type: string + description: |- + A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [Amazon SQS FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html) in the *Developer Guide*. + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + ReceiveMessageWaitTimeSeconds: + type: integer + description: >- + Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long + polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*. + RedriveAllowPolicy: + type: object + description: |- + The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + + + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``. + RedrivePolicy: + type: object + description: |- + The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + + ``maxReceiveCount``: The number of times a message is received by a consumer of the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. + + The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. + *JSON* + ``{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }`` + *YAML* + ``deadLetterTargetArn : String`` + ``maxReceiveCount : Integer`` + Tags: + type: array + description: The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + VisibilityTimeout: + type: integer + description: |- + The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. + Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. + For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*. + x-stackQL-stringOnly: true + x-title: CreateQueueRequest type: object + required: [] + CreateQueueInlinePolicyRequest: properties: - Id: + ClientToken: type: string - description: '' - PolicyDocument: + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object - description: A policy document that contains the permissions for the specified SQS queues. For more information about SQS policies, see [Using custom policies with the access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Developer Guide*. - Queues: - type: array - description: The URLs of the queues to which you want to add the policy. You can use the ``Ref`` function to specify an ``AWS::SQS::Queue`` resource. - uniqueItems: false - x-insertionOrder: false - items: - type: string - required: - - PolicyDocument - - Queues - x-stackql-resource-name: queue_policy - x-stackql-primaryIdentifier: - - Id - x-read-only-properties: - - Id - x-required-permissions: - create: - - sqs:SetQueueAttributes - update: - - sqs:SetQueueAttributes - delete: - - sqs:SetQueueAttributes + properties: + PolicyDocument: + description: A policy document that contains permissions to add to the specified SQS queue + type: object + Queue: + description: The URL of the SQS queue. + type: string + x-stackQL-stringOnly: true + x-title: CreateQueueInlinePolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: queues: name: queues id: awscc.sqs.queues x-cfn-schema-name: Queue - x-type: list - x-identifiers: - - QueueUrl - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.QueueUrl') as queue_url - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'QueueUrl') as queue_url - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' - AND region = 'us-east-1' - queue: - name: queue - id: awscc.sqs.queue - x-cfn-schema-name: Queue - x-type: get + x-cfn-type-name: AWS::SQS::Queue x-identifiers: - QueueUrl + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SQS::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SQS::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SQS::Queue" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -235,7 +818,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -261,17 +844,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SQS::Queue' AND data__Identifier = '' AND region = 'us-east-1' - queue_inline_policy: - name: queue_inline_policy - id: awscc.sqs.queue_inline_policy + queues_list_only: + name: queues_list_only + id: awscc.sqs.queues_list_only + x-cfn-schema-name: Queue + x-cfn-type-name: AWS::SQS::Queue + x-identifiers: + - QueueUrl + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.QueueUrl') as queue_url + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QueueUrl') as queue_url + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' + AND region = 'us-east-1' + queue_inline_policies: + name: queue_inline_policies + id: awscc.sqs.queue_inline_policies x-cfn-schema-name: QueueInlinePolicy - x-type: get + x-cfn-type-name: AWS::SQS::QueueInlinePolicy x-identifiers: - Queue + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QueueInlinePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SQS::QueueInlinePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SQS::QueueInlinePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SQS::QueueInlinePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -282,7 +944,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -292,3 +954,240 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SQS::QueueInlinePolicy' AND data__Identifier = '' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Queue&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueue + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QueueInlinePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQueueInlinePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQueueInlinePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ssm.yaml b/providers/src/awscc/v00.00.00000/services/ssm.yaml index 2a2c67b1..88a04661 100644 --- a/providers/src/awscc/v00.00.00000/services/ssm.yaml +++ b/providers/src/awscc/v00.00.00000/services/ssm.yaml @@ -1,135 +1,497 @@ openapi: 3.0.0 info: title: SSM - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Target: type: object + additionalProperties: false properties: - Key: - type: string - pattern: ^[\p{L}\p{Z}\p{N}_.:/=+\-@]{1,128}$|resource-groups:Name Values: type: array + uniqueItems: false items: type: string - minItems: 0 - maxItems: 50 - additionalProperties: false + Key: + type: string required: - - Key - Values - ParameterValues: - type: array - items: - type: string - S3Region: - type: string - minLength: 3 - maxLength: 20 - S3BucketName: - type: string - minLength: 3 - maxLength: 63 + - Key S3KeyPrefix: type: string maxLength: 1024 + S3Region: + minLength: 3 + type: string + maxLength: 20 S3OutputLocation: + additionalProperties: false type: object properties: + OutputS3KeyPrefix: + $ref: '#/components/schemas/S3KeyPrefix' OutputS3Region: $ref: '#/components/schemas/S3Region' OutputS3BucketName: $ref: '#/components/schemas/S3BucketName' - OutputS3KeyPrefix: - $ref: '#/components/schemas/S3KeyPrefix' - additionalProperties: false + S3BucketName: + x-relationshipRef: + typeName: AWS::S3::Bucket + propertyPath: /properties/BucketName + minLength: 3 + type: string + maxLength: 63 InstanceAssociationOutputLocation: + additionalProperties: false type: object properties: S3Location: $ref: '#/components/schemas/S3OutputLocation' - additionalProperties: false + ParameterValues: + type: array + items: + type: string Association: type: object properties: - AssociationId: - description: Unique identifier of the association. - type: string - pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' - x-examples: - - 88df7b09-95e8-48c4-a3cb-08c2c20d5110 - - 203dd0ec-0055-4bf0-a872-707f72ef06aa AssociationName: - description: The name of the association. - type: string pattern: ^[a-zA-Z0-9_\-.]{3,128}$ - DocumentVersion: - description: The version of the SSM document to associate with the target. - type: string - pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) - InstanceId: - description: The ID of the instance that the SSM document is associated with. - type: string - pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) - x-examples: - - i-0e60836d21cf313c4 - - mi-0532c22e49636ee13 - Name: - description: The name of the SSM document. + description: The name of the association. type: string - pattern: ^[a-zA-Z0-9_\-.:/]{3,200}$ + CalendarNames: x-examples: - - AWS-GatherSoftwareInventory - - MyCustomSSMDocument - Parameters: - description: Parameter values that the SSM document uses at runtime. - type: object - x-patternProperties: - .*{1,255}: - $ref: '#/components/schemas/ParameterValues' - additionalProperties: false + - - calendar1 + - calendar2 + - - calendar3 + type: array + items: + type: string ScheduleExpression: - description: A Cron or Rate expression that specifies when the association is applied to the target. - type: string - minLength: 1 - maxLength: 256 x-examples: - cron(0 0 */1 * * ? *) - cron(0 16 ? * TUE *) - rate(30 minutes) - rate(7 days) - Targets: - description: The targets that the SSM document sends commands to. - type: array - items: - $ref: '#/components/schemas/Target' - minItems: 0 - maxItems: 5 - OutputLocation: - $ref: '#/components/schemas/InstanceAssociationOutputLocation' - AutomationTargetParameterName: - type: string minLength: 1 - maxLength: 50 - MaxErrors: + description: A Cron or Rate expression that specifies when the association is applied to the target. type: string - pattern: ^([1-9][0-9]{0,6}|[0]|[1-9][0-9]%|[0-9]%|100%)$ + maxLength: 256 + MaxErrors: x-examples: - 1% - 10% - 50% - '1' - MaxConcurrency: + pattern: ^([1-9][0-9]{0,6}|[0]|[1-9][0-9]%|[0-9]%|100%)$ type: string - pattern: ^([1-9][0-9]{0,6}|[1-9][0-9]%|[1-9]%|100%)$ + Parameters: + x-patternProperties: + .{1,255}: + $ref: '#/components/schemas/ParameterValues' + description: Parameter values that the SSM document uses at runtime. + additionalProperties: false + type: object + InstanceId: + x-examples: + - i-0e60836d21cf313c4 + - mi-0532c22e49636ee13 + pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) + description: The ID of the instance that the SSM document is associated with. + type: string + WaitForSuccessTimeoutSeconds: + maximum: 172800 + type: integer + minimum: 15 + MaxConcurrency: x-examples: - 1% - 10% - 50% - '1' + pattern: ^([1-9][0-9]{0,6}|[1-9][0-9]%|[1-9]%|100%)$ + type: string ComplianceSeverity: type: string enum: @@ -138,37 +500,69 @@ components: - MEDIUM - LOW - UNSPECIFIED + Targets: + minItems: 0 + maxItems: 5 + description: The targets that the SSM document sends commands to. + type: array + items: + $ref: '#/components/schemas/Target' SyncCompliance: type: string enum: - AUTO - MANUAL - WaitForSuccessTimeoutSeconds: + OutputLocation: + $ref: '#/components/schemas/InstanceAssociationOutputLocation' + ScheduleOffset: + maximum: 6 type: integer - minimum: 15 - maximum: 172800 + minimum: 1 + Name: + x-examples: + - AWS-GatherSoftwareInventory + - MyCustomSSMDocument + pattern: ^[a-zA-Z0-9_\-.:/]{3,200}$ + description: The name of the SSM document. + type: string ApplyOnlyAtCronInterval: type: boolean - CalendarNames: - type: array - items: - type: string + DocumentVersion: + pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) + description: The version of the SSM document to associate with the target. + type: string + AssociationId: x-examples: - - - calendar1 - - calendar2 - - - calendar3 - ScheduleOffset: - type: integer - minimum: 1 - maximum: 6 + - 88df7b09-95e8-48c4-a3cb-08c2c20d5110 + - 203dd0ec-0055-4bf0-a872-707f72ef06aa + pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' + description: Unique identifier of the association. + type: string + AutomationTargetParameterName: + minLength: 1 + type: string + maxLength: 50 required: - Name x-stackql-resource-name: association - x-stackql-primaryIdentifier: + description: The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document. + x-type-name: AWS::SSM::Association + x-stackql-primary-identifier: - AssociationId + x-write-only-properties: + - WaitForSuccessTimeoutSeconds x-read-only-properties: - AssociationId + x-required-properties: + - Name + x-tagging: + taggable: false x-required-permissions: + read: + - ssm:DescribeAssociation + - resource-groups:GetGroupQuery + - resource-groups:ListGroups + - resource-groups:ListGroupResources create: - ec2:DescribeInstanceStatus - iam:PassRole @@ -176,19 +570,14 @@ components: - ssm:CreateAssociation - ssm:DescribeAssociation - ssm:GetCalendarState - delete: - - ssm:DeleteAssociation update: - iam:PassRole - ssm:UpdateAssociation - ssm:GetCalendarState - read: - - ssm:DescribeAssociation - - resource-groups:GetGroupQuery - - resource-groups:ListGroups - - resource-groups:ListGroupResources list: - ssm:ListAssociations + delete: + - ssm:DeleteAssociation AttachmentsSource: type: object properties: @@ -276,10 +665,12 @@ components: - ApplicationConfigurationSchema - Automation - Automation.ChangeTemplate + - AutoApprovalPolicy - ChangeCalendar - CloudFormation - Command - DeploymentStrategy + - ManualApprovalPolicy - Package - Policy - ProblemAnalysis @@ -321,11 +712,35 @@ components: required: - Content x-stackql-resource-name: document - x-stackql-primaryIdentifier: + description: The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances. + x-type-name: AWS::SSM::Document + x-stackql-primary-identifier: - Name x-create-only-properties: - Name - DocumentType + x-conditional-create-only-properties: + - Content + - Attachments + - VersionName + - DocumentFormat + - TargetType + - Requires + x-write-only-properties: + - UpdateMethod + - Attachments + x-required-properties: + - Content + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ssm:AddTagsToResource + - ssm:ListTagsForResource + - ssm:RemoveTagsFromResource x-required-permissions: create: - ssm:CreateDocument @@ -335,6 +750,7 @@ components: - s3:GetObject - iam:PassRole read: + - ssm:DescribeDocument - ssm:GetDocument - ssm:ListTagsForResource update: @@ -351,6 +767,213 @@ components: - ssm:GetDocument list: - ssm:ListDocuments + Targets: + type: object + additionalProperties: false + properties: + Values: + type: array + uniqueItems: false + items: + type: string + Key: + type: string + required: + - Values + - Key + MaintenanceWindowTarget: + type: object + properties: + OwnerInformation: + type: string + Description: + type: string + WindowId: + type: string + ResourceType: + type: string + Targets: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Targets' + Id: + type: string + Name: + type: string + required: + - WindowId + - ResourceType + - Targets + x-stackql-resource-name: maintenance_window_target + description: Resource Type definition for AWS::SSM::MaintenanceWindowTarget + x-type-name: AWS::SSM::MaintenanceWindowTarget + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - WindowId + x-read-only-properties: + - Id + x-required-properties: + - WindowId + - ResourceType + - Targets + TaskInvocationParameters: + type: object + additionalProperties: false + properties: + MaintenanceWindowStepFunctionsParameters: + $ref: '#/components/schemas/MaintenanceWindowStepFunctionsParameters' + MaintenanceWindowRunCommandParameters: + $ref: '#/components/schemas/MaintenanceWindowRunCommandParameters' + MaintenanceWindowLambdaParameters: + $ref: '#/components/schemas/MaintenanceWindowLambdaParameters' + MaintenanceWindowAutomationParameters: + $ref: '#/components/schemas/MaintenanceWindowAutomationParameters' + CloudWatchOutputConfig: + type: object + additionalProperties: false + properties: + CloudWatchOutputEnabled: + type: boolean + CloudWatchLogGroupName: + type: string + MaintenanceWindowRunCommandParameters: + type: object + additionalProperties: false + properties: + TimeoutSeconds: + type: integer + Comment: + type: string + OutputS3KeyPrefix: + type: string + Parameters: + type: object + CloudWatchOutputConfig: + $ref: '#/components/schemas/CloudWatchOutputConfig' + DocumentHashType: + type: string + ServiceRoleArn: + type: string + NotificationConfig: + $ref: '#/components/schemas/NotificationConfig' + DocumentVersion: + type: string + OutputS3BucketName: + type: string + DocumentHash: + type: string + MaintenanceWindowAutomationParameters: + type: object + additionalProperties: false + properties: + Parameters: + type: object + DocumentVersion: + type: string + NotificationConfig: + type: object + additionalProperties: false + properties: + NotificationEvents: + type: array + uniqueItems: false + items: + type: string + NotificationArn: + type: string + NotificationType: + type: string + required: + - NotificationArn + MaintenanceWindowStepFunctionsParameters: + type: object + additionalProperties: false + properties: + Input: + type: string + Name: + type: string + LoggingInfo: + type: object + additionalProperties: false + properties: + Region: + type: string + S3Prefix: + type: string + S3Bucket: + type: string + required: + - S3Bucket + - Region + MaintenanceWindowLambdaParameters: + type: object + additionalProperties: false + properties: + Qualifier: + type: string + Payload: + type: string + ClientContext: + type: string + MaintenanceWindowTask: + type: object + properties: + MaxErrors: + type: string + Description: + type: string + ServiceRoleArn: + type: string + Priority: + type: integer + MaxConcurrency: + type: string + Targets: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Target' + Name: + type: string + TaskArn: + type: string + TaskInvocationParameters: + $ref: '#/components/schemas/TaskInvocationParameters' + WindowId: + type: string + TaskParameters: + type: object + TaskType: + type: string + CutoffBehavior: + type: string + Id: + type: string + LoggingInfo: + $ref: '#/components/schemas/LoggingInfo' + required: + - WindowId + - Priority + - TaskType + - TaskArn + x-stackql-resource-name: maintenance_window_task + description: Resource Type definition for AWS::SSM::MaintenanceWindowTask + x-type-name: AWS::SSM::MaintenanceWindowTask + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - WindowId + - TaskType + x-read-only-properties: + - Id + x-required-properties: + - WindowId + - Priority + - TaskType + - TaskArn Parameter: type: object properties: @@ -358,7 +981,7 @@ components: type: string description: |- The type of parameter. - Although ``SecureString`` is included in the list of valid values, CFNlong does *not* currently support creating a ``SecureString`` parameter type. + Parameters of type ``SecureString`` are not supported by CFNlong. enum: - String - StringList @@ -374,10 +997,10 @@ components: type: string description: |- Information about the policies assigned to a parameter. - [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*. + [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*. AllowedPattern: type: string - description: 'A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\d+$``' + description: 'A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\d+$``' Tier: type: string description: The parameter tier. @@ -402,15 +1025,40 @@ components: type: string description: |- The name of the parameter. - The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName`` + The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters. + This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: ``arn:aws:ssm:us-east-2:111122223333:parameter/``. required: - Value - Type x-stackql-resource-name: parameter - x-stackql-primaryIdentifier: + description: |- + The ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store. + To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify. + To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing access using policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*. + For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*. + x-type-name: AWS::SSM::Parameter + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - Description + - Tier + - AllowedPattern + - Policies + x-required-properties: + - Value + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ssm:AddTagsToResource + - ssm:ListTagsForResource + - ssm:RemoveTagsFromResource x-required-permissions: create: - ssm:PutParameter @@ -418,6 +1066,7 @@ components: - ssm:GetParameters read: - ssm:GetParameters + - ssm:ListTagsForResource update: - ssm:PutParameter - ssm:AddTagsToResource @@ -646,6 +1295,12 @@ components: GlobalFilters: description: A set of global filters used to include patches in the baseline. $ref: '#/components/schemas/PatchFilterGroup' + AvailableSecurityUpdatesComplianceStatus: + description: The compliance status for vendor recommended security updates that are not approved by this patch baseline. + type: string + enum: + - NON_COMPLIANT + - COMPLIANT Tags: description: Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways. type: array @@ -657,12 +1312,26 @@ components: required: - Name x-stackql-resource-name: patch_baseline - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SSM::PatchBaseline + x-type-name: AWS::SSM::PatchBaseline + x-stackql-primary-identifier: - Id x-create-only-properties: - OperatingSystem x-read-only-properties: - Id + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ssm:AddTagsToResource + - ssm:ListTagsForResource + - ssm:RemoveTagsFromResource x-required-permissions: create: - ssm:CreatePatchBaseline @@ -794,7 +1463,9 @@ components: required: - SyncName x-stackql-resource-name: resource_data_sync - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SSM::ResourceDataSync + x-type-name: AWS::SSM::ResourceDataSync + x-stackql-primary-identifier: - SyncName x-create-only-properties: - KMSKeyArn @@ -805,8 +1476,10 @@ components: - BucketName - S3Destination - SyncType - x-read-only-properties: + x-required-properties: - SyncName + x-tagging: + taggable: false x-required-permissions: create: - ssm:CreateResourceDataSync @@ -832,129 +1505,667 @@ components: description: Actual policy statement. PolicyId: type: string - description: 'An unique identifier within the policies of a resource. ' - PolicyHash: + description: 'An unique identifier within the policies of a resource. ' + PolicyHash: + type: string + description: A snapshot identifier for the policy over time. + required: + - ResourceArn + - Policy + x-stackql-resource-name: resource_policy + description: Resource Type definition for AWS::SSM::ResourcePolicy + x-type-name: AWS::SSM::ResourcePolicy + x-stackql-primary-identifier: + - PolicyId + - ResourceArn + x-create-only-properties: + - ResourceArn + x-read-only-properties: + - PolicyId + - PolicyHash + x-required-properties: + - ResourceArn + - Policy + x-tagging: + taggable: false + x-required-permissions: + create: + - ssm:PutResourcePolicy + read: + - ssm:GetResourcePolicies + update: + - ssm:GetResourcePolicies + - ssm:PutResourcePolicy + delete: + - ssm:GetResourcePolicies + - ssm:DeleteResourcePolicy + list: + - ssm:GetResourcePolicies + CreateAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssociationName: + pattern: ^[a-zA-Z0-9_\-.]{3,128}$ + description: The name of the association. + type: string + CalendarNames: + x-examples: + - - calendar1 + - calendar2 + - - calendar3 + type: array + items: + type: string + ScheduleExpression: + x-examples: + - cron(0 0 */1 * * ? *) + - cron(0 16 ? * TUE *) + - rate(30 minutes) + - rate(7 days) + minLength: 1 + description: A Cron or Rate expression that specifies when the association is applied to the target. + type: string + maxLength: 256 + MaxErrors: + x-examples: + - 1% + - 10% + - 50% + - '1' + pattern: ^([1-9][0-9]{0,6}|[0]|[1-9][0-9]%|[0-9]%|100%)$ + type: string + Parameters: + x-patternProperties: + .{1,255}: + $ref: '#/components/schemas/ParameterValues' + description: Parameter values that the SSM document uses at runtime. + additionalProperties: false + type: object + InstanceId: + x-examples: + - i-0e60836d21cf313c4 + - mi-0532c22e49636ee13 + pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$) + description: The ID of the instance that the SSM document is associated with. + type: string + WaitForSuccessTimeoutSeconds: + maximum: 172800 + type: integer + minimum: 15 + MaxConcurrency: + x-examples: + - 1% + - 10% + - 50% + - '1' + pattern: ^([1-9][0-9]{0,6}|[1-9][0-9]%|[1-9]%|100%)$ + type: string + ComplianceSeverity: + type: string + enum: + - CRITICAL + - HIGH + - MEDIUM + - LOW + - UNSPECIFIED + Targets: + minItems: 0 + maxItems: 5 + description: The targets that the SSM document sends commands to. + type: array + items: + $ref: '#/components/schemas/Target' + SyncCompliance: + type: string + enum: + - AUTO + - MANUAL + OutputLocation: + $ref: '#/components/schemas/InstanceAssociationOutputLocation' + ScheduleOffset: + maximum: 6 + type: integer + minimum: 1 + Name: + x-examples: + - AWS-GatherSoftwareInventory + - MyCustomSSMDocument + pattern: ^[a-zA-Z0-9_\-.:/]{3,200}$ + description: The name of the SSM document. + type: string + ApplyOnlyAtCronInterval: + type: boolean + DocumentVersion: + pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$) + description: The version of the SSM document to associate with the target. + type: string + AssociationId: + x-examples: + - 88df7b09-95e8-48c4-a3cb-08c2c20d5110 + - 203dd0ec-0055-4bf0-a872-707f72ef06aa + pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' + description: Unique identifier of the association. + type: string + AutomationTargetParameterName: + minLength: 1 + type: string + maxLength: 50 + x-stackQL-stringOnly: true + x-title: CreateAssociationRequest + type: object + required: [] + CreateDocumentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Content: + description: The content for the Systems Manager document in JSON, YAML or String format. + type: object + Attachments: + description: A list of key and value pairs that describe attachments to a version of a document. + type: array + items: + $ref: '#/components/schemas/AttachmentsSource' + minItems: 0 + maxItems: 20 + x-insertionOrder: false + Name: + description: A name for the Systems Manager document. + type: string + pattern: ^[a-zA-Z0-9_\-.]{3,128}$ + VersionName: + description: An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed. + type: string + pattern: ^[a-zA-Z0-9_\-.]{1,128}$ + DocumentType: + description: The type of document to create. + type: string + enum: + - ApplicationConfiguration + - ApplicationConfigurationSchema + - Automation + - Automation.ChangeTemplate + - AutoApprovalPolicy + - ChangeCalendar + - CloudFormation + - Command + - DeploymentStrategy + - ManualApprovalPolicy + - Package + - Policy + - ProblemAnalysis + - ProblemAnalysisTemplate + - Session + DocumentFormat: + description: Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format. + type: string + enum: + - YAML + - JSON + - TEXT + default: JSON + TargetType: + description: Specify a target type to define the kinds of resources the document can run on. + type: string + pattern: ^\/[\w\.\-\:\/]*$ + Tags: + description: Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 1000 + x-insertionOrder: false + Requires: + description: A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document. + type: array + items: + $ref: '#/components/schemas/DocumentRequires' + minItems: 1 + x-insertionOrder: false + UpdateMethod: + description: Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version. + type: string + enum: + - Replace + - NewVersion + default: Replace + x-stackQL-stringOnly: true + x-title: CreateDocumentRequest + type: object + required: [] + CreateParameterRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Type: + type: string + description: |- + The type of parameter. + Parameters of type ``SecureString`` are not supported by CFNlong. + enum: + - String + - StringList + Value: + type: string + description: |- + The parameter value. + If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field. + Description: + type: string + description: Information about the parameter. + Policies: + type: string + description: |- + Information about the policies assigned to a parameter. + [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*. + AllowedPattern: + type: string + description: 'A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\d+$``' + Tier: + type: string + description: The parameter tier. + enum: + - Standard + - Advanced + - Intelligent-Tiering + Tags: + type: object + description: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. + x-patternProperties: + ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$: + type: string + additionalProperties: false + DataType: + type: string + description: The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``. + enum: + - text + - aws:ec2:image + Name: + type: string + description: |- + The name of the parameter. + The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters. + This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: ``arn:aws:ssm:us-east-2:111122223333:parameter/``. + x-stackQL-stringOnly: true + x-title: CreateParameterRequest + type: object + required: [] + CreatePatchBaselineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: The ID of the patch baseline. + type: string + pattern: ^[a-zA-Z0-9_\-:/]{20,128}$ + minLength: 20 + maxLength: 128 + DefaultBaseline: + description: Set the baseline as default baseline. Only registering to default patch baseline is allowed. + type: boolean + default: false + OperatingSystem: + description: Defines the operating system the patch baseline applies to. The Default value is WINDOWS. + type: string + default: WINDOWS + enum: + - WINDOWS + - AMAZON_LINUX + - AMAZON_LINUX_2 + - AMAZON_LINUX_2022 + - AMAZON_LINUX_2023 + - UBUNTU + - REDHAT_ENTERPRISE_LINUX + - SUSE + - CENTOS + - ORACLE_LINUX + - DEBIAN + - MACOS + - RASPBIAN + - ROCKY_LINUX + - ALMA_LINUX + Description: + description: The description of the patch baseline. + type: string + minLength: 1 + maxLength: 1024 + ApprovalRules: + $ref: '#/components/schemas/RuleGroup' + Sources: + description: Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/PatchSource' + minItems: 0 + maxItems: 20 + Name: + description: The name of the patch baseline. + type: string + pattern: ^[a-zA-Z0-9_\-.]{3,128}$ + minLength: 3 + maxLength: 128 + RejectedPatches: + description: A list of explicitly rejected patches for the baseline. + type: array + uniqueItems: false + items: + type: string + minLength: 1 + maxLength: 100 + minItems: 0 + maxItems: 50 + x-insertionOrder: false + ApprovedPatches: + description: A list of explicitly approved patches for the baseline. + type: array + uniqueItems: false + items: + type: string + minLength: 1 + maxLength: 100 + minItems: 0 + maxItems: 50 + x-insertionOrder: false + RejectedPatchesAction: + description: The action for Patch Manager to take on patches included in the RejectedPackages list. + type: string + default: ALLOW_AS_DEPENDENCY + enum: + - ALLOW_AS_DEPENDENCY + - BLOCK + PatchGroups: + description: PatchGroups is used to associate instances with a specific patch baseline + type: array + uniqueItems: false + items: + type: string + minLength: 1 + maxLength: 256 + ApprovedPatchesComplianceLevel: + description: Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED. + type: string + default: UNSPECIFIED + enum: + - CRITICAL + - HIGH + - MEDIUM + - LOW + - INFORMATIONAL + - UNSPECIFIED + ApprovedPatchesEnableNonSecurity: + description: Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. + type: boolean + default: false + GlobalFilters: + description: A set of global filters used to include patches in the baseline. + $ref: '#/components/schemas/PatchFilterGroup' + AvailableSecurityUpdatesComplianceStatus: + description: The compliance status for vendor recommended security updates that are not approved by this patch baseline. + type: string + enum: + - NON_COMPLIANT + - COMPLIANT + Tags: + description: Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways. + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + maxItems: 1000 + x-stackQL-stringOnly: true + x-title: CreatePatchBaselineRequest + type: object + required: [] + CreateResourceDataSyncRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + S3Destination: + $ref: '#/components/schemas/S3Destination' + KMSKeyArn: + type: string + minLength: 0 + maxLength: 512 + SyncSource: + $ref: '#/components/schemas/SyncSource' + BucketName: + type: string + minLength: 1 + maxLength: 2048 + BucketRegion: + type: string + minLength: 1 + maxLength: 64 + SyncFormat: + type: string + minLength: 0 + maxLength: 1024 + SyncName: + type: string + minLength: 1 + maxLength: 64 + SyncType: + type: string + minLength: 1 + maxLength: 64 + BucketPrefix: + type: string + minLength: 0 + maxLength: 64 + x-stackQL-stringOnly: true + x-title: CreateResourceDataSyncRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: type: string - description: A snapshot identifier for the policy over time. - required: - - ResourceArn - - Policy - x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: - - PolicyId - - ResourceArn - x-create-only-properties: - - ResourceArn - x-read-only-properties: - - PolicyId - - PolicyHash - x-required-permissions: - create: - - ssm:PutResourcePolicy - read: - - ssm:GetResourcePolicies - update: - - ssm:PutResourcePolicy - delete: - - ssm:DeleteResourcePolicy - list: - - ssm:GetResourcePolicies + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + type: string + description: Arn of OpsItemGroup etc. + Policy: + type: object + description: Actual policy statement. + PolicyId: + type: string + description: 'An unique identifier within the policies of a resource. ' + PolicyHash: + type: string + description: A snapshot identifier for the policy over time. + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: associations: name: associations id: awscc.ssm.associations x-cfn-schema-name: Association - x-type: list - x-identifiers: - - AssociationId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' - AND region = 'us-east-1' - association: - name: association - id: awscc.ssm.association - x-cfn-schema-name: Association - x-type: get + x-cfn-type-name: AWS::SSM::Association x-identifiers: - AssociationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Association&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Association" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Association" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Association" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id, JSON_EXTRACT(Properties, '$.AssociationName') as association_name, - JSON_EXTRACT(Properties, '$.DocumentVersion') as document_version, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.CalendarNames') as calendar_names, JSON_EXTRACT(Properties, '$.ScheduleExpression') as schedule_expression, - JSON_EXTRACT(Properties, '$.Targets') as targets, - JSON_EXTRACT(Properties, '$.OutputLocation') as output_location, - JSON_EXTRACT(Properties, '$.AutomationTargetParameterName') as automation_target_parameter_name, JSON_EXTRACT(Properties, '$.MaxErrors') as max_errors, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.WaitForSuccessTimeoutSeconds') as wait_for_success_timeout_seconds, JSON_EXTRACT(Properties, '$.MaxConcurrency') as max_concurrency, JSON_EXTRACT(Properties, '$.ComplianceSeverity') as compliance_severity, + JSON_EXTRACT(Properties, '$.Targets') as targets, JSON_EXTRACT(Properties, '$.SyncCompliance') as sync_compliance, - JSON_EXTRACT(Properties, '$.WaitForSuccessTimeoutSeconds') as wait_for_success_timeout_seconds, + JSON_EXTRACT(Properties, '$.OutputLocation') as output_location, + JSON_EXTRACT(Properties, '$.ScheduleOffset') as schedule_offset, + JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.ApplyOnlyAtCronInterval') as apply_only_at_cron_interval, - JSON_EXTRACT(Properties, '$.CalendarNames') as calendar_names, - JSON_EXTRACT(Properties, '$.ScheduleOffset') as schedule_offset + JSON_EXTRACT(Properties, '$.DocumentVersion') as document_version, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id, + JSON_EXTRACT(Properties, '$.AutomationTargetParameterName') as automation_target_parameter_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Association' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'AssociationId') as association_id, json_extract_path_text(Properties, 'AssociationName') as association_name, - json_extract_path_text(Properties, 'DocumentVersion') as document_version, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'CalendarNames') as calendar_names, json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'OutputLocation') as output_location, - json_extract_path_text(Properties, 'AutomationTargetParameterName') as automation_target_parameter_name, json_extract_path_text(Properties, 'MaxErrors') as max_errors, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'WaitForSuccessTimeoutSeconds') as wait_for_success_timeout_seconds, json_extract_path_text(Properties, 'MaxConcurrency') as max_concurrency, json_extract_path_text(Properties, 'ComplianceSeverity') as compliance_severity, + json_extract_path_text(Properties, 'Targets') as targets, json_extract_path_text(Properties, 'SyncCompliance') as sync_compliance, - json_extract_path_text(Properties, 'WaitForSuccessTimeoutSeconds') as wait_for_success_timeout_seconds, + json_extract_path_text(Properties, 'OutputLocation') as output_location, + json_extract_path_text(Properties, 'ScheduleOffset') as schedule_offset, + json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'ApplyOnlyAtCronInterval') as apply_only_at_cron_interval, - json_extract_path_text(Properties, 'CalendarNames') as calendar_names, - json_extract_path_text(Properties, 'ScheduleOffset') as schedule_offset + json_extract_path_text(Properties, 'DocumentVersion') as document_version, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'AutomationTargetParameterName') as automation_target_parameter_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Association' AND data__Identifier = '' AND region = 'us-east-1' - documents: - name: documents - id: awscc.ssm.documents - x-cfn-schema-name: Document - x-type: list + associations_list_only: + name: associations_list_only + id: awscc.ssm.associations_list_only + x-cfn-schema-name: Association + x-cfn-type-name: AWS::SSM::Association x-identifiers: - - Name + - AssociationId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -962,28 +2173,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' AND region = 'us-east-1' - document: - name: document - id: awscc.ssm.document + documents: + name: documents + id: awscc.ssm.documents x-cfn-schema-name: Document - x-type: get + x-cfn-type-name: AWS::SSM::Document x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Document&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Document" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Document" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Document" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/documents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/documents/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/documents/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1002,7 +2261,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1020,13 +2279,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Document' AND data__Identifier = '' AND region = 'us-east-1' - parameters: - name: parameters - id: awscc.ssm.parameters - x-cfn-schema-name: Parameter - x-type: list + documents_list_only: + name: documents_list_only + id: awscc.ssm.documents_list_only + x-cfn-schema-name: Document + x-cfn-type-name: AWS::SSM::Document x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1035,7 +2300,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1043,19 +2308,93 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' AND region = 'us-east-1' - parameter: - name: parameter - id: awscc.ssm.parameter + maintenance_window_targets: + name: maintenance_window_targets + id: awscc.ssm.maintenance_window_targets + x-cfn-schema-name: MaintenanceWindowTarget + x-cfn-type-name: AWS::SSM::MaintenanceWindowTarget + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + maintenance_window_tasks: + name: maintenance_window_tasks + id: awscc.ssm.maintenance_window_tasks + x-cfn-schema-name: MaintenanceWindowTask + x-cfn-type-name: AWS::SSM::MaintenanceWindowTask + x-identifiers: + - Id + x-type: cloud_control + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + parameters: + name: parameters + id: awscc.ssm.parameters x-cfn-schema-name: Parameter - x-type: get + x-cfn-type-name: AWS::SSM::Parameter x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Parameter&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Parameter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Parameter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::Parameter" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/parameters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/parameters/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/parameters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1073,7 +2412,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1090,13 +2429,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Parameter' AND data__Identifier = '' AND region = 'us-east-1' - patch_baselines: - name: patch_baselines - id: awscc.ssm.patch_baselines - x-cfn-schema-name: PatchBaseline - x-type: list + parameters_list_only: + name: parameters_list_only + id: awscc.ssm.parameters_list_only + x-cfn-schema-name: Parameter + x-cfn-type-name: AWS::SSM::Parameter x-identifiers: - - Id + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1104,28 +2449,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' AND region = 'us-east-1' - patch_baseline: - name: patch_baseline - id: awscc.ssm.patch_baseline + patch_baselines: + name: patch_baselines + id: awscc.ssm.patch_baselines x-cfn-schema-name: PatchBaseline - x-type: get + x-cfn-type-name: AWS::SSM::PatchBaseline x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PatchBaseline&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::PatchBaseline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::PatchBaseline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::PatchBaseline" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1144,12 +2537,13 @@ components: JSON_EXTRACT(Properties, '$.ApprovedPatchesComplianceLevel') as approved_patches_compliance_level, JSON_EXTRACT(Properties, '$.ApprovedPatchesEnableNonSecurity') as approved_patches_enable_non_security, JSON_EXTRACT(Properties, '$.GlobalFilters') as global_filters, + JSON_EXTRACT(Properties, '$.AvailableSecurityUpdatesComplianceStatus') as available_security_updates_compliance_status, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::PatchBaseline' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1168,17 +2562,24 @@ components: json_extract_path_text(Properties, 'ApprovedPatchesComplianceLevel') as approved_patches_compliance_level, json_extract_path_text(Properties, 'ApprovedPatchesEnableNonSecurity') as approved_patches_enable_non_security, json_extract_path_text(Properties, 'GlobalFilters') as global_filters, + json_extract_path_text(Properties, 'AvailableSecurityUpdatesComplianceStatus') as available_security_updates_compliance_status, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::PatchBaseline' AND data__Identifier = '' AND region = 'us-east-1' - resource_data_syncs: - name: resource_data_syncs - id: awscc.ssm.resource_data_syncs - x-cfn-schema-name: ResourceDataSync - x-type: list + patch_baselines_list_only: + name: patch_baselines_list_only + id: awscc.ssm.patch_baselines_list_only + x-cfn-schema-name: PatchBaseline + x-cfn-type-name: AWS::SSM::PatchBaseline x-identifiers: - - SyncName + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1186,28 +2587,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.SyncName') as sync_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SyncName') as sync_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' AND region = 'us-east-1' - resource_data_sync: - name: resource_data_sync - id: awscc.ssm.resource_data_sync + resource_data_syncs: + name: resource_data_syncs + id: awscc.ssm.resource_data_syncs x-cfn-schema-name: ResourceDataSync - x-type: get + x-cfn-type-name: AWS::SSM::ResourceDataSync x-identifiers: - SyncName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceDataSync&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::ResourceDataSync" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::ResourceDataSync" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::ResourceDataSync" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1225,7 +2674,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1242,14 +2691,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' AND data__Identifier = '' AND region = 'us-east-1' - resource_policies: - name: resource_policies - id: awscc.ssm.resource_policies - x-cfn-schema-name: ResourcePolicy - x-type: list + resource_data_syncs_list_only: + name: resource_data_syncs_list_only + id: awscc.ssm.resource_data_syncs_list_only + x-cfn-schema-name: ResourceDataSync + x-cfn-type-name: AWS::SSM::ResourceDataSync x-identifiers: - - PolicyId - - ResourceArn + - SyncName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1257,31 +2711,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' + JSON_EXTRACT(Properties, '$.SyncName') as sync_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyId') as policy_id, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' + json_extract_path_text(Properties, 'SyncName') as sync_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.ssm.resource_policy + resource_policies: + name: resource_policies + id: awscc.ssm.resource_policies x-cfn-schema-name: ResourcePolicy - x-type: get + x-cfn-type-name: AWS::SSM::ResourcePolicy x-identifiers: - PolicyId - ResourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSM::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1294,7 +2794,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1306,3 +2806,442 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' AND data__Identifier = '|' AND region = 'us-east-1' + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.ssm.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::SSM::ResourcePolicy + x-identifiers: + - PolicyId + - ResourceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Association&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Document&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDocument + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDocumentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Parameter&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateParameter + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateParameterRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PatchBaseline&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePatchBaseline + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePatchBaselineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceDataSync&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceDataSync + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceDataSyncRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ssmcontacts.yaml b/providers/src/awscc/v00.00.00000/services/ssmcontacts.yaml index 4bb29207..e6f5cd8f 100644 --- a/providers/src/awscc/v00.00.00000/services/ssmcontacts.yaml +++ b/providers/src/awscc/v00.00.00000/services/ssmcontacts.yaml @@ -1,10 +1,408 @@ openapi: 3.0.0 info: title: SSMContacts - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + description: The key name of the tag + type: string + minLength: 1 + maxLength: 128 + Value: + description: The value for the tag. + type: string + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false ContactTargetInfo: type: object description: The contact that SSM Incident Manager is engaging during an incident. @@ -83,8 +481,6 @@ components: type: string enum: - PERSONAL - - CUSTOM - - SERVICE - ESCALATION - ONCALL_SCHEDULE Plan: @@ -92,6 +488,12 @@ components: type: array items: $ref: '#/components/schemas/Stage' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' Arn: type: string description: The Amazon Resource Name (ARN) of the contact. @@ -100,30 +502,55 @@ components: - DisplayName - Type x-stackql-resource-name: contact - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SSMContacts::Contact + x-type-name: AWS::SSMContacts::Contact + x-stackql-primary-identifier: - Arn x-create-only-properties: - Alias - Type + x-write-only-properties: + - Plan x-read-only-properties: - Arn + x-required-properties: + - Alias + - DisplayName + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ssm-contacts:TagResource + - ssm-contacts:UntagResource + - ssm-contacts:ListTagsForResource x-required-permissions: create: - ssm-contacts:CreateContact - ssm-contacts:GetContact - ssm-contacts:AssociateContact + - ssm-contacts:TagResource + - ssm-contacts:ListTagsForResource read: - ssm-contacts:GetContact + - ssm-contacts:ListTagsForResource update: - ssm-contacts:UpdateContact - ssm-contacts:GetContact - ssm-contacts:AssociateContact + - ssm-contacts:TagResource + - ssm-contacts:UntagResource + - ssm-contacts:ListTagsForResource delete: - ssm-contacts:DeleteContact - ssm-contacts:GetContact - ssm-contacts:AssociateContact list: - ssm-contacts:ListContacts + - ssm-contacts:ListTagsForResource ContactChannel: type: object properties: @@ -156,13 +583,22 @@ components: type: string description: The Amazon Resource Name (ARN) of the engagement to a contact channel. x-stackql-resource-name: contact_channel - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SSMContacts::ContactChannel + x-type-name: AWS::SSMContacts::ContactChannel + x-stackql-primary-identifier: - Arn x-create-only-properties: - ContactId - ChannelType + x-write-only-properties: + - DeferActivation x-read-only-properties: - Arn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - ssm-contacts:CreateContactChannel @@ -200,12 +636,21 @@ components: type: string description: The Amazon Resource Name (ARN) of the contact. x-stackql-resource-name: plan - x-stackql-primaryIdentifier: + description: Engagement Plan for a SSM Incident Manager Contact. + x-type-name: AWS::SSMContacts::Plan + x-stackql-primary-identifier: - Arn x-create-only-properties: - ContactId + x-write-only-properties: + - RotationIds x-read-only-properties: - Arn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - ssm-contacts:UpdateContact @@ -221,24 +666,6 @@ components: - ssm-contacts:UpdateContact - ssm-contacts:GetContact - ssm-contacts:AssociateContact - Tag: - description: A key-value pair to associate with a resource. - type: object - properties: - Key: - description: The key name of the tag - type: string - minLength: 1 - maxLength: 128 - Value: - description: The value for the tag. - type: string - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false HandOffTime: type: string pattern: ^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$ @@ -407,22 +834,37 @@ components: - TimeZoneId - Recurrence x-stackql-resource-name: rotation - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::SSMContacts::Rotation. + x-type-name: AWS::SSMContacts::Rotation + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-required-properties: + - Name + - ContactIds + - StartTime + - TimeZoneId + - Recurrence + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ssm-contacts:TagResource + - ssm-contacts:UntagResource + - ssm-contacts:ListTagsForResource x-required-permissions: create: - ssm-contacts:CreateRotation - ssm-contacts:GetRotation - ssm-contacts:TagResource - ssm-contacts:ListTagsForResource - - ssm-contacts:UntagResource read: - ssm-contacts:GetRotation - - ssm-contacts:TagResource - ssm-contacts:ListTagsForResource - - ssm-contacts:UntagResource update: - ssm-contacts:UpdateRotation - ssm-contacts:GetRotation @@ -438,43 +880,249 @@ components: - ssm-contacts:ListRotations - ssm-contacts:GetRotation - ssm-contacts:ListTagsForResource + CreateContactRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Alias: + description: Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed. + type: string + minLength: 1 + maxLength: 255 + pattern: ^[a-z0-9_\-\.]*$ + DisplayName: + description: Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed. + type: string + minLength: 1 + maxLength: 255 + pattern: ^[a-zA-Z0-9_\-\s]*$ + Type: + description: 'Contact type, which specify type of contact. Currently supported values: “PERSONAL”, “SHARED”, “OTHER“.' + type: string + enum: + - PERSONAL + - ESCALATION + - ONCALL_SCHEDULE + Plan: + description: The stages that an escalation plan or engagement plan engages contacts and contact methods in. + type: array + items: + $ref: '#/components/schemas/Stage' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the contact. + x-stackQL-stringOnly: true + x-title: CreateContactRequest + type: object + required: [] + CreateContactChannelRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContactId: + description: ARN of the contact resource + type: string + minLength: 1 + maxLength: 2048 + pattern: arn:[-\w+=\/,.@]+:[-\w+=\/,.@]+:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-]+)* + ChannelName: + description: The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters. + type: string + minLength: 1 + maxLength: 255 + pattern: '[a-zA-Z 0-9_\-+''&\uD83C-\uDBFF\uDC00-\uDFFF\u2000-\u3300]+' + ChannelType: + description: 'Device type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT.' + type: string + enum: + - SMS + - VOICE + - EMAIL + DeferActivation: + type: boolean + description: If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated. + ChannelAddress: + description: The details that SSM Incident Manager uses when trying to engage the contact channel. + type: string + Arn: + type: string + description: The Amazon Resource Name (ARN) of the engagement to a contact channel. + x-stackQL-stringOnly: true + x-title: CreateContactChannelRequest + type: object + required: [] + CreatePlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContactId: + description: Contact ID for the AWS SSM Incident Manager Contact to associate the plan. + type: string + pattern: arn:[-\w+=\/,.@]+:[-\w+=\/,.@]+:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-]+)* + Stages: + description: The stages that an escalation plan or engagement plan engages contacts and contact methods in. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Stage' + RotationIds: + description: Rotation Ids to associate with Oncall Contact for engagement. + type: array + x-insertionOrder: false + items: + type: string + Arn: + type: string + description: The Amazon Resource Name (ARN) of the contact. + x-stackQL-stringOnly: true + x-title: CreatePlanRequest + type: object + required: [] + CreateRotationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the Rotation + type: string + pattern: ^[a-zA-Z0-9_]*$ + ContactIds: + description: Members of the rotation + type: array + x-insertionOrder: false + items: + type: string + StartTime: + description: Start time of the first shift of Oncall Schedule + type: string + pattern: ^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2})$ + TimeZoneId: + description: TimeZone Identifier for the Oncall Schedule + type: string + Recurrence: + $ref: '#/components/schemas/RecurrenceSettings' + Tags: + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the rotation. + x-stackQL-stringOnly: true + x-title: CreateRotationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: contacts: name: contacts id: awscc.ssmcontacts.contacts x-cfn-schema-name: Contact - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' - AND region = 'us-east-1' - contact: - name: contact - id: awscc.ssmcontacts.contact - x-cfn-schema-name: Contact - x-type: get + x-cfn-type-name: AWS::SSMContacts::Contact x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Contact&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Contact" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Contact" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Contact" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contacts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contacts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/contacts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -483,12 +1131,13 @@ components: JSON_EXTRACT(Properties, '$.DisplayName') as display_name, JSON_EXTRACT(Properties, '$.Type') as type, JSON_EXTRACT(Properties, '$.Plan') as plan, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Arn') as arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Contact' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -497,17 +1146,24 @@ components: json_extract_path_text(Properties, 'DisplayName') as display_name, json_extract_path_text(Properties, 'Type') as type, json_extract_path_text(Properties, 'Plan') as plan, + json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'Arn') as arn FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Contact' AND data__Identifier = '' AND region = 'us-east-1' - contact_channels: - name: contact_channels - id: awscc.ssmcontacts.contact_channels - x-cfn-schema-name: ContactChannel - x-type: list + contacts_list_only: + name: contacts_list_only + id: awscc.ssmcontacts.contacts_list_only + x-cfn-schema-name: Contact + x-cfn-type-name: AWS::SSMContacts::Contact x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -516,7 +1172,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -524,19 +1180,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' AND region = 'us-east-1' - contact_channel: - name: contact_channel - id: awscc.ssmcontacts.contact_channel + contact_channels: + name: contact_channels + id: awscc.ssmcontacts.contact_channels x-cfn-schema-name: ContactChannel - x-type: get + x-cfn-type-name: AWS::SSMContacts::ContactChannel x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContactChannel&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::ContactChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::ContactChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::ContactChannel" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_channels/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/contact_channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -551,7 +1255,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -565,13 +1269,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' AND data__Identifier = '' AND region = 'us-east-1' - plan: - name: plan - id: awscc.ssmcontacts.plan - x-cfn-schema-name: Plan - x-type: get + contact_channels_list_only: + name: contact_channels_list_only + id: awscc.ssmcontacts.contact_channels_list_only + x-cfn-schema-name: ContactChannel + x-cfn-type-name: AWS::SSMContacts::ContactChannel x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -579,63 +1289,159 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ContactId') as contact_id, - JSON_EXTRACT(Properties, '$.Stages') as stages, - JSON_EXTRACT(Properties, '$.RotationIds') as rotation_ids, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Plan' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ContactId') as contact_id, - json_extract_path_text(Properties, 'Stages') as stages, - json_extract_path_text(Properties, 'RotationIds') as rotation_ids, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Plan' - AND data__Identifier = '' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' AND region = 'us-east-1' - rotations: - name: rotations - id: awscc.ssmcontacts.rotations - x-cfn-schema-name: Rotation - x-type: list + plans: + name: plans + id: awscc.ssmcontacts.plans + x-cfn-schema-name: Plan + x-cfn-type-name: AWS::SSMContacts::Plan x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Plan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Plan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Plan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Plan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ContactId') as contact_id, + JSON_EXTRACT(Properties, '$.Stages') as stages, + JSON_EXTRACT(Properties, '$.RotationIds') as rotation_ids, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Plan' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + json_extract_path_text(Properties, 'ContactId') as contact_id, + json_extract_path_text(Properties, 'Stages') as stages, + json_extract_path_text(Properties, 'RotationIds') as rotation_ids, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Plan' + AND data__Identifier = '' AND region = 'us-east-1' - rotation: - name: rotation - id: awscc.ssmcontacts.rotation + rotations: + name: rotations + id: awscc.ssmcontacts.rotations x-cfn-schema-name: Rotation - x-type: get + x-cfn-type-name: AWS::SSMContacts::Rotation x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Rotation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Rotation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Rotation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMContacts::Rotation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rotations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rotations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rotations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -651,7 +1457,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -666,3 +1472,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Rotation' AND data__Identifier = '' AND region = 'us-east-1' + rotations_list_only: + name: rotations_list_only + id: awscc.ssmcontacts.rotations_list_only + x-cfn-schema-name: Rotation + x-cfn-type-name: AWS::SSMContacts::Rotation + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Contact&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContact + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContactRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ContactChannel&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContactChannel + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContactChannelRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Plan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Rotation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRotation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRotationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ssmguiconnect.yaml b/providers/src/awscc/v00.00.00000/services/ssmguiconnect.yaml new file mode 100644 index 00000000..3d8f15ce --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/ssmguiconnect.yaml @@ -0,0 +1,820 @@ +openapi: 3.0.0 +info: + title: SSMGuiConnect + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + BucketOwner: + description: The AWS account number that owns the S3 bucket. + type: string + pattern: ^[0-9]{12}$ + BucketName: + description: The name of the S3 bucket where RDP connection recordings are stored. + type: string + pattern: (?=^.{3,63}$)(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])$) + S3Bucket: + description: The S3 bucket where RDP connection recordings are stored. + type: object + additionalProperties: false + properties: + BucketOwner: + $ref: '#/components/schemas/BucketOwner' + BucketName: + $ref: '#/components/schemas/BucketName' + required: + - BucketOwner + - BucketName + S3Buckets: + description: The S3 bucket where RDP connection recordings are stored. + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/S3Bucket' + minItems: 1 + maxItems: 1 + RecordingDestinations: + description: Determines where recordings of RDP connections are stored. + type: object + additionalProperties: false + properties: + S3Buckets: + $ref: '#/components/schemas/S3Buckets' + required: + - S3Buckets + KMSKeyArn: + description: The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to. + type: string + minLength: 1 + maxLength: 2048 + Preferences: + type: object + properties: + AccountId: + description: The AWS Account Id that the preference is associated with, used as the unique identifier for this resource. + type: string + pattern: \d{12} + ConnectionRecordingPreferences: + description: The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in. + type: object + additionalProperties: false + properties: + RecordingDestinations: + $ref: '#/components/schemas/RecordingDestinations' + KMSKeyArn: + $ref: '#/components/schemas/KMSKeyArn' + required: + - RecordingDestinations + - KMSKeyArn + x-stackql-resource-name: preferences + description: Definition of AWS::SSMGuiConnect::Preferences Resource Type + x-type-name: AWS::SSMGuiConnect::Preferences + x-stackql-primary-identifier: + - AccountId + x-read-only-properties: + - AccountId + x-tagging: + taggable: false + x-required-permissions: + create: + - kms:CreateGrant + - ssm-guiconnect:UpdateConnectionRecordingPreferences + - ssm-guiconnect:GetConnectionRecordingPreferences + read: + - ssm-guiconnect:GetConnectionRecordingPreferences + update: + - kms:CreateGrant + - ssm-guiconnect:UpdateConnectionRecordingPreferences + - ssm-guiconnect:GetConnectionRecordingPreferences + - ssm-guiconnect:DeleteConnectionRecordingPreferences + delete: + - ssm-guiconnect:GetConnectionRecordingPreferences + - ssm-guiconnect:DeleteConnectionRecordingPreferences + list: + - ssm-guiconnect:GetConnectionRecordingPreferences + CreatePreferencesRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + description: The AWS Account Id that the preference is associated with, used as the unique identifier for this resource. + type: string + pattern: \d{12} + ConnectionRecordingPreferences: + description: The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in. + type: object + additionalProperties: false + properties: + RecordingDestinations: + $ref: '#/components/schemas/RecordingDestinations' + KMSKeyArn: + $ref: '#/components/schemas/KMSKeyArn' + required: + - RecordingDestinations + - KMSKeyArn + x-stackQL-stringOnly: true + x-title: CreatePreferencesRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + preferences: + name: preferences + id: awscc.ssmguiconnect.preferences + x-cfn-schema-name: Preferences + x-cfn-type-name: AWS::SSMGuiConnect::Preferences + x-identifiers: + - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Preferences&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMGuiConnect::Preferences" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMGuiConnect::Preferences" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMGuiConnect::Preferences" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/preferences/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/preferences/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/preferences/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.ConnectionRecordingPreferences') as connection_recording_preferences + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMGuiConnect::Preferences' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'ConnectionRecordingPreferences') as connection_recording_preferences + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMGuiConnect::Preferences' + AND data__Identifier = '' + AND region = 'us-east-1' + preferences_list_only: + name: preferences_list_only + id: awscc.ssmguiconnect.preferences_list_only + x-cfn-schema-name: Preferences + x-cfn-type-name: AWS::SSMGuiConnect::Preferences + x-identifiers: + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMGuiConnect::Preferences' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMGuiConnect::Preferences' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Preferences&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePreferences + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePreferencesRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ssmincidents.yaml b/providers/src/awscc/v00.00.00000/services/ssmincidents.yaml index 3a8b4c0f..d1d9c7f2 100644 --- a/providers/src/awscc/v00.00.00000/services/ssmincidents.yaml +++ b/providers/src/awscc/v00.00.00000/services/ssmincidents.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: SSMIncidents - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Arn: description: The ARN of the ReplicationSet. @@ -29,7 +409,9 @@ components: additionalProperties: false properties: SseKmsKeyId: - $ref: '#/components/schemas/Arn' + type: string + description: The AWS Key Management Service key ID or Key Alias to use to encrypt your replication set. + maxLength: 2048 required: - SseKmsKeyId DeletionProtected: @@ -85,10 +467,24 @@ components: required: - Regions x-stackql-resource-name: replication_set - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::SSMIncidents::ReplicationSet + x-type-name: AWS::SSMIncidents::ReplicationSet + x-stackql-primary-identifier: - Arn x-read-only-properties: - Arn + x-required-properties: + - Regions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ssm-incidents:TagResource + - ssm-incidents:UntagResource + - ssm-incidents:ListTagsForResource x-required-permissions: create: - ssm-incidents:CreateReplicationSet @@ -397,12 +793,27 @@ components: - Name - IncidentTemplate x-stackql-resource-name: response_plan - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::SSMIncidents::ResponsePlan + x-type-name: AWS::SSMIncidents::ResponsePlan + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name x-read-only-properties: - Arn + x-required-properties: + - Name + - IncidentTemplate + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - ssm-incidents:TagResource + - ssm-incidents:UntagResource + - ssm-incidents:ListTagsForResource x-required-permissions: create: - ssm-incidents:CreateResponsePlan @@ -412,7 +823,10 @@ components: - iam:PassRole - secretsmanager:GetSecretValue - kms:Decrypt - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext read: - ssm-incidents:GetResponsePlan - ssm-incidents:ListTagsForResource @@ -425,49 +839,191 @@ components: - iam:PassRole - secretsmanager:GetSecretValue - kms:Decrypt - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext delete: - ssm-incidents:DeleteResponsePlan - ssm-incidents:GetResponsePlan list: - ssm-incidents:ListResponsePlans + CreateReplicationSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The ARN of the ReplicationSet. + $ref: '#/components/schemas/Arn' + additionalProperties: false + Regions: + description: The ReplicationSet configuration. + $ref: '#/components/schemas/RegionList' + DeletionProtected: + $ref: '#/components/schemas/DeletionProtected' + default: false + Tags: + description: The tags to apply to the replication set. + type: array + default: [] + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateReplicationSetRequest + type: object + required: [] + CreateResponsePlanRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The ARN of the response plan. + type: string + pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + maxLength: 1000 + Name: + description: The name of the response plan. + type: string + pattern: ^[a-zA-Z0-9_-]*$ + maxLength: 200 + minLength: 1 + DisplayName: + description: The display name of the response plan. + type: string + maxLength: 200 + minLength: 1 + ChatChannel: + $ref: '#/components/schemas/ChatChannel' + Engagements: + description: The list of engagements to use. + type: array + default: [] + maxItems: 5 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/SSMContact' + Actions: + description: The list of actions. + type: array + default: [] + uniqueItems: true + x-insertionOrder: true + maxItems: 1 + items: + $ref: '#/components/schemas/Action' + Integrations: + description: The list of integrations. + type: array + default: [] + uniqueItems: true + x-insertionOrder: true + maxItems: 1 + items: + $ref: '#/components/schemas/Integration' + Tags: + description: The tags to apply to the response plan. + type: array + default: [] + uniqueItems: true + x-insertionOrder: false + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + IncidentTemplate: + $ref: '#/components/schemas/IncidentTemplate' + x-stackQL-stringOnly: true + x-title: CreateResponsePlanRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: replication_sets: name: replication_sets id: awscc.ssmincidents.replication_sets x-cfn-schema-name: ReplicationSet - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' - AND region = 'us-east-1' - replication_set: - name: replication_set - id: awscc.ssmincidents.replication_set - x-cfn-schema-name: ReplicationSet - x-type: get + x-cfn-type-name: AWS::SSMIncidents::ReplicationSet x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ReplicationSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMIncidents::ReplicationSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMIncidents::ReplicationSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMIncidents::ReplicationSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replication_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replication_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/replication_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -480,7 +1036,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -492,13 +1048,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' AND data__Identifier = '' AND region = 'us-east-1' - response_plans: - name: response_plans - id: awscc.ssmincidents.response_plans - x-cfn-schema-name: ResponsePlan - x-type: list + replication_sets_list_only: + name: replication_sets_list_only + id: awscc.ssmincidents.replication_sets_list_only + x-cfn-schema-name: ReplicationSet + x-cfn-type-name: AWS::SSMIncidents::ReplicationSet x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -507,7 +1069,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -515,19 +1077,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' AND region = 'us-east-1' - response_plan: - name: response_plan - id: awscc.ssmincidents.response_plan + response_plans: + name: response_plans + id: awscc.ssmincidents.response_plans x-cfn-schema-name: ResponsePlan - x-type: get + x-cfn-type-name: AWS::SSMIncidents::ResponsePlan x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResponsePlan&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMIncidents::ResponsePlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMIncidents::ResponsePlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMIncidents::ResponsePlan" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/response_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/response_plans/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/response_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -545,7 +1155,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -562,3 +1172,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' AND data__Identifier = '' AND region = 'us-east-1' + response_plans_list_only: + name: response_plans_list_only + id: awscc.ssmincidents.response_plans_list_only + x-cfn-schema-name: ResponsePlan + x-cfn-type-name: AWS::SSMIncidents::ResponsePlan + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ReplicationSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateReplicationSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateReplicationSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResponsePlan&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResponsePlan + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResponsePlanRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/ssmquicksetup.yaml b/providers/src/awscc/v00.00.00000/services/ssmquicksetup.yaml new file mode 100644 index 00000000..bf28039c --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/ssmquicksetup.yaml @@ -0,0 +1,1014 @@ +openapi: 3.0.0 +info: + title: SSMQuickSetup + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ConfigurationDefinition: + type: object + properties: + Type: + type: string + pattern: ^[a-zA-Z0-9_\-.:/]{3,200}$ + Parameters: + $ref: '#/components/schemas/ConfigurationParametersMap' + TypeVersion: + type: string + maxLength: 128 + minLength: 1 + LocalDeploymentExecutionRoleName: + type: string + maxLength: 256 + minLength: 1 + LocalDeploymentAdministrationRoleArn: + type: string + id: + type: string + required: + - Parameters + - Type + additionalProperties: false + ConfigurationParametersMap: + type: object + x-patternProperties: + ^[A-Za-z0-9+=@_\/\s-]+$: + type: string + maxLength: 40960 + additionalProperties: false + Status: + type: string + enum: + - INITIALIZING + - DEPLOYING + - SUCCEEDED + - DELETING + - STOPPING + - FAILED + - STOPPED + - DELETE_FAILED + - STOP_FAILED + - NONE + StatusDetails: + type: object + x-patternProperties: + .+: + type: string + additionalProperties: false + StatusSummary: + type: object + properties: + StatusType: + $ref: '#/components/schemas/StatusType' + Status: + $ref: '#/components/schemas/Status' + StatusMessage: + type: string + LastUpdatedAt: + type: string + StatusDetails: + $ref: '#/components/schemas/StatusDetails' + required: + - LastUpdatedAt + - StatusType + additionalProperties: false + StatusType: + type: string + enum: + - Deployment + - AsyncExecutions + TagsMap: + type: object + x-patternProperties: + ^[A-Za-z0-9 +=@_\/:.-]+$: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[A-Za-z0-9 +=@_\/:.-]+$ + additionalProperties: false + ConfigurationManager: + type: object + properties: + ConfigurationDefinitions: + type: array + items: + $ref: '#/components/schemas/ConfigurationDefinition' + CreatedAt: + type: string + Description: + type: string + pattern: ^.{0,512}$ + LastModifiedAt: + type: string + ManagerArn: + type: string + Name: + type: string + pattern: ^[ A-Za-z0-9_-]{1,50}$ + StatusSummaries: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/StatusSummary' + Tags: + $ref: '#/components/schemas/TagsMap' + required: + - ConfigurationDefinitions + x-stackql-resource-name: configuration_manager + description: Definition of AWS::SSMQuickSetup::ConfigurationManager Resource Type + x-type-name: AWS::SSMQuickSetup::ConfigurationManager + x-stackql-primary-identifier: + - ManagerArn + x-create-only-properties: + - ConfigurationDefinitions/*/Type + - ConfigurationDefinitions/*/TypeVersion + x-read-only-properties: + - CreatedAt + - LastModifiedAt + - ManagerArn + - StatusSummaries + - ConfigurationDefinitions/*/id + x-required-properties: + - ConfigurationDefinitions + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: false + permissions: + - ssm-quicksetup:TagResource + - ssm-quicksetup:UntagResource + x-required-permissions: + create: + - iam:GetRole + - iam:CreateServiceLinkedRole + - iam:ListRoles + - iam:PassRole + - ssm-quicksetup:CreateConfigurationManager + - ssm-quicksetup:GetConfigurationManager + - ssm-quicksetup:TagResource + - ssm-quicksetup:UntagResource + - ssm-quicksetup:UpdateConfigurationManager + - ssm:Describe* + - ssm:Get* + - ssm:List* + - ssm:DeleteAssociation + - ssm:CreateResourceDataSync + - ssm:UpdateResourceDataSync + - ssm:StartAutomationExecution + - ssm:CreateAssociation + - ssm:StartAssociationsOnce + - cloudformation:List* + - cloudformation:Describe* + - cloudformation:CreateStack + - cloudformation:CreateStackInstances + - cloudformation:CreateStackSet + - cloudformation:DeleteStack + - cloudformation:DeleteStackInstances + - cloudformation:DeleteStackSet + - cloudformation:UpdateStack + - cloudformation:UpdateStackSet + - cloudformation:StopStackSetOperation + - cloudformation:GetTemplate + - cloudformation:RollbackStack + - cloudformation:TagResource + - cloudformation:UntagResource + - organizations:Describe* + - organizations:List* + - organizations:RegisterDelegatedAdministrator + - organizations:DeregisterDelegatedAdministrator + - organizations:EnableAWSServiceAccess + read: + - ssm-quicksetup:GetConfigurationManager + - iam:GetRole + - iam:PassRole + - iam:ListRoles + - ssm:DescribeDocument + - ssm:GetDocument + update: + - iam:GetRole + - iam:CreateServiceLinkedRole + - iam:ListRoles + - iam:PassRole + - ssm-quicksetup:GetConfigurationManager + - ssm-quicksetup:TagResource + - ssm-quicksetup:UntagResource + - ssm-quicksetup:UpdateConfigurationManager + - ssm-quicksetup:UpdateConfigurationDefinition + - ssm:Describe* + - ssm:Get* + - ssm:List* + - ssm:DeleteAssociation + - ssm:CreateResourceDataSync + - ssm:UpdateResourceDataSync + - ssm:StartAutomationExecution + - ssm:CreateAssociation + - ssm:StartAssociationsOnce + - cloudformation:List* + - cloudformation:Describe* + - cloudformation:CreateStack + - cloudformation:CreateStackInstances + - cloudformation:CreateStackSet + - cloudformation:DeleteStack + - cloudformation:DeleteStackInstances + - cloudformation:DeleteStackSet + - cloudformation:UpdateStack + - cloudformation:UpdateStackSet + - cloudformation:StopStackSetOperation + - cloudformation:GetTemplate + - cloudformation:RollbackStack + - cloudformation:TagResource + - cloudformation:UntagResource + - organizations:Describe* + - organizations:List* + - organizations:RegisterDelegatedAdministrator + - organizations:DeregisterDelegatedAdministrator + - organizations:EnableAWSServiceAccess + delete: + - ssm-quicksetup:DeleteConfigurationManager + - iam:GetRole + - iam:CreateServiceLinkedRole + - iam:ListRoles + - iam:PassRole + - ssm-quicksetup:GetConfigurationManager + - ssm-quicksetup:ListConfigurationManagers + - ssm-quicksetup:TagResource + - ssm-quicksetup:UntagResource + - ssm-quicksetup:UpdateConfigurationManager + - ssm:Describe* + - ssm:Get* + - ssm:List* + - ssm:DeleteAssociation + - ssm:CreateResourceDataSync + - ssm:UpdateResourceDataSync + - ssm:StartAutomationExecution + - ssm:CreateAssociation + - ssm:StartAssociationsOnce + - cloudformation:List* + - cloudformation:Describe* + - cloudformation:CreateStack + - cloudformation:CreateStackInstances + - cloudformation:CreateStackSet + - cloudformation:DeleteStack + - cloudformation:DeleteStackInstances + - cloudformation:DeleteStackSet + - cloudformation:UpdateStack + - cloudformation:UpdateStackSet + - cloudformation:StopStackSetOperation + - cloudformation:GetTemplate + - cloudformation:RollbackStack + - cloudformation:TagResource + - cloudformation:UntagResource + - organizations:Describe* + - organizations:List* + - organizations:RegisterDelegatedAdministrator + - organizations:DeregisterDelegatedAdministrator + - organizations:EnableAWSServiceAccess + list: + - ssm-quicksetup:ListConfigurationManagers + CreateConfigurationManagerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConfigurationDefinitions: + type: array + items: + $ref: '#/components/schemas/ConfigurationDefinition' + CreatedAt: + type: string + Description: + type: string + pattern: ^.{0,512}$ + LastModifiedAt: + type: string + ManagerArn: + type: string + Name: + type: string + pattern: ^[ A-Za-z0-9_-]{1,50}$ + StatusSummaries: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/StatusSummary' + Tags: + $ref: '#/components/schemas/TagsMap' + x-stackQL-stringOnly: true + x-title: CreateConfigurationManagerRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + configuration_managers: + name: configuration_managers + id: awscc.ssmquicksetup.configuration_managers + x-cfn-schema-name: ConfigurationManager + x-cfn-type-name: AWS::SSMQuickSetup::ConfigurationManager + x-identifiers: + - ManagerArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationManager&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMQuickSetup::ConfigurationManager" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMQuickSetup::ConfigurationManager" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSMQuickSetup::ConfigurationManager" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_managers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_managers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/configuration_managers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ConfigurationDefinitions') as configuration_definitions, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.LastModifiedAt') as last_modified_at, + JSON_EXTRACT(Properties, '$.ManagerArn') as manager_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.StatusSummaries') as status_summaries, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMQuickSetup::ConfigurationManager' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConfigurationDefinitions') as configuration_definitions, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LastModifiedAt') as last_modified_at, + json_extract_path_text(Properties, 'ManagerArn') as manager_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'StatusSummaries') as status_summaries, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSMQuickSetup::ConfigurationManager' + AND data__Identifier = '' + AND region = 'us-east-1' + configuration_managers_list_only: + name: configuration_managers_list_only + id: awscc.ssmquicksetup.configuration_managers_list_only + x-cfn-schema-name: ConfigurationManager + x-cfn-type-name: AWS::SSMQuickSetup::ConfigurationManager + x-identifiers: + - ManagerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ManagerArn') as manager_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMQuickSetup::ConfigurationManager' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ManagerArn') as manager_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSMQuickSetup::ConfigurationManager' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationManager&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationManager + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationManagerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/sso.yaml b/providers/src/awscc/v00.00.00000/services/sso.yaml index fb2bd85e..3ba5c108 100644 --- a/providers/src/awscc/v00.00.00000/services/sso.yaml +++ b/providers/src/awscc/v00.00.00000/services/sso.yaml @@ -1,10 +1,592 @@ openapi: 3.0.0 info: title: SSO - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + Tag: + description: The metadata that you apply to the permission set to help you categorize and organize them. + type: object + properties: + Key: + type: string + pattern: '[\w+=,.@-]+' + minLength: 1 + maxLength: 128 + Value: + type: string + pattern: '[\w+=,.@-]+' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + SignInOptions: + description: A structure that describes the sign-in options for an application portal + type: object + properties: + Origin: + description: This determines how IAM Identity Center navigates the user to the target application + type: string + enum: + - IDENTITY_CENTER + - APPLICATION + ApplicationUrl: + description: The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION + type: string + pattern: ^http(s)?:\/\/[-a-zA-Z0-9+&@#\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\/%?=~_|]$ + minLength: 1 + maxLength: 512 + required: + - Origin + additionalProperties: false + PortalOptionsConfiguration: + description: A structure that describes the options for the access portal associated with an application + type: object + properties: + Visibility: + description: Indicates whether this application is visible in the access portal + type: string + enum: + - ENABLED + - DISABLED + SignInOptions: + description: A structure that describes the sign-in options for the access portal + $ref: '#/components/schemas/SignInOptions' + required: [] + additionalProperties: false + Application: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Application + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 0 + maxLength: 255 + Description: + description: The description information for the Identity Center (SSO) Application + type: string + minLength: 1 + maxLength: 128 + InstanceArn: + description: The ARN of the instance of IAM Identity Center under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationArn: + description: The Application ARN that is returned upon creation of the Identity Center (SSO) Application + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationProviderArn: + description: The ARN of the application provider under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$ + minLength: 10 + maxLength: 1224 + Status: + description: Specifies whether the application is enabled or disabled + type: string + enum: + - ENABLED + - DISABLED + PortalOptions: + description: A structure that describes the options for the portal associated with an application + $ref: '#/components/schemas/PortalOptionsConfiguration' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + description: Specifies tags to be attached to the application + $ref: '#/components/schemas/Tag' + maxItems: 75 + required: + - Name + - InstanceArn + - ApplicationProviderArn + x-stackql-resource-name: application + description: Resource Type definition for Identity Center (SSO) Application + x-type-name: AWS::SSO::Application + x-stackql-primary-identifier: + - ApplicationArn + x-create-only-properties: + - InstanceArn + - ApplicationProviderArn + x-read-only-properties: + - ApplicationArn + x-required-properties: + - Name + - InstanceArn + - ApplicationProviderArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sso:TagResource + - sso:UntagResource + x-required-permissions: + create: + - sso:CreateApplication + - sso:DescribeApplication + - sso:TagResource + - sso:ListTagsForResource + read: + - sso:DescribeApplication + - sso:ListTagsForResource + update: + - sso:UpdateApplication + - sso:TagResource + - sso:UntagResource + - sso:ListTagsForResource + - sso:DescribeApplication + delete: + - sso:DeleteApplication + list: + - sso:ListApplications + - sso:ListTagsForResource + ApplicationAssignment: + type: object + properties: + ApplicationArn: + description: The ARN of the application. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16} + minLength: 10 + maxLength: 1224 + PrincipalType: + description: The entity type for which the assignment will be created. + type: string + enum: + - USER + - GROUP + PrincipalId: + description: An identifier for an object in IAM Identity Center, such as a user or group + type: string + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + minLength: 1 + maxLength: 47 + required: + - ApplicationArn + - PrincipalType + - PrincipalId + x-stackql-resource-name: application_assignment + description: Resource Type definition for SSO application access grant to a user or group. + x-type-name: AWS::SSO::ApplicationAssignment + x-stackql-primary-identifier: + - ApplicationArn + - PrincipalType + - PrincipalId + x-create-only-properties: + - ApplicationArn + - PrincipalType + - PrincipalId + x-required-properties: + - ApplicationArn + - PrincipalType + - PrincipalId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + x-required-permissions: + create: + - sso:CreateApplicationAssignment + - sso:DescribeApplicationAssignment + read: + - sso:DescribeApplicationAssignment + delete: + - sso:DeleteApplicationAssignment + list: + - sso:ListApplicationAssignments Assignment: type: object properties: @@ -49,7 +631,9 @@ components: - PrincipalType - PrincipalId x-stackql-resource-name: assignment - x-stackql-primaryIdentifier: + description: Resource Type definition for SSO assignmet + x-type-name: AWS::SSO::Assignment + x-stackql-primary-identifier: - InstanceArn - TargetId - TargetType @@ -63,6 +647,17 @@ components: - PermissionSetArn - PrincipalType - PrincipalId + x-required-properties: + - InstanceArn + - TargetId + - TargetType + - PermissionSetArn + - PrincipalType + - PrincipalId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false x-required-permissions: create: - sso:CreateAccountAssignment @@ -87,6 +682,90 @@ components: list: - sso:ListAccountAssignments - iam:ListRolePolicies + Instance: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Instance + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 1 + maxLength: 32 + InstanceArn: + description: The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + OwnerAccountId: + description: The AWS accountId of the owner of the Identity Center (SSO) Instance + type: string + pattern: ^\d{12}?$ + minLength: 12 + maxLength: 12 + IdentityStoreId: + description: The ID of the identity store associated with the created Identity Center (SSO) Instance + type: string + pattern: ^[a-zA-Z0-9-]*$ + minLength: 1 + maxLength: 64 + Status: + description: The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active + type: string + enum: + - CREATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - ACTIVE + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 75 + x-stackql-resource-name: instance + description: Resource Type definition for Identity Center (SSO) Instance + x-type-name: AWS::SSO::Instance + x-stackql-primary-identifier: + - InstanceArn + x-read-only-properties: + - InstanceArn + - OwnerAccountId + - IdentityStoreId + - Status + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + permissions: + - sso:TagInstance + - sso:TagResource + - sso:UntagResource + - sso:ListTagsForResource + x-required-permissions: + create: + - sso:CreateInstance + - sso:DescribeInstance + - sso:TagResource + - iam:CreateServiceLinkedRole + - sso:TagInstance + - sso:ListTagsForResource + read: + - sso:DescribeInstance + - sso:ListTagsForResource + update: + - sso:UpdateInstance + - sso:TagResource + - sso:UntagResource + - sso:ListTagsForResource + - sso:TagInstance + - sso:DescribeInstance + delete: + - sso:DeleteInstance + list: + - sso:ListInstances AccessControlAttributeValueSource: type: string minLength: 0 @@ -149,10 +828,18 @@ components: required: - InstanceArn x-stackql-resource-name: instance_access_control_attribute_configuration - x-stackql-primaryIdentifier: + description: Resource Type definition for SSO InstanceAccessControlAttributeConfiguration + x-type-name: AWS::SSO::InstanceAccessControlAttributeConfiguration + x-stackql-primary-identifier: - InstanceArn x-create-only-properties: - InstanceArn + x-required-properties: + - InstanceArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false x-required-permissions: create: - sso:CreateInstanceAccessControlAttributeConfiguration @@ -168,24 +855,6 @@ components: - sso:DescribeInstanceAccessControlAttributeConfiguration list: - sso:DescribeInstanceAccessControlAttributeConfiguration - Tag: - description: The metadata that you apply to the permission set to help you categorize and organize them. - type: object - properties: - Key: - type: string - pattern: '[\w+=,.@-]+' - minLength: 1 - maxLength: 128 - Value: - type: string - pattern: '[\w+=,.@-]+' - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false ManagedPolicyArn: description: The managed policy to attach. type: string @@ -283,7 +952,9 @@ components: - Name - InstanceArn x-stackql-resource-name: permission_set - x-stackql-primaryIdentifier: + description: Resource Type definition for SSO PermissionSet + x-type-name: AWS::SSO::PermissionSet + x-stackql-primary-identifier: - InstanceArn - PermissionSetArn x-create-only-properties: @@ -291,6 +962,18 @@ components: - Name x-read-only-properties: - PermissionSetArn + x-required-properties: + - Name + - InstanceArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - sso:TagResource + - sso:UntagResource x-required-permissions: create: - sso:CreatePermissionSet @@ -336,12 +1019,563 @@ components: - sso:DeletePermissionSet list: - sso:DescribePermissionSet + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Application + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 0 + maxLength: 255 + Description: + description: The description information for the Identity Center (SSO) Application + type: string + minLength: 1 + maxLength: 128 + InstanceArn: + description: The ARN of the instance of IAM Identity Center under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationArn: + description: The Application ARN that is returned upon creation of the Identity Center (SSO) Application + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationProviderArn: + description: The ARN of the application provider under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$ + minLength: 10 + maxLength: 1224 + Status: + description: Specifies whether the application is enabled or disabled + type: string + enum: + - ENABLED + - DISABLED + PortalOptions: + description: A structure that describes the options for the portal associated with an application + $ref: '#/components/schemas/PortalOptionsConfiguration' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + description: Specifies tags to be attached to the application + $ref: '#/components/schemas/Tag' + maxItems: 75 + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateApplicationAssignmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationArn: + description: The ARN of the application. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16} + minLength: 10 + maxLength: 1224 + PrincipalType: + description: The entity type for which the assignment will be created. + type: string + enum: + - USER + - GROUP + PrincipalId: + description: An identifier for an object in IAM Identity Center, such as a user or group + type: string + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + minLength: 1 + maxLength: 47 + x-stackQL-stringOnly: true + x-title: CreateApplicationAssignmentRequest + type: object + required: [] + CreateAssignmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The sso instance that the permission set is owned. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + minLength: 10 + maxLength: 1224 + TargetId: + description: The account id to be provisioned. + type: string + pattern: \d{12} + TargetType: + description: The type of resource to be provsioned to, only aws account now + type: string + enum: + - AWS_ACCOUNT + PermissionSetArn: + description: The permission set that the assignemt will be assigned + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16} + minLength: 10 + maxLength: 1224 + PrincipalType: + description: The assignee's type, user/group + type: string + enum: + - USER + - GROUP + PrincipalId: + description: The assignee's identifier, user id/group id + type: string + pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ + minLength: 1 + maxLength: 47 + x-stackQL-stringOnly: true + x-title: CreateAssignmentRequest + type: object + required: [] + CreateInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Instance + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 1 + maxLength: 32 + InstanceArn: + description: The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + OwnerAccountId: + description: The AWS accountId of the owner of the Identity Center (SSO) Instance + type: string + pattern: ^\d{12}?$ + minLength: 12 + maxLength: 12 + IdentityStoreId: + description: The ID of the identity store associated with the created Identity Center (SSO) Instance + type: string + pattern: ^[a-zA-Z0-9-]*$ + minLength: 1 + maxLength: 64 + Status: + description: The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active + type: string + enum: + - CREATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - ACTIVE + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 75 + x-stackQL-stringOnly: true + x-title: CreateInstanceRequest + type: object + required: [] + CreateInstanceAccessControlAttributeConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The ARN of the AWS SSO instance under which the operation will be executed. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + minLength: 10 + maxLength: 1224 + InstanceAccessControlAttributeConfiguration: + description: The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead. + type: object + properties: + AccessControlAttributes: + $ref: '#/components/schemas/AccessControlAttributeList' + required: + - AccessControlAttributes + additionalProperties: false + AccessControlAttributes: + $ref: '#/components/schemas/AccessControlAttributeList' + x-stackQL-stringOnly: true + x-title: CreateInstanceAccessControlAttributeConfigurationRequest + type: object + required: [] + CreatePermissionSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this permission set. + type: string + pattern: '[\w+=,.@-]+' + minLength: 1 + maxLength: 32 + PermissionSetArn: + description: The permission set that the policy will be attached to + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16} + minLength: 10 + maxLength: 1224 + Description: + description: The permission set description. + type: string + pattern: '[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*' + minLength: 1 + maxLength: 700 + InstanceArn: + description: The sso instance arn that the permission set is owned. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + minLength: 10 + maxLength: 1224 + SessionDuration: + description: The length of time that a user can be signed in to an AWS account. + type: string + pattern: ^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$ + minLength: 1 + maxLength: 100 + RelayStateType: + description: The relay state URL that redirect links to any service in the AWS Management Console. + type: string + pattern: '[a-zA-Z0-9&$@#\/%?=~\-_''"|!:,.;*+\[\]\ \(\)\{\}]+' + minLength: 1 + maxLength: 240 + ManagedPolicies: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/ManagedPolicyArn' + maxItems: 20 + default: [] + InlinePolicy: + description: The inline policy to put in permission set. + type: object + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + CustomerManagedPolicyReferences: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CustomerManagedPolicyReference' + maxItems: 20 + default: [] + PermissionsBoundary: + $ref: '#/components/schemas/PermissionsBoundary' + x-stackQL-stringOnly: true + x-title: CreatePermissionSetRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: + applications: + name: applications + id: awscc.sso.applications + x-cfn-schema-name: Application + x-cfn-type-name: AWS::SSO::Application + x-identifiers: + - ApplicationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ApplicationProviderArn') as application_provider_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.PortalOptions') as portal_options, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationProviderArn') as application_provider_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'PortalOptions') as portal_options, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.sso.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::SSO::Application + x-identifiers: + - ApplicationArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Application' + AND region = 'us-east-1' + application_assignments: + name: application_assignments + id: awscc.sso.application_assignments + x-cfn-schema-name: ApplicationAssignment + x-cfn-type-name: AWS::SSO::ApplicationAssignment + x-identifiers: + - ApplicationArn + - PrincipalType + - PrincipalId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationAssignment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::ApplicationAssignment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::ApplicationAssignment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_assignments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_assignments/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, + JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'PrincipalType') as principal_type, + json_extract_path_text(Properties, 'PrincipalId') as principal_id + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND data__Identifier = '||' + AND region = 'us-east-1' + application_assignments_list_only: + name: application_assignments_list_only + id: awscc.sso.application_assignments_list_only + x-cfn-schema-name: ApplicationAssignment + x-cfn-type-name: AWS::SSO::ApplicationAssignment + x-identifiers: + - ApplicationArn + - PrincipalType + - PrincipalId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, + JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'PrincipalType') as principal_type, + json_extract_path_text(Properties, 'PrincipalId') as principal_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND region = 'us-east-1' assignments: name: assignments id: awscc.sso.assignments x-cfn-schema-name: Assignment - x-type: list + x-cfn-type-name: AWS::SSO::Assignment x-identifiers: - InstanceArn - TargetId @@ -349,39 +1583,78 @@ components: - PermissionSetArn - PrincipalType - PrincipalId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Assignment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Assignment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Assignment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assignments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assignments/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, JSON_EXTRACT(Properties, '$.TargetId') as target_id, JSON_EXTRACT(Properties, '$.TargetType') as target_type, JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn, JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Assignment' + AND data__Identifier = '|||||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, json_extract_path_text(Properties, 'InstanceArn') as instance_arn, json_extract_path_text(Properties, 'TargetId') as target_id, json_extract_path_text(Properties, 'TargetType') as target_type, json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, json_extract_path_text(Properties, 'PrincipalType') as principal_type, json_extract_path_text(Properties, 'PrincipalId') as principal_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Assignment' + AND data__Identifier = '|||||' AND region = 'us-east-1' - assignment: - name: assignment - id: awscc.sso.assignment + assignments_list_only: + name: assignments_list_only + id: awscc.sso.assignments_list_only x-cfn-schema-name: Assignment - x-type: get + x-cfn-type-name: AWS::SSO::Assignment x-identifiers: - InstanceArn - TargetId @@ -389,6 +1662,12 @@ components: - PermissionSetArn - PrincipalType - PrincipalId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -396,38 +1675,127 @@ components: ddl: |- SELECT region, - data__Identifier, JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, JSON_EXTRACT(Properties, '$.TargetId') as target_id, JSON_EXTRACT(Properties, '$.TargetType') as target_type, JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn, JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Assignment' - AND data__Identifier = '|||||' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, json_extract_path_text(Properties, 'InstanceArn') as instance_arn, json_extract_path_text(Properties, 'TargetId') as target_id, json_extract_path_text(Properties, 'TargetType') as target_type, json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, json_extract_path_text(Properties, 'PrincipalType') as principal_type, json_extract_path_text(Properties, 'PrincipalId') as principal_id - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Assignment' - AND data__Identifier = '|||||' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' AND region = 'us-east-1' - instance_access_control_attribute_configurations: - name: instance_access_control_attribute_configurations - id: awscc.sso.instance_access_control_attribute_configurations - x-cfn-schema-name: InstanceAccessControlAttributeConfiguration - x-type: list + instances: + name: instances + id: awscc.sso.instances + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::SSO::Instance x-identifiers: - InstanceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.OwnerAccountId') as owner_account_id, + JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Instance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Instance' + AND data__Identifier = '' + AND region = 'us-east-1' + instances_list_only: + name: instances_list_only + id: awscc.sso.instances_list_only + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::SSO::Instance + x-identifiers: + - InstanceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -436,7 +1804,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Instance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -444,19 +1812,67 @@ components: SELECT region, json_extract_path_text(Properties, 'InstanceArn') as instance_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Instance' AND region = 'us-east-1' - instance_access_control_attribute_configuration: - name: instance_access_control_attribute_configuration - id: awscc.sso.instance_access_control_attribute_configuration + instance_access_control_attribute_configurations: + name: instance_access_control_attribute_configurations + id: awscc.sso.instance_access_control_attribute_configurations x-cfn-schema-name: InstanceAccessControlAttributeConfiguration - x-type: get + x-cfn-type-name: AWS::SSO::InstanceAccessControlAttributeConfiguration x-identifiers: - InstanceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceAccessControlAttributeConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -468,7 +1884,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -479,14 +1895,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - permission_sets: - name: permission_sets - id: awscc.sso.permission_sets - x-cfn-schema-name: PermissionSet - x-type: list + instance_access_control_attribute_configurations_list_only: + name: instance_access_control_attribute_configurations_list_only + id: awscc.sso.instance_access_control_attribute_configurations_list_only + x-cfn-schema-name: InstanceAccessControlAttributeConfiguration + x-cfn-type-name: AWS::SSO::InstanceAccessControlAttributeConfiguration x-identifiers: - InstanceArn - - PermissionSetArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -494,31 +1915,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' + json_extract_path_text(Properties, 'InstanceArn') as instance_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' AND region = 'us-east-1' - permission_set: - name: permission_set - id: awscc.sso.permission_set + permission_sets: + name: permission_sets + id: awscc.sso.permission_sets x-cfn-schema-name: PermissionSet - x-type: get + x-cfn-type-name: AWS::SSO::PermissionSet x-identifiers: - InstanceArn - PermissionSetArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PermissionSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::PermissionSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::PermissionSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::PermissionSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permission_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permission_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/permission_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -538,7 +2005,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -557,3 +2024,442 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::PermissionSet' AND data__Identifier = '|' AND region = 'us-east-1' + permission_sets_list_only: + name: permission_sets_list_only + id: awscc.sso.permission_sets_list_only + x-cfn-schema-name: PermissionSet + x-cfn-type-name: AWS::SSO::PermissionSet + x-identifiers: + - InstanceArn + - PermissionSetArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationAssignment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationAssignment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationAssignmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Assignment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssignment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssignmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceAccessControlAttributeConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceAccessControlAttributeConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceAccessControlAttributeConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PermissionSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePermissionSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePermissionSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/stepfunctions.yaml b/providers/src/awscc/v00.00.00000/services/stepfunctions.yaml index 8922af0a..e936cab9 100644 --- a/providers/src/awscc/v00.00.00000/services/stepfunctions.yaml +++ b/providers/src/awscc/v00.00.00000/services/stepfunctions.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: StepFunctions - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: TagsEntry: type: object @@ -20,6 +400,25 @@ components: required: - Key - Value + EncryptionConfiguration: + type: object + additionalProperties: false + properties: + KmsKeyId: + type: string + minLength: 1 + maxLength: 2048 + KmsDataKeyReusePeriodSeconds: + type: integer + minimum: 60 + maximum: 900 + Type: + type: string + enum: + - CUSTOMER_MANAGED_KMS_KEY + - AWS_OWNED_KEY + required: + - Type Activity: type: object properties: @@ -37,18 +436,38 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/TagsEntry' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' required: - Name x-stackql-resource-name: activity - x-stackql-primaryIdentifier: + description: Resource schema for Activity + x-type-name: AWS::StepFunctions::Activity + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name + - EncryptionConfiguration x-read-only-properties: - Arn + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - states:UntagResource + - states:TagResource + - states:ListTagsForResource x-required-permissions: create: - states:CreateActivity + - states:DescribeActivity + - states:TagResource + - kms:DescribeKey read: - states:DescribeActivity - states:ListTagsForResource @@ -57,7 +476,10 @@ components: - states:TagResource - states:UntagResource delete: + - states:DescribeActivity - states:DeleteActivity + list: + - states:ListActivities CloudWatchLogsLogGroup: type: object additionalProperties: false @@ -159,6 +581,8 @@ components: $ref: '#/components/schemas/LoggingConfiguration' TracingConfiguration: $ref: '#/components/schemas/TracingConfiguration' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' DefinitionS3Location: $ref: '#/components/schemas/S3Location' DefinitionSubstitutions: @@ -174,15 +598,35 @@ components: required: - RoleArn x-stackql-resource-name: state_machine - x-stackql-primaryIdentifier: + description: Resource schema for StateMachine + x-type-name: AWS::StepFunctions::StateMachine + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - StateMachineName x-create-only-properties: - StateMachineName - StateMachineType + x-write-only-properties: + - Definition + - DefinitionS3Location + - DefinitionSubstitutions x-read-only-properties: - Arn - Name - StateMachineRevisionId + x-required-properties: + - RoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - states:UntagResource + - states:TagResource + - states:ListTagsForResource x-required-permissions: create: - states:CreateStateMachine @@ -190,15 +634,20 @@ components: - states:TagResource - iam:PassRole - s3:GetObject + - kms:DescribeKey + - kms:GenerateDataKey read: - states:DescribeStateMachine - states:ListTagsForResource + - kms:Decrypt update: - states:UpdateStateMachine - states:TagResource - states:UntagResource - states:ListTagsForResource - iam:PassRole + - kms:DescribeKey + - kms:GenerateDataKey delete: - states:DeleteStateMachine - states:DescribeStateMachine @@ -293,12 +742,18 @@ components: DeploymentPreference: $ref: '#/components/schemas/DeploymentPreference' x-stackql-resource-name: state_machine_alias - x-stackql-primaryIdentifier: + description: Resource schema for StateMachineAlias + x-type-name: AWS::StepFunctions::StateMachineAlias + x-stackql-primary-identifier: - Arn x-create-only-properties: - Name + x-write-only-properties: + - DeploymentPreference x-read-only-properties: - Arn + x-tagging: + taggable: false x-required-permissions: create: - states:CreateStateMachineAlias @@ -336,13 +791,22 @@ components: required: - StateMachineArn x-stackql-resource-name: state_machine_version - x-stackql-primaryIdentifier: + description: Resource schema for StateMachineVersion + x-type-name: AWS::StepFunctions::StateMachineVersion + x-stackql-primary-identifier: - Arn x-create-only-properties: - StateMachineArn - StateMachineRevisionId + - Description + x-write-only-properties: + - StateMachineArn x-read-only-properties: - Arn + x-required-properties: + - StateMachineArn + x-tagging: + taggable: false x-required-permissions: create: - states:PublishStateMachineVersion @@ -355,47 +819,276 @@ components: - states:DescribeStateMachine list: - states:ListStateMachineVersions + CreateActivityRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + minLength: 1 + maxLength: 2048 + Name: + type: string + minLength: 1 + maxLength: 80 + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagsEntry' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + x-stackQL-stringOnly: true + x-title: CreateActivityRequest + type: object + required: [] + CreateStateMachineRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + minLength: 1 + maxLength: 2048 + Name: + type: string + minLength: 1 + maxLength: 80 + DefinitionString: + type: string + minLength: 1 + maxLength: 1048576 + RoleArn: + type: string + minLength: 1 + maxLength: 256 + StateMachineName: + type: string + minLength: 1 + maxLength: 80 + StateMachineType: + type: string + enum: + - STANDARD + - EXPRESS + StateMachineRevisionId: + type: string + minLength: 1 + maxLength: 256 + LoggingConfiguration: + $ref: '#/components/schemas/LoggingConfiguration' + TracingConfiguration: + $ref: '#/components/schemas/TracingConfiguration' + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + DefinitionS3Location: + $ref: '#/components/schemas/S3Location' + DefinitionSubstitutions: + $ref: '#/components/schemas/DefinitionSubstitutions' + Definition: + $ref: '#/components/schemas/Definition' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/TagsEntry' + x-stackQL-stringOnly: true + x-title: CreateStateMachineRequest + type: object + required: [] + CreateStateMachineAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + minLength: 1 + maxLength: 2048 + description: The ARN of the alias. + Name: + type: string + description: The alias name. + minLength: 1 + maxLength: 80 + Description: + type: string + description: An optional description of the alias. + minLength: 1 + maxLength: 256 + RoutingConfiguration: + $ref: '#/components/schemas/RoutingConfiguration' + DeploymentPreference: + $ref: '#/components/schemas/DeploymentPreference' + x-stackQL-stringOnly: true + x-title: CreateStateMachineAliasRequest + type: object + required: [] + CreateStateMachineVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + minLength: 1 + maxLength: 2048 + StateMachineArn: + type: string + minLength: 1 + maxLength: 2048 + StateMachineRevisionId: + type: string + minLength: 1 + maxLength: 2048 + Description: + type: string + minLength: 1 + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreateStateMachineVersionRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - activity: - name: activity - id: awscc.stepfunctions.activity + activities: + name: activities + id: awscc.stepfunctions.activities x-cfn-schema-name: Activity - x-type: get + x-cfn-type-name: AWS::StepFunctions::Activity x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Activity&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::Activity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::Activity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::Activity" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/activities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/activities/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/activities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::Activity' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::Activity' AND data__Identifier = '' AND region = 'us-east-1' - state_machines: - name: state_machines - id: awscc.stepfunctions.state_machines - x-cfn-schema-name: StateMachine - x-type: list + activities_list_only: + name: activities_list_only + id: awscc.stepfunctions.activities_list_only + x-cfn-schema-name: Activity + x-cfn-type-name: AWS::StepFunctions::Activity x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -404,7 +1097,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::Activity' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -412,19 +1105,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::Activity' AND region = 'us-east-1' - state_machine: - name: state_machine - id: awscc.stepfunctions.state_machine + state_machines: + name: state_machines + id: awscc.stepfunctions.state_machines x-cfn-schema-name: StateMachine - x-type: get + x-cfn-type-name: AWS::StepFunctions::StateMachine x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StateMachine&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachine" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachine" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachine" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/state_machines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/state_machines/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/state_machines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -438,6 +1179,7 @@ components: JSON_EXTRACT(Properties, '$.StateMachineRevisionId') as state_machine_revision_id, JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration, JSON_EXTRACT(Properties, '$.TracingConfiguration') as tracing_configuration, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration, JSON_EXTRACT(Properties, '$.DefinitionS3Location') as definition_s3_location, JSON_EXTRACT(Properties, '$.DefinitionSubstitutions') as definition_substitutions, JSON_EXTRACT(Properties, '$.Definition') as definition, @@ -446,7 +1188,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -460,6 +1202,7 @@ components: json_extract_path_text(Properties, 'StateMachineRevisionId') as state_machine_revision_id, json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, json_extract_path_text(Properties, 'TracingConfiguration') as tracing_configuration, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, json_extract_path_text(Properties, 'DefinitionS3Location') as definition_s3_location, json_extract_path_text(Properties, 'DefinitionSubstitutions') as definition_substitutions, json_extract_path_text(Properties, 'Definition') as definition, @@ -467,13 +1210,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' AND data__Identifier = '' AND region = 'us-east-1' - state_machine_aliases: - name: state_machine_aliases - id: awscc.stepfunctions.state_machine_aliases - x-cfn-schema-name: StateMachineAlias - x-type: list + state_machines_list_only: + name: state_machines_list_only + id: awscc.stepfunctions.state_machines_list_only + x-cfn-schema-name: StateMachine + x-cfn-type-name: AWS::StepFunctions::StateMachine x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -482,7 +1231,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -490,19 +1239,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' AND region = 'us-east-1' - state_machine_alias: - name: state_machine_alias - id: awscc.stepfunctions.state_machine_alias + state_machine_aliases: + name: state_machine_aliases + id: awscc.stepfunctions.state_machine_aliases x-cfn-schema-name: StateMachineAlias - x-type: get + x-cfn-type-name: AWS::StepFunctions::StateMachineAlias x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StateMachineAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachineAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachineAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachineAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -516,7 +1313,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -529,13 +1326,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' AND data__Identifier = '' AND region = 'us-east-1' - state_machine_versions: - name: state_machine_versions - id: awscc.stepfunctions.state_machine_versions - x-cfn-schema-name: StateMachineVersion - x-type: list + state_machine_aliases_list_only: + name: state_machine_aliases_list_only + id: awscc.stepfunctions.state_machine_aliases_list_only + x-cfn-schema-name: StateMachineAlias + x-cfn-type-name: AWS::StepFunctions::StateMachineAlias x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -544,7 +1347,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -552,19 +1355,54 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' AND region = 'us-east-1' - state_machine_version: - name: state_machine_version - id: awscc.stepfunctions.state_machine_version + state_machine_versions: + name: state_machine_versions + id: awscc.stepfunctions.state_machine_versions x-cfn-schema-name: StateMachineVersion - x-type: get + x-cfn-type-name: AWS::StepFunctions::StateMachineVersion x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StateMachineVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachineVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::StepFunctions::StateMachineVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/state_machine_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/state_machine_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -577,7 +1415,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -589,3 +1427,355 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' AND data__Identifier = '' AND region = 'us-east-1' + state_machine_versions_list_only: + name: state_machine_versions_list_only + id: awscc.stepfunctions.state_machine_versions_list_only + x-cfn-schema-name: StateMachineVersion + x-cfn-type-name: AWS::StepFunctions::StateMachineVersion + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Activity&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateActivity + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateActivityRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StateMachine&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStateMachine + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStateMachineRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StateMachineAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStateMachineAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStateMachineAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__StateMachineVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateStateMachineVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateStateMachineVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/supportapp.yaml b/providers/src/awscc/v00.00.00000/services/supportapp.yaml index 6624e4b6..2de5fcc1 100644 --- a/providers/src/awscc/v00.00.00000/services/supportapp.yaml +++ b/providers/src/awscc/v00.00.00000/services/supportapp.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: SupportApp - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: AccountAlias: type: object @@ -23,10 +403,14 @@ components: required: - AccountAlias x-stackql-resource-name: account_alias - x-stackql-primaryIdentifier: + description: An AWS Support App resource that creates, updates, reads, and deletes a customer's account alias. + x-type-name: AWS::SupportApp::AccountAlias + x-stackql-primary-identifier: - AccountAliasResourceId x-read-only-properties: - AccountAliasResourceId + x-required-properties: + - AccountAlias x-required-permissions: create: - supportapp:PutAccountAlias @@ -90,12 +474,19 @@ components: - NotifyOnCaseSeverity - ChannelRoleArn x-stackql-resource-name: slack_channel_configuration - x-stackql-primaryIdentifier: + description: An AWS Support App resource that creates, updates, lists and deletes Slack channel configurations. + x-type-name: AWS::SupportApp::SlackChannelConfiguration + x-stackql-primary-identifier: - TeamId - ChannelId x-create-only-properties: - TeamId - ChannelId + x-required-properties: + - TeamId + - ChannelId + - NotifyOnCaseSeverity + - ChannelRoleArn x-required-permissions: create: - supportapp:CreateSlackChannelConfiguration @@ -128,10 +519,18 @@ components: required: - TeamId x-stackql-resource-name: slack_workspace_configuration - x-stackql-primaryIdentifier: + description: An AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations. + x-type-name: AWS::SupportApp::SlackWorkspaceConfiguration + x-stackql-primary-identifier: - TeamId x-create-only-properties: - TeamId + x-write-only-properties: + - VersionId + x-required-properties: + - TeamId + x-tagging: + taggable: false x-required-permissions: create: - supportapp:RegisterSlackWorkspaceForOrganization @@ -146,43 +545,188 @@ components: - supportapp:DeleteSlackWorkspaceConfiguration list: - supportapp:ListSlackWorkspaceConfigurations + CreateAccountAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountAlias: + description: An account alias associated with a customer's account. + type: string + pattern: ^[\w\- ]+$ + minLength: 1 + maxLength: 30 + AccountAliasResourceId: + description: Unique identifier representing an alias tied to an account + type: string + pattern: ^[\w\- ]+$ + minLength: 29 + maxLength: 29 + x-stackQL-stringOnly: true + x-title: CreateAccountAliasRequest + type: object + required: [] + CreateSlackChannelConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TeamId: + description: The team ID in Slack, which uniquely identifies a workspace. + type: string + pattern: ^\S+$ + minLength: 1 + maxLength: 256 + ChannelId: + description: The channel ID in Slack, which identifies a channel within a workspace. + type: string + pattern: ^\S+$ + minLength: 1 + maxLength: 256 + ChannelName: + description: The channel name in Slack. + type: string + pattern: ^.+$ + minLength: 1 + maxLength: 256 + NotifyOnCreateOrReopenCase: + description: Whether to notify when a case is created or reopened. + type: boolean + NotifyOnAddCorrespondenceToCase: + description: Whether to notify when a correspondence is added to a case. + type: boolean + NotifyOnResolveCase: + description: Whether to notify when a case is resolved. + type: boolean + NotifyOnCaseSeverity: + description: The severity level of a support case that a customer wants to get notified for. + type: string + enum: + - none + - all + - high + ChannelRoleArn: + description: The Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services. + type: string + pattern: ^arn:aws[-a-z0-9]*:iam::[0-9]{12}:role\/(.+)$ + minLength: 31 + maxLength: 2048 + x-stackQL-stringOnly: true + x-title: CreateSlackChannelConfigurationRequest + type: object + required: [] + CreateSlackWorkspaceConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TeamId: + description: The team ID in Slack, which uniquely identifies a workspace. + type: string + pattern: ^\S+$ + minLength: 1 + maxLength: 256 + VersionId: + description: An identifier used to update an existing Slack workspace configuration in AWS CloudFormation. + type: string + pattern: ^[0-9]+$ + minLength: 1 + maxLength: 256 + x-stackQL-stringOnly: true + x-title: CreateSlackWorkspaceConfigurationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: account_aliases: name: account_aliases id: awscc.supportapp.account_aliases x-cfn-schema-name: AccountAlias - x-type: list - x-identifiers: - - AccountAliasResourceId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountAliasResourceId') as account_alias_resource_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountAliasResourceId') as account_alias_resource_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' - AND region = 'us-east-1' - account_alias: - name: account_alias - id: awscc.supportapp.account_alias - x-cfn-schema-name: AccountAlias - x-type: get + x-cfn-type-name: AWS::SupportApp::AccountAlias x-identifiers: - AccountAliasResourceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccountAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::AccountAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::AccountAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::AccountAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/account_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/account_aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/account_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -193,7 +737,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -203,14 +747,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' AND data__Identifier = '' AND region = 'us-east-1' - slack_channel_configurations: - name: slack_channel_configurations - id: awscc.supportapp.slack_channel_configurations - x-cfn-schema-name: SlackChannelConfiguration - x-type: list + account_aliases_list_only: + name: account_aliases_list_only + id: awscc.supportapp.account_aliases_list_only + x-cfn-schema-name: AccountAlias + x-cfn-type-name: AWS::SupportApp::AccountAlias x-identifiers: - - TeamId - - ChannelId + - AccountAliasResourceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -218,31 +767,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TeamId') as team_id, - JSON_EXTRACT(Properties, '$.ChannelId') as channel_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' + JSON_EXTRACT(Properties, '$.AccountAliasResourceId') as account_alias_resource_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TeamId') as team_id, - json_extract_path_text(Properties, 'ChannelId') as channel_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' + json_extract_path_text(Properties, 'AccountAliasResourceId') as account_alias_resource_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' AND region = 'us-east-1' - slack_channel_configuration: - name: slack_channel_configuration - id: awscc.supportapp.slack_channel_configuration + slack_channel_configurations: + name: slack_channel_configurations + id: awscc.supportapp.slack_channel_configurations x-cfn-schema-name: SlackChannelConfiguration - x-type: get + x-cfn-type-name: AWS::SupportApp::SlackChannelConfiguration x-identifiers: - TeamId - ChannelId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SlackChannelConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::SlackChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::SlackChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::SlackChannelConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -259,7 +854,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -275,13 +870,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' AND data__Identifier = '|' AND region = 'us-east-1' - slack_workspace_configurations: - name: slack_workspace_configurations - id: awscc.supportapp.slack_workspace_configurations - x-cfn-schema-name: SlackWorkspaceConfiguration - x-type: list + slack_channel_configurations_list_only: + name: slack_channel_configurations_list_only + id: awscc.supportapp.slack_channel_configurations_list_only + x-cfn-schema-name: SlackChannelConfiguration + x-cfn-type-name: AWS::SupportApp::SlackChannelConfiguration x-identifiers: - TeamId + - ChannelId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -289,28 +891,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TeamId') as team_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' + JSON_EXTRACT(Properties, '$.TeamId') as team_id, + JSON_EXTRACT(Properties, '$.ChannelId') as channel_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TeamId') as team_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' + json_extract_path_text(Properties, 'TeamId') as team_id, + json_extract_path_text(Properties, 'ChannelId') as channel_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' AND region = 'us-east-1' - slack_workspace_configuration: - name: slack_workspace_configuration - id: awscc.supportapp.slack_workspace_configuration + slack_workspace_configurations: + name: slack_workspace_configurations + id: awscc.supportapp.slack_workspace_configurations x-cfn-schema-name: SlackWorkspaceConfiguration - x-type: get + x-cfn-type-name: AWS::SupportApp::SlackWorkspaceConfiguration x-identifiers: - TeamId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SlackWorkspaceConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::SlackWorkspaceConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::SlackWorkspaceConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SupportApp::SlackWorkspaceConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -321,7 +973,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -331,3 +983,313 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' AND data__Identifier = '' AND region = 'us-east-1' + slack_workspace_configurations_list_only: + name: slack_workspace_configurations_list_only + id: awscc.supportapp.slack_workspace_configurations_list_only + x-cfn-schema-name: SlackWorkspaceConfiguration + x-cfn-type-name: AWS::SupportApp::SlackWorkspaceConfiguration + x-identifiers: + - TeamId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TeamId') as team_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TeamId') as team_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccountAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccountAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccountAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SlackChannelConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSlackChannelConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSlackChannelConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SlackWorkspaceConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSlackWorkspaceConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSlackWorkspaceConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/synthetics.yaml b/providers/src/awscc/v00.00.00000/services/synthetics.yaml index fb97f0c0..a6595400 100644 --- a/providers/src/awscc/v00.00.00000/services/synthetics.yaml +++ b/providers/src/awscc/v00.00.00000/services/synthetics.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Synthetics - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Schedule: type: object @@ -13,6 +393,9 @@ components: type: string DurationInSeconds: type: string + RetryConfig: + $ref: '#/components/schemas/RetryConfig' + description: Provide canary auto retry configuration required: - Expression Code: @@ -31,6 +414,12 @@ components: type: string SourceLocationArn: type: string + Dependencies: + type: array + description: List of Lambda layers to attach to the canary + maxItems: 1 + items: + $ref: '#/components/schemas/Dependency' required: - Handler oneOf: @@ -39,6 +428,23 @@ components: - S3Key - required: - Script + Dependency: + type: object + additionalProperties: false + properties: + Type: + type: string + enum: + - LambdaLayer + description: Type of dependency + Reference: + type: string + description: ARN of the Lambda layer + pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+ + minLength: 1 + maxLength: 140 + required: + - Reference Tag: description: A key-value pair to associate with a resource. additionalProperties: false @@ -73,6 +479,9 @@ components: type: array items: type: string + Ipv6AllowedForDualStack: + description: Allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets if set to true + type: boolean required: - SubnetIds - SecurityGroupIds @@ -86,6 +495,9 @@ components: MemoryInMB: description: Provide maximum memory available for canary in MB type: integer + EphemeralStorage: + description: Provide ephemeralStorage available for canary in MB + type: integer ActiveTracing: description: Enable active tracing if set to true type: boolean @@ -108,6 +520,8 @@ components: description: List of screenshots used as base reference for visual testing items: $ref: '#/components/schemas/BaseScreenshot' + BrowserType: + $ref: '#/components/schemas/BrowserType' required: - BaseCanaryRunId BaseScreenshot: @@ -141,13 +555,40 @@ components: KmsKeyArn: type: string description: KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only. + ResourceToTag: + type: string + description: Specifies which resources canary tags should be replicated to. + enum: + - lambda-function + RetryConfig: + type: object + additionalProperties: false + properties: + MaxRetries: + type: integer + description: maximum times the canary will be retried upon the scheduled run failure + required: + - MaxRetries + BrowserConfig: + type: object + additionalProperties: false + properties: + BrowserType: + $ref: '#/components/schemas/BrowserType' + required: + - BrowserType + BrowserType: + type: string + enum: + - CHROME + - FIREFOX Canary: type: object properties: Name: description: Name of the canary. type: string - pattern: ^[0-9a-z_\-]{1,21}$ + pattern: ^[0-9a-z_\-]{1,255}$ Id: description: Id of the canary type: string @@ -199,6 +640,35 @@ components: DeleteLambdaResourcesOnCanaryDeletion: description: Deletes associated lambda resources created by Synthetics if set to True. Default is False type: boolean + ResourcesToReplicateTags: + type: array + uniqueItems: true + description: List of resources which canary tags should be replicated to. + items: + $ref: '#/components/schemas/ResourceToTag' + ProvisionedResourceCleanup: + description: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC. + type: string + enum: + - AUTOMATIC + - 'OFF' + DryRunAndUpdate: + description: Setting to control if UpdateCanary will perform a DryRun and validate it is PASSING before performing the Update. Default is FALSE. + type: boolean + BrowserConfigs: + description: List of browser configurations for the canary + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/BrowserConfig' + VisualReferences: + description: List of visual references for the canary + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/VisualReference' required: - Name - Code @@ -207,14 +677,44 @@ components: - Schedule - RuntimeVersion x-stackql-resource-name: canary - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Synthetics::Canary + x-type-name: AWS::Synthetics::Canary + x-stackql-primary-identifier: - Name x-create-only-properties: - Name + x-write-only-properties: + - Code/S3Bucket + - Code/S3Key + - Code/S3ObjectVersion + - Code/Script + - DeleteLambdaResourcesOnCanaryDeletion + - StartCanaryAfterCreation + - ResourcesToReplicateTags + - RunConfig/EnvironmentVariables + - VisualReference + - VisualReferences + - DryRunAndUpdate x-read-only-properties: - Id - State - Code/SourceLocationArn + x-required-properties: + - Name + - Code + - ArtifactS3Location + - ExecutionRoleArn + - Schedule + - RuntimeVersion + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - synthetics:TagResource + - synthetics:UntagResource x-required-permissions: create: - synthetics:CreateCanary @@ -230,11 +730,13 @@ components: - lambda:CreateFunction - lambda:AddPermission - lambda:PublishVersion + - lambda:UpdateFunctionCode - lambda:UpdateFunctionConfiguration - lambda:GetFunctionConfiguration - lambda:GetLayerVersionByArn - lambda:GetLayerVersion - lambda:PublishLayerVersion + - lambda:TagResource - ec2:DescribeVpcs - ec2:DescribeSubnets - ec2:DescribeSecurityGroups @@ -242,8 +744,10 @@ components: update: - synthetics:UpdateCanary - synthetics:StartCanary + - synthetics:StartCanaryDryRun - synthetics:StopCanary - synthetics:GetCanary + - synthetics:GetCanaryRuns - synthetics:TagResource - synthetics:UntagResource - s3:GetObject @@ -253,12 +757,19 @@ components: - s3:GetBucketLocation - lambda:AddPermission - lambda:PublishVersion + - lambda:UpdateFunctionCode - lambda:UpdateFunctionConfiguration - lambda:GetFunctionConfiguration - lambda:GetLayerVersionByArn - lambda:GetLayerVersion - lambda:PublishLayerVersion + - lambda:ListTags + - lambda:TagResource + - lambda:UntagResource - iam:PassRole + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups read: - synthetics:GetCanary - synthetics:DescribeCanaries @@ -269,12 +780,14 @@ components: delete: - synthetics:DeleteCanary - synthetics:GetCanary + - lambda:DeleteFunction + - lambda:DeleteLayerVersion list: - synthetics:DescribeCanaries ResourceArn: type: string description: Provide Canary Arn associated with the group. - pattern: arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:canary:[0-9a-z_\-] + pattern: arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b|e|f?)))?-[a-z]+-\d{1}:\d{12}:canary:[0-9a-z_\-] Group: type: object properties: @@ -300,12 +813,26 @@ components: required: - Name x-stackql-resource-name: group - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Synthetics::Group + x-type-name: AWS::Synthetics::Group + x-stackql-primary-identifier: - Name x-create-only-properties: - Name x-read-only-properties: - Id + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - synthetics:TagResource + - synthetics:UntagResource + - synthetics:ListTagsForResource x-required-permissions: create: - synthetics:CreateGroup @@ -328,43 +855,210 @@ components: - synthetics:GetGroup list: - synthetics:ListGroups + CreateCanaryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the canary. + type: string + pattern: ^[0-9a-z_\-]{1,255}$ + Id: + description: Id of the canary + type: string + State: + description: State of the canary + type: string + Code: + description: Provide the canary script source + $ref: '#/components/schemas/Code' + ArtifactS3Location: + description: Provide the s3 bucket output location for test results + type: string + pattern: ^(s3|S3):// + ArtifactConfig: + description: Provide artifact configuration + $ref: '#/components/schemas/ArtifactConfig' + Schedule: + description: Frequency to run your canaries + $ref: '#/components/schemas/Schedule' + ExecutionRoleArn: + description: Lambda Execution role used to run your canaries + type: string + RuntimeVersion: + description: Runtime version of Synthetics Library + type: string + SuccessRetentionPeriod: + description: Retention period of successful canary runs represented in number of days + type: integer + FailureRetentionPeriod: + description: Retention period of failed canary runs represented in number of days + type: integer + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + VPCConfig: + description: Provide VPC Configuration if enabled. + $ref: '#/components/schemas/VPCConfig' + RunConfig: + description: Provide canary run configuration + $ref: '#/components/schemas/RunConfig' + StartCanaryAfterCreation: + description: Runs canary if set to True. Default is False + type: boolean + VisualReference: + description: Visual reference configuration for visual testing + $ref: '#/components/schemas/VisualReference' + DeleteLambdaResourcesOnCanaryDeletion: + description: Deletes associated lambda resources created by Synthetics if set to True. Default is False + type: boolean + ResourcesToReplicateTags: + type: array + uniqueItems: true + description: List of resources which canary tags should be replicated to. + items: + $ref: '#/components/schemas/ResourceToTag' + ProvisionedResourceCleanup: + description: Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC. + type: string + enum: + - AUTOMATIC + - 'OFF' + DryRunAndUpdate: + description: Setting to control if UpdateCanary will perform a DryRun and validate it is PASSING before performing the Update. Default is FALSE. + type: boolean + BrowserConfigs: + description: List of browser configurations for the canary + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/BrowserConfig' + VisualReferences: + description: List of visual references for the canary + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/VisualReference' + x-stackQL-stringOnly: true + x-title: CreateCanaryRequest + type: object + required: [] + CreateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: Name of the group. + type: string + pattern: ^[0-9a-z_\-]{1,64}$ + Id: + description: Id of the group. + type: string + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + minItems: 0 + ResourceArns: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/ResourceArn' + maxItems: 10 + x-stackQL-stringOnly: true + x-title: CreateGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: canaries: name: canaries id: awscc.synthetics.canaries x-cfn-schema-name: Canary - x-type: list - x-identifiers: - - Name - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' - AND region = 'us-east-1' - canary: - name: canary - id: awscc.synthetics.canary - x-cfn-schema-name: Canary - x-type: get + x-cfn-type-name: AWS::Synthetics::Canary x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Canary&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Synthetics::Canary" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Synthetics::Canary" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Synthetics::Canary" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/canaries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/canaries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/canaries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -385,12 +1079,17 @@ components: JSON_EXTRACT(Properties, '$.RunConfig') as run_config, JSON_EXTRACT(Properties, '$.StartCanaryAfterCreation') as start_canary_after_creation, JSON_EXTRACT(Properties, '$.VisualReference') as visual_reference, - JSON_EXTRACT(Properties, '$.DeleteLambdaResourcesOnCanaryDeletion') as delete_lambda_resources_on_canary_deletion + JSON_EXTRACT(Properties, '$.DeleteLambdaResourcesOnCanaryDeletion') as delete_lambda_resources_on_canary_deletion, + JSON_EXTRACT(Properties, '$.ResourcesToReplicateTags') as resources_to_replicate_tags, + JSON_EXTRACT(Properties, '$.ProvisionedResourceCleanup') as provisioned_resource_cleanup, + JSON_EXTRACT(Properties, '$.DryRunAndUpdate') as dry_run_and_update, + JSON_EXTRACT(Properties, '$.BrowserConfigs') as browser_configs, + JSON_EXTRACT(Properties, '$.VisualReferences') as visual_references FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Canary' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -411,17 +1110,28 @@ components: json_extract_path_text(Properties, 'RunConfig') as run_config, json_extract_path_text(Properties, 'StartCanaryAfterCreation') as start_canary_after_creation, json_extract_path_text(Properties, 'VisualReference') as visual_reference, - json_extract_path_text(Properties, 'DeleteLambdaResourcesOnCanaryDeletion') as delete_lambda_resources_on_canary_deletion + json_extract_path_text(Properties, 'DeleteLambdaResourcesOnCanaryDeletion') as delete_lambda_resources_on_canary_deletion, + json_extract_path_text(Properties, 'ResourcesToReplicateTags') as resources_to_replicate_tags, + json_extract_path_text(Properties, 'ProvisionedResourceCleanup') as provisioned_resource_cleanup, + json_extract_path_text(Properties, 'DryRunAndUpdate') as dry_run_and_update, + json_extract_path_text(Properties, 'BrowserConfigs') as browser_configs, + json_extract_path_text(Properties, 'VisualReferences') as visual_references FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Canary' AND data__Identifier = '' AND region = 'us-east-1' - groups: - name: groups - id: awscc.synthetics.groups - x-cfn-schema-name: Group - x-type: list + canaries_list_only: + name: canaries_list_only + id: awscc.synthetics.canaries_list_only + x-cfn-schema-name: Canary + x-cfn-type-name: AWS::Synthetics::Canary x-identifiers: - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -430,7 +1140,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -438,19 +1148,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Name') as name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' AND region = 'us-east-1' - group: - name: group - id: awscc.synthetics.group + groups: + name: groups + id: awscc.synthetics.groups x-cfn-schema-name: Group - x-type: get + x-cfn-type-name: AWS::Synthetics::Group x-identifiers: - Name + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Synthetics::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Synthetics::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Synthetics::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -463,7 +1221,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -475,3 +1233,271 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Group' AND data__Identifier = '' AND region = 'us-east-1' + groups_list_only: + name: groups_list_only + id: awscc.synthetics.groups_list_only + x-cfn-schema-name: Group + x-cfn-type-name: AWS::Synthetics::Group + x-identifiers: + - Name + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Canary&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCanary + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCanaryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/systemsmanagersap.yaml b/providers/src/awscc/v00.00.00000/services/systemsmanagersap.yaml index 9544e1c5..a5d8d8e4 100644 --- a/providers/src/awscc/v00.00.00000/services/systemsmanagersap.yaml +++ b/providers/src/awscc/v00.00.00000/services/systemsmanagersap.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: SystemsManagerSAP - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: A key-value pair to associate with a resource. @@ -40,18 +420,39 @@ components: Instance: type: string pattern: ^i-[\w\d]{8}$|^i-[\w\d]{17}$ + ComponentInfo: + type: object + properties: + ComponentType: + type: string + enum: + - HANA + - HANA_NODE + - ABAP + - ASCS + - DIALOG + - WEBDISP + - WD + - ERS + Ec2InstanceId: + type: string + pattern: ^i-[\w\d]{8}$|^i-[\w\d]{17}$ + Sid: + type: string + pattern: '[A-Z][A-Z0-9]{2}' Application: type: object properties: ApplicationId: type: string - pattern: '[\w\d]{1,50}' + pattern: '[\w\d\.-]{1,60}' ApplicationType: type: string enum: - HANA + - SAP_ABAP Arn: - description: The ARN of the Helix application + description: The ARN of the SSM-SAP application type: string pattern: ^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\/.+$ Credentials: @@ -78,25 +479,61 @@ components: items: $ref: '#/components/schemas/Tag' x-insertionOrder: true + DatabaseArn: + description: The ARN of the SAP HANA database + type: string + pattern: ^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\/.+$ + ComponentsInfo: + description: This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher. + type: array + items: + $ref: '#/components/schemas/ComponentInfo' + minItems: 1 + x-insertionOrder: true required: - ApplicationId - ApplicationType x-stackql-resource-name: application - x-stackql-primaryIdentifier: + description: Resource schema for AWS::SystemsManagerSAP::Application + x-type-name: AWS::SystemsManagerSAP::Application + x-stackql-primary-identifier: - Arn x-create-only-properties: - Credentials - Instances - SapInstanceNumber - Sid + - DatabaseArn + - ComponentsInfo + x-write-only-properties: + - Credentials + - Instances + - SapInstanceNumber + - Sid + - DatabaseArn + - ComponentsInfo x-read-only-properties: - Arn + x-required-properties: + - ApplicationId + - ApplicationType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - ssm-sap:UntagResource + - ssm-sap:TagResource + - ssm-sap:ListTagsForResource x-required-permissions: create: - ssm-sap:RegisterApplication - ssm-sap:GetApplication - ssm-sap:TagResource - ssm-sap:ListTagsForResource + - iam:CreateServiceLinkedRole read: - ssm-sap:GetApplication - ssm-sap:ListTagsForResource @@ -110,43 +547,137 @@ components: - ssm-sap:GetApplication list: - ssm-sap:ListApplications + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + pattern: '[\w\d\.-]{1,60}' + ApplicationType: + type: string + enum: + - HANA + - SAP_ABAP + Arn: + description: The ARN of the SSM-SAP application + type: string + pattern: ^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\/.+$ + Credentials: + type: array + items: + $ref: '#/components/schemas/Credential' + minItems: 1 + x-insertionOrder: true + Instances: + type: array + items: + $ref: '#/components/schemas/Instance' + minItems: 1 + x-insertionOrder: true + SapInstanceNumber: + type: string + pattern: '[0-9]{2}' + Sid: + type: string + pattern: '[A-Z][A-Z0-9]{2}' + Tags: + description: The tags of a SystemsManagerSAP application. + type: array + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: true + DatabaseArn: + description: The ARN of the SAP HANA database + type: string + pattern: ^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\/.+$ + ComponentsInfo: + description: This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher. + type: array + items: + $ref: '#/components/schemas/ComponentInfo' + minItems: 1 + x-insertionOrder: true + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: applications: name: applications id: awscc.systemsmanagersap.applications x-cfn-schema-name: Application - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' - AND region = 'us-east-1' - application: - name: application - id: awscc.systemsmanagersap.application - x-cfn-schema-name: Application - x-type: get + x-cfn-type-name: AWS::SystemsManagerSAP::Application x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SystemsManagerSAP::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SystemsManagerSAP::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SystemsManagerSAP::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -158,12 +689,14 @@ components: JSON_EXTRACT(Properties, '$.Instances') as instances, JSON_EXTRACT(Properties, '$.SapInstanceNumber') as sap_instance_number, JSON_EXTRACT(Properties, '$.Sid') as sid, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.DatabaseArn') as database_arn, + JSON_EXTRACT(Properties, '$.ComponentsInfo') as components_info FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -175,7 +708,235 @@ components: json_extract_path_text(Properties, 'Instances') as instances, json_extract_path_text(Properties, 'SapInstanceNumber') as sap_instance_number, json_extract_path_text(Properties, 'Sid') as sid, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DatabaseArn') as database_arn, + json_extract_path_text(Properties, 'ComponentsInfo') as components_info FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' AND data__Identifier = '' AND region = 'us-east-1' + applications_list_only: + name: applications_list_only + id: awscc.systemsmanagersap.applications_list_only + x-cfn-schema-name: Application + x-cfn-type-name: AWS::SystemsManagerSAP::Application + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/tagging.yaml b/providers/src/awscc/v00.00.00000/services/tagging.yaml new file mode 100644 index 00000000..f6aba337 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/tagging.yaml @@ -0,0 +1,1261 @@ +openapi: 3.0.0 +info: + version: '2017-01-26' + x-release: v4 + title: AWS Resource Groups Tagging API + description: Resource Groups Tagging API + x-logo: + url: 'https://twitter.com/awscloud/profile_image?size=original' + backgroundColor: '#FFFFFF' + termsOfService: 'https://aws.amazon.com/service-terms/' + contact: + name: Mike Ralphson + email: mike.ralphson@gmail.com + url: 'https://github.com/mermade/aws2openapi' + x-twitter: PermittedSoc + license: + name: Apache 2.0 License + url: 'http://www.apache.org/licenses/' + x-providerName: amazonaws.com + x-serviceName: tagging + x-origin: + - contentType: application/x-amz-json-1.1 + url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/resourcegroupstaggingapi-2017-01-26.normal.json' + converter: + url: 'https://github.com/mermade/aws2openapi' + version: 1.0.0 + x-apisguru-driver: external + x-apiClientRegistration: + url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' + x-apisguru-categories: + - cloud + x-preferred: true +externalDocs: + description: Amazon Web Services documentation + url: 'https://docs.aws.amazon.com/tagging/' +servers: + - url: 'https://tagging.{region}.amazonaws.com' + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Resource Groups Tagging API multi-region endpoin +x-hasEquivalentPaths: true +paths: + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.DescribeReportCreation&__nativeEndpoint=true: + post: + operationId: DescribeReportCreation + description:

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's management account and from the us-east-1 Region.

+ responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DescribeReportCreationOutput' + '480': + description: ConstraintViolationException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ConstraintViolationException' + '481': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + '482': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '483': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DescribeReportCreationInput' + parameters: + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.DescribeReportCreation + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetComplianceSummary&__nativeEndpoint=true: + post: + operationId: GetComplianceSummary + description: '

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the Organizations User Guide.

You can call this operation only from the organization''s management account and from the us-east-1 Region.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetComplianceSummaryOutput' + '480': + description: ConstraintViolationException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ConstraintViolationException' + '481': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + '482': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '483': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetComplianceSummaryInput' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: PaginationToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.GetComplianceSummary + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetResources&__nativeEndpoint=true: + post: + operationId: GetResources + description: '

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.

Depending on what information you want returned, you can also specify the following:

  • Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.

  • Information about compliance with the account''s effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetResourcesOutput' + '480': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + '482': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + '483': + description: PaginationTokenExpiredException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/PaginationTokenExpiredException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetResourcesInput' + parameters: + - name: ResourcesPerPage + in: query + schema: + type: string + description: Pagination limit + required: false + - name: PaginationToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: Content-Type + in: query + schema: + type: string + default: application/x-amz-json-1.1 + required: false + # - name: User-Agent + # in: header + # required: false + # schema: + # type: string + # default: 'aws-cli/2.15.8 Python/3.11.6 Darwin/23.2.0 exe/x86_64 prompt/off command/resourcegroupstaggingapi.get-resources' + # - name: X-Amz-Date + # in: header + # required: false + # schema: + # type: string + # default: '20251011T031645Z' + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + default: 'ResourceGroupsTaggingAPI_20170126.GetResources' + # - name: Host + # in: header + # # required: true + # schema: + # type: string + # default: tagging.ap-southeast-2.amazonaws.com + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetTagKeys&__nativeEndpoint=true: + post: + operationId: GetTagKeys + description: '

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetTagKeysOutput' + '480': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + '482': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + '483': + description: PaginationTokenExpiredException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/PaginationTokenExpiredException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetTagKeysInput' + parameters: + - name: PaginationToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.GetTagKeys + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetTagValues&__nativeEndpoint=true: + post: + operationId: GetTagValues + description: '

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetTagValuesOutput' + '480': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + '482': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + '483': + description: PaginationTokenExpiredException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/PaginationTokenExpiredException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/GetTagValuesInput' + parameters: + - name: PaginationToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.GetTagValues + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.StartReportCreation&__nativeEndpoint=true: + post: + operationId: StartReportCreation + description: '

Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.

The generated report is saved to the following location:

s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization''s management account and from the us-east-1 Region.

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/StartReportCreationOutput' + '480': + description: ConcurrentModificationException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + '481': + description: ConstraintViolationException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ConstraintViolationException' + '482': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + '483': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '484': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/StartReportCreationInput' + parameters: + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.StartReportCreation + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.TagResources&__nativeEndpoint=true: + post: + operationId: TagResources + description: '

Applies one or more tags to the specified resources. Note the following:

  • Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn''t yet support this operation, the resource''s service might support tagging using its own API operations. For more information, refer to the documentation for that service.

  • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General Reference.

  • You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.

  • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions:

  • tag:TagResource

  • ec2:CreateTags

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/TagResourcesOutput' + '480': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + '482': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/TagResourcesInput' + parameters: + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.TagResources + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.UntagResources&__nativeEndpoint=true: + post: + operationId: UntagResources + description: '

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.

  • You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

  • tag:UntagResource

  • ec2:DeleteTags

' + responses: + '200': + description: Success + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/UntagResourcesOutput' + '480': + description: InvalidParameterException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ThrottledException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ThrottledException' + '482': + description: InternalServiceException + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/InternalServiceException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/UntagResourcesInput' + parameters: + - name: X-Amz-Target + in: header + # required: true + schema: + type: string + enum: + - ResourceGroupsTaggingAPI_20170126.UntagResources + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + schemas: + DescribeReportCreationOutput: + type: object + properties: + Status: + allOf: + - $ref: '#/components/schemas/Status' + - description: '

Reports the status of the operation.

The operation status can be one of the following:

  • RUNNING - Report creation is in progress.

  • SUCCEEDED - Report creation is complete. You can open the report from the Amazon S3 bucket that you specified when you ran StartReportCreation.

  • FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.

  • NO REPORT - No report was generated in the last 90 days.

' + S3Location: + allOf: + - $ref: '#/components/schemas/S3Location' + - description: The path to the Amazon S3 bucket where the report was stored on creation. + ErrorMessage: + allOf: + - $ref: '#/components/schemas/ErrorMessage' + - description: Details of the common errors that all operations return. + DescribeReportCreationInput: + type: object + title: DescribeReportCreationInput + properties: {} + ConstraintViolationException: {} + InternalServiceException: {} + InvalidParameterException: {} + ThrottledException: {} + GetComplianceSummaryOutput: + type: object + properties: + SummaryList: + allOf: + - $ref: '#/components/schemas/SummaryList' + - description: A table that shows counts of noncompliant resources. + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: 'A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.' + GetComplianceSummaryInput: + type: object + title: GetComplianceSummaryInput + properties: + TargetIdFilters: + allOf: + - $ref: '#/components/schemas/TargetIdFilterList' + - description: 'Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.' + RegionFilters: + allOf: + - $ref: '#/components/schemas/RegionFilterList' + - description: 'Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.' + ResourceTypeFilters: + allOf: + - $ref: '#/components/schemas/ResourceTypeFilterList' + - description: '

Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource''s Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

' + TagKeyFilters: + allOf: + - $ref: '#/components/schemas/TagKeyFilterList' + - description: 'Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.' + GroupBy: + allOf: + - $ref: '#/components/schemas/GroupBy' + - description: 'Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.' + MaxResults: + allOf: + - $ref: '#/components/schemas/MaxResultsGetComplianceSummary' + - description: 'Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.' + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request. + GetResourcesOutput: + type: object + properties: + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: 'A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.' + ResourceTagMappingList: + allOf: + - $ref: '#/components/schemas/ResourceTagMappingList' + - description: A list of resource ARNs and the tags (keys and values) associated with each. + GetResourcesInput: + type: object + title: GetResourcesInput + properties: + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request. + TagFilters: + allOf: + - $ref: '#/components/schemas/TagFilterList' + - description: '

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

  • If you don''t specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don''t have tags are shown with an empty tag set, like this: "Tags": [].

  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.

  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don''t specify a value for a key, the response returns all resources that are tagged with that key, with any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1

    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4

    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value

    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

' + ResourcesPerPage: + allOf: + - $ref: '#/components/schemas/ResourcesPerPage' + - description: 'Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.' + TagsPerPage: + allOf: + - $ref: '#/components/schemas/TagsPerPage' + - description: '

Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.

' + ResourceTypeFilters: + allOf: + - $ref: '#/components/schemas/ResourceTypeFilterList' + - description: '

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource''s Amazon Resource Name (ARN). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.

You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

ec2:instance,s3:bucket,auditmanager

' + IncludeComplianceDetails: + allOf: + - $ref: '#/components/schemas/IncludeComplianceDetails' + - description: Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details. + ExcludeCompliantResources: + allOf: + - $ref: '#/components/schemas/ExcludeCompliantResources' + - description:

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

+ ResourceARNList: + allOf: + - $ref: '#/components/schemas/ResourceARNListForGet' + - description: '

Specifies a list of ARNs of resources for which you want to retrieve tag data. You can''t specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

If a resource specified by this parameter doesn''t exist, it doesn''t generate an error; it simply isn''t included in the response.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

' + PaginationTokenExpiredException: {} + GetTagKeysOutput: + type: object + properties: + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: 'A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.' + TagKeys: + allOf: + - $ref: '#/components/schemas/TagKeyList' + - description: A list of all tag keys in the Amazon Web Services account. + GetTagKeysInput: + type: object + title: GetTagKeysInput + properties: + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request. + GetTagValuesOutput: + type: object + properties: + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: 'A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.' + TagValues: + allOf: + - $ref: '#/components/schemas/TagValuesOutputList' + - description: A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account. + GetTagValuesInput: + type: object + required: + - Key + title: GetTagValuesInput + properties: + PaginationToken: + allOf: + - $ref: '#/components/schemas/PaginationToken' + - description: Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request. + Key: + allOf: + - $ref: '#/components/schemas/TagKey' + - description: Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account. + StartReportCreationOutput: + type: object + properties: {} + StartReportCreationInput: + type: object + required: + - S3Bucket + title: StartReportCreationInput + properties: + S3Bucket: + allOf: + - $ref: '#/components/schemas/S3Bucket' + - description: '

The name of the Amazon S3 bucket where the report will be stored; for example:

awsexamplebucket

For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page.

' + ConcurrentModificationException: {} + TagResourcesOutput: + type: object + properties: + FailedResourcesMap: + allOf: + - $ref: '#/components/schemas/FailedResourcesMap' + - description: 'A map containing a key-value pair for each failed item that couldn''t be tagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.' + TagResourcesInput: + type: object + required: + - ResourceARNList + - Tags + title: TagResourcesInput + properties: + ResourceARNList: + allOf: + - $ref: '#/components/schemas/ResourceARNListForTagUntag' + - description: '

Specifies the list of ARNs of the resources that you want to apply tags to.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

' + Tags: + allOf: + - $ref: '#/components/schemas/TagMap' + - description: Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define. + UntagResourcesOutput: + type: object + properties: + FailedResourcesMap: + allOf: + - $ref: '#/components/schemas/FailedResourcesMap' + - description: 'A map containing a key-value pair for each failed item that couldn''t be untagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.' + UntagResourcesInput: + type: object + required: + - ResourceARNList + - TagKeys + title: UntagResourcesInput + properties: + ResourceARNList: + allOf: + - $ref: '#/components/schemas/ResourceARNListForTagUntag' + - description: '

Specifies a list of ARNs of the resources that you want to remove tags from.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

' + TagKeys: + allOf: + - $ref: '#/components/schemas/TagKeyListForUntag' + - description: Specifies a list of tag keys that you want to remove from the specified resources. + AmazonResourceType: + type: string + pattern: '[\s\S]*' + minLength: 0 + maxLength: 256 + TagKeyList: + type: array + items: + $ref: '#/components/schemas/TagKey' + ComplianceStatus: + type: boolean + ComplianceDetails: + type: object + properties: + NoncompliantKeys: + allOf: + - $ref: '#/components/schemas/TagKeyList' + - description: These tag keys on the resource are noncompliant with the effective tag policy. + KeysWithNoncompliantValues: + allOf: + - $ref: '#/components/schemas/TagKeyList' + - description: 'These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values. ' + ComplianceStatus: + allOf: + - $ref: '#/components/schemas/ComplianceStatus' + - description: Whether a resource is compliant with the effective tag policy. + description: 'Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.' + Status: + type: string + S3Location: + type: string + ErrorMessage: + type: string + ErrorCode: + type: string + enum: + - InternalServiceException + - InvalidParameterException + ExcludeCompliantResources: + type: boolean + FailureInfo: + type: object + properties: + StatusCode: + allOf: + - $ref: '#/components/schemas/StatusCode' + - description: The HTTP status code of the common error. + ErrorCode: + allOf: + - $ref: '#/components/schemas/ErrorCode' + - description: 'The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the Amazon Web Services service that hosts the resource that you want to tag.' + ErrorMessage: + allOf: + - $ref: '#/components/schemas/ErrorMessage' + - description: The message of the common error. + description: '

Information about the errors that are returned for each failed resource. This information can include InternalServiceException and InvalidParameterException errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.

The following are common error codes that you might receive from other Amazon Web Services services:

  • InternalServiceException – This can mean that the Resource Groups Tagging API didn''t receive a response from another Amazon Web Services service. It can also mean that the resource type in the request is not supported by the Resource Groups Tagging API. In these cases, it''s safe to retry the request and then call GetResources to verify the changes.

  • AccessDeniedException – This can mean that you need permission to call the tagging operations in the Amazon Web Services service that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch alarm resource, you need permission to call both TagResources and TagResource in the CloudWatch API.

For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.

' + FailedResourcesMap: + type: object + additionalProperties: + $ref: '#/components/schemas/FailureInfo' + StatusCode: + type: integer + TargetIdFilterList: + type: array + items: + $ref: '#/components/schemas/TargetId' + minItems: 1 + maxItems: 100 + RegionFilterList: + type: array + items: + $ref: '#/components/schemas/Region' + minItems: 1 + maxItems: 100 + ResourceTypeFilterList: + type: array + items: + $ref: '#/components/schemas/AmazonResourceType' + TagKeyFilterList: + type: array + items: + $ref: '#/components/schemas/TagKey' + minItems: 1 + maxItems: 50 + GroupBy: + type: array + items: + $ref: '#/components/schemas/GroupByAttribute' + MaxResultsGetComplianceSummary: + type: integer + minimum: 1 + maximum: 1000 + PaginationToken: + type: string + pattern: '[\s\S]*' + minLength: 0 + maxLength: 2048 + SummaryList: + type: array + items: + $ref: '#/components/schemas/Summary' + TagFilterList: + type: array + items: + $ref: '#/components/schemas/TagFilter' + minItems: 0 + maxItems: 50 + ResourcesPerPage: + type: integer + TagsPerPage: + type: integer + IncludeComplianceDetails: + type: boolean + ResourceARNListForGet: + type: array + items: + $ref: '#/components/schemas/ResourceARN' + minItems: 1 + maxItems: 100 + ResourceTagMappingList: + type: array + items: + $ref: '#/components/schemas/ResourceTagMapping' + TagKey: + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 128 + TagValuesOutputList: + type: array + items: + $ref: '#/components/schemas/TagValue' + GroupByAttribute: + type: string + enum: + - TARGET_ID + - REGION + - RESOURCE_TYPE + LastUpdated: + type: string + NonCompliantResources: + type: integer + Region: + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 256 + ResourceARN: + type: string + pattern: '[\s\S]*' + minLength: 1 + maxLength: 1011 + ResourceARNListForTagUntag: + type: array + items: + $ref: '#/components/schemas/ResourceARN' + minItems: 1 + maxItems: 20 + TagList: + type: array + items: + $ref: '#/components/schemas/Tag' + ResourceTagMapping: + type: object + properties: + ResourceARN: + allOf: + - $ref: '#/components/schemas/ResourceARN' + - description: The ARN of the resource. + Tags: + allOf: + - $ref: '#/components/schemas/TagList' + - description: The tags that have been applied to one or more Amazon Web Services resources. + ComplianceDetails: + allOf: + - $ref: '#/components/schemas/ComplianceDetails' + - description: 'Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.' + description: A list of resource ARNs and the tags (keys and values) that are associated with each. + S3Bucket: + type: string + pattern: '[a-z0-9.-]*' + minLength: 3 + maxLength: 63 + TargetId: + type: string + pattern: '[a-zA-Z0-9-]*' + minLength: 6 + maxLength: 68 + TargetIdType: + type: string + enum: + - ACCOUNT + - OU + - ROOT + Summary: + type: object + properties: + LastUpdated: + allOf: + - $ref: '#/components/schemas/LastUpdated' + - description: 'The timestamp that shows when this summary was generated in this Region. ' + TargetId: + allOf: + - $ref: '#/components/schemas/TargetId' + - description: 'The account identifier or the root identifier of the organization. If you don''t know the root ID, you can call the Organizations ListRoots API.' + TargetIdType: + allOf: + - $ref: '#/components/schemas/TargetIdType' + - description: 'Whether the target is an account, an OU, or the organization root.' + Region: + allOf: + - $ref: '#/components/schemas/Region' + - description: The Amazon Web Services Region that the summary applies to. + ResourceType: + allOf: + - $ref: '#/components/schemas/AmazonResourceType' + - description: The Amazon Web Services resource type. + NonCompliantResources: + allOf: + - $ref: '#/components/schemas/NonCompliantResources' + - description: The count of noncompliant resources. + description: A count of noncompliant resources. + TagValue: + type: string + pattern: '[\s\S]*' + minLength: 0 + maxLength: 256 + Tag: + type: object + required: + - Key + - Value + properties: + Key: + allOf: + - $ref: '#/components/schemas/TagKey' + - description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values. + Value: + allOf: + - $ref: '#/components/schemas/TagValue' + - description: One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null. + description: 'The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.' + TagValueList: + type: array + items: + $ref: '#/components/schemas/TagValue' + minItems: 0 + maxItems: 20 + TagFilter: + type: object + properties: + Key: + allOf: + - $ref: '#/components/schemas/TagKey' + - description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values. + Values: + allOf: + - $ref: '#/components/schemas/TagValueList' + - description: One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null. + description: A list of tags (keys and values) that are used to specify the associated resources. + TagKeyListForUntag: + type: array + items: + $ref: '#/components/schemas/TagKey' + minItems: 1 + maxItems: 50 + TagMap: + type: object + minProperties: 1 + maxProperties: 50 + additionalProperties: + $ref: '#/components/schemas/TagValue' + x-stackQL-resources: + report_creation: + name: report_creation + x-type: native + x-description: Describes the status of the StartReportCreation operation for generating a report of all tagged resources in accounts across your organization + methods: + describe_report_creation: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.DescribeReportCreation&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + start_report_creation: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.StartReportCreation&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + id: awscc.tagging.report_creation + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/report_creation/methods/describe_report_creation' + update: [] + title: report_creation + compliance_summary: + name: compliance_summary + x-type: native + x-description: Returns a table that shows counts of resources that are noncompliant with their tag policies + methods: + get_compliance_summary: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetComplianceSummary&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + id: awscc.tagging.compliance_summary + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/compliance_summary/methods/get_compliance_summary' + update: [] + title: compliance_summary + tagged_resources: + name: tagged_resources + x-type: native + x-description: Returns all the tagged or previously tagged resources that are located in the specified AWS Region for the account + methods: + get_resources: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetResources&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + tag_resources: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.TagResources&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + untag_resources: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.UntagResources&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + id: awscc.tagging.tagged_resources + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/tagged_resources/methods/get_resources' + update: [] + title: tagged_resources + tag_keys: + name: tag_keys + x-type: native + x-description: Returns all tag keys currently in use in the specified AWS Region for the calling account + methods: + get_tag_keys: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetTagKeys&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + id: awscc.tagging.tag_keys + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/tag_keys/methods/get_tag_keys' + update: [] + title: tag_keys + tag_values: + name: tag_values + x-type: native + x-description: Returns all tag values for the specified key that are used in the specified AWS Region for the calling account + methods: + get_tag_values: + operation: + $ref: '#/paths/~1?__X-Amz-Target=ResourceGroupsTaggingAPI_20170126.GetTagValues&__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/x-amz-json-1.1 + openAPIDocKey: '200' + id: awscc.tagging.tag_values + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/tag_values/methods/get_tag_values' + update: [] + title: tag_values +security: + - hmac: [] +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body + queryParamTranspose: + algorithm: AWSCanonical \ No newline at end of file diff --git a/providers/src/awscc/v00.00.00000/services/timestream.yaml b/providers/src/awscc/v00.00.00000/services/timestream.yaml index a2db5a61..1ed5d2b4 100644 --- a/providers/src/awscc/v00.00.00000/services/timestream.yaml +++ b/providers/src/awscc/v00.00.00000/services/timestream.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Timestream - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources. @@ -40,12 +420,24 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: database - x-stackql-primaryIdentifier: + description: The AWS::Timestream::Database resource creates a Timestream database. + x-type-name: AWS::Timestream::Database + x-stackql-primary-identifier: - DatabaseName x-create-only-properties: - DatabaseName x-read-only-properties: - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - timestream:TagResource + - timestream:ListTagsForResource + - timestream:UntagResource x-required-permissions: create: - timestream:CreateDatabase @@ -70,6 +462,249 @@ components: list: - timestream:ListDatabases - timestream:DescribeEndpoints + InfluxDBInstance: + type: object + properties: + Username: + type: string + minLength: 1 + maxLength: 64 + description: The username for the InfluxDB instance. + Password: + type: string + minLength: 8 + maxLength: 64 + pattern: ^[a-zA-Z0-9]+$ + description: The password for the InfluxDB instance. + Organization: + type: string + minLength: 1 + maxLength: 64 + description: The organization for the InfluxDB instance. + Bucket: + type: string + minLength: 2 + maxLength: 64 + pattern: ^[^_][^"]*$ + description: The bucket for the InfluxDB instance. + DbInstanceType: + type: string + enum: + - db.influx.medium + - db.influx.large + - db.influx.xlarge + - db.influx.2xlarge + - db.influx.4xlarge + - db.influx.8xlarge + - db.influx.12xlarge + - db.influx.16xlarge + - db.influx.24xlarge + description: The compute instance of the InfluxDB instance. + VpcSubnetIds: + type: array + x-insertionOrder: false + items: + type: string + minItems: 1 + maxItems: 3 + description: A list of EC2 subnet IDs for this InfluxDB instance. + VpcSecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + minItems: 1 + maxItems: 5 + description: A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance. + PubliclyAccessible: + type: boolean + description: Attach a public IP to the customer ENI. + default: false + DbStorageType: + type: string + enum: + - InfluxIOIncludedT1 + - InfluxIOIncludedT2 + - InfluxIOIncludedT3 + description: The storage type of the InfluxDB instance. + AllocatedStorage: + type: integer + minimum: 20 + maximum: 16384 + description: The allocated storage for the InfluxDB instance. + DbParameterGroupIdentifier: + type: string + minLength: 3 + maxLength: 64 + pattern: ^[a-zA-Z0-9]+$ + description: The name of an existing InfluxDB parameter group. + Port: + type: integer + minimum: 1024 + maximum: 65535 + description: The port number on which InfluxDB accepts connections. + NetworkType: + type: string + description: Network type of the InfluxDB Instance. + enum: + - IPV4 + - DUAL + LogDeliveryConfiguration: + type: object + description: Configuration for sending logs to customer account from the InfluxDB instance. + properties: + S3Configuration: + description: S3 configuration for sending logs to customer account from the InfluxDB instance. + type: object + properties: + BucketName: + description: The bucket name for logs to be sent from the InfluxDB instance + type: string + minLength: 3 + maxLength: 63 + pattern: ^[0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+$ + Enabled: + description: Specifies whether logging to customer specified bucket is enabled. + type: boolean + required: + - Enabled + - BucketName + additionalProperties: false + required: + - S3Configuration + additionalProperties: false + Status: + type: string + description: Status of the InfluxDB Instance. + enum: + - CREATING + - AVAILABLE + - DELETING + - MODIFYING + - UPDATING + - UPDATING_DEPLOYMENT_TYPE + - UPDATING_INSTANCE_TYPE + - DELETED + - FAILED + Arn: + type: string + minLength: 1 + maxLength: 1011 + pattern: ^arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance)/[a-zA-Z0-9]{3,64}$ + description: The Amazon Resource Name (ARN) that is associated with the InfluxDB instance. + Name: + type: string + minLength: 3 + maxLength: 40 + pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ + description: The unique name that is associated with the InfluxDB instance. + AvailabilityZone: + type: string + description: The Availability Zone (AZ) where the InfluxDB instance is created. + SecondaryAvailabilityZone: + type: string + description: The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY. + Endpoint: + type: string + description: The connection endpoint for the InfluxDB instance. + InfluxAuthParametersSecretArn: + type: string + pattern: ^arn:[a-z]*:secretsmanager:[a-z\-0-9]*:[0-9]*:secret:[a-zA-Z0-9\-]* + description: The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance. + Id: + type: string + pattern: ^[a-zA-Z0-9]+$ + minLength: 3 + maxLength: 64 + description: The service generated unique identifier for InfluxDB instance. + DeploymentType: + type: string + description: Deployment type of the InfluxDB Instance. + enum: + - SINGLE_AZ + - WITH_MULTIAZ_STANDBY + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + maxItems: 200 + description: An arbitrary set of tags (key-value pairs) for this DB instance. + x-stackql-resource-name: influxdb_instance + description: The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance. + x-type-name: AWS::Timestream::InfluxDBInstance + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + - Username + - Password + - Organization + - Bucket + - VpcSubnetIds + - VpcSecurityGroupIds + - PubliclyAccessible + - NetworkType + x-write-only-properties: + - Username + - Password + - Organization + - Bucket + x-read-only-properties: + - Status + - Arn + - Id + - AvailabilityZone + - Endpoint + - SecondaryAvailabilityZone + - InfluxAuthParametersSecretArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - timestream-influxdb:TagResource + - timestream-influxdb:ListTagsForResource + - timestream-influxdb:UntagResource + x-required-permissions: + create: + - s3:ListBucket + - s3:GetBucketPolicy + - timestream-influxdb:GetDbInstance + - timestream-influxdb:ListDbInstances + - timestream-influxdb:CreateDbInstance + - timestream-influxdb:TagResource + - timestream-influxdb:ListTagsForResource + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - ec2:DescribeNetworkInterfaces + - ec2:DescribeSecurityGroups + - ec2:CreateNetworkInterface + - iam:CreateServiceLinkedRole + read: + - timestream-influxdb:GetDbInstance + - timestream-influxdb:ListTagsForResource + update: + - s3:ListBucket + - s3:GetBucketPolicy + - timestream-influxdb:GetDbInstance + - timestream-influxdb:ListDbInstances + - timestream-influxdb:UpdateDbInstance + - timestream-influxdb:TagResource + - timestream-influxdb:UntagResource + - timestream-influxdb:ListTagsForResource + - ec2:DescribeSubnets + - ec2:DescribeVpcs + delete: + - timestream-influxdb:GetDbInstance + - timestream-influxdb:ListDbInstances + - timestream-influxdb:DeleteDbInstance + list: + - timestream-influxdb:ListDbInstances Arn: description: Amazon Resource Name of the scheduled query that is generated upon creation. type: string @@ -418,18 +1053,21 @@ components: - ScheduledQueryExecutionRoleArn - ErrorReportConfiguration x-stackql-resource-name: scheduled_query - x-stackql-primaryIdentifier: + description: The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query. + x-type-name: AWS::Timestream::ScheduledQuery + x-stackql-primary-identifier: - Arn x-create-only-properties: - ScheduledQueryName - QueryString - ScheduleConfiguration - NotificationConfiguration - - ClientToken - ScheduledQueryExecutionRoleArn - TargetConfiguration - ErrorReportConfiguration - KmsKeyId + x-write-only-properties: + - ClientToken x-read-only-properties: - Arn - SQName @@ -440,14 +1078,36 @@ components: - SQTargetConfiguration - SQErrorReportConfiguration - SQKmsKeyId + x-required-properties: + - QueryString + - ScheduleConfiguration + - NotificationConfiguration + - ScheduledQueryExecutionRoleArn + - ErrorReportConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - timestream:TagResource + - timestream:ListTagsForResource + - timestream:UntagResource x-required-permissions: create: - timestream:CreateScheduledQuery - timestream:DescribeEndpoints + - timestream:TagResource + - iam:PassRole + - kms:DescribeKey + - kms:GenerateDataKey read: - timestream:DescribeScheduledQuery - timestream:ListTagsForResource - timestream:DescribeEndpoints + - kms:GenerateDataKey + - kms:Decrypt update: - timestream:UpdateScheduledQuery - timestream:TagResource @@ -455,6 +1115,7 @@ components: - timestream:DescribeEndpoints delete: - timestream:DeleteScheduledQuery + - timestream:DescribeScheduledQuery - timestream:DescribeEndpoints list: - timestream:ListScheduledQueries @@ -575,7 +1236,9 @@ components: required: - DatabaseName x-stackql-resource-name: table - x-stackql-primaryIdentifier: + description: The AWS::Timestream::Table resource creates a Timestream Table. + x-type-name: AWS::Timestream::Table + x-stackql-primary-identifier: - DatabaseName - TableName x-create-only-properties: @@ -584,6 +1247,18 @@ components: x-read-only-properties: - Arn - Name + x-required-properties: + - DatabaseName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - timestream:TagResource + - timestream:ListTagsForResource + - timestream:UntagResource x-required-permissions: create: - timestream:CreateTable @@ -592,7 +1267,8 @@ components: - s3:PutObject - s3:GetObject - s3:GetBucketAcl - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyWithoutPlaintext - kms:DescribeKey - kms:Encrypt read: @@ -607,7 +1283,8 @@ components: - s3:PutObject - s3:GetObject - s3:GetBucketAcl - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyWithoutPlaintext - kms:DescribeKey - kms:Encrypt delete: @@ -617,14 +1294,484 @@ components: list: - timestream:ListTables - timestream:DescribeEndpoints + CreateDatabaseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + DatabaseName: + description: The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name. + type: string + pattern: ^[a-zA-Z0-9_.-]{3,256}$ + KmsKeyId: + description: The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. + type: string + minLength: 1 + maxLength: 2048 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDatabaseRequest + type: object + required: [] + CreateInfluxDBInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Username: + type: string + minLength: 1 + maxLength: 64 + description: The username for the InfluxDB instance. + Password: + type: string + minLength: 8 + maxLength: 64 + pattern: ^[a-zA-Z0-9]+$ + description: The password for the InfluxDB instance. + Organization: + type: string + minLength: 1 + maxLength: 64 + description: The organization for the InfluxDB instance. + Bucket: + type: string + minLength: 2 + maxLength: 64 + pattern: ^[^_][^"]*$ + description: The bucket for the InfluxDB instance. + DbInstanceType: + type: string + enum: + - db.influx.medium + - db.influx.large + - db.influx.xlarge + - db.influx.2xlarge + - db.influx.4xlarge + - db.influx.8xlarge + - db.influx.12xlarge + - db.influx.16xlarge + - db.influx.24xlarge + description: The compute instance of the InfluxDB instance. + VpcSubnetIds: + type: array + x-insertionOrder: false + items: + type: string + minItems: 1 + maxItems: 3 + description: A list of EC2 subnet IDs for this InfluxDB instance. + VpcSecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + minItems: 1 + maxItems: 5 + description: A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance. + PubliclyAccessible: + type: boolean + description: Attach a public IP to the customer ENI. + default: false + DbStorageType: + type: string + enum: + - InfluxIOIncludedT1 + - InfluxIOIncludedT2 + - InfluxIOIncludedT3 + description: The storage type of the InfluxDB instance. + AllocatedStorage: + type: integer + minimum: 20 + maximum: 16384 + description: The allocated storage for the InfluxDB instance. + DbParameterGroupIdentifier: + type: string + minLength: 3 + maxLength: 64 + pattern: ^[a-zA-Z0-9]+$ + description: The name of an existing InfluxDB parameter group. + Port: + type: integer + minimum: 1024 + maximum: 65535 + description: The port number on which InfluxDB accepts connections. + NetworkType: + type: string + description: Network type of the InfluxDB Instance. + enum: + - IPV4 + - DUAL + LogDeliveryConfiguration: + type: object + description: Configuration for sending logs to customer account from the InfluxDB instance. + properties: + S3Configuration: + description: S3 configuration for sending logs to customer account from the InfluxDB instance. + type: object + properties: + BucketName: + description: The bucket name for logs to be sent from the InfluxDB instance + type: string + minLength: 3 + maxLength: 63 + pattern: ^[0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+$ + Enabled: + description: Specifies whether logging to customer specified bucket is enabled. + type: boolean + required: + - Enabled + - BucketName + additionalProperties: false + required: + - S3Configuration + additionalProperties: false + Status: + type: string + description: Status of the InfluxDB Instance. + enum: + - CREATING + - AVAILABLE + - DELETING + - MODIFYING + - UPDATING + - UPDATING_DEPLOYMENT_TYPE + - UPDATING_INSTANCE_TYPE + - DELETED + - FAILED + Arn: + type: string + minLength: 1 + maxLength: 1011 + pattern: ^arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance)/[a-zA-Z0-9]{3,64}$ + description: The Amazon Resource Name (ARN) that is associated with the InfluxDB instance. + Name: + type: string + minLength: 3 + maxLength: 40 + pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$ + description: The unique name that is associated with the InfluxDB instance. + AvailabilityZone: + type: string + description: The Availability Zone (AZ) where the InfluxDB instance is created. + SecondaryAvailabilityZone: + type: string + description: The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY. + Endpoint: + type: string + description: The connection endpoint for the InfluxDB instance. + InfluxAuthParametersSecretArn: + type: string + pattern: ^arn:[a-z]*:secretsmanager:[a-z\-0-9]*:[0-9]*:secret:[a-zA-Z0-9\-]* + description: The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance. + Id: + type: string + pattern: ^[a-zA-Z0-9]+$ + minLength: 3 + maxLength: 64 + description: The service generated unique identifier for InfluxDB instance. + DeploymentType: + type: string + description: Deployment type of the InfluxDB Instance. + enum: + - SINGLE_AZ + - WITH_MULTIAZ_STANDBY + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + maxItems: 200 + description: An arbitrary set of tags (key-value pairs) for this DB instance. + x-stackQL-stringOnly: true + x-title: CreateInfluxDBInstanceRequest + type: object + required: [] + CreateScheduledQueryRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/Arn' + ScheduledQueryName: + $ref: '#/components/schemas/ScheduledQueryName' + QueryString: + $ref: '#/components/schemas/QueryString' + ScheduleConfiguration: + $ref: '#/components/schemas/ScheduleConfiguration' + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + ClientToken: + $ref: '#/components/schemas/ClientToken' + ScheduledQueryExecutionRoleArn: + $ref: '#/components/schemas/ScheduledQueryExecutionRoleArn' + TargetConfiguration: + $ref: '#/components/schemas/TargetConfiguration' + ErrorReportConfiguration: + $ref: '#/components/schemas/ErrorReportConfiguration' + KmsKeyId: + $ref: '#/components/schemas/KmsKeyId' + SQName: + description: The name of the scheduled query. Scheduled query names must be unique within each Region. + type: string + SQQueryString: + description: >- + The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 + 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query. + type: string + SQScheduleConfiguration: + description: Configuration for when the scheduled query is executed. + type: string + SQNotificationConfiguration: + description: Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it. + type: string + SQScheduledQueryExecutionRoleArn: + description: The ARN for the IAM role that Timestream will assume when running the scheduled query. + type: string + SQTargetConfiguration: + description: Configuration of target store where scheduled query results are written to. + type: string + SQErrorReportConfiguration: + description: Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results. + type: string + SQKmsKeyId: + description: The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest. + type: string + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateScheduledQueryRequest + type: object + required: [] + CreateTableRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + Name: + description: The table name exposed as a read-only attribute. + type: string + DatabaseName: + description: The name for the database which the table to be created belongs to. + type: string + pattern: ^[a-zA-Z0-9_.-]{3,256}$ + TableName: + description: The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. + type: string + pattern: ^[a-zA-Z0-9_.-]{3,256}$ + RetentionProperties: + description: The retention duration of the memory store and the magnetic store. + type: object + properties: + MemoryStoreRetentionPeriodInHours: + description: The duration for which data must be stored in the memory store. + type: string + MagneticStoreRetentionPeriodInDays: + description: The duration for which data must be stored in the magnetic store. + type: string + additionalProperties: false + Schema: + description: A Schema specifies the expected data model of the table. + type: object + properties: + CompositePartitionKey: + $ref: '#/components/schemas/PartitionKeyList' + additionalProperties: false + MagneticStoreWriteProperties: + description: The properties that determine whether magnetic store writes are enabled. + type: object + properties: + EnableMagneticStoreWrites: + description: Boolean flag indicating whether magnetic store writes are enabled. + type: boolean + MagneticStoreRejectedDataLocation: + description: Location to store information about records that were asynchronously rejected during magnetic store writes. + type: object + properties: + S3Configuration: + description: S3 configuration for location to store rejections from magnetic store writes + type: object + properties: + BucketName: + description: The bucket name used to store the data. + type: string + ObjectKeyPrefix: + description: String used to prefix all data in the bucket. + type: string + EncryptionOption: + description: Either SSE_KMS or SSE_S3. + type: string + KmsKeyId: + description: Must be provided if SSE_KMS is specified as the encryption option + type: string + required: + - EncryptionOption + - BucketName + additionalProperties: false + additionalProperties: false + required: + - EnableMagneticStoreWrites + additionalProperties: false + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + maxItems: 200 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTableRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: databases: name: databases id: awscc.timestream.databases x-cfn-schema-name: Database - x-type: list + x-cfn-type-name: AWS::Timestream::Database x-identifiers: - DatabaseName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Database&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::Database" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Database' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Database' + AND data__Identifier = '' + AND region = 'us-east-1' + databases_list_only: + name: databases_list_only + id: awscc.timestream.databases_list_only + x-cfn-schema-name: Database + x-cfn-type-name: AWS::Timestream::Database + x-identifiers: + - DatabaseName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -643,48 +1790,142 @@ components: json_extract_path_text(Properties, 'DatabaseName') as database_name FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Database' AND region = 'us-east-1' - database: - name: database - id: awscc.timestream.database - x-cfn-schema-name: Database - x-type: get + influxdb_instances: + name: influxdb_instances + id: awscc.timestream.influxdb_instances + x-cfn-schema-name: InfluxDBInstance + x-cfn-type-name: AWS::Timestream::InfluxDBInstance x-identifiers: - - DatabaseName + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InfluxDBInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::InfluxDBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::InfluxDBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::InfluxDBInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.Username') as username, + JSON_EXTRACT(Properties, '$.Password') as password, + JSON_EXTRACT(Properties, '$.Organization') as organization, + JSON_EXTRACT(Properties, '$.Bucket') as bucket, + JSON_EXTRACT(Properties, '$.DbInstanceType') as db_instance_type, + JSON_EXTRACT(Properties, '$.VpcSubnetIds') as vpc_subnet_ids, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, + JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, + JSON_EXTRACT(Properties, '$.DbStorageType') as db_storage_type, + JSON_EXTRACT(Properties, '$.AllocatedStorage') as allocated_storage, + JSON_EXTRACT(Properties, '$.DbParameterGroupIdentifier') as db_parameter_group_identifier, + JSON_EXTRACT(Properties, '$.Port') as port, + JSON_EXTRACT(Properties, '$.NetworkType') as network_type, + JSON_EXTRACT(Properties, '$.LogDeliveryConfiguration') as log_delivery_configuration, + JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, - JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.SecondaryAvailabilityZone') as secondary_availability_zone, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.InfluxAuthParametersSecretArn') as influx_auth_parameters_secret_arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DeploymentType') as deployment_type, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Database' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + json_extract_path_text(Properties, 'Username') as username, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'Organization') as organization, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'DbInstanceType') as db_instance_type, + json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'DbStorageType') as db_storage_type, + json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, + json_extract_path_text(Properties, 'DbParameterGroupIdentifier') as db_parameter_group_identifier, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'NetworkType') as network_type, + json_extract_path_text(Properties, 'LogDeliveryConfiguration') as log_delivery_configuration, + json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'SecondaryAvailabilityZone') as secondary_availability_zone, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'InfluxAuthParametersSecretArn') as influx_auth_parameters_secret_arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DeploymentType') as deployment_type, json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Database' - AND data__Identifier = '' + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' + AND data__Identifier = '' AND region = 'us-east-1' - scheduled_queries: - name: scheduled_queries - id: awscc.timestream.scheduled_queries - x-cfn-schema-name: ScheduledQuery - x-type: list + influxdb_instances_list_only: + name: influxdb_instances_list_only + id: awscc.timestream.influxdb_instances_list_only + x-cfn-schema-name: InfluxDBInstance + x-cfn-type-name: AWS::Timestream::InfluxDBInstance x-identifiers: - - Arn + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -692,28 +1933,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' AND region = 'us-east-1' - scheduled_query: - name: scheduled_query - id: awscc.timestream.scheduled_query + scheduled_queries: + name: scheduled_queries + id: awscc.timestream.scheduled_queries x-cfn-schema-name: ScheduledQuery - x-type: get + x-cfn-type-name: AWS::Timestream::ScheduledQuery x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ScheduledQuery&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::ScheduledQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::ScheduledQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::ScheduledQuery" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -741,7 +2030,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -768,14 +2057,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' AND data__Identifier = '' AND region = 'us-east-1' - tables: - name: tables - id: awscc.timestream.tables - x-cfn-schema-name: Table - x-type: list + scheduled_queries_list_only: + name: scheduled_queries_list_only + id: awscc.timestream.scheduled_queries_list_only + x-cfn-schema-name: ScheduledQuery + x-cfn-type-name: AWS::Timestream::ScheduledQuery x-identifiers: - - DatabaseName - - TableName + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -783,31 +2077,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'TableName') as table_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' AND region = 'us-east-1' - table: - name: table - id: awscc.timestream.table + tables: + name: tables + id: awscc.timestream.tables x-cfn-schema-name: Table - x-type: get + x-cfn-type-name: AWS::Timestream::Table x-identifiers: - DatabaseName - TableName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Timestream::Table" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -824,7 +2164,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -840,3 +2180,358 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Table' AND data__Identifier = '|' AND region = 'us-east-1' + tables_list_only: + name: tables_list_only + id: awscc.timestream.tables_list_only + x-cfn-schema-name: Table + x-cfn-type-name: AWS::Timestream::Table + x-identifiers: + - DatabaseName + - TableName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'TableName') as table_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Database&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDatabase + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDatabaseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InfluxDBInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInfluxDBInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInfluxDBInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ScheduledQuery&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateScheduledQuery + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateScheduledQueryRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Table&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTable + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTableRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/transfer.yaml b/providers/src/awscc/v00.00.00000/services/transfer.yaml index d8938a52..7c86744e 100644 --- a/providers/src/awscc/v00.00.00000/services/transfer.yaml +++ b/providers/src/awscc/v00.00.00000/services/transfer.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: Transfer - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: description: Creates a key-value pair for a specific resource. @@ -29,7 +409,7 @@ components: Description: description: A textual description for the agreement. type: string - pattern: ^[\w\- ]*$ + pattern: ^[\u0021-\u007E]+$ minLength: 1 maxLength: 200 ServerId: @@ -53,7 +433,7 @@ components: BaseDirectory: description: Specifies the base directory for the agreement. type: string - pattern: ^$|/.* + pattern: ^(|/.*)$ maxLength: 1024 AccessRole: description: Specifies the access role for the agreement. @@ -87,14 +467,58 @@ components: pattern: arn:.* minLength: 20 maxLength: 1600 + PreserveFilename: + description: Specifies whether to preserve the filename received for this agreement. + type: string + enum: + - ENABLED + - DISABLED + EnforceMessageSigning: + description: Specifies whether to enforce an AS2 message is signed for this agreement. + type: string + enum: + - ENABLED + - DISABLED + CustomDirectories: + description: Specifies a separate directory for each type of file to store for an AS2 message. + type: object + properties: + FailedFilesDirectory: + type: string + description: Specifies a location to store the failed files for an AS2 message. + pattern: (|/.*) + MdnFilesDirectory: + type: string + description: Specifies a location to store the MDN file for an AS2 message. + pattern: (|/.*) + PayloadFilesDirectory: + type: string + description: Specifies a location to store the payload file for an AS2 message. + pattern: (|/.*) + StatusFilesDirectory: + type: string + description: Specifies a location to store the status file for an AS2 message. + pattern: (|/.*) + TemporaryFilesDirectory: + type: string + description: Specifies a location to store the temporary processing file for an AS2 message. + pattern: (|/.*) + required: + - FailedFilesDirectory + - MdnFilesDirectory + - PayloadFilesDirectory + - StatusFilesDirectory + - TemporaryFilesDirectory + additionalProperties: false required: - ServerId - LocalProfileId - PartnerProfileId - - BaseDirectory - AccessRole x-stackql-resource-name: agreement - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Transfer::Agreement + x-type-name: AWS::Transfer::Agreement + x-stackql-primary-identifier: - AgreementId - ServerId x-create-only-properties: @@ -102,6 +526,21 @@ components: x-read-only-properties: - AgreementId - Arn + x-required-properties: + - ServerId + - LocalProfileId + - PartnerProfileId + - AccessRole + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - transfer:ListTagsForResource + - transfer:UnTagResource + - transfer:TagResource x-required-permissions: create: - transfer:CreateAgreement @@ -127,22 +566,23 @@ components: enum: - SIGNING - ENCRYPTION + - TLS Certificate: description: Specifies the certificate body to be imported. type: string - pattern: "^[\t\n\r -ÿ]*" + pattern: ^[\t\n\r\u0020-\u00FF]+$ minLength: 1 maxLength: 16384 CertificateChain: description: Specifies the certificate chain to be imported. type: string - pattern: "^[\t\n\r -ÿ]*" + pattern: ^[\t\n\r\u0020-\u00FF]+$ minLength: 1 maxLength: 2097152 PrivateKey: description: Specifies the private key for the certificate. type: string - pattern: "^[\t\n\r -ÿ]*" + pattern: ^[\t\n\r\u0020-\u00FF]+$ minLength: 1 maxLength: 16384 ActiveDate: @@ -154,7 +594,7 @@ components: Description: description: A textual description for the certificate. type: string - pattern: ^[\w\- ]*$ + pattern: ^[\u0021-\u007E]+$ minLength: 1 maxLength: 200 Tags: @@ -193,7 +633,7 @@ components: Serial: description: Specifies Certificate's serial. type: string - pattern: ^[\p{XDigit}{2}:?]* + pattern: ^[0-9a-fA-F{}:?]*$ minLength: 0 maxLength: 48 NotBeforeDate: @@ -206,12 +646,16 @@ components: - Certificate - Usage x-stackql-resource-name: certificate - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Transfer::Certificate + x-type-name: AWS::Transfer::Certificate + x-stackql-primary-identifier: - CertificateId x-create-only-properties: - Certificate - CertificateChain - PrivateKey + x-write-only-properties: + - PrivateKey x-read-only-properties: - Arn - CertificateId @@ -220,6 +664,19 @@ components: - Serial - NotAfterDate - NotBeforeDate + x-required-properties: + - Certificate + - Usage + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - transfer:ListTagsForResource + - transfer:UnTagResource + - transfer:TagResource x-required-permissions: create: - transfer:ImportCertificate @@ -267,7 +724,7 @@ components: MessageSubject: type: string description: The message subject for this AS2 connector configuration. - pattern: ^[\p{Print}\p{Blank}]+ + pattern: ^[\u0020-\u007E\t]+$ minLength: 1 maxLength: 1024 Compression: @@ -284,6 +741,7 @@ components: - AES192_CBC - AES256_CBC - NONE + - DES_EDE3_CBC SigningAlgorithm: type: string description: Signing algorithm for this AS2 connector configuration. @@ -314,6 +772,12 @@ components: description: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector minLength: 0 maxLength: 2048 + PreserveContentType: + description: Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message. + type: string + enum: + - ENABLED + - DISABLED additionalProperties: false SftpConfig: description: Configuration for an SFTP connector. @@ -332,6 +796,12 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/SftpConnectorTrustedHostKey' + MaxConcurrentConnections: + description: Specifies the number of active connections that your connector can establish with the remote server at the same time. + type: integer + minimum: 1 + maximum: 5 + default: 1 additionalProperties: false Arn: description: Specifies the unique Amazon Resource Name (ARN) for the connector. @@ -351,6 +821,13 @@ components: pattern: arn:.*role/.* minLength: 20 maxLength: 2048 + ServiceManagedEgressIpAddresses: + description: The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ Tags: description: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. type: array @@ -363,15 +840,36 @@ components: description: URL for Connector type: string maxLength: 255 + SecurityPolicyName: + description: Security policy for SFTP Connector + type: string + pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ + maxLength: 50 required: - AccessRole - Url x-stackql-resource-name: connector - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Transfer::Connector + x-type-name: AWS::Transfer::Connector + x-stackql-primary-identifier: - ConnectorId x-read-only-properties: - Arn - ConnectorId + - ServiceManagedEgressIpAddresses + x-required-properties: + - AccessRole + - Url + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - transfer:ListTagsForResource + - transfer:UnTagResource + - transfer:TagResource x-required-permissions: create: - transfer:CreateConnector @@ -400,6 +898,7 @@ components: As2Id: description: AS2 identifier agreed with a trading partner. type: string + pattern: ^[\u0020-\u007E\s]*$ minLength: 1 maxLength: 128 ProfileType: @@ -438,13 +937,28 @@ components: - As2Id - ProfileType x-stackql-resource-name: profile - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::Transfer::Profile + x-type-name: AWS::Transfer::Profile + x-stackql-primary-identifier: - ProfileId x-create-only-properties: - ProfileType x-read-only-properties: - Arn - ProfileId + x-required-properties: + - As2Id + - ProfileType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - transfer:ListTagsForResource + - transfer:UnTagResource + - transfer:TagResource x-required-permissions: create: - transfer:CreateProfile @@ -459,323 +973,1759 @@ components: - transfer:DeleteProfile list: - transfer:ListProfiles - S3Tag: - description: Specifies the key-value pair that are assigned to a file during the execution of a Tagging step. + As2Transport: + type: string + enum: + - HTTP + DirectoryListingOptimization: + type: string + description: Indicates whether optimization to directory listing on S3 servers is used. Disabled by default for compatibility. + enum: + - ENABLED + - DISABLED + Domain: + type: string + enum: + - S3 + - EFS + EndpointDetails: type: object properties: - Key: - description: The name assigned to the tag that you create. + AddressAllocationIds: + type: array + x-insertionOrder: true + items: + type: string + SubnetIds: + type: array + x-insertionOrder: true + items: + type: string + VpcEndpointId: type: string - minLength: 1 - maxLength: 128 - Value: - description: The value that corresponds to the key. + maxLength: 22 + minLength: 22 + pattern: ^vpce-[0-9a-f]{17}$ + VpcId: type: string - minLength: 0 - maxLength: 256 - required: - - Key - - Value + SecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 20 + minLength: 11 + pattern: ^sg-[0-9a-f]{8,17}$ additionalProperties: false - EfsInputFileLocation: - description: Specifies the details for an EFS file. + EndpointType: + type: string + enum: + - PUBLIC + - VPC + - VPC_ENDPOINT + IdentityProviderDetails: type: object + description: You can provide a structure that contains the details for the identity provider to use with your web app. properties: - FileSystemId: - description: Specifies the EFS filesystem that contains the file. + ApplicationArn: type: string - pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$ - minLength: 0 - maxLength: 128 - Path: - description: The name assigned to the file when it was created in EFS. You use the object path to retrieve the object. + maxLength: 1224 + minLength: 10 + pattern: ^arn:[\w-]+:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + InstanceArn: type: string - pattern: ^[^\x00]+$ - minLength: 1 - maxLength: 65536 + description: The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app. + maxLength: 1224 + minLength: 10 + pattern: ^arn:[\w-]+:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + Role: + type: string + description: The IAM role in IAM Identity Center used for the web app. + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z-]+:iam::[0-9]{12}:role[:/]\S+$ additionalProperties: false - S3InputFileLocation: - description: Specifies the details for a S3 file. + IdentityProviderType: + type: string + enum: + - SERVICE_MANAGED + - API_GATEWAY + - AWS_DIRECTORY_SERVICE + - AWS_LAMBDA + IpAddressType: + type: string + enum: + - IPV4 + - DUALSTACK + Protocol: + type: string + enum: + - SFTP + - FTP + - FTPS + - AS2 + ProtocolDetails: type: object properties: - Bucket: - description: Specifies the S3 bucket that contains the file. - type: string - pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ - minLength: 3 - maxLength: 63 - Key: - description: The name assigned to the file when it was created in S3. You use the object key to retrieve the object. + PassiveIp: type: string - pattern: .* + maxLength: 15 minLength: 0 - maxLength: 1024 + TlsSessionResumptionMode: + $ref: '#/components/schemas/TlsSessionResumptionMode' + SetStatOption: + $ref: '#/components/schemas/SetStatOption' + As2Transports: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/As2Transport' + maxItems: 1 + minItems: 1 additionalProperties: false - InputFileLocation: - description: Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps. + S3StorageOptions: type: object properties: - S3FileLocation: - $ref: '#/components/schemas/S3InputFileLocation' - EfsFileLocation: - $ref: '#/components/schemas/EfsInputFileLocation' + DirectoryListingOptimization: + $ref: '#/components/schemas/DirectoryListingOptimization' additionalProperties: false - S3FileLocation: - description: Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps. + SetStatOption: + type: string + enum: + - DEFAULT + - ENABLE_NO_OP + SftpAuthenticationMethods: + type: string + enum: + - PASSWORD + - PUBLIC_KEY + - PUBLIC_KEY_OR_PASSWORD + - PUBLIC_KEY_AND_PASSWORD + State: + type: string + enum: + - OFFLINE + - ONLINE + - STARTING + - STOPPING + - START_FAILED + - STOP_FAILED + TlsSessionResumptionMode: + type: string + enum: + - DISABLED + - ENABLED + - ENFORCED + WorkflowDetail: type: object properties: - S3FileLocation: - $ref: '#/components/schemas/S3InputFileLocation' + WorkflowId: + type: string + maxLength: 19 + minLength: 19 + pattern: ^w-([a-z0-9]{17})$ + ExecutionRole: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:.*role/\S+$ + required: + - ExecutionRole + - WorkflowId additionalProperties: false - WorkflowStep: - description: The basic building block of a workflow. + WorkflowDetails: type: object properties: - CopyStepDetails: - description: Details for a step that performs a file copy. - type: object - properties: - DestinationFileLocation: - $ref: '#/components/schemas/S3FileLocation' - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - OverwriteExisting: - description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. - type: string - enum: - - 'TRUE' - - 'FALSE' - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. - type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - CustomStepDetails: - description: Details for a step that invokes a lambda function. - type: object - properties: - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - Target: - description: The ARN for the lambda function that is being called. - type: string - pattern: arn:[a-z-]+:lambda:.*$ - minLength: 0 - maxLength: 170 - TimeoutSeconds: - description: Timeout, in seconds, for the step. - type: integer - minimum: 1 - maximum: 1800 + OnUpload: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowDetail' + maxItems: 1 + minItems: 0 + OnPartialUpload: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowDetail' + maxItems: 1 + minItems: 0 + additionalProperties: false + Server: + type: object + properties: + Arn: + type: string + maxLength: 1600 + minLength: 20 + pattern: ^arn:\S+$ + As2ServiceManagedEgressIpAddresses: + type: array + x-insertionOrder: false + items: + type: string + pattern: ^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ + description: The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs. These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well. + Certificate: + type: string + maxLength: 1600 + minLength: 0 + Domain: + $ref: '#/components/schemas/Domain' + EndpointDetails: + $ref: '#/components/schemas/EndpointDetails' + EndpointType: + $ref: '#/components/schemas/EndpointType' + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + IdentityProviderType: + $ref: '#/components/schemas/IdentityProviderType' + IpAddressType: + $ref: '#/components/schemas/IpAddressType' + LoggingRole: + type: string + maxLength: 2048 + minLength: 0 + pattern: ^(|arn:.*role/\S+)$ + PostAuthenticationLoginBanner: + type: string + maxLength: 4096 + minLength: 0 + pattern: ^[\x09-\x0D\x20-\x7E]*$ + PreAuthenticationLoginBanner: + type: string + maxLength: 4096 + minLength: 0 + pattern: ^[\x09-\x0D\x20-\x7E]*$ + ProtocolDetails: + $ref: '#/components/schemas/ProtocolDetails' + Protocols: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Protocol' + maxItems: 4 + minItems: 1 + S3StorageOptions: + $ref: '#/components/schemas/S3StorageOptions' + SecurityPolicyName: + type: string + maxLength: 100 + minLength: 0 + pattern: ^TransferSecurityPolicy-.+$ + ServerId: + type: string + maxLength: 19 + minLength: 19 + pattern: ^s-([0-9a-f]{17})$ + State: + $ref: '#/components/schemas/State' + StructuredLogDestinations: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 1600 + minLength: 20 + pattern: ^arn:\S+$ + maxItems: 1 + minItems: 0 + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 1 + WorkflowDetails: + $ref: '#/components/schemas/WorkflowDetails' + x-stackql-resource-name: server + description: Definition of AWS::Transfer::Server Resource Type + x-type-name: AWS::Transfer::Server + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - ServerId + x-create-only-properties: + - Domain + - IdentityProviderType + x-conditional-create-only-properties: + - EndpointDetails + - EndpointDetails/AddressAllocationIds + - IpAddressType + x-write-only-properties: + - IdentityProviderType + x-read-only-properties: + - Arn + - As2ServiceManagedEgressIpAddresses + - ServerId + - State + x-tagging: + cloudFormationSystemTags: true + permissions: + - transfer:TagResource + - transfer:UnTagResource + - transfer:ListTagsForResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - apigateway:GET + - ds:AuthorizeApplication + - ds:DescribeDirectories + - ec2:AssociateAddress + - ec2:CreateVpcEndpoint + - ec2:DescribeAddresses + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVpcEndpoints + - iam:PassRole + - logs:CreateLogDelivery + - logs:DeleteLogDelivery + - logs:DescribeLogGroups + - logs:DescribeResourcePolicies + - logs:GetLogDelivery + - logs:ListLogDeliveries + - logs:PutResourcePolicy + - logs:UpdateLogDelivery + - transfer:CreateServer + - transfer:DescribeServer + - transfer:StartServer + - transfer:StopServer + - transfer:TagResource + - transfer:UpdateServer + read: + - ec2:DescribeVpcEndpoints + - transfer:DescribeServer + update: + - apigateway:GET + - ec2:AssociateAddress + - ec2:CreateVpcEndpoint + - ec2:DeleteVpcEndpoints + - ec2:DescribeAddresses + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVpcEndpoints + - ec2:DisassociateAddress + - ec2:ModifyVpcEndpoint + - iam:PassRole + - logs:CreateLogDelivery + - logs:DeleteLogDelivery + - logs:DescribeLogGroups + - logs:DescribeResourcePolicies + - logs:GetLogDelivery + - logs:ListLogDeliveries + - logs:PutResourcePolicy + - logs:UpdateLogDelivery + - transfer:DescribeServer + - transfer:StartServer + - transfer:StopServer + - transfer:TagResource + - transfer:UnTagResource + - transfer:UpdateServer + delete: + - ds:DescribeDirectories + - ds:UnauthorizeApplication + - ec2:DeleteVpcEndpoints + - ec2:DescribeAddresses + - ec2:DescribeNetworkInterfaces + - ec2:DescribeVpcEndpoints + - ec2:DisassociateAddress + - logs:DeleteLogDelivery + - logs:GetLogDelivery + - logs:ListLogDeliveries + - transfer:DeleteServer + list: + - transfer:ListServers + HomeDirectoryMapEntry: + type: object + properties: + Entry: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^/.*$ + Target: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^/.*$ + Type: + $ref: '#/components/schemas/MapType' + required: + - Entry + - Target + additionalProperties: false + HomeDirectoryType: + type: string + enum: + - PATH + - LOGICAL + MapType: + type: string + enum: + - FILE + - DIRECTORY + PosixProfile: + type: object + properties: + Uid: + type: number + maximum: 4294967295 + minimum: 0 + Gid: + type: number + maximum: 4294967295 + minimum: 0 + SecondaryGids: + type: array + x-insertionOrder: false + items: + type: number + maximum: 4294967295 + minimum: 0 + maxItems: 16 + minItems: 0 + required: + - Gid + - Uid + additionalProperties: false + User: + type: object + properties: + Arn: + type: string + maxLength: 1600 + minLength: 20 + pattern: ^arn:\S+$ + HomeDirectory: + type: string + maxLength: 1024 + minLength: 0 + pattern: ^(|/.*)$ + HomeDirectoryMappings: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/HomeDirectoryMapEntry' + maxItems: 50000 + minItems: 1 + HomeDirectoryType: + $ref: '#/components/schemas/HomeDirectoryType' + Policy: + type: string + maxLength: 2048 + minLength: 0 + PosixProfile: + $ref: '#/components/schemas/PosixProfile' + Role: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:.*role/\S+$ + ServerId: + type: string + maxLength: 19 + minLength: 19 + pattern: ^s-([0-9a-f]{17})$ + SshPublicKeys: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 2048 + minLength: 0 + pattern: ^\s*(ssh|ecdsa)-[a-z0-9-]+[ \t]+(([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{1,3})?(={0,3})?)(\s*|[ \t]+[\S \t]*\s*)$ + description: This represents the SSH User Public Keys for CloudFormation resource + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 1 + UserName: + type: string + maxLength: 100 + minLength: 3 + pattern: ^[\w][\w@.-]{2,99}$ + required: + - Role + - ServerId + - UserName + x-stackql-resource-name: user + description: Definition of AWS::Transfer::User Resource Type + x-type-name: AWS::Transfer::User + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - ServerId + - UserName + x-create-only-properties: + - ServerId + - UserName + x-read-only-properties: + - Arn + x-required-properties: + - Role + - ServerId + - UserName + x-tagging: + cloudFormationSystemTags: true + permissions: + - transfer:TagResource + - transfer:UnTagResource + - transfer:ListTagsForResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - iam:PassRole + - transfer:CreateUser + - transfer:DescribeUser + - transfer:ImportSshPublicKey + - transfer:TagResource + read: + - transfer:DescribeUser + update: + - iam:PassRole + - transfer:DeleteSshPublicKey + - transfer:DescribeUser + - transfer:ImportSshPublicKey + - transfer:TagResource + - transfer:UnTagResource + - transfer:UpdateUser + delete: + - transfer:DeleteUser + list: + - transfer:ListUsers + WebAppCustomization: + type: object + properties: + Title: + description: Specifies a title to display on the web app. + type: string + maxLength: 100 + minLength: 0 + LogoFile: + description: Specifies a logo to display on the web app. + type: string + minLength: 1 + maxLength: 51200 + FaviconFile: + description: Specifies a favicon to display in the browser tab. + type: string + minLength: 1 + maxLength: 20960 + additionalProperties: false + WebAppEndpointPolicy: + type: string + enum: + - STANDARD + - FIPS + WebAppUnits: + oneOf: + - type: object + description: A union that contains the value for number of concurrent connections or the user sessions on your web app. + title: Provisioned + properties: + Provisioned: + type: integer + minimum: 1 + required: + - Provisioned + additionalProperties: false + WebApp: + type: object + properties: + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the web app. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + WebAppId: + description: A unique identifier for the web app. + type: string + pattern: ^webapp-([0-9a-f]{17})$ + minLength: 24 + maxLength: 24 + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + AccessEndpoint: + description: The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. + type: string + minLength: 1 + maxLength: 1024 + WebAppUnits: + $ref: '#/components/schemas/WebAppUnits' + WebAppCustomization: + $ref: '#/components/schemas/WebAppCustomization' + WebAppEndpointPolicy: + $ref: '#/components/schemas/WebAppEndpointPolicy' + Tags: + type: array + description: Key-value pairs that can be used to group and search for web apps. + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - IdentityProviderDetails + x-stackql-resource-name: web_app + description: Resource Type definition for AWS::Transfer::WebApp + x-type-name: AWS::Transfer::WebApp + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - WebAppId + x-create-only-properties: + - WebAppEndpointPolicy + - IdentityProviderDetails/InstanceArn + x-read-only-properties: + - Arn + - WebAppId + - IdentityProviderDetails/ApplicationArn + x-required-properties: + - IdentityProviderDetails + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - transfer:TagResource + - transfer:UnTagResource + - transfer:ListTagsForResource + x-required-permissions: + create: + - transfer:CreateWebApp + - transfer:DescribeWebApp + - transfer:DescribeWebAppCustomization + - transfer:TagResource + - transfer:UpdateWebAppCustomization + - iam:PassRole + - sso:CreateApplication + - sso:DescribeApplication + - sso:ListApplications + - sso:PutApplicationGrant + - sso:GetApplicationGrant + - sso:ListApplicationGrants + - sso:PutApplicationAuthenticationMethod + - sso:GetApplicationAuthenticationMethod + - sso:ListApplicationAuthenticationMethods + - sso:PutApplicationAccessScope + - sso:GetApplicationAccessScope + - sso:ListApplicationAccessScopes + read: + - transfer:DescribeWebApp + - transfer:DescribeWebAppCustomization + update: + - transfer:DescribeWebApp + - transfer:DescribeWebAppCustomization + - transfer:UpdateWebApp + - transfer:UpdateWebAppCustomization + - transfer:DeleteWebAppCustomization + - transfer:UnTagResource + - transfer:TagResource + - iam:PassRole + - sso:PutApplicationGrant + - sso:GetApplicationGrant + - sso:ListApplicationGrants + - sso:UpdateApplication + - sso:DescribeApplication + - sso:ListApplications + delete: + - transfer:DeleteWebApp + - sso:DescribeApplication + - sso:DeleteApplication + list: + - transfer:ListWebApps + S3Tag: + description: Specifies the key-value pair that are assigned to a file during the execution of a Tagging step. + type: object + properties: + Key: + description: The name assigned to the tag that you create. + type: string + minLength: 1 + maxLength: 128 + Value: + description: The value that corresponds to the key. + type: string + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + EfsInputFileLocation: + description: Specifies the details for an EFS file. + type: object + properties: + FileSystemId: + description: Specifies the EFS filesystem that contains the file. + type: string + pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$ + minLength: 0 + maxLength: 128 + Path: + description: The name assigned to the file when it was created in EFS. You use the object path to retrieve the object. + type: string + pattern: ^[^\x00]+$ + minLength: 1 + maxLength: 65536 + additionalProperties: false + S3InputFileLocation: + description: Specifies the details for a S3 file. + type: object + properties: + Bucket: + description: Specifies the S3 bucket that contains the file. + type: string + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + minLength: 3 + maxLength: 63 + Key: + description: The name assigned to the file when it was created in S3. You use the object key to retrieve the object. + type: string + pattern: .* + minLength: 0 + maxLength: 1024 + additionalProperties: false + InputFileLocation: + description: Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps. + type: object + properties: + S3FileLocation: + $ref: '#/components/schemas/S3InputFileLocation' + EfsFileLocation: + $ref: '#/components/schemas/EfsInputFileLocation' + additionalProperties: false + S3FileLocation: + description: Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps. + type: object + properties: + S3FileLocation: + $ref: '#/components/schemas/S3InputFileLocation' + additionalProperties: false + WorkflowStep: + description: The basic building block of a workflow. + type: object + properties: + CopyStepDetails: + description: Details for a step that performs a file copy. + type: object + properties: + DestinationFileLocation: + $ref: '#/components/schemas/S3FileLocation' + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + OverwriteExisting: + description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. + type: string + enum: + - 'TRUE' + - 'FALSE' + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + CustomStepDetails: + description: Details for a step that invokes a lambda function. + type: object + properties: + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + Target: + description: The ARN for the lambda function that is being called. + type: string + pattern: arn:[a-z-]+:lambda:.*$ + minLength: 0 + maxLength: 170 + TimeoutSeconds: + description: Timeout, in seconds, for the step. + type: integer + minimum: 1 + maximum: 1800 + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + DecryptStepDetails: + description: Details for a step that performs a file decryption. + type: object + properties: + DestinationFileLocation: + $ref: '#/components/schemas/InputFileLocation' + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + Type: + description: Specifies which encryption method to use. + type: string + enum: + - PGP + OverwriteExisting: + description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. + type: string + enum: + - 'TRUE' + - 'FALSE' + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + required: + - DestinationFileLocation + - Type + additionalProperties: false + DeleteStepDetails: + description: Details for a step that deletes the file. + type: object + properties: + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + TagStepDetails: + description: Details for a step that creates one or more tags. + type: object + properties: + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + Tags: + description: Array that contains from 1 to 10 key/value pairs. + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/S3Tag' SourceFileLocation: description: Specifies which file to use as input to the workflow step. type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - DecryptStepDetails: - description: Details for a step that performs a file decryption. + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + Type: + type: string + enum: + - COPY + - CUSTOM + - DECRYPT + - DELETE + - TAG + additionalProperties: false + Workflow: + type: object + properties: + OnExceptionSteps: + description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Steps: + description: Specifies the details for the steps that are in the specified workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Tags: + description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Description: + description: A textual description for the workflow. + type: string + pattern: ^[\w\- ]*$ + minLength: 0 + maxLength: 256 + WorkflowId: + description: A unique identifier for the workflow. + type: string + pattern: ^w-([a-z0-9]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the workflow. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + required: + - Steps + x-stackql-resource-name: workflow + description: Resource Type definition for AWS::Transfer::Workflow + x-type-name: AWS::Transfer::Workflow + x-stackql-primary-identifier: + - WorkflowId + x-create-only-properties: + - Steps + - OnExceptionSteps + - Description + x-read-only-properties: + - WorkflowId + - Arn + x-required-properties: + - Steps + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - transfer:ListTagsForResource + - transfer:UnTagResource + - transfer:TagResource + x-required-permissions: + create: + - transfer:CreateWorkflow + - transfer:TagResource + read: + - transfer:DescribeWorkflow + delete: + - transfer:DeleteWorkflow + list: + - transfer:ListWorkflows + update: + - transfer:UnTagResource + - transfer:TagResource + CreateAgreementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A textual description for the agreement. + type: string + pattern: ^[\u0021-\u007E]+$ + minLength: 1 + maxLength: 200 + ServerId: + description: A unique identifier for the server. + type: string + pattern: ^s-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + LocalProfileId: + description: A unique identifier for the local profile. + type: string + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + PartnerProfileId: + description: A unique identifier for the partner profile. + type: string + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + BaseDirectory: + description: Specifies the base directory for the agreement. + type: string + pattern: ^(|/.*)$ + maxLength: 1024 + AccessRole: + description: Specifies the access role for the agreement. + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + Status: + description: Specifies the status of the agreement. + type: string + enum: + - ACTIVE + - INACTIVE + Tags: + description: Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AgreementId: + description: A unique identifier for the agreement. + type: string + pattern: ^a-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the agreement. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + PreserveFilename: + description: Specifies whether to preserve the filename received for this agreement. + type: string + enum: + - ENABLED + - DISABLED + EnforceMessageSigning: + description: Specifies whether to enforce an AS2 message is signed for this agreement. + type: string + enum: + - ENABLED + - DISABLED + CustomDirectories: + description: Specifies a separate directory for each type of file to store for an AS2 message. + type: object + properties: + FailedFilesDirectory: + type: string + description: Specifies a location to store the failed files for an AS2 message. + pattern: (|/.*) + MdnFilesDirectory: + type: string + description: Specifies a location to store the MDN file for an AS2 message. + pattern: (|/.*) + PayloadFilesDirectory: + type: string + description: Specifies a location to store the payload file for an AS2 message. + pattern: (|/.*) + StatusFilesDirectory: + type: string + description: Specifies a location to store the status file for an AS2 message. + pattern: (|/.*) + TemporaryFilesDirectory: + type: string + description: Specifies a location to store the temporary processing file for an AS2 message. + pattern: (|/.*) + required: + - FailedFilesDirectory + - MdnFilesDirectory + - PayloadFilesDirectory + - StatusFilesDirectory + - TemporaryFilesDirectory + additionalProperties: false + x-stackQL-stringOnly: true + x-title: CreateAgreementRequest + type: object + required: [] + CreateCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Usage: + description: Specifies the usage type for the certificate. + type: string + enum: + - SIGNING + - ENCRYPTION + - TLS + Certificate: + description: Specifies the certificate body to be imported. + type: string + pattern: ^[\t\n\r\u0020-\u00FF]+$ + minLength: 1 + maxLength: 16384 + CertificateChain: + description: Specifies the certificate chain to be imported. + type: string + pattern: ^[\t\n\r\u0020-\u00FF]+$ + minLength: 1 + maxLength: 2097152 + PrivateKey: + description: Specifies the private key for the certificate. + type: string + pattern: ^[\t\n\r\u0020-\u00FF]+$ + minLength: 1 + maxLength: 16384 + ActiveDate: + description: Specifies the active date for the certificate. + type: string + InactiveDate: + description: Specifies the inactive date for the certificate. + type: string + Description: + description: A textual description for the certificate. + type: string + pattern: ^[\u0021-\u007E]+$ + minLength: 1 + maxLength: 200 + Tags: + description: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the agreement. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + CertificateId: + description: A unique identifier for the certificate. + type: string + pattern: ^cert-([0-9a-f]{17})$ + minLength: 22 + maxLength: 22 + Status: + description: A status description for the certificate. + type: string + enum: + - ACTIVE + - PENDING + - INACTIVE + Type: + description: Describing the type of certificate. With or without a private key. + type: string + enum: + - CERTIFICATE + - CERTIFICATE_WITH_PRIVATE_KEY + Serial: + description: Specifies Certificate's serial. + type: string + pattern: ^[0-9a-fA-F{}:?]*$ + minLength: 0 + maxLength: 48 + NotBeforeDate: + description: Specifies the not before date for the certificate. + type: string + NotAfterDate: + description: Specifies the not after date for the certificate. + type: string + x-stackQL-stringOnly: true + x-title: CreateCertificateRequest + type: object + required: [] + CreateConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessRole: + description: Specifies the access role for the connector. + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + As2Config: + description: Configuration for an AS2 connector. + type: object + properties: + LocalProfileId: + type: string + description: A unique identifier for the local profile. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + PartnerProfileId: + type: string + description: A unique identifier for the partner profile. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + MessageSubject: + type: string + description: The message subject for this AS2 connector configuration. + pattern: ^[\u0020-\u007E\t]+$ + minLength: 1 + maxLength: 1024 + Compression: + type: string + description: Compression setting for this AS2 connector configuration. + enum: + - ZLIB + - DISABLED + EncryptionAlgorithm: + type: string + description: Encryption algorithm for this AS2 connector configuration. + enum: + - AES128_CBC + - AES192_CBC + - AES256_CBC + - NONE + - DES_EDE3_CBC + SigningAlgorithm: + type: string + description: Signing algorithm for this AS2 connector configuration. + enum: + - SHA256 + - SHA384 + - SHA512 + - SHA1 + - NONE + MdnSigningAlgorithm: + type: string + description: MDN Signing algorithm for this AS2 connector configuration. + enum: + - SHA256 + - SHA384 + - SHA512 + - SHA1 + - NONE + - DEFAULT + MdnResponse: + type: string + description: MDN Response setting for this AS2 connector configuration. + enum: + - SYNC + - NONE + BasicAuthSecretId: + type: string + description: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector + minLength: 0 + maxLength: 2048 + PreserveContentType: + description: Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message. + type: string + enum: + - ENABLED + - DISABLED + additionalProperties: false + SftpConfig: + description: Configuration for an SFTP connector. + type: object + properties: + UserSecretId: + type: string + description: ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords. + minLength: 1 + maxLength: 2048 + TrustedHostKeys: + description: List of public host keys, for the external server to which you are connecting. + type: array + maxItems: 10 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/SftpConnectorTrustedHostKey' + MaxConcurrentConnections: + description: Specifies the number of active connections that your connector can establish with the remote server at the same time. + type: integer + minimum: 1 + maximum: 5 + default: 1 + additionalProperties: false + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the connector. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + ConnectorId: + description: A unique identifier for the connector. + type: string + pattern: ^c-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + LoggingRole: + description: Specifies the logging role for the connector. + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + ServiceManagedEgressIpAddresses: + description: The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector. + type: array + x-insertionOrder: false + items: + type: string + pattern: ^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ + Tags: + description: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Url: + description: URL for Connector + type: string + maxLength: 255 + SecurityPolicyName: + description: Security policy for SFTP Connector + type: string + pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ + maxLength: 50 + x-stackQL-stringOnly: true + x-title: CreateConnectorRequest + type: object + required: [] + CreateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object properties: - DestinationFileLocation: - $ref: '#/components/schemas/InputFileLocation' - Name: - description: The name of the step, used as an identifier. + As2Id: + description: AS2 identifier agreed with a trading partner. type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - Type: - description: Specifies which encryption method to use. + pattern: ^[\u0020-\u007E\s]*$ + minLength: 1 + maxLength: 128 + ProfileType: + description: Enum specifying whether the profile is local or associated with a trading partner. type: string enum: - - PGP - OverwriteExisting: - description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. + - LOCAL + - PARTNER + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CertificateIds: + description: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CertificateId' + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the profile. type: string - enum: - - 'TRUE' - - 'FALSE' - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. + pattern: arn:.* + minLength: 20 + maxLength: 1600 + ProfileId: + description: A unique identifier for the profile type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - DeleteStepDetails: - description: Details for a step that deletes the file. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + x-stackQL-stringOnly: true + x-title: CreateProfileRequest + type: object + required: [] + CreateServerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object properties: - Name: - description: The name of the step, used as an identifier. + Arn: type: string - pattern: ^[\w-]*$ + maxLength: 1600 + minLength: 20 + pattern: ^arn:\S+$ + As2ServiceManagedEgressIpAddresses: + type: array + x-insertionOrder: false + items: + type: string + pattern: ^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ + description: The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs. These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well. + Certificate: + type: string + maxLength: 1600 minLength: 0 - maxLength: 30 - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. + Domain: + $ref: '#/components/schemas/Domain' + EndpointDetails: + $ref: '#/components/schemas/EndpointDetails' + EndpointType: + $ref: '#/components/schemas/EndpointType' + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + IdentityProviderType: + $ref: '#/components/schemas/IdentityProviderType' + IpAddressType: + $ref: '#/components/schemas/IpAddressType' + LoggingRole: type: string - pattern: ^\$\{(\w+.)+\w+\}$ + maxLength: 2048 minLength: 0 - maxLength: 256 - additionalProperties: false - TagStepDetails: - description: Details for a step that creates one or more tags. + pattern: ^(|arn:.*role/\S+)$ + PostAuthenticationLoginBanner: + type: string + maxLength: 4096 + minLength: 0 + pattern: ^[\x09-\x0D\x20-\x7E]*$ + PreAuthenticationLoginBanner: + type: string + maxLength: 4096 + minLength: 0 + pattern: ^[\x09-\x0D\x20-\x7E]*$ + ProtocolDetails: + $ref: '#/components/schemas/ProtocolDetails' + Protocols: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Protocol' + maxItems: 4 + minItems: 1 + S3StorageOptions: + $ref: '#/components/schemas/S3StorageOptions' + SecurityPolicyName: + type: string + maxLength: 100 + minLength: 0 + pattern: ^TransferSecurityPolicy-.+$ + ServerId: + type: string + maxLength: 19 + minLength: 19 + pattern: ^s-([0-9a-f]{17})$ + State: + $ref: '#/components/schemas/State' + StructuredLogDestinations: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 1600 + minLength: 20 + pattern: ^arn:\S+$ + maxItems: 1 + minItems: 0 + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 1 + WorkflowDetails: + $ref: '#/components/schemas/WorkflowDetails' + x-stackQL-stringOnly: true + x-title: CreateServerRequest + type: object + required: [] + CreateUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: type: object properties: - Name: - description: The name of the step, used as an identifier. + Arn: type: string - pattern: ^[\w-]*$ + maxLength: 1600 + minLength: 20 + pattern: ^arn:\S+$ + HomeDirectory: + type: string + maxLength: 1024 minLength: 0 - maxLength: 30 - Tags: - description: Array that contains from 1 to 10 key/value pairs. + pattern: ^(|/.*)$ + HomeDirectoryMappings: type: array - maxItems: 10 - uniqueItems: true x-insertionOrder: false items: - $ref: '#/components/schemas/S3Tag' - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. + $ref: '#/components/schemas/HomeDirectoryMapEntry' + maxItems: 50000 + minItems: 1 + HomeDirectoryType: + $ref: '#/components/schemas/HomeDirectoryType' + Policy: type: string - pattern: ^\$\{(\w+.)+\w+\}$ + maxLength: 2048 minLength: 0 - maxLength: 256 - additionalProperties: false - Type: + PosixProfile: + $ref: '#/components/schemas/PosixProfile' + Role: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:.*role/\S+$ + ServerId: + type: string + maxLength: 19 + minLength: 19 + pattern: ^s-([0-9a-f]{17})$ + SshPublicKeys: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 2048 + minLength: 0 + pattern: ^\s*(ssh|ecdsa)-[a-z0-9-]+[ \t]+(([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{1,3})?(={0,3})?)(\s*|[ \t]+[\S \t]*\s*)$ + description: This represents the SSH User Public Keys for CloudFormation resource + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 50 + minItems: 1 + UserName: + type: string + maxLength: 100 + minLength: 3 + pattern: ^[\w][\w@.-]{2,99}$ + x-stackQL-stringOnly: true + x-title: CreateUserRequest + type: object + required: [] + CreateWebAppRequest: + properties: + ClientToken: type: string - enum: - - COPY - - CUSTOM - - DECRYPT - - DELETE - - TAG - additionalProperties: false - Workflow: + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the web app. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + WebAppId: + description: A unique identifier for the web app. + type: string + pattern: ^webapp-([0-9a-f]{17})$ + minLength: 24 + maxLength: 24 + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + AccessEndpoint: + description: The AccessEndpoint is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value. + type: string + minLength: 1 + maxLength: 1024 + WebAppUnits: + $ref: '#/components/schemas/WebAppUnits' + WebAppCustomization: + $ref: '#/components/schemas/WebAppCustomization' + WebAppEndpointPolicy: + $ref: '#/components/schemas/WebAppEndpointPolicy' + Tags: + type: array + description: Key-value pairs that can be used to group and search for web apps. + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateWebAppRequest type: object + required: [] + CreateWorkflowRequest: properties: - OnExceptionSteps: - description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. - type: array - maxItems: 8 - uniqueItems: true - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowStep' - Steps: - description: Specifies the details for the steps that are in the specified workflow. - type: array - maxItems: 8 - uniqueItems: true - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowStep' - Tags: - description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Description: - description: A textual description for the workflow. + ClientToken: type: string - pattern: ^[\w\- ]*$ - minLength: 0 - maxLength: 256 - WorkflowId: - description: A unique identifier for the workflow. + RoleArn: type: string - pattern: ^w-([a-z0-9]{17})$ - minLength: 19 - maxLength: 19 - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the workflow. + TypeName: type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - required: - - Steps - x-stackql-resource-name: workflow - x-stackql-primaryIdentifier: - - WorkflowId - x-create-only-properties: - - Steps - - OnExceptionSteps - - Description - x-read-only-properties: - - WorkflowId - - Arn - x-required-permissions: - create: - - transfer:CreateWorkflow - - transfer:TagResource - read: - - transfer:DescribeWorkflow - delete: - - transfer:DeleteWorkflow - list: - - transfer:ListWorkflows - update: - - transfer:UnTagResource - - transfer:TagResource - x-stackQL-resources: - agreements: - name: agreements - id: awscc.transfer.agreements - x-cfn-schema-name: Agreement - x-type: list - x-identifiers: - - AgreementId - - ServerId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, - JSON_EXTRACT(Properties, '$.ServerId') as server_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AgreementId') as agreement_id, - json_extract_path_text(Properties, 'ServerId') as server_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' - AND region = 'us-east-1' - agreement: - name: agreement - id: awscc.transfer.agreement + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OnExceptionSteps: + description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Steps: + description: Specifies the details for the steps that are in the specified workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Tags: + description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Description: + description: A textual description for the workflow. + type: string + pattern: ^[\w\- ]*$ + minLength: 0 + maxLength: 256 + WorkflowId: + description: A unique identifier for the workflow. + type: string + pattern: ^w-([a-z0-9]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the workflow. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + x-stackQL-stringOnly: true + x-title: CreateWorkflowRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + agreements: + name: agreements + id: awscc.transfer.agreements x-cfn-schema-name: Agreement - x-type: get + x-cfn-type-name: AWS::Transfer::Agreement x-identifiers: - AgreementId - ServerId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Agreement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Agreement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Agreement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Agreement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agreements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agreements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/agreements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -789,12 +2739,15 @@ components: JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.PreserveFilename') as preserve_filename, + JSON_EXTRACT(Properties, '$.EnforceMessageSigning') as enforce_message_signing, + JSON_EXTRACT(Properties, '$.CustomDirectories') as custom_directories FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Agreement' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -808,17 +2761,27 @@ components: json_extract_path_text(Properties, 'Status') as status, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'AgreementId') as agreement_id, - json_extract_path_text(Properties, 'Arn') as arn + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'PreserveFilename') as preserve_filename, + json_extract_path_text(Properties, 'EnforceMessageSigning') as enforce_message_signing, + json_extract_path_text(Properties, 'CustomDirectories') as custom_directories FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Agreement' AND data__Identifier = '|' AND region = 'us-east-1' - certificates: - name: certificates - id: awscc.transfer.certificates - x-cfn-schema-name: Certificate - x-type: list + agreements_list_only: + name: agreements_list_only + id: awscc.transfer.agreements_list_only + x-cfn-schema-name: Agreement + x-cfn-type-name: AWS::Transfer::Agreement x-identifiers: - - CertificateId + - AgreementId + - ServerId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -826,28 +2789,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.CertificateId') as certificate_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' + JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, + JSON_EXTRACT(Properties, '$.ServerId') as server_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'CertificateId') as certificate_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' + json_extract_path_text(Properties, 'AgreementId') as agreement_id, + json_extract_path_text(Properties, 'ServerId') as server_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' AND region = 'us-east-1' - certificate: - name: certificate - id: awscc.transfer.certificate + certificates: + name: certificates + id: awscc.transfer.certificates x-cfn-schema-name: Certificate - x-type: get + x-cfn-type-name: AWS::Transfer::Certificate x-identifiers: - CertificateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -871,7 +2884,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -894,13 +2907,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Certificate' AND data__Identifier = '' AND region = 'us-east-1' - connectors: - name: connectors - id: awscc.transfer.connectors - x-cfn-schema-name: Connector - x-type: list + certificates_list_only: + name: certificates_list_only + id: awscc.transfer.certificates_list_only + x-cfn-schema-name: Certificate + x-cfn-type-name: AWS::Transfer::Certificate x-identifiers: - - ConnectorId + - CertificateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -908,28 +2927,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' + JSON_EXTRACT(Properties, '$.CertificateId') as certificate_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ConnectorId') as connector_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' + json_extract_path_text(Properties, 'CertificateId') as certificate_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' AND region = 'us-east-1' - connector: - name: connector - id: awscc.transfer.connector + connectors: + name: connectors + id: awscc.transfer.connectors x-cfn-schema-name: Connector - x-type: get + x-cfn-type-name: AWS::Transfer::Connector x-identifiers: - ConnectorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -940,13 +3007,15 @@ components: JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id, JSON_EXTRACT(Properties, '$.LoggingRole') as logging_role, + JSON_EXTRACT(Properties, '$.ServiceManagedEgressIpAddresses') as service_managed_egress_ip_addresses, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Url') as url + JSON_EXTRACT(Properties, '$.Url') as url, + JSON_EXTRACT(Properties, '$.SecurityPolicyName') as security_policy_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Connector' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -957,18 +3026,26 @@ components: json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'ConnectorId') as connector_id, json_extract_path_text(Properties, 'LoggingRole') as logging_role, + json_extract_path_text(Properties, 'ServiceManagedEgressIpAddresses') as service_managed_egress_ip_addresses, json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Url') as url + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'SecurityPolicyName') as security_policy_name FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Connector' AND data__Identifier = '' AND region = 'us-east-1' - profiles: - name: profiles - id: awscc.transfer.profiles - x-cfn-schema-name: Profile - x-type: list + connectors_list_only: + name: connectors_list_only + id: awscc.transfer.connectors_list_only + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::Transfer::Connector x-identifiers: - - ProfileId + - ConnectorId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -976,28 +3053,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' + JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProfileId') as profile_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' + json_extract_path_text(Properties, 'ConnectorId') as connector_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' AND region = 'us-east-1' - profile: - name: profile - id: awscc.transfer.profile + profiles: + name: profiles + id: awscc.transfer.profiles x-cfn-schema-name: Profile - x-type: get + x-cfn-type-name: AWS::Transfer::Profile x-identifiers: - ProfileId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1012,7 +3137,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1026,13 +3151,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Profile' AND data__Identifier = '' AND region = 'us-east-1' - workflows: - name: workflows - id: awscc.transfer.workflows - x-cfn-schema-name: Workflow - x-type: list + profiles_list_only: + name: profiles_list_only + id: awscc.transfer.profiles_list_only + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::Transfer::Profile x-identifiers: - - WorkflowId + - ProfileId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1040,28 +3171,474 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'WorkflowId') as workflow_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' + AND region = 'us-east-1' + servers: + name: servers + id: awscc.transfer.servers + x-cfn-schema-name: Server + x-cfn-type-name: AWS::Transfer::Server + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Server&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Server" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Server" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Server" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/servers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/servers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/servers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.As2ServiceManagedEgressIpAddresses') as as2_service_managed_egress_ip_addresses, + JSON_EXTRACT(Properties, '$.Certificate') as certificate, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.EndpointDetails') as endpoint_details, + JSON_EXTRACT(Properties, '$.EndpointType') as endpoint_type, + JSON_EXTRACT(Properties, '$.IdentityProviderDetails') as identity_provider_details, + JSON_EXTRACT(Properties, '$.IdentityProviderType') as identity_provider_type, + JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type, + JSON_EXTRACT(Properties, '$.LoggingRole') as logging_role, + JSON_EXTRACT(Properties, '$.PostAuthenticationLoginBanner') as post_authentication_login_banner, + JSON_EXTRACT(Properties, '$.PreAuthenticationLoginBanner') as pre_authentication_login_banner, + JSON_EXTRACT(Properties, '$.ProtocolDetails') as protocol_details, + JSON_EXTRACT(Properties, '$.Protocols') as protocols, + JSON_EXTRACT(Properties, '$.S3StorageOptions') as s3_storage_options, + JSON_EXTRACT(Properties, '$.SecurityPolicyName') as security_policy_name, + JSON_EXTRACT(Properties, '$.ServerId') as server_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.StructuredLogDestinations') as structured_log_destinations, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.WorkflowDetails') as workflow_details + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Server' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'As2ServiceManagedEgressIpAddresses') as as2_service_managed_egress_ip_addresses, + json_extract_path_text(Properties, 'Certificate') as certificate, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'EndpointDetails') as endpoint_details, + json_extract_path_text(Properties, 'EndpointType') as endpoint_type, + json_extract_path_text(Properties, 'IdentityProviderDetails') as identity_provider_details, + json_extract_path_text(Properties, 'IdentityProviderType') as identity_provider_type, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'LoggingRole') as logging_role, + json_extract_path_text(Properties, 'PostAuthenticationLoginBanner') as post_authentication_login_banner, + json_extract_path_text(Properties, 'PreAuthenticationLoginBanner') as pre_authentication_login_banner, + json_extract_path_text(Properties, 'ProtocolDetails') as protocol_details, + json_extract_path_text(Properties, 'Protocols') as protocols, + json_extract_path_text(Properties, 'S3StorageOptions') as s3_storage_options, + json_extract_path_text(Properties, 'SecurityPolicyName') as security_policy_name, + json_extract_path_text(Properties, 'ServerId') as server_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'StructuredLogDestinations') as structured_log_destinations, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkflowDetails') as workflow_details + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Server' + AND data__Identifier = '' + AND region = 'us-east-1' + servers_list_only: + name: servers_list_only + id: awscc.transfer.servers_list_only + x-cfn-schema-name: Server + x-cfn-type-name: AWS::Transfer::Server + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Server' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Server' + AND region = 'us-east-1' + users: + name: users + id: awscc.transfer.users + x-cfn-schema-name: User + x-cfn-type-name: AWS::Transfer::User + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::User" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.HomeDirectory') as home_directory, + JSON_EXTRACT(Properties, '$.HomeDirectoryMappings') as home_directory_mappings, + JSON_EXTRACT(Properties, '$.HomeDirectoryType') as home_directory_type, + JSON_EXTRACT(Properties, '$.Policy') as policy, + JSON_EXTRACT(Properties, '$.PosixProfile') as posix_profile, + JSON_EXTRACT(Properties, '$.Role') as role, + JSON_EXTRACT(Properties, '$.ServerId') as server_id, + JSON_EXTRACT(Properties, '$.SshPublicKeys') as ssh_public_keys, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UserName') as user_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::User' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'HomeDirectory') as home_directory, + json_extract_path_text(Properties, 'HomeDirectoryMappings') as home_directory_mappings, + json_extract_path_text(Properties, 'HomeDirectoryType') as home_directory_type, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'PosixProfile') as posix_profile, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'ServerId') as server_id, + json_extract_path_text(Properties, 'SshPublicKeys') as ssh_public_keys, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserName') as user_name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::User' + AND data__Identifier = '' + AND region = 'us-east-1' + users_list_only: + name: users_list_only + id: awscc.transfer.users_list_only + x-cfn-schema-name: User + x-cfn-type-name: AWS::Transfer::User + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::User' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::User' + AND region = 'us-east-1' + web_apps: + name: web_apps + id: awscc.transfer.web_apps + x-cfn-schema-name: WebApp + x-cfn-type-name: AWS::Transfer::WebApp + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WebApp&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::WebApp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::WebApp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::WebApp" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/web_apps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/web_apps/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/web_apps/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.WebAppId') as web_app_id, + JSON_EXTRACT(Properties, '$.IdentityProviderDetails') as identity_provider_details, + JSON_EXTRACT(Properties, '$.AccessEndpoint') as access_endpoint, + JSON_EXTRACT(Properties, '$.WebAppUnits') as web_app_units, + JSON_EXTRACT(Properties, '$.WebAppCustomization') as web_app_customization, + JSON_EXTRACT(Properties, '$.WebAppEndpointPolicy') as web_app_endpoint_policy, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::WebApp' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'WebAppId') as web_app_id, + json_extract_path_text(Properties, 'IdentityProviderDetails') as identity_provider_details, + json_extract_path_text(Properties, 'AccessEndpoint') as access_endpoint, + json_extract_path_text(Properties, 'WebAppUnits') as web_app_units, + json_extract_path_text(Properties, 'WebAppCustomization') as web_app_customization, + json_extract_path_text(Properties, 'WebAppEndpointPolicy') as web_app_endpoint_policy, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::WebApp' + AND data__Identifier = '' + AND region = 'us-east-1' + web_apps_list_only: + name: web_apps_list_only + id: awscc.transfer.web_apps_list_only + x-cfn-schema-name: WebApp + x-cfn-type-name: AWS::Transfer::WebApp + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::WebApp' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::WebApp' AND region = 'us-east-1' - workflow: - name: workflow - id: awscc.transfer.workflow + workflows: + name: workflows + id: awscc.transfer.workflows x-cfn-schema-name: Workflow - x-type: get + x-cfn-type-name: AWS::Transfer::Workflow x-identifiers: - WorkflowId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1076,7 +3653,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1090,3 +3667,523 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Workflow' AND data__Identifier = '' AND region = 'us-east-1' + workflows_list_only: + name: workflows_list_only + id: awscc.transfer.workflows_list_only + x-cfn-schema-name: Workflow + x-cfn-type-name: AWS::Transfer::Workflow + x-identifiers: + - WorkflowId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkflowId') as workflow_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Agreement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAgreement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAgreementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Server&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServer + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WebApp&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWebApp + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWebAppRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkflow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkflowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/verifiedpermissions.yaml b/providers/src/awscc/v00.00.00000/services/verifiedpermissions.yaml index 792b9ca9..4974d732 100644 --- a/providers/src/awscc/v00.00.00000/services/verifiedpermissions.yaml +++ b/providers/src/awscc/v00.00.00000/services/verifiedpermissions.yaml @@ -1,10 +1,401 @@ openapi: 3.0.0 info: title: VerifiedPermissions - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: + CognitoGroupConfiguration: + type: object + properties: + GroupEntityType: + type: string + maxLength: 200 + minLength: 1 + pattern: ^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$ + required: + - GroupEntityType + additionalProperties: false CognitoUserPoolConfiguration: type: object properties: @@ -15,7 +406,6 @@ components: pattern: ^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\d{12}:userpool/[\w-]+_[0-9a-zA-Z]+))$ ClientIds: type: array - x-insertionOrder: false items: type: string maxLength: 255 @@ -23,24 +413,35 @@ components: pattern: ^.*$ maxItems: 1000 minItems: 0 + x-insertionOrder: false + GroupConfiguration: + $ref: '#/components/schemas/CognitoGroupConfiguration' required: - UserPoolArn additionalProperties: false IdentitySourceConfiguration: - type: object - x-title: CognitoUserPoolConfiguration - properties: - CognitoUserPoolConfiguration: - $ref: '#/components/schemas/CognitoUserPoolConfiguration' - required: - - CognitoUserPoolConfiguration - additionalProperties: false + oneOf: + - type: object + title: CognitoUserPoolConfiguration + properties: + CognitoUserPoolConfiguration: + $ref: '#/components/schemas/CognitoUserPoolConfiguration' + required: + - CognitoUserPoolConfiguration + additionalProperties: false + - type: object + title: OpenIdConnectConfiguration + properties: + OpenIdConnectConfiguration: + $ref: '#/components/schemas/OpenIdConnectConfiguration' + required: + - OpenIdConnectConfiguration + additionalProperties: false IdentitySourceDetails: type: object properties: ClientIds: type: array - x-insertionOrder: false items: type: string maxLength: 255 @@ -48,6 +449,7 @@ components: pattern: ^.*$ maxItems: 1000 minItems: 0 + x-insertionOrder: false UserPoolArn: type: string maxLength: 255 @@ -61,6 +463,94 @@ components: OpenIdIssuer: $ref: '#/components/schemas/OpenIdIssuer' additionalProperties: false + OpenIdConnectAccessTokenConfiguration: + type: object + properties: + PrincipalIdClaim: + type: string + default: sub + minLength: 1 + Audiences: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + maxItems: 255 + minItems: 1 + x-insertionOrder: false + additionalProperties: false + OpenIdConnectConfiguration: + type: object + properties: + Issuer: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^https://.*$ + EntityIdPrefix: + type: string + maxLength: 100 + minLength: 1 + GroupConfiguration: + $ref: '#/components/schemas/OpenIdConnectGroupConfiguration' + TokenSelection: + $ref: '#/components/schemas/OpenIdConnectTokenSelection' + required: + - Issuer + - TokenSelection + additionalProperties: false + OpenIdConnectGroupConfiguration: + type: object + properties: + GroupClaim: + type: string + minLength: 1 + GroupEntityType: + type: string + maxLength: 200 + minLength: 1 + pattern: ^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$ + required: + - GroupClaim + - GroupEntityType + additionalProperties: false + OpenIdConnectIdentityTokenConfiguration: + type: object + properties: + PrincipalIdClaim: + type: string + default: sub + minLength: 1 + ClientIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^.*$ + maxItems: 1000 + minItems: 0 + x-insertionOrder: false + additionalProperties: false + OpenIdConnectTokenSelection: + oneOf: + - type: object + title: AccessTokenOnly + properties: + AccessTokenOnly: + $ref: '#/components/schemas/OpenIdConnectAccessTokenConfiguration' + required: + - AccessTokenOnly + additionalProperties: false + - type: object + title: IdentityTokenOnly + properties: + IdentityTokenOnly: + $ref: '#/components/schemas/OpenIdConnectIdentityTokenConfiguration' + required: + - IdentityTokenOnly + additionalProperties: false OpenIdIssuer: type: string enum: @@ -91,7 +581,9 @@ components: - Configuration - PolicyStoreId x-stackql-resource-name: identity_source - x-stackql-primaryIdentifier: + description: Definition of AWS::VerifiedPermissions::IdentitySource Resource Type + x-type-name: AWS::VerifiedPermissions::IdentitySource + x-stackql-primary-identifier: - IdentitySourceId - PolicyStoreId x-create-only-properties: @@ -99,45 +591,37 @@ components: x-read-only-properties: - Details - IdentitySourceId + x-required-properties: + - Configuration + - PolicyStoreId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - verifiedpermissions:CreateIdentitySource - verifiedpermissions:GetIdentitySource - - verifiedpermissions:UpdateIdentitySource - - verifiedpermissions:DeleteIdentitySource - - verifiedpermissions:ListIdentitySources - cognito-idp:DescribeUserPool - cognito-idp:ListUserPoolClients read: - - verifiedpermissions:CreateIdentitySource - verifiedpermissions:GetIdentitySource - - verifiedpermissions:UpdateIdentitySource - - verifiedpermissions:DeleteIdentitySource - - verifiedpermissions:ListIdentitySources - cognito-idp:DescribeUserPool - cognito-idp:ListUserPoolClients update: - - verifiedpermissions:CreateIdentitySource - - verifiedpermissions:GetIdentitySource - verifiedpermissions:UpdateIdentitySource - - verifiedpermissions:DeleteIdentitySource - - verifiedpermissions:ListIdentitySources + - verifiedpermissions:GetIdentitySource - cognito-idp:DescribeUserPool - cognito-idp:ListUserPoolClients delete: - - verifiedpermissions:CreateIdentitySource - - verifiedpermissions:GetIdentitySource - - verifiedpermissions:UpdateIdentitySource - verifiedpermissions:DeleteIdentitySource - - verifiedpermissions:ListIdentitySources + - verifiedpermissions:GetIdentitySource - cognito-idp:DescribeUserPool - cognito-idp:ListUserPoolClients list: - - verifiedpermissions:CreateIdentitySource - - verifiedpermissions:GetIdentitySource - - verifiedpermissions:UpdateIdentitySource - - verifiedpermissions:DeleteIdentitySource - verifiedpermissions:ListIdentitySources + - verifiedpermissions:GetIdentitySource - cognito-idp:DescribeUserPool - cognito-idp:ListUserPoolClients EntityIdentifier: @@ -230,7 +714,9 @@ components: - Definition - PolicyStoreId x-stackql-resource-name: policy - x-stackql-primaryIdentifier: + description: Definition of AWS::VerifiedPermissions::Policy Resource Type + x-type-name: AWS::VerifiedPermissions::Policy + x-stackql-primary-identifier: - PolicyId - PolicyStoreId x-create-only-properties: @@ -238,32 +724,29 @@ components: x-read-only-properties: - PolicyId - PolicyType + x-required-properties: + - Definition + - PolicyStoreId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - verifiedpermissions:CreatePolicy - verifiedpermissions:GetPolicy - - verifiedpermissions:UpdatePolicy - - verifiedpermissions:DeletePolicy read: - - verifiedpermissions:CreatePolicy - verifiedpermissions:GetPolicy - - verifiedpermissions:UpdatePolicy - - verifiedpermissions:DeletePolicy update: - - verifiedpermissions:CreatePolicy - - verifiedpermissions:GetPolicy - verifiedpermissions:UpdatePolicy - - verifiedpermissions:DeletePolicy - delete: - - verifiedpermissions:CreatePolicy - verifiedpermissions:GetPolicy - - verifiedpermissions:UpdatePolicy + delete: - verifiedpermissions:DeletePolicy + - verifiedpermissions:GetPolicy list: - - verifiedpermissions:CreatePolicy + - verifiedpermissions:ListPolicies - verifiedpermissions:GetPolicy - - verifiedpermissions:UpdatePolicy - - verifiedpermissions:DeletePolicy ValidationMode: type: string enum: @@ -279,12 +762,51 @@ components: additionalProperties: false SchemaJson: type: string + SchemaCedarFormat: + type: string SchemaDefinition: + oneOf: + - type: object + title: CedarJson + properties: + CedarJson: + $ref: '#/components/schemas/SchemaJson' + required: + - CedarJson + additionalProperties: false + - type: object + title: CedarFormat + properties: + CedarFormat: + $ref: '#/components/schemas/SchemaCedarFormat' + required: + - CedarFormat + additionalProperties: false + DeletionMode: + type: string + default: DISABLED + enum: + - ENABLED + - DISABLED + DeletionProtection: type: object properties: - CedarJson: - $ref: '#/components/schemas/SchemaJson' + Mode: + $ref: '#/components/schemas/DeletionMode' + required: + - Mode + additionalProperties: false + Tag: + type: object additionalProperties: false + properties: + Key: + type: string + Value: + type: string + required: + - Key + - Value PolicyStore: type: object properties: @@ -306,45 +828,60 @@ components: $ref: '#/components/schemas/ValidationSettings' Schema: $ref: '#/components/schemas/SchemaDefinition' + DeletionProtection: + $ref: '#/components/schemas/DeletionProtection' + Tags: + description: The tags to add to the policy store + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - ValidationSettings x-stackql-resource-name: policy_store - x-stackql-primaryIdentifier: + description: Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests + x-type-name: AWS::VerifiedPermissions::PolicyStore + x-stackql-primary-identifier: - PolicyStoreId x-read-only-properties: - Arn - PolicyStoreId + x-required-properties: + - ValidationSettings + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - verifiedpermissions:TagResource + - verifiedpermissions:ListTagsForResource + - verifiedpermissions:UntagResource x-required-permissions: create: - verifiedpermissions:CreatePolicyStore + - verifiedpermissions:TagResource - verifiedpermissions:GetPolicyStore - - verifiedpermissions:UpdatePolicyStore - - verifiedpermissions:DeletePolicyStore - verifiedpermissions:PutSchema read: - - verifiedpermissions:CreatePolicyStore - verifiedpermissions:GetPolicyStore - - verifiedpermissions:UpdatePolicyStore - - verifiedpermissions:DeletePolicyStore + - verifiedpermissions:ListTagsForResource - verifiedpermissions:GetSchema update: - - verifiedpermissions:CreatePolicyStore - - verifiedpermissions:GetPolicyStore - verifiedpermissions:UpdatePolicyStore - - verifiedpermissions:DeletePolicyStore + - verifiedpermissions:GetPolicyStore + - verifiedpermissions:TagResource + - verifiedpermissions:UntagResource - verifiedpermissions:GetSchema - verifiedpermissions:PutSchema delete: - - verifiedpermissions:CreatePolicyStore - - verifiedpermissions:GetPolicyStore - - verifiedpermissions:UpdatePolicyStore - verifiedpermissions:DeletePolicyStore - list: - - verifiedpermissions:CreatePolicyStore - verifiedpermissions:GetPolicyStore - - verifiedpermissions:UpdatePolicyStore - - verifiedpermissions:DeletePolicyStore + list: - verifiedpermissions:ListPolicyStores + - verifiedpermissions:GetPolicyStore - verifiedpermissions:GetSchema PolicyTemplate: type: object @@ -371,81 +908,252 @@ components: - Statement - PolicyStoreId x-stackql-resource-name: policy_template - x-stackql-primaryIdentifier: + description: Definition of AWS::VerifiedPermissions::PolicyTemplate Resource Type + x-type-name: AWS::VerifiedPermissions::PolicyTemplate + x-stackql-primary-identifier: - PolicyStoreId - PolicyTemplateId x-create-only-properties: - PolicyStoreId x-read-only-properties: - PolicyTemplateId + x-required-properties: + - Statement + - PolicyStoreId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - verifiedpermissions:CreatePolicyTemplate - verifiedpermissions:GetPolicyTemplate - - verifiedpermissions:UpdatePolicyTemplate - - verifiedpermissions:DeletePolicyTemplate read: - - verifiedpermissions:CreatePolicyTemplate - verifiedpermissions:GetPolicyTemplate - - verifiedpermissions:UpdatePolicyTemplate - - verifiedpermissions:DeletePolicyTemplate update: - - verifiedpermissions:CreatePolicyTemplate - - verifiedpermissions:GetPolicyTemplate - verifiedpermissions:UpdatePolicyTemplate - - verifiedpermissions:DeletePolicyTemplate - delete: - - verifiedpermissions:CreatePolicyTemplate - verifiedpermissions:GetPolicyTemplate - - verifiedpermissions:UpdatePolicyTemplate + delete: - verifiedpermissions:DeletePolicyTemplate - list: - - verifiedpermissions:CreatePolicyTemplate - verifiedpermissions:GetPolicyTemplate - - verifiedpermissions:UpdatePolicyTemplate - - verifiedpermissions:DeletePolicyTemplate + list: - verifiedpermissions:ListPolicyTemplates + - verifiedpermissions:GetPolicyTemplate + CreateIdentitySourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Configuration: + $ref: '#/components/schemas/IdentitySourceConfiguration' + Details: + $ref: '#/components/schemas/IdentitySourceDetails' + IdentitySourceId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + PolicyStoreId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + PrincipalEntityType: + type: string + maxLength: 200 + minLength: 1 + pattern: ^.*$ + x-stackQL-stringOnly: true + x-title: CreateIdentitySourceRequest + type: object + required: [] + CreatePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Definition: + $ref: '#/components/schemas/PolicyDefinition' + PolicyId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + PolicyStoreId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + PolicyType: + $ref: '#/components/schemas/PolicyType' + x-stackQL-stringOnly: true + x-title: CreatePolicyRequest + type: object + required: [] + CreatePolicyStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2500 + minLength: 1 + pattern: ^arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$ + Description: + type: string + maxLength: 150 + minLength: 0 + PolicyStoreId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + ValidationSettings: + $ref: '#/components/schemas/ValidationSettings' + Schema: + $ref: '#/components/schemas/SchemaDefinition' + DeletionProtection: + $ref: '#/components/schemas/DeletionProtection' + Tags: + description: The tags to add to the policy store + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePolicyStoreRequest + type: object + required: [] + CreatePolicyTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 150 + minLength: 0 + PolicyStoreId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + PolicyTemplateId: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + Statement: + type: string + maxLength: 10000 + minLength: 1 + x-stackQL-stringOnly: true + x-title: CreatePolicyTemplateRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: identity_sources: name: identity_sources id: awscc.verifiedpermissions.identity_sources x-cfn-schema-name: IdentitySource - x-type: list - x-identifiers: - - IdentitySourceId - - PolicyStoreId - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IdentitySourceId') as identity_source_id, - JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IdentitySourceId') as identity_source_id, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' - AND region = 'us-east-1' - identity_source: - name: identity_source - id: awscc.verifiedpermissions.identity_source - x-cfn-schema-name: IdentitySource - x-type: get + x-cfn-type-name: AWS::VerifiedPermissions::IdentitySource x-identifiers: - IdentitySourceId - PolicyStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentitySource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::IdentitySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::IdentitySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::IdentitySource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -459,7 +1167,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -472,14 +1180,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' AND data__Identifier = '|' AND region = 'us-east-1' - policies: - name: policies - id: awscc.verifiedpermissions.policies - x-cfn-schema-name: Policy - x-type: list + identity_sources_list_only: + name: identity_sources_list_only + id: awscc.verifiedpermissions.identity_sources_list_only + x-cfn-schema-name: IdentitySource + x-cfn-type-name: AWS::VerifiedPermissions::IdentitySource x-identifiers: - - PolicyId + - IdentitySourceId - PolicyStoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -487,31 +1201,79 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, + JSON_EXTRACT(Properties, '$.IdentitySourceId') as identity_source_id, JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'IdentitySourceId') as identity_source_id, json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' AND region = 'us-east-1' - policy: - name: policy - id: awscc.verifiedpermissions.policy + policies: + name: policies + id: awscc.verifiedpermissions.policies x-cfn-schema-name: Policy - x-type: get + x-cfn-type-name: AWS::VerifiedPermissions::Policy x-identifiers: - PolicyId - PolicyStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::Policy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -524,7 +1286,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -536,13 +1298,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' AND data__Identifier = '|' AND region = 'us-east-1' - policy_stores: - name: policy_stores - id: awscc.verifiedpermissions.policy_stores - x-cfn-schema-name: PolicyStore - x-type: list + policies_list_only: + name: policies_list_only + id: awscc.verifiedpermissions.policies_list_only + x-cfn-schema-name: Policy + x-cfn-type-name: AWS::VerifiedPermissions::Policy x-identifiers: + - PolicyId - PolicyStoreId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -550,28 +1319,78 @@ components: ddl: |- SELECT region, + JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, + json_extract_path_text(Properties, 'PolicyId') as policy_id, json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' AND region = 'us-east-1' - policy_store: - name: policy_store - id: awscc.verifiedpermissions.policy_store + policy_stores: + name: policy_stores + id: awscc.verifiedpermissions.policy_stores x-cfn-schema-name: PolicyStore - x-type: get + x-cfn-type-name: AWS::VerifiedPermissions::PolicyStore x-identifiers: - PolicyStoreId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PolicyStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::PolicyStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::PolicyStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::PolicyStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policy_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -580,12 +1399,14 @@ components: JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id, JSON_EXTRACT(Properties, '$.ValidationSettings') as validation_settings, - JSON_EXTRACT(Properties, '$.Schema') as _schema + JSON_EXTRACT(Properties, '$.Schema') as _schema, + JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -594,18 +1415,25 @@ components: json_extract_path_text(Properties, 'Description') as description, json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, json_extract_path_text(Properties, 'ValidationSettings') as validation_settings, - json_extract_path_text(Properties, 'Schema') as _schema + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' AND data__Identifier = '' AND region = 'us-east-1' - policy_templates: - name: policy_templates - id: awscc.verifiedpermissions.policy_templates - x-cfn-schema-name: PolicyTemplate - x-type: list + policy_stores_list_only: + name: policy_stores_list_only + id: awscc.verifiedpermissions.policy_stores_list_only + x-cfn-schema-name: PolicyStore + x-cfn-type-name: AWS::VerifiedPermissions::PolicyStore x-identifiers: - PolicyStoreId - - PolicyTemplateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -613,31 +1441,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id, - JSON_EXTRACT(Properties, '$.PolicyTemplateId') as policy_template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' + JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, - json_extract_path_text(Properties, 'PolicyTemplateId') as policy_template_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' AND region = 'us-east-1' - policy_template: - name: policy_template - id: awscc.verifiedpermissions.policy_template + policy_templates: + name: policy_templates + id: awscc.verifiedpermissions.policy_templates x-cfn-schema-name: PolicyTemplate - x-type: get + x-cfn-type-name: AWS::VerifiedPermissions::PolicyTemplate x-identifiers: - PolicyStoreId - PolicyTemplateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PolicyTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::PolicyTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::PolicyTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VerifiedPermissions::PolicyTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policy_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -650,7 +1524,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -662,3 +1536,358 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' AND data__Identifier = '|' AND region = 'us-east-1' + policy_templates_list_only: + name: policy_templates_list_only + id: awscc.verifiedpermissions.policy_templates_list_only + x-cfn-schema-name: PolicyTemplate + x-cfn-type-name: AWS::VerifiedPermissions::PolicyTemplate + x-identifiers: + - PolicyStoreId + - PolicyTemplateId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id, + JSON_EXTRACT(Properties, '$.PolicyTemplateId') as policy_template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, + json_extract_path_text(Properties, 'PolicyTemplateId') as policy_template_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentitySource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentitySource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentitySourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Policy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PolicyStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicyStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PolicyTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicyTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/voiceid.yaml b/providers/src/awscc/v00.00.00000/services/voiceid.yaml index a602d25a..fddf22b0 100644 --- a/providers/src/awscc/v00.00.00000/services/voiceid.yaml +++ b/providers/src/awscc/v00.00.00000/services/voiceid.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: VoiceID - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ServerSideEncryptionConfiguration: type: object @@ -63,10 +443,24 @@ components: - Name - ServerSideEncryptionConfiguration x-stackql-resource-name: domain - x-stackql-primaryIdentifier: + description: The AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain. + x-type-name: AWS::VoiceID::Domain + x-stackql-primary-identifier: - DomainId x-read-only-properties: - DomainId + x-required-properties: + - Name + - ServerSideEncryptionConfiguration + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - voiceid:TagResource + - voiceid:UntagResource x-required-permissions: create: - voiceid:CreateDomain @@ -96,39 +490,153 @@ components: list: - voiceid:ListDomains - kms:Decrypt + CreateDomainRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 1024 + minLength: 1 + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ + DomainId: + type: string + maxLength: 22 + minLength: 22 + pattern: ^[a-zA-Z0-9]{22}$ + Name: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateDomainRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: domains: name: domains id: awscc.voiceid.domains x-cfn-schema-name: Domain - x-type: list + x-cfn-type-name: AWS::VoiceID::Domain x-identifiers: - DomainId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VoiceID::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VoiceID::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VoiceID::Domain" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VoiceID::Domain' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VoiceID::Domain' + AND data__Identifier = '' AND region = 'us-east-1' - domain: - name: domain - id: awscc.voiceid.domain + domains_list_only: + name: domains_list_only + id: awscc.voiceid.domains_list_only x-cfn-schema-name: Domain - x-type: get + x-cfn-type-name: AWS::VoiceID::Domain x-identifiers: - DomainId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -136,26 +644,209 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VoiceID::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VoiceID::Domain' - AND data__Identifier = '' + json_extract_path_text(Properties, 'DomainId') as domain_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Domain&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDomain + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDomainRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/vpclattice.yaml b/providers/src/awscc/v00.00.00000/services/vpclattice.yaml index e874b628..97c56ff1 100644 --- a/providers/src/awscc/v00.00.00000/services/vpclattice.yaml +++ b/providers/src/awscc/v00.00.00000/services/vpclattice.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: VpcLattice - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Tag: type: object @@ -51,8 +431,13 @@ components: ResourceIdentifier: type: string maxLength: 2048 - minLength: 20 - pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$ + minLength: 17 + pattern: ^((((sn)|(svc)|(rcfg))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(resourceconfiguration/rcfg)|(service/svc))-[0-9a-z]{17}))$ + ServiceNetworkLogType: + type: string + enum: + - SERVICE + - RESOURCE Tags: type: array x-insertionOrder: false @@ -64,15 +449,36 @@ components: required: - DestinationArn x-stackql-resource-name: access_log_subscription - x-stackql-primaryIdentifier: + description: Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. + x-type-name: AWS::VpcLattice::AccessLogSubscription + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id + - - ResourceIdentifier + - DestinationArn + - ServiceNetworkLogType x-create-only-properties: - ResourceIdentifier + x-write-only-properties: + - ResourceIdentifier x-read-only-properties: - Arn - Id - ResourceArn - ResourceId + x-required-properties: + - DestinationArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateAccessLogSubscription @@ -102,6 +508,7 @@ components: update: - vpc-lattice:GetAccessLogSubscription - vpc-lattice:UpdateAccessLogSubscription + - vpc-lattice:ListTagsForResource - vpc-lattice:TagResource - vpc-lattice:UntagResource - logs:UpdateLogDelivery @@ -135,6 +542,7 @@ components: - firehose:UntagDeliveryStream list: - vpc-lattice:ListAccessLogSubscriptions + - logs:GetLogDelivery AuthPolicy: type: object properties: @@ -142,7 +550,7 @@ components: type: string pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$ maxLength: 200 - minLength: 21 + minLength: 17 Policy: type: object State: @@ -154,12 +562,19 @@ components: - ResourceIdentifier - Policy x-stackql-resource-name: auth_policy - x-stackql-primaryIdentifier: + description: Creates or updates the auth policy. + x-type-name: AWS::VpcLattice::AuthPolicy + x-stackql-primary-identifier: - ResourceIdentifier x-create-only-properties: - ResourceIdentifier x-read-only-properties: - State + x-required-properties: + - ResourceIdentifier + - Policy + x-tagging: + taggable: false x-required-permissions: create: - vpc-lattice:GetAuthPolicy @@ -179,7 +594,7 @@ components: type: array items: $ref: '#/components/schemas/WeightedTargetGroup' - maxItems: 2 + maxItems: 10 minItems: 1 x-insertionOrder: false required: @@ -248,6 +663,7 @@ components: enum: - HTTP - HTTPS + - TLS_PASSTHROUGH ServiceArn: type: string maxLength: 2048 @@ -275,18 +691,39 @@ components: - DefaultAction - Protocol x-stackql-resource-name: listener - x-stackql-primaryIdentifier: + description: Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. + x-type-name: AWS::VpcLattice::Listener + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ServiceIdentifier + - Name + - Port x-create-only-properties: - ServiceIdentifier - Name - Port - Protocol + x-write-only-properties: + - ServiceIdentifier x-read-only-properties: - Arn - Id - ServiceArn - ServiceId + x-required-properties: + - DefaultAction + - Protocol + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateListener @@ -306,6 +743,301 @@ components: - vpc-lattice:DeleteListener list: - vpc-lattice:ListListeners + IpResource: + minLength: 4 + type: string + maxLength: 39 + PortRange: + minLength: 1 + pattern: ^((\d{1,5}\-\d{1,5})|(\d+))$ + type: string + maxLength: 11 + DnsResource: + additionalProperties: false + type: object + properties: + IpAddressType: + type: string + enum: + - IPV4 + - IPV6 + - DUALSTACK + DomainName: + minLength: 3 + type: string + maxLength: 255 + required: + - DomainName + - IpAddressType + ArnResource: + pattern: ^arn.* + type: string + maxLength: 1224 + Id: + minLength: 22 + pattern: ^rcfg-[0-9a-z]{17}$ + type: string + maxLength: 22 + ResourceConfiguration: + type: object + properties: + AllowAssociationToSharableServiceNetwork: + type: boolean + ProtocolType: + type: string + enum: + - TCP + ResourceConfigurationType: + type: string + enum: + - GROUP + - CHILD + - SINGLE + - ARN + PortRanges: + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PortRange' + ResourceConfigurationDefinition: + oneOf: + - additionalProperties: false + type: object + title: IpResource + properties: + IpResource: + $ref: '#/components/schemas/IpResource' + required: + - IpResource + - additionalProperties: false + type: object + title: ArnResource + properties: + ArnResource: + $ref: '#/components/schemas/ArnResource' + required: + - ArnResource + - additionalProperties: false + type: object + title: DnsResource + properties: + DnsResource: + $ref: '#/components/schemas/DnsResource' + required: + - DnsResource + type: object + Id: + $ref: '#/components/schemas/Id' + ResourceGatewayId: + type: string + Arn: + minLength: 20 + pattern: ^arn:[a-z0-9f\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$ + type: string + maxLength: 2048 + ResourceConfigurationAuthType: + type: string + enum: + - NONE + - AWS_IAM + ResourceConfigurationGroupId: + $ref: '#/components/schemas/Id' + Tags: + minItems: 0 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + Name: + minLength: 3 + pattern: ^(?!rcfg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + type: string + maxLength: 40 + required: + - Name + - ResourceConfigurationType + x-stackql-resource-name: resource_configuration + description: VpcLattice ResourceConfiguration CFN resource + x-type-name: AWS::VpcLattice::ResourceConfiguration + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - Id + x-create-only-properties: + - ResourceGatewayId + - ResourceConfigurationType + - ProtocolType + - ResourceConfigurationAuthType + x-write-only-properties: + - ResourceConfigurationAuthType + - ResourceConfigurationGroupId + x-read-only-properties: + - Id + - Arn + x-required-properties: + - Name + - ResourceConfigurationType + x-tagging: + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - vpc-lattice:GetResourceConfiguration + - vpc-lattice:ListTagsForResource + create: + - ec2:DescribeSubnets + - vpc-lattice:CreateResourceConfiguration + - vpc-lattice:GetResourceConfiguration + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource + update: + - ec2:DescribeSubnets + - vpc-lattice:TagResource + - vpc-lattice:UntagResource + - vpc-lattice:ListTagsForResource + - vpc-lattice:UpdateResourceConfiguration + - vpc-lattice:GetResourceConfiguration + list: + - vpc-lattice:ListResourceConfigurations + delete: + - vpc-lattice:DeleteResourceConfiguration + - vpc-lattice:GetResourceConfiguration + - vpc-lattice:UntagResource + ResourceGateway: + type: object + properties: + IpAddressType: + type: string + enum: + - IPV4 + - IPV6 + - DUALSTACK + VpcIdentifier: + minLength: 5 + type: string + maxLength: 50 + Ipv4AddressesPerEni: + description: The number of IPv4 addresses to allocate per ENI for the resource gateway + type: integer + Id: + minLength: 17 + pattern: ^((rgw-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}))$ + type: string + maxLength: 2048 + Arn: + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}$ + type: string + maxLength: 2048 + SubnetIds: + uniqueItems: true + description: The ID of one or more subnets in which to create an endpoint network interface. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + type: string + SecurityGroupIds: + uniqueItems: true + description: The ID of one or more security groups to associate with the endpoint network interface. + x-insertionOrder: false + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/DefaultSecurityGroup + type: string + Tags: + minItems: 0 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + Name: + minLength: 3 + pattern: ^(?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + type: string + maxLength: 40 + required: + - Name + - VpcIdentifier + - SubnetIds + x-stackql-resource-name: resource_gateway + description: Creates a resource gateway for a service. + x-type-name: AWS::VpcLattice::ResourceGateway + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - Id + x-create-only-properties: + - VpcIdentifier + - SubnetIds + - IpAddressType + - Name + x-read-only-properties: + - Id + - Arn + x-required-properties: + - Name + - VpcIdentifier + - SubnetIds + x-tagging: + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + cloudFormationSystemTags: true + x-required-permissions: + read: + - vpc-lattice:GetResourceGateway + - vpc-lattice:ListTagsForResource + create: + - vpc-lattice:CreateResourceGateway + - vpc-lattice:GetResourceGateway + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + update: + - vpc-lattice:UpdateResourceGateway + - vpc-lattice:GetResourceGateway + - vpc-lattice:TagResource + - vpc-lattice:UntagResource + - vpc-lattice:ListTagsForResource + - ec2:DescribeVpcs + - ec2:DescribeSubnets + - ec2:DescribeSecurityGroups + list: + - vpc-lattice:ListResourceGateways + delete: + - vpc-lattice:DeleteResourceGateway + - vpc-lattice:GetResourceGateway + - vpc-lattice:UntagResource ResourcePolicy: type: object properties: @@ -320,10 +1052,17 @@ components: - ResourceArn - Policy x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: + description: Retrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource. + x-type-name: AWS::VpcLattice::ResourcePolicy + x-stackql-primary-identifier: - ResourceArn x-create-only-properties: - ResourceArn + x-required-properties: + - ResourceArn + - Policy + x-tagging: + taggable: false x-required-permissions: create: - vpc-lattice:GetResourcePolicy @@ -484,15 +1223,38 @@ components: - Match - Priority x-stackql-resource-name: rule - x-stackql-primaryIdentifier: + description: Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. + x-type-name: AWS::VpcLattice::Rule + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - ServiceIdentifier + - ListenerIdentifier + - Name x-create-only-properties: - ListenerIdentifier - ServiceIdentifier - Name + x-write-only-properties: + - ListenerIdentifier + - ServiceIdentifier x-read-only-properties: - Arn - Id + x-required-properties: + - Action + - Match + - Priority + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateRule @@ -507,8 +1269,10 @@ components: - vpc-lattice:GetRule - vpc-lattice:TagResource - vpc-lattice:UntagResource + - vpc-lattice:ListTagsForResource delete: - vpc-lattice:DeleteRule + - vpc-lattice:UntagResource list: - vpc-lattice:ListRules DnsEntry: @@ -574,8 +1338,13 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: service - x-stackql-primaryIdentifier: + description: A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). + x-type-name: AWS::VpcLattice::Service + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id + - - Name x-create-only-properties: - Name - CustomDomainName @@ -587,6 +1356,16 @@ components: - Id - LastUpdatedAt - Status + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateService @@ -608,8 +1387,17 @@ components: delete: - vpc-lattice:DeleteService - vpc-lattice:GetService + - vpc-lattice:UntagResource list: - vpc-lattice:ListServices + SharingConfig: + type: object + additionalProperties: false + properties: + enabled: + type: boolean + required: + - enabled ServiceNetwork: type: object properties: @@ -646,9 +1434,16 @@ components: maxItems: 50 items: $ref: '#/components/schemas/Tag' + SharingConfig: + $ref: '#/components/schemas/SharingConfig' x-stackql-resource-name: service_network - x-stackql-primaryIdentifier: + description: A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. + x-type-name: AWS::VpcLattice::ServiceNetwork + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id + - - Name x-create-only-properties: - Name x-read-only-properties: @@ -656,6 +1451,16 @@ components: - CreatedAt - Id - LastUpdatedAt + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:GetServiceNetwork @@ -671,11 +1476,87 @@ components: - vpc-lattice:UpdateServiceNetwork - vpc-lattice:TagResource - vpc-lattice:UntagResource + - vpc-lattice:ListTagsForResource delete: - vpc-lattice:DeleteServiceNetwork + - vpc-lattice:UntagResource list: - vpc-lattice:ListServiceNetworks - ServiceNetworkServiceAssociation: + ServiceNetworkResourceAssociation: + type: object + properties: + Id: + type: string + minLength: 22 + maxLength: 22 + pattern: ^snra-[0-9a-f]{17}$ + Arn: + type: string + minLength: 22 + maxLength: 2048 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}$ + ResourceConfigurationId: + type: string + minLength: 17 + maxLength: 2048 + pattern: ^rcfg-[0-9a-z]{17}$ + ServiceNetworkId: + type: string + minLength: 3 + maxLength: 2048 + pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}))$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: service_network_resource_association + description: VpcLattice ServiceNetworkResourceAssociation CFN resource + x-type-name: AWS::VpcLattice::ServiceNetworkResourceAssociation + x-stackql-primary-identifier: + - Arn + x-stackql-additional-identifiers: + - - Id + x-create-only-properties: + - ResourceConfigurationId + - ServiceNetworkId + x-read-only-properties: + - Id + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource + x-required-permissions: + create: + - vpc-lattice:CreateServiceNetworkResourceAssociation + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource + read: + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:ListTagsForResource + update: + - vpc-lattice:TagResource + - vpc-lattice:UntagResource + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:ListTagsForResource + delete: + - vpc-lattice:DeleteServiceNetworkResourceAssociation + - vpc-lattice:GetServiceNetworkResourceAssociation + - vpc-lattice:UntagResource + list: + - vpc-lattice:ListServiceNetworkResourceAssociations + ServiceNetworkServiceAssociation: type: object properties: Arn: @@ -749,11 +1630,20 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: service_network_service_association - x-stackql-primaryIdentifier: + description: Associates a service with a service network. + x-type-name: AWS::VpcLattice::ServiceNetworkServiceAssociation + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id + - - ServiceNetworkIdentifier + - ServiceIdentifier x-create-only-properties: - ServiceNetworkIdentifier - ServiceIdentifier + x-write-only-properties: + - ServiceNetworkIdentifier + - ServiceIdentifier x-read-only-properties: - Arn - CreatedAt @@ -767,6 +1657,16 @@ components: - ServiceId - ServiceName - Status + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateServiceNetworkServiceAssociation @@ -784,6 +1684,7 @@ components: delete: - vpc-lattice:DeleteServiceNetworkServiceAssociation - vpc-lattice:GetServiceNetworkServiceAssociation + - vpc-lattice:UntagResource list: - vpc-lattice:ListServiceNetworkServiceAssociations ServiceNetworkVpcAssociation: @@ -858,11 +1759,20 @@ components: items: $ref: '#/components/schemas/Tag' x-stackql-resource-name: service_network_vpc_association - x-stackql-primaryIdentifier: + description: Associates a VPC with a service network. + x-type-name: AWS::VpcLattice::ServiceNetworkVpcAssociation + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id + - - ServiceNetworkIdentifier + - VpcIdentifier x-create-only-properties: - ServiceNetworkIdentifier - VpcIdentifier + x-write-only-properties: + - ServiceNetworkIdentifier + - VpcIdentifier x-read-only-properties: - Arn - CreatedAt @@ -872,6 +1782,16 @@ components: - ServiceNetworkName - Status - VpcId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateServiceNetworkVpcAssociation @@ -894,6 +1814,7 @@ components: delete: - vpc-lattice:DeleteServiceNetworkVpcAssociation - vpc-lattice:GetServiceNetworkVpcAssociation + - vpc-lattice:UntagResource list: - vpc-lattice:ListServiceNetworkVpcAssociations HealthCheckConfig: @@ -912,7 +1833,6 @@ components: enum: - HTTP1 - HTTP2 - - GRPC Port: type: integer maximum: 65535 @@ -964,6 +1884,7 @@ components: enum: - HTTP - HTTPS + - TCP ProtocolVersion: type: string default: HTTP1 @@ -1060,8 +1981,13 @@ components: required: - Type x-stackql-resource-name: target_group - x-stackql-primaryIdentifier: + description: A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. + x-type-name: AWS::VpcLattice::TargetGroup + x-stackql-primary-identifier: - Arn + x-stackql-additional-identifiers: + - - Id + - - Name x-create-only-properties: - Name - Type @@ -1077,6 +2003,18 @@ components: - Id - LastUpdatedAt - Status + x-required-properties: + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - vpc-lattice:UntagResource + - vpc-lattice:TagResource + - vpc-lattice:ListTagsForResource x-required-permissions: create: - vpc-lattice:CreateTargetGroup @@ -1123,43 +2061,888 @@ components: - lambda:RemovePermission list: - vpc-lattice:ListTargetGroups + CreateAccessLogSubscriptionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:accesslogsubscription/als-[0-9a-z]{17}$ + DestinationArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$ + Id: + type: string + maxLength: 21 + minLength: 21 + pattern: ^als-[0-9a-z]{17}$ + ResourceArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$ + ResourceId: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^((sn)|(svc))-[0-9a-z]{17}$ + ResourceIdentifier: + type: string + maxLength: 2048 + minLength: 17 + pattern: ^((((sn)|(svc)|(rcfg))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(resourceconfiguration/rcfg)|(service/svc))-[0-9a-z]{17}))$ + ServiceNetworkLogType: + type: string + enum: + - SERVICE + - RESOURCE + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateAccessLogSubscriptionRequest + type: object + required: [] + CreateAuthPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceIdentifier: + type: string + pattern: ^((((sn)|(svc))-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}))$ + maxLength: 200 + minLength: 17 + Policy: + type: object + State: + type: string + enum: + - ACTIVE + - INACTIVE + x-stackQL-stringOnly: true + x-title: CreateAuthPolicyRequest + type: object + required: [] + CreateListenerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}$ + DefaultAction: + $ref: '#/components/schemas/DefaultAction' + Id: + type: string + maxLength: 26 + minLength: 26 + pattern: ^listener-[0-9a-z]{17}$ + Name: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!listener-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + Port: + type: integer + maximum: 65535 + minimum: 1 + Protocol: + type: string + enum: + - HTTP + - HTTPS + - TLS_PASSTHROUGH + ServiceArn: + type: string + maxLength: 2048 + minLength: 21 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}$ + ServiceId: + type: string + maxLength: 21 + minLength: 21 + pattern: ^svc-[0-9a-z]{17}$ + ServiceIdentifier: + type: string + maxLength: 2048 + minLength: 21 + pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}))$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateListenerRequest + type: object + required: [] + CreateResourceConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AllowAssociationToSharableServiceNetwork: + type: boolean + ProtocolType: + type: string + enum: + - TCP + ResourceConfigurationType: + type: string + enum: + - GROUP + - CHILD + - SINGLE + - ARN + PortRanges: + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/PortRange' + ResourceConfigurationDefinition: + oneOf: + - additionalProperties: false + type: object + title: IpResource + properties: + IpResource: + $ref: '#/components/schemas/IpResource' + required: + - IpResource + - additionalProperties: false + type: object + title: ArnResource + properties: + ArnResource: + $ref: '#/components/schemas/ArnResource' + required: + - ArnResource + - additionalProperties: false + type: object + title: DnsResource + properties: + DnsResource: + $ref: '#/components/schemas/DnsResource' + required: + - DnsResource + type: object + Id: + $ref: '#/components/schemas/Id' + ResourceGatewayId: + type: string + Arn: + minLength: 20 + pattern: ^arn:[a-z0-9f\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$ + type: string + maxLength: 2048 + ResourceConfigurationAuthType: + type: string + enum: + - NONE + - AWS_IAM + ResourceConfigurationGroupId: + $ref: '#/components/schemas/Id' + Tags: + minItems: 0 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + Name: + minLength: 3 + pattern: ^(?!rcfg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + type: string + maxLength: 40 + x-stackQL-stringOnly: true + x-title: CreateResourceConfigurationRequest + type: object + required: [] + CreateResourceGatewayRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IpAddressType: + type: string + enum: + - IPV4 + - IPV6 + - DUALSTACK + VpcIdentifier: + minLength: 5 + type: string + maxLength: 50 + Ipv4AddressesPerEni: + description: The number of IPv4 addresses to allocate per ENI for the resource gateway + type: integer + Id: + minLength: 17 + pattern: ^((rgw-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}))$ + type: string + maxLength: 2048 + Arn: + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}$ + type: string + maxLength: 2048 + SubnetIds: + uniqueItems: true + description: The ID of one or more subnets in which to create an endpoint network interface. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId + type: string + SecurityGroupIds: + uniqueItems: true + description: The ID of one or more security groups to associate with the endpoint network interface. + x-insertionOrder: false + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/DefaultSecurityGroup + type: string + Tags: + minItems: 0 + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + Name: + minLength: 3 + pattern: ^(?!rgw-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + type: string + maxLength: 40 + x-stackQL-stringOnly: true + x-title: CreateResourceGatewayRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + type: string + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:((servicenetwork/sn)|(service/svc))-[0-9a-z]{17}$ + minLength: 20 + maxLength: 200 + Policy: + type: object + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Action: + $ref: '#/components/schemas/Action' + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}/rule/((rule-[0-9a-z]{17})|(default))$ + Id: + type: string + maxLength: 22 + minLength: 7 + pattern: ^((rule-[0-9a-z]{17})|(default))$ + ListenerIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^((listener-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}/listener/listener-[0-9a-z]{17}))$ + Match: + $ref: '#/components/schemas/Match' + Name: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!rule-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + Priority: + type: integer + maximum: 100 + minimum: 1 + ServiceIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^((svc-[0-9a-z]{17})|(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:service/svc-[0-9a-z]{17}))$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRuleRequest + type: object + required: [] + CreateServiceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}$ + AuthType: + type: string + default: NONE + enum: + - NONE + - AWS_IAM + CreatedAt: + type: string + DnsEntry: + $ref: '#/components/schemas/DnsEntry' + Id: + type: string + maxLength: 21 + minLength: 21 + pattern: ^svc-[0-9a-z]{17}$ + LastUpdatedAt: + type: string + Name: + type: string + maxLength: 40 + minLength: 3 + pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + Status: + type: string + enum: + - ACTIVE + - CREATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - CREATE_FAILED + - DELETE_FAILED + CertificateArn: + type: string + maxLength: 2048 + pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?$ + CustomDomainName: + type: string + maxLength: 255 + minLength: 3 + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateServiceRequest + type: object + required: [] + CreateServiceNetworkRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}$ + CreatedAt: + type: string + Id: + type: string + maxLength: 20 + minLength: 20 + pattern: ^sn-[0-9a-z]{17}$ + LastUpdatedAt: + type: string + Name: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + AuthType: + type: string + default: NONE + enum: + - NONE + - AWS_IAM + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + SharingConfig: + $ref: '#/components/schemas/SharingConfig' + x-stackQL-stringOnly: true + x-title: CreateServiceNetworkRequest + type: object + required: [] + CreateServiceNetworkResourceAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + type: string + minLength: 22 + maxLength: 22 + pattern: ^snra-[0-9a-f]{17}$ + Arn: + type: string + minLength: 22 + maxLength: 2048 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}$ + ResourceConfigurationId: + type: string + minLength: 17 + maxLength: 2048 + pattern: ^rcfg-[0-9a-z]{17}$ + ServiceNetworkId: + type: string + minLength: 3 + maxLength: 2048 + pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}))$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateServiceNetworkResourceAssociationRequest + type: object + required: [] + CreateServiceNetworkServiceAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkserviceassociation/snsa-[0-9a-z]{17}$ + CreatedAt: + type: string + DnsEntry: + $ref: '#/components/schemas/DnsEntry' + Id: + type: string + maxLength: 2048 + minLength: 17 + pattern: ^snsa-[0-9a-z]{17}$ + ServiceNetworkArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}$ + ServiceNetworkId: + type: string + maxLength: 20 + minLength: 20 + pattern: ^sn-[0-9a-z]{17}$ + ServiceNetworkIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}))$ + ServiceNetworkName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + ServiceArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}$ + ServiceId: + type: string + maxLength: 21 + minLength: 21 + pattern: ^svc-[0-9a-z]{17}$ + ServiceIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}))$ + ServiceName: + type: string + maxLength: 40 + minLength: 3 + pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + Status: + type: string + enum: + - CREATE_IN_PROGRESS + - ACTIVE + - DELETE_IN_PROGRESS + - CREATE_FAILED + - DELETE_FAILED + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateServiceNetworkServiceAssociationRequest + type: object + required: [] + CreateServiceNetworkVpcAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkvpcassociation/snva-[0-9a-z]{17}$ + CreatedAt: + type: string + SecurityGroupIds: + type: array + x-insertionOrder: false + uniqueItems: true + items: + type: string + maxLength: 200 + minLength: 0 + pattern: ^sg-(([0-9a-z]{8})|([0-9a-z]{17}))$ + Id: + type: string + maxLength: 22 + minLength: 22 + pattern: ^snva-[0-9a-z]{17}$ + ServiceNetworkArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}$ + ServiceNetworkId: + type: string + maxLength: 20 + minLength: 20 + pattern: ^sn-[0-9a-z]{17}$ + ServiceNetworkIdentifier: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}))$ + ServiceNetworkName: + type: string + maxLength: 63 + minLength: 3 + pattern: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + Status: + type: string + enum: + - CREATE_IN_PROGRESS + - ACTIVE + - UPDATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - CREATE_FAILED + - DELETE_FAILED + VpcId: + type: string + maxLength: 2048 + minLength: 5 + pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$ + VpcIdentifier: + type: string + maxLength: 2048 + minLength: 5 + pattern: ^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$ + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateServiceNetworkVpcAssociationRequest + type: object + required: [] + CreateTargetGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-[0-9a-z]{17}$ + Config: + $ref: '#/components/schemas/TargetGroupConfig' + CreatedAt: + type: string + Id: + type: string + maxLength: 20 + minLength: 20 + pattern: ^tg-[0-9a-z]{17}$ + LastUpdatedAt: + type: string + Name: + type: string + maxLength: 128 + minLength: 3 + pattern: ^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$ + Status: + type: string + enum: + - CREATE_IN_PROGRESS + - ACTIVE + - DELETE_IN_PROGRESS + - CREATE_FAILED + - DELETE_FAILED + Type: + type: string + enum: + - IP + - LAMBDA + - INSTANCE + - ALB + Targets: + type: array + x-insertionOrder: false + minItems: 0 + maxItems: 100 + default: [] + items: + $ref: '#/components/schemas/Target' + Tags: + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 0 + maxItems: 50 + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateTargetGroupRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: access_log_subscriptions: name: access_log_subscriptions id: awscc.vpclattice.access_log_subscriptions x-cfn-schema-name: AccessLogSubscription - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' - AND region = 'us-east-1' - access_log_subscription: - name: access_log_subscription - id: awscc.vpclattice.access_log_subscription - x-cfn-schema-name: AccessLogSubscription - x-type: get + x-cfn-type-name: AWS::VpcLattice::AccessLogSubscription x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AccessLogSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::AccessLogSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::AccessLogSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::AccessLogSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1170,12 +2953,13 @@ components: JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, JSON_EXTRACT(Properties, '$.ResourceIdentifier') as resource_identifier, + JSON_EXTRACT(Properties, '$.ServiceNetworkLogType') as service_network_log_type, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1186,21 +2970,101 @@ components: json_extract_path_text(Properties, 'ResourceArn') as resource_arn, json_extract_path_text(Properties, 'ResourceId') as resource_id, json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, + json_extract_path_text(Properties, 'ServiceNetworkLogType') as service_network_log_type, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' AND data__Identifier = '' AND region = 'us-east-1' - auth_policy: - name: auth_policy - id: awscc.vpclattice.auth_policy + access_log_subscriptions_list_only: + name: access_log_subscriptions_list_only + id: awscc.vpclattice.access_log_subscriptions_list_only + x-cfn-schema-name: AccessLogSubscription + x-cfn-type-name: AWS::VpcLattice::AccessLogSubscription + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' + AND region = 'us-east-1' + auth_policies: + name: auth_policies + id: awscc.vpclattice.auth_policies x-cfn-schema-name: AuthPolicy - x-type: get + x-cfn-type-name: AWS::VpcLattice::AuthPolicy x-identifiers: - ResourceIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AuthPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::AuthPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::AuthPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::AuthPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/auth_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/auth_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/auth_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1212,7 +3076,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1227,38 +3091,61 @@ components: name: listeners id: awscc.vpclattice.listeners x-cfn-schema-name: Listener - x-type: list - x-identifiers: - - Arn - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' - AND region = 'us-east-1' - listener: - name: listener - id: awscc.vpclattice.listener - x-cfn-schema-name: Listener - x-type: get + x-cfn-type-name: AWS::VpcLattice::Listener x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Listener&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Listener" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/listeners/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1277,7 +3164,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1295,13 +3182,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Listener' AND data__Identifier = '' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.vpclattice.resource_policy - x-cfn-schema-name: ResourcePolicy - x-type: get + listeners_list_only: + name: listeners_list_only + id: awscc.vpclattice.listeners_list_only + x-cfn-schema-name: Listener + x-cfn-type-name: AWS::VpcLattice::Listener x-identifiers: - - ResourceArn + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1309,30 +3202,129 @@ components: ddl: |- SELECT region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, - JSON_EXTRACT(Properties, '$.Policy') as policy - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourcePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'Policy') as policy - FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourcePolicy' - AND data__Identifier = '' + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' AND region = 'us-east-1' - rules: - name: rules - id: awscc.vpclattice.rules - x-cfn-schema-name: Rule - x-type: list + resource_configurations: + name: resource_configurations + id: awscc.vpclattice.resource_configurations + x-cfn-schema-name: ResourceConfiguration + x-cfn-type-name: AWS::VpcLattice::ResourceConfiguration x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourceConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourceConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourceConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_configurations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AllowAssociationToSharableServiceNetwork') as allow_association_to_sharable_service_network, + JSON_EXTRACT(Properties, '$.ProtocolType') as protocol_type, + JSON_EXTRACT(Properties, '$.ResourceConfigurationType') as resource_configuration_type, + JSON_EXTRACT(Properties, '$.PortRanges') as port_ranges, + JSON_EXTRACT(Properties, '$.ResourceConfigurationDefinition') as resource_configuration_definition, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.ResourceGatewayId') as resource_gateway_id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ResourceConfigurationAuthType') as resource_configuration_auth_type, + JSON_EXTRACT(Properties, '$.ResourceConfigurationGroupId') as resource_configuration_group_id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourceConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllowAssociationToSharableServiceNetwork') as allow_association_to_sharable_service_network, + json_extract_path_text(Properties, 'ProtocolType') as protocol_type, + json_extract_path_text(Properties, 'ResourceConfigurationType') as resource_configuration_type, + json_extract_path_text(Properties, 'PortRanges') as port_ranges, + json_extract_path_text(Properties, 'ResourceConfigurationDefinition') as resource_configuration_definition, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ResourceGatewayId') as resource_gateway_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ResourceConfigurationAuthType') as resource_configuration_auth_type, + json_extract_path_text(Properties, 'ResourceConfigurationGroupId') as resource_configuration_group_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourceConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + resource_configurations_list_only: + name: resource_configurations_list_only + id: awscc.vpclattice.resource_configurations_list_only + x-cfn-schema-name: ResourceConfiguration + x-cfn-type-name: AWS::VpcLattice::ResourceConfiguration + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1341,7 +3333,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ResourceConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1349,19 +3341,270 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ResourceConfiguration' AND region = 'us-east-1' - rule: - name: rule - id: awscc.vpclattice.rule - x-cfn-schema-name: Rule - x-type: get + resource_gateways: + name: resource_gateways + id: awscc.vpclattice.resource_gateways + x-cfn-schema-name: ResourceGateway + x-cfn-type-name: AWS::VpcLattice::ResourceGateway + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourceGateway&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourceGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourceGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourceGateway" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_gateways/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_gateways/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.IpAddressType') as ip_address_type, + JSON_EXTRACT(Properties, '$.VpcIdentifier') as vpc_identifier, + JSON_EXTRACT(Properties, '$.Ipv4AddressesPerEni') as ipv4_addresses_per_eni, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourceGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'VpcIdentifier') as vpc_identifier, + json_extract_path_text(Properties, 'Ipv4AddressesPerEni') as ipv4_addresses_per_eni, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourceGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + resource_gateways_list_only: + name: resource_gateways_list_only + id: awscc.vpclattice.resource_gateways_list_only + x-cfn-schema-name: ResourceGateway + x-cfn-type-name: AWS::VpcLattice::ResourceGateway x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ResourceGateway' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ResourceGateway' + AND region = 'us-east-1' + resource_policies: + name: resource_policies + id: awscc.vpclattice.resource_policies + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::VpcLattice::ResourcePolicy + x-identifiers: + - ResourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.Policy') as policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'Policy') as policy + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + rules: + name: rules + id: awscc.vpclattice.rules + x-cfn-schema-name: Rule + x-cfn-type-name: AWS::VpcLattice::Rule + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Rule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1379,7 +3622,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1396,13 +3639,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Rule' AND data__Identifier = '' AND region = 'us-east-1' - services: - name: services - id: awscc.vpclattice.services - x-cfn-schema-name: Service - x-type: list + rules_list_only: + name: rules_list_only + id: awscc.vpclattice.rules_list_only + x-cfn-schema-name: Rule + x-cfn-type-name: AWS::VpcLattice::Rule x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1411,7 +3660,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1419,19 +3668,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' AND region = 'us-east-1' - service: - name: service - id: awscc.vpclattice.service + services: + name: services + id: awscc.vpclattice.services x-cfn-schema-name: Service - x-type: get + x-cfn-type-name: AWS::VpcLattice::Service x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::Service" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1451,7 +3748,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1470,13 +3767,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Service' AND data__Identifier = '' AND region = 'us-east-1' - service_networks: - name: service_networks - id: awscc.vpclattice.service_networks - x-cfn-schema-name: ServiceNetwork - x-type: list + services_list_only: + name: services_list_only + id: awscc.vpclattice.services_list_only + x-cfn-schema-name: Service + x-cfn-type-name: AWS::VpcLattice::Service x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1485,7 +3788,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1493,19 +3796,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' AND region = 'us-east-1' - service_network: - name: service_network - id: awscc.vpclattice.service_network + service_networks: + name: service_networks + id: awscc.vpclattice.service_networks x-cfn-schema-name: ServiceNetwork - x-type: get + x-cfn-type-name: AWS::VpcLattice::ServiceNetwork x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceNetwork&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetwork" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_networks/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_networks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1516,12 +3867,13 @@ components: JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.AuthType') as auth_type, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.SharingConfig') as sharing_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1532,17 +3884,24 @@ components: json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'AuthType') as auth_type, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SharingConfig') as sharing_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' AND data__Identifier = '' AND region = 'us-east-1' - service_network_service_associations: - name: service_network_service_associations - id: awscc.vpclattice.service_network_service_associations - x-cfn-schema-name: ServiceNetworkServiceAssociation - x-type: list + service_networks_list_only: + name: service_networks_list_only + id: awscc.vpclattice.service_networks_list_only + x-cfn-schema-name: ServiceNetwork + x-cfn-type-name: AWS::VpcLattice::ServiceNetwork x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1551,7 +3910,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1559,19 +3918,183 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' AND region = 'us-east-1' - service_network_service_association: - name: service_network_service_association - id: awscc.vpclattice.service_network_service_association - x-cfn-schema-name: ServiceNetworkServiceAssociation - x-type: get + service_network_resource_associations: + name: service_network_resource_associations + id: awscc.vpclattice.service_network_resource_associations + x-cfn-schema-name: ServiceNetworkResourceAssociation + x-cfn-type-name: AWS::VpcLattice::ServiceNetworkResourceAssociation + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceNetworkResourceAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_network_resource_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_network_resource_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_network_resource_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ResourceConfigurationId') as resource_configuration_id, + JSON_EXTRACT(Properties, '$.ServiceNetworkId') as service_network_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkResourceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ResourceConfigurationId') as resource_configuration_id, + json_extract_path_text(Properties, 'ServiceNetworkId') as service_network_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkResourceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + service_network_resource_associations_list_only: + name: service_network_resource_associations_list_only + id: awscc.vpclattice.service_network_resource_associations_list_only + x-cfn-schema-name: ServiceNetworkResourceAssociation + x-cfn-type-name: AWS::VpcLattice::ServiceNetworkResourceAssociation x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkResourceAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkResourceAssociation' + AND region = 'us-east-1' + service_network_service_associations: + name: service_network_service_associations + id: awscc.vpclattice.service_network_service_associations + x-cfn-schema-name: ServiceNetworkServiceAssociation + x-cfn-type-name: AWS::VpcLattice::ServiceNetworkServiceAssociation + x-identifiers: + - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceNetworkServiceAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkServiceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkServiceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkServiceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1594,7 +4117,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1616,13 +4139,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' AND data__Identifier = '' AND region = 'us-east-1' - service_network_vpc_associations: - name: service_network_vpc_associations - id: awscc.vpclattice.service_network_vpc_associations - x-cfn-schema-name: ServiceNetworkVpcAssociation - x-type: list + service_network_service_associations_list_only: + name: service_network_service_associations_list_only + id: awscc.vpclattice.service_network_service_associations_list_only + x-cfn-schema-name: ServiceNetworkServiceAssociation + x-cfn-type-name: AWS::VpcLattice::ServiceNetworkServiceAssociation x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1631,7 +4160,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1639,19 +4168,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' AND region = 'us-east-1' - service_network_vpc_association: - name: service_network_vpc_association - id: awscc.vpclattice.service_network_vpc_association + service_network_vpc_associations: + name: service_network_vpc_associations + id: awscc.vpclattice.service_network_vpc_associations x-cfn-schema-name: ServiceNetworkVpcAssociation - x-type: get + x-cfn-type-name: AWS::VpcLattice::ServiceNetworkVpcAssociation x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServiceNetworkVpcAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkVpcAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkVpcAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::ServiceNetworkVpcAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1672,7 +4249,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1692,13 +4269,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' AND data__Identifier = '' AND region = 'us-east-1' - target_groups: - name: target_groups - id: awscc.vpclattice.target_groups - x-cfn-schema-name: TargetGroup - x-type: list + service_network_vpc_associations_list_only: + name: service_network_vpc_associations_list_only + id: awscc.vpclattice.service_network_vpc_associations_list_only + x-cfn-schema-name: ServiceNetworkVpcAssociation + x-cfn-type-name: AWS::VpcLattice::ServiceNetworkVpcAssociation x-identifiers: - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1707,7 +4290,7 @@ components: SELECT region, JSON_EXTRACT(Properties, '$.Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -1715,19 +4298,67 @@ components: SELECT region, json_extract_path_text(Properties, 'Arn') as arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' AND region = 'us-east-1' - target_group: - name: target_group - id: awscc.vpclattice.target_group + target_groups: + name: target_groups + id: awscc.vpclattice.target_groups x-cfn-schema-name: TargetGroup - x-type: get + x-cfn-type-name: AWS::VpcLattice::TargetGroup x-identifiers: - Arn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TargetGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::TargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::TargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::VpcLattice::TargetGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1746,7 +4377,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1764,3 +4395,733 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' AND data__Identifier = '' AND region = 'us-east-1' + target_groups_list_only: + name: target_groups_list_only + id: awscc.vpclattice.target_groups_list_only + x-cfn-schema-name: TargetGroup + x-cfn-type-name: AWS::VpcLattice::TargetGroup + x-identifiers: + - Arn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AccessLogSubscription&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAccessLogSubscription + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAccessLogSubscriptionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AuthPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAuthPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAuthPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Listener&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateListener + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateListenerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourceGateway&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourceGateway + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourceGatewayRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Rule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Service&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateService + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceNetwork&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceNetwork + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceNetworkRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceNetworkResourceAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceNetworkResourceAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceNetworkResourceAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceNetworkServiceAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceNetworkServiceAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceNetworkServiceAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceNetworkVpcAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceNetworkVpcAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceNetworkVpcAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TargetGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTargetGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTargetGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/wafv2.yaml b/providers/src/awscc/v00.00.00000/services/wafv2.yaml index 8c11f63e..dc1ba919 100644 --- a/providers/src/awscc/v00.00.00000/services/wafv2.yaml +++ b/providers/src/awscc/v00.00.00000/services/wafv2.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: WAFv2 - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: EntityName: description: Name of the WebACL. @@ -80,7 +460,9 @@ components: - IPAddressVersion - Scope x-stackql-resource-name: ip_set - x-stackql-primaryIdentifier: + description: Contains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually + x-type-name: AWS::WAFv2::IPSet + x-stackql-primary-identifier: - Name - Id - Scope @@ -90,11 +472,27 @@ components: x-read-only-properties: - Arn - Id + x-required-properties: + - Addresses + - IPAddressVersion + - Scope + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagUpdatable: true + taggable: true + tagProperty: /properties/Tags + permissions: + - wafv2:TagResource + - wafv2:UntagResource + - wafv2:ListTagsForResource x-required-permissions: create: - wafv2:CreateIPSet - wafv2:GetIPSet - wafv2:ListTagsForResource + - wafv2:TagResource + - wafv2:UntagResource delete: - wafv2:DeleteIPSet - wafv2:GetIPSet @@ -105,6 +503,8 @@ components: - wafv2:UpdateIPSet - wafv2:GetIPSet - wafv2:ListTagsForResource + - wafv2:TagResource + - wafv2:UntagResource list: - wafv2:listIPSets Filter: @@ -205,6 +605,12 @@ components: $ref: '#/components/schemas/Headers' Cookies: $ref: '#/components/schemas/Cookies' + JA3Fingerprint: + $ref: '#/components/schemas/JA3Fingerprint' + JA4Fingerprint: + $ref: '#/components/schemas/JA4Fingerprint' + UriFragment: + $ref: '#/components/schemas/UriFragment' additionalProperties: false LoggingConfiguration: type: object @@ -250,12 +656,22 @@ components: - ResourceArn - LogDestinationConfigs x-stackql-resource-name: logging_configuration - x-stackql-primaryIdentifier: + description: A WAFv2 Logging Configuration Resource Provider + x-type-name: AWS::WAFv2::LoggingConfiguration + x-stackql-primary-identifier: - ResourceArn x-create-only-properties: - ResourceArn x-read-only-properties: - ManagedByFirewallManager + x-required-properties: + - ResourceArn + - LogDestinationConfigs + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - wafv2:PutLoggingConfiguration @@ -326,7 +742,9 @@ components: - Scope - RegularExpressionList x-stackql-resource-name: regex_pattern_set - x-stackql-primaryIdentifier: + description: Contains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions . + x-type-name: AWS::WAFv2::RegexPatternSet + x-stackql-primary-identifier: - Name - Id - Scope @@ -336,10 +754,25 @@ components: x-read-only-properties: - Arn - Id + x-required-properties: + - Scope + - RegularExpressionList + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagUpdatable: true + taggable: true + tagProperty: /properties/Tags + permissions: + - wafv2:TagResource + - wafv2:UntagResource + - wafv2:ListTagsForResource x-required-permissions: create: - wafv2:CreateRegexPatternSet - wafv2:GetRegexPatternSet + - wafv2:TagResource + - wafv2:UntagResource - wafv2:ListTagsForResource delete: - wafv2:DeleteRegexPatternSet @@ -351,6 +784,8 @@ components: - wafv2:UpdateRegexPatternSet - wafv2:GetRegexPatternSet - wafv2:ListTagsForResource + - wafv2:TagResource + - wafv2:UntagResource list: - wafv2:listRegexPatternSets AndStatement: @@ -484,6 +919,8 @@ components: properties: Limit: $ref: '#/components/schemas/RateLimit' + EvaluationWindowSec: + $ref: '#/components/schemas/EvaluationWindowSec' AggregateKeyType: type: string enum: @@ -527,6 +964,12 @@ components: $ref: '#/components/schemas/RateLimitQueryString' UriPath: $ref: '#/components/schemas/RateLimitUriPath' + JA3Fingerprint: + $ref: '#/components/schemas/RateLimitJA3Fingerprint' + JA4Fingerprint: + $ref: '#/components/schemas/RateLimitJA4Fingerprint' + ASN: + $ref: '#/components/schemas/RateLimitAsn' additionalProperties: false RateLimitCookie: description: Specifies a cookie as an aggregate key for a rate-based rule. @@ -624,10 +1067,44 @@ components: required: - TextTransformations additionalProperties: false + RateLimitJA3Fingerprint: + description: Specifies the request's JA3 fingerprint as an aggregate key for a rate-based rule. + type: object + properties: + FallbackBehavior: + type: string + enum: + - MATCH + - NO_MATCH + required: + - FallbackBehavior + additionalProperties: false + RateLimitJA4Fingerprint: + description: Specifies the request's JA4 fingerprint as an aggregate key for a rate-based rule. + type: object + properties: + FallbackBehavior: + type: string + enum: + - MATCH + - NO_MATCH + required: + - FallbackBehavior + additionalProperties: false + RateLimitAsn: + description: Specifies the request's ASN as an aggregate key for a rate-based rule. + type: object RateLimit: type: integer - minimum: 100 + minimum: 10 maximum: 2000000000 + EvaluationWindowSec: + type: integer + enum: + - 60 + - 120 + - 300 + - 600 RegexPatternSetReferenceStatement: type: object properties: @@ -900,7 +1377,11 @@ components: - Scope - VisibilityConfig x-stackql-resource-name: rule_group - x-stackql-primaryIdentifier: + description: >- + Contains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request + needs to match only one of the specifications to be allowed, blocked, or counted. + x-type-name: AWS::WAFv2::RuleGroup + x-stackql-primary-identifier: - Name - Id - Scope @@ -913,10 +1394,26 @@ components: - LabelNamespace - AvailableLabels/*/Name - ConsumedLabels/*/Name + x-required-properties: + - Capacity + - Scope + - VisibilityConfig + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagUpdatable: true + taggable: true + tagProperty: /properties/Tags + permissions: + - wafv2:TagResource + - wafv2:UntagResource + - wafv2:ListTagsForResource x-required-permissions: create: - wafv2:CreateRuleGroup - wafv2:GetRuleGroup + - wafv2:TagResource + - wafv2:UntagResource - wafv2:ListTagsForResource delete: - wafv2:DeleteRuleGroup @@ -925,6 +1422,8 @@ components: - wafv2:GetRuleGroup - wafv2:ListTagsForResource update: + - wafv2:TagResource + - wafv2:UntagResource - wafv2:UpdateRuleGroup - wafv2:GetRuleGroup - wafv2:ListTagsForResource @@ -1019,6 +1518,8 @@ components: $ref: '#/components/schemas/LabelMatchStatement' RegexMatchStatement: $ref: '#/components/schemas/RegexMatchStatement' + AsnMatchStatement: + $ref: '#/components/schemas/AsnMatchStatement' additionalProperties: false TextTransformation: description: Text Transformation on the Search String before match. @@ -1147,6 +1648,18 @@ components: - FieldToMatch - TextTransformations additionalProperties: false + AsnMatchStatement: + type: object + properties: + AsnList: + type: array + items: + type: integer + minimum: 0 + maximum: 4294967295 + ForwardedIPConfig: + $ref: '#/components/schemas/ForwardedIPConfiguration' + additionalProperties: false CaptchaConfig: type: object properties: @@ -1192,7 +1705,7 @@ components: - OversizeHandling additionalProperties: false Cookies: - description: Includes headers of a web request. + description: Includes cookies of a web request. type: object properties: MatchPattern: @@ -1278,6 +1791,40 @@ components: enum: - LOW - HIGH + JA3Fingerprint: + description: Includes the JA3 fingerprint of a web request. + type: object + properties: + FallbackBehavior: + type: string + enum: + - MATCH + - NO_MATCH + required: + - FallbackBehavior + additionalProperties: false + JA4Fingerprint: + description: Includes the JA4 fingerprint of a web request. + type: object + properties: + FallbackBehavior: + type: string + enum: + - MATCH + - NO_MATCH + required: + - FallbackBehavior + additionalProperties: false + UriFragment: + description: The path component of the URI Fragment. This is the part of a web request that identifies a fragment uri, for example, /abcd#introduction + type: object + properties: + FallbackBehavior: + type: string + enum: + - MATCH + - NO_MATCH + additionalProperties: false DefaultAction: description: Default Action WebACL will take against ingress traffic when there is no matching Rule. type: object @@ -1395,6 +1942,65 @@ components: additionalProperties: false UriPath: type: object + DataProtectionConfig: + type: object + properties: + DataProtections: + $ref: '#/components/schemas/DataProtections' + required: + - DataProtections + additionalProperties: false + DataProtections: + type: array + items: + $ref: '#/components/schemas/DataProtect' + minItems: 1 + DataProtect: + type: object + properties: + Field: + $ref: '#/components/schemas/FieldToProtect' + Action: + $ref: '#/components/schemas/DataProtectionAction' + ExcludeRuleMatchDetails: + type: boolean + ExcludeRateBasedDetails: + type: boolean + required: + - Field + - Action + additionalProperties: false + DataProtectionAction: + type: string + enum: + - SUBSTITUTION + - HASH + FieldToProtect: + description: Field in log to protect. + type: object + properties: + FieldType: + description: Field type to protect + type: string + enum: + - SINGLE_HEADER + - SINGLE_COOKIE + - SINGLE_QUERY_ARGUMENT + - QUERY_STRING + - BODY + FieldKeys: + description: List of field keys to protect + type: array + items: + $ref: '#/components/schemas/FieldToProtectKeyName' + required: + - FieldType + additionalProperties: false + FieldToProtectKeyName: + description: Key of the field to protect. + type: string + minLength: 1 + maxLength: 64 ManagedRuleGroupConfig: description: ManagedRuleGroupConfig. type: object @@ -1419,6 +2025,8 @@ components: $ref: '#/components/schemas/AWSManagedRulesATPRuleSet' AWSManagedRulesACFPRuleSet: $ref: '#/components/schemas/AWSManagedRulesACFPRuleSet' + AWSManagedRulesAntiDDoSRuleSet: + $ref: '#/components/schemas/AWSManagedRulesAntiDDoSRuleSet' additionalProperties: false AWSManagedRulesBotControlRuleSet: description: Configures how to use the Bot Control managed rule group in the web ACL @@ -1468,6 +2076,64 @@ components: - RegistrationPagePath - RequestInspection additionalProperties: false + AWSManagedRulesAntiDDoSRuleSet: + description: Configures how to use the AntiDDOS AWS managed rule group in the web ACL + type: object + properties: + ClientSideActionConfig: + $ref: '#/components/schemas/ClientSideActionConfig' + SensitivityToBlock: + $ref: '#/components/schemas/SensitivityToAct' + required: + - ClientSideActionConfig + additionalProperties: false + ClientSideActionConfig: + description: Client side action config for AntiDDOS AMR. + type: object + properties: + Challenge: + $ref: '#/components/schemas/ClientSideAction' + required: + - Challenge + additionalProperties: false + ClientSideAction: + description: Client side action config for AntiDDOS AMR. + type: object + properties: + UsageOfAction: + $ref: '#/components/schemas/UsageOfAction' + Sensitivity: + $ref: '#/components/schemas/SensitivityToAct' + ExemptUriRegularExpressions: + $ref: '#/components/schemas/RegularExpressionList' + required: + - UsageOfAction + additionalProperties: false + UsageOfAction: + type: string + enum: + - ENABLED + - DISABLED + SensitivityToAct: + type: string + enum: + - LOW + - MEDIUM + - HIGH + RegularExpressionList: + type: array + items: + $ref: '#/components/schemas/Regex' + Regex: + description: Regex + type: object + properties: + RegexString: + $ref: '#/components/schemas/RegexPatternString' + RegexPatternString: + type: string + maxLength: 512 + minLength: 1 RequestInspection: description: Configures the inspection of login requests type: object @@ -1658,7 +2324,7 @@ components: type: object description: Map of AssociatedResourceType and RequestBodyAssociatedResourceTypeConfig x-patternProperties: - ^(CLOUDFRONT)$: + ^(CLOUDFRONT|API_GATEWAY|COGNITO_USER_POOL|APP_RUNNER_SERVICE|VERIFIED_ACCESS_INSTANCE)$: $ref: '#/components/schemas/RequestBodyAssociatedResourceTypeConfig' additionalProperties: false RequestBodyAssociatedResourceTypeConfig: @@ -1692,6 +2358,18 @@ components: required: - Identifier additionalProperties: false + OnSourceDDoSProtectionConfig: + description: Configures the options for on-source DDoS protection provided by supported resource type. + type: object + properties: + ALBLowReputationMode: + type: string + enum: + - ACTIVE_UNDER_DDOS + - ALWAYS_ON + required: + - ALBLowReputationMode + additionalProperties: false WebACL: type: object properties: @@ -1717,6 +2395,9 @@ components: $ref: '#/components/schemas/Rule' VisibilityConfig: $ref: '#/components/schemas/VisibilityConfig' + DataProtectionConfig: + description: Collection of dataProtects. + $ref: '#/components/schemas/DataProtectionConfig' Tags: type: array items: @@ -1734,12 +2415,18 @@ components: $ref: '#/components/schemas/TokenDomains' AssociationConfig: $ref: '#/components/schemas/AssociationConfig' + OnSourceDDoSProtectionConfig: + $ref: '#/components/schemas/OnSourceDDoSProtectionConfig' required: - DefaultAction - Scope - VisibilityConfig x-stackql-resource-name: web_acl - x-stackql-primaryIdentifier: + description: >- + Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to + match only one of the specifications to be allowed, blocked, or counted. + x-type-name: AWS::WAFv2::WebACL + x-stackql-primary-identifier: - Name - Id - Scope @@ -1751,11 +2438,27 @@ components: - Capacity - Id - LabelNamespace + x-required-properties: + - DefaultAction + - Scope + - VisibilityConfig + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagUpdatable: true + taggable: true + tagProperty: /properties/Tags + permissions: + - wafv2:TagResource + - wafv2:UntagResource + - wafv2:ListTagsForResource x-required-permissions: create: - wafv2:CreateWebACL - wafv2:GetWebACL - wafv2:ListTagsForResource + - wafv2:TagResource + - wafv2:UntagResource delete: - wafv2:DeleteWebACL - wafv2:GetWebACL @@ -1766,6 +2469,8 @@ components: - wafv2:UpdateWebACL - wafv2:GetWebACL - wafv2:ListTagsForResource + - wafv2:TagResource + - wafv2:UntagResource list: - wafv2:listWebACLs WebACLAssociation: @@ -1779,18 +2484,30 @@ components: - ResourceArn - WebACLArn x-stackql-resource-name: webacl_association - x-stackql-primaryIdentifier: + description: Associates WebACL to Application Load Balancer, CloudFront or API Gateway. + x-type-name: AWS::WAFv2::WebACLAssociation + x-stackql-primary-identifier: - ResourceArn - WebACLArn x-create-only-properties: - ResourceArn - WebACLArn + x-required-properties: + - ResourceArn + - WebACLArn + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: false + tagUpdatable: false + taggable: false x-required-permissions: create: - wafv2:AssociateWebACL - wafv2:GetWebACLForResource - wafv2:GetWebACL - wafv2:DisassociateWebACL + - wafv2:PutPermissionPolicy + - wafv2:GetPermissionPolicy - elasticloadbalancing:SetWebACL - apigateway:SetWebACL - appsync:SetWebACL @@ -1804,11 +2521,14 @@ components: - ec2:DisassociateVerifiedAccessInstanceWebAcl - ec2:DescribeVerifiedAccessInstanceWebAclAssociations - ec2:GetVerifiedAccessInstanceWebAcl + - amplify:AssociateWebACL + - amplify:GetWebACLForResource delete: - wafv2:AssociateWebACL - wafv2:GetWebACLForResource - wafv2:GetWebACL - wafv2:DisassociateWebACL + - wafv2:PutPermissionPolicy - elasticloadbalancing:SetWebACL - apigateway:SetWebACL - appsync:SetWebACL @@ -1822,6 +2542,8 @@ components: - ec2:DisassociateVerifiedAccessInstanceWebAcl - ec2:DescribeVerifiedAccessInstanceWebAclAssociations - ec2:GetVerifiedAccessInstanceWebAcl + - amplify:DisassociateWebACL + - amplify:GetWebACLForResource read: - wafv2:AssociateWebACL - wafv2:GetWebACLForResource @@ -1840,6 +2562,7 @@ components: - ec2:DisassociateVerifiedAccessInstanceWebAcl - ec2:DescribeVerifiedAccessInstanceWebAclAssociations - ec2:GetVerifiedAccessInstanceWebAcl + - amplify:GetWebACLForResource update: - wafv2:AssociateWebACL - wafv2:GetWebACLForResource @@ -1858,51 +2581,353 @@ components: - ec2:DisassociateVerifiedAccessInstanceWebAcl - ec2:DescribeVerifiedAccessInstanceWebAclAssociations - ec2:GetVerifiedAccessInstanceWebAcl + CreateIPSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/ResourceArn' + Description: + $ref: '#/components/schemas/EntityDescription' + Name: + $ref: '#/components/schemas/EntityName' + Id: + $ref: '#/components/schemas/EntityId' + Scope: + $ref: '#/components/schemas/Scope' + IPAddressVersion: + $ref: '#/components/schemas/IPAddressVersion' + Addresses: + description: List of IPAddresses. + type: array + items: + $ref: '#/components/schemas/IPAddress' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + x-stackQL-stringOnly: true + x-title: CreateIPSetRequest + type: object + required: [] + CreateLoggingConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + description: The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. + type: string + LogDestinationConfigs: + description: The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL. + type: array + items: + type: string + RedactedFields: + description: The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/FieldToMatch' + ManagedByFirewallManager: + description: Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. + type: boolean + LoggingFilter: + description: Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. + type: object + additionalProperties: false + properties: + DefaultBehavior: + description: Default handling for logs that don't match any of the specified filtering conditions. + type: string + enum: + - KEEP + - DROP + Filters: + description: The filters that you want to apply to the logs. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Filter' + required: + - DefaultBehavior + - Filters + x-stackQL-stringOnly: true + x-title: CreateLoggingConfigurationRequest + type: object + required: [] + CreateRegexPatternSetRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: ARN of the WAF entity. + type: string + Description: + description: Description of the entity. + type: string + pattern: ^[a-zA-Z0-9=:#@/\-,.][a-zA-Z0-9+=:#@/\-,.\s]+[a-zA-Z0-9+=:#@/\-,.]{1,256}$ + Name: + description: Name of the RegexPatternSet. + type: string + pattern: ^[0-9A-Za-z_-]{1,128}$ + Id: + description: Id of the RegexPatternSet + type: string + pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ + RegularExpressionList: + type: array + items: + type: string + Scope: + description: Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway. + type: string + enum: + - CLOUDFRONT + - REGIONAL + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + x-stackQL-stringOnly: true + x-title: CreateRegexPatternSetRequest + type: object + required: [] + CreateRuleGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/ResourceArn' + Capacity: + type: integer + minimum: 0 + Description: + $ref: '#/components/schemas/EntityDescription' + Name: + $ref: '#/components/schemas/EntityName' + Id: + $ref: '#/components/schemas/EntityId' + Scope: + $ref: '#/components/schemas/Scope' + Rules: + description: Collection of Rules. + type: array + items: + $ref: '#/components/schemas/Rule' + VisibilityConfig: + $ref: '#/components/schemas/VisibilityConfig' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + LabelNamespace: + $ref: '#/components/schemas/LabelName' + CustomResponseBodies: + $ref: '#/components/schemas/CustomResponseBodies' + AvailableLabels: + description: Collection of Available Labels. + type: array + items: + $ref: '#/components/schemas/LabelSummary' + ConsumedLabels: + description: Collection of Consumed Labels. + type: array + items: + $ref: '#/components/schemas/LabelSummary' + x-stackQL-stringOnly: true + x-title: CreateRuleGroupRequest + type: object + required: [] + CreateWebACLRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + $ref: '#/components/schemas/ResourceArn' + Capacity: + type: integer + minimum: 0 + DefaultAction: + $ref: '#/components/schemas/DefaultAction' + Description: + $ref: '#/components/schemas/EntityDescription' + Name: + $ref: '#/components/schemas/EntityName' + Id: + $ref: '#/components/schemas/EntityId' + Scope: + $ref: '#/components/schemas/Scope' + Rules: + description: Collection of Rules. + type: array + items: + $ref: '#/components/schemas/Rule' + VisibilityConfig: + $ref: '#/components/schemas/VisibilityConfig' + DataProtectionConfig: + description: Collection of dataProtects. + $ref: '#/components/schemas/DataProtectionConfig' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + LabelNamespace: + $ref: '#/components/schemas/LabelName' + CustomResponseBodies: + $ref: '#/components/schemas/CustomResponseBodies' + CaptchaConfig: + $ref: '#/components/schemas/CaptchaConfig' + ChallengeConfig: + $ref: '#/components/schemas/ChallengeConfig' + TokenDomains: + $ref: '#/components/schemas/TokenDomains' + AssociationConfig: + $ref: '#/components/schemas/AssociationConfig' + OnSourceDDoSProtectionConfig: + $ref: '#/components/schemas/OnSourceDDoSProtectionConfig' + x-stackQL-stringOnly: true + x-title: CreateWebACLRequest + type: object + required: [] + CreateWebACLAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceArn: + $ref: '#/components/schemas/ResourceArn' + WebACLArn: + $ref: '#/components/schemas/ResourceArn' + x-stackQL-stringOnly: true + x-title: CreateWebACLAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: ip_sets: name: ip_sets id: awscc.wafv2.ip_sets x-cfn-schema-name: IPSet - x-type: list - x-identifiers: - - Name - - Id - - Scope - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' - AND region = 'us-east-1' - ip_set: - name: ip_set - id: awscc.wafv2.ip_set - x-cfn-schema-name: IPSet - x-type: get + x-cfn-type-name: AWS::WAFv2::IPSet x-identifiers: - Name - Id - Scope + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IPSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::IPSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::IPSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::IPSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1919,7 +2944,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1935,13 +2960,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::IPSet' AND data__Identifier = '||' AND region = 'us-east-1' - logging_configurations: - name: logging_configurations - id: awscc.wafv2.logging_configurations - x-cfn-schema-name: LoggingConfiguration - x-type: list + ip_sets_list_only: + name: ip_sets_list_only + id: awscc.wafv2.ip_sets_list_only + x-cfn-schema-name: IPSet + x-cfn-type-name: AWS::WAFv2::IPSet x-identifiers: - - ResourceArn + - Name + - Id + - Scope + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1949,28 +2982,80 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Scope') as scope + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' AND region = 'us-east-1' - logging_configuration: - name: logging_configuration - id: awscc.wafv2.logging_configuration + logging_configurations: + name: logging_configurations + id: awscc.wafv2.logging_configurations x-cfn-schema-name: LoggingConfiguration - x-type: get + x-cfn-type-name: AWS::WAFv2::LoggingConfiguration x-identifiers: - ResourceArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LoggingConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::LoggingConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1984,7 +3069,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1997,15 +3082,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' AND data__Identifier = '' AND region = 'us-east-1' - regex_pattern_sets: - name: regex_pattern_sets - id: awscc.wafv2.regex_pattern_sets - x-cfn-schema-name: RegexPatternSet - x-type: list + logging_configurations_list_only: + name: logging_configurations_list_only + id: awscc.wafv2.logging_configurations_list_only + x-cfn-schema-name: LoggingConfiguration + x-cfn-type-name: AWS::WAFv2::LoggingConfiguration x-identifiers: - - Name - - Id - - Scope + - ResourceArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2013,34 +3102,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' + json_extract_path_text(Properties, 'ResourceArn') as resource_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' AND region = 'us-east-1' - regex_pattern_set: - name: regex_pattern_set - id: awscc.wafv2.regex_pattern_set + regex_pattern_sets: + name: regex_pattern_sets + id: awscc.wafv2.regex_pattern_sets x-cfn-schema-name: RegexPatternSet - x-type: get + x-cfn-type-name: AWS::WAFv2::RegexPatternSet x-identifiers: - Name - Id - Scope + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RegexPatternSet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::RegexPatternSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::RegexPatternSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::RegexPatternSet" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2056,7 +3189,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2071,15 +3204,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' AND data__Identifier = '||' AND region = 'us-east-1' - rule_groups: - name: rule_groups - id: awscc.wafv2.rule_groups - x-cfn-schema-name: RuleGroup - x-type: list + regex_pattern_sets_list_only: + name: regex_pattern_sets_list_only + id: awscc.wafv2.regex_pattern_sets_list_only + x-cfn-schema-name: RegexPatternSet + x-cfn-type-name: AWS::WAFv2::RegexPatternSet x-identifiers: - Name - Id - Scope + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2090,7 +3229,7 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2100,21 +3239,69 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' AND region = 'us-east-1' - rule_group: - name: rule_group - id: awscc.wafv2.rule_group + rule_groups: + name: rule_groups + id: awscc.wafv2.rule_groups x-cfn-schema-name: RuleGroup - x-type: get + x-cfn-type-name: AWS::WAFv2::RuleGroup x-identifiers: - Name - Id - Scope + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RuleGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::RuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::RuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::RuleGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2136,7 +3323,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2157,15 +3344,21 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' AND data__Identifier = '||' AND region = 'us-east-1' - web_acls: - name: web_acls - id: awscc.wafv2.web_acls - x-cfn-schema-name: WebACL - x-type: list + rule_groups_list_only: + name: rule_groups_list_only + id: awscc.wafv2.rule_groups_list_only + x-cfn-schema-name: RuleGroup + x-cfn-type-name: AWS::WAFv2::RuleGroup x-identifiers: - Name - Id - Scope + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -2176,7 +3369,7 @@ components: JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" @@ -2186,21 +3379,69 @@ components: json_extract_path_text(Properties, 'Name') as name, json_extract_path_text(Properties, 'Id') as id, json_extract_path_text(Properties, 'Scope') as scope - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' AND region = 'us-east-1' - web_acl: - name: web_acl - id: awscc.wafv2.web_acl + web_acls: + name: web_acls + id: awscc.wafv2.web_acls x-cfn-schema-name: WebACL - x-type: get + x-cfn-type-name: AWS::WAFv2::WebACL x-identifiers: - Name - Id - Scope + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WebACL&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::WebACL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::WebACL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::WebACL" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/web_acls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/web_acls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/web_acls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2214,18 +3455,20 @@ components: JSON_EXTRACT(Properties, '$.Scope') as scope, JSON_EXTRACT(Properties, '$.Rules') as rules, JSON_EXTRACT(Properties, '$.VisibilityConfig') as visibility_config, + JSON_EXTRACT(Properties, '$.DataProtectionConfig') as data_protection_config, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.LabelNamespace') as label_namespace, JSON_EXTRACT(Properties, '$.CustomResponseBodies') as custom_response_bodies, JSON_EXTRACT(Properties, '$.CaptchaConfig') as captcha_config, JSON_EXTRACT(Properties, '$.ChallengeConfig') as challenge_config, JSON_EXTRACT(Properties, '$.TokenDomains') as token_domains, - JSON_EXTRACT(Properties, '$.AssociationConfig') as association_config + JSON_EXTRACT(Properties, '$.AssociationConfig') as association_config, + JSON_EXTRACT(Properties, '$.OnSourceDDoSProtectionConfig') as on_source_ddo_sprotection_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::WebACL' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2239,28 +3482,115 @@ components: json_extract_path_text(Properties, 'Scope') as scope, json_extract_path_text(Properties, 'Rules') as rules, json_extract_path_text(Properties, 'VisibilityConfig') as visibility_config, + json_extract_path_text(Properties, 'DataProtectionConfig') as data_protection_config, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'LabelNamespace') as label_namespace, json_extract_path_text(Properties, 'CustomResponseBodies') as custom_response_bodies, json_extract_path_text(Properties, 'CaptchaConfig') as captcha_config, json_extract_path_text(Properties, 'ChallengeConfig') as challenge_config, json_extract_path_text(Properties, 'TokenDomains') as token_domains, - json_extract_path_text(Properties, 'AssociationConfig') as association_config + json_extract_path_text(Properties, 'AssociationConfig') as association_config, + json_extract_path_text(Properties, 'OnSourceDDoSProtectionConfig') as on_source_ddo_sprotection_config FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::WebACL' AND data__Identifier = '||' AND region = 'us-east-1' - webacl_association: - name: webacl_association - id: awscc.wafv2.webacl_association + web_acls_list_only: + name: web_acls_list_only + id: awscc.wafv2.web_acls_list_only + x-cfn-schema-name: WebACL + x-cfn-type-name: AWS::WAFv2::WebACL + x-identifiers: + - Name + - Id + - Scope + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Scope') as scope + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' + AND region = 'us-east-1' + webacl_associations: + name: webacl_associations + id: awscc.wafv2.webacl_associations x-cfn-schema-name: WebACLAssociation - x-type: get + x-cfn-type-name: AWS::WAFv2::WebACLAssociation x-identifiers: - ResourceArn - WebACLArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WebACLAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::WebACLAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::WebACLAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WAFv2::WebACLAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2271,7 +3601,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2281,3 +3611,408 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::WebACLAssociation' AND data__Identifier = '|' AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IPSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIPSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIPSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__LoggingConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateLoggingConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateLoggingConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RegexPatternSet&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRegexPatternSet + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRegexPatternSetRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RuleGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRuleGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRuleGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WebACL&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWebACL + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWebACLRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WebACLAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWebACLAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWebACLAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/wisdom.yaml b/providers/src/awscc/v00.00.00000/services/wisdom.yaml index 7039d3c7..f25897b9 100644 --- a/providers/src/awscc/v00.00.00000/services/wisdom.yaml +++ b/providers/src/awscc/v00.00.00000/services/wisdom.yaml @@ -1,283 +1,3920 @@ openapi: 3.0.0 info: title: Wisdom - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: - AssistantType: + AIAgentAssociationConfigurationType: type: string enum: - - AGENT - ServerSideEncryptionConfiguration: + - KNOWLEDGE_BASE + AIAgentConfiguration: + oneOf: + - type: object + title: ManualSearchAIAgentConfiguration + properties: + ManualSearchAIAgentConfiguration: + $ref: '#/components/schemas/ManualSearchAIAgentConfiguration' + required: + - ManualSearchAIAgentConfiguration + additionalProperties: false + - type: object + title: AnswerRecommendationAIAgentConfiguration + properties: + AnswerRecommendationAIAgentConfiguration: + $ref: '#/components/schemas/AnswerRecommendationAIAgentConfiguration' + required: + - AnswerRecommendationAIAgentConfiguration + additionalProperties: false + - type: object + title: SelfServiceAIAgentConfiguration + properties: + SelfServiceAIAgentConfiguration: + $ref: '#/components/schemas/SelfServiceAIAgentConfiguration' + required: + - SelfServiceAIAgentConfiguration + additionalProperties: false + AIAgentType: + type: string + enum: + - MANUAL_SEARCH + - ANSWER_RECOMMENDATION + - SELF_SERVICE + SelfServiceAIAgentConfiguration: type: object properties: - KmsKeyId: + SelfServicePreProcessingAIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + SelfServiceAnswerGenerationAIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + SelfServiceAIGuardrailId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + AssociationConfigurations: + type: array + items: + $ref: '#/components/schemas/AssociationConfiguration' + additionalProperties: false + AnswerRecommendationAIAgentConfiguration: + type: object + properties: + IntentLabelingGenerationAIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + QueryReformulationAIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + AnswerGenerationAIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + AnswerGenerationAIGuardrailId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + AssociationConfigurations: + type: array + items: + $ref: '#/components/schemas/AssociationConfiguration' + Locale: type: string - maxLength: 4096 minLength: 1 additionalProperties: false - Tag: + AssociationConfiguration: + type: object + properties: + AssociationId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssociationType: + $ref: '#/components/schemas/AIAgentAssociationConfigurationType' + AssociationConfigurationData: + $ref: '#/components/schemas/AssociationConfigurationData' + additionalProperties: false + AssociationConfigurationData: + oneOf: + - type: object + title: KnowledgeBaseAssociationConfigurationData + properties: + KnowledgeBaseAssociationConfigurationData: + $ref: '#/components/schemas/KnowledgeBaseAssociationConfigurationData' + required: + - KnowledgeBaseAssociationConfigurationData + additionalProperties: false + KnowledgeBaseAssociationConfigurationData: + type: object + properties: + ContentTagFilter: + $ref: '#/components/schemas/TagFilter' + MaxResults: + type: number + maximum: 100 + minimum: 1 + OverrideKnowledgeBaseSearchType: + $ref: '#/components/schemas/KnowledgeBaseSearchType' + additionalProperties: false + KnowledgeBaseSearchType: + type: string + enum: + - HYBRID + - SEMANTIC + ManualSearchAIAgentConfiguration: + type: object + properties: + AnswerGenerationAIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + AnswerGenerationAIGuardrailId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + AssociationConfigurations: + type: array + items: + $ref: '#/components/schemas/AssociationConfiguration' + Locale: + type: string + minLength: 1 additionalProperties: false + OrCondition: + oneOf: + - type: object + title: AndConditions + properties: + AndConditions: + type: array + items: + $ref: '#/components/schemas/TagCondition' + required: + - AndConditions + additionalProperties: false + - type: object + title: TagCondition + properties: + TagCondition: + $ref: '#/components/schemas/TagCondition' + required: + - TagCondition + additionalProperties: false + TagCondition: + type: object properties: Key: + type: string maxLength: 128 minLength: 1 pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ - type: string Value: + type: string maxLength: 256 minLength: 1 - type: string required: - Key - - Value + additionalProperties: false + TagFilter: + oneOf: + - type: object + title: TagCondition + properties: + TagCondition: + $ref: '#/components/schemas/TagCondition' + required: + - TagCondition + additionalProperties: false + - type: object + title: AndConditions + properties: + AndConditions: + type: array + items: + $ref: '#/components/schemas/TagCondition' + required: + - AndConditions + additionalProperties: false + - type: object + title: OrConditions + properties: + OrConditions: + type: array + items: + $ref: '#/components/schemas/OrCondition' + required: + - OrConditions + additionalProperties: false + Tags: type: object - Assistant: + x-patternProperties: + ^(?!aws:)[a-zA-Z+-=._:/]+$: + type: string + maxLength: 256 + minLength: 1 + additionalProperties: false + AIAgent: type: object properties: - Type: - $ref: '#/components/schemas/AssistantType' - Description: + AIAgentId: type: string - maxLength: 255 - minLength: 1 - AssistantArn: + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$ + AIAgentArn: type: string - pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ AssistantId: type: string - pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - ServerSideEncryptionConfiguration: - $ref: '#/components/schemas/ServerSideEncryptionConfiguration' - Tags: - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/Tag' - type: array + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + Configuration: + $ref: '#/components/schemas/AIAgentConfiguration' + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ Name: type: string maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + Tags: + $ref: '#/components/schemas/Tags' + Type: + $ref: '#/components/schemas/AIAgentType' + ModifiedTimeSeconds: + type: number required: - - Name + - AssistantId + - Configuration - Type - x-stackql-resource-name: assistant - x-stackql-primaryIdentifier: + x-stackql-resource-name: ai_agent + description: Definition of AWS::Wisdom::AIAgent Resource Type + x-type-name: AWS::Wisdom::AIAgent + x-stackql-primary-identifier: + - AIAgentId - AssistantId + x-stackql-additional-identifiers: + - - AIAgentArn + - AssistantArn x-create-only-properties: - - Description + - AssistantId - Name - - ServerSideEncryptionConfiguration - Tags - Type x-read-only-properties: - - AssistantId + - AIAgentArn + - AIAgentId - AssistantArn + - ModifiedTimeSeconds + x-required-properties: + - AssistantId + - Configuration + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource x-required-permissions: create: - - kms:CreateGrant - - kms:DescribeKey - - wisdom:CreateAssistant + - wisdom:CreateAIAgent - wisdom:TagResource - update: - - wisdom:GetAssistant read: - - wisdom:GetAssistant - list: - - wisdom:ListAssistants + - wisdom:GetAIAgent + update: + - wisdom:UpdateAIAgent delete: - - wisdom:DeleteAssistant - AssociationData: - type: object - properties: - KnowledgeBaseId: - type: string - pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - required: - - KnowledgeBaseId - additionalProperties: false - AssociationType: - type: string - enum: - - KNOWLEDGE_BASE - AssistantAssociation: + - wisdom:DeleteAIAgent + list: + - wisdom:ListAIAgents + AIAgentVersion: type: object properties: - AssistantAssociationArn: + AIAgentArn: type: string pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ AssistantArn: type: string pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ - AssistantAssociationId: + AIAgentId: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ AssistantId: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - Association: - $ref: '#/components/schemas/AssociationData' - AssociationType: - $ref: '#/components/schemas/AssociationType' - Tags: - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/Tag' - type: array + AIAgentVersionId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + VersionNumber: + type: number + ModifiedTimeSeconds: + type: number required: - - Association - - AssociationType - AssistantId - x-stackql-resource-name: assistant_association - x-stackql-primaryIdentifier: - - AssistantAssociationId + - AIAgentId + x-stackql-resource-name: ai_agent_version + description: Definition of AWS::Wisdom::AIAgentVersion Resource Type + x-type-name: AWS::Wisdom::AIAgentVersion + x-stackql-primary-identifier: - AssistantId + - AIAgentId + - VersionNumber + x-stackql-additional-identifiers: + - - AIAgentArn + - AssistantArn x-create-only-properties: - - Association - - AssociationType - AssistantId - - Tags + - AIAgentId + - ModifiedTimeSeconds x-read-only-properties: - - AssistantAssociationId - - AssistantAssociationArn + - AIAgentVersionId + - AIAgentArn - AssistantArn + - VersionNumber + x-required-properties: + - AssistantId + - AIAgentId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - - wisdom:CreateAssistantAssociation - - wisdom:TagResource - update: - - wisdom:GetAssistantAssociation + - wisdom:CreateAIAgentVersion read: - - wisdom:GetAssistantAssociation - list: - - wisdom:ListAssistantAssociations + - wisdom:GetAIAgent + - wisdom:GetAIAgentVersion + update: + - wisdom:GetAIAgent + - wisdom:GetAIAgentVersion delete: - - wisdom:DeleteAssistantAssociation - AppIntegrationsConfiguration: + - wisdom:DeleteAIAgentVersion + list: + - wisdom:ListAIAgentVersions + AIGuardrailContentPolicyConfig: type: object + description: Content policy config for a guardrail. properties: - ObjectFields: + FiltersConfig: type: array items: - type: string - maxLength: 4096 - minLength: 1 - x-insertionOrder: false - maxItems: 100 + $ref: '#/components/schemas/GuardrailContentFilterConfig' + maxItems: 6 minItems: 1 - AppIntegrationArn: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$ + description: List of content filter configs in content policy. required: - - AppIntegrationArn + - FiltersConfig additionalProperties: false - KnowledgeBaseType: - type: string - enum: - - EXTERNAL - - CUSTOM - RenderingConfiguration: + AIGuardrailContextualGroundingPolicyConfig: type: object + description: Contextual grounding policy config for a guardrail. properties: - TemplateUri: - type: string - maxLength: 4096 - minLength: 1 + FiltersConfig: + type: array + items: + $ref: '#/components/schemas/GuardrailContextualGroundingFilterConfig' + minItems: 1 + description: List of contextual grounding filter configs. + required: + - FiltersConfig additionalProperties: false - SourceConfiguration: + AIGuardrailSensitiveInformationPolicyConfig: type: object + description: Sensitive information policy config for a guardrail. properties: - AppIntegrations: - $ref: '#/components/schemas/AppIntegrationsConfiguration' - oneOf: - - required: - - AppIntegrations - additionalProperties: false - KnowledgeBase: + PiiEntitiesConfig: + type: array + items: + $ref: '#/components/schemas/GuardrailPiiEntityConfig' + minItems: 1 + uniqueItems: true + description: List of entities. + RegexesConfig: + type: array + items: + $ref: '#/components/schemas/GuardrailRegexConfig' + minItems: 1 + description: List of regex. + additionalProperties: false + AIGuardrailTopicPolicyConfig: + type: object + description: Topic policy config for a guardrail. + properties: + TopicsConfig: + type: array + items: + $ref: '#/components/schemas/GuardrailTopicConfig' + minItems: 1 + description: List of topic configs in topic policy. + required: + - TopicsConfig + additionalProperties: false + AIGuardrailWordPolicyConfig: + type: object + description: Word policy config for a guardrail. + properties: + WordsConfig: + type: array + items: + $ref: '#/components/schemas/GuardrailWordConfig' + minItems: 1 + description: List of custom word configs. + ManagedWordListsConfig: + type: array + items: + $ref: '#/components/schemas/GuardrailManagedWordsConfig' + description: A config for the list of managed words. + additionalProperties: false + GuardrailContentFilterConfig: + type: object + description: Content filter config in content policy. + properties: + Type: + $ref: '#/components/schemas/GuardrailContentFilterType' + InputStrength: + $ref: '#/components/schemas/GuardrailFilterStrength' + OutputStrength: + $ref: '#/components/schemas/GuardrailFilterStrength' + required: + - InputStrength + - OutputStrength + - Type + additionalProperties: false + GuardrailContentFilterType: + type: string + description: Type of text to text filter in content policy + enum: + - SEXUAL + - VIOLENCE + - HATE + - INSULTS + - MISCONDUCT + - PROMPT_ATTACK + GuardrailContextualGroundingFilterConfig: + type: object + description: A config for grounding filter. + properties: + Type: + $ref: '#/components/schemas/GuardrailContextualGroundingFilterType' + Threshold: + type: number + default: 0 + minimum: 0 + description: The threshold for this filter. + required: + - Threshold + - Type + additionalProperties: false + GuardrailContextualGroundingFilterType: + type: string + description: Type of contextual grounding filter + enum: + - GROUNDING + - RELEVANCE + GuardrailFilterStrength: + type: string + description: Strength for filters + enum: + - NONE + - LOW + - MEDIUM + - HIGH + GuardrailManagedWordsConfig: + type: object + description: A managed words config. + properties: + Type: + $ref: '#/components/schemas/GuardrailManagedWordsType' + required: + - Type + additionalProperties: false + GuardrailManagedWordsType: + type: string + description: Options for managed words. + enum: + - PROFANITY + GuardrailPiiEntityConfig: + type: object + description: Pii entity configuration. + properties: + Type: + $ref: '#/components/schemas/GuardrailPiiEntityType' + Action: + $ref: '#/components/schemas/GuardrailSensitiveInformationAction' + required: + - Action + - Type + additionalProperties: false + GuardrailPiiEntityType: + type: string + description: The currently supported PII entities + enum: + - ADDRESS + - AGE + - AWS_ACCESS_KEY + - AWS_SECRET_KEY + - CA_HEALTH_NUMBER + - CA_SOCIAL_INSURANCE_NUMBER + - CREDIT_DEBIT_CARD_CVV + - CREDIT_DEBIT_CARD_EXPIRY + - CREDIT_DEBIT_CARD_NUMBER + - DRIVER_ID + - EMAIL + - INTERNATIONAL_BANK_ACCOUNT_NUMBER + - IP_ADDRESS + - LICENSE_PLATE + - MAC_ADDRESS + - NAME + - PASSWORD + - PHONE + - PIN + - SWIFT_CODE + - UK_NATIONAL_HEALTH_SERVICE_NUMBER + - UK_NATIONAL_INSURANCE_NUMBER + - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER + - URL + - USERNAME + - US_BANK_ACCOUNT_NUMBER + - US_BANK_ROUTING_NUMBER + - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER + - US_PASSPORT_NUMBER + - US_SOCIAL_SECURITY_NUMBER + - VEHICLE_IDENTIFICATION_NUMBER + GuardrailRegexConfig: type: object + description: A regex configuration. properties: + Name: + type: string + maxLength: 100 + minLength: 1 + description: The regex name. Description: + type: string + maxLength: 1000 + minLength: 1 + description: The regex description. + Pattern: + type: string + minLength: 1 + description: The regex pattern. + Action: + $ref: '#/components/schemas/GuardrailSensitiveInformationAction' + required: + - Action + - Name + - Pattern + additionalProperties: false + GuardrailSensitiveInformationAction: + type: string + description: Options for sensitive information action. + enum: + - BLOCK + - ANONYMIZE + GuardrailTopicConfig: + type: object + description: Topic config in topic policy. + properties: + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[0-9a-zA-Z-_ !?.]+$ + description: Name of topic in topic policy + Definition: + type: string + maxLength: 200 + minLength: 1 + description: Definition of topic in topic policy + Examples: + type: array + items: + type: string + maxLength: 100 + minLength: 1 + description: Text example in topic policy + minItems: 0 + description: List of text examples + Type: + $ref: '#/components/schemas/GuardrailTopicType' + required: + - Definition + - Name + - Type + additionalProperties: false + GuardrailTopicType: + type: string + description: Type of topic in a policy + enum: + - DENY + GuardrailWordConfig: + type: object + description: A custom word config. + properties: + Text: + type: string + minLength: 1 + description: The custom word text. + required: + - Text + additionalProperties: false + AIGuardrail: + type: object + properties: + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AIGuardrailArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AIGuardrailId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$ + Name: type: string maxLength: 255 minLength: 1 - KnowledgeBaseArn: + pattern: ^[a-zA-Z0-9\s_.,-]+ + BlockedInputMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + BlockedOutputsMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the guardrail or its version + TopicPolicyConfig: + $ref: '#/components/schemas/AIGuardrailTopicPolicyConfig' + ContentPolicyConfig: + $ref: '#/components/schemas/AIGuardrailContentPolicyConfig' + WordPolicyConfig: + $ref: '#/components/schemas/AIGuardrailWordPolicyConfig' + SensitiveInformationPolicyConfig: + $ref: '#/components/schemas/AIGuardrailSensitiveInformationPolicyConfig' + ContextualGroundingPolicyConfig: + $ref: '#/components/schemas/AIGuardrailContextualGroundingPolicyConfig' + Tags: + $ref: '#/components/schemas/Tags' + required: + - AssistantId + - BlockedInputMessaging + - BlockedOutputsMessaging + x-stackql-resource-name: ai_guardrail + description: Definition of AWS::Wisdom::AIGuardrail Resource Type + x-type-name: AWS::Wisdom::AIGuardrail + x-stackql-primary-identifier: + - AIGuardrailId + - AssistantId + x-stackql-additional-identifiers: + - - AIGuardrailArn + - AssistantArn + x-create-only-properties: + - AssistantId + - Name + - Tags + x-read-only-properties: + - AIGuardrailArn + - AIGuardrailId + - AssistantArn + x-required-properties: + - AssistantId + - BlockedInputMessaging + - BlockedOutputsMessaging + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource + x-required-permissions: + create: + - wisdom:CreateAIGuardrail + - wisdom:TagResource + read: + - wisdom:GetAIGuardrail + update: + - wisdom:UpdateAIGuardrail + delete: + - wisdom:DeleteAIGuardrail + list: + - wisdom:ListAIGuardrails + AIGuardrailVersion: + type: object + properties: + AIGuardrailArn: type: string pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ - KnowledgeBaseId: + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AIGuardrailId: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - KnowledgeBaseType: - $ref: '#/components/schemas/KnowledgeBaseType' + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AIGuardrailVersionId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + VersionNumber: + type: number + ModifiedTimeSeconds: + type: number + required: + - AssistantId + - AIGuardrailId + x-stackql-resource-name: ai_guardrail_version + description: Definition of AWS::Wisdom::AIGuardrailVersion Resource Type + x-type-name: AWS::Wisdom::AIGuardrailVersion + x-stackql-primary-identifier: + - AssistantId + - AIGuardrailId + - VersionNumber + x-stackql-additional-identifiers: + - - AIGuardrailArn + - AssistantArn + x-create-only-properties: + - AssistantId + - AIGuardrailId + - ModifiedTimeSeconds + x-read-only-properties: + - AIGuardrailVersionId + - AIGuardrailArn + - AssistantArn + - VersionNumber + x-required-properties: + - AssistantId + - AIGuardrailId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - wisdom:CreateAIGuardrailVersion + read: + - wisdom:GetAIGuardrail + - wisdom:GetAIGuardrailVersion + update: + - wisdom:GetAIGuardrail + - wisdom:GetAIGuardrailVersion + delete: + - wisdom:DeleteAIGuardrailVersion + list: + - wisdom:ListAIGuardrailVersions + AIPromptAPIFormat: + type: string + enum: + - ANTHROPIC_CLAUDE_MESSAGES + - ANTHROPIC_CLAUDE_TEXT_COMPLETIONS + - MESSAGES + - TEXT_COMPLETIONS + AIPromptTemplateConfiguration: + type: object + oneOf: + - type: object + title: TextFullAIPromptEditTemplateConfiguration + properties: + TextFullAIPromptEditTemplateConfiguration: + $ref: '#/components/schemas/TextFullAIPromptEditTemplateConfiguration' + required: + - TextFullAIPromptEditTemplateConfiguration + additionalProperties: false + AIPromptTemplateType: + type: string + enum: + - TEXT + AIPromptType: + type: string + enum: + - ANSWER_GENERATION + - INTENT_LABELING_GENERATION + - QUERY_REFORMULATION + - SELF_SERVICE_PRE_PROCESSING + - SELF_SERVICE_ANSWER_GENERATION + TextFullAIPromptEditTemplateConfiguration: + type: object + properties: + Text: + type: string + maxLength: 200000 + minLength: 1 + required: + - Text + additionalProperties: false + AIPrompt: + type: object + properties: + AIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$ + AIPromptArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + ApiFormat: + $ref: '#/components/schemas/AIPromptAPIFormat' + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + ModelId: + type: string + maxLength: 2048 + minLength: 1 Name: type: string maxLength: 255 minLength: 1 - RenderingConfiguration: - $ref: '#/components/schemas/RenderingConfiguration' - ServerSideEncryptionConfiguration: - $ref: '#/components/schemas/ServerSideEncryptionConfiguration' - SourceConfiguration: - $ref: '#/components/schemas/SourceConfiguration' + pattern: ^[a-zA-Z0-9\s_.,-]+ Tags: - x-insertionOrder: false - uniqueItems: true - items: - $ref: '#/components/schemas/Tag' - type: array + $ref: '#/components/schemas/Tags' + TemplateConfiguration: + $ref: '#/components/schemas/AIPromptTemplateConfiguration' + TemplateType: + $ref: '#/components/schemas/AIPromptTemplateType' + Type: + $ref: '#/components/schemas/AIPromptType' + ModifiedTimeSeconds: + type: number required: - - KnowledgeBaseType - - Name - x-stackql-resource-name: knowledge_base - x-stackql-primaryIdentifier: - - KnowledgeBaseId + - ApiFormat + - ModelId + - TemplateConfiguration + - TemplateType + - Type + x-stackql-resource-name: ai_prompt + description: Definition of AWS::Wisdom::AIPrompt Resource Type + x-type-name: AWS::Wisdom::AIPrompt + x-stackql-primary-identifier: + - AIPromptId + - AssistantId + x-stackql-additional-identifiers: + - - AIPromptArn + - AssistantArn x-create-only-properties: - - Description - - KnowledgeBaseType + - ApiFormat + - AssistantId - Name - - ServerSideEncryptionConfiguration - - SourceConfiguration - Tags + - TemplateType + - Type x-read-only-properties: - - KnowledgeBaseId - - KnowledgeBaseArn + - AIPromptArn + - AIPromptId + - AssistantArn + - ModifiedTimeSeconds + x-required-properties: + - ApiFormat + - ModelId + - TemplateConfiguration + - TemplateType + - Type + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource x-required-permissions: create: - - appflow:CreateFlow - - appflow:DeleteFlow - - appflow:StartFlow - - appflow:TagResource - - appflow:UseConnectorProfile - - app-integrations:CreateDataIntegrationAssociation - - app-integrations:GetDataIntegration - - kms:DescribeKey - - kms:CreateGrant - - kms:ListGrants - - wisdom:CreateKnowledgeBase + - wisdom:CreateAIPrompt - wisdom:TagResource + read: + - wisdom:GetAIPrompt update: - - wisdom:GetKnowledgeBase + - wisdom:UpdateAIPrompt delete: - - appflow:DeleteFlow - - appflow:StopFlow - - app-integrations:DeleteDataIntegrationAssociation - - wisdom:DeleteKnowledgeBase + - wisdom:DeleteAIPrompt list: - - wisdom:ListKnowledgeBases + - wisdom:ListAIPrompts + AIPromptVersion: + type: object + properties: + AIPromptArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AIPromptVersionId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + VersionNumber: + type: number + ModifiedTimeSeconds: + type: number + required: + - AssistantId + - AIPromptId + x-stackql-resource-name: ai_prompt_version + description: Definition of AWS::Wisdom::AIPromptVersion Resource Type + x-type-name: AWS::Wisdom::AIPromptVersion + x-stackql-primary-identifier: + - AssistantId + - AIPromptId + - VersionNumber + x-stackql-additional-identifiers: + - - AIPromptArn + - AssistantArn + x-create-only-properties: + - AssistantId + - AIPromptId + - ModifiedTimeSeconds + x-read-only-properties: + - AIPromptArn + - AIPromptVersionId + - AssistantArn + - VersionNumber + x-required-properties: + - AssistantId + - AIPromptId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - wisdom:CreateAIPromptVersion read: - - wisdom:GetKnowledgeBase - x-stackQL-resources: - assistants: - name: assistants - id: awscc.wisdom.assistants - x-cfn-schema-name: Assistant - x-type: list + - wisdom:GetAIPrompt + - wisdom:GetAIPromptVersion + update: + - wisdom:GetAIPrompt + - wisdom:GetAIPromptVersion + delete: + - wisdom:DeleteAIPromptVersion + list: + - wisdom:ListAIPromptVersions + AssistantType: + type: string + enum: + - AGENT + ServerSideEncryptionConfiguration: + type: object + properties: + KmsKeyId: + type: string + maxLength: 4096 + minLength: 1 + additionalProperties: false + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -' + type: string + pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ + minLength: 1 + maxLength: 128 + Value: + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -' + type: string + minLength: 1 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + Assistant: + type: object + properties: + Type: + $ref: '#/components/schemas/AssistantType' + Description: + type: string + maxLength: 255 + minLength: 1 + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + Tags: + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + Name: + type: string + maxLength: 255 + minLength: 1 + required: + - Name + - Type + x-stackql-resource-name: assistant + description: Definition of AWS::Wisdom::Assistant Resource Type + x-type-name: AWS::Wisdom::Assistant + x-stackql-primary-identifier: + - AssistantId + x-stackql-additional-identifiers: + - - AssistantArn + x-create-only-properties: + - Description + - Name + - ServerSideEncryptionConfiguration + - Tags + - Type + x-read-only-properties: + - AssistantId + - AssistantArn + x-required-properties: + - Name + - Type + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource + x-required-permissions: + create: + - kms:CreateGrant + - kms:DescribeKey + - wisdom:CreateAssistant + - wisdom:TagResource + update: + - wisdom:GetAssistant + read: + - wisdom:GetAssistant + list: + - wisdom:ListAssistants + delete: + - wisdom:DeleteAssistant + AssociationData: + type: object + properties: + KnowledgeBaseId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + required: + - KnowledgeBaseId + additionalProperties: false + AssociationType: + type: string + enum: + - KNOWLEDGE_BASE + AssistantAssociation: + type: object + properties: + AssistantAssociationArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantAssociationId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Association: + $ref: '#/components/schemas/AssociationData' + AssociationType: + $ref: '#/components/schemas/AssociationType' + Tags: + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + required: + - Association + - AssociationType + - AssistantId + x-stackql-resource-name: assistant_association + description: Definition of AWS::Wisdom::AssistantAssociation Resource Type + x-type-name: AWS::Wisdom::AssistantAssociation + x-stackql-primary-identifier: + - AssistantAssociationId + - AssistantId + x-stackql-additional-identifiers: + - - AssistantAssociationArn + - AssistantArn + x-create-only-properties: + - Association + - AssociationType + - AssistantId + - Tags + x-read-only-properties: + - AssistantAssociationId + - AssistantAssociationArn + - AssistantArn + x-required-properties: + - Association + - AssociationType + - AssistantId + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource + x-required-permissions: + create: + - wisdom:CreateAssistantAssociation + - wisdom:TagResource + update: + - wisdom:GetAssistantAssociation + read: + - wisdom:GetAssistantAssociation + list: + - wisdom:ListAssistantAssociations + delete: + - wisdom:DeleteAssistantAssociation + AppIntegrationsConfiguration: + type: object + properties: + ObjectFields: + type: array + items: + type: string + maxLength: 4096 + minLength: 1 + x-insertionOrder: false + maxItems: 100 + minItems: 1 + AppIntegrationArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$ + required: + - AppIntegrationArn + additionalProperties: false + KnowledgeBaseType: + type: string + enum: + - EXTERNAL + - CUSTOM + - MESSAGE_TEMPLATES + - MANAGED + - QUICK_RESPONSES + RenderingConfiguration: + type: object + properties: + TemplateUri: + type: string + maxLength: 4096 + minLength: 1 + additionalProperties: false + SeedUrl: + type: object + additionalProperties: false + properties: + Url: + type: string + pattern: ^https?://[A-Za-z0-9][^\s]*$ + UrlFilterPattern: + type: string + maxLength: 1000 + minLength: 1 + UrlFilterList: + type: array + items: + $ref: '#/components/schemas/UrlFilterPattern' + maxItems: 25 + minItems: 1 + WebCrawlerConfiguration: + type: object + additionalProperties: false + properties: + UrlConfiguration: + type: object + additionalProperties: false + properties: + SeedUrls: + type: array + items: + $ref: '#/components/schemas/SeedUrl' + maxItems: 100 + minItems: 1 + CrawlerLimits: + type: object + additionalProperties: false + properties: + RateLimit: + type: number + minimum: 1 + maximum: 3000 + InclusionFilters: + $ref: '#/components/schemas/UrlFilterList' + ExclusionFilters: + $ref: '#/components/schemas/UrlFilterList' + Scope: + type: string + enum: + - HOST_ONLY + - SUBDOMAINS + required: + - UrlConfiguration + ManagedSourceConfiguration: + oneOf: + - type: object + properties: + WebCrawlerConfiguration: + $ref: '#/components/schemas/WebCrawlerConfiguration' + required: + - WebCrawlerConfiguration + additionalProperties: false + FixedSizeChunkingConfiguration: + type: object + additionalProperties: false + properties: + MaxTokens: + type: number + minimum: 1 + OverlapPercentage: + type: number + minimum: 1 + maximum: 99 + required: + - MaxTokens + - OverlapPercentage + HierarchicalChunkingLevelConfiguration: + type: object + additionalProperties: false + properties: + MaxTokens: + type: number + minimum: 1 + maximum: 8192 + required: + - MaxTokens + HierarchicalChunkingConfiguration: + type: object + additionalProperties: false + properties: + LevelConfigurations: + type: array + items: + $ref: '#/components/schemas/HierarchicalChunkingLevelConfiguration' + maxItems: 2 + minItems: 2 + OverlapTokens: + type: number + minimum: 1 + required: + - LevelConfigurations + - OverlapTokens + SemanticChunkingConfiguration: + type: object + additionalProperties: false + properties: + MaxTokens: + type: number + minimum: 1 + BufferSize: + type: number + minimum: 0 + maximum: 1 + BreakpointPercentileThreshold: + type: number + minimum: 50 + maximum: 99 + required: + - MaxTokens + - BufferSize + - BreakpointPercentileThreshold + BedrockFoundationModelConfiguration: + type: object + additionalProperties: false + properties: + ModelArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/anthropic.claude-3-haiku-20240307-v1:0$ + ParsingPrompt: + type: object + additionalProperties: false + properties: + ParsingPromptText: + type: string + maxLength: 10000 + minLength: 1 + required: + - ParsingPromptText + required: + - ModelArn + VectorIngestionConfiguration: + type: object + additionalProperties: false + properties: + ChunkingConfiguration: + type: object + additionalProperties: false + properties: + ChunkingStrategy: + type: string + enum: + - FIXED_SIZE + - NONE + - HIERARCHICAL + - SEMANTIC + FixedSizeChunkingConfiguration: + $ref: '#/components/schemas/FixedSizeChunkingConfiguration' + HierarchicalChunkingConfiguration: + $ref: '#/components/schemas/HierarchicalChunkingConfiguration' + SemanticChunkingConfiguration: + $ref: '#/components/schemas/SemanticChunkingConfiguration' + required: + - ChunkingStrategy + ParsingConfiguration: + type: object + additionalProperties: false + properties: + ParsingStrategy: + type: string + enum: + - BEDROCK_FOUNDATION_MODEL + BedrockFoundationModelConfiguration: + $ref: '#/components/schemas/BedrockFoundationModelConfiguration' + required: + - ParsingStrategy + SourceConfiguration: + oneOf: + - type: object + title: AppIntegrationsConfiguration + properties: + AppIntegrations: + $ref: '#/components/schemas/AppIntegrationsConfiguration' + required: + - AppIntegrations + additionalProperties: false + - type: object + title: ManagedSourceConfiguration + properties: + ManagedSourceConfiguration: + $ref: '#/components/schemas/ManagedSourceConfiguration' + required: + - ManagedSourceConfiguration + additionalProperties: false + KnowledgeBase: + type: object + properties: + Description: + type: string + maxLength: 255 + minLength: 1 + KnowledgeBaseArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + KnowledgeBaseId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + KnowledgeBaseType: + $ref: '#/components/schemas/KnowledgeBaseType' + Name: + type: string + maxLength: 255 + minLength: 1 + RenderingConfiguration: + $ref: '#/components/schemas/RenderingConfiguration' + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + SourceConfiguration: + $ref: '#/components/schemas/SourceConfiguration' + VectorIngestionConfiguration: + $ref: '#/components/schemas/VectorIngestionConfiguration' + Tags: + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + required: + - KnowledgeBaseType + - Name + x-stackql-resource-name: knowledge_base + description: Definition of AWS::Wisdom::KnowledgeBase Resource Type + x-type-name: AWS::Wisdom::KnowledgeBase + x-stackql-primary-identifier: + - KnowledgeBaseId + x-stackql-additional-identifiers: + - - KnowledgeBaseArn + x-create-only-properties: + - Description + - KnowledgeBaseType + - Name + - ServerSideEncryptionConfiguration + - SourceConfiguration + - Tags + x-read-only-properties: + - KnowledgeBaseId + - KnowledgeBaseArn + x-required-properties: + - KnowledgeBaseType + - Name + x-replacement-strategy: delete_then_create + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource + x-required-permissions: + create: + - appflow:CreateFlow + - appflow:DeleteFlow + - appflow:StartFlow + - appflow:TagResource + - appflow:UseConnectorProfile + - app-integrations:CreateDataIntegrationAssociation + - app-integrations:GetDataIntegration + - kms:DescribeKey + - kms:CreateGrant + - kms:ListGrants + - wisdom:CreateKnowledgeBase + - wisdom:TagResource + update: + - wisdom:GetKnowledgeBase + delete: + - appflow:DeleteFlow + - appflow:StopFlow + - app-integrations:DeleteDataIntegrationAssociation + - wisdom:DeleteKnowledgeBase + list: + - wisdom:ListKnowledgeBases + read: + - wisdom:GetKnowledgeBase + ChannelSubtype: + description: The channel subtype this message template applies to. + type: string + enum: + - EMAIL + - SMS + Content: + description: The content of the message template. + type: object + properties: + EmailMessageTemplateContent: + $ref: '#/components/schemas/EmailMessageTemplateContent' + SmsMessageTemplateContent: + $ref: '#/components/schemas/SmsMessageTemplateContent' + oneOf: + - required: + - EmailMessageTemplateContent + - required: + - SmsMessageTemplateContent + additionalProperties: false + EmailMessageTemplateContent: + description: The content of message template that applies to email channel subtype. + type: object + properties: + Subject: + description: The subject line, or title, to use in email messages. + type: string + minLength: 1 + Body: + $ref: '#/components/schemas/EmailMessageTemplateContentBody' + Headers: + description: The email headers to include in email messages. + type: array + items: + $ref: '#/components/schemas/EmailMessageTemplateHeader' + uniqueItems: true + x-insertionOrder: true + minItems: 0 + maxItems: 15 + required: + - Subject + - Body + - Headers + additionalProperties: false + EmailMessageTemplateContentBody: + description: The body to use in email messages. + type: object + properties: + PlainText: + description: The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. + $ref: '#/components/schemas/MessageTemplateBodyContentProvider' + Html: + description: The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. + $ref: '#/components/schemas/MessageTemplateBodyContentProvider' + additionalProperties: false + EmailMessageTemplateHeader: + description: The email header to include in email messages. + type: object + properties: + Name: + description: The name of the email header. + type: string + pattern: ^[!-9;-@A-~]+$ + minLength: 1 + maxLength: 126 + Value: + description: The value of the email header. + type: string + pattern: '[ -~]*' + minLength: 1 + maxLength: 870 + additionalProperties: false + SmsMessageTemplateContent: + description: The content of message template that applies to SMS channel subtype. + type: object + properties: + Body: + $ref: '#/components/schemas/SmsMessageTemplateContentBody' + required: + - Body + additionalProperties: false + SmsMessageTemplateContentBody: + description: The body to use in SMS messages. + type: object + properties: + PlainText: + $ref: '#/components/schemas/MessageTemplateBodyContentProvider' + additionalProperties: false + MessageTemplateBodyContentProvider: + description: The container of message template body. + type: object + properties: + Content: + type: string + minLength: 1 + additionalProperties: false + MessageTemplateAttributes: + description: An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. + type: object + properties: + SystemAttributes: + $ref: '#/components/schemas/SystemAttributes' + AgentAttributes: + $ref: '#/components/schemas/AgentAttributes' + CustomerProfileAttributes: + $ref: '#/components/schemas/CustomerProfileAttributes' + CustomAttributes: + $ref: '#/components/schemas/CustomAttributes' + additionalProperties: false + SystemAttributes: + description: The system attributes that are used with the message template. + type: object + properties: + Name: + description: The name of the task. + type: string + minLength: 1 + maxLength: 32767 + CustomerEndpoint: + description: The CustomerEndpoint attribute. + $ref: '#/components/schemas/SystemEndpointAttributes' + SystemEndpoint: + description: The SystemEndpoint attribute. + $ref: '#/components/schemas/SystemEndpointAttributes' + additionalProperties: false + SystemEndpointAttributes: + description: The system endpoint attributes that are used with the message template. + type: object + properties: + Address: + description: The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint. + type: string + minLength: 1 + maxLength: 32767 + additionalProperties: false + AgentAttributes: + description: The agent attributes that are used with the message template. + type: object + properties: + FirstName: + description: The agent’s first name as entered in their Amazon Connect user account. + type: string + minLength: 1 + maxLength: 32767 + LastName: + description: The agent’s last name as entered in their Amazon Connect user account. + type: string + minLength: 1 + maxLength: 32767 + additionalProperties: false + CustomerProfileAttributes: + description: The customer profile attributes that are used with the message template. + type: object + properties: + ProfileId: + description: The unique identifier of a customer profile. + type: string + minLength: 1 + maxLength: 32767 + ProfileARN: + description: The ARN of a customer profile. + type: string + minLength: 1 + maxLength: 32767 + FirstName: + description: The customer's first name. + type: string + minLength: 1 + maxLength: 32767 + MiddleName: + description: The customer's middle name. + type: string + minLength: 1 + maxLength: 32767 + LastName: + description: The customer's last name. + type: string + minLength: 1 + maxLength: 32767 + AccountNumber: + description: A unique account number that you have given to the customer. + type: string + minLength: 1 + maxLength: 32767 + EmailAddress: + description: The customer's email address, which has not been specified as a personal or business address. + type: string + minLength: 1 + maxLength: 32767 + PhoneNumber: + description: The customer's phone number, which has not been specified as a mobile, home, or business number. + type: string + minLength: 1 + maxLength: 32767 + AdditionalInformation: + description: Any additional information relevant to the customer's profile. + type: string + minLength: 1 + maxLength: 32767 + PartyType: + description: The customer's party type. + type: string + minLength: 1 + maxLength: 32767 + BusinessName: + description: The name of the customer's business. + type: string + minLength: 1 + maxLength: 32767 + BirthDate: + description: The customer's birth date. + type: string + minLength: 1 + maxLength: 32767 + Gender: + description: The customer's gender. + type: string + minLength: 1 + maxLength: 32767 + MobilePhoneNumber: + description: The customer's mobile phone number. + type: string + minLength: 1 + maxLength: 32767 + HomePhoneNumber: + description: The customer's home phone number. + type: string + minLength: 1 + maxLength: 32767 + BusinessPhoneNumber: + description: The customer's business phone number. + type: string + minLength: 1 + maxLength: 32767 + BusinessEmailAddress: + description: The customer's business email address. + type: string + minLength: 1 + maxLength: 32767 + Address1: + description: The first line of a customer address. + type: string + minLength: 1 + maxLength: 32767 + Address2: + description: The second line of a customer address. + type: string + minLength: 1 + maxLength: 32767 + Address3: + description: The third line of a customer address. + type: string + minLength: 1 + maxLength: 32767 + Address4: + description: The fourth line of a customer address. + type: string + minLength: 1 + maxLength: 32767 + City: + description: The city in which a customer lives. + type: string + minLength: 1 + maxLength: 32767 + County: + description: The county in which a customer lives. + type: string + minLength: 1 + maxLength: 32767 + Country: + description: The country in which a customer lives. + type: string + minLength: 1 + maxLength: 32767 + PostalCode: + description: The postal code of a customer address. + type: string + minLength: 1 + maxLength: 32767 + Province: + description: The province in which a customer lives. + type: string + minLength: 1 + maxLength: 32767 + State: + description: The state in which a customer lives. + type: string + minLength: 1 + maxLength: 32767 + ShippingAddress1: + description: The first line of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingAddress2: + description: The second line of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingAddress3: + description: The third line of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingAddress4: + description: The fourth line of a customer’s shipping address + type: string + minLength: 1 + maxLength: 32767 + ShippingCity: + description: The city of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingCounty: + description: The county of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingCountry: + description: The country of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingPostalCode: + description: The postal code of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingProvince: + description: The province of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + ShippingState: + description: The state of a customer’s shipping address. + type: string + minLength: 1 + maxLength: 32767 + MailingAddress1: + description: The first line of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingAddress2: + description: The second line of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingAddress3: + description: The third line of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingAddress4: + description: The fourth line of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingCity: + description: The city of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingCounty: + description: The county of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingCountry: + description: The country of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingPostalCode: + description: The postal code of a customer’s mailing address + type: string + minLength: 1 + maxLength: 32767 + MailingProvince: + description: The province of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + MailingState: + description: The state of a customer’s mailing address. + type: string + minLength: 1 + maxLength: 32767 + BillingAddress1: + description: The first line of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingAddress2: + description: The second line of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingAddress3: + description: The third line of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingAddress4: + description: The fourth line of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingCity: + description: The city of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingCounty: + description: The county of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingCountry: + description: The country of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingPostalCode: + description: The postal code of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingProvince: + description: The province of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + BillingState: + description: The state of a customer’s billing address. + type: string + minLength: 1 + maxLength: 32767 + Custom: + $ref: '#/components/schemas/CustomAttributes' + additionalProperties: false + CustomAttributes: + description: The custom attributes that are used with the message template. + type: object + x-patternProperties: + ^[a-zA-Z0-9\s._:/=+@-]*$: + description: Value of a custom attribute. + type: string + minLength: 1 + maxLength: 32767 + additionalProperties: false + GroupingConfiguration: + description: The configuration information of the user groups that the quick response is accessible to. + type: object + properties: + Criteria: + description: The criteria used for grouping Amazon Q in Connect users. + type: string + minLength: 1 + maxLength: 100 + Values: + description: The list of values that define different groups of Amazon Q in Connect users. + type: array + items: + $ref: '#/components/schemas/GroupingValue' + x-insertionOrder: true + uniqueItems: true + required: + - Criteria + - Values + additionalProperties: false + GroupingValue: + description: The value that define the group of Amazon Q in Connect users. + type: string + minLength: 1 + maxLength: 2048 + AttachmentUrl: + description: 'The S3 Presigned URL for the attachment file. When generating the PreSignedUrl, please ensure that the expires-in time is set to 30 minutes. The URL can be generated through the AWS Console or through the AWS CLI (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html). ' + type: string + minLength: 1 + AttachmentName: + description: The name of the attachment file being uploaded. The name should include the file extension. + type: string + minLength: 1 + maxLength: 255 + MessageTemplateAttachment: + description: '' + type: object + properties: + AttachmentId: + type: string + minLength: 1 + AttachmentName: + $ref: '#/components/schemas/AttachmentName' + S3PresignedUrl: + $ref: '#/components/schemas/AttachmentUrl' + additionalProperties: false + required: + - AttachmentName + - S3PresignedUrl + MessageTemplate: + type: object + properties: + KnowledgeBaseArn: + description: The Amazon Resource Name (ARN) of the knowledge base to which the message template belongs. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + MessageTemplateId: + description: The unique identifier of the message template. + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + MessageTemplateArn: + description: The Amazon Resource Name (ARN) of the message template. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + Name: + description: The name of the message template. + type: string + pattern: ^[a-zA-Z0-9\\s_.,-]+ + minLength: 1 + maxLength: 255 + ChannelSubtype: + $ref: '#/components/schemas/ChannelSubtype' + Content: + $ref: '#/components/schemas/Content' + Description: + description: The description of the message template. + type: string + pattern: ^[a-zA-Z0-9\\s_.,-]+ + minLength: 1 + maxLength: 255 + Language: + description: The language code value for the language in which the message template is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW + type: string + minLength: 2 + maxLength: 5 + GroupingConfiguration: + $ref: '#/components/schemas/GroupingConfiguration' + DefaultAttributes: + $ref: '#/components/schemas/MessageTemplateAttributes' + MessageTemplateContentSha256: + description: The content SHA256 of the message template. + type: string + minLength: 1 + maxLength: 64 + MessageTemplateAttachments: + description: List of message template attachments + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/MessageTemplateAttachment' + Tags: + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.' + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + required: + - KnowledgeBaseArn + - ChannelSubtype + - Name + - Content + x-stackql-resource-name: message_template + description: Definition of AWS::Wisdom::MessageTemplate Resource Type + x-type-name: AWS::Wisdom::MessageTemplate + x-stackql-primary-identifier: + - MessageTemplateArn + x-create-only-properties: + - KnowledgeBaseArn + - ChannelSubtype + x-write-only-properties: + - MessageTemplateAttachments/*/S3PresignedUrl + x-read-only-properties: + - MessageTemplateId + - MessageTemplateArn + - MessageTemplateContentSha256 + - MessageTemplateAttachments/*/AttachmentId + x-required-properties: + - KnowledgeBaseArn + - ChannelSubtype + - Name + - Content + x-replacement-strategy: create_then_delete + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource + - wisdom:UntagResource + x-required-permissions: + create: + - wisdom:CreateMessageTemplate + - wisdom:GetMessageTemplate + - wisdom:TagResource + - connect:SearchRoutingProfiles + - connect:DescribeRoutingProfile + - wisdom:CreateMessageTemplateAttachment + - wisdom:DeleteMessageTemplateAttachment + update: + - wisdom:UpdateMessageTemplate + - wisdom:UpdateMessageTemplateMetadata + - wisdom:GetMessageTemplate + - wisdom:TagResource + - wisdom:UntagResource + - connect:SearchRoutingProfiles + - connect:DescribeRoutingProfile + - wisdom:CreateMessageTemplateAttachment + - wisdom:DeleteMessageTemplateAttachment + delete: + - wisdom:DeleteMessageTemplate + - wisdom:UntagResource + - wisdom:DeleteMessageTemplateAttachment + list: + - wisdom:ListMessageTemplates + read: + - wisdom:GetMessageTemplate + MessageTemplateVersion: + type: object + properties: + MessageTemplateArn: + description: The unqualified Amazon Resource Name (ARN) of the message template. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + MessageTemplateVersionArn: + description: The unqualified Amazon Resource Name (ARN) of the message template version. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}):[0-9]+?$ + MessageTemplateContentSha256: + description: The content SHA256 of the message template. + type: string + minLength: 1 + maxLength: 64 + MessageTemplateVersionNumber: + description: Current version number of the message template. + type: number + required: + - MessageTemplateArn + x-stackql-resource-name: message_template_version + description: A version for the specified customer-managed message template within the specified knowledge base. + x-type-name: AWS::Wisdom::MessageTemplateVersion + x-stackql-primary-identifier: + - MessageTemplateVersionArn + x-create-only-properties: + - MessageTemplateArn + x-conditional-create-only-properties: + - MessageTemplateContentSha256 + x-read-only-properties: + - MessageTemplateVersionNumber + - MessageTemplateVersionArn + x-required-properties: + - MessageTemplateArn + x-tagging: + taggable: false + x-required-permissions: + create: + - wisdom:CreateMessageTemplateVersion + - wisdom:ListMessageTemplateVersions + delete: + - wisdom:DeleteMessageTemplate + update: + - wisdom:CreateMessageTemplateVersion + list: + - wisdom:ListMessageTemplateVersions + read: + - wisdom:GetMessageTemplate + ChannelType: + type: string + enum: + - Chat + - Email + QuickResponseContentProvider: + description: The container of quick response content. + type: object + properties: + Content: + description: The content of the quick response. + type: string + minLength: 1 + maxLength: 1024 + additionalProperties: false + QuickResponseContents: + description: The content of the quick response stored in different media types. + type: object + properties: + Markdown: + $ref: '#/components/schemas/QuickResponseContentProvider' + PlainText: + $ref: '#/components/schemas/QuickResponseContentProvider' + additionalProperties: false + Status: + description: The status of the quick response data. + type: string + enum: + - CREATE_IN_PROGRESS + - CREATE_FAILED + - CREATED + - DELETE_IN_PROGRESS + - DELETE_FAILED + - DELETED + - UPDATE_IN_PROGRESS + - UPDATE_FAILED + QuickResponse: + type: object + properties: + ContentType: + description: |- + The media type of the quick response content. + - Use application/x.quickresponse;format=plain for quick response written in plain text. + - Use application/x.quickresponse;format=markdown for quick response written in richtext. + type: string + pattern: ^(application/x\.quickresponse;format=(plain|markdown))$ + KnowledgeBaseArn: + description: The Amazon Resource Name (ARN) of the knowledge base. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + Name: + description: The name of the quick response. + type: string + minLength: 1 + maxLength: 100 + QuickResponseArn: + description: The Amazon Resource Name (ARN) of the quick response. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + QuickResponseId: + description: The identifier of the quick response. + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Channels: + description: The Amazon Connect contact channels this quick response applies to. + type: array + items: + $ref: '#/components/schemas/ChannelType' + Content: + $ref: '#/components/schemas/QuickResponseContentProvider' + Contents: + $ref: '#/components/schemas/QuickResponseContents' + Description: + description: The description of the quick response. + type: string + minLength: 1 + maxLength: 255 + GroupingConfiguration: + $ref: '#/components/schemas/GroupingConfiguration' + IsActive: + description: Whether the quick response is active. + type: boolean + Language: + description: The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW + type: string + minLength: 2 + maxLength: 5 + ShortcutKey: + description: The shortcut key of the quick response. The value should be unique across the knowledge base. + type: string + minLength: 1 + maxLength: 100 + Status: + $ref: '#/components/schemas/Status' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - KnowledgeBaseArn + - Content + - Name + x-stackql-resource-name: quick_response + description: Definition of AWS::Wisdom::QuickResponse Resource Type. + x-type-name: AWS::Wisdom::QuickResponse + x-stackql-primary-identifier: + - QuickResponseArn + x-create-only-properties: + - KnowledgeBaseArn + x-read-only-properties: + - QuickResponseId + - QuickResponseArn + - Status + - Contents + x-required-properties: + - KnowledgeBaseArn + - Content + - Name + x-replacement-strategy: create_then_delete + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - wisdom:TagResource + - wisdom:UntagResource + x-required-permissions: + create: + - wisdom:CreateQuickResponse + - wisdom:GetQuickResponse + - wisdom:TagResource + - connect:SearchRoutingProfiles + - connect:DescribeRoutingProfile + update: + - wisdom:UpdateQuickResponse + - wisdom:GetQuickResponse + - wisdom:TagResource + - wisdom:UntagResource + - connect:SearchRoutingProfiles + - connect:DescribeRoutingProfile + delete: + - wisdom:DeleteQuickResponse + - wisdom:UntagResource + list: + - wisdom:ListQuickResponses + read: + - wisdom:GetQuickResponse + CreateAIAgentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AIAgentId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$ + AIAgentArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + Configuration: + $ref: '#/components/schemas/AIAgentConfiguration' + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + Tags: + $ref: '#/components/schemas/Tags' + Type: + $ref: '#/components/schemas/AIAgentType' + ModifiedTimeSeconds: + type: number + x-stackQL-stringOnly: true + x-title: CreateAIAgentRequest + type: object + required: [] + CreateAIAgentVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AIAgentArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AIAgentId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AIAgentVersionId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + VersionNumber: + type: number + ModifiedTimeSeconds: + type: number + x-stackQL-stringOnly: true + x-title: CreateAIAgentVersionRequest + type: object + required: [] + CreateAIGuardrailRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AIGuardrailArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AIGuardrailId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$ + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + BlockedInputMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + BlockedOutputsMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the guardrail or its version + TopicPolicyConfig: + $ref: '#/components/schemas/AIGuardrailTopicPolicyConfig' + ContentPolicyConfig: + $ref: '#/components/schemas/AIGuardrailContentPolicyConfig' + WordPolicyConfig: + $ref: '#/components/schemas/AIGuardrailWordPolicyConfig' + SensitiveInformationPolicyConfig: + $ref: '#/components/schemas/AIGuardrailSensitiveInformationPolicyConfig' + ContextualGroundingPolicyConfig: + $ref: '#/components/schemas/AIGuardrailContextualGroundingPolicyConfig' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateAIGuardrailRequest + type: object + required: [] + CreateAIGuardrailVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AIGuardrailArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AIGuardrailId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AIGuardrailVersionId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + VersionNumber: + type: number + ModifiedTimeSeconds: + type: number + x-stackQL-stringOnly: true + x-title: CreateAIGuardrailVersionRequest + type: object + required: [] + CreateAIPromptRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$ + AIPromptArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + ApiFormat: + $ref: '#/components/schemas/AIPromptAPIFormat' + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + Description: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + ModelId: + type: string + maxLength: 2048 + minLength: 1 + Name: + type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9\s_.,-]+ + Tags: + $ref: '#/components/schemas/Tags' + TemplateConfiguration: + $ref: '#/components/schemas/AIPromptTemplateConfiguration' + TemplateType: + $ref: '#/components/schemas/AIPromptTemplateType' + Type: + $ref: '#/components/schemas/AIPromptType' + ModifiedTimeSeconds: + type: number + x-stackQL-stringOnly: true + x-title: CreateAIPromptRequest + type: object + required: [] + CreateAIPromptVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AIPromptArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AIPromptId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AIPromptVersionId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$ + VersionNumber: + type: number + ModifiedTimeSeconds: + type: number + x-stackQL-stringOnly: true + x-title: CreateAIPromptVersionRequest + type: object + required: [] + CreateAssistantRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Type: + $ref: '#/components/schemas/AssistantType' + Description: + type: string + maxLength: 255 + minLength: 1 + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + Tags: + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + Name: + type: string + maxLength: 255 + minLength: 1 + x-stackQL-stringOnly: true + x-title: CreateAssistantRequest + type: object + required: [] + CreateAssistantAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssistantAssociationArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + AssistantAssociationId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + AssistantId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Association: + $ref: '#/components/schemas/AssociationData' + AssociationType: + $ref: '#/components/schemas/AssociationType' + Tags: + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + x-stackQL-stringOnly: true + x-title: CreateAssistantAssociationRequest + type: object + required: [] + CreateKnowledgeBaseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 255 + minLength: 1 + KnowledgeBaseArn: + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + KnowledgeBaseId: + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + KnowledgeBaseType: + $ref: '#/components/schemas/KnowledgeBaseType' + Name: + type: string + maxLength: 255 + minLength: 1 + RenderingConfiguration: + $ref: '#/components/schemas/RenderingConfiguration' + ServerSideEncryptionConfiguration: + $ref: '#/components/schemas/ServerSideEncryptionConfiguration' + SourceConfiguration: + $ref: '#/components/schemas/SourceConfiguration' + VectorIngestionConfiguration: + $ref: '#/components/schemas/VectorIngestionConfiguration' + Tags: + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + x-stackQL-stringOnly: true + x-title: CreateKnowledgeBaseRequest + type: object + required: [] + CreateMessageTemplateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + KnowledgeBaseArn: + description: The Amazon Resource Name (ARN) of the knowledge base to which the message template belongs. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + MessageTemplateId: + description: The unique identifier of the message template. + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + MessageTemplateArn: + description: The Amazon Resource Name (ARN) of the message template. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + Name: + description: The name of the message template. + type: string + pattern: ^[a-zA-Z0-9\\s_.,-]+ + minLength: 1 + maxLength: 255 + ChannelSubtype: + $ref: '#/components/schemas/ChannelSubtype' + Content: + $ref: '#/components/schemas/Content' + Description: + description: The description of the message template. + type: string + pattern: ^[a-zA-Z0-9\\s_.,-]+ + minLength: 1 + maxLength: 255 + Language: + description: The language code value for the language in which the message template is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW + type: string + minLength: 2 + maxLength: 5 + GroupingConfiguration: + $ref: '#/components/schemas/GroupingConfiguration' + DefaultAttributes: + $ref: '#/components/schemas/MessageTemplateAttributes' + MessageTemplateContentSha256: + description: The content SHA256 of the message template. + type: string + minLength: 1 + maxLength: 64 + MessageTemplateAttachments: + description: List of message template attachments + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/MessageTemplateAttachment' + Tags: + description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.' + x-insertionOrder: false + uniqueItems: true + items: + $ref: '#/components/schemas/Tag' + type: array + x-stackQL-stringOnly: true + x-title: CreateMessageTemplateRequest + type: object + required: [] + CreateMessageTemplateVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + MessageTemplateArn: + description: The unqualified Amazon Resource Name (ARN) of the message template. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$ + MessageTemplateVersionArn: + description: The unqualified Amazon Resource Name (ARN) of the message template version. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}):[0-9]+?$ + MessageTemplateContentSha256: + description: The content SHA256 of the message template. + type: string + minLength: 1 + maxLength: 64 + MessageTemplateVersionNumber: + description: Current version number of the message template. + type: number + x-stackQL-stringOnly: true + x-title: CreateMessageTemplateVersionRequest + type: object + required: [] + CreateQuickResponseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContentType: + description: |- + The media type of the quick response content. + - Use application/x.quickresponse;format=plain for quick response written in plain text. + - Use application/x.quickresponse;format=markdown for quick response written in richtext. + type: string + pattern: ^(application/x\.quickresponse;format=(plain|markdown))$ + KnowledgeBaseArn: + description: The Amazon Resource Name (ARN) of the knowledge base. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + Name: + description: The name of the quick response. + type: string + minLength: 1 + maxLength: 100 + QuickResponseArn: + description: The Amazon Resource Name (ARN) of the quick response. + type: string + pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$ + QuickResponseId: + description: The identifier of the quick response. + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + Channels: + description: The Amazon Connect contact channels this quick response applies to. + type: array + items: + $ref: '#/components/schemas/ChannelType' + Content: + $ref: '#/components/schemas/QuickResponseContentProvider' + Contents: + $ref: '#/components/schemas/QuickResponseContents' + Description: + description: The description of the quick response. + type: string + minLength: 1 + maxLength: 255 + GroupingConfiguration: + $ref: '#/components/schemas/GroupingConfiguration' + IsActive: + description: Whether the quick response is active. + type: boolean + Language: + description: The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW + type: string + minLength: 2 + maxLength: 5 + ShortcutKey: + description: The shortcut key of the quick response. The value should be unique across the knowledge base. + type: string + minLength: 1 + maxLength: 100 + Status: + $ref: '#/components/schemas/Status' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateQuickResponseRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + ai_agents: + name: ai_agents + id: awscc.wisdom.ai_agents + x-cfn-schema-name: AIAgent + x-cfn-type-name: AWS::Wisdom::AIAgent + x-identifiers: + - AIAgentId + - AssistantId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AIAgent&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIAgent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIAgent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIAgent" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ai_agents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ai_agents/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ai_agents/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AIAgentId') as a_iagent_id, + JSON_EXTRACT(Properties, '$.AIAgentArn') as a_iagent_arn, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AssistantArn') as assistant_arn, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIAgent' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AIAgentId') as a_iagent_id, + json_extract_path_text(Properties, 'AIAgentArn') as a_iagent_arn, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIAgent' + AND data__Identifier = '|' + AND region = 'us-east-1' + ai_agents_list_only: + name: ai_agents_list_only + id: awscc.wisdom.ai_agents_list_only + x-cfn-schema-name: AIAgent + x-cfn-type-name: AWS::Wisdom::AIAgent + x-identifiers: + - AIAgentId + - AssistantId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AIAgentId') as a_iagent_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIAgent' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AIAgentId') as a_iagent_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIAgent' + AND region = 'us-east-1' + ai_agent_versions: + name: ai_agent_versions + id: awscc.wisdom.ai_agent_versions + x-cfn-schema-name: AIAgentVersion + x-cfn-type-name: AWS::Wisdom::AIAgentVersion + x-identifiers: + - AssistantId + - AIAgentId + - VersionNumber + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AIAgentVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIAgentVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIAgentVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIAgentVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ai_agent_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ai_agent_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ai_agent_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AIAgentArn') as a_iagent_arn, + JSON_EXTRACT(Properties, '$.AssistantArn') as assistant_arn, + JSON_EXTRACT(Properties, '$.AIAgentId') as a_iagent_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AIAgentVersionId') as a_iagent_version_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number, + JSON_EXTRACT(Properties, '$.ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIAgentVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AIAgentArn') as a_iagent_arn, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'AIAgentId') as a_iagent_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AIAgentVersionId') as a_iagent_version_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number, + json_extract_path_text(Properties, 'ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIAgentVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + ai_agent_versions_list_only: + name: ai_agent_versions_list_only + id: awscc.wisdom.ai_agent_versions_list_only + x-cfn-schema-name: AIAgentVersion + x-cfn-type-name: AWS::Wisdom::AIAgentVersion + x-identifiers: + - AssistantId + - AIAgentId + - VersionNumber + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AIAgentId') as a_iagent_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIAgentVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AIAgentId') as a_iagent_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIAgentVersion' + AND region = 'us-east-1' + ai_guardrails: + name: ai_guardrails + id: awscc.wisdom.ai_guardrails + x-cfn-schema-name: AIGuardrail + x-cfn-type-name: AWS::Wisdom::AIGuardrail + x-identifiers: + - AIGuardrailId + - AssistantId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AIGuardrail&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIGuardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIGuardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIGuardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ai_guardrails/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ai_guardrails/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ai_guardrails/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AssistantArn') as assistant_arn, + JSON_EXTRACT(Properties, '$.AIGuardrailArn') as a_iguardrail_arn, + JSON_EXTRACT(Properties, '$.AIGuardrailId') as a_iguardrail_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.BlockedInputMessaging') as blocked_input_messaging, + JSON_EXTRACT(Properties, '$.BlockedOutputsMessaging') as blocked_outputs_messaging, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.TopicPolicyConfig') as topic_policy_config, + JSON_EXTRACT(Properties, '$.ContentPolicyConfig') as content_policy_config, + JSON_EXTRACT(Properties, '$.WordPolicyConfig') as word_policy_config, + JSON_EXTRACT(Properties, '$.SensitiveInformationPolicyConfig') as sensitive_information_policy_config, + JSON_EXTRACT(Properties, '$.ContextualGroundingPolicyConfig') as contextual_grounding_policy_config, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIGuardrail' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'AIGuardrailArn') as a_iguardrail_arn, + json_extract_path_text(Properties, 'AIGuardrailId') as a_iguardrail_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'BlockedInputMessaging') as blocked_input_messaging, + json_extract_path_text(Properties, 'BlockedOutputsMessaging') as blocked_outputs_messaging, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TopicPolicyConfig') as topic_policy_config, + json_extract_path_text(Properties, 'ContentPolicyConfig') as content_policy_config, + json_extract_path_text(Properties, 'WordPolicyConfig') as word_policy_config, + json_extract_path_text(Properties, 'SensitiveInformationPolicyConfig') as sensitive_information_policy_config, + json_extract_path_text(Properties, 'ContextualGroundingPolicyConfig') as contextual_grounding_policy_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIGuardrail' + AND data__Identifier = '|' + AND region = 'us-east-1' + ai_guardrails_list_only: + name: ai_guardrails_list_only + id: awscc.wisdom.ai_guardrails_list_only + x-cfn-schema-name: AIGuardrail + x-cfn-type-name: AWS::Wisdom::AIGuardrail + x-identifiers: + - AIGuardrailId + - AssistantId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AIGuardrailId') as a_iguardrail_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIGuardrail' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AIGuardrailId') as a_iguardrail_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIGuardrail' + AND region = 'us-east-1' + ai_guardrail_versions: + name: ai_guardrail_versions + id: awscc.wisdom.ai_guardrail_versions + x-cfn-schema-name: AIGuardrailVersion + x-cfn-type-name: AWS::Wisdom::AIGuardrailVersion + x-identifiers: + - AssistantId + - AIGuardrailId + - VersionNumber + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AIGuardrailVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIGuardrailVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIGuardrailVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIGuardrailVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ai_guardrail_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ai_guardrail_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ai_guardrail_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AIGuardrailArn') as a_iguardrail_arn, + JSON_EXTRACT(Properties, '$.AssistantArn') as assistant_arn, + JSON_EXTRACT(Properties, '$.AIGuardrailId') as a_iguardrail_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AIGuardrailVersionId') as a_iguardrail_version_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number, + JSON_EXTRACT(Properties, '$.ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIGuardrailVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AIGuardrailArn') as a_iguardrail_arn, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'AIGuardrailId') as a_iguardrail_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AIGuardrailVersionId') as a_iguardrail_version_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number, + json_extract_path_text(Properties, 'ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIGuardrailVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + ai_guardrail_versions_list_only: + name: ai_guardrail_versions_list_only + id: awscc.wisdom.ai_guardrail_versions_list_only + x-cfn-schema-name: AIGuardrailVersion + x-cfn-type-name: AWS::Wisdom::AIGuardrailVersion + x-identifiers: + - AssistantId + - AIGuardrailId + - VersionNumber + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AIGuardrailId') as a_iguardrail_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIGuardrailVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AIGuardrailId') as a_iguardrail_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIGuardrailVersion' + AND region = 'us-east-1' + ai_prompts: + name: ai_prompts + id: awscc.wisdom.ai_prompts + x-cfn-schema-name: AIPrompt + x-cfn-type-name: AWS::Wisdom::AIPrompt + x-identifiers: + - AIPromptId + - AssistantId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AIPrompt&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIPrompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIPrompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIPrompt" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ai_prompts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ai_prompts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ai_prompts/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AIPromptId') as a_iprompt_id, + JSON_EXTRACT(Properties, '$.AIPromptArn') as a_iprompt_arn, + JSON_EXTRACT(Properties, '$.ApiFormat') as api_format, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AssistantArn') as assistant_arn, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ModelId') as model_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TemplateConfiguration') as template_configuration, + JSON_EXTRACT(Properties, '$.TemplateType') as template_type, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIPrompt' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AIPromptId') as a_iprompt_id, + json_extract_path_text(Properties, 'AIPromptArn') as a_iprompt_arn, + json_extract_path_text(Properties, 'ApiFormat') as api_format, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ModelId') as model_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateConfiguration') as template_configuration, + json_extract_path_text(Properties, 'TemplateType') as template_type, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIPrompt' + AND data__Identifier = '|' + AND region = 'us-east-1' + ai_prompts_list_only: + name: ai_prompts_list_only + id: awscc.wisdom.ai_prompts_list_only + x-cfn-schema-name: AIPrompt + x-cfn-type-name: AWS::Wisdom::AIPrompt x-identifiers: + - AIPromptId - AssistantId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -285,28 +3922,206 @@ components: ddl: |- SELECT region, + JSON_EXTRACT(Properties, '$.AIPromptId') as a_iprompt_id, JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIPrompt' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, + json_extract_path_text(Properties, 'AIPromptId') as a_iprompt_id, json_extract_path_text(Properties, 'AssistantId') as assistant_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIPrompt' AND region = 'us-east-1' - assistant: - name: assistant - id: awscc.wisdom.assistant - x-cfn-schema-name: Assistant - x-type: get + ai_prompt_versions: + name: ai_prompt_versions + id: awscc.wisdom.ai_prompt_versions + x-cfn-schema-name: AIPromptVersion + x-cfn-type-name: AWS::Wisdom::AIPromptVersion + x-identifiers: + - AssistantId + - AIPromptId + - VersionNumber + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AIPromptVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIPromptVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIPromptVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AIPromptVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ai_prompt_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ai_prompt_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ai_prompt_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AIPromptArn') as a_iprompt_arn, + JSON_EXTRACT(Properties, '$.AssistantArn') as assistant_arn, + JSON_EXTRACT(Properties, '$.AIPromptId') as a_iprompt_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AIPromptVersionId') as a_iprompt_version_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number, + JSON_EXTRACT(Properties, '$.ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIPromptVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AIPromptArn') as a_iprompt_arn, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'AIPromptId') as a_iprompt_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AIPromptVersionId') as a_iprompt_version_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number, + json_extract_path_text(Properties, 'ModifiedTimeSeconds') as modified_time_seconds + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AIPromptVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + ai_prompt_versions_list_only: + name: ai_prompt_versions_list_only + id: awscc.wisdom.ai_prompt_versions_list_only + x-cfn-schema-name: AIPromptVersion + x-cfn-type-name: AWS::Wisdom::AIPromptVersion x-identifiers: - AssistantId + - AIPromptId + - VersionNumber + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id, + JSON_EXTRACT(Properties, '$.AIPromptId') as a_iprompt_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIPromptVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'AIPromptId') as a_iprompt_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AIPromptVersion' + AND region = 'us-east-1' + assistants: + name: assistants + id: awscc.wisdom.assistants + x-cfn-schema-name: Assistant + x-cfn-type-name: AWS::Wisdom::Assistant + x-identifiers: + - AssistantId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Assistant&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::Assistant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::Assistant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::Assistant" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assistants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assistants/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/assistants/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -322,7 +4137,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -337,14 +4152,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::Assistant' AND data__Identifier = '' AND region = 'us-east-1' - assistant_associations: - name: assistant_associations - id: awscc.wisdom.assistant_associations - x-cfn-schema-name: AssistantAssociation - x-type: list + assistants_list_only: + name: assistants_list_only + id: awscc.wisdom.assistants_list_only + x-cfn-schema-name: Assistant + x-cfn-type-name: AWS::Wisdom::Assistant x-identifiers: - - AssistantAssociationId - AssistantId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -352,31 +4172,77 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AssistantAssociationId') as assistant_association_id, JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AssistantAssociationId') as assistant_association_id, json_extract_path_text(Properties, 'AssistantId') as assistant_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' AND region = 'us-east-1' - assistant_association: - name: assistant_association - id: awscc.wisdom.assistant_association + assistant_associations: + name: assistant_associations + id: awscc.wisdom.assistant_associations x-cfn-schema-name: AssistantAssociation - x-type: get + x-cfn-type-name: AWS::Wisdom::AssistantAssociation x-identifiers: - AssistantAssociationId - AssistantId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__AssistantAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AssistantAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AssistantAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::AssistantAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -392,7 +4258,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -407,13 +4273,20 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' AND data__Identifier = '|' AND region = 'us-east-1' - knowledge_bases: - name: knowledge_bases - id: awscc.wisdom.knowledge_bases - x-cfn-schema-name: KnowledgeBase - x-type: list + assistant_associations_list_only: + name: assistant_associations_list_only + id: awscc.wisdom.assistant_associations_list_only + x-cfn-schema-name: AssistantAssociation + x-cfn-type-name: AWS::Wisdom::AssistantAssociation x-identifiers: - - KnowledgeBaseId + - AssistantAssociationId + - AssistantId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -421,28 +4294,78 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' + JSON_EXTRACT(Properties, '$.AssistantAssociationId') as assistant_association_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' + json_extract_path_text(Properties, 'AssistantAssociationId') as assistant_association_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' AND region = 'us-east-1' - knowledge_base: - name: knowledge_base - id: awscc.wisdom.knowledge_base + knowledge_bases: + name: knowledge_bases + id: awscc.wisdom.knowledge_bases x-cfn-schema-name: KnowledgeBase - x-type: get + x-cfn-type-name: AWS::Wisdom::KnowledgeBase x-identifiers: - KnowledgeBaseId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -455,12 +4378,13 @@ components: JSON_EXTRACT(Properties, '$.RenderingConfiguration') as rendering_configuration, JSON_EXTRACT(Properties, '$.ServerSideEncryptionConfiguration') as server_side_encryption_configuration, JSON_EXTRACT(Properties, '$.SourceConfiguration') as source_configuration, + JSON_EXTRACT(Properties, '$.VectorIngestionConfiguration') as vector_ingestion_configuration, JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -473,7 +4397,1078 @@ components: json_extract_path_text(Properties, 'RenderingConfiguration') as rendering_configuration, json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, + json_extract_path_text(Properties, 'VectorIngestionConfiguration') as vector_ingestion_configuration, json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' AND data__Identifier = '' AND region = 'us-east-1' + knowledge_bases_list_only: + name: knowledge_bases_list_only + id: awscc.wisdom.knowledge_bases_list_only + x-cfn-schema-name: KnowledgeBase + x-cfn-type-name: AWS::Wisdom::KnowledgeBase + x-identifiers: + - KnowledgeBaseId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' + AND region = 'us-east-1' + message_templates: + name: message_templates + id: awscc.wisdom.message_templates + x-cfn-schema-name: MessageTemplate + x-cfn-type-name: AWS::Wisdom::MessageTemplate + x-identifiers: + - MessageTemplateArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MessageTemplate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::MessageTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::MessageTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::MessageTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/message_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/message_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/message_templates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.KnowledgeBaseArn') as knowledge_base_arn, + JSON_EXTRACT(Properties, '$.MessageTemplateId') as message_template_id, + JSON_EXTRACT(Properties, '$.MessageTemplateArn') as message_template_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ChannelSubtype') as channel_subtype, + JSON_EXTRACT(Properties, '$.Content') as content, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Language') as language, + JSON_EXTRACT(Properties, '$.GroupingConfiguration') as grouping_configuration, + JSON_EXTRACT(Properties, '$.DefaultAttributes') as default_attributes, + JSON_EXTRACT(Properties, '$.MessageTemplateContentSha256') as message_template_content_sha256, + JSON_EXTRACT(Properties, '$.MessageTemplateAttachments') as message_template_attachments, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::MessageTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, + json_extract_path_text(Properties, 'MessageTemplateId') as message_template_id, + json_extract_path_text(Properties, 'MessageTemplateArn') as message_template_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ChannelSubtype') as channel_subtype, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Language') as language, + json_extract_path_text(Properties, 'GroupingConfiguration') as grouping_configuration, + json_extract_path_text(Properties, 'DefaultAttributes') as default_attributes, + json_extract_path_text(Properties, 'MessageTemplateContentSha256') as message_template_content_sha256, + json_extract_path_text(Properties, 'MessageTemplateAttachments') as message_template_attachments, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::MessageTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + message_templates_list_only: + name: message_templates_list_only + id: awscc.wisdom.message_templates_list_only + x-cfn-schema-name: MessageTemplate + x-cfn-type-name: AWS::Wisdom::MessageTemplate + x-identifiers: + - MessageTemplateArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.MessageTemplateArn') as message_template_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::MessageTemplate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MessageTemplateArn') as message_template_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::MessageTemplate' + AND region = 'us-east-1' + message_template_versions: + name: message_template_versions + id: awscc.wisdom.message_template_versions + x-cfn-schema-name: MessageTemplateVersion + x-cfn-type-name: AWS::Wisdom::MessageTemplateVersion + x-identifiers: + - MessageTemplateVersionArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__MessageTemplateVersion&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::MessageTemplateVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::MessageTemplateVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::MessageTemplateVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/message_template_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/message_template_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/message_template_versions/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.MessageTemplateArn') as message_template_arn, + JSON_EXTRACT(Properties, '$.MessageTemplateVersionArn') as message_template_version_arn, + JSON_EXTRACT(Properties, '$.MessageTemplateContentSha256') as message_template_content_sha256, + JSON_EXTRACT(Properties, '$.MessageTemplateVersionNumber') as message_template_version_number + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::MessageTemplateVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MessageTemplateArn') as message_template_arn, + json_extract_path_text(Properties, 'MessageTemplateVersionArn') as message_template_version_arn, + json_extract_path_text(Properties, 'MessageTemplateContentSha256') as message_template_content_sha256, + json_extract_path_text(Properties, 'MessageTemplateVersionNumber') as message_template_version_number + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::MessageTemplateVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + message_template_versions_list_only: + name: message_template_versions_list_only + id: awscc.wisdom.message_template_versions_list_only + x-cfn-schema-name: MessageTemplateVersion + x-cfn-type-name: AWS::Wisdom::MessageTemplateVersion + x-identifiers: + - MessageTemplateVersionArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.MessageTemplateVersionArn') as message_template_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::MessageTemplateVersion' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MessageTemplateVersionArn') as message_template_version_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::MessageTemplateVersion' + AND region = 'us-east-1' + quick_responses: + name: quick_responses + id: awscc.wisdom.quick_responses + x-cfn-schema-name: QuickResponse + x-cfn-type-name: AWS::Wisdom::QuickResponse + x-identifiers: + - QuickResponseArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__QuickResponse&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::QuickResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::QuickResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Wisdom::QuickResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/quick_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/quick_responses/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/quick_responses/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ContentType') as content_type, + JSON_EXTRACT(Properties, '$.KnowledgeBaseArn') as knowledge_base_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.QuickResponseArn') as quick_response_arn, + JSON_EXTRACT(Properties, '$.QuickResponseId') as quick_response_id, + JSON_EXTRACT(Properties, '$.Channels') as channels, + JSON_EXTRACT(Properties, '$.Content') as content, + JSON_EXTRACT(Properties, '$.Contents') as contents, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.GroupingConfiguration') as grouping_configuration, + JSON_EXTRACT(Properties, '$.IsActive') as is_active, + JSON_EXTRACT(Properties, '$.Language') as language, + JSON_EXTRACT(Properties, '$.ShortcutKey') as shortcut_key, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::QuickResponse' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'QuickResponseArn') as quick_response_arn, + json_extract_path_text(Properties, 'QuickResponseId') as quick_response_id, + json_extract_path_text(Properties, 'Channels') as channels, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Contents') as contents, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'GroupingConfiguration') as grouping_configuration, + json_extract_path_text(Properties, 'IsActive') as is_active, + json_extract_path_text(Properties, 'Language') as language, + json_extract_path_text(Properties, 'ShortcutKey') as shortcut_key, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::QuickResponse' + AND data__Identifier = '' + AND region = 'us-east-1' + quick_responses_list_only: + name: quick_responses_list_only + id: awscc.wisdom.quick_responses_list_only + x-cfn-schema-name: QuickResponse + x-cfn-type-name: AWS::Wisdom::QuickResponse + x-identifiers: + - QuickResponseArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.QuickResponseArn') as quick_response_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::QuickResponse' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QuickResponseArn') as quick_response_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::QuickResponse' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AIAgent&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAIAgent + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAIAgentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AIAgentVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAIAgentVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAIAgentVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AIGuardrail&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAIGuardrail + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAIGuardrailRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AIGuardrailVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAIGuardrailVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAIGuardrailVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AIPrompt&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAIPrompt + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAIPromptRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AIPromptVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAIPromptVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAIPromptVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Assistant&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssistant + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssistantRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__AssistantAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAssistantAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAssistantAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKnowledgeBase + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKnowledgeBaseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MessageTemplate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMessageTemplate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMessageTemplateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__MessageTemplateVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateMessageTemplateVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateMessageTemplateVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__QuickResponse&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateQuickResponse + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateQuickResponseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/workspaces.yaml b/providers/src/awscc/v00.00.00000/services/workspaces.yaml index 41751676..e4f214f4 100644 --- a/providers/src/awscc/v00.00.00000/services/workspaces.yaml +++ b/providers/src/awscc/v00.00.00000/services/workspaces.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: WorkSpaces - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: ConnectionAliasAssociation: type: object @@ -31,15 +411,15 @@ components: pattern: ^[a-zA-Z0-9]+$ Tag: type: object - additionalProperties: false properties: Key: type: string Value: type: string required: - - Value - Key + - Value + additionalProperties: false ConnectionAlias: type: object properties: @@ -47,6 +427,7 @@ components: type: array maxLength: 25 minLength: 1 + x-insertionOrder: false items: $ref: '#/components/schemas/ConnectionAliasAssociation' AliasId: @@ -68,12 +449,15 @@ components: Tags: type: array uniqueItems: false + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - ConnectionString x-stackql-resource-name: connection_alias - x-stackql-primaryIdentifier: + description: Resource Type definition for AWS::WorkSpaces::ConnectionAlias + x-type-name: AWS::WorkSpaces::ConnectionAlias + x-stackql-primary-identifier: - AliasId x-create-only-properties: - ConnectionString @@ -82,25 +466,327 @@ components: - ConnectionAliasState - AliasId - Associations + x-required-properties: + - ConnectionString + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - workspaces:CreateTags + - workspaces:DescribeTags x-required-permissions: create: - workspaces:CreateConnectionAlias + - workspaces:CreateTags + - workspaces:DescribeConnectionAliases + - workspaces:DescribeTags read: - workspaces:DescribeConnectionAliases + - workspaces:DescribeTags delete: - workspaces:DeleteConnectionAlias + - workspaces:DeleteTags + - workspaces:DescribeTags + - workspaces:DescribeConnectionAliases + ApplicationSettingsStatus: + type: string + enum: + - DISABLED + - ENABLED + RunningMode: + type: string + enum: + - ALWAYS_ON + - AUTO_STOP + Capacity: + type: object + properties: + DesiredUserSessions: + type: integer + minimum: 0 + required: + - DesiredUserSessions + additionalProperties: false + ApplicationSettings: + type: object + properties: + Status: + $ref: '#/components/schemas/ApplicationSettingsStatus' + SettingsGroup: + type: string + pattern: ^[A-Za-z0-9_./()!*'-]+$ + maxLength: 100 + required: + - Status + additionalProperties: false + TimeoutSettings: + type: object + properties: + DisconnectTimeoutInSeconds: + type: integer + minimum: 60 + maximum: 36000 + IdleDisconnectTimeoutInSeconds: + type: integer + minimum: 0 + maximum: 36000 + MaxUserDurationInSeconds: + type: integer + minimum: 600 + maximum: 432000 + required: [] + additionalProperties: false + WorkspacesPool: + type: object + properties: + PoolId: + type: string + pattern: ^wspool-[0-9a-z]{9}$ + PoolArn: + type: string + pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$ + Capacity: + $ref: '#/components/schemas/Capacity' + PoolName: + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$ + Description: + type: string + pattern: ^[a-zA-Z0-9_./() -]+$ + minLength: 1 + maxLength: 255 + CreatedAt: + type: string + BundleId: + type: string + pattern: ^wsb-[0-9a-z]{8,63}$ + DirectoryId: + type: string + pattern: ^wsd-[0-9a-z]{8,63}$ + minLength: 10 + maxLength: 65 + ApplicationSettings: + $ref: '#/components/schemas/ApplicationSettings' + TimeoutSettings: + $ref: '#/components/schemas/TimeoutSettings' + RunningMode: + $ref: '#/components/schemas/RunningMode' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - PoolName + - BundleId + - DirectoryId + - Capacity + x-stackql-resource-name: workspaces_pool + description: Resource Type definition for AWS::WorkSpaces::WorkspacesPool + x-type-name: AWS::WorkSpaces::WorkspacesPool + x-stackql-primary-identifier: + - PoolId + x-create-only-properties: + - PoolName + x-read-only-properties: + - PoolId + - PoolArn + - CreatedAt + x-required-properties: + - PoolName + - BundleId + - DirectoryId + - Capacity + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - workspaces:CreateTags + - workspaces:DescribeTags + - workspaces:DeleteTags + x-required-permissions: + create: + - workspaces:CreateWorkspacesPool + - workspaces:DescribeWorkspacesPools + - workspaces:CreateTags + read: + - workspaces:DescribeWorkspacesPools + - workspaces:DescribeTags + update: + - workspaces:UpdateWorkspacesPool + - workspaces:CreateTags + - workspaces:DeleteTags + - workspaces:DescribeWorkspacesPools + - workspaces:DescribeTags + delete: + - workspaces:DescribeWorkspacesPools + - workspaces:TerminateWorkspacesPool + - workspaces:DeleteTags + list: + - workspaces:DescribeWorkspacesPools + - workspaces:DescribeTags + CreateConnectionAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Associations: + type: array + maxLength: 25 + minLength: 1 + x-insertionOrder: false + items: + $ref: '#/components/schemas/ConnectionAliasAssociation' + AliasId: + type: string + pattern: ^wsca-[0-9a-z]{8,63}$ + maxLength: 68 + minLength: 13 + ConnectionString: + type: string + pattern: ^[.0-9a-zA-Z\-]{1,255}$ + minLength: 1 + maxLength: 255 + ConnectionAliasState: + type: string + enum: + - CREATING + - CREATED + - DELETING + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateConnectionAliasRequest + type: object + required: [] + CreateWorkspacesPoolRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PoolId: + type: string + pattern: ^wspool-[0-9a-z]{9}$ + PoolArn: + type: string + pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$ + Capacity: + $ref: '#/components/schemas/Capacity' + PoolName: + type: string + pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$ + Description: + type: string + pattern: ^[a-zA-Z0-9_./() -]+$ + minLength: 1 + maxLength: 255 + CreatedAt: + type: string + BundleId: + type: string + pattern: ^wsb-[0-9a-z]{8,63}$ + DirectoryId: + type: string + pattern: ^wsd-[0-9a-z]{8,63}$ + minLength: 10 + maxLength: 65 + ApplicationSettings: + $ref: '#/components/schemas/ApplicationSettings' + TimeoutSettings: + $ref: '#/components/schemas/TimeoutSettings' + RunningMode: + $ref: '#/components/schemas/RunningMode' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateWorkspacesPoolRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - connection_alias: - name: connection_alias - id: awscc.workspaces.connection_alias + connection_aliases: + name: connection_aliases + id: awscc.workspaces.connection_aliases x-cfn-schema-name: ConnectionAlias - x-type: get + x-cfn-type-name: AWS::WorkSpaces::ConnectionAlias x-identifiers: - AliasId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConnectionAlias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpaces::ConnectionAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpaces::ConnectionAlias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connection_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connection_aliases/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -114,7 +800,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -127,3 +813,370 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpaces::ConnectionAlias' AND data__Identifier = '' AND region = 'us-east-1' + workspaces_pools: + name: workspaces_pools + id: awscc.workspaces.workspaces_pools + x-cfn-schema-name: WorkspacesPool + x-cfn-type-name: AWS::WorkSpaces::WorkspacesPool + x-identifiers: + - PoolId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WorkspacesPool&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpaces::WorkspacesPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpaces::WorkspacesPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpaces::WorkspacesPool" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces_pools/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workspaces_pools/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PoolId') as pool_id, + JSON_EXTRACT(Properties, '$.PoolArn') as pool_arn, + JSON_EXTRACT(Properties, '$.Capacity') as capacity, + JSON_EXTRACT(Properties, '$.PoolName') as pool_name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.BundleId') as bundle_id, + JSON_EXTRACT(Properties, '$.DirectoryId') as directory_id, + JSON_EXTRACT(Properties, '$.ApplicationSettings') as application_settings, + JSON_EXTRACT(Properties, '$.TimeoutSettings') as timeout_settings, + JSON_EXTRACT(Properties, '$.RunningMode') as running_mode, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpaces::WorkspacesPool' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PoolId') as pool_id, + json_extract_path_text(Properties, 'PoolArn') as pool_arn, + json_extract_path_text(Properties, 'Capacity') as capacity, + json_extract_path_text(Properties, 'PoolName') as pool_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'BundleId') as bundle_id, + json_extract_path_text(Properties, 'DirectoryId') as directory_id, + json_extract_path_text(Properties, 'ApplicationSettings') as application_settings, + json_extract_path_text(Properties, 'TimeoutSettings') as timeout_settings, + json_extract_path_text(Properties, 'RunningMode') as running_mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpaces::WorkspacesPool' + AND data__Identifier = '' + AND region = 'us-east-1' + workspaces_pools_list_only: + name: workspaces_pools_list_only + id: awscc.workspaces.workspaces_pools_list_only + x-cfn-schema-name: WorkspacesPool + x-cfn-type-name: AWS::WorkSpaces::WorkspacesPool + x-identifiers: + - PoolId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.PoolId') as pool_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpaces::WorkspacesPool' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PoolId') as pool_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpaces::WorkspacesPool' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ConnectionAlias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnectionAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectionAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WorkspacesPool&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkspacesPool + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkspacesPoolRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/workspacesinstances.yaml b/providers/src/awscc/v00.00.00000/services/workspacesinstances.yaml new file mode 100644 index 00000000..138afb02 --- /dev/null +++ b/providers/src/awscc/v00.00.00000/services/workspacesinstances.yaml @@ -0,0 +1,1872 @@ +openapi: 3.0.0 +info: + title: WorkspacesInstances + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + type: object + properties: + Key: + type: string + minLength: 1 + maxLength: 128 + Value: + type: string + maxLength: 256 + required: + - Key + additionalProperties: false + TagSpecification: + type: object + properties: + ResourceType: + type: string + enum: + - instance + - volume + - spot-instances-request + - network-interface + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 30 + additionalProperties: false + Volume: + type: object + properties: + VolumeId: + type: string + description: Unique identifier for the volume + pattern: ^vol-[0-9a-zA-Z]{1,63}$ + AvailabilityZone: + type: string + description: The Availability Zone in which to create the volume + pattern: ^[a-z]{2}-[a-z]+-\d[a-z](-[a-z0-9]+)?$ + Encrypted: + type: boolean + description: Indicates whether the volume should be encrypted + Iops: + type: integer + description: The number of I/O operations per second (IOPS) + minimum: 0 + KmsKeyId: + type: string + description: The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption + maxLength: 128 + SizeInGB: + type: integer + description: The size of the volume, in GiBs + minimum: 0 + SnapshotId: + type: string + description: The snapshot from which to create the volume + pattern: ^snap-[0-9a-zA-Z]{1,63}$ + Throughput: + type: integer + description: The throughput to provision for a volume, with a maximum of 1,000 MiB/s + minimum: 0 + VolumeType: + type: string + description: The volume type + enum: + - standard + - io1 + - io2 + - gp2 + - sc1 + - st1 + - gp3 + TagSpecifications: + type: array + items: + $ref: '#/components/schemas/TagSpecification' + description: The tags passed to EBS volume + maxItems: 30 + required: + - AvailabilityZone + x-stackql-resource-name: volume + description: Resource Type definition for AWS::WorkspacesInstances::Volume - Manages WorkSpaces Volume resources + x-type-name: AWS::WorkspacesInstances::Volume + x-stackql-primary-identifier: + - VolumeId + x-create-only-properties: + - AvailabilityZone + - Encrypted + - Iops + - KmsKeyId + - SizeInGB + - SnapshotId + - Throughput + - VolumeType + - TagSpecifications + x-read-only-properties: + - VolumeId + x-required-properties: + - AvailabilityZone + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - workspaces-instances:CreateVolume + - ec2:CreateVolume + - ec2:CreateTags + read: + - ec2:DescribeVolumes + delete: + - workspaces-instances:DeleteVolume + - ec2:DescribeVolumes + - ec2:DeleteVolume + list: + - ec2:DescribeVolumes + VolumeAssociation: + type: object + properties: + WorkspaceInstanceId: + type: string + description: ID of the workspace instance to associate with the volume + pattern: ^wsinst-[0-9a-zA-Z]{8,63}$ + VolumeId: + type: string + description: ID of the volume to attach to the workspace instance + pattern: ^vol-[0-9a-zA-Z]{1,63}$ + Device: + type: string + description: The device name for the volume attachment + maxLength: 32 + DisassociateMode: + type: string + description: Mode to use when disassociating the volume + enum: + - FORCE + - NO_FORCE + required: + - WorkspaceInstanceId + - VolumeId + - Device + x-stackql-resource-name: volume_association + description: Resource Type definition for AWS::WorkspacesInstances::VolumeAssociation + x-type-name: AWS::WorkspacesInstances::VolumeAssociation + x-stackql-primary-identifier: + - WorkspaceInstanceId + - VolumeId + - Device + x-create-only-properties: + - WorkspaceInstanceId + - VolumeId + - Device + x-write-only-properties: + - DisassociateMode + x-required-properties: + - WorkspaceInstanceId + - VolumeId + - Device + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:DescribeVolumes + - ec2:AttachVolume + - workspaces-instances:GetWorkspaceInstance + - workspaces-instances:AssociateVolume + read: + - ec2:DescribeVolumes + - workspaces-instances:GetWorkspaceInstance + delete: + - ec2:DescribeVolumes + - ec2:DetachVolume + - workspaces-instances:GetWorkspaceInstance + - workspaces-instances:DisassociateVolume + list: + - ec2:DescribeVolumes + - workspaces-instances:ListWorkspaceInstances + BlockDeviceMapping: + type: object + properties: + DeviceName: + type: string + maxLength: 32 + Ebs: + $ref: '#/components/schemas/EbsBlockDevice' + NoDevice: + type: string + maxLength: 32 + VirtualName: + type: string + pattern: ^ephemeral(0|[1-9][0-9]{0,2})$ + additionalProperties: false + EbsBlockDevice: + type: object + properties: + VolumeType: + type: string + enum: + - standard + - io1 + - io2 + - gp2 + - sc1 + - st1 + - gp3 + Encrypted: + type: boolean + KmsKeyId: + type: string + maxLength: 128 + Iops: + type: integer + minimum: 0 + Throughput: + type: integer + minimum: 0 + VolumeSize: + type: integer + minimum: 0 + additionalProperties: false + CapacityReservationSpecification: + type: object + properties: + CapacityReservationPreference: + type: string + enum: + - capacity-reservations-only + - open + - none + CapacityReservationTarget: + $ref: '#/components/schemas/CapacityReservationTarget' + additionalProperties: false + CapacityReservationTarget: + type: object + properties: + CapacityReservationId: + type: string + maxLength: 128 + CapacityReservationResourceGroupArn: + type: string + pattern: ^arn:.* + additionalProperties: false + CpuOptionsRequest: + type: object + properties: + CoreCount: + type: integer + minimum: 0 + ThreadsPerCore: + type: integer + minimum: 0 + additionalProperties: false + CreditSpecificationRequest: + type: object + properties: + CpuCredits: + type: string + enum: + - standard + - unlimited + additionalProperties: false + EnclaveOptionsRequest: + type: object + properties: + Enabled: + type: boolean + additionalProperties: false + HibernationOptionsRequest: + type: object + properties: + Configured: + type: boolean + additionalProperties: false + IamInstanceProfileSpecification: + type: object + properties: + Arn: + type: string + pattern: ^arn:.* + maxLength: 2048 + Name: + type: string + maxLength: 64 + additionalProperties: false + InstanceMarketOptionsRequest: + type: object + properties: + MarketType: + type: string + enum: + - spot + - capacity-block + SpotOptions: + $ref: '#/components/schemas/SpotMarketOptions' + additionalProperties: false + SpotMarketOptions: + type: object + properties: + InstanceInterruptionBehavior: + type: string + enum: + - hibernate + - stop + MaxPrice: + type: string + maxLength: 64 + SpotInstanceType: + type: string + enum: + - one-time + - persistent + ValidUntilUtc: + type: string + maxLength: 64 + additionalProperties: false + ConnectionTrackingSpecificationRequest: + type: object + properties: + TcpEstablishedTimeout: + type: integer + UdpStreamTimeout: + type: integer + UdpTimeout: + type: integer + additionalProperties: false + EnaSrdSpecificationRequest: + type: object + properties: + EnaSrdEnabled: + type: boolean + EnaSrdUdpSpecification: + $ref: '#/components/schemas/EnaSrdUdpSpecificationRequest' + additionalProperties: false + EnaSrdUdpSpecificationRequest: + type: object + properties: + EnaSrdUdpEnabled: + type: boolean + additionalProperties: false + InstanceIpv6Address: + type: object + properties: + Ipv6Address: + type: string + maxLength: 128 + IsPrimaryIpv6: + type: boolean + additionalProperties: false + Ipv4PrefixSpecificationRequest: + type: object + properties: + Ipv4Prefix: + type: string + maxLength: 128 + additionalProperties: false + Ipv6PrefixSpecificationRequest: + type: object + properties: + Ipv6Prefix: + type: string + maxLength: 128 + additionalProperties: false + PrivateIpAddressSpecification: + type: object + properties: + PrivateIpAddress: + type: string + maxLength: 128 + Primary: + type: boolean + additionalProperties: false + LicenseConfigurationRequest: + type: object + properties: + LicenseConfigurationArn: + type: string + pattern: ^arn:.* + additionalProperties: false + InstanceMaintenanceOptionsRequest: + type: object + properties: + AutoRecovery: + type: string + enum: + - disabled + - default + additionalProperties: false + InstanceMetadataOptionsRequest: + type: object + properties: + HttpEndpoint: + type: string + enum: + - enabled + - disabled + HttpProtocolIpv6: + type: string + enum: + - enabled + - disabled + HttpPutResponseHopLimit: + type: integer + minimum: 1 + maximum: 64 + HttpTokens: + type: string + enum: + - optional + - required + InstanceMetadataTags: + type: string + enum: + - enabled + - disabled + additionalProperties: false + RunInstancesMonitoringEnabled: + type: object + properties: + Enabled: + type: boolean + additionalProperties: false + InstanceNetworkInterfaceSpecification: + type: object + properties: + Description: + type: string + maxLength: 1000 + pattern: ^[\S\s]*$ + DeviceIndex: + type: integer + minimum: 0 + Groups: + type: array + items: + type: string + pattern: ^sg-[0-9a-zA-Z]{1,63}$ + SubnetId: + type: string + pattern: ^subnet-[0-9a-zA-Z]{1,63}$ + additionalProperties: false + InstanceNetworkPerformanceOptionsRequest: + type: object + properties: + BandwidthWeighting: + type: string + enum: + - default + - vpc-1 + - ebs-1 + additionalProperties: false + Placement: + type: object + properties: + AvailabilityZone: + type: string + pattern: ^[a-z]{2}-[a-z]+-\d[a-z](-[a-z0-9]+)?$ + GroupId: + type: string + pattern: ^pg-[0-9a-zA-Z]{1,63}$ + GroupName: + type: string + maxLength: 255 + PartitionNumber: + type: integer + Tenancy: + type: string + enum: + - default + - dedicated + - host + additionalProperties: false + PrivateDnsNameOptionsRequest: + type: object + properties: + HostnameType: + type: string + enum: + - ip-name + - resource-name + EnableResourceNameDnsARecord: + type: boolean + EnableResourceNameDnsAAAARecord: + type: boolean + additionalProperties: false + EC2ManagedInstance: + type: object + properties: + InstanceId: + type: string + additionalProperties: false + WorkspaceInstance: + type: object + properties: + ManagedInstance: + type: object + properties: + BlockDeviceMappings: + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' + CapacityReservationSpecification: + $ref: '#/components/schemas/CapacityReservationSpecification' + CpuOptions: + $ref: '#/components/schemas/CpuOptionsRequest' + CreditSpecification: + $ref: '#/components/schemas/CreditSpecificationRequest' + DisableApiStop: + type: boolean + EbsOptimized: + type: boolean + EnablePrimaryIpv6: + type: boolean + EnclaveOptions: + $ref: '#/components/schemas/EnclaveOptionsRequest' + HibernationOptions: + $ref: '#/components/schemas/HibernationOptionsRequest' + IamInstanceProfile: + $ref: '#/components/schemas/IamInstanceProfileSpecification' + ImageId: + type: string + pattern: ^ami-[0-9a-zA-Z]{1,63}$ + InstanceMarketOptions: + $ref: '#/components/schemas/InstanceMarketOptionsRequest' + InstanceType: + type: string + pattern: ^([a-z0-9-]+)\.([a-z0-9]+)$ + Ipv6AddressCount: + type: integer + minimum: 0 + KeyName: + type: string + maxLength: 64 + LicenseSpecifications: + type: array + items: + $ref: '#/components/schemas/LicenseConfigurationRequest' + MaintenanceOptions: + $ref: '#/components/schemas/InstanceMaintenanceOptionsRequest' + MetadataOptions: + $ref: '#/components/schemas/InstanceMetadataOptionsRequest' + Monitoring: + $ref: '#/components/schemas/RunInstancesMonitoringEnabled' + NetworkInterfaces: + type: array + items: + $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification' + NetworkPerformanceOptions: + $ref: '#/components/schemas/InstanceNetworkPerformanceOptionsRequest' + Placement: + $ref: '#/components/schemas/Placement' + PrivateDnsNameOptions: + $ref: '#/components/schemas/PrivateDnsNameOptionsRequest' + SubnetId: + type: string + pattern: ^subnet-[0-9a-zA-Z]{1,63}$ + TagSpecifications: + type: array + maxItems: 30 + items: + $ref: '#/components/schemas/TagSpecification' + UserData: + type: string + maxLength: 16000 + required: + - ImageId + - InstanceType + additionalProperties: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 30 + WorkspaceInstanceId: + type: string + description: Unique identifier for the workspace instance + pattern: ^wsinst-[0-9a-zA-Z]{8,63}$ + ProvisionState: + type: string + description: The current state of the workspace instance + enum: + - ALLOCATING + - ALLOCATED + - DEALLOCATING + - DEALLOCATED + - ERROR_ALLOCATING + - ERROR_DEALLOCATING + EC2ManagedInstance: + $ref: '#/components/schemas/EC2ManagedInstance' + required: [] + x-stackql-resource-name: workspace_instance + description: Resource Type definition for AWS::WorkspacesInstances::WorkspaceInstance + x-type-name: AWS::WorkspacesInstances::WorkspaceInstance + x-stackql-primary-identifier: + - WorkspaceInstanceId + x-create-only-properties: + - ManagedInstance + x-conditional-create-only-properties: + - Tags + x-write-only-properties: + - ManagedInstance + x-read-only-properties: + - WorkspaceInstanceId + - ProvisionState + - EC2ManagedInstance + - EC2ManagedInstance/InstanceId + x-required-properties: [] + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - workspaces-instances:TagResource + - workspaces-instances:UntagResource + - workspaces-instances:ListTagsForResource + x-required-permissions: + create: + - workspaces-instances:CreateWorkspaceInstance + - workspaces-instances:GetWorkspaceInstance + - workspaces-instances:TagResource + - ec2:RunInstances + - ec2:DescribeInstances + - ec2:DescribeInstanceStatus + - ec2:CreateTags + - iam:PassRole + read: + - workspaces-instances:GetWorkspaceInstance + - workspaces-instances:ListTagsForResource + update: + - workspaces-instances:TagResource + - workspaces-instances:UntagResource + - workspaces-instances:ListTagsForResource + - workspaces-instances:GetWorkspaceInstance + delete: + - workspaces-instances:DeleteWorkspaceInstance + - workspaces-instances:GetWorkspaceInstance + - ec2:TerminateInstances + - ec2:DescribeInstances + - ec2:DescribeInstanceStatus + list: + - workspaces-instances:ListWorkspaceInstances + CreateVolumeRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + VolumeId: + type: string + description: Unique identifier for the volume + pattern: ^vol-[0-9a-zA-Z]{1,63}$ + AvailabilityZone: + type: string + description: The Availability Zone in which to create the volume + pattern: ^[a-z]{2}-[a-z]+-\d[a-z](-[a-z0-9]+)?$ + Encrypted: + type: boolean + description: Indicates whether the volume should be encrypted + Iops: + type: integer + description: The number of I/O operations per second (IOPS) + minimum: 0 + KmsKeyId: + type: string + description: The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption + maxLength: 128 + SizeInGB: + type: integer + description: The size of the volume, in GiBs + minimum: 0 + SnapshotId: + type: string + description: The snapshot from which to create the volume + pattern: ^snap-[0-9a-zA-Z]{1,63}$ + Throughput: + type: integer + description: The throughput to provision for a volume, with a maximum of 1,000 MiB/s + minimum: 0 + VolumeType: + type: string + description: The volume type + enum: + - standard + - io1 + - io2 + - gp2 + - sc1 + - st1 + - gp3 + TagSpecifications: + type: array + items: + $ref: '#/components/schemas/TagSpecification' + description: The tags passed to EBS volume + maxItems: 30 + x-stackQL-stringOnly: true + x-title: CreateVolumeRequest + type: object + required: [] + CreateVolumeAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + WorkspaceInstanceId: + type: string + description: ID of the workspace instance to associate with the volume + pattern: ^wsinst-[0-9a-zA-Z]{8,63}$ + VolumeId: + type: string + description: ID of the volume to attach to the workspace instance + pattern: ^vol-[0-9a-zA-Z]{1,63}$ + Device: + type: string + description: The device name for the volume attachment + maxLength: 32 + DisassociateMode: + type: string + description: Mode to use when disassociating the volume + enum: + - FORCE + - NO_FORCE + x-stackQL-stringOnly: true + x-title: CreateVolumeAssociationRequest + type: object + required: [] + CreateWorkspaceInstanceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ManagedInstance: + type: object + properties: + BlockDeviceMappings: + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' + CapacityReservationSpecification: + $ref: '#/components/schemas/CapacityReservationSpecification' + CpuOptions: + $ref: '#/components/schemas/CpuOptionsRequest' + CreditSpecification: + $ref: '#/components/schemas/CreditSpecificationRequest' + DisableApiStop: + type: boolean + EbsOptimized: + type: boolean + EnablePrimaryIpv6: + type: boolean + EnclaveOptions: + $ref: '#/components/schemas/EnclaveOptionsRequest' + HibernationOptions: + $ref: '#/components/schemas/HibernationOptionsRequest' + IamInstanceProfile: + $ref: '#/components/schemas/IamInstanceProfileSpecification' + ImageId: + type: string + pattern: ^ami-[0-9a-zA-Z]{1,63}$ + InstanceMarketOptions: + $ref: '#/components/schemas/InstanceMarketOptionsRequest' + InstanceType: + type: string + pattern: ^([a-z0-9-]+)\.([a-z0-9]+)$ + Ipv6AddressCount: + type: integer + minimum: 0 + KeyName: + type: string + maxLength: 64 + LicenseSpecifications: + type: array + items: + $ref: '#/components/schemas/LicenseConfigurationRequest' + MaintenanceOptions: + $ref: '#/components/schemas/InstanceMaintenanceOptionsRequest' + MetadataOptions: + $ref: '#/components/schemas/InstanceMetadataOptionsRequest' + Monitoring: + $ref: '#/components/schemas/RunInstancesMonitoringEnabled' + NetworkInterfaces: + type: array + items: + $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification' + NetworkPerformanceOptions: + $ref: '#/components/schemas/InstanceNetworkPerformanceOptionsRequest' + Placement: + $ref: '#/components/schemas/Placement' + PrivateDnsNameOptions: + $ref: '#/components/schemas/PrivateDnsNameOptionsRequest' + SubnetId: + type: string + pattern: ^subnet-[0-9a-zA-Z]{1,63}$ + TagSpecifications: + type: array + maxItems: 30 + items: + $ref: '#/components/schemas/TagSpecification' + UserData: + type: string + maxLength: 16000 + required: + - ImageId + - InstanceType + additionalProperties: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 30 + WorkspaceInstanceId: + type: string + description: Unique identifier for the workspace instance + pattern: ^wsinst-[0-9a-zA-Z]{8,63}$ + ProvisionState: + type: string + description: The current state of the workspace instance + enum: + - ALLOCATING + - ALLOCATED + - DEALLOCATING + - DEALLOCATED + - ERROR_ALLOCATING + - ERROR_DEALLOCATING + EC2ManagedInstance: + $ref: '#/components/schemas/EC2ManagedInstance' + x-stackQL-stringOnly: true + x-title: CreateWorkspaceInstanceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + volumes: + name: volumes + id: awscc.workspacesinstances.volumes + x-cfn-schema-name: Volume + x-cfn-type-name: AWS::WorkspacesInstances::Volume + x-identifiers: + - VolumeId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Volume&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::Volume" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::Volume" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.Encrypted') as encrypted, + JSON_EXTRACT(Properties, '$.Iops') as iops, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.SizeInGB') as size_in_gb, + JSON_EXTRACT(Properties, '$.SnapshotId') as snapshot_id, + JSON_EXTRACT(Properties, '$.Throughput') as throughput, + JSON_EXTRACT(Properties, '$.VolumeType') as volume_type, + JSON_EXTRACT(Properties, '$.TagSpecifications') as tag_specifications + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkspacesInstances::Volume' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'Encrypted') as encrypted, + json_extract_path_text(Properties, 'Iops') as iops, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SizeInGB') as size_in_gb, + json_extract_path_text(Properties, 'SnapshotId') as snapshot_id, + json_extract_path_text(Properties, 'Throughput') as throughput, + json_extract_path_text(Properties, 'VolumeType') as volume_type, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkspacesInstances::Volume' + AND data__Identifier = '' + AND region = 'us-east-1' + volumes_list_only: + name: volumes_list_only + id: awscc.workspacesinstances.volumes_list_only + x-cfn-schema-name: Volume + x-cfn-type-name: AWS::WorkspacesInstances::Volume + x-identifiers: + - VolumeId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkspacesInstances::Volume' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VolumeId') as volume_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkspacesInstances::Volume' + AND region = 'us-east-1' + volume_associations: + name: volume_associations + id: awscc.workspacesinstances.volume_associations + x-cfn-schema-name: VolumeAssociation + x-cfn-type-name: AWS::WorkspacesInstances::VolumeAssociation + x-identifiers: + - WorkspaceInstanceId + - VolumeId + - Device + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VolumeAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::VolumeAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::VolumeAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/volume_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/volume_associations/methods/delete_resource' + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.WorkspaceInstanceId') as workspace_instance_id, + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, + JSON_EXTRACT(Properties, '$.Device') as device, + JSON_EXTRACT(Properties, '$.DisassociateMode') as disassociate_mode + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkspacesInstances::VolumeAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkspaceInstanceId') as workspace_instance_id, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'Device') as device, + json_extract_path_text(Properties, 'DisassociateMode') as disassociate_mode + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkspacesInstances::VolumeAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + volume_associations_list_only: + name: volume_associations_list_only + id: awscc.workspacesinstances.volume_associations_list_only + x-cfn-schema-name: VolumeAssociation + x-cfn-type-name: AWS::WorkspacesInstances::VolumeAssociation + x-identifiers: + - WorkspaceInstanceId + - VolumeId + - Device + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkspaceInstanceId') as workspace_instance_id, + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, + JSON_EXTRACT(Properties, '$.Device') as device + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkspacesInstances::VolumeAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceInstanceId') as workspace_instance_id, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'Device') as device + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkspacesInstances::VolumeAssociation' + AND region = 'us-east-1' + workspace_instances: + name: workspace_instances + id: awscc.workspacesinstances.workspace_instances + x-cfn-schema-name: WorkspaceInstance + x-cfn-type-name: AWS::WorkspacesInstances::WorkspaceInstance + x-identifiers: + - WorkspaceInstanceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WorkspaceInstance&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::WorkspaceInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::WorkspaceInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkspacesInstances::WorkspaceInstance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspace_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspace_instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workspace_instances/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ManagedInstance') as managed_instance, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.WorkspaceInstanceId') as workspace_instance_id, + JSON_EXTRACT(Properties, '$.ProvisionState') as provision_state, + JSON_EXTRACT(Properties, '$.EC2ManagedInstance') as e_c2_managed_instance + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkspacesInstances::WorkspaceInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ManagedInstance') as managed_instance, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkspaceInstanceId') as workspace_instance_id, + json_extract_path_text(Properties, 'ProvisionState') as provision_state, + json_extract_path_text(Properties, 'EC2ManagedInstance') as e_c2_managed_instance + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkspacesInstances::WorkspaceInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + workspace_instances_list_only: + name: workspace_instances_list_only + id: awscc.workspacesinstances.workspace_instances_list_only + x-cfn-schema-name: WorkspaceInstance + x-cfn-type-name: AWS::WorkspacesInstances::WorkspaceInstance + x-identifiers: + - WorkspaceInstanceId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkspaceInstanceId') as workspace_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkspacesInstances::WorkspaceInstance' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceInstanceId') as workspace_instance_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkspacesInstances::WorkspaceInstance' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Volume&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVolume + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVolumeRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VolumeAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVolumeAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVolumeAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WorkspaceInstance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkspaceInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkspaceInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/workspacesthinclient.yaml b/providers/src/awscc/v00.00.00000/services/workspacesthinclient.yaml index c9b3dac9..866fbd42 100644 --- a/providers/src/awscc/v00.00.00000/services/workspacesthinclient.yaml +++ b/providers/src/awscc/v00.00.00000/services/workspacesthinclient.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: WorkSpacesThinClient - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: Hour: type: integer @@ -173,16 +553,26 @@ components: maxLength: 2048 Tags: type: array - maxItems: 20 + maxItems: 50 uniqueItems: true x-insertionOrder: false description: An array of key-value pairs to apply to this resource. items: $ref: '#/components/schemas/Tag' + DeviceCreationTags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to the newly created devices for this environment. + items: + $ref: '#/components/schemas/Tag' required: - DesktopArn x-stackql-resource-name: environment - x-stackql-primaryIdentifier: + description: Resource type definition for AWS::WorkSpacesThinClient::Environment. + x-type-name: AWS::WorkSpacesThinClient::Environment + x-stackql-primary-identifier: - Id x-create-only-properties: - KmsKeyArn @@ -198,6 +588,18 @@ components: - PendingSoftwareSetId - PendingSoftwareSetVersion - SoftwareSetComplianceStatus + x-required-properties: + - DesktopArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - thinclient:UntagResource + - thinclient:ListTagsForResource + - thinclient:TagResource x-required-permissions: create: - thinclient:CreateEnvironment @@ -208,14 +610,12 @@ components: - workspaces-web:GetPortal - workspaces-web:GetUserSettings - kms:DescribeKey - - kms:Encrypt - - kms:Decrypt - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt read: - thinclient:GetEnvironment - thinclient:ListTagsForResource - - kms:DescribeKey - - kms:Encrypt - kms:Decrypt update: - appstream:DescribeStacks @@ -223,63 +623,207 @@ components: - workspaces-web:GetPortal - workspaces-web:GetUserSettings - thinclient:UpdateEnvironment - - thinclient:GetEnvironment - thinclient:TagResource - thinclient:UntagResource - - thinclient:ListTagsForResource - - kms:DescribeKey - - kms:Encrypt - kms:Decrypt - - kms:CreateGrant - - kms:RetireGrant + - kms:GenerateDataKey delete: - thinclient:DeleteEnvironment - thinclient:UntagResource - - kms:DescribeKey + - kms:Decrypt - kms:RetireGrant list: - - thinclient:ListEnvironment + - thinclient:ListEnvironments - thinclient:ListTagsForResource - - kms:DescribeKey - - kms:Encrypt - kms:Decrypt + CreateEnvironmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: Unique identifier of the environment. + type: string + pattern: ^[a-z0-9]{9}$ + Name: + description: The name of the environment. + type: string + pattern: ^.+$ + minLength: 1 + maxLength: 64 + DesktopArn: + description: The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0. + type: string + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA-Z0-9\-\/\._]+$ + minLength: 20 + maxLength: 2048 + DesktopEndpoint: + description: The URL for the identity provider login (only for environments that use AppStream 2.0). + type: string + pattern: ^(https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9]{1,5})?(\/.*)?$ + minLength: 1 + maxLength: 1024 + DesktopType: + description: The type of VDI. + type: string + enum: + - workspaces + - appstream + - workspaces-web + ActivationCode: + description: Activation code for devices associated with environment. + type: string + pattern: ^[a-z]{2}[a-z0-9]{6}$ + RegisteredDevicesCount: + description: Number of devices registered to the environment. + type: integer + minimum: 0 + SoftwareSetUpdateSchedule: + description: An option to define if software updates should be applied within a maintenance window. + type: string + enum: + - USE_MAINTENANCE_WINDOW + - APPLY_IMMEDIATELY + MaintenanceWindow: + description: A specification for a time window to apply software updates. + $ref: '#/components/schemas/MaintenanceWindow' + SoftwareSetUpdateMode: + description: An option to define which software updates to apply. + type: string + enum: + - USE_LATEST + - USE_DESIRED + DesiredSoftwareSetId: + description: The ID of the software set to apply. + type: string + pattern: ^[0-9]{1,9}$ + PendingSoftwareSetId: + description: The ID of the software set that is pending to be installed. + type: string + pattern: ^[0-9]{1,9}$ + PendingSoftwareSetVersion: + description: The version of the software set that is pending to be installed. + type: string + SoftwareSetComplianceStatus: + description: Describes if the software currently installed on all devices in the environment is a supported version. + type: string + enum: + - COMPLIANT + - NOT_COMPLIANT + - NO_REGISTERED_DEVICES + CreatedAt: + description: The timestamp in unix epoch format when environment was created. + type: string + UpdatedAt: + description: The timestamp in unix epoch format when environment was last updated. + type: string + Arn: + description: The environment ARN. + type: string + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA-Z0-9\-\/\._]+$ + minLength: 20 + maxLength: 2048 + KmsKeyArn: + description: The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment. + type: string + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[0-9]{0,12}:key\/[a-zA-Z0-9-]+$ + minLength: 20 + maxLength: 2048 + Tags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to this resource. + items: + $ref: '#/components/schemas/Tag' + DeviceCreationTags: + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + description: An array of key-value pairs to apply to the newly created devices for this environment. + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateEnvironmentRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: environments: name: environments id: awscc.workspacesthinclient.environments x-cfn-schema-name: Environment - x-type: list - x-identifiers: - - Id - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: awscc.workspacesthinclient.environment - x-cfn-schema-name: Environment - x-type: get + x-cfn-type-name: AWS::WorkSpacesThinClient::Environment x-identifiers: - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesThinClient::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesThinClient::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesThinClient::Environment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -302,12 +846,13 @@ components: JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.DeviceCreationTags') as device_creation_tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -330,7 +875,234 @@ components: json_extract_path_text(Properties, 'UpdatedAt') as updated_at, json_extract_path_text(Properties, 'Arn') as arn, json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'Tags') as tags + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DeviceCreationTags') as device_creation_tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' AND data__Identifier = '' AND region = 'us-east-1' + environments_list_only: + name: environments_list_only + id: awscc.workspacesthinclient.environments_list_only + x-cfn-schema-name: Environment + x-cfn-type-name: AWS::WorkSpacesThinClient::Environment + x-identifiers: + - Id + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Environment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateEnvironment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateEnvironmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/workspacesweb.yaml b/providers/src/awscc/v00.00.00000/services/workspacesweb.yaml index 2f0fd247..6e16ee8e 100644 --- a/providers/src/awscc/v00.00.00000/services/workspacesweb.yaml +++ b/providers/src/awscc/v00.00.00000/services/workspacesweb.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: WorkSpacesWeb - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: EncryptionContextMap: type: object @@ -67,7 +447,9 @@ components: minItems: 0 x-insertionOrder: false x-stackql-resource-name: browser_settings - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::BrowserSettings Resource Type + x-type-name: AWS::WorkSpacesWeb::BrowserSettings + x-stackql-primary-identifier: - BrowserSettingsArn x-create-only-properties: - AdditionalEncryptionContext @@ -75,16 +457,28 @@ components: x-read-only-properties: - AssociatedPortalArns - BrowserSettingsArn + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateBrowserSettings - workspaces-web:GetBrowserSettings - workspaces-web:ListTagsForResource - workspaces-web:TagResource - - kms:CreateGrant - kms:DescribeKey - kms:GenerateDataKey - kms:Decrypt + - kms:GenerateDataKeyWithoutPlaintext + - kms:ReEncryptTo + - kms:ReEncryptFrom read: - workspaces-web:GetBrowserSettings - workspaces-web:ListBrowserSettings @@ -113,6 +507,221 @@ components: - kms:Decrypt list: - workspaces-web:ListBrowserSettings + - kms:Decrypt + - kms:DescribeKey + CustomPattern: + type: object + properties: + PatternName: + type: string + maxLength: 20 + minLength: 1 + pattern: ^[_\-\d\w]+$ + PatternRegex: + type: string + maxLength: 300 + minLength: 0 + pattern: ^\/((?:[^\n])+)\/([gimsuyvd]{0,8})$ + PatternDescription: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + KeywordRegex: + type: string + maxLength: 300 + minLength: 0 + pattern: ^\/((?:[^\n])+)\/([gimsuyvd]{0,8})$ + required: + - PatternName + - PatternRegex + additionalProperties: false + InlineRedactionConfiguration: + type: object + properties: + InlineRedactionPatterns: + type: array + items: + $ref: '#/components/schemas/InlineRedactionPattern' + maxItems: 150 + minItems: 0 + GlobalEnforcedUrls: + type: array + items: + type: string + pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+)(?::(\d{1,5}))?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?|(([a-zA-Z][a-zA-Z0-9+.-]*):(\/\/)?\*))$ + maxItems: 100 + minItems: 1 + GlobalExemptUrls: + type: array + items: + type: string + pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+)(?::(\d{1,5}))?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?|(([a-zA-Z][a-zA-Z0-9+.-]*):(\/\/)?\*))$ + maxItems: 100 + minItems: 1 + GlobalConfidenceLevel: + type: number + maximum: 3 + minimum: 1 + required: + - InlineRedactionPatterns + additionalProperties: false + InlineRedactionPattern: + type: object + properties: + BuiltInPatternId: + type: string + maxLength: 50 + minLength: 1 + pattern: ^[_\-\d\w]+$ + CustomPattern: + $ref: '#/components/schemas/CustomPattern' + RedactionPlaceHolder: + $ref: '#/components/schemas/RedactionPlaceHolder' + EnforcedUrls: + type: array + items: + type: string + pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+)(?::(\d{1,5}))?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?|(([a-zA-Z][a-zA-Z0-9+.-]*):(\/\/)?\*))$ + maxItems: 20 + minItems: 1 + ExemptUrls: + type: array + items: + type: string + pattern: ^((([a-zA-Z][a-zA-Z0-9+.-]*):\/\/(\*|[\w%._\-\+~#=@]+)?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?)|(\*|[\w%._\-\+~#=@]+\.[\w%._\-\+~#=@]+)(?::(\d{1,5}))?(\/[^@\s]*)?(?:\?([^*\s]+(?:\*?)))?|(([a-zA-Z][a-zA-Z0-9+.-]*):(\/\/)?\*))$ + maxItems: 20 + minItems: 1 + ConfidenceLevel: + type: number + maximum: 3 + minimum: 1 + required: + - RedactionPlaceHolder + additionalProperties: false + RedactionPlaceHolder: + type: object + properties: + RedactionPlaceHolderType: + $ref: '#/components/schemas/RedactionPlaceHolderType' + RedactionPlaceHolderText: + type: string + maxLength: 20 + minLength: 1 + pattern: ^[*_\-\d\w]+$ + required: + - RedactionPlaceHolderType + additionalProperties: false + RedactionPlaceHolderType: + type: string + enum: + - CustomText + DataProtectionSettings: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + CreationDate: + type: string + format: date-time + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DataProtectionSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + DisplayName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + InlineRedactionConfiguration: + $ref: '#/components/schemas/InlineRedactionConfiguration' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackql-resource-name: data_protection_settings + description: Definition of AWS::WorkSpacesWeb::DataProtectionSettings Resource Type + x-type-name: AWS::WorkSpacesWeb::DataProtectionSettings + x-stackql-primary-identifier: + - DataProtectionSettingsArn + x-create-only-properties: + - AdditionalEncryptionContext + - CustomerManagedKey + x-read-only-properties: + - AssociatedPortalArns + - CreationDate + - DataProtectionSettingsArn + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource + x-required-permissions: + create: + - workspaces-web:CreateDataProtectionSettings + - workspaces-web:GetDataProtectionSettings + - workspaces-web:ListDataProtectionSettings + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + - kms:GenerateDataKeyWithoutPlaintext + - kms:ReEncryptTo + - kms:ReEncryptFrom + read: + - workspaces-web:GetDataProtectionSettings + - workspaces-web:ListDataProtectionSettings + - workspaces-web:ListTagsForResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + update: + - workspaces-web:UpdateDataProtectionSettings + - workspaces-web:GetDataProtectionSettings + - workspaces-web:ListDataProtectionSettings + - workspaces-web:TagResource + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + delete: + - workspaces-web:GetDataProtectionSettings + - workspaces-web:ListDataProtectionSettings + - workspaces-web:DeleteDataProtectionSettings + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + list: + - workspaces-web:ListDataProtectionSettings + - kms:Decrypt + - kms:DescribeKey IdentityProviderDetails: type: object x-patternProperties: @@ -153,17 +762,42 @@ components: maxLength: 2048 minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false required: - IdentityProviderDetails - IdentityProviderName - IdentityProviderType x-stackql-resource-name: identity_provider - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::IdentityProvider Resource Type + x-type-name: AWS::WorkSpacesWeb::IdentityProvider + x-stackql-primary-identifier: - IdentityProviderArn x-create-only-properties: - PortalArn + x-write-only-properties: + - PortalArn x-read-only-properties: - IdentityProviderArn + x-required-properties: + - IdentityProviderDetails + - IdentityProviderName + - IdentityProviderType + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateIdentityProvider @@ -254,7 +888,9 @@ components: required: - IpRules x-stackql-resource-name: ip_access_settings - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type + x-type-name: AWS::WorkSpacesWeb::IpAccessSettings + x-stackql-primary-identifier: - IpAccessSettingsArn x-create-only-properties: - AdditionalEncryptionContext @@ -263,6 +899,18 @@ components: - AssociatedPortalArns - CreationDate - IpAccessSettingsArn + x-required-properties: + - IpRules + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateIpAccessSettings @@ -270,10 +918,12 @@ components: - workspaces-web:ListIpAccessSettings - workspaces-web:ListTagsForResource - workspaces-web:TagResource - - kms:CreateGrant - kms:DescribeKey - kms:GenerateDataKey - kms:Decrypt + - kms:GenerateDataKeyWithoutPlaintext + - kms:ReEncryptTo + - kms:ReEncryptFrom read: - workspaces-web:GetIpAccessSettings - workspaces-web:ListIpAccessSettings @@ -303,6 +953,8 @@ components: - kms:Decrypt list: - workspaces-web:ListIpAccessSettings + - kms:Decrypt + - kms:DescribeKey NetworkSettings: type: object properties: @@ -356,11 +1008,27 @@ components: - SubnetIds - VpcId x-stackql-resource-name: network_settings - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::NetworkSettings Resource Type + x-type-name: AWS::WorkSpacesWeb::NetworkSettings + x-stackql-primary-identifier: - NetworkSettingsArn x-read-only-properties: - AssociatedPortalArns - NetworkSettingsArn + x-required-properties: + - SecurityGroupIds + - SubnetIds + - VpcId + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateNetworkSettings @@ -391,6 +1059,12 @@ components: type: string enum: - Chrome + InstanceType: + type: string + enum: + - standard.regular + - standard.large + - standard.xlarge PortalStatus: type: string enum: @@ -423,16 +1097,27 @@ components: maxLength: 2048 minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DataProtectionSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ DisplayName: type: string maxLength: 64 minLength: 1 pattern: ^.+$ + InstanceType: + $ref: '#/components/schemas/InstanceType' IpAccessSettingsArn: type: string maxLength: 2048 minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + MaxConcurrentSessions: + type: number + maximum: 5000 + minimum: 1 NetworkSettingsArn: type: string maxLength: 2048 @@ -457,6 +1142,11 @@ components: maxLength: 204800 minLength: 0 pattern: ^.*$ + SessionLoggerArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ StatusReason: type: string maxLength: 1024 @@ -485,7 +1175,9 @@ components: minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ x-stackql-resource-name: portal - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::Portal Resource Type + x-type-name: AWS::WorkSpacesWeb::Portal + x-stackql-primary-identifier: - PortalArn x-create-only-properties: - AdditionalEncryptionContext @@ -499,22 +1191,36 @@ components: - RendererType - ServiceProviderSamlMetadata - StatusReason + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:List* + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreatePortal - - workspaces-web:GetPortal - - workspaces-web:GetPortalServiceProviderMetadata + - workspaces-web:GetPortal* - workspaces-web:AssociateBrowserSettings - workspaces-web:AssociateIpAccessSettings - workspaces-web:AssociateNetworkSettings - workspaces-web:AssociateTrustStore - workspaces-web:AssociateUserAccessLoggingSettings - workspaces-web:AssociateUserSettings - - workspaces-web:ListTagsForResource + - workspaces-web:AssociateDataProtectionSettings + - workspaces-web:AssociateSessionLogger + - workspaces-web:List* - workspaces-web:TagResource - - kms:CreateGrant + - kms:DescribeKey - kms:GenerateDataKey - kms:Decrypt + - kms:GenerateDataKeyWithoutPlaintext + - kms:ReEncryptTo + - kms:ReEncryptFrom - ec2:CreateNetworkInterface - ec2:CreateNetworkInterfacePermission - ec2:DeleteNetworkInterface @@ -522,17 +1228,17 @@ components: - ec2:ModifyNetworkInterfaceAttribute - kinesis:PutRecord - kinesis:PutRecords - - kinesis:DescribeStreamSummary + - kinesis:Describe* - sso:CreateManagedApplicationInstance - - sso:DescribeRegisteredRegions + - sso:Describe* + - s3:PutObject read: - - workspaces-web:GetPortal - - workspaces-web:GetPortalServiceProviderMetadata - - workspaces-web:ListTagsForResource + - workspaces-web:GetPortal* + - workspaces-web:List* - kms:Decrypt + - kms:DescribeKey update: - - workspaces-web:GetPortal - - workspaces-web:GetPortalServiceProviderMetadata + - workspaces-web:GetPortal* - workspaces-web:UpdatePortal - workspaces-web:AssociateBrowserSettings - workspaces-web:AssociateIpAccessSettings @@ -540,19 +1246,24 @@ components: - workspaces-web:AssociateTrustStore - workspaces-web:AssociateUserAccessLoggingSettings - workspaces-web:AssociateUserSettings + - workspaces-web:AssociateDataProtectionSettings + - workspaces-web:AssociateSessionLogger - workspaces-web:DisassociateBrowserSettings - workspaces-web:DisassociateIpAccessSettings - workspaces-web:DisassociateNetworkSettings - workspaces-web:DisassociateTrustStore - workspaces-web:DisassociateUserAccessLoggingSettings - workspaces-web:DisassociateUserSettings - - workspaces-web:ListTagsForResource + - workspaces-web:DisassociateDataProtectionSettings + - workspaces-web:DisassociateSessionLogger + - workspaces-web:List* - workspaces-web:TagResource - workspaces-web:UntagResource - kms:CreateGrant - kms:Encrypt - kms:GenerateDataKey - kms:Decrypt + - kms:DescribeKey - ec2:CreateNetworkInterface - ec2:CreateNetworkInterfacePermission - ec2:DeleteNetworkInterface @@ -560,14 +1271,15 @@ components: - ec2:ModifyNetworkInterfaceAttribute - kinesis:PutRecord - kinesis:PutRecords - - kinesis:DescribeStreamSummary + - kinesis:Describe* - sso:CreateManagedApplicationInstance - sso:DeleteManagedApplicationInstance - - sso:DescribeRegisteredRegions + - sso:Describe* - sso:GetApplicationInstance - - sso:ListApplicationInstances + - sso:List* + - s3:PutObject delete: - - workspaces-web:GetPortal + - workspaces-web:GetPortal* - workspaces-web:DeletePortal - workspaces-web:DisassociateBrowserSettings - workspaces-web:DisassociateIpAccessSettings @@ -575,10 +1287,205 @@ components: - workspaces-web:DisassociateTrustStore - workspaces-web:DisassociateUserAccessLoggingSettings - workspaces-web:DisassociateUserSettings + - workspaces-web:DisassociateDataProtectionSettings + - workspaces-web:DisassociateSessionLogger - kms:Decrypt + - kms:DescribeKey - sso:DeleteManagedApplicationInstance list: - - workspaces-web:ListPortals + - workspaces-web:List* + - kms:Decrypt + - kms:DescribeKey + Event: + type: string + enum: + - WebsiteInteract + - FileDownloadFromSecureBrowserToRemoteDisk + - FileTransferFromRemoteToLocalDisk + - FileTransferFromLocalToRemoteDisk + - FileUploadFromRemoteDiskToSecureBrowser + - ContentPasteToWebsite + - ContentTransferFromLocalToRemoteClipboard + - ContentCopyFromWebsite + - UrlLoad + - TabOpen + - TabClose + - PrintJobSubmit + - SessionConnect + - SessionStart + - SessionDisconnect + - SessionEnd + - UrlBlockByContentFilter + EventFilter: + oneOf: + - type: object + title: All + properties: + All: + $ref: '#/components/schemas/Unit' + required: + - All + additionalProperties: false + - type: object + title: Include + properties: + Include: + type: array + items: + $ref: '#/components/schemas/Event' + maxItems: 100 + minItems: 1 + uniqueItems: true + required: + - Include + additionalProperties: false + FolderStructure: + type: string + enum: + - Flat + - NestedByDate + LogConfiguration: + type: object + properties: + S3: + $ref: '#/components/schemas/S3LogConfiguration' + additionalProperties: false + LogFileFormat: + type: string + enum: + - JSONLines + - Json + S3LogConfiguration: + type: object + properties: + Bucket: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + KeyPrefix: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[\d\w\-_/!().*']+$ + BucketOwner: + type: string + pattern: ^[0-9]{12}$ + LogFileFormat: + $ref: '#/components/schemas/LogFileFormat' + FolderStructure: + $ref: '#/components/schemas/FolderStructure' + required: + - Bucket + - FolderStructure + - LogFileFormat + additionalProperties: false + Unit: + type: object + additionalProperties: false + SessionLogger: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + CreationDate: + type: string + format: date-time + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DisplayName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + EventFilter: + $ref: '#/components/schemas/EventFilter' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + SessionLoggerArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + required: + - EventFilter + - LogConfiguration + x-stackql-resource-name: session_logger + description: Definition of AWS::WorkSpacesWeb::SessionLogger Resource Type + x-type-name: AWS::WorkSpacesWeb::SessionLogger + x-stackql-primary-identifier: + - SessionLoggerArn + x-create-only-properties: + - AdditionalEncryptionContext + - CustomerManagedKey + x-read-only-properties: + - AssociatedPortalArns + - CreationDate + - SessionLoggerArn + x-required-properties: + - EventFilter + - LogConfiguration + x-tagging: + cloudFormationSystemTags: false + permissions: + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource + - workspaces-web:UntagResource + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - workspaces-web:CreateSessionLogger + - workspaces-web:GetSessionLogger + - workspaces-web:ListSessionLoggers + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource + - s3:PutObject + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt + - kms:GenerateDataKeyWithoutPlaintext + - kms:ReEncryptTo + - kms:ReEncryptFrom + read: + - workspaces-web:GetSessionLogger + - workspaces-web:ListTagsForResource + - kms:Decrypt + update: + - workspaces-web:UpdateSessionLogger + - workspaces-web:GetSessionLogger + - workspaces-web:ListSessionLoggers + - workspaces-web:TagResource + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - s3:PutObject + - kms:GenerateDataKey + - kms:Decrypt + delete: + - workspaces-web:GetSessionLogger + - workspaces-web:DeleteSessionLogger + - kms:Decrypt + list: + - workspaces-web:ListSessionLoggers - kms:Decrypt TrustStore: type: object @@ -611,11 +1518,25 @@ components: required: - CertificateList x-stackql-resource-name: trust_store - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::TrustStore Resource Type + x-type-name: AWS::WorkSpacesWeb::TrustStore + x-stackql-primary-identifier: - TrustStoreArn x-read-only-properties: - AssociatedPortalArns - TrustStoreArn + x-required-properties: + - CertificateList + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateTrustStore @@ -676,11 +1597,25 @@ components: required: - KinesisStreamArn x-stackql-resource-name: user_access_logging_settings - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type + x-type-name: AWS::WorkSpacesWeb::UserAccessLoggingSettings + x-stackql-primary-identifier: - UserAccessLoggingSettingsArn x-read-only-properties: - AssociatedPortalArns - UserAccessLoggingSettingsArn + x-required-properties: + - KinesisStreamArn + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateUserAccessLoggingSettings @@ -748,6 +1683,49 @@ components: enum: - Disabled - Enabled + MaxDisplayResolution: + type: string + enum: + - size4096X2160 + - size3840X2160 + - size3440X1440 + - size2560X1440 + - size1920X1080 + - size1280X720 + - size1024X768 + - size800X600 + ToolbarConfiguration: + type: object + properties: + ToolbarType: + $ref: '#/components/schemas/ToolbarType' + VisualMode: + $ref: '#/components/schemas/VisualMode' + HiddenToolbarItems: + type: array + items: + $ref: '#/components/schemas/ToolbarItem' + MaxDisplayResolution: + $ref: '#/components/schemas/MaxDisplayResolution' + additionalProperties: false + ToolbarItem: + type: string + enum: + - Windows + - DualMonitor + - FullScreen + - Webcam + - Microphone + ToolbarType: + type: string + enum: + - Floating + - Docked + VisualMode: + type: string + enum: + - Dark + - Light UserSettings: type: object properties: @@ -793,6 +1771,8 @@ components: maxItems: 200 minItems: 0 x-insertionOrder: false + ToolbarConfiguration: + $ref: '#/components/schemas/ToolbarConfiguration' UploadAllowed: $ref: '#/components/schemas/EnabledType' UserSettingsArn: @@ -800,6 +1780,8 @@ components: maxLength: 2048 minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + DeepLinkAllowed: + $ref: '#/components/schemas/EnabledType' required: - CopyAllowed - DownloadAllowed @@ -807,24 +1789,41 @@ components: - PrintAllowed - UploadAllowed x-stackql-resource-name: user_settings - x-stackql-primaryIdentifier: + description: Definition of AWS::WorkSpacesWeb::UserSettings Resource Type + x-type-name: AWS::WorkSpacesWeb::UserSettings + x-stackql-primary-identifier: - UserSettingsArn - x-create-only-properties: - - AdditionalEncryptionContext - - CustomerManagedKey x-read-only-properties: - AssociatedPortalArns - UserSettingsArn + x-required-properties: + - CopyAllowed + - DownloadAllowed + - PasteAllowed + - PrintAllowed + - UploadAllowed + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + permissions: + - workspaces-web:UntagResource + - workspaces-web:ListTagsForResource + - workspaces-web:TagResource x-required-permissions: create: - workspaces-web:CreateUserSettings - workspaces-web:GetUserSettings - workspaces-web:ListTagsForResource - workspaces-web:TagResource - - kms:CreateGrant - kms:DescribeKey - kms:GenerateDataKey - kms:Decrypt + - kms:GenerateDataKeyWithoutPlaintext + - kms:ReEncryptTo + - kms:ReEncryptFrom read: - workspaces-web:GetUserSettings - workspaces-web:ListTagsForResource @@ -855,18 +1854,671 @@ components: - kms:DescribeKey - kms:GenerateDataKey - kms:Decrypt + CreateBrowserSettingsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-insertionOrder: false + BrowserPolicy: + type: string + maxLength: 131072 + minLength: 2 + pattern: \{[\S\s]*\}\s* + BrowserSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateBrowserSettingsRequest + type: object + required: [] + CreateDataProtectionSettingsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + CreationDate: + type: string + format: date-time + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DataProtectionSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + DisplayName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + InlineRedactionConfiguration: + $ref: '#/components/schemas/InlineRedactionConfiguration' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-stackQL-stringOnly: true + x-title: CreateDataProtectionSettingsRequest + type: object + required: [] + CreateIdentityProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + IdentityProviderArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36}){2,}$ + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + IdentityProviderName: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+$ + IdentityProviderType: + $ref: '#/components/schemas/IdentityProviderType' + PortalArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateIdentityProviderRequest + type: object + required: [] + CreateIpAccessSettingsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-insertionOrder: false + CreationDate: + type: string + format: date-time + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + Description: + type: string + maxLength: 256 + minLength: 1 + pattern: ^.+$ + DisplayName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^.+$ + IpAccessSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + IpRules: + type: array + items: + $ref: '#/components/schemas/IpRule' + maxItems: 100 + minItems: 1 + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateIpAccessSettingsRequest + type: object + required: [] + CreateNetworkSettingsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-insertionOrder: false + NetworkSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + SecurityGroupIds: + type: array + items: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[\w+\-]+$ + maxItems: 5 + minItems: 1 + x-insertionOrder: false + SubnetIds: + type: array + items: + type: string + maxLength: 32 + minLength: 1 + pattern: ^subnet-([0-9a-f]{8}|[0-9a-f]{17})$ + maxItems: 3 + minItems: 2 + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + VpcId: + type: string + maxLength: 255 + minLength: 1 + pattern: ^vpc-[0-9a-z]*$ + x-stackQL-stringOnly: true + x-title: CreateNetworkSettingsRequest + type: object + required: [] + CreatePortalRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AuthenticationType: + $ref: '#/components/schemas/AuthenticationType' + BrowserSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + BrowserType: + $ref: '#/components/schemas/BrowserType' + CreationDate: + type: string + format: date-time + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DataProtectionSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + DisplayName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^.+$ + InstanceType: + $ref: '#/components/schemas/InstanceType' + IpAccessSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + MaxConcurrentSessions: + type: number + maximum: 5000 + minimum: 1 + NetworkSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + PortalArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + PortalEndpoint: + type: string + maxLength: 253 + minLength: 1 + pattern: ^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\.)+[a-zA-Z0-9]+$ + PortalStatus: + $ref: '#/components/schemas/PortalStatus' + RendererType: + $ref: '#/components/schemas/RendererType' + ServiceProviderSamlMetadata: + type: string + maxLength: 204800 + minLength: 0 + pattern: ^.*$ + SessionLoggerArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + StatusReason: + type: string + maxLength: 1024 + minLength: 1 + pattern: .* + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + TrustStoreArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + UserAccessLoggingSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + UserSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-stackQL-stringOnly: true + x-title: CreatePortalRequest + type: object + required: [] + CreateSessionLoggerRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + CreationDate: + type: string + format: date-time + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DisplayName: + type: string + maxLength: 64 + minLength: 1 + pattern: ^[ _\-\d\w]+$ + EventFilter: + $ref: '#/components/schemas/EventFilter' + LogConfiguration: + $ref: '#/components/schemas/LogConfiguration' + SessionLoggerArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateSessionLoggerRequest + type: object + required: [] + CreateTrustStoreRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-insertionOrder: false + CertificateList: + type: array + items: + type: string + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + TrustStoreArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-stackQL-stringOnly: true + x-title: CreateTrustStoreRequest + type: object + required: [] + CreateUserAccessLoggingSettingsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-insertionOrder: false + KinesisStreamArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: arn:[\w+=/,.@-]+:kinesis:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:stream/.+ + description: Kinesis stream ARN to which log events are published. + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + UserAccessLoggingSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-stackQL-stringOnly: true + x-title: CreateUserAccessLoggingSettingsRequest + type: object + required: [] + CreateUserSettingsRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AdditionalEncryptionContext: + $ref: '#/components/schemas/EncryptionContextMap' + AssociatedPortalArns: + type: array + items: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + x-insertionOrder: false + CookieSynchronizationConfiguration: + $ref: '#/components/schemas/CookieSynchronizationConfiguration' + CopyAllowed: + $ref: '#/components/schemas/EnabledType' + CustomerManagedKey: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$ + DisconnectTimeoutInMinutes: + type: number + default: null + maximum: 600 + minimum: 1 + DownloadAllowed: + $ref: '#/components/schemas/EnabledType' + IdleDisconnectTimeoutInMinutes: + type: number + default: null + maximum: 60 + minimum: 0 + PasteAllowed: + $ref: '#/components/schemas/EnabledType' + PrintAllowed: + $ref: '#/components/schemas/EnabledType' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + ToolbarConfiguration: + $ref: '#/components/schemas/ToolbarConfiguration' + UploadAllowed: + $ref: '#/components/schemas/EnabledType' + UserSettingsArn: + type: string + maxLength: 2048 + minLength: 20 + pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + DeepLinkAllowed: + $ref: '#/components/schemas/EnabledType' + x-stackQL-stringOnly: true + x-title: CreateUserSettingsRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: browser_settings: name: browser_settings id: awscc.workspacesweb.browser_settings x-cfn-schema-name: BrowserSettings - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::BrowserSettings x-identifiers: - BrowserSettingsArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BrowserSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::BrowserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::BrowserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::BrowserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/browser_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/browser_settings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/browser_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -881,7 +2533,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -895,13 +2547,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' AND data__Identifier = '' AND region = 'us-east-1' - identity_providers: - name: identity_providers - id: awscc.workspacesweb.identity_providers - x-cfn-schema-name: IdentityProvider - x-type: list + browser_settings_list_only: + name: browser_settings_list_only + id: awscc.workspacesweb.browser_settings_list_only + x-cfn-schema-name: BrowserSettings + x-cfn-type-name: AWS::WorkSpacesWeb::BrowserSettings x-identifiers: - - IdentityProviderArn + - BrowserSettingsArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -909,28 +2567,200 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.IdentityProviderArn') as identity_provider_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' + JSON_EXTRACT(Properties, '$.BrowserSettingsArn') as browser_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'IdentityProviderArn') as identity_provider_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' + json_extract_path_text(Properties, 'BrowserSettingsArn') as browser_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' + AND region = 'us-east-1' + data_protection_settings: + name: data_protection_settings + id: awscc.workspacesweb.data_protection_settings + x-cfn-schema-name: DataProtectionSettings + x-cfn-type-name: AWS::WorkSpacesWeb::DataProtectionSettings + x-identifiers: + - DataProtectionSettingsArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataProtectionSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::DataProtectionSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::DataProtectionSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::DataProtectionSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_protection_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_protection_settings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_protection_settings/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AdditionalEncryptionContext') as additional_encryption_context, + JSON_EXTRACT(Properties, '$.AssociatedPortalArns') as associated_portal_arns, + JSON_EXTRACT(Properties, '$.CreationDate') as creation_date, + JSON_EXTRACT(Properties, '$.CustomerManagedKey') as customer_managed_key, + JSON_EXTRACT(Properties, '$.DataProtectionSettingsArn') as data_protection_settings_arn, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.InlineRedactionConfiguration') as inline_redaction_configuration, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::DataProtectionSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'DataProtectionSettingsArn') as data_protection_settings_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'InlineRedactionConfiguration') as inline_redaction_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::DataProtectionSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + data_protection_settings_list_only: + name: data_protection_settings_list_only + id: awscc.workspacesweb.data_protection_settings_list_only + x-cfn-schema-name: DataProtectionSettings + x-cfn-type-name: AWS::WorkSpacesWeb::DataProtectionSettings + x-identifiers: + - DataProtectionSettingsArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.DataProtectionSettingsArn') as data_protection_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::DataProtectionSettings' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DataProtectionSettingsArn') as data_protection_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::DataProtectionSettings' AND region = 'us-east-1' - identity_provider: - name: identity_provider - id: awscc.workspacesweb.identity_provider + identity_providers: + name: identity_providers + id: awscc.workspacesweb.identity_providers x-cfn-schema-name: IdentityProvider - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::IdentityProvider x-identifiers: - IdentityProviderArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IdentityProvider&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IdentityProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IdentityProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IdentityProvider" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -939,12 +2769,13 @@ components: JSON_EXTRACT(Properties, '$.IdentityProviderDetails') as identity_provider_details, JSON_EXTRACT(Properties, '$.IdentityProviderName') as identity_provider_name, JSON_EXTRACT(Properties, '$.IdentityProviderType') as identity_provider_type, - JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn + JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -953,21 +2784,101 @@ components: json_extract_path_text(Properties, 'IdentityProviderDetails') as identity_provider_details, json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name, json_extract_path_text(Properties, 'IdentityProviderType') as identity_provider_type, - json_extract_path_text(Properties, 'PortalArn') as portal_arn + json_extract_path_text(Properties, 'PortalArn') as portal_arn, + json_extract_path_text(Properties, 'Tags') as tags FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' AND data__Identifier = '' AND region = 'us-east-1' + identity_providers_list_only: + name: identity_providers_list_only + id: awscc.workspacesweb.identity_providers_list_only + x-cfn-schema-name: IdentityProvider + x-cfn-type-name: AWS::WorkSpacesWeb::IdentityProvider + x-identifiers: + - IdentityProviderArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.IdentityProviderArn') as identity_provider_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdentityProviderArn') as identity_provider_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' + AND region = 'us-east-1' ip_access_settings: name: ip_access_settings id: awscc.workspacesweb.ip_access_settings x-cfn-schema-name: IpAccessSettings - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::IpAccessSettings x-identifiers: - IpAccessSettingsArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IpAccessSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IpAccessSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IpAccessSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IpAccessSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_access_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_access_settings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ip_access_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -985,7 +2896,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1002,17 +2913,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' AND data__Identifier = '' AND region = 'us-east-1' + ip_access_settings_list_only: + name: ip_access_settings_list_only + id: awscc.workspacesweb.ip_access_settings_list_only + x-cfn-schema-name: IpAccessSettings + x-cfn-type-name: AWS::WorkSpacesWeb::IpAccessSettings + x-identifiers: + - IpAccessSettingsArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.IpAccessSettingsArn') as ip_access_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' + AND region = 'us-east-1' network_settings: name: network_settings id: awscc.workspacesweb.network_settings x-cfn-schema-name: NetworkSettings - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::NetworkSettings x-identifiers: - NetworkSettingsArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::NetworkSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::NetworkSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::NetworkSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_settings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1027,7 +3017,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1041,13 +3031,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' AND data__Identifier = '' AND region = 'us-east-1' - portals: - name: portals - id: awscc.workspacesweb.portals - x-cfn-schema-name: Portal - x-type: list + network_settings_list_only: + name: network_settings_list_only + id: awscc.workspacesweb.network_settings_list_only + x-cfn-schema-name: NetworkSettings + x-cfn-type-name: AWS::WorkSpacesWeb::NetworkSettings x-identifiers: - - PortalArn + - NetworkSettingsArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1055,28 +3051,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' + JSON_EXTRACT(Properties, '$.NetworkSettingsArn') as network_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PortalArn') as portal_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' + json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' AND region = 'us-east-1' - portal: - name: portal - id: awscc.workspacesweb.portal + portals: + name: portals + id: awscc.workspacesweb.portals x-cfn-schema-name: Portal - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::Portal x-identifiers: - PortalArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Portal&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::Portal" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::Portal" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::Portal" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/portals/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/portals/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/portals/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1087,14 +3131,18 @@ components: JSON_EXTRACT(Properties, '$.BrowserType') as browser_type, JSON_EXTRACT(Properties, '$.CreationDate') as creation_date, JSON_EXTRACT(Properties, '$.CustomerManagedKey') as customer_managed_key, + JSON_EXTRACT(Properties, '$.DataProtectionSettingsArn') as data_protection_settings_arn, JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, JSON_EXTRACT(Properties, '$.IpAccessSettingsArn') as ip_access_settings_arn, + JSON_EXTRACT(Properties, '$.MaxConcurrentSessions') as max_concurrent_sessions, JSON_EXTRACT(Properties, '$.NetworkSettingsArn') as network_settings_arn, JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn, JSON_EXTRACT(Properties, '$.PortalEndpoint') as portal_endpoint, JSON_EXTRACT(Properties, '$.PortalStatus') as portal_status, JSON_EXTRACT(Properties, '$.RendererType') as renderer_type, JSON_EXTRACT(Properties, '$.ServiceProviderSamlMetadata') as service_provider_saml_metadata, + JSON_EXTRACT(Properties, '$.SessionLoggerArn') as session_logger_arn, JSON_EXTRACT(Properties, '$.StatusReason') as status_reason, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn, @@ -1104,7 +3152,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1115,14 +3163,18 @@ components: json_extract_path_text(Properties, 'BrowserType') as browser_type, json_extract_path_text(Properties, 'CreationDate') as creation_date, json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'DataProtectionSettingsArn') as data_protection_settings_arn, json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'InstanceType') as instance_type, json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn, + json_extract_path_text(Properties, 'MaxConcurrentSessions') as max_concurrent_sessions, json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn, json_extract_path_text(Properties, 'PortalArn') as portal_arn, json_extract_path_text(Properties, 'PortalEndpoint') as portal_endpoint, json_extract_path_text(Properties, 'PortalStatus') as portal_status, json_extract_path_text(Properties, 'RendererType') as renderer_type, json_extract_path_text(Properties, 'ServiceProviderSamlMetadata') as service_provider_saml_metadata, + json_extract_path_text(Properties, 'SessionLoggerArn') as session_logger_arn, json_extract_path_text(Properties, 'StatusReason') as status_reason, json_extract_path_text(Properties, 'Tags') as tags, json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn, @@ -1131,13 +3183,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' AND data__Identifier = '' AND region = 'us-east-1' - trust_stores: - name: trust_stores - id: awscc.workspacesweb.trust_stores - x-cfn-schema-name: TrustStore - x-type: list + portals_list_only: + name: portals_list_only + id: awscc.workspacesweb.portals_list_only + x-cfn-schema-name: Portal + x-cfn-type-name: AWS::WorkSpacesWeb::Portal x-identifiers: - - TrustStoreArn + - PortalArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -1145,28 +3203,200 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' + JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' + json_extract_path_text(Properties, 'PortalArn') as portal_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' AND region = 'us-east-1' - trust_store: - name: trust_store - id: awscc.workspacesweb.trust_store + session_loggers: + name: session_loggers + id: awscc.workspacesweb.session_loggers + x-cfn-schema-name: SessionLogger + x-cfn-type-name: AWS::WorkSpacesWeb::SessionLogger + x-identifiers: + - SessionLoggerArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SessionLogger&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::SessionLogger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::SessionLogger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::SessionLogger" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/session_loggers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/session_loggers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/session_loggers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AdditionalEncryptionContext') as additional_encryption_context, + JSON_EXTRACT(Properties, '$.AssociatedPortalArns') as associated_portal_arns, + JSON_EXTRACT(Properties, '$.CreationDate') as creation_date, + JSON_EXTRACT(Properties, '$.CustomerManagedKey') as customer_managed_key, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.EventFilter') as event_filter, + JSON_EXTRACT(Properties, '$.LogConfiguration') as log_configuration, + JSON_EXTRACT(Properties, '$.SessionLoggerArn') as session_logger_arn, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::SessionLogger' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'EventFilter') as event_filter, + json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, + json_extract_path_text(Properties, 'SessionLoggerArn') as session_logger_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::SessionLogger' + AND data__Identifier = '' + AND region = 'us-east-1' + session_loggers_list_only: + name: session_loggers_list_only + id: awscc.workspacesweb.session_loggers_list_only + x-cfn-schema-name: SessionLogger + x-cfn-type-name: AWS::WorkSpacesWeb::SessionLogger + x-identifiers: + - SessionLoggerArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.SessionLoggerArn') as session_logger_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::SessionLogger' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SessionLoggerArn') as session_logger_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::SessionLogger' + AND region = 'us-east-1' + trust_stores: + name: trust_stores + id: awscc.workspacesweb.trust_stores x-cfn-schema-name: TrustStore - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::TrustStore x-identifiers: - TrustStoreArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TrustStore&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::TrustStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::TrustStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::TrustStore" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1179,7 +3409,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1191,17 +3421,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' AND data__Identifier = '' AND region = 'us-east-1' + trust_stores_list_only: + name: trust_stores_list_only + id: awscc.workspacesweb.trust_stores_list_only + x-cfn-schema-name: TrustStore + x-cfn-type-name: AWS::WorkSpacesWeb::TrustStore + x-identifiers: + - TrustStoreArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' + AND region = 'us-east-1' user_access_logging_settings: name: user_access_logging_settings id: awscc.workspacesweb.user_access_logging_settings x-cfn-schema-name: UserAccessLoggingSettings - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::UserAccessLoggingSettings x-identifiers: - UserAccessLoggingSettingsArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserAccessLoggingSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_access_logging_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_access_logging_settings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_access_logging_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1214,7 +3523,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1226,17 +3535,96 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' AND data__Identifier = '' AND region = 'us-east-1' + user_access_logging_settings_list_only: + name: user_access_logging_settings_list_only + id: awscc.workspacesweb.user_access_logging_settings_list_only + x-cfn-schema-name: UserAccessLoggingSettings + x-cfn-type-name: AWS::WorkSpacesWeb::UserAccessLoggingSettings + x-identifiers: + - UserAccessLoggingSettingsArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserAccessLoggingSettingsArn') as user_access_logging_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserAccessLoggingSettingsArn') as user_access_logging_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' + AND region = 'us-east-1' user_settings: name: user_settings id: awscc.workspacesweb.user_settings x-cfn-schema-name: UserSettings - x-type: get + x-cfn-type-name: AWS::WorkSpacesWeb::UserSettings x-identifiers: - UserSettingsArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_settings/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/user_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1252,13 +3640,15 @@ components: JSON_EXTRACT(Properties, '$.PasteAllowed') as paste_allowed, JSON_EXTRACT(Properties, '$.PrintAllowed') as print_allowed, JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.ToolbarConfiguration') as toolbar_configuration, JSON_EXTRACT(Properties, '$.UploadAllowed') as upload_allowed, - JSON_EXTRACT(Properties, '$.UserSettingsArn') as user_settings_arn + JSON_EXTRACT(Properties, '$.UserSettingsArn') as user_settings_arn, + JSON_EXTRACT(Properties, '$.DeepLinkAllowed') as deep_link_allowed FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1274,8 +3664,614 @@ components: json_extract_path_text(Properties, 'PasteAllowed') as paste_allowed, json_extract_path_text(Properties, 'PrintAllowed') as print_allowed, json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ToolbarConfiguration') as toolbar_configuration, json_extract_path_text(Properties, 'UploadAllowed') as upload_allowed, - json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn + json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn, + json_extract_path_text(Properties, 'DeepLinkAllowed') as deep_link_allowed FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' AND data__Identifier = '' AND region = 'us-east-1' + user_settings_list_only: + name: user_settings_list_only + id: awscc.workspacesweb.user_settings_list_only + x-cfn-schema-name: UserSettings + x-cfn-type-name: AWS::WorkSpacesWeb::UserSettings + x-identifiers: + - UserSettingsArn + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.UserSettingsArn') as user_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__BrowserSettings&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateBrowserSettings + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateBrowserSettingsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataProtectionSettings&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataProtectionSettings + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataProtectionSettingsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IdentityProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIdentityProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIdentityProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__IpAccessSettings&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIpAccessSettings + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIpAccessSettingsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__NetworkSettings&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateNetworkSettings + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateNetworkSettingsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Portal&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePortal + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePortalRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SessionLogger&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSessionLogger + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSessionLoggerRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TrustStore&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTrustStore + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTrustStoreRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserAccessLoggingSettings&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserAccessLoggingSettings + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserAccessLoggingSettingsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserSettings&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserSettings + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserSettingsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/awscc/v00.00.00000/services/xray.yaml b/providers/src/awscc/v00.00.00000/services/xray.yaml index acd18f90..ba6d4dc3 100644 --- a/providers/src/awscc/v00.00.00000/services/xray.yaml +++ b/providers/src/awscc/v00.00.00000/services/xray.yaml @@ -1,9 +1,389 @@ openapi: 3.0.0 info: title: XRay - version: 1.0.0 -paths: {} + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object schemas: InsightsConfiguration: type: object @@ -57,10 +437,23 @@ components: required: - GroupName x-stackql-resource-name: group - x-stackql-primaryIdentifier: + description: This schema provides construct and validation rules for AWS-XRay Group resource parameters. + x-type-name: AWS::XRay::Group + x-stackql-primary-identifier: - GroupARN x-read-only-properties: - GroupARN + x-required-properties: + - GroupName + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - xray:TagResource + - xray:UntagResource x-required-permissions: create: - xray:CreateGroup @@ -99,10 +492,22 @@ components: - PolicyName - PolicyDocument x-stackql-resource-name: resource_policy - x-stackql-primaryIdentifier: + description: This schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters. + x-type-name: AWS::XRay::ResourcePolicy + x-stackql-primary-identifier: - PolicyName x-create-only-properties: - PolicyName + x-write-only-properties: + - BypassPolicyLockoutCheck + x-required-properties: + - PolicyName + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - xray:PutResourcePolicy @@ -132,16 +537,29 @@ components: Tags: $ref: '#/components/schemas/Tags' x-stackql-resource-name: sampling_rule - x-stackql-primaryIdentifier: + description: This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters. + x-type-name: AWS::XRay::SamplingRule + x-stackql-primary-identifier: - RuleARN x-create-only-properties: - SamplingRule/Version x-read-only-properties: - RuleARN + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - xray:TagResource + - xray:UntagResource + - xray:ListTagsForResource x-required-permissions: create: - xray:CreateSamplingRule - xray:TagResource + - xray:ListTagsForResource read: - xray:GetSamplingRules - xray:ListTagsForResource @@ -229,43 +647,238 @@ components: RuleARN: description: The ARN of the sampling rule. Specify a rule by either name or ARN, but not both. type: string + AccountId: + description: User account id, used as the primary identifier for the resource + type: string + pattern: ^\d{12}$ + IndexingPercentage: + description: Determines the percentage of traces indexed from CloudWatch Logs to X-Ray + type: number + minimum: 0 + maximum: 100 + TransactionSearchConfig: + type: object + properties: + AccountId: + $ref: '#/components/schemas/AccountId' + IndexingPercentage: + $ref: '#/components/schemas/IndexingPercentage' + x-stackql-resource-name: transaction_search_config + description: This schema provides construct and validation rules for AWS-XRay TransactionSearchConfig resource parameters. + x-type-name: AWS::XRay::TransactionSearchConfig + x-stackql-primary-identifier: + - AccountId + x-read-only-properties: + - AccountId + x-tagging: + taggable: false + x-required-permissions: + create: + - application-signals:StartDiscovery + - iam:CreateServiceLinkedRole + - logs:CreateLogGroup + - logs:CreateLogStream + - logs:PutRetentionPolicy + - xray:GetIndexingRules + - xray:GetTraceSegmentDestination + - xray:UpdateIndexingRule + - xray:UpdateTraceSegmentDestination + read: + - xray:GetTraceSegmentDestination + - xray:GetIndexingRules + list: + - xray:GetTraceSegmentDestination + - xray:GetIndexingRules + update: + - xray:GetIndexingRules + - xray:GetTraceSegmentDestination + - xray:UpdateIndexingRule + delete: + - xray:GetTraceSegmentDestination + - xray:UpdateTraceSegmentDestination + - xray:UpdateIndexingRule + CreateGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + FilterExpression: + description: The filter expression defining criteria by which to group traces. + type: string + GroupName: + description: The case-sensitive name of the new group. Names must be unique. + type: string + minLength: 1 + maxLength: 32 + GroupARN: + description: The ARN of the group that was generated on creation. + type: string + minLength: 1 + maxLength: 400 + InsightsConfiguration: + $ref: '#/components/schemas/InsightsConfiguration' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateGroupRequest + type: object + required: [] + CreateResourcePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyName: + description: The name of the resource policy. Must be unique within a specific AWS account. + type: string + pattern: '[\w+=,.@-]+' + minLength: 1 + maxLength: 128 + PolicyDocument: + description: The resource policy document, which can be up to 5kb in size. + type: string + minLength: 1 + maxLength: 5120 + BypassPolicyLockoutCheck: + description: A flag to indicate whether to bypass the resource policy lockout safety check + type: boolean + x-stackQL-stringOnly: true + x-title: CreateResourcePolicyRequest + type: object + required: [] + CreateSamplingRuleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SamplingRule: + $ref: '#/components/schemas/SamplingRule' + SamplingRuleRecord: + $ref: '#/components/schemas/SamplingRuleRecord' + SamplingRuleUpdate: + $ref: '#/components/schemas/SamplingRuleUpdate' + RuleARN: + $ref: '#/components/schemas/RuleARN' + RuleName: + $ref: '#/components/schemas/RuleName' + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateSamplingRuleRequest + type: object + required: [] + CreateTransactionSearchConfigRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccountId: + $ref: '#/components/schemas/AccountId' + IndexingPercentage: + $ref: '#/components/schemas/IndexingPercentage' + x-stackQL-stringOnly: true + x-title: CreateTransactionSearchConfigRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: groups: name: groups id: awscc.xray.groups x-cfn-schema-name: Group - x-type: list - x-identifiers: - - GroupARN - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupARN') as group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupARN') as group_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' - AND region = 'us-east-1' - group: - name: group - id: awscc.xray.group - x-cfn-schema-name: Group - x-type: get + x-cfn-type-name: AWS::XRay::Group x-identifiers: - GroupARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::Group" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -279,7 +892,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -292,13 +905,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::Group' AND data__Identifier = '' AND region = 'us-east-1' - resource_policies: - name: resource_policies - id: awscc.xray.resource_policies - x-cfn-schema-name: ResourcePolicy - x-type: list + groups_list_only: + name: groups_list_only + id: awscc.xray.groups_list_only + x-cfn-schema-name: Group + x-cfn-type-name: AWS::XRay::Group x-identifiers: - - PolicyName + - GroupARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -306,28 +925,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' + JSON_EXTRACT(Properties, '$.GroupARN') as group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'PolicyName') as policy_name - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' + json_extract_path_text(Properties, 'GroupARN') as group_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: awscc.xray.resource_policy + resource_policies: + name: resource_policies + id: awscc.xray.resource_policies x-cfn-schema-name: ResourcePolicy - x-type: get + x-cfn-type-name: AWS::XRay::ResourcePolicy x-identifiers: - PolicyName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::ResourcePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -339,7 +1006,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -350,13 +1017,19 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' AND data__Identifier = '' AND region = 'us-east-1' - sampling_rules: - name: sampling_rules - id: awscc.xray.sampling_rules - x-cfn-schema-name: SamplingRule - x-type: list + resource_policies_list_only: + name: resource_policies_list_only + id: awscc.xray.resource_policies_list_only + x-cfn-schema-name: ResourcePolicy + x-cfn-type-name: AWS::XRay::ResourcePolicy x-identifiers: - - RuleARN + - PolicyName + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] config: views: select: @@ -364,28 +1037,76 @@ components: ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RuleARN') as rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' AND region = 'us-east-1' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RuleARN') as rule_arn - FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' + json_extract_path_text(Properties, 'PolicyName') as policy_name + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' AND region = 'us-east-1' - sampling_rule: - name: sampling_rule - id: awscc.xray.sampling_rule + sampling_rules: + name: sampling_rules + id: awscc.xray.sampling_rules x-cfn-schema-name: SamplingRule - x-type: get + x-cfn-type-name: AWS::XRay::SamplingRule x-identifiers: - RuleARN + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SamplingRule&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::SamplingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::SamplingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::SamplingRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -400,7 +1121,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -414,3 +1135,465 @@ components: FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::SamplingRule' AND data__Identifier = '' AND region = 'us-east-1' + sampling_rules_list_only: + name: sampling_rules_list_only + id: awscc.xray.sampling_rules_list_only + x-cfn-schema-name: SamplingRule + x-cfn-type-name: AWS::XRay::SamplingRule + x-identifiers: + - RuleARN + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.RuleARN') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleARN') as rule_arn + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' + AND region = 'us-east-1' + transaction_search_configs: + name: transaction_search_configs + id: awscc.xray.transaction_search_configs + x-cfn-schema-name: TransactionSearchConfig + x-cfn-type-name: AWS::XRay::TransactionSearchConfig + x-identifiers: + - AccountId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransactionSearchConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::TransactionSearchConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::TransactionSearchConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::XRay::TransactionSearchConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transaction_search_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transaction_search_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transaction_search_configs/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.IndexingPercentage') as indexing_percentage + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::TransactionSearchConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'IndexingPercentage') as indexing_percentage + FROM awscc.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::TransactionSearchConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + transaction_search_configs_list_only: + name: transaction_search_configs_list_only + id: awscc.xray.transaction_search_configs_list_only + x-cfn-schema-name: TransactionSearchConfig + x-cfn-type-name: AWS::XRay::TransactionSearchConfig + x-identifiers: + - AccountId + x-type: cloud_control_view + methods: {} + sqlVerbs: + insert: [] + delete: [] + update: [] + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::TransactionSearchConfig' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM awscc.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::TransactionSearchConfig' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ResourcePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResourcePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateResourcePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SamplingRule&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSamplingRule + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSamplingRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__TransactionSearchConfig&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransactionSearchConfig + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransactionSearchConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body